@gatwech/auth 1.0.0-beta.18

package/dist/src/plugins/email-otp/index.d.ts

@@ -0,0 +1,826 @@
+import * as z from "zod";
+export interface EmailOTPOptions {
+    /**
+     * Function to send email verification
+     */
+    sendVerificationOTP: (data: {
+        email: string;
+        otp: string;
+        type: "sign-in" | "email-verification" | "forget-password";
+    }, request?: Request | undefined) => Promise<void>;
+    /**
+     * Length of the OTP
+     *
+     * @default 6
+     */
+    otpLength?: number | undefined;
+    /**
+     * Expiry time of the OTP in seconds
+     *
+     * @default 300 (5 minutes)
+     */
+    expiresIn?: number | undefined;
+    /**
+     * Custom function to generate otp
+     */
+    generateOTP?: (data: {
+        email: string;
+        type: "sign-in" | "email-verification" | "forget-password";
+    }, request?: Request) => string | undefined;
+    /**
+     * Send email verification on sign-up
+     *
+     * @Default false
+     */
+    sendVerificationOnSignUp?: boolean | undefined;
+    /**
+     * A boolean value that determines whether to prevent
+     * automatic sign-up when the user is not registered.
+     *
+     * @Default false
+     */
+    disableSignUp?: boolean | undefined;
+    /**
+     * Allowed attempts for the OTP code
+     * @default 3
+     */
+    allowedAttempts?: number | undefined;
+    /**
+     * Store the OTP in your database in a secure way
+     * Note: This will not affect the OTP sent to the user, it will only affect the OTP stored in your database
+     *
+     * @default "plain"
+     */
+    storeOTP?: ("hashed" | "plain" | "encrypted" | {
+        hash: (otp: string) => Promise<string>;
+    } | {
+        encrypt: (otp: string) => Promise<string>;
+        decrypt: (otp: string) => Promise<string>;
+    }) | undefined;
+    /**
+     * Override the default email verification to use email otp instead
+     *
+     * @default false
+     */
+    overrideDefaultEmailVerification?: boolean | undefined;
+}
+export declare const emailOTP: (options: EmailOTPOptions) => {
+    id: "email-otp";
+    init(ctx: import("@gatwech/core").AuthContext<import("@gatwech/core").PayvoAuthOptions>): {
+        options: {
+            emailVerification: {
+                sendVerificationEmail(data: {
+                    user: import("packages/core/dist/index-65G5U5DB.mjs")._t;
+                    url: string;
+                    token: string;
+                }, request: Request | undefined): Promise<void>;
+            };
+        };
+    } | undefined;
+    endpoints: {
+        createVerificationOTP: {
+            <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+                body: {
+                    email: string;
+                    type: "sign-in" | "email-verification" | "forget-password";
+                };
+            } & {
+                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: string;
+            } : string>;
+            options: {
+                method: "POST";
+                body: z.ZodObject<{
+                    email: z.ZodString;
+                    type: z.ZodEnum<{
+                        "sign-in": "sign-in";
+                        "email-verification": "email-verification";
+                        "forget-password": "forget-password";
+                    }>;
+                }, z.core.$strip>;
+                metadata: {
+                    SERVER_ONLY: true;
+                    openapi: {
+                        description: string;
+                        responses: {
+                            200: {
+                                description: string;
+                                content: {
+                                    "application/json": {
+                                        schema: {
+                                            type: "string";
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            } & {
+                use: any[];
+            };
+            path: "/email-otp/create-verification-otp";
+        };
+        /**
+         * ### Endpoint
+         *
+         * GET `/email-otp/get-verification-otp`
+         *
+         * ### API Methods
+         *
+         * **server:**
+         * `auth.api.getVerificationOTP`
+         *
+         * @see [Read our docs to learn more.](https://payvopayvo.com/docs/plugins/email-otp#api-method-email-otp-get-verification-otp)
+         */
+        getVerificationOTP: {
+            <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+                body?: undefined;
+            } & {
+                method?: "GET" | undefined;
+            } & {
+                query: {
+                    email: string;
+                    type: "sign-in" | "email-verification" | "forget-password";
+                };
+            } & {
+                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: {
+                    otp: null;
+                } | {
+                    otp: string;
+                };
+            } : {
+                otp: null;
+            } | {
+                otp: string;
+            }>;
+            options: {
+                method: "GET";
+                query: z.ZodObject<{
+                    email: z.ZodString;
+                    type: z.ZodEnum<{
+                        "sign-in": "sign-in";
+                        "email-verification": "email-verification";
+                        "forget-password": "forget-password";
+                    }>;
+                }, z.core.$strip>;
+                metadata: {
+                    SERVER_ONLY: true;
+                    openapi: {
+                        description: string;
+                        responses: {
+                            "200": {
+                                description: string;
+                                content: {
+                                    "application/json": {
+                                        schema: {
+                                            type: "object";
+                                            properties: {
+                                                otp: {
+                                                    type: string;
+                                                    nullable: boolean;
+                                                    description: string;
+                                                };
+                                            };
+                                            required: string[];
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            } & {
+                use: any[];
+            };
+            path: "/email-otp/get-verification-otp";
+        };
+        /**
+         * ### Endpoint
+         *
+         * GET `/email-otp/check-verification-otp`
+         *
+         * ### API Methods
+         *
+         * **server:**
+         * `auth.api.checkVerificationOTP`
+         *
+         * @see [Read our docs to learn more.](https://payvopayvo.com/docs/plugins/email-otp#api-method-email-otp-check-verification-otp)
+         */
+        checkVerificationOTP: {
+            <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+                body: {
+                    email: string;
+                    type: "sign-in" | "email-verification" | "forget-password";
+                    otp: 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: {
+                    success: boolean;
+                };
+            } : {
+                success: boolean;
+            }>;
+            options: {
+                method: "POST";
+                body: z.ZodObject<{
+                    email: z.ZodString;
+                    type: z.ZodEnum<{
+                        "sign-in": "sign-in";
+                        "email-verification": "email-verification";
+                        "forget-password": "forget-password";
+                    }>;
+                    otp: z.ZodString;
+                }, z.core.$strip>;
+                metadata: {
+                    openapi: {
+                        description: string;
+                        responses: {
+                            200: {
+                                description: string;
+                                content: {
+                                    "application/json": {
+                                        schema: {
+                                            type: "object";
+                                            properties: {
+                                                success: {
+                                                    type: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            } & {
+                use: any[];
+            };
+            path: "/email-otp/check-verification-otp";
+        };
+        /**
+         * ### Endpoint
+         *
+         * POST `/email-otp/verify-email`
+         *
+         * ### API Methods
+         *
+         * **server:**
+         * `auth.api.verifyEmailOTP`
+         *
+         * **client:**
+         * `authClient.emailOtp.verifyEmail`
+         *
+         * @see [Read our docs to learn more.](https://payvopayvo.com/docs/plugins/email-otp#api-method-email-otp-verify-email)
+         */
+        verifyEmailOTP: {
+            <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+                body: {
+                    email: string;
+                    otp: 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: {
+                    status: boolean;
+                    token: string;
+                    user: {
+                        id: any;
+                        email: any;
+                        emailVerified: any;
+                        name: any;
+                        image: any;
+                        createdAt: any;
+                        updatedAt: any;
+                    };
+                } | {
+                    status: boolean;
+                    token: null;
+                    user: {
+                        id: any;
+                        email: any;
+                        emailVerified: any;
+                        name: any;
+                        image: any;
+                        createdAt: any;
+                        updatedAt: any;
+                    };
+                };
+            } : {
+                status: boolean;
+                token: string;
+                user: {
+                    id: any;
+                    email: any;
+                    emailVerified: any;
+                    name: any;
+                    image: any;
+                    createdAt: any;
+                    updatedAt: any;
+                };
+            } | {
+                status: boolean;
+                token: null;
+                user: {
+                    id: any;
+                    email: any;
+                    emailVerified: any;
+                    name: any;
+                    image: any;
+                    createdAt: any;
+                    updatedAt: any;
+                };
+            }>;
+            options: {
+                method: "POST";
+                body: z.ZodObject<{
+                    email: z.ZodString;
+                    otp: z.ZodString;
+                }, z.core.$strip>;
+                metadata: {
+                    openapi: {
+                        description: string;
+                        responses: {
+                            200: {
+                                description: string;
+                                content: {
+                                    "application/json": {
+                                        schema: {
+                                            type: "object";
+                                            properties: {
+                                                status: {
+                                                    type: string;
+                                                    description: string;
+                                                    enum: boolean[];
+                                                };
+                                                token: {
+                                                    type: string;
+                                                    nullable: boolean;
+                                                    description: string;
+                                                };
+                                                user: {
+                                                    $ref: string;
+                                                };
+                                            };
+                                            required: string[];
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            } & {
+                use: any[];
+            };
+            path: "/email-otp/verify-email";
+        };
+        /**
+         * ### Endpoint
+         *
+         * POST `/sign-in/email-otp`
+         *
+         * ### API Methods
+         *
+         * **server:**
+         * `auth.api.signInEmailOTP`
+         *
+         * **client:**
+         * `authClient.signIn.emailOtp`
+         *
+         * @see [Read our docs to learn more.](https://payvopayvo.com/docs/plugins/email-otp#api-method-sign-in-email-otp)
+         */
+        signInEmailOTP: {
+            <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+                body: {
+                    email: string;
+                    otp: 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: {
+                    token: string;
+                    user: {
+                        id: string;
+                        email: string;
+                        emailVerified: boolean;
+                        name: string;
+                        image: string | null | undefined;
+                        createdAt: Date;
+                        updatedAt: Date;
+                    };
+                };
+            } : {
+                token: string;
+                user: {
+                    id: string;
+                    email: string;
+                    emailVerified: boolean;
+                    name: string;
+                    image: string | null | undefined;
+                    createdAt: Date;
+                    updatedAt: Date;
+                };
+            }>;
+            options: {
+                method: "POST";
+                body: z.ZodObject<{
+                    email: z.ZodString;
+                    otp: z.ZodString;
+                }, z.core.$strip>;
+                metadata: {
+                    openapi: {
+                        description: string;
+                        responses: {
+                            200: {
+                                description: string;
+                                content: {
+                                    "application/json": {
+                                        schema: {
+                                            type: "object";
+                                            properties: {
+                                                token: {
+                                                    type: string;
+                                                    description: string;
+                                                };
+                                                user: {
+                                                    $ref: string;
+                                                };
+                                            };
+                                            required: string[];
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            } & {
+                use: any[];
+            };
+            path: "/sign-in/email-otp";
+        };
+        /**
+         * ### Endpoint
+         *
+         * POST `/forget-password/email-otp`
+         *
+         * ### API Methods
+         *
+         * **server:**
+         * `auth.api.forgetPasswordEmailOTP`
+         *
+         * **client:**
+         * `authClient.forgetPassword.emailOtp`
+         *
+         * @see [Read our docs to learn more.](https://payvopayvo.com/docs/plugins/email-otp#api-method-forget-password-email-otp)
+         */
+        forgetPasswordEmailOTP: {
+            <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+                body: {
+                    email: 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: {
+                    success: boolean;
+                };
+            } : {
+                success: boolean;
+            }>;
+            options: {
+                method: "POST";
+                body: z.ZodObject<{
+                    email: z.ZodString;
+                }, z.core.$strip>;
+                metadata: {
+                    openapi: {
+                        description: string;
+                        responses: {
+                            200: {
+                                description: string;
+                                content: {
+                                    "application/json": {
+                                        schema: {
+                                            type: "object";
+                                            properties: {
+                                                success: {
+                                                    type: string;
+                                                    description: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            } & {
+                use: any[];
+            };
+            path: "/forget-password/email-otp";
+        };
+        /**
+         * ### Endpoint
+         *
+         * POST `/email-otp/reset-password`
+         *
+         * ### API Methods
+         *
+         * **server:**
+         * `auth.api.resetPasswordEmailOTP`
+         *
+         * **client:**
+         * `authClient.emailOtp.resetPassword`
+         *
+         * @see [Read our docs to learn more.](https://payvopayvo.com/docs/plugins/email-otp#api-method-email-otp-reset-password)
+         */
+        resetPasswordEmailOTP: {
+            <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+                body: {
+                    email: string;
+                    otp: string;
+                    password: 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: {
+                    success: boolean;
+                };
+            } : {
+                success: boolean;
+            }>;
+            options: {
+                method: "POST";
+                body: z.ZodObject<{
+                    email: z.ZodString;
+                    otp: z.ZodString;
+                    password: z.ZodString;
+                }, z.core.$strip>;
+                metadata: {
+                    openapi: {
+                        description: string;
+                        responses: {
+                            200: {
+                                description: string;
+                                contnt: {
+                                    "application/json": {
+                                        schema: {
+                                            type: string;
+                                            properties: {
+                                                success: {
+                                                    type: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            } & {
+                use: any[];
+            };
+            path: "/email-otp/reset-password";
+        };
+        /**
+         * ### Endpoint
+         *
+         * POST `/email-otp/send-verification-otp`
+         *
+         * ### API Methods
+         *
+         * **server:**
+         * `auth.api.sendVerificationOTP`
+         *
+         * **client:**
+         * `authClient.emailOtp.sendVerificationOtp`
+         *
+         * @see [Read our docs to learn more.](https://payvopayvo.com/docs/plugins/email-otp#api-method-email-otp-send-verification-otp)
+         */
+        sendVerificationOTP: {
+            <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+                body: {
+                    email: string;
+                    type: "sign-in" | "email-verification" | "forget-password";
+                };
+            } & {
+                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: {
+                    success: boolean;
+                };
+            } : {
+                success: boolean;
+            }>;
+            options: {
+                method: "POST";
+                body: z.ZodObject<{
+                    email: z.ZodString;
+                    type: z.ZodEnum<{
+                        "sign-in": "sign-in";
+                        "email-verification": "email-verification";
+                        "forget-password": "forget-password";
+                    }>;
+                }, z.core.$strip>;
+                metadata: {
+                    openapi: {
+                        description: string;
+                        responses: {
+                            200: {
+                                description: string;
+                                content: {
+                                    "application/json": {
+                                        schema: {
+                                            type: "object";
+                                            properties: {
+                                                success: {
+                                                    type: string;
+                                                };
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            } & {
+                use: any[];
+            };
+            path: "/email-otp/send-verification-otp";
+        };
+    };
+    hooks: {
+        after: {
+            matcher(context: import("@gatwech/core").HookEndpointContext): boolean;
+            handler: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>;
+        }[];
+    };
+    $ERROR_CODES: {
+        readonly OTP_EXPIRED: "OTP expired";
+        readonly INVALID_OTP: "Invalid OTP";
+        readonly TOO_MANY_ATTEMPTS: "Too many attempts";
+    };
+    rateLimit: ({
+        pathMatcher(path: string): path is "/email-otp/send-verification-otp";
+        window: number;
+        max: number;
+    } | {
+        pathMatcher(path: string): path is "/email-otp/check-verification-otp";
+        window: number;
+        max: number;
+    } | {
+        pathMatcher(path: string): path is "/email-otp/verify-email";
+        window: number;
+        max: number;
+    } | {
+        pathMatcher(path: string): path is "/sign-in/email-otp";
+        window: number;
+        max: number;
+    })[];
+};