refactor: state when item is exported in main

This explicitly states that an item is @external when it is exported from BootstrapVue.ts. This includes types, composables, and directives, and a util class

Author: VividLemon

packages/bootstrap-vue-3/src/BootstrapVue.ts

@@ -4,6 +4,7 @@ import Directives from './directives'
 import {BootstrapVueOptions} from './types'
 import {createBreadcrumb, useBreadcrumb} from './composables'
 import './styles/styles.scss'
+
 // All available components
 // Keep this list in sync with /components/index.ts please
 import BAccordion from './components/BAccordion/BAccordion.vue'
@@ -98,14 +99,7 @@ import BToastContainer from './components/BToast/BToaster.vue'
 import BTransition from './components/BTransition/BTransition.vue'
 
 // Export available composables
-export {useToast}
-
-// Export available plugins
-// Not to be confused with the above main app plugin
-export {BToastPlugin}
-
-// Export available composables
-export {useBreadcrumb}
+export {useToast, useBreadcrumb}
 
 // Export available directives
 export {
@@ -115,6 +109,10 @@ export {
   BVisible as VBVisible,
 } from './directives'
 
+// Export available plugins
+// Not to be confused with the main app plugin
+export {BToastPlugin}
+
 // Export available utils
 export {BvEvent} from './utils'
 

packages/bootstrap-vue-3/src/components/BToast/plugin.ts

@@ -31,6 +31,9 @@ export interface Toast {
   content: ToastContent
 }
 
+/**
+ * @external
+ */
 export type BodyProp = ToastContent['body']
 
 // Toast ViewModel, Each toast instance controls one view model
@@ -193,6 +196,9 @@ export function getKey(): any {
   return inject(fetchKey)
 }
 
+/**
+ * @external
+ */
 export function useToast(): ToastInstance | undefined
 export function useToast(vm: {id: symbol}, key?: symbol): ToastInstance | undefined
 export function useToast(
@@ -216,6 +222,9 @@ export function useToast(vm?: any, key: symbol = injectkey): ToastInstance | und
   return new ToastInstance(vm_instance)
 }
 
+/**
+ * @external
+ */
 export const BToastPlugin: Plugin = {
   install: (app: App, options: BootstrapVueOptions = {}) => {
     app.provide(fetchKey, options?.BToast?.injectkey ?? injectkey)

packages/bootstrap-vue-3/src/composables/useAlignment.ts

@@ -2,6 +2,11 @@ import {computed, ComputedRef} from 'vue'
 
 import type {Alignment} from '../types'
 
+/**
+ *
+ * @param props
+ * @returns
+ */
 export default (props: {align: Alignment}): ComputedRef<string> =>
   computed(() => {
     if (props.align === 'center') {

packages/bootstrap-vue-3/src/composables/useBreadcrumb.ts

@@ -15,10 +15,18 @@ const BREADCRUMB_OBJECT: UseBreadcrumbI = {
   },
 }
 
+/**
+ * @param app
+ */
 export const createBreadcrumb = (app: App): void => {
   app.provide(BREADCRUMB_SYMBOL, BREADCRUMB_OBJECT)
 }
 
+/**
+ * @external
+ *
+ * @returns
+ */
 export const useBreadcrumb = (): UseBreadcrumbI => {
   const context = inject(BREADCRUMB_SYMBOL)
 

packages/bootstrap-vue-3/src/composables/useEventListener.ts

@@ -1,5 +1,10 @@
 import {onBeforeUnmount, onMounted, Ref} from 'vue'
 
+/**
+ * @param element
+ * @param event
+ * @param callback
+ */
 export default (
   element: Ref<HTMLElement | undefined>,
   event: string,

packages/bootstrap-vue-3/src/composables/useFormCheck.ts

@@ -1,5 +1,9 @@
 import {computed, ComputedRef} from 'vue'
 
+/**
+ * @param props
+ * @returns
+ */
 const _getComputedAriaInvalid = (props: any): ComputedRef =>
   computed(() => {
     if (props.ariaInvalid === true || props.ariaInvalid === 'true' || props.ariaInvalid === '') {
@@ -10,6 +14,10 @@ const _getComputedAriaInvalid = (props: any): ComputedRef =>
     return computedState === false ? 'true' : props.ariaInvalid
   })
 
+/**
+ * @param props
+ * @returns
+ */
 const getClasses = (props: any): ComputedRef =>
   computed(() => ({
     'form-check': !props.plain && !props.button,
@@ -18,6 +26,10 @@ const getClasses = (props: any): ComputedRef =>
     [`form-control-${props.size}`]: props.size && props.size !== 'md',
   }))
 
+/**
+ * @param props
+ * @returns
+ */
 const getInputClasses = (props: any): ComputedRef =>
   computed(() => ({
     'form-check-input': !props.plain && !props.button,
@@ -26,6 +38,10 @@ const getInputClasses = (props: any): ComputedRef =>
     'btn-check': props.button,
   }))
 
+/**
+ * @param props
+ * @returns
+ */
 const getLabelClasses = (props: any): ComputedRef =>
   computed(() => ({
     'form-check-label': !props.plain && !props.button,
@@ -34,12 +50,20 @@ const getLabelClasses = (props: any): ComputedRef =>
     [`btn-${props.size}`]: props.button && props.size && props.size !== 'md',
   }))
 
+/**
+ * @param props
+ * @returns
+ */
 const getGroupAttr = (props: any): ComputedRef =>
   computed(() => ({
     'aria-invalid': _getComputedAriaInvalid(props).value,
     'aria-required': props.required.toString() === 'true' ? 'true' : null,
   }))
 
+/**
+ * @param props
+ * @returns
+ */
 const getGroupClasses = (props: any): ComputedRef =>
   computed(() => ({
     'was-validated': props.validated,
@@ -48,6 +72,12 @@ const getGroupClasses = (props: any): ComputedRef =>
     [`btn-group-${props.size}`]: props.size,
   }))
 
+/**
+ * @param slots
+ * @param nodeType
+ * @param disabled
+ * @returns
+ */
 const slotsToElements = (slots: Array<any>, nodeType: string, disabled: boolean) =>
   slots
     .filter((e: any) => e.type.name === nodeType)
@@ -65,6 +95,11 @@ const slotsToElements = (slots: Array<any>, nodeType: string, disabled: boolean)
       }
     })
 
+/**
+ * @param option
+ * @param props
+ * @returns
+ */
 const optionToElement = (option: any, props: any): any => {
   if (typeof option === 'string') {
     return {
@@ -87,6 +122,14 @@ const optionToElement = (option: any, props: any): any => {
   }
 }
 
+/**
+ * @param el
+ * @param idx
+ * @param props
+ * @param computedName
+ * @param computedId
+ * @returns
+ */
 const bindGroupProps = (
   el: any,
   idx: number,

packages/bootstrap-vue-3/src/composables/useFormInput.ts

@@ -43,6 +43,11 @@ type InputEmitType = (
   ...args: any[]
 ) => void
 
+/**
+ * @param props
+ * @param emit
+ * @returns
+ */
 export default (props: Readonly<InputProps>, emit: InputEmitType) => {
   const input = ref<HTMLInputElement>()
   let inputValue: string | null = null

packages/bootstrap-vue-3/src/composables/useFormSelect.ts

@@ -41,6 +41,12 @@ const _normalizeOption = (
   }
 }
 
+/**
+ * @param options
+ * @param componentName
+ * @param props
+ * @returns
+ */
 const normalizeOptions = (options: any[], componentName: string, props: any): any => {
   if (Array.isArray(options)) {
     return options.map((option) => _normalizeOption(option, null, componentName, props))

packages/bootstrap-vue-3/src/composables/useId.ts

@@ -1,5 +1,10 @@
 import {getID} from '../utils'
 import {computed, ComputedRef} from 'vue'
 
+/**
+ * @param id
+ * @param suffix
+ * @returns
+ */
 export default (id?: string, suffix?: string): ComputedRef<string> =>
   computed(() => id || getID(suffix))

packages/bootstrap-vue-3/src/directives/BModal.ts

@@ -1,5 +1,8 @@
 import {DirectiveBinding} from 'vue'
 
+/**
+ * This is not marked as external, but in the future I think it may be
+ */
 export default {
   mounted(el: HTMLElement, binding: DirectiveBinding): void {
     let target: string = binding.value