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
71d1df51d1
openpanel/packages/devtools-internal/CHANGELOG.md
Stefan Pejcic 09f9f9502d packages
2024-11-07 19:03:37 +01:00

18 KiB
Raw Blame History

@refinedev/devtools-internal

1.1.14

Patch Changes

  • #6165 ccddff6eba23286d4025a7301de3ebfc24b1b633 Thanks @aliemir! - fix(devtools-internal): fix noop return on hooks for production builds

    Currently, @refinedev/devtools-internal returns noop function when bundled for production, yet the notation is not correctly interpreted by some bundlers. This PR fixes the issue by moving the empty return and noop functions to a separate definition.

    Resolves #6030

  • #6185 603c73eb7d376fc2357a577f5921f844a8f444e4 Thanks @aliemir! - feat(devtools): ability to change the port of the devtools server

    Now users can change the port of the devtools server by setting the REFINE_DEVTOOLS_PORT environment variable. Previously, the port was hardcoded to "5001" and could not be changed.

    If you're using @refinedev/cli's runner commands to start your development server, REFINE_DEVTOOLS_PORT will be propagated to your app with appropriate prefix. E.g. if you're using Vite, the environment variable will be VITE_REFINE_DEVTOOLS_PORT and it will be used by the @refinedev/devtools's <DevtoolsProvider /> component to connect to the devtools server.

    • In Next.js apps, it will be prefixed with NEXT_PUBLIC_
    • In Craco and Create React App apps, it will be prefixed with REACT_APP_
    • In Remix apps and other custom setups, the environment variable will be used as is.

    In some scenarios where the environment variables are not passed to the browser, you may need to manually set the Refine Devtools URL in the <DevtoolsProvider /> component via the url prop. Remix apps do not automatically pass environment variables to the browser, so you will need to set the URL manually. If not set, the default URL will be used.

    While the port can be changed, this feature also allows users to host the devtools server on a different machine or domain and provide the <DevtoolsProvider /> with the custom domain URL. This such case will be useful if you're dockerizing your app and devtools server separately.

    Enterprise Edition: Refine Devtools running on ports other than "5001" is only available in the Enterprise Edition. If you're using the Community Edition, Refine Devtools will not work if the port is changed.

    Resolves #5111

  • Updated dependencies [603c73eb7d376fc2357a577f5921f844a8f444e4]:

    • @refinedev/devtools-shared@1.1.12

1.1.13

Patch Changes

1.1.11

Patch Changes

1.1.10

Patch Changes

1.1.9

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.

  • Updated dependencies [db9756e7908]:

    • @refinedev/devtools-shared@1.1.7

1.1.8

Patch Changes

  • #5875 1c9a95f22ab Thanks @aliemir! - feat: update resource name accessing logic

    Updated resource name displaying logic to use resourceName from activity records to make sure resource is correctly displayed with custom query keys.

  • #5875 1c9a95f22ab Thanks @aliemir! - feat: add invalidate query button

    Added Invalidate Query button to settled queries in the devtools panel to allow users to manually invalidate queries for debugging purposes.

  • #5881 ba719f6ea26 Thanks @aliemir! - fix: declaration files in node10, node16 and nodenext module resolutions

  • Updated dependencies [1c9a95f22ab, 1c9a95f22ab, ba719f6ea26]:

    • @refinedev/devtools-shared@1.1.6

1.1.7

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

  • Updated dependencies [0c197d82393, 56ed144a0f5]:

    • @refinedev/devtools-shared@1.1.5

1.1.6

Patch Changes

1.1.5

Patch Changes

1.1.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.

  • Updated dependencies [80513a4e42f]:

    • @refinedev/devtools-shared@1.1.2

1.1.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.

  • Updated dependencies [80513a4e42f]:

    • @refinedev/devtools-shared@1.1.1

1.1.2

Patch Changes

  • #5008 c8499114e55 Thanks @aliemir! - Fixing the version of @refinedev/devtools-shared dependency to avoid breaking projects in mismatching releases.

1.1.1

Patch Changes

  • #5008 c8499114e55 Thanks @aliemir! - Fixing the version of @refinedev/devtools-shared dependency to avoid breaking projects in mismatching releases.

1.1.0

