@refinedev/core 4.48.0 → 4.49.0

package/dist/contexts/data/types.d.ts

@@ -0,0 +1,347 @@
+import { QueryFunctionContext, QueryKey } from "@tanstack/react-query";
+import { DocumentNode } from "graphql";
+import { UseListConfig } from "../../hooks/data/useList";
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type BaseKey = string | number;
+export type BaseRecord = {
+    id?: BaseKey;
+    [key: string]: any;
+};
+export type BaseOption = {
+    label: any;
+    value: any;
+};
+/**
+ * @deprecated Use `BaseOption` instead.
+ */
+export interface Option extends BaseOption {
+}
+export type NestedField = {
+    operation: string;
+    variables: QueryBuilderOptions[];
+    fields: Fields;
+};
+export type Fields = Array<string | object | NestedField>;
+export type VariableOptions = {
+    type?: string;
+    name?: string;
+    value: any;
+    list?: boolean;
+    required?: boolean;
+} | {
+    [k: string]: any;
+};
+export interface QueryBuilderOptions {
+    operation?: string;
+    fields?: Fields;
+    variables?: VariableOptions;
+}
+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;
+};
+export type MetaQuery = {
+    [k: string]: any;
+    queryContext?: Omit<QueryFunctionContext, "meta">;
+} & QueryBuilderOptions & GraphQLQueryOptions;
+export interface Pagination {
+    /**
+     * Initial page index
+     * @default 1
+     */
+    current?: number;
+    /**
+     * Initial number of items per page
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * Whether to use server side pagination or not.
+     * @default "server"
+     */
+    mode?: "client" | "server" | "off";
+}
+/**
+ * @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">;
+} & QueryBuilderOptions;
+export interface IQueryKeys {
+    all: QueryKey;
+    resourceAll: QueryKey;
+    list: (config?: UseListConfig | {
+        pagination?: Required<Pagination>;
+        hasPagination?: boolean;
+        sorters?: CrudSort[];
+        filters?: CrudFilter[];
+    } | undefined) => QueryKey;
+    many: (ids?: BaseKey[]) => QueryKey;
+    detail: (id?: BaseKey) => QueryKey;
+    logList: (meta?: Record<number | string, any>) => QueryKey;
+}
+export interface ValidationErrors {
+    [field: string]: string | string[] | boolean | {
+        key: string;
+        message: string;
+    };
+}
+export interface HttpError extends Record<string, any> {
+    message: string;
+    statusCode: number;
+    errors?: ValidationErrors;
+}
+export type RefineError = HttpError;
+export type MutationMode = "pessimistic" | "optimistic" | "undoable";
+export type QueryResponse<T = BaseRecord> = 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;
+};
+export type Context = {
+    previousQueries: ContextQuery[];
+};
+export type ContextQuery<T = BaseRecord> = {
+    query: QueryResponse<T>;
+    queryKey: QueryKey;
+};
+export type CrudOperators = "eq" | "ne" | "lt" | "gt" | "lte" | "gte" | "in" | "nin" | "contains" | "ncontains" | "containss" | "ncontainss" | "between" | "nbetween" | "null" | "nnull" | "startswith" | "nstartswith" | "startswiths" | "nstartswiths" | "endswith" | "nendswith" | "endswiths" | "nendswiths" | "or" | "and";
+export type SortOrder = "desc" | "asc" | null;
+export type LogicalFilter = {
+    field: string;
+    operator: Exclude<CrudOperators, "or" | "and">;
+    value: any;
+};
+export type ConditionalFilter = {
+    key?: string;
+    operator: Extract<CrudOperators, "or" | "and">;
+    value: (LogicalFilter | ConditionalFilter)[];
+};
+export type CrudFilter = LogicalFilter | ConditionalFilter;
+export type CrudSort = {
+    field: string;
+    order: "asc" | "desc";
+};
+export type CrudFilters = CrudFilter[];
+export type CrudSorting = CrudSort[];
+export interface CustomResponse<TData = BaseRecord> {
+    data: TData;
+}
+export interface GetListResponse<TData = BaseRecord> {
+    data: TData[];
+    total: number;
+    [key: string]: any;
+}
+export interface CreateResponse<TData = BaseRecord> {
+    data: TData;
+}
+export interface CreateManyResponse<TData = BaseRecord> {
+    data: TData[];
+}
+export interface UpdateResponse<TData = BaseRecord> {
+    data: TData;
+}
+export interface UpdateManyResponse<TData = BaseRecord> {
+    data: TData[];
+}
+export interface GetOneResponse<TData = BaseRecord> {
+    data: TData;
+}
+export interface GetManyResponse<TData = BaseRecord> {
+    data: TData[];
+}
+export interface DeleteOneResponse<TData = BaseRecord> {
+    data: TData;
+}
+export interface DeleteManyResponse<TData = BaseRecord> {
+    data: TData[];
+}
+export interface GetListParams {
+    resource: string;
+    pagination?: Pagination;
+    /**
+     * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
+     */
+    hasPagination?: boolean;
+    /**
+     * @deprecated `sort` is deprecated, use `sorters` instead.
+     */
+    sort?: CrudSort[];
+    sorters?: CrudSort[];
+    filters?: CrudFilter[];
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+    dataProviderName?: string;
+}
+export interface GetManyParams {
+    resource: string;
+    ids: BaseKey[];
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+    dataProviderName?: string;
+}
+export interface GetOneParams {
+    resource: string;
+    id: BaseKey;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+export interface CreateParams<TVariables = {}> {
+    resource: string;
+    variables: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+export interface CreateManyParams<TVariables = {}> {
+    resource: string;
+    variables: TVariables[];
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+export interface UpdateParams<TVariables = {}> {
+    resource: string;
+    id: BaseKey;
+    variables: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+export interface UpdateManyParams<TVariables = {}> {
+    resource: string;
+    ids: BaseKey[];
+    variables: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+export interface DeleteOneParams<TVariables = {}> {
+    resource: string;
+    id: BaseKey;
+    variables?: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+export interface DeleteManyParams<TVariables = {}> {
+    resource: string;
+    ids: BaseKey[];
+    variables?: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+export interface CustomParams<TQuery = unknown, TPayload = unknown> {
+    url: string;
+    method: "get" | "delete" | "head" | "options" | "post" | "put" | "patch";
+    /**
+     * @deprecated `sort` is deprecated, use `sorters` instead.
+     */
+    sort?: CrudSort[];
+    sorters?: CrudSort[];
+    filters?: CrudFilter[];
+    payload?: TPayload;
+    query?: TQuery;
+    headers?: {};
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+export type DataProvider = {
+    getList: <TData extends BaseRecord = BaseRecord>(params: GetListParams) => Promise<GetListResponse<TData>>;
+    getMany?: <TData extends BaseRecord = BaseRecord>(params: GetManyParams) => Promise<GetManyResponse<TData>>;
+    getOne: <TData extends BaseRecord = BaseRecord>(params: GetOneParams) => Promise<GetOneResponse<TData>>;
+    create: <TData extends BaseRecord = BaseRecord, TVariables = {}>(params: CreateParams<TVariables>) => Promise<CreateResponse<TData>>;
+    createMany?: <TData extends BaseRecord = BaseRecord, TVariables = {}>(params: CreateManyParams<TVariables>) => Promise<CreateManyResponse<TData>>;
+    update: <TData extends BaseRecord = BaseRecord, TVariables = {}>(params: UpdateParams<TVariables>) => Promise<UpdateResponse<TData>>;
+    updateMany?: <TData extends BaseRecord = BaseRecord, TVariables = {}>(params: UpdateManyParams<TVariables>) => Promise<UpdateManyResponse<TData>>;
+    deleteOne: <TData extends BaseRecord = BaseRecord, TVariables = {}>(params: DeleteOneParams<TVariables>) => Promise<DeleteOneResponse<TData>>;
+    deleteMany?: <TData extends BaseRecord = BaseRecord, TVariables = {}>(params: DeleteManyParams<TVariables>) => Promise<DeleteManyResponse<TData>>;
+    getApiUrl: () => string;
+    custom?: <TData extends BaseRecord = BaseRecord, TQuery = unknown, TPayload = unknown>(params: CustomParams<TQuery, TPayload>) => Promise<CustomResponse<TData>>;
+};
+export type DataProviders = {
+    default: DataProvider;
+    [key: string]: DataProvider;
+};
+export type IDataContext = DataProviders;
+export type DataBindings = DataProvider | DataProviders;
+//# sourceMappingURL=types.d.ts.map

package/dist/contexts/data/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contexts/data/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEzD,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,GAAG,EAAE,CAAC;AAEP,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACtC,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,GAAG,CAAC;IACX,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,MAAO,SAAQ,UAAU;CAAG;AAE7C,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC,CAAC;AAE1D,MAAM,MAAM,eAAe,GACvB;IACE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,GACD;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAEzB,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACjB,YAAY,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;CACnD,GAAG,mBAAmB,GACrB,mBAAmB,CAAC;AAEtB,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACjB,YAAY,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;CACnD,GAAG,mBAAmB,CAAC;AAExB,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,QAAQ,CAAC;IACd,WAAW,EAAE,QAAQ,CAAC;IACtB,IAAI,EAAE,CACJ,MAAM,CAAC,EACH,aAAa,GACb;QACE,UAAU,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAClC,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;QACrB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;KACxB,GACD,SAAS,KACV,QAAQ,CAAC;IACd,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,QAAQ,CAAC;IACpC,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,KAAK,QAAQ,CAAC;IACnC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,KAAK,QAAQ,CAAC;CAC5D;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,KAAK,EAAE,MAAM,GACV,MAAM,GACN,MAAM,EAAE,GACR,OAAO,GACP;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC;AAEpC,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,YAAY,GAAG,UAAU,CAAC;AAErE,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,UAAU,IACpC,eAAe,CAAC,CAAC,CAAC,GAClB,cAAc,CAAC,CAAC,CAAC,CAAC;AAEtB,MAAM,MAAM,aAAa,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC;AAE/D,MAAM,MAAM,WAAW,CAAC,KAAK,IAAI;IAC/B,eAAe,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;IACxC;;OAEG;IACH,QAAQ,EAAE,UAAU,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,eAAe,EAAE,YAAY,EAAE,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,UAAU,IAAI;IACzC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AA2BF,MAAM,MAAM,aAAa,GACrB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,SAAS,GACT,UAAU,GACV,MAAM,GACN,OAAO,GACP,YAAY,GACZ,aAAa,GACb,aAAa,GACb,cAAc,GACd,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,IAAI,GACJ,KAAK,CAAC;AAEV,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,IAAI,CAAC;AAE9C,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC,aAAa,EAAE,IAAI,GAAG,KAAK,CAAC,CAAC;IAC/C,KAAK,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC,aAAa,EAAE,IAAI,GAAG,KAAK,CAAC,CAAC;IAC/C,KAAK,EAAE,CAAC,aAAa,GAAG,iBAAiB,CAAC,EAAE,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,iBAAiB,CAAC;AAC3D,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC;AACvC,MAAM,MAAM,WAAW,GAAG,QAAQ,EAAE,CAAC;AAErC,MAAM,WAAW,cAAc,CAAC,KAAK,GAAG,UAAU;IAChD,IAAI,EAAE,KAAK,CAAC;CACb;AACD,MAAM,WAAW,eAAe,CAAC,KAAK,GAAG,UAAU;IACjD,IAAI,EAAE,KAAK,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,cAAc,CAAC,KAAK,GAAG,UAAU;IAChD,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB,CAAC,KAAK,GAAG,UAAU;IACpD,IAAI,EAAE,KAAK,EAAE,CAAC;CACf;AAED,MAAM,WAAW,cAAc,CAAC,KAAK,GAAG,UAAU;IAChD,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB,CAAC,KAAK,GAAG,UAAU;IACpD,IAAI,EAAE,KAAK,EAAE,CAAC;CACf;AAED,MAAM,WAAW,cAAc,CAAC,KAAK,GAAG,UAAU;IAChD,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,eAAe,CAAC,KAAK,GAAG,UAAU;IACjD,IAAI,EAAE,KAAK,EAAE,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB,CAAC,KAAK,GAAG,UAAU;IACnD,IAAI,EAAE,KAAK,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB,CAAC,KAAK,GAAG,UAAU;IACpD,IAAI,EAAE,KAAK,EAAE,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,OAAO,EAAE,CAAC;IACf,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,YAAY,CAAC,UAAU,GAAG,EAAE;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,UAAU,CAAC;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,GAAG,EAAE;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,UAAU,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,YAAY,CAAC,UAAU,GAAG,EAAE;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,OAAO,CAAC;IACZ,SAAS,EAAE,UAAU,CAAC;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,GAAG,EAAE;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,OAAO,EAAE,CAAC;IACf,SAAS,EAAE,UAAU,CAAC;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,eAAe,CAAC,UAAU,GAAG,EAAE;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,OAAO,CAAC;IACZ,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB,CAAC,UAAU,GAAG,EAAE;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,OAAO,EAAE,CAAC;IACf,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,YAAY,CAAC,MAAM,GAAG,OAAO,EAAE,QAAQ,GAAG,OAAO;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC;IACzE;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,EAAE,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAC7C,MAAM,EAAE,aAAa,KAClB,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IAErC,OAAO,CAAC,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAC9C,MAAM,EAAE,aAAa,KAClB,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IAErC,MAAM,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,EAAE,YAAY,KACjB,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAEpC,MAAM,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,UAAU,GAAG,EAAE,EAC7D,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,KAC7B,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAEpC,UAAU,CAAC,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,UAAU,GAAG,EAAE,EAClE,MAAM,EAAE,gBAAgB,CAAC,UAAU,CAAC,KACjC,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;IAExC,MAAM,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,UAAU,GAAG,EAAE,EAC7D,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,KAC7B,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAEpC,UAAU,CAAC,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,UAAU,GAAG,EAAE,EAClE,MAAM,EAAE,gBAAgB,CAAC,UAAU,CAAC,KACjC,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;IAExC,SAAS,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,UAAU,GAAG,EAAE,EAChE,MAAM,EAAE,eAAe,CAAC,UAAU,CAAC,KAChC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;IAEvC,UAAU,CAAC,EAAE,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,UAAU,GAAG,EAAE,EAClE,MAAM,EAAE,gBAAgB,CAAC,UAAU,CAAC,KACjC,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;IAExC,SAAS,EAAE,MAAM,MAAM,CAAC;IAExB,MAAM,CAAC,EAAE,CACP,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,MAAM,GAAG,OAAO,EAChB,QAAQ,GAAG,OAAO,EAElB,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,KACnC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,YAAY,CAAC;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC;AAEzC,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC"}

package/dist/contexts/i18n/index.d.cts

@@ -0,0 +1,7 @@
+import React, { PropsWithChildren } from "react";
+import { I18nProvider, II18nContext } from "./types";
+/** @deprecated default value for translation context has no use and is an empty object.  */
+export declare const defaultProvider: Partial<I18nProvider>;
+export declare const I18nContext: React.Context<II18nContext>;
+export declare const I18nContextProvider: React.FC<PropsWithChildren<II18nContext>>;
+//# sourceMappingURL=index.d.ts.map

package/dist/contexts/i18n/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/i18n/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAErD,4FAA4F;AAC5F,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,YAAY,CAAM,CAAC;AAEzD,eAAO,MAAM,WAAW,6BAAwC,CAAC;AAEjE,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAazE,CAAC"}

package/dist/contexts/i18n/index.d.mts

@@ -0,0 +1,7 @@
+import React, { PropsWithChildren } from "react";
+import { I18nProvider, II18nContext } from "./types";
+/** @deprecated default value for translation context has no use and is an empty object.  */
+export declare const defaultProvider: Partial<I18nProvider>;
+export declare const I18nContext: React.Context<II18nContext>;
+export declare const I18nContextProvider: React.FC<PropsWithChildren<II18nContext>>;
+//# sourceMappingURL=index.d.ts.map

package/dist/contexts/i18n/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/i18n/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAErD,4FAA4F;AAC5F,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,YAAY,CAAM,CAAC;AAEzD,eAAO,MAAM,WAAW,6BAAwC,CAAC;AAEjE,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAazE,CAAC"}

package/dist/contexts/i18n/index.d.ts

@@ -0,0 +1,7 @@
+import React, { PropsWithChildren } from "react";
+import { I18nProvider, II18nContext } from "./types";
+/** @deprecated default value for translation context has no use and is an empty object.  */
+export declare const defaultProvider: Partial<I18nProvider>;
+export declare const I18nContext: React.Context<II18nContext>;
+export declare const I18nContextProvider: React.FC<PropsWithChildren<II18nContext>>;
+//# sourceMappingURL=index.d.ts.map

package/dist/contexts/i18n/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/i18n/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAErD,4FAA4F;AAC5F,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,YAAY,CAAM,CAAC;AAEzD,eAAO,MAAM,WAAW,6BAAwC,CAAC;AAEjE,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAazE,CAAC"}

package/dist/contexts/i18n/types.d.cts

@@ -0,0 +1,13 @@
+type TranslateFunction = (key: string, options?: any, defaultMessage?: string) => string;
+type ChangeLocaleFunction = (locale: string, options?: any) => Promise<any> | any;
+type GetLocaleFunction = () => string;
+export type I18nProvider = {
+    translate: TranslateFunction;
+    changeLocale: ChangeLocaleFunction;
+    getLocale: GetLocaleFunction;
+};
+export interface II18nContext {
+    i18nProvider?: I18nProvider;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/contexts/i18n/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contexts/i18n/types.ts"],"names":[],"mappings":"AAAA,KAAK,iBAAiB,GAAG,CACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,GAAG,EACb,cAAc,CAAC,EAAE,MAAM,KACpB,MAAM,CAAC;AAEZ,KAAK,oBAAoB,GAAG,CAC1B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,GAAG,KACV,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AAExB,KAAK,iBAAiB,GAAG,MAAM,MAAM,CAAC;AAEtC,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,YAAY,EAAE,oBAAoB,CAAC;IACnC,SAAS,EAAE,iBAAiB,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B"}

package/dist/contexts/i18n/types.d.mts

@@ -0,0 +1,13 @@
+type TranslateFunction = (key: string, options?: any, defaultMessage?: string) => string;
+type ChangeLocaleFunction = (locale: string, options?: any) => Promise<any> | any;
+type GetLocaleFunction = () => string;
+export type I18nProvider = {
+    translate: TranslateFunction;
+    changeLocale: ChangeLocaleFunction;
+    getLocale: GetLocaleFunction;
+};
+export interface II18nContext {
+    i18nProvider?: I18nProvider;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/contexts/i18n/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contexts/i18n/types.ts"],"names":[],"mappings":"AAAA,KAAK,iBAAiB,GAAG,CACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,GAAG,EACb,cAAc,CAAC,EAAE,MAAM,KACpB,MAAM,CAAC;AAEZ,KAAK,oBAAoB,GAAG,CAC1B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,GAAG,KACV,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AAExB,KAAK,iBAAiB,GAAG,MAAM,MAAM,CAAC;AAEtC,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,YAAY,EAAE,oBAAoB,CAAC;IACnC,SAAS,EAAE,iBAAiB,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B"}

package/dist/contexts/i18n/types.d.ts

@@ -0,0 +1,13 @@
+type TranslateFunction = (key: string, options?: any, defaultMessage?: string) => string;
+type ChangeLocaleFunction = (locale: string, options?: any) => Promise<any> | any;
+type GetLocaleFunction = () => string;
+export type I18nProvider = {
+    translate: TranslateFunction;
+    changeLocale: ChangeLocaleFunction;
+    getLocale: GetLocaleFunction;
+};
+export interface II18nContext {
+    i18nProvider?: I18nProvider;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/contexts/i18n/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contexts/i18n/types.ts"],"names":[],"mappings":"AAAA,KAAK,iBAAiB,GAAG,CACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,GAAG,EACb,cAAc,CAAC,EAAE,MAAM,KACpB,MAAM,CAAC;AAEZ,KAAK,oBAAoB,GAAG,CAC1B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,GAAG,KACV,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AAExB,KAAK,iBAAiB,GAAG,MAAM,MAAM,CAAC;AAEtC,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,YAAY,EAAE,oBAAoB,CAAC;IACnC,SAAS,EAAE,iBAAiB,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B"}

package/dist/contexts/live/index.d.cts

@@ -0,0 +1,5 @@
+import React, { PropsWithChildren } from "react";
+import { ILiveContext } from "./types";
+export declare const LiveContext: React.Context<ILiveContext>;
+export declare const LiveContextProvider: React.FC<PropsWithChildren<ILiveContext>>;
+//# sourceMappingURL=index.d.ts.map

package/dist/contexts/live/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/live/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,eAAO,MAAM,WAAW,6BAAwC,CAAC;AAEjE,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,CASzE,CAAC"}

package/dist/contexts/live/index.d.mts

@@ -0,0 +1,5 @@
+import React, { PropsWithChildren } from "react";
+import { ILiveContext } from "./types";
+export declare const LiveContext: React.Context<ILiveContext>;
+export declare const LiveContextProvider: React.FC<PropsWithChildren<ILiveContext>>;
+//# sourceMappingURL=index.d.ts.map

package/dist/contexts/live/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/live/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,eAAO,MAAM,WAAW,6BAAwC,CAAC;AAEjE,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,CASzE,CAAC"}

package/dist/contexts/live/index.d.ts

@@ -1,5 +1,5 @@
-import React from "react";
-import { ILiveContext, ILiveContextProvider } from "./ILiveContext";
+import React, { PropsWithChildren } from "react";
+import { ILiveContext } from "./types";
 export declare const LiveContext: React.Context<ILiveContext>;
-export declare const LiveContextProvider: React.FC<ILiveContextProvider>;
+export declare const LiveContextProvider: React.FC<PropsWithChildren<ILiveContext>>;
 //# sourceMappingURL=index.d.ts.map

package/dist/contexts/live/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/live/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAEpE,eAAO,MAAM,WAAW,6BAA+C,CAAC;AAExE,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAO9D,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/live/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,eAAO,MAAM,WAAW,6BAAwC,CAAC;AAEjE,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC,CASzE,CAAC"}

package/dist/contexts/live/types.d.cts

@@ -0,0 +1,96 @@
+import { BaseKey, CrudFilter, CrudSort, MetaQuery, Pagination } from "../data/types";
+export type LiveEvent = {
+    channel: string;
+    type: "deleted" | "updated" | "created" | "*" | string;
+    payload: {
+        ids?: BaseKey[];
+        [x: string]: any;
+    };
+    date: Date;
+    meta?: MetaQuery & {
+        dataProviderName?: string;
+    };
+};
+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;
+    };
+};
+export type ILiveModeContextProvider = LiveModeProps;
+export type LiveListParams = {
+    resource?: string;
+    pagination?: Pagination;
+    hasPagination?: boolean;
+    sorters?: CrudSort[];
+    filters?: CrudFilter[];
+    meta?: MetaQuery;
+    metaData?: MetaQuery;
+};
+export type LiveOneParams = {
+    resource?: string;
+    id?: BaseKey;
+};
+export type LiveManyParams = {
+    resource?: string;
+    ids?: BaseKey[];
+};
+export type LiveCommonParams = {
+    subscriptionType?: "useList" | "useOne" | "useMany";
+    [key: string]: unknown;
+};
+type LiveSubscribeOptions = {
+    channel: string;
+    types: Array<LiveEvent["type"]>;
+    callback: (event: LiveEvent) => void;
+    params?: LiveCommonParams & LiveListParams & LiveOneParams & LiveManyParams;
+};
+type LiveDeprecatedSubscribeOptions = {
+    /**
+     * @deprecated use `meta.dataProviderName` instead.
+     */
+    dataProviderName?: string;
+    /**
+     * @deprecated `params.meta` is depcerated. Use `meta` directly from the root level instead.
+     */
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+    /**
+     * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
+     */
+    hasPagination?: boolean;
+    /**
+     * @deprecated `sort` is deprecated, use `sorters` instead.
+     */
+    sort?: CrudSort[];
+};
+export type LiveProvider = {
+    publish?: (event: LiveEvent) => void;
+    subscribe: (options: LiveSubscribeOptions & LiveDeprecatedSubscribeOptions) => any;
+    unsubscribe: (subscription: any) => void;
+};
+export type ILiveContext = {
+    liveProvider?: LiveProvider;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/contexts/live/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contexts/live/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,UAAU,EACV,QAAQ,EACR,SAAS,EACT,UAAU,EACX,MAAM,eAAe,CAAC;AAEvB,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,GAAG,GAAG,MAAM,CAAC;IACvD,OAAO,EAAE;QACP,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;QAChB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;KAClB,CAAC;IACF,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,CAAC,EAAE,SAAS,GAAG;QACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACrC;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACzC;;;;OAIG;IACH,UAAU,CAAC,EAAE;QACX,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAErD,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,OAAO,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gBAAgB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IACpD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAChC,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACrC,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAC;CAC7E,CAAC;AAEF,KAAK,8BAA8B,GAAG;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACrC,SAAS,EAAE,CACT,OAAO,EAAE,oBAAoB,GAAG,8BAA8B,KAC3D,GAAG,CAAC;IACT,WAAW,EAAE,CAAC,YAAY,EAAE,GAAG,KAAK,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC"}