@refinedev/core 4.47.2 → 4.49.0

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

@@ -0,0 +1,313 @@
+import React, { ReactNode } from "react";
+import { QueryClient, QueryClientConfig } from "@tanstack/react-query";
+import { RedirectAction } from "../../hooks/form/types";
+import { UseLoadingOvertimeRefineContext } from "../../hooks/useLoadingOvertime";
+import { AccessControlProvider } from "../accessControl/types";
+import { AuditLogProvider } from "../auditLog/types";
+import { AuthProvider, LegacyAuthProvider } from "../auth/types";
+import { DataProvider, DataProviders, MutationMode } from "../data/types";
+import { I18nProvider } from "../i18n/types";
+import { LiveModeProps, LiveProvider } from "../live/types";
+import { NotificationProvider } from "../notification/types";
+import { ResourceProps } from "../resource/types";
+import { LegacyRouterProvider } from "../router/legacy/types";
+import { RouterProvider } from "../router/types";
+export type TitleProps = {
+    collapsed: boolean;
+};
+export type LayoutProps = {
+    Sider?: React.FC<{
+        Title?: React.FC<TitleProps>;
+        render?: (props: {
+            items: JSX.Element[];
+            logout: React.ReactNode;
+            dashboard: React.ReactNode;
+            collapsed: boolean;
+        }) => React.ReactNode;
+        meta?: Record<string, unknown>;
+    }>;
+    Header?: React.FC;
+    Title?: React.FC<TitleProps>;
+    Footer?: React.FC;
+    OffLayoutArea?: React.FC;
+    dashboard?: boolean;
+    children?: ReactNode;
+};
+export type DashboardPageProps<TCrudData = any> = {
+    initialData?: TCrudData;
+} & Record<any, any>;
+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;
+};
+export interface IRefineOptions {
+    breadcrumb?: ReactNode;
+    mutationMode?: MutationMode;
+    syncWithLocation?: boolean;
+    warnWhenUnsavedChanges?: boolean;
+    undoableTimeout?: number;
+    liveMode?: LiveModeProps["liveMode"];
+    disableTelemetry?: boolean;
+    redirect?: {
+        afterCreate?: RedirectAction;
+        afterClone?: RedirectAction;
+        afterEdit?: RedirectAction;
+    };
+    reactQuery?: {
+        clientConfig?: QueryClientConfig | InstanceType<typeof QueryClient>;
+        /**
+         * @deprecated `@tanstack/react-query`'s devtools are removed from the core. Please use the `@tanstack/react-query-devtools` package manually in your project. This option will be removed in the next major version and has no effect on the `@tanstack/react-query-devtools` package usage.
+         */
+        devtoolConfig?: any | false;
+    };
+    overtime?: UseLoadingOvertimeRefineContext;
+    textTransformers?: TextTransformers;
+    /**
+     * Disables server-side validation globally for the useForm hook
+     * @default false
+     * @see {@link https://refine.dev/docs/advanced-tutorials/forms/server-side-form-validation/}
+     */
+    disableServerSideValidation?: boolean;
+    /**
+     * The project id of your refine project. Will be set automatically. Don't modify.
+     */
+    projectId?: string;
+    useNewQueryKeys?: boolean;
+}
+export interface IRefineContextOptions {
+    breadcrumb?: ReactNode;
+    mutationMode: MutationMode;
+    syncWithLocation: boolean;
+    warnWhenUnsavedChanges: boolean;
+    undoableTimeout: number;
+    liveMode: LiveModeProps["liveMode"];
+    redirect: {
+        afterCreate: RedirectAction;
+        afterClone: RedirectAction;
+        afterEdit: RedirectAction;
+    };
+    overtime: UseLoadingOvertimeRefineContext;
+    textTransformers: Required<TextTransformers>;
+    disableServerSideValidation: boolean;
+    projectId?: string;
+    useNewQueryKeys?: boolean;
+}
+export interface IRefineContext {
+    __initialized?: boolean;
+    hasDashboard: boolean;
+    mutationMode: MutationMode;
+    /**
+     * @deprecated Please use `UnsavedChangesNotifier` components from router packages instead.
+     */
+    warnWhenUnsavedChanges: boolean;
+    syncWithLocation: boolean;
+    undoableTimeout: number;
+    catchAll?: React.ReactNode;
+    DashboardPage?: RefineProps["DashboardPage"];
+    LoginPage?: React.FC | false;
+    Title?: React.FC<TitleProps>;
+    Layout: React.FC<LayoutProps>;
+    Sider?: React.FC;
+    Header?: React.FC;
+    Footer?: React.FC;
+    OffLayoutArea?: React.FC;
+    liveMode: LiveModeProps["liveMode"];
+    onLiveEvent?: LiveModeProps["onLiveEvent"];
+    options: IRefineContextOptions;
+}
+export interface IRefineContextProvider {
+    __initialized?: boolean;
+    hasDashboard: boolean;
+    mutationMode: MutationMode;
+    warnWhenUnsavedChanges: boolean;
+    syncWithLocation: boolean;
+    undoableTimeout: number;
+    /**
+     * @deprecated Please use the `catchAll` element in your routes instead.
+     */
+    catchAll?: React.ReactNode;
+    /**
+     * @deprecated Please use the `DashboardPage` component in your routes instead.
+     */
+    DashboardPage?: RefineProps["DashboardPage"];
+    /**
+     * @deprecated Please use the `LoginPage` component in your routes instead.
+     */
+    LoginPage?: React.FC | false;
+    /**
+     * @deprecated Please pass the `Title` component to your `Layout` component.
+     */
+    Title?: React.FC<TitleProps>;
+    /**
+     * @deprecated Please use the `Layout` component as a children instead of a prop.
+     */
+    Layout?: React.FC<LayoutProps>;
+    /**
+     * @deprecated Please pass the `Sider` component to your `Layout` component.
+     */
+    Sider?: React.FC;
+    /**
+     * @deprecated Please pass the `Header` component to your `Layout` component.
+     */
+    Header?: React.FC;
+    /**
+     * @deprecated Please pass the `Footer` component to your `Layout` component.
+     */
+    Footer?: React.FC;
+    /**
+     * @deprecated Please use your `OffLayoutArea` component as a children instead of a prop.
+     */
+    OffLayoutArea?: React.FC;
+    liveMode: LiveModeProps["liveMode"];
+    onLiveEvent?: LiveModeProps["onLiveEvent"];
+    options: IRefineContextOptions;
+    children?: ReactNode;
+}
+export interface RefineProps {
+    children?: React.ReactNode;
+    /**
+     * `resources` is the predefined interaction points for a refine app. A resource represents an entity in an endpoint in the API.
+     * While this is not a required property, it is used in resource detection and creation of routes for the app.
+     * @type [`ResourceProps[]`](https://refine.dev/docs/api-reference/core/components/refine-config/#resources)
+     */
+    resources?: ResourceProps[];
+    /**
+     * **refine** needs some router functions to create resource pages, handle navigation, etc. This provider allows you to use the router library you want
+     * @type [`IRouterProvider`](https://refine.dev/docs/api-reference/core/providers/router-provider/)
+     * @deprecated This property is deprecated and was the legacy way of routing. Please use `routerProvider` with new router bindings instead.
+     */
+    legacyRouterProvider?: LegacyRouterProvider;
+    /**
+     * Router bindings for **refine**. A simple interface for **refine** to interact with your router in a flexible way.
+     * @type [`RouterProvider`](https://refine.dev/docs/routing/router-provider/)
+     */
+    routerProvider?: RouterProvider;
+    /**
+     * A `dataProvider` is the place where a refine app communicates with an API. Data providers also act as adapters for refine, making it possible for it to consume different API's and data services.
+     * @type [`DataProvider` | `DataProviders`](https://refine.dev/docs/api-reference/core/providers/data-provider/)
+     */
+    dataProvider?: DataProvider | DataProviders;
+    /**
+     * `authProvider` handles authentication logic like login, logout flow and checking user credentials. It is an object with methods that refine uses when necessary.
+     * @type [`AuthProvider`](https://refine.dev/docs/api-reference/core/providers/auth-provider/)
+     */
+    authProvider?: AuthProvider;
+    /**
+     * `legacyAuthProvider` handles authentication logic like login, logout flow and checking user credentials. It is an object with methods that refine uses when necessary.
+     * @type [`AuthProvider`](https://refine.dev/docs/api-reference/core/providers/auth-provider/)
+     * @deprecated `legacyAuthProvider` is deprecated with refine@4, use `authProvider` instead.
+     */
+    legacyAuthProvider?: LegacyAuthProvider;
+    /**
+     * **refine** lets you add Realtime support to your app via `liveProvider`. It can be used to update and show data in Realtime throughout your app.
+     * @type [`LiveProvider`](https://refine.dev/docs/api-reference/core/providers/live-provider/)
+     */
+    liveProvider?: LiveProvider;
+    /**
+     * `notificationProvider` handles notification logics. It is an object with methods that refine uses when necessary.
+     * @type [`NotificationProvider` | `(() => NotificationProvider)`](https://refine.dev/docs/api-reference/core/providers/notification-provider/)
+     */
+    notificationProvider?: NotificationProvider | (() => NotificationProvider);
+    /**
+     * `accessControlProvider` is the entry point for implementing access control for refine apps.
+     * @type [`AccessControlProvider`](https://refine.dev/docs/api-reference/core/providers/accessControl-provider/)
+     */
+    accessControlProvider?: AccessControlProvider;
+    /**
+     * **refine** allows you to track changes in your data and keep track of who made the changes.
+     * @type [`AuditLogProvider`](https://refine.dev/docs/api-reference/core/providers/audit-log-provider#overview)
+     */
+    auditLogProvider?: AuditLogProvider;
+    /**
+     * `i18nProvider` property lets you add i18n support to your app. Making you able to use any i18n framework.
+     * @type [`i18nProvider`](https://refine.dev/docs/api-reference/core/providers/i18n-provider/)
+     */
+    i18nProvider?: I18nProvider;
+    /**
+     * A custom error component.
+     * @type [`ReactNode`](https://refine.dev/docs/api-reference/core/components/refine-config/#catchall)
+     * @deprecated Please use the `catchAll` element in your routes instead.
+     */
+    catchAll?: React.ReactNode;
+    /**
+     * Custom login component can be passed to the `LoginPage` property.
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#loginpage)
+     * @deprecated Please use the `LoginPage` component in your routes instead.
+     */
+    LoginPage?: React.FC;
+    /**
+     * A custom dashboard page can be passed to the `DashboardPage` prop which is accessible on root route.
+     * @type [`React.FC<DashboardPageProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#dashboardpage)
+     * @deprecated Please use the `DashboardPage` component in your routes instead.
+     */
+    DashboardPage?: React.FC<DashboardPageProps>;
+    /**
+     * Custom ready page component can be set by passing to `ReadyPage` property.
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#readypage)
+     * @deprecated This component is only used with the legacy router and will be removed in the future.
+     */
+    ReadyPage?: React.FC;
+    /**
+     * Default layout can be customized by passing the `Layout` property.
+     * @type [`React.FC<LayoutProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#layout)
+     * @deprecated Please use the `Layout` component as a children instead of a prop.
+     */
+    Layout?: React.FC<LayoutProps>;
+    /**
+     * The default sidebar can be customized by using refine hooks and passing custom components to `Sider` property.
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#sider)
+     * @deprecated Please pass the `Sider` component to your `Layout` component.
+     */
+    Sider?: React.FC;
+    /**
+     * The default app header can be customized by passing the `Header` property.
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#header)
+     * @deprecated Please pass the `Header` component to your `Layout` component.
+     */
+    Header?: React.FC;
+    /**
+     *The default app footer can be customized by passing the `Footer` property.
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#footer)
+     * @deprecated Please pass the `Footer` component to your `Layout` component.
+     */
+    Footer?: React.FC;
+    /**
+     * The component wanted to be placed out of app layout structure can be set by passing to `OffLayoutArea` prop.
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#offlayoutarea)
+     * @deprecated Please use your `OffLayoutArea` component as a children instead of a prop.
+     */
+    OffLayoutArea?: React.FC;
+    /**
+     * TThe app title can be set by passing the `Title` property.
+     * @type [`React.FC<TitleProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#title)
+     * @deprecated Please pass the `Title` component to your `Layout` component.
+     */
+    Title?: React.FC<TitleProps>;
+    /**
+     * Callback to handle all live events.
+     * @type [`(event: LiveEvent) => void`](https://refine.dev/docs/api-reference/core/providers/live-provider/#onliveevent)
+     */
+    onLiveEvent?: LiveModeProps["onLiveEvent"];
+    /**
+     * `options` is used to configure the app.
+     * @type [`IRefineOptions`](https://refine.dev/docs/api-reference/core/components/refine-config/#options)
+     * */
+    options?: IRefineOptions;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contexts/refine/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAEvE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,+BAA+B,EAAE,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE;YACf,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;YACrB,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC;YACxB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;YAC3B,SAAS,EAAE,OAAO,CAAC;SACpB,KAAK,KAAK,CAAC,SAAS,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC,CAAC,CAAC;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;IAC7B,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAClB,aAAa,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,SAAS,GAAG,GAAG,IAAI;IAChD,WAAW,CAAC,EAAE,SAAS,CAAC;CACzB,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAErB,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACrC,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACrC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,EAAE;QACT,WAAW,CAAC,EAAE,cAAc,CAAC;QAC7B,UAAU,CAAC,EAAE,cAAc,CAAC;QAC5B,SAAS,CAAC,EAAE,cAAc,CAAC;KAC5B,CAAC;IACF,UAAU,CAAC,EAAE;QACX,YAAY,CAAC,EAAE,iBAAiB,GAAG,YAAY,CAAC,OAAO,WAAW,CAAC,CAAC;QACpE;;WAEG;QACH,aAAa,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,EAAE,+BAA+B,CAAC;IAC3C,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,sBAAsB,EAAE,OAAO,CAAC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,QAAQ,EAAE;QACR,WAAW,EAAE,cAAc,CAAC;QAC5B,UAAU,EAAE,cAAc,CAAC;QAC3B,SAAS,EAAE,cAAc,CAAC;KAC3B,CAAC;IACF,QAAQ,EAAE,+BAA+B,CAAC;IAC1C,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC7C,2BAA2B,EAAE,OAAO,CAAC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,YAAY,CAAC;IAC3B;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,aAAa,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7C,SAAS,CAAC,EAAE,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC;IAC7B,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;IAC7B,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACjB,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAClB,aAAa,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACzB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,WAAW,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IAC3C,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,YAAY,CAAC;IAC3B,sBAAsB,EAAE,OAAO,CAAC;IAChC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;OAEG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IAC7C;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACzB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,WAAW,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IAC3C,OAAO,EAAE,qBAAqB,CAAC;IAC/B,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;IAC5B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;IAC5C;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,CAAC,MAAM,oBAAoB,CAAC,CAAC;IAC3E;;;OAGG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACrB;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAC7C;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IAC/B;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;IACzB;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IAC3C;;;SAGK;IACL,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B"}

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { IResourceContext, ResourceProps } from "./types";
+export declare const ResourceContext: React.Context<IResourceContext>;
+export declare const ResourceContextProvider: React.FC<React.PropsWithChildren<{
+    resources: ResourceProps[];
+}>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/resource/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,OAAO,EAAE,gBAAgB,EAAiB,aAAa,EAAE,MAAM,SAAS,CAAC;AAEzE,eAAO,MAAM,eAAe,iCAE1B,CAAC;AAEH,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAC5C,KAAK,CAAC,iBAAiB,CAAC;IAAE,SAAS,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC,CAWxD,CAAC"}

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

@@ -0,0 +1,7 @@
+import React from "react";
+import { IResourceContext, ResourceProps } from "./types";
+export declare const ResourceContext: React.Context<IResourceContext>;
+export declare const ResourceContextProvider: React.FC<React.PropsWithChildren<{
+    resources: ResourceProps[];
+}>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/resource/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,OAAO,EAAE,gBAAgB,EAAiB,aAAa,EAAE,MAAM,SAAS,CAAC;AAEzE,eAAO,MAAM,eAAe,iCAE1B,CAAC;AAEH,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAC5C,KAAK,CAAC,iBAAiB,CAAC;IAAE,SAAS,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC,CAWxD,CAAC"}

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

@@ -1,7 +1,5 @@
 import React from "react";
-import { IResourceContext } from "./IResourceContext";
-import { ResourceProps } from "../../interfaces/bindings/resource";
-export { IResourceItem, IResourceComponents, IResourceComponentsProps, IResourceContext, } from "../../interfaces/bindings/resource";
+import { IResourceContext, ResourceProps } from "./types";
 export declare const ResourceContext: React.Context<IResourceContext>;
 export declare const ResourceContextProvider: React.FC<React.PropsWithChildren<{
     resources: ResourceProps[];

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/resource/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAEH,aAAa,EAChB,MAAM,oCAAoC,CAAC;AAI5C,OAAO,EACH,aAAa,EACb,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,GACnB,MAAM,oCAAoC,CAAC;AAE5C,eAAO,MAAM,eAAe,iCAE1B,CAAC;AAEH,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAC1C,KAAK,CAAC,iBAAiB,CAAC;IAAE,SAAS,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC,CAW1D,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contexts/resource/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,OAAO,EAAE,gBAAgB,EAAiB,aAAa,EAAE,MAAM,SAAS,CAAC;AAEzE,eAAO,MAAM,eAAe,iCAE1B,CAAC;AAEH,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAC5C,KAAK,CAAC,iBAAiB,CAAC;IAAE,SAAS,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC,CAWxD,CAAC"}

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

@@ -0,0 +1,168 @@
+import { ComponentType, ReactNode } from "react";
+import { UseQueryResult } from "@tanstack/react-query";
+import { ILogData } from "../auditLog/types";
+/**
+ * Resource route components
+ */
+export type ResourceRouteComponent = ComponentType<IResourceComponentsProps<any, any>>;
+export type ResourceRoutePath = string;
+export type ResourceRouteDefinition = {
+    path: ResourceRoutePath;
+    component: ResourceRouteComponent;
+};
+export type ResourceRouteComposition = ResourceRouteDefinition | ResourceRoutePath | ResourceRouteComponent;
+export interface IResourceComponents {
+    list?: ResourceRouteComposition;
+    create?: ResourceRouteComposition;
+    clone?: ResourceRouteComposition;
+    edit?: ResourceRouteComposition;
+    show?: ResourceRouteComposition;
+}
+export type AnyString = string & {
+    __ignore?: never;
+};
+export type ResourceAuditLogPermissions = "create" | "update" | "delete" | AnyString;
+/** Resource `meta` */
+export interface KnownResourceMeta {
+    /**
+     * This is used when setting the document title, in breadcrumbs and `<Sider />` components.
+     * Therefore it will only work if the related components have implemented the `label` property.
+     */
+    label?: string;
+    /**
+     * Whether to hide the resource from the sidebar or not.
+     * This property is checked by the `<Sider />` components.
+     * Therefore it will only work if the `<Sider />` component has implemented the `hide` property.
+     */
+    hide?: boolean;
+    /**
+     * Dedicated data provider name for the resource.
+     * If not set, the default data provider will be used.
+     * You can use this property to pick a data provider for a resource when you have multiple data providers.
+     */
+    dataProviderName?: string;
+    /**
+     * To nest a resource under another resource, set the parent property to the name of the parent resource.
+     * This will work even if the parent resource is not explicitly defined.
+     */
+    parent?: string;
+    /**
+     * To determine if the resource has ability to delete or not.
+     */
+    canDelete?: boolean;
+    /**
+     * To permit the audit log for actions on the resource.
+     * @default All actions are permitted to be logged.
+     */
+    audit?: ResourceAuditLogPermissions[];
+    /**
+     * To pass `icon` to the resource.
+     */
+    icon?: ReactNode;
+}
+export interface DeprecatedOptions {
+    /**
+     * @deprecated Please use `audit` property instead.
+     */
+    auditLog?: {
+        permissions?: ResourceAuditLogPermissions[];
+    };
+    /**
+     * @deprecated Define the route in the resource components instead
+     */
+    route?: string;
+}
+export interface ResourceMeta extends KnownResourceMeta {
+    [key: string]: any;
+}
+export interface ResourceProps extends IResourceComponents {
+    name: string;
+    /**
+     * This property can be used to identify a resource. In some cases, `name` of the resource might be repeated in different resources.
+     * To avoid conflicts, you pass the `identifier` property to be used as the key of the resource.
+     * @default `name` of the resource
+     */
+    identifier?: string;
+    /**
+     * @deprecated This property is not used anymore.
+     */
+    key?: string;
+    /**
+     * @deprecated Please use the `meta` property instead.
+     */
+    options?: ResourceMeta & DeprecatedOptions;
+    /**
+     * To configure the resource, you can set `meta` properties. You can use `meta` to store any data related to the resource.
+     * There are some known `meta` properties that are used by the core and extension packages.
+     */
+    meta?: ResourceMeta & DeprecatedOptions;
+    /**
+     * @deprecated Please use the `meta.canDelete` property instead.
+     */
+    canDelete?: boolean;
+    /**
+     * @deprecated Please use the `meta.icon` property instead
+     */
+    icon?: ReactNode;
+    /**
+     * @deprecated Please use the `meta.parent` property instead
+     */
+    parentName?: string;
+}
+export interface RouteableProperties {
+    /**
+     * @deprecated Please use action props instead.
+     */
+    canCreate?: boolean;
+    /**
+     * @deprecated Please use action props instead.
+     */
+    canEdit?: boolean;
+    /**
+     * @deprecated Please use action props instead.
+     */
+    canShow?: boolean;
+    /**
+     * @deprecated Please use the `meta.canDelete` property instead.
+     */
+    canDelete?: boolean;
+}
+export interface IResourceComponentsProps<TCrudData = any, TLogQueryResult = ILogData> extends RouteableProperties {
+    name?: string;
+    initialData?: TCrudData;
+    options?: ResourceMeta & DeprecatedOptions;
+    logQueryResult?: UseQueryResult<TLogQueryResult>;
+}
+export interface IResourceItem extends IResourceComponents, RouteableProperties, ResourceProps {
+    /**
+     * @deprecated Please use the `meta.label` property instead.
+     */
+    label?: string;
+    /**
+     * @deprecated Please use action components and `getDefaultActionPath` helper instead.
+     */
+    route?: string;
+}
+export interface IResourceContext {
+    resources: IResourceItem[];
+}
+export type ResourceBindings = ResourceProps[];
+export interface RouteableProperties {
+    canCreate?: boolean;
+    canEdit?: boolean;
+    canShow?: boolean;
+    canDelete?: boolean;
+    canList?: boolean;
+}
+export interface IResourceContext {
+    resources: IResourceItem[];
+}
+export type ITreeMenu = IResourceItem & {
+    key?: string;
+    children: ITreeMenu[];
+};
+export type IMenuItem = IResourceItem & {
+    key: string;
+    route: string;
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/contexts/resource/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEjD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAChD,wBAAwB,CAAC,GAAG,EAAE,GAAG,CAAC,CACnC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,iBAAiB,CAAC;IACxB,SAAS,EAAE,sBAAsB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAChC,uBAAuB,GACvB,iBAAiB,GACjB,sBAAsB,CAAC;AAE3B,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,wBAAwB,CAAC;IAChC,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,IAAI,CAAC,EAAE,wBAAwB,CAAC;IAChC,IAAI,CAAC,EAAE,wBAAwB,CAAC;CACjC;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEtD,MAAM,MAAM,2BAA2B,GACnC,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,CAAC;AAEd,sBAAsB;AACtB,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,KAAK,CAAC,EAAE,2BAA2B,EAAE,CAAC;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAC;KAC7C,CAAC;IACF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,aAAc,SAAQ,mBAAmB;IACxD,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,GAAG,iBAAiB,CAAC;IAC3C;;;OAGG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,iBAAiB,CAAC;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB,CACvC,SAAS,GAAG,GAAG,EACf,eAAe,GAAG,QAAQ,CAC1B,SAAQ,mBAAmB;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,OAAO,CAAC,EAAE,YAAY,GAAG,iBAAiB,CAAC;IAC3C,cAAc,CAAC,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,aACf,SAAQ,mBAAmB,EACzB,mBAAmB,EACnB,aAAa;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,MAAM,gBAAgB,GAAG,aAAa,EAAE,CAAC;AAI/C,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAGD,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG;IACtC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}