@refinedev/core 4.48.0 → 4.49.0

package/dist/hooks/use-resource-params/index.d.ts

@@ -0,0 +1,43 @@
+import React from "react";
+import { BaseKey } from "../../contexts/data/types";
+import { IResourceItem } from "../../contexts/resource/types";
+import { Action } from "../../contexts/router/types";
+import { FormAction } from "../form/types";
+type Props = {
+    id?: BaseKey;
+    resource?: string;
+    action?: Action;
+};
+type ResourceParams = {
+    id?: BaseKey;
+    setId: React.Dispatch<React.SetStateAction<BaseKey | undefined>>;
+    resource?: IResourceItem;
+    action?: Action;
+    identifier?: string;
+    formAction: FormAction;
+};
+/**
+ * Interactions in Refine has 3 main parameters: resource, action and id.
+ *
+ * This hook is used to manage these parameters based on below conditions and outputs the final parameters.
+ *
+ * `resource`: The resource to be used. (either the identifier or the name of the resource)
+ * - If a `resource` is provided, it will be used (even if it's not defined in the <Refine/> component)
+ * - If a `resource` is not provided, it will be inferred from the route.
+ * `id`: The `id` of the record to be used.
+ * - If an `id` is provided, it will be used.
+ * - If an `id` is not provided, it will either be inferred from the route or will be `undefined`.
+ * -- If a custom resource is provided and it's different from the inferred resource, the id will be undefined.
+ * -- If a custom resource is provided and it's same as the inferred resource, the id will be inferred from the route.
+ * -- If a custom resource is not provided, the id will be inferred from the route.
+ * `action`: The action to be used.
+ * - If an `action` is provided, it will be used.
+ * - If an `action` is not provided, it will be inferred from the route.
+ * `formAction`: The action to be used in the form.
+ * - `formAction` can only be "edit", "clone" or "create".
+ * - If action is "edit" or "clone", `formAction` will be the same as action.
+ * - Same as `id`, if passed resource is different from inferred resource, `formAction` will fallback to "create" and ignore the action from the route.
+ */
+export declare function useResourceParams(props?: Props): ResourceParams;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/use-resource-params/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-resource-params/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,KAAK,KAAK,GAAG;IACX,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;IACjE,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,cAAc,CAyC/D"}

package/dist/hooks/use-resource-params/use-action/index.d.cts

@@ -0,0 +1,12 @@
+import { Action } from "../../../contexts/router/types";
+/**
+ * Returns the action from the router regardless of the router type.
+ * In legacy routers, `useParsed` won't work and in the new router bindings, `useParams` won't work.
+ * To make it easier to get the action from the router, this hook can be used.
+ *
+ * Additionally, if an action is provided as a parameter, it will be used instead of the inferred action.
+ *
+ * @internal usage only
+ */
+export declare const useAction: (action?: Action) => Action | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/use-resource-params/use-action/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-resource-params/use-action/index.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAIxD;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,YAAa,MAAM,uBAWxC,CAAC"}

package/dist/hooks/use-resource-params/use-action/index.d.mts

@@ -0,0 +1,12 @@
+import { Action } from "../../../contexts/router/types";
+/**
+ * Returns the action from the router regardless of the router type.
+ * In legacy routers, `useParsed` won't work and in the new router bindings, `useParams` won't work.
+ * To make it easier to get the action from the router, this hook can be used.
+ *
+ * Additionally, if an action is provided as a parameter, it will be used instead of the inferred action.
+ *
+ * @internal usage only
+ */
+export declare const useAction: (action?: Action) => Action | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/use-resource-params/use-action/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-resource-params/use-action/index.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAIxD;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,YAAa,MAAM,uBAWxC,CAAC"}

package/dist/hooks/use-resource-params/use-action/index.d.ts

@@ -0,0 +1,12 @@
+import { Action } from "../../../contexts/router/types";
+/**
+ * Returns the action from the router regardless of the router type.
+ * In legacy routers, `useParsed` won't work and in the new router bindings, `useParams` won't work.
+ * To make it easier to get the action from the router, this hook can be used.
+ *
+ * Additionally, if an action is provided as a parameter, it will be used instead of the inferred action.
+ *
+ * @internal usage only
+ */
+export declare const useAction: (action?: Action) => Action | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/use-resource-params/use-action/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-resource-params/use-action/index.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAIxD;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,YAAa,MAAM,uBAWxC,CAAC"}

package/dist/hooks/use-resource-params/use-id/index.d.cts

