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

package/dist/application/transform/schema-comment.cjs

@@ -1,5 +1,6 @@
 'use strict';
 
+const appendAll = require('../../domain/append-all.cjs');
 const outputFixes = require('../../domain/output-fixes.cjs');
 
 const LINE_BREAK_RE = /\r?\n/g;
@@ -46,7 +47,10 @@ function valueTagLines(schema) {
     lines.push(`@${tag} ${formatValue(value)}`);
   }
   if (Array.isArray(schema.examples)) {
-    lines.push(...schema.examples.map((example) => `@example ${formatValue(example)}`));
+    appendAll.appendAll(
+      lines,
+      schema.examples.map((example) => `@example ${formatValue(example)}`)
+    );
   }
   return lines;
 }

package/dist/application/transform/schema-comment.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"schema-comment.cjs","sources":["../../../src/application/transform/schema-comment.ts"],"sourcesContent":["import type { IrComment, IrPropertySignature } from \"../../domain/ir/nodes.js\";\nimport { FIX, type OutputFix } from \"../../domain/output-fixes.js\";\n\n/** Schema fields that produce JSDoc lines (the original `AnnotatedSchemaObject`). */\nexport interface AnnotatedSchema {\n  readonly const?: unknown;\n  readonly default?: unknown;\n  readonly deprecated?: boolean;\n  readonly description?: string;\n  readonly enum?: unknown[];\n  readonly example?: unknown;\n  readonly examples?: unknown;\n  readonly format?: string;\n  readonly nullable?: boolean;\n  readonly summary?: string;\n  readonly title?: string;\n  readonly type?: string | string[];\n}\n\nconst LINE_BREAK_RE = /\\r?\\n/g;\n/** Continuation lines of a multi-line value are indented under the tag. */\nconst CONTINUATION = \"\\n *     \";\nconst COMMENT_END_RE = /\\*\\//g;\n/** Tags written as `@tag value`; an empty string is kept only where it is a meaningful value. */\nconst VALUE_TAGS = [\"description\", \"default\", \"example\"] as const;\nconst TAGS_KEEPING_EMPTY_STRING: ReadonlySet<string> = new Set([\"default\", \"example\"]);\nconst JSON_INDENT = 2;\n/** The member lists whose descriptions `anyof-oneof-descriptions` adds, with their headings. */\nconst MEMBER_LISTS = [\n  [\"anyOf\", \"Any of:\"],\n  [\"oneOf\", \"One of:\"],\n] as const;\n/** The later lines of a member's description are indented under its bullet. */\nconst BULLET_CONTINUATION = \"\\n  \";\n\n/** How a schema's JSDoc is written. */\nexport interface SchemaCommentOptions {\n  /** `anyof-oneof-descriptions`: the descriptions of `anyOf` and `oneOf` members are listed. */\n  readonly hasMemberDescriptions: boolean;\n}\n\n/** The JSDoc the original writes. */\nexport const ORIGINAL_SCHEMA_COMMENT: SchemaCommentOptions = { hasMemberDescriptions: false };\n\n/** How the fixes turned on write a schema's JSDoc. */\nexport function schemaCommentOptionsOf(fixes: ReadonlySet<OutputFix>): SchemaCommentOptions {\n  return { hasMemberDescriptions: fixes.has(FIX.ANYOF_ONEOF_DESCRIPTIONS) };\n}\n\nfunction formatValue(value: unknown): string {\n  const text = typeof value === \"object\" ? JSON.stringify(value, null, JSON_INDENT) : value;\n  return String(text).trim().replace(LINE_BREAK_RE, CONTINUATION);\n}\n\nfunction plainLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  for (const text of [schema.title, schema.summary]) {\n    // The document is not validated against the schema dialect: a property named `summary`\n    // written without `properties:` makes `summary` an object (upstream #2349).\n    if (typeof text === \"string\" && text) {\n      lines.push(text.trim().replace(LINE_BREAK_RE, CONTINUATION));\n    }\n  }\n  if (schema.format) {\n    lines.push(`Format: ${schema.format}`);\n  }\n  if (schema.deprecated) {\n    lines.push(\"@deprecated\");\n  }\n  return lines;\n}\n\nfunction valueTagLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  for (const tag of VALUE_TAGS) {\n    const value = schema[tag];\n    if (value === undefined || (value === \"\" && !TAGS_KEEPING_EMPTY_STRING.has(tag))) {\n      continue;\n    }\n    lines.push(`@${tag} ${formatValue(value)}`);\n  }\n  if (Array.isArray(schema.examples)) {\n    lines.push(...schema.examples.map((example: unknown) => `@example ${formatValue(example)}`));\n  }\n  return lines;\n}\n\nfunction enumTypeName(schema: AnnotatedSchema): string {\n  if (Array.isArray(schema.type)) {\n    return schema.type.join(\"|\");\n  }\n  return typeof schema.type === \"string\" ? schema.type : \"unknown\";\n}\n\nfunction constantAndEnumLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  if (\"const\" in schema) {\n    lines.push(\"@constant\");\n  }\n  if (schema.enum) {\n    lines.push(`@enum {${enumTypeName(schema)}${schema.nullable ? \"|null\" : \"\"}}`);\n  }\n  return lines;\n}\n\n/** The own, non-blank `description` of each member; a member without one is left out. */\nfunction memberDescriptions(members: unknown): string[] {\n  if (!Array.isArray(members)) {\n    return [];\n  }\n  return members.flatMap((member: unknown) => {\n    const description = isSchemaObject(member) ? member.description : undefined;\n    return typeof description === \"string\" && description.trim() !== \"\" ? [description.trim()] : [];\n  });\n}\n\n/** Each member list with a described member, as a heading and one bullet per description. */\nfunction memberDescriptionLists(schema: SchemaRecord): string[] {\n  return MEMBER_LISTS.flatMap(([keyword, heading]) => {\n    const descriptions = memberDescriptions(schema[keyword]);\n    if (descriptions.length === 0) {\n      return [];\n    }\n    const bullets = descriptions.map(\n      (description) => `- ${description.replace(LINE_BREAK_RE, BULLET_CONTINUATION)}`,\n    );\n    return [[heading, ...bullets].join(\"\\n\")];\n  });\n}\n\n/**\n * The schema with the descriptions of its `anyOf` and `oneOf` members after its own description\n * (upstream #2142). A member's description holds only where that member applies, so each one is\n * listed under its keyword rather than merged into one sentence. A `description` that is not a\n * string is kept as it is.\n */\nfunction withMemberDescriptions(schema: SchemaRecord): AnnotatedSchema {\n  const lists = memberDescriptionLists(schema);\n  const own = schema.description;\n  if (lists.length === 0 || (own !== undefined && typeof own !== \"string\")) {\n    // As the original, the keywords are read as they are, without validating them.\n    return schema as AnnotatedSchema;\n  }\n  const ownLines = typeof own === \"string\" && own.trim() !== \"\" ? [own.trim()] : [];\n  return { ...(schema as AnnotatedSchema), description: [...ownLines, ...lists].join(\"\\n\") };\n}\n\n/** A schema object read without knowing its keywords. */\ninterface SchemaRecord {\n  readonly description?: unknown;\n  readonly [keyword: string]: unknown;\n}\n\nfunction isSchemaObject(value: unknown): value is SchemaRecord {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/**\n * The JSDoc comment the original writes for a schema (`addJSDocComment`): title, summary and\n * format, then `@deprecated`, `@description`, `@default`, `@example`, `@constant` and `@enum`\n * tags. One short line stays on the `/**` line; anything else is a block. Returns null when there\n * is nothing to say, or when the value is not a schema object.\n */\nexport function schemaComment(\n  schema: unknown,\n  options: SchemaCommentOptions = ORIGINAL_SCHEMA_COMMENT,\n): IrComment | null {\n  if (!isSchemaObject(schema)) {\n    return null;\n  }\n  const annotated = options.hasMemberDescriptions\n    ? withMemberDescriptions(schema)\n    : (schema as AnnotatedSchema);\n  const lines = [\n    ...plainLines(annotated),\n    ...valueTagLines(annotated),\n    ...constantAndEnumLines(annotated),\n  ];\n  if (lines.length === 0) {\n    return null;\n  }\n  const isSingleLine = lines.length === 1 && !lines.some((line) => line.includes(\"\\n\"));\n  const text = isSingleLine ? `* ${lines.join(\"\\n\")} ` : `*\\n * ${lines.join(\"\\n * \")}\\n `;\n  // A `*/` inside a value would end the comment early.\n  return { kind: \"block\", text: text.replace(COMMENT_END_RE, \"*\\\\/\") };\n}\n\n/** The property with the schema's JSDoc added after the comments it already has. */\nexport function withSchemaComment(\n  property: IrPropertySignature,\n  schema: unknown,\n  options: SchemaCommentOptions = ORIGINAL_SCHEMA_COMMENT,\n): IrPropertySignature {\n  const comment = schemaComment(schema, options);\n  return comment === null ? property : { ...property, comments: [...property.comments, comment] };\n}\n"],"names":["FIX"],"mappings":";;;;AAmBA,MAAM,aAAA,GAAgB,QAAA;AAEtB,MAAM,YAAA,GAAe,WAAA;AACrB,MAAM,cAAA,GAAiB,OAAA;AAEvB,MAAM,UAAA,GAAa,CAAC,aAAA,EAAe,SAAA,EAAW,SAAS,CAAA;AACvD,MAAM,4CAAiD,IAAI,GAAA,CAAI,CAAC,SAAA,EAAW,SAAS,CAAC,CAAA;AACrF,MAAM,WAAA,GAAc,CAAA;AAEpB,MAAM,YAAA,GAAe;AAAA,EACnB,CAAC,SAAS,SAAS,CAAA;AAAA,EACnB,CAAC,SAAS,SAAS;AACrB,CAAA;AAEA,MAAM,mBAAA,GAAsB,MAAA;AASrB,MAAM,uBAAA,GAAgD,EAAE,qBAAA,EAAuB,KAAA;AAG/E,SAAS,uBAAuB,KAAA,EAAqD;AAC1F,EAAA,OAAO,EAAE,qBAAA,EAAuB,KAAA,CAAM,GAAA,CAAIA,eAAA,CAAI,wBAAwB,CAAA,EAAE;AAC1E;AAEA,SAAS,YAAY,KAAA,EAAwB;AAC3C,EAAA,MAAM,IAAA,GAAO,OAAO,KAAA,KAAU,QAAA,GAAW,KAAK,SAAA,CAAU,KAAA,EAAO,IAAA,EAAM,WAAW,CAAA,GAAI,KAAA;AACpF,EAAA,OAAO,OAAO,IAAI,CAAA,CAAE,MAAK,CAAE,OAAA,CAAQ,eAAe,YAAY,CAAA;AAChE;AAEA,SAAS,WAAW,MAAA,EAAmC;AACrD,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,QAAQ,CAAC,MAAA,CAAO,KAAA,EAAO,MAAA,CAAO,OAAO,CAAA,EAAG;AAGjD,IAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,EAAM;AACpC,MAAA,KAAA,CAAM,KAAK,IAAA,CAAK,IAAA,GAAO,OAAA,CAAQ,aAAA,EAAe,YAAY,CAAC,CAAA;AAAA,IAC7D;AAAA,EACF;AACA,EAAA,IAAI,OAAO,MAAA,EAAQ;AACjB,IAAA,KAAA,CAAM,IAAA,CAAK,CAAA,QAAA,EAAW,MAAA,CAAO,MAAM,CAAA,CAAE,CAAA;AAAA,EACvC;AACA,EAAA,IAAI,OAAO,UAAA,EAAY;AACrB,IAAA,KAAA,CAAM,KAAK,aAAa,CAAA;AAAA,EAC1B;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,cAAc,MAAA,EAAmC;AACxD,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,OAAO,UAAA,EAAY;AAC5B,IAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,IAAA,IAAI,KAAA,KAAU,UAAc,KAAA,KAAU,EAAA,IAAM,CAAC,yBAAA,CAA0B,GAAA,CAAI,GAAG,CAAA,EAAI;AAChF,MAAA;AAAA,IACF;AACA,IAAA,KAAA,CAAM,KAAK,CAAA,CAAA,EAAI,GAAG,IAAI,WAAA,CAAY,KAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAC5C;AACA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,QAAQ,CAAA,EAAG;AAClC,IAAA,KAAA,CAAM,IAAA,CAAK,GAAG,MAAA,CAAO,QAAA,CAAS,GAAA,CAAI,CAAC,OAAA,KAAqB,CAAA,SAAA,EAAY,WAAA,CAAY,OAAO,CAAC,CAAA,CAAE,CAAC,CAAA;AAAA,EAC7F;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,aAAa,MAAA,EAAiC;AACrD,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,IAAI,CAAA,EAAG;AAC9B,IAAA,OAAO,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,GAAG,CAAA;AAAA,EAC7B;AACA,EAAA,OAAO,OAAO,MAAA,CAAO,IAAA,KAAS,QAAA,GAAW,OAAO,IAAA,GAAO,SAAA;AACzD;AAEA,SAAS,qBAAqB,MAAA,EAAmC;AAC/D,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,IAAI,WAAW,MAAA,EAAQ;AACrB,IAAA,KAAA,CAAM,KAAK,WAAW,CAAA;AAAA,EACxB;AACA,EAAA,IAAI,OAAO,IAAA,EAAM;AACf,IAAA,KAAA,CAAM,IAAA,CAAK,CAAA,OAAA,EAAU,YAAA,CAAa,MAAM,CAAC,GAAG,MAAA,CAAO,QAAA,GAAW,OAAA,GAAU,EAAE,CAAA,CAAA,CAAG,CAAA;AAAA,EAC/E;AACA,EAAA,OAAO,KAAA;AACT;AAGA,SAAS,mBAAmB,OAAA,EAA4B;AACtD,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC3B,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,OAAA,CAAQ,OAAA,CAAQ,CAAC,MAAA,KAAoB;AAC1C,IAAA,MAAM,WAAA,GAAc,cAAA,CAAe,MAAM,CAAA,GAAI,OAAO,WAAA,GAAc,MAAA;AAClE,IAAA,OAAO,OAAO,WAAA,KAAgB,QAAA,IAAY,WAAA,CAAY,IAAA,EAAK,KAAM,EAAA,GAAK,CAAC,WAAA,CAAY,IAAA,EAAM,CAAA,GAAI,EAAC;AAAA,EAChG,CAAC,CAAA;AACH;AAGA,SAAS,uBAAuB,MAAA,EAAgC;AAC9D,EAAA,OAAO,aAAa,OAAA,CAAQ,CAAC,CAAC,OAAA,EAAS,OAAO,CAAA,KAAM;AAClD,IAAA,MAAM,YAAA,GAAe,kBAAA,CAAmB,MAAA,CAAO,OAAO,CAAC,CAAA;AACvD,IAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,MAAM,UAAU,YAAA,CAAa,GAAA;AAAA,MAC3B,CAAC,WAAA,KAAgB,CAAA,EAAA,EAAK,YAAY,OAAA,CAAQ,aAAA,EAAe,mBAAmB,CAAC,CAAA;AAAA,KAC/E;AACA,IAAA,OAAO,CAAC,CAAC,OAAA,EAAS,GAAG,OAAO,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,EAC1C,CAAC,CAAA;AACH;AAQA,SAAS,uBAAuB,MAAA,EAAuC;AACrE,EAAA,MAAM,KAAA,GAAQ,uBAAuB,MAAM,CAAA;AAC3C,EAAA,MAAM,MAAM,MAAA,CAAO,WAAA;AACnB,EAAA,IAAI,MAAM,MAAA,KAAW,CAAA,IAAM,QAAQ,MAAA,IAAa,OAAO,QAAQ,QAAA,EAAW;AAExE,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,QAAA,GAAW,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,CAAI,IAAA,EAAK,KAAM,EAAA,GAAK,CAAC,GAAA,CAAI,IAAA,EAAM,IAAI,EAAC;AAChF,EAAA,OAAO,EAAE,GAAI,MAAA,EAA4B,WAAA,EAAa,CAAC,GAAG,QAAA,EAAU,GAAG,KAAK,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA,EAAE;AAC3F;AAQA,SAAS,eAAe,KAAA,EAAuC;AAC7D,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAQO,SAAS,aAAA,CACd,MAAA,EACA,OAAA,GAAgC,uBAAA,EACd;AAClB,EAAA,IAAI,CAAC,cAAA,CAAe,MAAM,CAAA,EAAG;AAC3B,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,qBAAA,GACtB,sBAAA,CAAuB,MAAM,CAAA,GAC5B,MAAA;AACL,EAAA,MAAM,KAAA,GAAQ;AAAA,IACZ,GAAG,WAAW,SAAS,CAAA;AAAA,IACvB,GAAG,cAAc,SAAS,CAAA;AAAA,IAC1B,GAAG,qBAAqB,SAAS;AAAA,GACnC;AACA,EAAA,IAAI,KAAA,CAAM,WAAW,CAAA,EAAG;AACtB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,YAAA,GAAe,KAAA,CAAM,MAAA,KAAW,CAAA,IAAK,CAAC,KAAA,CAAM,IAAA,CAAK,CAAC,IAAA,KAAS,IAAA,CAAK,QAAA,CAAS,IAAI,CAAC,CAAA;AACpF,EAAA,MAAM,OAAO,YAAA,GAAe,CAAA,EAAA,EAAK,MAAM,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA,CAAA,GAAM,CAAA;AAAA,GAAA,EAAS,KAAA,CAAM,IAAA,CAAK,OAAO,CAAC;AAAA,CAAA,CAAA;AAEnF,EAAA,OAAO,EAAE,MAAM,OAAA,EAAS,IAAA,EAAM,KAAK,OAAA,CAAQ,cAAA,EAAgB,MAAM,CAAA,EAAE;AACrE;AAGO,SAAS,iBAAA,CACd,QAAA,EACA,MAAA,EACA,OAAA,GAAgC,uBAAA,EACX;AACrB,EAAA,MAAM,OAAA,GAAU,aAAA,CAAc,MAAA,EAAQ,OAAO,CAAA;AAC7C,EAAA,OAAO,OAAA,KAAY,IAAA,GAAO,QAAA,GAAW,EAAE,GAAG,QAAA,EAAU,QAAA,EAAU,CAAC,GAAG,QAAA,CAAS,QAAA,EAAU,OAAO,CAAA,EAAE;AAChG;;;;;"}
+{"version":3,"file":"schema-comment.cjs","sources":["../../../src/application/transform/schema-comment.ts"],"sourcesContent":["import { appendAll } from \"../../domain/append-all.js\";\nimport type { IrComment, IrPropertySignature } from \"../../domain/ir/nodes.js\";\nimport { FIX, type OutputFix } from \"../../domain/output-fixes.js\";\n\n/** Schema fields that produce JSDoc lines (the original `AnnotatedSchemaObject`). */\nexport interface AnnotatedSchema {\n  readonly const?: unknown;\n  readonly default?: unknown;\n  readonly deprecated?: boolean;\n  readonly description?: string;\n  readonly enum?: unknown[];\n  readonly example?: unknown;\n  readonly examples?: unknown;\n  readonly format?: string;\n  readonly nullable?: boolean;\n  readonly summary?: string;\n  readonly title?: string;\n  readonly type?: string | string[];\n}\n\nconst LINE_BREAK_RE = /\\r?\\n/g;\n/** Continuation lines of a multi-line value are indented under the tag. */\nconst CONTINUATION = \"\\n *     \";\nconst COMMENT_END_RE = /\\*\\//g;\n/** Tags written as `@tag value`; an empty string is kept only where it is a meaningful value. */\nconst VALUE_TAGS = [\"description\", \"default\", \"example\"] as const;\nconst TAGS_KEEPING_EMPTY_STRING: ReadonlySet<string> = new Set([\"default\", \"example\"]);\nconst JSON_INDENT = 2;\n/** The member lists whose descriptions `anyof-oneof-descriptions` adds, with their headings. */\nconst MEMBER_LISTS = [\n  [\"anyOf\", \"Any of:\"],\n  [\"oneOf\", \"One of:\"],\n] as const;\n/** The later lines of a member's description are indented under its bullet. */\nconst BULLET_CONTINUATION = \"\\n  \";\n\n/** How a schema's JSDoc is written. */\nexport interface SchemaCommentOptions {\n  /** `anyof-oneof-descriptions`: the descriptions of `anyOf` and `oneOf` members are listed. */\n  readonly hasMemberDescriptions: boolean;\n}\n\n/** The JSDoc the original writes. */\nexport const ORIGINAL_SCHEMA_COMMENT: SchemaCommentOptions = { hasMemberDescriptions: false };\n\n/** How the fixes turned on write a schema's JSDoc. */\nexport function schemaCommentOptionsOf(fixes: ReadonlySet<OutputFix>): SchemaCommentOptions {\n  return { hasMemberDescriptions: fixes.has(FIX.ANYOF_ONEOF_DESCRIPTIONS) };\n}\n\nfunction formatValue(value: unknown): string {\n  const text = typeof value === \"object\" ? JSON.stringify(value, null, JSON_INDENT) : value;\n  return String(text).trim().replace(LINE_BREAK_RE, CONTINUATION);\n}\n\nfunction plainLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  for (const text of [schema.title, schema.summary]) {\n    // The document is not validated against the schema dialect: a property named `summary`\n    // written without `properties:` makes `summary` an object (upstream #2349).\n    if (typeof text === \"string\" && text) {\n      lines.push(text.trim().replace(LINE_BREAK_RE, CONTINUATION));\n    }\n  }\n  if (schema.format) {\n    lines.push(`Format: ${schema.format}`);\n  }\n  if (schema.deprecated) {\n    lines.push(\"@deprecated\");\n  }\n  return lines;\n}\n\nfunction valueTagLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  for (const tag of VALUE_TAGS) {\n    const value = schema[tag];\n    if (value === undefined || (value === \"\" && !TAGS_KEEPING_EMPTY_STRING.has(tag))) {\n      continue;\n    }\n    lines.push(`@${tag} ${formatValue(value)}`);\n  }\n  if (Array.isArray(schema.examples)) {\n    appendAll(\n      lines,\n      schema.examples.map((example: unknown) => `@example ${formatValue(example)}`),\n    );\n  }\n  return lines;\n}\n\nfunction enumTypeName(schema: AnnotatedSchema): string {\n  if (Array.isArray(schema.type)) {\n    return schema.type.join(\"|\");\n  }\n  return typeof schema.type === \"string\" ? schema.type : \"unknown\";\n}\n\nfunction constantAndEnumLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  if (\"const\" in schema) {\n    lines.push(\"@constant\");\n  }\n  if (schema.enum) {\n    lines.push(`@enum {${enumTypeName(schema)}${schema.nullable ? \"|null\" : \"\"}}`);\n  }\n  return lines;\n}\n\n/** The own, non-blank `description` of each member; a member without one is left out. */\nfunction memberDescriptions(members: unknown): string[] {\n  if (!Array.isArray(members)) {\n    return [];\n  }\n  return members.flatMap((member: unknown) => {\n    const description = isSchemaObject(member) ? member.description : undefined;\n    return typeof description === \"string\" && description.trim() !== \"\" ? [description.trim()] : [];\n  });\n}\n\n/** Each member list with a described member, as a heading and one bullet per description. */\nfunction memberDescriptionLists(schema: SchemaRecord): string[] {\n  return MEMBER_LISTS.flatMap(([keyword, heading]) => {\n    const descriptions = memberDescriptions(schema[keyword]);\n    if (descriptions.length === 0) {\n      return [];\n    }\n    const bullets = descriptions.map(\n      (description) => `- ${description.replace(LINE_BREAK_RE, BULLET_CONTINUATION)}`,\n    );\n    return [[heading, ...bullets].join(\"\\n\")];\n  });\n}\n\n/**\n * The schema with the descriptions of its `anyOf` and `oneOf` members after its own description\n * (upstream #2142). A member's description holds only where that member applies, so each one is\n * listed under its keyword rather than merged into one sentence. A `description` that is not a\n * string is kept as it is.\n */\nfunction withMemberDescriptions(schema: SchemaRecord): AnnotatedSchema {\n  const lists = memberDescriptionLists(schema);\n  const own = schema.description;\n  if (lists.length === 0 || (own !== undefined && typeof own !== \"string\")) {\n    // As the original, the keywords are read as they are, without validating them.\n    return schema as AnnotatedSchema;\n  }\n  const ownLines = typeof own === \"string\" && own.trim() !== \"\" ? [own.trim()] : [];\n  return { ...(schema as AnnotatedSchema), description: [...ownLines, ...lists].join(\"\\n\") };\n}\n\n/** A schema object read without knowing its keywords. */\ninterface SchemaRecord {\n  readonly description?: unknown;\n  readonly [keyword: string]: unknown;\n}\n\nfunction isSchemaObject(value: unknown): value is SchemaRecord {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/**\n * The JSDoc comment the original writes for a schema (`addJSDocComment`): title, summary and\n * format, then `@deprecated`, `@description`, `@default`, `@example`, `@constant` and `@enum`\n * tags. One short line stays on the `/**` line; anything else is a block. Returns null when there\n * is nothing to say, or when the value is not a schema object.\n */\nexport function schemaComment(\n  schema: unknown,\n  options: SchemaCommentOptions = ORIGINAL_SCHEMA_COMMENT,\n): IrComment | null {\n  if (!isSchemaObject(schema)) {\n    return null;\n  }\n  const annotated = options.hasMemberDescriptions\n    ? withMemberDescriptions(schema)\n    : (schema as AnnotatedSchema);\n  const lines = [\n    ...plainLines(annotated),\n    ...valueTagLines(annotated),\n    ...constantAndEnumLines(annotated),\n  ];\n  if (lines.length === 0) {\n    return null;\n  }\n  const isSingleLine = lines.length === 1 && !lines.some((line) => line.includes(\"\\n\"));\n  const text = isSingleLine ? `* ${lines.join(\"\\n\")} ` : `*\\n * ${lines.join(\"\\n * \")}\\n `;\n  // A `*/` inside a value would end the comment early.\n  return { kind: \"block\", text: text.replace(COMMENT_END_RE, \"*\\\\/\") };\n}\n\n/** The property with the schema's JSDoc added after the comments it already has. */\nexport function withSchemaComment(\n  property: IrPropertySignature,\n  schema: unknown,\n  options: SchemaCommentOptions = ORIGINAL_SCHEMA_COMMENT,\n): IrPropertySignature {\n  const comment = schemaComment(schema, options);\n  return comment === null ? property : { ...property, comments: [...property.comments, comment] };\n}\n"],"names":["FIX","appendAll"],"mappings":";;;;;AAoBA,MAAM,aAAA,GAAgB,QAAA;AAEtB,MAAM,YAAA,GAAe,WAAA;AACrB,MAAM,cAAA,GAAiB,OAAA;AAEvB,MAAM,UAAA,GAAa,CAAC,aAAA,EAAe,SAAA,EAAW,SAAS,CAAA;AACvD,MAAM,4CAAiD,IAAI,GAAA,CAAI,CAAC,SAAA,EAAW,SAAS,CAAC,CAAA;AACrF,MAAM,WAAA,GAAc,CAAA;AAEpB,MAAM,YAAA,GAAe;AAAA,EACnB,CAAC,SAAS,SAAS,CAAA;AAAA,EACnB,CAAC,SAAS,SAAS;AACrB,CAAA;AAEA,MAAM,mBAAA,GAAsB,MAAA;AASrB,MAAM,uBAAA,GAAgD,EAAE,qBAAA,EAAuB,KAAA;AAG/E,SAAS,uBAAuB,KAAA,EAAqD;AAC1F,EAAA,OAAO,EAAE,qBAAA,EAAuB,KAAA,CAAM,GAAA,CAAIA,eAAA,CAAI,wBAAwB,CAAA,EAAE;AAC1E;AAEA,SAAS,YAAY,KAAA,EAAwB;AAC3C,EAAA,MAAM,IAAA,GAAO,OAAO,KAAA,KAAU,QAAA,GAAW,KAAK,SAAA,CAAU,KAAA,EAAO,IAAA,EAAM,WAAW,CAAA,GAAI,KAAA;AACpF,EAAA,OAAO,OAAO,IAAI,CAAA,CAAE,MAAK,CAAE,OAAA,CAAQ,eAAe,YAAY,CAAA;AAChE;AAEA,SAAS,WAAW,MAAA,EAAmC;AACrD,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,QAAQ,CAAC,MAAA,CAAO,KAAA,EAAO,MAAA,CAAO,OAAO,CAAA,EAAG;AAGjD,IAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,EAAM;AACpC,MAAA,KAAA,CAAM,KAAK,IAAA,CAAK,IAAA,GAAO,OAAA,CAAQ,aAAA,EAAe,YAAY,CAAC,CAAA;AAAA,IAC7D;AAAA,EACF;AACA,EAAA,IAAI,OAAO,MAAA,EAAQ;AACjB,IAAA,KAAA,CAAM,IAAA,CAAK,CAAA,QAAA,EAAW,MAAA,CAAO,MAAM,CAAA,CAAE,CAAA;AAAA,EACvC;AACA,EAAA,IAAI,OAAO,UAAA,EAAY;AACrB,IAAA,KAAA,CAAM,KAAK,aAAa,CAAA;AAAA,EAC1B;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,cAAc,MAAA,EAAmC;AACxD,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,OAAO,UAAA,EAAY;AAC5B,IAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,IAAA,IAAI,KAAA,KAAU,UAAc,KAAA,KAAU,EAAA,IAAM,CAAC,yBAAA,CAA0B,GAAA,CAAI,GAAG,CAAA,EAAI;AAChF,MAAA;AAAA,IACF;AACA,IAAA,KAAA,CAAM,KAAK,CAAA,CAAA,EAAI,GAAG,IAAI,WAAA,CAAY,KAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAC5C;AACA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,QAAQ,CAAA,EAAG;AAClC,IAAAC,mBAAA;AAAA,MACE,KAAA;AAAA,MACA,MAAA,CAAO,SAAS,GAAA,CAAI,CAAC,YAAqB,CAAA,SAAA,EAAY,WAAA,CAAY,OAAO,CAAC,CAAA,CAAE;AAAA,KAC9E;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,aAAa,MAAA,EAAiC;AACrD,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,IAAI,CAAA,EAAG;AAC9B,IAAA,OAAO,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,GAAG,CAAA;AAAA,EAC7B;AACA,EAAA,OAAO,OAAO,MAAA,CAAO,IAAA,KAAS,QAAA,GAAW,OAAO,IAAA,GAAO,SAAA;AACzD;AAEA,SAAS,qBAAqB,MAAA,EAAmC;AAC/D,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,IAAI,WAAW,MAAA,EAAQ;AACrB,IAAA,KAAA,CAAM,KAAK,WAAW,CAAA;AAAA,EACxB;AACA,EAAA,IAAI,OAAO,IAAA,EAAM;AACf,IAAA,KAAA,CAAM,IAAA,CAAK,CAAA,OAAA,EAAU,YAAA,CAAa,MAAM,CAAC,GAAG,MAAA,CAAO,QAAA,GAAW,OAAA,GAAU,EAAE,CAAA,CAAA,CAAG,CAAA;AAAA,EAC/E;AACA,EAAA,OAAO,KAAA;AACT;AAGA,SAAS,mBAAmB,OAAA,EAA4B;AACtD,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC3B,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,OAAA,CAAQ,OAAA,CAAQ,CAAC,MAAA,KAAoB;AAC1C,IAAA,MAAM,WAAA,GAAc,cAAA,CAAe,MAAM,CAAA,GAAI,OAAO,WAAA,GAAc,MAAA;AAClE,IAAA,OAAO,OAAO,WAAA,KAAgB,QAAA,IAAY,WAAA,CAAY,IAAA,EAAK,KAAM,EAAA,GAAK,CAAC,WAAA,CAAY,IAAA,EAAM,CAAA,GAAI,EAAC;AAAA,EAChG,CAAC,CAAA;AACH;AAGA,SAAS,uBAAuB,MAAA,EAAgC;AAC9D,EAAA,OAAO,aAAa,OAAA,CAAQ,CAAC,CAAC,OAAA,EAAS,OAAO,CAAA,KAAM;AAClD,IAAA,MAAM,YAAA,GAAe,kBAAA,CAAmB,MAAA,CAAO,OAAO,CAAC,CAAA;AACvD,IAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,MAAM,UAAU,YAAA,CAAa,GAAA;AAAA,MAC3B,CAAC,WAAA,KAAgB,CAAA,EAAA,EAAK,YAAY,OAAA,CAAQ,aAAA,EAAe,mBAAmB,CAAC,CAAA;AAAA,KAC/E;AACA,IAAA,OAAO,CAAC,CAAC,OAAA,EAAS,GAAG,OAAO,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,EAC1C,CAAC,CAAA;AACH;AAQA,SAAS,uBAAuB,MAAA,EAAuC;AACrE,EAAA,MAAM,KAAA,GAAQ,uBAAuB,MAAM,CAAA;AAC3C,EAAA,MAAM,MAAM,MAAA,CAAO,WAAA;AACnB,EAAA,IAAI,MAAM,MAAA,KAAW,CAAA,IAAM,QAAQ,MAAA,IAAa,OAAO,QAAQ,QAAA,EAAW;AAExE,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,QAAA,GAAW,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,CAAI,IAAA,EAAK,KAAM,EAAA,GAAK,CAAC,GAAA,CAAI,IAAA,EAAM,IAAI,EAAC;AAChF,EAAA,OAAO,EAAE,GAAI,MAAA,EAA4B,WAAA,EAAa,CAAC,GAAG,QAAA,EAAU,GAAG,KAAK,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA,EAAE;AAC3F;AAQA,SAAS,eAAe,KAAA,EAAuC;AAC7D,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAQO,SAAS,aAAA,CACd,MAAA,EACA,OAAA,GAAgC,uBAAA,EACd;AAClB,EAAA,IAAI,CAAC,cAAA,CAAe,MAAM,CAAA,EAAG;AAC3B,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,qBAAA,GACtB,sBAAA,CAAuB,MAAM,CAAA,GAC5B,MAAA;AACL,EAAA,MAAM,KAAA,GAAQ;AAAA,IACZ,GAAG,WAAW,SAAS,CAAA;AAAA,IACvB,GAAG,cAAc,SAAS,CAAA;AAAA,IAC1B,GAAG,qBAAqB,SAAS;AAAA,GACnC;AACA,EAAA,IAAI,KAAA,CAAM,WAAW,CAAA,EAAG;AACtB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,YAAA,GAAe,KAAA,CAAM,MAAA,KAAW,CAAA,IAAK,CAAC,KAAA,CAAM,IAAA,CAAK,CAAC,IAAA,KAAS,IAAA,CAAK,QAAA,CAAS,IAAI,CAAC,CAAA;AACpF,EAAA,MAAM,OAAO,YAAA,GAAe,CAAA,EAAA,EAAK,MAAM,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA,CAAA,GAAM,CAAA;AAAA,GAAA,EAAS,KAAA,CAAM,IAAA,CAAK,OAAO,CAAC;AAAA,CAAA,CAAA;AAEnF,EAAA,OAAO,EAAE,MAAM,OAAA,EAAS,IAAA,EAAM,KAAK,OAAA,CAAQ,cAAA,EAAgB,MAAM,CAAA,EAAE;AACrE;AAGO,SAAS,iBAAA,CACd,QAAA,EACA,MAAA,EACA,OAAA,GAAgC,uBAAA,EACX;AACrB,EAAA,MAAM,OAAA,GAAU,aAAA,CAAc,MAAA,EAAQ,OAAO,CAAA;AAC7C,EAAA,OAAO,OAAA,KAAY,IAAA,GAAO,QAAA,GAAW,EAAE,GAAG,QAAA,EAAU,QAAA,EAAU,CAAC,GAAG,QAAA,CAAS,QAAA,EAAU,OAAO,CAAA,EAAE;AAChG;;;;;"}

