openapi-typesafe 1.0.0-rc.4 → 1.0.0-rc.6

package/dist/application/transform/schema/unevaluated-properties.cjs

@@ -2,7 +2,7 @@
 
 const constructors = require('../../../domain/ir/constructors.cjs');
 const outputFixes = require('../../../domain/output-fixes.cjs');
-const helperTypes = require('../helper-types.cjs');
+const declaredValueTypes = require('../declared-value-types.cjs');
 const sharedTypes = require('../shared-types.cjs');
 const typeCombinators = require('../type-combinators.cjs');
 
@@ -16,34 +16,6 @@ function unevaluatedSchemaOf(schema, request) {
 function isAnySchema(schema) {
   return schema === true || typeof schema === "object" && Object.keys(schema).length === 0;
 }
-function memberValueTypes(member) {
-  if (member.kind === "indexSignature") {
-    return [member.type];
-  }
-  return member.isOptional ? [member.type, constructors.irKeyword("undefined")] : [member.type];
-}
-function declaredValueTypes(type, request) {
-  switch (type.kind) {
-    case "object":
-      return type.members.flatMap(memberValueTypes);
-    case "union":
-    case "intersection":
-      return type.types.flatMap((member) => declaredValueTypes(member, request));
-    case "reference":
-    case "indexedAccess":
-    case "raw":
-      request.context.footer.requirePropertyValues();
-      return [constructors.irReference(helperTypes.HELPER_TYPES.propertyValues.name, [type])];
-    case "keyword":
-    case "stringLiteral":
-    case "numberLiteral":
-    case "booleanLiteral":
-    case "array":
-    case "tuple":
-    case "readonly":
-      return [];
-  }
-}
 function unevaluatedPropertiesType(schema, composed, request) {
   const unevaluated = unevaluatedSchemaOf(schema, request);
   if (unevaluated === null) {
@@ -51,7 +23,7 @@ function unevaluatedPropertiesType(schema, composed, request) {
   }
   const valueTypes = isAnySchema(unevaluated) ? [sharedTypes.UNKNOWN_TYPE] : [
     request.transformNested(unevaluated, request.location, true),
-    ...composed === null ? [] : declaredValueTypes(composed, request)
+    ...composed === null ? [] : declaredValueTypes.declaredValueTypes(composed, request.context.footer)
   ];
   const { immutable } = request.context.options;
   return constructors.irObject([constructors.irStringIndexSignature("key", typeCombinators.unionOf(valueTypes), immutable)]);

package/dist/application/transform/schema/unevaluated-properties.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"unevaluated-properties.cjs","sources":["../../../../src/application/transform/schema/unevaluated-properties.ts"],"sourcesContent":["import {\n  irKeyword,\n  irObject,\n  irReference,\n  irStringIndexSignature,\n} from \"../../../domain/ir/constructors.js\";\nimport type { IrMember, IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { FIX } from \"../../../domain/output-fixes.js\";\nimport { HELPER_TYPES } from \"../helper-types.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { unionOf } from \"../type-combinators.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/**\n * The `unevaluated-properties` fix (ADR-021, roadmap R11; upstream #2839, #2880). Without it\n * `unevaluatedProperties` is ignored, so its value type is lost and an object with only that\n * keyword is `Record<string, never>`. With it the composed type is intersected with an index\n * signature, as `additionalProperties` gives: every key that no other keyword declares has the\n * `unevaluatedProperties` type. TypeScript checks that index signature against every key of a\n * value, declared ones included, so its type also holds the types of the declared properties\n * (of this schema and of its `allOf`, `anyOf` and `oneOf` members); otherwise a valid value would\n * not be assignable. `false` adds nothing, like `additionalProperties: false`: TypeScript has no\n * closed object type.\n */\n\n/**\n * Whether `unevaluatedProperties` applies. It types the keys left over at this level, so it\n * does nothing next to `additionalProperties` (which already types them all), and only an object\n * schema has keys. A `type` list is typed one listed type at a time, so its object gets it.\n */\nfunction unevaluatedSchemaOf(schema: SchemaObject, request: SchemaRequest): Schema | null {\n  const { unevaluatedProperties } = schema;\n  if (\n    !request.context.options.fixes.has(FIX.UNEVALUATED_PROPERTIES) ||\n    unevaluatedProperties === undefined ||\n    unevaluatedProperties === false ||\n    schema.additionalProperties !== undefined\n  ) {\n    return null;\n  }\n  return schema.type === undefined || schema.type === \"object\" ? unevaluatedProperties : null;\n}\n\nfunction isAnySchema(schema: Schema): boolean {\n  return schema === true || (typeof schema === \"object\" && Object.keys(schema).length === 0);\n}\n\nfunction memberValueTypes(member: IrMember): IrType[] {\n  if (member.kind === \"indexSignature\") {\n    return [member.type];\n  }\n  return member.isOptional ? [member.type, irKeyword(\"undefined\")] : [member.type];\n}\n\n/**\n * The value types a key of the composed type can have, read from its IR: the members of object\n * types, through unions and intersections. A reference (a `$ref`, `Omit`, `WithRequired`) or a raw\n * type is read with `PropertyValues`. Primitives, literals and arrays declare no keys.\n */\nfunction declaredValueTypes(type: IrType, request: SchemaRequest): IrType[] {\n  switch (type.kind) {\n    case \"object\":\n      return type.members.flatMap(memberValueTypes);\n    case \"union\":\n    case \"intersection\":\n      return type.types.flatMap((member) => declaredValueTypes(member, request));\n    case \"reference\":\n    case \"indexedAccess\":\n    case \"raw\":\n      request.context.footer.requirePropertyValues();\n      return [irReference(HELPER_TYPES.propertyValues.name, [type])];\n    case \"keyword\":\n    case \"stringLiteral\":\n    case \"numberLiteral\":\n    case \"booleanLiteral\":\n    case \"array\":\n    case \"tuple\":\n    case \"readonly\":\n      return [];\n  }\n}\n\n/**\n * The index signature object for `unevaluatedProperties`, given the composed type of the other\n * keywords (null when there is none). Null when the fix is off or the keyword does not apply.\n */\nexport function unevaluatedPropertiesType(\n  schema: SchemaObject,\n  composed: IrType | null,\n  request: SchemaRequest,\n): IrType | null {\n  const unevaluated = unevaluatedSchemaOf(schema, request);\n  if (unevaluated === null) {\n    return null;\n  }\n  const valueTypes = isAnySchema(unevaluated)\n    ? [UNKNOWN_TYPE]\n    : [\n        request.transformNested(unevaluated, request.location, true),\n        ...(composed === null ? [] : declaredValueTypes(composed, request)),\n      ];\n  const { immutable } = request.context.options;\n  return irObject([irStringIndexSignature(\"key\", unionOf(valueTypes), immutable)]);\n}\n"],"names":["FIX","irKeyword","irReference","HELPER_TYPES","UNKNOWN_TYPE","irObject","irStringIndexSignature","unionOf"],"mappings":";;;;;;;;AA+BA,SAAS,mBAAA,CAAoB,QAAsB,OAAA,EAAuC;AACxF,EAAA,MAAM,EAAE,uBAAsB,GAAI,MAAA;AAClC,EAAA,IACE,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAA,CAAIA,eAAA,CAAI,sBAAsB,CAAA,IAC7D,0BAA0B,MAAA,IAC1B,qBAAA,KAA0B,KAAA,IAC1B,MAAA,CAAO,yBAAyB,MAAA,EAChC;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,IAAA,KAAS,MAAA,IAAa,MAAA,CAAO,IAAA,KAAS,WAAW,qBAAA,GAAwB,IAAA;AACzF;AAEA,SAAS,YAAY,MAAA,EAAyB;AAC5C,EAAA,OAAO,MAAA,KAAW,QAAS,OAAO,MAAA,KAAW,YAAY,MAAA,CAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA;AAC1F;AAEA,SAAS,iBAAiB,MAAA,EAA4B;AACpD,EAAA,IAAI,MAAA,CAAO,SAAS,gBAAA,EAAkB;AACpC,IAAA,OAAO,CAAC,OAAO,IAAI,CAAA;AAAA,EACrB;AACA,EAAA,OAAO,MAAA,CAAO,UAAA,GAAa,CAAC,MAAA,CAAO,IAAA,EAAMC,sBAAA,CAAU,WAAW,CAAC,CAAA,GAAI,CAAC,MAAA,CAAO,IAAI,CAAA;AACjF;AAOA,SAAS,kBAAA,CAAmB,MAAc,OAAA,EAAkC;AAC1E,EAAA,QAAQ,KAAK,IAAA;AAAM,IACjB,KAAK,QAAA;AACH,MAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,gBAAgB,CAAA;AAAA,IAC9C,KAAK,OAAA;AAAA,IACL,KAAK,cAAA;AACH,MAAA,OAAO,IAAA,CAAK,MAAM,OAAA,CAAQ,CAAC,WAAW,kBAAA,CAAmB,MAAA,EAAQ,OAAO,CAAC,CAAA;AAAA,IAC3E,KAAK,WAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,KAAA;AACH,MAAA,OAAA,CAAQ,OAAA,CAAQ,OAAO,qBAAA,EAAsB;AAC7C,MAAA,OAAO,CAACC,yBAAYC,wBAAA,CAAa,cAAA,CAAe,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AAAA,IAC/D,KAAK,SAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,gBAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,UAAA;AACH,MAAA,OAAO,EAAC;AAAA;AAEd;AAMO,SAAS,yBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACe;AACf,EAAA,MAAM,WAAA,GAAc,mBAAA,CAAoB,MAAA,EAAQ,OAAO,CAAA;AACvD,EAAA,IAAI,gBAAgB,IAAA,EAAM;AACxB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,aAAa,WAAA,CAAY,WAAW,CAAA,GACtC,CAACC,wBAAY,CAAA,GACb;AAAA,IACE,OAAA,CAAQ,eAAA,CAAgB,WAAA,EAAa,OAAA,CAAQ,UAAU,IAAI,CAAA;AAAA,IAC3D,GAAI,QAAA,KAAa,IAAA,GAAO,EAAC,GAAI,kBAAA,CAAmB,UAAU,OAAO;AAAA,GACnE;AACJ,EAAA,MAAM,EAAE,SAAA,EAAU,GAAI,OAAA,CAAQ,OAAA,CAAQ,OAAA;AACtC,EAAA,OAAOC,qBAAA,CAAS,CAACC,mCAAA,CAAuB,KAAA,EAAOC,wBAAQ,UAAU,CAAA,EAAG,SAAS,CAAC,CAAC,CAAA;AACjF;;"}
+{"version":3,"file":"unevaluated-properties.cjs","sources":["../../../../src/application/transform/schema/unevaluated-properties.ts"],"sourcesContent":["import { irObject, irStringIndexSignature } from \"../../../domain/ir/constructors.js\";\nimport type { IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { FIX } from \"../../../domain/output-fixes.js\";\nimport { declaredValueTypes } from \"../declared-value-types.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { unionOf } from \"../type-combinators.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/**\n * The `unevaluated-properties` fix (ADR-021, roadmap R11; upstream #2839, #2880). Without it\n * `unevaluatedProperties` is ignored, so its value type is lost and an object with only that\n * keyword is `Record<string, never>`. With it the composed type is intersected with an index\n * signature, as `additionalProperties` gives: every key that no other keyword declares has the\n * `unevaluatedProperties` type. TypeScript checks that index signature against every key of a\n * value, declared ones included, so its type also holds the types of the declared properties\n * (of this schema and of its `allOf`, `anyOf` and `oneOf` members); otherwise a valid value would\n * not be assignable. `false` adds nothing, like `additionalProperties: false`: TypeScript has no\n * closed object type.\n */\n\n/**\n * Whether `unevaluatedProperties` applies. It types the keys left over at this level, so it\n * does nothing next to `additionalProperties` (which already types them all), and only an object\n * schema has keys. A `type` list is typed one listed type at a time, so its object gets it.\n */\nfunction unevaluatedSchemaOf(schema: SchemaObject, request: SchemaRequest): Schema | null {\n  const { unevaluatedProperties } = schema;\n  if (\n    !request.context.options.fixes.has(FIX.UNEVALUATED_PROPERTIES) ||\n    unevaluatedProperties === undefined ||\n    unevaluatedProperties === false ||\n    schema.additionalProperties !== undefined\n  ) {\n    return null;\n  }\n  return schema.type === undefined || schema.type === \"object\" ? unevaluatedProperties : null;\n}\n\nfunction isAnySchema(schema: Schema): boolean {\n  return schema === true || (typeof schema === \"object\" && Object.keys(schema).length === 0);\n}\n\n/**\n * The index signature object for `unevaluatedProperties`, given the composed type of the other\n * keywords (null when there is none). Null when the fix is off or the keyword does not apply.\n */\nexport function unevaluatedPropertiesType(\n  schema: SchemaObject,\n  composed: IrType | null,\n  request: SchemaRequest,\n): IrType | null {\n  const unevaluated = unevaluatedSchemaOf(schema, request);\n  if (unevaluated === null) {\n    return null;\n  }\n  const valueTypes = isAnySchema(unevaluated)\n    ? [UNKNOWN_TYPE]\n    : [\n        request.transformNested(unevaluated, request.location, true),\n        ...(composed === null ? [] : declaredValueTypes(composed, request.context.footer)),\n      ];\n  const { immutable } = request.context.options;\n  return irObject([irStringIndexSignature(\"key\", unionOf(valueTypes), immutable)]);\n}\n"],"names":["FIX","UNKNOWN_TYPE","declaredValueTypes","irObject","irStringIndexSignature","unionOf"],"mappings":";;;;;;;;AA0BA,SAAS,mBAAA,CAAoB,QAAsB,OAAA,EAAuC;AACxF,EAAA,MAAM,EAAE,uBAAsB,GAAI,MAAA;AAClC,EAAA,IACE,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAA,CAAIA,eAAA,CAAI,sBAAsB,CAAA,IAC7D,0BAA0B,MAAA,IAC1B,qBAAA,KAA0B,KAAA,IAC1B,MAAA,CAAO,yBAAyB,MAAA,EAChC;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,IAAA,KAAS,MAAA,IAAa,MAAA,CAAO,IAAA,KAAS,WAAW,qBAAA,GAAwB,IAAA;AACzF;AAEA,SAAS,YAAY,MAAA,EAAyB;AAC5C,EAAA,OAAO,MAAA,KAAW,QAAS,OAAO,MAAA,KAAW,YAAY,MAAA,CAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA;AAC1F;AAMO,SAAS,yBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACe;AACf,EAAA,MAAM,WAAA,GAAc,mBAAA,CAAoB,MAAA,EAAQ,OAAO,CAAA;AACvD,EAAA,IAAI,gBAAgB,IAAA,EAAM;AACxB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,aAAa,WAAA,CAAY,WAAW,CAAA,GACtC,CAACC,wBAAY,CAAA,GACb;AAAA,IACE,OAAA,CAAQ,eAAA,CAAgB,WAAA,EAAa,OAAA,CAAQ,UAAU,IAAI,CAAA;AAAA,IAC3D,GAAI,aAAa,IAAA,GAAO,KAAKC,qCAAA,CAAmB,QAAA,EAAU,OAAA,CAAQ,OAAA,CAAQ,MAAM;AAAA,GAClF;AACJ,EAAA,MAAM,EAAE,SAAA,EAAU,GAAI,OAAA,CAAQ,OAAA,CAAQ,OAAA;AACtC,EAAA,OAAOC,qBAAA,CAAS,CAACC,mCAAA,CAAuB,KAAA,EAAOC,wBAAQ,UAAU,CAAA,EAAG,SAAS,CAAC,CAAC,CAAA;AACjF;;"}

package/dist/application/transform/schema/unevaluated-properties.mjs

@@ -1,6 +1,6 @@
-import { irObject, irStringIndexSignature, irReference, irKeyword } from '../../../domain/ir/constructors.mjs';
+import { irObject, irStringIndexSignature } from '../../../domain/ir/constructors.mjs';
 import { FIX } from '../../../domain/output-fixes.mjs';
-import { HELPER_TYPES } from '../helper-types.mjs';
+import { declaredValueTypes } from '../declared-value-types.mjs';
 import { UNKNOWN_TYPE } from '../shared-types.mjs';
 import { unionOf } from '../type-combinators.mjs';
 
@@ -14,34 +14,6 @@ function unevaluatedSchemaOf(schema, request) {
 function isAnySchema(schema) {
   return schema === true || typeof schema === "object" && Object.keys(schema).length === 0;
 }
-function memberValueTypes(member) {
-  if (member.kind === "indexSignature") {
-    return [member.type];
-  }
-  return member.isOptional ? [member.type, irKeyword("undefined")] : [member.type];
-}
-function declaredValueTypes(type, request) {
-  switch (type.kind) {
-    case "object":
-      return type.members.flatMap(memberValueTypes);
-    case "union":
-    case "intersection":
-      return type.types.flatMap((member) => declaredValueTypes(member, request));
-    case "reference":
-    case "indexedAccess":
-    case "raw":
-      request.context.footer.requirePropertyValues();
-      return [irReference(HELPER_TYPES.propertyValues.name, [type])];
-    case "keyword":
-    case "stringLiteral":
-    case "numberLiteral":
-    case "booleanLiteral":
-    case "array":
-    case "tuple":
-    case "readonly":
-      return [];
-  }
-}
 function unevaluatedPropertiesType(schema, composed, request) {
   const unevaluated = unevaluatedSchemaOf(schema, request);
   if (unevaluated === null) {
@@ -49,7 +21,7 @@ function unevaluatedPropertiesType(schema, composed, request) {
   }
   const valueTypes = isAnySchema(unevaluated) ? [UNKNOWN_TYPE] : [
     request.transformNested(unevaluated, request.location, true),
-    ...composed === null ? [] : declaredValueTypes(composed, request)
+    ...composed === null ? [] : declaredValueTypes(composed, request.context.footer)
   ];
   const { immutable } = request.context.options;
   return irObject([irStringIndexSignature("key", unionOf(valueTypes), immutable)]);

package/dist/application/transform/schema/unevaluated-properties.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"unevaluated-properties.mjs","sources":["../../../../src/application/transform/schema/unevaluated-properties.ts"],"sourcesContent":["import {\n  irKeyword,\n  irObject,\n  irReference,\n  irStringIndexSignature,\n} from \"../../../domain/ir/constructors.js\";\nimport type { IrMember, IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { FIX } from \"../../../domain/output-fixes.js\";\nimport { HELPER_TYPES } from \"../helper-types.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { unionOf } from \"../type-combinators.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/**\n * The `unevaluated-properties` fix (ADR-021, roadmap R11; upstream #2839, #2880). Without it\n * `unevaluatedProperties` is ignored, so its value type is lost and an object with only that\n * keyword is `Record<string, never>`. With it the composed type is intersected with an index\n * signature, as `additionalProperties` gives: every key that no other keyword declares has the\n * `unevaluatedProperties` type. TypeScript checks that index signature against every key of a\n * value, declared ones included, so its type also holds the types of the declared properties\n * (of this schema and of its `allOf`, `anyOf` and `oneOf` members); otherwise a valid value would\n * not be assignable. `false` adds nothing, like `additionalProperties: false`: TypeScript has no\n * closed object type.\n */\n\n/**\n * Whether `unevaluatedProperties` applies. It types the keys left over at this level, so it\n * does nothing next to `additionalProperties` (which already types them all), and only an object\n * schema has keys. A `type` list is typed one listed type at a time, so its object gets it.\n */\nfunction unevaluatedSchemaOf(schema: SchemaObject, request: SchemaRequest): Schema | null {\n  const { unevaluatedProperties } = schema;\n  if (\n    !request.context.options.fixes.has(FIX.UNEVALUATED_PROPERTIES) ||\n    unevaluatedProperties === undefined ||\n    unevaluatedProperties === false ||\n    schema.additionalProperties !== undefined\n  ) {\n    return null;\n  }\n  return schema.type === undefined || schema.type === \"object\" ? unevaluatedProperties : null;\n}\n\nfunction isAnySchema(schema: Schema): boolean {\n  return schema === true || (typeof schema === \"object\" && Object.keys(schema).length === 0);\n}\n\nfunction memberValueTypes(member: IrMember): IrType[] {\n  if (member.kind === \"indexSignature\") {\n    return [member.type];\n  }\n  return member.isOptional ? [member.type, irKeyword(\"undefined\")] : [member.type];\n}\n\n/**\n * The value types a key of the composed type can have, read from its IR: the members of object\n * types, through unions and intersections. A reference (a `$ref`, `Omit`, `WithRequired`) or a raw\n * type is read with `PropertyValues`. Primitives, literals and arrays declare no keys.\n */\nfunction declaredValueTypes(type: IrType, request: SchemaRequest): IrType[] {\n  switch (type.kind) {\n    case \"object\":\n      return type.members.flatMap(memberValueTypes);\n    case \"union\":\n    case \"intersection\":\n      return type.types.flatMap((member) => declaredValueTypes(member, request));\n    case \"reference\":\n    case \"indexedAccess\":\n    case \"raw\":\n      request.context.footer.requirePropertyValues();\n      return [irReference(HELPER_TYPES.propertyValues.name, [type])];\n    case \"keyword\":\n    case \"stringLiteral\":\n    case \"numberLiteral\":\n    case \"booleanLiteral\":\n    case \"array\":\n    case \"tuple\":\n    case \"readonly\":\n      return [];\n  }\n}\n\n/**\n * The index signature object for `unevaluatedProperties`, given the composed type of the other\n * keywords (null when there is none). Null when the fix is off or the keyword does not apply.\n */\nexport function unevaluatedPropertiesType(\n  schema: SchemaObject,\n  composed: IrType | null,\n  request: SchemaRequest,\n): IrType | null {\n  const unevaluated = unevaluatedSchemaOf(schema, request);\n  if (unevaluated === null) {\n    return null;\n  }\n  const valueTypes = isAnySchema(unevaluated)\n    ? [UNKNOWN_TYPE]\n    : [\n        request.transformNested(unevaluated, request.location, true),\n        ...(composed === null ? [] : declaredValueTypes(composed, request)),\n      ];\n  const { immutable } = request.context.options;\n  return irObject([irStringIndexSignature(\"key\", unionOf(valueTypes), immutable)]);\n}\n"],"names":[],"mappings":";;;;;;AA+BA,SAAS,mBAAA,CAAoB,QAAsB,OAAA,EAAuC;AACxF,EAAA,MAAM,EAAE,uBAAsB,GAAI,MAAA;AAClC,EAAA,IACE,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAA,CAAI,GAAA,CAAI,sBAAsB,CAAA,IAC7D,0BAA0B,MAAA,IAC1B,qBAAA,KAA0B,KAAA,IAC1B,MAAA,CAAO,yBAAyB,MAAA,EAChC;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,IAAA,KAAS,MAAA,IAAa,MAAA,CAAO,IAAA,KAAS,WAAW,qBAAA,GAAwB,IAAA;AACzF;AAEA,SAAS,YAAY,MAAA,EAAyB;AAC5C,EAAA,OAAO,MAAA,KAAW,QAAS,OAAO,MAAA,KAAW,YAAY,MAAA,CAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA;AAC1F;AAEA,SAAS,iBAAiB,MAAA,EAA4B;AACpD,EAAA,IAAI,MAAA,CAAO,SAAS,gBAAA,EAAkB;AACpC,IAAA,OAAO,CAAC,OAAO,IAAI,CAAA;AAAA,EACrB;AACA,EAAA,OAAO,MAAA,CAAO,UAAA,GAAa,CAAC,MAAA,CAAO,IAAA,EAAM,SAAA,CAAU,WAAW,CAAC,CAAA,GAAI,CAAC,MAAA,CAAO,IAAI,CAAA;AACjF;AAOA,SAAS,kBAAA,CAAmB,MAAc,OAAA,EAAkC;AAC1E,EAAA,QAAQ,KAAK,IAAA;AAAM,IACjB,KAAK,QAAA;AACH,MAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,gBAAgB,CAAA;AAAA,IAC9C,KAAK,OAAA;AAAA,IACL,KAAK,cAAA;AACH,MAAA,OAAO,IAAA,CAAK,MAAM,OAAA,CAAQ,CAAC,WAAW,kBAAA,CAAmB,MAAA,EAAQ,OAAO,CAAC,CAAA;AAAA,IAC3E,KAAK,WAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,KAAA;AACH,MAAA,OAAA,CAAQ,OAAA,CAAQ,OAAO,qBAAA,EAAsB;AAC7C,MAAA,OAAO,CAAC,YAAY,YAAA,CAAa,cAAA,CAAe,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AAAA,IAC/D,KAAK,SAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,gBAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,UAAA;AACH,MAAA,OAAO,EAAC;AAAA;AAEd;AAMO,SAAS,yBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACe;AACf,EAAA,MAAM,WAAA,GAAc,mBAAA,CAAoB,MAAA,EAAQ,OAAO,CAAA;AACvD,EAAA,IAAI,gBAAgB,IAAA,EAAM;AACxB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,aAAa,WAAA,CAAY,WAAW,CAAA,GACtC,CAAC,YAAY,CAAA,GACb;AAAA,IACE,OAAA,CAAQ,eAAA,CAAgB,WAAA,EAAa,OAAA,CAAQ,UAAU,IAAI,CAAA;AAAA,IAC3D,GAAI,QAAA,KAAa,IAAA,GAAO,EAAC,GAAI,kBAAA,CAAmB,UAAU,OAAO;AAAA,GACnE;AACJ,EAAA,MAAM,EAAE,SAAA,EAAU,GAAI,OAAA,CAAQ,OAAA,CAAQ,OAAA;AACtC,EAAA,OAAO,QAAA,CAAS,CAAC,sBAAA,CAAuB,KAAA,EAAO,QAAQ,UAAU,CAAA,EAAG,SAAS,CAAC,CAAC,CAAA;AACjF;;"}
+{"version":3,"file":"unevaluated-properties.mjs","sources":["../../../../src/application/transform/schema/unevaluated-properties.ts"],"sourcesContent":["import { irObject, irStringIndexSignature } from \"../../../domain/ir/constructors.js\";\nimport type { IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { FIX } from \"../../../domain/output-fixes.js\";\nimport { declaredValueTypes } from \"../declared-value-types.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { unionOf } from \"../type-combinators.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/**\n * The `unevaluated-properties` fix (ADR-021, roadmap R11; upstream #2839, #2880). Without it\n * `unevaluatedProperties` is ignored, so its value type is lost and an object with only that\n * keyword is `Record<string, never>`. With it the composed type is intersected with an index\n * signature, as `additionalProperties` gives: every key that no other keyword declares has the\n * `unevaluatedProperties` type. TypeScript checks that index signature against every key of a\n * value, declared ones included, so its type also holds the types of the declared properties\n * (of this schema and of its `allOf`, `anyOf` and `oneOf` members); otherwise a valid value would\n * not be assignable. `false` adds nothing, like `additionalProperties: false`: TypeScript has no\n * closed object type.\n */\n\n/**\n * Whether `unevaluatedProperties` applies. It types the keys left over at this level, so it\n * does nothing next to `additionalProperties` (which already types them all), and only an object\n * schema has keys. A `type` list is typed one listed type at a time, so its object gets it.\n */\nfunction unevaluatedSchemaOf(schema: SchemaObject, request: SchemaRequest): Schema | null {\n  const { unevaluatedProperties } = schema;\n  if (\n    !request.context.options.fixes.has(FIX.UNEVALUATED_PROPERTIES) ||\n    unevaluatedProperties === undefined ||\n    unevaluatedProperties === false ||\n    schema.additionalProperties !== undefined\n  ) {\n    return null;\n  }\n  return schema.type === undefined || schema.type === \"object\" ? unevaluatedProperties : null;\n}\n\nfunction isAnySchema(schema: Schema): boolean {\n  return schema === true || (typeof schema === \"object\" && Object.keys(schema).length === 0);\n}\n\n/**\n * The index signature object for `unevaluatedProperties`, given the composed type of the other\n * keywords (null when there is none). Null when the fix is off or the keyword does not apply.\n */\nexport function unevaluatedPropertiesType(\n  schema: SchemaObject,\n  composed: IrType | null,\n  request: SchemaRequest,\n): IrType | null {\n  const unevaluated = unevaluatedSchemaOf(schema, request);\n  if (unevaluated === null) {\n    return null;\n  }\n  const valueTypes = isAnySchema(unevaluated)\n    ? [UNKNOWN_TYPE]\n    : [\n        request.transformNested(unevaluated, request.location, true),\n        ...(composed === null ? [] : declaredValueTypes(composed, request.context.footer)),\n      ];\n  const { immutable } = request.context.options;\n  return irObject([irStringIndexSignature(\"key\", unionOf(valueTypes), immutable)]);\n}\n"],"names":[],"mappings":";;;;;;AA0BA,SAAS,mBAAA,CAAoB,QAAsB,OAAA,EAAuC;AACxF,EAAA,MAAM,EAAE,uBAAsB,GAAI,MAAA;AAClC,EAAA,IACE,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAA,CAAI,GAAA,CAAI,sBAAsB,CAAA,IAC7D,0BAA0B,MAAA,IAC1B,qBAAA,KAA0B,KAAA,IAC1B,MAAA,CAAO,yBAAyB,MAAA,EAChC;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,IAAA,KAAS,MAAA,IAAa,MAAA,CAAO,IAAA,KAAS,WAAW,qBAAA,GAAwB,IAAA;AACzF;AAEA,SAAS,YAAY,MAAA,EAAyB;AAC5C,EAAA,OAAO,MAAA,KAAW,QAAS,OAAO,MAAA,KAAW,YAAY,MAAA,CAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA;AAC1F;AAMO,SAAS,yBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACe;AACf,EAAA,MAAM,WAAA,GAAc,mBAAA,CAAoB,MAAA,EAAQ,OAAO,CAAA;AACvD,EAAA,IAAI,gBAAgB,IAAA,EAAM;AACxB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,aAAa,WAAA,CAAY,WAAW,CAAA,GACtC,CAAC,YAAY,CAAA,GACb;AAAA,IACE,OAAA,CAAQ,eAAA,CAAgB,WAAA,EAAa,OAAA,CAAQ,UAAU,IAAI,CAAA;AAAA,IAC3D,GAAI,aAAa,IAAA,GAAO,KAAK,kBAAA,CAAmB,QAAA,EAAU,OAAA,CAAQ,OAAA,CAAQ,MAAM;AAAA,GAClF;AACJ,EAAA,MAAM,EAAE,SAAA,EAAU,GAAI,OAAA,CAAQ,OAAA,CAAQ,OAAA;AACtC,EAAA,OAAO,QAAA,CAAS,CAAC,sBAAA,CAAuB,KAAA,EAAO,QAAQ,UAAU,CAAA,EAAG,SAAS,CAAC,CAAC,CAAA;AACjF;;"}

package/dist/cli/api-logger.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+function apiLogger(logger, apiName) {
+  const prefix = `API ${apiName}: `;
+  return {
+    debug: (message, group, durationMs) => logger.debug(`${prefix}${message}`, group, durationMs),
+    warn: (message) => logger.warn(`${prefix}${message}`),
+    error: (message) => logger.error(`${prefix}${message}`)
+  };
+}
+
+exports.apiLogger = apiLogger;
+//# sourceMappingURL=api-logger.cjs.map

package/dist/cli/api-logger.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-logger.cjs","sources":["../../src/cli/api-logger.ts"],"sourcesContent":["import type { DebugGroup, Logger } from \"../application/ports/logger.js\";\n\n/**\n * A logger whose lines name the API they are about. With several APIs in `redocly.yaml`, each is\n * loaded and linted in turn, and a problem line such as \"Can't resolve $ref\" is the same for\n * each, so without the name the user cannot tell which API it belongs to. The summary of a\n * failed API names it the same way (`API a: …`).\n */\nexport function apiLogger(logger: Logger, apiName: string): Logger {\n  const prefix = `API ${apiName}: `;\n  return {\n    debug: (message: string, group?: DebugGroup, durationMs?: number) =>\n      logger.debug(`${prefix}${message}`, group, durationMs),\n    warn: (message: string) => logger.warn(`${prefix}${message}`),\n    error: (message: string) => logger.error(`${prefix}${message}`),\n  };\n}\n"],"names":[],"mappings":";;AAQO,SAAS,SAAA,CAAU,QAAgB,OAAA,EAAyB;AACjE,EAAA,MAAM,MAAA,GAAS,OAAO,OAAO,CAAA,EAAA,CAAA;AAC7B,EAAA,OAAO;AAAA,IACL,KAAA,EAAO,CAAC,OAAA,EAAiB,KAAA,EAAoB,UAAA,KAC3C,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,MAAM,CAAA,EAAG,OAAO,CAAA,CAAA,EAAI,OAAO,UAAU,CAAA;AAAA,IACvD,IAAA,EAAM,CAAC,OAAA,KAAoB,MAAA,CAAO,KAAK,CAAA,EAAG,MAAM,CAAA,EAAG,OAAO,CAAA,CAAE,CAAA;AAAA,IAC5D,KAAA,EAAO,CAAC,OAAA,KAAoB,MAAA,CAAO,MAAM,CAAA,EAAG,MAAM,CAAA,EAAG,OAAO,CAAA,CAAE;AAAA,GAChE;AACF;;"}

package/dist/cli/api-logger.mjs

@@ -0,0 +1,11 @@
+function apiLogger(logger, apiName) {
+  const prefix = `API ${apiName}: `;
+  return {
+    debug: (message, group, durationMs) => logger.debug(`${prefix}${message}`, group, durationMs),
+    warn: (message) => logger.warn(`${prefix}${message}`),
+    error: (message) => logger.error(`${prefix}${message}`)
+  };
+}
+
+export { apiLogger };
+//# sourceMappingURL=api-logger.mjs.map

package/dist/cli/api-logger.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-logger.mjs","sources":["../../src/cli/api-logger.ts"],"sourcesContent":["import type { DebugGroup, Logger } from \"../application/ports/logger.js\";\n\n/**\n * A logger whose lines name the API they are about. With several APIs in `redocly.yaml`, each is\n * loaded and linted in turn, and a problem line such as \"Can't resolve $ref\" is the same for\n * each, so without the name the user cannot tell which API it belongs to. The summary of a\n * failed API names it the same way (`API a: …`).\n */\nexport function apiLogger(logger: Logger, apiName: string): Logger {\n  const prefix = `API ${apiName}: `;\n  return {\n    debug: (message: string, group?: DebugGroup, durationMs?: number) =>\n      logger.debug(`${prefix}${message}`, group, durationMs),\n    warn: (message: string) => logger.warn(`${prefix}${message}`),\n    error: (message: string) => logger.error(`${prefix}${message}`),\n  };\n}\n"],"names":[],"mappings":"AAQO,SAAS,SAAA,CAAU,QAAgB,OAAA,EAAyB;AACjE,EAAA,MAAM,MAAA,GAAS,OAAO,OAAO,CAAA,EAAA,CAAA;AAC7B,EAAA,OAAO;AAAA,IACL,KAAA,EAAO,CAAC,OAAA,EAAiB,KAAA,EAAoB,UAAA,KAC3C,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,MAAM,CAAA,EAAG,OAAO,CAAA,CAAA,EAAI,OAAO,UAAU,CAAA;AAAA,IACvD,IAAA,EAAM,CAAC,OAAA,KAAoB,MAAA,CAAO,KAAK,CAAA,EAAG,MAAM,CAAA,EAAG,OAAO,CAAA,CAAE,CAAA;AAAA,IAC5D,KAAA,EAAO,CAAC,OAAA,KAAoB,MAAA,CAAO,MAAM,CAAA,EAAG,MAAM,CAAA,EAAG,OAAO,CAAA,CAAE;AAAA,GAChE;AACF;;"}

