@xylex-group/athena 3.1.0 → 3.5.1

package/dist/env.js

@@ -0,0 +1,122 @@
+// src/env/index.ts
+var ATHENA_ENV_PRIMARY_KEYS = {
+  url: "ATHENA_URL",
+  apiKey: "ATHENA_API_KEY",
+  client: "ATHENA_CLIENT",
+  authUrl: "ATHENA_AUTH_URL"
+};
+var ATHENA_ENV_LEGACY_URL_KEYS = [
+  "ATHENA_URL",
+  "NEXT_PUBLIC_ATHENA_URL",
+  "ATHENA_GATEWAY_URL",
+  "NEXT_PUBLIC_ATHENA_GATEWAY_URL"
+];
+var ATHENA_ENV_LEGACY_API_KEY_KEYS = [
+  "ATHENA_API_KEY",
+  "ATHENA_KEY",
+  "ATHENA_PUBLISHABLE_KEY",
+  "NEXT_PUBLIC_ATHENA_API_KEY",
+  "NEXT_PUBLIC_ATHENA_PUBLISHABLE_KEY"
+];
+var ATHENA_ENV_LEGACY_CLIENT_KEYS = [
+  "ATHENA_CLIENT",
+  "NEXT_PUBLIC_ATHENA_CLIENT",
+  "ATHENA_CLIENT_NAME"
+];
+var ATHENA_ENV_LEGACY_AUTH_URL_KEYS = [
+  "ATHENA_AUTH_URL",
+  "ATHENA_AUTH_UPSTREAM_URL",
+  "NEXT_PUBLIC_ATHENA_AUTH_URL",
+  "NEXT_PUBLIC_ATHENA_AUTH_UPSTREAM_URL"
+];
+function readProcessEnv() {
+  try {
+    return globalThis.process?.env ?? {};
+  } catch {
+    return {};
+  }
+}
+function candidatesFor(field, legacyAliases) {
+  const primary = ATHENA_ENV_PRIMARY_KEYS[field];
+  if (!legacyAliases) return [primary];
+  switch (field) {
+    case "url":
+      return ATHENA_ENV_LEGACY_URL_KEYS;
+    case "apiKey":
+      return ATHENA_ENV_LEGACY_API_KEY_KEYS;
+    case "client":
+      return ATHENA_ENV_LEGACY_CLIENT_KEYS;
+    case "authUrl":
+      return ATHENA_ENV_LEGACY_AUTH_URL_KEYS;
+    default:
+      return [primary];
+  }
+}
+function pickField(field, source, legacyAliases, ignored) {
+  const keys = candidatesFor(field, legacyAliases);
+  let chosen = {};
+  for (const key of keys) {
+    const raw = source[key]?.trim();
+    if (!raw) continue;
+    if (!chosen.value) {
+      chosen = { value: raw, key };
+    } else {
+      ignored.push({ field, key });
+    }
+  }
+  return chosen;
+}
+function resolveAthenaEnv(options = {}) {
+  const source = options.env ?? readProcessEnv();
+  const legacyAliases = options.legacyAliases === true;
+  const ignored = [];
+  const url = pickField("url", source, legacyAliases, ignored);
+  const apiKey = pickField("apiKey", source, legacyAliases, ignored);
+  const client = pickField("client", source, legacyAliases, ignored);
+  const authUrl = pickField("authUrl", source, legacyAliases, ignored);
+  const result = {
+    url: url.value,
+    apiKey: apiKey.value,
+    client: client.value,
+    authUrl: authUrl.value,
+    sources: {
+      ...url.key ? { url: url.key } : {},
+      ...apiKey.key ? { apiKey: apiKey.key } : {},
+      ...client.key ? { client: client.key } : {},
+      ...authUrl.key ? { authUrl: authUrl.key } : {}
+    },
+    ignored
+  };
+  const shouldDebug = options.debug === true || options.debug !== false && globalThis.process?.env?.ATHENA_ENV_DEBUG === "1";
+  if (shouldDebug) {
+    console.info("[athena/env] resolved", {
+      sources: result.sources,
+      ignored: result.ignored,
+      hasUrl: Boolean(result.url),
+      hasApiKey: Boolean(result.apiKey),
+      hasClient: Boolean(result.client),
+      hasAuthUrl: Boolean(result.authUrl)
+    });
+  }
+  return result;
+}
+function requireAthenaEnv(options = {}) {
+  const resolved = resolveAthenaEnv(options);
+  if (!resolved.url || !resolved.apiKey) {
+    const missing = [];
+    if (!resolved.url) missing.push(ATHENA_ENV_PRIMARY_KEYS.url);
+    if (!resolved.apiKey) missing.push(ATHENA_ENV_PRIMARY_KEYS.apiKey);
+    throw new Error(
+      `Missing required Athena env: ${missing.join(", ")}. ` + (options.legacyAliases ? "Legacy aliases were enabled but none resolved." : "Set primary keys, or pass legacyAliases: true for historical names.")
+    );
+  }
+  return {
+    ...resolved,
+    url: resolved.url,
+    apiKey: resolved.apiKey
+  };
+}
+
+export { ATHENA_ENV_LEGACY_API_KEY_KEYS, ATHENA_ENV_LEGACY_AUTH_URL_KEYS, ATHENA_ENV_LEGACY_CLIENT_KEYS, ATHENA_ENV_LEGACY_URL_KEYS, ATHENA_ENV_PRIMARY_KEYS, requireAthenaEnv, resolveAthenaEnv };
+//# sourceMappingURL=env.js.map
+//# sourceMappingURL=env.js.map

package/dist/env.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/env/index.ts"],"names":[],"mappings":";AAgBO,IAAM,uBAAA,GAA0B;AAAA,EACrC,GAAA,EAAK,YAAA;AAAA,EACL,MAAA,EAAQ,gBAAA;AAAA,EACR,MAAA,EAAQ,eAAA;AAAA,EACR,OAAA,EAAS;AACX;AAGO,IAAM,0BAAA,GAA6B;AAAA,EACxC,YAAA;AAAA,EACA,wBAAA;AAAA,EACA,oBAAA;AAAA,EACA;AACF;AAGO,IAAM,8BAAA,GAAiC;AAAA,EAC5C,gBAAA;AAAA,EACA,YAAA;AAAA,EACA,wBAAA;AAAA,EACA,4BAAA;AAAA,EACA;AACF;AAGO,IAAM,6BAAA,GAAgC;AAAA,EAC3C,eAAA;AAAA,EACA,2BAAA;AAAA,EACA;AACF;AAGO,IAAM,+BAAA,GAAkC;AAAA,EAC7C,iBAAA;AAAA,EACA,0BAAA;AAAA,EACA,6BAAA;AAAA,EACA;AACF;AA2BA,SAAS,cAAA,GAA0B;AACjC,EAAA,IAAI;AACF,IAAA,OAAQ,UAAA,CAA+C,OAAA,EAAS,GAAA,IAAO,EAAC;AAAA,EAC1E,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,EAAC;AAAA,EACV;AACF;AAEA,SAAS,aAAA,CACP,OACA,aAAA,EACmB;AACnB,EAAA,MAAM,OAAA,GAAU,wBAAwB,KAAK,CAAA;AAC7C,EAAA,IAAI,CAAC,aAAA,EAAe,OAAO,CAAC,OAAO,CAAA;AAEnC,EAAA,QAAQ,KAAA;AAAO,IACb,KAAK,KAAA;AACH,MAAA,OAAO,0BAAA;AAAA,IACT,KAAK,QAAA;AACH,MAAA,OAAO,8BAAA;AAAA,IACT,KAAK,QAAA;AACH,MAAA,OAAO,6BAAA;AAAA,IACT,KAAK,SAAA;AACH,MAAA,OAAO,+BAAA;AAAA,IACT;AACE,MAAA,OAAO,CAAC,OAAO,CAAA;AAAA;AAErB;AAEA,SAAS,SAAA,CACP,KAAA,EACA,MAAA,EACA,aAAA,EACA,OAAA,EACkC;AAClC,EAAA,MAAM,IAAA,GAAO,aAAA,CAAc,KAAA,EAAO,aAAa,CAAA;AAC/C,EAAA,IAAI,SAA2C,EAAC;AAEhD,EAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,IAAA,MAAM,GAAA,GAAM,MAAA,CAAO,GAAG,CAAA,EAAG,IAAA,EAAK;AAC9B,IAAA,IAAI,CAAC,GAAA,EAAK;AACV,IAAA,IAAI,CAAC,OAAO,KAAA,EAAO;AACjB,MAAA,MAAA,GAAS,EAAE,KAAA,EAAO,GAAA,EAAK,GAAA,EAAI;AAAA,IAC7B,CAAA,MAAO;AACL,MAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,KAAA,EAAO,GAAA,EAAK,CAAA;AAAA,IAC7B;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AAOO,SAAS,gBAAA,CACd,OAAA,GAAmC,EAAC,EACf;AACrB,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,GAAA,IAAO,cAAA,EAAe;AAC7C,EAAA,MAAM,aAAA,GAAgB,QAAQ,aAAA,KAAkB,IAAA;AAChD,EAAA,MAAM,UAA0C,EAAC;AAEjD,EAAA,MAAM,GAAA,GAAM,SAAA,CAAU,KAAA,EAAO,MAAA,EAAQ,eAAe,OAAO,CAAA;AAC3D,EAAA,MAAM,MAAA,GAAS,SAAA,CAAU,QAAA,EAAU,MAAA,EAAQ,eAAe,OAAO,CAAA;AACjE,EAAA,MAAM,MAAA,GAAS,SAAA,CAAU,QAAA,EAAU,MAAA,EAAQ,eAAe,OAAO,CAAA;AACjE,EAAA,MAAM,OAAA,GAAU,SAAA,CAAU,SAAA,EAAW,MAAA,EAAQ,eAAe,OAAO,CAAA;AAEnE,EAAA,MAAM,MAAA,GAA8B;AAAA,IAClC,KAAK,GAAA,CAAI,KAAA;AAAA,IACT,QAAQ,MAAA,CAAO,KAAA;AAAA,IACf,QAAQ,MAAA,CAAO,KAAA;AAAA,IACf,SAAS,OAAA,CAAQ,KAAA;AAAA,IACjB,OAAA,EAAS;AAAA,MACP,GAAI,IAAI,GAAA,GAAM,EAAE,KAAK,GAAA,CAAI,GAAA,KAAQ,EAAC;AAAA,MAClC,GAAI,OAAO,GAAA,GAAM,EAAE,QAAQ,MAAA,CAAO,GAAA,KAAQ,EAAC;AAAA,MAC3C,GAAI,OAAO,GAAA,GAAM,EAAE,QAAQ,MAAA,CAAO,GAAA,KAAQ,EAAC;AAAA,MAC3C,GAAI,QAAQ,GAAA,GAAM,EAAE,SAAS,OAAA,CAAQ,GAAA,KAAQ;AAAC,KAChD;AAAA,IACA;AAAA,GACF;AAEA,EAAA,MAAM,WAAA,GACJ,OAAA,CAAQ,KAAA,KAAU,IAAA,IACjB,OAAA,CAAQ,UAAU,KAAA,IAChB,UAAA,CAAqE,OAAA,EAAS,GAAA,EAC3E,gBAAA,KAAqB,GAAA;AAE7B,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,OAAA,CAAQ,KAAK,uBAAA,EAAyB;AAAA,MACpC,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,MAAA,EAAQ,OAAA,CAAQ,MAAA,CAAO,GAAG,CAAA;AAAA,MAC1B,SAAA,EAAW,OAAA,CAAQ,MAAA,CAAO,MAAM,CAAA;AAAA,MAChC,SAAA,EAAW,OAAA,CAAQ,MAAA,CAAO,MAAM,CAAA;AAAA,MAChC,UAAA,EAAY,OAAA,CAAQ,MAAA,CAAO,OAAO;AAAA,KACnC,CAAA;AAAA,EACH;AAEA,EAAA,OAAO,MAAA;AACT;AAKO,SAAS,gBAAA,CACd,OAAA,GAAmC,EAAC,EACmB;AACvD,EAAA,MAAM,QAAA,GAAW,iBAAiB,OAAO,CAAA;AACzC,EAAA,IAAI,CAAC,QAAA,CAAS,GAAA,IAAO,CAAC,SAAS,MAAA,EAAQ;AACrC,IAAA,MAAM,UAAoB,EAAC;AAC3B,IAAA,IAAI,CAAC,QAAA,CAAS,GAAA,EAAK,OAAA,CAAQ,IAAA,CAAK,wBAAwB,GAAG,CAAA;AAC3D,IAAA,IAAI,CAAC,QAAA,CAAS,MAAA,EAAQ,OAAA,CAAQ,IAAA,CAAK,wBAAwB,MAAM,CAAA;AACjE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,6BAAA,EAAgC,QAAQ,IAAA,CAAK,IAAI,CAAC,CAAA,EAAA,CAAA,IAC/C,OAAA,CAAQ,gBACL,gDAAA,GACA,qEAAA;AAAA,KACR;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,GAAG,QAAA;AAAA,IACH,KAAK,QAAA,CAAS,GAAA;AAAA,IACd,QAAQ,QAAA,CAAS;AAAA,GACnB;AACF","file":"env.js","sourcesContent":["/**\n * Canonical Athena environment resolution.\n *\n * Primary keys (default):\n * - `ATHENA_URL`\n * - `ATHENA_API_KEY`\n * - `ATHENA_CLIENT`\n * - `ATHENA_AUTH_URL`\n *\n * Pass `legacyAliases: true` to also accept historical multi-key sets used by\n * older apps and generators.\n */\n\nimport type { EnvLike } from '../utils/athena-auth-url.ts'\n\n/** Recommended primary environment keys. */\nexport const ATHENA_ENV_PRIMARY_KEYS = {\n  url: 'ATHENA_URL',\n  apiKey: 'ATHENA_API_KEY',\n  client: 'ATHENA_CLIENT',\n  authUrl: 'ATHENA_AUTH_URL',\n} as const\n\n/** Legacy URL aliases (order = priority within the alias set). */\nexport const ATHENA_ENV_LEGACY_URL_KEYS = [\n  'ATHENA_URL',\n  'NEXT_PUBLIC_ATHENA_URL',\n  'ATHENA_GATEWAY_URL',\n  'NEXT_PUBLIC_ATHENA_GATEWAY_URL',\n] as const\n\n/** Legacy API key aliases. */\nexport const ATHENA_ENV_LEGACY_API_KEY_KEYS = [\n  'ATHENA_API_KEY',\n  'ATHENA_KEY',\n  'ATHENA_PUBLISHABLE_KEY',\n  'NEXT_PUBLIC_ATHENA_API_KEY',\n  'NEXT_PUBLIC_ATHENA_PUBLISHABLE_KEY',\n] as const\n\n/** Legacy client-name aliases. */\nexport const ATHENA_ENV_LEGACY_CLIENT_KEYS = [\n  'ATHENA_CLIENT',\n  'NEXT_PUBLIC_ATHENA_CLIENT',\n  'ATHENA_CLIENT_NAME',\n] as const\n\n/** Legacy auth URL aliases. */\nexport const ATHENA_ENV_LEGACY_AUTH_URL_KEYS = [\n  'ATHENA_AUTH_URL',\n  'ATHENA_AUTH_UPSTREAM_URL',\n  'NEXT_PUBLIC_ATHENA_AUTH_URL',\n  'NEXT_PUBLIC_ATHENA_AUTH_UPSTREAM_URL',\n] as const\n\nexport type AthenaEnvField = 'url' | 'apiKey' | 'client' | 'authUrl'\n\nexport interface ResolveAthenaEnvOptions {\n  /** Explicit env map. Defaults to `process.env` when available. */\n  env?: EnvLike\n  /**\n   * When true, fall back to {@link ATHENA_ENV_LEGACY_*_KEYS} after primary keys.\n   * Default false so new apps only document one key set.\n   */\n  legacyAliases?: boolean\n  /** Log which keys resolved and which were ignored (non-production only unless forced). */\n  debug?: boolean\n}\n\nexport interface AthenaEnvResolution {\n  url?: string\n  apiKey?: string\n  client?: string\n  authUrl?: string\n  /** Key that supplied each field, when present. */\n  sources: Partial<Record<AthenaEnvField, string>>\n  /** Non-empty keys that were considered but not chosen (lower priority). */\n  ignored: Array<{ field: AthenaEnvField; key: string }>\n}\n\nfunction readProcessEnv(): EnvLike {\n  try {\n    return (globalThis as { process?: { env?: EnvLike } }).process?.env ?? {}\n  } catch {\n    return {}\n  }\n}\n\nfunction candidatesFor(\n  field: AthenaEnvField,\n  legacyAliases: boolean,\n): readonly string[] {\n  const primary = ATHENA_ENV_PRIMARY_KEYS[field]\n  if (!legacyAliases) return [primary]\n\n  switch (field) {\n    case 'url':\n      return ATHENA_ENV_LEGACY_URL_KEYS\n    case 'apiKey':\n      return ATHENA_ENV_LEGACY_API_KEY_KEYS\n    case 'client':\n      return ATHENA_ENV_LEGACY_CLIENT_KEYS\n    case 'authUrl':\n      return ATHENA_ENV_LEGACY_AUTH_URL_KEYS\n    default:\n      return [primary]\n  }\n}\n\nfunction pickField(\n  field: AthenaEnvField,\n  source: EnvLike,\n  legacyAliases: boolean,\n  ignored: AthenaEnvResolution['ignored'],\n): { value?: string; key?: string } {\n  const keys = candidatesFor(field, legacyAliases)\n  let chosen: { value?: string; key?: string } = {}\n\n  for (const key of keys) {\n    const raw = source[key]?.trim()\n    if (!raw) continue\n    if (!chosen.value) {\n      chosen = { value: raw, key }\n    } else {\n      ignored.push({ field, key })\n    }\n  }\n\n  return chosen\n}\n\n/**\n * Resolve Athena connection settings from an env map.\n *\n * Primary keys only unless `legacyAliases: true`.\n */\nexport function resolveAthenaEnv(\n  options: ResolveAthenaEnvOptions = {},\n): AthenaEnvResolution {\n  const source = options.env ?? readProcessEnv()\n  const legacyAliases = options.legacyAliases === true\n  const ignored: AthenaEnvResolution['ignored'] = []\n\n  const url = pickField('url', source, legacyAliases, ignored)\n  const apiKey = pickField('apiKey', source, legacyAliases, ignored)\n  const client = pickField('client', source, legacyAliases, ignored)\n  const authUrl = pickField('authUrl', source, legacyAliases, ignored)\n\n  const result: AthenaEnvResolution = {\n    url: url.value,\n    apiKey: apiKey.value,\n    client: client.value,\n    authUrl: authUrl.value,\n    sources: {\n      ...(url.key ? { url: url.key } : {}),\n      ...(apiKey.key ? { apiKey: apiKey.key } : {}),\n      ...(client.key ? { client: client.key } : {}),\n      ...(authUrl.key ? { authUrl: authUrl.key } : {}),\n    },\n    ignored,\n  }\n\n  const shouldDebug =\n    options.debug === true ||\n    (options.debug !== false &&\n      (globalThis as { process?: { env?: { ATHENA_ENV_DEBUG?: string } } }).process?.env\n        ?.ATHENA_ENV_DEBUG === '1')\n\n  if (shouldDebug) {\n    console.info('[athena/env] resolved', {\n      sources: result.sources,\n      ignored: result.ignored,\n      hasUrl: Boolean(result.url),\n      hasApiKey: Boolean(result.apiKey),\n      hasClient: Boolean(result.client),\n      hasAuthUrl: Boolean(result.authUrl),\n    })\n  }\n\n  return result\n}\n\n/**\n * Like {@link resolveAthenaEnv}, but throws when `url` or `apiKey` is missing.\n */\nexport function requireAthenaEnv(\n  options: ResolveAthenaEnvOptions = {},\n): AthenaEnvResolution & { url: string; apiKey: string } {\n  const resolved = resolveAthenaEnv(options)\n  if (!resolved.url || !resolved.apiKey) {\n    const missing: string[] = []\n    if (!resolved.url) missing.push(ATHENA_ENV_PRIMARY_KEYS.url)\n    if (!resolved.apiKey) missing.push(ATHENA_ENV_PRIMARY_KEYS.apiKey)\n    throw new Error(\n      `Missing required Athena env: ${missing.join(', ')}. ` +\n        (options.legacyAliases\n          ? 'Legacy aliases were enabled but none resolved.'\n          : 'Set primary keys, or pass legacyAliases: true for historical names.'),\n    )\n  }\n  return {\n    ...resolved,\n    url: resolved.url,\n    apiKey: resolved.apiKey,\n  }\n}\n"]}