package/dist/application/transform/schema-comment.mjs

@@ -1,3 +1,4 @@
+import { appendAll } from '../../domain/append-all.mjs';
 import { FIX } from '../../domain/output-fixes.mjs';
 
 const LINE_BREAK_RE = /\r?\n/g;
@@ -44,7 +45,10 @@ function valueTagLines(schema) {
     lines.push(`@${tag} ${formatValue(value)}`);
   }
   if (Array.isArray(schema.examples)) {
-    lines.push(...schema.examples.map((example) => `@example ${formatValue(example)}`));
+    appendAll(
+      lines,
+      schema.examples.map((example) => `@example ${formatValue(example)}`)
+    );
   }
   return lines;
 }

package/dist/application/transform/schema-comment.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"schema-comment.mjs","sources":["../../../src/application/transform/schema-comment.ts"],"sourcesContent":["import type { IrComment, IrPropertySignature } from \"../../domain/ir/nodes.js\";\nimport { FIX, type OutputFix } from \"../../domain/output-fixes.js\";\n\n/** Schema fields that produce JSDoc lines (the original `AnnotatedSchemaObject`). */\nexport interface AnnotatedSchema {\n  readonly const?: unknown;\n  readonly default?: unknown;\n  readonly deprecated?: boolean;\n  readonly description?: string;\n  readonly enum?: unknown[];\n  readonly example?: unknown;\n  readonly examples?: unknown;\n  readonly format?: string;\n  readonly nullable?: boolean;\n  readonly summary?: string;\n  readonly title?: string;\n  readonly type?: string | string[];\n}\n\nconst LINE_BREAK_RE = /\\r?\\n/g;\n/** Continuation lines of a multi-line value are indented under the tag. */\nconst CONTINUATION = \"\\n *     \";\nconst COMMENT_END_RE = /\\*\\//g;\n/** Tags written as `@tag value`; an empty string is kept only where it is a meaningful value. */\nconst VALUE_TAGS = [\"description\", \"default\", \"example\"] as const;\nconst TAGS_KEEPING_EMPTY_STRING: ReadonlySet<string> = new Set([\"default\", \"example\"]);\nconst JSON_INDENT = 2;\n/** The member lists whose descriptions `anyof-oneof-descriptions` adds, with their headings. */\nconst MEMBER_LISTS = [\n  [\"anyOf\", \"Any of:\"],\n  [\"oneOf\", \"One of:\"],\n] as const;\n/** The later lines of a member's description are indented under its bullet. */\nconst BULLET_CONTINUATION = \"\\n  \";\n\n/** How a schema's JSDoc is written. */\nexport interface SchemaCommentOptions {\n  /** `anyof-oneof-descriptions`: the descriptions of `anyOf` and `oneOf` members are listed. */\n  readonly hasMemberDescriptions: boolean;\n}\n\n/** The JSDoc the original writes. */\nexport const ORIGINAL_SCHEMA_COMMENT: SchemaCommentOptions = { hasMemberDescriptions: false };\n\n/** How the fixes turned on write a schema's JSDoc. */\nexport function schemaCommentOptionsOf(fixes: ReadonlySet<OutputFix>): SchemaCommentOptions {\n  return { hasMemberDescriptions: fixes.has(FIX.ANYOF_ONEOF_DESCRIPTIONS) };\n}\n\nfunction formatValue(value: unknown): string {\n  const text = typeof value === \"object\" ? JSON.stringify(value, null, JSON_INDENT) : value;\n  return String(text).trim().replace(LINE_BREAK_RE, CONTINUATION);\n}\n\nfunction plainLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  for (const text of [schema.title, schema.summary]) {\n    // The document is not validated against the schema dialect: a property named `summary`\n    // written without `properties:` makes `summary` an object (upstream #2349).\n    if (typeof text === \"string\" && text) {\n      lines.push(text.trim().replace(LINE_BREAK_RE, CONTINUATION));\n    }\n  }\n  if (schema.format) {\n    lines.push(`Format: ${schema.format}`);\n  }\n  if (schema.deprecated) {\n    lines.push(\"@deprecated\");\n  }\n  return lines;\n}\n\nfunction valueTagLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  for (const tag of VALUE_TAGS) {\n    const value = schema[tag];\n    if (value === undefined || (value === \"\" && !TAGS_KEEPING_EMPTY_STRING.has(tag))) {\n      continue;\n    }\n    lines.push(`@${tag} ${formatValue(value)}`);\n  }\n  if (Array.isArray(schema.examples)) {\n    lines.push(...schema.examples.map((example: unknown) => `@example ${formatValue(example)}`));\n  }\n  return lines;\n}\n\nfunction enumTypeName(schema: AnnotatedSchema): string {\n  if (Array.isArray(schema.type)) {\n    return schema.type.join(\"|\");\n  }\n  return typeof schema.type === \"string\" ? schema.type : \"unknown\";\n}\n\nfunction constantAndEnumLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  if (\"const\" in schema) {\n    lines.push(\"@constant\");\n  }\n  if (schema.enum) {\n    lines.push(`@enum {${enumTypeName(schema)}${schema.nullable ? \"|null\" : \"\"}}`);\n  }\n  return lines;\n}\n\n/** The own, non-blank `description` of each member; a member without one is left out. */\nfunction memberDescriptions(members: unknown): string[] {\n  if (!Array.isArray(members)) {\n    return [];\n  }\n  return members.flatMap((member: unknown) => {\n    const description = isSchemaObject(member) ? member.description : undefined;\n    return typeof description === \"string\" && description.trim() !== \"\" ? [description.trim()] : [];\n  });\n}\n\n/** Each member list with a described member, as a heading and one bullet per description. */\nfunction memberDescriptionLists(schema: SchemaRecord): string[] {\n  return MEMBER_LISTS.flatMap(([keyword, heading]) => {\n    const descriptions = memberDescriptions(schema[keyword]);\n    if (descriptions.length === 0) {\n      return [];\n    }\n    const bullets = descriptions.map(\n      (description) => `- ${description.replace(LINE_BREAK_RE, BULLET_CONTINUATION)}`,\n    );\n    return [[heading, ...bullets].join(\"\\n\")];\n  });\n}\n\n/**\n * The schema with the descriptions of its `anyOf` and `oneOf` members after its own description\n * (upstream #2142). A member's description holds only where that member applies, so each one is\n * listed under its keyword rather than merged into one sentence. A `description` that is not a\n * string is kept as it is.\n */\nfunction withMemberDescriptions(schema: SchemaRecord): AnnotatedSchema {\n  const lists = memberDescriptionLists(schema);\n  const own = schema.description;\n  if (lists.length === 0 || (own !== undefined && typeof own !== \"string\")) {\n    // As the original, the keywords are read as they are, without validating them.\n    return schema as AnnotatedSchema;\n  }\n  const ownLines = typeof own === \"string\" && own.trim() !== \"\" ? [own.trim()] : [];\n  return { ...(schema as AnnotatedSchema), description: [...ownLines, ...lists].join(\"\\n\") };\n}\n\n/** A schema object read without knowing its keywords. */\ninterface SchemaRecord {\n  readonly description?: unknown;\n  readonly [keyword: string]: unknown;\n}\n\nfunction isSchemaObject(value: unknown): value is SchemaRecord {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/**\n * The JSDoc comment the original writes for a schema (`addJSDocComment`): title, summary and\n * format, then `@deprecated`, `@description`, `@default`, `@example`, `@constant` and `@enum`\n * tags. One short line stays on the `/**` line; anything else is a block. Returns null when there\n * is nothing to say, or when the value is not a schema object.\n */\nexport function schemaComment(\n  schema: unknown,\n  options: SchemaCommentOptions = ORIGINAL_SCHEMA_COMMENT,\n): IrComment | null {\n  if (!isSchemaObject(schema)) {\n    return null;\n  }\n  const annotated = options.hasMemberDescriptions\n    ? withMemberDescriptions(schema)\n    : (schema as AnnotatedSchema);\n  const lines = [\n    ...plainLines(annotated),\n    ...valueTagLines(annotated),\n    ...constantAndEnumLines(annotated),\n  ];\n  if (lines.length === 0) {\n    return null;\n  }\n  const isSingleLine = lines.length === 1 && !lines.some((line) => line.includes(\"\\n\"));\n  const text = isSingleLine ? `* ${lines.join(\"\\n\")} ` : `*\\n * ${lines.join(\"\\n * \")}\\n `;\n  // A `*/` inside a value would end the comment early.\n  return { kind: \"block\", text: text.replace(COMMENT_END_RE, \"*\\\\/\") };\n}\n\n/** The property with the schema's JSDoc added after the comments it already has. */\nexport function withSchemaComment(\n  property: IrPropertySignature,\n  schema: unknown,\n  options: SchemaCommentOptions = ORIGINAL_SCHEMA_COMMENT,\n): IrPropertySignature {\n  const comment = schemaComment(schema, options);\n  return comment === null ? property : { ...property, comments: [...property.comments, comment] };\n}\n"],"names":[],"mappings":";;AAmBA,MAAM,aAAA,GAAgB,QAAA;AAEtB,MAAM,YAAA,GAAe,WAAA;AACrB,MAAM,cAAA,GAAiB,OAAA;AAEvB,MAAM,UAAA,GAAa,CAAC,aAAA,EAAe,SAAA,EAAW,SAAS,CAAA;AACvD,MAAM,4CAAiD,IAAI,GAAA,CAAI,CAAC,SAAA,EAAW,SAAS,CAAC,CAAA;AACrF,MAAM,WAAA,GAAc,CAAA;AAEpB,MAAM,YAAA,GAAe;AAAA,EACnB,CAAC,SAAS,SAAS,CAAA;AAAA,EACnB,CAAC,SAAS,SAAS;AACrB,CAAA;AAEA,MAAM,mBAAA,GAAsB,MAAA;AASrB,MAAM,uBAAA,GAAgD,EAAE,qBAAA,EAAuB,KAAA;AAG/E,SAAS,uBAAuB,KAAA,EAAqD;AAC1F,EAAA,OAAO,EAAE,qBAAA,EAAuB,KAAA,CAAM,GAAA,CAAI,GAAA,CAAI,wBAAwB,CAAA,EAAE;AAC1E;AAEA,SAAS,YAAY,KAAA,EAAwB;AAC3C,EAAA,MAAM,IAAA,GAAO,OAAO,KAAA,KAAU,QAAA,GAAW,KAAK,SAAA,CAAU,KAAA,EAAO,IAAA,EAAM,WAAW,CAAA,GAAI,KAAA;AACpF,EAAA,OAAO,OAAO,IAAI,CAAA,CAAE,MAAK,CAAE,OAAA,CAAQ,eAAe,YAAY,CAAA;AAChE;AAEA,SAAS,WAAW,MAAA,EAAmC;AACrD,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,QAAQ,CAAC,MAAA,CAAO,KAAA,EAAO,MAAA,CAAO,OAAO,CAAA,EAAG;AAGjD,IAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,EAAM;AACpC,MAAA,KAAA,CAAM,KAAK,IAAA,CAAK,IAAA,GAAO,OAAA,CAAQ,aAAA,EAAe,YAAY,CAAC,CAAA;AAAA,IAC7D;AAAA,EACF;AACA,EAAA,IAAI,OAAO,MAAA,EAAQ;AACjB,IAAA,KAAA,CAAM,IAAA,CAAK,CAAA,QAAA,EAAW,MAAA,CAAO,MAAM,CAAA,CAAE,CAAA;AAAA,EACvC;AACA,EAAA,IAAI,OAAO,UAAA,EAAY;AACrB,IAAA,KAAA,CAAM,KAAK,aAAa,CAAA;AAAA,EAC1B;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,cAAc,MAAA,EAAmC;AACxD,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,OAAO,UAAA,EAAY;AAC5B,IAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,IAAA,IAAI,KAAA,KAAU,UAAc,KAAA,KAAU,EAAA,IAAM,CAAC,yBAAA,CAA0B,GAAA,CAAI,GAAG,CAAA,EAAI;AAChF,MAAA;AAAA,IACF;AACA,IAAA,KAAA,CAAM,KAAK,CAAA,CAAA,EAAI,GAAG,IAAI,WAAA,CAAY,KAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAC5C;AACA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,QAAQ,CAAA,EAAG;AAClC,IAAA,KAAA,CAAM,IAAA,CAAK,GAAG,MAAA,CAAO,QAAA,CAAS,GAAA,CAAI,CAAC,OAAA,KAAqB,CAAA,SAAA,EAAY,WAAA,CAAY,OAAO,CAAC,CAAA,CAAE,CAAC,CAAA;AAAA,EAC7F;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,aAAa,MAAA,EAAiC;AACrD,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,IAAI,CAAA,EAAG;AAC9B,IAAA,OAAO,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,GAAG,CAAA;AAAA,EAC7B;AACA,EAAA,OAAO,OAAO,MAAA,CAAO,IAAA,KAAS,QAAA,GAAW,OAAO,IAAA,GAAO,SAAA;AACzD;AAEA,SAAS,qBAAqB,MAAA,EAAmC;AAC/D,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,IAAI,WAAW,MAAA,EAAQ;AACrB,IAAA,KAAA,CAAM,KAAK,WAAW,CAAA;AAAA,EACxB;AACA,EAAA,IAAI,OAAO,IAAA,EAAM;AACf,IAAA,KAAA,CAAM,IAAA,CAAK,CAAA,OAAA,EAAU,YAAA,CAAa,MAAM,CAAC,GAAG,MAAA,CAAO,QAAA,GAAW,OAAA,GAAU,EAAE,CAAA,CAAA,CAAG,CAAA;AAAA,EAC/E;AACA,EAAA,OAAO,KAAA;AACT;AAGA,SAAS,mBAAmB,OAAA,EAA4B;AACtD,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC3B,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,OAAA,CAAQ,OAAA,CAAQ,CAAC,MAAA,KAAoB;AAC1C,IAAA,MAAM,WAAA,GAAc,cAAA,CAAe,MAAM,CAAA,GAAI,OAAO,WAAA,GAAc,MAAA;AAClE,IAAA,OAAO,OAAO,WAAA,KAAgB,QAAA,IAAY,WAAA,CAAY,IAAA,EAAK,KAAM,EAAA,GAAK,CAAC,WAAA,CAAY,IAAA,EAAM,CAAA,GAAI,EAAC;AAAA,EAChG,CAAC,CAAA;AACH;AAGA,SAAS,uBAAuB,MAAA,EAAgC;AAC9D,EAAA,OAAO,aAAa,OAAA,CAAQ,CAAC,CAAC,OAAA,EAAS,OAAO,CAAA,KAAM;AAClD,IAAA,MAAM,YAAA,GAAe,kBAAA,CAAmB,MAAA,CAAO,OAAO,CAAC,CAAA;AACvD,IAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,MAAM,UAAU,YAAA,CAAa,GAAA;AAAA,MAC3B,CAAC,WAAA,KAAgB,CAAA,EAAA,EAAK,YAAY,OAAA,CAAQ,aAAA,EAAe,mBAAmB,CAAC,CAAA;AAAA,KAC/E;AACA,IAAA,OAAO,CAAC,CAAC,OAAA,EAAS,GAAG,OAAO,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,EAC1C,CAAC,CAAA;AACH;AAQA,SAAS,uBAAuB,MAAA,EAAuC;AACrE,EAAA,MAAM,KAAA,GAAQ,uBAAuB,MAAM,CAAA;AAC3C,EAAA,MAAM,MAAM,MAAA,CAAO,WAAA;AACnB,EAAA,IAAI,MAAM,MAAA,KAAW,CAAA,IAAM,QAAQ,MAAA,IAAa,OAAO,QAAQ,QAAA,EAAW;AAExE,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,QAAA,GAAW,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,CAAI,IAAA,EAAK,KAAM,EAAA,GAAK,CAAC,GAAA,CAAI,IAAA,EAAM,IAAI,EAAC;AAChF,EAAA,OAAO,EAAE,GAAI,MAAA,EAA4B,WAAA,EAAa,CAAC,GAAG,QAAA,EAAU,GAAG,KAAK,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA,EAAE;AAC3F;AAQA,SAAS,eAAe,KAAA,EAAuC;AAC7D,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAQO,SAAS,aAAA,CACd,MAAA,EACA,OAAA,GAAgC,uBAAA,EACd;AAClB,EAAA,IAAI,CAAC,cAAA,CAAe,MAAM,CAAA,EAAG;AAC3B,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,qBAAA,GACtB,sBAAA,CAAuB,MAAM,CAAA,GAC5B,MAAA;AACL,EAAA,MAAM,KAAA,GAAQ;AAAA,IACZ,GAAG,WAAW,SAAS,CAAA;AAAA,IACvB,GAAG,cAAc,SAAS,CAAA;AAAA,IAC1B,GAAG,qBAAqB,SAAS;AAAA,GACnC;AACA,EAAA,IAAI,KAAA,CAAM,WAAW,CAAA,EAAG;AACtB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,YAAA,GAAe,KAAA,CAAM,MAAA,KAAW,CAAA,IAAK,CAAC,KAAA,CAAM,IAAA,CAAK,CAAC,IAAA,KAAS,IAAA,CAAK,QAAA,CAAS,IAAI,CAAC,CAAA;AACpF,EAAA,MAAM,OAAO,YAAA,GAAe,CAAA,EAAA,EAAK,MAAM,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA,CAAA,GAAM,CAAA;AAAA,GAAA,EAAS,KAAA,CAAM,IAAA,CAAK,OAAO,CAAC;AAAA,CAAA,CAAA;AAEnF,EAAA,OAAO,EAAE,MAAM,OAAA,EAAS,IAAA,EAAM,KAAK,OAAA,CAAQ,cAAA,EAAgB,MAAM,CAAA,EAAE;AACrE;AAGO,SAAS,iBAAA,CACd,QAAA,EACA,MAAA,EACA,OAAA,GAAgC,uBAAA,EACX;AACrB,EAAA,MAAM,OAAA,GAAU,aAAA,CAAc,MAAA,EAAQ,OAAO,CAAA;AAC7C,EAAA,OAAO,OAAA,KAAY,IAAA,GAAO,QAAA,GAAW,EAAE,GAAG,QAAA,EAAU,QAAA,EAAU,CAAC,GAAG,QAAA,CAAS,QAAA,EAAU,OAAO,CAAA,EAAE;AAChG;;"}
+{"version":3,"file":"schema-comment.mjs","sources":["../../../src/application/transform/schema-comment.ts"],"sourcesContent":["import { appendAll } from \"../../domain/append-all.js\";\nimport type { IrComment, IrPropertySignature } from \"../../domain/ir/nodes.js\";\nimport { FIX, type OutputFix } from \"../../domain/output-fixes.js\";\n\n/** Schema fields that produce JSDoc lines (the original `AnnotatedSchemaObject`). */\nexport interface AnnotatedSchema {\n  readonly const?: unknown;\n  readonly default?: unknown;\n  readonly deprecated?: boolean;\n  readonly description?: string;\n  readonly enum?: unknown[];\n  readonly example?: unknown;\n  readonly examples?: unknown;\n  readonly format?: string;\n  readonly nullable?: boolean;\n  readonly summary?: string;\n  readonly title?: string;\n  readonly type?: string | string[];\n}\n\nconst LINE_BREAK_RE = /\\r?\\n/g;\n/** Continuation lines of a multi-line value are indented under the tag. */\nconst CONTINUATION = \"\\n *     \";\nconst COMMENT_END_RE = /\\*\\//g;\n/** Tags written as `@tag value`; an empty string is kept only where it is a meaningful value. */\nconst VALUE_TAGS = [\"description\", \"default\", \"example\"] as const;\nconst TAGS_KEEPING_EMPTY_STRING: ReadonlySet<string> = new Set([\"default\", \"example\"]);\nconst JSON_INDENT = 2;\n/** The member lists whose descriptions `anyof-oneof-descriptions` adds, with their headings. */\nconst MEMBER_LISTS = [\n  [\"anyOf\", \"Any of:\"],\n  [\"oneOf\", \"One of:\"],\n] as const;\n/** The later lines of a member's description are indented under its bullet. */\nconst BULLET_CONTINUATION = \"\\n  \";\n\n/** How a schema's JSDoc is written. */\nexport interface SchemaCommentOptions {\n  /** `anyof-oneof-descriptions`: the descriptions of `anyOf` and `oneOf` members are listed. */\n  readonly hasMemberDescriptions: boolean;\n}\n\n/** The JSDoc the original writes. */\nexport const ORIGINAL_SCHEMA_COMMENT: SchemaCommentOptions = { hasMemberDescriptions: false };\n\n/** How the fixes turned on write a schema's JSDoc. */\nexport function schemaCommentOptionsOf(fixes: ReadonlySet<OutputFix>): SchemaCommentOptions {\n  return { hasMemberDescriptions: fixes.has(FIX.ANYOF_ONEOF_DESCRIPTIONS) };\n}\n\nfunction formatValue(value: unknown): string {\n  const text = typeof value === \"object\" ? JSON.stringify(value, null, JSON_INDENT) : value;\n  return String(text).trim().replace(LINE_BREAK_RE, CONTINUATION);\n}\n\nfunction plainLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  for (const text of [schema.title, schema.summary]) {\n    // The document is not validated against the schema dialect: a property named `summary`\n    // written without `properties:` makes `summary` an object (upstream #2349).\n    if (typeof text === \"string\" && text) {\n      lines.push(text.trim().replace(LINE_BREAK_RE, CONTINUATION));\n    }\n  }\n  if (schema.format) {\n    lines.push(`Format: ${schema.format}`);\n  }\n  if (schema.deprecated) {\n    lines.push(\"@deprecated\");\n  }\n  return lines;\n}\n\nfunction valueTagLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  for (const tag of VALUE_TAGS) {\n    const value = schema[tag];\n    if (value === undefined || (value === \"\" && !TAGS_KEEPING_EMPTY_STRING.has(tag))) {\n      continue;\n    }\n    lines.push(`@${tag} ${formatValue(value)}`);\n  }\n  if (Array.isArray(schema.examples)) {\n    appendAll(\n      lines,\n      schema.examples.map((example: unknown) => `@example ${formatValue(example)}`),\n    );\n  }\n  return lines;\n}\n\nfunction enumTypeName(schema: AnnotatedSchema): string {\n  if (Array.isArray(schema.type)) {\n    return schema.type.join(\"|\");\n  }\n  return typeof schema.type === \"string\" ? schema.type : \"unknown\";\n}\n\nfunction constantAndEnumLines(schema: AnnotatedSchema): string[] {\n  const lines: string[] = [];\n  if (\"const\" in schema) {\n    lines.push(\"@constant\");\n  }\n  if (schema.enum) {\n    lines.push(`@enum {${enumTypeName(schema)}${schema.nullable ? \"|null\" : \"\"}}`);\n  }\n  return lines;\n}\n\n/** The own, non-blank `description` of each member; a member without one is left out. */\nfunction memberDescriptions(members: unknown): string[] {\n  if (!Array.isArray(members)) {\n    return [];\n  }\n  return members.flatMap((member: unknown) => {\n    const description = isSchemaObject(member) ? member.description : undefined;\n    return typeof description === \"string\" && description.trim() !== \"\" ? [description.trim()] : [];\n  });\n}\n\n/** Each member list with a described member, as a heading and one bullet per description. */\nfunction memberDescriptionLists(schema: SchemaRecord): string[] {\n  return MEMBER_LISTS.flatMap(([keyword, heading]) => {\n    const descriptions = memberDescriptions(schema[keyword]);\n    if (descriptions.length === 0) {\n      return [];\n    }\n    const bullets = descriptions.map(\n      (description) => `- ${description.replace(LINE_BREAK_RE, BULLET_CONTINUATION)}`,\n    );\n    return [[heading, ...bullets].join(\"\\n\")];\n  });\n}\n\n/**\n * The schema with the descriptions of its `anyOf` and `oneOf` members after its own description\n * (upstream #2142). A member's description holds only where that member applies, so each one is\n * listed under its keyword rather than merged into one sentence. A `description` that is not a\n * string is kept as it is.\n */\nfunction withMemberDescriptions(schema: SchemaRecord): AnnotatedSchema {\n  const lists = memberDescriptionLists(schema);\n  const own = schema.description;\n  if (lists.length === 0 || (own !== undefined && typeof own !== \"string\")) {\n    // As the original, the keywords are read as they are, without validating them.\n    return schema as AnnotatedSchema;\n  }\n  const ownLines = typeof own === \"string\" && own.trim() !== \"\" ? [own.trim()] : [];\n  return { ...(schema as AnnotatedSchema), description: [...ownLines, ...lists].join(\"\\n\") };\n}\n\n/** A schema object read without knowing its keywords. */\ninterface SchemaRecord {\n  readonly description?: unknown;\n  readonly [keyword: string]: unknown;\n}\n\nfunction isSchemaObject(value: unknown): value is SchemaRecord {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/**\n * The JSDoc comment the original writes for a schema (`addJSDocComment`): title, summary and\n * format, then `@deprecated`, `@description`, `@default`, `@example`, `@constant` and `@enum`\n * tags. One short line stays on the `/**` line; anything else is a block. Returns null when there\n * is nothing to say, or when the value is not a schema object.\n */\nexport function schemaComment(\n  schema: unknown,\n  options: SchemaCommentOptions = ORIGINAL_SCHEMA_COMMENT,\n): IrComment | null {\n  if (!isSchemaObject(schema)) {\n    return null;\n  }\n  const annotated = options.hasMemberDescriptions\n    ? withMemberDescriptions(schema)\n    : (schema as AnnotatedSchema);\n  const lines = [\n    ...plainLines(annotated),\n    ...valueTagLines(annotated),\n    ...constantAndEnumLines(annotated),\n  ];\n  if (lines.length === 0) {\n    return null;\n  }\n  const isSingleLine = lines.length === 1 && !lines.some((line) => line.includes(\"\\n\"));\n  const text = isSingleLine ? `* ${lines.join(\"\\n\")} ` : `*\\n * ${lines.join(\"\\n * \")}\\n `;\n  // A `*/` inside a value would end the comment early.\n  return { kind: \"block\", text: text.replace(COMMENT_END_RE, \"*\\\\/\") };\n}\n\n/** The property with the schema's JSDoc added after the comments it already has. */\nexport function withSchemaComment(\n  property: IrPropertySignature,\n  schema: unknown,\n  options: SchemaCommentOptions = ORIGINAL_SCHEMA_COMMENT,\n): IrPropertySignature {\n  const comment = schemaComment(schema, options);\n  return comment === null ? property : { ...property, comments: [...property.comments, comment] };\n}\n"],"names":[],"mappings":";;;AAoBA,MAAM,aAAA,GAAgB,QAAA;AAEtB,MAAM,YAAA,GAAe,WAAA;AACrB,MAAM,cAAA,GAAiB,OAAA;AAEvB,MAAM,UAAA,GAAa,CAAC,aAAA,EAAe,SAAA,EAAW,SAAS,CAAA;AACvD,MAAM,4CAAiD,IAAI,GAAA,CAAI,CAAC,SAAA,EAAW,SAAS,CAAC,CAAA;AACrF,MAAM,WAAA,GAAc,CAAA;AAEpB,MAAM,YAAA,GAAe;AAAA,EACnB,CAAC,SAAS,SAAS,CAAA;AAAA,EACnB,CAAC,SAAS,SAAS;AACrB,CAAA;AAEA,MAAM,mBAAA,GAAsB,MAAA;AASrB,MAAM,uBAAA,GAAgD,EAAE,qBAAA,EAAuB,KAAA;AAG/E,SAAS,uBAAuB,KAAA,EAAqD;AAC1F,EAAA,OAAO,EAAE,qBAAA,EAAuB,KAAA,CAAM,GAAA,CAAI,GAAA,CAAI,wBAAwB,CAAA,EAAE;AAC1E;AAEA,SAAS,YAAY,KAAA,EAAwB;AAC3C,EAAA,MAAM,IAAA,GAAO,OAAO,KAAA,KAAU,QAAA,GAAW,KAAK,SAAA,CAAU,KAAA,EAAO,IAAA,EAAM,WAAW,CAAA,GAAI,KAAA;AACpF,EAAA,OAAO,OAAO,IAAI,CAAA,CAAE,MAAK,CAAE,OAAA,CAAQ,eAAe,YAAY,CAAA;AAChE;AAEA,SAAS,WAAW,MAAA,EAAmC;AACrD,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,QAAQ,CAAC,MAAA,CAAO,KAAA,EAAO,MAAA,CAAO,OAAO,CAAA,EAAG;AAGjD,IAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,EAAM;AACpC,MAAA,KAAA,CAAM,KAAK,IAAA,CAAK,IAAA,GAAO,OAAA,CAAQ,aAAA,EAAe,YAAY,CAAC,CAAA;AAAA,IAC7D;AAAA,EACF;AACA,EAAA,IAAI,OAAO,MAAA,EAAQ;AACjB,IAAA,KAAA,CAAM,IAAA,CAAK,CAAA,QAAA,EAAW,MAAA,CAAO,MAAM,CAAA,CAAE,CAAA;AAAA,EACvC;AACA,EAAA,IAAI,OAAO,UAAA,EAAY;AACrB,IAAA,KAAA,CAAM,KAAK,aAAa,CAAA;AAAA,EAC1B;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,cAAc,MAAA,EAAmC;AACxD,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,KAAA,MAAW,OAAO,UAAA,EAAY;AAC5B,IAAA,MAAM,KAAA,GAAQ,OAAO,GAAG,CAAA;AACxB,IAAA,IAAI,KAAA,KAAU,UAAc,KAAA,KAAU,EAAA,IAAM,CAAC,yBAAA,CAA0B,GAAA,CAAI,GAAG,CAAA,EAAI;AAChF,MAAA;AAAA,IACF;AACA,IAAA,KAAA,CAAM,KAAK,CAAA,CAAA,EAAI,GAAG,IAAI,WAAA,CAAY,KAAK,CAAC,CAAA,CAAE,CAAA;AAAA,EAC5C;AACA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,QAAQ,CAAA,EAAG;AAClC,IAAA,SAAA;AAAA,MACE,KAAA;AAAA,MACA,MAAA,CAAO,SAAS,GAAA,CAAI,CAAC,YAAqB,CAAA,SAAA,EAAY,WAAA,CAAY,OAAO,CAAC,CAAA,CAAE;AAAA,KAC9E;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,aAAa,MAAA,EAAiC;AACrD,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,IAAI,CAAA,EAAG;AAC9B,IAAA,OAAO,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,GAAG,CAAA;AAAA,EAC7B;AACA,EAAA,OAAO,OAAO,MAAA,CAAO,IAAA,KAAS,QAAA,GAAW,OAAO,IAAA,GAAO,SAAA;AACzD;AAEA,SAAS,qBAAqB,MAAA,EAAmC;AAC/D,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,IAAI,WAAW,MAAA,EAAQ;AACrB,IAAA,KAAA,CAAM,KAAK,WAAW,CAAA;AAAA,EACxB;AACA,EAAA,IAAI,OAAO,IAAA,EAAM;AACf,IAAA,KAAA,CAAM,IAAA,CAAK,CAAA,OAAA,EAAU,YAAA,CAAa,MAAM,CAAC,GAAG,MAAA,CAAO,QAAA,GAAW,OAAA,GAAU,EAAE,CAAA,CAAA,CAAG,CAAA;AAAA,EAC/E;AACA,EAAA,OAAO,KAAA;AACT;AAGA,SAAS,mBAAmB,OAAA,EAA4B;AACtD,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC3B,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,OAAA,CAAQ,OAAA,CAAQ,CAAC,MAAA,KAAoB;AAC1C,IAAA,MAAM,WAAA,GAAc,cAAA,CAAe,MAAM,CAAA,GAAI,OAAO,WAAA,GAAc,MAAA;AAClE,IAAA,OAAO,OAAO,WAAA,KAAgB,QAAA,IAAY,WAAA,CAAY,IAAA,EAAK,KAAM,EAAA,GAAK,CAAC,WAAA,CAAY,IAAA,EAAM,CAAA,GAAI,EAAC;AAAA,EAChG,CAAC,CAAA;AACH;AAGA,SAAS,uBAAuB,MAAA,EAAgC;AAC9D,EAAA,OAAO,aAAa,OAAA,CAAQ,CAAC,CAAC,OAAA,EAAS,OAAO,CAAA,KAAM;AAClD,IAAA,MAAM,YAAA,GAAe,kBAAA,CAAmB,MAAA,CAAO,OAAO,CAAC,CAAA;AACvD,IAAA,IAAI,YAAA,CAAa,WAAW,CAAA,EAAG;AAC7B,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,MAAM,UAAU,YAAA,CAAa,GAAA;AAAA,MAC3B,CAAC,WAAA,KAAgB,CAAA,EAAA,EAAK,YAAY,OAAA,CAAQ,aAAA,EAAe,mBAAmB,CAAC,CAAA;AAAA,KAC/E;AACA,IAAA,OAAO,CAAC,CAAC,OAAA,EAAS,GAAG,OAAO,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,EAC1C,CAAC,CAAA;AACH;AAQA,SAAS,uBAAuB,MAAA,EAAuC;AACrE,EAAA,MAAM,KAAA,GAAQ,uBAAuB,MAAM,CAAA;AAC3C,EAAA,MAAM,MAAM,MAAA,CAAO,WAAA;AACnB,EAAA,IAAI,MAAM,MAAA,KAAW,CAAA,IAAM,QAAQ,MAAA,IAAa,OAAO,QAAQ,QAAA,EAAW;AAExE,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,MAAM,QAAA,GAAW,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,CAAI,IAAA,EAAK,KAAM,EAAA,GAAK,CAAC,GAAA,CAAI,IAAA,EAAM,IAAI,EAAC;AAChF,EAAA,OAAO,EAAE,GAAI,MAAA,EAA4B,WAAA,EAAa,CAAC,GAAG,QAAA,EAAU,GAAG,KAAK,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA,EAAE;AAC3F;AAQA,SAAS,eAAe,KAAA,EAAuC;AAC7D,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAQO,SAAS,aAAA,CACd,MAAA,EACA,OAAA,GAAgC,uBAAA,EACd;AAClB,EAAA,IAAI,CAAC,cAAA,CAAe,MAAM,CAAA,EAAG;AAC3B,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,qBAAA,GACtB,sBAAA,CAAuB,MAAM,CAAA,GAC5B,MAAA;AACL,EAAA,MAAM,KAAA,GAAQ;AAAA,IACZ,GAAG,WAAW,SAAS,CAAA;AAAA,IACvB,GAAG,cAAc,SAAS,CAAA;AAAA,IAC1B,GAAG,qBAAqB,SAAS;AAAA,GACnC;AACA,EAAA,IAAI,KAAA,CAAM,WAAW,CAAA,EAAG;AACtB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,YAAA,GAAe,KAAA,CAAM,MAAA,KAAW,CAAA,IAAK,CAAC,KAAA,CAAM,IAAA,CAAK,CAAC,IAAA,KAAS,IAAA,CAAK,QAAA,CAAS,IAAI,CAAC,CAAA;AACpF,EAAA,MAAM,OAAO,YAAA,GAAe,CAAA,EAAA,EAAK,MAAM,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA,CAAA,GAAM,CAAA;AAAA,GAAA,EAAS,KAAA,CAAM,IAAA,CAAK,OAAO,CAAC;AAAA,CAAA,CAAA;AAEnF,EAAA,OAAO,EAAE,MAAM,OAAA,EAAS,IAAA,EAAM,KAAK,OAAA,CAAQ,cAAA,EAAgB,MAAM,CAAA,EAAE;AACrE;AAGO,SAAS,iBAAA,CACd,QAAA,EACA,MAAA,EACA,OAAA,GAAgC,uBAAA,EACX;AACrB,EAAA,MAAM,OAAA,GAAU,aAAA,CAAc,MAAA,EAAQ,OAAO,CAAA;AAC7C,EAAA,OAAO,OAAA,KAAY,IAAA,GAAO,QAAA,GAAW,EAAE,GAAG,QAAA,EAAU,QAAA,EAAU,CAAC,GAAG,QAAA,CAAS,QAAA,EAAU,OAAO,CAAA,EAAE;AAChG;;"}

package/dist/cli/api-settings.cjs

@@ -1,10 +1,12 @@
 '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 OUTPUT_SETTING = "output";
 const FIX_SETTING = "fix";
@@ -31,25 +33,76 @@ function unknownSettingWarnings(apiName, settings) {
     )
   );
 }
+function settingKey(settings, name) {
+  if (name in settings) {
+    return name;
+  }
+  const kebabName = scule.kebabCase(name);
+  return kebabName in settings ? kebabName : void 0;
+}
 function settingValue(settings, name) {
-  return name in settings ? settings[name] : settings[scule.kebabCase(name)];
+  const key = settingKey(settings, name);
+  return key === void 0 ? void 0 : settings[key];
 }
 function hasSetting(settings, name) {
-  return name in settings || scule.kebabCase(name) in settings;
+  return settingKey(settings, name) !== void 0;
 }
-function invalidSetting(apiName, name, expected) {
+function invalidSetting(apiName, settings, name, expected) {
+  const key = settingKey(settings, name) ?? scule.kebabCase(name);
   return cliErrors.cliError(
     "CLI_CONFIG_INVALID",
-    `API ${apiName}: \`${scule.kebabCase(name)}\` in x-openapi-ts must be ${expected}`
+    `API ${apiName}: \`${key}\` in x-openapi-ts must be ${expected}`
   );
 }
+function apiFlags(apiName, settings) {
+  const flags = {};
+  for (const name of cliArguments.GENERATOR_FLAGS) {
+    const value = settingValue(settings, name);
+    if (typeof value === "boolean") {
+      flags[name] = value;
+    } else if (hasSetting(settings, name)) {
+      throw invalidSetting(apiName, settings, name, "true or false");
+    }
+  }
+  return flags;
+}
+function apiOutputOf(apiName, settings) {
+  const output = settings[OUTPUT_SETTING];
+  if (typeof output !== "string") {
+    throw invalidSetting(apiName, settings, OUTPUT_SETTING, "a file path");
+  }
+  return output;
+}
+function apiFixNames(apiName, settings) {
+  if (!hasSetting(settings, FIX_SETTING)) {
+    return void 0;
+  }
+  const entries = [settingValue(settings, FIX_SETTING)].flat();
+  if (entries.some((entry) => typeof entry !== "string")) {
+    throw invalidSetting(apiName, settings, FIX_SETTING, "a list of fix names or a comma list");
+  }
+  try {
+    return fixOption.fixNamesOf(entries);
+  } catch (error) {
+    throw errors.isOpenAPITypesafeError(error) ? withApiName(apiName, error) : 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, LOCAL_REF_ROOT_SETTING, "a directory path");
+    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, "a directory path");
   }
   return { localRefRoot: cliOutput.resolveLocationUrl(value === "" ? "." : value, configRoot) };
 }
@@ -60,7 +113,7 @@ function remoteRefHostsOf(apiName, settings) {
   const value = settingValue(settings, REMOTE_REF_HOSTS_SETTING) ?? [];
   const entries = [value].flat();
   if (entries.some((entry) => typeof entry !== "string")) {
-    throw invalidSetting(apiName, REMOTE_REF_HOSTS_SETTING, "a host list");
+    throw invalidSetting(apiName, settings, REMOTE_REF_HOSTS_SETTING, "a host list");
   }
   return { remoteRefHosts: cliArguments.hostList(entries) ?? [] };
 }
@@ -73,6 +126,9 @@ function apiRefLimitOptions(apiName, settings, configRoot) {
 
 exports.FIX_SETTING = FIX_SETTING;
 exports.OUTPUT_SETTING = OUTPUT_SETTING;
+exports.apiFixNames = apiFixNames;
+exports.apiFlags = apiFlags;
+exports.apiOutputOf = apiOutputOf;
 exports.apiRefLimitOptions = apiRefLimitOptions;
 exports.unknownSettingWarnings = unknownSettingWarnings;
 //# sourceMappingURL=api-settings.cjs.map

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 { WARNING_CODES, warningText } from \"../domain/warnings.js\";\nimport { GENERATOR_FLAGS, hostList } from \"./cli-arguments.js\";\nimport { cliError } from \"./cli-errors.js\";\nimport { resolveLocationUrl } from \"./cli-output.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 value of a setting in camelCase, else in kebab-case; `undefined` when it is absent. */\nfunction settingValue(settings: ApiSettings, name: string): unknown {\n  return name in settings ? settings[name] : settings[kebabCase(name)];\n}\n\nfunction hasSetting(settings: ApiSettings, name: string): boolean {\n  return name in settings || kebabCase(name) in settings;\n}\n\nfunction invalidSetting(apiName: string, name: string, expected: string): Error {\n  return cliError(\n    \"CLI_CONFIG_INVALID\",\n    `API ${apiName}: \\`${kebabCase(name)}\\` in x-openapi-ts must be ${expected}`,\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, 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, 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","resolveLocationUrl","hostList"],"mappings":";;;;;;;;AAgBO,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,YAAA,CAAa,UAAuB,IAAA,EAAuB;AAClE,EAAA,OAAO,IAAA,IAAQ,WAAW,QAAA,CAAS,IAAI,IAAI,QAAA,CAASF,eAAA,CAAU,IAAI,CAAC,CAAA;AACrE;AAEA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAuB;AAChE,EAAA,OAAO,IAAA,IAAQ,QAAA,IAAYA,eAAA,CAAU,IAAI,CAAA,IAAK,QAAA;AAChD;AAEA,SAAS,cAAA,CAAe,OAAA,EAAiB,IAAA,EAAc,QAAA,EAAyB;AAC9E,EAAA,OAAOG,kBAAA;AAAA,IACL,oBAAA;AAAA,IACA,OAAO,OAAO,CAAA,IAAA,EAAOH,gBAAU,IAAI,CAAC,8BAA8B,QAAQ,CAAA;AAAA,GAC5E;AACF;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,sBAAA,EAAwB,kBAAkB,CAAA;AAAA,EAC1E;AACA,EAAA,OAAO,EAAE,cAAcI,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,wBAAA,EAA0B,aAAa,CAAA;AAAA,EACvE;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 { 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;;;;;;;;"}

