UniqueSoft/openpanel
2
0
Fork 0
mirror of https://github.com/stefanpejcic/openpanel synced 2025-06-26 18:28:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
ce1cc1fef4
openpanel/packages/kbar/CHANGELOG.md
Stefan Pejcic 09f9f9502d packages
2024-11-07 19:03:37 +01:00

18 KiB
Raw Blame History

@refinedev/kbar

1.3.12

Patch Changes

1.3.11

Patch Changes

1.3.10

Patch Changes

  • #5928 db9756e7908 Thanks @aliemir! - fix: type errors on typescript <5

    Due to the changes in #5881, typescript users below version 5 are facing type errors. This PR fixes the type errors by updating the file extensions required by the d.mts declaration files to provide a compatible declarations for both typescript 4 and 5 users.

1.3.9

Patch Changes

1.3.8

Patch Changes

  • #5765 0c197d82393 Thanks @aliemir! - refactor: package bundles and package.json configuration for exports

    Previously, Refine packages had exported ESM and CJS bundles with same .js extension and same types for both with .d.ts extensions. This was causing issues with bundlers and compilers to pick up the wrong files for the wrong environment. Now we're outputting ESM bundles with .mjs extension and CJS bundles with .cjs extension. Also types are now exported with both .d.mts and .d.cts extensions.

    In older versions ESM and CJS outputs of some packages were using wrong imports/requires to dependencies causing errors in some environments. This will be fixed since now we're also enforcing the module type with extensions.

    Above mentioned changes also supported with changes in package.json files of the packages to support the new extensions and types. All Refine packages now include exports fields in their configuration to make sure the correct bundle is picked up by the bundlers and compilers.

  • #5754 56ed144a0f5 Thanks @alicanerdurmaz! - chore: TypeScript upgraded to v5.x.x. #5752

1.3.7

Patch Changes

1.3.6

Patch Changes

1.3.5

Patch Changes

1.3.4

Patch Changes

  • #5022 80513a4e42f Thanks @BatuhanW! - chore: update README.md

    • fix grammar errors.
    • make all README.md files consistent.
    • add code example code snippets.

1.3.3

Patch Changes

  • #5022 80513a4e42f Thanks @BatuhanW! - chore: update README.md

    • fix grammar errors.
    • make all README.md files consistent.
    • add code example code snippets.

1.3.2

Patch Changes

1.3.1

Patch Changes

1.3.0

Minor Changes

  • #4741 026ccf34356 Thanks @aliemir! - Added sideEffects: false to package.json to help bundlers tree-shake unused code.

1.2.0

Minor Changes

  • #4741 026ccf34356 Thanks @aliemir! - Added sideEffects: false to package.json to help bundlers tree-shake unused code.

1.1.2

Patch Changes

1.1.1

Patch Changes

1.1.0

Minor Changes

Patch Changes

0.12.0

Minor Changes

0.11.0

Minor Changes

0.10.2

Patch Changes

  • Fixed version of react-router to 6.3.0

0.10.1

Patch Changes

0.10.0

Minor Changes

  • Update type declaration generation with tsc instead of tsup for better navigation throughout projects source code.

0.9.0

Minor Changes

  • #2440 0150dcd070 Thanks @aliemir! - Update type declaration generation with tsc instead of tsup for better navigation throughout projects source code.

0.8.0

Minor Changes

  • Add React@18 support 🚀

0.7.0

Minor Changes

0.6.0

Minor Changes

  • Pass the full resource to the accessControlProvider can method. This will enable Attribute Based Access Control (ABAC), for example granting permissions based on the value of a field in the resource object.

    const App: React.FC = () => {
  <Refine
    // other providers and props
    accessControlProvider={{
      can: async ({ resource, action, params }) => {
        if (resource === "posts" && action === "edit") {
          return Promise.resolve({
            can: false,
            reason: "Unauthorized",
          });
        }

        // or you can access directly *resource object
        // const resourceName = params?.resource?.name;
        // const anyUsefulOption = params?.resource?.options?.yourUsefulOption;
        // if (resourceName === "posts" && anyUsefulOption === true && action === "edit") {
        //     return Promise.resolve({
        //         can: false,
        //         reason: "Unauthorized",
        //     });
        // }

        return Promise.resolve({ can: true });
      },
    }}
  />;
};

0.5.0

