@gatwech/auth 1.0.0-beta.18

package/dist/src/plugins/api-key/schema.d.ts

@@ -0,0 +1,188 @@
+export declare const apiKeySchema: ({ timeWindow, rateLimitMax, }: {
+    timeWindow: number;
+    rateLimitMax: number;
+}) => {
+    apikey: {
+        fields: {
+            /**
+             * The name of the key.
+             */
+            name: {
+                type: "string";
+                required: false;
+                input: false;
+            };
+            /**
+             * Shows the first few characters of the API key
+             * This allows you to show those few characters in the UI to make it easier for users to identify the API key.
+             */
+            start: {
+                type: "string";
+                required: false;
+                input: false;
+            };
+            /**
+             * The prefix of the key.
+             */
+            prefix: {
+                type: "string";
+                required: false;
+                input: false;
+            };
+            /**
+             * The hashed key value.
+             */
+            key: {
+                type: "string";
+                required: true;
+                input: false;
+            };
+            /**
+             * The user id of the user who created the key.
+             */
+            userId: {
+                type: "string";
+                references: {
+                    model: string;
+                    field: string;
+                    onDelete: "cascade";
+                };
+                required: true;
+                input: false;
+            };
+            /**
+             * The interval to refill the key in milliseconds.
+             */
+            refillInterval: {
+                type: "number";
+                required: false;
+                input: false;
+            };
+            /**
+             * The amount to refill the remaining count of the key.
+             */
+            refillAmount: {
+                type: "number";
+                required: false;
+                input: false;
+            };
+            /**
+             * The date and time when the key was last refilled.
+             */
+            lastRefillAt: {
+                type: "date";
+                required: false;
+                input: false;
+            };
+            /**
+             * Whether the key is enabled.
+             */
+            enabled: {
+                type: "boolean";
+                required: false;
+                input: false;
+                defaultValue: true;
+            };
+            /**
+             * Whether the key has rate limiting enabled.
+             */
+            rateLimitEnabled: {
+                type: "boolean";
+                required: false;
+                input: false;
+                defaultValue: true;
+            };
+            /**
+             * The time window in milliseconds for the rate limit.
+             */
+            rateLimitTimeWindow: {
+                type: "number";
+                required: false;
+                input: false;
+                defaultValue: number;
+            };
+            /**
+             * The maximum number of requests allowed within the `rateLimitTimeWindow`.
+             */
+            rateLimitMax: {
+                type: "number";
+                required: false;
+                input: false;
+                defaultValue: number;
+            };
+            /**
+             * The number of requests made within the rate limit time window
+             */
+            requestCount: {
+                type: "number";
+                required: false;
+                input: false;
+                defaultValue: number;
+            };
+            /**
+             * The remaining number of requests before the key is revoked.
+             *
+             * If this is null, then the key is not revoked.
+             *
+             * If `refillInterval` & `refillAmount` are provided, than this will refill accordingly.
+             */
+            remaining: {
+                type: "number";
+                required: false;
+                input: false;
+            };
+            /**
+             * The date and time of the last request made to the key.
+             */
+            lastRequest: {
+                type: "date";
+                required: false;
+                input: false;
+            };
+            /**
+             * The date and time when the key will expire.
+             */
+            expiresAt: {
+                type: "date";
+                required: false;
+                input: false;
+            };
+            /**
+             * The date and time when the key was created.
+             */
+            createdAt: {
+                type: "date";
+                required: true;
+                input: false;
+            };
+            /**
+             * The date and time when the key was last updated.
+             */
+            updatedAt: {
+                type: "date";
+                required: true;
+                input: false;
+            };
+            /**
+             * The permissions of the key.
+             */
+            permissions: {
+                type: "string";
+                required: false;
+                input: false;
+            };
+            /**
+             * Any additional metadata you want to store with the key.
+             */
+            metadata: {
+                type: "string";
+                required: false;
+                input: true;
+                transform: {
+                    input(value: import("@gatwech/core/db").DBPrimitive): string;
+                    output(value: import("@gatwech/core/db").DBPrimitive): any;
+                };
+            };
+        };
+    };
+};

package/dist/src/plugins/api-key/types.d.ts

