@better-auth/passkey 1.5.6 → 1.6.0-beta.0

package/dist/index-BzKpmgHh.d.mts

@@ -0,0 +1,771 @@
+import * as _simplewebauthn_server0 from "@simplewebauthn/server";
+import { AuthenticationExtensionsClientInputs, AuthenticationResponseJSON, CredentialDeviceType, RegistrationResponseJSON, VerifiedAuthenticationResponse, VerifiedRegistrationResponse } from "@simplewebauthn/server";
+import * as better_auth0 from "better-auth";
+import { GenericEndpointContext } from "@better-auth/core";
+import { InferOptionSchema } from "better-auth/types";
+import * as better_call0 from "better-call";
+
+//#region src/schema.d.ts
+declare const schema: {
+  passkey: {
+    fields: {
+      name: {
+        type: "string";
+        required: false;
+      };
+      publicKey: {
+        type: "string";
+        required: true;
+      };
+      userId: {
+        type: "string";
+        references: {
+          model: string;
+          field: string;
+        };
+        required: true;
+        index: true;
+      };
+      credentialID: {
+        type: "string";
+        required: true;
+        index: true;
+      };
+      counter: {
+        type: "number";
+        required: true;
+      };
+      deviceType: {
+        type: "string";
+        required: true;
+      };
+      backedUp: {
+        type: "boolean";
+        required: true;
+      };
+      transports: {
+        type: "string";
+        required: false;
+      };
+      createdAt: {
+        type: "date";
+        required: false;
+      };
+      aaguid: {
+        type: "string";
+        required: false;
+      };
+    };
+  };
+};
+//#endregion
+//#region src/types.d.ts
+/**
+ * @internal
+ */
+interface WebAuthnChallengeValue {
+  expectedChallenge: string;
+  userData: {
+    id: string;
+    name?: string | undefined;
+    displayName?: string | undefined;
+  };
+  context?: string | null;
+}
+type Awaitable<T> = T | Promise<T>;
+interface PasskeyRegistrationUser {
+  id: string;
+  name: string;
+  displayName?: string | undefined;
+}
+type PasskeyExtensionsResolver = AuthenticationExtensionsClientInputs | ((args: {
+  ctx: GenericEndpointContext;
+}) => Awaitable<AuthenticationExtensionsClientInputs | undefined>);
+interface PasskeyRegistrationOptions {
+  /**
+   * Require an authenticated session for passkey registration.
+   *
+   * @default true
+   */
+  requireSession?: boolean | undefined;
+  /**
+   * Resolve the user when session is not available.
+   * Required when `requireSession` is false and no session exists.
+   */
+  resolveUser?: ((args: {
+    ctx: GenericEndpointContext;
+    context?: string | null | undefined;
+  }) => Awaitable<PasskeyRegistrationUser>) | undefined;
+  /**
+   * Callback after a successful registration verification.
+   * Useful for user linking or auditing.
+   */
+  afterVerification?: ((args: {
+    ctx: GenericEndpointContext;
+    verification: VerifiedRegistrationResponse;
+    user: PasskeyRegistrationUser;
+    clientData: RegistrationResponseJSON;
+    context?: string | null | undefined;
+  }) => Awaitable<{
+    userId?: string;
+  } | void>) | undefined;
+  /**
+   * Optional WebAuthn extensions to include in registration options.
+   */
+  extensions?: PasskeyExtensionsResolver | undefined;
+}
+interface PasskeyAuthenticationOptions {
+  /**
+   * Optional WebAuthn extensions to include in authentication options.
+   */
+  extensions?: PasskeyExtensionsResolver | undefined;
+  /**
+   * Callback after a successful authentication verification.
+   */
+  afterVerification?: ((args: {
+    ctx: GenericEndpointContext;
+    verification: VerifiedAuthenticationResponse;
+    clientData: AuthenticationResponseJSON;
+  }) => Awaitable<void>) | undefined;
+}
+interface PasskeyOptions {
+  /**
+   * A unique identifier for your website. 'localhost' is okay for
+   * local dev
+   *
+   * @default "localhost"
+   */
+  rpID?: string | undefined;
+  /**
+   * Human-readable title for your website
+   *
+   * @default "Better Auth"
+   */
+  rpName?: string | undefined;
+  /**
+   * The URL at which registrations and authentications should occur.
+   * `http://localhost` and `http://localhost:PORT` are also valid.
+   * Do NOT include any trailing /
+   *
+   * if this isn't provided. The client itself will
+   * pass this value.
+   */
+  origin?: (string | string[] | null) | undefined;
+  /**
+   * Allow customization of the authenticatorSelection options
+   * during passkey registration.
+   */
+  authenticatorSelection?: AuthenticatorSelectionCriteria | undefined;
+  /**
+   * Advanced options
+   */
+  advanced?: {
+    /**
+     * Cookie name for storing WebAuthn challenge ID during authentication flow
+     *
+     * @default "better-auth-passkey"
+     */
+    webAuthnChallengeCookie?: string;
+  } | undefined;
+  /**
+   * Schema for the passkey model
+   */
+  schema?: InferOptionSchema<typeof schema> | undefined;
+  /**
+   * Registration behavior overrides
+   */
+  registration?: PasskeyRegistrationOptions | undefined;
+  /**
+   * Authentication behavior overrides
+   */
+  authentication?: PasskeyAuthenticationOptions | undefined;
+}
+type Passkey = {
+  id: string;
+  name?: string | undefined;
+  publicKey: string;
+  userId: string;
+  credentialID: string;
+  counter: number;
+  deviceType: CredentialDeviceType;
+  backedUp: boolean;
+  transports?: string | undefined;
+  createdAt: Date;
+  aaguid?: string | undefined;
+};
+//#endregion
+//#region src/error-codes.d.ts
+declare const PASSKEY_ERROR_CODES: {
+  CHALLENGE_NOT_FOUND: better_auth0.RawError<"CHALLENGE_NOT_FOUND">;
+  YOU_ARE_NOT_ALLOWED_TO_REGISTER_THIS_PASSKEY: better_auth0.RawError<"YOU_ARE_NOT_ALLOWED_TO_REGISTER_THIS_PASSKEY">;
+  FAILED_TO_VERIFY_REGISTRATION: better_auth0.RawError<"FAILED_TO_VERIFY_REGISTRATION">;
+  PASSKEY_NOT_FOUND: better_auth0.RawError<"PASSKEY_NOT_FOUND">;
+  AUTHENTICATION_FAILED: better_auth0.RawError<"AUTHENTICATION_FAILED">;
+  UNABLE_TO_CREATE_SESSION: better_auth0.RawError<"UNABLE_TO_CREATE_SESSION">;
+  FAILED_TO_UPDATE_PASSKEY: better_auth0.RawError<"FAILED_TO_UPDATE_PASSKEY">;
+  PREVIOUSLY_REGISTERED: better_auth0.RawError<"PREVIOUSLY_REGISTERED">;
+  REGISTRATION_CANCELLED: better_auth0.RawError<"REGISTRATION_CANCELLED">;
+  AUTH_CANCELLED: better_auth0.RawError<"AUTH_CANCELLED">;
+  UNKNOWN_ERROR: better_auth0.RawError<"UNKNOWN_ERROR">;
+  SESSION_REQUIRED: better_auth0.RawError<"SESSION_REQUIRED">;
+  RESOLVE_USER_REQUIRED: better_auth0.RawError<"RESOLVE_USER_REQUIRED">;
+  RESOLVED_USER_INVALID: better_auth0.RawError<"RESOLVED_USER_INVALID">;
+};
+//#endregion
+//#region src/index.d.ts
+declare module "@better-auth/core" {
+  interface BetterAuthPluginRegistry<AuthOptions, Options> {
+    passkey: {
+      creator: typeof passkey;
+    };
+  }
+}
+declare const passkey: (options?: PasskeyOptions | undefined) => {
+  id: "passkey";
+  version: string;
+  endpoints: {
+    generatePasskeyRegistrationOptions: better_call0.Endpoint<"/passkey/generate-register-options", "GET", undefined, {
+      authenticatorAttachment?: "platform" | "cross-platform" | undefined;
+      name?: string | undefined;
+      context?: string | undefined;
+    } | undefined, [better_call0.Middleware<(inputContext: Record<string, any>) => Promise<{
+      session: {
+        session: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          userId: string;
+          expiresAt: Date;
+          token: string;
+          ipAddress?: string | null | undefined;
+          userAgent?: string | null | undefined;
+        };
+        user: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          email: string;
+          emailVerified: boolean;
+          name: string;
+          image?: string | null | undefined;
+        };
+      };
+    }>>], _simplewebauthn_server0.PublicKeyCredentialCreationOptionsJSON, {
+      openapi: {
+        operationId: string;
+        description: string;
+        responses: {
+          200: {
+            description: string;
+            parameters: {
+              query: {
+                authenticatorAttachment: {
+                  description: string;
+                  required: boolean;
+                };
+                name: {
+                  description: string;
+                  required: boolean;
+                };
+                context: {
+                  description: string;
+                  required: boolean;
+                };
+              };
+            };
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object";
+                  properties: {
+                    challenge: {
+                      type: string;
+                    };
+                    rp: {
+                      type: string;
+                      properties: {
+                        name: {
+                          type: string;
+                        };
+                        id: {
+                          type: string;
+                        };
+                      };
+                    };
+                    user: {
+                      type: string;
+                      properties: {
+                        id: {
+                          type: string;
+                        };
+                        name: {
+                          type: string;
+                        };
+                        displayName: {
+                          type: string;
+                        };
+                      };
+                    };
+                    pubKeyCredParams: {
+                      type: string;
+                      items: {
+                        type: string;
+                        properties: {
+                          type: {
+                            type: string;
+                          };
+                          alg: {
+                            type: string;
+                          };
+                        };
+                      };
+                    };
+                    timeout: {
+                      type: string;
+                    };
+                    excludeCredentials: {
+                      type: string;
+                      items: {
+                        type: string;
+                        properties: {
+                          id: {
+                            type: string;
+                          };
+                          type: {
+                            type: string;
+                          };
+                          transports: {
+                            type: string;
+                            items: {
+                              type: string;
+                            };
+                          };
+                        };
+                      };
+                    };
+                    authenticatorSelection: {
+                      type: string;
+                      properties: {
+                        authenticatorAttachment: {
+                          type: string;
+                        };
+                        requireResidentKey: {
+                          type: string;
+                        };
+                        userVerification: {
+                          type: string;
+                        };
+                      };
+                    };
+                    attestation: {
+                      type: string;
+                    };
+                    extensions: {
+                      type: string;
+                    };
+                  };
+                };
+              };
+            };
+          };
+        };
+      };
+    }, undefined>;
+    generatePasskeyAuthenticationOptions: better_call0.Endpoint<"/passkey/generate-authenticate-options", "GET", undefined, Record<string, any> | undefined, [], _simplewebauthn_server0.PublicKeyCredentialRequestOptionsJSON, {
+      openapi: {
+        operationId: string;
+        description: string;
+        responses: {
+          200: {
+            description: string;
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object";
+                  properties: {
+                    challenge: {
+                      type: string;
+                    };
+                    rp: {
+                      type: string;
+                      properties: {
+                        name: {
+                          type: string;
+                        };
+                        id: {
+                          type: string;
+                        };
+                      };
+                    };
+                    user: {
+                      type: string;
+                      properties: {
+                        id: {
+                          type: string;
+                        };
+                        name: {
+                          type: string;
+                        };
+                        displayName: {
+                          type: string;
+                        };
+                      };
+                    };
+                    timeout: {
+                      type: string;
+                    };
+                    allowCredentials: {
+                      type: string;
+                      items: {
+                        type: string;
+                        properties: {
+                          id: {
+                            type: string;
+                          };
+                          type: {
+                            type: string;
+                          };
+                          transports: {
+                            type: string;
+                            items: {
+                              type: string;
+                            };
+                          };
+                        };
+                      };
+                    };
+                    userVerification: {
+                      type: string;
+                    };
+                    authenticatorSelection: {
+                      type: string;
+                      properties: {
+                        authenticatorAttachment: {
+                          type: string;
+                        };
+                        requireResidentKey: {
+                          type: string;
+                        };
+                        userVerification: {
+                          type: string;
+                        };
+                      };
+                    };
+                    extensions: {
+                      type: string;
+                    };
+                  };
+                };
+              };
+            };
+          };
+        };
+      };
+    }, undefined>;
+    verifyPasskeyRegistration: better_call0.Endpoint<"/passkey/verify-registration", "POST", {
+      response: any;
+      name?: string | undefined;
+    }, Record<string, any> | undefined, [better_call0.Middleware<(inputContext: Record<string, any>) => Promise<{
+      session: {
+        session: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          userId: string;
+          expiresAt: Date;
+          token: string;
+          ipAddress?: string | null | undefined;
+          userAgent?: string | null | undefined;
+        };
+        user: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          email: string;
+          emailVerified: boolean;
+          name: string;
+          image?: string | null | undefined;
+        };
+      };
+    }>>], Passkey, {
+      openapi: {
+        operationId: string;
+        description: string;
+        responses: {
+          200: {
+            description: string;
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: string;
+                };
+              };
+            };
+          };
+          400: {
+            description: string;
+          };
+        };
+      };
+    }, undefined>;
+    verifyPasskeyAuthentication: better_call0.Endpoint<"/passkey/verify-authentication", "POST", {
+      response: _simplewebauthn_server0.AuthenticationResponseJSON;
+    }, Record<string, any> | undefined, [], {
+      session: {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        userId: string;
+        expiresAt: Date;
+        token: string;
+        ipAddress?: string | null | undefined;
+        userAgent?: string | null | undefined;
+      };
+    }, {
+      openapi: {
+        operationId: string;
+        description: string;
+        responses: {
+          200: {
+            description: string;
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object";
+                  properties: {
+                    session: {
+                      $ref: string;
+                    };
+                    user: {
+                      $ref: string;
+                    };
+                  };
+                };
+              };
+            };
+          };
+        };
+      };
+      $Infer: {
+        body: {
+          response: _simplewebauthn_server0.AuthenticationResponseJSON;
+        };
+      };
+    }, undefined>;
+    listPasskeys: better_call0.Endpoint<"/passkey/list-user-passkeys", "GET", undefined, Record<string, any> | undefined, [better_call0.Middleware<(inputContext: Record<string, any>) => Promise<{
+      session: {
+        session: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          userId: string;
+          expiresAt: Date;
+          token: string;
+          ipAddress?: string | null | undefined;
+          userAgent?: string | null | undefined;
+        };
+        user: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          email: string;
+          emailVerified: boolean;
+          name: string;
+          image?: string | null | undefined;
+        };
+      };
+    }>>], Passkey[], {
+      openapi: {
+        description: string;
+        responses: {
+          "200": {
+            description: string;
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array";
+                  items: {
+                    $ref: string;
+                    required: string[];
+                  };
+                  description: string;
+                };
+              };
+            };
+          };
+        };
+      };
+    }, undefined>;
+    deletePasskey: better_call0.Endpoint<"/passkey/delete-passkey", "POST", {
+      id: string;
+    }, Record<string, any> | undefined, [better_call0.Middleware<(inputContext: Record<string, any>) => Promise<{
+      session: {
+        session: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          userId: string;
+          expiresAt: Date;
+          token: string;
+          ipAddress?: string | null | undefined;
+          userAgent?: string | null | undefined;
+        };
+        user: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          email: string;
+          emailVerified: boolean;
+          name: string;
+          image?: string | null | undefined;
+        };
+      };
+    }>>], {
+      status: boolean;
+    }, {
+      openapi: {
+        description: string;
+        responses: {
+          "200": {
+            description: string;
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object";
+                  properties: {
+                    status: {
+                      type: string;
+                      description: string;
+                    };
+                  };
+                  required: string[];
+                };
+              };
+            };
+          };
+        };
+      };
+    }, undefined>;
+    updatePasskey: better_call0.Endpoint<"/passkey/update-passkey", "POST", {
+      id: string;
+      name: string;
+    }, Record<string, any> | undefined, [better_call0.Middleware<(inputContext: Record<string, any>) => Promise<{
+      session: {
+        session: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          userId: string;
+          expiresAt: Date;
+          token: string;
+          ipAddress?: string | null | undefined;
+          userAgent?: string | null | undefined;
+        };
+        user: Record<string, any> & {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          email: string;
+          emailVerified: boolean;
+          name: string;
+          image?: string | null | undefined;
+        };
+      };
+    }>>], {
+      passkey: Passkey;
+    }, {
+      openapi: {
+        description: string;
+        responses: {
+          "200": {
+            description: string;
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object";
+                  properties: {
+                    passkey: {
+                      $ref: string;
+                    };
+                  };
+                  required: string[];
+                };
+              };
+            };
+          };
+        };
+      };
+    }, undefined>;
+  };
+  schema: {
+    passkey: {
+      fields: {
+        name: {
+          type: "string";
+          required: false;
+        };
+        publicKey: {
+          type: "string";
+          required: true;
+        };
+        userId: {
+          type: "string";
+          references: {
+            model: string;
+            field: string;
+          };
+          required: true;
+          index: true;
+        };
+        credentialID: {
+          type: "string";
+          required: true;
+          index: true;
+        };
+        counter: {
+          type: "number";
+          required: true;
+        };
+        deviceType: {
+          type: "string";
+          required: true;
+        };
+        backedUp: {
+          type: "boolean";
+          required: true;
+        };
+        transports: {
+          type: "string";
+          required: false;
+        };
+        createdAt: {
+          type: "date";
+          required: false;
+        };
+        aaguid: {
+          type: "string";
+          required: false;
+        };
+      };
+    };
+  };
+  $ERROR_CODES: {
+    CHALLENGE_NOT_FOUND: better_auth0.RawError<"CHALLENGE_NOT_FOUND">;
+    YOU_ARE_NOT_ALLOWED_TO_REGISTER_THIS_PASSKEY: better_auth0.RawError<"YOU_ARE_NOT_ALLOWED_TO_REGISTER_THIS_PASSKEY">;
+    FAILED_TO_VERIFY_REGISTRATION: better_auth0.RawError<"FAILED_TO_VERIFY_REGISTRATION">;
+    PASSKEY_NOT_FOUND: better_auth0.RawError<"PASSKEY_NOT_FOUND">;
+    AUTHENTICATION_FAILED: better_auth0.RawError<"AUTHENTICATION_FAILED">;
+    UNABLE_TO_CREATE_SESSION: better_auth0.RawError<"UNABLE_TO_CREATE_SESSION">;
+    FAILED_TO_UPDATE_PASSKEY: better_auth0.RawError<"FAILED_TO_UPDATE_PASSKEY">;
+    PREVIOUSLY_REGISTERED: better_auth0.RawError<"PREVIOUSLY_REGISTERED">;
+    REGISTRATION_CANCELLED: better_auth0.RawError<"REGISTRATION_CANCELLED">;
+    AUTH_CANCELLED: better_auth0.RawError<"AUTH_CANCELLED">;
+    UNKNOWN_ERROR: better_auth0.RawError<"UNKNOWN_ERROR">;
+    SESSION_REQUIRED: better_auth0.RawError<"SESSION_REQUIRED">;
+    RESOLVE_USER_REQUIRED: better_auth0.RawError<"RESOLVE_USER_REQUIRED">;
+    RESOLVED_USER_INVALID: better_auth0.RawError<"RESOLVED_USER_INVALID">;
+  };
+  options: PasskeyOptions | undefined;
+};
+//#endregion
+export { PasskeyExtensionsResolver as a, PasskeyRegistrationUser as c, PasskeyAuthenticationOptions as i, WebAuthnChallengeValue as l, PASSKEY_ERROR_CODES as n, PasskeyOptions as o, Passkey as r, PasskeyRegistrationOptions as s, passkey as t };