@refinedev/core 4.51.0 → 4.52.0

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

@@ -1 +1,167 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useTable/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAEnD,OAAO,KAAK,EACV,mBAAmB,EACnB,eAAe,EAChB,MAAM,uBAAuB,CAAC;AA4B/B,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,QAAQ,EACR,eAAe,EACf,SAAS,EACT,SAAS,EACT,UAAU,EACV,QAAQ,EACT,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EACL,KAAK,8BAA8B,EACnC,KAAK,4BAA4B,EAElC,MAAM,uBAAuB,CAAC;AAE/B,KAAK,iBAAiB,GAAG,OAAO,GAAG,SAAS,CAAC;AAE7C,MAAM,MAAM,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,IAAI;IACvD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;QACrB;;;WAGG;QACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;QACvB;;;WAGG;QACH,IAAI,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;KACzB,CAAC;IACF;;;OAGG;IACH,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC3B;;;;OAIG;IACH,eAAe,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;QACvB;;;WAGG;QACH,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC;QACzB;;;WAGG;QACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;QACpC;;;WAGG;QACH,IAAI,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;KACzB,CAAC;IACF;;;OAGG;IACH,aAAa,CAAC,EAAE,UAAU,EAAE,CAAC;IAC7B;;;;OAIG;IACH,eAAe,CAAC,EAAE,UAAU,EAAE,CAAC;IAC/B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,iBAAiB,CAAC;IAC7C;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAC5B,eAAe,CAAC,YAAY,CAAC,EAC7B,MAAM,EACN,eAAe,CAAC,KAAK,CAAC,CACvB,CAAC;IACF;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,GAAG,wBAAwB,CAC1B,eAAe,CAAC,KAAK,CAAC,EACtB,MAAM,EACN,QAAQ,CAAC,aAAa,CAAC,CACxB,GACC,aAAa,GACb,8BAA8B,CAAC;AAEjC,KAAK,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhE,KAAK,sBAAsB,GAAG;IAC5B,UAAU,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpD;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IACpB,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,MAAM,SAAS,SAAS,GAAG,SAAS,IAClC;IACF,gBAAgB,EAAE,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACtE;;OAEG;IACH,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,IAAI,CAAC;IACxC,UAAU,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,IAAI,CAAC;IACzC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,QAAQ,CAAC,EAAE,iBAAiB,KAAK,IAAI,CAAC,GACzE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,KAAK,UAAU,EAAE,KAAK,IAAI,CAAC,CAAC;IAClE,6BAA6B,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,MAAM,CAAC;IAC1E,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,aAAa,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3D,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,4BAA4B,CAAC;AAkBjC,wBAAgB,QAAQ,CACtB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,EACA,cAAc,EACd,eAAe,EACf,aAAoB,EACpB,UAAU,EACV,aAAa,EACb,eAAwC,EACxC,wBAAwB,EACxB,aAAa,EACb,eAAwC,EACxC,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,EACxB,gBAAgB,EAAE,oBAAoB,EACtC,QAAQ,EAAE,gBAAgB,EAC1B,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,QAAQ,EAAE,gBAAgB,EAC1B,WAAW,EACX,UAAU,EACV,IAAI,EACJ,QAAQ,EACR,gBAAgB,EAChB,eAAe,GAChB,GAAE,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,CAAM,GAAG,kBAAkB,CACrE,KAAK,EACL,MAAM,CACP,CAmTA"}
+import React from "react";
+import type { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
+import type { BaseRecord, CrudFilter, CrudSort, GetListResponse, HttpError, MetaQuery, Pagination, Prettify } from "../../contexts/data/types";
+import type { LiveModeProps } from "../../contexts/live/types";
+import type { SuccessErrorNotification } from "../../contexts/notification/types";
+import type { BaseListProps } from "../data/useList";
+import { type UseLoadingOvertimeOptionsProps, type UseLoadingOvertimeReturnType } from "../useLoadingOvertime";
+type SetFilterBehavior = "merge" | "replace";
+export type useTableProps<TQueryFnData, TError, TData> = {
+    /**
+     * Resource name for API data interactions
+     * @default Resource name that it reads from route
+     */
+    resource?: string;
+    /**
+     * Configuration for pagination
+     */
+    pagination?: Pagination;
+    /**
+     * Initial page index
+     * @default 1
+     * @deprecated `initialCurrent` property is deprecated. Use `pagination.current` instead.
+     */
+    initialCurrent?: number;
+    /**
+     * Initial number of items per page
+     * @default 10
+     * @deprecated `initialPageSize` property is deprecated. Use `pagination.pageSize` instead.
+     */
+    initialPageSize?: number;
+    /**
+     * Sort configs
+     */
+    sorters?: {
+        /**
+         * Initial sorter state
+         */
+        initial?: CrudSort[];
+        /**
+         * Default and unchangeable sorter state
+         *  @default `[]`
+         */
+        permanent?: CrudSort[];
+        /**
+         * Whether to use server side sorting or not.
+         * @default "server"
+         */
+        mode?: "server" | "off";
+    };
+    /**
+     * Initial sorter state
+     * @deprecated `initialSorter` property is deprecated. Use `sorters.initial` instead.
+     */
+    initialSorter?: CrudSort[];
+    /**
+     * Default and unchangeable sorter state
+     *  @default `[]`
+     *  @deprecated `permanentSorter` property is deprecated. Use `sorters.permanent` instead.
+     */
+    permanentSorter?: CrudSort[];
+    /**
+     * Filter configs
+     */
+    filters?: {
+        /**
+         * Initial filter state
+         */
+        initial?: CrudFilter[];
+        /**
+         * Default and unchangeable filter state
+         *  @default `[]`
+         */
+        permanent?: CrudFilter[];
+        /**
+         * Default behavior of the `setFilters` function
+         * @default `"merge"`
+         */
+        defaultBehavior?: SetFilterBehavior;
+        /**
+         * Whether to use server side filter or not.
+         * @default "server"
+         */
+        mode?: "server" | "off";
+    };
+    /**
+     * Initial filter state
+     * @deprecated `initialFilter` property is deprecated. Use `filters.initial` instead.
+     */
+    initialFilter?: CrudFilter[];
+    /**
+     * Default and unchangeable filter state
+     * @default `[]`
+     * @deprecated `permanentFilter` property is deprecated. Use `filters.permanent` instead.
+     */
+    permanentFilter?: CrudFilter[];
+    /**
+     * Default behavior of the `setFilters` function
+     * @default `"merge"`
+     * @deprecated `defaultSetFilterBehavior` property is deprecated. Use `filters.defaultBehavior` instead.
+     */
+    defaultSetFilterBehavior?: SetFilterBehavior;
+    /**
+     * Whether to use server side pagination or not.
+     * @default `true`
+     * @deprecated `hasPagination` property is deprecated. Use `pagination.mode` instead.
+     */
+    hasPagination?: boolean;
+    /**
+     * Sortings, filters, page index and records shown per page are tracked by browser history
+     * @default Value set in [Refine](/docs/api-reference/core/components/refine-config/#syncwithlocation). If a custom resource is given, it will be `false`
+     */
+    syncWithLocation?: boolean;
+    /**
+     * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+     */
+    queryOptions?: UseQueryOptions<GetListResponse<TQueryFnData>, TError, GetListResponse<TData>>;
+    /**
+     * Metadata query for dataProvider
+     */
+    meta?: MetaQuery;
+    /**
+     * Metadata query for dataProvider
+     * @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.
+     */
+    dataProviderName?: string;
+} & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
+type ReactSetState<T> = React.Dispatch<React.SetStateAction<T>>;
+type SyncWithLocationParams = {
+    pagination: {
+        current?: number;
+        pageSize?: number;
+    };
+    /**
+     * @deprecated `sorter` is deprecated. Use `sorters` instead.
+     */
+    sorter?: CrudSort[];
+    sorters: CrudSort[];
+    filters: CrudFilter[];
+};
+export type useTableReturnType<TData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError> = {
+    tableQueryResult: QueryObserverResult<GetListResponse<TData>, TError>;
+    /**
+     * @deprecated `sorter` is deprecated. Use `sorters` instead.
+     */
+    sorter: CrudSort[];
+    sorters: CrudSort[];
+    /**
+     * @deprecated `setSorter` is deprecated. Use `setSorters` instead.
+     */
+    setSorter: (sorter: CrudSort[]) => void;
+    setSorters: (sorter: CrudSort[]) => void;
+    filters: CrudFilter[];
+    setFilters: ((filters: CrudFilter[], behavior?: SetFilterBehavior) => void) & ((setter: (prevFilters: CrudFilter[]) => CrudFilter[]) => void);
+    createLinkForSyncWithLocation: (params: SyncWithLocationParams) => string;
+    current: number;
+    setCurrent: ReactSetState<useTableReturnType["current"]>;
+    pageSize: number;
+    setPageSize: ReactSetState<useTableReturnType["pageSize"]>;
+    pageCount: number;
+} & UseLoadingOvertimeReturnType;
+export declare function useTable<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TData extends BaseRecord = TQueryFnData>({ initialCurrent, initialPageSize, hasPagination, pagination, initialSorter, permanentSorter, defaultSetFilterBehavior, initialFilter, permanentFilter, filters: filtersFromProp, sorters: sortersFromProp, syncWithLocation: syncWithLocationProp, resource: resourceFromProp, successNotification, errorNotification, queryOptions, liveMode: liveModeFromProp, onLiveEvent, liveParams, meta, metaData, dataProviderName, overtimeOptions, }?: useTableProps<TQueryFnData, TError, TData>): useTableReturnType<TData, TError>;
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -1 +1,3 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useTelemetryData/index.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAKvE,eAAO,MAAM,gBAAgB,QAAO,cA0DnC,CAAC"}
+import type { ITelemetryData } from "../../components/telemetry/types";
+export declare const useTelemetryData: () => ITelemetryData;
+//# sourceMappingURL=index.d.ts.map