@@ -0,0 +1,12 @@
+import { BaseKey } from "../../../contexts/data/types";
+/**
+ * Returns the id from the router regardless of the router type.
+ * In legacy routers, `useParsed` won't work and in the new router bindings, `useParams` won't work.
+ * To make it easier to get the id from the router, this hook can be used.
+ *
+ * Additionally, if an id is provided as a parameter, it will be used instead of the inferred id.
+ *
+ * @internal usage only
+ */
+export declare const useId: (id?: BaseKey) => BaseKey | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/use-resource-params/use-id/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-resource-params/use-id/index.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAIvD;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,QAAS,OAAO,wBAUjC,CAAC"}

package/dist/hooks/use-resource-params/use-id/index.d.mts

@@ -0,0 +1,12 @@
+import { BaseKey } from "../../../contexts/data/types";
+/**
+ * Returns the id from the router regardless of the router type.
+ * In legacy routers, `useParsed` won't work and in the new router bindings, `useParams` won't work.
+ * To make it easier to get the id from the router, this hook can be used.
+ *
+ * Additionally, if an id is provided as a parameter, it will be used instead of the inferred id.
+ *
+ * @internal usage only
+ */
+export declare const useId: (id?: BaseKey) => BaseKey | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/use-resource-params/use-id/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-resource-params/use-id/index.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAIvD;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,QAAS,OAAO,wBAUjC,CAAC"}

package/dist/hooks/use-resource-params/use-id/index.d.ts

@@ -0,0 +1,12 @@
+import { BaseKey } from "../../../contexts/data/types";
+/**
+ * Returns the id from the router regardless of the router type.
+ * In legacy routers, `useParsed` won't work and in the new router bindings, `useParams` won't work.
+ * To make it easier to get the id from the router, this hook can be used.
+ *
+ * Additionally, if an id is provided as a parameter, it will be used instead of the inferred id.
+ *
+ * @internal usage only
+ */
+export declare const useId: (id?: BaseKey) => BaseKey | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/use-resource-params/use-id/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/use-resource-params/use-id/index.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAIvD;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK,QAAS,OAAO,wBAUjC,CAAC"}

package/dist/hooks/useKeys/index.d.cts

@@ -0,0 +1,5 @@
+export declare const useKeys: () => {
+    keys: () => import("@definitions/index").KeyBuilder;
+    preferLegacyKeys: boolean;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/useKeys/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useKeys/index.tsx"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO;;;CASnB,CAAC"}

package/dist/hooks/useKeys/index.d.mts

@@ -0,0 +1,5 @@
+export declare const useKeys: () => {
+    keys: () => import("@definitions/index").KeyBuilder;
+    preferLegacyKeys: boolean;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/useKeys/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useKeys/index.tsx"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO;;;CASnB,CAAC"}

package/dist/hooks/useLoadingOvertime/index.d.cts

@@ -0,0 +1,49 @@
+export type UseLoadingOvertimeRefineContext = Omit<UseLoadingOvertimeCoreProps, "isLoading" | "interval"> & Required<Pick<UseLoadingOvertimeCoreProps, "interval">>;
+export type UseLoadingOvertimeOptionsProps = {
+    overtimeOptions?: UseLoadingOvertimeCoreOptions;
+};
+export type UseLoadingOvertimeReturnType = {
+    overtime: {
+        elapsedTime?: number;
+    };
+};
+type UseLoadingOvertimeCoreOptions = Omit<UseLoadingOvertimeCoreProps, "isLoading">;
+type UseLoadingOvertimeCoreReturnType = {
+    elapsedTime?: number;
+};
+export type UseLoadingOvertimeCoreProps = {
+    /**
+     * The loading state. If true, the elapsed time will be calculated.
+     */
+    isLoading: boolean;
+    /**
+     * The interval in milliseconds. If the loading time exceeds this time, the `onInterval` callback will be called.
+     * If not specified, the `interval` value from the `overtime` option of the `RefineProvider` will be used.
+     *
+     * @default: 1000 (1 second)
+     */
+    interval?: number;
+    /**
+     * The callback function that will be called when the loading time exceeds the specified time.
+     * If not specified, the `onInterval` value from the `overtime` option of the `RefineProvider` will be used.
+     *
+     * @param elapsedInterval The elapsed time in milliseconds.
+     */
+    onInterval?: (elapsedInterval: number) => void;
+};
+/**
+ * if you need to do something when the loading time exceeds the specified time, refine provides the `useLoadingOvertime` hook.
+ * It returns the elapsed time in milliseconds.
+ *
+ * @example
+ * const { elapsedTime } = useLoadingOvertime({
+ *    isLoading,
+ *    interval: 1000,
+ *    onInterval(elapsedInterval) {
+ *        console.log("loading overtime", elapsedInterval);
+ *    },
+ * });
+ */
+export declare const useLoadingOvertime: ({ isLoading, interval: intervalProp, onInterval: onIntervalProp, }: UseLoadingOvertimeCoreProps) => UseLoadingOvertimeCoreReturnType;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/useLoadingOvertime/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useLoadingOvertime/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,+BAA+B,GAAG,IAAI,CAChD,2BAA2B,EAC3B,WAAW,GAAG,UAAU,CACzB,GACC,QAAQ,CAAC,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC,CAAC;AAE1D,MAAM,MAAM,8BAA8B,GAAG;IAC3C,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,KAAK,6BAA6B,GAAG,IAAI,CACvC,2BAA2B,EAC3B,WAAW,CACZ,CAAC;AAEF,KAAK,gCAAgC,GAAG;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB,uEAI5B,2BAA2B,KAAG,gCA2ChC,CAAC"}

