@refinedev/core 4.58.0 → 5.0.0

package/src/components/pages/login/index.tsx

@@ -1,77 +0,0 @@
-import React, { useState } from "react";
-
-import { useLogin, useTranslate } from "@hooks";
-import { useActiveAuthProvider } from "@definitions/helpers";
-export interface ILoginForm {
-  username: string;
-  password: string;
-}
-
-/**
- * @deprecated LoginPage is deprecated. Use AuthPage instead. @see {@link https://refine.dev/docs/core/components/auth-page} for more details.
- * **refine** has a default login page form which is served on `/login` route when the `authProvider` configuration is provided.
- *
- * @see {@link https://refine.dev/docs/api-reference/core/components/refine-config/#loginpage} for more details.
- */
-export const LoginPage: React.FC = () => {
-  const [username, setUsername] = useState("");
-  const [password, setPassword] = useState("");
-
-  const translate = useTranslate();
-
-  const authProvider = useActiveAuthProvider();
-  const { mutate: login } = useLogin<ILoginForm>({
-    v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
-  });
-
-  return (
-    <>
-      <h1>{translate("pages.login.title", "Sign in your account")}</h1>
-      <form
-        onSubmit={(e) => {
-          e.preventDefault();
-          login({ username, password });
-        }}
-      >
-        <table>
-          <tbody>
-            <tr>
-              <td>
-                {translate("pages.login.username", undefined, "username")}:
-              </td>
-              <td>
-                <input
-                  type="text"
-                  size={20}
-                  autoCorrect="off"
-                  spellCheck={false}
-                  autoCapitalize="off"
-                  autoFocus
-                  required
-                  value={username}
-                  onChange={(e) => setUsername(e.target.value)}
-                />
-              </td>
-            </tr>
-            <tr>
-              <td>
-                {translate("pages.login.password", undefined, "password")}:
-              </td>
-              <td>
-                <input
-                  type="password"
-                  required
-                  size={20}
-                  value={password}
-                  onChange={(e) => setPassword(e.target.value)}
-                />
-              </td>
-            </tr>
-          </tbody>
-        </table>
-        <br />
-        <input type="submit" value="login" />
-      </form>
-    </>
-  );
-};

package/src/components/pages/ready/index.tsx

@@ -1,30 +0,0 @@
-import React from "react";
-
-/**
- * **refine** shows a default ready page on root route when no `resources` is passed to the `<Refine>` component as a property.
- *
- * @deprecated `ReadyPage` is deprecated and will be removed in the next major release.
- */
-export const ReadyPage: React.FC = () => {
-  return (
-    <>
-      <h1>Welcome on board</h1>
-      <p>Your configuration is completed.</p>
-      <p>
-        Now you can get started by adding your resources to the{" "}
-        <code>`resources`</code> property of <code>{"`<Refine>`"}</code>
-      </p>
-      <div style={{ display: "flex", gap: 8 }}>
-        <a href="https://refine.dev" target="_blank" rel="noreferrer">
-          <button>Documentation</button>
-        </a>
-        <a href="https://refine.dev/examples" target="_blank" rel="noreferrer">
-          <button>Examples</button>
-        </a>
-        <a href="https://discord.gg/refine" target="_blank" rel="noreferrer">
-          <button>Community</button>
-        </a>
-      </div>
-    </>
-  );
-};

package/src/contexts/router/legacy/index.tsx

@@ -1,41 +0,0 @@
-import React, { type PropsWithChildren } from "react";
-
-import type { ILegacyRouterContext } from "./types";
-
-export const defaultProvider: ILegacyRouterContext = {
-  useHistory: () => false,
-  useLocation: () => false,
-  useParams: () => ({}) as any,
-  Prompt: () => null,
-  Link: () => null,
-};
-
-export const LegacyRouterContext =
-  React.createContext<ILegacyRouterContext>(defaultProvider);
-
-export const LegacyRouterContextProvider: React.FC<
-  PropsWithChildren<Partial<ILegacyRouterContext>>
-> = ({
-  children,
-  useHistory,
-  useLocation,
-  useParams,
-  Prompt,
-  Link,
-  routes,
-}) => {
-  return (
-    <LegacyRouterContext.Provider
-      value={{
-        useHistory: useHistory ?? defaultProvider.useHistory,
-        useLocation: useLocation ?? defaultProvider.useLocation,
-        useParams: useParams ?? defaultProvider.useParams,
-        Prompt: Prompt ?? defaultProvider.Prompt,
-        Link: Link ?? defaultProvider.Link,
-        routes: routes ?? defaultProvider.routes,
-      }}
-    >
-      {children}
-    </LegacyRouterContext.Provider>
-  );
-};