package/dist/cli/api-settings.mjs

@@ -1,8 +1,10 @@
 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 { fixNamesOf } from './fix-option.mjs';
 
 const OUTPUT_SETTING = "output";
 const FIX_SETTING = "fix";
@@ -29,25 +31,76 @@ function unknownSettingWarnings(apiName, settings) {
     )
   );
 }
+function settingKey(settings, name) {
+  if (name in settings) {
+    return name;
+  }
+  const kebabName = kebabCase(name);
+  return kebabName in settings ? kebabName : void 0;
+}
 function settingValue(settings, name) {
-  return name in settings ? settings[name] : settings[kebabCase(name)];
+  const key = settingKey(settings, name);
+  return key === void 0 ? void 0 : settings[key];
 }
 function hasSetting(settings, name) {
-  return name in settings || kebabCase(name) in settings;
+  return settingKey(settings, name) !== void 0;
 }
-function invalidSetting(apiName, name, expected) {
+function invalidSetting(apiName, settings, name, expected) {
+  const key = settingKey(settings, name) ?? kebabCase(name);
   return cliError(
     "CLI_CONFIG_INVALID",
-    `API ${apiName}: \`${kebabCase(name)}\` in x-openapi-ts must be ${expected}`
+    `API ${apiName}: \`${key}\` in x-openapi-ts must be ${expected}`
   );
 }
+function apiFlags(apiName, settings) {
+  const flags = {};
+  for (const name of GENERATOR_FLAGS) {
+    const value = settingValue(settings, name);
+    if (typeof value === "boolean") {
+      flags[name] = value;
+    } else if (hasSetting(settings, name)) {
+      throw invalidSetting(apiName, settings, name, "true or false");
+    }
+  }
+  return flags;
+}
+function apiOutputOf(apiName, settings) {
+  const output = settings[OUTPUT_SETTING];
+  if (typeof output !== "string") {
+    throw invalidSetting(apiName, settings, OUTPUT_SETTING, "a file path");
+  }
+  return output;
+}
+function apiFixNames(apiName, settings) {
+  if (!hasSetting(settings, FIX_SETTING)) {
+    return void 0;
+  }
+  const entries = [settingValue(settings, FIX_SETTING)].flat();
+  if (entries.some((entry) => typeof entry !== "string")) {
+    throw invalidSetting(apiName, settings, FIX_SETTING, "a list of fix names or a comma list");
+  }
+  try {
+    return fixNamesOf(entries);
+  } catch (error) {
+    throw isOpenAPITypesafeError(error) ? withApiName(apiName, error) : 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, LOCAL_REF_ROOT_SETTING, "a directory path");
+    throw invalidSetting(apiName, settings, LOCAL_REF_ROOT_SETTING, "a directory path");
   }
   return { localRefRoot: resolveLocationUrl(value === "" ? "." : value, configRoot) };
 }