package/dist/hooks/useLoadingOvertime/index.d.mts

@@ -0,0 +1,49 @@
+export type UseLoadingOvertimeRefineContext = Omit<UseLoadingOvertimeCoreProps, "isLoading" | "interval"> & Required<Pick<UseLoadingOvertimeCoreProps, "interval">>;
+export type UseLoadingOvertimeOptionsProps = {
+    overtimeOptions?: UseLoadingOvertimeCoreOptions;
+};
+export type UseLoadingOvertimeReturnType = {
+    overtime: {
+        elapsedTime?: number;
+    };
+};
+type UseLoadingOvertimeCoreOptions = Omit<UseLoadingOvertimeCoreProps, "isLoading">;
+type UseLoadingOvertimeCoreReturnType = {
+    elapsedTime?: number;
+};
+export type UseLoadingOvertimeCoreProps = {
+    /**
+     * The loading state. If true, the elapsed time will be calculated.
+     */
+    isLoading: boolean;
+    /**
+     * The interval in milliseconds. If the loading time exceeds this time, the `onInterval` callback will be called.
+     * If not specified, the `interval` value from the `overtime` option of the `RefineProvider` will be used.
+     *
+     * @default: 1000 (1 second)
+     */
+    interval?: number;
+    /**
+     * The callback function that will be called when the loading time exceeds the specified time.
+     * If not specified, the `onInterval` value from the `overtime` option of the `RefineProvider` will be used.
+     *
+     * @param elapsedInterval The elapsed time in milliseconds.
+     */
+    onInterval?: (elapsedInterval: number) => void;
+};
+/**
+ * if you need to do something when the loading time exceeds the specified time, refine provides the `useLoadingOvertime` hook.
+ * It returns the elapsed time in milliseconds.
+ *
+ * @example
+ * const { elapsedTime } = useLoadingOvertime({
+ *    isLoading,
+ *    interval: 1000,
+ *    onInterval(elapsedInterval) {
+ *        console.log("loading overtime", elapsedInterval);
+ *    },
+ * });
+ */
+export declare const useLoadingOvertime: ({ isLoading, interval: intervalProp, onInterval: onIntervalProp, }: UseLoadingOvertimeCoreProps) => UseLoadingOvertimeCoreReturnType;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/useLoadingOvertime/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useLoadingOvertime/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,+BAA+B,GAAG,IAAI,CAChD,2BAA2B,EAC3B,WAAW,GAAG,UAAU,CACzB,GACC,QAAQ,CAAC,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC,CAAC;AAE1D,MAAM,MAAM,8BAA8B,GAAG;IAC3C,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,KAAK,6BAA6B,GAAG,IAAI,CACvC,2BAA2B,EAC3B,WAAW,CACZ,CAAC;AAEF,KAAK,gCAAgC,GAAG;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB,uEAI5B,2BAA2B,KAAG,gCA2ChC,CAAC"}

package/dist/hooks/useLoadingOvertime/index.d.ts