package/src/contexts/router/legacy/types.ts

@@ -1,50 +0,0 @@
-import React from "react";
-
-import type { Action } from "../types";
-
-export interface LegacyRouterProvider {
-  useHistory: () => {
-    push: (...args: any) => any;
-    replace: (...args: any) => any;
-    goBack: (...args: any) => any;
-  };
-  useLocation: () => {
-    search: string;
-    pathname: string;
-  };
-  useParams: <Params extends { [K in keyof Params]?: string } = {}>() => Params;
-  Prompt: React.FC<PromptProps>;
-  Link: React.FC<any>;
-  RouterComponent?: React.FC<any>;
-  routes?: any;
-}
-
-export interface ILegacyRouterContext {
-  useHistory: () => any;
-  useLocation: () => any;
-  useParams: <Params extends { [K in keyof Params]?: string } = {}>() => Params;
-  Prompt: React.FC<PromptProps>;
-  Link: React.FC<any>;
-  routes?: any;
-}
-
-export type PromptProps = {
-  message: string;
-  when?: boolean;
-  setWarnWhen?: (warnWhen: boolean) => void;
-};
-
-export type RouteAction = Exclude<Action, "list"> | undefined;
-
-export type ActionWithPage = Extract<Action, "show" | "create" | "edit">;
-
-export type ResourceRouterParams = {
-  resource: string;
-  id?: string;
-  action: RouteAction;
-};
-
-export type ResourceErrorRouterParams = {
-  resource: string;
-  action: ActionWithPage | undefined;
-};

package/src/contexts/router/picker/index.tsx

@@ -1,21 +0,0 @@
-import React from "react";
-
-/**
- * This context is used to determine which router to use.
- *
- * This is a temporary solution until we remove the legacy router.
- */
-
-export const RouterPickerContext = React.createContext<"legacy" | "new">("new");
-
-export const RouterPickerProvider = RouterPickerContext.Provider;
-
-/**
- * This is a temporary hook to determine which router to use.
- * It will be removed once the legacy router is removed.
- * @internal This is an internal hook.
- */
-export const useRouterType = () => {
-  const value = React.useContext(RouterPickerContext);
-  return value;
-};

package/src/definitions/helpers/legacy-resource-transform/index.ts

@@ -1,29 +0,0 @@
-import type {
-  IResourceItem,
-  ResourceProps,
-} from "../../../contexts/resource/types";
-import { routeGenerator } from "../routeGenerator";
-
-/**
- * For the legacy definition of resources, we did a basic transformation for provided resources
- * - This is meant to provide an easier way to access properties.
- * - In the new definition, we don't need to do transformations and properties can be accessed via helpers or manually.
- * This is kept for backward compability
- */
-export const legacyResourceTransform = (resources: ResourceProps[]) => {
-  const _resources: IResourceItem[] = [];
-
-  resources.forEach((resource) => {
-    _resources.push({
-      ...resource,
-      label: resource.meta?.label ?? resource.options?.label,
-      route: routeGenerator(resource, resources),
-      canCreate: !!resource.create,
-      canEdit: !!resource.edit,
-      canShow: !!resource.show,
-      canDelete: resource.canDelete,
-    });
-  });
-
-  return _resources;
-};

package/src/definitions/helpers/pickNotDeprecated/index.ts

@@ -1,9 +0,0 @@
-/*
- * Returns first value that is not undefined.
- * @internal This is an internal helper function. Please do not use externally.
- */
-export const pickNotDeprecated = <T extends unknown[]>(
-  ...args: T
-): T[never] => {
-  return args.find((arg) => typeof arg !== "undefined");
-};

package/src/definitions/helpers/queryKeys/index.ts