@@ -0,0 +1,285 @@
+import type { GenericEndpointContext, HookEndpointContext } from "@gatwech/core";
+import type { InferOptionSchema } from "../../types";
+import type { Statements } from "../access";
+import type { apiKeySchema } from "./schema";
+export interface ApiKeyOptions {
+    /**
+     * The header name to check for API key
+     * @default "x-api-key"
+     */
+    apiKeyHeaders?: (string | string[]) | undefined;
+    /**
+     * Disable hashing of the API key.
+     *
+     * ⚠️ Security Warning: It's strongly recommended to not disable hashing.
+     * Storing API keys in plaintext makes them vulnerable to database breaches, potentially exposing all your users' API keys.
+     *
+     * @default false
+     */
+    disableKeyHashing?: boolean | undefined;
+    /**
+     * The function to get the API key from the context
+     */
+    customAPIKeyGetter?: ((ctx: HookEndpointContext) => string | null) | undefined;
+    /**
+     * A custom function to validate the API key
+     */
+    customAPIKeyValidator?: ((options: {
+        ctx: GenericEndpointContext;
+        key: string;
+    }) => boolean | Promise<boolean>) | undefined;
+    /**
+     * custom key generation function
+     */
+    customKeyGenerator?: (options: {
+        /**
+         * The length of the API key to generate
+         */
+        length: number;
+        /**
+         * The prefix of the API key to generate
+         */
+        prefix: string | undefined;
+    }) => string | Promise<string>;
+    /**
+     * The configuration for storing the starting characters of the API key in the database.
+     *
+     * Useful if you want to display the starting characters of an API key in the UI.
+     */
+    startingCharactersConfig?: {
+        /**
+         * Whether to store the starting characters in the database. If false, we will set `start` to `null`.
+         *
+         * @default true
+         */
+        shouldStore?: boolean;
+        /**
+         * The length of the starting characters to store in the database.
+         *
+         * This includes the prefix length.
+         *
+         * @default 6
+         */
+        charactersLength?: number;
+    } | undefined;
+    /**
+     * The length of the API key. Longer is better. Default is 64. (Doesn't include the prefix length)
+     * @default 64
+     */
+    defaultKeyLength?: number | undefined;
+    /**
+     * The prefix of the API key.
+     *
+     * Note: We recommend you append an underscore to the prefix to make the prefix more identifiable. (eg `hello_`)
+     */
+    defaultPrefix?: string | undefined;
+    /**
+     * The maximum length of the prefix.
+     *
+     * @default 32
+     */
+    maximumPrefixLength?: number | undefined;
+    /**
+     * Whether to require a name for the API key.
+     *
+     * @default false
+     */
+    requireName?: boolean | undefined;
+    /**
+     * The minimum length of the prefix.
+     *
+     * @default 1
+     */
+    minimumPrefixLength?: number | undefined;
+    /**
+     * The maximum length of the name.
+     *
+     * @default 32
+     */
+    maximumNameLength?: number | undefined;
+    /**
+     * The minimum length of the name.
+     *
+     * @default 1
+     */
+    minimumNameLength?: number | undefined;
+    /**
+     * Whether to enable metadata for an API key.
+     *
+     * @default false
+     */
+    enableMetadata?: boolean | undefined;
+    /**
+     * Customize the key expiration.
+     */
+    keyExpiration?: {
+        /**
+         * The default expires time in milliseconds.
+         *
+         * If `null`, then there will be no expiration time.
+         *
+         * @default null
+         */
+        defaultExpiresIn?: number | null;
+        /**
+         * Whether to disable the expires time passed from the client.
+         *
+         * If `true`, the expires time will be based on the default values.
+         *
+         * @default false
+         */
+        disableCustomExpiresTime?: boolean;
+        /**
+         * The minimum expiresIn value allowed to be set from the client. in days.
+         *
+         * @default 1
+         */
+        minExpiresIn?: number;
+        /**
+         * The maximum expiresIn value allowed to be set from the client. in days.
+         *
+         * @default 365
+         */
+        maxExpiresIn?: number;
+    } | undefined;
+    /**
+     * Default rate limiting options.
+     */
+    rateLimit?: {
+        /**
+         * Whether to enable rate limiting.
+         *
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * The duration in milliseconds where each request is counted.
+         *
+         * Once the `maxRequests` is reached, the request will be rejected until the `timeWindow` has passed, at which point the `timeWindow` will be reset.
+         *
+         * @default 1000 * 60 * 60 * 24 // 1 day
+         */
+        timeWindow?: number;
+        /**
+         * Maximum amount of requests allowed within a window
+         *
+         * Once the `maxRequests` is reached, the request will be rejected until the `timeWindow` has passed, at which point the `timeWindow` will be reset.
+         *
+         * @default 10 // 10 requests per day
+         */
+        maxRequests?: number;
+    } | undefined;
+    /**
+     * custom schema for the API key plugin
+     */
+    schema?: InferOptionSchema<ReturnType<typeof apiKeySchema>> | undefined;
+    /**
+     * An API Key can represent a valid session, so we automatically mock a session for the user if we find a valid API key in the request headers.
+     *
+     * ⚠︎ This is not recommended for production use, as it can lead to security issues.
+     * @default false
+     */
+    enableSessionForAPIKeys?: boolean | undefined;
+    /**
+     * Permissions for the API key.
+     */
+    permissions?: {
+        /**
+         * The default permissions for the API key.
+         */
+        defaultPermissions?: Statements | ((userId: string, ctx: GenericEndpointContext) => Statements | Promise<Statements>);
+    } | undefined;
+}
+export type ApiKey = {
+    /**
+     * ID
+     */
+    id: string;
+    /**
+     * The name of the key
+     */
+    name: string | null;
+    /**
+     * Shows the first few characters of the API key, including the prefix.
+     * This allows you to show those few characters in the UI to make it easier for users to identify the API key.
+     */
+    start: string | null;
+    /**
+     * The API Key prefix. Stored as plain text.
+     */
+    prefix: string | null;
+    /**
+     * The hashed API key value
+     */
+    key: string;
+    /**
+     * The owner of the user id
+     */
+    userId: string;
+    /**
+     * The interval in milliseconds between refills of the `remaining` count
+     *
+     * @example 3600000 // refill every hour (3600000ms = 1h)
+     */
+    refillInterval: number | null;
+    /**
+     * The amount to refill
+     */
+    refillAmount: number | null;
+    /**
+     * The last refill date
+     */
+    lastRefillAt: Date | null;
+    /**
+     * Sets if key is enabled or disabled
+     *
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Whether the key has rate limiting enabled.
+     */
+    rateLimitEnabled: boolean;
+    /**
+     * The duration in milliseconds
+     */
+    rateLimitTimeWindow: number | null;
+    /**
+     * Maximum amount of requests allowed within a window
+     */
+    rateLimitMax: number | null;
+    /**
+     * The number of requests made within the rate limit time window
+     */
+    requestCount: number;
+    /**
+     * Remaining requests (every time API key is used this should updated and should be updated on refill as well)
+     */
+    remaining: number | null;
+    /**
+     * When last request occurred
+     */
+    lastRequest: Date | null;
+    /**
+     * Expiry date of a key
+     */
+    expiresAt: Date | null;
+    /**
+     * created at
+     */
+    createdAt: Date;
+    /**
+     * updated at
+     */
+    updatedAt: Date;
+    /**
+     * Extra metadata about the apiKey
+     */
+    metadata: Record<string, any> | null;
+    /**
+     * Permissions for the API key
+     */
+    permissions?: ({
+        [key: string]: string[];
+    } | null) | undefined;
+};

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