@@ -58,7 +111,7 @@ function remoteRefHostsOf(apiName, settings) {
   const value = settingValue(settings, REMOTE_REF_HOSTS_SETTING) ?? [];
   const entries = [value].flat();
   if (entries.some((entry) => typeof entry !== "string")) {
-    throw invalidSetting(apiName, REMOTE_REF_HOSTS_SETTING, "a host list");
+    throw invalidSetting(apiName, settings, REMOTE_REF_HOSTS_SETTING, "a host list");
   }
   return { remoteRefHosts: hostList(entries) ?? [] };
 }
@@ -69,5 +122,5 @@ function apiRefLimitOptions(apiName, settings, configRoot) {
   };
 }
 
-export { FIX_SETTING, OUTPUT_SETTING, apiRefLimitOptions, unknownSettingWarnings };
+export { FIX_SETTING, OUTPUT_SETTING, apiFixNames, apiFlags, apiOutputOf, apiRefLimitOptions, unknownSettingWarnings };
 //# sourceMappingURL=api-settings.mjs.map

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 { WARNING_CODES, warningText } from \"../domain/warnings.js\";\nimport { GENERATOR_FLAGS, hostList } from \"./cli-arguments.js\";\nimport { cliError } from \"./cli-errors.js\";\nimport { resolveLocationUrl } from \"./cli-output.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 value of a setting in camelCase, else in kebab-case; `undefined` when it is absent. */\nfunction settingValue(settings: ApiSettings, name: string): unknown {\n  return name in settings ? settings[name] : settings[kebabCase(name)];\n}\n\nfunction hasSetting(settings: ApiSettings, name: string): boolean {\n  return name in settings || kebabCase(name) in settings;\n}\n\nfunction invalidSetting(apiName: string, name: string, expected: string): Error {\n  return cliError(\n    \"CLI_CONFIG_INVALID\",\n    `API ${apiName}: \\`${kebabCase(name)}\\` in x-openapi-ts must be ${expected}`,\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, 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, 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":";;;;;;AAgBO,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,YAAA,CAAa,UAAuB,IAAA,EAAuB;AAClE,EAAA,OAAO,IAAA,IAAQ,WAAW,QAAA,CAAS,IAAI,IAAI,QAAA,CAAS,SAAA,CAAU,IAAI,CAAC,CAAA;AACrE;AAEA,SAAS,UAAA,CAAW,UAAuB,IAAA,EAAuB;AAChE,EAAA,OAAO,IAAA,IAAQ,QAAA,IAAY,SAAA,CAAU,IAAI,CAAA,IAAK,QAAA;AAChD;AAEA,SAAS,cAAA,CAAe,OAAA,EAAiB,IAAA,EAAc,QAAA,EAAyB;AAC9E,EAAA,OAAO,QAAA;AAAA,IACL,oBAAA;AAAA,IACA,OAAO,OAAO,CAAA,IAAA,EAAO,UAAU,IAAI,CAAC,8BAA8B,QAAQ,CAAA;AAAA,GAC5E;AACF;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,sBAAA,EAAwB,kBAAkB,CAAA;AAAA,EAC1E;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,wBAAA,EAA0B,aAAa,CAAA;AAAA,EACvE;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 { 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;;"}