@@ -1,17 +1,17 @@
-export declare type UseLoadingOvertimeRefineContext = Omit<UseLoadingOvertimeCoreProps, "isLoading" | "interval"> & Required<Pick<UseLoadingOvertimeCoreProps, "interval">>;
-export declare type UseLoadingOvertimeOptionsProps = {
+export type UseLoadingOvertimeRefineContext = Omit<UseLoadingOvertimeCoreProps, "isLoading" | "interval"> & Required<Pick<UseLoadingOvertimeCoreProps, "interval">>;
+export type UseLoadingOvertimeOptionsProps = {
     overtimeOptions?: UseLoadingOvertimeCoreOptions;
 };
-export declare type UseLoadingOvertimeReturnType = {
+export type UseLoadingOvertimeReturnType = {
     overtime: {
         elapsedTime?: number;
     };
 };
-declare type UseLoadingOvertimeCoreOptions = Omit<UseLoadingOvertimeCoreProps, "isLoading">;
-declare type UseLoadingOvertimeCoreReturnType = {
+type UseLoadingOvertimeCoreOptions = Omit<UseLoadingOvertimeCoreProps, "isLoading">;
+type UseLoadingOvertimeCoreReturnType = {
     elapsedTime?: number;
 };
-export declare type UseLoadingOvertimeCoreProps = {
+export type UseLoadingOvertimeCoreProps = {
     /**
      * The loading state. If true, the elapsed time will be calculated.
      */

package/dist/hooks/useLoadingOvertime/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useLoadingOvertime/index.ts"],"names":[],"mappings":"AAGA,oBAAY,+BAA+B,GAAG,IAAI,CAChD,2BAA2B,EAC3B,WAAW,GAAG,UAAU,CACzB,GACC,QAAQ,CAAC,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC,CAAC;AAE1D,oBAAY,8BAA8B,GAAG;IAC3C,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD,CAAC;AAEF,oBAAY,4BAA4B,GAAG;IACzC,QAAQ,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,aAAK,6BAA6B,GAAG,IAAI,CACvC,2BAA2B,EAC3B,WAAW,CACZ,CAAC;AAEF,aAAK,gCAAgC,GAAG;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB,uEAI5B,2BAA2B,KAAG,gCA2ChC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useLoadingOvertime/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,+BAA+B,GAAG,IAAI,CAChD,2BAA2B,EAC3B,WAAW,GAAG,UAAU,CACzB,GACC,QAAQ,CAAC,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC,CAAC;AAE1D,MAAM,MAAM,8BAA8B,GAAG;IAC3C,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,KAAK,6BAA6B,GAAG,IAAI,CACvC,2BAA2B,EAC3B,WAAW,CACZ,CAAC;AAEF,KAAK,gCAAgC,GAAG;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB,uEAI5B,2BAA2B,KAAG,gCA2ChC,CAAC"}

package/dist/hooks/useMeta/index.d.cts

@@ -0,0 +1,19 @@
+import { MetaQuery } from "../../contexts/data/types";
+import { IResourceItem } from "../../contexts/resource/types";
+/**
+ * Hook that returns a function to get meta.
+ * The meta is a combination of the resource meta, hook meta and query params.
+ * @internal
+ */
+export declare const useMeta: () => ({ resource, meta: metaFromProp, }?: {
+    resource?: IResourceItem | undefined;
+    meta?: MetaQuery | undefined;
+}) => {
+    queryContext?: Omit<import("@tanstack/query-core").QueryFunctionContext<import("@tanstack/query-core").QueryKey, any>, "meta"> | undefined;
+    operation?: string | undefined;
+    fields?: import("../../contexts/data/types").Fields | undefined;
+    variables?: import("../../contexts/data/types").VariableOptions | undefined;
+    gqlQuery?: import("graphql").DocumentNode | undefined;
+    gqlMutation?: import("graphql").DocumentNode | undefined;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/useMeta/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useMeta/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;CAyBnB,CAAC"}

package/dist/hooks/useMeta/index.d.mts

@@ -0,0 +1,19 @@
+import { MetaQuery } from "../../contexts/data/types";
+import { IResourceItem } from "../../contexts/resource/types";
+/**
+ * Hook that returns a function to get meta.
+ * The meta is a combination of the resource meta, hook meta and query params.
+ * @internal
+ */
+export declare const useMeta: () => ({ resource, meta: metaFromProp, }?: {
+    resource?: IResourceItem | undefined;
+    meta?: MetaQuery | undefined;
+}) => {
+    queryContext?: Omit<import("@tanstack/query-core").QueryFunctionContext<import("@tanstack/query-core").QueryKey, any>, "meta"> | undefined;
+    operation?: string | undefined;
+    fields?: import("../../contexts/data/types").Fields | undefined;
+    variables?: import("../../contexts/data/types").VariableOptions | undefined;
+    gqlQuery?: import("graphql").DocumentNode | undefined;
+    gqlMutation?: import("graphql").DocumentNode | undefined;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/useMeta/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useMeta/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;CAyBnB,CAAC"}

package/dist/hooks/useMeta/index.d.ts

@@ -1,4 +1,5 @@
-import { IResourceItem, MetaQuery } from "../../interfaces";
+import { MetaQuery } from "../../contexts/data/types";
+import { IResourceItem } from "../../contexts/resource/types";
 /**
  * Hook that returns a function to get meta.
  * The meta is a combination of the resource meta, hook meta and query params.
@@ -10,8 +11,8 @@ export declare const useMeta: () => ({ resource, meta: metaFromProp, }?: {
 }) => {
     queryContext?: Omit<import("@tanstack/query-core").QueryFunctionContext<import("@tanstack/query-core").QueryKey, any>, "meta"> | undefined;
     operation?: string | undefined;
-    fields?: import("../../interfaces/metaData/fields").Fields | undefined;
-    variables?: import("../../interfaces/metaData/variableOptions").VariableOptions | undefined;
+    fields?: import("../../contexts/data/types").Fields | undefined;
+    variables?: import("../../contexts/data/types").VariableOptions | undefined;
     gqlQuery?: import("graphql").DocumentNode | undefined;
     gqlMutation?: import("graphql").DocumentNode | undefined;
 };

package/dist/hooks/useMeta/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useMeta/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;CAyBnB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useMeta/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;CAyBnB,CAAC"}

package/dist/hooks/useSelect/index.d.cts

@@ -0,0 +1,131 @@
+import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
+import { BaseKey, BaseOption, BaseRecord, CrudFilter, CrudSort, GetListResponse, GetManyResponse, HttpError, MetaQuery, Pagination, Prettify } from "../../contexts/data/types";
+import { LiveModeProps } from "../../contexts/live/types";
+import { SuccessErrorNotification } from "../../contexts/notification/types";
+import { BaseListProps } from "../data/useList";
+import { UseLoadingOvertimeOptionsProps, UseLoadingOvertimeReturnType } from "../useLoadingOvertime";
+export type UseSelectProps<TQueryFnData, TError, TData> = {
+    /**
+     * Resource name for API data interactions
+     */
+    resource: string;
+    /**
+     * Set the option's label value
+     * @default `"title"`
+     */
+    optionLabel?: keyof TData extends string ? keyof TData : never | ((item: TData) => string);
+    /**
+     * Set the option's value
+     * @default `"id"`
+     */
+    optionValue?: keyof TData extends string ? keyof TData : never | ((item: TData) => string);
+    /**
+     * Field name to search for.
+     * @description If provided `optionLabel` is a string, uses `optionLabel`'s value.
+     * @default `"title"`
+     * @example
+     * // when optionLabel is string.
+     * useSelect({ optionLabel: "name" })
+     * // uses `name` field.
+     * @example
+     * // when optionLabel is function.
+     * useSelect({ optionLabel: (field) => field.description })
+     * // uses `title`, since `optionLabel` is a function.
+     */
+    searchField?: keyof TData extends string ? keyof TData : never;
+    /**
+     * Allow us to sort the options
+     * @deprecated Use `sorters` instead
+     */
+    sort?: CrudSort[];
+    /**
+     * Allow us to sort the options
+     */
+    sorters?: CrudSort[];
+    /**
+     * Resource name for API data interactions
+     */
+    filters?: CrudFilter[];
+    /**
+     * Adds extra `options`
+     */
+    defaultValue?: BaseKey | BaseKey[];
+    /**
+     * The number of milliseconds to delay
+     * @default `300`
+     */
+    debounce?: number;
+    /**
+     * react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options
+     */
+    queryOptions?: UseQueryOptions<GetListResponse<TQueryFnData>, TError, GetListResponse<TData>>;
+    /**
+     * Pagination option from [`useList()`](/docs/api-reference/core/hooks/data/useList/)
+     * @type {  current?: number; pageSize?: number;}
+     * @default `undefined`
+     */
+    pagination?: Prettify<Omit<Pagination, "mode"> & {
+        /**
+         * Whether to use server side pagination or not.
+         * @default "off"
+         */
+        mode?: Pagination["mode"];
+    }>;
+    /**
+     * Disabling pagination option from [`useList()`](/docs/api-reference/core/hooks/data/useList/)
+     * @type boolean
+     * @default `false`
+     * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
+     */
+    hasPagination?: boolean;
+    /**
+     * react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options
+     */
+    defaultValueQueryOptions?: UseQueryOptions<GetManyResponse<TQueryFnData>, TError>;
+    /**
+     * If defined, this callback allows us to override all filters for every search request.
+     * @default `undefined`
+     */
+    onSearch?: (value: string) => CrudFilter[];
+    /**
+     * Additional meta data to pass to the `useMany` from the data provider
+     */
+    meta?: MetaQuery;
+    /**
+     * Additional meta data to pass to the `useMany` from the data provider
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+    /**
+     * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
+     * @default `default`
+     */
+    dataProviderName?: string;
+    /**
+     * Amount of records to fetch in select box list.
+     * @deprecated use [`pagination`](https://refine.dev/docs/api-reference/core/interfaceReferences/#pagination) instead
+     * @default `undefined`
+     */
+    fetchSize?: number;
+} & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
+export type UseSelectReturnType<TData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TOption extends BaseOption = BaseOption> = {
+    queryResult: QueryObserverResult<GetListResponse<TData>, TError>;
+    defaultValueQueryResult: QueryObserverResult<GetManyResponse<TData>>;
+    onSearch: (value: string) => void;
+    options: TOption[];
+} & UseLoadingOvertimeReturnType;
+/**
+ * `useSelect` hook is used to fetch data from the dataProvider and return the options for the select box.
+ *
+ * It uses `getList` method as query function from the dataProvider that is
+ * passed to {@link https://refine.dev/docs/api-reference/core/components/refine-config/ `<Refine>`}.
+ *
+ * @see {@link https://refine.dev/docs/api-reference/core/hooks/useSelect} for more details.
+ *
+ * @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
+ * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
+ * @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
+ *
+ */
+export declare const useSelect: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TData extends BaseRecord = TQueryFnData, TOption extends BaseOption = BaseOption>(props: UseSelectProps<TQueryFnData, TError, TData>) => UseSelectReturnType<TData, TError, TOption>;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/useSelect/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useSelect/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAQ7E,OAAO,EACL,OAAO,EACP,UAAU,EACV,UAAU,EACV,UAAU,EACV,QAAQ,EACR,eAAe,EACf,eAAe,EACf,SAAS,EACT,SAAS,EACT,UAAU,EACV,QAAQ,EACT,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAE7B,MAAM,uBAAuB,CAAC;AAE/B,MAAM,MAAM,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,IAAI;IACxD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,KAAK,SAAS,MAAM,GACpC,MAAM,KAAK,GACX,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,KAAK,MAAM,CAAC,CAAC;IACtC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,KAAK,SAAS,MAAM,GACpC,MAAM,KAAK,GACX,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,KAAK,MAAM,CAAC,CAAC;IACtC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,MAAM,KAAK,SAAS,MAAM,GAAG,MAAM,KAAK,GAAG,KAAK,CAAC;IAC/D;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAC5B,eAAe,CAAC,YAAY,CAAC,EAC7B,MAAM,EACN,eAAe,CAAC,KAAK,CAAC,CACvB,CAAC;IACF;;;;OAIG;IACH,UAAU,CAAC,EAAE,QAAQ,CACnB,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;QACzB;;;WAGG;QACH,IAAI,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;KAC3B,CACF,CAAC;IACF;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,wBAAwB,CAAC,EAAE,eAAe,CACxC,eAAe,CAAC,YAAY,CAAC,EAC7B,MAAM,CACP,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,EAAE,CAAC;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GAAG,wBAAwB,CAC1B,eAAe,CAAC,KAAK,CAAC,EACtB,MAAM,EACN,QAAQ,CAAC,aAAa,CAAC,CACxB,GACC,aAAa,GACb,8BAA8B,CAAC;AAEjC,MAAM,MAAM,mBAAmB,CAC7B,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,OAAO,SAAS,UAAU,GAAG,UAAU,IACrC;IACF,WAAW,EAAE,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACjE,uBAAuB,EAAE,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IACrE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,OAAO,EAAE,OAAO,EAAE,CAAC;CACpB,GAAG,4BAA4B,CAAC;AAEjC;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,SAAS,gLAMb,eAAe,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,KACjD,oBAAoB,KAAK,EAAE,MAAM,EAAE,OAAO,CAuL5C,CAAC"}