@holo-js/auth-clerk 0.1.4 → 0.1.6

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { AuthUserLike, AuthEstablishedSession, authRuntimeInternals } from '@holo-js/auth';
-import { AuthClerkProviderConfig } from '@holo-js/config';
+import { AuthResult, AuthLogoutResult, AuthFieldErrors, AuthenticatedAuthUser, AuthEstablishedSession, authRuntimeInternals } from '@holo-js/auth';
+import { AuthClerkProviderConfig, NormalizedAuthClerkProviderConfig } from '@holo-js/config';
 
 interface ClerkEmailAddress {
     readonly id?: string;
@@ -8,16 +8,20 @@ interface ClerkEmailAddress {
 }
 interface ClerkUserProfile {
     readonly id: string;
-    readonly email?: string;
-    readonly emailVerified?: boolean;
+    readonly email: string;
+    readonly emailVerified: boolean;
     readonly firstName?: string;
     readonly lastName?: string;
-    readonly name?: string;
+    readonly name: string;
     readonly imageUrl?: string;
     readonly primaryEmailAddressId?: string;
     readonly emailAddresses?: readonly ClerkEmailAddress[];
     readonly raw?: unknown;
 }
+type ClerkUserAttributeValue = string | number | boolean | Date | null | undefined | readonly ClerkUserAttributeValue[] | {
+    readonly [key: string]: ClerkUserAttributeValue;
+};
+type ClerkUserAttributes = Readonly<Record<string, ClerkUserAttributeValue>>;
 interface ClerkVerifiedSession {
     readonly sessionId: string;
     readonly user: ClerkUserProfile;
@@ -28,6 +32,56 @@ interface ClerkVerifiedSession {
     };
     readonly raw?: unknown;
 }
+interface ClerkLogoutSession {
+    readonly provider: string;
+    readonly sessionId: string;
+}
+type ClerkHostedAuthFailureFields = AuthFieldErrors<'_root'>;
+interface ClerkCompleteAuthData<TUser extends Readonly<Record<string, unknown>> = Readonly<Record<string, unknown>>> {
+    readonly provider: string;
+    readonly guard: string;
+    readonly authProvider: string;
+    readonly status: ClerkSyncStatus;
+    readonly user: ClerkAuthenticatedUser<TUser>;
+    readonly identity: HostedIdentityRecord;
+    readonly session: ClerkVerifiedSession;
+    readonly authSession?: AuthEstablishedSession;
+}
+type ClerkCompleteAuthResult<TUser extends Readonly<Record<string, unknown>> = Readonly<Record<string, unknown>>> = AuthResult<ClerkCompleteAuthData<TUser>, string, ClerkHostedAuthFailureFields>;
+type ClerkRequestHeaders = Headers | ReadonlyArray<readonly [string, string]> | Record<string, string | readonly string[] | undefined> | {
+    readonly get?: (name: string) => string | null | undefined;
+    readonly forEach?: (callback: (value: string, key: string) => void) => void;
+    readonly entries?: () => Iterable<readonly [string, string]>;
+};
+type ClerkRequestLike = {
+    readonly method?: string;
+    readonly path?: string;
+    readonly url?: string | URL;
+    readonly headers?: ClerkRequestHeaders;
+    readonly request?: Request;
+    readonly req?: Request | {
+        readonly method?: string;
+        readonly url?: string;
+        readonly headers?: ClerkRequestHeaders;
+    };
+    readonly node?: {
+        readonly req?: {
+            readonly method?: string;
+            readonly url?: string;
+            readonly headers?: ClerkRequestHeaders;
+        };
+    };
+    readonly web?: {
+        readonly request?: Request;
+    };
+};
+type ClerkRequestInput = Request | ClerkRequestLike;
+type ClerkLogoutErrorCode = 'clerk_logout_failed' | 'clerk_session_missing';
+interface ClerkLogoutData {
+    readonly url: string;
+    readonly local: AuthLogoutResult;
+}
+type ClerkLogoutResult = AuthResult<ClerkLogoutData, ClerkLogoutErrorCode, ClerkHostedAuthFailureFields>;
 interface ClerkVerifyRequestContext {
     readonly provider: string;
     readonly request: Request;
@@ -42,7 +96,6 @@ interface ClerkProviderRuntime {
     verifyRequest?(context: ClerkVerifyRequestContext): Promise<ClerkVerifiedSession | null>;
     verifySession?(context: ClerkVerifySessionContext): Promise<ClerkVerifiedSession | null>;
 }
-type RuntimeAuthProviderAdapter = ReturnType<typeof authRuntimeInternals.getRuntimeBindings>['providers'][string];
 interface HostedIdentityRecord {
     readonly provider: string;
     readonly providerUserId: string;
@@ -58,15 +111,19 @@ interface HostedIdentityRecord {
 interface HostedIdentityStore {
     findByProviderUserId(provider: string, providerUserId: string): Promise<HostedIdentityRecord | null>;
     findByUserId(provider: string, authProvider: string, userId: string | number): Promise<HostedIdentityRecord | null>;
+    claim?(record: HostedIdentityRecord): Promise<HostedIdentityRecord>;
     save(record: HostedIdentityRecord): Promise<void>;
 }
 type ClerkSyncStatus = 'created' | 'updated' | 'linked' | 'relinked';
-interface ClerkAuthenticationResult {
+type ClerkAuthenticatedUser<TUser extends Readonly<Record<string, unknown>> = Readonly<Record<string, unknown>>> = AuthenticatedAuthUser & TUser & {
+    readonly id: string | number;
+};
+interface ClerkAuthenticationResult<TUser extends Readonly<Record<string, unknown>> = Readonly<Record<string, unknown>>> {
     readonly provider: string;
     readonly guard: string;
     readonly authProvider: string;
     readonly status: ClerkSyncStatus;
-    readonly user: AuthUserLike;
+    readonly user: ClerkAuthenticatedUser<TUser>;
     readonly identity: HostedIdentityRecord;
     readonly session: ClerkVerifiedSession;
     readonly authSession?: AuthEstablishedSession;
@@ -79,11 +136,31 @@ interface ConfigureClerkAuthRuntimeOptions {
     readonly providers?: Readonly<Record<string, ClerkProviderRuntime>>;
     readonly identityStore?: HostedIdentityStore;
 }
+type ClerkDefaultUserAttributes$1 = {
+    readonly email: string;
+    readonly name: string;
+};
 interface ClerkAuthFacade {
-    verifyRequest(request: Request, provider?: string): Promise<ClerkVerifiedSession | null>;
+    loginWithClerk(request: ClerkRequestInput, options?: {
+        readonly provider?: string;
+    }): Promise<Response>;
+    registerWithClerk(request: ClerkRequestInput, options?: {
+        readonly provider?: string;
+    }): Promise<Response>;
+    logoutWithClerk(request: ClerkRequestInput, options?: {
+        readonly provider?: string;
+        readonly returnTo?: string;
+    }): Promise<ClerkLogoutResult>;
+    completeClerkAuth<TUserAttributes extends ClerkUserAttributes = ClerkDefaultUserAttributes$1>(request: ClerkRequestInput, options?: {
+        readonly provider?: string;
+        readonly user?: (clerkUser: ClerkUserProfile) => TUserAttributes;
+    }): Promise<ClerkCompleteAuthResult<TUserAttributes>>;
+    verifyRequest(request: ClerkRequestInput, provider?: string): Promise<ClerkVerifiedSession | null>;
     verifySession(token: string, provider?: string): Promise<ClerkVerifiedSession | null>;
-    syncIdentity(session: ClerkVerifiedSession, provider?: string): Promise<ClerkAuthenticationResult>;
-    authenticate(request: Request, provider?: string): Promise<ClerkAuthenticationResult | null>;
+    syncIdentity<TUserAttributes extends ClerkUserAttributes = ClerkDefaultUserAttributes$1>(session: ClerkVerifiedSession, provider?: string, options?: {
+        readonly user?: (clerkUser: ClerkUserProfile) => TUserAttributes;
+    }): Promise<ClerkAuthenticationResult<TUserAttributes>>;
+    authenticate(request: ClerkRequestInput, provider?: string): Promise<ClerkAuthenticationResult | null>;
 }
 declare class ClerkAuthConflictError extends Error {
     readonly code = "clerk_identity_conflict";
@@ -97,20 +174,22 @@ declare class ClerkAuthConflictError extends Error {
         readonly message: string;
     });
 }
+
+type RuntimeAuthProviderAdapter = ReturnType<typeof authRuntimeInternals.getRuntimeBindings>['providers'][string];
+type ClerkDefaultUserAttributes = {
+    readonly email: string;
+    readonly name: string;
+};
+type CompleteClerkAuthOptions<TUserAttributes extends ClerkUserAttributes = ClerkDefaultUserAttributes> = {
+    readonly provider?: string;
+    readonly user?: (clerkUser: ClerkUserProfile) => TUserAttributes;
+};
 declare function getBindings(): ClerkAuthBindings;
+declare function normalizeClerkUserProfile(user: Readonly<Record<string, unknown>>): ClerkUserProfile;
 declare function resolveConfiguredProviderName(provider?: string): string;
 declare function getConfiguredProviderConfig(provider?: string): {
     readonly name: string;
-    readonly publishableKey?: string;
-    readonly secretKey?: string;
-    readonly jwtKey?: string;
-    readonly apiUrl?: string;
-    readonly frontendApi?: string;
-    readonly sessionCookie: string;
-    readonly authorizedParties: readonly string[];
-    readonly guard?: string;
-    readonly mapToProvider?: string;
-};
+} & NormalizedAuthClerkProviderConfig;
 declare function resolveGuardAndProvider(provider?: string): {
     readonly guard: string;
     readonly authProvider: string;
@@ -120,18 +199,35 @@ declare function resolvePrimaryEmail(profile: ClerkUserProfile): {
     email?: string;
     emailVerified: boolean;
 };
-declare function resolveDisplayName(profile: ClerkUserProfile): string | undefined;
+declare function resolveDisplayName(profile: ClerkUserProfile): string;
 declare function resolveEmailForCreation(profile: ClerkUserProfile): string;
 declare function normalizeHostedProfile(profile: ClerkUserProfile): Readonly<Record<string, unknown>>;
 declare function getSessionTokenFromRequest(request: Request, sessionCookie: string): string | null;
 declare function verifySession(token: string, provider?: string): Promise<ClerkVerifiedSession | null>;
-declare function verifyRequest(request: Request, provider?: string): Promise<ClerkVerifiedSession | null>;
-declare function syncIdentity(session: ClerkVerifiedSession, provider?: string): Promise<ClerkAuthenticationResult>;
-declare function authenticate(request: Request, provider?: string): Promise<ClerkAuthenticationResult | null>;
+declare function verifyRequest(input: ClerkRequestInput, provider?: string): Promise<ClerkVerifiedSession | null>;
+declare function syncIdentity<TUserAttributes extends ClerkUserAttributes = ClerkDefaultUserAttributes>(session: ClerkVerifiedSession, provider?: string, options?: {
+    readonly user?: (clerkUser: ClerkUserProfile) => TUserAttributes;
+}): Promise<ClerkAuthenticationResult<TUserAttributes>>;
+declare function authenticate(input: ClerkRequestInput, provider?: string): Promise<ClerkAuthenticationResult | null>;
+declare function loginWithClerk(_input: ClerkRequestInput, options?: {
+    readonly provider?: string;
+}): Promise<Response>;
+declare function registerWithClerk(_input: ClerkRequestInput, options?: {
+    readonly provider?: string;
+}): Promise<Response>;
+declare function logoutWithClerk(input: ClerkRequestInput, options?: {
+    readonly provider?: string;
+    readonly returnTo?: string;
+}): Promise<ClerkLogoutResult>;
+declare function completeClerkAuth<TUserAttributes extends ClerkUserAttributes = ClerkDefaultUserAttributes>(input: ClerkRequestInput, options?: CompleteClerkAuthOptions<TUserAttributes>): Promise<ClerkCompleteAuthResult<TUserAttributes>>;
 declare function configureClerkAuthRuntime(bindings?: ConfigureClerkAuthRuntimeOptions): void;
 declare function resetClerkAuthRuntime(): void;
 declare const clerkAuth: Readonly<{
     authenticate: typeof authenticate;
+    completeClerkAuth: typeof completeClerkAuth;
+    loginWithClerk: typeof loginWithClerk;
+    logoutWithClerk: typeof logoutWithClerk;
+    registerWithClerk: typeof registerWithClerk;
     syncIdentity: typeof syncIdentity;
     verifyRequest: typeof verifyRequest;
     verifySession: typeof verifySession;
@@ -140,6 +236,7 @@ declare const clerkAuthInternals: {
     getBindings: typeof getBindings;
     getConfiguredProviderConfig: typeof getConfiguredProviderConfig;
     getSessionTokenFromRequest: typeof getSessionTokenFromRequest;
+    normalizeClerkUserProfile: typeof normalizeClerkUserProfile;
     normalizeHostedProfile: typeof normalizeHostedProfile;
     resolveConfiguredProviderName: typeof resolveConfiguredProviderName;
     resolveDisplayName: typeof resolveDisplayName;
@@ -148,4 +245,4 @@ declare const clerkAuthInternals: {
     resolvePrimaryEmail: typeof resolvePrimaryEmail;
 };
 
-export { type ClerkAuthBindings, ClerkAuthConflictError, type ClerkAuthFacade, type ClerkAuthenticationResult, type ClerkEmailAddress, type ClerkProviderRuntime, type ClerkSyncStatus, type ClerkUserProfile, type ClerkVerifiedSession, type ClerkVerifyRequestContext, type ClerkVerifySessionContext, type ConfigureClerkAuthRuntimeOptions, type HostedIdentityRecord, type HostedIdentityStore, authenticate, clerkAuth, clerkAuthInternals, configureClerkAuthRuntime, resetClerkAuthRuntime, syncIdentity, verifyRequest, verifySession };
+export { type ClerkAuthBindings, ClerkAuthConflictError, type ClerkAuthFacade, type ClerkAuthenticatedUser, type ClerkAuthenticationResult, type ClerkCompleteAuthData, type ClerkCompleteAuthResult, type ClerkEmailAddress, type ClerkHostedAuthFailureFields, type ClerkLogoutData, type ClerkLogoutErrorCode, type ClerkLogoutResult, type ClerkLogoutSession, type ClerkProviderRuntime, type ClerkRequestHeaders, type ClerkRequestInput, type ClerkRequestLike, type ClerkSyncStatus, type ClerkUserAttributeValue, type ClerkUserAttributes, type ClerkUserProfile, type ClerkVerifiedSession, type ClerkVerifyRequestContext, type ClerkVerifySessionContext, type ConfigureClerkAuthRuntimeOptions, type HostedIdentityRecord, type HostedIdentityStore, authenticate, clerkAuth, clerkAuthInternals, completeClerkAuth, configureClerkAuthRuntime, loginWithClerk, logoutWithClerk, registerWithClerk, resetClerkAuthRuntime, syncIdentity, verifyRequest, verifySession };