bt-core-app 1.1.4 → 1.1.6

package/dist/index.d.ts

@@ -1,16 +1,43 @@
-export * from './composables/actions-tracker';
-export * from './composables/actions';
-export * from './composables/demo';
-export * from './composables/document-meta';
+export { useActionsTracker } from './composables/actions-tracker';
+export type { BTActions, GetOptions, DeleteOptions, RestoreOptions, SaveOptions, ApiActionOptions, UseActionsOptions } from './composables/actions';
+export { useActions } from './composables/actions';
+export type { BTApi, UseApiOptions, PathOptions, QueryParams } from './composables/api';
+export { createApi } from './composables/api';
+export type { BTAuth, AuthItem, AuthSubscription, BaseAuthCredentials, CreateAuthOptions } from './composables/auth';
+export { createAuth } from './composables/auth';
+export type { BTCosmetics, BaseCosmeticTheme, UseCosmeticsOptions } from './composables/cosmetics';
+export { createCosmetics } from './composables/cosmetics';
+export * from './composables/csv';
+export type { BTDates, CreateDatesOptions } from './composables/dates';
+export { createDates } from './composables/dates';
+export type { BTDemo } from './composables/demo';
+export { createDemo } from './composables/demo';
+export * from './composables/dialogs';
+export type { BTDocumentMeta, UseDocumentMetaOptions } from './composables/document-meta';
+export { useDocumentMeta } from './composables/document-meta';
 export * from './composables/draggable';
-export * from './composables/forage';
+export type { BTFilters, UseFiltersOptions } from './composables/filters';
+export { createFilters } from './composables/filters';
+export { useLocalDb, useLocalCache } from './composables/forage';
 export * from './composables/helpers';
-export * from './composables/id';
-export * from './composables/list';
+export { useId } from './composables/id';
+export type { TableColumn, CustomFilterParam, ListEvents, ListProps, GroupedHeaderOption, UseListOptions } from './composables/list';
+export { useList } from './composables/list';
+export type { BTNavigation, ExternalParty, ExternalNavigation, NavigationItem, UseNavigationOptions } from './composables/navigation';
+export { createNavigation } from './composables/navigation';
+export type { BTPresets, CreatePresetsOptions } from './composables/presets';
+export { createPresets } from './composables/presets';
+export type { BTPWA, SWEvent } from './composables/pwa';
+export { createPWA } from './composables/pwa';
 export * from './composables/resizable';
-export * from './composables/rules';
-export * from './composables/stores';
-export * from './composables/track';
-export * from './composables/urls';
-export * from './useApi';
-export * from './core';
+export type { UseRulesOptions } from './composables/rules';
+export { useRules } from './composables/rules';
+export type { BTStore, StoreMode, StorageMode, LocalMeta, LocallyStoredItem, StoreGetAllReturn, StoreGetReturn, UseStoreOptions, CreateStoreBuilderOptions, CreateStoreOptions } from './composables/stores';
+export { createStoreBuilder, createStore, createWholeLastUpdateStore, createSessionStore } from './composables/stores';
+export type { UseTrackerOptions } from './composables/track';
+export { useTracker } from './composables/track';
+export { useUrl } from './composables/urls';
+export { useApi, useAuth, useCosmetics, useDates, useDemo, useFilters, useNavigation, usePresets, usePWA, useStore } from './useApi';
+export * from './types';
+export type { CoreApp, CreateCoreOptions } from './core';
+export { createCore } from './core';

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "bt-core-app",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "Core app tools for some basic features like navigation, authentication, server apis, and cosmetics",
   "homepage": "https://github.com/BlitzItTech/bt-core",
   "bugs": {
     "url": "https://github.com/BlitzItTech/bt-core/issues"
   },
   "type": "module",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "dev": "vite",
     "build": "vue-tsc && vite build",

package/src/composables/api.ts

@@ -58,7 +58,7 @@ type FindPath = (navName?: string) => string | undefined
 // type BuildQuery = (params: any) => string
 // type BuildUrl = (path: PathOptions) => string
 