@@ -1,114 +0,0 @@
-import type { QueryKey } from "@tanstack/react-query";
-
-import type { IQueryKeys, MetaQuery } from "../../../contexts/data/types";
-import { keys as newKeys } from "../keys";
-import { pickNotDeprecated } from "../pickNotDeprecated";
-
-/**
- * @deprecated `queryKeys` is deprecated. Please use `keys` instead.
- */
-export const queryKeys = (
-  resource?: string,
-  dataProviderName?: string,
-  meta?: MetaQuery,
-  /**
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery | undefined,
-): IQueryKeys => {
-  const providerName = dataProviderName || "default";
-  const keys: IQueryKeys = {
-    all: [providerName],
-    resourceAll: [providerName, resource || ""],
-    list: (config) => [
-      ...keys.resourceAll,
-      "list",
-      {
-        ...config,
-        ...(pickNotDeprecated(meta, metaData) || {}),
-      } as QueryKey,
-    ],
-    many: (ids) =>
-      [
-        ...keys.resourceAll,
-        "getMany",
-        ids?.map(String) as QueryKey,
-        { ...(pickNotDeprecated(meta, metaData) || {}) } as QueryKey,
-      ].filter((item) => item !== undefined),
-    detail: (id) => [
-      ...keys.resourceAll,
-      "detail",
-      id?.toString(),
-      { ...(pickNotDeprecated(meta, metaData) || {}) } as QueryKey,
-    ],
-    logList: (meta) =>
-      ["logList", resource, meta as any, metaData as QueryKey].filter(
-        (item) => item !== undefined,
-      ),
-  };
-  return keys;
-};
-
-export const queryKeysReplacement = (preferLegacyKeys?: boolean) => {
-  return (
-    resource?: string,
-    dataProviderName?: string,
-    meta?: MetaQuery,
-    /**
-     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-     */
-    metaData?: MetaQuery | undefined,
-  ): IQueryKeys => {
-    const providerName = dataProviderName || "default";
-
-    const keys: IQueryKeys = {
-      all: newKeys().data(providerName).get(preferLegacyKeys),
-      resourceAll: newKeys()
-        .data(dataProviderName)
-        .resource(resource ?? "")
-        .get(preferLegacyKeys),
-      list: (config) =>
-        newKeys()
-          .data(dataProviderName)
-          .resource(resource ?? "")
-          .action("list")
-          .params({
-            ...config,
-            ...(pickNotDeprecated(meta, metaData) || {}),
-          })
-          .get(preferLegacyKeys),
-      many: (ids) =>
-        newKeys()
-          .data(dataProviderName)
-          .resource(resource ?? "")
-          .action("many")
-          .ids(...(ids ?? []))
-          .params({
-            ...(pickNotDeprecated(meta, metaData) || {}),
-          })
-          .get(preferLegacyKeys),
-      detail: (id) =>
-        newKeys()
-          .data(dataProviderName)
-          .resource(resource ?? "")
-          .action("one")
-          .id(id ?? "")
-          .params({
-            ...(pickNotDeprecated(meta, metaData) || {}),
-          })
-          .get(preferLegacyKeys),
-      logList: (meta) =>
-        [
-          ...newKeys()
-            .audit()
-            .resource(resource)
-            .action("list")
-            .params(meta)
-            .get(preferLegacyKeys),
-          metaData as QueryKey,
-        ].filter((item) => item !== undefined),
-    };
-
-    return keys;
-  };
-};

package/src/definitions/helpers/routeGenerator/index.ts

@@ -1,29 +0,0 @@
-import type { ResourceProps } from "../../../contexts/resource/types";
-import { pickNotDeprecated } from "../pickNotDeprecated";
-import { getParentPrefixForResource } from "../router";
-
-/**
- * generates route for the resource based on parents and custom routes
- * @deprecated this is a **legacy** function and works only with the old resource definition
- */
-export const routeGenerator = (
-  item: ResourceProps,
-  resourcesFromProps: ResourceProps[],
-): string | undefined => {
-  let route;
-
-  const parentPrefix = getParentPrefixForResource(
-    item,
-    resourcesFromProps,
-    true,
-  );
-
-  if (parentPrefix) {
-    const meta = pickNotDeprecated(item.meta, item.options);
-    route = `${parentPrefix}/${meta?.route ?? item.name}`;
-  } else {
-    route = item.options?.route ?? item.name;
-  }
-
-  return `/${route.replace(/^\//, "")}`;
-};