package/dist/cli/api-writes.cjs

@@ -0,0 +1,72 @@
+'use strict';
+
+const cliOutput = require('./cli-output.cjs');
+
+function failuresOf(step) {
+  try {
+    step();
+    return [];
+  } catch (failure) {
+    return [failure];
+  }
+}
+function claimOutputs(run, apis, failures) {
+  const claimed = [];
+  for (const api of apis) {
+    try {
+      const claim = run.args.isCheck ? void 0 : run.deps.files.claimFile(api.outputFile.file);
+      claimed.push({ api, claim });
+    } catch (failure) {
+      failures.set(api.name, [failure]);
+    }
+  }
+  return claimed;
+}
+function sharedOutputs(claimed) {
+  const byIdentity = /* @__PURE__ */ new Map();
+  for (const { api, claim } of claimed) {
+    if (claim) {
+      byIdentity.set(claim.identity, [...byIdentity.get(claim.identity) ?? [], api.name]);
+    }
+  }
+  const shared = /* @__PURE__ */ new Map();
+  for (const names of byIdentity.values()) {
+    for (const name of names.length > 1 ? names : []) {
+      shared.set(
+        name,
+        names.filter((other) => other !== name).map((other) => `API ${other}`)
+      );
+    }
+  }
+  return shared;
+}
+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 writeGeneratedApis(run, apis, readFiles) {
+  const failures = /* @__PURE__ */ new Map();
+  const ownOutputs = apis.filter((api) => {
+    const failure = failuresOf(() => cliOutput.ensureOutputIsNotSchema(run, api.outputFile, readFiles));
+    failures.set(api.name, failure);
+    return failure.length === 0;
+  });
+  const claimed = claimOutputs(run, ownOutputs, failures);
+  const shared = sharedOutputs(claimed);
+  for (const entry of [...claimed].reverse()) {
+    const { api, claim } = entry;
+    const others = shared.get(api.name);
+    if (others) {
+      const release = claim ? failuresOf(() => claim.release()) : [];
+      failures.set(api.name, [cliOutput.duplicateOutputError(api.outputFile, others), ...release]);
+    }
+  }
+  for (const entry of claimed.filter(({ api }) => !shared.has(api.name))) {
+    failures.set(entry.api.name, writeClaimed(run, entry));
+  }
+  return failures;
+}
+
+exports.failuresOf = failuresOf;
+exports.writeGeneratedApis = writeGeneratedApis;
+//# sourceMappingURL=api-writes.cjs.map

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