package/dist/cli/api-settings.cjs

@@ -1,16 +1,17 @@
 'use strict';
 
 const scule = require('scule');
-const errors = require('../domain/errors.cjs');
 const warnings = require('../domain/warnings.cjs');
 const cliArguments = require('./cli-arguments.cjs');
 const cliErrors = require('./cli-errors.cjs');
-const cliOutput = require('./cli-output.cjs');
 const fixOption = require('./fix-option.cjs');
+const refLimits = require('./ref-limits.cjs');
+const cliFlagNames = require('./cli-flag-names.cjs');
 
 const OUTPUT_SETTING = "output";
 const FIX_SETTING = "fix";
 const LOCAL_REF_ROOT_SETTING = "localRefRoot";
+const LOCAL_ROOT_EXPECTED = "a directory path or a file: URL";
 const REMOTE_REF_HOSTS_SETTING = "remoteRefHosts";
 const IGNORED_SETTINGS = ["contentNever"];
 const CAMEL_CASE_SETTINGS = [
@@ -18,7 +19,7 @@ const CAMEL_CASE_SETTINGS = [
   FIX_SETTING,
   LOCAL_REF_ROOT_SETTING,
   REMOTE_REF_HOSTS_SETTING,
-  ...cliArguments.GENERATOR_FLAGS,
+  ...cliFlagNames.GENERATOR_FLAGS,
   ...IGNORED_SETTINGS
 ];
 const KNOWN_SETTINGS = /* @__PURE__ */ new Set([
@@ -56,7 +57,7 @@ function invalidSetting(apiName, settings, name, expected) {
 }
 function apiFlags(apiName, settings) {
   const flags = {};
-  for (const name of cliArguments.GENERATOR_FLAGS) {
+  for (const name of cliFlagNames.GENERATOR_FLAGS) {
     const value = settingValue(settings, name);
     if (typeof value === "boolean") {
       flags[name] = value;
@@ -84,27 +85,19 @@ function apiFixNames(apiName, settings) {
   try {
     return fixOption.fixNamesOf(entries);
   } catch (error) {
-    throw errors.isOpenAPITypesafeError(error) ? withApiName(apiName, error) : error;
+    throw new cliErrors.ApiFailure(apiName, error);
   }
 }
-function withApiName(apiName, error) {
-  const { code, details, cause } = error;
-  return new errors.OpenAPITypesafeError({
-    code,
-    message: `API ${apiName}: ${error.message}`,
-    details,
-    cause
-  });
-}
 function localRefRootOf(apiName, settings, configRoot) {
   if (!hasSetting(settings, LOCAL_REF_ROOT_SETTING)) {
     return {};
   }
   const value = settingValue(settings, LOCAL_REF_ROOT_SETTING) ?? "";
-  if (typeof value !== "string") {
-    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, "a directory path");
+  const localRoot = typeof value === "string" ? refLimits.localRootUrl(value, configRoot) : void 0;
+  if (localRoot === void 0) {
+    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, LOCAL_ROOT_EXPECTED);
   }
-  return { localRefRoot: cliOutput.resolveLocationUrl(value === "" ? "." : value, configRoot) };
+  return { localRefRoot: localRoot };
 }
 function remoteRefHostsOf(apiName, settings) {
   if (!hasSetting(settings, REMOTE_REF_HOSTS_SETTING)) {

package/dist/cli/api-settings.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"api-settings.cjs","sources":["../../src/cli/api-settings.ts"],"sourcesContent":["import { kebabCase } from \"scule\";\nimport { isOpenAPITypesafeError, OpenAPITypesafeError } from \"../domain/errors.js\";\nimport type { OutputFixName } from \"../domain/output-fixes.js\";\nimport { WARNING_CODES, warningText } from \"../domain/warnings.js\";\nimport { GENERATOR_FLAGS, type GeneratorFlags, hostList } from \"./cli-arguments.js\";\nimport { cliError } from \"./cli-errors.js\";\nimport { resolveLocationUrl } from \"./cli-output.js\";\nimport { fixNamesOf } from \"./fix-option.js\";\nimport type { RefLimitOptions } from \"./ref-limits.js\";\n\n/**\n * The settings of one API in `redocly.yaml` (`apis.<name>.x-openapi-ts`). A setting has the name\n * of its CLI flag, in kebab-case or camelCase (ADR-021, decision 1); a setting the CLI does not\n * read gets a warning, as an unknown flag gets a notice.\n */\n\nexport type ApiSettings = Readonly<Record<string, unknown>>;\n\n/** The setting that names the output file. */\nexport const OUTPUT_SETTING = \"output\";\n\n/** The setting that lists the API's output fixes. */\nexport const FIX_SETTING = \"fix\";\n\nconst LOCAL_REF_ROOT_SETTING = \"localRefRoot\";\nconst REMOTE_REF_HOSTS_SETTING = \"remoteRefHosts\";\n\n/** `--content-never` is accepted and has no effect, as on the command line. */\nconst IGNORED_SETTINGS = [\"contentNever\"] as const;\n\nconst CAMEL_CASE_SETTINGS = [\n  OUTPUT_SETTING,\n  FIX_SETTING,\n  LOCAL_REF_ROOT_SETTING,\n  REMOTE_REF_HOSTS_SETTING,\n  ...GENERATOR_FLAGS,\n  ...IGNORED_SETTINGS,\n];\n\nconst KNOWN_SETTINGS = new Set<string>([\n  ...CAMEL_CASE_SETTINGS,\n  ...CAMEL_CASE_SETTINGS.map((name) => kebabCase(name)),\n]);\n\n/** The warning for each setting of an API that no code reads. */\nexport function unknownSettingWarnings(apiName: string, settings: ApiSettings): string[] {\n  return Object.keys(settings)\n    .filter((key) => !KNOWN_SETTINGS.has(key))\n    .map((key) =>\n      warningText(\n        `API ${apiName}: the setting \\`${key}\\` is not an openapi-typesafe option and is ignored`,\n        WARNING_CODES.CONFIG_SETTING_UNKNOWN,\n      ),\n    );\n}\n\n/** The key a setting is written with: camelCase, else kebab-case; undefined when it is absent. */\nfunction settingKey(settings: ApiSettings, name: string): string | undefined {\n  if (name in settings) {\n    return name;\n  }\n  const kebabName = kebabCase(name);\n  return kebabName in settings ? kebabName : undefined;\n}\n\n/** The value of a setting in camelCase, else in kebab-case; `undefined` when it is absent. */\nfunction settingValue(settings: ApiSettings, name: string): unknown {\n  const key = settingKey(settings, name);\n  return key === undefined ? undefined : settings[key];\n}\n\nfunction hasSetting(settings: ApiSettings, name: string): boolean {\n  return settingKey(settings, name) !== undefined;\n}\n\n/** `CLI_CONFIG_INVALID` for the setting `name` of an API, named as the user wrote it. */\nfunction invalidSetting(apiName: string, settings: ApiSettings, name: string, expected: string) {\n  const key = settingKey(settings, name) ?? kebabCase(name);\n  return cliError(\n    \"CLI_CONFIG_INVALID\",\n    `API ${apiName}: \\`${key}\\` in x-openapi-ts must be ${expected}`,\n  );\n}\n\n/**\n * The boolean flags an API sets, in camelCase or kebab-case; they win over the CLI's flags. A\n * value of another type (`root-types: \"true\"`) fails with `CLI_CONFIG_INVALID`: ignoring it\n * would generate other types than the config asks for, without a word.\n */\nexport function apiFlags(apiName: string, settings: ApiSettings): GeneratorFlags {\n  const flags: Partial<Record<(typeof GENERATOR_FLAGS)[number], boolean>> = {};\n  for (const name of GENERATOR_FLAGS) {\n    const value = settingValue(settings, name);\n    if (typeof value === \"boolean\") {\n      flags[name] = value;\n    } else if (hasSetting(settings, name)) {\n      throw invalidSetting(apiName, settings, name, \"true or false\");\n    }\n  }\n  return flags;\n}\n\n/** The API's `output` file as written; fails with `CLI_CONFIG_INVALID` when it is not text. */\nexport function apiOutputOf(apiName: string, settings: ApiSettings): string {\n  const output = settings[OUTPUT_SETTING];\n  if (typeof output !== \"string\") {\n    throw invalidSetting(apiName, settings, OUTPUT_SETTING, \"a file path\");\n  }\n  return output;\n}\n\n/**\n * The API's `fix` names, which replace the CLI's `--fix` (ADR-021). An entry that is not text\n * fails with `CLI_CONFIG_INVALID`; an unknown name with `OPTION_FIX_UNKNOWN`, naming the API.\n */\nexport function apiFixNames(\n  apiName: string,\n  settings: ApiSettings,\n): readonly OutputFixName[] | undefined {\n  if (!hasSetting(settings, FIX_SETTING)) {\n    return undefined;\n  }\n  const entries = [settingValue(settings, FIX_SETTING)].flat();\n  if (entries.some((entry) => typeof entry !== \"string\")) {\n    throw invalidSetting(apiName, settings, FIX_SETTING, \"a list of fix names or a comma list\");\n  }\n  try {\n    return fixNamesOf(entries);\n  } catch (error) {\n    throw isOpenAPITypesafeError(error) ? withApiName(apiName, error) : error;\n  }\n}\n\n/** The same error, with the API named first in its message. */\nfunction withApiName(apiName: string, error: OpenAPITypesafeError): OpenAPITypesafeError {\n  const { code, details, cause } = error;\n  return new OpenAPITypesafeError({\n    code,\n    message: `API ${apiName}: ${error.message}`,\n    details,\n    cause,\n  });\n}\n\n/** `local-ref-root: dir`, relative to the config file; empty means the config file's directory. */\nfunction localRefRootOf(apiName: string, settings: ApiSettings, configRoot: URL): RefLimitOptions {\n  if (!hasSetting(settings, LOCAL_REF_ROOT_SETTING)) {\n    return {};\n  }\n  const value = settingValue(settings, LOCAL_REF_ROOT_SETTING) ?? \"\";\n  if (typeof value !== \"string\") {\n    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, \"a directory path\");\n  }\n  return { localRefRoot: resolveLocationUrl(value === \"\" ? \".\" : value, configRoot) };\n}\n\n/** `remote-ref-hosts: [a, b]` or `a,b`; an empty list or value allows no host. */\nfunction remoteRefHostsOf(apiName: string, settings: ApiSettings): RefLimitOptions {\n  if (!hasSetting(settings, REMOTE_REF_HOSTS_SETTING)) {\n    return {};\n  }\n  const value = settingValue(settings, REMOTE_REF_HOSTS_SETTING) ?? [];\n  const entries = [value].flat();\n  if (entries.some((entry) => typeof entry !== \"string\")) {\n    throw invalidSetting(apiName, settings, REMOTE_REF_HOSTS_SETTING, \"a host list\");\n  }\n  return { remoteRefHosts: hostList(entries) ?? [] };\n}\n\n/**\n * The `$ref` limits an API sets (threat model R1, R2). Each one replaces the CLI flag of the same\n * name for this API, as its boolean settings and `fix` do; fails with `CLI_CONFIG_INVALID` for a\n * value of another type.\n */\nexport function apiRefLimitOptions(\n  apiName: string,\n  settings: ApiSettings,\n  configRoot: URL,\n): RefLimitOptions {\n  return {\n    ...localRefRootOf(apiName, settings, configRoot),\n    ...remoteRefHostsOf(apiName, settings),\n  };\n}\n"],"names":["GENERATOR_FLAGS","kebabCase","warningText","WARNING_CODES","cliError","fixNamesOf","isOpenAPITypesafeError","OpenAPITypesafeError","resolveLocationUrl","hostList"],"mappings":";;;;;;;;;;AAmBO,MAAM,cAAA,GAAiB;AAGvB,MAAM,WAAA,GAAc;AAE3B,MAAM,sBAAA,GAAyB,cAAA;AAC/B,MAAM,wBAAA,GAA2B,gBAAA;AAGjC,MAAM,gBAAA,GAAmB,CAAC,cAAc,CAAA;AAExC,MAAM,mBAAA,GAAsB;AAAA,EAC1B,cAAA;AAAA,EACA,WAAA;AAAA,EACA,sBAAA;AAAA,EACA,wBAAA;AAAA,EACA,GAAGA,4BAAA;AAAA,EACH,GAAG;AACL,CAAA;AAEA,MAAM,cAAA,uBAAqB,GAAA,CAAY;AAAA,EACrC,GAAG,mBAAA;AAAA,EACH,GAAG,mBAAA,CAAoB,GAAA,CAAI,CAAC,IAAA,KAASC,eAAA,CAAU,IAAI,CAAC;AACtD,CAAC,CAAA;AAGM,SAAS,sBAAA,CAAuB,SAAiB,QAAA,EAAiC;AACvF,EAAA,OAAO,MAAA,CAAO,IAAA,CAAK,QAAQ,CAAA,CACxB,MAAA,CAAO,CAAC,GAAA,KAAQ,CAAC,cAAA,CAAe,GAAA,CAAI,GAAG,CAAC,CAAA,CACxC,GAAA;AAAA,IAAI,CAAC,GAAA,KACJC,oBAAA;AAAA,MACE,CAAA,IAAA,EAAO,OAAO,CAAA,gBAAA,EAAmB,GAAG,CAAA,mDAAA,CAAA;AAAA,MACpCC,sBAAA,CAAc;AAAA;AAChB,GACF;AACJ;AAGA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAkC;AAC3E,EAAA,IAAI,QAAQ,QAAA,EAAU;AACpB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAYF,gBAAU,IAAI,CAAA;AAChC,EAAA,OAAO,SAAA,IAAa,WAAW,SAAA,GAAY,MAAA;AAC7C;AAGA,SAAS,YAAA,CAAa,UAAuB,IAAA,EAAuB;AAClE,EAAA,MAAM,GAAA,GAAM,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA;AACrC,EAAA,OAAO,GAAA,KAAQ,MAAA,GAAY,MAAA,GAAY,QAAA,CAAS,GAAG,CAAA;AACrD;AAEA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAuB;AAChE,EAAA,OAAO,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,KAAM,MAAA;AACxC;AAGA,SAAS,cAAA,CAAe,OAAA,EAAiB,QAAA,EAAuB,IAAA,EAAc,QAAA,EAAkB;AAC9F,EAAA,MAAM,MAAM,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,IAAKA,gBAAU,IAAI,CAAA;AACxD,EAAA,OAAOG,kBAAA;AAAA,IACL,oBAAA;AAAA,IACA,CAAA,IAAA,EAAO,OAAO,CAAA,IAAA,EAAO,GAAG,8BAA8B,QAAQ,CAAA;AAAA,GAChE;AACF;AAOO,SAAS,QAAA,CAAS,SAAiB,QAAA,EAAuC;AAC/E,EAAA,MAAM,QAAoE,EAAC;AAC3E,EAAA,KAAA,MAAW,QAAQJ,4BAAA,EAAiB;AAClC,IAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,IAAI,CAAA;AACzC,IAAA,IAAI,OAAO,UAAU,SAAA,EAAW;AAC9B,MAAA,KAAA,CAAM,IAAI,CAAA,GAAI,KAAA;AAAA,IAChB,CAAA,MAAA,IAAW,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,EAAG;AACrC,MAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,IAAA,EAAM,eAAe,CAAA;AAAA,IAC/D;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAGO,SAAS,WAAA,CAAY,SAAiB,QAAA,EAA+B;AAC1E,EAAA,MAAM,MAAA,GAAS,SAAS,cAAc,CAAA;AACtC,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAC9B,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,cAAA,EAAgB,aAAa,CAAA;AAAA,EACvE;AACA,EAAA,OAAO,MAAA;AACT;AAMO,SAAS,WAAA,CACd,SACA,QAAA,EACsC;AACtC,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,WAAW,CAAA,EAAG;AACtC,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,UAAU,CAAC,YAAA,CAAa,UAAU,WAAW,CAAC,EAAE,IAAA,EAAK;AAC3D,EAAA,IAAI,QAAQ,IAAA,CAAK,CAAC,UAAU,OAAO,KAAA,KAAU,QAAQ,CAAA,EAAG;AACtD,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,WAAA,EAAa,qCAAqC,CAAA;AAAA,EAC5F;AACA,EAAA,IAAI;AACF,IAAA,OAAOK,qBAAW,OAAO,CAAA;AAAA,EAC3B,SAAS,KAAA,EAAO;AACd,IAAA,MAAMC,8BAAuB,KAAK,CAAA,GAAI,WAAA,CAAY,OAAA,EAAS,KAAK,CAAA,GAAI,KAAA;AAAA,EACtE;AACF;AAGA,SAAS,WAAA,CAAY,SAAiB,KAAA,EAAmD;AACvF,EAAA,MAAM,EAAE,IAAA,EAAM,OAAA,EAAS,KAAA,EAAM,GAAI,KAAA;AACjC,EAAA,OAAO,IAAIC,2BAAA,CAAqB;AAAA,IAC9B,IAAA;AAAA,IACA,OAAA,EAAS,CAAA,IAAA,EAAO,OAAO,CAAA,EAAA,EAAK,MAAM,OAAO,CAAA,CAAA;AAAA,IACzC,OAAA;AAAA,IACA;AAAA,GACD,CAAA;AACH;AAGA,SAAS,cAAA,CAAe,OAAA,EAAiB,QAAA,EAAuB,UAAA,EAAkC;AAChG,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,sBAAsB,CAAA,EAAG;AACjD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,sBAAsB,CAAA,IAAK,EAAA;AAChE,EAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,sBAAA,EAAwB,kBAAkB,CAAA;AAAA,EACpF;AACA,EAAA,OAAO,EAAE,cAAcC,4BAAA,CAAmB,KAAA,KAAU,KAAK,GAAA,GAAM,KAAA,EAAO,UAAU,CAAA,EAAE;AACpF;AAGA,SAAS,gBAAA,CAAiB,SAAiB,QAAA,EAAwC;AACjF,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,wBAAwB,CAAA,EAAG;AACnD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,wBAAwB,KAAK,EAAC;AACnE,EAAA,MAAM,OAAA,GAAU,CAAC,KAAK,CAAA,CAAE,IAAA,EAAK;AAC7B,EAAA,IAAI,QAAQ,IAAA,CAAK,CAAC,UAAU,OAAO,KAAA,KAAU,QAAQ,CAAA,EAAG;AACtD,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,wBAAA,EAA0B,aAAa,CAAA;AAAA,EACjF;AACA,EAAA,OAAO,EAAE,cAAA,EAAgBC,qBAAA,CAAS,OAAO,CAAA,IAAK,EAAC,EAAE;AACnD;AAOO,SAAS,kBAAA,CACd,OAAA,EACA,QAAA,EACA,UAAA,EACiB;AACjB,EAAA,OAAO;AAAA,IACL,GAAG,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,UAAU,CAAA;AAAA,IAC/C,GAAG,gBAAA,CAAiB,OAAA,EAAS,QAAQ;AAAA,GACvC;AACF;;;;;;;;"}
+{"version":3,"file":"api-settings.cjs","sources":["../../src/cli/api-settings.ts"],"sourcesContent":["import { kebabCase } from \"scule\";\nimport type { OutputFixName } from \"../domain/output-fixes.js\";\nimport { WARNING_CODES, warningText } from \"../domain/warnings.js\";\nimport { GENERATOR_FLAGS, type GeneratorFlags, hostList } from \"./cli-arguments.js\";\nimport { ApiFailure, cliError } from \"./cli-errors.js\";\nimport { fixNamesOf } from \"./fix-option.js\";\nimport { localRootUrl, type RefLimitOptions } from \"./ref-limits.js\";\n\n/**\n * The settings of one API in `redocly.yaml` (`apis.<name>.x-openapi-ts`). A setting has the name\n * of its CLI flag, in kebab-case or camelCase (ADR-021, decision 1); a setting the CLI does not\n * read gets a warning, as an unknown flag gets a notice.\n */\n\nexport type ApiSettings = Readonly<Record<string, unknown>>;\n\n/** The setting that names the output file. */\nexport const OUTPUT_SETTING = \"output\";\n\n/** The setting that lists the API's output fixes. */\nexport const FIX_SETTING = \"fix\";\n\nconst LOCAL_REF_ROOT_SETTING = \"localRefRoot\";\nconst LOCAL_ROOT_EXPECTED = \"a directory path or a file: URL\";\nconst REMOTE_REF_HOSTS_SETTING = \"remoteRefHosts\";\n\n/** `--content-never` is accepted and has no effect, as on the command line. */\nconst IGNORED_SETTINGS = [\"contentNever\"] as const;\n\nconst CAMEL_CASE_SETTINGS = [\n  OUTPUT_SETTING,\n  FIX_SETTING,\n  LOCAL_REF_ROOT_SETTING,\n  REMOTE_REF_HOSTS_SETTING,\n  ...GENERATOR_FLAGS,\n  ...IGNORED_SETTINGS,\n];\n\nconst KNOWN_SETTINGS = new Set<string>([\n  ...CAMEL_CASE_SETTINGS,\n  ...CAMEL_CASE_SETTINGS.map((name) => kebabCase(name)),\n]);\n\n/** The warning for each setting of an API that no code reads. */\nexport function unknownSettingWarnings(apiName: string, settings: ApiSettings): string[] {\n  return Object.keys(settings)\n    .filter((key) => !KNOWN_SETTINGS.has(key))\n    .map((key) =>\n      warningText(\n        `API ${apiName}: the setting \\`${key}\\` is not an openapi-typesafe option and is ignored`,\n        WARNING_CODES.CONFIG_SETTING_UNKNOWN,\n      ),\n    );\n}\n\n/** The key a setting is written with: camelCase, else kebab-case; undefined when it is absent. */\nfunction settingKey(settings: ApiSettings, name: string): string | undefined {\n  if (name in settings) {\n    return name;\n  }\n  const kebabName = kebabCase(name);\n  return kebabName in settings ? kebabName : undefined;\n}\n\n/** The value of a setting in camelCase, else in kebab-case; `undefined` when it is absent. */\nfunction settingValue(settings: ApiSettings, name: string): unknown {\n  const key = settingKey(settings, name);\n  return key === undefined ? undefined : settings[key];\n}\n\nfunction hasSetting(settings: ApiSettings, name: string): boolean {\n  return settingKey(settings, name) !== undefined;\n}\n\n/** `CLI_CONFIG_INVALID` for the setting `name` of an API, named as the user wrote it. */\nfunction invalidSetting(apiName: string, settings: ApiSettings, name: string, expected: string) {\n  const key = settingKey(settings, name) ?? kebabCase(name);\n  return cliError(\n    \"CLI_CONFIG_INVALID\",\n    `API ${apiName}: \\`${key}\\` in x-openapi-ts must be ${expected}`,\n  );\n}\n\n/**\n * The boolean flags an API sets, in camelCase or kebab-case; they win over the CLI's flags. A\n * value of another type (`root-types: \"true\"`) fails with `CLI_CONFIG_INVALID`: ignoring it\n * would generate other types than the config asks for, without a word.\n */\nexport function apiFlags(apiName: string, settings: ApiSettings): GeneratorFlags {\n  const flags: Partial<Record<(typeof GENERATOR_FLAGS)[number], boolean>> = {};\n  for (const name of GENERATOR_FLAGS) {\n    const value = settingValue(settings, name);\n    if (typeof value === \"boolean\") {\n      flags[name] = value;\n    } else if (hasSetting(settings, name)) {\n      throw invalidSetting(apiName, settings, name, \"true or false\");\n    }\n  }\n  return flags;\n}\n\n/** The API's `output` file as written; fails with `CLI_CONFIG_INVALID` when it is not text. */\nexport function apiOutputOf(apiName: string, settings: ApiSettings): string {\n  const output = settings[OUTPUT_SETTING];\n  if (typeof output !== \"string\") {\n    throw invalidSetting(apiName, settings, OUTPUT_SETTING, \"a file path\");\n  }\n  return output;\n}\n\n/**\n * The API's `fix` names, which replace the CLI's `--fix` (ADR-021). An entry that is not text\n * fails with `CLI_CONFIG_INVALID`; an unknown name with `OPTION_FIX_UNKNOWN`, naming the API.\n */\nexport function apiFixNames(\n  apiName: string,\n  settings: ApiSettings,\n): readonly OutputFixName[] | undefined {\n  if (!hasSetting(settings, FIX_SETTING)) {\n    return undefined;\n  }\n  const entries = [settingValue(settings, FIX_SETTING)].flat();\n  if (entries.some((entry) => typeof entry !== \"string\")) {\n    throw invalidSetting(apiName, settings, FIX_SETTING, \"a list of fix names or a comma list\");\n  }\n  try {\n    return fixNamesOf(entries);\n  } catch (error) {\n    throw new ApiFailure(apiName, error);\n  }\n}\n\n/**\n * `local-ref-root: dir`, relative to the config file; empty means the config file's directory. A\n * value that is no text or a URL of another protocol fails with `CLI_CONFIG_INVALID`.\n */\nfunction localRefRootOf(apiName: string, settings: ApiSettings, configRoot: URL): RefLimitOptions {\n  if (!hasSetting(settings, LOCAL_REF_ROOT_SETTING)) {\n    return {};\n  }\n  const value = settingValue(settings, LOCAL_REF_ROOT_SETTING) ?? \"\";\n  const localRoot = typeof value === \"string\" ? localRootUrl(value, configRoot) : undefined;\n  if (localRoot === undefined) {\n    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, LOCAL_ROOT_EXPECTED);\n  }\n  return { localRefRoot: localRoot };\n}\n\n/** `remote-ref-hosts: [a, b]` or `a,b`; an empty list or value allows no host. */\nfunction remoteRefHostsOf(apiName: string, settings: ApiSettings): RefLimitOptions {\n  if (!hasSetting(settings, REMOTE_REF_HOSTS_SETTING)) {\n    return {};\n  }\n  const value = settingValue(settings, REMOTE_REF_HOSTS_SETTING) ?? [];\n  const entries = [value].flat();\n  if (entries.some((entry) => typeof entry !== \"string\")) {\n    throw invalidSetting(apiName, settings, REMOTE_REF_HOSTS_SETTING, \"a host list\");\n  }\n  return { remoteRefHosts: hostList(entries) ?? [] };\n}\n\n/**\n * The `$ref` limits an API sets (threat model R1, R2). Each one replaces the CLI flag of the same\n * name for this API, as its boolean settings and `fix` do; fails with `CLI_CONFIG_INVALID` for a\n * value of another type.\n */\nexport function apiRefLimitOptions(\n  apiName: string,\n  settings: ApiSettings,\n  configRoot: URL,\n): RefLimitOptions {\n  return {\n    ...localRefRootOf(apiName, settings, configRoot),\n    ...remoteRefHostsOf(apiName, settings),\n  };\n}\n"],"names":["GENERATOR_FLAGS","kebabCase","warningText","WARNING_CODES","cliError","fixNamesOf","ApiFailure","localRootUrl","hostList"],"mappings":";;;;;;;;;;AAiBO,MAAM,cAAA,GAAiB;AAGvB,MAAM,WAAA,GAAc;AAE3B,MAAM,sBAAA,GAAyB,cAAA;AAC/B,MAAM,mBAAA,GAAsB,iCAAA;AAC5B,MAAM,wBAAA,GAA2B,gBAAA;AAGjC,MAAM,gBAAA,GAAmB,CAAC,cAAc,CAAA;AAExC,MAAM,mBAAA,GAAsB;AAAA,EAC1B,cAAA;AAAA,EACA,WAAA;AAAA,EACA,sBAAA;AAAA,EACA,wBAAA;AAAA,EACA,GAAGA,4BAAA;AAAA,EACH,GAAG;AACL,CAAA;AAEA,MAAM,cAAA,uBAAqB,GAAA,CAAY;AAAA,EACrC,GAAG,mBAAA;AAAA,EACH,GAAG,mBAAA,CAAoB,GAAA,CAAI,CAAC,IAAA,KAASC,eAAA,CAAU,IAAI,CAAC;AACtD,CAAC,CAAA;AAGM,SAAS,sBAAA,CAAuB,SAAiB,QAAA,EAAiC;AACvF,EAAA,OAAO,MAAA,CAAO,IAAA,CAAK,QAAQ,CAAA,CACxB,MAAA,CAAO,CAAC,GAAA,KAAQ,CAAC,cAAA,CAAe,GAAA,CAAI,GAAG,CAAC,CAAA,CACxC,GAAA;AAAA,IAAI,CAAC,GAAA,KACJC,oBAAA;AAAA,MACE,CAAA,IAAA,EAAO,OAAO,CAAA,gBAAA,EAAmB,GAAG,CAAA,mDAAA,CAAA;AAAA,MACpCC,sBAAA,CAAc;AAAA;AAChB,GACF;AACJ;AAGA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAkC;AAC3E,EAAA,IAAI,QAAQ,QAAA,EAAU;AACpB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAYF,gBAAU,IAAI,CAAA;AAChC,EAAA,OAAO,SAAA,IAAa,WAAW,SAAA,GAAY,MAAA;AAC7C;AAGA,SAAS,YAAA,CAAa,UAAuB,IAAA,EAAuB;AAClE,EAAA,MAAM,GAAA,GAAM,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA;AACrC,EAAA,OAAO,GAAA,KAAQ,MAAA,GAAY,MAAA,GAAY,QAAA,CAAS,GAAG,CAAA;AACrD;AAEA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAuB;AAChE,EAAA,OAAO,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,KAAM,MAAA;AACxC;AAGA,SAAS,cAAA,CAAe,OAAA,EAAiB,QAAA,EAAuB,IAAA,EAAc,QAAA,EAAkB;AAC9F,EAAA,MAAM,MAAM,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,IAAKA,gBAAU,IAAI,CAAA;AACxD,EAAA,OAAOG,kBAAA;AAAA,IACL,oBAAA;AAAA,IACA,CAAA,IAAA,EAAO,OAAO,CAAA,IAAA,EAAO,GAAG,8BAA8B,QAAQ,CAAA;AAAA,GAChE;AACF;AAOO,SAAS,QAAA,CAAS,SAAiB,QAAA,EAAuC;AAC/E,EAAA,MAAM,QAAoE,EAAC;AAC3E,EAAA,KAAA,MAAW,QAAQJ,4BAAA,EAAiB;AAClC,IAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,IAAI,CAAA;AACzC,IAAA,IAAI,OAAO,UAAU,SAAA,EAAW;AAC9B,MAAA,KAAA,CAAM,IAAI,CAAA,GAAI,KAAA;AAAA,IAChB,CAAA,MAAA,IAAW,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,EAAG;AACrC,MAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,IAAA,EAAM,eAAe,CAAA;AAAA,IAC/D;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAGO,SAAS,WAAA,CAAY,SAAiB,QAAA,EAA+B;AAC1E,EAAA,MAAM,MAAA,GAAS,SAAS,cAAc,CAAA;AACtC,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAC9B,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,cAAA,EAAgB,aAAa,CAAA;AAAA,EACvE;AACA,EAAA,OAAO,MAAA;AACT;AAMO,SAAS,WAAA,CACd,SACA,QAAA,EACsC;AACtC,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,WAAW,CAAA,EAAG;AACtC,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,UAAU,CAAC,YAAA,CAAa,UAAU,WAAW,CAAC,EAAE,IAAA,EAAK;AAC3D,EAAA,IAAI,QAAQ,IAAA,CAAK,CAAC,UAAU,OAAO,KAAA,KAAU,QAAQ,CAAA,EAAG;AACtD,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,WAAA,EAAa,qCAAqC,CAAA;AAAA,EAC5F;AACA,EAAA,IAAI;AACF,IAAA,OAAOK,qBAAW,OAAO,CAAA;AAAA,EAC3B,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAIC,oBAAA,CAAW,OAAA,EAAS,KAAK,CAAA;AAAA,EACrC;AACF;AAMA,SAAS,cAAA,CAAe,OAAA,EAAiB,QAAA,EAAuB,UAAA,EAAkC;AAChG,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,sBAAsB,CAAA,EAAG;AACjD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,sBAAsB,CAAA,IAAK,EAAA;AAChE,EAAA,MAAM,YAAY,OAAO,KAAA,KAAU,WAAWC,sBAAA,CAAa,KAAA,EAAO,UAAU,CAAA,GAAI,MAAA;AAChF,EAAA,IAAI,cAAc,MAAA,EAAW;AAC3B,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,sBAAA,EAAwB,mBAAmB,CAAA;AAAA,EACrF;AACA,EAAA,OAAO,EAAE,cAAc,SAAA,EAAU;AACnC;AAGA,SAAS,gBAAA,CAAiB,SAAiB,QAAA,EAAwC;AACjF,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,wBAAwB,CAAA,EAAG;AACnD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,wBAAwB,KAAK,EAAC;AACnE,EAAA,MAAM,OAAA,GAAU,CAAC,KAAK,CAAA,CAAE,IAAA,EAAK;AAC7B,EAAA,IAAI,QAAQ,IAAA,CAAK,CAAC,UAAU,OAAO,KAAA,KAAU,QAAQ,CAAA,EAAG;AACtD,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,wBAAA,EAA0B,aAAa,CAAA;AAAA,EACjF;AACA,EAAA,OAAO,EAAE,cAAA,EAAgBC,qBAAA,CAAS,OAAO,CAAA,IAAK,EAAC,EAAE;AACnD;AAOO,SAAS,kBAAA,CACd,OAAA,EACA,QAAA,EACA,UAAA,EACiB;AACjB,EAAA,OAAO;AAAA,IACL,GAAG,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,UAAU,CAAA;AAAA,IAC/C,GAAG,gBAAA,CAAiB,OAAA,EAAS,QAAQ;AAAA,GACvC;AACF;;;;;;;;"}

package/dist/cli/api-settings.mjs

@@ -1,14 +1,15 @@
 import { kebabCase } from 'scule';
-import { isOpenAPITypesafeError, OpenAPITypesafeError } from '../domain/errors.mjs';
 import { warningText, WARNING_CODES } from '../domain/warnings.mjs';
-import { GENERATOR_FLAGS, hostList } from './cli-arguments.mjs';
-import { cliError } from './cli-errors.mjs';
-import { resolveLocationUrl } from './cli-output.mjs';
+import { hostList } from './cli-arguments.mjs';
+import { cliError, ApiFailure } from './cli-errors.mjs';
 import { fixNamesOf } from './fix-option.mjs';
+import { localRootUrl } from './ref-limits.mjs';
+import { GENERATOR_FLAGS } from './cli-flag-names.mjs';
 
 const OUTPUT_SETTING = "output";
 const FIX_SETTING = "fix";
 const LOCAL_REF_ROOT_SETTING = "localRefRoot";
+const LOCAL_ROOT_EXPECTED = "a directory path or a file: URL";
 const REMOTE_REF_HOSTS_SETTING = "remoteRefHosts";
 const IGNORED_SETTINGS = ["contentNever"];
 const CAMEL_CASE_SETTINGS = [
@@ -82,27 +83,19 @@ function apiFixNames(apiName, settings) {
   try {
     return fixNamesOf(entries);
   } catch (error) {
-    throw isOpenAPITypesafeError(error) ? withApiName(apiName, error) : error;
+    throw new ApiFailure(apiName, error);
   }
 }
-function withApiName(apiName, error) {
-  const { code, details, cause } = error;
-  return new OpenAPITypesafeError({
-    code,
-    message: `API ${apiName}: ${error.message}`,
-    details,
-    cause
-  });
-}
 function localRefRootOf(apiName, settings, configRoot) {
   if (!hasSetting(settings, LOCAL_REF_ROOT_SETTING)) {
     return {};
   }
   const value = settingValue(settings, LOCAL_REF_ROOT_SETTING) ?? "";
-  if (typeof value !== "string") {
-    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, "a directory path");
+  const localRoot = typeof value === "string" ? localRootUrl(value, configRoot) : void 0;
+  if (localRoot === void 0) {
+    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, LOCAL_ROOT_EXPECTED);
   }
-  return { localRefRoot: resolveLocationUrl(value === "" ? "." : value, configRoot) };
+  return { localRefRoot: localRoot };
 }
 function remoteRefHostsOf(apiName, settings) {
   if (!hasSetting(settings, REMOTE_REF_HOSTS_SETTING)) {

package/dist/cli/api-settings.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"api-settings.mjs","sources":["../../src/cli/api-settings.ts"],"sourcesContent":["import { kebabCase } from \"scule\";\nimport { isOpenAPITypesafeError, OpenAPITypesafeError } from \"../domain/errors.js\";\nimport type { OutputFixName } from \"../domain/output-fixes.js\";\nimport { WARNING_CODES, warningText } from \"../domain/warnings.js\";\nimport { GENERATOR_FLAGS, type GeneratorFlags, hostList } from \"./cli-arguments.js\";\nimport { cliError } from \"./cli-errors.js\";\nimport { resolveLocationUrl } from \"./cli-output.js\";\nimport { fixNamesOf } from \"./fix-option.js\";\nimport type { RefLimitOptions } from \"./ref-limits.js\";\n\n/**\n * The settings of one API in `redocly.yaml` (`apis.<name>.x-openapi-ts`). A setting has the name\n * of its CLI flag, in kebab-case or camelCase (ADR-021, decision 1); a setting the CLI does not\n * read gets a warning, as an unknown flag gets a notice.\n */\n\nexport type ApiSettings = Readonly<Record<string, unknown>>;\n\n/** The setting that names the output file. */\nexport const OUTPUT_SETTING = \"output\";\n\n/** The setting that lists the API's output fixes. */\nexport const FIX_SETTING = \"fix\";\n\nconst LOCAL_REF_ROOT_SETTING = \"localRefRoot\";\nconst REMOTE_REF_HOSTS_SETTING = \"remoteRefHosts\";\n\n/** `--content-never` is accepted and has no effect, as on the command line. */\nconst IGNORED_SETTINGS = [\"contentNever\"] as const;\n\nconst CAMEL_CASE_SETTINGS = [\n  OUTPUT_SETTING,\n  FIX_SETTING,\n  LOCAL_REF_ROOT_SETTING,\n  REMOTE_REF_HOSTS_SETTING,\n  ...GENERATOR_FLAGS,\n  ...IGNORED_SETTINGS,\n];\n\nconst KNOWN_SETTINGS = new Set<string>([\n  ...CAMEL_CASE_SETTINGS,\n  ...CAMEL_CASE_SETTINGS.map((name) => kebabCase(name)),\n]);\n\n/** The warning for each setting of an API that no code reads. */\nexport function unknownSettingWarnings(apiName: string, settings: ApiSettings): string[] {\n  return Object.keys(settings)\n    .filter((key) => !KNOWN_SETTINGS.has(key))\n    .map((key) =>\n      warningText(\n        `API ${apiName}: the setting \\`${key}\\` is not an openapi-typesafe option and is ignored`,\n        WARNING_CODES.CONFIG_SETTING_UNKNOWN,\n      ),\n    );\n}\n\n/** The key a setting is written with: camelCase, else kebab-case; undefined when it is absent. */\nfunction settingKey(settings: ApiSettings, name: string): string | undefined {\n  if (name in settings) {\n    return name;\n  }\n  const kebabName = kebabCase(name);\n  return kebabName in settings ? kebabName : undefined;\n}\n\n/** The value of a setting in camelCase, else in kebab-case; `undefined` when it is absent. */\nfunction settingValue(settings: ApiSettings, name: string): unknown {\n  const key = settingKey(settings, name);\n  return key === undefined ? undefined : settings[key];\n}\n\nfunction hasSetting(settings: ApiSettings, name: string): boolean {\n  return settingKey(settings, name) !== undefined;\n}\n\n/** `CLI_CONFIG_INVALID` for the setting `name` of an API, named as the user wrote it. */\nfunction invalidSetting(apiName: string, settings: ApiSettings, name: string, expected: string) {\n  const key = settingKey(settings, name) ?? kebabCase(name);\n  return cliError(\n    \"CLI_CONFIG_INVALID\",\n    `API ${apiName}: \\`${key}\\` in x-openapi-ts must be ${expected}`,\n  );\n}\n\n/**\n * The boolean flags an API sets, in camelCase or kebab-case; they win over the CLI's flags. A\n * value of another type (`root-types: \"true\"`) fails with `CLI_CONFIG_INVALID`: ignoring it\n * would generate other types than the config asks for, without a word.\n */\nexport function apiFlags(apiName: string, settings: ApiSettings): GeneratorFlags {\n  const flags: Partial<Record<(typeof GENERATOR_FLAGS)[number], boolean>> = {};\n  for (const name of GENERATOR_FLAGS) {\n    const value = settingValue(settings, name);\n    if (typeof value === \"boolean\") {\n      flags[name] = value;\n    } else if (hasSetting(settings, name)) {\n      throw invalidSetting(apiName, settings, name, \"true or false\");\n    }\n  }\n  return flags;\n}\n\n/** The API's `output` file as written; fails with `CLI_CONFIG_INVALID` when it is not text. */\nexport function apiOutputOf(apiName: string, settings: ApiSettings): string {\n  const output = settings[OUTPUT_SETTING];\n  if (typeof output !== \"string\") {\n    throw invalidSetting(apiName, settings, OUTPUT_SETTING, \"a file path\");\n  }\n  return output;\n}\n\n/**\n * The API's `fix` names, which replace the CLI's `--fix` (ADR-021). An entry that is not text\n * fails with `CLI_CONFIG_INVALID`; an unknown name with `OPTION_FIX_UNKNOWN`, naming the API.\n */\nexport function apiFixNames(\n  apiName: string,\n  settings: ApiSettings,\n): readonly OutputFixName[] | undefined {\n  if (!hasSetting(settings, FIX_SETTING)) {\n    return undefined;\n  }\n  const entries = [settingValue(settings, FIX_SETTING)].flat();\n  if (entries.some((entry) => typeof entry !== \"string\")) {\n    throw invalidSetting(apiName, settings, FIX_SETTING, \"a list of fix names or a comma list\");\n  }\n  try {\n    return fixNamesOf(entries);\n  } catch (error) {\n    throw isOpenAPITypesafeError(error) ? withApiName(apiName, error) : error;\n  }\n}\n\n/** The same error, with the API named first in its message. */\nfunction withApiName(apiName: string, error: OpenAPITypesafeError): OpenAPITypesafeError {\n  const { code, details, cause } = error;\n  return new OpenAPITypesafeError({\n    code,\n    message: `API ${apiName}: ${error.message}`,\n    details,\n    cause,\n  });\n}\n\n/** `local-ref-root: dir`, relative to the config file; empty means the config file's directory. */\nfunction localRefRootOf(apiName: string, settings: ApiSettings, configRoot: URL): RefLimitOptions {\n  if (!hasSetting(settings, LOCAL_REF_ROOT_SETTING)) {\n    return {};\n  }\n  const value = settingValue(settings, LOCAL_REF_ROOT_SETTING) ?? \"\";\n  if (typeof value !== \"string\") {\n    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, \"a directory path\");\n  }\n  return { localRefRoot: resolveLocationUrl(value === \"\" ? \".\" : value, configRoot) };\n}\n\n/** `remote-ref-hosts: [a, b]` or `a,b`; an empty list or value allows no host. */\nfunction remoteRefHostsOf(apiName: string, settings: ApiSettings): RefLimitOptions {\n  if (!hasSetting(settings, REMOTE_REF_HOSTS_SETTING)) {\n    return {};\n  }\n  const value = settingValue(settings, REMOTE_REF_HOSTS_SETTING) ?? [];\n  const entries = [value].flat();\n  if (entries.some((entry) => typeof entry !== \"string\")) {\n    throw invalidSetting(apiName, settings, REMOTE_REF_HOSTS_SETTING, \"a host list\");\n  }\n  return { remoteRefHosts: hostList(entries) ?? [] };\n}\n\n/**\n * The `$ref` limits an API sets (threat model R1, R2). Each one replaces the CLI flag of the same\n * name for this API, as its boolean settings and `fix` do; fails with `CLI_CONFIG_INVALID` for a\n * value of another type.\n */\nexport function apiRefLimitOptions(\n  apiName: string,\n  settings: ApiSettings,\n  configRoot: URL,\n): RefLimitOptions {\n  return {\n    ...localRefRootOf(apiName, settings, configRoot),\n    ...remoteRefHostsOf(apiName, settings),\n  };\n}\n"],"names":[],"mappings":";;;;;;;;AAmBO,MAAM,cAAA,GAAiB;AAGvB,MAAM,WAAA,GAAc;AAE3B,MAAM,sBAAA,GAAyB,cAAA;AAC/B,MAAM,wBAAA,GAA2B,gBAAA;AAGjC,MAAM,gBAAA,GAAmB,CAAC,cAAc,CAAA;AAExC,MAAM,mBAAA,GAAsB;AAAA,EAC1B,cAAA;AAAA,EACA,WAAA;AAAA,EACA,sBAAA;AAAA,EACA,wBAAA;AAAA,EACA,GAAG,eAAA;AAAA,EACH,GAAG;AACL,CAAA;AAEA,MAAM,cAAA,uBAAqB,GAAA,CAAY;AAAA,EACrC,GAAG,mBAAA;AAAA,EACH,GAAG,mBAAA,CAAoB,GAAA,CAAI,CAAC,IAAA,KAAS,SAAA,CAAU,IAAI,CAAC;AACtD,CAAC,CAAA;AAGM,SAAS,sBAAA,CAAuB,SAAiB,QAAA,EAAiC;AACvF,EAAA,OAAO,MAAA,CAAO,IAAA,CAAK,QAAQ,CAAA,CACxB,MAAA,CAAO,CAAC,GAAA,KAAQ,CAAC,cAAA,CAAe,GAAA,CAAI,GAAG,CAAC,CAAA,CACxC,GAAA;AAAA,IAAI,CAAC,GAAA,KACJ,WAAA;AAAA,MACE,CAAA,IAAA,EAAO,OAAO,CAAA,gBAAA,EAAmB,GAAG,CAAA,mDAAA,CAAA;AAAA,MACpC,aAAA,CAAc;AAAA;AAChB,GACF;AACJ;AAGA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAkC;AAC3E,EAAA,IAAI,QAAQ,QAAA,EAAU;AACpB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,UAAU,IAAI,CAAA;AAChC,EAAA,OAAO,SAAA,IAAa,WAAW,SAAA,GAAY,MAAA;AAC7C;AAGA,SAAS,YAAA,CAAa,UAAuB,IAAA,EAAuB;AAClE,EAAA,MAAM,GAAA,GAAM,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA;AACrC,EAAA,OAAO,GAAA,KAAQ,MAAA,GAAY,MAAA,GAAY,QAAA,CAAS,GAAG,CAAA;AACrD;AAEA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAuB;AAChE,EAAA,OAAO,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,KAAM,MAAA;AACxC;AAGA,SAAS,cAAA,CAAe,OAAA,EAAiB,QAAA,EAAuB,IAAA,EAAc,QAAA,EAAkB;AAC9F,EAAA,MAAM,MAAM,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,IAAK,UAAU,IAAI,CAAA;AACxD,EAAA,OAAO,QAAA;AAAA,IACL,oBAAA;AAAA,IACA,CAAA,IAAA,EAAO,OAAO,CAAA,IAAA,EAAO,GAAG,8BAA8B,QAAQ,CAAA;AAAA,GAChE;AACF;AAOO,SAAS,QAAA,CAAS,SAAiB,QAAA,EAAuC;AAC/E,EAAA,MAAM,QAAoE,EAAC;AAC3E,EAAA,KAAA,MAAW,QAAQ,eAAA,EAAiB;AAClC,IAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,IAAI,CAAA;AACzC,IAAA,IAAI,OAAO,UAAU,SAAA,EAAW;AAC9B,MAAA,KAAA,CAAM,IAAI,CAAA,GAAI,KAAA;AAAA,IAChB,CAAA,MAAA,IAAW,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,EAAG;AACrC,MAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,IAAA,EAAM,eAAe,CAAA;AAAA,IAC/D;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAGO,SAAS,WAAA,CAAY,SAAiB,QAAA,EAA+B;AAC1E,EAAA,MAAM,MAAA,GAAS,SAAS,cAAc,CAAA;AACtC,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAC9B,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,cAAA,EAAgB,aAAa,CAAA;AAAA,EACvE;AACA,EAAA,OAAO,MAAA;AACT;AAMO,SAAS,WAAA,CACd,SACA,QAAA,EACsC;AACtC,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,WAAW,CAAA,EAAG;AACtC,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,UAAU,CAAC,YAAA,CAAa,UAAU,WAAW,CAAC,EAAE,IAAA,EAAK;AAC3D,EAAA,IAAI,QAAQ,IAAA,CAAK,CAAC,UAAU,OAAO,KAAA,KAAU,QAAQ,CAAA,EAAG;AACtD,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,WAAA,EAAa,qCAAqC,CAAA;AAAA,EAC5F;AACA,EAAA,IAAI;AACF,IAAA,OAAO,WAAW,OAAO,CAAA;AAAA,EAC3B,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,uBAAuB,KAAK,CAAA,GAAI,WAAA,CAAY,OAAA,EAAS,KAAK,CAAA,GAAI,KAAA;AAAA,EACtE;AACF;AAGA,SAAS,WAAA,CAAY,SAAiB,KAAA,EAAmD;AACvF,EAAA,MAAM,EAAE,IAAA,EAAM,OAAA,EAAS,KAAA,EAAM,GAAI,KAAA;AACjC,EAAA,OAAO,IAAI,oBAAA,CAAqB;AAAA,IAC9B,IAAA;AAAA,IACA,OAAA,EAAS,CAAA,IAAA,EAAO,OAAO,CAAA,EAAA,EAAK,MAAM,OAAO,CAAA,CAAA;AAAA,IACzC,OAAA;AAAA,IACA;AAAA,GACD,CAAA;AACH;AAGA,SAAS,cAAA,CAAe,OAAA,EAAiB,QAAA,EAAuB,UAAA,EAAkC;AAChG,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,sBAAsB,CAAA,EAAG;AACjD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,sBAAsB,CAAA,IAAK,EAAA;AAChE,EAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,sBAAA,EAAwB,kBAAkB,CAAA;AAAA,EACpF;AACA,EAAA,OAAO,EAAE,cAAc,kBAAA,CAAmB,KAAA,KAAU,KAAK,GAAA,GAAM,KAAA,EAAO,UAAU,CAAA,EAAE;AACpF;AAGA,SAAS,gBAAA,CAAiB,SAAiB,QAAA,EAAwC;AACjF,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,wBAAwB,CAAA,EAAG;AACnD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,wBAAwB,KAAK,EAAC;AACnE,EAAA,MAAM,OAAA,GAAU,CAAC,KAAK,CAAA,CAAE,IAAA,EAAK;AAC7B,EAAA,IAAI,QAAQ,IAAA,CAAK,CAAC,UAAU,OAAO,KAAA,KAAU,QAAQ,CAAA,EAAG;AACtD,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,wBAAA,EAA0B,aAAa,CAAA;AAAA,EACjF;AACA,EAAA,OAAO,EAAE,cAAA,EAAgB,QAAA,CAAS,OAAO,CAAA,IAAK,EAAC,EAAE;AACnD;AAOO,SAAS,kBAAA,CACd,OAAA,EACA,QAAA,EACA,UAAA,EACiB;AACjB,EAAA,OAAO;AAAA,IACL,GAAG,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,UAAU,CAAA;AAAA,IAC/C,GAAG,gBAAA,CAAiB,OAAA,EAAS,QAAQ;AAAA,GACvC;AACF;;"}
+{"version":3,"file":"api-settings.mjs","sources":["../../src/cli/api-settings.ts"],"sourcesContent":["import { kebabCase } from \"scule\";\nimport type { OutputFixName } from \"../domain/output-fixes.js\";\nimport { WARNING_CODES, warningText } from \"../domain/warnings.js\";\nimport { GENERATOR_FLAGS, type GeneratorFlags, hostList } from \"./cli-arguments.js\";\nimport { ApiFailure, cliError } from \"./cli-errors.js\";\nimport { fixNamesOf } from \"./fix-option.js\";\nimport { localRootUrl, type RefLimitOptions } from \"./ref-limits.js\";\n\n/**\n * The settings of one API in `redocly.yaml` (`apis.<name>.x-openapi-ts`). A setting has the name\n * of its CLI flag, in kebab-case or camelCase (ADR-021, decision 1); a setting the CLI does not\n * read gets a warning, as an unknown flag gets a notice.\n */\n\nexport type ApiSettings = Readonly<Record<string, unknown>>;\n\n/** The setting that names the output file. */\nexport const OUTPUT_SETTING = \"output\";\n\n/** The setting that lists the API's output fixes. */\nexport const FIX_SETTING = \"fix\";\n\nconst LOCAL_REF_ROOT_SETTING = \"localRefRoot\";\nconst LOCAL_ROOT_EXPECTED = \"a directory path or a file: URL\";\nconst REMOTE_REF_HOSTS_SETTING = \"remoteRefHosts\";\n\n/** `--content-never` is accepted and has no effect, as on the command line. */\nconst IGNORED_SETTINGS = [\"contentNever\"] as const;\n\nconst CAMEL_CASE_SETTINGS = [\n  OUTPUT_SETTING,\n  FIX_SETTING,\n  LOCAL_REF_ROOT_SETTING,\n  REMOTE_REF_HOSTS_SETTING,\n  ...GENERATOR_FLAGS,\n  ...IGNORED_SETTINGS,\n];\n\nconst KNOWN_SETTINGS = new Set<string>([\n  ...CAMEL_CASE_SETTINGS,\n  ...CAMEL_CASE_SETTINGS.map((name) => kebabCase(name)),\n]);\n\n/** The warning for each setting of an API that no code reads. */\nexport function unknownSettingWarnings(apiName: string, settings: ApiSettings): string[] {\n  return Object.keys(settings)\n    .filter((key) => !KNOWN_SETTINGS.has(key))\n    .map((key) =>\n      warningText(\n        `API ${apiName}: the setting \\`${key}\\` is not an openapi-typesafe option and is ignored`,\n        WARNING_CODES.CONFIG_SETTING_UNKNOWN,\n      ),\n    );\n}\n\n/** The key a setting is written with: camelCase, else kebab-case; undefined when it is absent. */\nfunction settingKey(settings: ApiSettings, name: string): string | undefined {\n  if (name in settings) {\n    return name;\n  }\n  const kebabName = kebabCase(name);\n  return kebabName in settings ? kebabName : undefined;\n}\n\n/** The value of a setting in camelCase, else in kebab-case; `undefined` when it is absent. */\nfunction settingValue(settings: ApiSettings, name: string): unknown {\n  const key = settingKey(settings, name);\n  return key === undefined ? undefined : settings[key];\n}\n\nfunction hasSetting(settings: ApiSettings, name: string): boolean {\n  return settingKey(settings, name) !== undefined;\n}\n\n/** `CLI_CONFIG_INVALID` for the setting `name` of an API, named as the user wrote it. */\nfunction invalidSetting(apiName: string, settings: ApiSettings, name: string, expected: string) {\n  const key = settingKey(settings, name) ?? kebabCase(name);\n  return cliError(\n    \"CLI_CONFIG_INVALID\",\n    `API ${apiName}: \\`${key}\\` in x-openapi-ts must be ${expected}`,\n  );\n}\n\n/**\n * The boolean flags an API sets, in camelCase or kebab-case; they win over the CLI's flags. A\n * value of another type (`root-types: \"true\"`) fails with `CLI_CONFIG_INVALID`: ignoring it\n * would generate other types than the config asks for, without a word.\n */\nexport function apiFlags(apiName: string, settings: ApiSettings): GeneratorFlags {\n  const flags: Partial<Record<(typeof GENERATOR_FLAGS)[number], boolean>> = {};\n  for (const name of GENERATOR_FLAGS) {\n    const value = settingValue(settings, name);\n    if (typeof value === \"boolean\") {\n      flags[name] = value;\n    } else if (hasSetting(settings, name)) {\n      throw invalidSetting(apiName, settings, name, \"true or false\");\n    }\n  }\n  return flags;\n}\n\n/** The API's `output` file as written; fails with `CLI_CONFIG_INVALID` when it is not text. */\nexport function apiOutputOf(apiName: string, settings: ApiSettings): string {\n  const output = settings[OUTPUT_SETTING];\n  if (typeof output !== \"string\") {\n    throw invalidSetting(apiName, settings, OUTPUT_SETTING, \"a file path\");\n  }\n  return output;\n}\n\n/**\n * The API's `fix` names, which replace the CLI's `--fix` (ADR-021). An entry that is not text\n * fails with `CLI_CONFIG_INVALID`; an unknown name with `OPTION_FIX_UNKNOWN`, naming the API.\n */\nexport function apiFixNames(\n  apiName: string,\n  settings: ApiSettings,\n): readonly OutputFixName[] | undefined {\n  if (!hasSetting(settings, FIX_SETTING)) {\n    return undefined;\n  }\n  const entries = [settingValue(settings, FIX_SETTING)].flat();\n  if (entries.some((entry) => typeof entry !== \"string\")) {\n    throw invalidSetting(apiName, settings, FIX_SETTING, \"a list of fix names or a comma list\");\n  }\n  try {\n    return fixNamesOf(entries);\n  } catch (error) {\n    throw new ApiFailure(apiName, error);\n  }\n}\n\n/**\n * `local-ref-root: dir`, relative to the config file; empty means the config file's directory. A\n * value that is no text or a URL of another protocol fails with `CLI_CONFIG_INVALID`.\n */\nfunction localRefRootOf(apiName: string, settings: ApiSettings, configRoot: URL): RefLimitOptions {\n  if (!hasSetting(settings, LOCAL_REF_ROOT_SETTING)) {\n    return {};\n  }\n  const value = settingValue(settings, LOCAL_REF_ROOT_SETTING) ?? \"\";\n  const localRoot = typeof value === \"string\" ? localRootUrl(value, configRoot) : undefined;\n  if (localRoot === undefined) {\n    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, LOCAL_ROOT_EXPECTED);\n  }\n  return { localRefRoot: localRoot };\n}\n\n/** `remote-ref-hosts: [a, b]` or `a,b`; an empty list or value allows no host. */\nfunction remoteRefHostsOf(apiName: string, settings: ApiSettings): RefLimitOptions {\n  if (!hasSetting(settings, REMOTE_REF_HOSTS_SETTING)) {\n    return {};\n  }\n  const value = settingValue(settings, REMOTE_REF_HOSTS_SETTING) ?? [];\n  const entries = [value].flat();\n  if (entries.some((entry) => typeof entry !== \"string\")) {\n    throw invalidSetting(apiName, settings, REMOTE_REF_HOSTS_SETTING, \"a host list\");\n  }\n  return { remoteRefHosts: hostList(entries) ?? [] };\n}\n\n/**\n * The `$ref` limits an API sets (threat model R1, R2). Each one replaces the CLI flag of the same\n * name for this API, as its boolean settings and `fix` do; fails with `CLI_CONFIG_INVALID` for a\n * value of another type.\n */\nexport function apiRefLimitOptions(\n  apiName: string,\n  settings: ApiSettings,\n  configRoot: URL,\n): RefLimitOptions {\n  return {\n    ...localRefRootOf(apiName, settings, configRoot),\n    ...remoteRefHostsOf(apiName, settings),\n  };\n}\n"],"names":[],"mappings":";;;;;;;;AAiBO,MAAM,cAAA,GAAiB;AAGvB,MAAM,WAAA,GAAc;AAE3B,MAAM,sBAAA,GAAyB,cAAA;AAC/B,MAAM,mBAAA,GAAsB,iCAAA;AAC5B,MAAM,wBAAA,GAA2B,gBAAA;AAGjC,MAAM,gBAAA,GAAmB,CAAC,cAAc,CAAA;AAExC,MAAM,mBAAA,GAAsB;AAAA,EAC1B,cAAA;AAAA,EACA,WAAA;AAAA,EACA,sBAAA;AAAA,EACA,wBAAA;AAAA,EACA,GAAG,eAAA;AAAA,EACH,GAAG;AACL,CAAA;AAEA,MAAM,cAAA,uBAAqB,GAAA,CAAY;AAAA,EACrC,GAAG,mBAAA;AAAA,EACH,GAAG,mBAAA,CAAoB,GAAA,CAAI,CAAC,IAAA,KAAS,SAAA,CAAU,IAAI,CAAC;AACtD,CAAC,CAAA;AAGM,SAAS,sBAAA,CAAuB,SAAiB,QAAA,EAAiC;AACvF,EAAA,OAAO,MAAA,CAAO,IAAA,CAAK,QAAQ,CAAA,CACxB,MAAA,CAAO,CAAC,GAAA,KAAQ,CAAC,cAAA,CAAe,GAAA,CAAI,GAAG,CAAC,CAAA,CACxC,GAAA;AAAA,IAAI,CAAC,GAAA,KACJ,WAAA;AAAA,MACE,CAAA,IAAA,EAAO,OAAO,CAAA,gBAAA,EAAmB,GAAG,CAAA,mDAAA,CAAA;AAAA,MACpC,aAAA,CAAc;AAAA;AAChB,GACF;AACJ;AAGA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAkC;AAC3E,EAAA,IAAI,QAAQ,QAAA,EAAU;AACpB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,UAAU,IAAI,CAAA;AAChC,EAAA,OAAO,SAAA,IAAa,WAAW,SAAA,GAAY,MAAA;AAC7C;AAGA,SAAS,YAAA,CAAa,UAAuB,IAAA,EAAuB;AAClE,EAAA,MAAM,GAAA,GAAM,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA;AACrC,EAAA,OAAO,GAAA,KAAQ,MAAA,GAAY,MAAA,GAAY,QAAA,CAAS,GAAG,CAAA;AACrD;AAEA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAuB;AAChE,EAAA,OAAO,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,KAAM,MAAA;AACxC;AAGA,SAAS,cAAA,CAAe,OAAA,EAAiB,QAAA,EAAuB,IAAA,EAAc,QAAA,EAAkB;AAC9F,EAAA,MAAM,MAAM,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,IAAK,UAAU,IAAI,CAAA;AACxD,EAAA,OAAO,QAAA;AAAA,IACL,oBAAA;AAAA,IACA,CAAA,IAAA,EAAO,OAAO,CAAA,IAAA,EAAO,GAAG,8BAA8B,QAAQ,CAAA;AAAA,GAChE;AACF;AAOO,SAAS,QAAA,CAAS,SAAiB,QAAA,EAAuC;AAC/E,EAAA,MAAM,QAAoE,EAAC;AAC3E,EAAA,KAAA,MAAW,QAAQ,eAAA,EAAiB;AAClC,IAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,IAAI,CAAA;AACzC,IAAA,IAAI,OAAO,UAAU,SAAA,EAAW;AAC9B,MAAA,KAAA,CAAM,IAAI,CAAA,GAAI,KAAA;AAAA,IAChB,CAAA,MAAA,IAAW,UAAA,CAAW,QAAA,EAAU,IAAI,CAAA,EAAG;AACrC,MAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,IAAA,EAAM,eAAe,CAAA;AAAA,IAC/D;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAGO,SAAS,WAAA,CAAY,SAAiB,QAAA,EAA+B;AAC1E,EAAA,MAAM,MAAA,GAAS,SAAS,cAAc,CAAA;AACtC,EAAA,IAAI,OAAO,WAAW,QAAA,EAAU;AAC9B,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,cAAA,EAAgB,aAAa,CAAA;AAAA,EACvE;AACA,EAAA,OAAO,MAAA;AACT;AAMO,SAAS,WAAA,CACd,SACA,QAAA,EACsC;AACtC,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,WAAW,CAAA,EAAG;AACtC,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,UAAU,CAAC,YAAA,CAAa,UAAU,WAAW,CAAC,EAAE,IAAA,EAAK;AAC3D,EAAA,IAAI,QAAQ,IAAA,CAAK,CAAC,UAAU,OAAO,KAAA,KAAU,QAAQ,CAAA,EAAG;AACtD,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,WAAA,EAAa,qCAAqC,CAAA;AAAA,EAC5F;AACA,EAAA,IAAI;AACF,IAAA,OAAO,WAAW,OAAO,CAAA;AAAA,EAC3B,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,IAAI,UAAA,CAAW,OAAA,EAAS,KAAK,CAAA;AAAA,EACrC;AACF;AAMA,SAAS,cAAA,CAAe,OAAA,EAAiB,QAAA,EAAuB,UAAA,EAAkC;AAChG,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,sBAAsB,CAAA,EAAG;AACjD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,sBAAsB,CAAA,IAAK,EAAA;AAChE,EAAA,MAAM,YAAY,OAAO,KAAA,KAAU,WAAW,YAAA,CAAa,KAAA,EAAO,UAAU,CAAA,GAAI,MAAA;AAChF,EAAA,IAAI,cAAc,MAAA,EAAW;AAC3B,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,sBAAA,EAAwB,mBAAmB,CAAA;AAAA,EACrF;AACA,EAAA,OAAO,EAAE,cAAc,SAAA,EAAU;AACnC;AAGA,SAAS,gBAAA,CAAiB,SAAiB,QAAA,EAAwC;AACjF,EAAA,IAAI,CAAC,UAAA,CAAW,QAAA,EAAU,wBAAwB,CAAA,EAAG;AACnD,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,KAAA,GAAQ,YAAA,CAAa,QAAA,EAAU,wBAAwB,KAAK,EAAC;AACnE,EAAA,MAAM,OAAA,GAAU,CAAC,KAAK,CAAA,CAAE,IAAA,EAAK;AAC7B,EAAA,IAAI,QAAQ,IAAA,CAAK,CAAC,UAAU,OAAO,KAAA,KAAU,QAAQ,CAAA,EAAG;AACtD,IAAA,MAAM,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,wBAAA,EAA0B,aAAa,CAAA;AAAA,EACjF;AACA,EAAA,OAAO,EAAE,cAAA,EAAgB,QAAA,CAAS,OAAO,CAAA,IAAK,EAAC,EAAE;AACnD;AAOO,SAAS,kBAAA,CACd,OAAA,EACA,QAAA,EACA,UAAA,EACiB;AACjB,EAAA,OAAO;AAAA,IACL,GAAG,cAAA,CAAe,OAAA,EAAS,QAAA,EAAU,UAAU,CAAA;AAAA,IAC/C,GAAG,gBAAA,CAAiB,OAAA,EAAS,QAAQ;AAAA,GACvC;AACF;;"}

package/dist/cli/api-writes.cjs

@@ -1,5 +1,6 @@
 'use strict';
 
+const cliErrors = require('./cli-errors.cjs');
 const cliOutput = require('./cli-output.cjs');
 
 function failuresOf(step) {
@@ -44,6 +45,11 @@ function writeClaimed(run, { api, claim }) {
   const failures = failuresOf(() => cliOutput.emitOutput(run, api.outputFile, api.types.contents));
   return failures.length > 0 && claim ? [...failures, ...failuresOf(() => claim.release())] : failures;
 }
+function namedFailures(failures) {
+  return new Map(
+    [...failures].map(([name, list]) => [name, list.map((cause) => new cliErrors.ApiFailure(name, cause))])
+  );
+}
 function writeGeneratedApis(run, apis, readFiles) {
   const failures = /* @__PURE__ */ new Map();
   const ownOutputs = apis.filter((api) => {
@@ -64,7 +70,7 @@ function writeGeneratedApis(run, apis, readFiles) {
   for (const entry of claimed.filter(({ api }) => !shared.has(api.name))) {
     failures.set(entry.api.name, writeClaimed(run, entry));
   }
-  return failures;
+  return namedFailures(failures);
 }
 
 exports.failuresOf = failuresOf;

package/dist/cli/api-writes.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"api-writes.cjs","sources":["../../src/cli/api-writes.ts"],"sourcesContent":["import type { ClaimedFile } from \"../application/ports/file-system.js\";\nimport type { GeneratedTypes } from \"./cli-dependencies.js\";\nimport {\n  type CliRun,\n  duplicateOutputError,\n  emitOutput,\n  ensureOutputIsNotSchema,\n  type NamedFile,\n  type OutputFile,\n} from \"./cli-output.js\";\n\n/**\n * Writing the generated APIs of a Redocly config. Before the first byte is written, every output\n * is claimed: a missing one is created empty, so the file system gives it its own identity. Two\n * APIs whose files then have one identity fail with `CLI_OUTPUT_DUPLICATE` and write nothing,\n * also when their names looked different (ADR-043, decision 1).\n */\n\n/** An API whose types are generated and not written yet. */\nexport interface GeneratedApi {\n  readonly name: string;\n  readonly outputFile: OutputFile;\n  readonly types: GeneratedTypes;\n}\n\n/** An API whose output is claimed; `claim` is undefined with `--check`, which writes nothing. */\ninterface ClaimedApi {\n  readonly api: GeneratedApi;\n  readonly claim: ClaimedFile | undefined;\n}\n\n/** The failures of the API an API name maps to; an API without failures was written. */\ntype ApiFailures = Map<string, unknown[]>;\n\n/** The failure of a step, as a list: empty when it succeeded. */\nexport function failuresOf(step: () => void): unknown[] {\n  try {\n    step();\n    return [];\n  } catch (failure) {\n    return [failure];\n  }\n}\n\n/** Claim the output of each API; an API whose claim fails gets that failure instead. */\nfunction claimOutputs(run: CliRun, apis: readonly GeneratedApi[], failures: ApiFailures) {\n  const claimed: ClaimedApi[] = [];\n  for (const api of apis) {\n    try {\n      const claim = run.args.isCheck ? undefined : run.deps.files.claimFile(api.outputFile.file);\n      claimed.push({ api, claim });\n    } catch (failure) {\n      failures.set(api.name, [failure]);\n    }\n  }\n  return claimed;\n}\n\n/** The APIs that share their claimed file with another, by API name, with the other names. */\nfunction sharedOutputs(claimed: readonly ClaimedApi[]): Map<string, string[]> {\n  const byIdentity = new Map<string, string[]>();\n  for (const { api, claim } of claimed) {\n    if (claim) {\n      byIdentity.set(claim.identity, [...(byIdentity.get(claim.identity) ?? []), api.name]);\n    }\n  }\n  const shared = new Map<string, string[]>();\n  for (const names of byIdentity.values()) {\n    for (const name of names.length > 1 ? names : []) {\n      shared.set(\n        name,\n        names.filter((other) => other !== name).map((other) => `API ${other}`),\n      );\n    }\n  }\n  return shared;\n}\n\n/** Write one claimed API; a failed write releases the claim, so no empty file is left. */\nfunction writeClaimed(run: CliRun, { api, claim }: ClaimedApi): unknown[] {\n  const failures = failuresOf(() => emitOutput(run, api.outputFile, api.types.contents));\n  return failures.length > 0 && claim\n    ? [...failures, ...failuresOf(() => claim.release())]\n    : failures;\n}\n\n/**\n * Write (or `--check`) every API unless its output is a file the run read or the file of another\n * API. Returns the failures by API name. Claims are released in reverse order, so a directory\n * one claim created is empty by the time it is removed.\n */\nexport function writeGeneratedApis(\n  run: CliRun,\n  apis: readonly GeneratedApi[],\n  readFiles: readonly NamedFile[],\n): ApiFailures {\n  const failures: ApiFailures = new Map();\n  const ownOutputs = apis.filter((api) => {\n    const failure = failuresOf(() => ensureOutputIsNotSchema(run, api.outputFile, readFiles));\n    failures.set(api.name, failure);\n    return failure.length === 0;\n  });\n  const claimed = claimOutputs(run, ownOutputs, failures);\n  const shared = sharedOutputs(claimed);\n  for (const entry of [...claimed].reverse()) {\n    const { api, claim } = entry;\n    const others = shared.get(api.name);\n    if (others) {\n      const release = claim ? failuresOf(() => claim.release()) : [];\n      failures.set(api.name, [duplicateOutputError(api.outputFile, others), ...release]);\n    }\n  }\n  for (const entry of claimed.filter(({ api }) => !shared.has(api.name))) {\n    failures.set(entry.api.name, writeClaimed(run, entry));\n  }\n  return failures;\n}\n"],"names":["emitOutput","ensureOutputIsNotSchema","duplicateOutputError"],"mappings":";;;;AAmCO,SAAS,WAAW,IAAA,EAA6B;AACtD,EAAA,IAAI;AACF,IAAA,IAAA,EAAK;AACL,IAAA,OAAO,EAAC;AAAA,EACV,SAAS,OAAA,EAAS;AAChB,IAAA,OAAO,CAAC,OAAO,CAAA;AAAA,EACjB;AACF;AAGA,SAAS,YAAA,CAAa,GAAA,EAAa,IAAA,EAA+B,QAAA,EAAuB;AACvF,EAAA,MAAM,UAAwB,EAAC;AAC/B,EAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,IAAA,IAAI;AACF,MAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,IAAA,CAAK,OAAA,GAAU,KAAA,CAAA,GAAY,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,SAAA,CAAU,GAAA,CAAI,UAAA,CAAW,IAAI,CAAA;AACzF,MAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,GAAA,EAAK,KAAA,EAAO,CAAA;AAAA,IAC7B,SAAS,OAAA,EAAS;AAChB,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,CAAC,OAAO,CAAC,CAAA;AAAA,IAClC;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;AAGA,SAAS,cAAc,OAAA,EAAuD;AAC5E,EAAA,MAAM,UAAA,uBAAiB,GAAA,EAAsB;AAC7C,EAAA,KAAA,MAAW,EAAE,GAAA,EAAK,KAAA,EAAM,IAAK,OAAA,EAAS;AACpC,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,UAAA,CAAW,GAAA,CAAI,KAAA,CAAM,QAAA,EAAU,CAAC,GAAI,UAAA,CAAW,GAAA,CAAI,KAAA,CAAM,QAAQ,CAAA,IAAK,EAAC,EAAI,GAAA,CAAI,IAAI,CAAC,CAAA;AAAA,IACtF;AAAA,EACF;AACA,EAAA,MAAM,MAAA,uBAAa,GAAA,EAAsB;AACzC,EAAA,KAAA,MAAW,KAAA,IAAS,UAAA,CAAW,MAAA,EAAO,EAAG;AACvC,IAAA,KAAA,MAAW,QAAQ,KAAA,CAAM,MAAA,GAAS,CAAA,GAAI,KAAA,GAAQ,EAAC,EAAG;AAChD,MAAA,MAAA,CAAO,GAAA;AAAA,QACL,IAAA;AAAA,QACA,KAAA,CAAM,MAAA,CAAO,CAAC,KAAA,KAAU,KAAA,KAAU,IAAI,CAAA,CAAE,GAAA,CAAI,CAAC,KAAA,KAAU,CAAA,IAAA,EAAO,KAAK,CAAA,CAAE;AAAA,OACvE;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;AAGA,SAAS,YAAA,CAAa,GAAA,EAAa,EAAE,GAAA,EAAK,OAAM,EAA0B;AACxE,EAAA,MAAM,QAAA,GAAW,UAAA,CAAW,MAAMA,oBAAA,CAAW,GAAA,EAAK,IAAI,UAAA,EAAY,GAAA,CAAI,KAAA,CAAM,QAAQ,CAAC,CAAA;AACrF,EAAA,OAAO,QAAA,CAAS,MAAA,GAAS,CAAA,IAAK,KAAA,GAC1B,CAAC,GAAG,QAAA,EAAU,GAAG,UAAA,CAAW,MAAM,KAAA,CAAM,OAAA,EAAS,CAAC,CAAA,GAClD,QAAA;AACN;AAOO,SAAS,kBAAA,CACd,GAAA,EACA,IAAA,EACA,SAAA,EACa;AACb,EAAA,MAAM,QAAA,uBAA4B,GAAA,EAAI;AACtC,EAAA,MAAM,UAAA,GAAa,IAAA,CAAK,MAAA,CAAO,CAAC,GAAA,KAAQ;AACtC,IAAA,MAAM,OAAA,GAAU,WAAW,MAAMC,iCAAA,CAAwB,KAAK,GAAA,CAAI,UAAA,EAAY,SAAS,CAAC,CAAA;AACxF,IAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,OAAO,CAAA;AAC9B,IAAA,OAAO,QAAQ,MAAA,KAAW,CAAA;AAAA,EAC5B,CAAC,CAAA;AACD,EAAA,MAAM,OAAA,GAAU,YAAA,CAAa,GAAA,EAAK,UAAA,EAAY,QAAQ,CAAA;AACtD,EAAA,MAAM,MAAA,GAAS,cAAc,OAAO,CAAA;AACpC,EAAA,KAAA,MAAW,SAAS,CAAC,GAAG,OAAO,CAAA,CAAE,SAAQ,EAAG;AAC1C,IAAA,MAAM,EAAE,GAAA,EAAK,KAAA,EAAM,GAAI,KAAA;AACvB,IAAA,MAAM,MAAA,GAAS,MAAA,CAAO,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA;AAClC,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,MAAM,OAAA,GAAU,QAAQ,UAAA,CAAW,MAAM,MAAM,OAAA,EAAS,IAAI,EAAC;AAC7D,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,CAACC,8BAAA,CAAqB,GAAA,CAAI,UAAA,EAAY,MAAM,CAAA,EAAG,GAAG,OAAO,CAAC,CAAA;AAAA,IACnF;AAAA,EACF;AACA,EAAA,KAAA,MAAW,KAAA,IAAS,OAAA,CAAQ,MAAA,CAAO,CAAC,EAAE,GAAA,EAAI,KAAM,CAAC,MAAA,CAAO,GAAA,CAAI,GAAA,CAAI,IAAI,CAAC,CAAA,EAAG;AACtE,IAAA,QAAA,CAAS,IAAI,KAAA,CAAM,GAAA,CAAI,MAAM,YAAA,CAAa,GAAA,EAAK,KAAK,CAAC,CAAA;AAAA,EACvD;AACA,EAAA,OAAO,QAAA;AACT;;;"}
+{"version":3,"file":"api-writes.cjs","sources":["../../src/cli/api-writes.ts"],"sourcesContent":["import type { ClaimedFile } from \"../application/ports/file-system.js\";\nimport type { GeneratedTypes } from \"./cli-dependencies.js\";\nimport { ApiFailure } from \"./cli-errors.js\";\nimport {\n  type CliRun,\n  duplicateOutputError,\n  emitOutput,\n  ensureOutputIsNotSchema,\n  type NamedFile,\n  type OutputFile,\n} from \"./cli-output.js\";\n\n/**\n * Writing the generated APIs of a Redocly config. Before the first byte is written, every output\n * is claimed: a missing one is created empty, so the file system gives it its own identity. Two\n * APIs whose files then have one identity fail with `CLI_OUTPUT_DUPLICATE` and write nothing,\n * also when their names looked different (ADR-043, decision 1).\n */\n\n/** An API whose types are generated and not written yet. */\nexport interface GeneratedApi {\n  readonly name: string;\n  readonly outputFile: OutputFile;\n  readonly types: GeneratedTypes;\n}\n\n/** An API whose output is claimed; `claim` is undefined with `--check`, which writes nothing. */\ninterface ClaimedApi {\n  readonly api: GeneratedApi;\n  readonly claim: ClaimedFile | undefined;\n}\n\n/** The failures of the API an API name maps to; an API without failures was written. */\ntype ApiFailures = Map<string, unknown[]>;\n\n/** The failure of a step, as a list: empty when it succeeded. */\nexport function failuresOf(step: () => void): unknown[] {\n  try {\n    step();\n    return [];\n  } catch (failure) {\n    return [failure];\n  }\n}\n\n/** Claim the output of each API; an API whose claim fails gets that failure instead. */\nfunction claimOutputs(run: CliRun, apis: readonly GeneratedApi[], failures: ApiFailures) {\n  const claimed: ClaimedApi[] = [];\n  for (const api of apis) {\n    try {\n      const claim = run.args.isCheck ? undefined : run.deps.files.claimFile(api.outputFile.file);\n      claimed.push({ api, claim });\n    } catch (failure) {\n      failures.set(api.name, [failure]);\n    }\n  }\n  return claimed;\n}\n\n/** The APIs that share their claimed file with another, by API name, with the other names. */\nfunction sharedOutputs(claimed: readonly ClaimedApi[]): Map<string, string[]> {\n  const byIdentity = new Map<string, string[]>();\n  for (const { api, claim } of claimed) {\n    if (claim) {\n      byIdentity.set(claim.identity, [...(byIdentity.get(claim.identity) ?? []), api.name]);\n    }\n  }\n  const shared = new Map<string, string[]>();\n  for (const names of byIdentity.values()) {\n    for (const name of names.length > 1 ? names : []) {\n      shared.set(\n        name,\n        names.filter((other) => other !== name).map((other) => `API ${other}`),\n      );\n    }\n  }\n  return shared;\n}\n\n/** Write one claimed API; a failed write releases the claim, so no empty file is left. */\nfunction writeClaimed(run: CliRun, { api, claim }: ClaimedApi): unknown[] {\n  const failures = failuresOf(() => emitOutput(run, api.outputFile, api.types.contents));\n  return failures.length > 0 && claim\n    ? [...failures, ...failuresOf(() => claim.release())]\n    : failures;\n}\n\n/** The failures with the name of their API, which the CLI prints before each message. */\nfunction namedFailures(failures: ApiFailures): ApiFailures {\n  return new Map(\n    [...failures].map(([name, list]) => [name, list.map((cause) => new ApiFailure(name, cause))]),\n  );\n}\n\n/**\n * Write (or `--check`) every API unless its output is a file the run read or the file of another\n * API. Returns the failures by API name, each an `ApiFailure`. Claims are released in reverse\n * order, so a directory one claim created is empty by the time it is removed.\n */\nexport function writeGeneratedApis(\n  run: CliRun,\n  apis: readonly GeneratedApi[],\n  readFiles: readonly NamedFile[],\n): ApiFailures {\n  const failures: ApiFailures = new Map();\n  const ownOutputs = apis.filter((api) => {\n    const failure = failuresOf(() => ensureOutputIsNotSchema(run, api.outputFile, readFiles));\n    failures.set(api.name, failure);\n    return failure.length === 0;\n  });\n  const claimed = claimOutputs(run, ownOutputs, failures);\n  const shared = sharedOutputs(claimed);\n  for (const entry of [...claimed].reverse()) {\n    const { api, claim } = entry;\n    const others = shared.get(api.name);\n    if (others) {\n      const release = claim ? failuresOf(() => claim.release()) : [];\n      failures.set(api.name, [duplicateOutputError(api.outputFile, others), ...release]);\n    }\n  }\n  for (const entry of claimed.filter(({ api }) => !shared.has(api.name))) {\n    failures.set(entry.api.name, writeClaimed(run, entry));\n  }\n  return namedFailures(failures);\n}\n"],"names":["emitOutput","ApiFailure","ensureOutputIsNotSchema","duplicateOutputError"],"mappings":";;;;;AAoCO,SAAS,WAAW,IAAA,EAA6B;AACtD,EAAA,IAAI;AACF,IAAA,IAAA,EAAK;AACL,IAAA,OAAO,EAAC;AAAA,EACV,SAAS,OAAA,EAAS;AAChB,IAAA,OAAO,CAAC,OAAO,CAAA;AAAA,EACjB;AACF;AAGA,SAAS,YAAA,CAAa,GAAA,EAAa,IAAA,EAA+B,QAAA,EAAuB;AACvF,EAAA,MAAM,UAAwB,EAAC;AAC/B,EAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,IAAA,IAAI;AACF,MAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,IAAA,CAAK,OAAA,GAAU,KAAA,CAAA,GAAY,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,SAAA,CAAU,GAAA,CAAI,UAAA,CAAW,IAAI,CAAA;AACzF,MAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,GAAA,EAAK,KAAA,EAAO,CAAA;AAAA,IAC7B,SAAS,OAAA,EAAS;AAChB,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,CAAC,OAAO,CAAC,CAAA;AAAA,IAClC;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;AAGA,SAAS,cAAc,OAAA,EAAuD;AAC5E,EAAA,MAAM,UAAA,uBAAiB,GAAA,EAAsB;AAC7C,EAAA,KAAA,MAAW,EAAE,GAAA,EAAK,KAAA,EAAM,IAAK,OAAA,EAAS;AACpC,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,UAAA,CAAW,GAAA,CAAI,KAAA,CAAM,QAAA,EAAU,CAAC,GAAI,UAAA,CAAW,GAAA,CAAI,KAAA,CAAM,QAAQ,CAAA,IAAK,EAAC,EAAI,GAAA,CAAI,IAAI,CAAC,CAAA;AAAA,IACtF;AAAA,EACF;AACA,EAAA,MAAM,MAAA,uBAAa,GAAA,EAAsB;AACzC,EAAA,KAAA,MAAW,KAAA,IAAS,UAAA,CAAW,MAAA,EAAO,EAAG;AACvC,IAAA,KAAA,MAAW,QAAQ,KAAA,CAAM,MAAA,GAAS,CAAA,GAAI,KAAA,GAAQ,EAAC,EAAG;AAChD,MAAA,MAAA,CAAO,GAAA;AAAA,QACL,IAAA;AAAA,QACA,KAAA,CAAM,MAAA,CAAO,CAAC,KAAA,KAAU,KAAA,KAAU,IAAI,CAAA,CAAE,GAAA,CAAI,CAAC,KAAA,KAAU,CAAA,IAAA,EAAO,KAAK,CAAA,CAAE;AAAA,OACvE;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;AAGA,SAAS,YAAA,CAAa,GAAA,EAAa,EAAE,GAAA,EAAK,OAAM,EAA0B;AACxE,EAAA,MAAM,QAAA,GAAW,UAAA,CAAW,MAAMA,oBAAA,CAAW,GAAA,EAAK,IAAI,UAAA,EAAY,GAAA,CAAI,KAAA,CAAM,QAAQ,CAAC,CAAA;AACrF,EAAA,OAAO,QAAA,CAAS,MAAA,GAAS,CAAA,IAAK,KAAA,GAC1B,CAAC,GAAG,QAAA,EAAU,GAAG,UAAA,CAAW,MAAM,KAAA,CAAM,OAAA,EAAS,CAAC,CAAA,GAClD,QAAA;AACN;AAGA,SAAS,cAAc,QAAA,EAAoC;AACzD,EAAA,OAAO,IAAI,GAAA;AAAA,IACT,CAAC,GAAG,QAAQ,CAAA,CAAE,IAAI,CAAC,CAAC,IAAA,EAAM,IAAI,CAAA,KAAM,CAAC,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,KAAA,KAAU,IAAIC,qBAAW,IAAA,EAAM,KAAK,CAAC,CAAC,CAAC;AAAA,GAC9F;AACF;AAOO,SAAS,kBAAA,CACd,GAAA,EACA,IAAA,EACA,SAAA,EACa;AACb,EAAA,MAAM,QAAA,uBAA4B,GAAA,EAAI;AACtC,EAAA,MAAM,UAAA,GAAa,IAAA,CAAK,MAAA,CAAO,CAAC,GAAA,KAAQ;AACtC,IAAA,MAAM,OAAA,GAAU,WAAW,MAAMC,iCAAA,CAAwB,KAAK,GAAA,CAAI,UAAA,EAAY,SAAS,CAAC,CAAA;AACxF,IAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,OAAO,CAAA;AAC9B,IAAA,OAAO,QAAQ,MAAA,KAAW,CAAA;AAAA,EAC5B,CAAC,CAAA;AACD,EAAA,MAAM,OAAA,GAAU,YAAA,CAAa,GAAA,EAAK,UAAA,EAAY,QAAQ,CAAA;AACtD,EAAA,MAAM,MAAA,GAAS,cAAc,OAAO,CAAA;AACpC,EAAA,KAAA,MAAW,SAAS,CAAC,GAAG,OAAO,CAAA,CAAE,SAAQ,EAAG;AAC1C,IAAA,MAAM,EAAE,GAAA,EAAK,KAAA,EAAM,GAAI,KAAA;AACvB,IAAA,MAAM,MAAA,GAAS,MAAA,CAAO,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA;AAClC,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,MAAM,OAAA,GAAU,QAAQ,UAAA,CAAW,MAAM,MAAM,OAAA,EAAS,IAAI,EAAC;AAC7D,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,CAACC,8BAAA,CAAqB,GAAA,CAAI,UAAA,EAAY,MAAM,CAAA,EAAG,GAAG,OAAO,CAAC,CAAA;AAAA,IACnF;AAAA,EACF;AACA,EAAA,KAAA,MAAW,KAAA,IAAS,OAAA,CAAQ,MAAA,CAAO,CAAC,EAAE,GAAA,EAAI,KAAM,CAAC,MAAA,CAAO,GAAA,CAAI,GAAA,CAAI,IAAI,CAAC,CAAA,EAAG;AACtE,IAAA,QAAA,CAAS,IAAI,KAAA,CAAM,GAAA,CAAI,MAAM,YAAA,CAAa,GAAA,EAAK,KAAK,CAAC,CAAA;AAAA,EACvD;AACA,EAAA,OAAO,cAAc,QAAQ,CAAA;AAC/B;;;"}

package/dist/cli/api-writes.mjs

@@ -1,3 +1,4 @@
+import { ApiFailure } from './cli-errors.mjs';
 import { duplicateOutputError, ensureOutputIsNotSchema, emitOutput } from './cli-output.mjs';
 
 function failuresOf(step) {
@@ -42,6 +43,11 @@ function writeClaimed(run, { api, claim }) {
   const failures = failuresOf(() => emitOutput(run, api.outputFile, api.types.contents));
   return failures.length > 0 && claim ? [...failures, ...failuresOf(() => claim.release())] : failures;
 }
+function namedFailures(failures) {
+  return new Map(
+    [...failures].map(([name, list]) => [name, list.map((cause) => new ApiFailure(name, cause))])
+  );
+}
 function writeGeneratedApis(run, apis, readFiles) {
   const failures = /* @__PURE__ */ new Map();
   const ownOutputs = apis.filter((api) => {
@@ -62,7 +68,7 @@ function writeGeneratedApis(run, apis, readFiles) {
   for (const entry of claimed.filter(({ api }) => !shared.has(api.name))) {
     failures.set(entry.api.name, writeClaimed(run, entry));
   }
-  return failures;
+  return namedFailures(failures);
 }
 
 export { failuresOf, writeGeneratedApis };

package/dist/cli/api-writes.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"api-writes.mjs","sources":["../../src/cli/api-writes.ts"],"sourcesContent":["import type { ClaimedFile } from \"../application/ports/file-system.js\";\nimport type { GeneratedTypes } from \"./cli-dependencies.js\";\nimport {\n  type CliRun,\n  duplicateOutputError,\n  emitOutput,\n  ensureOutputIsNotSchema,\n  type NamedFile,\n  type OutputFile,\n} from \"./cli-output.js\";\n\n/**\n * Writing the generated APIs of a Redocly config. Before the first byte is written, every output\n * is claimed: a missing one is created empty, so the file system gives it its own identity. Two\n * APIs whose files then have one identity fail with `CLI_OUTPUT_DUPLICATE` and write nothing,\n * also when their names looked different (ADR-043, decision 1).\n */\n\n/** An API whose types are generated and not written yet. */\nexport interface GeneratedApi {\n  readonly name: string;\n  readonly outputFile: OutputFile;\n  readonly types: GeneratedTypes;\n}\n\n/** An API whose output is claimed; `claim` is undefined with `--check`, which writes nothing. */\ninterface ClaimedApi {\n  readonly api: GeneratedApi;\n  readonly claim: ClaimedFile | undefined;\n}\n\n/** The failures of the API an API name maps to; an API without failures was written. */\ntype ApiFailures = Map<string, unknown[]>;\n\n/** The failure of a step, as a list: empty when it succeeded. */\nexport function failuresOf(step: () => void): unknown[] {\n  try {\n    step();\n    return [];\n  } catch (failure) {\n    return [failure];\n  }\n}\n\n/** Claim the output of each API; an API whose claim fails gets that failure instead. */\nfunction claimOutputs(run: CliRun, apis: readonly GeneratedApi[], failures: ApiFailures) {\n  const claimed: ClaimedApi[] = [];\n  for (const api of apis) {\n    try {\n      const claim = run.args.isCheck ? undefined : run.deps.files.claimFile(api.outputFile.file);\n      claimed.push({ api, claim });\n    } catch (failure) {\n      failures.set(api.name, [failure]);\n    }\n  }\n  return claimed;\n}\n\n/** The APIs that share their claimed file with another, by API name, with the other names. */\nfunction sharedOutputs(claimed: readonly ClaimedApi[]): Map<string, string[]> {\n  const byIdentity = new Map<string, string[]>();\n  for (const { api, claim } of claimed) {\n    if (claim) {\n      byIdentity.set(claim.identity, [...(byIdentity.get(claim.identity) ?? []), api.name]);\n    }\n  }\n  const shared = new Map<string, string[]>();\n  for (const names of byIdentity.values()) {\n    for (const name of names.length > 1 ? names : []) {\n      shared.set(\n        name,\n        names.filter((other) => other !== name).map((other) => `API ${other}`),\n      );\n    }\n  }\n  return shared;\n}\n\n/** Write one claimed API; a failed write releases the claim, so no empty file is left. */\nfunction writeClaimed(run: CliRun, { api, claim }: ClaimedApi): unknown[] {\n  const failures = failuresOf(() => emitOutput(run, api.outputFile, api.types.contents));\n  return failures.length > 0 && claim\n    ? [...failures, ...failuresOf(() => claim.release())]\n    : failures;\n}\n\n/**\n * Write (or `--check`) every API unless its output is a file the run read or the file of another\n * API. Returns the failures by API name. Claims are released in reverse order, so a directory\n * one claim created is empty by the time it is removed.\n */\nexport function writeGeneratedApis(\n  run: CliRun,\n  apis: readonly GeneratedApi[],\n  readFiles: readonly NamedFile[],\n): ApiFailures {\n  const failures: ApiFailures = new Map();\n  const ownOutputs = apis.filter((api) => {\n    const failure = failuresOf(() => ensureOutputIsNotSchema(run, api.outputFile, readFiles));\n    failures.set(api.name, failure);\n    return failure.length === 0;\n  });\n  const claimed = claimOutputs(run, ownOutputs, failures);\n  const shared = sharedOutputs(claimed);\n  for (const entry of [...claimed].reverse()) {\n    const { api, claim } = entry;\n    const others = shared.get(api.name);\n    if (others) {\n      const release = claim ? failuresOf(() => claim.release()) : [];\n      failures.set(api.name, [duplicateOutputError(api.outputFile, others), ...release]);\n    }\n  }\n  for (const entry of claimed.filter(({ api }) => !shared.has(api.name))) {\n    failures.set(entry.api.name, writeClaimed(run, entry));\n  }\n  return failures;\n}\n"],"names":[],"mappings":";;AAmCO,SAAS,WAAW,IAAA,EAA6B;AACtD,EAAA,IAAI;AACF,IAAA,IAAA,EAAK;AACL,IAAA,OAAO,EAAC;AAAA,EACV,SAAS,OAAA,EAAS;AAChB,IAAA,OAAO,CAAC,OAAO,CAAA;AAAA,EACjB;AACF;AAGA,SAAS,YAAA,CAAa,GAAA,EAAa,IAAA,EAA+B,QAAA,EAAuB;AACvF,EAAA,MAAM,UAAwB,EAAC;AAC/B,EAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,IAAA,IAAI;AACF,MAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,IAAA,CAAK,OAAA,GAAU,KAAA,CAAA,GAAY,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,SAAA,CAAU,GAAA,CAAI,UAAA,CAAW,IAAI,CAAA;AACzF,MAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,GAAA,EAAK,KAAA,EAAO,CAAA;AAAA,IAC7B,SAAS,OAAA,EAAS;AAChB,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,CAAC,OAAO,CAAC,CAAA;AAAA,IAClC;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;AAGA,SAAS,cAAc,OAAA,EAAuD;AAC5E,EAAA,MAAM,UAAA,uBAAiB,GAAA,EAAsB;AAC7C,EAAA,KAAA,MAAW,EAAE,GAAA,EAAK,KAAA,EAAM,IAAK,OAAA,EAAS;AACpC,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,UAAA,CAAW,GAAA,CAAI,KAAA,CAAM,QAAA,EAAU,CAAC,GAAI,UAAA,CAAW,GAAA,CAAI,KAAA,CAAM,QAAQ,CAAA,IAAK,EAAC,EAAI,GAAA,CAAI,IAAI,CAAC,CAAA;AAAA,IACtF;AAAA,EACF;AACA,EAAA,MAAM,MAAA,uBAAa,GAAA,EAAsB;AACzC,EAAA,KAAA,MAAW,KAAA,IAAS,UAAA,CAAW,MAAA,EAAO,EAAG;AACvC,IAAA,KAAA,MAAW,QAAQ,KAAA,CAAM,MAAA,GAAS,CAAA,GAAI,KAAA,GAAQ,EAAC,EAAG;AAChD,MAAA,MAAA,CAAO,GAAA;AAAA,QACL,IAAA;AAAA,QACA,KAAA,CAAM,MAAA,CAAO,CAAC,KAAA,KAAU,KAAA,KAAU,IAAI,CAAA,CAAE,GAAA,CAAI,CAAC,KAAA,KAAU,CAAA,IAAA,EAAO,KAAK,CAAA,CAAE;AAAA,OACvE;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;AAGA,SAAS,YAAA,CAAa,GAAA,EAAa,EAAE,GAAA,EAAK,OAAM,EAA0B;AACxE,EAAA,MAAM,QAAA,GAAW,UAAA,CAAW,MAAM,UAAA,CAAW,GAAA,EAAK,IAAI,UAAA,EAAY,GAAA,CAAI,KAAA,CAAM,QAAQ,CAAC,CAAA;AACrF,EAAA,OAAO,QAAA,CAAS,MAAA,GAAS,CAAA,IAAK,KAAA,GAC1B,CAAC,GAAG,QAAA,EAAU,GAAG,UAAA,CAAW,MAAM,KAAA,CAAM,OAAA,EAAS,CAAC,CAAA,GAClD,QAAA;AACN;AAOO,SAAS,kBAAA,CACd,GAAA,EACA,IAAA,EACA,SAAA,EACa;AACb,EAAA,MAAM,QAAA,uBAA4B,GAAA,EAAI;AACtC,EAAA,MAAM,UAAA,GAAa,IAAA,CAAK,MAAA,CAAO,CAAC,GAAA,KAAQ;AACtC,IAAA,MAAM,OAAA,GAAU,WAAW,MAAM,uBAAA,CAAwB,KAAK,GAAA,CAAI,UAAA,EAAY,SAAS,CAAC,CAAA;AACxF,IAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,OAAO,CAAA;AAC9B,IAAA,OAAO,QAAQ,MAAA,KAAW,CAAA;AAAA,EAC5B,CAAC,CAAA;AACD,EAAA,MAAM,OAAA,GAAU,YAAA,CAAa,GAAA,EAAK,UAAA,EAAY,QAAQ,CAAA;AACtD,EAAA,MAAM,MAAA,GAAS,cAAc,OAAO,CAAA;AACpC,EAAA,KAAA,MAAW,SAAS,CAAC,GAAG,OAAO,CAAA,CAAE,SAAQ,EAAG;AAC1C,IAAA,MAAM,EAAE,GAAA,EAAK,KAAA,EAAM,GAAI,KAAA;AACvB,IAAA,MAAM,MAAA,GAAS,MAAA,CAAO,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA;AAClC,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,MAAM,OAAA,GAAU,QAAQ,UAAA,CAAW,MAAM,MAAM,OAAA,EAAS,IAAI,EAAC;AAC7D,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,CAAC,oBAAA,CAAqB,GAAA,CAAI,UAAA,EAAY,MAAM,CAAA,EAAG,GAAG,OAAO,CAAC,CAAA;AAAA,IACnF;AAAA,EACF;AACA,EAAA,KAAA,MAAW,KAAA,IAAS,OAAA,CAAQ,MAAA,CAAO,CAAC,EAAE,GAAA,EAAI,KAAM,CAAC,MAAA,CAAO,GAAA,CAAI,GAAA,CAAI,IAAI,CAAC,CAAA,EAAG;AACtE,IAAA,QAAA,CAAS,IAAI,KAAA,CAAM,GAAA,CAAI,MAAM,YAAA,CAAa,GAAA,EAAK,KAAK,CAAC,CAAA;AAAA,EACvD;AACA,EAAA,OAAO,QAAA;AACT;;"}
+{"version":3,"file":"api-writes.mjs","sources":["../../src/cli/api-writes.ts"],"sourcesContent":["import type { ClaimedFile } from \"../application/ports/file-system.js\";\nimport type { GeneratedTypes } from \"./cli-dependencies.js\";\nimport { ApiFailure } from \"./cli-errors.js\";\nimport {\n  type CliRun,\n  duplicateOutputError,\n  emitOutput,\n  ensureOutputIsNotSchema,\n  type NamedFile,\n  type OutputFile,\n} from \"./cli-output.js\";\n\n/**\n * Writing the generated APIs of a Redocly config. Before the first byte is written, every output\n * is claimed: a missing one is created empty, so the file system gives it its own identity. Two\n * APIs whose files then have one identity fail with `CLI_OUTPUT_DUPLICATE` and write nothing,\n * also when their names looked different (ADR-043, decision 1).\n */\n\n/** An API whose types are generated and not written yet. */\nexport interface GeneratedApi {\n  readonly name: string;\n  readonly outputFile: OutputFile;\n  readonly types: GeneratedTypes;\n}\n\n/** An API whose output is claimed; `claim` is undefined with `--check`, which writes nothing. */\ninterface ClaimedApi {\n  readonly api: GeneratedApi;\n  readonly claim: ClaimedFile | undefined;\n}\n\n/** The failures of the API an API name maps to; an API without failures was written. */\ntype ApiFailures = Map<string, unknown[]>;\n\n/** The failure of a step, as a list: empty when it succeeded. */\nexport function failuresOf(step: () => void): unknown[] {\n  try {\n    step();\n    return [];\n  } catch (failure) {\n    return [failure];\n  }\n}\n\n/** Claim the output of each API; an API whose claim fails gets that failure instead. */\nfunction claimOutputs(run: CliRun, apis: readonly GeneratedApi[], failures: ApiFailures) {\n  const claimed: ClaimedApi[] = [];\n  for (const api of apis) {\n    try {\n      const claim = run.args.isCheck ? undefined : run.deps.files.claimFile(api.outputFile.file);\n      claimed.push({ api, claim });\n    } catch (failure) {\n      failures.set(api.name, [failure]);\n    }\n  }\n  return claimed;\n}\n\n/** The APIs that share their claimed file with another, by API name, with the other names. */\nfunction sharedOutputs(claimed: readonly ClaimedApi[]): Map<string, string[]> {\n  const byIdentity = new Map<string, string[]>();\n  for (const { api, claim } of claimed) {\n    if (claim) {\n      byIdentity.set(claim.identity, [...(byIdentity.get(claim.identity) ?? []), api.name]);\n    }\n  }\n  const shared = new Map<string, string[]>();\n  for (const names of byIdentity.values()) {\n    for (const name of names.length > 1 ? names : []) {\n      shared.set(\n        name,\n        names.filter((other) => other !== name).map((other) => `API ${other}`),\n      );\n    }\n  }\n  return shared;\n}\n\n/** Write one claimed API; a failed write releases the claim, so no empty file is left. */\nfunction writeClaimed(run: CliRun, { api, claim }: ClaimedApi): unknown[] {\n  const failures = failuresOf(() => emitOutput(run, api.outputFile, api.types.contents));\n  return failures.length > 0 && claim\n    ? [...failures, ...failuresOf(() => claim.release())]\n    : failures;\n}\n\n/** The failures with the name of their API, which the CLI prints before each message. */\nfunction namedFailures(failures: ApiFailures): ApiFailures {\n  return new Map(\n    [...failures].map(([name, list]) => [name, list.map((cause) => new ApiFailure(name, cause))]),\n  );\n}\n\n/**\n * Write (or `--check`) every API unless its output is a file the run read or the file of another\n * API. Returns the failures by API name, each an `ApiFailure`. Claims are released in reverse\n * order, so a directory one claim created is empty by the time it is removed.\n */\nexport function writeGeneratedApis(\n  run: CliRun,\n  apis: readonly GeneratedApi[],\n  readFiles: readonly NamedFile[],\n): ApiFailures {\n  const failures: ApiFailures = new Map();\n  const ownOutputs = apis.filter((api) => {\n    const failure = failuresOf(() => ensureOutputIsNotSchema(run, api.outputFile, readFiles));\n    failures.set(api.name, failure);\n    return failure.length === 0;\n  });\n  const claimed = claimOutputs(run, ownOutputs, failures);\n  const shared = sharedOutputs(claimed);\n  for (const entry of [...claimed].reverse()) {\n    const { api, claim } = entry;\n    const others = shared.get(api.name);\n    if (others) {\n      const release = claim ? failuresOf(() => claim.release()) : [];\n      failures.set(api.name, [duplicateOutputError(api.outputFile, others), ...release]);\n    }\n  }\n  for (const entry of claimed.filter(({ api }) => !shared.has(api.name))) {\n    failures.set(entry.api.name, writeClaimed(run, entry));\n  }\n  return namedFailures(failures);\n}\n"],"names":[],"mappings":";;;AAoCO,SAAS,WAAW,IAAA,EAA6B;AACtD,EAAA,IAAI;AACF,IAAA,IAAA,EAAK;AACL,IAAA,OAAO,EAAC;AAAA,EACV,SAAS,OAAA,EAAS;AAChB,IAAA,OAAO,CAAC,OAAO,CAAA;AAAA,EACjB;AACF;AAGA,SAAS,YAAA,CAAa,GAAA,EAAa,IAAA,EAA+B,QAAA,EAAuB;AACvF,EAAA,MAAM,UAAwB,EAAC;AAC/B,EAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,IAAA,IAAI;AACF,MAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,IAAA,CAAK,OAAA,GAAU,KAAA,CAAA,GAAY,GAAA,CAAI,IAAA,CAAK,KAAA,CAAM,SAAA,CAAU,GAAA,CAAI,UAAA,CAAW,IAAI,CAAA;AACzF,MAAA,OAAA,CAAQ,IAAA,CAAK,EAAE,GAAA,EAAK,KAAA,EAAO,CAAA;AAAA,IAC7B,SAAS,OAAA,EAAS;AAChB,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,CAAC,OAAO,CAAC,CAAA;AAAA,IAClC;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;AAGA,SAAS,cAAc,OAAA,EAAuD;AAC5E,EAAA,MAAM,UAAA,uBAAiB,GAAA,EAAsB;AAC7C,EAAA,KAAA,MAAW,EAAE,GAAA,EAAK,KAAA,EAAM,IAAK,OAAA,EAAS;AACpC,IAAA,IAAI,KAAA,EAAO;AACT,MAAA,UAAA,CAAW,GAAA,CAAI,KAAA,CAAM,QAAA,EAAU,CAAC,GAAI,UAAA,CAAW,GAAA,CAAI,KAAA,CAAM,QAAQ,CAAA,IAAK,EAAC,EAAI,GAAA,CAAI,IAAI,CAAC,CAAA;AAAA,IACtF;AAAA,EACF;AACA,EAAA,MAAM,MAAA,uBAAa,GAAA,EAAsB;AACzC,EAAA,KAAA,MAAW,KAAA,IAAS,UAAA,CAAW,MAAA,EAAO,EAAG;AACvC,IAAA,KAAA,MAAW,QAAQ,KAAA,CAAM,MAAA,GAAS,CAAA,GAAI,KAAA,GAAQ,EAAC,EAAG;AAChD,MAAA,MAAA,CAAO,GAAA;AAAA,QACL,IAAA;AAAA,QACA,KAAA,CAAM,MAAA,CAAO,CAAC,KAAA,KAAU,KAAA,KAAU,IAAI,CAAA,CAAE,GAAA,CAAI,CAAC,KAAA,KAAU,CAAA,IAAA,EAAO,KAAK,CAAA,CAAE;AAAA,OACvE;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,MAAA;AACT;AAGA,SAAS,YAAA,CAAa,GAAA,EAAa,EAAE,GAAA,EAAK,OAAM,EAA0B;AACxE,EAAA,MAAM,QAAA,GAAW,UAAA,CAAW,MAAM,UAAA,CAAW,GAAA,EAAK,IAAI,UAAA,EAAY,GAAA,CAAI,KAAA,CAAM,QAAQ,CAAC,CAAA;AACrF,EAAA,OAAO,QAAA,CAAS,MAAA,GAAS,CAAA,IAAK,KAAA,GAC1B,CAAC,GAAG,QAAA,EAAU,GAAG,UAAA,CAAW,MAAM,KAAA,CAAM,OAAA,EAAS,CAAC,CAAA,GAClD,QAAA;AACN;AAGA,SAAS,cAAc,QAAA,EAAoC;AACzD,EAAA,OAAO,IAAI,GAAA;AAAA,IACT,CAAC,GAAG,QAAQ,CAAA,CAAE,IAAI,CAAC,CAAC,IAAA,EAAM,IAAI,CAAA,KAAM,CAAC,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,KAAA,KAAU,IAAI,WAAW,IAAA,EAAM,KAAK,CAAC,CAAC,CAAC;AAAA,GAC9F;AACF;AAOO,SAAS,kBAAA,CACd,GAAA,EACA,IAAA,EACA,SAAA,EACa;AACb,EAAA,MAAM,QAAA,uBAA4B,GAAA,EAAI;AACtC,EAAA,MAAM,UAAA,GAAa,IAAA,CAAK,MAAA,CAAO,CAAC,GAAA,KAAQ;AACtC,IAAA,MAAM,OAAA,GAAU,WAAW,MAAM,uBAAA,CAAwB,KAAK,GAAA,CAAI,UAAA,EAAY,SAAS,CAAC,CAAA;AACxF,IAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,OAAO,CAAA;AAC9B,IAAA,OAAO,QAAQ,MAAA,KAAW,CAAA;AAAA,EAC5B,CAAC,CAAA;AACD,EAAA,MAAM,OAAA,GAAU,YAAA,CAAa,GAAA,EAAK,UAAA,EAAY,QAAQ,CAAA;AACtD,EAAA,MAAM,MAAA,GAAS,cAAc,OAAO,CAAA;AACpC,EAAA,KAAA,MAAW,SAAS,CAAC,GAAG,OAAO,CAAA,CAAE,SAAQ,EAAG;AAC1C,IAAA,MAAM,EAAE,GAAA,EAAK,KAAA,EAAM,GAAI,KAAA;AACvB,IAAA,MAAM,MAAA,GAAS,MAAA,CAAO,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA;AAClC,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,MAAM,OAAA,GAAU,QAAQ,UAAA,CAAW,MAAM,MAAM,OAAA,EAAS,IAAI,EAAC;AAC7D,MAAA,QAAA,CAAS,GAAA,CAAI,GAAA,CAAI,IAAA,EAAM,CAAC,oBAAA,CAAqB,GAAA,CAAI,UAAA,EAAY,MAAM,CAAA,EAAG,GAAG,OAAO,CAAC,CAAA;AAAA,IACnF;AAAA,EACF;AACA,EAAA,KAAA,MAAW,KAAA,IAAS,OAAA,CAAQ,MAAA,CAAO,CAAC,EAAE,GAAA,EAAI,KAAM,CAAC,MAAA,CAAO,GAAA,CAAI,GAAA,CAAI,IAAI,CAAC,CAAA,EAAG;AACtE,IAAA,QAAA,CAAS,IAAI,KAAA,CAAM,GAAA,CAAI,MAAM,YAAA,CAAa,GAAA,EAAK,KAAK,CAAC,CAAA;AAAA,EACvD;AACA,EAAA,OAAO,cAAc,QAAQ,CAAA;AAC/B;;"}