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

fix(deps): update dependency @clerk/clerk-sdk-node to v5 #98

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Apr 29, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@clerk/clerk-sdk-node (source) 4.13.21 -> 5.0.40 age adoption passing confidence

Release Notes

clerk/javascript (@​clerk/clerk-sdk-node)

v5.0.40

Compare Source

Patch Changes

v5.0.39

Compare Source

Patch Changes

v5.0.38

Compare Source

Patch Changes

v5.0.37

Compare Source

Patch Changes

v5.0.36

Compare Source

Patch Changes

v5.0.35

Compare Source

Patch Changes

v5.0.34

Compare Source

Patch Changes

v5.0.33

Compare Source

Patch Changes

v5.0.32

Compare Source

Patch Changes

v5.0.31

Compare Source

Patch Changes

v5.0.30

Compare Source

Patch Changes

v5.0.29

Compare Source

Patch Changes

v5.0.28

Compare Source

Patch Changes

v5.0.27

Compare Source

Patch Changes

v5.0.26

Compare Source

Patch Changes

v5.0.25

Compare Source

Patch Changes

v5.0.24

Compare Source

Patch Changes

v5.0.23

Compare Source

Patch Changes

v5.0.22

Compare Source

Patch Changes

v5.0.21

Compare Source

Patch Changes

v5.0.20

Compare Source

Patch Changes

v5.0.19

Compare Source

Patch Changes

v5.0.18

Compare Source

Patch Changes

v5.0.17

Compare Source

Patch Changes

v5.0.16

Compare Source

Patch Changes

v5.0.15

Compare Source

Patch Changes

v5.0.14

Compare Source

Patch Changes

v5.0.13

Compare Source

Patch Changes

v5.0.12

Compare Source

Patch Changes

v5.0.11

Compare Source

Patch Changes

v5.0.10

Compare Source

Patch Changes

v5.0.9

Compare Source

Patch Changes

v5.0.8

Compare Source

Patch Changes

v5.0.7

Compare Source

Patch Changes

v5.0.6

Compare Source

Patch Changes

v5.0.5

Compare Source

