@refinedev/core 4.47.2 → 4.48.0

package/src/interfaces/index.ts

@@ -57,30 +57,28 @@ export * from "./auditLog";
 
 export type BaseKey = string | number;
 export type BaseRecord = {
-    id?: BaseKey;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    [key: string]: any;
+  id?: BaseKey;
+  [key: string]: any;
 };
 export type BaseOption = {
-    label: any;
-    value: any;
+  label: any;
+  value: any;
 };
 
 /**
  * @deprecated Use `BaseOption` instead.
  */
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface Option extends BaseOption {}
 
 /* Backward compatible version of 'TreeMenuItem' */
 export type ITreeMenu = IResourceItem & {
-    key?: string;
-    children: ITreeMenu[];
+  key?: string;
+  children: ITreeMenu[];
 };
 
 export type IMenuItem = IResourceItem & {
-    key: string;
-    route: string;
+  key: string;
+  route: string;
 };
 
 export * from "./form-url-params";

package/src/interfaces/live/LiveEvent.ts

@@ -1,14 +1,14 @@
 import { BaseKey, MetaQuery } from "..";
 
 export type LiveEvent = {
-    channel: string;
-    type: "deleted" | "updated" | "created" | "*" | string;
-    payload: {
-        ids?: BaseKey[];
-        [x: string]: any;
-    };
-    date: Date;
-    meta?: MetaQuery & {
-        dataProviderName?: string;
-    };
+  channel: string;
+  type: "deleted" | "updated" | "created" | "*" | string;
+  payload: {
+    ids?: BaseKey[];
+    [x: string]: any;
+  };
+  date: Date;
+  meta?: MetaQuery & {
+    dataProviderName?: string;
+  };
 };

package/src/interfaces/live/LiveModeProps.ts

@@ -2,27 +2,27 @@ import { LiveEvent } from ".";
 import { BaseKey } from "..";
 
 export type LiveModeProps = {
-    /**
-     * Whether to update data automatically ("auto") or not ("manual") if a related live event is received. The "off" value is used to avoid creating a subscription.
-     * @type  [`"auto" | "manual" | "off"`](/docs/api-reference/core/providers/live-provider/#livemode)
-     * @default `"off"`
-     */
-    liveMode?: "auto" | "manual" | "off";
-    /**
-     * Callback to handle all related live events of this hook.
-     * @type [`(event: LiveEvent) => void`](/docs/api-reference/core/interfaceReferences/#livemodeprops)
-     * @default `undefined`
-     */
-    onLiveEvent?: (event: LiveEvent) => void;
-    /**
-     * Params to pass to liveProvider's subscribe method if liveMode is enabled.
-     * @type [`{ ids?: BaseKey[]; [key: string]: any; }`](/docs/api-reference/core/interfaceReferences/#livemodeprops)
-     * @default `undefined`
-     */
-    liveParams?: {
-        ids?: BaseKey[];
-        [key: string]: any;
-    };
+  /**
+   * Whether to update data automatically ("auto") or not ("manual") if a related live event is received. The "off" value is used to avoid creating a subscription.
+   * @type  [`"auto" | "manual" | "off"`](/docs/api-reference/core/providers/live-provider/#livemode)
+   * @default `"off"`
+   */
+  liveMode?: "auto" | "manual" | "off";
+  /**
+   * Callback to handle all related live events of this hook.
+   * @type [`(event: LiveEvent) => void`](/docs/api-reference/core/interfaceReferences/#livemodeprops)
+   * @default `undefined`
+   */
+  onLiveEvent?: (event: LiveEvent) => void;
+  /**
+   * Params to pass to liveProvider's subscribe method if liveMode is enabled.
+   * @type [`{ ids?: BaseKey[]; [key: string]: any; }`](/docs/api-reference/core/interfaceReferences/#livemodeprops)
+   * @default `undefined`
+   */
+  liveParams?: {
+    ids?: BaseKey[];
+    [key: string]: any;
+  };
 };
 
 export type ILiveModeContextProvider = LiveModeProps;

package/src/interfaces/mapDataFn.ts

@@ -1,3 +1,3 @@
 export interface MapDataFn<TItem, TVariables> {
-    (item: TItem, index?: number, items?: TItem[]): TVariables;
+  (item: TItem, index?: number, items?: TItem[]): TVariables;
 }

package/src/interfaces/metaData/graphqlQueryOptions.ts

@@ -1,53 +1,53 @@
 import type { DocumentNode } from "graphql";
 
 export type GraphQLQueryOptions = {
-    /**
-     * @description GraphQL query to be used by data providers.
-     * @optional
-     * @example
-     * ```tsx
-     * import gql from 'graphql-tag'
-     * import { useOne } from '@refinedev/core'
-     *
-     * const PRODUCT_QUERY = gql`
-     *   query GetProduct($id: ID!) {
-     *     product(id: $id) {
-     *       id
-     *       name
-     *     }
-     *   }
-     * `
-     *
-     * useOne({
-     *   id: 1,
-     *   meta: { gqlQuery: PRODUCT_QUERY }
-     * })
-     * ```
-     */
-    gqlQuery?: DocumentNode;
-    /**
-     * @description GraphQL mutation to be used by data providers.
-     * @optional
-     * @example
-     * ```tsx
-     * import gql from 'graphql-tag'
-     * import { useCreate } from '@refinedev/core'
-     *
-     * const PRODUCT_CREATE_MUTATION = gql`
-     *   mutation CreateProduct($input: CreateOneProductInput!) {
-     *     createProduct(input: $input) {
-     *       id
-     *       name
-     *     }
-     *   }
-     * `
-     * const { mutate } = useCreate()
-     *
-     * mutate({
-     *   values: { name: "My Product" },
-     *   meta: { gqlQuery: PRODUCT_QUERY }
-     * })
-     * ```
-     */
-    gqlMutation?: DocumentNode;
+  /**
+   * @description GraphQL query to be used by data providers.
+   * @optional
+   * @example
+   * ```tsx
+   * import gql from 'graphql-tag'
+   * import { useOne } from '@refinedev/core'
+   *
+   * const PRODUCT_QUERY = gql`
+   *   query GetProduct($id: ID!) {
+   *     product(id: $id) {
+   *       id
+   *       name
+   *     }
+   *   }
+   * `
+   *
+   * useOne({
+   *   id: 1,
+   *   meta: { gqlQuery: PRODUCT_QUERY }
+   * })
+   * ```
+   */
+  gqlQuery?: DocumentNode;
+  /**
+   * @description GraphQL mutation to be used by data providers.
+   * @optional
+   * @example
+   * ```tsx
+   * import gql from 'graphql-tag'
+   * import { useCreate } from '@refinedev/core'
+   *
+   * const PRODUCT_CREATE_MUTATION = gql`
+   *   mutation CreateProduct($input: CreateOneProductInput!) {
+   *     createProduct(input: $input) {
+   *       id
+   *       name
+   *     }
+   *   }
+   * `
+   * const { mutate } = useCreate()
+   *
+   * mutate({
+   *   values: { name: "My Product" },
+   *   meta: { gqlQuery: PRODUCT_QUERY }
+   * })
+   * ```
+   */
+  gqlMutation?: DocumentNode;
 };

package/src/interfaces/metaData/metaDataQuery.ts

@@ -5,6 +5,6 @@ import { QueryBuilderOptions } from "./queryBuilderOptions";
  * @deprecated `MetaDataQuery` is deprecated with refine@4, use `MetaQuery` instead, however, we still support `MetaDataQuery` for backward compatibility.
  */
 export type MetaDataQuery = {
-    [k: string]: any;
-    queryContext?: Omit<QueryFunctionContext, "meta">;
+  [k: string]: any;
+  queryContext?: Omit<QueryFunctionContext, "meta">;
 } & QueryBuilderOptions;

package/src/interfaces/metaData/metaQuery.ts

@@ -3,7 +3,7 @@ import { QueryBuilderOptions } from "./queryBuilderOptions";
 import { GraphQLQueryOptions } from "./graphqlQueryOptions";
 
 export type MetaQuery = {
-    [k: string]: any;
-    queryContext?: Omit<QueryFunctionContext, "meta">;
+  [k: string]: any;
+  queryContext?: Omit<QueryFunctionContext, "meta">;
 } & QueryBuilderOptions &