package/src/definitions/helpers/treeView/createTreeView/index.ts

@@ -1,49 +0,0 @@
-import { pickNotDeprecated } from "@definitions/helpers/pickNotDeprecated";
-
-import type {
-  IMenuItem,
-  IResourceItem,
-  ITreeMenu,
-} from "../../../../contexts/resource/types";
-
-/**
- * @deprecated This helper is deprecated. Please use `createTree` instead.
- */
-export const createTreeView = (
-  resources: IResourceItem[] | IMenuItem[],
-): ITreeMenu[] | ITreeMenu[] => {
-  const tree = [];
-  const resourcesRouteObject: { [key: string]: any } = {};
-  const resourcesNameObject: { [key: string]: any } = {};
-  let parent: IResourceItem | IMenuItem;
-  let child: ITreeMenu;
-
-  for (let i = 0; i < resources.length; i++) {
-    parent = resources[i];
-
-    const route =
-      parent.route ??
-      pickNotDeprecated(parent?.meta, parent.options)?.route ??
-      "";
-
-    resourcesRouteObject[route] = parent;
-    resourcesRouteObject[route]["children"] = [];
-
-    resourcesNameObject[parent.name] = parent;
-    resourcesNameObject[parent.name]["children"] = [];
-  }
-
-  for (const name in resourcesRouteObject) {
-    if (Object.hasOwn(resourcesRouteObject, name)) {
-      child = resourcesRouteObject[name];
-
-      if (child.parentName && resourcesNameObject[child.parentName]) {
-        resourcesNameObject[child.parentName]["children"].push(child);
-      } else {
-        tree.push(child);
-      }
-    }
-  }
-
-  return tree;
-};

package/src/definitions/helpers/treeView/index.ts

@@ -1 +0,0 @@
-export { createTreeView } from "./createTreeView";

package/src/definitions/helpers/userFriendlyResourceName/index.ts

@@ -1,18 +0,0 @@
-import pluralize from "pluralize";
-import { humanizeString } from "@definitions";
-
-/**
- * A method that the internal uses
- * @internal
- * @deprecated use `useUserFriendlyName` instead.
- */
-export const userFriendlyResourceName = (
-  resource = "",
-  type: "singular" | "plural",
-): string => {
-  const humanizeResource = humanizeString(resource);
-  if (type === "singular") {
-    return pluralize.singular(humanizeResource);
-  }
-  return pluralize.plural(humanizeResource);
-};

package/src/hooks/legacy-router/index.ts

@@ -1 +0,0 @@
-export * from "./useRouterContext";

package/src/hooks/legacy-router/useRouterContext.ts

@@ -1,19 +0,0 @@
-import { useContext } from "react";
-
-import { LegacyRouterContext, defaultProvider } from "@contexts/router/legacy";
-
-export const useRouterContext = () => {
-  const routerContextValues = useContext(LegacyRouterContext);
-
-  const { useHistory, useLocation, useParams, Prompt, Link, routes } =
-    routerContextValues ?? defaultProvider;
-
-  return {
-    useHistory,
-    useLocation,
-    useParams,
-    Prompt,
-    Link,
-    routes,
-  };
-};

package/src/hooks/refine/useTitle.tsx

@@ -1,17 +0,0 @@
-import { useContext } from "react";
-
-import { RefineContext } from "@contexts/refine";
-
-import type { TitleProps } from "../../contexts/refine/types";
-
-/**
- * `useTitle` returns a component that calls the `<Title>` passed to the `<Refine>`.
- * In this way, it becomes easier for us to access this component in various parts of the application.
- *
- * @see {@link https://refine.dev/docs/api-reference/core/hooks/refine/useTitle} for more details.
- */
-export const useTitle: () => React.FC<TitleProps> | undefined = () => {
-  const { Title } = useContext(RefineContext);
-
-  return Title;
-};

package/src/hooks/resource/index.ts

@@ -1,2 +0,0 @@
-export * from "./useResource";
-export * from "./useResourceWithRoute";