@clerk/backend - npm Package Compare versions

Comparing version 0.5.2 to 0.6.0-staging.0

dist/types/index.d.ts

@@ -8,3 +8,3 @@ import type { CreateBackendApiOptions } from './api';
 export { constants } from './constants';
-export type ClerkOptions = CreateBackendApiOptions & Partial<Pick<CreateAuthenticateRequestOptions['options'], 'jwtKey'>>;
+export type ClerkOptions = CreateBackendApiOptions & Partial<Pick<CreateAuthenticateRequestOptions['options'], 'jwtKey' | 'proxyUrl'>>;
 export declare function Clerk(options: ClerkOptions): {
@@ -18,7 +18,8 @@ __unstable_options: {
         httpOptions?: RequestInit | undefined;
+        proxyUrl?: string | undefined;
         jwtKey?: string | undefined;
     };
-    authenticateRequest: ({ apiKey: runtimeApiKey, secretKey: runtimeSecretKey, frontendApi: runtimeFrontendApi, publishableKey: runtimePublishableKey, jwtKey: runtimeJwtKey, ...rest }: Omit<import("./tokens").AuthenticateRequestOptions, "apiUrl" | "apiVersion">) => Promise<import("./tokens").RequestState>;
+    authenticateRequest: ({ apiKey: runtimeApiKey, secretKey: runtimeSecretKey, frontendApi: runtimeFrontendApi, proxyUrl: runtimeProxyUrl, publishableKey: runtimePublishableKey, jwtKey: runtimeJwtKey, ...rest }: Omit<import("./tokens").AuthenticateRequestOptions, "apiUrl" | "apiVersion">) => Promise<import("./tokens").RequestState>;
     localInterstitial: typeof import("./tokens").loadInterstitialFromLocal;
-    remotePublicInterstitial: ({ frontendApi: runtimeFrontendApi, publishableKey: runtimePublishableKey, ...rest }: import("./tokens/interstitial").LoadInterstitialOptions) => Promise<string>;
+    remotePublicInterstitial: ({ frontendApi: runtimeFrontendApi, publishableKey: runtimePublishableKey, proxyUrl: runtimeProxyUrl, ...rest }: import("./tokens/interstitial").LoadInterstitialOptions) => Promise<string>;
     remotePrivateInterstitial: () => Promise<string>;
@@ -29,2 +30,3 @@ remotePublicInterstitialUrl: typeof import("./tokens/interstitial").buildPublicInterstitialUrl;
         isSignedIn: boolean;
+        proxyUrl: string | undefined;
         isInterstitial: boolean;
@@ -34,2 +36,4 @@ reason: import("./tokens/authStatus").AuthReason | null;
         publishableKey: string;
+        isSatellite: boolean;
+        domain: string;
     };
@@ -36,0 +40,0 @@ allowlistIdentifiers: import("./api/endpoints").AllowlistIdentifierAPI;

dist/types/tokens/authStatus.d.ts

@@ -15,3 +15,6 @@ import type { JwtPayload } from '@clerk/types';
     frontendApi: string;
+    proxyUrl?: string;
     publishableKey: string;
+    isSatellite: boolean;
+    domain: string;
     isSignedIn: true;
@@ -27,3 +30,6 @@ isInterstitial: false;
     frontendApi: string;
+    proxyUrl?: string;
     publishableKey: string;
+    isSatellite: boolean;
+    domain: string;
     isSignedIn: false;
@@ -30,0 +36,0 @@ isInterstitial: false;

dist/types/tokens/factory.d.ts

@@ -6,9 +6,9 @@ import type { ApiClient } from '../api';
 export type CreateAuthenticateRequestOptions = {
-    options: Partial<Pick<AuthenticateRequestOptions, 'apiKey' | 'secretKey' | 'apiUrl' | 'apiVersion' | 'frontendApi' | 'publishableKey' | 'jwtKey'>>;
+    options: Partial<Pick<AuthenticateRequestOptions, 'apiKey' | 'secretKey' | 'apiUrl' | 'apiVersion' | 'frontendApi' | 'publishableKey' | 'jwtKey' | 'proxyUrl'>>;
     apiClient: ApiClient;
 };
 export declare function createAuthenticateRequest(params: CreateAuthenticateRequestOptions): {
-    authenticateRequest: ({ apiKey: runtimeApiKey, secretKey: runtimeSecretKey, frontendApi: runtimeFrontendApi, publishableKey: runtimePublishableKey, jwtKey: runtimeJwtKey, ...rest }: Omit<AuthenticateRequestOptions, 'apiUrl' | 'apiVersion'>) => Promise<import("./authStatus").RequestState>;
+    authenticateRequest: ({ apiKey: runtimeApiKey, secretKey: runtimeSecretKey, frontendApi: runtimeFrontendApi, proxyUrl: runtimeProxyUrl, publishableKey: runtimePublishableKey, jwtKey: runtimeJwtKey, ...rest }: Omit<AuthenticateRequestOptions, 'apiUrl' | 'apiVersion'>) => Promise<import("./authStatus").RequestState>;
     localInterstitial: typeof loadInterstitialFromLocal;
-    remotePublicInterstitial: ({ frontendApi: runtimeFrontendApi, publishableKey: runtimePublishableKey, ...rest }: LoadInterstitialOptions) => Promise<string>;
+    remotePublicInterstitial: ({ frontendApi: runtimeFrontendApi, publishableKey: runtimePublishableKey, proxyUrl: runtimeProxyUrl, ...rest }: LoadInterstitialOptions) => Promise<string>;
     remotePrivateInterstitial: () => Promise<string>;
@@ -19,2 +19,3 @@ remotePublicInterstitialUrl: typeof buildPublicInterstitialUrl;
         isSignedIn: boolean;
+        proxyUrl: string | undefined;
         isInterstitial: boolean;
@@ -24,4 +25,6 @@ reason: import("./authStatus").AuthReason | null;
         publishableKey: string;
+        isSatellite: boolean;
+        domain: string;
     };
 };
 //# sourceMappingURL=factory.d.ts.map

dist/types/tokens/interstitial.d.ts

 export type LoadInterstitialOptions = {
     apiUrl: string;
     frontendApi: string;
+    proxyUrl?: string;
     publishableKey: string;
     pkgVersion?: string;
     debugData?: any;
+    isSatellite?: boolean;
+    domain?: string;
 };
-export declare function loadInterstitialFromLocal(options: Omit<LoadInterstitialOptions, 'apiUrl'>): string;
+export declare function loadInterstitialFromLocal(options: Omit<LoadInterstitialOptions, 'apiUrl' | 'isSatellite' | 'domain' | 'proxyUrl'>): string;
 export declare function loadInterstitialFromBAPI(options: LoadInterstitialOptions): Promise<string>;
 export declare function buildPublicInterstitialUrl(options: LoadInterstitialOptions): string;
 //# sourceMappingURL=interstitial.d.ts.map

dist/types/tokens/request.d.ts

@@ -9,3 +9,8 @@ import type { RequestState } from './authStatus';
 export type RequiredVerifyTokenOptions = Required<Pick<VerifyTokenOptions, 'apiKey' | 'secretKey' | 'apiUrl' | 'apiVersion'>>;
-export type OptionalVerifyTokenOptions = Partial<Pick<VerifyTokenOptions, 'authorizedParties' | 'clockSkewInSeconds' | 'jwksCacheTtlInMs' | 'skipJwksCache' | 'jwtKey'>>;
+export type OptionalVerifyTokenOptions = Partial<Pick<VerifyTokenOptions, 'authorizedParties' | 'clockSkewInSeconds' | 'jwksCacheTtlInMs' | 'skipJwksCache' | 'jwtKey' | 'proxyUrl'>>;
+export type AuthenticateRequestOptionsWithExperimental = {
+    domain?: string;
+    isSatellite?: boolean;
+    proxyUrl?: string;
+} & AuthenticateRequestOptions;
 export type AuthenticateRequestOptions = RequiredVerifyTokenOptions & OptionalVerifyTokenOptions & LoadResourcesOptions & {
@@ -29,2 +34,3 @@ cookieToken?: string;
     isSignedIn: boolean;
+    proxyUrl: string | undefined;
     isInterstitial: boolean;
@@ -34,3 +40,5 @@ reason: import("./authStatus").AuthReason | null;
     publishableKey: string;
+    isSatellite: boolean;
+    domain: string;
 };
 //# sourceMappingURL=request.d.ts.map

dist/types/tokens/verify.d.ts

@@ -6,4 +6,5 @@ import type { JwtPayload } from '@clerk/types';
     jwtKey?: string;
+    proxyUrl?: string;
 } & Pick<LoadClerkJWKFromRemoteOptions, 'apiKey' | 'secretKey' | 'apiUrl' | 'apiVersion' | 'jwksCacheTtlInMs' | 'skipJwksCache'>;
 export declare function verifyToken(token: string, options: VerifyTokenOptions): Promise<JwtPayload>;
 //# sourceMappingURL=verify.d.ts.map

dist/types/util/request.d.ts

@@ -8,2 +8,3 @@ export declare function checkCrossOrigin({ originURL, host, forwardedHost, forwardedPort, forwardedProto, }: {
 }): boolean;
+export declare function convertHostHeaderValueToURL(host: string): URL;
 //# sourceMappingURL=request.d.ts.map

package.json

 {
   "name": "@clerk/backend",
-  "version": "0.5.2",
+  "version": "0.6.0-staging.0",
   "license": "MIT",
@@ -27,3 +27,3 @@ "description": "Clerk Backend SDK - REST Client for Backend API & JWT verification utilities",
   "dependencies": {
-    "@clerk/types": "^3.25.1",
+    "@clerk/types": "^3.26.0-staging.1",
     "@peculiar/webcrypto": "1.4.1",
@@ -78,3 +78,3 @@ "@types/node": "16.18.6",
   },
-  "gitHead": "b7df6843348b91d919f8a704ff5d9e1a0d6e460b"
+  "gitHead": "1d87f08cb3f24ed61f9612c1d936c9b25f338d4c"
 }

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

584241

increased by12.19%

Lines of code

6057

increased by237.44%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Number of package files

140

decreased by-9.09%

Number of medium supply chain risk alerts

4

increased by100%

Dependency changes

• Updated@clerk/types@^3.26.0-staging.1