@@ -0,0 +1,31 @@
+interface BearerOptions {
+    /**
+     * If true, only signed tokens
+     * will be converted to session
+     * cookies
+     *
+     * @default false
+     */
+    requireSignature?: boolean | undefined;
+}
+/**
+ * Converts bearer token to session cookie
+ */
+export declare const bearer: (options?: BearerOptions | undefined) => {
+    id: "bearer";
+    hooks: {
+        before: {
+            matcher(context: import("@gatwech/core").HookEndpointContext): boolean;
+            handler: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<{
+                context: {
+                    headers: Headers;
+                };
+            } | undefined>;
+        }[];
+        after: {
+            matcher(context: import("@gatwech/core").HookEndpointContext): true;
+            handler: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>;
+        }[];
+    };
+};
+export {};

package/dist/src/plugins/captcha/constants.d.ts

@@ -0,0 +1,9 @@
+import type { Provider } from "./types";
+export declare const defaultEndpoints: string[];
+export declare const Providers: {
+    readonly CLOUDFLARE_TURNSTILE: "cloudflare-turnstile";
+    readonly GOOGLE_RECAPTCHA: "google-recaptcha";
+    readonly HCAPTCHA: "hcaptcha";
+    readonly CAPTCHAFOX: "captchafox";
+};
+export declare const siteVerifyMap: Record<Provider, string>;

package/dist/src/plugins/captcha/error-codes.d.ts

@@ -0,0 +1,9 @@
+export declare const EXTERNAL_ERROR_CODES: {
+    readonly VERIFICATION_FAILED: "Captcha verification failed";
+    readonly MISSING_RESPONSE: "Missing CAPTCHA response";
+    readonly UNKNOWN_ERROR: "Something went wrong";
+};
+export declare const INTERNAL_ERROR_CODES: {
+    readonly MISSING_SECRET_KEY: "Missing secret key";
+    readonly SERVICE_UNAVAILABLE: "CAPTCHA service unavailable";
+};

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

