@anzusystems/common-admin 1.47.0-beta.dev-1771794052 → 1.47.0-beta.dev-1771894800

package/dist/labs.d.ts

@@ -40,9 +40,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 +65,8 @@ onSubmit?: (() => any) | undefined;
 onBookmarkLoadAfter?: (() => any) | undefined;
 }>, {
 userId: IntegerIdNullable;
-hideButtons: boolean;
 client: () => AxiosInstance;
+hideButtons: boolean;
 formName: string;
 disableFilterUrlSync: boolean;
 store: FilterStoreIdentifier | boolean;
@@ -579,46 +579,15 @@ declare type DatetimeUTCNullable = string | null;
  */
 declare type DocId = string;
 
-declare interface ExecuteFetchByIdsFn<R> {
-    /** @deprecated Use object params form: executeFetch(ids, { urlTemplateOverride, urlParamsOverride }) */
-    (ids: DocId[] | IntegerId[], urlTemplateOverride?: string, urlParamsOverride?: UrlParams): Promise<R>;
-    (ids: DocId[] | IntegerId[], params?: FetchByIdsParams): Promise<R>;
-}
-
-declare interface ExecuteFetchListBatchFn<R> {
-    /**
-     * @deprecated Use object params form:
-     *   executeFetch(filterData, filterConfig,
-     *     { urlTemplateOverride, urlParamsOverride, sortBy, sortDesc, batchSize, forceElastic })
-     */
-    (filterData: FilterData<any>, filterConfig: FilterConfig<any>, urlTemplateOverride?: string, urlParamsOverride?: UrlParams, sortBy?: string, sortDesc?: boolean, batchSize?: number, forceElastic?: boolean): Promise<R>;
-    (filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListBatchParams): Promise<R>;
-}
-
-declare interface ExecuteFetchListFn<R> {
-    /**
-     * @deprecated Use object params form:
-     *   executeFetch(pagination, filterData, filterConfig, { urlTemplateOverride, urlParamsOverride, forceElastic })
-     */
-    (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, urlTemplateOverride?: string | undefined, urlParamsOverride?: UrlParams | undefined, forceElastic?: boolean): Promise<R>;
-    (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListParams): Promise<R>;
-}
-
-declare interface ExecuteRequestFn<R, T> {
-    /** @deprecated Use object params form: executeRequest({ urlTemplateOverride, urlParamsOverride, object }) */
-    (urlTemplateOverride?: string, urlParamsOverride?: UrlParams | undefined, object?: T | undefined): Promise<R>;
-    (params: ExecuteRequestParams<T>): Promise<R>;
-}
-
 declare type ExecuteRequestParams<T> = {
-    urlTemplateOverride?: string;
-    urlParamsOverride?: UrlParams;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
     object?: T;
 };
 
 declare type FetchByIdsParams = {
-    urlTemplateOverride?: string;
-    urlParamsOverride?: UrlParams;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
 };
 
 declare type FetchItemsMinimalByIdsType = ((ids: IntegerId[]) => Promise<any[]>) | ((ids: DocId[]) => Promise<any[]>);
@@ -626,8 +595,8 @@ declare type FetchItemsMinimalByIdsType = ((ids: IntegerId[]) => Promise<any[]>)
 declare type FetchItemsMinimalType = (pagination: Ref<Pagination>, filterData: FilterData, filterConfig: FilterConfig) => Promise<any[]>;
 
 declare type FetchListBatchParams = {
-    urlTemplateOverride?: string;
-    urlParamsOverride?: UrlParams;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
     sortBy?: string;
     sortDesc?: boolean;
     batchSize?: number;
@@ -635,8 +604,8 @@ declare type FetchListBatchParams = {
 };
 
 declare type FetchListParams = {
-    urlTemplateOverride?: string;
-    urlParamsOverride?: UrlParams;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
     forceElastic?: boolean;
 };
 
@@ -812,17 +781,11 @@ declare type UrlParams = {
 };
 
 declare type UseApiAnyRequestReturnType<R, T = R> = {
-    executeRequest: ExecuteRequestFn<R, T>;
+    executeRequest: (params?: ExecuteRequestParams<T>) => Promise<R>;
     abortRequest: () => void;
 };
 
-/**
- * @deprecated Use object params form:
- *   useApiFetchByIds({ client, system, entity, urlTemplate, urlParams, options, isSearchApi, field })
- */
-export declare function useApiFetchByIds<R>(client: AxiosClientFn, system: string, entity: string, urlTemplate?: string, urlParams?: UrlParams, options?: AxiosRequestConfig, isSearchApi?: boolean, field?: string): UseApiFetchByIdsReturnType<R>;
-
-export declare function useApiFetchByIds<R>(params: UseApiFetchByIdsParams): UseApiFetchByIdsReturnType<R>;
+export declare const useApiFetchByIds: <R>(params: UseApiFetchByIdsParams) => UseApiFetchByIdsReturnType<R>;
 
 declare type UseApiFetchByIdsParams = {
     client: AxiosClientFn;
@@ -836,33 +799,13 @@ declare type UseApiFetchByIdsParams = {
 };
 
 declare type UseApiFetchByIdsReturnType<R> = {
-    executeFetch: ExecuteFetchByIdsFn<R>;
+    executeFetch: (ids: DocId[] | IntegerId[], params?: FetchByIdsParams) => Promise<R>;
     abortFetch: () => void;
 };
 
-/**
- * @template R Response type override, optional
- * @deprecated Use object params form:
- *   useApiFetchList({ client, system, entity, urlTemplate, urlParams, options })
- */
-export declare function useApiFetchList<R>(client: AxiosClientFn, system: string, entity: string, urlTemplate?: string, urlParams?: UrlParams, options?: AxiosRequestConfig): UseApiFetchListReturnType<R>;
+export declare const useApiFetchList: <R>(params: UseApiFetchListParams) => UseApiFetchListReturnType<R>;
 
-/**
- * @template R Response type override, optional
- */
-export declare function useApiFetchList<R>(params: UseApiFetchListParams): UseApiFetchListReturnType<R>;
-
-/**
- * @template R Response type override
- * @deprecated Use object params form:
- *   useApiFetchListBatch({ client, system, entity, urlTemplate, urlParams, options })
- */
-export declare function useApiFetchListBatch<R>(client: AxiosClientFn, system: string, entity: string, urlTemplate?: string, urlParams?: UrlParams, options?: AxiosRequestConfig): UseApiFetchListBatchReturnType<R>;
-
-/**
- * @template R Response type override
- */
-export declare function useApiFetchListBatch<R>(params: UseApiFetchListBatchParams): UseApiFetchListBatchReturnType<R>;
+export declare const useApiFetchListBatch: <R>(params: UseApiFetchListBatchParams) => UseApiFetchListBatchReturnType<R>;
 
 declare type UseApiFetchListBatchParams = {
     client: AxiosClientFn;
@@ -874,7 +817,7 @@ declare type UseApiFetchListBatchParams = {
 };
 
 declare type UseApiFetchListBatchReturnType<R> = {
-    executeFetch: ExecuteFetchListBatchFn<R>;
+    executeFetch: (filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListBatchParams) => Promise<R>;
     abortFetch: () => void;
 };
 
@@ -888,7 +831,7 @@ declare type UseApiFetchListParams = {
 };
 
 declare type UseApiFetchListReturnType<R> = {
-    executeFetch: ExecuteFetchListFn<R>;
+    executeFetch: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListParams) => Promise<R>;
     abortFetch: () => void;
 };
 
@@ -910,19 +853,7 @@ export declare function useApiQueryBuilder(): {
     q: Ref<string[], string[]>;
 };
 
-/**
- * @template R Response type
- * @template T Type used for request payload, by default, same as Response type
- * @deprecated Use object params form:
- *   useApiRequest({ client, method, system, entity, urlTemplate, urlParams, options })
- */
-export declare function useApiRequest<R, T = R>(client: AxiosClientFn, method: Method, system: string, entity: string, urlTemplate?: string, urlParams?: UrlParams, options?: AxiosRequestConfig): UseApiAnyRequestReturnType<R, T>;
-
-/**
- * @template R Response type
- * @template T Type used for request payload, by default, same as Response type
- */
-export declare function useApiRequest<R, T = R>(params: UseApiRequestParams): UseApiAnyRequestReturnType<R, T>;
+export declare const useApiRequest: <R, T = R>(params: UseApiRequestParams) => UseApiAnyRequestReturnType<R, T>;
 
 declare type UseApiRequestParams = {
     client: AxiosClientFn;
@@ -1004,7 +935,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>;