Minor Changes

  • #4960 d8e464fa2c4 Thanks @aliemir! - Initial beta release of refine devtools.🎉

    We're releasing refine devtools in beta. refine devtools is designed to help you debug and develop your refine apps. It will be a collection of features including monitoring queries and mutations, testing out inferencer generated codes, adding and updating refine packages from the UI and more. 🤯

    refine devtools gif

    Usage

    Install the dependencies using your package manager.

    npm i @refinedev/devtools@latest @refinedev/cli@latest

    Add <DevtoolsProvider /> and <DevtoolsPanel /> components to your app:

    You'll need to wrap your app with <DevtoolsProvider /> component and add <DevtoolsPanel /> component to your app to access the devtools UI.

    import { DevtoolsPanel, DevtoolsProvider } from "@refinedev/devtools";

const App = () => {
  return (
    <DevtoolsProvider>
      <Refine
      // ...
      >
        {/* ... */}
      </Refine>
      <DevtoolsPanel />
    </DevtoolsProvider>
  );
};

    Then you're good to go 🙌, <DevtoolsProvider /> will tell refine to connect to the devtools server and track your queries and mutations. <DevtoolsPanel /> will render the devtools UI in your app.

    note: Devtools only works in development mode and have no overhead on production builds. You don't need to do anything special to exclude DevTools from your bundle.

    Devtools is integrated with @refinedev/cli and it will be started automatically in development mode if you have @refinedev/devtools installed.

    If you want to start devtools manually or have a custom dev script, you can run refine devtools in your project directory or add the following scripts to your package.json:

    {
    "scripts": {
        // If you have not customized the start script.
        "start": "refine dev", // The devtools server runs automatically; you don't need to do anything.

        // If you have customized the start script.
        "start": "my-custom-dev-script & refine devtools" // Run the devtools server manually.

        // other scripts
    }
}

    If you don't have @refinedev/cli installed already, you can follow the installation guide to add it to your project.

    These commands will start the devtools server. If you want to access the devtools UI outside of your app without depending on the <DevtoolsPanel /> component, you can go to http://localhost:5001 in your browser. 🚀

Patch Changes

  • Updated dependencies [d8e464fa2c4]:
    • @refinedev/devtools-shared@1.1.0

1.0.0

Major Changes

  • #4960 d8e464fa2c4 Thanks @aliemir! - Initial beta release of refine devtools.🎉

    We're releasing refine devtools in beta. refine devtools is designed to help you debug and develop your refine apps. It will be a collection of features including monitoring queries and mutations, testing out inferencer generated codes, adding and updating refine packages from the UI and more. 🤯

    Usage

    Install the dependencies using your package manager.

    npm i @refinedev/devtools@next @refinedev/cli@next @refinedev/core@next

    Add <DevtoolsProvider /> and <DevtoolsPanel /> components to your app:

    You'll need to wrap your app with <DevtoolsProvider /> component and add <DevtoolsPanel /> component to your app to access the devtools UI.

    import { DevtoolsPanel, DevtoolsProvider } from "@refinedev/devtools";

const App = () => {
  return (
    <DevtoolsProvider>
      <Refine
      // ...
      >
        {/* ... */}
      </Refine>
      <DevtoolsPanel />
    </DevtoolsProvider>
  );
};

    Then you're good to go 🙌, <DevtoolsProvider /> will tell refine to connect to the devtools server and track your queries and mutations. <DevtoolsPanel /> will render the devtools UI in your app.

    note: Devtools only works in development mode and have no overhead on production builds. You don't need to do anything special to exclude DevTools from your bundle.

    Devtools is integrated with @refinedev/cli and it will be started automatically in development mode if you have @refinedev/devtools installed.

    If you want to start devtools manually or have a custom dev script, you can run refine devtools in your project directory or add the following scripts to your package.json:

    {
    "scripts": {
        // If you have not customized the start script.
        "start": "refine dev", // The devtools server runs automatically; you don't need to do anything.

        // If you have customized the start script.
        "start": "my-custom-dev-script & refine devtools" // Run the devtools server manually.

        // other scripts
    }
}

    If you don't have @refinedev/cli installed already, you can follow the installation guide to add it to your project.

    These commands will start the devtools server. If you want to access the devtools UI outside of your app without depending on the <DevtoolsPanel /> component, you can go to http://localhost:5001 in your browser. 🚀

Patch Changes

  • Updated dependencies [d8e464fa2c4]:
    • @refinedev/devtools-shared@1.0.0