@gatwech/core 0.0.11 → 1.0.0-beta.18

package/src/db/adapter/index.ts

@@ -1,466 +0,0 @@
-import type { PayvoAuthOptions } from "../../types";
-import type { PayvoAuthDBSchema, DBFieldAttribute } from "../type";
-
-export type DBAdapterDebugLogOption =
-  | boolean
-  | {
-      /**
-       * Useful when you want to log only certain conditions.
-       */
-      logCondition?: (() => boolean) | undefined;
-      create?: boolean | undefined;
-      update?: boolean | undefined;
-      updateMany?: boolean | undefined;
-      findOne?: boolean | undefined;
-      findMany?: boolean | undefined;
-      delete?: boolean | undefined;
-      deleteMany?: boolean | undefined;
-      count?: boolean | undefined;
-    }
-  | {
-      /**
-       * Only used for adapter tests to show debug logs if a test fails.
-       *
-       * @deprecated Not actually deprecated. Doing this for IDEs to show this option at the very bottom and stop end-users from using this.
-       */
-      isRunningAdapterTests: boolean;
-    };
-
-export type DBAdapterSchemaCreation = {
-  /**
-   * Code to be inserted into the file
-   */
-  code: string;
-  /**
-   * Path to the file, including the file name and extension.
-   * Relative paths are supported, with the current working directory of the developer's project as the base.
-   */
-  path: string;
-  /**
-   * Append the file if it already exists.
-   * Note: This will not apply if `overwrite` is set to true.
-   */
-  append?: boolean | undefined;
-  /**
-   * Overwrite the file if it already exists
-   */
-  overwrite?: boolean | undefined;
-};
-
-export interface DBAdapterFactoryConfig<
-  Options extends PayvoAuthOptions = PayvoAuthOptions,
-> {
-  /**
-   * Use plural table names.
-   *
-   * All tables will be named with an `s` at the end.
-   *
-   * @default false
-   */
-  usePlural?: boolean | undefined;
-  /**
-   * Enable debug logs.
-   *
-   * @default false
-   */
-  debugLogs?: DBAdapterDebugLogOption | undefined;
-  /**
-   * Name of the adapter.
-   *
-   * This is used to identify the adapter in the debug logs.
-   *
-   * @default `adapterId`
-   */
-  adapterName?: string | undefined;
-  /**
-   * Adapter id
-   */
-  adapterId: string;
-  /**
-   * If the database supports numeric ids, set this to `true`.
-   *
-   * @default true
-   */
-  supportsNumericIds?: boolean | undefined;
-  /**
-   * If the database doesn't support JSON columns, set this to `false`.
-   *
-   * We will handle the translation between using `JSON` columns, and saving `string`s to the database.
-   *
-   * @default false
-   */
-  supportsJSON?: boolean | undefined;
-  /**
-   * If the database doesn't support dates, set this to `false`.
-   *
-   * We will handle the translation between using `Date` objects, and saving `string`s to the database.
-   *
-   * @default true
-   */
-  supportsDates?: boolean | undefined;
-  /**
-   * If the database doesn't support booleans, set this to `false`.
-   *
-   * We will handle the translation between using `boolean`s, and saving `0`s and `1`s to the database.
-   *
-   * @default true
-   */
-  supportsBooleans?: boolean | undefined;
-  /**
-   * Execute multiple operations in a transaction.
-   *
-   * If the database doesn't support transactions, set this to `false` and operations will be executed sequentially.
-   *
-   * @default false
-   */
-  transaction?:
-    | (
-        | false
-        | (<R>(
-            callback: (trx: DBTransactionAdapter<Options>) => Promise<R>
-          ) => Promise<R>)
-      )
-    | undefined;
-  /**
-   * Disable id generation for the `create` method.
-   *
-   * This is useful for databases that don't support custom id values and would auto-generate them for you.
-   *
-   * @default false
-   */
-  disableIdGeneration?: boolean | undefined;
-  /**
-   * Map the keys of the input data.
-   *
-   * This is useful for databases that expect a different key name for a given situation.
-   *
-   * For example, MongoDB uses `_id` while in Better-Auth we use `id`.
-   *
-   *
-   * @example
-   * Each key represents the old key to replace.
-   * The value represents the new key
-   *
-   * This can be a partial object that only transforms some keys.
-   *
-   * ```ts
-   * mapKeysTransformInput: {
-   *  id: "_id" // We want to replace `id` to `_id` to save into MongoDB
-   * }
-   * ```
-   */
-  mapKeysTransformInput?: Record<string, string> | undefined;
-  /**
-   * Map the keys of the output data.
-   *
-   * This is useful for databases that expect a different key name for a given situation.
-   *
-   * For example, MongoDB uses `_id` while in Better-Auth we use `id`.
-   *
-   * @example
-   * Each key represents the old key to replace.
-   * The value represents the new key
-   *
-   * This can be a partial object that only transforms some keys.
-   *
-   * ```ts
-   * mapKeysTransformOutput: {
-   *  _id: "id" // In MongoDB, we save `id` as `_id`. So we want to replace `_id` with `id` when we get the data back.
-   * }
-   * ```
-   */
-  mapKeysTransformOutput?: Record<string, string> | undefined;
-  /**
-   * Custom transform input function.
-   *
-   * This function is used to transform the input data before it is saved to the database.
-   */
-  customTransformInput?:
-    | ((props: {
-        data: any;
-        /**
-         * The fields of the model.
-         */
-        fieldAttributes: DBFieldAttribute;
-        /**
-         * The field to transform.
-         */
-        field: string;
-        /**
-         * The action which was called from the adapter.
-         */
-        action: "create" | "update";
-        /**
-         * The model name.
-         */
-        model: string;
-        /**
-         * The schema of the user's Better-Auth instance.
-         */
-        schema: PayvoAuthDBSchema;
-        /**
-         * The options of the user's Better-Auth instance.
-         */
-        options: Options;
-      }) => any)
-    | undefined;
-  /**
-   * Custom transform output function.
-   *
-   * This function is used to transform the output data before it is returned to the user.
-   */
-  customTransformOutput?:
-    | ((props: {
-        data: any;
-        /**
-         * The fields of the model.
-         */
-        fieldAttributes: DBFieldAttribute;
-        /**
-         * The field to transform.
-         */
-        field: string;
-        /**
-         * The fields to select.
-         */
-        select: string[];
-        /**
-         * The model name.
-         */
-        model: string;
-        /**
-         * The schema of the user's Better-Auth instance.
-         */
-        schema: PayvoAuthDBSchema;
-        /**
-         * The options of the user's Better-Auth instance.
-         */
-        options: Options;
-      }) => any)
-    | undefined;
-  /**
-   * Custom ID generator function.
-   *
-   * By default, we can handle ID generation for you, however if the database your adapter is for only supports a specific custom id generation,
-   * then you can use this function to generate your own IDs.
-   *
-   *
-   * Notes:
-   * - If the user enabled `useNumberId`, then this option will be ignored. Unless this adapter config has `supportsNumericIds` set to `false`.
-   * - If `generateId` is `false` in the user's Better-Auth config, then this option will be ignored.
-   * - If `generateId` is a function, then it will override this option.
-   *
-   * @example
-   *
-   * ```ts
-   * customIdGenerator: ({ model }) => {
-   *  return "my-super-unique-id";
-   * }
-   * ```
-   */
-  customIdGenerator?: ((props: { model: string }) => string) | undefined;
-  /**
-   * Whether to disable the transform output.
-   * Do not use this option unless you know what you are doing.
-   * @default false
-   */
-  disableTransformOutput?: boolean | undefined;
-  /**
-   * Whether to disable the transform input.
-   * Do not use this option unless you know what you are doing.
-   * @default false
-   */
-  disableTransformInput?: boolean | undefined;
-}
-
-export type Where = {
-  /**
-   * @default eq
-   */
-  operator?:
-    | (
-        | "eq"
-        | "ne"
-        | "lt"
-        | "lte"
-        | "gt"
-        | "gte"
-        | "in"
-        | "not_in"
-        | "contains"
-        | "starts_with"
-        | "ends_with"
-      )
-    | undefined;
-  value: string | number | boolean | string[] | number[] | Date | null;
-  field: string;
-  /**
-   * @default AND
-   */
-  connector?: ("AND" | "OR") | undefined;
-};
-
-export type DBTransactionAdapter<
-  Options extends PayvoAuthOptions = PayvoAuthOptions,
-> = Omit<DBAdapter<Options>, "transaction">;
-
-export type DBAdapter<Options extends PayvoAuthOptions = PayvoAuthOptions> = {
-  id: string;
-  create: <T extends Record<string, any>, R = T>(data: {
-    model: string;
-    data: Omit<T, "id">;
-    select?: string[] | undefined;
-    /**
-     * By default, any `id` provided in `data` will be ignored.
-     *
-     * If you want to force the `id` to be the same as the `data.id`, set this to `true`.
-     */
-    forceAllowId?: boolean | undefined;
-  }) => Promise<R>;
-  findOne: <T>(data: {
-    model: string;
-    where: Where[];
-    select?: string[] | undefined;
-  }) => Promise<T | null>;
-  findMany: <T>(data: {
-    model: string;
-    where?: Where[] | undefined;
-    limit?: number | undefined;
-    sortBy?:
-      | {
-          field: string;
-          direction: "asc" | "desc";
-        }
-      | undefined;
-    offset?: number | undefined;
-  }) => Promise<T[]>;
-  count: (data: {
-    model: string;
-    where?: Where[] | undefined;
-  }) => Promise<number>;
-  /**
-   * ⚠︎ Update may not return the updated data
-   * if multiple where clauses are provided
-   */
-  update: <T>(data: {
-    model: string;
-    where: Where[];
-    update: Record<string, any>;
-  }) => Promise<T | null>;
-  updateMany: (data: {
-    model: string;
-    where: Where[];
-    update: Record<string, any>;
-  }) => Promise<number>;
-  delete: <T>(data: { model: string; where: Where[] }) => Promise<void>;
-  deleteMany: (data: { model: string; where: Where[] }) => Promise<number>;
-  /**
-   * Execute multiple operations in a transaction.
-   * If the adapter doesn't support transactions, operations will be executed sequentially.
-   */
-  transaction: <R>(
-    callback: (trx: DBTransactionAdapter<Options>) => Promise<R>
-  ) => Promise<R>;
-  /**
-   *
-   * @param options
-   * @param file - file path if provided by the user
-   */
-  createSchema?:
-    | ((options: Options, file?: string) => Promise<DBAdapterSchemaCreation>)
-    | undefined;
-  options?:
-    | ({
-        adapterConfig: DBAdapterFactoryConfig<Options>;
-      } & CustomAdapter["options"])
-    | undefined;
-};
-
-export type CleanedWhere = Required<Where>;
-
-export interface CustomAdapter {
-  create: <T extends Record<string, any>>({
-    data,
-    model,
-    select,
-  }: {
-    model: string;
-    data: T;
-    select?: string[] | undefined;
-  }) => Promise<T>;
-  update: <T>(data: {
-    model: string;
-    where: CleanedWhere[];
-    update: T;
-  }) => Promise<T | null>;
-  updateMany: (data: {
-    model: string;
-    where: CleanedWhere[];
-    update: Record<string, any>;
-  }) => Promise<number>;
-  findOne: <T>({
-    model,
-    where,
-    select,
-  }: {
-    model: string;
-    where: CleanedWhere[];
-    select?: string[] | undefined;
-  }) => Promise<T | null>;
-  findMany: <T>({
-    model,
-    where,
-    limit,
-    sortBy,
-    offset,
-  }: {
-    model: string;
-    where?: CleanedWhere[] | undefined;
-    limit: number;
-    sortBy?: { field: string; direction: "asc" | "desc" } | undefined;
-    offset?: number | undefined;
-  }) => Promise<T[]>;
-  delete: ({
-    model,
-    where,
-  }: {
-    model: string;
-    where: CleanedWhere[];
-  }) => Promise<void>;
-  deleteMany: ({
-    model,
-    where,
-  }: {
-    model: string;
-    where: CleanedWhere[];
-  }) => Promise<number>;
-  count: ({
-    model,
-    where,
-  }: {
-    model: string;
-    where?: CleanedWhere[] | undefined;
-  }) => Promise<number>;
-  createSchema?:
-    | ((props: {
-        /**
-         * The file the user may have passed in to the `generate` command as the expected schema file output path.
-         */
-        file?: string;
-        /**
-         * The tables from the user's Better-Auth instance schema.
-         */
-        tables: PayvoAuthDBSchema;
-      }) => Promise<DBAdapterSchemaCreation>)
-    | undefined;
-  /**
-   * Your adapter's options.
-   */
-  options?: Record<string, any> | undefined;
-}
-
-export interface DBAdapterInstance<
-  Options extends PayvoAuthOptions = PayvoAuthOptions,
-> {
-  (options: PayvoAuthOptions): DBAdapter<Options>;
-}