@@ -0,0 +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;;;"}

package/dist/cli/api-writes.mjs

@@ -0,0 +1,69 @@
+import { duplicateOutputError, ensureOutputIsNotSchema, emitOutput } from './cli-output.mjs';
+
+function failuresOf(step) {
+  try {
+    step();
+    return [];
+  } catch (failure) {
+    return [failure];
+  }
+}
+function claimOutputs(run, apis, failures) {
+  const claimed = [];
+  for (const api of apis) {
+    try {
+      const claim = run.args.isCheck ? void 0 : run.deps.files.claimFile(api.outputFile.file);
+      claimed.push({ api, claim });
+    } catch (failure) {
+      failures.set(api.name, [failure]);
+    }
+  }
+  return claimed;
+}
+function sharedOutputs(claimed) {
+  const byIdentity = /* @__PURE__ */ new Map();
+  for (const { api, claim } of claimed) {
+    if (claim) {
+      byIdentity.set(claim.identity, [...byIdentity.get(claim.identity) ?? [], api.name]);
+    }
+  }
+  const shared = /* @__PURE__ */ new Map();
+  for (const names of byIdentity.values()) {
+    for (const name of names.length > 1 ? names : []) {
+      shared.set(
+        name,
+        names.filter((other) => other !== name).map((other) => `API ${other}`)
+      );
+    }
+  }
+  return shared;
+}
+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 writeGeneratedApis(run, apis, readFiles) {
+  const failures = /* @__PURE__ */ new Map();
+  const ownOutputs = apis.filter((api) => {
+    const failure = failuresOf(() => ensureOutputIsNotSchema(run, api.outputFile, readFiles));
+    failures.set(api.name, failure);
+    return failure.length === 0;
+  });
+  const claimed = claimOutputs(run, ownOutputs, failures);
+  const shared = sharedOutputs(claimed);
+  for (const entry of [...claimed].reverse()) {
+    const { api, claim } = entry;
+    const others = shared.get(api.name);
+    if (others) {
+      const release = claim ? failuresOf(() => claim.release()) : [];
+      failures.set(api.name, [duplicateOutputError(api.outputFile, others), ...release]);
+    }
+  }
+  for (const entry of claimed.filter(({ api }) => !shared.has(api.name))) {
+    failures.set(entry.api.name, writeClaimed(run, entry));
+  }
+  return failures;
+}
+
+export { failuresOf, writeGeneratedApis };
+//# sourceMappingURL=api-writes.mjs.map