better-auth 1.2.6-beta.7 → 1.2.7-beta.1

package/dist/plugins/index.cjs

@@ -1,14 +1,14 @@
 'use strict';
 
-const organization = require('../shared/better-auth.CV1L7TPV.cjs');
+const organization = require('../shared/better-auth.D_ZIX1O8.cjs');
 const plugins_twoFactor_index = require('./two-factor/index.cjs');
 const plugins_username_index = require('./username/index.cjs');
 const plugins_bearer_index = require('./bearer/index.cjs');
-const refreshToken = require('../shared/better-auth.BDYXUcLv.cjs');
+const refreshToken = require('../shared/better-auth.Dg0siV5C.cjs');
 const plugins_magicLink_index = require('./magic-link/index.cjs');
 const plugins_phoneNumber_index = require('./phone-number/index.cjs');
 const plugins_anonymous_index = require('./anonymous/index.cjs');
-const admin = require('../shared/better-auth.CsSpq0zL.cjs');
+const admin = require('../shared/better-auth.CHUzBidy.cjs');
 const plugins_genericOauth_index = require('./generic-oauth/index.cjs');
 const plugins_jwt_index = require('./jwt/index.cjs');
 const plugins_multiSession_index = require('./multi-session/index.cjs');
@@ -26,9 +26,9 @@ const zod = require('zod');
 const date = require('../shared/better-auth.C1hdVENX.cjs');
 require('../shared/better-auth.DiSjtgs9.cjs');
 require('@better-auth/utils/hmac');
-const schema = require('../shared/better-auth.C5H9XEzZ.cjs');
+const schema = require('../shared/better-auth.DcWKCjjf.cjs');
 require('../shared/better-auth.GpOOav9x.cjs');
-const getRequestIp = require('../shared/better-auth.BSsp73pg.cjs');
+const getRequestIp = require('../shared/better-auth.B7cZ2juS.cjs');
 require('defu');
 require('@better-auth/utils/random');
 require('@noble/ciphers/chacha');
@@ -43,19 +43,19 @@ require('../shared/better-auth.CYeOI8C-.cjs');
 require('kysely');
 const parser = require('../shared/better-auth.DhsGZ30Q.cjs');
 const json = require('../shared/better-auth.D3mtHEZg.cjs');
-const id = require('../shared/better-auth.Bg6iw3ig.cjs');
 const plugins_access_index = require('./access/index.cjs');
-const errorCode = require('../shared/better-auth.C1-vpKly.cjs');
+const plugins_haveibeenpwned_index = require('./haveibeenpwned/index.cjs');
+const plugins_oneTimeToken_index = require('./one-time-token/index.cjs');
 const client = require('../shared/better-auth.DnER2-iT.cjs');
 require('../shared/better-auth.ANpbi45u.cjs');
-require('../shared/better-auth.DLTzKoOS.cjs');
+require('../shared/better-auth.DSVbLSt7.cjs');
 require('./organization/access/index.cjs');
 require('../cookies/index.cjs');
 require('../shared/better-auth.C-R0J0n1.cjs');
+require('../shared/better-auth.Bg6iw3ig.cjs');
 require('../crypto/index.cjs');
 require('../shared/better-auth.YUF6P-PB.cjs');
 require('../shared/better-auth.BMYo0QR-.cjs');
-require('../shared/better-auth.m575EIBC.cjs');
 require('@better-auth/utils/otp');
 require('../shared/better-auth.CDXNofOe.cjs');
 require('../social-providers/index.cjs');
@@ -65,7 +65,7 @@ require('../shared/better-auth.QbbyHMYf.cjs');
 require('jose/errors');
 require('@better-auth/utils/binary');
 require('../shared/better-auth.DNqtHmvg.cjs');
-require('../shared/better-auth.CApEjVDP.cjs');
+require('../shared/better-auth.BW8BpneG.cjs');
 require('./admin/access/index.cjs');
 require('../shared/better-auth.BG6vHVNT.cjs');
 require('../api/index.cjs');
@@ -303,7 +303,143 @@ function createApiKey({
           description: "Whether the key has rate limiting enabled. Server Only Property."
         }).optional(),
         permissions: zod.z.record(zod.z.string(), zod.z.array(zod.z.string())).optional()