@@ -0,0 +1,7 @@
+import type { CaptchaOptions } from "./types";
+export declare const captcha: (options: CaptchaOptions) => {
+    id: "captcha";
+    onRequest: (request: Request, ctx: import("@gatwech/core").AuthContext<import("@gatwech/core").PayvoAuthOptions>) => Promise<{
+        response: Response;
+    } | undefined>;
+};

package/dist/src/plugins/captcha/types.d.ts

@@ -0,0 +1,23 @@
+import type { Providers } from "./constants";
+export type Provider = (typeof Providers)[keyof typeof Providers];
+export interface BaseCaptchaOptions {
+    secretKey: string;
+    endpoints?: string[] | undefined;
+    siteVerifyURLOverride?: string | undefined;
+}
+export interface GoogleRecaptchaOptions extends BaseCaptchaOptions {
+    provider: typeof Providers.GOOGLE_RECAPTCHA;
+    minScore?: number | undefined;
+}
+export interface CloudflareTurnstileOptions extends BaseCaptchaOptions {
+    provider: typeof Providers.CLOUDFLARE_TURNSTILE;
+}
+export interface HCaptchaOptions extends BaseCaptchaOptions {
+    provider: typeof Providers.HCAPTCHA;
+    siteKey?: string | undefined;
+}
+export interface CaptchaFoxOptions extends BaseCaptchaOptions {
+    provider: typeof Providers.CAPTCHAFOX;
+    siteKey?: string | undefined;
+}
+export type CaptchaOptions = GoogleRecaptchaOptions | CloudflareTurnstileOptions | HCaptchaOptions | CaptchaFoxOptions;

package/dist/src/plugins/captcha/utils.d.ts

@@ -0,0 +1 @@
+export declare const encodeToURLParams: (obj: Record<string, any>) => string;

package/dist/src/plugins/captcha/verify-handlers/captchafox.d.ts

@@ -0,0 +1,11 @@
+type Params = {
+    siteVerifyURL: string;
+    secretKey: string;
+    captchaResponse: string;
+    siteKey?: string | undefined;
+    remoteIP?: string | undefined;
+};
+export declare const captchaFox: ({ siteVerifyURL, captchaResponse, secretKey, siteKey, remoteIP, }: Params) => Promise<{
+    response: Response;
+} | undefined>;
+export {};

package/dist/src/plugins/captcha/verify-handlers/cloudflare-turnstile.d.ts

@@ -0,0 +1,10 @@
+type Params = {
+    siteVerifyURL: string;
+    secretKey: string;
+    captchaResponse: string;
+    remoteIP?: string | undefined;
+};
+export declare const cloudflareTurnstile: ({ siteVerifyURL, captchaResponse, secretKey, remoteIP, }: Params) => Promise<{
+    response: Response;
+} | undefined>;
+export {};

package/dist/src/plugins/captcha/verify-handlers/google-recaptcha.d.ts

@@ -0,0 +1,11 @@
+type Params = {
+    siteVerifyURL: string;
+    secretKey: string;
+    captchaResponse: string;
+    minScore?: number | undefined;
+    remoteIP?: string | undefined;
+};
+export declare const googleRecaptcha: ({ siteVerifyURL, captchaResponse, secretKey, minScore, remoteIP, }: Params) => Promise<{
+    response: Response;
+} | undefined>;
+export {};

package/dist/src/plugins/captcha/verify-handlers/h-captcha.d.ts

@@ -0,0 +1,11 @@
+type Params = {
+    siteVerifyURL: string;
+    secretKey: string;
+    captchaResponse: string;
+    siteKey?: string | undefined;
+    remoteIP?: string | undefined;
+};
+export declare const hCaptcha: ({ siteVerifyURL, captchaResponse, secretKey, siteKey, remoteIP, }: Params) => Promise<{
+    response: Response;
+} | undefined>;
+export {};

package/dist/src/plugins/captcha/verify-handlers/index.d.ts

@@ -0,0 +1,4 @@
+export { captchaFox } from "./captchafox";
+export { cloudflareTurnstile } from "./cloudflare-turnstile";
+export { googleRecaptcha } from "./google-recaptcha";
+export { hCaptcha } from "./h-captcha";

package/dist/src/plugins/custom-session/client.d.ts

@@ -0,0 +1,12 @@
+import type { Auth } from "../../auth";
+import type { PayvoAuthOptions } from "../../types";
+export declare const customSessionClient: <A extends Auth | {
+    options: PayvoAuthOptions;
+}>() => {
+    id: "infer-server-plugin";
+    $InferServerPlugin: (A extends {
+        options: infer O;
+    } ? O : A)["plugins"] extends (infer P)[] ? P extends {
+        id: "custom-session";
+    } ? P : never : never;
+};