@xylex-group/athena 3.1.0 → 3.3.0

package/dist/{athena-request-headers-DujFFyMU.d.cts → athena-request-headers-Lr_m8xCV.d.cts}

@@ -77,6 +77,53 @@ interface ClearAuthCookiesOptions {
  * }
  * ```
  */
+interface SignOutAndClearAthenaSessionOptions {
+    /**
+     * Call the auth client's sign-out (or equivalent). Failures are swallowed so
+     * cookies still clear; rethrow by setting `throwOnSignOutError`.
+     */
+    signOut: () => Promise<unknown> | unknown;
+    /**
+     * Optional app-host session bridge clear
+     * (`clearAthenaAuthSessionOnAppHost` from `@xylex-group/athena/next/client`).
+     */
+    clearBridge?: () => Promise<unknown> | unknown;
+    /**
+     * When set and running in a browser, hard-redirect after clearing cookies.
+     * Pass `null` / omit to skip navigation (caller uses soft navigate).
+     */
+    redirectTo?: string | null;
+    /**
+     * When false, skip `window.location` even if `redirectTo` is set.
+     * @default true when `redirectTo` is a non-empty string
+     */
+    hardRedirect?: boolean;
+    clearCookieOptions?: ClearAuthCookiesOptions;
+    throwOnSignOutError?: boolean;
+}
+interface SignOutAndClearAthenaSessionResult {
+    clearedCookies: string[];
+    signOutError: unknown | null;
+}
+/**
+ * Sign out, clear Athena/Better Auth cookies, optionally clear the app-host
+ * session bridge cookie, then optionally hard-redirect.
+ *
+ * Prefer this over per-app `try/finally` copy-paste of clear + redirect.
+ *
+ * @example
+ * ```ts
+ * import { signOutAndClearAthenaSession } from "@xylex-group/athena/utils"
+ * import { clearAthenaAuthSessionOnAppHost } from "@xylex-group/athena/next/client"
+ *
+ * await signOutAndClearAthenaSession({
+ *   signOut: () => authClient.signOut({ fetchOptions: { throw: true } }),
+ *   clearBridge: () => clearAthenaAuthSessionOnAppHost(),
+ *   redirectTo: "/sign-in",
+ * })
+ * ```
+ */
+declare function signOutAndClearAthenaSession(options: SignOutAndClearAthenaSessionOptions): Promise<SignOutAndClearAthenaSessionResult>;
 declare function clearAuthCookies(options?: ClearAuthCookiesOptions): string[];
 
 /**
@@ -177,205 +224,6 @@ declare function shouldRedirectAuthenticatedAuthMode(mode: AuthMode): boolean;
  */
 declare function resolveAuthModeRedirect(mode: string | undefined, redirects?: AuthModeRedirects): string | null;
 
-/**
- * Resolve Athena Auth base / upstream URLs from env or explicit config.
- *
- * Mirrors the Athena Auth UI base-url contract so apps and the SDK share one
- * precedence order for `ATHENA_AUTH_*` environment variables.
- */
-/** Default browser/proxy path for same-origin auth routing. */
-declare const ATHENA_AUTH_PATH = "/api/auth";
-/** Fallback origin when no absolute upstream is configured (server-side). */
-declare const LOCAL_DEV_ORIGIN = "http://localhost:3000";
-/**
- * Hosted Athena Auth origin used when no upstream override is supplied.
- * Origin only — no `/api/auth` suffix.
- */
-declare const DEFAULT_ATHENA_AUTH_ORIGIN = "https://auth.athena-auth.com";
-/**
- * @deprecated Prefer {@link DEFAULT_ATHENA_AUTH_ORIGIN}.
- * Kept for callers that used the older name.
- */
-declare const DEFAULT_ATHENA_AUTH_UPSTREAM_URL = "https://auth.athena-auth.com";
-/**
- * Environment keys checked (in order) for the Athena Auth upstream URL.
- *
- * Prefer server-only keys first so private upstream hosts are not forced to
- * rely on `NEXT_PUBLIC_*` values.
- */
-declare const ATHENA_AUTH_UPSTREAM_ENV_KEYS: readonly ["ATHENA_AUTH_UPSTREAM_URL", "ATHENA_AUTH_URL", "NEXT_PUBLIC_ATHENA_AUTH_UPSTREAM_URL", "NEXT_PUBLIC_ATHENA_AUTH_URL"];
-/**
- * Auth UI naming parity (`base-url.ts`).
- * Same ordered list as {@link ATHENA_AUTH_UPSTREAM_ENV_KEYS}.
- */
-declare const ATHENA_AUTH_UPSTREAM_URL_ENV_NAMES: readonly ["ATHENA_AUTH_UPSTREAM_URL", "ATHENA_AUTH_URL", "NEXT_PUBLIC_ATHENA_AUTH_UPSTREAM_URL", "NEXT_PUBLIC_ATHENA_AUTH_URL"];
-type AthenaAuthUpstreamEnvKey = (typeof ATHENA_AUTH_UPSTREAM_ENV_KEYS)[number];
-/** Loose env map (Node `process.env` or a test fixture). */
-type EnvLike = Record<string, string | undefined>;
-type AthenaAuthUpstreamEnv = Partial<Record<AthenaAuthUpstreamEnvKey, string | undefined>> & EnvLike;
-interface AthenaAuthClientBaseUrlOptions {
-    /**
-     * When `true` (default), ensure the client base ends with `/api/auth`.
-     * Set `false` when the auth server is mounted at a custom path or root.
-     */
-    appendAuthPath?: boolean;
-}
-/**
- * Returns `true` when the value is an absolute `http://` or `https://` URL.
- */
-declare function isAbsoluteUrl(value: string): boolean;
-/**
- * Read the first non-empty Athena Auth upstream URL from an env-like map.
- *
- * @returns Trimmed URL string, or `undefined` when none of the keys are set
- */
-declare function readAthenaAuthUpstreamUrlFromEnv(env: EnvLike): string | undefined;
-/**
- * Normalize a consumer-supplied auth base URL so it targets `/api/auth`
- * (unless the path already ends with that segment).
- *
- * Absolute URLs keep origin and rewrite pathname; relative paths are ensured
- * to end with `/api/auth`.
- *
- * @example
- * ```ts
- * normalizeAthenaAuthBaseUrl('https://auth.example.com')
- * // => 'https://auth.example.com/api/auth'
- *
- * normalizeAthenaAuthBaseUrl('/api/auth')
- * // => '/api/auth'
- * ```
- */
-declare function normalizeAthenaAuthBaseUrl(urlOrPath: string): string;
-/**
- * Resolve the **server-side** Athena Auth upstream origin (no `/api/auth` suffix).
- *
- * Used when proxying or calling the auth host directly from Node / edge.
- *
- * @param rawUpstreamUrl - Explicit URL, env map, or omit to read `process.env`
- * @returns Origin like `https://auth.example.com` (no trailing slash)
- */
-declare function resolveAthenaAuthUpstreamUrl(rawUpstreamUrl?: string | AthenaAuthUpstreamEnv): string;
-/**
- * Resolve the **browser-facing** auth client base URL.
- *
- * Default behavior appends `/api/auth` for same-origin proxying. Pass
- * `{ appendAuthPath: false }` to keep a custom path or root mount.
- *
- * Overloads match common call styles from Athena Auth UI and app code:
- * - `resolveAthenaAuthClientBaseUrl("https://auth.example.com")`
- * - `resolveAthenaAuthClientBaseUrl(process.env)`
- * - `resolveAthenaAuthClientBaseUrl(undefined)` → env + defaults
- * - `resolveAthenaAuthClientBaseUrl(path, upstream, { appendAuthPath: false })`
- */
-declare function resolveAthenaAuthClientBaseUrl(configuredAuthBaseUrl?: string | EnvLike, rawUpstreamUrl?: string | AthenaAuthUpstreamEnv, options?: AthenaAuthClientBaseUrlOptions): string;
-declare function resolveAthenaAuthClientBaseUrl(configuredAuthBaseUrl: string, rawUpstreamUrl?: string | AthenaAuthUpstreamEnv, options?: AthenaAuthClientBaseUrlOptions): string;
-/**
- * Build an absolute Athena Auth request URL for a path under the client base.
- *
- * Resolves at **call time** (reads env when `rawBaseUrl` is omitted) so module
- * load order does not freeze a stale URL.
- *
- * @param path - Path relative to the auth base (leading slashes stripped)
- * @param rawBaseUrl - Optional base string or env map
- *
- * @example
- * ```ts
- * resolveAthenaAuthRequestUrl('get-session', 'https://auth.example.com')
- * // => 'https://auth.example.com/api/auth/get-session'
- * ```
- */
-declare function resolveAthenaAuthRequestUrl(path: string, rawBaseUrl?: string | EnvLike): string;
-/** Relative auth path for email verification (`GET /verify-email`). */
-declare const ATHENA_AUTH_VERIFY_EMAIL_PATH = "verify-email";
-/**
- * Relative segment for session lookup (`GET /get-session`).
- * Prefer with {@link resolveAthenaAuthRequestUrl} when `base` already ends in `/api/auth`.
- */
-declare const ATHENA_AUTH_GET_SESSION_PATH = "get-session";
-/**
- * Absolute app/proxy path for session lookup.
- * Use with `new URL(ATHENA_AUTH_GET_SESSION_ABSOLUTE_PATH, appOrigin)` when
- * `baseUrl` is the **app origin** (e.g. `https://app.example.com`), not the auth client base.
- */
-declare const ATHENA_AUTH_GET_SESSION_ABSOLUTE_PATH = "/api/auth/get-session";
-/**
- * @deprecated Alias of {@link ATHENA_AUTH_GET_SESSION_ABSOLUTE_PATH} for drop-in
- * replacement of app-local `AUTH_SESSION_PATH` constants. Prefer the `ATHENA_` name.
- */
-declare const AUTH_SESSION_PATH = "/api/auth/get-session";
-/**
- * Query param that forces Athena Auth / Better Auth style session handlers to
- * skip cookie cache and re-read the live session cookie.
- */
-declare const ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_PARAM = "disableCookieCache";
-/**
- * @deprecated Alias of {@link ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_PARAM}.
- */
-declare const DISABLE_COOKIE_CACHE_QUERY_PARAM = "disableCookieCache";
-/** Value paired with {@link ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_PARAM}. */
-declare const ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_VALUE = "true";
-/**
- * @deprecated Alias of {@link ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_VALUE}.
- */
-declare const DISABLE_COOKIE_CACHE_QUERY_VALUE = "true";
-/**
- * Optional request/response header some apps use to pass serialized session
- * payload between edge middleware and the app (not set by the SDK itself).
- */
-declare const ATHENA_SESSION_DATA_HEADER = "x-session-data";
-/**
- * @deprecated Alias of {@link ATHENA_SESSION_DATA_HEADER}.
- */
-declare const SESSION_DATA_HEADER = "x-session-data";
-/**
- * Absolute callback URL for email verification.
- *
- * Equivalent to `resolveAthenaAuthRequestUrl("verify-email")` — use this in
- * sign-up / send-verification payloads as `callbackURL` instead of a local
- * wrapper around Auth UI `base-url` helpers.
- *
- * @param rawBaseUrl - Optional base string or env map (defaults to process env)
- * @returns e.g. `https://auth.example.com/api/auth/verify-email`
- *
- * @example
- * ```ts
- * import { resolveEmailVerificationCallbackUrl } from "@xylex-group/athena/utils"
- *
- * await client.auth.signUp.email({
- *   email,
- *   password,
- *   name,
- *   callbackURL: resolveEmailVerificationCallbackUrl(),
- * })
- * ```
- */
-declare function resolveEmailVerificationCallbackUrl(rawBaseUrl?: string | EnvLike): string;
-/**
- * Build a same-origin (or absolute) **fresh** get-session URL.
- *
- * Appends `disableCookieCache=true` so middleware / RSC session probes do not
- * reuse a stale cookie-cache entry.
- *
- * @param baseUrl - App origin (`https://app.example.com`) or any base accepted by
- *   the `URL` constructor. Resolves {@link ATHENA_AUTH_GET_SESSION_ABSOLUTE_PATH}
- *   (`/api/auth/get-session`) against that base.
- * @returns URL such as `https://app.example.com/api/auth/get-session?disableCookieCache=true`
- *
- * @example
- * ```ts
- * import { createFreshSessionLookupUrl } from "@xylex-group/athena/utils"
- *
- * const url = createFreshSessionLookupUrl("https://app.example.com")
- * await fetch(url, { headers: { cookie: requestHeaders.get("cookie") ?? "" } })
- * ```
- *
- * For auth-client base URLs that already include `/api/auth`, prefer:
- * `resolveAthenaAuthRequestUrl("get-session", authBase) + "?disableCookieCache=true"`
- * or pass the **app** origin into this helper when you proxy `/api/auth/*` locally.
- */
-declare function createFreshSessionLookupUrl(baseUrl: string | URL): URL;
-
 declare function asString(value: unknown): string | null;
 declare function asBoolean(value: unknown): boolean;
 declare function asBooleanOrNull(value: unknown): boolean | null;
