Skip to content

Commit bf8d43a

Browse files
djgouldclaude
andcommitted
chore(*): deprecate the keyless substrate ahead of removal
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 0217e07 commit bf8d43a

6 files changed

Lines changed: 19 additions & 0 deletions

File tree

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@clerk/shared': patch
3+
'@clerk/backend': patch
4+
---
5+
6+
Mark the keyless substrate as deprecated ahead of removal in the next major: `resolveKeysWithKeylessFallback` in `@clerk/shared/keyless`, and the experimental accountless applications API in `@clerk/backend`. Both are kept functional for the claimed-keys migration path and for older published SDK versions.

packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ type AccountlessApplicationParams = {
99
source?: string;
1010
};
1111

12+
/**
13+
* @deprecated Keyless mode is no longer activated by the framework SDKs. Kept for the claimed-keys migration path and older published SDK versions; remove in the next major.
14+
*/
1215
export class AccountlessApplicationAPI extends AbstractAPI {
1316
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
1417
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;

packages/backend/src/api/factory.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ export function createBackendApiClient(options: CreateBackendApiOptions) {
4848
const request = buildRequest(options);
4949

5050
return {
51+
/**
52+
* @deprecated Keyless mode is no longer activated by the framework SDKs. Kept for the claimed-keys migration path and older published SDK versions; remove in the next major.
53+
*/
5154
__experimental_accountlessApplications: new AccountlessApplicationAPI(
5255
buildRequest({ ...options, requireSecretKey: false }),
5356
),

packages/backend/src/api/resources/AccountlessApplication.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import type { AccountlessApplicationJSON } from './JSON';
22

3+
/**
4+
* @deprecated Keyless mode is no longer activated by the framework SDKs. Kept for the claimed-keys migration path and older published SDK versions; remove in the next major.
5+
*/
36
export class AccountlessApplication {
47
constructor(
58
readonly publishableKey: string,

packages/shared/src/keyless/resolveKeysWithKeylessFallback.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ export interface KeylessResult {
1717
* @param keylessService - The keyless service instance (or null if unavailable)
1818
* @param canUseKeyless - Whether keyless mode is enabled in the current environment
1919
* @returns The resolved keys (either configured or from keyless mode)
20+
*
21+
* @deprecated Keyless mode is no longer activated by the framework SDKs; kept for older published SDK versions. Remove in the next major.
2022
*/
2123
export async function resolveKeysWithKeylessFallback(
2224
configuredPublishableKey: string | undefined,

packages/shared/src/keyless/service.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ export interface KeylessService {
128128
* @param configuredPublishableKey - The publishable key from options or environment
129129
* @param configuredSecretKey - The secret key from options or environment
130130
* @returns The resolved keys (either configured or from keyless mode)
131+
*
132+
* @deprecated Keyless mode is no longer activated by the framework SDKs; kept for older published SDK versions. Remove in the next major.
131133
*/
132134
resolveKeysWithKeylessFallback: (
133135
configuredPublishableKey: string | undefined,

0 commit comments

Comments
 (0)