@gatwech/auth 1.0.0-beta.18

package/dist/src/plugins/passkey/index.d.ts

@@ -0,0 +1,838 @@
+import type { AuthenticationResponseJSON, PublicKeyCredentialCreationOptionsJSON } from "@simplewebauthn/server";
+import * as z from "zod";
+import type { Passkey, PasskeyOptions } from "./types";
+export 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?: import("better-call").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: import("better-call").MiddlewareInputContext<import("better-call").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.ZodOptional<z.ZodObject<{
+                    authenticatorAttachment: z.ZodOptional<z.ZodEnum<{
+                        platform: "platform";
+                        "cross-platform": "cross-platform";
+                    }>>;
+                    name: z.ZodOptional<z.ZodString>;
+                }, z.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?: import("better-call").Middleware[];
+                path?: string;
+            } & {
+                asResponse?: AsResponse | undefined;
+                returnHeaders?: ReturnHeaders | undefined;
+            }) | undefined): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+                headers: Headers;
+                response: import("@simplewebauthn/server").PublicKeyCredentialRequestOptionsJSON;
+            } : import("@simplewebauthn/server").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?: import("better-call").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.ZodObject<{
+                    response: z.ZodAny;
+                    name: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+                use: ((inputContext: import("better-call").MiddlewareInputContext<import("better-call").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?: import("better-call").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.ZodObject<{
+                    response: z.ZodRecord<z.ZodAny, z.ZodAny>;
+                }, z.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?: import("better-call").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: import("better-call").MiddlewareInputContext<import("better-call").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?: import("better-call").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.ZodObject<{
+                    id: z.ZodString;
+                }, z.core.$strip>;
+                use: ((inputContext: import("better-call").MiddlewareInputContext<import("better-call").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?: import("better-call").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.ZodObject<{
+                    id: z.ZodString;
+                    name: z.ZodString;
+                }, z.core.$strip>;
+                use: ((inputContext: import("better-call").MiddlewareInputContext<import("better-call").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";
+    };
+};
+export type { Passkey, PasskeyOptions };