Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version Packages #1915

Merged
merged 1 commit into from
Oct 24, 2023
Merged

Version Packages #1915

merged 1 commit into from
Oct 24, 2023

Conversation

clerk-cookie
Copy link
Collaborator

@clerk-cookie clerk-cookie commented Oct 18, 2023

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@clerk/shared@1.0.0

Major Changes

  • The package was reworked to allow for better isomorphic use cases and ESM support, resulting in some breaking changes. It now allows for subpath exports and restricts some imports to specific subpaths. (#1898) by @LekoArts

    Instead of importing from the root @clerk/shared import you can now use subpaths for most things:

    - import { deprecated, OrganizationProvider } from "@clerk/shared"
    + import { deprecated } from "@clerk/shared/deprecated"
    + import { OrganizationProvider } from "@clerk/shared/react"

    By using subpaths you can tell bundlers to only bundle specific parts, potentially helping with tree-shaking. It also mitigates issues where e.g. modules only relevant for React where picked up in Node.js-only environments.

    If you're not using @clerk/shared directly (only by proxy through e.g. @clerk/clerk-react) you don't need to do anything. If you are relying on @clerk/shared, please read through the breaking changes below and change your code accordingly. You can rely on your IDE to give you hints on which exports are available at @clerk/shared and @clerk/shared/<name> subpaths.

    Breaking Changes

    • @clerk/shared was and still is a dual CJS/ESM package. The ESM files provided by @clerk/shared now use .mjs file extensions and also define them in their import paths, following the ESM spec. Your bundler should handle this for you.

    • Some imports where moved from the root @clerk/shared import to isolated subpaths.

      • Helper utils for cookies and globs:

        - import { createCookieHandler, globs } from "@clerk/shared"
        + import { createCookieHandler } from "@clerk/shared/cookie"
        + import { globs } from "@clerk/shared/globs"
      • Everything related to React. Below is a small example and the full list of exports:

        - import { useSafeLayoutEffect, ClerkInstanceContext } from "@clerk/shared"
        + import { useSafeLayoutEffect, ClerkInstanceContext } from "@clerk/shared/react"

        Full list of exports moved to @clerk/shared/react:

        export {
          ClerkInstanceContext,
          ClientContext,
          OrganizationContext,
          OrganizationProvider,
          SessionContext,
          UserContext,
          assertContextExists,
          createContextAndHook,
          useClerkInstanceContext,
          useClientContext,
          useOrganization,
          useOrganizationContext,
          useOrganizationList,
          useOrganizations,
          useSafeLayoutEffect,
          useSessionContext,
          useUserContext,
        };

    If you run into an issues that might be a bug, please open a bug report with a minimal reproduction.

Patch Changes

  • Publish packages with npm provenance enabled (#1891) by @LekoArts

  • Improve internal test coverage and fix small bug inside callWithRetry (#1925) by @LekoArts

  • Update imports of @clerk/shared to granular entrypoints. This addresses warnings during a Next.js build that are the result of unsupported APIs being included in the module graph of builds for the edge runtime. (#1924) by @BRKalow

@clerk/clerk-js@4.63.0

Minor Changes

  • Introduce customization in UserProfile and OrganizationProfile (#1822) by @anagstef

    The <UserProfile /> component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the <UserProfile.Page> component, and external links can be added using the <UserProfile.Link> component. The default routes, such as Account and Security, can be reordered.

    Example React API usage:

    <UserProfile>
      <UserProfile.Page
        label='Custom Page'
        url='custom'
        labelIcon={<CustomIcon />}
      >
        <MyCustomPageContent />
      </UserProfile.Page>
      <UserProfile.Link
        label='External'
        url='/home'
        labelIcon={<Icon />}
      />
      <UserProfile.Page label='account' />
      <UserProfile.Page label='security' />
    </UserProfile>

    Custom pages and links should be provided as children using the <UserButton.UserProfilePage> and <UserButton.UserProfileLink> components when using the UserButton component.

    The <OrganizationProfile /> component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the <OrganizationProfile.Page> component, and external links can be added using the <OrganizationProfile.Link> component. The default routes, such as Members and Settings, can be reordered.

    Example React API usage:

    <OrganizationProfile>
      <OrganizationProfile.Page
        label='Custom Page'
        url='custom'
        labelIcon={<CustomIcon />}
      >
        <MyCustomPageContent />
      </OrganizationProfile.Page>
      <OrganizationProfile.Link
        label='External'
        url='/home'
        labelIcon={<Icon />}
      />
      <OrganizationProfile.Page label='members' />
      <OrganizationProfile.Page label='settings' />
    </OrganizationProfile>

    Custom pages and links should be provided as children using the <OrganizationSwitcher.OrganizationProfilePage> and <OrganizationSwitcher.OrganizationProfileLink> components when using the OrganizationSwitcher component.

Patch Changes

@clerk/clerk-react@4.27.0

Minor Changes

  • Introduce customization in UserProfile and OrganizationProfile (#1822) by @anagstef

    The <UserProfile /> component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the <UserProfile.Page> component, and external links can be added using the <UserProfile.Link> component. The default routes, such as Account and Security, can be reordered.

    Example React API usage:

    <UserProfile>
      <UserProfile.Page
        label='Custom Page'
        url='custom'
        labelIcon={<CustomIcon />}
      >
        <MyCustomPageContent />
      </UserProfile.Page>
      <UserProfile.Link
        label='External'
        url='/home'
        labelIcon={<Icon />}
      />
      <UserProfile.Page label='account' />
      <UserProfile.Page label='security' />
    </UserProfile>

    Custom pages and links should be provided as children using the <UserButton.UserProfilePage> and <UserButton.UserProfileLink> components when using the UserButton component.

    The <OrganizationProfile /> component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the <OrganizationProfile.Page> component, and external links can be added using the <OrganizationProfile.Link> component. The default routes, such as Members and Settings, can be reordered.

    Example React API usage:

    <OrganizationProfile>
      <OrganizationProfile.Page
        label='Custom Page'
        url='custom'
        labelIcon={<CustomIcon />}
      >
        <MyCustomPageContent />
      </OrganizationProfile.Page>
      <OrganizationProfile.Link
        label='External'
        url='/home'
        labelIcon={<Icon />}
      />
      <OrganizationProfile.Page label='members' />
      <OrganizationProfile.Page label='settings' />
    </OrganizationProfile>

    Custom pages and links should be provided as children using the <OrganizationSwitcher.OrganizationProfilePage> and <OrganizationSwitcher.OrganizationProfileLink> components when using the OrganizationSwitcher component.

Patch Changes

@clerk/remix@3.1.0

Minor Changes

  • Support usage of Remix's defer() method in the loader passed to rootAuthLoader(). (#1926) by @BRKalow

Patch Changes

@clerk/types@3.57.0

Minor Changes

  • Introduce customization in UserProfile and OrganizationProfile (#1822) by @anagstef

    The <UserProfile /> component now allows the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the <UserProfile.Page> component, and external links can be added using the <UserProfile.Link> component. The default routes, such as Account and Security, can be reordered.

    Example React API usage:

    <UserProfile>
      <UserProfile.Page
        label='Custom Page'
        url='custom'
        labelIcon={<CustomIcon />}
      >
        <MyCustomPageContent />
      </UserProfile.Page>
      <UserProfile.Link
        label='External'
        url='/home'
        labelIcon={<Icon />}
      />
      <UserProfile.Page label='account' />
      <UserProfile.Page label='security' />
    </UserProfile>

    Custom pages and links should be provided as children using the <UserButton.UserProfilePage> and <UserButton.UserProfileLink> components when using the UserButton component.

    The <OrganizationProfile /> component now supports the addition of custom pages and external links to the navigation sidebar. Custom pages can be created using the <OrganizationProfile.Page> component, and external links can be added using the <OrganizationProfile.Link> component. The default routes, such as Members and Settings, can be reordered.

    Example React API usage:

    <OrganizationProfile>
      <OrganizationProfile.Page
        label='Custom Page'
        url='custom'
        labelIcon={<CustomIcon />}
      >
        <MyCustomPageContent />
      </OrganizationProfile.Page>
      <OrganizationProfile.Link
        label='External'
        url='/home'
        labelIcon={<Icon />}
      />
      <OrganizationProfile.Page label='members' />
      <OrganizationProfile.Page label='settings' />
    </OrganizationProfile>

    Custom pages and links should be provided as children using the <OrganizationSwitcher.OrganizationProfilePage> and <OrganizationSwitcher.OrganizationProfileLink> components when using the OrganizationSwitcher component.

Patch Changes

@clerk/backend@0.31.3

Patch Changes

@clerk/chrome-extension@0.4.10

Patch Changes

@clerk/clerk-expo@0.19.12

Patch Changes

@clerk/fastify@0.6.17

Patch Changes

gatsby-plugin-clerk@4.4.18

Patch Changes

@clerk/localizations@1.26.7

Patch Changes

@clerk/nextjs@4.25.7

Patch Changes

  • Fix an issue where only static routes would be allowed by publicRoutes prop from authMiddleware. (#1928) by @desiprisg

  • Publish packages with npm provenance enabled (#1891) by @LekoArts

  • Update <ClerkProvider /> to work in client components within the app router. This allows rendering of the provider in client components, previously the pages router provider was being imported and throwing an error. (#1840) by @BRKalow

  • Update imports of @clerk/shared to granular entrypoints. This addresses warnings during a Next.js build that are the result of unsupported APIs being included in the module graph of builds for the edge runtime. (#1924) by @BRKalow

  • Updated dependencies [3bf64107e, 52f8553d2, 92727eec3, b09b66eec, 51861addf, 37d8856ba, aa4cd7615]:

    • @clerk/clerk-sdk-node@4.12.16
    • @clerk/backend@0.31.3
    • @clerk/shared@1.0.0
    • @clerk/clerk-react@4.27.0
    • @clerk/types@3.57.0

@clerk/clerk-sdk-node@4.12.16

Patch Changes

@clerk/themes@1.7.9

Patch Changes

@BRKalow BRKalow closed this Oct 24, 2023
auto-merge was automatically disabled October 24, 2023 17:02

Pull request was closed

@BRKalow BRKalow reopened this Oct 24, 2023
@BRKalow BRKalow added this pull request to the merge queue Oct 24, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 24, 2023
@nikosdouvlis nikosdouvlis merged commit 5be081f into main Oct 24, 2023
12 checks passed
@nikosdouvlis nikosdouvlis deleted the changeset-release/main branch October 24, 2023 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants