bt-core-app 2.1.36 → 2.2.0

package/dist/composables/list.d.ts

@@ -0,0 +1,345 @@
+import { BulkActionResult, SyncOptions } from './sync.ts';
+import { ExternalParty } from './navigation.ts';
+import { StorageMode, StoreMode } from './stores.ts';
+import { RouteLocationNormalizedLoaded, Router } from 'vue-router';
+import { BladeMode, BladeVariant } from '../composables/blade.ts';
+import { GetOptions, OnCanDoAsync, OnDoActionAsync, OnDoSuccessAsync, OnGetAsync, OnGetSuccessAsync, OnGetAllAsync, OnGetAllSuccessAsync, OnDoMaybeSuccessAsync } from './actions.ts';
+
+export interface ListRefreshOptions {
+    deepRefresh?: boolean;
+    params?: any;
+    resetSearch?: boolean;
+}
+export interface TableColumn {
+    align?: 'start' | 'end' | 'center';
+    bool?: number;
+    csv?: boolean;
+    csvArray?: boolean;
+    csvFilter?: string;
+    csvText?: string;
+    display?: boolean;
+    hide?: boolean;
+    itemText?: string;
+    level?: number;
+    maxWidth?: string;
+    minWidth?: string;
+    nav?: string;
+    prefix?: string;
+    searchable?: boolean;
+    showSize?: string;
+    single?: boolean;
+    sublevel?: number;
+    suffix?: string;
+    textFilter?: string;
+    textFunction?: Function;
+    title?: string;
+    truncate?: boolean;
+    value?: string;
+    width?: string;
+}
+export interface CustomFilterParam {
+    name: string;
+    filterFunction: () => string;
+    onFilterResult: Function | null;
+}
+export interface LocalFilter {
+    name: string;
+    predicate?: (item: any) => boolean;
+    onFilter?: (list: any[]) => any[];
+}
+export interface ListEvents {
+    (e: 'change', item: any): void;
+    (e: 'deleted', item: any): void;
+    (e: 'fetched', item: any): void;
+    (e: 'input', item: any): void;
+    (e: 'select', item: any): void;
+    (e: 'confirm', item: any): void;
+    (e: 'mouse-over-item', item: any): void;
+}
+export interface ListProps<T, TSave, TReturn> {
+    addBladeName?: string;
+    additionalUrl?: string;
+    bladeGroup?: string;
+    bladeName?: string;
+    bladeStartShowing?: boolean;
+    canSelect?: boolean;
+    canUnselect?: boolean;
+    closeBladeNames?: string[] | string;
+    confirmOnDelete?: boolean;
+    customFilters?: CustomFilterParam[];
+    dateFrom?: string;
+    dateTo?: string;
+    defaultFilters?: string[];
+    eager?: boolean;
+    errorMsg?: string;
+    filterToggle?: boolean;
+    headers?: TableColumn[];
+    hideActions?: boolean;
+    idSelector?: <T>(item: T) => string;
+    ignoreID?: boolean;
+    inactiveProp?: string;
+    isSingle?: boolean;
+    itemBladeName?: string;
+    itemID?: string;
+    items?: any[];
+    /**only used with server pagination */
+    itemsPerPage?: number;
+    itemText?: string;
+    keyStrategy?: 'rID' | 'index' | 'id';
+    loadingMsg?: string;
+    localFilters?: LocalFilter[];
+    localOnly?: boolean;
+    nav?: string;
+    navType?: 'blade' | 'page';
+    /**for defining if deletable (show button or not) */
+    onCanDelete?: (item: TReturn) => boolean;
+    /**when trying to delete in api */
+    onCanDeleteAsync?: OnCanDoAsync<TReturn>;
+    /**for defining if can be integrated */
+    onCanIntegrate?: (item: TReturn) => boolean;
+    onCanRestore?: (item: TReturn) => boolean;
+    onCanRestoreAsync?: OnCanDoAsync<TReturn>;
+    onCanSave?: (item: TReturn) => boolean;
+    onCanSaveAsync?: OnCanDoAsync<TReturn | TSave>;
+    onCanSelectItem?: (item: TReturn) => boolean;
+    onDeleteAsync?: OnDoActionAsync<TReturn>;
+    onDeleteSuccessAsync?: OnDoMaybeSuccessAsync<TReturn, TReturn>;
+    onError?: (err: any) => any;
+    onFilter?: (list: TReturn[]) => TReturn[];
+    onFinished?: (items: any) => void;
+    onGetAsync?: OnGetAllAsync<T>;
+    onGetSingleAsync?: OnGetAsync<T>;
+    onGetSaveAsync?: OnDoSuccessAsync<TReturn, TSave>;
+    onGetSingleSuccessAsync?: OnGetSuccessAsync<T, TReturn>;
+    onGetSuccessAsync?: OnGetAllSuccessAsync<T, TReturn>;
+    onRestoreAsync?: OnDoActionAsync<TReturn>;
+    onRestoreSuccessAsync?: OnDoSuccessAsync<TReturn, TReturn>;
+    onSaveAsync?: (item: TSave | TReturn) => Promise<TReturn | undefined>;
+    onSaveSuccessAsync?: OnDoSuccessAsync<TReturn, TReturn>;
+    onSelectItem?: (item: TReturn) => void;
+    onSyncAsync?: (opt: SyncOptions<T>) => Promise<BulkActionResult<T>[]>;
+    onUpdateAsyncItem?: (asyncItem: TReturn | TReturn[] | undefined, newVersionItem: T) => void;
+    paginate?: 'server' | 'local';
+    params?: any;
+    proxyID?: string;
+    proxyKey?: string;
+    refreshOnChange?: boolean;
+    queryParams?: string[] | Record<string, string>[];
+    refreshLiteToggle?: boolean;
+    refreshToggle?: boolean;
+    searchKey?: string;
+    searchProps?: string[];
+    searchStr?: string;
+    selectProps?: string[];
+    sortDirection?: 'asc' | 'desc' | -1 | 1;
+    sortProp?: string | string[];
+    startEditing?: boolean;
+    startShowingInactive?: boolean;
+    startShowingSearch?: boolean;
+    storeMode?: StoreMode;
+    storageMode?: StorageMode;
+    /**usually used for last-updated configs or large quantities of local items */
+    /**uses pagination from server */
+    trackSearchQuery?: boolean;
+    useBladeSrc?: boolean;
+    useRouteSrc?: boolean;
+    variant?: BladeVariant;
+}
+export interface GroupedHeaderOption {
+    position: number;
+    values: TableColumn[];
+}
+export interface UseListOptions {
+    hideActions?: boolean;
+    /**used to select item. Default to x => x.id */
+    idSelector?: <T>(item: T) => string;
+    isNotSetup?: boolean;
+    onError?: (err: any) => any;
+    onFinished?: (items: any) => void;
+    onFinishedAsync?: (items: any) => Promise<void>;
+    params?: any;
+    router?: Router;
+    route?: RouteLocationNormalizedLoaded;
+}
+export interface BaseIDModel {
+    id?: string;
+}
+/**
+ * PROPS first
+ * ROUTE second
+ *  page=1
+ *
+ * BLADE third
+ * @param props
+ * @param emit
+ * @param options
+ */
+export declare function useList<T, TSave, TReturn>(props: ListProps<T, TSave, TReturn>, emit?: ListEvents, options?: UseListOptions): {
+    blades?: import('vue').Ref<import("../composables/blade.ts").BladeData[], import("../composables/blade.ts").BladeData[]> | undefined;
+    bladeData?: import('../composables/blade.ts').BladeData | undefined;
+    closeBlade?: ((options?: import('../composables/blade.ts').CloseBladeOptions | undefined) => void) | undefined;
+    closeBladeAsync?: ((options?: import('../composables/blade.ts').CloseBladeOptions | undefined) => Promise<void>) | undefined;
+    isMobile?: import('vue').Ref<boolean, boolean> | undefined;
+    isShowing?: import('vue').ComputedRef<(bladeName?: string | undefined) => boolean> | undefined;
+    updateBlade?: ((data: import('../composables/blade.ts').UpdateBladeData<GetOptions<T, TReturn>>) => void) | undefined;
+    variant?: import('vue').Ref<BladeVariant, BladeVariant> | undefined;
+    add: (variant: BladeVariant) => void;
+    applyFilters: () => Promise<void>;
+    asyncItems: import('vue').Ref<TReturn | TReturn[] | undefined, TReturn | TReturn[] | undefined>;
+    currentExternalParty: import('vue').Ref<ExternalParty | undefined, ExternalParty | undefined>;
+    currentPage: import('vue').Ref<number, number>;
+    deleteItem: (item: TReturn) => Promise<void>;
+    displayHeaders: import('vue').ComputedRef<{
+        align?: "end" | "start" | "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;
+        maxWidth?: string | undefined;
+        minWidth?: string | undefined;
+        nav?: string | undefined;
+        prefix?: string | undefined;
+        searchable?: boolean | undefined;
+        showSize?: string | undefined;
+        single?: boolean | undefined;
+        sublevel?: number | undefined;
+        suffix?: string | undefined;
+        textFilter?: string | undefined;
+        textFunction?: Function | undefined;
+        title?: string | undefined;
+        truncate?: boolean | undefined;
+        value?: string | undefined;
+        width?: string | undefined;
+    }[]>;
+    errorMsg: import('vue').ComputedRef<string | undefined>;
+    exportToCSV: () => void;
+    externalParties: import('vue').Ref<{
+        additionalUrl: string;
+        canUnlink: boolean;
+        externalTextProp?: string | undefined;
+        localIDProp: string;
+        party: string;
+    }[], ExternalParty[] | {
+        additionalUrl: string;
+        canUnlink: boolean;
+        externalTextProp?: string | undefined;
+        localIDProp: string;
+        party: string;
+    }[]>;
+    filteredItems: import('vue').ShallowRef<TReturn[], TReturn[]>;
+    filters: import('vue').ComputedRef<any[]>;
+    filtersChanged: import('vue').ComputedRef<boolean>;
+    headerOptions: import('vue').Ref<{
+        align?: "end" | "start" | "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;
+        maxWidth?: string | undefined;
+        minWidth?: string | undefined;
+        nav?: string | undefined;
+        prefix?: string | undefined;
+        searchable?: boolean | undefined;
+        showSize?: string | undefined;
+        single?: boolean | undefined;
+        sublevel?: number | undefined;
+        suffix?: string | undefined;
+        textFilter?: string | undefined;
+        textFunction?: Function | undefined;
+        title?: string | undefined;
+        truncate?: boolean | undefined;
+        value?: string | undefined;
+        width?: string | undefined;
+    }[], TableColumn[] | {
+        align?: "end" | "start" | "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;
+        maxWidth?: string | undefined;
+        minWidth?: string | undefined;
+        nav?: string | undefined;
+        prefix?: string | undefined;
+        searchable?: boolean | undefined;
+        showSize?: string | undefined;
+        single?: boolean | undefined;
+        sublevel?: number | undefined;
+        suffix?: string | undefined;
+        textFilter?: string | undefined;
+        textFunction?: Function | undefined;
+        title?: string | undefined;
+        truncate?: boolean | undefined;
+        value?: string | undefined;
+        width?: string | undefined;
+    }[]>;
+    id: import('vue').ComputedRef<string | undefined>;
+    isDeletable: import('vue').ComputedRef<(item: TReturn | any) => boolean>;
+    isEditing: import('vue').ComputedRef<boolean>;
+    isIntegratable: import('vue').ComputedRef<(item: TReturn | any) => boolean>;
+    isIntegrated: import('vue').ComputedRef<(item: TReturn | any) => boolean>;
+    isLoading: import('vue').ComputedRef<boolean>;
+    isRestorable: import('vue').ComputedRef<(item: TReturn | any) => boolean>;
+    loadingMsg: import('vue').ComputedRef<string | undefined>;
+    mode: import('vue').Ref<BladeMode, BladeMode>;
+    proxyID: import('vue').ComputedRef<string | undefined>;
+    pushToExternalParty: (dItem: any) => Promise<void>;
+    refresh: (rOptions?: ListRefreshOptions) => Promise<void>;
+    refreshFilteredList: () => void;
+    restoreItem: (dItem: any) => Promise<TReturn | undefined>;
+    saveItem: (dItem: any) => Promise<TReturn | undefined>;
+    searchString: import('vue').Ref<string | undefined, string | undefined>;
+    selectExternalParty: (party?: ExternalParty) => void;
+    selectedFilters: import('vue').Ref<number[], number[]>;
+    selectItem: (rItem: any, variant: BladeVariant) => void;
+    showError: import('vue').ShallowRef<boolean, boolean>;
+    showInactive: import('vue').Ref<boolean, boolean>;
+    showSearch: import('vue').ShallowRef<boolean, boolean>;
+    subtitleOptions: import('vue').ComputedRef<GroupedHeaderOption[]>;
+    tableHeaders: import('vue').ComputedRef<{
+        align?: "end" | "start" | "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;
+        maxWidth?: string | undefined;
+        minWidth?: string | undefined;
+        nav?: string | undefined;
+        prefix?: string | undefined;
+        searchable?: boolean | undefined;
+        showSize?: string | undefined;
+        single?: boolean | undefined;
+        sublevel?: number | undefined;
+        suffix?: string | undefined;
+        textFilter?: string | undefined;
+        textFunction?: Function | undefined;
+        title?: string | undefined;
+        truncate?: boolean | undefined;
+        value?: string | undefined;
+        width?: string | undefined;
+    }[]>;
+    titleOptions: import('vue').ComputedRef<GroupedHeaderOption[]>;
+    toggleSearch: () => void;
+    totalCount: import('vue').Ref<number | undefined, number | undefined>;
+    totalPages: import('vue').Ref<number, number>;
+    unlinkFromExternalParty: (dItem: any) => Promise<void>;
+};