From 841b084cb97b0a9c429eb1c25ef9719e13ea97e4 Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Thu, 24 Oct 2024 16:50:45 -0400 Subject: [PATCH] Add deprecation notice to Node SDK (#1652) Co-authored-by: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> --- docs/backend-requests/handling/nodejs.mdx | 9 ++++++--- docs/references/express/overview.mdx | 5 +++++ docs/references/nodejs/available-methods.mdx | 3 +++ docs/references/nodejs/overview.mdx | 3 +++ 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/backend-requests/handling/nodejs.mdx b/docs/backend-requests/handling/nodejs.mdx index cffb1a3d13..301b2cae3a 100644 --- a/docs/backend-requests/handling/nodejs.mdx +++ b/docs/backend-requests/handling/nodejs.mdx @@ -1,9 +1,12 @@ --- -title: Handling requests with Node.js and Express -description: Learn how to handle authenticated requests with Node.js and Express middleware using Clerk. +title: Handling requests with the Node SDK +description: Learn how to handle authenticated requests with Clerk's Node SDK. --- -## Node.js and Connect/Express Middleware +> [!CAUTION] +> On January 8, 2025, the Node SDK will no longer be available. [Upgrade to the Express SDK.](/docs/upgrade-guides/node-to-express) + +## Node SDK Middleware The Clerk Node SDK offers two authentication middlewares specifically for [Express](https://expressjs.com/) and Connect/Express compatible frameworks such as [Fastify](https://www.fastify.io/docs/latest/Reference/Middleware/). diff --git a/docs/references/express/overview.mdx b/docs/references/express/overview.mdx index 47d8a6956e..f8b129caf2 100644 --- a/docs/references/express/overview.mdx +++ b/docs/references/express/overview.mdx @@ -7,6 +7,11 @@ Clerk makes it simple to add authentication to your Express application. This do See the [quickstart](/docs/quickstarts/express) to get started. +{/* TODO: Remove callout when Node SDK is removed from docs */} + +> [!IMPORTANT] +> If you are upgrading from the Node SDK, see the [upgrade guide](/docs/upgrade-guides/node-to-express) for more information. + ## Available methods ### `clerkMiddleware()` diff --git a/docs/references/nodejs/available-methods.mdx b/docs/references/nodejs/available-methods.mdx index cc486bcf7d..302e23f705 100644 --- a/docs/references/nodejs/available-methods.mdx +++ b/docs/references/nodejs/available-methods.mdx @@ -3,6 +3,9 @@ title: Node.js Available Methods description: Learn how to use the Clerk Node.js SDK to interact with the Clerk API. --- +> [!CAUTION] +> On January 8, 2025, the Node SDK will no longer be available. [Upgrade to the Express SDK.](/docs/upgrade-guides/node-to-express) + All resource operations are mounted as sub-APIs on the `clerkClient` object. You can find the full list of available operations in the [JavaScript Backend SDK](/docs/references/backend/overview) documentation. To access a resource, you must first instantiate a `clerkClient` instance. ## Instantiate a default `clerkClient` instance diff --git a/docs/references/nodejs/overview.mdx b/docs/references/nodejs/overview.mdx index 9fcf72a3a1..897130a073 100644 --- a/docs/references/nodejs/overview.mdx +++ b/docs/references/nodejs/overview.mdx @@ -3,6 +3,9 @@ title: Clerk Node.js SDK description: Learn how to integrate Node.js into your Clerk application. --- +> [!CAUTION] +> On January 8, 2025, the Node SDK will no longer be available. [Upgrade to the Express SDK.](/docs/upgrade-guides/node-to-express) + ## Set up Clerk Node.js