package/src/db/plugin.ts

@@ -1,11 +0,0 @@
-import type { DBFieldAttribute } from "./type";
-
-export type PayvoAuthPluginDBSchema = {
-  [table in string]: {
-    fields: {
-      [field: string]: DBFieldAttribute;
-    };
-    disableMigration?: boolean | undefined;
-    modelName?: string | undefined;
-  };
-};

package/src/db/schema/account.ts

@@ -1,34 +0,0 @@
-import * as z from "zod";
-import { coreSchema } from "./shared";
-
-export const accountSchema = coreSchema.extend({
-  providerId: z.string(),
-  accountId: z.string(),
-  userId: z.coerce.string(),
-  accessToken: z.string().nullish(),
-  refreshToken: z.string().nullish(),
-  idToken: z.string().nullish(),
-  /**
-   * Access token expires at
-   */
-  accessTokenExpiresAt: z.date().nullish(),
-  /**
-   * Refresh token expires at
-   */
-  refreshTokenExpiresAt: z.date().nullish(),
-  /**
-   * The scopes that the user has authorized
-   */
-  scope: z.string().nullish(),
-  /**
-   * Password is only stored in the credential provider
-   */
-  password: z.string().nullish(),
-});
-
-/**
- * Account schema type used by payvo-auth, note that it's possible that account could have additional fields
- *
- * todo: we should use generics to extend this type with additional fields from plugins and options in the future
- */
-export type Account = z.infer<typeof accountSchema>;

