@anzusystems/common-admin 1.47.0-beta.21 → 1.47.0-beta.210

package/dist/labs.d.ts

@@ -0,0 +1,556 @@
+import { AnyFn } from '@vueuse/core';
+import { AxiosInstance } from 'axios';
+import { AxiosRequestConfig } from 'axios';
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { ComputedRef } from 'vue';
+import { DefineComponent } from 'vue';
+import { FilterField } from './filterFactory';
+import { InjectionKey } from 'vue';
+import { Method } from 'axios';
+import { PublicProps } from 'vue';
+import { Ref } from 'vue';
+import { SortOrderType as SortOrderType_2 } from '../../composables/system/datatableColumns';
+
+declare const __VLS_component: DefineComponent<__VLS_PublicProps, {
+submit: () => void;
+reset: () => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"update:datatableHiddenColumns": (value: string[] | undefined) => any;
+"update:showDetail": (value: boolean) => any;
+"update:touched": (value: boolean) => any;
+} & {
+reset: () => any;
+submit: () => any;
+bookmarkLoadAfter: () => any;
+}, string, PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+onReset?: (() => any) | undefined;
+onSubmit?: (() => any) | undefined;
+"onUpdate:datatableHiddenColumns"?: ((value: string[] | undefined) => any) | undefined;
+onBookmarkLoadAfter?: (() => any) | undefined;
+"onUpdate:showDetail"?: ((value: boolean) => any) | undefined;
+"onUpdate:touched"?: ((value: boolean) => any) | undefined;
+}>, {
+system: string;
+userId: IntegerIdNullable;
+enableTop: boolean;
+hideButtons: boolean;
+client: () => AxiosInstance;
+formName: string;
+disableFilterUrlSync: boolean;
+bookmarkSystemResource: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare const __VLS_component_2: DefineComponent<__VLS_Props_8, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_8> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {
+placeholder: string;
+dataCy: string;
+allowed: TimeIntervalToolsValue[];
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare type __VLS_Props = {
+    enableTop?: boolean;
+    hideButtons?: boolean;
+    formName?: string;
+    disableFilterUrlSync?: boolean;
+    system?: string | undefined;
+    userId?: IntegerIdNullable | undefined;
+    client?: (() => AxiosInstance) | undefined;
+    bookmarkSystemResource?: string | undefined;
+};
+
+declare type __VLS_Props_10 = {
+    variant?: 'default' | 'id' | 'most-relevant';
+    customOptions?: undefined | DatatableOrderingOptions;
+    paginationUpdateCustomCb?: ((option: DatatableOrderingOption, pagination: Ref<Pagination>) => void) | undefined;
+};
+
+declare type __VLS_Props_11 = {
+    itemsPerPageOptions?: number[];
+    hideRecordsPerPage?: boolean;
+};
+
+declare type __VLS_Props_2 = {
+    name: string;
+    allT?: string;
+    trueT?: string;
+    falseT?: string;
+    dataCy?: string;
+};
+
+declare type __VLS_Props_3 = {
+    name: string;
+    dataCy?: string;
+};
+
+declare type __VLS_Props_4 = {
+    name: string;
+    placeholder?: string | undefined;
+    dataCy?: string;
+};
+
+declare type __VLS_Props_5 = {
+    name: string;
+    fetchItems: (pagination: Ref<Pagination>, filterData: FilterData, filterConfig: FilterConfig) => Promise<ValueObjectOption<string | number>[]>;
+    fetchItemsByIds: FetchItemsByIdsType;
+    filterByField: string;
+    filterSortBy?: DatatableSortBy;
+    placeholder?: string | undefined;
+    prefetch?: 'hover' | 'focus' | 'mounted' | false;
+    searchMinChars?: number;
+};
+
+declare type __VLS_Props_6 = {
+    name: string;
+    fetchItemsMinimal: FetchItemsMinimalType;
+    fetchItemsMinimalByIds: FetchItemsMinimalByIdsType;
+    filterByField: string;
+    filterSortBy?: DatatableSortBy;
+    placeholder?: string | undefined;
+    prefetch?: 'hover' | 'focus' | 'mounted' | false;
+    searchMinChars?: number;
+    itemTitle?: string;
+    itemValue?: string;
+};
+
+declare type __VLS_Props_7 = {
+    name: string;
+    placeholder?: string | undefined;
+    dataCy?: string;
+};
+
+declare type __VLS_Props_8 = {
+    nameFrom: string;
+    nameUntil: string;
+    allowed?: TimeIntervalToolsValue[];
+    placeholder?: string | undefined;
+    dataCy?: string;
+};
+
+declare type __VLS_Props_9 = {
+    name: string;
+    items: ValueObjectOption<string | number>[];
+};
+
+declare type __VLS_PublicProps = {
+    'datatableHiddenColumns'?: string[] | undefined;
+    'showDetail'?: boolean;
+    'touched'?: boolean;
+} & __VLS_Props;
+
+declare type __VLS_PublicProps_2 = {
+    'modelValue'?: number;
+} & __VLS_Props_10;
+
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Partial<Record<string, (_: {
+        itemConfig: FilterField;
+    }) => any>> & {
+        top?(_: {}): any;
+        bookmarks?(_: {}): any;
+        search?(_: {}): any;
+        buttons?(_: {}): any;
+        detail?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+
+declare function __VLS_template_2(): {
+    attrs: Partial<{}>;
+    slots: {
+        title?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+
+declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+
+declare type __VLS_TemplateResult_2 = ReturnType<typeof __VLS_template_2>;
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_2<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+export declare const ADatatableOrdering: DefineComponent<__VLS_PublicProps_2, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"update:modelValue": (value: number) => any;
+} & {
+sortByChange: (data: DatatableOrderingOption) => any;
+}, string, PublicProps, Readonly<__VLS_PublicProps_2> & Readonly<{
+"onUpdate:modelValue"?: ((value: number) => any) | undefined;
+onSortByChange?: ((data: DatatableOrderingOption) => any) | undefined;
+}>, {
+variant: "default" | "id" | "most-relevant";
+customOptions: DatatableOrderingOptions;
+paginationUpdateCustomCb: (option: DatatableOrderingOption, pagination: Ref<Pagination>) => void;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+
+export declare const ADatatablePagination: DefineComponent<__VLS_Props_11, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_11> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {
+itemsPerPageOptions: number[];
+hideRecordsPerPage: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+
+export declare const AFilterBooleanSelect: DefineComponent<__VLS_Props_2, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_2> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {
+dataCy: string;
+allT: string;
+trueT: string;
+falseT: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const AFilterDatetimePicker: DefineComponent<__VLS_Props_3, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_3> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {
+dataCy: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const AFilterInteger: DefineComponent<__VLS_Props_4, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_4> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {
+placeholder: string;
+dataCy: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const AFilterRemoteAutocomplete: DefineComponent<__VLS_Props_5, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_5> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {
+placeholder: string;
+filterSortBy: {
+key: string;
+order: SortOrderType_2;
+} | null;
+prefetch: "hover" | "focus" | "mounted" | false;
+searchMinChars: number;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const AFilterRemoteAutocompleteWithMinimal: DefineComponent<__VLS_Props_6, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_6> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {
+placeholder: string;
+itemValue: string;
+itemTitle: string;
+filterSortBy: {
+key: string;
+order: SortOrderType_2;
+} | null;
+prefetch: "hover" | "focus" | "mounted" | false;
+searchMinChars: number;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const AFilterString: DefineComponent<__VLS_Props_7, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_7> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {
+placeholder: string;
+dataCy: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const AFilterTimeInterval: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
+
+export declare const AFilterValueObjectOptionsSelect: DefineComponent<__VLS_Props_9, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+change: () => any;
+}, string, PublicProps, Readonly<__VLS_Props_9> & Readonly<{
+onChange?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const AFilterWrapper: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
+declare type AllowedFilterValues = number | number[] | string | string[] | null | undefined | boolean;
+
+declare type ColumnConfig = {
+    key: string;
+    title?: string;
+    sortable?: boolean;
+    fixed?: boolean;
+    maxWidth?: number;
+};
+
+export declare function createDatatableColumnsConfig(config: ColumnConfig[], columnsHidden: Ref<Array<string>>, system?: string | undefined, subject?: string | undefined, disableActions?: boolean, customI18n?: undefined | any, showExpand?: undefined | boolean, storeId?: string | undefined): {
+    columnsAll: {
+        key: string;
+        title?: string;
+        sortable: boolean;
+        fixed: boolean;
+        maxWidth?: number;
+    }[];
+    columnsVisible: ComputedRef<any>;
+    columnsHidden: Ref<string[], string[]>;
+};
+
+export declare function createFilter<F extends readonly MakeFilterOption<string>[]>(filterFields: F, store: FilterData<F>, options?: Partial<GeneralFilterOptions>): {
+    filterConfig: FilterConfig<F>;
+    filterData: FilterData<F>;
+};
+
+declare type DatatableOrderingOption = {
+    id: number;
+    titleT: string;
+    sortBy?: DatatableSortBy;
+    customData?: any;
+};
+
+declare type DatatableOrderingOptions = Array<DatatableOrderingOption>;
+
+export declare const DatatablePaginationKey: InjectionKey<Ref<Pagination>>;
+
+declare type DatatableSortBy = {
+    key: string;
+    order: SortOrderType;
+} | null | undefined;
+
+/**
+ * UUID v4 as string.
+ */
+declare type DocId = string;
+
+declare type FetchItemsByIdsType = ((ids: IntegerId[]) => Promise<ValueObjectOption<IntegerId>[]>) | ((ids: DocId[]) => Promise<ValueObjectOption<DocId>[]>);
+
+declare type FetchItemsMinimalByIdsType = ((ids: IntegerId[]) => Promise<any[]>) | ((ids: DocId[]) => Promise<any[]>);
+
+declare type FetchItemsMinimalType = (pagination: Ref<Pagination>, filterData: FilterData, filterConfig: FilterConfig) => Promise<any[]>;
+
+declare interface FilerRenderOptions {
+    skip: boolean;
+    xs: number;
+    sm: number;
+    md: number;
+    lg: number;
+    xl: number;
+}
+
+export declare type FilterConfig<F extends readonly MakeFilterOption<string>[] = readonly MakeFilterOption<string>[]> = {
+    general: GeneralFilterOptions;
+    fields: {
+        [P in F[number]['name']]: FilterField_2;
+    };
+};
+
+export declare const FilterConfigKey: InjectionKey<FilterConfig>;
+
+export declare type FilterData<F extends readonly MakeFilterOption<string>[] = readonly MakeFilterOption<string>[]> = {
+    [P in F[number]['name']]: AllowedFilterValues;
+};
+
+export declare const FilterDataKey: InjectionKey<FilterData>;
+
+declare interface FilterField_2 {
+    name: string;
+    type: FilterType;
+    variant: FilterVariant;
+    titleT?: string;
+    default: AllowedFilterValues;
+    apiName: string;
+    clearable: boolean;
+    mandatory: boolean;
+    multiple: boolean;
+    advanced: boolean;
+    exclude: boolean;
+    related: string | undefined;
+    render: FilerRenderOptions;
+}
+
+export declare const FilterInnerConfigKey: InjectionKey<FilterConfig>;
+
+export declare const FilterInnerDataKey: InjectionKey<FilterData>;
+
+export declare type FilterStore<T extends readonly {
+    name: string;
+}[]> = {
+    [K in T[number]['name']]: AllowedFilterValues;
+};
+
+declare type FilterType = 'boolean' | 'datetime' | 'integer' | 'string' | 'custom' | 'timeInterval';
+
+declare type FilterVariant = 'search' | 'lt' | 'in' | 'notIn' | 'endsWith' | 'startsWith' | 'memberOf' | 'contains' | 'neq' | 'gte' | 'gt' | 'eq' | 'lte' | 'custom';
+
+declare type FilterVariant_2 = 'search' | 'lt' | 'in' | 'notIn' | 'endsWith' | 'startsWith' | 'memberOf' | 'contains' | 'neq' | 'gte' | 'gt' | 'eq' | 'lte' | 'custom';
+
+declare interface GeneralFilterOptions {
+    system?: string;
+    subject?: string;
+    elastic?: boolean;
+}
+
+export declare const generateListQuery: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>) => string;
+
+/**
+ * Integer ID.
+ */
+declare type IntegerId = number;
+
+/**
+ * Integer ID + null.
+ */
+declare type IntegerIdNullable = number | null;
+
+export declare interface MakeFilterOption<TName extends string = string> {
+    name: TName;
+    type?: FilterType;
+    variant?: FilterVariant;
+    titleT?: string;
+    apiName?: string;
+    clearable?: boolean;
+    mandatory?: boolean;
+    advanced?: boolean;
+    exclude?: boolean;
+    related?: string | undefined;
+    render?: Partial<FilerRenderOptions>;
+}
+
+export declare interface Pagination {
+    sortBy: DatatableSortBy;
+    page: number;
+    rowsPerPage: number;
+    rowsNumber: number;
+    hasNextPage: null | boolean;
+    currentViewCount: number;
+    totalCount: number;
+}
+
+declare const SortOrder: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+
+declare type SortOrderType = (typeof SortOrder)[keyof typeof SortOrder];
+
+export declare const TimeIntervalSpecialOptions: {
+    readonly CurrentMonth: "cm";
+    readonly LastMonth: "lm";
+    readonly Last3Months: "l3m";
+    readonly Custom: "custom";
+};
+
+declare type TimeIntervalSpecialOptionsType = (typeof TimeIntervalSpecialOptions)[keyof typeof TimeIntervalSpecialOptions];
+
+/** note: number value represents time interval in minutes, null represent unselected */
+export declare type TimeIntervalToolsValue = number | TimeIntervalSpecialOptionsType | null;
+
+declare type UrlParams = {
+    [key: string]: number | string;
+};
+
+declare type UseApiAnyRequestReturnType<R, T = R> = {
+    executeRequest: (urlTemplate: string, urlParams?: UrlParams | undefined, object?: T | undefined) => Promise<R>;
+    abortRequest: () => void;
+};
+
+export declare const useApiFetchByIds: <R>(client: () => AxiosInstance, system: string, entity: string, options?: AxiosRequestConfig, isSearchApi?: boolean, field?: string) => UseApiFetchByIdsReturnType<R>;
+
+declare type UseApiFetchByIdsReturnType<R> = {
+    executeFetch: (ids: DocId[] | IntegerId[], urlTemplate: string, urlParams?: UrlParams | undefined) => Promise<R>;
+    abortFetch: () => void;
+};
+
+/**
+ * @template R Response type override, optional
+ */
+export declare const useApiFetchList: <R>(client: () => AxiosInstance, system: string, entity: string, options?: AxiosRequestConfig) => UseApiFetchListReturnType<R>;
+
+/**
+ * @template R Response type override
+ */
+export declare const useApiFetchListBatch: <R>(client: () => AxiosInstance, system: string, entity: string, options?: AxiosRequestConfig) => UseApiFetchListBatchReturnType<R>;
+
+declare type UseApiFetchListBatchReturnType<R> = {
+    executeFetch: (filterData: FilterData<any>, filterConfig: FilterConfig<any>, urlTemplate: string, urlParams?: UrlParams, sortBy?: string, sortDesc?: boolean, batchSize?: number, forceElastic?: boolean) => Promise<R>;
+    abortFetch: () => void;
+};
+
+declare type UseApiFetchListReturnType<R> = {
+    executeFetch: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, urlTemplate: string, urlParams?: UrlParams | undefined) => Promise<R>;
+    abortFetch: () => void;
+};
+
+/**
+ * Docs: /doc/Admin-Cms-Doc/Filters.md
+ */
+export declare function useApiQueryBuilder(): {
+    querySetLimit: (value: number) => void;
+    querySetOffset: (page: number, limit: number) => void;
+    querySetOrder: (field: string | null, desc: boolean) => void;
+    queryAddFilter: (filterVariant: FilterVariant_2, field: string, value: string | number | boolean) => void;
+    querySetFilters: (filterData: FilterData<any>, filterConfig: FilterConfig<any>) => void;
+    queryAdd: (key: string, value: any) => void;
+    queryBuild: () => string;
+};
+
+/**
+ * @template T Type used for request payload, by default same as Response type
+ * @template R Response type override, optional
+ */
+export declare const useApiRequest: <R, T = R>(client: () => AxiosInstance, method: Method, system: string, entity: string, options?: AxiosRequestConfig) => UseApiAnyRequestReturnType<R, T>;
+
+export declare function useFilterHelpers<F extends readonly MakeFilterOption<string>[] = readonly MakeFilterOption<string>[]>(filterData: FilterData<F>, filterConfig: FilterConfig<F>, systemResource?: string | undefined): {
+    loadStoredFilters: () => boolean;
+    resetFilter: (pagination: Ref<Pagination>, callback?: AnyFn) => void;
+    submitFilter: (pagination: Ref<Pagination>, callback?: AnyFn) => void;
+    serializeFilters: (data: Record<string, AllowedFilterValues>, pagination: Ref<Pagination>, includeSort: boolean) => string;
+    deserializeFilters: (hash: string) => {
+        filters: Record<string, AllowedFilterValues>;
+        sortBy: DatatableSortBy;
+    } | null;
+};
+
+export declare function usePagination(sortBy?: DatatableSortBy): Ref<    {
+sortBy: {
+key: string;
+order: SortOrderType_2;
+} | null | undefined;
+page: number;
+rowsPerPage: number;
+rowsNumber: number;
+hasNextPage: null | boolean;
+currentViewCount: number;
+totalCount: number;
+}, Pagination | {
+sortBy: {
+key: string;
+order: SortOrderType_2;
+} | null | undefined;
+page: number;
+rowsPerPage: number;
+rowsNumber: number;
+hasNextPage: null | boolean;
+currentViewCount: number;
+totalCount: number;
+}>;
+
+declare interface ValueObjectOption<T> {
+    value: T;
+    title: string;
+    color?: string;
+    active?: false;
+    subtitle?: string;
+}
+
+export { }