@htilabs/platform-common-models 0.9.0 → 0.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/dist/config/index.cjs +4 -0
  2. package/dist/config/index.cjs.map +1 -1
  3. package/dist/config/index.d.cts +16 -1
  4. package/dist/config/index.d.ts +16 -1
  5. package/dist/config/index.js +2 -0
  6. package/dist/config/index.js.map +1 -1
  7. package/dist/constants/index.cjs +473 -182
  8. package/dist/constants/index.cjs.map +1 -1
  9. package/dist/constants/index.d.cts +1 -1
  10. package/dist/constants/index.d.ts +1 -1
  11. package/dist/constants/index.js +470 -170
  12. package/dist/constants/index.js.map +1 -1
  13. package/dist/cvc-Cp4uWnAa.d.cts +298 -0
  14. package/dist/cvc-Cp4uWnAa.d.ts +298 -0
  15. package/dist/cvcs/index.cjs +21798 -811
  16. package/dist/cvcs/index.cjs.map +1 -1
  17. package/dist/cvcs/index.d.cts +25138 -2212
  18. package/dist/cvcs/index.d.ts +25138 -2212
  19. package/dist/cvcs/index.js +21736 -810
  20. package/dist/cvcs/index.js.map +1 -1
  21. package/dist/enums/index.cjs +4557 -0
  22. package/dist/enums/index.cjs.map +1 -0
  23. package/dist/enums/index.d.cts +5257 -0
  24. package/dist/enums/index.d.ts +5257 -0
  25. package/dist/enums/index.js +4354 -0
  26. package/dist/enums/index.js.map +1 -0
  27. package/dist/index.cjs +24053 -1052
  28. package/dist/index.cjs.map +1 -1
  29. package/dist/index.d.cts +5 -3072
  30. package/dist/index.d.ts +5 -3072
  31. package/dist/index.js +23928 -1039
  32. package/dist/index.js.map +1 -1
  33. package/dist/mongo/index.cjs +383 -0
  34. package/dist/mongo/index.cjs.map +1 -0
  35. package/dist/mongo/index.d.cts +221 -0
  36. package/dist/mongo/index.d.ts +221 -0
  37. package/dist/mongo/index.js +351 -0
  38. package/dist/mongo/index.js.map +1 -0
  39. package/dist/{platform-auth-XVB9aHqR.d.cts → platform-auth-Dv5fu0Fh.d.cts} +22 -77
  40. package/dist/{platform-auth-XVB9aHqR.d.ts → platform-auth-Dv5fu0Fh.d.ts} +22 -77
  41. package/dist/schemas/index.cjs +30 -157
  42. package/dist/schemas/index.cjs.map +1 -1
  43. package/dist/schemas/index.js +30 -157
  44. package/dist/schemas/index.js.map +1 -1
  45. package/dist/services/index.cjs +0 -3
  46. package/dist/services/index.cjs.map +1 -1
  47. package/dist/services/index.js +0 -3
  48. package/dist/services/index.js.map +1 -1
  49. package/dist/types/index.d.cts +2 -2
  50. package/dist/types/index.d.ts +2 -2
  51. package/dist/validation/index.cjs +58 -0
  52. package/dist/validation/index.cjs.map +1 -1
  53. package/dist/validation/index.d.cts +82 -283
  54. package/dist/validation/index.d.ts +82 -283
  55. package/dist/validation/index.js +57 -0
  56. package/dist/validation/index.js.map +1 -1
  57. package/package.json +18 -1
  58. package/src/__sot__/README.md +91 -0
  59. package/src/__sot__/coreIndicatorFields.ts +331 -0
  60. package/src/__sot__/coreIndicators.pin.json +2149 -0
  61. package/src/__sot__/cvcIndex.pin.json +272 -0
  62. package/src/__sot__/scoringEmits.pin.json +176 -0
  63. package/src/__tests__/__snapshots__/cvc-sot.snap +260 -40
  64. package/src/__tests__/core-information-scope-invariant.test.ts +134 -0
  65. package/src/__tests__/cvc-136-scoring-invariant.test.ts +328 -0
  66. package/src/__tests__/cvc-181-182-country-parity.test.ts +163 -0
  67. package/src/__tests__/cvc-drift-gate.test.ts +1036 -0
  68. package/src/__tests__/cvc-sot-snapshot.test.ts +191 -18
  69. package/src/__tests__/cvc-status-parser.test.ts +150 -0
  70. package/src/__tests__/cvc-structural.test.ts +70 -1
  71. package/src/__tests__/mongo-verifier.test.ts +502 -0
  72. package/src/config/index.ts +8 -2
  73. package/src/constants/ic.ts +629 -206
  74. package/src/constants/service-catalog.ts +4 -2
  75. package/src/cvcs/activityType.v1.0.0.json +143 -0
  76. package/src/cvcs/adminRoles.v1.0.0.json +153 -0
  77. package/src/cvcs/administeringJurisdiction.v1.0.0.json +40 -40
  78. package/src/cvcs/ageBinReporting.v1.0.0.json +40 -40
  79. package/src/cvcs/assertionDomain.v1.1.0.json +647 -0
  80. package/src/cvcs/assertionStatus.v1.0.0.json +80 -0
  81. package/src/cvcs/carCorrectionReason.v1.0.0.json +89 -0
  82. package/src/cvcs/caseShareState.v1.0.0.json +62 -0
  83. package/src/cvcs/{checkInPhase.v1.0.0.json → checkInPhase.v1.1.0.json} +20 -2
  84. package/src/cvcs/childChangeType.v1.0.0.json +152 -0
  85. package/src/cvcs/citizenship.v1.0.0.json +3062 -0
  86. package/src/cvcs/contactInfoTypes.v1.0.0.json +40 -40
  87. package/src/cvcs/contactLinkType.v1.0.0.json +89 -0
  88. package/src/cvcs/coreDhState.v1.0.0.json +113 -0
  89. package/src/cvcs/coreFunctions.v1.0.0.json +746 -0
  90. package/src/cvcs/coreIndicators.v1.0.0.json +2918 -0
  91. package/src/cvcs/coreInformationScope.v1.0.0.json +1165 -0
  92. package/src/cvcs/coreReferralOutcome.v1.0.0.json +71 -0
  93. package/src/cvcs/countries.v1.0.0.json +3077 -0
  94. package/src/cvcs/createdBySystem.v1.0.0.json +89 -0
  95. package/src/cvcs/criminalOrgCategory.v1.0.0.json +116 -0
  96. package/src/cvcs/determinationHelperCategories.v1.0.0.json +1166 -0
  97. package/src/cvcs/employmentStatus.v1.0.0.json +60 -60
  98. package/src/cvcs/exploitationType.v1.0.0.json +106 -0
  99. package/src/cvcs/facilitatorEntityType.v1.0.0.json +40 -40
  100. package/src/cvcs/highestEducationLevelCompleted.v1.0.0.json +55 -46
  101. package/src/cvcs/hivStatus.v1.0.0.json +71 -0
  102. package/src/cvcs/hmisCurrentLivingSituation.v1.0.0.json +409 -0
  103. package/src/cvcs/hmisRelationshipToHoh.v1.0.0.json +104 -0
  104. package/src/cvcs/homelessStatus.v1.0.0.json +27 -27
  105. package/src/cvcs/housingSubsidyTypes.v1.0.0.json +161 -0
  106. package/src/cvcs/htType.v1.0.0.json +87 -0
  107. package/src/cvcs/identificationStatus.v1.0.0.json +18 -0
  108. package/src/cvcs/immigrationLegalStatusChangeType.v1.0.0.json +143 -0
  109. package/src/cvcs/incarcerationEpisodeType.v1.0.0.json +106 -0
  110. package/src/cvcs/incidentInvolvementRoles.v1.0.0.json +40 -40
  111. package/src/cvcs/incidentParticipationRoles.v1.0.0.json +47 -37
  112. package/src/cvcs/incomeBenefitsSources.v1.0.0.json +31 -2
  113. package/src/cvcs/index.ts +138 -1
  114. package/src/cvcs/juvenileJusticeEpisodeType.v1.0.0.json +28 -18
  115. package/src/cvcs/juvenileJusticeInvolvementStatus.v1.0.0.json +32 -32
  116. package/src/cvcs/livingSituation.v1.0.0.json +213 -0
  117. package/src/cvcs/mentalHealthStatus.v1.0.0.json +71 -0
  118. package/src/cvcs/militaryBranch.v1.0.0.json +20 -20
  119. package/src/cvcs/militaryStatus.v1.0.0.json +20 -20
  120. package/src/cvcs/minorAdultStatus.v1.0.0.json +80 -0
  121. package/src/cvcs/nameType.v1.0.0.json +40 -40
  122. package/src/cvcs/needsAssessmentChangeType.v1.0.0.json +134 -0
  123. package/src/cvcs/offenderStatus.v1.0.0.json +40 -40
  124. package/src/cvcs/offenderStatusFamily.v1.0.0.json +36 -36
  125. package/src/cvcs/personRelationships.v1.0.0.json +67 -2
  126. package/src/cvcs/poPetitionBasis.v1.0.0.json +96 -0
  127. package/src/cvcs/poStatus.v1.0.0.json +144 -0
  128. package/src/cvcs/poViolationStatus.v1.0.0.json +76 -0
  129. package/src/cvcs/programEnrollmentChangeType.v1.0.0.json +134 -0
  130. package/src/cvcs/provenanceSourceId.v1.0.0.json +134 -0
  131. package/src/cvcs/radiusBucket.v1.0.0.json +110 -0
  132. package/src/cvcs/recencyBand.v1.0.0.json +104 -39
  133. package/src/cvcs/referralEntityCategory.v1.0.0.json +40 -40
  134. package/src/cvcs/referralOrigin.v1.0.0.json +26 -0
  135. package/src/cvcs/relationshipConcern.v1.0.0.json +123 -0
  136. package/src/cvcs/riskCategory.v1.0.0.json +134 -0
  137. package/src/cvcs/riskIdentificationMilestone.v1.0.0.json +109 -0
  138. package/src/cvcs/riskSeverityBand.v1.0.0.json +139 -0
  139. package/src/cvcs/roiMethod.v1.0.0.json +107 -0
  140. package/src/cvcs/roiScope.v1.0.0.json +296 -0
  141. package/src/cvcs/roiStatus.v1.0.0.json +106 -0
  142. package/src/cvcs/romanticRelationshipChangeType.v1.0.0.json +162 -0
  143. package/src/cvcs/serviceAudience.v1.0.0.json +96 -0
  144. package/src/cvcs/serviceCategories.v1.0.0.json +44 -44
  145. package/src/cvcs/serviceDeliveryChannel.v1.0.0.json +147 -0
  146. package/src/cvcs/serviceMechanisms.v1.0.0.json +36 -36
  147. package/src/cvcs/serviceStates.v1.0.0.json +55 -33
  148. package/src/cvcs/sessionNoteVisibility.v1.0.0.json +80 -0
  149. package/src/cvcs/sessionTemplate.v1.0.0.json +283 -0
  150. package/src/cvcs/sexProviderSubrole.v1.0.0.json +35 -28
  151. package/src/cvcs/sharePurpose.v1.0.0.json +80 -12
  152. package/src/cvcs/smtType.v1.0.0.json +40 -40
  153. package/src/cvcs/sourceCategory.v1.1.0.json +8 -1
  154. package/src/cvcs/sourceInstrument.v1.0.0.json +458 -0
  155. package/src/cvcs/sourceSubtype.v1.1.0.json +36 -0
  156. package/src/cvcs/sourceSystem.v1.0.0.json +203 -0
  157. package/src/cvcs/specialNeedsDisabilities.v1.0.0.json +143 -0
  158. package/src/cvcs/subjectType.v1.0.0.json +80 -0
  159. package/src/cvcs/suggestionSource.v1.0.0.json +71 -0
  160. package/src/cvcs/traffickingRelevantRole.v1.0.0.json +104 -0
  161. package/src/cvcs/userRoles.v1.0.0.json +203 -0
  162. package/src/cvcs/verificationMethod.v1.0.0.json +18 -0
  163. package/src/cvcs/victimAbuseTypes.v1.0.0.json +276 -0
  164. package/src/cvcs/victimStatusFamily.v1.0.0.json +40 -40
  165. package/src/cvcs/whyNots.v1.0.0.json +385 -0
  166. package/src/generated/cvc-enums.ts +2318 -10
  167. package/src/mongo/catalog.ts +65 -0
  168. package/src/mongo/contract.ts +157 -0
  169. package/src/mongo/index.ts +343 -0
  170. package/src/mongo/similarity.ts +133 -0
  171. package/src/mongo/uri.ts +53 -0
  172. package/src/services/cvcRegistryService.ts +1 -1
  173. package/src/validation/cvcStatus.ts +209 -0
  174. package/src/validation/index.ts +1 -0
@@ -21,6 +21,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
21
21
  var config_exports = {};
22
22
  __export(config_exports, {
23
23
  createConfigEndpoint: () => createConfigEndpoint,
24
+ loadContract: () => loadContract,
25
+ resolveDefault: () => resolveDefault,
24
26
  validateAgainstContract: () => validateAgainstContract
25
27
  });
26
28
  module.exports = __toCommonJS(config_exports);
@@ -186,6 +188,8 @@ function createConfigEndpoint(runtimeYamlPath, opts = {}) {
186
188
  // Annotate the CommonJS export names for ESM import in node:
187
189
  0 && (module.exports = {
188
190
  createConfigEndpoint,
191
+ loadContract,
192
+ resolveDefault,
189
193
  validateAgainstContract
190
194
  });
191
195
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/config/index.ts"],"sourcesContent":["/**\n * @htilabs/platform-common-models — Runtime Config Contract Validator\n *\n * Implements contract R12.1 (platform-common home):\n * - validateAgainstContract(runtimeYamlPath, opts?) — startup validator (R3.2)\n * - createConfigEndpoint(runtimeYamlPath, opts?) — /api/config factory (R7)\n *\n * Consumers MUST call validateAgainstContract once at process startup, before\n * any other initialization that reads env vars. Build-phase variables\n * (phase: build) are NOT checked at runtime per R3.4.\n *\n * No secret VALUES are read, stored, or returned here. Secret env vars are\n * validated for presence but their values are never logged or exposed.\n *\n * Dual ESM + CJS via tsup. Plain JS consumers (pave, leads) use require():\n * const { validateAgainstContract } = require('@htilabs/platform-common-models/config');\n */\n\nimport { readFileSync } from \"node:fs\";\nimport { parse } from \"yaml\";\n\n// ─── Schema types (mirrors thread's runtime-config-lib.ts VariableSpec) ──────\n\nexport interface VariableSpec {\n type: \"string\" | \"boolean\" | \"number\" | \"enum\" | \"url\" | \"json\";\n required: boolean;\n secret: boolean;\n description: string;\n phase?: \"runtime\" | \"build\";\n values?: string[];\n default?: Record<string, unknown>;\n provider?: string;\n name?: string;\n client_visible?: boolean;\n deprecated?: { since: string; remove_after?: string; replacement?: string };\n}\n\nexport interface ServiceContract {\n service: string;\n version: number;\n environments: string[];\n // Thread extensions (tolerated, not required — R1.1 note)\n port?: number;\n build_secrets?: string[];\n variables: Record<string, VariableSpec>;\n}\n\n/** Typed config accessor returned by validateAgainstContract. */\nexport type TypedConfig = Record<string, string | boolean | number | unknown>;\n\nexport interface ValidateOptions {\n /**\n * Environment name used to select per-env defaults (e.g. \"local\", \"test\").\n * Defaults to process.env.NODE_ENV, then \"local\".\n */\n env?: string;\n /**\n * If true, do not call process.exit(1) on failure; throw instead.\n * Useful for tests. Defaults to false (production mode exits).\n */\n throwOnFailure?: boolean;\n}\n\nexport interface EndpointOptions {\n /** Cache-Control header value. Defaults to \"private, no-store\". */\n cacheControl?: string;\n}\n\n/**\n * A framework-agnostic route handler that returns a JSON response.\n * Compatible with:\n * - Next.js App Router: export const GET = createConfigEndpoint(...)\n * - Fastify: instance.get('/api/config', createConfigEndpoint(...))\n * - Express: app.get('/api/config', createConfigEndpoint(...))\n */\nexport type RouteHandler = (\n req?: unknown,\n res?: unknown,\n) => Promise<Response | void> | Response | void;\n\n// ─── YAML parser ──────────────────────────────────────────────────────────────\n\nfunction loadContract(runtimeYamlPath: string): ServiceContract {\n let raw: string;\n try {\n raw = readFileSync(runtimeYamlPath, \"utf8\");\n } catch (err) {\n const msg =\n err instanceof Error ? err.message : String(err);\n throw new Error(\n `[platform-common/config] Cannot read ${runtimeYamlPath}: ${msg}`,\n );\n }\n const parsed = parse(raw) as ServiceContract | null;\n if (!parsed || typeof parsed !== \"object\") {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: not a YAML mapping`,\n );\n }\n if (parsed.version !== 1) {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: unsupported contract version ${parsed.version} (expected 1)`,\n );\n }\n if (!parsed.variables || typeof parsed.variables !== \"object\") {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: missing \"variables\" map`,\n );\n }\n return parsed;\n}\n\n// ─── Coercion ────────────────────────────────────────────────────────────────\n\n/**\n * Coerce a raw environment string value to the declared type.\n * Returns [ok, coerced] or [false, errorMessage].\n */\nfunction coerce(\n key: string,\n raw: string,\n spec: VariableSpec,\n): [true, unknown] | [false, string] {\n switch (spec.type) {\n case \"boolean\": {\n if (raw === \"true\" || raw === \"1\") return [true, true];\n if (raw === \"false\" || raw === \"0\") return [true, false];\n return [false, `${key}: expected boolean (\"true\"/\"false\"/\"1\"/\"0\"), got \"${raw}\"`];\n }\n case \"number\": {\n const n = Number(raw);\n if (!Number.isFinite(n)) {\n return [false, `${key}: expected number, got \"${raw}\"`];\n }\n return [true, n];\n }\n case \"enum\": {\n const vals = spec.values ?? [];\n if (!vals.includes(raw)) {\n return [false, `${key}: expected one of [${vals.join(\", \")}], got \"${raw}\"`];\n }\n return [true, raw];\n }\n case \"url\": {\n try {\n new URL(raw);\n return [true, raw];\n } catch {\n return [false, `${key}: expected a valid URL, got \"${raw}\"`];\n }\n }\n case \"json\": {\n try {\n const parsed = JSON.parse(raw) as unknown;\n return [true, parsed];\n } catch {\n return [false, `${key}: expected valid JSON, got \"${raw}\"`];\n }\n }\n default:\n // string\n return [true, raw];\n }\n}\n\n// ─── Default application ─────────────────────────────────────────────────────\n\n/**\n * Returns the default value for a variable in the given environment,\n * or undefined if no default applies.\n *\n * Exact env match only — defaults are per-environment and MUST NOT bleed\n * across envs. (A local default stays local; it does not fall back into prod.)\n */\nfunction resolveDefault(\n spec: VariableSpec,\n env: string,\n): string | undefined {\n if (!spec.default) return undefined;\n const v = spec.default[env];\n if (v === undefined) return undefined;\n return String(v);\n}\n\n// ─── validateAgainstContract ─────────────────────────────────────────────────\n\n/**\n * Parse `runtimeYamlPath`, coerce every runtime-phase variable from\n * `process.env` (with per-env defaults applied), and fail fast on any\n * missing or invalid required variable (R3.2).\n *\n * Build-phase variables (phase: build) are skipped per R3.4.\n *\n * Returns a typed config object keyed by variable name.\n */\nexport function validateAgainstContract(\n runtimeYamlPath: string,\n opts: ValidateOptions = {},\n): TypedConfig {\n const contract = loadContract(runtimeYamlPath);\n const env =\n opts.env ??\n (process.env.NODE_ENV as string | undefined) ??\n \"local\";\n\n const errors: string[] = [];\n const result: TypedConfig = {};\n\n for (const [key, spec] of Object.entries(contract.variables)) {\n // R3.4: skip build-phase variables entirely at runtime.\n if (spec.phase === \"build\") continue;\n\n const rawFromEnv = process.env[key];\n const defaultValue = resolveDefault(spec, env);\n const effective = rawFromEnv ?? defaultValue;\n\n if (effective === undefined || effective === \"\") {\n if (spec.required) {\n errors.push(\n `${key}: required but not set (no value in process.env and no default for env \"${env}\")`,\n );\n }\n // Not required and not set — omit from result.\n continue;\n }\n\n const [ok, coerced] = coerce(key, effective, spec);\n if (!ok) {\n errors.push(coerced as string);\n continue;\n }\n result[key] = coerced;\n }\n\n if (errors.length > 0) {\n const message = [\n `[platform-common/config] validateAgainstContract failed for ${runtimeYamlPath}`,\n `${errors.length} variable(s) missing or invalid:`,\n ...errors.map((e) => ` - ${e}`),\n ].join(\"\\n\");\n\n if (opts.throwOnFailure) {\n throw new Error(message);\n }\n console.error(message);\n process.exit(1);\n }\n\n return result;\n}\n\n// ─── createConfigEndpoint ────────────────────────────────────────────────────\n\n/**\n * Build a static JSON payload containing only variables that are\n * client_visible: true AND secret: false (R7.2, R7.3). Reads process.env\n * once at factory call time.\n */\nfunction buildClientPayload(\n contract: ServiceContract,\n env: string,\n): Record<string, unknown> {\n const payload: Record<string, unknown> = {};\n\n for (const [key, spec] of Object.entries(contract.variables)) {\n // R7.3: never expose secrets.\n if (spec.secret) continue;\n // R7.2: only expose client_visible vars.\n if (!spec.client_visible) continue;\n // R3.4: build-phase vars are not available at runtime.\n if (spec.phase === \"build\") continue;\n\n const raw = process.env[key] ?? resolveDefault(spec, env);\n if (raw === undefined) continue;\n\n const [ok, coerced] = coerce(key, raw, spec);\n payload[key] = ok ? coerced : raw;\n }\n\n return payload;\n}\n\n/**\n * Route-handler factory for GET /api/config (R7.1).\n *\n * Reads the contract and process.env once at factory-call time and caches\n * the JSON payload. The returned handler is compatible with:\n *\n * Next.js App Router:\n * export const GET = createConfigEndpoint(path);\n *\n * Fastify:\n * instance.get('/api/config', createConfigEndpoint(path));\n *\n * Express:\n * app.get('/api/config', createConfigEndpoint(path));\n *\n * The handler detects the calling convention at runtime:\n * - Next.js / fetch-native: called with no arguments; returns a Response.\n * - Express: called with (req, res); calls res.json() and returns void.\n * - Fastify: called with (req, reply); calls reply.send() and returns void.\n */\nexport function createConfigEndpoint(\n runtimeYamlPath: string,\n opts: EndpointOptions = {},\n): RouteHandler {\n const contract = loadContract(runtimeYamlPath);\n const env =\n (process.env.NODE_ENV as string | undefined) ?? \"local\";\n const payload = buildClientPayload(contract, env);\n const cacheControl = opts.cacheControl ?? \"private, no-store\";\n const body = JSON.stringify(payload);\n\n return function configHandler(\n _req?: unknown,\n res?: unknown,\n ): Promise<Response | void> | Response | void {\n // Express-shaped: res has .json()\n if (res && typeof (res as Record<string, unknown>)[\"json\"] === \"function\") {\n const r = res as {\n setHeader: (k: string, v: string) => void;\n json: (data: unknown) => void;\n };\n r.setHeader(\"Cache-Control\", cacheControl);\n r.setHeader(\"Content-Type\", \"application/json\");\n r.json(payload);\n return;\n }\n\n // Fastify-shaped: res has .send()\n if (res && typeof (res as Record<string, unknown>)[\"send\"] === \"function\") {\n const r = res as {\n header: (k: string, v: string) => void;\n type: (ct: string) => void;\n send: (data: string) => void;\n };\n r.header(\"Cache-Control\", cacheControl);\n r.type(\"application/json\");\n r.send(body);\n return;\n }\n\n // Next.js / fetch-native (no res argument, or unrecognised res)\n return new Response(body, {\n status: 200,\n headers: {\n \"Content-Type\": \"application/json\",\n \"Cache-Control\": cacheControl,\n },\n });\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkBA,qBAA6B;AAC7B,kBAAsB;AA+DtB,SAAS,aAAa,iBAA0C;AAC9D,MAAI;AACJ,MAAI;AACF,cAAM,6BAAa,iBAAiB,MAAM;AAAA,EAC5C,SAAS,KAAK;AACZ,UAAM,MACJ,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AACjD,UAAM,IAAI;AAAA,MACR,wCAAwC,eAAe,KAAK,GAAG;AAAA,IACjE;AAAA,EACF;AACA,QAAM,aAAS,mBAAM,GAAG;AACxB,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe;AAAA,IAC7C;AAAA,EACF;AACA,MAAI,OAAO,YAAY,GAAG;AACxB,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe,kCAAkC,OAAO,OAAO;AAAA,IAC7F;AAAA,EACF;AACA,MAAI,CAAC,OAAO,aAAa,OAAO,OAAO,cAAc,UAAU;AAC7D,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe;AAAA,IAC7C;AAAA,EACF;AACA,SAAO;AACT;AAQA,SAAS,OACP,KACA,KACA,MACmC;AACnC,UAAQ,KAAK,MAAM;AAAA,IACjB,KAAK,WAAW;AACd,UAAI,QAAQ,UAAU,QAAQ,IAAK,QAAO,CAAC,MAAM,IAAI;AACrD,UAAI,QAAQ,WAAW,QAAQ,IAAK,QAAO,CAAC,MAAM,KAAK;AACvD,aAAO,CAAC,OAAO,GAAG,GAAG,qDAAqD,GAAG,GAAG;AAAA,IAClF;AAAA,IACA,KAAK,UAAU;AACb,YAAM,IAAI,OAAO,GAAG;AACpB,UAAI,CAAC,OAAO,SAAS,CAAC,GAAG;AACvB,eAAO,CAAC,OAAO,GAAG,GAAG,2BAA2B,GAAG,GAAG;AAAA,MACxD;AACA,aAAO,CAAC,MAAM,CAAC;AAAA,IACjB;AAAA,IACA,KAAK,QAAQ;AACX,YAAM,OAAO,KAAK,UAAU,CAAC;AAC7B,UAAI,CAAC,KAAK,SAAS,GAAG,GAAG;AACvB,eAAO,CAAC,OAAO,GAAG,GAAG,sBAAsB,KAAK,KAAK,IAAI,CAAC,WAAW,GAAG,GAAG;AAAA,MAC7E;AACA,aAAO,CAAC,MAAM,GAAG;AAAA,IACnB;AAAA,IACA,KAAK,OAAO;AACV,UAAI;AACF,YAAI,IAAI,GAAG;AACX,eAAO,CAAC,MAAM,GAAG;AAAA,MACnB,QAAQ;AACN,eAAO,CAAC,OAAO,GAAG,GAAG,gCAAgC,GAAG,GAAG;AAAA,MAC7D;AAAA,IACF;AAAA,IACA,KAAK,QAAQ;AACX,UAAI;AACF,cAAM,SAAS,KAAK,MAAM,GAAG;AAC7B,eAAO,CAAC,MAAM,MAAM;AAAA,MACtB,QAAQ;AACN,eAAO,CAAC,OAAO,GAAG,GAAG,+BAA+B,GAAG,GAAG;AAAA,MAC5D;AAAA,IACF;AAAA,IACA;AAEE,aAAO,CAAC,MAAM,GAAG;AAAA,EACrB;AACF;AAWA,SAAS,eACP,MACA,KACoB;AACpB,MAAI,CAAC,KAAK,QAAS,QAAO;AAC1B,QAAM,IAAI,KAAK,QAAQ,GAAG;AAC1B,MAAI,MAAM,OAAW,QAAO;AAC5B,SAAO,OAAO,CAAC;AACjB;AAaO,SAAS,wBACd,iBACA,OAAwB,CAAC,GACZ;AACb,QAAM,WAAW,aAAa,eAAe;AAC7C,QAAM,MACJ,KAAK,OACJ,QAAQ,IAAI,YACb;AAEF,QAAM,SAAmB,CAAC;AAC1B,QAAM,SAAsB,CAAC;AAE7B,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,SAAS,SAAS,GAAG;AAE5D,QAAI,KAAK,UAAU,QAAS;AAE5B,UAAM,aAAa,QAAQ,IAAI,GAAG;AAClC,UAAM,eAAe,eAAe,MAAM,GAAG;AAC7C,UAAM,YAAY,cAAc;AAEhC,QAAI,cAAc,UAAa,cAAc,IAAI;AAC/C,UAAI,KAAK,UAAU;AACjB,eAAO;AAAA,UACL,GAAG,GAAG,2EAA2E,GAAG;AAAA,QACtF;AAAA,MACF;AAEA;AAAA,IACF;AAEA,UAAM,CAAC,IAAI,OAAO,IAAI,OAAO,KAAK,WAAW,IAAI;AACjD,QAAI,CAAC,IAAI;AACP,aAAO,KAAK,OAAiB;AAC7B;AAAA,IACF;AACA,WAAO,GAAG,IAAI;AAAA,EAChB;AAEA,MAAI,OAAO,SAAS,GAAG;AACrB,UAAM,UAAU;AAAA,MACd,+DAA+D,eAAe;AAAA,MAC9E,GAAG,OAAO,MAAM;AAAA,MAChB,GAAG,OAAO,IAAI,CAAC,MAAM,OAAO,CAAC,EAAE;AAAA,IACjC,EAAE,KAAK,IAAI;AAEX,QAAI,KAAK,gBAAgB;AACvB,YAAM,IAAI,MAAM,OAAO;AAAA,IACzB;AACA,YAAQ,MAAM,OAAO;AACrB,YAAQ,KAAK,CAAC;AAAA,EAChB;AAEA,SAAO;AACT;AASA,SAAS,mBACP,UACA,KACyB;AACzB,QAAM,UAAmC,CAAC;AAE1C,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,SAAS,SAAS,GAAG;AAE5D,QAAI,KAAK,OAAQ;AAEjB,QAAI,CAAC,KAAK,eAAgB;AAE1B,QAAI,KAAK,UAAU,QAAS;AAE5B,UAAM,MAAM,QAAQ,IAAI,GAAG,KAAK,eAAe,MAAM,GAAG;AACxD,QAAI,QAAQ,OAAW;AAEvB,UAAM,CAAC,IAAI,OAAO,IAAI,OAAO,KAAK,KAAK,IAAI;AAC3C,YAAQ,GAAG,IAAI,KAAK,UAAU;AAAA,EAChC;AAEA,SAAO;AACT;AAsBO,SAAS,qBACd,iBACA,OAAwB,CAAC,GACX;AACd,QAAM,WAAW,aAAa,eAAe;AAC7C,QAAM,MACH,QAAQ,IAAI,YAAmC;AAClD,QAAM,UAAU,mBAAmB,UAAU,GAAG;AAChD,QAAM,eAAe,KAAK,gBAAgB;AAC1C,QAAM,OAAO,KAAK,UAAU,OAAO;AAEnC,SAAO,SAAS,cACd,MACA,KAC4C;AAE5C,QAAI,OAAO,OAAQ,IAAgC,MAAM,MAAM,YAAY;AACzE,YAAM,IAAI;AAIV,QAAE,UAAU,iBAAiB,YAAY;AACzC,QAAE,UAAU,gBAAgB,kBAAkB;AAC9C,QAAE,KAAK,OAAO;AACd;AAAA,IACF;AAGA,QAAI,OAAO,OAAQ,IAAgC,MAAM,MAAM,YAAY;AACzE,YAAM,IAAI;AAKV,QAAE,OAAO,iBAAiB,YAAY;AACtC,QAAE,KAAK,kBAAkB;AACzB,QAAE,KAAK,IAAI;AACX;AAAA,IACF;AAGA,WAAO,IAAI,SAAS,MAAM;AAAA,MACxB,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,iBAAiB;AAAA,MACnB;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/config/index.ts"],"sourcesContent":["/**\n * @htilabs/platform-common-models — Runtime Config Contract Validator\n *\n * Implements contract R12.1 (platform-common home):\n * - validateAgainstContract(runtimeYamlPath, opts?) — startup validator (R3.2)\n * - createConfigEndpoint(runtimeYamlPath, opts?) — /api/config factory (R7)\n *\n * Consumers MUST call validateAgainstContract once at process startup, before\n * any other initialization that reads env vars. Build-phase variables\n * (phase: build) are NOT checked at runtime per R3.4.\n *\n * No secret VALUES are read, stored, or returned here. Secret env vars are\n * validated for presence but their values are never logged or exposed.\n *\n * Dual ESM + CJS via tsup. Plain JS consumers (pave, leads) use require():\n * const { validateAgainstContract } = require('@htilabs/platform-common-models/config');\n */\n\nimport { readFileSync } from \"node:fs\";\nimport { parse } from \"yaml\";\n\n// ─── Schema types (mirrors thread's runtime-config-lib.ts VariableSpec) ──────\n\nexport interface VariableSpec {\n type: \"string\" | \"boolean\" | \"number\" | \"enum\" | \"url\" | \"json\";\n required: boolean;\n secret: boolean;\n description: string;\n phase?: \"runtime\" | \"build\";\n values?: string[];\n default?: Record<string, unknown>;\n provider?: string;\n name?: string;\n client_visible?: boolean;\n deprecated?: { since: string; remove_after?: string; replacement?: string };\n}\n\nexport interface ServiceContract {\n service: string;\n version: number;\n environments: string[];\n // Thread extensions (tolerated, not required — R1.1 note)\n port?: number;\n build_secrets?: string[];\n variables: Record<string, VariableSpec>;\n /**\n * Optional MongoDB declaration consumed by `@htilabs/platform-common-models/mongo`.\n * Left untyped here to keep `config` free of a dependency on `mongo`; the\n * verifier validates its shape via `parseMongoBlock`.\n */\n mongo?: unknown;\n}\n\n/** Typed config accessor returned by validateAgainstContract. */\nexport type TypedConfig = Record<string, string | boolean | number | unknown>;\n\nexport interface ValidateOptions {\n /**\n * Environment name used to select per-env defaults (e.g. \"local\", \"test\").\n * Defaults to process.env.NODE_ENV, then \"local\".\n */\n env?: string;\n /**\n * If true, do not call process.exit(1) on failure; throw instead.\n * Useful for tests. Defaults to false (production mode exits).\n */\n throwOnFailure?: boolean;\n}\n\nexport interface EndpointOptions {\n /** Cache-Control header value. Defaults to \"private, no-store\". */\n cacheControl?: string;\n}\n\n/**\n * A framework-agnostic route handler that returns a JSON response.\n * Compatible with:\n * - Next.js App Router: export const GET = createConfigEndpoint(...)\n * - Fastify: instance.get('/api/config', createConfigEndpoint(...))\n * - Express: app.get('/api/config', createConfigEndpoint(...))\n */\nexport type RouteHandler = (\n req?: unknown,\n res?: unknown,\n) => Promise<Response | void> | Response | void;\n\n// ─── YAML parser ──────────────────────────────────────────────────────────────\n\nexport function loadContract(runtimeYamlPath: string): ServiceContract {\n let raw: string;\n try {\n raw = readFileSync(runtimeYamlPath, \"utf8\");\n } catch (err) {\n const msg =\n err instanceof Error ? err.message : String(err);\n throw new Error(\n `[platform-common/config] Cannot read ${runtimeYamlPath}: ${msg}`,\n );\n }\n const parsed = parse(raw) as ServiceContract | null;\n if (!parsed || typeof parsed !== \"object\") {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: not a YAML mapping`,\n );\n }\n if (parsed.version !== 1) {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: unsupported contract version ${parsed.version} (expected 1)`,\n );\n }\n if (!parsed.variables || typeof parsed.variables !== \"object\") {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: missing \"variables\" map`,\n );\n }\n return parsed;\n}\n\n// ─── Coercion ────────────────────────────────────────────────────────────────\n\n/**\n * Coerce a raw environment string value to the declared type.\n * Returns [ok, coerced] or [false, errorMessage].\n */\nfunction coerce(\n key: string,\n raw: string,\n spec: VariableSpec,\n): [true, unknown] | [false, string] {\n switch (spec.type) {\n case \"boolean\": {\n if (raw === \"true\" || raw === \"1\") return [true, true];\n if (raw === \"false\" || raw === \"0\") return [true, false];\n return [false, `${key}: expected boolean (\"true\"/\"false\"/\"1\"/\"0\"), got \"${raw}\"`];\n }\n case \"number\": {\n const n = Number(raw);\n if (!Number.isFinite(n)) {\n return [false, `${key}: expected number, got \"${raw}\"`];\n }\n return [true, n];\n }\n case \"enum\": {\n const vals = spec.values ?? [];\n if (!vals.includes(raw)) {\n return [false, `${key}: expected one of [${vals.join(\", \")}], got \"${raw}\"`];\n }\n return [true, raw];\n }\n case \"url\": {\n try {\n new URL(raw);\n return [true, raw];\n } catch {\n return [false, `${key}: expected a valid URL, got \"${raw}\"`];\n }\n }\n case \"json\": {\n try {\n const parsed = JSON.parse(raw) as unknown;\n return [true, parsed];\n } catch {\n return [false, `${key}: expected valid JSON, got \"${raw}\"`];\n }\n }\n default:\n // string\n return [true, raw];\n }\n}\n\n// ─── Default application ─────────────────────────────────────────────────────\n\n/**\n * Returns the default value for a variable in the given environment,\n * or undefined if no default applies.\n *\n * Exact env match only — defaults are per-environment and MUST NOT bleed\n * across envs. (A local default stays local; it does not fall back into prod.)\n */\nexport function resolveDefault(\n spec: VariableSpec,\n env: string,\n): string | undefined {\n if (!spec.default) return undefined;\n const v = spec.default[env];\n if (v === undefined) return undefined;\n return String(v);\n}\n\n// ─── validateAgainstContract ─────────────────────────────────────────────────\n\n/**\n * Parse `runtimeYamlPath`, coerce every runtime-phase variable from\n * `process.env` (with per-env defaults applied), and fail fast on any\n * missing or invalid required variable (R3.2).\n *\n * Build-phase variables (phase: build) are skipped per R3.4.\n *\n * Returns a typed config object keyed by variable name.\n */\nexport function validateAgainstContract(\n runtimeYamlPath: string,\n opts: ValidateOptions = {},\n): TypedConfig {\n const contract = loadContract(runtimeYamlPath);\n const env =\n opts.env ??\n (process.env.NODE_ENV as string | undefined) ??\n \"local\";\n\n const errors: string[] = [];\n const result: TypedConfig = {};\n\n for (const [key, spec] of Object.entries(contract.variables)) {\n // R3.4: skip build-phase variables entirely at runtime.\n if (spec.phase === \"build\") continue;\n\n const rawFromEnv = process.env[key];\n const defaultValue = resolveDefault(spec, env);\n const effective = rawFromEnv ?? defaultValue;\n\n if (effective === undefined || effective === \"\") {\n if (spec.required) {\n errors.push(\n `${key}: required but not set (no value in process.env and no default for env \"${env}\")`,\n );\n }\n // Not required and not set — omit from result.\n continue;\n }\n\n const [ok, coerced] = coerce(key, effective, spec);\n if (!ok) {\n errors.push(coerced as string);\n continue;\n }\n result[key] = coerced;\n }\n\n if (errors.length > 0) {\n const message = [\n `[platform-common/config] validateAgainstContract failed for ${runtimeYamlPath}`,\n `${errors.length} variable(s) missing or invalid:`,\n ...errors.map((e) => ` - ${e}`),\n ].join(\"\\n\");\n\n if (opts.throwOnFailure) {\n throw new Error(message);\n }\n console.error(message);\n process.exit(1);\n }\n\n return result;\n}\n\n// ─── createConfigEndpoint ────────────────────────────────────────────────────\n\n/**\n * Build a static JSON payload containing only variables that are\n * client_visible: true AND secret: false (R7.2, R7.3). Reads process.env\n * once at factory call time.\n */\nfunction buildClientPayload(\n contract: ServiceContract,\n env: string,\n): Record<string, unknown> {\n const payload: Record<string, unknown> = {};\n\n for (const [key, spec] of Object.entries(contract.variables)) {\n // R7.3: never expose secrets.\n if (spec.secret) continue;\n // R7.2: only expose client_visible vars.\n if (!spec.client_visible) continue;\n // R3.4: build-phase vars are not available at runtime.\n if (spec.phase === \"build\") continue;\n\n const raw = process.env[key] ?? resolveDefault(spec, env);\n if (raw === undefined) continue;\n\n const [ok, coerced] = coerce(key, raw, spec);\n payload[key] = ok ? coerced : raw;\n }\n\n return payload;\n}\n\n/**\n * Route-handler factory for GET /api/config (R7.1).\n *\n * Reads the contract and process.env once at factory-call time and caches\n * the JSON payload. The returned handler is compatible with:\n *\n * Next.js App Router:\n * export const GET = createConfigEndpoint(path);\n *\n * Fastify:\n * instance.get('/api/config', createConfigEndpoint(path));\n *\n * Express:\n * app.get('/api/config', createConfigEndpoint(path));\n *\n * The handler detects the calling convention at runtime:\n * - Next.js / fetch-native: called with no arguments; returns a Response.\n * - Express: called with (req, res); calls res.json() and returns void.\n * - Fastify: called with (req, reply); calls reply.send() and returns void.\n */\nexport function createConfigEndpoint(\n runtimeYamlPath: string,\n opts: EndpointOptions = {},\n): RouteHandler {\n const contract = loadContract(runtimeYamlPath);\n const env =\n (process.env.NODE_ENV as string | undefined) ?? \"local\";\n const payload = buildClientPayload(contract, env);\n const cacheControl = opts.cacheControl ?? \"private, no-store\";\n const body = JSON.stringify(payload);\n\n return function configHandler(\n _req?: unknown,\n res?: unknown,\n ): Promise<Response | void> | Response | void {\n // Express-shaped: res has .json()\n if (res && typeof (res as Record<string, unknown>)[\"json\"] === \"function\") {\n const r = res as {\n setHeader: (k: string, v: string) => void;\n json: (data: unknown) => void;\n };\n r.setHeader(\"Cache-Control\", cacheControl);\n r.setHeader(\"Content-Type\", \"application/json\");\n r.json(payload);\n return;\n }\n\n // Fastify-shaped: res has .send()\n if (res && typeof (res as Record<string, unknown>)[\"send\"] === \"function\") {\n const r = res as {\n header: (k: string, v: string) => void;\n type: (ct: string) => void;\n send: (data: string) => void;\n };\n r.header(\"Cache-Control\", cacheControl);\n r.type(\"application/json\");\n r.send(body);\n return;\n }\n\n // Next.js / fetch-native (no res argument, or unrecognised res)\n return new Response(body, {\n status: 200,\n headers: {\n \"Content-Type\": \"application/json\",\n \"Cache-Control\": cacheControl,\n },\n });\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkBA,qBAA6B;AAC7B,kBAAsB;AAqEf,SAAS,aAAa,iBAA0C;AACrE,MAAI;AACJ,MAAI;AACF,cAAM,6BAAa,iBAAiB,MAAM;AAAA,EAC5C,SAAS,KAAK;AACZ,UAAM,MACJ,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AACjD,UAAM,IAAI;AAAA,MACR,wCAAwC,eAAe,KAAK,GAAG;AAAA,IACjE;AAAA,EACF;AACA,QAAM,aAAS,mBAAM,GAAG;AACxB,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe;AAAA,IAC7C;AAAA,EACF;AACA,MAAI,OAAO,YAAY,GAAG;AACxB,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe,kCAAkC,OAAO,OAAO;AAAA,IAC7F;AAAA,EACF;AACA,MAAI,CAAC,OAAO,aAAa,OAAO,OAAO,cAAc,UAAU;AAC7D,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe;AAAA,IAC7C;AAAA,EACF;AACA,SAAO;AACT;AAQA,SAAS,OACP,KACA,KACA,MACmC;AACnC,UAAQ,KAAK,MAAM;AAAA,IACjB,KAAK,WAAW;AACd,UAAI,QAAQ,UAAU,QAAQ,IAAK,QAAO,CAAC,MAAM,IAAI;AACrD,UAAI,QAAQ,WAAW,QAAQ,IAAK,QAAO,CAAC,MAAM,KAAK;AACvD,aAAO,CAAC,OAAO,GAAG,GAAG,qDAAqD,GAAG,GAAG;AAAA,IAClF;AAAA,IACA,KAAK,UAAU;AACb,YAAM,IAAI,OAAO,GAAG;AACpB,UAAI,CAAC,OAAO,SAAS,CAAC,GAAG;AACvB,eAAO,CAAC,OAAO,GAAG,GAAG,2BAA2B,GAAG,GAAG;AAAA,MACxD;AACA,aAAO,CAAC,MAAM,CAAC;AAAA,IACjB;AAAA,IACA,KAAK,QAAQ;AACX,YAAM,OAAO,KAAK,UAAU,CAAC;AAC7B,UAAI,CAAC,KAAK,SAAS,GAAG,GAAG;AACvB,eAAO,CAAC,OAAO,GAAG,GAAG,sBAAsB,KAAK,KAAK,IAAI,CAAC,WAAW,GAAG,GAAG;AAAA,MAC7E;AACA,aAAO,CAAC,MAAM,GAAG;AAAA,IACnB;AAAA,IACA,KAAK,OAAO;AACV,UAAI;AACF,YAAI,IAAI,GAAG;AACX,eAAO,CAAC,MAAM,GAAG;AAAA,MACnB,QAAQ;AACN,eAAO,CAAC,OAAO,GAAG,GAAG,gCAAgC,GAAG,GAAG;AAAA,MAC7D;AAAA,IACF;AAAA,IACA,KAAK,QAAQ;AACX,UAAI;AACF,cAAM,SAAS,KAAK,MAAM,GAAG;AAC7B,eAAO,CAAC,MAAM,MAAM;AAAA,MACtB,QAAQ;AACN,eAAO,CAAC,OAAO,GAAG,GAAG,+BAA+B,GAAG,GAAG;AAAA,MAC5D;AAAA,IACF;AAAA,IACA;AAEE,aAAO,CAAC,MAAM,GAAG;AAAA,EACrB;AACF;AAWO,SAAS,eACd,MACA,KACoB;AACpB,MAAI,CAAC,KAAK,QAAS,QAAO;AAC1B,QAAM,IAAI,KAAK,QAAQ,GAAG;AAC1B,MAAI,MAAM,OAAW,QAAO;AAC5B,SAAO,OAAO,CAAC;AACjB;AAaO,SAAS,wBACd,iBACA,OAAwB,CAAC,GACZ;AACb,QAAM,WAAW,aAAa,eAAe;AAC7C,QAAM,MACJ,KAAK,OACJ,QAAQ,IAAI,YACb;AAEF,QAAM,SAAmB,CAAC;AAC1B,QAAM,SAAsB,CAAC;AAE7B,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,SAAS,SAAS,GAAG;AAE5D,QAAI,KAAK,UAAU,QAAS;AAE5B,UAAM,aAAa,QAAQ,IAAI,GAAG;AAClC,UAAM,eAAe,eAAe,MAAM,GAAG;AAC7C,UAAM,YAAY,cAAc;AAEhC,QAAI,cAAc,UAAa,cAAc,IAAI;AAC/C,UAAI,KAAK,UAAU;AACjB,eAAO;AAAA,UACL,GAAG,GAAG,2EAA2E,GAAG;AAAA,QACtF;AAAA,MACF;AAEA;AAAA,IACF;AAEA,UAAM,CAAC,IAAI,OAAO,IAAI,OAAO,KAAK,WAAW,IAAI;AACjD,QAAI,CAAC,IAAI;AACP,aAAO,KAAK,OAAiB;AAC7B;AAAA,IACF;AACA,WAAO,GAAG,IAAI;AAAA,EAChB;AAEA,MAAI,OAAO,SAAS,GAAG;AACrB,UAAM,UAAU;AAAA,MACd,+DAA+D,eAAe;AAAA,MAC9E,GAAG,OAAO,MAAM;AAAA,MAChB,GAAG,OAAO,IAAI,CAAC,MAAM,OAAO,CAAC,EAAE;AAAA,IACjC,EAAE,KAAK,IAAI;AAEX,QAAI,KAAK,gBAAgB;AACvB,YAAM,IAAI,MAAM,OAAO;AAAA,IACzB;AACA,YAAQ,MAAM,OAAO;AACrB,YAAQ,KAAK,CAAC;AAAA,EAChB;AAEA,SAAO;AACT;AASA,SAAS,mBACP,UACA,KACyB;AACzB,QAAM,UAAmC,CAAC;AAE1C,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,SAAS,SAAS,GAAG;AAE5D,QAAI,KAAK,OAAQ;AAEjB,QAAI,CAAC,KAAK,eAAgB;AAE1B,QAAI,KAAK,UAAU,QAAS;AAE5B,UAAM,MAAM,QAAQ,IAAI,GAAG,KAAK,eAAe,MAAM,GAAG;AACxD,QAAI,QAAQ,OAAW;AAEvB,UAAM,CAAC,IAAI,OAAO,IAAI,OAAO,KAAK,KAAK,IAAI;AAC3C,YAAQ,GAAG,IAAI,KAAK,UAAU;AAAA,EAChC;AAEA,SAAO;AACT;AAsBO,SAAS,qBACd,iBACA,OAAwB,CAAC,GACX;AACd,QAAM,WAAW,aAAa,eAAe;AAC7C,QAAM,MACH,QAAQ,IAAI,YAAmC;AAClD,QAAM,UAAU,mBAAmB,UAAU,GAAG;AAChD,QAAM,eAAe,KAAK,gBAAgB;AAC1C,QAAM,OAAO,KAAK,UAAU,OAAO;AAEnC,SAAO,SAAS,cACd,MACA,KAC4C;AAE5C,QAAI,OAAO,OAAQ,IAAgC,MAAM,MAAM,YAAY;AACzE,YAAM,IAAI;AAIV,QAAE,UAAU,iBAAiB,YAAY;AACzC,QAAE,UAAU,gBAAgB,kBAAkB;AAC9C,QAAE,KAAK,OAAO;AACd;AAAA,IACF;AAGA,QAAI,OAAO,OAAQ,IAAgC,MAAM,MAAM,YAAY;AACzE,YAAM,IAAI;AAKV,QAAE,OAAO,iBAAiB,YAAY;AACtC,QAAE,KAAK,kBAAkB;AACzB,QAAE,KAAK,IAAI;AACX;AAAA,IACF;AAGA,WAAO,IAAI,SAAS,MAAM;AAAA,MACxB,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,iBAAiB;AAAA,MACnB;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":[]}
@@ -39,6 +39,12 @@ interface ServiceContract {
39
39
  port?: number;
40
40
  build_secrets?: string[];
41
41
  variables: Record<string, VariableSpec>;
42
+ /**
43
+ * Optional MongoDB declaration consumed by `@htilabs/platform-common-models/mongo`.
44
+ * Left untyped here to keep `config` free of a dependency on `mongo`; the
45
+ * verifier validates its shape via `parseMongoBlock`.
46
+ */
47
+ mongo?: unknown;
42
48
  }
43
49
  /** Typed config accessor returned by validateAgainstContract. */
44
50
  type TypedConfig = Record<string, string | boolean | number | unknown>;
@@ -66,6 +72,15 @@ interface EndpointOptions {
66
72
  * - Express: app.get('/api/config', createConfigEndpoint(...))
67
73
  */
68
74
  type RouteHandler = (req?: unknown, res?: unknown) => Promise<Response | void> | Response | void;
75
+ declare function loadContract(runtimeYamlPath: string): ServiceContract;
76
+ /**
77
+ * Returns the default value for a variable in the given environment,
78
+ * or undefined if no default applies.
79
+ *
80
+ * Exact env match only — defaults are per-environment and MUST NOT bleed
81
+ * across envs. (A local default stays local; it does not fall back into prod.)
82
+ */
83
+ declare function resolveDefault(spec: VariableSpec, env: string): string | undefined;
69
84
  /**
70
85
  * Parse `runtimeYamlPath`, coerce every runtime-phase variable from
71
86
  * `process.env` (with per-env defaults applied), and fail fast on any
@@ -98,4 +113,4 @@ declare function validateAgainstContract(runtimeYamlPath: string, opts?: Validat
98
113
  */
99
114
  declare function createConfigEndpoint(runtimeYamlPath: string, opts?: EndpointOptions): RouteHandler;
100
115
 
101
- export { type EndpointOptions, type RouteHandler, type ServiceContract, type TypedConfig, type ValidateOptions, type VariableSpec, createConfigEndpoint, validateAgainstContract };
116
+ export { type EndpointOptions, type RouteHandler, type ServiceContract, type TypedConfig, type ValidateOptions, type VariableSpec, createConfigEndpoint, loadContract, resolveDefault, validateAgainstContract };
@@ -39,6 +39,12 @@ interface ServiceContract {
39
39
  port?: number;
40
40
  build_secrets?: string[];
41
41
  variables: Record<string, VariableSpec>;
42
+ /**
43
+ * Optional MongoDB declaration consumed by `@htilabs/platform-common-models/mongo`.
44
+ * Left untyped here to keep `config` free of a dependency on `mongo`; the
45
+ * verifier validates its shape via `parseMongoBlock`.
46
+ */
47
+ mongo?: unknown;
42
48
  }
43
49
  /** Typed config accessor returned by validateAgainstContract. */
44
50
  type TypedConfig = Record<string, string | boolean | number | unknown>;
@@ -66,6 +72,15 @@ interface EndpointOptions {
66
72
  * - Express: app.get('/api/config', createConfigEndpoint(...))
67
73
  */
68
74
  type RouteHandler = (req?: unknown, res?: unknown) => Promise<Response | void> | Response | void;
75
+ declare function loadContract(runtimeYamlPath: string): ServiceContract;
76
+ /**
77
+ * Returns the default value for a variable in the given environment,
78
+ * or undefined if no default applies.
79
+ *
80
+ * Exact env match only — defaults are per-environment and MUST NOT bleed
81
+ * across envs. (A local default stays local; it does not fall back into prod.)
82
+ */
83
+ declare function resolveDefault(spec: VariableSpec, env: string): string | undefined;
69
84
  /**
70
85
  * Parse `runtimeYamlPath`, coerce every runtime-phase variable from
71
86
  * `process.env` (with per-env defaults applied), and fail fast on any
@@ -98,4 +113,4 @@ declare function validateAgainstContract(runtimeYamlPath: string, opts?: Validat
98
113
  */
99
114
  declare function createConfigEndpoint(runtimeYamlPath: string, opts?: EndpointOptions): RouteHandler;
100
115
 
101
- export { type EndpointOptions, type RouteHandler, type ServiceContract, type TypedConfig, type ValidateOptions, type VariableSpec, createConfigEndpoint, validateAgainstContract };
116
+ export { type EndpointOptions, type RouteHandler, type ServiceContract, type TypedConfig, type ValidateOptions, type VariableSpec, createConfigEndpoint, loadContract, resolveDefault, validateAgainstContract };
@@ -160,6 +160,8 @@ function createConfigEndpoint(runtimeYamlPath, opts = {}) {
160
160
  }
161
161
  export {
162
162
  createConfigEndpoint,
163
+ loadContract,
164
+ resolveDefault,
163
165
  validateAgainstContract
164
166
  };
165
167
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/config/index.ts"],"sourcesContent":["/**\n * @htilabs/platform-common-models — Runtime Config Contract Validator\n *\n * Implements contract R12.1 (platform-common home):\n * - validateAgainstContract(runtimeYamlPath, opts?) — startup validator (R3.2)\n * - createConfigEndpoint(runtimeYamlPath, opts?) — /api/config factory (R7)\n *\n * Consumers MUST call validateAgainstContract once at process startup, before\n * any other initialization that reads env vars. Build-phase variables\n * (phase: build) are NOT checked at runtime per R3.4.\n *\n * No secret VALUES are read, stored, or returned here. Secret env vars are\n * validated for presence but their values are never logged or exposed.\n *\n * Dual ESM + CJS via tsup. Plain JS consumers (pave, leads) use require():\n * const { validateAgainstContract } = require('@htilabs/platform-common-models/config');\n */\n\nimport { readFileSync } from \"node:fs\";\nimport { parse } from \"yaml\";\n\n// ─── Schema types (mirrors thread's runtime-config-lib.ts VariableSpec) ──────\n\nexport interface VariableSpec {\n type: \"string\" | \"boolean\" | \"number\" | \"enum\" | \"url\" | \"json\";\n required: boolean;\n secret: boolean;\n description: string;\n phase?: \"runtime\" | \"build\";\n values?: string[];\n default?: Record<string, unknown>;\n provider?: string;\n name?: string;\n client_visible?: boolean;\n deprecated?: { since: string; remove_after?: string; replacement?: string };\n}\n\nexport interface ServiceContract {\n service: string;\n version: number;\n environments: string[];\n // Thread extensions (tolerated, not required — R1.1 note)\n port?: number;\n build_secrets?: string[];\n variables: Record<string, VariableSpec>;\n}\n\n/** Typed config accessor returned by validateAgainstContract. */\nexport type TypedConfig = Record<string, string | boolean | number | unknown>;\n\nexport interface ValidateOptions {\n /**\n * Environment name used to select per-env defaults (e.g. \"local\", \"test\").\n * Defaults to process.env.NODE_ENV, then \"local\".\n */\n env?: string;\n /**\n * If true, do not call process.exit(1) on failure; throw instead.\n * Useful for tests. Defaults to false (production mode exits).\n */\n throwOnFailure?: boolean;\n}\n\nexport interface EndpointOptions {\n /** Cache-Control header value. Defaults to \"private, no-store\". */\n cacheControl?: string;\n}\n\n/**\n * A framework-agnostic route handler that returns a JSON response.\n * Compatible with:\n * - Next.js App Router: export const GET = createConfigEndpoint(...)\n * - Fastify: instance.get('/api/config', createConfigEndpoint(...))\n * - Express: app.get('/api/config', createConfigEndpoint(...))\n */\nexport type RouteHandler = (\n req?: unknown,\n res?: unknown,\n) => Promise<Response | void> | Response | void;\n\n// ─── YAML parser ──────────────────────────────────────────────────────────────\n\nfunction loadContract(runtimeYamlPath: string): ServiceContract {\n let raw: string;\n try {\n raw = readFileSync(runtimeYamlPath, \"utf8\");\n } catch (err) {\n const msg =\n err instanceof Error ? err.message : String(err);\n throw new Error(\n `[platform-common/config] Cannot read ${runtimeYamlPath}: ${msg}`,\n );\n }\n const parsed = parse(raw) as ServiceContract | null;\n if (!parsed || typeof parsed !== \"object\") {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: not a YAML mapping`,\n );\n }\n if (parsed.version !== 1) {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: unsupported contract version ${parsed.version} (expected 1)`,\n );\n }\n if (!parsed.variables || typeof parsed.variables !== \"object\") {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: missing \"variables\" map`,\n );\n }\n return parsed;\n}\n\n// ─── Coercion ────────────────────────────────────────────────────────────────\n\n/**\n * Coerce a raw environment string value to the declared type.\n * Returns [ok, coerced] or [false, errorMessage].\n */\nfunction coerce(\n key: string,\n raw: string,\n spec: VariableSpec,\n): [true, unknown] | [false, string] {\n switch (spec.type) {\n case \"boolean\": {\n if (raw === \"true\" || raw === \"1\") return [true, true];\n if (raw === \"false\" || raw === \"0\") return [true, false];\n return [false, `${key}: expected boolean (\"true\"/\"false\"/\"1\"/\"0\"), got \"${raw}\"`];\n }\n case \"number\": {\n const n = Number(raw);\n if (!Number.isFinite(n)) {\n return [false, `${key}: expected number, got \"${raw}\"`];\n }\n return [true, n];\n }\n case \"enum\": {\n const vals = spec.values ?? [];\n if (!vals.includes(raw)) {\n return [false, `${key}: expected one of [${vals.join(\", \")}], got \"${raw}\"`];\n }\n return [true, raw];\n }\n case \"url\": {\n try {\n new URL(raw);\n return [true, raw];\n } catch {\n return [false, `${key}: expected a valid URL, got \"${raw}\"`];\n }\n }\n case \"json\": {\n try {\n const parsed = JSON.parse(raw) as unknown;\n return [true, parsed];\n } catch {\n return [false, `${key}: expected valid JSON, got \"${raw}\"`];\n }\n }\n default:\n // string\n return [true, raw];\n }\n}\n\n// ─── Default application ─────────────────────────────────────────────────────\n\n/**\n * Returns the default value for a variable in the given environment,\n * or undefined if no default applies.\n *\n * Exact env match only — defaults are per-environment and MUST NOT bleed\n * across envs. (A local default stays local; it does not fall back into prod.)\n */\nfunction resolveDefault(\n spec: VariableSpec,\n env: string,\n): string | undefined {\n if (!spec.default) return undefined;\n const v = spec.default[env];\n if (v === undefined) return undefined;\n return String(v);\n}\n\n// ─── validateAgainstContract ─────────────────────────────────────────────────\n\n/**\n * Parse `runtimeYamlPath`, coerce every runtime-phase variable from\n * `process.env` (with per-env defaults applied), and fail fast on any\n * missing or invalid required variable (R3.2).\n *\n * Build-phase variables (phase: build) are skipped per R3.4.\n *\n * Returns a typed config object keyed by variable name.\n */\nexport function validateAgainstContract(\n runtimeYamlPath: string,\n opts: ValidateOptions = {},\n): TypedConfig {\n const contract = loadContract(runtimeYamlPath);\n const env =\n opts.env ??\n (process.env.NODE_ENV as string | undefined) ??\n \"local\";\n\n const errors: string[] = [];\n const result: TypedConfig = {};\n\n for (const [key, spec] of Object.entries(contract.variables)) {\n // R3.4: skip build-phase variables entirely at runtime.\n if (spec.phase === \"build\") continue;\n\n const rawFromEnv = process.env[key];\n const defaultValue = resolveDefault(spec, env);\n const effective = rawFromEnv ?? defaultValue;\n\n if (effective === undefined || effective === \"\") {\n if (spec.required) {\n errors.push(\n `${key}: required but not set (no value in process.env and no default for env \"${env}\")`,\n );\n }\n // Not required and not set — omit from result.\n continue;\n }\n\n const [ok, coerced] = coerce(key, effective, spec);\n if (!ok) {\n errors.push(coerced as string);\n continue;\n }\n result[key] = coerced;\n }\n\n if (errors.length > 0) {\n const message = [\n `[platform-common/config] validateAgainstContract failed for ${runtimeYamlPath}`,\n `${errors.length} variable(s) missing or invalid:`,\n ...errors.map((e) => ` - ${e}`),\n ].join(\"\\n\");\n\n if (opts.throwOnFailure) {\n throw new Error(message);\n }\n console.error(message);\n process.exit(1);\n }\n\n return result;\n}\n\n// ─── createConfigEndpoint ────────────────────────────────────────────────────\n\n/**\n * Build a static JSON payload containing only variables that are\n * client_visible: true AND secret: false (R7.2, R7.3). Reads process.env\n * once at factory call time.\n */\nfunction buildClientPayload(\n contract: ServiceContract,\n env: string,\n): Record<string, unknown> {\n const payload: Record<string, unknown> = {};\n\n for (const [key, spec] of Object.entries(contract.variables)) {\n // R7.3: never expose secrets.\n if (spec.secret) continue;\n // R7.2: only expose client_visible vars.\n if (!spec.client_visible) continue;\n // R3.4: build-phase vars are not available at runtime.\n if (spec.phase === \"build\") continue;\n\n const raw = process.env[key] ?? resolveDefault(spec, env);\n if (raw === undefined) continue;\n\n const [ok, coerced] = coerce(key, raw, spec);\n payload[key] = ok ? coerced : raw;\n }\n\n return payload;\n}\n\n/**\n * Route-handler factory for GET /api/config (R7.1).\n *\n * Reads the contract and process.env once at factory-call time and caches\n * the JSON payload. The returned handler is compatible with:\n *\n * Next.js App Router:\n * export const GET = createConfigEndpoint(path);\n *\n * Fastify:\n * instance.get('/api/config', createConfigEndpoint(path));\n *\n * Express:\n * app.get('/api/config', createConfigEndpoint(path));\n *\n * The handler detects the calling convention at runtime:\n * - Next.js / fetch-native: called with no arguments; returns a Response.\n * - Express: called with (req, res); calls res.json() and returns void.\n * - Fastify: called with (req, reply); calls reply.send() and returns void.\n */\nexport function createConfigEndpoint(\n runtimeYamlPath: string,\n opts: EndpointOptions = {},\n): RouteHandler {\n const contract = loadContract(runtimeYamlPath);\n const env =\n (process.env.NODE_ENV as string | undefined) ?? \"local\";\n const payload = buildClientPayload(contract, env);\n const cacheControl = opts.cacheControl ?? \"private, no-store\";\n const body = JSON.stringify(payload);\n\n return function configHandler(\n _req?: unknown,\n res?: unknown,\n ): Promise<Response | void> | Response | void {\n // Express-shaped: res has .json()\n if (res && typeof (res as Record<string, unknown>)[\"json\"] === \"function\") {\n const r = res as {\n setHeader: (k: string, v: string) => void;\n json: (data: unknown) => void;\n };\n r.setHeader(\"Cache-Control\", cacheControl);\n r.setHeader(\"Content-Type\", \"application/json\");\n r.json(payload);\n return;\n }\n\n // Fastify-shaped: res has .send()\n if (res && typeof (res as Record<string, unknown>)[\"send\"] === \"function\") {\n const r = res as {\n header: (k: string, v: string) => void;\n type: (ct: string) => void;\n send: (data: string) => void;\n };\n r.header(\"Cache-Control\", cacheControl);\n r.type(\"application/json\");\n r.send(body);\n return;\n }\n\n // Next.js / fetch-native (no res argument, or unrecognised res)\n return new Response(body, {\n status: 200,\n headers: {\n \"Content-Type\": \"application/json\",\n \"Cache-Control\": cacheControl,\n },\n });\n };\n}\n"],"mappings":";AAkBA,SAAS,oBAAoB;AAC7B,SAAS,aAAa;AA+DtB,SAAS,aAAa,iBAA0C;AAC9D,MAAI;AACJ,MAAI;AACF,UAAM,aAAa,iBAAiB,MAAM;AAAA,EAC5C,SAAS,KAAK;AACZ,UAAM,MACJ,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AACjD,UAAM,IAAI;AAAA,MACR,wCAAwC,eAAe,KAAK,GAAG;AAAA,IACjE;AAAA,EACF;AACA,QAAM,SAAS,MAAM,GAAG;AACxB,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe;AAAA,IAC7C;AAAA,EACF;AACA,MAAI,OAAO,YAAY,GAAG;AACxB,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe,kCAAkC,OAAO,OAAO;AAAA,IAC7F;AAAA,EACF;AACA,MAAI,CAAC,OAAO,aAAa,OAAO,OAAO,cAAc,UAAU;AAC7D,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe;AAAA,IAC7C;AAAA,EACF;AACA,SAAO;AACT;AAQA,SAAS,OACP,KACA,KACA,MACmC;AACnC,UAAQ,KAAK,MAAM;AAAA,IACjB,KAAK,WAAW;AACd,UAAI,QAAQ,UAAU,QAAQ,IAAK,QAAO,CAAC,MAAM,IAAI;AACrD,UAAI,QAAQ,WAAW,QAAQ,IAAK,QAAO,CAAC,MAAM,KAAK;AACvD,aAAO,CAAC,OAAO,GAAG,GAAG,qDAAqD,GAAG,GAAG;AAAA,IAClF;AAAA,IACA,KAAK,UAAU;AACb,YAAM,IAAI,OAAO,GAAG;AACpB,UAAI,CAAC,OAAO,SAAS,CAAC,GAAG;AACvB,eAAO,CAAC,OAAO,GAAG,GAAG,2BAA2B,GAAG,GAAG;AAAA,MACxD;AACA,aAAO,CAAC,MAAM,CAAC;AAAA,IACjB;AAAA,IACA,KAAK,QAAQ;AACX,YAAM,OAAO,KAAK,UAAU,CAAC;AAC7B,UAAI,CAAC,KAAK,SAAS,GAAG,GAAG;AACvB,eAAO,CAAC,OAAO,GAAG,GAAG,sBAAsB,KAAK,KAAK,IAAI,CAAC,WAAW,GAAG,GAAG;AAAA,MAC7E;AACA,aAAO,CAAC,MAAM,GAAG;AAAA,IACnB;AAAA,IACA,KAAK,OAAO;AACV,UAAI;AACF,YAAI,IAAI,GAAG;AACX,eAAO,CAAC,MAAM,GAAG;AAAA,MACnB,QAAQ;AACN,eAAO,CAAC,OAAO,GAAG,GAAG,gCAAgC,GAAG,GAAG;AAAA,MAC7D;AAAA,IACF;AAAA,IACA,KAAK,QAAQ;AACX,UAAI;AACF,cAAM,SAAS,KAAK,MAAM,GAAG;AAC7B,eAAO,CAAC,MAAM,MAAM;AAAA,MACtB,QAAQ;AACN,eAAO,CAAC,OAAO,GAAG,GAAG,+BAA+B,GAAG,GAAG;AAAA,MAC5D;AAAA,IACF;AAAA,IACA;AAEE,aAAO,CAAC,MAAM,GAAG;AAAA,EACrB;AACF;AAWA,SAAS,eACP,MACA,KACoB;AACpB,MAAI,CAAC,KAAK,QAAS,QAAO;AAC1B,QAAM,IAAI,KAAK,QAAQ,GAAG;AAC1B,MAAI,MAAM,OAAW,QAAO;AAC5B,SAAO,OAAO,CAAC;AACjB;AAaO,SAAS,wBACd,iBACA,OAAwB,CAAC,GACZ;AACb,QAAM,WAAW,aAAa,eAAe;AAC7C,QAAM,MACJ,KAAK,OACJ,QAAQ,IAAI,YACb;AAEF,QAAM,SAAmB,CAAC;AAC1B,QAAM,SAAsB,CAAC;AAE7B,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,SAAS,SAAS,GAAG;AAE5D,QAAI,KAAK,UAAU,QAAS;AAE5B,UAAM,aAAa,QAAQ,IAAI,GAAG;AAClC,UAAM,eAAe,eAAe,MAAM,GAAG;AAC7C,UAAM,YAAY,cAAc;AAEhC,QAAI,cAAc,UAAa,cAAc,IAAI;AAC/C,UAAI,KAAK,UAAU;AACjB,eAAO;AAAA,UACL,GAAG,GAAG,2EAA2E,GAAG;AAAA,QACtF;AAAA,MACF;AAEA;AAAA,IACF;AAEA,UAAM,CAAC,IAAI,OAAO,IAAI,OAAO,KAAK,WAAW,IAAI;AACjD,QAAI,CAAC,IAAI;AACP,aAAO,KAAK,OAAiB;AAC7B;AAAA,IACF;AACA,WAAO,GAAG,IAAI;AAAA,EAChB;AAEA,MAAI,OAAO,SAAS,GAAG;AACrB,UAAM,UAAU;AAAA,MACd,+DAA+D,eAAe;AAAA,MAC9E,GAAG,OAAO,MAAM;AAAA,MAChB,GAAG,OAAO,IAAI,CAAC,MAAM,OAAO,CAAC,EAAE;AAAA,IACjC,EAAE,KAAK,IAAI;AAEX,QAAI,KAAK,gBAAgB;AACvB,YAAM,IAAI,MAAM,OAAO;AAAA,IACzB;AACA,YAAQ,MAAM,OAAO;AACrB,YAAQ,KAAK,CAAC;AAAA,EAChB;AAEA,SAAO;AACT;AASA,SAAS,mBACP,UACA,KACyB;AACzB,QAAM,UAAmC,CAAC;AAE1C,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,SAAS,SAAS,GAAG;AAE5D,QAAI,KAAK,OAAQ;AAEjB,QAAI,CAAC,KAAK,eAAgB;AAE1B,QAAI,KAAK,UAAU,QAAS;AAE5B,UAAM,MAAM,QAAQ,IAAI,GAAG,KAAK,eAAe,MAAM,GAAG;AACxD,QAAI,QAAQ,OAAW;AAEvB,UAAM,CAAC,IAAI,OAAO,IAAI,OAAO,KAAK,KAAK,IAAI;AAC3C,YAAQ,GAAG,IAAI,KAAK,UAAU;AAAA,EAChC;AAEA,SAAO;AACT;AAsBO,SAAS,qBACd,iBACA,OAAwB,CAAC,GACX;AACd,QAAM,WAAW,aAAa,eAAe;AAC7C,QAAM,MACH,QAAQ,IAAI,YAAmC;AAClD,QAAM,UAAU,mBAAmB,UAAU,GAAG;AAChD,QAAM,eAAe,KAAK,gBAAgB;AAC1C,QAAM,OAAO,KAAK,UAAU,OAAO;AAEnC,SAAO,SAAS,cACd,MACA,KAC4C;AAE5C,QAAI,OAAO,OAAQ,IAAgC,MAAM,MAAM,YAAY;AACzE,YAAM,IAAI;AAIV,QAAE,UAAU,iBAAiB,YAAY;AACzC,QAAE,UAAU,gBAAgB,kBAAkB;AAC9C,QAAE,KAAK,OAAO;AACd;AAAA,IACF;AAGA,QAAI,OAAO,OAAQ,IAAgC,MAAM,MAAM,YAAY;AACzE,YAAM,IAAI;AAKV,QAAE,OAAO,iBAAiB,YAAY;AACtC,QAAE,KAAK,kBAAkB;AACzB,QAAE,KAAK,IAAI;AACX;AAAA,IACF;AAGA,WAAO,IAAI,SAAS,MAAM;AAAA,MACxB,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,iBAAiB;AAAA,MACnB;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/config/index.ts"],"sourcesContent":["/**\n * @htilabs/platform-common-models — Runtime Config Contract Validator\n *\n * Implements contract R12.1 (platform-common home):\n * - validateAgainstContract(runtimeYamlPath, opts?) — startup validator (R3.2)\n * - createConfigEndpoint(runtimeYamlPath, opts?) — /api/config factory (R7)\n *\n * Consumers MUST call validateAgainstContract once at process startup, before\n * any other initialization that reads env vars. Build-phase variables\n * (phase: build) are NOT checked at runtime per R3.4.\n *\n * No secret VALUES are read, stored, or returned here. Secret env vars are\n * validated for presence but their values are never logged or exposed.\n *\n * Dual ESM + CJS via tsup. Plain JS consumers (pave, leads) use require():\n * const { validateAgainstContract } = require('@htilabs/platform-common-models/config');\n */\n\nimport { readFileSync } from \"node:fs\";\nimport { parse } from \"yaml\";\n\n// ─── Schema types (mirrors thread's runtime-config-lib.ts VariableSpec) ──────\n\nexport interface VariableSpec {\n type: \"string\" | \"boolean\" | \"number\" | \"enum\" | \"url\" | \"json\";\n required: boolean;\n secret: boolean;\n description: string;\n phase?: \"runtime\" | \"build\";\n values?: string[];\n default?: Record<string, unknown>;\n provider?: string;\n name?: string;\n client_visible?: boolean;\n deprecated?: { since: string; remove_after?: string; replacement?: string };\n}\n\nexport interface ServiceContract {\n service: string;\n version: number;\n environments: string[];\n // Thread extensions (tolerated, not required — R1.1 note)\n port?: number;\n build_secrets?: string[];\n variables: Record<string, VariableSpec>;\n /**\n * Optional MongoDB declaration consumed by `@htilabs/platform-common-models/mongo`.\n * Left untyped here to keep `config` free of a dependency on `mongo`; the\n * verifier validates its shape via `parseMongoBlock`.\n */\n mongo?: unknown;\n}\n\n/** Typed config accessor returned by validateAgainstContract. */\nexport type TypedConfig = Record<string, string | boolean | number | unknown>;\n\nexport interface ValidateOptions {\n /**\n * Environment name used to select per-env defaults (e.g. \"local\", \"test\").\n * Defaults to process.env.NODE_ENV, then \"local\".\n */\n env?: string;\n /**\n * If true, do not call process.exit(1) on failure; throw instead.\n * Useful for tests. Defaults to false (production mode exits).\n */\n throwOnFailure?: boolean;\n}\n\nexport interface EndpointOptions {\n /** Cache-Control header value. Defaults to \"private, no-store\". */\n cacheControl?: string;\n}\n\n/**\n * A framework-agnostic route handler that returns a JSON response.\n * Compatible with:\n * - Next.js App Router: export const GET = createConfigEndpoint(...)\n * - Fastify: instance.get('/api/config', createConfigEndpoint(...))\n * - Express: app.get('/api/config', createConfigEndpoint(...))\n */\nexport type RouteHandler = (\n req?: unknown,\n res?: unknown,\n) => Promise<Response | void> | Response | void;\n\n// ─── YAML parser ──────────────────────────────────────────────────────────────\n\nexport function loadContract(runtimeYamlPath: string): ServiceContract {\n let raw: string;\n try {\n raw = readFileSync(runtimeYamlPath, \"utf8\");\n } catch (err) {\n const msg =\n err instanceof Error ? err.message : String(err);\n throw new Error(\n `[platform-common/config] Cannot read ${runtimeYamlPath}: ${msg}`,\n );\n }\n const parsed = parse(raw) as ServiceContract | null;\n if (!parsed || typeof parsed !== \"object\") {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: not a YAML mapping`,\n );\n }\n if (parsed.version !== 1) {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: unsupported contract version ${parsed.version} (expected 1)`,\n );\n }\n if (!parsed.variables || typeof parsed.variables !== \"object\") {\n throw new Error(\n `[platform-common/config] ${runtimeYamlPath}: missing \"variables\" map`,\n );\n }\n return parsed;\n}\n\n// ─── Coercion ────────────────────────────────────────────────────────────────\n\n/**\n * Coerce a raw environment string value to the declared type.\n * Returns [ok, coerced] or [false, errorMessage].\n */\nfunction coerce(\n key: string,\n raw: string,\n spec: VariableSpec,\n): [true, unknown] | [false, string] {\n switch (spec.type) {\n case \"boolean\": {\n if (raw === \"true\" || raw === \"1\") return [true, true];\n if (raw === \"false\" || raw === \"0\") return [true, false];\n return [false, `${key}: expected boolean (\"true\"/\"false\"/\"1\"/\"0\"), got \"${raw}\"`];\n }\n case \"number\": {\n const n = Number(raw);\n if (!Number.isFinite(n)) {\n return [false, `${key}: expected number, got \"${raw}\"`];\n }\n return [true, n];\n }\n case \"enum\": {\n const vals = spec.values ?? [];\n if (!vals.includes(raw)) {\n return [false, `${key}: expected one of [${vals.join(\", \")}], got \"${raw}\"`];\n }\n return [true, raw];\n }\n case \"url\": {\n try {\n new URL(raw);\n return [true, raw];\n } catch {\n return [false, `${key}: expected a valid URL, got \"${raw}\"`];\n }\n }\n case \"json\": {\n try {\n const parsed = JSON.parse(raw) as unknown;\n return [true, parsed];\n } catch {\n return [false, `${key}: expected valid JSON, got \"${raw}\"`];\n }\n }\n default:\n // string\n return [true, raw];\n }\n}\n\n// ─── Default application ─────────────────────────────────────────────────────\n\n/**\n * Returns the default value for a variable in the given environment,\n * or undefined if no default applies.\n *\n * Exact env match only — defaults are per-environment and MUST NOT bleed\n * across envs. (A local default stays local; it does not fall back into prod.)\n */\nexport function resolveDefault(\n spec: VariableSpec,\n env: string,\n): string | undefined {\n if (!spec.default) return undefined;\n const v = spec.default[env];\n if (v === undefined) return undefined;\n return String(v);\n}\n\n// ─── validateAgainstContract ─────────────────────────────────────────────────\n\n/**\n * Parse `runtimeYamlPath`, coerce every runtime-phase variable from\n * `process.env` (with per-env defaults applied), and fail fast on any\n * missing or invalid required variable (R3.2).\n *\n * Build-phase variables (phase: build) are skipped per R3.4.\n *\n * Returns a typed config object keyed by variable name.\n */\nexport function validateAgainstContract(\n runtimeYamlPath: string,\n opts: ValidateOptions = {},\n): TypedConfig {\n const contract = loadContract(runtimeYamlPath);\n const env =\n opts.env ??\n (process.env.NODE_ENV as string | undefined) ??\n \"local\";\n\n const errors: string[] = [];\n const result: TypedConfig = {};\n\n for (const [key, spec] of Object.entries(contract.variables)) {\n // R3.4: skip build-phase variables entirely at runtime.\n if (spec.phase === \"build\") continue;\n\n const rawFromEnv = process.env[key];\n const defaultValue = resolveDefault(spec, env);\n const effective = rawFromEnv ?? defaultValue;\n\n if (effective === undefined || effective === \"\") {\n if (spec.required) {\n errors.push(\n `${key}: required but not set (no value in process.env and no default for env \"${env}\")`,\n );\n }\n // Not required and not set — omit from result.\n continue;\n }\n\n const [ok, coerced] = coerce(key, effective, spec);\n if (!ok) {\n errors.push(coerced as string);\n continue;\n }\n result[key] = coerced;\n }\n\n if (errors.length > 0) {\n const message = [\n `[platform-common/config] validateAgainstContract failed for ${runtimeYamlPath}`,\n `${errors.length} variable(s) missing or invalid:`,\n ...errors.map((e) => ` - ${e}`),\n ].join(\"\\n\");\n\n if (opts.throwOnFailure) {\n throw new Error(message);\n }\n console.error(message);\n process.exit(1);\n }\n\n return result;\n}\n\n// ─── createConfigEndpoint ────────────────────────────────────────────────────\n\n/**\n * Build a static JSON payload containing only variables that are\n * client_visible: true AND secret: false (R7.2, R7.3). Reads process.env\n * once at factory call time.\n */\nfunction buildClientPayload(\n contract: ServiceContract,\n env: string,\n): Record<string, unknown> {\n const payload: Record<string, unknown> = {};\n\n for (const [key, spec] of Object.entries(contract.variables)) {\n // R7.3: never expose secrets.\n if (spec.secret) continue;\n // R7.2: only expose client_visible vars.\n if (!spec.client_visible) continue;\n // R3.4: build-phase vars are not available at runtime.\n if (spec.phase === \"build\") continue;\n\n const raw = process.env[key] ?? resolveDefault(spec, env);\n if (raw === undefined) continue;\n\n const [ok, coerced] = coerce(key, raw, spec);\n payload[key] = ok ? coerced : raw;\n }\n\n return payload;\n}\n\n/**\n * Route-handler factory for GET /api/config (R7.1).\n *\n * Reads the contract and process.env once at factory-call time and caches\n * the JSON payload. The returned handler is compatible with:\n *\n * Next.js App Router:\n * export const GET = createConfigEndpoint(path);\n *\n * Fastify:\n * instance.get('/api/config', createConfigEndpoint(path));\n *\n * Express:\n * app.get('/api/config', createConfigEndpoint(path));\n *\n * The handler detects the calling convention at runtime:\n * - Next.js / fetch-native: called with no arguments; returns a Response.\n * - Express: called with (req, res); calls res.json() and returns void.\n * - Fastify: called with (req, reply); calls reply.send() and returns void.\n */\nexport function createConfigEndpoint(\n runtimeYamlPath: string,\n opts: EndpointOptions = {},\n): RouteHandler {\n const contract = loadContract(runtimeYamlPath);\n const env =\n (process.env.NODE_ENV as string | undefined) ?? \"local\";\n const payload = buildClientPayload(contract, env);\n const cacheControl = opts.cacheControl ?? \"private, no-store\";\n const body = JSON.stringify(payload);\n\n return function configHandler(\n _req?: unknown,\n res?: unknown,\n ): Promise<Response | void> | Response | void {\n // Express-shaped: res has .json()\n if (res && typeof (res as Record<string, unknown>)[\"json\"] === \"function\") {\n const r = res as {\n setHeader: (k: string, v: string) => void;\n json: (data: unknown) => void;\n };\n r.setHeader(\"Cache-Control\", cacheControl);\n r.setHeader(\"Content-Type\", \"application/json\");\n r.json(payload);\n return;\n }\n\n // Fastify-shaped: res has .send()\n if (res && typeof (res as Record<string, unknown>)[\"send\"] === \"function\") {\n const r = res as {\n header: (k: string, v: string) => void;\n type: (ct: string) => void;\n send: (data: string) => void;\n };\n r.header(\"Cache-Control\", cacheControl);\n r.type(\"application/json\");\n r.send(body);\n return;\n }\n\n // Next.js / fetch-native (no res argument, or unrecognised res)\n return new Response(body, {\n status: 200,\n headers: {\n \"Content-Type\": \"application/json\",\n \"Cache-Control\": cacheControl,\n },\n });\n };\n}\n"],"mappings":";AAkBA,SAAS,oBAAoB;AAC7B,SAAS,aAAa;AAqEf,SAAS,aAAa,iBAA0C;AACrE,MAAI;AACJ,MAAI;AACF,UAAM,aAAa,iBAAiB,MAAM;AAAA,EAC5C,SAAS,KAAK;AACZ,UAAM,MACJ,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AACjD,UAAM,IAAI;AAAA,MACR,wCAAwC,eAAe,KAAK,GAAG;AAAA,IACjE;AAAA,EACF;AACA,QAAM,SAAS,MAAM,GAAG;AACxB,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe;AAAA,IAC7C;AAAA,EACF;AACA,MAAI,OAAO,YAAY,GAAG;AACxB,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe,kCAAkC,OAAO,OAAO;AAAA,IAC7F;AAAA,EACF;AACA,MAAI,CAAC,OAAO,aAAa,OAAO,OAAO,cAAc,UAAU;AAC7D,UAAM,IAAI;AAAA,MACR,4BAA4B,eAAe;AAAA,IAC7C;AAAA,EACF;AACA,SAAO;AACT;AAQA,SAAS,OACP,KACA,KACA,MACmC;AACnC,UAAQ,KAAK,MAAM;AAAA,IACjB,KAAK,WAAW;AACd,UAAI,QAAQ,UAAU,QAAQ,IAAK,QAAO,CAAC,MAAM,IAAI;AACrD,UAAI,QAAQ,WAAW,QAAQ,IAAK,QAAO,CAAC,MAAM,KAAK;AACvD,aAAO,CAAC,OAAO,GAAG,GAAG,qDAAqD,GAAG,GAAG;AAAA,IAClF;AAAA,IACA,KAAK,UAAU;AACb,YAAM,IAAI,OAAO,GAAG;AACpB,UAAI,CAAC,OAAO,SAAS,CAAC,GAAG;AACvB,eAAO,CAAC,OAAO,GAAG,GAAG,2BAA2B,GAAG,GAAG;AAAA,MACxD;AACA,aAAO,CAAC,MAAM,CAAC;AAAA,IACjB;AAAA,IACA,KAAK,QAAQ;AACX,YAAM,OAAO,KAAK,UAAU,CAAC;AAC7B,UAAI,CAAC,KAAK,SAAS,GAAG,GAAG;AACvB,eAAO,CAAC,OAAO,GAAG,GAAG,sBAAsB,KAAK,KAAK,IAAI,CAAC,WAAW,GAAG,GAAG;AAAA,MAC7E;AACA,aAAO,CAAC,MAAM,GAAG;AAAA,IACnB;AAAA,IACA,KAAK,OAAO;AACV,UAAI;AACF,YAAI,IAAI,GAAG;AACX,eAAO,CAAC,MAAM,GAAG;AAAA,MACnB,QAAQ;AACN,eAAO,CAAC,OAAO,GAAG,GAAG,gCAAgC,GAAG,GAAG;AAAA,MAC7D;AAAA,IACF;AAAA,IACA,KAAK,QAAQ;AACX,UAAI;AACF,cAAM,SAAS,KAAK,MAAM,GAAG;AAC7B,eAAO,CAAC,MAAM,MAAM;AAAA,MACtB,QAAQ;AACN,eAAO,CAAC,OAAO,GAAG,GAAG,+BAA+B,GAAG,GAAG;AAAA,MAC5D;AAAA,IACF;AAAA,IACA;AAEE,aAAO,CAAC,MAAM,GAAG;AAAA,EACrB;AACF;AAWO,SAAS,eACd,MACA,KACoB;AACpB,MAAI,CAAC,KAAK,QAAS,QAAO;AAC1B,QAAM,IAAI,KAAK,QAAQ,GAAG;AAC1B,MAAI,MAAM,OAAW,QAAO;AAC5B,SAAO,OAAO,CAAC;AACjB;AAaO,SAAS,wBACd,iBACA,OAAwB,CAAC,GACZ;AACb,QAAM,WAAW,aAAa,eAAe;AAC7C,QAAM,MACJ,KAAK,OACJ,QAAQ,IAAI,YACb;AAEF,QAAM,SAAmB,CAAC;AAC1B,QAAM,SAAsB,CAAC;AAE7B,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,SAAS,SAAS,GAAG;AAE5D,QAAI,KAAK,UAAU,QAAS;AAE5B,UAAM,aAAa,QAAQ,IAAI,GAAG;AAClC,UAAM,eAAe,eAAe,MAAM,GAAG;AAC7C,UAAM,YAAY,cAAc;AAEhC,QAAI,cAAc,UAAa,cAAc,IAAI;AAC/C,UAAI,KAAK,UAAU;AACjB,eAAO;AAAA,UACL,GAAG,GAAG,2EAA2E,GAAG;AAAA,QACtF;AAAA,MACF;AAEA;AAAA,IACF;AAEA,UAAM,CAAC,IAAI,OAAO,IAAI,OAAO,KAAK,WAAW,IAAI;AACjD,QAAI,CAAC,IAAI;AACP,aAAO,KAAK,OAAiB;AAC7B;AAAA,IACF;AACA,WAAO,GAAG,IAAI;AAAA,EAChB;AAEA,MAAI,OAAO,SAAS,GAAG;AACrB,UAAM,UAAU;AAAA,MACd,+DAA+D,eAAe;AAAA,MAC9E,GAAG,OAAO,MAAM;AAAA,MAChB,GAAG,OAAO,IAAI,CAAC,MAAM,OAAO,CAAC,EAAE;AAAA,IACjC,EAAE,KAAK,IAAI;AAEX,QAAI,KAAK,gBAAgB;AACvB,YAAM,IAAI,MAAM,OAAO;AAAA,IACzB;AACA,YAAQ,MAAM,OAAO;AACrB,YAAQ,KAAK,CAAC;AAAA,EAChB;AAEA,SAAO;AACT;AASA,SAAS,mBACP,UACA,KACyB;AACzB,QAAM,UAAmC,CAAC;AAE1C,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,SAAS,SAAS,GAAG;AAE5D,QAAI,KAAK,OAAQ;AAEjB,QAAI,CAAC,KAAK,eAAgB;AAE1B,QAAI,KAAK,UAAU,QAAS;AAE5B,UAAM,MAAM,QAAQ,IAAI,GAAG,KAAK,eAAe,MAAM,GAAG;AACxD,QAAI,QAAQ,OAAW;AAEvB,UAAM,CAAC,IAAI,OAAO,IAAI,OAAO,KAAK,KAAK,IAAI;AAC3C,YAAQ,GAAG,IAAI,KAAK,UAAU;AAAA,EAChC;AAEA,SAAO;AACT;AAsBO,SAAS,qBACd,iBACA,OAAwB,CAAC,GACX;AACd,QAAM,WAAW,aAAa,eAAe;AAC7C,QAAM,MACH,QAAQ,IAAI,YAAmC;AAClD,QAAM,UAAU,mBAAmB,UAAU,GAAG;AAChD,QAAM,eAAe,KAAK,gBAAgB;AAC1C,QAAM,OAAO,KAAK,UAAU,OAAO;AAEnC,SAAO,SAAS,cACd,MACA,KAC4C;AAE5C,QAAI,OAAO,OAAQ,IAAgC,MAAM,MAAM,YAAY;AACzE,YAAM,IAAI;AAIV,QAAE,UAAU,iBAAiB,YAAY;AACzC,QAAE,UAAU,gBAAgB,kBAAkB;AAC9C,QAAE,KAAK,OAAO;AACd;AAAA,IACF;AAGA,QAAI,OAAO,OAAQ,IAAgC,MAAM,MAAM,YAAY;AACzE,YAAM,IAAI;AAKV,QAAE,OAAO,iBAAiB,YAAY;AACtC,QAAE,KAAK,kBAAkB;AACzB,QAAE,KAAK,IAAI;AACX;AAAA,IACF;AAGA,WAAO,IAAI,SAAS,MAAM;AAAA,MACxB,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,iBAAiB;AAAA,MACnB;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":[]}