@authsignal/browser 1.12.7 → 1.13.0-alpha.0

package/dist/api/digital-credential-api-client.d.ts

@@ -0,0 +1,12 @@
+import { ErrorResponse } from "./types/passkey";
+import { ApiClientOptions, ChallengeResponse } from "./types/shared";
+import { PresentationOptionsRequest, PresentationOptionsResponse, VerifyPresentationRequest, VerifyPresentationResponse } from "./types/digital-credential";
+export declare class DigitalCredentialApiClient {
+    tenantId: string;
+    baseUrl: string;
+    onTokenExpired?: () => void;
+    constructor({ baseUrl, tenantId, onTokenExpired }: ApiClientOptions);
+    presentationOptions({ action, challengeId, anonymous, token, documentTypes, claims, }: PresentationOptionsRequest): Promise<PresentationOptionsResponse | ErrorResponse>;
+    verifyPresentation({ token, data, challengeId, redirectUrl, }: VerifyPresentationRequest): Promise<VerifyPresentationResponse | ErrorResponse>;
+    challenge(action: string): Promise<ChallengeResponse | ErrorResponse>;
+}

package/dist/api/types/digital-credential.d.ts

@@ -0,0 +1,27 @@
+export type PresentationOptionsRequest = {
+    action?: string;
+    token?: string;
+    anonymous?: boolean;
+    challengeId?: string;
+    documentTypes?: string[];
+    claims?: string[][];
+};
+export type PresentationOptionsResponse = {
+    challengeId: string;
+    dcapiOptions: any;
+};
+export type VerifyPresentationRequest = {
+    token?: string;
+    data: any;
+    challengeId: string;
+    redirectUrl?: string;
+};
+export type VerifyPresentationResponse = {
+    isVerified: boolean;
+    accessToken?: string;
+    username?: string;
+    userId?: string;
+    url?: string;
+    requireUserVerification?: boolean;
+    claims?: Record<string, string>;
+};

package/dist/api/types/shared.d.ts

@@ -1,4 +1,5 @@
 import { CredentialDeviceType } from "@simplewebauthn/browser";