-interface UseApiOptions {
+export interface UseApiOptions {
     auth?: BTAuth
     /**overrides the default */
     buildHeaders?: (path: PathOptions) => HeadersInit

package/src/composables/document-meta.ts

@@ -6,8 +6,12 @@ export interface UseDocumentMetaOptions {
     demo?: BTDemo
 }
 
+export interface BTDocumentMeta {
+    updateMeta: (to: RouteLocationNormalized) => void
+}
+
 /**routes with meta object */
-export function useDocumentMeta(options?: UseDocumentMetaOptions) {
+export function useDocumentMeta(options?: UseDocumentMetaOptions): BTDocumentMeta {
 
     function updateMeta(to: RouteLocationNormalized) {
         const nearestWithTitle = to.matched.slice().reverse().find(r => r.meta && r.meta.title);

package/src/composables/list.ts

@@ -9,6 +9,11 @@ import { useArrayDifference, useArrayUnique, watchArray, watchDebounced } from '
 import { useActions } from '@/composables/actions'
 import { StorageMode, StoreMode, useStore } from '../index'
 
+export interface RefreshOptions {
+    deepRefresh?: boolean,
+    resetSearch?: boolean
+}
+
 export interface TableColumn {
     align?: 'start' | 'end' | 'center'
     csv?: boolean,
@@ -412,11 +417,6 @@ export function useList(props: ListProps, emit?: ListEvents, options?: UseListOp
         }
     }
 
-    interface RefreshOptions {
-        deepRefresh?: boolean,
-        resetSearch?: boolean
-    }
-    
     async function refresh(options?: RefreshOptions) {
         showError.value = false
 

package/src/composables/navigation.ts

@@ -94,7 +94,7 @@ export interface BTNavigation {
     updateNavigationProperties: (navName?: string | NavigationItem) => void
 }
 
-interface UseNavigationOptions {
+export interface UseNavigationOptions {
     defaultCacheExpiryHours?: number
     navItems?: NavigationItem[]
 }

package/src/composables/rules.ts

@@ -1,6 +1,6 @@
 import { validEmail } from '@/composables/helpers'
 
-interface UseRulesOptions {
+export interface UseRulesOptions {
     forEmail?: boolean
     forPassword?: boolean
     otherRules?: any

package/src/composables/stores.ts

@@ -50,7 +50,7 @@ export interface ApiError {
     message: string
 }
 
-interface UseStoreOptions {
+export interface UseStoreOptions {
     /**ideally required. Otherwise will struggle to find url path */
     api?: BTApi
     /**ideally required. For setting unique local storage keys */

package/src/index.ts

@@ -1,16 +1,49 @@
-export * from './composables/actions-tracker'
-export * from './composables/actions'
-export * from './composables/demo'
-export * from './composables/document-meta'
+export { useActionsTracker } from './composables/actions-tracker'
+export type { BTActions, GetOptions, DeleteOptions, RestoreOptions, SaveOptions, ApiActionOptions, UseActionsOptions } from './composables/actions'
+export { useActions } from './composables/actions'
+export type { BTApi, UseApiOptions, PathOptions, QueryParams } from './composables/api'
+export { createApi } from './composables/api'
+export type { BTAuth, AuthItem, AuthSubscription, BaseAuthCredentials, CreateAuthOptions } from './composables/auth'
+export { createAuth } from './composables/auth'
+export type { BTCosmetics, BaseCosmeticTheme, UseCosmeticsOptions } from './composables/cosmetics'
+export { createCosmetics } from './composables/cosmetics'
+export * from './composables/csv'
+export type { BTDates, CreateDatesOptions } from './composables/dates'
+export { createDates } from './composables/dates'
+export type { BTDemo } from './composables/demo'
+export { createDemo } from './composables/demo'
+export * from './composables/dialogs'
+export type { BTDocumentMeta, UseDocumentMetaOptions } from './composables/document-meta'
+export { useDocumentMeta } from './composables/document-meta'
 export * from './composables/draggable'
-export * from './composables/forage'
+export type { BTFilters, UseFiltersOptions } from './composables/filters'
+export { createFilters } from './composables/filters'
+export { useLocalDb, useLocalCache } from './composables/forage'
 export * from './composables/helpers'
-export * from './composables/id'
-export * from './composables/list'
+export { useId } from './composables/id'
+export type { TableColumn, CustomFilterParam, ListEvents, ListProps, GroupedHeaderOption, UseListOptions } from './composables/list'
+export { useList } from './composables/list'
+export type { BTNavigation, ExternalParty, ExternalNavigation, NavigationItem, UseNavigationOptions } from './composables/navigation'
+export { createNavigation } from './composables/navigation'
+export type { BTPresets, CreatePresetsOptions } from './composables/presets'
+export { createPresets } from './composables/presets'
+export type { BTPWA, SWEvent } from './composables/pwa'
+export { createPWA } from './composables/pwa'
 export * from './composables/resizable'
-export * from './composables/rules'
-export * from './composables/stores'
-export * from './composables/track'
-export * from './composables/urls'
-export * from './useApi'
-export * from './core'
+export type { UseRulesOptions } from './composables/rules'
+export { useRules } from './composables/rules'
+export type { BTStore, StoreMode, StorageMode, LocalMeta, LocallyStoredItem, StoreGetAllReturn, StoreGetReturn, UseStoreOptions, CreateStoreBuilderOptions, CreateStoreOptions } from './composables/stores'
+export { createStoreBuilder, createStore, createWholeLastUpdateStore, createSessionStore } from './composables/stores'
+export type { UseTrackerOptions } from './composables/track'
+export { useTracker } from './composables/track'
+export { useUrl } from './composables/urls'
+export { useApi, useAuth, useCosmetics, useDates, useDemo, useFilters, useNavigation, usePresets, usePWA, useStore } from './useApi'
+export * from './types'
+export type { CoreApp, CreateCoreOptions } from './core'
+export { createCore } from './core'
+
+
+// import BTBtn from './components/BT-Btn.vue'
+// import BTCol from './components/BT-Col.vue'
+
+// export { BTBtn, BTCol }

package/vite.config.ts

@@ -15,11 +15,19 @@ export default defineConfig({
     lib: {
       entry: path.resolve(__dirname, './src/index.ts'),
       formats: ['es']
+    },
+    rollupOptions: {
+      external: ['vue', 'vuetify'],
+      output: {
+        globals: {
+          vue: 'Vue'
+        }
+      }
     }
   },
   plugins: [
     vue(),
-    dts({ include: ['src'] })
+    dts({ include: path.resolve(__dirname, './src/index.ts') })
   ],
   resolve: {
     alias: {

package/dist/components/BT-Span.vue.d.ts

@@ -1,17 +0,0 @@
-interface Props {
-    filter: string;
-    prefix?: string;
-    suffix?: string;
-    value: any;
-}
-declare const _default: import('vue').DefineComponent<__VLS_TypePropsToRuntimeProps<Props>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<Props>>>, {}, {}>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};

package/dist/components/Dialog-Confirm.vue.d.ts

@@ -1,38 +0,0 @@
-import { ConfirmDialogProps } from '../composables/dialogs';
-
-declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ConfirmDialogProps>, {
-    cancelValue: boolean;
-    confirmValue: boolean;
-    startIncludeDetails: boolean;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    cancel: (...args: any[]) => void;
-    confirm: (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ConfirmDialogProps>, {
-    cancelValue: boolean;
-    confirmValue: boolean;
-    startIncludeDetails: boolean;
-}>>> & {
-    onCancel?: ((...args: any[]) => any) | undefined;
-    onConfirm?: ((...args: any[]) => any) | undefined;
-}, {
-    cancelValue: any;
-    confirmValue: any;
-}, {}>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
-        default: D[K];
-    }> : P[K];
-};
-type __VLS_Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};

package/dist/components/Dialog-Select-Date.vue.d.ts

@@ -1,36 +0,0 @@
-import { SelectDateProps } from '../composables/dialogs';
-
-declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<SelectDateProps>, {
-    cancelValue: boolean;
-    height: string;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    cancel: (...args: any[]) => void;
-    confirm: (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<SelectDateProps>, {
-    cancelValue: boolean;
-    height: string;
-}>>> & {
-    onCancel?: ((...args: any[]) => any) | undefined;
-    onConfirm?: ((...args: any[]) => any) | undefined;
-}, {
-    height: string;
-    cancelValue: any;
-}, {}>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
-        default: D[K];
-    }> : P[K];
-};
-type __VLS_Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};

package/dist/components/Dialog-Select.vue.d.ts

@@ -1,48 +0,0 @@
-import { SelectDialogProps } from '../composables/dialogs';
-
-declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<SelectDialogProps>, {
-    cancelValue: boolean;
-    height: string;
-    showSearch: boolean;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    cancel: (...args: any[]) => void;
-    confirm: (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<SelectDialogProps>, {
-    cancelValue: boolean;
-    height: string;
-    showSearch: boolean;
-}>>> & {
-    onCancel?: ((...args: any[]) => any) | undefined;
-    onConfirm?: ((...args: any[]) => any) | undefined;
-}, {
-    height: string;
-    cancelValue: any;
-    showSearch: boolean;
-}, {}>, {
-    default?(_: {
-        item: any;
-    }): any;
-}>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
-        default: D[K];
-    }> : P[K];
-};
-type __VLS_Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};

package/dist/components/Dialog-Text.vue.d.ts

@@ -1,33 +0,0 @@
-import { TextDialogProps } from '../composables/dialogs';
-
-declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<TextDialogProps>, {
-    height: string;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    cancel: (...args: any[]) => void;
-    confirm: (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<TextDialogProps>, {
-    height: string;
-}>>> & {
-    onCancel?: ((...args: any[]) => any) | undefined;
-    onConfirm?: ((...args: any[]) => any) | undefined;
-}, {
-    height: string;
-}, {}>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
-        default: D[K];
-    }> : P[K];
-};
-type __VLS_Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};

package/dist/composables/actions-tracker.d.ts

@@ -1,19 +0,0 @@
-import { ShallowRef } from 'vue';
-
-export interface DoActionOptions {
-    completionMsg?: string;
-    confirmationMsg?: string;
-    errorMsg?: string;
-    loadingMsg?: string;
-    requireConfirmation?: boolean;
-    throwError?: boolean;
-}
-export declare function useActionsTracker(useOptions?: DoActionOptions): {
-    actionErrorMsg: ShallowRef<string | undefined>;
-    actionLoadingMsg: ShallowRef<string | undefined>;
-    actionCompleteMsg: ShallowRef<string | undefined>;
-    clearErrors: () => void;
-    doAction: (action: any, options?: DoActionOptions) => Promise<any>;
-    isLoading: import('vue').ComputedRef<boolean>;
-    logError: (err?: string | Error) => void;
-};

package/dist/composables/actions.d.ts

@@ -1,79 +0,0 @@
-import { ShallowRef, ComputedRef } from 'vue';
-import { DoActionOptions } from './actions-tracker';
-import { BTApi, PathOptions } from './api';
-import { BTStore } from './stores';
-import { BladeMode } from '../types';
-
-export type OnCanDoAsync = (item: any) => Promise<string | undefined>;
-export type OnDoAsync = (item: any) => Promise<string | undefined>;
-export type OnDoSuccessAsync = (item: any) => Promise<any>;
-export type OnGetAsync = (opt?: GetOptions) => Promise<any>;
-export type OnGetSuccessAsync = (item: any, opt?: GetOptions) => Promise<any>;
-export interface GetOptions extends PathOptions, DoActionOptions {
-    /**returns an error msg if failed */
-    onGetAsync?: OnGetAsync;
-    /**called after get occurs successfully */
-    onGetSuccessAsync?: OnGetSuccessAsync;
-    store?: BTStore;
-}
-export interface DeleteOptions extends PathOptions, DoActionOptions {
-    /**Returns a string if cannot */
-    onCanDeleteAsync?: OnCanDoAsync;
-    /**Will override the default store delete action */
-    onDeleteAsync?: OnDoAsync;
-    /**Will open a dialog box requesting user confirmation for delete action */
-    onDeleteSuccessAsync?: OnDoAsync;
-    store?: BTStore;
-}
-export interface RestoreOptions extends PathOptions, DoActionOptions {
-    /**Returns a string if cannot */
-    onCanRestoreAsync?: OnCanDoAsync;
-    /**Will override the default store delete action */
-    onRestoreAsync?: OnDoSuccessAsync;
-    /**Called after restore succeeds */
-    onRestoreSuccessAsync?: OnDoSuccessAsync;
-    store?: BTStore;
-}
-export interface SaveOptions extends PathOptions, DoActionOptions {
-    /**will seek to post if 'new' otherwise will patch */
-    mode?: BladeMode;
-    /**called to check whether to proceed with save */
-    onCanSaveAsync?: OnCanDoAsync;
-    /**
-     * retrieves item to save
-     * called before seeing whether it can save
-     */
-    onGetSaveAsync?: OnDoSuccessAsync;
-    /**Will override the default store post/patch action */
-    onSaveAsync?: OnDoSuccessAsync;
-    /**Called after save succeeds */
-    onSaveSuccessAsync?: OnDoSuccessAsync;
-    store?: BTStore;
-}
-export interface ApiActionOptions extends PathOptions, DoActionOptions {
-    api: BTApi;
-}
-export interface UseActionsOptions extends DoActionOptions {
-    nav?: string;
-    proxyID?: string;
-    refresh?: boolean;
-    store?: BTStore;
-    throwError?: boolean;
-    url?: string;
-}
-export interface BTActions {
-    apiGet: (doOptions: ApiActionOptions) => Promise<any>;
-    apiPost: (doOptions: ApiActionOptions) => Promise<any>;
-    actionLoadingMsg: ShallowRef<string | undefined>;
-    actionErrorMsg: ShallowRef<string | undefined>;
-    clearErrors: () => void;
-    deleteItem: (doOptions: DeleteOptions) => Promise<any>;
-    doAction: (action: any, options?: DoActionOptions) => Promise<any>;
-    getAllItems: (doOptions: GetOptions) => Promise<any>;
-    getItem: (doOptions: GetOptions) => Promise<any>;
-    isLoading: ComputedRef<boolean>;
-    logError: (err?: string | Error) => void;
-    restoreItem: (doOptions: RestoreOptions) => Promise<any>;
-    saveItem: (doOptions: SaveOptions) => Promise<any>;
-}
-export declare function useActions(options?: UseActionsOptions): BTActions;

package/dist/composables/api.d.ts

@@ -1,85 +0,0 @@
-import { BTAuth } from './auth';
-
-export interface QueryParams {
-    filterBy?: string;
-    includeCount?: boolean;
-    includeDetails?: boolean;
-    includeInactive?: boolean;
-    lastUpdate?: string;
-    other?: any;
-    properties?: string[] | string;
-    query?: string;
-    searchString?: string;
-    sortOrder?: string;
-    sortBy?: string;
-    takeFrom?: number;
-    takeAmount?: number;
-}
-export interface PathOptions {
-    /**always added to end before query {url}/{additionalUrl}?{query} */
-    additionalUrl?: string;
-    /**application/json or other options */
-    contentType?: string;
-    /**that data to send in the body for POST, PATCH, and DELETE requests */
-    data?: any;
-    /** resulting url after building {nav | url}/{additionalUrl}?{params} */
-    finalUrl?: string;
-    /**override default headers */
-    headers?: HeadersInit;
-    /**id will be added as a url paramter (/{id}?) rather than as a query parameter */
-    id?: string;
-    /**where to find the url */
-    nav?: string;
-    /**headers will not be calculated.  Only the given headers in these options will be used */
-    overrideHeaders?: boolean;
-    /**query parameters */
-    params?: QueryParams;
-    /**attaches a proxyID to the request */
-    proxyID?: string;
-    /**whether to refresh the store data and go straight to the server */
-    refresh?: boolean;
-    /**returns result as a json object.  Defaults to true. */
-    returnJson?: boolean;
-    /**returns result as a string */
-    returnText?: boolean;
-    /**If false, returns response no matter the status code */
-    throwError?: boolean;
-    /**if exists then overrides default nav */
-    url?: string;
-    /**whether to preference using the local cache */
-    useLocalCache?: boolean;
-}
-type FindPath = (navName?: string) => string | undefined;
-interface UseApiOptions {
-    auth?: BTAuth;
-    /**overrides the default */
-    buildHeaders?: (path: PathOptions) => HeadersInit;
-    /**build a query.  Overrides the default */
-    buildQuery?: (params: any) => string;
-    /**overrides the default */
-    buildUrl?: (path: PathOptions) => string;
-    /**defaults to 'application/json' */
-    defaultContentType?: string;
-    /**returns result as a json object.  Defaults to true. */
-    defaultReturnJson?: boolean;
-    /**returns result as a string */
-    defaultReturnText?: boolean;
-    /**defaults to true.  Will throw an error on fail */
-    defaultThrowError?: boolean;
-    /**defaults to a function that returns '' */
-    findPath?: FindPath;
-    /**if true and logged in then will set an authorization header with 'bearer [token]' */
-    useBearerToken?: boolean;
-}
-export interface BTApi {
-    buildHeaders: (options: PathOptions) => HeadersInit;
-    buildQuery: (params: any) => string;
-    buildUrl: (path: PathOptions) => string;
-    deleteItem: (pathOptions: PathOptions) => Promise<string | undefined>;
-    get: <T>(pathOptions: PathOptions) => Promise<T>;
-    getAll: <T>(pathOptions: PathOptions) => Promise<T>;
-    post: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
-    patch: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
-}
-export declare function createApi(options?: UseApiOptions): BTApi;
-export {};

package/dist/composables/auth.d.ts

@@ -1,58 +0,0 @@
-import { BTDemo } from './demo';
-import { RemovableRef } from '@vueuse/core';
-
-export interface AuthItem {
-    children?: AuthItem[];
-    ignoreSuspension?: boolean;
-    permissions?: string[];
-    requiresAuth?: boolean;
-    subscriptions?: string[];
-}
-export interface AuthSubscription {
-    code: string;
-    value: number;
-}
-export interface BaseAuthCredentials {
-    expiresOn?: string;
-    isGlobalAdmin?: boolean;
-    isLoggedIn?: boolean;
-    isSuspended?: boolean;
-    permissions?: string;
-    subscriptionCode?: string;
-    timeZone?: string;
-    token?: string;
-    userID?: string;
-    userPermissions?: string[];
-}
-export type GetAuthUrl = (redirectPath?: string, state?: string) => string;
-export interface CreateAuthOptions {
-    defaultTimeZone?: string;
-    demo?: BTDemo;
-    /**expiry token date format.  Defaults to 'd/MM/yyyy h:mm:ss a' */
-    expiryTokenFormat?: string;
-    /**retrieve the auth item */
-    getAuthItem: (navName?: string | AuthItem) => AuthItem | null;
-    /**retrieve the url to navigate to for the OAuth 2.0 process */
-    getAuthUrl: GetAuthUrl;
-    /**sets current credentials on top of default function*/
-    setCredentials?: (state: RemovableRef<any>, payload: any) => void;
-    /**suboptions */
-    subscriptionOptions?: AuthSubscription[];
-}
-export interface BTAuth {
-    authState: string;
-    canEdit: (navName?: string) => boolean;
-    canEditPermit: (permit: string) => boolean;
-    canView: (navName?: string) => boolean;
-    canViewPermit: (permit: string) => boolean;
-    credentials: any;
-    doShow: (subcodes?: string[], permissions?: string[], action?: 'view' | 'edit') => boolean;
-    doShowByNav: (navName?: string | AuthItem, includeChildren?: boolean) => boolean;
-    getAuthUrl: (redirectPath?: string) => string;
-    getTimeZone: () => string;
-    login: (redirectPath?: string) => void;
-    logout: (navNameRedirect?: string) => void;
-    setAuth: (jwtToken?: string) => void;
-    tryLogin: () => boolean | undefined;
-}
-export declare function createAuth(options: CreateAuthOptions): BTAuth;