@gatwech/auth 1.0.0-beta.18

package/dist/index-DlaMq1nb.d.mts

@@ -0,0 +1,955 @@
+import { t as InferOptionSchema } from "./plugins-hFZT3hmK.mjs";
+import * as better_call176 from "better-call";
+import * as z$1 from "zod";
+import * as _simplewebauthn_server0 from "@simplewebauthn/server";
+import { AuthenticationResponseJSON, CredentialDeviceType, PublicKeyCredentialCreationOptionsJSON } from "@simplewebauthn/server";
+
+//#region src/plugins/passkey/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;
+      };
+      credentialID: {
+        type: "string";
+        required: 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/plugins/passkey/types.d.ts
+
+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 "Payvo 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 "payvo-auth-passkey"
+     */
+    webAuthnChallengeCookie?: string;
+  } | undefined;
+  /**
+   * Schema for the passkey model
+   */
+  schema?: InferOptionSchema<typeof schema> | 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/plugins/passkey/index.d.ts
+declare const passkey: (options?: PasskeyOptions | undefined) => {
+  id: "passkey";
+  endpoints: {
+    generatePasskeyRegistrationOptions: {
+      <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0?: ({
+        body?: undefined;
+      } & {
+        method?: "GET" | undefined;
+      } & {
+        query?: {
+          authenticatorAttachment?: "platform" | "cross-platform" | undefined;
+          name?: string | undefined;
+        } | undefined;
+      } & {
+        params?: Record<string, any>;
+      } & {
+        request?: Request;
+      } & {
+        headers?: HeadersInit;
+      } & {
+        asResponse?: boolean;
+        returnHeaders?: boolean;
+        use?: better_call176.Middleware[];
+        path?: string;
+      } & {
+        asResponse?: AsResponse | undefined;
+        returnHeaders?: ReturnHeaders | undefined;
+      }) | undefined): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+        headers: Headers;
+        response: PublicKeyCredentialCreationOptionsJSON;
+      } : PublicKeyCredentialCreationOptionsJSON>;
+      options: {
+        method: "GET";
+        use: ((inputContext: better_call176.MiddlewareInputContext<better_call176.MiddlewareOptions>) => 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;
+            };
+          };
+        }>)[];
+        query: z$1.ZodOptional<z$1.ZodObject<{
+          authenticatorAttachment: z$1.ZodOptional<z$1.ZodEnum<{
+            platform: "platform";
+            "cross-platform": "cross-platform";
+          }>>;
+          name: z$1.ZodOptional<z$1.ZodString>;
+        }, z$1.core.$strip>>;
+        metadata: {
+          client: boolean;
+          openapi: {
+            description: string;
+            responses: {
+              200: {
+                description: string;
+                parameters: {
+                  query: {
+                    authenticatorAttachment: {
+                      description: string;
+                      required: boolean;
+                    };
+                    name: {
+                      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;
+                        };
+                      };
+                    };
+                  };
+                };
+              };
+            };
+          };
+        };
+      } & {
+        use: any[];
+      };
+      path: "/passkey/generate-register-options";
+    };
+    generatePasskeyAuthenticationOptions: {
+      <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0?: ({
+        body?: undefined;
+      } & {
+        method?: "POST" | undefined;
+      } & {
+        query?: Record<string, any> | undefined;
+      } & {
+        params?: Record<string, any>;
+      } & {
+        request?: Request;
+      } & {
+        headers?: HeadersInit;
+      } & {
+        asResponse?: boolean;
+        returnHeaders?: boolean;
+        use?: better_call176.Middleware[];
+        path?: string;
+      } & {
+        asResponse?: AsResponse | undefined;
+        returnHeaders?: ReturnHeaders | undefined;
+      }) | undefined): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+        headers: Headers;
+        response: _simplewebauthn_server0.PublicKeyCredentialRequestOptionsJSON;
+      } : _simplewebauthn_server0.PublicKeyCredentialRequestOptionsJSON>;
+      options: {
+        method: "POST";
+        metadata: {
+          openapi: {
+            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;
+                        };
+                      };
+                    };
+                  };
+                };
+              };
+            };
+          };
+        };
+      } & {
+        use: any[];
+      };
+      path: "/passkey/generate-authenticate-options";
+    };
+    verifyPasskeyRegistration: {
+      <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+        body: {
+          response: any;
+          name?: string | undefined;
+        };
+      } & {
+        method?: "POST" | undefined;
+      } & {
+        query?: Record<string, any> | undefined;
+      } & {
+        params?: Record<string, any>;
+      } & {
+        request?: Request;
+      } & {
+        headers?: HeadersInit;
+      } & {
+        asResponse?: boolean;
+        returnHeaders?: boolean;
+        use?: better_call176.Middleware[];
+        path?: string;
+      } & {
+        asResponse?: AsResponse | undefined;
+        returnHeaders?: ReturnHeaders | undefined;
+      }): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+        headers: Headers;
+        response: Passkey | null;
+      } : Passkey | null>;
+      options: {
+        method: "POST";
+        body: z$1.ZodObject<{
+          response: z$1.ZodAny;
+          name: z$1.ZodOptional<z$1.ZodString>;
+        }, z$1.core.$strip>;
+        use: ((inputContext: better_call176.MiddlewareInputContext<better_call176.MiddlewareOptions>) => 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;
+            };
+          };
+        }>)[];
+        metadata: {
+          openapi: {
+            description: string;
+            responses: {
+              200: {
+                description: string;
+                content: {
+                  "application/json": {
+                    schema: {
+                      $ref: string;
+                    };
+                  };
+                };
+              };
+              400: {
+                description: string;
+              };
+            };
+          };
+        };
+      } & {
+        use: any[];
+      };
+      path: "/passkey/verify-registration";
+    };
+    verifyPasskeyAuthentication: {
+      <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+        body: {
+          response: AuthenticationResponseJSON;
+        };
+      } & {
+        method?: "POST" | undefined;
+      } & {
+        query?: Record<string, any> | undefined;
+      } & {
+        params?: Record<string, any>;
+      } & {
+        request?: Request;
+      } & {
+        headers?: HeadersInit;
+      } & {
+        asResponse?: boolean;
+        returnHeaders?: boolean;
+        use?: better_call176.Middleware[];
+        path?: string;
+      } & {
+        asResponse?: AsResponse | undefined;
+        returnHeaders?: ReturnHeaders | undefined;
+      }): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+        headers: Headers;
+        response: {
+          session: {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            userId: string;
+            expiresAt: Date;
+            token: string;
+            ipAddress?: string | null | undefined;
+            userAgent?: string | null | undefined;
+          };
+        };
+      } : {
+        session: {
+          id: string;
+          createdAt: Date;
+          updatedAt: Date;
+          userId: string;
+          expiresAt: Date;
+          token: string;
+          ipAddress?: string | null | undefined;
+          userAgent?: string | null | undefined;
+        };
+      }>;
+      options: {
+        method: "POST";
+        body: z$1.ZodObject<{
+          response: z$1.ZodRecord<z$1.ZodAny, z$1.ZodAny>;
+        }, z$1.core.$strip>;
+        metadata: {
+          openapi: {
+            description: string;
+            responses: {
+              200: {
+                description: string;
+                content: {
+                  "application/json": {
+                    schema: {
+                      type: "object";
+                      properties: {
+                        session: {
+                          $ref: string;
+                        };
+                        user: {
+                          $ref: string;
+                        };
+                      };
+                    };
+                  };
+                };
+              };
+            };
+          };
+          $Infer: {
+            body: {
+              response: AuthenticationResponseJSON;
+            };
+          };
+        };
+      } & {
+        use: any[];
+      };
+      path: "/passkey/verify-authentication";
+    };
+    /**
+     * ### Endpoint
+     *
+     * GET `/passkey/list-user-passkeys`
+     *
+     * ### API Methods
+     *
+     * **server:**
+     * `auth.api.listPasskeys`
+     *
+     * **client:**
+     * `authClient.passkey.listUserPasskeys`
+     *
+     * @see [Read our docs to learn more.](https://payvo-auth.com/docs/plugins/passkey#api-method-passkey-list-user-passkeys)
+     */
+    listPasskeys: {
+      <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0?: ({
+        body?: undefined;
+      } & {
+        method?: "GET" | undefined;
+      } & {
+        query?: Record<string, any> | undefined;
+      } & {
+        params?: Record<string, any>;
+      } & {
+        request?: Request;
+      } & {
+        headers?: HeadersInit;
+      } & {
+        asResponse?: boolean;
+        returnHeaders?: boolean;
+        use?: better_call176.Middleware[];
+        path?: string;
+      } & {
+        asResponse?: AsResponse | undefined;
+        returnHeaders?: ReturnHeaders | undefined;
+      }) | undefined): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+        headers: Headers;
+        response: Passkey[];
+      } : Passkey[]>;
+      options: {
+        method: "GET";
+        use: ((inputContext: better_call176.MiddlewareInputContext<better_call176.MiddlewareOptions>) => 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;
+            };
+          };
+        }>)[];
+        metadata: {
+          openapi: {
+            description: string;
+            responses: {
+              "200": {
+                description: string;
+                content: {
+                  "application/json": {
+                    schema: {
+                      type: "array";
+                      items: {
+                        $ref: string;
+                        required: string[];
+                      };
+                      description: string;
+                    };
+                  };
+                };
+              };
+            };
+          };
+        };
+      } & {
+        use: any[];
+      };
+      path: "/passkey/list-user-passkeys";
+    };
+    /**
+     * ### Endpoint
+     *
+     * POST `/passkey/delete-passkey`
+     *
+     * ### API Methods
+     *
+     * **server:**
+     * `auth.api.deletePasskey`
+     *
+     * **client:**
+     * `authClient.passkey.deletePasskey`
+     *
+     * @see [Read our docs to learn more.](https://payvo-auth.com/docs/plugins/passkey#api-method-passkey-delete-passkey)
+     */
+    deletePasskey: {
+      <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+        body: {
+          id: string;
+        };
+      } & {
+        method?: "POST" | undefined;
+      } & {
+        query?: Record<string, any> | undefined;
+      } & {
+        params?: Record<string, any>;
+      } & {
+        request?: Request;
+      } & {
+        headers?: HeadersInit;
+      } & {
+        asResponse?: boolean;
+        returnHeaders?: boolean;
+        use?: better_call176.Middleware[];
+        path?: string;
+      } & {
+        asResponse?: AsResponse | undefined;
+        returnHeaders?: ReturnHeaders | undefined;
+      }): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+        headers: Headers;
+        response: null;
+      } : null>;
+      options: {
+        method: "POST";
+        body: z$1.ZodObject<{
+          id: z$1.ZodString;
+        }, z$1.core.$strip>;
+        use: ((inputContext: better_call176.MiddlewareInputContext<better_call176.MiddlewareOptions>) => 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;
+            };
+          };
+        }>)[];
+        metadata: {
+          openapi: {
+            description: string;
+            responses: {
+              "200": {
+                description: string;
+                content: {
+                  "application/json": {
+                    schema: {
+                      type: "object";
+                      properties: {
+                        status: {
+                          type: string;
+                          description: string;
+                        };
+                      };
+                      required: string[];
+                    };
+                  };
+                };
+              };
+            };
+          };
+        };
+      } & {
+        use: any[];
+      };
+      path: "/passkey/delete-passkey";
+    };
+    /**
+     * ### Endpoint
+     *
+     * POST `/passkey/update-passkey`
+     *
+     * ### API Methods
+     *
+     * **server:**
+     * `auth.api.updatePasskey`
+     *
+     * **client:**
+     * `authClient.passkey.updatePasskey`
+     *
+     * @see [Read our docs to learn more.](https://payvo-auth.com/docs/plugins/passkey#api-method-passkey-update-passkey)
+     */
+    updatePasskey: {
+      <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+        body: {
+          id: string;
+          name: string;
+        };
+      } & {
+        method?: "POST" | undefined;
+      } & {
+        query?: Record<string, any> | undefined;
+      } & {
+        params?: Record<string, any>;
+      } & {
+        request?: Request;
+      } & {
+        headers?: HeadersInit;
+      } & {
+        asResponse?: boolean;
+        returnHeaders?: boolean;
+        use?: better_call176.Middleware[];
+        path?: string;
+      } & {
+        asResponse?: AsResponse | undefined;
+        returnHeaders?: ReturnHeaders | undefined;
+      }): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+        headers: Headers;
+        response: {
+          passkey: Passkey;
+        };
+      } : {
+        passkey: Passkey;
+      }>;
+      options: {
+        method: "POST";
+        body: z$1.ZodObject<{
+          id: z$1.ZodString;
+          name: z$1.ZodString;
+        }, z$1.core.$strip>;
+        use: ((inputContext: better_call176.MiddlewareInputContext<better_call176.MiddlewareOptions>) => 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;
+            };
+          };
+        }>)[];
+        metadata: {
+          openapi: {
+            description: string;
+            responses: {
+              "200": {
+                description: string;
+                content: {
+                  "application/json": {
+                    schema: {
+                      type: "object";
+                      properties: {
+                        passkey: {
+                          $ref: string;
+                        };
+                      };
+                      required: string[];
+                    };
+                  };
+                };
+              };
+            };
+          };
+        };
+      } & {
+        use: any[];
+      };
+      path: "/passkey/update-passkey";
+    };
+  };
+  schema: {
+    passkey: {
+      fields: {
+        name: {
+          type: "string";
+          required: false;
+        };
+        publicKey: {
+          type: "string";
+          required: true;
+        };
+        userId: {
+          type: "string";
+          references: {
+            model: string;
+            field: string;
+          };
+          required: true;
+        };
+        credentialID: {
+          type: "string";
+          required: 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: {
+    readonly CHALLENGE_NOT_FOUND: "Challenge not found";
+    readonly YOU_ARE_NOT_ALLOWED_TO_REGISTER_THIS_PASSKEY: "You are not allowed to register this passkey";
+    readonly FAILED_TO_VERIFY_REGISTRATION: "Failed to verify registration";
+    readonly PASSKEY_NOT_FOUND: "Passkey not found";
+    readonly AUTHENTICATION_FAILED: "Authentication failed";
+    readonly UNABLE_TO_CREATE_SESSION: "Unable to create session";
+    readonly FAILED_TO_UPDATE_PASSKEY: "Failed to update passkey";
+  };
+};
+//#endregion
+export { Passkey as n, PasskeyOptions as r, passkey as t };