bt-core-app 2.1.37 → 2.2.0

package/dist/composables/stores.d.ts

@@ -0,0 +1,258 @@
+import { BTDates } from './dates.ts';
+import { BTDemo } from './demo.ts';
+import { BTNavigation } from './navigation.ts';
+import { BTAuth } from './auth.ts';
+import { PathOptions, BTApi } from './api.ts';
+import { Store, StoreDefinition } from 'pinia';
+
+export type StoreMode = 'whole-last-updated' | 'partial-last-updated' | 'session' | 'whole-store';
+export type StorageMode = 'session' | 'local-cache';
+export interface LocalMeta {
+    storedOn: string;
+    isDetailed?: boolean;
+    lastUpdate?: string;
+}
+export interface LocallyStoredItem {
+    meta: LocalMeta;
+    data: any;
+    count?: number;
+    filters?: string[];
+}
+export interface StoreGetAllReturn<T> {
+    data: T[];
+    count?: number;
+    filters?: string[];
+}
+export interface StoreGetReturn<T> {
+    data: T;
+}
+export interface GetStorageKeyOptions {
+    credentials?: any;
+    itemID?: string;
+    proxyID?: string;
+    start: string;
+    storeName?: string;
+    userID?: string;
+}
+export interface StorePathOptions extends PathOptions {
+    /**will store this request in session as a special memory in the pinia store */
+    getStorageKey?: (dOptions: GetStorageKeyOptions) => string;
+    localOnly?: boolean;
+    localPredicate?: (item: any) => boolean;
+    /**PLU Only */
+    dateFrom?: string;
+    /**PLU Only */
+    dateTo?: string;
+}
+export interface BTBlobStoreDefinition extends StoreDefinition<any, {}, {}, {
+    getBlob: (dOptions: StorePathOptions) => Promise<Blob | undefined>;
+}> {
+}
+export interface BTBlobStore extends Store<any, {}, {}, {
+    getBlob: (dOptions: StorePathOptions) => Promise<Blob | undefined>;
+}> {
+}
+export interface BTStoreDefinition extends StoreDefinition<any, {}, {}, {
+    $reset: () => void;
+    deleteItem: <T>(dOptions: StorePathOptions) => Promise<T | undefined>;
+    get: <T>(dOptions: StorePathOptions) => Promise<StoreGetReturn<T>>;
+    getAll: <T>(dOptions: StorePathOptions) => Promise<StoreGetAllReturn<T>>;
+    patch: <T>(dOptions: StorePathOptions) => Promise<T | undefined>;
+    post: <T>(dOptions: StorePathOptions) => Promise<T | undefined>;
+    restore: <T>(dOptions: StorePathOptions) => Promise<T | undefined>;
+}> {
+}
+export interface BTStore extends Store<any, {}, {}, {
+    $reset: () => void;
+    deleteItem: <T>(dOptions: StorePathOptions) => Promise<T | undefined>;
+    get: <T>(dOptions: StorePathOptions) => Promise<StoreGetReturn<T>>;
+    getAll: <T>(dOptions: StorePathOptions) => Promise<StoreGetAllReturn<T>>;
+    patch: <T>(dOptions: StorePathOptions) => Promise<T | undefined>;
+    post: <T>(dOptions: StorePathOptions) => Promise<T | undefined>;
+    restore: <T>(dOptions: StorePathOptions) => Promise<T | undefined>;
+}> {
+}
+export interface UseStoreOptions {
+    /**ideally required. Otherwise will struggle to find url path */
+    api?: BTApi;
+    /**ideally required. For setting unique local storage keys */
+    auth?: BTAuth;
+    /**build a query.  Overrides the default */
+    builderQuery?: (params: any) => string;
+    /**overrides the default */
+    buildUrl?: (path: PathOptions) => string;
+    dates: BTDates;
+    demo?: BTDemo;
+    /**custom override for getting the key to store */
+    getStorageKey?: (dOptions: GetStorageKeyOptions) => string;
+    /**used to select item. Default to x => x.id */
+    idSelector?: (item: any) => string;
+    /**the name of this store found in navigation */
+    nav?: string;
+    /**ideally required.  For determining store mode */
+    navigation?: BTNavigation;
+    /**appended to the end of the store name if exists */
+    proxyID?: string;
+    /**particularly what store syle to use */
+    storeMode?: StoreMode;
+    /**whether to store data locally or only for the duration of the session */
+    storageMode?: StorageMode;
+    /**the name of this store */
+    storeName?: string;
+    /**props to ignore (ie. 'customer') when updating */
+    updateIgnoreProps?: string[];
+}
+export interface CreateStoreBuilderOptions {
+    /**ideally required. Otherwise will struggle to find url path */
+    api?: BTApi;
+    /**ideally required. For setting unique local storage keys */
+    auth?: BTAuth;
+    /**build a query.  Overrides the default */
+    builderQuery?: (params: any) => string;
+    /**overrides the default */
+    buildUrl?: (path: PathOptions) => string;
+    dates: BTDates;
+    demo?: BTDemo;
+    /**ideally required.  For determining store mode */
+    navigation?: BTNavigation;
+}
+export interface CreateStoreOptions {
+    /**particularly what store syle to use */
+    storeMode?: StoreMode;
+    /**whether to store data locally or only for the duration of the session */
+    storageMode?: StorageMode;
+    /**the nav item or name of this store */
+    nav: string;
+    proxyID?: string;
+}
+export interface CreateBlobStoreOptions {
+    /**whether to store data locally or only for the duration of the session */
+    storageMode?: StorageMode;
+    /**the nav item or name of this store */
+    nav: string;
+}
+export declare function useBlobStore(options: CreateBlobStoreOptions): BTBlobStore;
+export declare function useStore(options: CreateStoreOptions): BTStore;
+export declare function useStoreDefinition(options: CreateStoreOptions): BTStoreDefinition;
+export declare function createStoreBuilder(options: CreateStoreBuilderOptions): (opt: CreateStoreOptions) => BTStoreDefinition;
+export declare function createBlobStoreBuilder(options: CreateStoreBuilderOptions): (opt: CreateBlobStoreOptions) => BTBlobStoreDefinition;
+/**defaults to options --> navigation --> session/local-cache */
+export declare function createStoreDefinition(options: UseStoreOptions): BTStoreDefinition;
+interface UseBlobStoreOptions extends UseStoreOptions {
+    api?: BTApi;
+    auth?: BTAuth;
+    demo?: BTDemo;
+    /**custom override for getting the key to store */
+    getStorageKey?: (dOptions: GetStorageKeyOptions) => string;
+    /**whether to store data locally or only for the duration of the session */
+    storageMode?: 'session' | 'local-cache';
+    /**overrides the default */
+    buildUrl?: (path: PathOptions) => string;
+    /**the name of this store */
+    storeName?: string;
+}
+export declare function createBlobStoreDefinition(options: UseBlobStoreOptions): BTBlobStoreDefinition;
+interface UseSessionStoreOptions {
+    /**ideally required. Otherwise will struggle to find url path */
+    api?: BTApi;
+    /**ideally required. For setting unique local storage keys */
+    auth?: BTAuth;
+    demo?: BTDemo;
+    /**custom override for getting the key to store */
+    getStorageKey?: (dOptions: GetStorageKeyOptions) => string;
+    /**used to select item. Default to x => x.id */
+    idSelector?: (item: any) => string;
+    /**whether to search for list locally or server first */
+    priority?: 'server' | 'local';
+    /**whether to store data locally or only for the duration of the session */
+    storageMode?: 'session' | 'local-cache';
+    /**build a query.  Overrides the default */
+    buildQuery?: (params: any) => string;
+    /**overrides the default */
+    buildUrl?: (path: PathOptions) => string;
+    /**the name of this store */
+    storeName: string;
+    /**props to ignore (ie. 'customer') when updating */
+    updateIgnoreProps?: string[];
+}
+export declare function createSessionStoreDefinition(options: UseSessionStoreOptions): BTStoreDefinition;
+interface UseWholeStoreStoreOptions {
+    /**ideally required. Otherwise will struggle to find url path */
+    api?: BTApi;
+    /**ideally required. For setting unique local storage keys */
+    auth?: BTAuth;
+    dates: BTDates;
+    demo?: BTDemo;
+    /**custom override for getting the key to store */
+    getStorageKey?: (dOptions: GetStorageKeyOptions) => string;
+    /**how many minutes until store clears all data. Undefined means it won't happen */
+    minutesToClear?: number;
+    /**used to select item. Default to x => x.id */
+    idSelector?: (item: any) => string;
+    /**whether to search for list locally or server first */
+    priority?: 'server' | 'local';
+    storageMode?: 'session' | 'local-cache';
+    storeName: string;
+}
+export declare function createWholeStoreStoreDefinition(options: UseWholeStoreStoreOptions): BTStoreDefinition;
+interface UseWholeLastUpdateStoreOptions {
+    /**ideally required. Otherwise will struggle to find url path */
+    api?: BTApi;
+    /**ideally required. For setting unique local storage keys */
+    auth?: BTAuth;
+    dates: BTDates;
+    demo?: BTDemo;
+    /**custom override for getting the key to store */
+    getStorageKey?: (dOptions: GetStorageKeyOptions) => string;
+    /**how many minutes until store clears all data. Undefined means it won't happen */
+    minutesToClear?: number;
+    /**used to select item. Default to x => x.id */
+    idSelector?: (item: any) => string;
+    /**whether to search for list locally or server first */
+    priority?: 'server' | 'local';
+    storageMode?: 'session' | 'local-cache';
+    storeName: string;
+}
+export declare function createWholeLastUpdateStoreDefinition(options: UseWholeLastUpdateStoreOptions): BTStoreDefinition;
+interface UsePartialLastUpdateStoreOptions {
+    /**ideally required. Otherwise will struggle to find url path */
+    api?: BTApi;
+    /**ideally required. For setting unique local storage keys */
+    auth?: BTAuth;
+    bundlingDays?: number;
+    dates: BTDates;
+    /**PLU ONLY - the prop to compare date from and date to window */
+    dateProp?: string;
+    demo?: BTDemo;
+    /**custom override for getting the key to store */
+    getStorageKey?: (dOptions: GetStorageKeyOptions) => string;
+    /**used to select item. Default to x => x.id */
+    idSelector?: (item: any) => string;
+    storageMode?: 'session' | 'local-cache';
+    storeName: string;
+}
+export interface PLULocalMeta {
+    storedOn: string;
+    lastUpdate: string;
+    dateFrom?: string;
+    dateTo?: string;
+}
+export interface LocallyStoredPLUItem {
+    data: any;
+}
+export interface DateWindow {
+    dateFrom: string;
+    dateTo: string;
+}
+export interface WindowAdjustment {
+    left?: DateWindow;
+    reset: boolean;
+    right?: DateWindow;
+}
+export interface WindowAdjustments {
+    left?: DateWindow[];
+    reset: boolean;
+    right?: DateWindow[];
+}
+export declare function createPartialLastUpdateStoreDefinition(options: UsePartialLastUpdateStoreOptions): BTStoreDefinition;
+export {};