Patch Changes
  • Inherit verifyToken options from clerkClient. (#​3296) by @​panteliselef

    The below code now works as expected: (requires CLERK_SECRET_KEY env var to have been set)

    import { clerkClient } from "@​clerk/clerk-sdk-node";
    
    // Use the default settings from the already instanciated clerkClient
    clerkClient.verifyToken(token);
    // or provide overrides the options
    clerkClient.verifyToken(token, {
      secretKey: "xxxx",
    });
  • Updated dependencies [b92402258]:

v5.0.4

Compare Source

Patch Changes

v5.0.3

Compare Source

Patch Changes

v5.0.2

Compare Source

Patch Changes

v5.0.1

Compare Source

Patch Changes

v5.0.0

Compare Source

Major Changes
  • c2a0905: Change the minimal Node.js version required by Clerk to 18.17.0.

  • deac67c: Drop default exports from all packages. Migration guide:

    • use import { Clerk } from '@​clerk/backend';
    • use import { clerkInstance } from '@​clerk/clerk-sdk-node';
    • use import { Clerk } from '@​clerk/clerk-sdk-node';
    • use import { Clerk } from '@​clerk/clerk-js';
    • use import { Clerk } from '@​clerk/clerk-js/headless';
    • use import { IsomorphicClerk } from '@​clerk/clerk-react'
  • 02976d4: (Note: This is only relevant if, in the unlikely case, you are using Clerk from @clerk/clerk-sdk-node directly. If not, you can safely ignore this change.)

    Remove the named Clerk import from @clerk/clerk-sdk-node and import createClerkClient instead. The latter is a factory method to create a Clerk client instance for you. This update aligns usage across our SDKs and will enable us to ship DX improvements better in the future.

    import { Clerk } from "@​clerk/clerk-sdk-node";
    const clerk = Clerk({ secretKey: "..." });

    You need to rename the import from Clerk to createClerkClient and change its usage:

    import { createClerkClient } from "@​clerk/clerk-sdk-node";
    const clerk = createClerkClient({ secretKey: "..." });
  • 9b02c1a: Drop all pre-instantiated Backend API resources (allowlistIdentifiers, clients, emailAddresses, emails, invitations, organizations, phoneNumbers, redirectUrls, sessions, signInTokens, users, domains). Use the clerkClient import instead.

    // Before
    import { users } from "@​clerk/clerk-sdk-node";
    // After
    import { clerkClient } from "@​clerk/clerk-sdk-node";
    clerkClient.users;
  • 71663c5: Internal update default apiUrl domain from clerk.dev to clerk.com

  • dd57030: Change the response payload of Backend API requests to return { data, errors } instead of return the data and throwing on error response.
    Code example to keep the same behavior:

    import { users } from "@​clerk/backend";
    import { ClerkAPIResponseError } from "@​clerk/shared/error";
    
    const { data, errors, clerkTraceId, status, statusText } =
      await users.getUser("user_deadbeef");
    if (errors) {
      throw new ClerkAPIResponseError(statusText, {
        data: errors,
        status,
        clerkTraceId,
      });
    }
  • f0126a7: Changes the request.auth type from LegacyAuthObject to AuthObject.

    type LegacyAuthObject = {
      sessionId: string | null;
      actor: ActClaim | undefined | null;
      userId: string | null;
      getToken: ServerGetToken | null;
      debug: AuthObjectDebug | null;
      claims: JwtPayload | null;
    };
    
    type AuthObject = {
      sessionClaims: JwtPayload | null;
      sessionId: string | null;
      actor: ActClaim | undefined | null;
      userId: string | null;
      orgId: string | undefined | null;
      orgRole: OrganizationCustomRoleKey | undefined | null;
      orgSlug: string | undefined | null;
      orgPermissions: OrganizationCustomPermissionKey[] | undefined | null;
      getToken: ServerGetToken | null;
      has: CheckAuthorizationWithCustomPermissions | null;
      debug: AuthObjectDebug | null;
    };
  • ee432df: Drop deprecations. Migration steps:

    • use CLERK_SECRET_KEY instead of CLERK_API_KEY env variable
    • use secretKey instead of apiKey
    • use CLERK_PUBLISHABLE_KEY instead of CLERK_FRONTEND_API env variable
    • use publishableKey instead of frontendApi
    • drop Redwood hotfix (upgrade to latest version)
    • use createClerkClient with options to create a new clerkClient instead of using
      the following setters:
      • setClerkApiVersion
      • setClerkHttpOptions
      • setClerkServerApiUrl
      • setClerkApiKey
    • use @clerk/clerk-sdk-node instead of @clerk/clerk-sdk-node/{cjs|esm}/instance

    Extra:

    • bundle only index.ts and instance.ts
  • 97407d8: Dropping support for Node 14 and 16 as they both reached EOL status. The minimal Node.js version required by Clerk is 18.18.0 now.

  • 0ec3a14: Changes in exports of @clerk/backend:

    • Expose the following helpers and enums from @clerk/backend/internal:
      import {
        AuthStatus,
        buildRequestUrl,
        constants,
        createAuthenticateRequest,
        createIsomorphicRequest,
        debugRequestState,
        makeAuthObjectSerializable,
        prunePrivateMetadata,
        redirect,
        sanitizeAuthObject,
        signedInAuthObject,
        signedOutAuthObject,
      } from "@​clerk/backend/internal";
    • Drop the above exports from the top-level api:
      // Before
      import { AuthStatus, ... } from '@​clerk/backend';
      // After
      import { AuthStatus, ... } from '@​clerk/backend/internal';
      Dropping those exports results in also dropping the exports from gatsby-plugin-clerk, @clerk/clerk-sdk-node, @clerk/backend, @clerk/fastify, @clerk/nextjs, @clerk/remix packages.
  • 1ad910e: Changes in exports of @clerk/backend:

    • Drop the following internal exports from the top-level api:
      // Before
      import {
        AllowlistIdentifier,
        Client,
        DeletedObject,
        Email,
        EmailAddress,
        ExternalAccount,
        IdentificationLink,
        Invitation,
        OauthAccessToken,
        ObjectType,
        Organization,
        OrganizationInvitation,
        OrganizationMembership,
        OrganizationMembershipPublicUserData,
        PhoneNumber,
        RedirectUrl,
        SMSMessage,
        Session,
        SignInToken,
        Token,
        User,
        Verification,
      } from "@​clerk/backend";
      // After : no alternative since there is no need to use those classes
      Dropping those exports results in also dropping the exports from gatsby-plugin-clerk, @clerk/clerk-sdk-node, @clerk/backend, @clerk/fastify, @clerk/nextjs, @clerk/remix packages.
    • Keep those 3 resource related type exports
      import type {
        Organization,
        Session,
        User,
        WebhookEvent,
        WebhookEventType,
      } from "@​clerk/backend";
  • f58a994: Changes in exports of @clerk/backend:

    • Expose the following helpers and enums from @clerk/backend/jwt:
      import {
        decodeJwt,
        hasValidSignature,
        signJwt,
        verifyJwt,
      } from "@​clerk/backend/jwt";
    • Drop the above exports from the top-level api:
      // Before
      import { decodeJwt, ... } from '@​clerk/backend';
      // After
      import { decodeJwt, ... } from '@​clerk/backend/jwt';
      Dropping those exports results in also dropping the exports from gatsby-plugin-clerk, @clerk/clerk-sdk-node, @clerk/backend, @clerk/fastify, @clerk/nextjs, @clerk/remix packages.
  • e1f7eae: Limit TokenVerificationError exports to TokenVerificationError and TokenVerificationErrorReason

  • 9b02c1a: Changes in @clerk/backend exports:

    • Drop Internal deserialize helper
    • Introduce /errors subpath export, eg:
      import {
        TokenVerificationError,
        TokenVerificationErrorAction,
        TokenVerificationErrorCode,
        TokenVerificationErrorReason,
      } from "@​clerk/backend/errors";
    • Drop errors from top-level export
      // Before
      import {
        TokenVerificationError,
        TokenVerificationErrorReason,
      } from "@​clerk/backend";
      // After
      import {
        TokenVerificationError,
        TokenVerificationErrorReason,
      } from "@​clerk/backend/errors";
Minor Changes
  • 2964f8a: Expose debug headers in response for handshake / signed-out states from SDKs using headers returned from authenticateRequest()

  • 7af0949: Add missing createdAt param in User#createUser() of @clerk/backend.
    Fix clerkClient.verifyToken() signature to support a single token: string parameter.

  • 4bb5705: Breaking Changes:

    • Drop isLegacyFrontendApiKey from @clerk/shared
    • Drop default exports from @clerk/clerk-js
      • on headless Clerk type
      • on ui and ui.retheme Portal
    • Use isProductionFromSecretKey instead of isProductionFromApiKey
    • Use isDevelopmentFromSecretKey instead of isDevelopmentFromApiKey

    Changes:

    • Rename HeadlessBrowserClerkConstrutor / HeadlessBrowserClerkConstructor (typo)
    • Use isomorphicAtob / isomorhpicBtoa to replace base-64 in @clerk/expo
    • Refactor merging build-time and runtime props in @clerk/backend clerk client
    • Drop node-fetch dependency from @clerk/backend
    • Drop duplicate test in @clerk/backend
  • 18c0d01: Pass environment into sdkMetadata in order to detect if production clerk-js is used by other sdks in dev mode. When it is log dev warning from clerk-js.

  • b4e79c1: Replace the Clerk-Backend-SDK header with User-Agent in BAPI requests and update it's value to contain both the package name and the package version of the clerk package
    executing the request. Eg request from @clerk/nextjs to BAPI with append User-Agent: @​clerk/nextjs@5.0.0-alpha-v5.16 using the latest version.

    Miscellaneous changes: The backend test build changed to use tsup.

  • a86a5fc: Fix error thrown for undefined Clerk in case of using default clerkClient from @clerk/clerk-sdk-node without secretKey caused by replaced import.

Patch Changes
  • 93d05c8: Drop the introduction of OrganizationRole and OrganizationPermission resources fro BAPI.

  • 4aaf510: Remove createSms functions from @​clerk/backend and @​clerk/sdk-node.

    The equivalent /sms_messages Backend API endpoint will also dropped in the future, since this feature will no longer be available for new instances.

    For a brief period it will still be accessible for instances that have used it in the past 7
    days (13-11-2023 to 20-11-2023).

    New instances will get a 403 forbidden response if they try to access it.

  • 2de442b: Rename beta-v5 to beta

  • ef2325d: Introduce isTruthy helper to better cast environment variables to a boolean. Previously only the string "true" was checked, now true, "true", "1", and 1 will work.

  • 6a76977: Update README for v5

  • b8266a0: Integrate handshake handling into ClerkExpressWithAuth() and ClerkExpressRequireWith(). If the authenticateRequest() returns a redirect or is in a handshake state, the middlewares will properly handle this and respond accordingly.

  • 8e5c881: The following paginated APIs now return { data, totalCount } instead of simple arrays, in order to make building paginated UIs easier:

    • clerkClient.users.getOrganizationMembershipList(...)
    • clerkClient.organization.getOrganizationList(...)
    • clerkClient.organization.getOrganizationInvitationList(...)

    Revert changing the { data, errors } return value of the following helpers to throw the errors or return the data (keep v4 format):

    • import { verifyToken } from '@​clerk/backend'
    • import { signJwt, hasValidSignature, decodeJwt, verifyJwt } from '@​clerk/backend/jwt'
    • BAPI clerkClient methods eg (clerkClient.users.getUserList(...))
  • 2e77cd7: Set correct information on required Node.js and React versions in README

  • 0ce0edc: Add OrganizationPermissionAPI for CRUD operations regarding instance level organization permissions.

  • a605335: Fix types of ClerkExpressWithAuth/ClerkExpressRequireAuth args

  • 40ac4b6: Introduces telemetry collection from Clerk's SDKs. Collected telemetry will be used to gain insights into product usage and help drive roadmap priority. For more information, see https://clerk.com/docs/telemetry.

  • Updated dependencies [3a2f136]

  • Updated dependencies [8c23651]

  • Updated dependencies [f4f99f1]

  • Updated dependencies [743c4d2]

  • Updated dependencies [4b8bedc]

  • Updated dependencies [9272006]

  • Updated dependencies [c2a0905]

  • Updated dependencies [966b312]

  • Updated dependencies [1834a3e]

  • Updated dependencies [a8901be]

  • Updated dependencies [896cb61]

  • Updated dependencies [64d3763]

  • Updated dependencies [8350109]

  • Updated dependencies [7b200af]

  • Updated dependencies [988a299]

  • Updated dependencies [ecb60da]

  • Updated dependencies [deac67c]

  • Updated dependencies [b3a3dcd]

  • Updated dependencies [1dc28ab]

  • Updated dependencies [83e9d08]

  • Updated dependencies [244de5e]

  • Updated dependencies [791c498]

  • Updated dependencies [935b088]

  • Updated dependencies [93d05c8]

  • Updated dependencies [ea49336]

  • Updated dependencies [a9fe242]

  • Updated dependencies [448e02e]

  • Updated dependencies [2671e7a]

  • Updated dependencies [799abc2]

  • Updated dependencies [4aaf510]

  • Updated dependencies [a68eb30]

  • Updated dependencies [2de442b]

  • Updated dependencies [15af02a]

  • Updated dependencies [db18787]

  • Updated dependencies [7f833da]

  • Updated dependencies [de6519d]

  • Updated dependencies [e6ecbaa]

  • Updated dependencies [ef2325d]

  • Updated dependencies [6a76977]

  • Updated dependencies [fc3ffd8]

  • Updated dependencies [8b6b094]

  • Updated dependencies [bab2e7e]

  • Updated dependencies [71663c5]

  • Updated dependencies [a6b893d]

  • Updated dependencies [02976d4]

  • Updated dependencies [492b8a7]

  • Updated dependencies [8e5c881]

  • Updated dependencies [9e99eb7]

  • Updated dependencies [034c47c]

  • Updated dependencies [e5c989a]

  • Updated dependencies [7ecd6f6]

  • Updated dependencies [12f3c5c]

  • Updated dependencies [c776f86]

  • Updated dependencies [90aa2ea]

  • Updated dependencies [1e98187]

  • Updated dependencies [a605335]

  • Updated dependencies [2e77cd7]

  • Updated dependencies [2964f8a]

  • Updated dependencies [7af0949]

  • Updated dependencies [97407d8]

  • Updated dependencies [63dfe8d]

  • Updated dependencies [e921af2]

  • Updated dependencies [d08ec6d]

  • Updated dependencies [dd57030]

  • Updated dependencies [5f58a22]

  • Updated dependencies [0307957]

  • Updated dependencies [c22cd52]

  • Updated dependencies [52ff8fe]

  • Updated dependencies [86d52fb]

  • Updated dependencies [c7e6d00]

  • Updated dependencies [8cc45d2]

  • Updated dependencies [a9fe242]

  • Updated dependencies [97407d8]

  • Updated dependencies [12962bc]

  • Updated dependencies [7cb1241]

  • Updated dependencies [9615e6c]

  • Updated dependencies [0ec3a14]

  • Updated dependencies [4bb5705]

  • Updated dependencies [bad4de1]

  • Updated dependencies [d4ff346]

  • Updated dependencies [7644b74]

  • Updated dependencies [2ec9f6b]

  • Updated dependencies [66b2836]

  • Updated dependencies [46040a2]

  • Updated dependencies [cace853]

  • Updated dependencies [1ad910e]

  • Updated dependencies [8daf845]

  • Updated dependencies [f58a994]

  • Updated dependencies [4aaf510]

  • Updated dependencies [75ea300]

  • Updated dependencies [d22e616]

  • Updated dependencies [e1f7eae]

  • Updated dependencies [7f751c4]

  • Updated dependencies [4fced88]

  • Updated dependencies [f5d55bb]

  • Updated dependencies [[0d1052a](https://redirect.githu


Configuration

📅 Schedule: Branch creation - "before 4am on Monday" (UTC), Automerge - "after 9am and before 5pm Monday" (UTC).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot changed the title fix(deps): update dependency @clerk/clerk-sdk-node to v5 fix(deps): update dependency @clerk/clerk-sdk-node to v5 - autoclosed May 1, 2024
@renovate renovate bot closed this May 1, 2024
@renovate renovate bot deleted the renovate/clerk-clerk-sdk-node-5.x branch May 1, 2024 09:05
@renovate renovate bot changed the title fix(deps): update dependency @clerk/clerk-sdk-node to v5 - autoclosed fix(deps): update dependency @clerk/clerk-sdk-node to v5 May 1, 2024
@renovate renovate bot restored the renovate/clerk-clerk-sdk-node-5.x branch May 1, 2024 13:36
@renovate renovate bot reopened this May 1, 2024
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 2 times, most recently from 56c7b30 to a20aa50 Compare May 6, 2024 04:18
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 4 times, most recently from fa9efea to dc7ba11 Compare May 15, 2024 15:06
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 3 times, most recently from d19d021 to 6e9fcc9 Compare May 27, 2024 03:31
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 3 times, most recently from 34c7fbb to 6c178f4 Compare June 10, 2024 04:08
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch from 6c178f4 to 6e1df6c Compare June 12, 2024 11:04
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch from 6e1df6c to c601264 Compare June 20, 2024 10:31
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch from c601264 to 4939803 Compare July 3, 2024 02:01
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 2 times, most recently from 616b977 to 9db8062 Compare July 16, 2024 18:55
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 3 times, most recently from 6c4c4bb to 8211468 Compare July 26, 2024 16:22
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 4 times, most recently from 874bd7f to 4c39a2d Compare August 5, 2024 22:46
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 2 times, most recently from 5de3c97 to c1e207a Compare August 8, 2024 14:51
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 3 times, most recently from 450b424 to 446c0a1 Compare August 20, 2024 10:32
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 4 times, most recently from b794ea6 to be7d6eb Compare August 28, 2024 11:55
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 3 times, most recently from 4aab832 to 66496b3 Compare September 3, 2024 17:11
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch 3 times, most recently from 134fc6a to dfbac2c Compare September 16, 2024 15:37
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@renovate renovate bot force-pushed the renovate/clerk-clerk-sdk-node-5.x branch from dfbac2c to 453e8ad Compare September 17, 2024 01:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants