@better-auth/api-key 1.5.0 → 1.5.1-beta.2

package/dist/types.d.mts

@@ -1,358 +1,2 @@
-import { t as apiKeySchema } from "./schema-D2f7--fy.mjs";
-import { Statements } from "better-auth/plugins/access";
-import { Awaitable, GenericEndpointContext, HookEndpointContext, LiteralString } from "@better-auth/core";
-import { InferOptionSchema } from "better-auth/types";
-
-//#region src/types.d.ts
-interface ApiKeyOptions {
-  schema?: InferOptionSchema<ReturnType<typeof apiKeySchema>> | undefined;
-}
-interface ApiKeyConfigurationOptions {
-  /**
-   * The name for this set of API key configurations. Must be unique across different configurations.
-   */
-  configId?: LiteralString | undefined;
-  /**
-   * 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;
-  }) => Awaitable<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;
-  }) => Awaitable<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;
-  /**
-   * 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 | ((referenceId: string, ctx: GenericEndpointContext) => Awaitable<Statements>);
-  } | undefined;
-  /**
-   * Storage backend for API keys.
-   *
-   * - `"database"`: Store API keys in the database adapter (default)
-   * - `"secondary-storage"`: Store API keys in the configured secondary storage (e.g., Redis)
-   *
-   * @default "database"
-   */
-  storage?: "database" | "secondary-storage" | undefined;
-  /**
-   * When `storage` is `"secondary-storage"`, enable fallback to database if key is not found in secondary storage.
-   *
-   * Useful for gradual migration from database to secondary storage.
-   *
-   * @default false
-   */
-  fallbackToDatabase?: boolean | undefined;
-  /**
-   * Custom storage methods for API keys.
-   *
-   * If provided, these methods will be used instead of `ctx.context.secondaryStorage`.
-   * Custom methods take precedence over global secondary storage.
-   *
-   * Useful when you want to use a different storage backend specifically for API keys,
-   * or when you need custom logic for storage operations.
-   */
-  customStorage?: {
-    /**
-     * Get a value from storage
-     */
-    get: (key: string) => Awaitable<unknown>;
-    /**
-     * Set a value in storage
-     */
-    set: (key: string, value: string, ttl?: number | undefined) => Awaitable<void | null | unknown>;
-    /**
-     * Delete a value from storage
-     */
-    delete: (key: string) => Awaitable<void | null | string>;
-  } | undefined;
-  /**
-   * Defer non-critical updates (rate limiting counters, timestamps, remaining count)
-   * to run after the response is sent using the global `advanced.backgroundTasks` handler.
-   *
-   * Requires `advanced.backgroundTasks.handler` to be configured in the main auth options.
-   *
-   * ⚠️ Warning: Enabling this introduces eventual consistency where the response
-   * returns optimistic data before the database is updated. If the deferred update
-   * fails, the database will have stale values. Only enable if your application
-   * can tolerate this trade-off for improved latency.
-   *
-   * @default false
-   */
-  deferUpdates?: boolean | undefined;
-  /**
-   * What the API key references. This determines ownership over the API key.
-   *
-   * @default "user"
-   */
-  references?: "user" | "organization" | undefined;
-}
-type ApiKey = {
-  /**
-   * ID
-   */
-  id: string;
-  /**
-   * The configuration ID this key belongs to.
-   * Use this to look up the configuration to determine the reference type (user vs organization).
-   */
-  configId: 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 ID of the entity that owns this key (userId or organizationId based on config's `references` setting)
-   */
-  referenceId: 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;
-};
-//#endregion
-export { ApiKey, ApiKeyConfigurationOptions, ApiKeyOptions };
-//# sourceMappingURL=types.d.mts.map
+import { n as ApiKeyConfigurationOptions, r as ApiKeyOptions, t as ApiKey } from "./types-CCe5L05Y.mjs";
+export { ApiKey, ApiKeyConfigurationOptions, ApiKeyOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-auth/api-key",
-  "version": "1.5.0",
+  "version": "1.5.1-beta.2",
   "description": "API Key plugin for Better Auth.",
   "type": "module",
   "license": "MIT",
@@ -59,14 +59,14 @@
     "zod": "^4.3.6"
   },
   "devDependencies": {
-    "tsdown": "^0.20.3",
-    "@better-auth/core": "1.5.0",
-    "better-auth": "1.5.0"
+    "tsdown": "0.21.0-beta.2",
+    "@better-auth/core": "1.5.1-beta.2",
+    "better-auth": "1.5.1-beta.2"
   },
   "peerDependencies": {
     "@better-auth/utils": "0.3.1",
-    "@better-auth/core": "1.5.0",
-    "better-auth": "1.5.0"
+    "@better-auth/core": "1.5.1-beta.2",
+    "better-auth": "1.5.1-beta.2"
   },
   "scripts": {
     "build": "tsdown",

package/dist/error-codes-xCoIeQ-k.d.mts

@@ -1,50 +0,0 @@
-import { ApiKeyConfigurationOptions } from "./types.mjs";
-import * as better_auth0 from "better-auth";
-import "zod";
-import "better-call";
-import { Awaitable } from "@better-auth/core";
-
-//#region src/routes/index.d.ts
-type PredefinedApiKeyOptions = ApiKeyConfigurationOptions & Required<Pick<ApiKeyConfigurationOptions, "apiKeyHeaders" | "defaultKeyLength" | "keyExpiration" | "rateLimit" | "maximumPrefixLength" | "minimumPrefixLength" | "maximumNameLength" | "disableKeyHashing" | "minimumNameLength" | "requireName" | "enableMetadata" | "enableSessionForAPIKeys" | "startingCharactersConfig" | "storage" | "fallbackToDatabase" | "deferUpdates">> & {
-  keyExpiration: Required<NonNullable<ApiKeyConfigurationOptions["keyExpiration"]>>;
-  startingCharactersConfig: Required<NonNullable<ApiKeyConfigurationOptions["startingCharactersConfig"]>>;
-  rateLimit: Required<NonNullable<ApiKeyConfigurationOptions["rateLimit"]>>;
-};
-//#endregion
-//#region src/error-codes.d.ts
-declare const API_KEY_ERROR_CODES: {
-  INVALID_METADATA_TYPE: better_auth0.RawError<"INVALID_METADATA_TYPE">;
-  REFILL_AMOUNT_AND_INTERVAL_REQUIRED: better_auth0.RawError<"REFILL_AMOUNT_AND_INTERVAL_REQUIRED">;
-  REFILL_INTERVAL_AND_AMOUNT_REQUIRED: better_auth0.RawError<"REFILL_INTERVAL_AND_AMOUNT_REQUIRED">;
-  USER_BANNED: better_auth0.RawError<"USER_BANNED">;
-  UNAUTHORIZED_SESSION: better_auth0.RawError<"UNAUTHORIZED_SESSION">;
-  KEY_NOT_FOUND: better_auth0.RawError<"KEY_NOT_FOUND">;
-  KEY_DISABLED: better_auth0.RawError<"KEY_DISABLED">;
-  KEY_EXPIRED: better_auth0.RawError<"KEY_EXPIRED">;
-  USAGE_EXCEEDED: better_auth0.RawError<"USAGE_EXCEEDED">;
-  KEY_NOT_RECOVERABLE: better_auth0.RawError<"KEY_NOT_RECOVERABLE">;
-  EXPIRES_IN_IS_TOO_SMALL: better_auth0.RawError<"EXPIRES_IN_IS_TOO_SMALL">;
-  EXPIRES_IN_IS_TOO_LARGE: better_auth0.RawError<"EXPIRES_IN_IS_TOO_LARGE">;
-  INVALID_REMAINING: better_auth0.RawError<"INVALID_REMAINING">;
-  INVALID_PREFIX_LENGTH: better_auth0.RawError<"INVALID_PREFIX_LENGTH">;
-  INVALID_NAME_LENGTH: better_auth0.RawError<"INVALID_NAME_LENGTH">;
-  METADATA_DISABLED: better_auth0.RawError<"METADATA_DISABLED">;
-  RATE_LIMIT_EXCEEDED: better_auth0.RawError<"RATE_LIMIT_EXCEEDED">;
-  NO_VALUES_TO_UPDATE: better_auth0.RawError<"NO_VALUES_TO_UPDATE">;
-  KEY_DISABLED_EXPIRATION: better_auth0.RawError<"KEY_DISABLED_EXPIRATION">;
-  INVALID_API_KEY: better_auth0.RawError<"INVALID_API_KEY">;
-  INVALID_USER_ID_FROM_API_KEY: better_auth0.RawError<"INVALID_USER_ID_FROM_API_KEY">;
-  INVALID_REFERENCE_ID_FROM_API_KEY: better_auth0.RawError<"INVALID_REFERENCE_ID_FROM_API_KEY">;
-  INVALID_API_KEY_GETTER_RETURN_TYPE: better_auth0.RawError<"INVALID_API_KEY_GETTER_RETURN_TYPE">;
-  SERVER_ONLY_PROPERTY: better_auth0.RawError<"SERVER_ONLY_PROPERTY">;
-  FAILED_TO_UPDATE_API_KEY: better_auth0.RawError<"FAILED_TO_UPDATE_API_KEY">;
-  NAME_REQUIRED: better_auth0.RawError<"NAME_REQUIRED">;
-  ORGANIZATION_ID_REQUIRED: better_auth0.RawError<"ORGANIZATION_ID_REQUIRED">;
-  USER_NOT_MEMBER_OF_ORGANIZATION: better_auth0.RawError<"USER_NOT_MEMBER_OF_ORGANIZATION">;
-  INSUFFICIENT_API_KEY_PERMISSIONS: better_auth0.RawError<"INSUFFICIENT_API_KEY_PERMISSIONS">;
-  NO_DEFAULT_API_KEY_CONFIGURATION_FOUND: better_auth0.RawError<"NO_DEFAULT_API_KEY_CONFIGURATION_FOUND">;
-  ORGANIZATION_PLUGIN_REQUIRED: better_auth0.RawError<"ORGANIZATION_PLUGIN_REQUIRED">;
-};
-//#endregion
-export { PredefinedApiKeyOptions as n, API_KEY_ERROR_CODES as t };
-//# sourceMappingURL=error-codes-xCoIeQ-k.d.mts.map

package/dist/schema-D2f7--fy.d.mts

@@ -1,201 +0,0 @@
-import * as better_auth0 from "better-auth";
-
-//#region src/schema.d.ts
-declare const apiKeySchema: ({
-  defaultRateLimitMax,
-  defaultTimeWindow
-}: {
-  defaultTimeWindow: number;
-  defaultRateLimitMax: number;
-}) => {
-  apikey: {
-    fields: {
-      configId: {
-        type: "string";
-        required: true;
-        defaultValue: string;
-        input: false;
-        index: true;
-      };
-      /**
-       * 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 ID of the entity that owns this key (userId or organizationId based on config's `references` setting).
-       */
-      referenceId: {
-        type: "string";
-        required: true;
-        input: false;
-        index: true;
-      };
-      /**
-       * The prefix of the key.
-       */
-      prefix: {
-        type: "string";
-        required: false;
-        input: false;
-      };
-      /**
-       * The hashed key value.
-       */
-      key: {
-        type: "string";
-        required: true;
-        input: false;
-        index: true;
-      };
-      /**
-       * 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: better_auth0.DBPrimitive): string;
-          output(value: better_auth0.DBPrimitive): any;
-        };
-      };
-    };
-  };
-};
-//#endregion
-export { apiKeySchema as t };
-//# sourceMappingURL=schema-D2f7--fy.d.mts.map