@supabase/server 0.1.0-alpha.1 → 0.1.1-rc.25

package/dist/types-ClmJ8pi8.d.mts

@@ -0,0 +1,227 @@
+import { SupabaseClient } from "@supabase/supabase-js";
+
+//#region src/types.d.ts
+/**
+ * Authentication mode that determines what credentials a request must provide.
+ *
+ * - `"always"` — No credentials required. Every request is accepted.
+ * - `"public"` — Requires a valid publishable key in the `apikey` header.
+ * - `"secret"` — Requires a valid secret key in the `apikey` header (timing-safe comparison).
+ * - `"user"` — Requires a valid JWT in the `Authorization: Bearer <token>` header.
+ *
+ * @example
+ * ```ts
+ * // Single mode
+ * withSupabase({ allow: 'user' }, handler)
+ *
+ * // Multiple modes — the first match wins
+ * withSupabase({ allow: ['user', 'public'] }, handler)
+ * ```
+ */
+type Allow = 'always' | 'public' | 'secret' | 'user';
+/**
+ * Extended auth mode that supports targeting a specific named key.
+ *
+ * Use the colon syntax (`"public:web_app"`) to require a specific named key
+ * from the `SUPABASE_PUBLISHABLE_KEYS` or `SUPABASE_SECRET_KEYS` JSON object.
+ * Use `"public:*"` or `"secret:*"` to accept any key in the set.
+ *
+ * @example
+ * ```ts
+ * // Accept only the "mobile" publishable key
+ * withSupabase({ allow: 'public:mobile' }, handler)
+ *
+ * // Accept any secret key
+ * withSupabase({ allow: 'secret:*' }, handler)
+ *
+ * // Mix named keys with other modes
+ * withSupabase({ allow: ['user', 'public:web_app'] }, handler)
+ * ```
+ */
+type AllowWithKey = Allow | `public:${string}` | `secret:${string}`;
+/**
+ * Resolved Supabase environment configuration.
+ *
+ * Holds the project URL, API keys, and JWKS needed by every other primitive.
+ * Typically resolved automatically from environment variables by {@link resolveEnv},
+ * but can be passed explicitly via the `env` option.
+ *
+ * @see {@link resolveEnv} for how each field maps to environment variables.
+ */
+interface SupabaseEnv {
+  /** Supabase project URL (e.g. `"https://<ref>.supabase.co"`). Sourced from `SUPABASE_URL`. */
+  url: string;
+  /**
+   * Named publishable (anon) keys. Sourced from `SUPABASE_PUBLISHABLE_KEYS` (JSON object)
+   * or `SUPABASE_PUBLISHABLE_KEY` (single key, stored as `{ default: "<value>" }`).
+   */
+  publishableKeys: Record<string, string>;
+  /**
+   * Named secret (service-role) keys. Sourced from `SUPABASE_SECRET_KEYS` (JSON object)
+   * or `SUPABASE_SECRET_KEY` (single key, stored as `{ default: "<value>" }`).
+   */
+  secretKeys: Record<string, string>;
+  /**
+   * JSON Web Key Set used for JWT verification. Sourced from `SUPABASE_JWKS`.
+   * Accepts both `{ keys: [...] }` and bare `[...]` array formats.
+   * `null` when no JWKS is configured (JWT verification will be unavailable).
+   */
+  jwks: JsonWebKeySet | null;
+}
+/**
+ * A JSON Web Key Set as defined by RFC 7517.
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7517
+ */
+interface JsonWebKeySet {
+  /** Array of JSON Web Keys. */
+  keys: JsonWebKey[];
+}
+/**
+ * Raw credentials extracted from an incoming HTTP request.
+ *
+ * Produced by {@link extractCredentials} from the `Authorization` and `apikey` headers.
+ *
+ * @see {@link extractCredentials}
+ */
+interface Credentials {
+  /** Bearer token from the `Authorization: Bearer <token>` header, or `null` if absent. */
+  token: string | null;
+  /** API key from the `apikey` header, or `null` if absent. */
+  apikey: string | null;
+}
+/**
+ * Result of credential verification.
+ *
+ * Contains the resolved auth mode, the verified token (for `"user"` mode),
+ * decoded JWT claims, and the matched key name (for `"public"` / `"secret"` modes).
+ *
+ * @see {@link verifyCredentials}
+ * @see {@link verifyAuth}
+ */
+interface AuthResult {
+  /** The auth mode that was successfully matched. */
+  authType: Allow;
+  /** The verified JWT, or `null` for non-user auth modes. */
+  token: string | null;
+  /** Normalized user identity derived from the JWT, or `null` when no JWT is present. */
+  userClaims: UserClaims | null;
+  /** Raw JWT payload, or `null` when no JWT is present. */
+  claims: JWTClaims | null;
+  /** Name of the matched key (e.g. `"default"`, `"mobile"`), or `null` for `"user"` / `"always"` modes. */
+  keyName?: string | null;
+}
+/**
+ * Standard JWT claims as defined by RFC 7519, extended with Supabase-specific fields.
+ *
+ * This is the raw JWT payload — use {@link UserClaims} for a normalized, camelCase view.
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7519#section-4.1
+ */
+interface JWTClaims {
+  /** Subject — the user's unique ID. */
+  sub: string;
+  /** Issuer — typically your Supabase project URL. */
+  iss?: string;
+  /** Audience — who the token is intended for. */
+  aud?: string | string[];
+  /** Expiration time (seconds since epoch). */
+  exp?: number;
+  /** Issued at (seconds since epoch). */
+  iat?: number;
+  /** Supabase role (e.g. `"authenticated"`, `"anon"`). */
+  role?: string;
+  /** User's email address from Supabase Auth. */
+  email?: string;
+  /** Application-level metadata set via Supabase Auth admin APIs. */
+  app_metadata?: Record<string, unknown>;
+  /** User-editable metadata set via Supabase Auth. */
+  user_metadata?: Record<string, unknown>;
+  /** Additional custom claims. */
+  [key: string]: unknown;
+}
+/**
+ * Normalized, camelCase view of the authenticated user's identity.
+ *
+ * Derived from {@link JWTClaims}. For the full Supabase `User` object
+ * (including email confirmation status, providers, etc.), call
+ * `supabase.auth.getUser()` using the context client.
+ */
+interface UserClaims {
+  /** User's unique ID (same as `JWTClaims.sub`). */
+  id: string;
+  /** Supabase role (e.g. `"authenticated"`). */
+  role?: string;
+  /** User's email address. */
+  email?: string;
+  /** Application-level metadata (e.g. roles, permissions). */
+  appMetadata?: Record<string, unknown>;
+  /** User-editable profile metadata (e.g. display name, avatar). */
+  userMetadata?: Record<string, unknown>;
+}
+/**
+ * Configuration for {@link withSupabase} and {@link createSupabaseContext}.
+ *
+ * Controls which auth modes are accepted, environment overrides, and CORS behavior.
+ *
+ * @example
+ * ```ts
+ * // Require authenticated users, auto-CORS enabled (default)
+ * const config: WithSupabaseConfig = { allow: 'user' }
+ *
+ * // Accept users or service-to-service calls, custom CORS headers
+ * const config: WithSupabaseConfig = {
+ *   allow: ['user', 'secret'],
+ *   cors: { 'Access-Control-Allow-Origin': 'https://myapp.com' },
+ * }
+ *
+ * // No auth required, CORS disabled
+ * const config: WithSupabaseConfig = { allow: 'always', cors: false }
+ * ```
+ */
+interface WithSupabaseConfig {
+  /**
+   * Auth mode(s) to accept. Modes are tried in order — the first match wins.
+   *
+   * @defaultValue `"user"`
+   */
+  allow?: AllowWithKey | AllowWithKey[];
+  /**
+   * Override auto-detected environment variables. Useful for testing
+   * or when running in environments without standard env var support.
+   */
+  env?: Partial<SupabaseEnv>;
+  /**
+   * CORS configuration for the `withSupabase` wrapper.
+   *
+   * - `true` (default) — uses `@supabase/supabase-js` default CORS headers.
+   * - `false` — disables CORS handling entirely.
+   * - `Record<string, string>` — custom CORS headers.
+   *
+   * @remarks Only applies to the top-level {@link withSupabase} wrapper.
+   * The Hono adapter handles CORS separately via Hono's own middleware.
+   *
+   * @defaultValue `true`
+   */
+  cors?: boolean | Record<string, string>;
+}
+/**
+ * The Supabase context created for each authenticated request.
+ *
+ * Contains pre-configured Supabase clients and the caller's identity.
+ * Identical regardless of which layer or adapter produced it.
+ */
+interface SupabaseContext<Database = unknown> {
+  /** Supabase client scoped to the caller's identity. RLS policies apply. */
+  supabase: SupabaseClient<Database>;
+  /** Admin Supabase client that bypasses Row-Level Security. */
+  supabaseAdmin: SupabaseClient<Database>;
+  /** JWT-derived identity. For the full Supabase User object, call `supabase.auth.getUser()`. */
+  userClaims: UserClaims | null;
+  /** Raw JWT payload. `null` for non-user auth modes. */
+  claims: JWTClaims | null;
+  /** The auth mode that was used for this request. */
+  authType: Allow;
+}
+//#endregion
+export { JWTClaims as a, UserClaims as c, Credentials as i, WithSupabaseConfig as l, AllowWithKey as n, SupabaseContext as o, AuthResult as r, SupabaseEnv as s, Allow as t };