@@ -458,4 +306,4 @@ declare function buildAthenaGatewayHeaders(input: {
 }): Record<string, string>;
 declare function buildAthenaRequestHeaders(input: BuildAthenaRequestHeadersInput): Record<string, string>;
 
-export { resolveAuthModeRedirect as $, ATHENA_AUTH_COOKIE_PREFIXES as A, type AuthView as B, type BuildAthenaRequestHeadersInput as C, type ClearAuthCookiesOptions as D, DEFAULT_ATHENA_AUTH_ORIGIN as E, DEFAULT_ATHENA_AUTH_UPSTREAM_URL as F, DISABLE_COOKIE_CACHE_QUERY_PARAM as G, DISABLE_COOKIE_CACHE_QUERY_VALUE as H, type EnvLike as I, asNonEmptyString as J, asString as K, LOCAL_DEV_ORIGIN as L, buildAthenaGatewayHeaders as M, buildAthenaRequestHeaders as N, clearAuthCookies as O, createAuthModeRedirects as P, createAuthRoutes as Q, createFreshSessionLookupUrl as R, SESSION_DATA_HEADER as S, isAbsoluteUrl as T, isAuthMode as U, normalizeAthenaAuthBaseUrl as V, readAthenaAuthUpstreamUrlFromEnv as W, readTrimmedString as X, resolveAthenaAuthClientBaseUrl as Y, resolveAthenaAuthRequestUrl as Z, resolveAthenaAuthUpstreamUrl as _, ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_PARAM as a, resolveAuthViewFromSegment as a0, resolveEmailVerificationCallbackUrl as a1, shouldRedirectAuthenticatedAuthMode as a2, shouldRedirectAuthenticatedAuthView as a3, type ResolvedRequestHeaderOverrides as a4, applyAthenaApiKeyHeaders as a5, applyAthenaAuthContextHeaders as a6, applyAthenaPgUriHeaders as a7, buildServiceRequestHeaders as a8, hasHeaderIgnoreCase as a9, resolveHeaderValue as aa, resolveRequestHeaderOverrides as ab, DEFAULT_AUTH_COOKIE_PREFIXES as ac, asBoolean as ad, asBooleanOrNull as ae, asIdentifier as af, asNumber as ag, asRecord as ah, asStringArray as ai, firstString as aj, ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_VALUE as b, ATHENA_AUTH_GET_SESSION_ABSOLUTE_PATH as c, ATHENA_AUTH_GET_SESSION_PATH as d, ATHENA_AUTH_PATH as e, ATHENA_AUTH_UPSTREAM_ENV_KEYS as f, ATHENA_AUTH_UPSTREAM_URL_ENV_NAMES as g, ATHENA_AUTH_VERIFY_EMAIL_PATH as h, ATHENA_SESSION_DATA_HEADER as i, AUTHENTICATED_REDIRECT_MODE_SET as j, AUTHENTICATED_REDIRECT_VIEW_SET as k, AUTH_DEFAULT_VIEW as l, AUTH_MODE_REDIRECTS as m, AUTH_MODE_SET as n, AUTH_ROUTES as o, AUTH_SESSION_PATH as p, AUTH_TWO_FACTOR_SEGMENT as q, AUTH_VIEW_BY_SEGMENT as r, type AthenaAuthClientBaseUrlOptions as s, type AthenaAuthUpstreamEnv as t, type AthenaAuthUpstreamEnvKey as u, type AthenaRequestHeaderOverrideFields as v, type AthenaRequestHeaderProfile as w, type AuthMode as x, type AuthModeRedirects as y, type AuthRoutes as z };
+export { ATHENA_AUTH_COOKIE_PREFIXES as A, type BuildAthenaRequestHeadersInput as B, type ClearAuthCookiesOptions as C, shouldRedirectAuthenticatedAuthView as D, applyAthenaApiKeyHeaders as E, applyAthenaAuthContextHeaders as F, applyAthenaPgUriHeaders as G, buildServiceRequestHeaders as H, hasHeaderIgnoreCase as I, resolveHeaderValue as J, resolveRequestHeaderOverrides as K, DEFAULT_AUTH_COOKIE_PREFIXES as L, type SignOutAndClearAthenaSessionResult as M, asBoolean as N, asBooleanOrNull as O, asIdentifier as P, asNumber as Q, type ResolvedRequestHeaderOverrides as R, type SignOutAndClearAthenaSessionOptions as S, asRecord as T, asStringArray as U, firstString as V, signOutAndClearAthenaSession as W, AUTHENTICATED_REDIRECT_MODE_SET as a, AUTHENTICATED_REDIRECT_VIEW_SET as b, AUTH_DEFAULT_VIEW as c, AUTH_MODE_REDIRECTS as d, AUTH_MODE_SET as e, AUTH_ROUTES as f, AUTH_TWO_FACTOR_SEGMENT as g, AUTH_VIEW_BY_SEGMENT as h, type AthenaRequestHeaderOverrideFields as i, type AthenaRequestHeaderProfile as j, type AuthMode as k, type AuthModeRedirects as l, type AuthRoutes as m, type AuthView as n, asNonEmptyString as o, asString as p, buildAthenaGatewayHeaders as q, buildAthenaRequestHeaders as r, clearAuthCookies as s, createAuthModeRedirects as t, createAuthRoutes as u, isAuthMode as v, readTrimmedString as w, resolveAuthModeRedirect as x, resolveAuthViewFromSegment as y, shouldRedirectAuthenticatedAuthMode as z };

package/dist/billing.cjs

@@ -2,7 +2,7 @@
 
 // package.json
 var package_default = {
-  version: "3.1.0"
+  version: "3.3.0"
 };
 
 // src/sdk-version.ts