-      })
+      }),
+      metadata: {
+        openapi: {
+          description: "Create a new API key for a user",
+          responses: {
+            "200": {
+              description: "API key created successfully",
+              content: {
+                "application/json": {
+                  schema: {
+                    type: "object",
+                    properties: {
+                      id: {
+                        type: "string",
+                        description: "Unique identifier of the API key"
+                      },
+                      createdAt: {
+                        type: "string",
+                        format: "date-time",
+                        description: "Creation timestamp"
+                      },
+                      updatedAt: {
+                        type: "string",
+                        format: "date-time",
+                        description: "Last update timestamp"
+                      },
+                      name: {
+                        type: "string",
+                        nullable: true,
+                        description: "Name of the API key"
+                      },
+                      prefix: {
+                        type: "string",
+                        nullable: true,
+                        description: "Prefix of the API key"
+                      },
+                      start: {
+                        type: "string",
+                        nullable: true,
+                        description: "Starting characters of the key (if configured)"
+                      },
+                      key: {
+                        type: "string",
+                        description: "The full API key (only returned on creation)"
+                      },
+                      enabled: {
+                        type: "boolean",
+                        description: "Whether the key is enabled"
+                      },
+                      expiresAt: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "Expiration timestamp"
+                      },
+                      userId: {
+                        type: "string",
+                        description: "ID of the user owning the key"
+                      },
+                      lastRefillAt: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "Last refill timestamp"
+                      },
+                      lastRequest: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "Last request timestamp"
+                      },
+                      metadata: {
+                        type: "object",
+                        nullable: true,
+                        additionalProperties: true,
+                        description: "Metadata associated with the key"
+                      },
+                      rateLimitMax: {
+                        type: "number",
+                        nullable: true,
+                        description: "Maximum requests in time window"
+                      },
+                      rateLimitTimeWindow: {
+                        type: "number",
+                        nullable: true,
+                        description: "Rate limit time window in milliseconds"
+                      },
+                      remaining: {
+                        type: "number",
+                        nullable: true,
+                        description: "Remaining requests"
+                      },
+                      refillAmount: {
+                        type: "number",
+                        nullable: true,
+                        description: "Amount to refill"
+                      },
+                      refillInterval: {
+                        type: "number",
+                        nullable: true,
+                        description: "Refill interval in milliseconds"
+                      },
+                      rateLimitEnabled: {
+                        type: "boolean",
+                        description: "Whether rate limiting is enabled"
+                      },
+                      requestCount: {
+                        type: "number",
+                        description: "Current request count in window"
+                      },
+                      permissions: {
+                        type: "object",
+                        nullable: true,
+                        additionalProperties: {
+                          type: "array",
+                          items: { type: "string" }
+                        },
+                        description: "Permissions associated with the key"
+                      }
+                    },
+                    required: [
+                      "id",
+                      "createdAt",
+                      "updatedAt",
+                      "key",
+                      "enabled",
+                      "userId",
+                      "rateLimitEnabled",
+                      "requestCount"
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     },
     async (ctx) => {
       const {
@@ -416,7 +552,6 @@ function createApiKey({
       const defaultPermissions = opts.permissions?.defaultPermissions ? typeof opts.permissions.defaultPermissions === "function" ? await opts.permissions.defaultPermissions(user.id, ctx) : opts.permissions.defaultPermissions : void 0;
       const permissionsToApply = permissions ? JSON.stringify(permissions) : defaultPermissions ? JSON.stringify(defaultPermissions) : void 0;
       let data = {
-        id: id.generateId(),
         createdAt: /* @__PURE__ */ new Date(),
         updatedAt: /* @__PURE__ */ new Date(),
         name: name ?? null,
@@ -434,7 +569,7 @@ function createApiKey({
         remaining: remaining || refillAmount || null,
         refillAmount: refillAmount ?? null,
         refillInterval: refillInterval ?? null,
-        rateLimitEnabled: rateLimitEnabled ?? true,
+        rateLimitEnabled: rateLimitEnabled ?? opts.rateLimit.enabled === void 0 ? true : opts.rateLimit.enabled,
         requestCount: 0,
         //@ts-ignore - we intentionally save the permissions as string on DB.
         permissions: permissionsToApply
@@ -473,7 +608,47 @@ function deleteApiKey({
           description: "The id of the Api Key"
         })
       }),
-      use: [refreshToken.sessionMiddleware]
+      use: [refreshToken.sessionMiddleware],
+      metadata: {
+        openapi: {
+          description: "Delete an existing API key",
+          requestBody: {
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    keyId: {
+                      type: "string",
+                      description: "The id of the API key to delete"
+                    }
+                  },
+                  required: ["keyId"]
+                }
+              }
+            }
+          },
+          responses: {
+            "200": {
+              description: "API key deleted successfully",
+              content: {
+                "application/json": {
+                  schema: {
+                    type: "object",
+                    properties: {
+                      success: {
+                        type: "boolean",
+                        description: "Indicates if the API key was successfully deleted"
+                      }
+                    },
+                    required: ["success"]
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     },
     async (ctx) => {
       const { keyId } = ctx.body;
@@ -534,7 +709,135 @@ function getApiKey({
           description: "The id of the Api Key"
         })
       }),
-      use: [refreshToken.sessionMiddleware]
+      use: [refreshToken.sessionMiddleware],
+      metadata: {
+        openapi: {
+          description: "Retrieve an existing API key by ID",
+          responses: {
+            "200": {
+              description: "API key retrieved successfully",
+              content: {
+                "application/json": {
+                  schema: {
+                    type: "object",
+                    properties: {
+                      id: {
+                        type: "string",
+                        description: "ID"
+                      },
+                      name: {
+                        type: "string",
+                        nullable: true,
+                        description: "The name of the key"
+                      },
+                      start: {
+                        type: "string",
+                        nullable: true,
+                        description: "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."
+                      },
+                      prefix: {
+                        type: "string",
+                        nullable: true,
+                        description: "The API Key prefix. Stored as plain text."
+                      },
+                      userId: {
+                        type: "string",
+                        description: "The owner of the user id"
+                      },
+                      refillInterval: {
+                        type: "number",
+                        nullable: true,
+                        description: "The interval in which the `remaining` count is refilled by day. Example: 1 // every day"
+                      },
+                      refillAmount: {
+                        type: "number",
+                        nullable: true,
+                        description: "The amount to refill"
+                      },
+                      lastRefillAt: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "The last refill date"
+                      },
+                      enabled: {
+                        type: "boolean",
+                        description: "Sets if key is enabled or disabled",
+                        default: true
+                      },
+                      rateLimitEnabled: {
+                        type: "boolean",
+                        description: "Whether the key has rate limiting enabled"
+                      },
+                      rateLimitTimeWindow: {
+                        type: "number",
+                        nullable: true,
+                        description: "The duration in milliseconds"
+                      },
+                      rateLimitMax: {
+                        type: "number",
+                        nullable: true,
+                        description: "Maximum amount of requests allowed within a window"
+                      },
+                      requestCount: {
+                        type: "number",
+                        description: "The number of requests made within the rate limit time window"
+                      },
+                      remaining: {
+                        type: "number",
+                        nullable: true,
+                        description: "Remaining requests (every time api key is used this should updated and should be updated on refill as well)"
+                      },
+                      lastRequest: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "When last request occurred"
+                      },
+                      expiresAt: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "Expiry date of a key"
+                      },
+                      createdAt: {
+                        type: "string",
+                        format: "date-time",
+                        description: "created at"
+                      },
+                      updatedAt: {
+                        type: "string",
+                        format: "date-time",
+                        description: "updated at"
+                      },
+                      metadata: {
+                        type: "object",
+                        nullable: true,
+                        additionalProperties: true,
+                        description: "Extra metadata about the apiKey"
+                      },
+                      permissions: {
+                        type: "string",
+                        nullable: true,
+                        description: "Permissions for the api key (stored as JSON string)"
+                      }
+                    },
+                    required: [
+                      "id",
+                      "userId",
+                      "enabled",
+                      "rateLimitEnabled",
+                      "requestCount",
+                      "createdAt",
+                      "updatedAt"
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     },
     async (ctx) => {
       const { id } = ctx.query;
@@ -618,7 +921,135 @@ function updateApiKey({
           description: "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."
         }).optional(),
         permissions: zod.z.record(zod.z.string(), zod.z.array(zod.z.string())).optional().nullable()
-      })
+      }),
+      metadata: {
+        openapi: {
+          description: "Retrieve an existing API key by ID",
+          responses: {
+            "200": {
+              description: "API key retrieved successfully",
+              content: {
+                "application/json": {
+                  schema: {
+                    type: "object",
+                    properties: {
+                      id: {
+                        type: "string",
+                        description: "ID"
+                      },
+                      name: {
+                        type: "string",
+                        nullable: true,
+                        description: "The name of the key"
+                      },
+                      start: {
+                        type: "string",
+                        nullable: true,
+                        description: "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."
+                      },
+                      prefix: {
+                        type: "string",
+                        nullable: true,
+                        description: "The API Key prefix. Stored as plain text."
+                      },
+                      userId: {
+                        type: "string",
+                        description: "The owner of the user id"
+                      },
+                      refillInterval: {
+                        type: "number",
+                        nullable: true,
+                        description: "The interval in which the `remaining` count is refilled by day. Example: 1 // every day"
+                      },
+                      refillAmount: {
+                        type: "number",
+                        nullable: true,
+                        description: "The amount to refill"
+                      },
+                      lastRefillAt: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "The last refill date"
+                      },
+                      enabled: {
+                        type: "boolean",
+                        description: "Sets if key is enabled or disabled",
+                        default: true
+                      },
+                      rateLimitEnabled: {
+                        type: "boolean",
+                        description: "Whether the key has rate limiting enabled"
+                      },
+                      rateLimitTimeWindow: {
+                        type: "number",
+                        nullable: true,
+                        description: "The duration in milliseconds"
+                      },
+                      rateLimitMax: {
+                        type: "number",
+                        nullable: true,
+                        description: "Maximum amount of requests allowed within a window"
+                      },
+                      requestCount: {
+                        type: "number",
+                        description: "The number of requests made within the rate limit time window"
+                      },
+                      remaining: {
+                        type: "number",
+                        nullable: true,
+                        description: "Remaining requests (every time api key is used this should updated and should be updated on refill as well)"
+                      },
+                      lastRequest: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "When last request occurred"
+                      },
+                      expiresAt: {
+                        type: "string",
+                        format: "date-time",
+                        nullable: true,
+                        description: "Expiry date of a key"
+                      },
+                      createdAt: {
+                        type: "string",
+                        format: "date-time",
+                        description: "created at"
+                      },
+                      updatedAt: {
+                        type: "string",
+                        format: "date-time",
+                        description: "updated at"
+                      },
+                      metadata: {
+                        type: "object",
+                        nullable: true,
+                        additionalProperties: true,
+                        description: "Extra metadata about the apiKey"
+                      },
+                      permissions: {
+                        type: "string",
+                        nullable: true,
+                        description: "Permissions for the api key (stored as JSON string)"
+                      }
+                    },
+                    required: [
+                      "id",
+                      "userId",
+                      "enabled",
+                      "rateLimitEnabled",
+                      "requestCount",
+                      "createdAt",
+                      "updatedAt"
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     },
     async (ctx) => {
       const {
@@ -1096,7 +1527,138 @@ function listApiKeys({
     "/api-key/list",
     {
       method: "GET",
-      use: [refreshToken.sessionMiddleware]
+      use: [refreshToken.sessionMiddleware],
+      metadata: {
+        openapi: {
+          description: "List all API keys for the authenticated user",
+          responses: {
+            "200": {
+              description: "API keys retrieved successfully",
+              content: {
+                "application/json": {
+                  schema: {
+                    type: "array",
+                    items: {
+                      type: "object",
+                      properties: {
+                        id: {
+                          type: "string",
+                          description: "ID"
+                        },
+                        name: {
+                          type: "string",
+                          nullable: true,
+                          description: "The name of the key"
+                        },
+                        start: {
+                          type: "string",
+                          nullable: true,
+                          description: "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."
+                        },
+                        prefix: {
+                          type: "string",
+                          nullable: true,
+                          description: "The API Key prefix. Stored as plain text."
+                        },
+                        userId: {
+                          type: "string",
+                          description: "The owner of the user id"
+                        },
+                        refillInterval: {
+                          type: "number",
+                          nullable: true,
+                          description: "The interval in which the `remaining` count is refilled by day. Example: 1 // every day"
+                        },
+                        refillAmount: {
+                          type: "number",
+                          nullable: true,
+                          description: "The amount to refill"
+                        },
+                        lastRefillAt: {
+                          type: "string",
+                          format: "date-time",
+                          nullable: true,
+                          description: "The last refill date"
+                        },
+                        enabled: {
+                          type: "boolean",
+                          description: "Sets if key is enabled or disabled",
+                          default: true
+                        },
+                        rateLimitEnabled: {
+                          type: "boolean",
+                          description: "Whether the key has rate limiting enabled"
+                        },
+                        rateLimitTimeWindow: {
+                          type: "number",
+                          nullable: true,
+                          description: "The duration in milliseconds"
+                        },
+                        rateLimitMax: {
+                          type: "number",
+                          nullable: true,
+                          description: "Maximum amount of requests allowed within a window"
+                        },
+                        requestCount: {
+                          type: "number",
+                          description: "The number of requests made within the rate limit time window"
+                        },
+                        remaining: {
+                          type: "number",
+                          nullable: true,
+                          description: "Remaining requests (every time api key is used this should updated and should be updated on refill as well)"
+                        },
+                        lastRequest: {
+                          type: "string",
+                          format: "date-time",
+                          nullable: true,
+                          description: "When last request occurred"
+                        },
+                        expiresAt: {
+                          type: "string",
+                          format: "date-time",
+                          nullable: true,
+                          description: "Expiry date of a key"
+                        },
+                        createdAt: {
+                          type: "string",
+                          format: "date-time",
+                          description: "created at"
+                        },
+                        updatedAt: {
+                          type: "string",
+                          format: "date-time",
+                          description: "updated at"
+                        },
+                        metadata: {
+                          type: "object",
+                          nullable: true,
+                          additionalProperties: true,
+                          description: "Extra metadata about the apiKey"
+                        },
+                        permissions: {
+                          type: "string",
+                          nullable: true,
+                          description: "Permissions for the api key (stored as JSON string)"
+                        }
+                      },
+                      required: [
+                        "id",
+                        "userId",
+                        "enabled",
+                        "rateLimitEnabled",
+                        "requestCount",
+                        "createdAt",
+                        "updatedAt"
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     },
     async (ctx) => {
       const session = ctx.context.session;
@@ -1246,7 +1808,7 @@ const apiKey = (options) => {
     minimumNameLength: options?.minimumNameLength ?? 1,
     enableMetadata: options?.enableMetadata ?? false,
     rateLimit: {
-      enabled: options?.rateLimit?.enabled ?? true,
+      enabled: options?.rateLimit?.enabled === void 0 ? true : options?.rateLimit?.enabled,
       timeWindow: options?.rateLimit?.timeWindow ?? 1e3 * 60 * 60 * 24,
       maxRequests: options?.rateLimit?.maxRequests ?? 10
     },
@@ -1392,6 +1954,7 @@ const apiKey = (options) => {
 
 exports.organization = organization.organization;
 exports.parseRoles = organization.parseRoles;
+exports.TWO_FACTOR_ERROR_CODES = plugins_twoFactor_index.TWO_FACTOR_ERROR_CODES;
 exports.twoFactor = plugins_twoFactor_index.twoFactor;
 exports.username = plugins_username_index.username;
 exports.bearer = plugins_bearer_index.bearer;
@@ -1414,7 +1977,8 @@ exports.customSession = plugins_customSession_index.customSession;
 exports.openAPI = plugins_openApi_index.openAPI;
 exports.oidcProvider = plugins_oidcProvider_index.oidcProvider;
 exports.captcha = plugins_captcha_index.captcha;
-exports.TWO_FACTOR_ERROR_CODES = errorCode.TWO_FACTOR_ERROR_CODES;
+exports.haveIBeenPwned = plugins_haveibeenpwned_index.haveIBeenPwned;
+exports.oneTimeToken = plugins_oneTimeToken_index.oneTimeToken;
 exports.twoFactorClient = client.twoFactorClient;
 exports.ERROR_CODES = ERROR_CODES;
 exports.apiKey = apiKey;