package/dist/types-CnKoFCMX.d.cts

@@ -0,0 +1,227 @@
+import { SupabaseClient } from "@supabase/supabase-js";
+
+//#region src/types.d.ts
+/**
+ * Authentication mode that determines what credentials a request must provide.
+ *
+ * - `"always"` — No credentials required. Every request is accepted.
+ * - `"public"` — Requires a valid publishable key in the `apikey` header.
+ * - `"secret"` — Requires a valid secret key in the `apikey` header (timing-safe comparison).
+ * - `"user"` — Requires a valid JWT in the `Authorization: Bearer <token>` header.
+ *
+ * @example
+ * ```ts
+ * // Single mode
+ * withSupabase({ allow: 'user' }, handler)
+ *
+ * // Multiple modes — the first match wins
+ * withSupabase({ allow: ['user', 'public'] }, handler)
+ * ```
+ */
+type Allow = 'always' | 'public' | 'secret' | 'user';
+/**
+ * Extended auth mode that supports targeting a specific named key.
+ *
+ * Use the colon syntax (`"public:web_app"`) to require a specific named key
+ * from the `SUPABASE_PUBLISHABLE_KEYS` or `SUPABASE_SECRET_KEYS` JSON object.
+ * Use `"public:*"` or `"secret:*"` to accept any key in the set.
+ *
+ * @example
+ * ```ts
+ * // Accept only the "mobile" publishable key
+ * withSupabase({ allow: 'public:mobile' }, handler)
+ *
+ * // Accept any secret key
+ * withSupabase({ allow: 'secret:*' }, handler)
+ *
+ * // Mix named keys with other modes
+ * withSupabase({ allow: ['user', 'public:web_app'] }, handler)
+ * ```
+ */
+type AllowWithKey = Allow | `public:${string}` | `secret:${string}`;
+/**
+ * Resolved Supabase environment configuration.
+ *
+ * Holds the project URL, API keys, and JWKS needed by every other primitive.
+ * Typically resolved automatically from environment variables by {@link resolveEnv},
+ * but can be passed explicitly via the `env` option.
+ *
+ * @see {@link resolveEnv} for how each field maps to environment variables.
+ */
+interface SupabaseEnv {
+  /** Supabase project URL (e.g. `"https://<ref>.supabase.co"`). Sourced from `SUPABASE_URL`. */
+  url: string;
+  /**
+   * Named publishable (anon) keys. Sourced from `SUPABASE_PUBLISHABLE_KEYS` (JSON object)
+   * or `SUPABASE_PUBLISHABLE_KEY` (single key, stored as `{ default: "<value>" }`).
+   */
+  publishableKeys: Record<string, string>;
+  /**
+   * Named secret (service-role) keys. Sourced from `SUPABASE_SECRET_KEYS` (JSON object)
+   * or `SUPABASE_SECRET_KEY` (single key, stored as `{ default: "<value>" }`).
+   */
+  secretKeys: Record<string, string>;
+  /**
+   * JSON Web Key Set used for JWT verification. Sourced from `SUPABASE_JWKS`.
+   * Accepts both `{ keys: [...] }` and bare `[...]` array formats.
+   * `null` when no JWKS is configured (JWT verification will be unavailable).
+   */
+  jwks: JsonWebKeySet | null;
+}
+/**
+ * A JSON Web Key Set as defined by RFC 7517.
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7517
+ */
+interface JsonWebKeySet {
+  /** Array of JSON Web Keys. */
+  keys: JsonWebKey[];
+}
+/**
+ * Raw credentials extracted from an incoming HTTP request.
+ *
+ * Produced by {@link extractCredentials} from the `Authorization` and `apikey` headers.
+ *
+ * @see {@link extractCredentials}
+ */
+interface Credentials {
+  /** Bearer token from the `Authorization: Bearer <token>` header, or `null` if absent. */
+  token: string | null;
+  /** API key from the `apikey` header, or `null` if absent. */
+  apikey: string | null;
+}
+/**
+ * Result of credential verification.
+ *
+ * Contains the resolved auth mode, the verified token (for `"user"` mode),
+ * decoded JWT claims, and the matched key name (for `"public"` / `"secret"` modes).
+ *
+ * @see {@link verifyCredentials}
+ * @see {@link verifyAuth}
+ */
+interface AuthResult {
+  /** The auth mode that was successfully matched. */
+  authType: Allow;
+  /** The verified JWT, or `null` for non-user auth modes. */
+  token: string | null;
+  /** Normalized user identity derived from the JWT, or `null` when no JWT is present. */
+  userClaims: UserClaims | null;
+  /** Raw JWT payload, or `null` when no JWT is present. */
+  claims: JWTClaims | null;
+  /** Name of the matched key (e.g. `"default"`, `"mobile"`), or `null` for `"user"` / `"always"` modes. */
+  keyName?: string | null;
+}
+/**
+ * Standard JWT claims as defined by RFC 7519, extended with Supabase-specific fields.
+ *
+ * This is the raw JWT payload — use {@link UserClaims} for a normalized, camelCase view.
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc7519#section-4.1
+ */
+interface JWTClaims {
+  /** Subject — the user's unique ID. */
+  sub: string;
+  /** Issuer — typically your Supabase project URL. */
+  iss?: string;
+  /** Audience — who the token is intended for. */
+  aud?: string | string[];
+  /** Expiration time (seconds since epoch). */
+  exp?: number;
+  /** Issued at (seconds since epoch). */
+  iat?: number;
+  /** Supabase role (e.g. `"authenticated"`, `"anon"`). */
+  role?: string;
+  /** User's email address from Supabase Auth. */
+  email?: string;
+  /** Application-level metadata set via Supabase Auth admin APIs. */
+  app_metadata?: Record<string, unknown>;
+  /** User-editable metadata set via Supabase Auth. */
+  user_metadata?: Record<string, unknown>;
+  /** Additional custom claims. */
+  [key: string]: unknown;
+}
+/**
+ * Normalized, camelCase view of the authenticated user's identity.
+ *
+ * Derived from {@link JWTClaims}. For the full Supabase `User` object
+ * (including email confirmation status, providers, etc.), call
+ * `supabase.auth.getUser()` using the context client.
+ */
+interface UserClaims {
+  /** User's unique ID (same as `JWTClaims.sub`). */
+  id: string;
+  /** Supabase role (e.g. `"authenticated"`). */
+  role?: string;
+  /** User's email address. */
+  email?: string;
+  /** Application-level metadata (e.g. roles, permissions). */
+  appMetadata?: Record<string, unknown>;
+  /** User-editable profile metadata (e.g. display name, avatar). */
+  userMetadata?: Record<string, unknown>;
+}
+/**
+ * Configuration for {@link withSupabase} and {@link createSupabaseContext}.
+ *
+ * Controls which auth modes are accepted, environment overrides, and CORS behavior.
+ *
+ * @example
+ * ```ts
+ * // Require authenticated users, auto-CORS enabled (default)
+ * const config: WithSupabaseConfig = { allow: 'user' }
+ *
+ * // Accept users or service-to-service calls, custom CORS headers
+ * const config: WithSupabaseConfig = {
+ *   allow: ['user', 'secret'],
+ *   cors: { 'Access-Control-Allow-Origin': 'https://myapp.com' },
+ * }
+ *
+ * // No auth required, CORS disabled
+ * const config: WithSupabaseConfig = { allow: 'always', cors: false }
+ * ```
+ */
+interface WithSupabaseConfig {
+  /**
+   * Auth mode(s) to accept. Modes are tried in order — the first match wins.
+   *
+   * @defaultValue `"user"`
+   */
+  allow?: AllowWithKey | AllowWithKey[];
+  /**
+   * Override auto-detected environment variables. Useful for testing
+   * or when running in environments without standard env var support.
+   */
+  env?: Partial<SupabaseEnv>;
+  /**
+   * CORS configuration for the `withSupabase` wrapper.
+   *
+   * - `true` (default) — uses `@supabase/supabase-js` default CORS headers.
+   * - `false` — disables CORS handling entirely.
+   * - `Record<string, string>` — custom CORS headers.
+   *
+   * @remarks Only applies to the top-level {@link withSupabase} wrapper.
+   * The Hono adapter handles CORS separately via Hono's own middleware.
+   *
+   * @defaultValue `true`
+   */
+  cors?: boolean | Record<string, string>;
+}
+/**
+ * The Supabase context created for each authenticated request.
+ *
+ * Contains pre-configured Supabase clients and the caller's identity.
+ * Identical regardless of which layer or adapter produced it.
+ */
+interface SupabaseContext<Database = unknown> {
+  /** Supabase client scoped to the caller's identity. RLS policies apply. */
+  supabase: SupabaseClient<Database>;
+  /** Admin Supabase client that bypasses Row-Level Security. */
+  supabaseAdmin: SupabaseClient<Database>;
+  /** JWT-derived identity. For the full Supabase User object, call `supabase.auth.getUser()`. */
+  userClaims: UserClaims | null;
+  /** Raw JWT payload. `null` for non-user auth modes. */
+  claims: JWTClaims | null;
+  /** The auth mode that was used for this request. */
+  authType: Allow;
+}
+//#endregion
+export { JWTClaims as a, UserClaims as c, Credentials as i, WithSupabaseConfig as l, AllowWithKey as n, SupabaseContext as o, AuthResult as r, SupabaseEnv as s, Allow as t };