-    GraphQLQueryOptions;
+  GraphQLQueryOptions;

package/src/interfaces/metaData/nestedField.ts

@@ -2,7 +2,7 @@ import { Fields } from "./fields";
 import { QueryBuilderOptions } from "./queryBuilderOptions";
 
 export type NestedField = {
-    operation: string;
-    variables: QueryBuilderOptions[];
-    fields: Fields;
+  operation: string;
+  variables: QueryBuilderOptions[];
+  fields: Fields;
 };

package/src/interfaces/metaData/queryBuilderOptions.ts

@@ -2,7 +2,7 @@ import { VariableOptions } from "./variableOptions";
 import { Fields } from "./fields";
 
 export interface QueryBuilderOptions {
-    operation?: string;
-    fields?: Fields;
-    variables?: VariableOptions;
+  operation?: string;
+  fields?: Fields;
+  variables?: VariableOptions;
 }

package/src/interfaces/metaData/variableOptions.ts

@@ -1,9 +1,9 @@
 export type VariableOptions =
-    | {
-          type?: string;
-          name?: string;
-          value: any;
-          list?: boolean;
-          required?: boolean;
-      }
-    | { [k: string]: any };
+  | {
+      type?: string;
+      name?: string;
+      value: any;
+      list?: boolean;
+      required?: boolean;
+    }
+  | { [k: string]: any };

package/src/interfaces/mutationMode.ts

@@ -1,32 +1,32 @@
 import {
-    BaseRecord,
-    GetListResponse,
-    GetOneResponse,
-    IQueryKeys,
+  BaseRecord,
+  GetListResponse,
+  GetOneResponse,
+  IQueryKeys,
 } from "../interfaces";
 import { QueryKey } from "@tanstack/react-query";
 
 export type MutationMode = "pessimistic" | "optimistic" | "undoable";
 
 export type QueryResponse<T = BaseRecord> =
-    | GetListResponse<T>
-    | GetOneResponse<T>;
+  | GetListResponse<T>
+  | GetOneResponse<T>;
 
 export type PreviousQuery<TData> = [QueryKey, TData | unknown];
 
 export type PrevContext<TData> = {
-    previousQueries: PreviousQuery<TData>[];
-    /**
-     * @deprecated `QueryKeys` is deprecated in favor of `keys`. Please use `keys` instead to construct query keys for queries and mutations.
-     */
-    queryKey: IQueryKeys;
+  previousQueries: PreviousQuery<TData>[];
+  /**
+   * @deprecated `QueryKeys` is deprecated in favor of `keys`. Please use `keys` instead to construct query keys for queries and mutations.
+   */
+  queryKey: IQueryKeys;
 };
 
 export type Context = {
-    previousQueries: ContextQuery[];
+  previousQueries: ContextQuery[];
 };
 
 export type ContextQuery<T = BaseRecord> = {
-    query: QueryResponse<T>;
-    queryKey: QueryKey;
+  query: QueryResponse<T>;
+  queryKey: QueryKey;
 };

package/src/interfaces/notification.ts

@@ -1,10 +1,10 @@
 import { BaseKey } from ".";
 export interface IUndoableQueue {
-    id: BaseKey;
-    resource: string;
-    cancelMutation: () => void;
-    doMutation: () => void;
-    seconds: number;
-    isRunning: boolean;
-    isSilent: boolean;
+  id: BaseKey;
+  resource: string;
+  cancelMutation: () => void;
+  doMutation: () => void;
+  seconds: number;
+  isRunning: boolean;
+  isSilent: boolean;
 }

package/src/interfaces/optimistic-update-map.ts