package/src/db/schema/rate-limit.ts

@@ -1,21 +0,0 @@
-import * as z from "zod";
-
-export const rateLimitSchema = z.object({
-  /**
-   * The key to use for rate limiting
-   */
-  key: z.string(),
-  /**
-   * The number of requests made
-   */
-  count: z.number(),
-  /**
-   * The last request time in milliseconds
-   */
-  lastRequest: z.number(),
-});
-
-/**
- * Rate limit schema type used by payvo-auth for rate limiting
- */
-export type RateLimit = z.infer<typeof rateLimitSchema>;

package/src/db/schema/session.ts

@@ -1,17 +0,0 @@
-import * as z from "zod";
-import { coreSchema } from "./shared";
-
-export const sessionSchema = coreSchema.extend({
-  userId: z.coerce.string(),
-  expiresAt: z.date(),
-  token: z.string(),
-  ipAddress: z.string().nullish(),
-  userAgent: z.string().nullish(),
-});
-
-/**
- * Session schema type used by payvo-auth, note that it's possible that session could have additional fields
- *
- * todo: we should use generics to extend this type with additional fields from plugins and options in the future
- */
-export type Session = z.infer<typeof sessionSchema>;

package/src/db/schema/shared.ts

@@ -1,7 +0,0 @@
-import * as z from "zod";
-
-export const coreSchema = z.object({
-	id: z.string(),
-	createdAt: z.date().default(() => new Date()),
-	updatedAt: z.date().default(() => new Date()),
-});

package/src/db/schema/user.ts

@@ -1,16 +0,0 @@
-import * as z from "zod";
-import { coreSchema } from "./shared";
-
-export const userSchema = coreSchema.extend({
-  email: z.string().transform((val) => val.toLowerCase()),
-  emailVerified: z.boolean().default(false),
-  name: z.string(),
-  image: z.string().nullish(),
-});
-
-/**
- * User schema type used by payvo-auth, note that it's possible that user could have additional fields
- *
- * todo: we should use generics to extend this type with additional fields from plugins and options in the future
- */
-export type User = z.infer<typeof userSchema>;