@xylex-group/athena 2.14.0 → 3.0.2

package/dist/admin.d.cts

@@ -1,4 +1,4 @@
-import { aF as AthenaAdminHasPermissionRequest, aG as AthenaAuthFetchCompatibleInput, E as AthenaAuthCallOptions, D as AthenaAuthBindings } from './types-eAKAh71s.cjs';
+import { aD as AthenaAdminHasPermissionRequest, aE as AthenaAuthFetchCompatibleInput, E as AthenaAuthCallOptions, D as AthenaAuthBindings } from './types-AOY-GLu8.cjs';
 
 /**
  * Minimal session shape used by the admin convenience helpers.

package/dist/admin.d.ts

@@ -1,4 +1,4 @@
-import { aF as AthenaAdminHasPermissionRequest, aG as AthenaAuthFetchCompatibleInput, E as AthenaAuthCallOptions, D as AthenaAuthBindings } from './types-eAKAh71s.js';
+import { aD as AthenaAdminHasPermissionRequest, aE as AthenaAuthFetchCompatibleInput, E as AthenaAuthCallOptions, D as AthenaAuthBindings } from './types-AOY-GLu8.js';
 
 /**
  * Minimal session shape used by the admin convenience helpers.

package/dist/{athena-auth-url-oLux_57a.d.cts → athena-request-headers-C7Jy-c_D.d.ts}

@@ -1,3 +1,5 @@
+import { t as BackendOption } from './types-Bltx6iL6.js';
+
 /**
  * Cookie name prefixes treated as Athena Auth / Better Auth session material.
  *
@@ -374,4 +376,86 @@ declare function resolveEmailVerificationCallbackUrl(rawBaseUrl?: string | EnvLi
  */
 declare function createFreshSessionLookupUrl(baseUrl: string | URL): URL;
 
-export { ATHENA_AUTH_COOKIE_PREFIXES as A, AUTH_SESSION_PATH as B, type ClearAuthCookiesOptions as C, DEFAULT_ATHENA_AUTH_ORIGIN as D, type EnvLike as E, AUTH_TWO_FACTOR_SEGMENT as F, type AthenaAuthClientBaseUrlOptions as G, type AthenaAuthUpstreamEnv as H, type AthenaAuthUpstreamEnvKey as I, type AuthMode as J, type AuthModeRedirects as K, type AuthRoutes as L, DEFAULT_ATHENA_AUTH_UPSTREAM_URL as M, DEFAULT_AUTH_COOKIE_PREFIXES as N, DISABLE_COOKIE_CACHE_QUERY_PARAM as O, DISABLE_COOKIE_CACHE_QUERY_VALUE as P, LOCAL_DEV_ORIGIN as Q, createAuthModeRedirects as R, SESSION_DATA_HEADER as S, createAuthRoutes as T, createFreshSessionLookupUrl as U, isAuthMode as V, readAthenaAuthUpstreamUrlFromEnv as W, resolveAuthModeRedirect as X, shouldRedirectAuthenticatedAuthMode as Y, ATHENA_AUTH_PATH as a, ATHENA_AUTH_UPSTREAM_ENV_KEYS as b, ATHENA_AUTH_UPSTREAM_URL_ENV_NAMES as c, AUTH_DEFAULT_VIEW as d, AUTH_ROUTES as e, AUTH_VIEW_BY_SEGMENT as f, type AuthView as g, clearAuthCookies as h, isAbsoluteUrl as i, resolveAthenaAuthRequestUrl as j, resolveAthenaAuthUpstreamUrl as k, resolveAuthViewFromSegment as l, resolveEmailVerificationCallbackUrl as m, normalizeAthenaAuthBaseUrl as n, ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_PARAM as o, ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_VALUE as p, ATHENA_AUTH_GET_SESSION_ABSOLUTE_PATH as q, resolveAthenaAuthClientBaseUrl as r, shouldRedirectAuthenticatedAuthView as s, ATHENA_AUTH_GET_SESSION_PATH as t, ATHENA_AUTH_VERIFY_EMAIL_PATH as u, ATHENA_SESSION_DATA_HEADER as v, AUTHENTICATED_REDIRECT_MODE_SET as w, AUTHENTICATED_REDIRECT_VIEW_SET as x, AUTH_MODE_REDIRECTS as y, AUTH_MODE_SET as z };
+declare function asString(value: unknown): string | null;
+declare function asBoolean(value: unknown): boolean;
+declare function asBooleanOrNull(value: unknown): boolean | null;
+declare function asRecord(value: unknown): Record<string, unknown> | null;
+declare function asIdentifier(value: unknown): string | null;
+declare function firstString(record: Record<string, unknown> | null | undefined, keys: readonly string[]): string | null;
+declare function readTrimmedString(value: unknown): string | null;
+/**
+ * Trim a string value; return `undefined` when not a non-empty string.
+ *
+ * Unlike {@link asString}, does not coerce numbers/bigints.
+ * Unlike {@link readTrimmedString}, returns `undefined` instead of `null`
+ * (handy for optional fields and `??` defaults).
+ */
+declare function asNonEmptyString(value: unknown): string | undefined;
+declare function asNumber(value: unknown): number | null;
+declare function asStringArray(value: unknown): string[];
+
+type AthenaRequestHeaderProfile = 'gateway' | 'auth' | 'chat' | 'storage' | 'minimal';
+interface BuildAthenaRequestHeadersInput {
+    profile: AthenaRequestHeaderProfile;
+    sdkHeaderValue: string;
+    apiKey?: string | null;
+    client?: string | null;
+    userId?: string | null;
+    organizationId?: string | null;
+    backend?: BackendOption;
+    publishEvent?: string | null;
+    stripNulls?: boolean;
+    bearerToken?: string | null;
+    cookie?: string | null;
+    sessionToken?: string | null;
+    pgUri?: string | null;
+    jdbcUrl?: string | null;
+    forceNoCache?: boolean;
+    configHeaders?: Record<string, string>;
+    callHeaders?: Record<string, string>;
+    contentType?: string | null;
+    accept?: string | null;
+}
+/** Shared config/call fields consumed by gateway, chat, auth, and `client.request(...)`. */
+interface AthenaRequestHeaderOverrideFields {
+    apiKey?: string | null;
+    client?: string | null;
+    userId?: string | null;
+    organizationId?: string | null;
+    backend?: BackendOption;
+    publishEvent?: string | null;
+    stripNulls?: boolean;
+    bearerToken?: string | null;
+    cookie?: string | null;
+    sessionToken?: string | null;
+    pgUri?: string | null;
+    jdbcUrl?: string | null;
+    forceNoCache?: boolean;
+    headers?: Record<string, string>;
+}
+type ResolvedRequestHeaderOverrides = Omit<BuildAthenaRequestHeadersInput, 'profile' | 'sdkHeaderValue' | 'contentType' | 'accept'>;
+declare function hasHeaderIgnoreCase(headers: Record<string, string>, targetKey: string): boolean;
+declare function resolveHeaderValue(headers: Record<string, string>, candidates: readonly string[]): string | undefined;
+declare function resolveRequestHeaderOverrides(config: AthenaRequestHeaderOverrideFields, options?: AthenaRequestHeaderOverrideFields, defaults?: Pick<AthenaRequestHeaderOverrideFields, 'client' | 'stripNulls'>): ResolvedRequestHeaderOverrides;
+declare function buildServiceRequestHeaders(profile: Exclude<AthenaRequestHeaderProfile, 'minimal'>, sdkHeaderValue: string, config: AthenaRequestHeaderOverrideFields, options?: AthenaRequestHeaderOverrideFields, extras?: Pick<BuildAthenaRequestHeadersInput, 'contentType' | 'accept'> & {
+    client?: string | null;
+    stripNulls?: boolean;
+}): Record<string, string>;
+declare function applyAthenaApiKeyHeaders(headers: Record<string, string>, apiKey?: string | null): void;
+declare function applyAthenaAuthContextHeaders(headers: Record<string, string>, input: Pick<BuildAthenaRequestHeadersInput, 'bearerToken' | 'cookie' | 'sessionToken' | 'profile' | 'configHeaders' | 'callHeaders'>): void;
+declare function applyAthenaPgUriHeaders(headers: Record<string, string>, input: Pick<BuildAthenaRequestHeadersInput, 'pgUri' | 'jdbcUrl' | 'configHeaders' | 'callHeaders'>): void;
+/**
+ * Minimal gateway/data request headers used by many apps before they adopt
+ * the full {@link buildAthenaRequestHeaders} profile model.
+ *
+ * Additive convenience — does not replace client-built headers. Prefer
+ * `createClient({ client, key })` so the SDK sets these on every call.
+ */
+declare function buildAthenaGatewayHeaders(input: {
+    clientName?: string | null;
+    gatewayKey?: string | null;
+    headers?: Record<string, string | null | undefined>;
+}): 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 };

package/dist/{athena-auth-url-oLux_57a.d.ts → athena-request-headers-DujFFyMU.d.cts}

@@ -1,3 +1,5 @@
+import { t as BackendOption } from './types-Bltx6iL6.cjs';
+
 /**
  * Cookie name prefixes treated as Athena Auth / Better Auth session material.
  *
@@ -374,4 +376,86 @@ declare function resolveEmailVerificationCallbackUrl(rawBaseUrl?: string | EnvLi
  */
 declare function createFreshSessionLookupUrl(baseUrl: string | URL): URL;
 
-export { ATHENA_AUTH_COOKIE_PREFIXES as A, AUTH_SESSION_PATH as B, type ClearAuthCookiesOptions as C, DEFAULT_ATHENA_AUTH_ORIGIN as D, type EnvLike as E, AUTH_TWO_FACTOR_SEGMENT as F, type AthenaAuthClientBaseUrlOptions as G, type AthenaAuthUpstreamEnv as H, type AthenaAuthUpstreamEnvKey as I, type AuthMode as J, type AuthModeRedirects as K, type AuthRoutes as L, DEFAULT_ATHENA_AUTH_UPSTREAM_URL as M, DEFAULT_AUTH_COOKIE_PREFIXES as N, DISABLE_COOKIE_CACHE_QUERY_PARAM as O, DISABLE_COOKIE_CACHE_QUERY_VALUE as P, LOCAL_DEV_ORIGIN as Q, createAuthModeRedirects as R, SESSION_DATA_HEADER as S, createAuthRoutes as T, createFreshSessionLookupUrl as U, isAuthMode as V, readAthenaAuthUpstreamUrlFromEnv as W, resolveAuthModeRedirect as X, shouldRedirectAuthenticatedAuthMode as Y, ATHENA_AUTH_PATH as a, ATHENA_AUTH_UPSTREAM_ENV_KEYS as b, ATHENA_AUTH_UPSTREAM_URL_ENV_NAMES as c, AUTH_DEFAULT_VIEW as d, AUTH_ROUTES as e, AUTH_VIEW_BY_SEGMENT as f, type AuthView as g, clearAuthCookies as h, isAbsoluteUrl as i, resolveAthenaAuthRequestUrl as j, resolveAthenaAuthUpstreamUrl as k, resolveAuthViewFromSegment as l, resolveEmailVerificationCallbackUrl as m, normalizeAthenaAuthBaseUrl as n, ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_PARAM as o, ATHENA_AUTH_DISABLE_COOKIE_CACHE_QUERY_VALUE as p, ATHENA_AUTH_GET_SESSION_ABSOLUTE_PATH as q, resolveAthenaAuthClientBaseUrl as r, shouldRedirectAuthenticatedAuthView as s, ATHENA_AUTH_GET_SESSION_PATH as t, ATHENA_AUTH_VERIFY_EMAIL_PATH as u, ATHENA_SESSION_DATA_HEADER as v, AUTHENTICATED_REDIRECT_MODE_SET as w, AUTHENTICATED_REDIRECT_VIEW_SET as x, AUTH_MODE_REDIRECTS as y, AUTH_MODE_SET as z };
+declare function asString(value: unknown): string | null;
+declare function asBoolean(value: unknown): boolean;
+declare function asBooleanOrNull(value: unknown): boolean | null;
+declare function asRecord(value: unknown): Record<string, unknown> | null;
+declare function asIdentifier(value: unknown): string | null;
+declare function firstString(record: Record<string, unknown> | null | undefined, keys: readonly string[]): string | null;
+declare function readTrimmedString(value: unknown): string | null;
+/**
+ * Trim a string value; return `undefined` when not a non-empty string.
+ *
+ * Unlike {@link asString}, does not coerce numbers/bigints.
+ * Unlike {@link readTrimmedString}, returns `undefined` instead of `null`
+ * (handy for optional fields and `??` defaults).
+ */
+declare function asNonEmptyString(value: unknown): string | undefined;
+declare function asNumber(value: unknown): number | null;
+declare function asStringArray(value: unknown): string[];
+
+type AthenaRequestHeaderProfile = 'gateway' | 'auth' | 'chat' | 'storage' | 'minimal';
+interface BuildAthenaRequestHeadersInput {
+    profile: AthenaRequestHeaderProfile;
+    sdkHeaderValue: string;
+    apiKey?: string | null;
+    client?: string | null;
+    userId?: string | null;
+    organizationId?: string | null;
+    backend?: BackendOption;
+    publishEvent?: string | null;
+    stripNulls?: boolean;
+    bearerToken?: string | null;
+    cookie?: string | null;
+    sessionToken?: string | null;
+    pgUri?: string | null;
+    jdbcUrl?: string | null;
+    forceNoCache?: boolean;
+    configHeaders?: Record<string, string>;
+    callHeaders?: Record<string, string>;
+    contentType?: string | null;
+    accept?: string | null;
+}
+/** Shared config/call fields consumed by gateway, chat, auth, and `client.request(...)`. */
+interface AthenaRequestHeaderOverrideFields {
+    apiKey?: string | null;
+    client?: string | null;
+    userId?: string | null;
+    organizationId?: string | null;
+    backend?: BackendOption;
+    publishEvent?: string | null;
+    stripNulls?: boolean;
+    bearerToken?: string | null;
+    cookie?: string | null;
+    sessionToken?: string | null;
+    pgUri?: string | null;
+    jdbcUrl?: string | null;
+    forceNoCache?: boolean;
+    headers?: Record<string, string>;
+}
+type ResolvedRequestHeaderOverrides = Omit<BuildAthenaRequestHeadersInput, 'profile' | 'sdkHeaderValue' | 'contentType' | 'accept'>;
+declare function hasHeaderIgnoreCase(headers: Record<string, string>, targetKey: string): boolean;
+declare function resolveHeaderValue(headers: Record<string, string>, candidates: readonly string[]): string | undefined;
+declare function resolveRequestHeaderOverrides(config: AthenaRequestHeaderOverrideFields, options?: AthenaRequestHeaderOverrideFields, defaults?: Pick<AthenaRequestHeaderOverrideFields, 'client' | 'stripNulls'>): ResolvedRequestHeaderOverrides;
+declare function buildServiceRequestHeaders(profile: Exclude<AthenaRequestHeaderProfile, 'minimal'>, sdkHeaderValue: string, config: AthenaRequestHeaderOverrideFields, options?: AthenaRequestHeaderOverrideFields, extras?: Pick<BuildAthenaRequestHeadersInput, 'contentType' | 'accept'> & {
+    client?: string | null;
+    stripNulls?: boolean;
+}): Record<string, string>;
+declare function applyAthenaApiKeyHeaders(headers: Record<string, string>, apiKey?: string | null): void;
+declare function applyAthenaAuthContextHeaders(headers: Record<string, string>, input: Pick<BuildAthenaRequestHeadersInput, 'bearerToken' | 'cookie' | 'sessionToken' | 'profile' | 'configHeaders' | 'callHeaders'>): void;
+declare function applyAthenaPgUriHeaders(headers: Record<string, string>, input: Pick<BuildAthenaRequestHeadersInput, 'pgUri' | 'jdbcUrl' | 'configHeaders' | 'callHeaders'>): void;
+/**
+ * Minimal gateway/data request headers used by many apps before they adopt
+ * the full {@link buildAthenaRequestHeaders} profile model.
+ *
+ * Additive convenience — does not replace client-built headers. Prefer
+ * `createClient({ client, key })` so the SDK sets these on every call.
+ */
+declare function buildAthenaGatewayHeaders(input: {
+    clientName?: string | null;
+    gatewayKey?: string | null;
+    headers?: Record<string, string | null | undefined>;
+}): 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 };