@@ -1,49 +1,49 @@
 import { BaseKey, GetListResponse, GetManyResponse, GetOneResponse } from ".";
 
 export type OptimisticUpdateMapType<TData, TVariables> = {
-    list?:
-        | ((
-              previous: GetListResponse<TData> | null | undefined,
-              values: TVariables,
-              id: BaseKey,
-          ) => GetListResponse<TData> | null)
-        | boolean;
-    many?:
-        | ((
-              previous: GetManyResponse<TData> | null | undefined,
-              values: TVariables,
-              id: BaseKey,
-          ) => GetManyResponse<TData> | null)
-        | boolean;
-    detail?:
-        | ((
-              previous: GetOneResponse<TData> | null | undefined,
-              values: TVariables,
-              id: BaseKey,
-          ) => GetOneResponse<TData> | null)
-        | boolean;
+  list?:
+    | ((
+        previous: GetListResponse<TData> | null | undefined,
+        values: TVariables,
+        id: BaseKey,
+      ) => GetListResponse<TData> | null)
+    | boolean;
+  many?:
+    | ((
+        previous: GetManyResponse<TData> | null | undefined,
+        values: TVariables,
+        id: BaseKey,
+      ) => GetManyResponse<TData> | null)
+    | boolean;
+  detail?:
+    | ((
+        previous: GetOneResponse<TData> | null | undefined,
+        values: TVariables,
+        id: BaseKey,
+      ) => GetOneResponse<TData> | null)
+    | boolean;
 };
 
 export type OptimisticUpdateManyMapType<TData, TVariables> = {
-    list?:
-        | ((
-              previous: GetListResponse<TData> | null | undefined,
-              values: TVariables,
-              ids: BaseKey[],
-          ) => GetListResponse<TData> | null)
-        | boolean;
-    many?:
-        | ((
-              previous: GetManyResponse<TData> | null | undefined,
-              values: TVariables,
-              ids: BaseKey[],
-          ) => GetManyResponse<TData> | null)
-        | boolean;
-    detail?:
-        | ((
-              previous: GetOneResponse<TData> | null | undefined,
-              values: TVariables,
-              id: BaseKey,
-          ) => GetOneResponse<TData> | null)
-        | boolean;
+  list?:
+    | ((
+        previous: GetListResponse<TData> | null | undefined,
+        values: TVariables,
+        ids: BaseKey[],
+      ) => GetListResponse<TData> | null)
+    | boolean;
+  many?:
+    | ((
+        previous: GetManyResponse<TData> | null | undefined,
+        values: TVariables,
+        ids: BaseKey[],
+      ) => GetManyResponse<TData> | null)
+    | boolean;
+  detail?:
+    | ((
+        previous: GetOneResponse<TData> | null | undefined,
+        values: TVariables,
+        id: BaseKey,
+      ) => GetOneResponse<TData> | null)
+    | boolean;
 };

package/src/interfaces/prettify.ts

@@ -1,3 +1,3 @@
 export type Prettify<T> = {
-    [K in keyof T]: T[K];
+  [K in keyof T]: T[K];
 } & {};

package/src/interfaces/queryKey.ts

@@ -4,20 +4,20 @@ import { UseListConfig } from "@hooks/data/useList";
 import { BaseKey, CrudFilters, CrudSorting, Pagination } from "src/interfaces";
 
 export interface IQueryKeys {
-    all: QueryKey;
-    resourceAll: QueryKey;
-    list: (
-        config?:
-            | UseListConfig
-            | {
-                  pagination?: Required<Pagination>;
-                  hasPagination?: boolean;
-                  sorters?: CrudSorting;
-                  filters?: CrudFilters;
-              }
-            | undefined,
-    ) => QueryKey;
-    many: (ids?: BaseKey[]) => QueryKey;
-    detail: (id?: BaseKey) => QueryKey;
-    logList: (meta?: Record<number | string, any>) => QueryKey;
+  all: QueryKey;
+  resourceAll: QueryKey;
+  list: (
+    config?:
+      | UseListConfig
+      | {
+          pagination?: Required<Pagination>;
+          hasPagination?: boolean;
+          sorters?: CrudSorting;
+          filters?: CrudFilters;
+        }
+      | undefined,
+  ) => QueryKey;
+  many: (ids?: BaseKey[]) => QueryKey;
+  detail: (id?: BaseKey) => QueryKey;
+  logList: (meta?: Record<number | string, any>) => QueryKey;
 }

package/src/interfaces/resourceErrorRouterParams.ts

