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

chore(deps): update dependency @clerk/types to v3.58.0 #9431

Merged
merged 1 commit into from
Nov 15, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 14, 2023

Mend Renovate logo banner

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@clerk/types (source) 3.52.0 -> 3.58.0 age adoption passing confidence

Release Notes

clerk/javascript (@​clerk/types)

v3.58.0

Compare Source

Minor Changes
  • Add support for custom roles in <OrganizationProfile/>. (#​2039) by @​panteliselef

    The previous roles (admin and basic_member), are still kept as a fallback.

  • Experimental support for <Gate/> with role checks. (#​2051) by @​panteliselef

v3.57.1

Compare Source

Patch Changes
  • Shows list of domains if member has the org:sys_domain:read permission. (#​1896) by @​panteliselef

  • Introduces new element appearance descriptors: (#​2010) by @​clerk-cookie

    • activeDeviceListItem allows you to customize the appearance of the active device list (accordion) item
      • activeDeviceListItem__current allows you to customize the appearance of the current active device list (accordion) item
    • activeDevice allows you to customize the appearance of the active device item
      • activeDevice__current allows you to customize the appearance of the current active device item
  • Simplify the WithOptions generic type (#​2008) by @​clerk-cookie

v3.57.0

Compare Source

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

v3.56.1

Compare Source

Patch Changes

v3.56.0

Compare Source

Minor Changes
  • Introduces three new element appearence descriptors: (#​1803) by @​octoper

    • tableHead let's you customize the tables head styles.
    • paginationButton let's you customize the pagination buttons.
    • paginationRowText let's you customize the pagination text.
Patch Changes
  • Update default organization permissions with a sys_ prefix as part of the entitlement. This changes makes it easy to distinguish between clerk reserved permissions and custom permissions created by developers. (#​1865) by @​mzhong9723

  • Mark the following SAML related types as stable: (#​1876) by @​dimkl

    • User.samlAccounts
    • SamlAccount
    • UserSettingsResource.saml
    • UserSettingsJSON.saml
    • SamlSettings
    • UserResource.samlAccounts
    • SamlAccountResource
    • SamlStrategy
    • UserJSON.saml_accounts
    • SamlAccountJSON
    • SamlConfig
    • SamlFactor
    • HandleSamlCallbackParams
  • Deprecate the organization.__unstable__invitationUpdate and organization.__unstable__membershipUpdate methods. (#​1879) by @​panteliselef

  • Fix methods in clerk-js that consumede paginated endpoints in order to retrieve single resources. (#​1871) by @​panteliselef

  • In invite members screen of the component, consume any invalid email addresses as they are returned in the API error and remove them from the input automatically. (#​1869) by @​chanioxaris

v3.55.0

Compare Source

Minor Changes
Patch Changes
  • Introduces a new isAuthorized() method in the Session class. Returns a promise and checks whether the active user is allowed to perform an action based on the passed (required) permission and the ones attached to the membership. (#​1834) by @​panteliselef

  • Introduce a new property on the core Clerk singleton, sdkMetadata. This will be populated by each host SDK. This metadata will be used to make logging and debugging easier. (#​1857) by @​BRKalow

  • Introduce new *EmailLink* helpers that will replace the *MagicLink* helpers. (#​1833) by @​dimkl

    Also marked all the *MagicLink* as deprecated using JSDocs.

v3.54.0

Compare Source

Minor Changes
  • Introduce a new user resource method to leave an organization. You can now call 'user.leaveOrganization(<org_id>)' when a user chooses to leave an organization instead of 'organization.removeMember(<user_id>)' which is mostly meant for organization based actions. (#​1809) by @​chanioxaris
Patch Changes
    • Introduce organizationProfileProps as prop in <OrganizationSwitcher/>. (#​1801) by @​panteliselef

    • Introduce appearance in userProfileProps in <UserButton/>.

    • Deprecate the usage of appearance.userProfile in <UserButton/>.

  • Introduce ClerkRuntimeError class for localizing error messages in ClerkJS components (#​1813) by @​panteliselef

  • Enables you to translate the tooltip hint while creating an organization through the formFieldHintText__slug key (#​1811) by @​LekoArts

  • Drop password property from UserJSON since it's not being returned by the Frontend API (#​1805) by @​dimkl

  • Remove experimenta jsdoc tags from multi-domain types. (#​1819) by @​panteliselef

  • Warn about publicUserData.profileImageUrl nested property deprecation in OrganizationMembership & OrganizationMembershipRequest resources. (#​1812) by @​dimkl

v3.53.0

Compare Source

Minor Changes
  • <SignIn/>, <SignUp/>, <RedirectToSignin/>, <RedirectToSignUp/>, clerk.redirectToSignIn() and clerk.redirectToSignUp() now accept the initialValues option, which will prefill the appropriate form fields with the values provided. (#​1701) by @​desiprisg

v3.52.1

Compare Source

Patch Changes
  • Introduces a new method for fetching organization invitations called Organization.getInvitations. (#​1766) by @​panteliselef

    Deprecate Organization.getPendingInvitations

  • Adds the ability to force users to reset their password. (#​1757) by @​kostaspt


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot enabled auto-merge (squash) November 14, 2023 23:59
@jtoar jtoar added the release:chore This PR is a chore (means nothing for users) label Nov 15, 2023
@jtoar jtoar added this to the next-release milestone Nov 15, 2023
@renovate renovate bot merged commit c5c41a0 into main Nov 15, 2023
34 of 36 checks passed
@renovate renovate bot deleted the renovate/clerk-types-3.x branch November 15, 2023 01:16
jtoar pushed a commit that referenced this pull request Nov 16, 2023
[![Mend Renovate logo
banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@clerk/types](https://clerk.com/)
([source](https://togithub.com/clerk/javascript)) | [`3.52.0` ->
`3.58.0`](https://renovatebot.com/diffs/npm/@clerk%2ftypes/3.52.0/3.58.0)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/@clerk%2ftypes/3.58.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@clerk%2ftypes/3.58.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@clerk%2ftypes/3.52.0/3.58.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@clerk%2ftypes/3.52.0/3.58.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

<details>
<summary>clerk/javascript (@&#8203;clerk/types)</summary>

[`v3.58.0`](https://togithub.com/clerk/javascript/releases/tag/%40clerk/types%403.58.0)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.57.1...@clerk/types@3.58.0)

- Add support for custom roles in `<OrganizationProfile/>`.
([#&#8203;2039](https://togithub.com/clerk/javascript/pull/2039)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

The previous roles (`admin` and `basic_member`), are still kept as a
fallback.

- Experimental support for `<Gate/>` with role checks.
([#&#8203;2051](https://togithub.com/clerk/javascript/pull/2051)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

[`v3.57.1`](https://togithub.com/clerk/javascript/releases/tag/%40clerk/types%403.57.1)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.57.0...@clerk/types@3.57.1)

- Shows list of domains if member has the `org:sys_domain:read`
permission.
([#&#8203;1896](https://togithub.com/clerkinc/javascript/pull/1896)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

- Introduces new element appearance descriptors:
([#&#8203;2010](https://togithub.com/clerkinc/javascript/pull/2010)) by
[@&#8203;clerk-cookie](https://togithub.com/clerk-cookie)

- `activeDeviceListItem` allows you to customize the appearance of the
active device list (accordion) item
- `activeDeviceListItem__current` allows you to customize the appearance
of the *current* active device list (accordion) item
- `activeDevice` allows you to customize the appearance of the active
device item
- `activeDevice__current` allows you to customize the appearance of the
*current* active device item

- Simplify the WithOptions generic type
([#&#8203;2008](https://togithub.com/clerkinc/javascript/pull/2008)) by
[@&#8203;clerk-cookie](https://togithub.com/clerk-cookie)

[`v3.57.0`](https://togithub.com/clerk/javascript/blob/HEAD/packages/types/CHANGELOG.md#3570)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.56.1...@clerk/types@3.57.0)

- Introduce customization in `UserProfile` and `OrganizationProfile`
([#&#8203;1822](https://togithub.com/clerk/javascript/pull/1822)) by
[@&#8203;anagstef](https://togithub.com/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:

    ```tsx
    <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:

    ```tsx
    <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.

- Publish packages with [npm
provenance](https://docs.npmjs.com/generating-provenance-statements)
enabled
([#&#8203;1891](https://togithub.com/clerk/javascript/pull/1891)) by
[@&#8203;LekoArts](https://togithub.com/LekoArts)

- Drop `experimental_force_oauth_first` &
`experimental__forceOauthFirst` from `DisplayConfig`
([#&#8203;1918](https://togithub.com/clerk/javascript/pull/1918)) by
[@&#8203;dimkl](https://togithub.com/dimkl)

[`v3.56.1`](https://togithub.com/clerk/javascript/blob/HEAD/packages/types/CHANGELOG.md#3561)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.56.0...@clerk/types@3.56.1)

- Deprecate experimental captcha from Clerk singleton.
([#&#8203;1905](https://togithub.com/clerk/javascript/pull/1905)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

[`v3.56.0`](https://togithub.com/clerk/javascript/blob/HEAD/packages/types/CHANGELOG.md#3560)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.55.0...@clerk/types@3.56.0)

- Introduces three new element appearence descriptors:
([#&#8203;1803](https://togithub.com/clerk/javascript/pull/1803)) by
[@&#8203;octoper](https://togithub.com/octoper)

    -   `tableHead` let's you customize the tables head styles.
    -   `paginationButton` let's you customize the pagination buttons.
    -   `paginationRowText` let's you customize the pagination text.

- Update default organization permissions with a `sys_` prefix as part
of the entitlement. This changes makes it easy to distinguish between
clerk reserved permissions and custom permissions created by developers.
([#&#8203;1865](https://togithub.com/clerk/javascript/pull/1865)) by
[@&#8203;mzhong9723](https://togithub.com/mzhong9723)

- Mark the following SAML related types as stable:
([#&#8203;1876](https://togithub.com/clerk/javascript/pull/1876)) by
[@&#8203;dimkl](https://togithub.com/dimkl)

    -   `User.samlAccounts`
    -   `SamlAccount`
    -   `UserSettingsResource.saml`
    -   `UserSettingsJSON.saml`
    -   `SamlSettings`
    -   `UserResource.samlAccounts`
    -   `SamlAccountResource`
    -   `SamlStrategy`
    -   `UserJSON.saml_accounts`
    -   `SamlAccountJSON`
    -   `SamlConfig`
    -   `SamlFactor`
    -   `HandleSamlCallbackParams`

- Deprecate the `organization.__unstable__invitationUpdate` and
`organization.__unstable__membershipUpdate` methods.
([#&#8203;1879](https://togithub.com/clerk/javascript/pull/1879)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

- Fix methods in clerk-js that consumede paginated endpoints in order to
retrieve single resources.
([#&#8203;1871](https://togithub.com/clerk/javascript/pull/1871)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

- In invite members screen of the <OrganizationProfile /> component,
consume any invalid email addresses as they are returned in the API
error and remove them from the input automatically.
([#&#8203;1869](https://togithub.com/clerk/javascript/pull/1869)) by
[@&#8203;chanioxaris](https://togithub.com/chanioxaris)

[`v3.55.0`](https://togithub.com/clerk/javascript/blob/HEAD/packages/types/CHANGELOG.md#3550)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.54.0...@clerk/types@3.55.0)

- Add support for LinkedIn OIDC
([#&#8203;1772](https://togithub.com/clerk/javascript/pull/1772)) by
[@&#8203;fragoulis](https://togithub.com/fragoulis)

- Introduces a new `isAuthorized()` method in the `Session` class.
Returns a promise and checks whether the active user is allowed to
perform an action based on the passed (required) permission and the ones
attached to the membership.
([#&#8203;1834](https://togithub.com/clerk/javascript/pull/1834)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

- Introduce a new property on the core Clerk singleton, `sdkMetadata`.
This will be populated by each host SDK. This metadata will be used to
make logging and debugging easier.
([#&#8203;1857](https://togithub.com/clerk/javascript/pull/1857)) by
[@&#8203;BRKalow](https://togithub.com/BRKalow)

- Introduce new `*EmailLink*` helpers that will replace the
`*MagicLink*` helpers.
([#&#8203;1833](https://togithub.com/clerk/javascript/pull/1833)) by
[@&#8203;dimkl](https://togithub.com/dimkl)

    Also marked all the `*MagicLink*` as deprecated using JSDocs.

[`v3.54.0`](https://togithub.com/clerk/javascript/blob/HEAD/packages/types/CHANGELOG.md#3540)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.53.0...@clerk/types@3.54.0)

- Introduce a new user resource method to leave an organization. You can
now call 'user.leaveOrganization(\<org_id>)' when a user chooses to
leave an organization instead of 'organization.removeMember(\<user_id>)'
which is mostly meant for organization based actions.
([#&#8203;1809](https://togithub.com/clerk/javascript/pull/1809)) by
[@&#8203;chanioxaris](https://togithub.com/chanioxaris)

- - Introduce organizationProfileProps as prop in
`<OrganizationSwitcher/>`.
([#&#8203;1801](https://togithub.com/clerk/javascript/pull/1801)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

    -   Introduce appearance in userProfileProps in `<UserButton/>`.

- Deprecate the usage of `appearance.userProfile` in `<UserButton/>`.

- Introduce ClerkRuntimeError class for localizing error messages in
ClerkJS components
([#&#8203;1813](https://togithub.com/clerk/javascript/pull/1813)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

- Enables you to translate the tooltip hint while creating an
organization through the `formFieldHintText__slug` key
([#&#8203;1811](https://togithub.com/clerk/javascript/pull/1811)) by
[@&#8203;LekoArts](https://togithub.com/LekoArts)

- Drop `password` property from `UserJSON` since it's not being returned
by the Frontend API
([#&#8203;1805](https://togithub.com/clerk/javascript/pull/1805)) by
[@&#8203;dimkl](https://togithub.com/dimkl)

- Remove experimenta jsdoc tags from multi-domain types.
([#&#8203;1819](https://togithub.com/clerk/javascript/pull/1819)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

- Warn about `publicUserData.profileImageUrl` nested property
deprecation in `OrganizationMembership` &
`OrganizationMembershipRequest` resources.
([#&#8203;1812](https://togithub.com/clerk/javascript/pull/1812)) by
[@&#8203;dimkl](https://togithub.com/dimkl)

[`v3.53.0`](https://togithub.com/clerk/javascript/blob/HEAD/packages/types/CHANGELOG.md#3530)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.52.1...@clerk/types@3.53.0)

- `<SignIn/>`, `<SignUp/>`, `<RedirectToSignin/>`,
`<RedirectToSignUp/>`, `clerk.redirectToSignIn()` and
`clerk.redirectToSignUp()` now accept the `initialValues` option, which
will prefill the appropriate form fields with the values provided.
([#&#8203;1701](https://togithub.com/clerk/javascript/pull/1701)) by
[@&#8203;desiprisg](https://togithub.com/desiprisg)

[`v3.52.1`](https://togithub.com/clerk/javascript/blob/HEAD/packages/types/CHANGELOG.md#3521)

[Compare
Source](https://togithub.com/clerk/javascript/compare/@clerk/types@3.52.0...@clerk/types@3.52.1)

- Introduces a new method for fetching organization invitations called
`Organization.getInvitations`.
([#&#8203;1766](https://togithub.com/clerk/javascript/pull/1766)) by
[@&#8203;panteliselef](https://togithub.com/panteliselef)

    Deprecate `Organization.getPendingInvitations`

- Adds the ability to force users to reset their password.
([#&#8203;1757](https://togithub.com/clerk/javascript/pull/1757)) by
[@&#8203;kostaspt](https://togithub.com/kostaspt)

</details>

---

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/redwoodjs/redwood).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@Tobbe Tobbe modified the milestones: next-release, v6.5.0 Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:chore This PR is a chore (means nothing for users)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants