bt-core-app 1.4.34 → 1.4.36

package/dist/index.d.ts

@@ -13,11 +13,14 @@ import { Store } from 'pinia';
 import { StoreDefinition } from 'pinia';
 import { ThemeInstance } from 'vuetify';
 
+export declare interface ActionOptions extends PathOptions, DoActionOptions {
+}
+
 /**adds and sorts the weekday string */
 export declare function addWeekday(weekdays?: string, day?: string): string | undefined;
 
-export declare interface ApiActionOptions extends PathOptions, DoActionOptions {
-    api: BTApi;
+declare interface ApiActionOptions extends PathOptions, DoActionOptions {
+    api?: BTApi;
 }
 
 export declare function appendUrl(originalVal?: string, additionalVal?: string): string;
@@ -75,8 +78,6 @@ export declare type BladeMode = 'new' | 'view' | 'edit';
 export declare type BladeVariant = 'page' | 'blade' | 'freestyle' | 'inline' | 'pane';
 
 export declare interface BTActions {
-    apiGet: (doOptions: ApiActionOptions) => Promise<any>;
-    apiPost: (doOptions: ApiActionOptions) => Promise<any>;
     actionLoadingMsg: ShallowRef<string | undefined>;
     actionErrorMsg: ShallowRef<string | undefined>;
     clearErrors: () => void;
@@ -95,27 +96,40 @@ export declare interface BTApi {
     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>;
+    get: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
+    getAll: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
     post: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
     patch: <T>(pathOptions: PathOptions) => Promise<T | undefined>;
 }
 
+export declare interface BTApiActions {
+    apiGet: (doOptions: ApiActionOptions) => Promise<any>;
+    apiPost: (doOptions: ApiActionOptions) => Promise<any>;
+    actionLoadingMsg: ShallowRef<string | undefined>;
+    actionErrorMsg: ShallowRef<string | undefined>;
+    clearErrors: () => void;
+    doAction: (action: any, options?: DoActionOptions) => Promise<any>;
+    isLoading: ComputedRef<boolean>;
+    logError: (err?: string | Error) => void;
+}
+
 export declare interface BTAuth {
-    authState: string;
+    authState: Ref<string>;
+    /**Global Admin, everything.edit, *.edit */
     canEdit: (navName?: string) => boolean;
     canEditPermit: (permit: string) => boolean;
+    /**Global Admin, everything.view, *.view */
     canView: (navName?: string) => boolean;
     canViewPermit: (permit: string) => boolean;
     credentials: RemovableRef<any>;
     doShow: (subcodes?: string[], permissions?: string[], action?: 'view' | 'edit') => boolean;
     doShowByNav: (navName?: string | AuthItem, includeChildren?: boolean) => boolean;
     getAuthorizeUrl: (redirectPath?: string) => string;
-    getTimeZone: () => string;
     getToken: (code?: string, state?: string) => Promise<void>;
     isLoggedIn: ComputedRef<boolean>;
     login: (redirectPath?: string) => void;
     logout: (navNameRedirect?: string) => void;
+    resetAuthState: () => void;
     setAuth: (jwtToken?: string) => void;
     timeZone: ComputedRef<string>;
     tryLogin: () => boolean | undefined;
@@ -132,8 +146,11 @@ export declare interface BTCosmetics {
 }
 
 export declare interface BTDates {
+    /**returns start of day */
     getToday: () => string;
+    /**returns start of tomorrow */
     getTomorrow: () => string;
+    /**returns current datetime in tz format */
     tzDate: (val?: string, fromFormat?: string) => DateTime;
     tzString: (val?: string, format?: string, fromFormat?: string) => string;
     utcDate: (val?: string, fromFormat?: string) => DateTime;
@@ -144,6 +161,12 @@ export declare interface BTDemo {
     endDemo: () => void;
     isDemoing: Ref<boolean>;
     startDemo: () => void;
+    data: DemoApiGroup[];
+    deleteItem: (pathOptions: PathOptions) => Promise<string | undefined>;
+    get: (pathOptions: PathOptions) => Promise<any>;
+    getAll: (pathOptions: PathOptions) => Promise<any>;
+    post: (pathOptions: PathOptions) => Promise<any>;
+    patch: (pathOptions: PathOptions) => Promise<any>;
 }
 
 export declare interface BTDocumentMeta {
@@ -165,7 +188,7 @@ export declare interface BTNavigation {
     findDisplay: (navName?: string | NavigationItem) => string | undefined;
     findIcon: (navName?: string | NavigationItem) => string | undefined;
     findItem: (navName?: string | NavigationItem) => NavigationItem | null;
-    findStoreName: (navName?: string | NavigationItem) => string;
+    findStoreName: (navName?: string | NavigationItem) => string | undefined;
     findPath: (navName?: string | NavigationItem) => string | undefined;
     findSingleDisplay: (navName?: string | NavigationItem) => string | undefined;
     updateNavigationProperties: (navName?: string | NavigationItem) => void;
@@ -278,9 +301,14 @@ export declare function createDates(options: CreateDatesOptions): BTDates;
 
 export declare interface CreateDatesOptions {
     getTimeZone: () => string;
+    getUTC?: () => DateTime;
 }
 
-export declare function createDemo(): BTDemo;
+export declare function createDemo(options?: CreateDemoOptions): BTDemo;
+
+declare interface CreateDemoOptions {
+    apis?: DemoApiGroup[];
+}
 
 export declare function createFilters(options: UseFiltersOptions): BTFilters;
 
@@ -367,6 +395,16 @@ export declare interface DeleteOptions extends PathOptions, DoActionOptions {
     store?: BTStoreDefinition;
 }
 
+declare interface DemoApiGroup {
+    nav?: string | string[];
+    path?: string;
+    data?: any[];
+    getAllAction?: (list: any[], params: any) => any[];
+    getAction?: (list: any[], id?: string) => any;
+    patchAction?: (list: any[], item: any) => any;
+    postAction?: (list: any[], item: any) => any;
+}
+
 export declare function distinct(list: any): any;
 
 declare interface DoActionOptions {
@@ -378,6 +416,13 @@ declare interface DoActionOptions {
     throwError?: boolean;
 }
 
+export declare interface ExportToCSVOptions {
+    items: any[];
+    headers?: TableColumn[];
+    fileName?: string;
+    format: 'array' | 'file';
+}
+
 export declare function extensionExists(elementId?: string): boolean;
 
 export declare interface ExternalNavigation {
@@ -493,33 +538,22 @@ export declare interface ListEvents {
 export declare interface ListProps {
     additionalUrl?: string;
     bladeName?: string;
-    canAdd?: boolean;
-    canDelete?: boolean;
-    canEdit?: boolean;
-    canRestore?: boolean;
-    canShowInactive?: boolean;
     canSelect?: boolean;
     canUnselect?: boolean;
     confirmOnDelete?: boolean;
     customFilters?: CustomFilterParam[];
     defaultFilters?: string[];
-    dividers?: boolean;
     eager?: boolean;
     errorMsg?: string;
     headers?: TableColumn[];
     hideActions?: boolean;
-    hideColumns?: boolean;
-    hideFilters?: boolean;
-    hideRefresh?: boolean;
-    hideSubtoolbarSettings?: boolean;
-    includeDetails?: boolean;
     isSingle?: boolean;
     itemBladeName?: string;
     itemID?: string;
     items?: any[];
+    /**only used with server pagination */
     itemsPerPage?: number;
     itemText?: string;
-    lines?: 'one' | 'two' | 'three';
     loadingMsg?: string;
     localOnly?: boolean;
     nav?: string;
@@ -527,10 +561,8 @@ export declare interface ListProps {
     onCanDelete?: (item: any) => boolean;
     /**when trying to delete in api */
     onCanDeleteAsync?: OnCanDoAsync;
-    onGetSaveAsync?: OnDoSuccessAsync;
     onCanRestore?: (item: any) => boolean;
     onCanRestoreAsync?: OnCanDoAsync;
-    onCanSaveAsync?: OnCanDoAsync;
     onCanSelectItem?: (item: any) => boolean;
     onDeleteAsync?: OnDoAsync;
     onDeleteSuccessAsync?: OnDoAsync;
@@ -539,8 +571,6 @@ export declare interface ListProps {
     onGetSuccessAsync?: OnGetSuccessAsync;
     onRestoreAsync?: OnDoSuccessAsync;
     onRestoreSuccessAsync?: OnDoSuccessAsync;
-    onSaveAsync?: OnDoSuccessAsync;
-    onSaveSuccessAsync?: OnDoSuccessAsync;
     onSelectItem?: (item: any) => void;
     params?: any;
     proxyID?: string;
@@ -551,8 +581,6 @@ export declare interface ListProps {
     selectProps?: string[];
     sortBy?: string;
     sortOrder?: 'Ascending' | 'Descending';
-    showListOnly?: boolean;
-    showTableOnly?: boolean;
     showSearch?: boolean;
     startShowingInactive?: boolean;
     storeMode?: StoreMode;
@@ -857,6 +885,7 @@ export declare interface TableColumn {
     csvArray?: boolean;
     csvFilter?: string;
     csvText?: string;
+    display?: boolean;
     hide?: boolean;
     itemText?: string;
     level?: number;
@@ -903,6 +932,8 @@ export declare interface UseActionsOptions extends DoActionOptions {
     store?: BTStoreDefinition;
     throwError?: boolean;
     url?: string;
+    /**for basic functionality when no store is provided */
+    items?: any[];
 }
 
 export declare function useActionsTracker(useOptions?: DoActionOptions): {
@@ -917,6 +948,16 @@ export declare function useActionsTracker(useOptions?: DoActionOptions): {
 
 export declare function useApi(): BTApi;
 
+export declare function useApiActions(options: UseApiActionsOptions): BTApiActions;
+
+export declare interface UseApiActionsOptions extends DoActionOptions {
+    nav?: string;
+    proxyID?: string;
+    throwError?: boolean;
+    url?: string;
+    api: BTApi;
+}
+
 export declare interface UseApiOptions {
     auth?: BTAuth;
     /**overrides the default */
@@ -933,6 +974,8 @@ export declare interface UseApiOptions {
     defaultReturnText?: boolean;
     /**defaults to true.  Will throw an error on fail */
     defaultThrowError?: boolean;
+    /**demo for providing any demo data */
+    demo?: BTDemo;
     /**defaults to a function that returns '' */
     findPath?: FindPath;
     /**if true and logged in then will set an authorization header with 'bearer [token]' */
@@ -1056,19 +1099,14 @@ export declare function useList(props: ListProps, emit?: ListEvents, options?: U
     asyncItems: Ref<any[]>;
     currentPage: Ref<number>;
     deleteItem: (dItem: MaybeRefOrGetter<any>) => void;
-    displayHeaders: ComputedRef<never[]>;
-    errorMsg: ComputedRef<string | undefined>;
-    exportToCSV: () => void;
-    filteredItems: ShallowRef<any[]>;
-    filters: ComputedRef<string[]>;
-    filtersChanged: ComputedRef<boolean>;
-    headerOptions: Ref<    {
+    displayHeaders: ComputedRef<    {
     align?: "start" | "end" | "center" | undefined;
     bool?: number | undefined;
     csv?: boolean | undefined;
     csvArray?: boolean | undefined;
     csvFilter?: string | undefined;
     csvText?: string | undefined;
+    display?: boolean | undefined;
     hide?: boolean | undefined;
     itemText?: string | undefined;
     level?: number | undefined;
@@ -1085,28 +1123,19 @@ export declare function useList(props: ListProps, emit?: ListEvents, options?: U
     title?: string | undefined;
     value?: string | undefined;
     }[]>;
-    isDeletable: ComputedRef<(item: any) => boolean>;
-    isLoading: ComputedRef<boolean>;
-    isRestorable: ComputedRef<(item: any) => boolean>;
-    loadingMsg: ComputedRef<string | undefined>;
-    refresh: (options?: RefreshOptions) => Promise<void>;
-    restoreItem: (dItem: MaybeRefOrGetter<any>) => void;
-    searchString: Ref<string | undefined>;
-    selectedFilters: Ref<number[]>;
-    selectItem: (rItem: any, variant: BladeVariant) => void;
-    serverFilters: Ref<string[]>;
-    showError: ShallowRef<boolean>;
-    showInactive: Ref<boolean>;
-    showSearch: ShallowRef<boolean>;
-    sortOrder: Ref<"Ascending" | "Descending" | undefined>;
-    subtitleOptions: ComputedRef<GroupedHeaderOption[]>;
-    tableHeaders: ComputedRef<    {
+    errorMsg: ComputedRef<string | undefined>;
+    exportToCSV: () => void;
+    filteredItems: ShallowRef<any[]>;
+    filters: ComputedRef<string[]>;
+    filtersChanged: ComputedRef<boolean>;
+    headerOptions: Ref<    {
     align?: "start" | "end" | "center" | undefined;
     bool?: number | undefined;
     csv?: boolean | undefined;
     csvArray?: boolean | undefined;
     csvFilter?: string | undefined;
     csvText?: string | undefined;
+    display?: boolean | undefined;
     hide?: boolean | undefined;
     itemText?: string | undefined;
     level?: number | undefined;
@@ -1123,6 +1152,20 @@ export declare function useList(props: ListProps, emit?: ListEvents, options?: U
     title?: string | undefined;
     value?: string | undefined;
     }[]>;
+    isDeletable: ComputedRef<(item: any) => boolean>;
+    isLoading: ComputedRef<boolean>;
+    isRestorable: ComputedRef<(item: any) => boolean>;
+    loadingMsg: ComputedRef<string | undefined>;
+    refresh: (options?: RefreshOptions) => Promise<void>;
+    restoreItem: (dItem: MaybeRefOrGetter<any>) => void;
+    searchString: Ref<string | undefined>;
+    selectedFilters: Ref<number[]>;
+    selectItem: (rItem: any, variant: BladeVariant) => void;
+    showError: ShallowRef<boolean>;
+    showInactive: Ref<boolean>;
+    showSearch: ShallowRef<boolean>;
+    sortOrder: Ref<"Ascending" | "Descending" | undefined>;
+    subtitleOptions: ComputedRef<GroupedHeaderOption[]>;
     titleOptions: ComputedRef<GroupedHeaderOption[]>;
     toggleSearch: () => void;
     totalPages: Ref<number>;
@@ -1216,7 +1259,7 @@ declare interface UseSessionStoreOptions {
     /**overrides the default */
     buildUrl?: (path: PathOptions) => string;
     /**the name of this store */
-    storeName?: string;
+    storeName: string;
 }
 
 export declare function useStore(options: CreateStoreOptions): BTStore;
@@ -1264,7 +1307,7 @@ declare interface UseWholeLastUpdateStoreOptions {
     /**ideally required. For setting unique local storage keys */
     auth?: BTAuth;
     storageMode?: 'session' | 'local-cache';
-    storeName?: string;
+    storeName: string;
 }
 
 export declare function validEmail(email?: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-core-app",
-  "version": "1.4.34",
+  "version": "1.4.36",
   "description": "Core app tools for some basic features like navigation, authentication, server apis, and cosmetics",
   "homepage": "https://github.com/BlitzItTech/bt-core",
   "bugs": {