@@ -1,6 +1,6 @@
 import { ActionWithPage } from "./actions";
 
 export type ResourceErrorRouterParams = {
-    resource: string;
-    action: ActionWithPage | undefined;
+  resource: string;
+  action: ActionWithPage | undefined;
 };

package/src/interfaces/resourceRouterParams.ts

@@ -1,7 +1,7 @@
 import { RouteAction } from "./actions";
 
 export type ResourceRouterParams = {
-    resource: string;
-    id?: string;
-    action: RouteAction;
+  resource: string;
+  id?: string;
+  action: RouteAction;
 };

package/src/interfaces/successErrorNotification.ts

@@ -1,33 +1,33 @@
 import { OpenNotificationParams } from ".";
 
 export type SuccessErrorNotification<
-    TData = unknown,
-    TError = unknown,
-    TVariables = unknown,
+  TData = unknown,
+  TError = unknown,
+  TVariables = unknown,
 > = {
-    /**
+  /**
      * Success notification configuration to be displayed when the mutation is successful.
      * @default '"There was an error creating resource (status code: `statusCode`)" or "Error when updating resource (status code: statusCode)"' 
 
      */
-    successNotification?:
-        | OpenNotificationParams
-        | false
-        | ((
-              data?: TData,
-              values?: TVariables,
-              resource?: string,
-          ) => OpenNotificationParams | false);
-    /**
-     * Error notification configuration to be displayed when the mutation fails.
-     * @default '"There was an error creating resource (status code: `statusCode`)" or "Error when updating resource (status code: statusCode)"'
-     */
-    errorNotification?:
-        | OpenNotificationParams
-        | false
-        | ((
-              error?: TError,
-              values?: TVariables,
-              resource?: string,
-          ) => OpenNotificationParams | false);
+  successNotification?:
+    | OpenNotificationParams
+    | false
+    | ((
+        data?: TData,
+        values?: TVariables,
+        resource?: string,
+      ) => OpenNotificationParams | false);
+  /**
+   * Error notification configuration to be displayed when the mutation fails.
+   * @default '"There was an error creating resource (status code: `statusCode`)" or "Error when updating resource (status code: statusCode)"'
+   */
+  errorNotification?:
+    | OpenNotificationParams
+    | false
+    | ((
+        error?: TError,
+        values?: TVariables,
+        resource?: string,
+      ) => OpenNotificationParams | false);
 };

package/src/interfaces/telemetry.ts

@@ -1,15 +1,15 @@
 export type ITelemetryData = {
-    providers: {
-        auth?: boolean;
-        data?: boolean;
-        router?: boolean;
-        notification?: boolean;
-        live?: boolean;
-        auditLog?: boolean;
-        i18n?: boolean;
-        accessControl?: boolean;
-    };
-    version: string;
-    resourceCount: number;
-    projectId?: string;
+  providers: {
+    auth?: boolean;
+    data?: boolean;
+    router?: boolean;
+    notification?: boolean;
+    live?: boolean;
+    auditLog?: boolean;
+    i18n?: boolean;
+    accessControl?: boolean;
+  };
+  version: string;
+  resourceCount: number;
+  projectId?: string;
 };

package/src/interfaces/textTransformers.ts

@@ -1,20 +1,20 @@
 export type TextTransformers = {
-    /**
-     * Convert a camelized/dasherized/underscored string into a humanized one
-     * @example
-     * humanize("some_name") => "Some name"
-     */
-    humanize?: (text: string) => string;
-    /**
-     * Pluralize a word
-     * @example
-     * plural('regex') => "regexes"
-     */
-    plural?: (word: string) => string;
-    /**
-     * Singularize a word
-     * @example
-     * singular('singles') => "single"
-     */
-    singular?: (word: string) => string;
+  /**
+   * Convert a camelized/dasherized/underscored string into a humanized one
+   * @example
+   * humanize("some_name") => "Some name"
+   */
+  humanize?: (text: string) => string;
+  /**
+   * Pluralize a word
+   * @example
+   * plural('regex') => "regexes"
+   */
+  plural?: (word: string) => string;
+  /**
+   * Singularize a word
+   * @example
+   * singular('singles') => "single"
+   */
+  singular?: (word: string) => string;
 };