bt-core-app 1.1.4 → 1.1.7

package/dist/composables/actions.d.ts

@@ -1,7 +1,7 @@
 import { ShallowRef, ComputedRef } from 'vue';
-import { DoActionOptions } from './actions-tracker';
-import { BTApi, PathOptions } from './api';
-import { BTStore } from './stores';
+import { DoActionOptions } from '../composables/actions-tracker';
+import { BTApi, PathOptions } from '../composables/api';
+import { BTStore } from '../composables/stores';
 import { BladeMode } from '../types';
 
 export type OnCanDoAsync = (item: any) => Promise<string | undefined>;

package/dist/composables/api.d.ts

@@ -50,7 +50,7 @@ export interface PathOptions {
     useLocalCache?: boolean;
 }
 type FindPath = (navName?: string) => string | undefined;
-interface UseApiOptions {
+export interface UseApiOptions {
     auth?: BTAuth;
     /**overrides the default */
     buildHeaders?: (path: PathOptions) => HeadersInit;

package/dist/composables/auth.d.ts

@@ -1,4 +1,4 @@
-import { BTDemo } from './demo';
+import { BTDemo } from '../composables/demo';
 import { RemovableRef } from '@vueuse/core';
 
 export interface AuthItem {

package/dist/composables/dialogs.d.ts

@@ -1,4 +1,4 @@
-import { ListProps } from './list';
+import { ListProps } from '../composables/list';
 
 export interface ConfirmDialogProps {
     cancelText?: string;

package/dist/composables/document-meta.d.ts

@@ -1,10 +1,11 @@
-import { BTDemo } from './demo';
+import { BTDemo } from '../composables/demo';
 import { RouteLocationNormalized } from 'vue-router';
 
 export interface UseDocumentMetaOptions {
     demo?: BTDemo;
 }
-/**routes with meta object */
-export declare function useDocumentMeta(options?: UseDocumentMetaOptions): {
+export interface BTDocumentMeta {
     updateMeta: (to: RouteLocationNormalized) => void;
-};
+}
+/**routes with meta object */
+export declare function useDocumentMeta(options?: UseDocumentMetaOptions): BTDocumentMeta;

package/dist/composables/list.d.ts

@@ -0,0 +1,202 @@
+import { StorageMode, StoreMode } from '../index';
+import { MaybeRefOrGetter } from 'vue';
+import { BladeVariant } from '../types';
+import { OnCanDoAsync, OnDoAsync, OnDoSuccessAsync, OnGetAsync, OnGetSuccessAsync } from './actions';
+
+export interface RefreshOptions {
+    deepRefresh?: boolean;
+    resetSearch?: boolean;
+}
+export interface TableColumn {
+    align?: 'start' | 'end' | 'center';
+    csv?: boolean;
+    csvArray?: boolean;
+    csvFilter?: string;
+    csvText?: string;
+    hide?: boolean;
+    itemText?: string;
+    level?: number;
+    maxWidth?: string;
+    minWidth?: string;
+    prefix?: string;
+    searchable?: boolean;
+    sublevel?: number;
+    suffix?: string;
+    textFilter?: string;
+    textFunction?: Function;
+    title?: string;
+    value?: string;
+}
+export interface CustomFilterParam {
+    name: string;
+    filterFunction: () => string;
+    onFilterResult: Function | null;
+}
+export interface ListEvents {
+    (e: 'change', item: any): void;
+    (e: 'deleted', item: any): void;
+    (e: 'input', item: any): void;
+    (e: 'select', item: any): void;
+    (e: 'mouse-over-item', item: any): void;
+}
+export 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[];
+    itemsPerPage?: number;
+    itemText?: string;
+    lines?: 'one' | 'two' | 'three';
+    loadingMsg?: string;
+    localOnly?: boolean;
+    nav?: string;
+    /**for defining if deletable (show button or not) */
+    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;
+    onFilter?: Function;
+    onGetAsync?: OnGetAsync;
+    onGetSuccessAsync?: OnGetSuccessAsync;
+    onRestoreAsync?: OnDoSuccessAsync;
+    onRestoreSuccessAsync?: OnDoSuccessAsync;
+    onSaveAsync?: OnDoSuccessAsync;
+    onSaveSuccessAsync?: OnDoSuccessAsync;
+    onSelectItem?: (item: any) => void;
+    params?: any;
+    proxyID?: string;
+    proxyQueryKey?: string;
+    refreshToggle?: boolean;
+    searchProps?: string[];
+    searchQueryKey?: string;
+    selectProps?: string[];
+    sortBy?: string;
+    sortOrder?: 'Ascending' | 'Descending';
+    showListOnly?: boolean;
+    showTableOnly?: boolean;
+    showSearch?: boolean;
+    startShowingInactive?: boolean;
+    storeMode?: StoreMode;
+    storageMode?: StorageMode;
+    useInterEvents?: boolean;
+    useServerPagination?: boolean;
+    useBladeSrc?: boolean;
+    useRouteSrc?: boolean;
+    variant?: BladeVariant;
+}
+export interface GroupedHeaderOption {
+    position: number;
+    values: TableColumn[];
+}
+export interface UseListOptions {
+    storeMode?: StoreMode;
+    storageMode?: StorageMode;
+    useBladeSrc?: boolean;
+    useRouteSrc?: boolean;
+}
+/**
+ * PROPS first
+ * ROUTE second
+ * BLADE third
+ * @param props
+ * @param emit
+ * @param options
+ */
+export declare function useList(props: ListProps, emit?: ListEvents, options?: UseListOptions): {
+    add: (variant: BladeVariant) => void;
+    asyncItems: import('vue').Ref<any[]>;
+    currentPage: import('vue').Ref<number>;
+    deleteItem: (dItem: MaybeRefOrGetter<any>) => void;
+    displayHeaders: import('vue').ComputedRef<never[]>;
+    errorMsg: import('vue').ComputedRef<string | undefined>;
+    exportToCSV: () => void;
+    filteredItems: import('vue').ShallowRef<any[]>;
+    filters: import('vue').ComputedRef<string[]>;
+    filtersChanged: import('vue').ComputedRef<boolean>;
+    headerOptions: import('vue').Ref<{
+        align?: "center" | "start" | "end" | undefined;
+        csv?: boolean | undefined;
+        csvArray?: boolean | undefined;
+        csvFilter?: string | undefined;
+        csvText?: string | undefined;
+        hide?: boolean | undefined;
+        itemText?: string | undefined;
+        level?: number | undefined;
+        maxWidth?: string | undefined;
+        minWidth?: string | undefined;
+        prefix?: string | undefined;
+        searchable?: boolean | undefined;
+        sublevel?: number | undefined;
+        suffix?: string | undefined;
+        textFilter?: string | undefined;
+        textFunction?: Function | undefined;
+        title?: string | undefined;
+        value?: string | undefined;
+    }[]>;
+    isDeletable: import('vue').ComputedRef<(item: any) => boolean>;
+    isLoading: import('vue').ComputedRef<boolean>;
+    isRestorable: import('vue').ComputedRef<(item: any) => boolean>;
+    loadingMsg: import('vue').ComputedRef<string | undefined>;
+    refresh: (options?: RefreshOptions) => Promise<void>;
+    restoreItem: (dItem: MaybeRefOrGetter<any>) => void;
+    searchString: import('vue').Ref<string | undefined>;
+    selectedFilters: import('vue').Ref<number[]>;
+    selectItem: (rItem: any, variant: BladeVariant) => void;
+    serverFilters: import('vue').Ref<string[]>;
+    showError: import('vue').ShallowRef<boolean>;
+    showInactive: import('vue').Ref<boolean>;
+    showSearch: import('vue').ShallowRef<boolean>;
+    sortOrder: import('vue').Ref<"Ascending" | "Descending" | undefined>;
+    subtitleOptions: import('vue').ComputedRef<GroupedHeaderOption[]>;
+    tableHeaders: import('vue').ComputedRef<{
+        align?: "center" | "start" | "end" | undefined;
+        csv?: boolean | undefined;
+        csvArray?: boolean | undefined;
+        csvFilter?: string | undefined;
+        csvText?: string | undefined;
+        hide?: boolean | undefined;
+        itemText?: string | undefined;
+        level?: number | undefined;
+        maxWidth?: string | undefined;
+        minWidth?: string | undefined;
+        prefix?: string | undefined;
+        searchable?: boolean | undefined;
+        sublevel?: number | undefined;
+        suffix?: string | undefined;
+        textFilter?: string | undefined;
+        textFunction?: Function | undefined;
+        title?: string | undefined;
+        value?: string | undefined;
+    }[]>;
+    titleOptions: import('vue').ComputedRef<GroupedHeaderOption[]>;
+    toggleSearch: () => void;
+    totalPages: import('vue').Ref<number>;
+};

package/dist/composables/navigation.d.ts

@@ -81,9 +81,8 @@ export interface BTNavigation {
     findSingleDisplay: (navName?: string) => string | undefined;
     updateNavigationProperties: (navName?: string | NavigationItem) => void;
 }
-interface UseNavigationOptions {
+export interface UseNavigationOptions {
     defaultCacheExpiryHours?: number;
     navItems?: NavigationItem[];
 }
 export declare function createNavigation(options: UseNavigationOptions): BTNavigation;
-export {};

package/dist/composables/rules.d.ts

@@ -1,8 +1,7 @@
-interface UseRulesOptions {
+export interface UseRulesOptions {
     forEmail?: boolean;
     forPassword?: boolean;
     otherRules?: any;
     required?: boolean;
 }
 export declare function useRules(options?: UseRulesOptions): any[];
-export {};

package/dist/composables/stores.d.ts

@@ -1,6 +1,6 @@
 import { BTAuth } from './auth';
 import { BaseModel } from '../types';
-import { PathOptions, BTApi } from './api';
+import { PathOptions, BTApi } from '../composables/api';
 import { StoreDefinition } from 'pinia';
 
 export type StoreMode = 'whole-last-updated' | 'partial-last-updated' | 'session';
@@ -37,7 +37,7 @@ export interface BTStore extends StoreDefinition<any, {}, {}, {
 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/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.7",
   "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/actions-tracker.ts

@@ -1,8 +1,8 @@
 import { computed, ref, shallowRef } from 'vue'
 import type { ShallowRef, Ref } from 'vue'
-import { useConfirmAsync } from '@/composables/dialogs'
+import { useConfirmAsync } from '../composables/dialogs'
 import { watchArray } from '@vueuse/core'
-import { useId } from '@/composables/id'
+import { useId } from '../composables/id'
 
 interface LoadingMsg {
     id: string,

package/src/composables/actions.ts

@@ -1,7 +1,7 @@
-import type { BladeMode } from '@/types'
-import { BTStore } from '@/composables/stores'
-import { BTApi, type PathOptions } from '@/composables/api'
-import { useActionsTracker, type DoActionOptions } from '@/composables/actions-tracker'
+import type { BladeMode } from '../types'
+import { BTStore } from '../composables/stores'
+import { BTApi, type PathOptions } from '../composables/api'
+import { useActionsTracker, type DoActionOptions } from '../composables/actions-tracker'
 import { ShallowRef, ComputedRef } from 'vue'
 
 export type OnCanDoAsync = (item: any) => Promise<string | undefined>

package/src/composables/api.ts

@@ -1,5 +1,5 @@
 import { toValue } from 'vue'
-import { appendUrl } from '@/composables/helpers'
+import { appendUrl } from '../composables/helpers'
 import { type BTAuth } from './auth'
 
 export interface QueryParams {
@@ -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/auth.ts

@@ -1,7 +1,7 @@
-import { isLengthyArray } from '@/composables/helpers';
+import { isLengthyArray } from '../composables/helpers';
 import { DateTime } from 'luxon'
 import { type RemovableRef, useStorage } from '@vueuse/core'
-import { type BTDemo } from '@/composables/demo'
+import { type BTDemo } from '../composables/demo'
 import { useRouter } from 'vue-router'
 import { toValue } from 'vue'
 

package/src/composables/dates.ts

@@ -1,5 +1,4 @@
 import { DateTime } from 'luxon'
-// import { useTimeZone } from '@/composables/auth'
 
 export interface BTDates {
     getToday: () => string

package/src/composables/dialogs.ts

@@ -1,10 +1,10 @@
 // import { openDialog } from 'vue3-promise-dialog'
 import { createConfirmDialog } from 'vuejs-confirm-dialog'
-import BTConfirmDialog from '@/components/Dialog-Confirm.vue'
-import BTSelectDateDialog from '@/components/Dialog-Select-Date.vue'
-import BTSelectDialog from '@/components/Dialog-Select.vue'
-import BTTextDialog from '@/components/Dialog-Text.vue'
-import { type ListProps } from '@/composables/list'
+import BTConfirmDialog from '../components/Dialog-Confirm.vue'
+import BTSelectDateDialog from '../components/Dialog-Select-Date.vue'
+import BTSelectDialog from '../components/Dialog-Select.vue'
+import BTTextDialog from '../components/Dialog-Text.vue'
+import { type ListProps } from '../composables/list'
 
 export interface ConfirmDialogProps {
     cancelText?: string

package/src/composables/document-meta.ts

@@ -1,13 +1,17 @@
 import { type RouteLocationNormalized } from 'vue-router'
-import { BTDemo } from '@/composables/demo'
-import { type Environment } from '@/composables/urls'
+import { BTDemo } from '../composables/demo'
+import { type Environment } from '../composables/urls'
 
 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/filters.ts

@@ -1,4 +1,4 @@
-import { getLocationLine, isMinDate } from '@/composables/helpers';
+import { getLocationLine, isMinDate } from '../composables/helpers';
 import { BTDates } from './dates';
 
 export interface BTFilters {

package/src/composables/forage.ts

@@ -1,5 +1,5 @@
 import localforage from 'localforage';
-import { useUrl } from '@/composables/urls';
+import { useUrl } from '../composables/urls';
 
 let localDb: LocalForage | null = null;
 

package/src/composables/list.ts

@@ -1,14 +1,19 @@
 import type { GetOptions, OnCanDoAsync, OnDoAsync, OnDoSuccessAsync, OnGetAsync, OnGetSuccessAsync } from './actions'
-import type { BladeVariant } from '@/types'
-import { useCSV } from '@/composables/csv'
+import type { BladeVariant } from '../types'
+import { useCSV } from '../composables/csv'
 import { isLengthyArray, hasSearch } from '../index'
 import { firstBy } from 'thenby'
 import { computed, ref, onMounted, toValue, shallowRef, MaybeRefOrGetter, watch } from 'vue'
 import { useRoute, useRouter } from 'vue-router'
 import { useArrayDifference, useArrayUnique, watchArray, watchDebounced } from '@vueuse/core'
-import { useActions } from '@/composables/actions'
+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

@@ -1,6 +1,6 @@
 //nav item needs to have a 'ignore Suspension' prop
-import { useUrl } from '@/composables/urls'
-import { appendUrl, deepSelect } from '@/composables/helpers'
+import { useUrl } from '../composables/urls'
+import { appendUrl, deepSelect } from '../composables/helpers'
 import { ref, type Ref } from 'vue'
 import { type AuthItem } from './auth'
 
@@ -94,7 +94,7 @@ export interface BTNavigation {
     updateNavigationProperties: (navName?: string | NavigationItem) => void
 }
 
-interface UseNavigationOptions {
+export interface UseNavigationOptions {
     defaultCacheExpiryHours?: number
     navItems?: NavigationItem[]
 }

package/src/composables/resizable.ts

@@ -1,8 +1,8 @@
 import { toValue, useEventListener, useParentElement } from "@vueuse/core"
 import { type ComponentPublicInstance, type Ref, ref } from 'vue'
 import type { Position, MaybeRefOrGetter } from "@vueuse/core"
-import { copyDeep } from "@/composables/helpers"
-import { type BladeVariant } from "@/types"
+import { copyDeep } from "../composables/helpers"
+import { type BladeVariant } from "../types"
 
 export type ResizeHandle = 't' | 'r' | 'b' | 'l' | 'tr' | 'br' | 'bl' | 'tl'
 

package/src/composables/rules.ts

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

package/src/composables/stores.ts

@@ -1,12 +1,12 @@
 import { defineStore, StoreDefinition } from 'pinia'
 import { ref, type Ref } from 'vue'
-import { type PathOptions, type BTApi } from '@/composables/api'
+import { type PathOptions, type BTApi } from '../composables/api'
 import { DateTime } from 'luxon'
 import { toValue } from 'vue'
-import { appendUrl, getMinDateString } from '@/composables/helpers'
+import { appendUrl, getMinDateString } from '../composables/helpers'
 import { firstBy } from 'thenby'
-import { useLocalDb } from '@/composables/forage'
-import { BaseModel } from '@/types'
+import { useLocalDb } from '../composables/forage'
+import { BaseModel } from '../types'
 import { BTAuth } from './auth'
 
 export type StoreMode = 'whole-last-updated' | 'partial-last-updated' | 'session'
@@ -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 */