@anzusystems/common-admin 1.47.0-beta.358 → 1.47.0-beta.359

package/dist/labs.d.ts

@@ -7,18 +7,12 @@ import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { ComputedRef } from 'vue';
 import { DefineComponent } from 'vue';
-import { FilterField } from './filterFactory';
-import { FilterField as FilterField_2 } from '../filters/filterFactory';
 import { InjectionKey } from 'vue';
 import { Method } from 'axios';
 import { PublicProps } from 'vue';
 import { Ref } from 'vue';
 import { ShallowUnwrapRef } from 'vue';
-import { SortOrderType as SortOrderType_2 } from '../../composables/system/datatableColumns';
-import { UseApiFetchListReturnType as UseApiFetchListReturnType_2 } from '../api/useApiFetchList';
 import { UseDebounceFnReturn } from '@vueuse/shared';
-import { UserAdminConfigDataFilterBookmark as UserAdminConfigDataFilterBookmark_2 } from '../../types/UserAdminConfig';
-import { UserAdminConfigDataPinnedWidgets as UserAdminConfigDataPinnedWidgets_2 } from '../../types/UserAdminConfig';
 import { VNode } from 'vue';
 import { VNodeProps } from 'vue';
 
@@ -40,9 +34,9 @@ onBookmarkLoadAfter?: (() => any) | undefined;
 "onUpdate:showDetail"?: ((value: boolean) => any) | undefined;
 }>, {
 userId: IntegerIdNullable;
+client: () => AxiosInstance;
 enableTop: boolean;
 hideButtons: boolean;
-client: () => AxiosInstance;
 formName: string;
 store: FilterStoreIdentifier | boolean;
 alwaysVisible: boolean;
@@ -65,8 +59,8 @@ onSubmit?: (() => any) | undefined;
 onBookmarkLoadAfter?: (() => any) | undefined;
 }>, {
 userId: IntegerIdNullable;
-hideButtons: boolean;
 client: () => AxiosInstance;
+hideButtons: boolean;
 formName: string;
 disableFilterUrlSync: boolean;
 store: FilterStoreIdentifier | boolean;
@@ -207,7 +201,7 @@ declare function __VLS_template(): {
 declare function __VLS_template_2(): {
     attrs: Partial<{}>;
     slots: Partial<Record<string, (_: {
-        itemConfig: FilterField_2;
+        itemConfig: FilterField;
     }) => any>> & {
         bookmarks?(_: {}): any;
         detail?(_: {}): any;
@@ -332,7 +326,7 @@ itemTitle: string;
 itemValue: string;
 filterSortBy: {
 key: string;
-order: SortOrderType_2;
+order: SortOrderType;
 } | null;
 prefetch: "hover" | "focus" | "mounted" | false;
 searchMinChars: number;
@@ -449,6 +443,7 @@ export declare const ASubjectSelect: <TItem>(__VLS_props: NonNullable<Awaited<ty
     } & Partial<{}>> & PublicProps;
     expose(exposed: ShallowUnwrapRef<    {
     open: () => void;
+    closeSidebarOnMobile: () => void;
     }>): void;
     attrs: any;
     slots: {
@@ -579,10 +574,36 @@ declare type DatetimeUTCNullable = string | null;
  */
 declare type DocId = string;
 
+declare type ExecuteRequestParams<T> = {
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    object?: T;
+};
+
+declare type FetchByIdsParams = {
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+};
+
 declare type FetchItemsMinimalByIdsType = ((ids: IntegerId[]) => Promise<any[]>) | ((ids: DocId[]) => Promise<any[]>);
 
 declare type FetchItemsMinimalType = (pagination: Ref<Pagination>, filterData: FilterData, filterConfig: FilterConfig) => Promise<any[]>;
 
+declare type FetchListBatchParams = {
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    sortBy?: string;
+    sortDesc?: boolean;
+    batchSize?: number;
+    forceElastic?: boolean;
+};
+
+declare type FetchListParams = {
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    forceElastic?: boolean;
+};
+
 declare interface FilerRenderOptions {
     skip: boolean;
     xs: number | undefined;
@@ -596,7 +617,7 @@ export declare type FilterConfig<F extends readonly MakeFilterOption<string>[] =
     general: GeneralFilterOptions;
     touched: boolean;
     fields: {
-        [P in F[number]['name']]: FilterField_3;
+        [P in F[number]['name']]: FilterField;
     };
 };
 
@@ -608,7 +629,7 @@ export declare type FilterData<F extends readonly MakeFilterOption<string>[] = r
 
 export declare const FilterDataKey: InjectionKey<FilterData>;
 
-declare interface FilterField_3 {
+declare interface FilterField {
     name: string;
     type: FilterType;
     variant: FilterVariant;
@@ -755,34 +776,60 @@ declare type UrlParams = {
 };
 
 declare type UseApiAnyRequestReturnType<R, T = R> = {
-    executeRequest: (urlTemplateOverride?: string, urlParamsOverride?: UrlParams | undefined, object?: T | undefined) => Promise<R>;
+    executeRequest: (params?: ExecuteRequestParams<T>) => Promise<R>;
     abortRequest: () => void;
 };
 
-export declare const useApiFetchByIds: <R>(client: AxiosClientFn, system: string, entity: string, urlTemplate?: string | undefined, urlParams?: UrlParams | undefined, options?: AxiosRequestConfig, isSearchApi?: boolean, field?: string) => UseApiFetchByIdsReturnType<R>;
+export declare const useApiFetchByIds: <R>(params: UseApiFetchByIdsParams) => UseApiFetchByIdsReturnType<R>;
+
+declare type UseApiFetchByIdsParams = {
+    client: AxiosClientFn;
+    system: string;
+    entity: string;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    options?: AxiosRequestConfig;
+    isSearchApi?: boolean;
+    field?: string;
+    silentConsoleError?: boolean;
+};
 
 declare type UseApiFetchByIdsReturnType<R> = {
-    executeFetch: (ids: DocId[] | IntegerId[], urlTemplateOverride?: string, urlParamsOverride?: UrlParams | undefined) => Promise<R>;
+    executeFetch: (ids: DocId[] | IntegerId[], params?: FetchByIdsParams) => Promise<R>;
     abortFetch: () => void;
 };
 
-/**
- * @template R Response type override, optional
- */
-export declare const useApiFetchList: <R>(client: AxiosClientFn, system: string, entity: string, urlTemplate?: string | undefined, urlParams?: UrlParams | undefined, options?: AxiosRequestConfig) => UseApiFetchListReturnType<R>;
+export declare const useApiFetchList: <R>(params: UseApiFetchListParams) => UseApiFetchListReturnType<R>;
 
-/**
- * @template R Response type override
- */
-export declare const useApiFetchListBatch: <R>(client: AxiosClientFn, system: string, entity: string, urlTemplate?: string | undefined, urlParams?: UrlParams | undefined, options?: AxiosRequestConfig) => UseApiFetchListBatchReturnType<R>;
+export declare const useApiFetchListBatch: <R>(params: UseApiFetchListBatchParams) => UseApiFetchListBatchReturnType<R>;
+
+declare type UseApiFetchListBatchParams = {
+    client: AxiosClientFn;
+    system: string;
+    entity: string;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    options?: AxiosRequestConfig;
+    silentConsoleError?: boolean;
+};
 
 declare type UseApiFetchListBatchReturnType<R> = {
-    executeFetch: (filterData: FilterData<any>, filterConfig: FilterConfig<any>, urlTemplateOverride?: string, urlParamsOverride?: UrlParams, sortBy?: string, sortDesc?: boolean, batchSize?: number, forceElastic?: boolean) => Promise<R>;
+    executeFetch: (filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListBatchParams) => Promise<R>;
     abortFetch: () => void;
 };
 
+declare type UseApiFetchListParams = {
+    client: AxiosClientFn;
+    system: string;
+    entity: string;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    options?: AxiosRequestConfig;
+    silentConsoleError?: boolean;
+};
+
 declare type UseApiFetchListReturnType<R> = {
-    executeFetch: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, urlTemplateOverride?: string | undefined, urlParamsOverride?: UrlParams | undefined, forceElastic?: boolean) => Promise<R>;
+    executeFetch: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListParams) => Promise<R>;
     abortFetch: () => void;
 };
 
@@ -804,11 +851,18 @@ export declare function useApiQueryBuilder(): {
     q: Ref<string[], 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: AxiosClientFn, method: Method, system: string, entity: string, urlTemplate?: string | undefined, urlParams?: UrlParams | undefined, options?: AxiosRequestConfig) => UseApiAnyRequestReturnType<R, T>;
+export declare const useApiRequest: <R, T = R>(params: UseApiRequestParams) => UseApiAnyRequestReturnType<R, T>;
+
+declare type UseApiRequestParams = {
+    client: AxiosClientFn;
+    method: Method;
+    system: string;
+    entity: string;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    options?: AxiosRequestConfig;
+    silentConsoleError?: boolean;
+};
 
 export declare function useFilterHelpers<F extends readonly MakeFilterOption<string>[] = readonly MakeFilterOption<string>[]>(filterData: FilterData<F>, filterConfig: FilterConfig<F>, moreOptions?: Partial<FilterHelpersMoreOptions>): {
     loadStoredFilters: (pagination: Ref<Pagination>, callback?: AnyFn) => boolean;
@@ -822,7 +876,7 @@ export declare function useFilterHelpers<F extends readonly MakeFilterOption<str
 };
 
 export declare function useJobApi<JobType extends JobBase = JobBase>(client: () => AxiosInstance, system: string): {
-    useFetchJobList: () => UseApiFetchListReturnType_2<JobType[]>;
+    useFetchJobList: () => UseApiFetchListReturnType<JobType[]>;
     fetchJob: (id: number) => Promise<JobType>;
     createJob: (data: JobType) => Promise<JobType>;
     deleteJob: (id: number) => Promise<JobType>;
@@ -880,7 +934,7 @@ export declare const UserAdminConfigTypeDefault: "pinnedWidgets";
 
 export declare type UserAdminConfigTypeType = (typeof UserAdminConfigType)[keyof typeof UserAdminConfigType];
 
-export declare function useSubjectSelect<TItem>(datatableConfig: any, datatableHiddenColumns: any, system: string, subject: string, executeFetch: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, urlTemplateOverride?: string | undefined, urlParamsOverride?: UrlParams | undefined, forceElastic?: boolean) => Promise<TItem[]>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, filterSortBy?: DatatableSortBy | null, urlTemplateOverride?: string | undefined, urlParamsOverride?: UrlParams | undefined, forceElastic?: boolean, enableActions?: boolean): {
+export declare function useSubjectSelect<TItem>(datatableConfig: any, datatableHiddenColumns: any, system: string, subject: string, executeFetch: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListParams) => Promise<TItem[]>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, filterSortBy?: DatatableSortBy | null, fetchParams?: FetchListParams | undefined, enableActions?: boolean): {
     items: Ref<TItem[], TItem[]>;
     selected: Ref<TItem[], TItem[]>;
     pagination: Ref<Pagination, Pagination>;
@@ -905,10 +959,10 @@ export declare function useSubjectSelect<TItem>(datatableConfig: any, datatableH
 };
 
 export declare function useUserAdminConfigApi(client: () => AxiosInstance, system: string, entity?: string, endPoint?: string): {
-    useFetchUserAdminConfigList: () => UseApiFetchListReturnType_2<UserAdminConfig<UserAdminConfigDataFilterBookmark_2 | UserAdminConfigDataPinnedWidgets_2<string>>[]>;
-    fetchUserAdminConfig: (id: IntegerId) => Promise<UserAdminConfig<UserAdminConfigDataFilterBookmark_2 | UserAdminConfigDataPinnedWidgets_2<string>>>;
-    createUserAdminConfig: (data: UserAdminConfig) => Promise<UserAdminConfig<UserAdminConfigDataFilterBookmark_2 | UserAdminConfigDataPinnedWidgets_2<string>>>;
-    updateUserAdminConfig: (id: IntegerId, data: UserAdminConfig) => Promise<UserAdminConfig<UserAdminConfigDataFilterBookmark_2 | UserAdminConfigDataPinnedWidgets_2<string>>>;
+    useFetchUserAdminConfigList: () => UseApiFetchListReturnType<UserAdminConfig<UserAdminConfigDataFilterBookmark | UserAdminConfigDataPinnedWidgets<string>>[]>;
+    fetchUserAdminConfig: (id: IntegerId) => Promise<UserAdminConfig<UserAdminConfigDataFilterBookmark | UserAdminConfigDataPinnedWidgets<string>>>;
+    createUserAdminConfig: (data: UserAdminConfig) => Promise<UserAdminConfig<UserAdminConfigDataFilterBookmark | UserAdminConfigDataPinnedWidgets<string>>>;
+    updateUserAdminConfig: (id: IntegerId, data: UserAdminConfig) => Promise<UserAdminConfig<UserAdminConfigDataFilterBookmark | UserAdminConfigDataPinnedWidgets<string>>>;
     deleteUserAdminConfig: (id: IntegerId) => Promise<unknown>;
     updateUserAdminConfigPositions: (ids: IntegerId[]) => Promise<{
         userAdminConfigs: IntegerId[];