Minor Changes

  • e78b181b12 Thanks @omeraplak! - Pass the full resource to the accessControlProvider can method. This will enable Attribute Based Access Control (ABAC), for example granting permissions based on the value of a field in the resource object.

    const App: React.FC = () => {
  <Refine
    // other providers and props
    accessControlProvider={{
      can: async ({ resource, action, params }) => {
        if (resource === "posts" && action === "edit") {
          return Promise.resolve({
            can: false,
            reason: "Unauthorized",
          });
        }

        // or you can access directly *resource object
        // const resourceName = params?.resource?.name;
        // const anyUsefulOption = params?.resource?.options?.yourUsefulOption;
        // if (resourceName === "posts" && anyUsefulOption === true && action === "edit") {
        //     return Promise.resolve({
        //         can: false,
        //         reason: "Unauthorized",
        //     });
        // }

        return Promise.resolve({ can: true });
      },
    }}
  />;
};

0.4.0

Minor Changes

  • All of the refine packages have dependencies on the @pankod/refine-core package. So far we have managed these dependencies with peerDependencies + dependencies but this causes issues like #2183. (having more than one @pankod/refine-core version in node_modules and creating different instances)

    Managing as peerDependencies + devDependencies seems like the best way for now to avoid such issues.

0.3.0

Minor Changes

  • #2217 b4aae00f77 Thanks @omeraplak! - All of the refine packages have dependencies on the @pankod/refine-core package. So far we have managed these dependencies with peerDependencies + dependencies but this causes issues like #2183. (having more than one @pankod/refine-core version in node_modules and creating different instances)

    Managing as peerDependencies + devDependencies seems like the best way for now to avoid such issues.

0.2.2

Patch Changes

  • Fixed react-dom dependency version

    - "react-dom": "^17.0.4"
+ "react-dom": "^17.0.0 || ^18.0.0"

0.2.1

Patch Changes

  • #2178 7a8e74a0af Thanks @biskuvit! - Fixed react-dom dependency version

    - "react-dom": "^17.0.4"
+ "react-dom": "^17.0.0 || ^18.0.0"

0.2.0

Minor Changes

  • Command palette for the refine. this package use kbar to generate the command palette.

    💡 How use the refine-kbar command palette?

    1. Import the package
    1. Wrap the <Refine> component with the <RefineKbarProvider>.
    import { Refine } from "@pankod/refine-core";
import { RefineKbarProvider } from "@pankod/refine-kbar";
const App: React.FC = () => {
  return (
    <RefineKbarProvider>
      <Refine />
    </RefineKbarProvider>
  );
};
    1. Create <OffLayoutArea/> component for the Refine component and use the refine-kbar command palette in <OffLayoutArea>

    We have the <RefineKbar> component to provide the command palette to the <Refine> component.

    import { Refine } from "@pankod/refine-core";
import { RefineKbar, RefineKbarProvider } from "@pankod/refine-kbar";

const OffLayoutArea: React.FC = () => {
  return <RefineKbar />;
};
const App: React.FC = () => {
  return (
    <RefineKbarProvider>
      <Refine OffLayoutArea={OffLayoutArea} />
    </RefineKbarProvider>
  );
};

    Note

    📢 Q: Why we need to wrap the <Refine> component with the <RefineKbarProvider>? A: The <RefineKbarProvider> is a wrapper component that provides the command palette to the <Refine> component. Q: Why we need to add <OffLayoutArea> to the <Refine> component? A: Because we need to reach the resources property of the <Refine> component.

0.1.0

Minor Changes

  • #2117 e941ac0f47 Thanks @biskuvit! - Command palette for the refine. this package use kbar to generate the command palette.

    💡 How use the refine-kbar command palette?

    1. Import the package
    1. Wrap the <Refine> component with the <RefineKbarProvider>.
    import { Refine } from "@pankod/refine-core";
import { RefineKbarProvider } from "@pankod/refine-kbar";
const App: React.FC = () => {
  return (
    <RefineKbarProvider>
      <Refine />
    </RefineKbarProvider>
  );
};
    1. Create <OffLayoutArea/> component for the Refine component and use the refine-kbar command palette in <OffLayoutArea>

    We have the <RefineKbar> component to provide the command palette to the <Refine> component.

    import { Refine } from "@pankod/refine-core";
import { RefineKbar, RefineKbarProvider } from "@pankod/refine-kbar";

const OffLayoutArea: React.FC = () => {
  return <RefineKbar />;
};
const App: React.FC = () => {
  return (
    <RefineKbarProvider>
      <Refine OffLayoutArea={OffLayoutArea} />
    </RefineKbarProvider>
  );
};

    Note

    📢 Q: Why we need to wrap the <Refine> component with the <RefineKbarProvider>? A: The <RefineKbarProvider> is a wrapper component that provides the command palette to the <Refine> component. Q: Why we need to add <OffLayoutArea> to the <Refine> component? A: Because we need to reach the resources property of the <Refine> component.