+import { ErrorCode } from "../../types";
 export type ApiClientOptions = {
     baseUrl: string;
     tenantId: string;
@@ -21,9 +22,12 @@ export type VerifyResponse = {
     userAuthenticator?: Authenticator;
 };
 export type ErrorResponse = {
-    error: string;
-    errorCode?: "expired_token" | (string & {});
-    errorDescription?: string;
+    /**
+     * @deprecated Use errorCode and errorDescription instead
+     */
+    error?: string;
+    errorCode?: ErrorCode;
+    errorDescription?: string | undefined;
 };
 export declare enum VerificationMethod {
     SMS = "SMS",

package/dist/authsignal.d.ts

@@ -8,11 +8,13 @@ import { SecurityKey } from "./security-key";
 import { QrCode } from "./qr-code";
 import { Push } from "./push";
 import { Whatsapp } from "./whatsapp";
+import { DigitalCredential } from "./digital-credential";
 export declare class Authsignal {
     anonymousId: string;
     profilingId: string;
     cookieDomain: string;
     anonymousIdCookieName: string;
+    enableLogging: boolean;
     passkey: Passkey;
     totp: Totp;
     email: Email;
@@ -22,7 +24,8 @@ export declare class Authsignal {
     qrCode: QrCode;
     push: Push;
     whatsapp: Whatsapp;
-    constructor({ cookieDomain, cookieName, baseUrl, tenantId, onTokenExpired, }: AuthsignalOptions);
+    digitalCredential: DigitalCredential;
+    constructor({ cookieDomain, cookieName, baseUrl, tenantId, onTokenExpired, enableLogging, }: AuthsignalOptions);
     setToken(token: string): void;
     launch(url: string, options?: {
         mode?: "redirect";

package/dist/digital-credential.d.ts

@@ -0,0 +1,43 @@
+import { DigitalCredentialApiClient } from "./api/digital-credential-api-client";
+import { AuthsignalResponse } from "./types";
+type DigitalCredentialOptions = {
+    baseUrl: string;
+    tenantId: string;
+    onTokenExpired?: () => void;
+    enableLogging: boolean;
+};
+type VerifyParams = {
+    action?: string;
+    token?: string;
+    redirectUrl?: string;
+};
+type VerifyResponse = {
+    isVerified: boolean;
+    token?: string;
+    username?: string;
+    userId?: string;
+    url?: string;
+    requireUserVerification?: boolean;
+    claims?: Record<string, string>;
+};
+type VerifyClaimsParams = {
+    action?: string;
+    documentTypes?: string[];
+    claims?: string[][];
+    redirectUrl?: string;
+};
+type VerifyClaimsResponse = {
+    isVerified: boolean;
+    claims?: Record<string, string>;
+    url?: string;
+    requireUserVerification?: boolean;
+};
+export declare class DigitalCredential {
+    api: DigitalCredentialApiClient;
+    private cache;
+    private enableLogging;
+    constructor({ baseUrl, tenantId, onTokenExpired, enableLogging }: DigitalCredentialOptions);
+    verify(params?: VerifyParams): Promise<AuthsignalResponse<VerifyResponse>>;
+    verifyClaims(params?: VerifyClaimsParams): Promise<AuthsignalResponse<VerifyClaimsResponse>>;
+}
+export {};

package/dist/email-magic-link.d.ts

@@ -4,6 +4,7 @@ type EmailMagicLinkOptions = {
     baseUrl: string;
     tenantId: string;
     onTokenExpired?: () => void;
+    enableLogging: boolean;
 };
 type EnrollParams = {
     email: string;
@@ -11,7 +12,8 @@ type EnrollParams = {
 export declare class EmailMagicLink {
     private api;
     private cache;
-    constructor({ baseUrl, tenantId, onTokenExpired }: EmailMagicLinkOptions);
+    private enableLogging;
+    constructor({ baseUrl, tenantId, onTokenExpired, enableLogging }: EmailMagicLinkOptions);
     enroll({ email }: EnrollParams): Promise<AuthsignalResponse<EnrollResponse>>;
     challenge(): Promise<AuthsignalResponse<ChallengeResponse>>;
     checkVerificationStatus(): Promise<AuthsignalResponse<VerifyResponse>>;

package/dist/email.d.ts

@@ -4,6 +4,7 @@ type EmailOptions = {
     baseUrl: string;
     tenantId: string;
     onTokenExpired?: () => void;
+    enableLogging: boolean;
 };
 type EnrollParams = {
     email: string;
@@ -14,7 +15,8 @@ type VerifyParams = {
 export declare class Email {
     private api;
     private cache;
-    constructor({ baseUrl, tenantId, onTokenExpired }: EmailOptions);
+    private enableLogging;
+    constructor({ baseUrl, tenantId, onTokenExpired, enableLogging }: EmailOptions);
     enroll({ email }: EnrollParams): Promise<AuthsignalResponse<EnrollResponse>>;
     challenge(): Promise<AuthsignalResponse<ChallengeResponse>>;
     verify({ code }: VerifyParams): Promise<AuthsignalResponse<VerifyResponse>>;

package/dist/helpers.d.ts

@@ -9,15 +9,29 @@ type CookieOptions = {
 export declare function setCookie({ name, value, expire, domain, secure }: CookieOptions): void;
 export declare function getCookieDomain(): string;
 export declare function getCookie(name: string): string | null;
-export declare function handleErrorResponse(errorResponse: ErrorResponse): {
-    error: string;
+type HandleErrorResponseParams = {
+    errorResponse: ErrorResponse;
+    enableLogging: boolean;
 };
-export declare function handleApiResponse<T>(response: ErrorResponse | T): {
-    error: string;
+export declare function handleErrorResponse({ errorResponse, enableLogging }: HandleErrorResponseParams): {
+    error: string | undefined;
+    errorCode: import("./types").ErrorCode | undefined;
+    errorDescription: string | undefined;
+};
+type HandleApiResponseParams<T> = {
+    response: ErrorResponse | T;
+    enableLogging: boolean;
+};
+export declare function handleApiResponse<T>({ response, enableLogging }: HandleApiResponseParams<T>): {
+    error: string | undefined;
+    errorCode: import("./types").ErrorCode | undefined;
+    errorDescription: string | undefined;
     data?: undefined;
 } | {
     data: T;
     error?: undefined;
+    errorCode?: undefined;
+    errorDescription?: undefined;
 };
 export declare function handleWebAuthnError(error: unknown): void;
 export {};

package/dist/index.d.ts

@@ -1,8 +1,11 @@
 export * from "./authsignal";
 export * from "./types";
+export { DigitalCredential } from "./digital-credential";
 export type { Authenticator, VerificationMethod, EnrollResponse, ChallengeResponse } from "./api/types/shared";
 export type { EnrollTotpResponse } from "./api/types/totp";
 export type { QrCodeChallengeResponse, QrCodeVerifyResponse } from "./api/types/qr-code";
 export type { PushChallengeResponse, PushVerifyResponse } from "./api/types/push";
 export type { WebSocketQrCodeOptions, WebSocketQrCodeResponse, ChallengeState } from "./api/types/websocket";
 export { Whatsapp } from "./whatsapp";
+export type { PresentationOptionsRequest, PresentationOptionsResponse, VerifyPresentationRequest, VerifyPresentationResponse, } from "./api/types/digital-credential";
+export { browserSupportsDigitalCredential } from "./utils";