@xylex-group/athena 2.12.1 → 2.13.0

package/dist/payload-DEOWN_oo.d.ts

@@ -0,0 +1,219 @@
+import { an as AthenaCreateClientAuthOptions, af as AthenaClientExperimentalOptions, aI as AthenaHeaderBag } from './client-DVOKSYDI.js';
+import { o as BackendConfig, p as BackendType } from './types-CH78O90i.js';
+
+interface AthenaRequestCookiesBag {
+    getAll(): Array<{
+        name: string;
+        value: string;
+    }>;
+}
+type AthenaRequestHeadersInput = AthenaHeaderBag | Record<string, string | null | undefined>;
+type AthenaRequestCookiesInput = AthenaRequestCookiesBag | string | null | undefined;
+type AthenaAdapterExperimentalOptions = Omit<AthenaClientExperimentalOptions, 'athenaStorageBackend'>;
+interface AthenaAdapterBaseOptions {
+    env?: Record<string, string | undefined>;
+    url?: string | null | undefined;
+    gatewayUrl?: string | null | undefined;
+    authUrl?: string | null | undefined;
+    chatUrl?: string | null | undefined;
+    chatWsUrl?: string | null | undefined;
+    storageUrl?: string | null | undefined;
+    key?: string | null | undefined;
+    client?: string | null | undefined;
+    backend?: BackendConfig | BackendType;
+    headers?: Record<string, string>;
+    auth?: AthenaCreateClientAuthOptions;
+    forceNoCache?: boolean;
+    storage?: boolean;
+    experimental?: AthenaAdapterExperimentalOptions;
+}
+interface AthenaServerRequestOptions {
+    requestHeaders?: AthenaRequestHeadersInput;
+    requestCookies?: AthenaRequestCookiesInput;
+}
+
+/**
+ * Default App Router path for the Athena Auth session cookie bridge.
+ *
+ * Mount as `app/api/athena-auth/session/route.ts`, or configure another path
+ * such as `/api/auth/session` when using catch-all handlers.
+ *
+ * @see {@link createAthenaAuthSessionBridgeHandlers}
+ * @see {@link createAthenaAuthSessionBridgePathHandlers}
+ */
+declare const ATHENA_AUTH_SESSION_BRIDGE_ROUTE = "/api/athena-auth/session";
+/**
+ * Primary host-app session cookie written by the bridge.
+ *
+ * Hyphen form (`session-token`) matches Athena Auth UI and several consumer
+ * apps. Underscore form is also cleared on DELETE for cookie-helper parity.
+ *
+ * @see {@link ATHENA_AUTH_SESSION_COOKIE_NAMES}
+ */
+declare const ATHENA_AUTH_SESSION_COOKIE_NAME = "athena-auth.session-token";
+/**
+ * Cookie names cleared on logout / bridge `DELETE`.
+ *
+ * Includes both hyphen and underscore variants so bridge clear stays aligned
+ * with `@xylex-group/athena/cookies` session token lookup.
+ */
+declare const ATHENA_AUTH_SESSION_COOKIE_NAMES: readonly ["athena-auth.session-token", "athena-auth.session_token"];
+
+/**
+ * Minimal session shape accepted when deriving a bridge payload from
+ * `auth.getSession()`-style responses.
+ *
+ * Either nested `session.token` or a top-level `token` may be present depending
+ * on the Athena Auth response envelope version.
+ */
+interface AthenaAuthSessionBridgeSource {
+    session?: {
+        /** ISO-8601 expiry when provided by the auth server. */
+        expiresAt?: string | null;
+        /** Opaque session token string. */
+        token?: string | null;
+    } | null;
+    /** Some clients surface the token at the envelope root. */
+    token?: string | null;
+}
+/**
+ * Body accepted by the session bridge `POST` handler and by
+ * {@link persistAthenaAuthSessionOnAppHost}.
+ */
+interface AthenaAuthSessionBridgePayload {
+    /** Non-empty session token to store in the app-host httpOnly cookie. */
+    token: string;
+    /**
+     * Optional cookie `Expires` value (ISO-8601 string).
+     * When omitted, the cookie is a session cookie (browser-lifetime).
+     */
+    expiresAt?: string | undefined;
+}
+/**
+ * Configuration for bridge route handlers and cookie attributes.
+ *
+ * All fields are optional; defaults match speedrun-formations /
+ * Athena Auth UI conventions.
+ */
+interface AthenaAuthSessionBridgeOptions {
+    /**
+     * Route reported in JSON responses and used by client helpers when not
+     * overridden.
+     *
+     * @defaultValue `/api/athena-auth/session`
+     */
+    route?: string | undefined;
+    /**
+     * Cookie name written on successful `POST`.
+     *
+     * @defaultValue `athena-auth.session-token`
+     */
+    cookieName?: string | undefined;
+    /**
+     * Cookie names cleared on `DELETE` (aliases).
+     *
+     * @defaultValue hyphen + underscore session token names
+     */
+    cookieNames?: readonly string[] | undefined;
+    /**
+     * Path attribute for the session cookie.
+     *
+     * @defaultValue `/`
+     */
+    cookiePath?: string | undefined;
+    /**
+     * Cookie SameSite attribute.
+     *
+     * @defaultValue `lax`
+     */
+    sameSite?: 'lax' | 'strict' | 'none' | undefined;
+    /**
+     * Force the `Secure` flag. When omitted, the handlers derive Secure from the
+     * request URL scheme and `x-forwarded-proto`.
+     */
+    secure?: boolean | undefined;
+}
+/**
+ * Options for catch-all / dynamic-segment handlers under `/api/auth/*`.
+ *
+ * Extends {@link AthenaAuthSessionBridgeOptions} with path matching.
+ */
+interface AthenaAuthSessionBridgePathOptions extends AthenaAuthSessionBridgeOptions {
+    /**
+     * Pathname suffixes (final URL segments) that activate the bridge.
+     *
+     * @defaultValue `['session']` — covers `/api/auth/session` and
+     * `/api/athena-auth/session`
+     */
+    matchPaths?: readonly string[] | undefined;
+}
+
+/**
+ * Options for browser-side bridge fetch helpers.
+ */
+interface AthenaAuthSessionBridgeClientOptions {
+    /**
+     * Bridge route on the app host.
+     *
+     * @defaultValue {@link ATHENA_AUTH_SESSION_BRIDGE_ROUTE}
+     */
+    route?: string | undefined;
+    /**
+     * Optional fetch implementation (defaults to global `fetch`).
+     * Useful in tests.
+     */
+    fetch?: typeof fetch | undefined;
+}
+/**
+ * Persist an Athena Auth session token on the app host via the bridge `POST` route.
+ *
+ * Sends a same-origin JSON POST with `credentials: "same-origin"`. No-ops when
+ * `payload` is null/undefined or when not running in a browser.
+ *
+ * @param payload - Token (+ optional expiry) from {@link resolveSessionBridgePayload}
+ * @param options - Route override and fetch implementation
+ * @throws {Error} When the bridge responds with a non-OK status
+ *
+ * @example
+ * ```ts
+ * await persistAthenaAuthSessionOnAppHost({
+ *   token: session.session.token,
+ *   expiresAt: session.session.expiresAt,
+ * })
+ * ```
+ */
+declare function persistAthenaAuthSessionOnAppHost(payload: AthenaAuthSessionBridgePayload | null, options?: AthenaAuthSessionBridgeClientOptions): Promise<void>;
+/**
+ * Clear the bridged session cookie on the app host via `DELETE`.
+ *
+ * No-ops outside the browser. Pair with `auth.signOut()` so the app-host
+ * cookie does not outlive the auth session.
+ *
+ * @param options - Route override and fetch implementation
+ * @throws {Error} When the bridge responds with a non-OK status
+ */
+declare function clearAthenaAuthSessionOnAppHost(options?: AthenaAuthSessionBridgeClientOptions): Promise<void>;
+
+/**
+ * Extract a bridge payload from a session response envelope.
+ *
+ * Preference order for the token:
+ * 1. `payload.session.token`
+ * 2. `payload.token`
+ *
+ * Returns `null` when no non-empty token string is available after trim.
+ *
+ * @param payload - Result of `auth.getSession()` data or a compatible object
+ * @returns Payload suitable for bridge `POST`, or `null`
+ *
+ * @example
+ * ```ts
+ * const { data, ok } = await client.auth.getSession()
+ * if (ok) {
+ *   await persistAthenaAuthSessionOnAppHost(resolveSessionBridgePayload(data))
+ * }
+ * ```
+ */
+declare function resolveSessionBridgePayload(payload: AthenaAuthSessionBridgeSource | null | undefined): AthenaAuthSessionBridgePayload | null;
+
+export { type AthenaAdapterBaseOptions as A, type AthenaAdapterExperimentalOptions as a, ATHENA_AUTH_SESSION_BRIDGE_ROUTE as b, ATHENA_AUTH_SESSION_COOKIE_NAME as c, ATHENA_AUTH_SESSION_COOKIE_NAMES as d, type AthenaAuthSessionBridgeClientOptions as e, type AthenaAuthSessionBridgePayload as f, type AthenaAuthSessionBridgeSource as g, clearAthenaAuthSessionOnAppHost as h, type AthenaAuthSessionBridgeOptions as i, type AthenaAuthSessionBridgePathOptions as j, type AthenaServerRequestOptions as k, persistAthenaAuthSessionOnAppHost as p, resolveSessionBridgePayload as r };

package/dist/{pipeline-DrjU2vNA.d.ts → pipeline-Bj6RWt1A.d.ts}

@@ -1,4 +1,4 @@
-import { R as RunGeneratorOptions, s as RunGeneratorResult } from './types-DRRb0Fd0.js';
+import { R as RunGeneratorOptions, d as RunGeneratorResult } from './types-DPgejxYC.js';
 
 /**
  * End-to-end generator execution: load config, introspect, render, and optionally write files.

package/dist/{pipeline-c7Gdm0qv.d.cts → pipeline-Dwck-wZO.d.cts}

@@ -1,4 +1,4 @@
-import { R as RunGeneratorOptions, s as RunGeneratorResult } from './types-BLizCLd1.cjs';
+import { R as RunGeneratorOptions, d as RunGeneratorResult } from './types-CjC9_5ZQ.cjs';
 
 /**
  * End-to-end generator execution: load config, introspect, render, and optionally write files.

package/dist/react.cjs

@@ -187,7 +187,7 @@ var getSessionCookie = (request, config) => {
 
 // src/utils/athena-request-headers.ts
 var NO_CACHE_HEADER_VALUE = "no-cache";
-var API_KEY_HEADER_CANDIDATES = ["X-Api-Key", "x-api-key", "apikey"];
+var API_KEY_HEADER_CANDIDATES = ["X-Athena-Key", "x-athena-key", "X-Api-Key", "x-api-key", "apikey"];
 var ATHENA_KEY_HEADER_CANDIDATES = ["X-Athena-Key", "x-athena-key"];
 var SESSION_TOKEN_HEADER_CANDIDATES = ["X-Athena-Auth-Session-Token"];
 var BEARER_MIRROR_HEADER_CANDIDATES = ["X-Athena-Auth-Bearer-Token"];
@@ -289,17 +289,6 @@ function buildServiceRequestHeaders(profile, sdkHeaderValue, config, options, ex
   });
 }
 function applyAthenaApiKeyHeaders(headers, apiKey, athenaKey) {
-  if (apiKey) {
-    if (!hasHeaderIgnoreCase(headers, "apikey")) {
-      headers.apikey = apiKey;
-    }
-    if (!Object.hasOwn(headers, "x-api-key")) {
-      headers["x-api-key"] = apiKey;
-    }
-    if (!Object.hasOwn(headers, "X-Api-Key")) {
-      headers["X-Api-Key"] = apiKey;
-    }
-  }
   const resolvedAthenaKey = normalizeHeaderValue(athenaKey) ?? normalizeHeaderValue(apiKey);
   if (resolvedAthenaKey && !hasHeaderIgnoreCase(headers, "X-Athena-Key")) {
     headers["X-Athena-Key"] = resolvedAthenaKey;
@@ -425,7 +414,7 @@ function buildAthenaRequestHeaders(input) {
 
 // package.json
 var package_default = {
-  version: "2.12.1"
+  version: "2.13.0"
 };
 
 // src/sdk-version.ts