openapi-typesafe 1.0.0-rc.0 → 1.0.0-rc.2

package/dist/application/transform/schema/object-type.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"object-type.mjs","sources":["../../../../src/application/transform/schema/object-type.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"../../../domain/errors.js\";\nimport {\n  irObject,\n  irProperty,\n  irReference,\n  irStringIndexSignature,\n} from \"../../../domain/ir/constructors.js\";\nimport type { IrMember, IrPropertySignature, IrType } from \"../../../domain/ir/nodes.js\";\nimport { toPropertyName } from \"../../../domain/ir/property-name.js\";\nimport { createRef } from \"../../../domain/openapi/json-pointer.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { documentEntries } from \"../document-entries.js\";\nimport { refType } from \"../ref-type.js\";\nimport { withSchemaComment } from \"../schema-comment.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { intersectionOf, unionOf } from \"../type-combinators.js\";\nimport { discriminatorProperty } from \"./discriminator-property.js\";\nimport type { SchemaOptions } from \"./schema-context.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/** Path parts where a default value cannot make a property required (inputs may omit it). */\nconst INPUT_PATH_PARTS = [\"parameters\", \"requestBody\", \"requestBodies\"] as const;\n\nexport class InvalidPropertyError extends OpenAPITypesafeError {\n  constructor(path: string | undefined, key: string, value: unknown) {\n    const received = Array.isArray(value) ? \"Array\" : typeof value;\n    super({\n      code: ERROR_CODES.SCHEMA_PROPERTY_INVALID,\n      message:\n        `${path}: invalid property ${key}. ` + `Expected Schema Object or boolean, got ${received}`,\n      details: { path, property: key, received },\n    });\n    this.name = \"InvalidPropertyError\";\n  }\n}\n\n/** `--read-write-markers`: `$Read<T>` / `$Write<T>`, unless the property is both or neither. */\nfunction withReadWriteMarker(type: IrType, flags: AccessFlags, options: SchemaOptions): IrType {\n  if (!options.readWriteMarkers || flags.isReadOnly === flags.isWriteOnly) {\n    return type;\n  }\n  return irReference(flags.isReadOnly ? \"$Read\" : \"$Write\", [type]);\n}\n\ninterface AccessFlags {\n  readonly isReadOnly: boolean;\n  readonly isWriteOnly: boolean;\n}\n\n/** Apply `transformProperty`, then the schema's JSDoc. */\nfunction finishProperty(\n  property: IrPropertySignature,\n  schema: Schema,\n  path: string,\n  request: SchemaRequest,\n): IrPropertySignature {\n  const location = { ...request.location, path };\n  const transformed =\n    request.context.callbacks.transformProperty(property, schema, location) ?? property;\n  // The original adds the schema's comment after any comment the callback set.\n  return withSchemaComment(transformed, schema);\n}\n\n/** What the property loop reads from a property schema, in the original order. */\ninterface PropertyFacts {\n  readonly ref: string | undefined;\n  readonly flags: AccessFlags;\n  readonly hasDefault: boolean;\n}\n\nfunction propertyFacts(value: Schema): PropertyFacts {\n  if (typeof value !== \"object\") {\n    return { ref: undefined, flags: { isReadOnly: false, isWriteOnly: false }, hasDefault: false };\n  }\n  // `in` throws for a null value, as in the original (which also reads `$ref` first).\n  const ref = \"$ref\" in value && value.$ref ? value.$ref : undefined;\n  const flags = {\n    isReadOnly: Boolean(\"readOnly\" in value && value.readOnly),\n    isWriteOnly: Boolean(\"writeOnly\" in value && value.writeOnly),\n  };\n  return { ref, flags, hasDefault: \"default\" in value && value.default !== undefined };\n}\n\nfunction isOptionalProperty(\n  key: string,\n  facts: PropertyFacts,\n  schema: SchemaObject,\n  request: SchemaRequest,\n): boolean {\n  const { options } = request.context;\n  const path = request.location.path;\n  const isDefaultRequired =\n    facts.hasDefault &&\n    options.defaultNonNullable &&\n    !INPUT_PATH_PARTS.some((part) => path?.includes(part));\n  const isRequired =\n    schema.required?.includes(key) ||\n    (schema.required === undefined && options.propertiesRequiredByDefault) ||\n    isDefaultRequired;\n  return !isRequired;\n}\n\nfunction isExcluded(value: Schema, facts: PropertyFacts, request: SchemaRequest): boolean {\n  if (!request.context.options.excludeDeprecated) {\n    return false;\n  }\n  const resolved = facts.ref ? request.context.refs.resolve(facts.ref) : value;\n  return Boolean((resolved as SchemaObject | undefined)?.deprecated);\n}\n\n/** A type, and whether a callback forced the property optional (null: no override). */\ninterface CustomResult {\n  readonly type: IrType;\n  readonly isOptional: true | null;\n}\n\nfunction propertyType(\n  key: string,\n  value: Schema,\n  facts: PropertyFacts,\n  request: SchemaRequest,\n): CustomResult {\n  const path = createRef([request.location.path, key]);\n  const type = facts.ref\n    ? refType(facts.ref)\n    : request.transformNested(value, { ...request.location, path });\n  const custom = request.context.callbacks.transform(value, request.location);\n  return custom === null\n    ? { type, isOptional: null }\n    : { type: custom.type, isOptional: custom.isOptional || null };\n}\n\nfunction propertyMember(\n  key: string,\n  value: Schema,\n  schema: SchemaObject,\n  request: SchemaRequest,\n): IrMember | null {\n  if ((typeof value !== \"object\" && typeof value !== \"boolean\") || Array.isArray(value)) {\n    throw new InvalidPropertyError(request.location.path, key, value);\n  }\n  const facts = propertyFacts(value);\n  if (isExcluded(value, facts, request)) {\n    return null;\n  }\n  const { options } = request.context;\n  const isOptional = isOptionalProperty(key, facts, schema, request);\n  const result = propertyType(key, value, facts, request);\n  const property = irProperty(\n    toPropertyName(key),\n    withReadWriteMarker(result.type, facts.flags, options),\n    {\n      isOptional: result.isOptional ?? isOptional,\n      isReadonly: options.immutable || (!options.readWriteMarkers && facts.flags.isReadOnly),\n    },\n  );\n  return finishProperty(property, value, createRef([request.location.path, key]), request);\n}\n\nfunction propertyMembers(schema: SchemaObject, request: SchemaRequest): IrMember[] {\n  const members: IrMember[] = [];\n  for (const [key, value] of documentEntries(schema.properties ?? {}, request.context.options)) {\n    const member = propertyMember(key, value, schema, request);\n    if (member !== null) {\n      members.push(member);\n    }\n  }\n  return members;\n}\n\n/**\n * `$defs` as a nested `$defs?: { … }` member, in document order (never alphabetized). It is\n * optional because `$defs` is a schema keyword, not data: the original made it required, so a\n * value of the type needed a `$defs` key (research/legacy-bugs.md, item 17, upstream #2664).\n */\nfunction defsMember(\n  defs: Readonly<Record<string, SchemaObject>>,\n  request: SchemaRequest,\n): IrMember {\n  const { options } = request.context;\n  const members = Object.entries(defs).map(([key, value]) => {\n    const path = createRef([request.location.path, \"$defs\", key]);\n    const flags = {\n      isReadOnly: \"readOnly\" in value && !!value.readOnly,\n      isWriteOnly: \"writeOnly\" in value && !!value.writeOnly,\n    };\n    const type = withReadWriteMarker(\n      request.transformNested(value, { ...request.location, path }),\n      flags,\n      options,\n    );\n    const property = irProperty(toPropertyName(key), type, {\n      isReadonly: options.immutable || (!options.readWriteMarkers && flags.isReadOnly),\n    });\n    return finishProperty(property, value, path, request);\n  });\n  return irProperty(toPropertyName(\"$defs\"), irObject(members), { isOptional: true });\n}\n\nfunction hasObjectKeywords(schema: SchemaObject): boolean {\n  const hasProperties = Boolean(schema.properties && Object.keys(schema.properties).length);\n  return (\n    hasProperties ||\n    Boolean(schema.additionalProperties || schema.patternProperties || schema.$defs)\n  );\n}\n\n/** Value types of the `[key: string]` index signature, in the original order. */\nfunction indexValueTypes(schema: SchemaObject, request: SchemaRequest): IrType[] {\n  const { additionalProperties } = schema;\n  const isObject = typeof additionalProperties === \"object\";\n  const hasExplicit = isObject && Object.keys(additionalProperties).length > 0;\n  const hasImplicit =\n    additionalProperties === true || (isObject && Object.keys(additionalProperties).length === 0);\n  const types: IrType[] = [];\n  if (hasExplicit) {\n    types.push(request.transformNested(additionalProperties as Schema, request.location, true));\n  }\n  if (hasImplicit || (!additionalProperties && request.context.options.additionalProperties)) {\n    types.push(UNKNOWN_TYPE);\n  }\n  const patterns = schema.patternProperties;\n  if (typeof patterns === \"object\" && patterns !== null && Object.keys(patterns).length > 0) {\n    for (const [, value] of documentEntries(patterns, request.context.options)) {\n      types.push(request.transformNested(value, request.location));\n    }\n  }\n  return types;\n}\n\n/** The discriminator property that a parent's mapping implies for this schema, if any. */\nfunction discriminatorMembers(schema: SchemaObject, request: SchemaRequest): IrMember[] {\n  if (!schema.allOf && !schema.anyOf) {\n    return [];\n  }\n  const path = request.location.path ?? \"\";\n  const { discriminators, options } = request.context;\n  // A schema does not get the discriminator it defines for its children, nor one added already.\n  const discriminator =\n    !schema.discriminator && !discriminators.isHandled(path) && discriminators.objectAt(path);\n  return discriminator ? [discriminatorProperty(discriminator, path, options.immutable)] : [];\n}\n\n/**\n * Object keywords: discriminator, `properties`, `$defs`, and an index signature for\n * `additionalProperties` / `patternProperties` (or `--additional-properties`). Null when the schema\n * has none of them.\n */\nexport function objectType(schema: SchemaObject, request: SchemaRequest): IrType | null {\n  const members = discriminatorMembers(schema, request);\n  if (!hasObjectKeywords(schema)) {\n    return members.length > 0 ? irObject(members) : null;\n  }\n  members.push(...propertyMembers(schema, request));\n  // As in the original, a null `$defs` throws here (Object.keys) instead of being skipped.\n  if (\n    \"$defs\" in schema &&\n    typeof schema.$defs === \"object\" &&\n    Object.keys(schema.$defs).length > 0\n  ) {\n    members.push(defsMember(schema.$defs, request));\n  }\n  const valueTypes = indexValueTypes(schema, request);\n  if (valueTypes.length === 0) {\n    return members.length > 0 ? irObject(members) : null;\n  }\n  const index = irObject([\n    irStringIndexSignature(\"key\", unionOf(valueTypes), request.context.options.immutable),\n  ]);\n  return intersectionOf([...(members.length > 0 ? [irObject(members)] : []), index]);\n}\n"],"names":[],"mappings":";;;;;;;;;;;AAqBA,MAAM,gBAAA,GAAmB,CAAC,YAAA,EAAc,aAAA,EAAe,eAAe,CAAA;AAE/D,MAAM,6BAA6B,oBAAA,CAAqB;AAAA,EAC7D,WAAA,CAAY,IAAA,EAA0B,GAAA,EAAa,KAAA,EAAgB;AACjE,IAAA,MAAM,WAAW,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,UAAU,OAAO,KAAA;AACzD,IAAA,KAAA,CAAM;AAAA,MACJ,MAAM,WAAA,CAAY,uBAAA;AAAA,MAClB,SACE,CAAA,EAAG,IAAI,CAAA,mBAAA,EAAsB,GAAG,4CAAiD,QAAQ,CAAA,CAAA;AAAA,MAC3F,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA,EAAU,KAAK,QAAA;AAAS,KAC1C,CAAA;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,sBAAA;AAAA,EACd;AACF;AAGA,SAAS,mBAAA,CAAoB,IAAA,EAAc,KAAA,EAAoB,OAAA,EAAgC;AAC7F,EAAA,IAAI,CAAC,OAAA,CAAQ,gBAAA,IAAoB,KAAA,CAAM,UAAA,KAAe,MAAM,WAAA,EAAa;AACvE,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,YAAY,KAAA,CAAM,UAAA,GAAa,UAAU,QAAA,EAAU,CAAC,IAAI,CAAC,CAAA;AAClE;AAQA,SAAS,cAAA,CACP,QAAA,EACA,MAAA,EACA,IAAA,EACA,OAAA,EACqB;AACrB,EAAA,MAAM,QAAA,GAAW,EAAE,GAAG,OAAA,CAAQ,UAAU,IAAA,EAAK;AAC7C,EAAA,MAAM,WAAA,GACJ,QAAQ,OAAA,CAAQ,SAAA,CAAU,kBAAkB,QAAA,EAAU,MAAA,EAAQ,QAAQ,CAAA,IAAK,QAAA;AAE7E,EAAA,OAAO,iBAAA,CAAkB,aAAa,MAAM,CAAA;AAC9C;AASA,SAAS,cAAc,KAAA,EAA8B;AACnD,EAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,IAAA,OAAO,EAAE,GAAA,EAAK,MAAA,EAAW,KAAA,EAAO,EAAE,UAAA,EAAY,KAAA,EAAO,WAAA,EAAa,KAAA,EAAM,EAAG,UAAA,EAAY,KAAA,EAAM;AAAA,EAC/F;AAEA,EAAA,MAAM,MAAM,MAAA,IAAU,KAAA,IAAS,KAAA,CAAM,IAAA,GAAO,MAAM,IAAA,GAAO,MAAA;AACzD,EAAA,MAAM,KAAA,GAAQ;AAAA,IACZ,UAAA,EAAY,OAAA,CAAQ,UAAA,IAAc,KAAA,IAAS,MAAM,QAAQ,CAAA;AAAA,IACzD,WAAA,EAAa,OAAA,CAAQ,WAAA,IAAe,KAAA,IAAS,MAAM,SAAS;AAAA,GAC9D;AACA,EAAA,OAAO,EAAE,KAAK,KAAA,EAAO,UAAA,EAAY,aAAa,KAAA,IAAS,KAAA,CAAM,YAAY,MAAA,EAAU;AACrF;AAEA,SAAS,kBAAA,CACP,GAAA,EACA,KAAA,EACA,MAAA,EACA,OAAA,EACS;AACT,EAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,OAAA,CAAQ,OAAA;AAC5B,EAAA,MAAM,IAAA,GAAO,QAAQ,QAAA,CAAS,IAAA;AAC9B,EAAA,MAAM,iBAAA,GACJ,KAAA,CAAM,UAAA,IACN,OAAA,CAAQ,kBAAA,IACR,CAAC,gBAAA,CAAiB,IAAA,CAAK,CAAC,IAAA,KAAS,IAAA,EAAM,QAAA,CAAS,IAAI,CAAC,CAAA;AACvD,EAAA,MAAM,UAAA,GACJ,MAAA,CAAO,QAAA,EAAU,QAAA,CAAS,GAAG,KAC5B,MAAA,CAAO,QAAA,KAAa,MAAA,IAAa,OAAA,CAAQ,2BAAA,IAC1C,iBAAA;AACF,EAAA,OAAO,CAAC,UAAA;AACV;AAEA,SAAS,UAAA,CAAW,KAAA,EAAe,KAAA,EAAsB,OAAA,EAAiC;AACxF,EAAA,IAAI,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,iBAAA,EAAmB;AAC9C,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,MAAM,QAAA,GAAW,MAAM,GAAA,GAAM,OAAA,CAAQ,QAAQ,IAAA,CAAK,OAAA,CAAQ,KAAA,CAAM,GAAG,CAAA,GAAI,KAAA;AACvE,EAAA,OAAO,OAAA,CAAS,UAAuC,UAAU,CAAA;AACnE;AAQA,SAAS,YAAA,CACP,GAAA,EACA,KAAA,EACA,KAAA,EACA,OAAA,EACc;AACd,EAAA,MAAM,OAAO,SAAA,CAAU,CAAC,QAAQ,QAAA,CAAS,IAAA,EAAM,GAAG,CAAC,CAAA;AACnD,EAAA,MAAM,IAAA,GAAO,KAAA,CAAM,GAAA,GACf,OAAA,CAAQ,MAAM,GAAG,CAAA,GACjB,OAAA,CAAQ,eAAA,CAAgB,OAAO,EAAE,GAAG,OAAA,CAAQ,QAAA,EAAU,MAAM,CAAA;AAChE,EAAA,MAAM,SAAS,OAAA,CAAQ,OAAA,CAAQ,UAAU,SAAA,CAAU,KAAA,EAAO,QAAQ,QAAQ,CAAA;AAC1E,EAAA,OAAO,MAAA,KAAW,IAAA,GACd,EAAE,IAAA,EAAM,YAAY,IAAA,EAAK,GACzB,EAAE,IAAA,EAAM,MAAA,CAAO,IAAA,EAAM,UAAA,EAAY,MAAA,CAAO,cAAc,IAAA,EAAK;AACjE;AAEA,SAAS,cAAA,CACP,GAAA,EACA,KAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,EAAA,IAAK,OAAO,UAAU,QAAA,IAAY,OAAO,UAAU,SAAA,IAAc,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACrF,IAAA,MAAM,IAAI,oBAAA,CAAqB,OAAA,CAAQ,QAAA,CAAS,IAAA,EAAM,KAAK,KAAK,CAAA;AAAA,EAClE;AACA,EAAA,MAAM,KAAA,GAAQ,cAAc,KAAK,CAAA;AACjC,EAAA,IAAI,UAAA,CAAW,KAAA,EAAO,KAAA,EAAO,OAAO,CAAA,EAAG;AACrC,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,OAAA,CAAQ,OAAA;AAC5B,EAAA,MAAM,UAAA,GAAa,kBAAA,CAAmB,GAAA,EAAK,KAAA,EAAO,QAAQ,OAAO,CAAA;AACjE,EAAA,MAAM,MAAA,GAAS,YAAA,CAAa,GAAA,EAAK,KAAA,EAAO,OAAO,OAAO,CAAA;AACtD,EAAA,MAAM,QAAA,GAAW,UAAA;AAAA,IACf,eAAe,GAAG,CAAA;AAAA,IAClB,mBAAA,CAAoB,MAAA,CAAO,IAAA,EAAM,KAAA,CAAM,OAAO,OAAO,CAAA;AAAA,IACrD;AAAA,MACE,UAAA,EAAY,OAAO,UAAA,IAAc,UAAA;AAAA,MACjC,YAAY,OAAA,CAAQ,SAAA,IAAc,CAAC,OAAA,CAAQ,gBAAA,IAAoB,MAAM,KAAA,CAAM;AAAA;AAC7E,GACF;AACA,EAAA,OAAO,cAAA,CAAe,QAAA,EAAU,KAAA,EAAO,SAAA,CAAU,CAAC,OAAA,CAAQ,QAAA,CAAS,IAAA,EAAM,GAAG,CAAC,CAAA,EAAG,OAAO,CAAA;AACzF;AAEA,SAAS,eAAA,CAAgB,QAAsB,OAAA,EAAoC;AACjF,EAAA,MAAM,UAAsB,EAAC;AAC7B,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,CAAA,IAAK,eAAA,CAAgB,MAAA,CAAO,UAAA,IAAc,EAAC,EAAG,OAAA,CAAQ,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC5F,IAAA,MAAM,MAAA,GAAS,cAAA,CAAe,GAAA,EAAK,KAAA,EAAO,QAAQ,OAAO,CAAA;AACzD,IAAA,IAAI,WAAW,IAAA,EAAM;AACnB,MAAA,OAAA,CAAQ,KAAK,MAAM,CAAA;AAAA,IACrB;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;AAOA,SAAS,UAAA,CACP,MACA,OAAA,EACU;AACV,EAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,OAAA,CAAQ,OAAA;AAC5B,EAAA,MAAM,OAAA,GAAU,MAAA,CAAO,OAAA,CAAQ,IAAI,CAAA,CAAE,IAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AACzD,IAAA,MAAM,IAAA,GAAO,UAAU,CAAC,OAAA,CAAQ,SAAS,IAAA,EAAM,OAAA,EAAS,GAAG,CAAC,CAAA;AAC5D,IAAA,MAAM,KAAA,GAAQ;AAAA,MACZ,UAAA,EAAY,UAAA,IAAc,KAAA,IAAS,CAAC,CAAC,KAAA,CAAM,QAAA;AAAA,MAC3C,WAAA,EAAa,WAAA,IAAe,KAAA,IAAS,CAAC,CAAC,KAAA,CAAM;AAAA,KAC/C;AACA,IAAA,MAAM,IAAA,GAAO,mBAAA;AAAA,MACX,OAAA,CAAQ,gBAAgB,KAAA,EAAO,EAAE,GAAG,OAAA,CAAQ,QAAA,EAAU,MAAM,CAAA;AAAA,MAC5D,KAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,QAAA,GAAW,UAAA,CAAW,cAAA,CAAe,GAAG,GAAG,IAAA,EAAM;AAAA,MACrD,YAAY,OAAA,CAAQ,SAAA,IAAc,CAAC,OAAA,CAAQ,oBAAoB,KAAA,CAAM;AAAA,KACtE,CAAA;AACD,IAAA,OAAO,cAAA,CAAe,QAAA,EAAU,KAAA,EAAO,IAAA,EAAM,OAAO,CAAA;AAAA,EACtD,CAAC,CAAA;AACD,EAAA,OAAO,UAAA,CAAW,cAAA,CAAe,OAAO,CAAA,EAAG,QAAA,CAAS,OAAO,CAAA,EAAG,EAAE,UAAA,EAAY,IAAA,EAAM,CAAA;AACpF;AAEA,SAAS,kBAAkB,MAAA,EAA+B;AACxD,EAAA,MAAM,aAAA,GAAgB,QAAQ,MAAA,CAAO,UAAA,IAAc,OAAO,IAAA,CAAK,MAAA,CAAO,UAAU,CAAA,CAAE,MAAM,CAAA;AACxF,EAAA,OACE,iBACA,OAAA,CAAQ,MAAA,CAAO,wBAAwB,MAAA,CAAO,iBAAA,IAAqB,OAAO,KAAK,CAAA;AAEnF;AAGA,SAAS,eAAA,CAAgB,QAAsB,OAAA,EAAkC;AAC/E,EAAA,MAAM,EAAE,sBAAqB,GAAI,MAAA;AACjC,EAAA,MAAM,QAAA,GAAW,OAAO,oBAAA,KAAyB,QAAA;AACjD,EAAA,MAAM,cAAc,QAAA,IAAY,MAAA,CAAO,IAAA,CAAK,oBAAoB,EAAE,MAAA,GAAS,CAAA;AAC3E,EAAA,MAAM,WAAA,GACJ,yBAAyB,IAAA,IAAS,QAAA,IAAY,OAAO,IAAA,CAAK,oBAAoB,EAAE,MAAA,KAAW,CAAA;AAC7F,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,KAAA,CAAM,KAAK,OAAA,CAAQ,eAAA,CAAgB,sBAAgC,OAAA,CAAQ,QAAA,EAAU,IAAI,CAAC,CAAA;AAAA,EAC5F;AACA,EAAA,IAAI,eAAgB,CAAC,oBAAA,IAAwB,OAAA,CAAQ,OAAA,CAAQ,QAAQ,oBAAA,EAAuB;AAC1F,IAAA,KAAA,CAAM,KAAK,YAAY,CAAA;AAAA,EACzB;AACA,EAAA,MAAM,WAAW,MAAA,CAAO,iBAAA;AACxB,EAAA,IAAI,OAAO,QAAA,KAAa,QAAA,IAAY,QAAA,KAAa,IAAA,IAAQ,OAAO,IAAA,CAAK,QAAQ,CAAA,CAAE,MAAA,GAAS,CAAA,EAAG;AACzF,IAAA,KAAA,MAAW,GAAG,KAAK,CAAA,IAAK,gBAAgB,QAAA,EAAU,OAAA,CAAQ,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC1E,MAAA,KAAA,CAAM,KAAK,OAAA,CAAQ,eAAA,CAAgB,KAAA,EAAO,OAAA,CAAQ,QAAQ,CAAC,CAAA;AAAA,IAC7D;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAGA,SAAS,oBAAA,CAAqB,QAAsB,OAAA,EAAoC;AACtF,EAAA,IAAI,CAAC,MAAA,CAAO,KAAA,IAAS,CAAC,OAAO,KAAA,EAAO;AAClC,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,IAAA,GAAO,OAAA,CAAQ,QAAA,CAAS,IAAA,IAAQ,EAAA;AACtC,EAAA,MAAM,EAAE,cAAA,EAAgB,OAAA,EAAQ,GAAI,OAAA,CAAQ,OAAA;AAE5C,EAAA,MAAM,aAAA,GACJ,CAAC,MAAA,CAAO,aAAA,IAAiB,CAAC,cAAA,CAAe,SAAA,CAAU,IAAI,CAAA,IAAK,cAAA,CAAe,QAAA,CAAS,IAAI,CAAA;AAC1F,EAAA,OAAO,aAAA,GAAgB,CAAC,qBAAA,CAAsB,aAAA,EAAe,MAAM,OAAA,CAAQ,SAAS,CAAC,CAAA,GAAI,EAAC;AAC5F;AAOO,SAAS,UAAA,CAAW,QAAsB,OAAA,EAAuC;AACtF,EAAA,MAAM,OAAA,GAAU,oBAAA,CAAqB,MAAA,EAAQ,OAAO,CAAA;AACpD,EAAA,IAAI,CAAC,iBAAA,CAAkB,MAAM,CAAA,EAAG;AAC9B,IAAA,OAAO,OAAA,CAAQ,MAAA,GAAS,CAAA,GAAI,QAAA,CAAS,OAAO,CAAA,GAAI,IAAA;AAAA,EAClD;AACA,EAAA,OAAA,CAAQ,IAAA,CAAK,GAAG,eAAA,CAAgB,MAAA,EAAQ,OAAO,CAAC,CAAA;AAEhD,EAAA,IACE,OAAA,IAAW,MAAA,IACX,OAAO,MAAA,CAAO,KAAA,KAAU,QAAA,IACxB,MAAA,CAAO,IAAA,CAAK,MAAA,CAAO,KAAK,CAAA,CAAE,MAAA,GAAS,CAAA,EACnC;AACA,IAAA,OAAA,CAAQ,IAAA,CAAK,UAAA,CAAW,MAAA,CAAO,KAAA,EAAO,OAAO,CAAC,CAAA;AAAA,EAChD;AACA,EAAA,MAAM,UAAA,GAAa,eAAA,CAAgB,MAAA,EAAQ,OAAO,CAAA;AAClD,EAAA,IAAI,UAAA,CAAW,WAAW,CAAA,EAAG;AAC3B,IAAA,OAAO,OAAA,CAAQ,MAAA,GAAS,CAAA,GAAI,QAAA,CAAS,OAAO,CAAA,GAAI,IAAA;AAAA,EAClD;AACA,EAAA,MAAM,QAAQ,QAAA,CAAS;AAAA,IACrB,sBAAA,CAAuB,OAAO,OAAA,CAAQ,UAAU,GAAG,OAAA,CAAQ,OAAA,CAAQ,QAAQ,SAAS;AAAA,GACrF,CAAA;AACD,EAAA,OAAO,cAAA,CAAe,CAAC,GAAI,OAAA,CAAQ,SAAS,CAAA,GAAI,CAAC,QAAA,CAAS,OAAO,CAAC,CAAA,GAAI,EAAC,EAAI,KAAK,CAAC,CAAA;AACnF;;"}
+{"version":3,"file":"object-type.mjs","sources":["../../../../src/application/transform/schema/object-type.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"../../../domain/errors.js\";\nimport {\n  irObject,\n  irProperty,\n  irReference,\n  irStringIndexSignature,\n} from \"../../../domain/ir/constructors.js\";\nimport type { IrMember, IrPropertySignature, IrType } from \"../../../domain/ir/nodes.js\";\nimport { toPropertyName } from \"../../../domain/ir/property-name.js\";\nimport { createRef } from \"../../../domain/openapi/json-pointer.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { documentEntries } from \"../document-entries.js\";\nimport { schemaRefType } from \"../ref-pointer/pointer-type.js\";\nimport { schemaCommentOptionsOf, withSchemaComment } from \"../schema-comment.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { intersectionOf, unionOf } from \"../type-combinators.js\";\nimport { type AccessFlags, propertyAccessFlags } from \"./access-flags.js\";\nimport { discriminatorMember, inheritedDiscriminator } from \"./inherited-discriminator.js\";\nimport type { SchemaOptions } from \"./schema-context.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/** Path parts where a default value cannot make a property required (inputs may omit it). */\nconst INPUT_PATH_PARTS = [\"parameters\", \"requestBody\", \"requestBodies\"] as const;\n\nexport class InvalidPropertyError extends OpenAPITypesafeError {\n  constructor(path: string | undefined, key: string, value: unknown) {\n    const received = Array.isArray(value) ? \"Array\" : typeof value;\n    super({\n      code: ERROR_CODES.SCHEMA_PROPERTY_INVALID,\n      message:\n        `${path}: invalid property ${key}. ` + `Expected Schema Object or boolean, got ${received}`,\n      details: { path, property: key, received },\n    });\n    this.name = \"InvalidPropertyError\";\n  }\n}\n\n/** `--read-write-markers`: `$Read<T>` / `$Write<T>`, unless the property is both or neither. */\nfunction withReadWriteMarker(type: IrType, flags: AccessFlags, options: SchemaOptions): IrType {\n  if (!options.readWriteMarkers || flags.isReadOnly === flags.isWriteOnly) {\n    return type;\n  }\n  return irReference(flags.isReadOnly ? \"$Read\" : \"$Write\", [type]);\n}\n\n/** Apply `transformProperty`, then the schema's JSDoc. */\nfunction finishProperty(\n  property: IrPropertySignature,\n  schema: Schema,\n  path: string,\n  request: SchemaRequest,\n): IrPropertySignature {\n  const location = { ...request.location, path };\n  const transformed =\n    request.context.callbacks.transformProperty(property, schema, location) ?? property;\n  // The original adds the schema's comment after any comment the callback set.\n  return withSchemaComment(\n    transformed,\n    schema,\n    schemaCommentOptionsOf(request.context.options.fixes),\n  );\n}\n\n/** What the property loop reads from a property schema, in the original order. */\ninterface PropertyFacts {\n  readonly ref: string | undefined;\n  readonly flags: AccessFlags;\n  readonly hasDefault: boolean;\n}\n\nfunction propertyFacts(value: Schema, request: SchemaRequest): PropertyFacts {\n  if (typeof value !== \"object\") {\n    return { ref: undefined, flags: { isReadOnly: false, isWriteOnly: false }, hasDefault: false };\n  }\n  // `in` throws for a null value, as in the original (which also reads `$ref` first).\n  const ref = \"$ref\" in value && value.$ref ? value.$ref : undefined;\n  const flags = propertyAccessFlags(value, request.context);\n  return { ref, flags, hasDefault: \"default\" in value && value.default !== undefined };\n}\n\nfunction isOptionalProperty(\n  key: string,\n  facts: PropertyFacts,\n  schema: SchemaObject,\n  request: SchemaRequest,\n): boolean {\n  const { options } = request.context;\n  const path = request.location.path;\n  const isDefaultRequired =\n    facts.hasDefault &&\n    options.defaultNonNullable &&\n    !INPUT_PATH_PARTS.some((part) => path?.includes(part));\n  const isRequired =\n    schema.required?.includes(key) ||\n    (schema.required === undefined && options.propertiesRequiredByDefault) ||\n    isDefaultRequired;\n  return !isRequired;\n}\n\nfunction isExcluded(value: Schema, facts: PropertyFacts, request: SchemaRequest): boolean {\n  if (!request.context.options.excludeDeprecated) {\n    return false;\n  }\n  const resolved = facts.ref ? request.context.refs.resolve(facts.ref) : value;\n  return Boolean((resolved as SchemaObject | undefined)?.deprecated);\n}\n\n/** A type, and whether a callback forced the property optional (null: no override). */\ninterface CustomResult {\n  readonly type: IrType;\n  readonly isOptional: true | null;\n}\n\nfunction propertyType(\n  key: string,\n  value: Schema,\n  facts: PropertyFacts,\n  request: SchemaRequest,\n): CustomResult {\n  const path = createRef([request.location.path, key]);\n  const type = facts.ref\n    ? schemaRefType(facts.ref, request)\n    : request.transformNested(value, { ...request.location, path });\n  const custom = request.context.callbacks.transform(value, request.location);\n  return custom === null\n    ? { type, isOptional: null }\n    : { type: custom.type, isOptional: custom.isOptional || null };\n}\n\nfunction propertyMember(\n  key: string,\n  value: Schema,\n  schema: SchemaObject,\n  request: SchemaRequest,\n): IrMember | null {\n  if ((typeof value !== \"object\" && typeof value !== \"boolean\") || Array.isArray(value)) {\n    throw new InvalidPropertyError(request.location.path, key, value);\n  }\n  const facts = propertyFacts(value, request);\n  if (isExcluded(value, facts, request)) {\n    return null;\n  }\n  const { options } = request.context;\n  const isOptional = isOptionalProperty(key, facts, schema, request);\n  const result = propertyType(key, value, facts, request);\n  const property = irProperty(\n    toPropertyName(key),\n    withReadWriteMarker(result.type, facts.flags, options),\n    {\n      isOptional: result.isOptional ?? isOptional,\n      isReadonly: options.immutable || (!options.readWriteMarkers && facts.flags.isReadOnly),\n    },\n  );\n  return finishProperty(property, value, createRef([request.location.path, key]), request);\n}\n\nfunction propertyMembers(schema: SchemaObject, request: SchemaRequest): IrMember[] {\n  const members: IrMember[] = [];\n  for (const [key, value] of documentEntries(schema.properties ?? {}, request.context.options)) {\n    const member = propertyMember(key, value, schema, request);\n    if (member !== null) {\n      members.push(member);\n    }\n  }\n  return members;\n}\n\n/**\n * `$defs` as a nested `$defs?: { … }` member, in document order (never alphabetized). It is\n * optional because `$defs` is a schema keyword, not data: the original made it required, so a\n * value of the type needed a `$defs` key (research/legacy-bugs.md, item 17, upstream #2664).\n */\nfunction defsMember(\n  defs: Readonly<Record<string, SchemaObject>>,\n  request: SchemaRequest,\n): IrMember {\n  const { options } = request.context;\n  const members = Object.entries(defs).map(([key, value]) => {\n    const path = createRef([request.location.path, \"$defs\", key]);\n    const flags = propertyAccessFlags(value, request.context);\n    const type = withReadWriteMarker(\n      request.transformNested(value, { ...request.location, path }),\n      flags,\n      options,\n    );\n    const property = irProperty(toPropertyName(key), type, {\n      isReadonly: options.immutable || (!options.readWriteMarkers && flags.isReadOnly),\n    });\n    return finishProperty(property, value, path, request);\n  });\n  return irProperty(toPropertyName(\"$defs\"), irObject(members), { isOptional: true });\n}\n\nfunction hasObjectKeywords(schema: SchemaObject): boolean {\n  const hasProperties = Boolean(schema.properties && Object.keys(schema.properties).length);\n  return (\n    hasProperties ||\n    Boolean(schema.additionalProperties || schema.patternProperties || schema.$defs)\n  );\n}\n\n/** Value types of the `[key: string]` index signature, in the original order. */\nfunction indexValueTypes(schema: SchemaObject, request: SchemaRequest): IrType[] {\n  const { additionalProperties } = schema;\n  const isObject = typeof additionalProperties === \"object\";\n  const hasExplicit = isObject && Object.keys(additionalProperties).length > 0;\n  const hasImplicit =\n    additionalProperties === true || (isObject && Object.keys(additionalProperties).length === 0);\n  const types: IrType[] = [];\n  if (hasExplicit) {\n    types.push(request.transformNested(additionalProperties as Schema, request.location, true));\n  }\n  if (hasImplicit || (!additionalProperties && request.context.options.additionalProperties)) {\n    types.push(UNKNOWN_TYPE);\n  }\n  const patterns = schema.patternProperties;\n  if (typeof patterns === \"object\" && patterns !== null && Object.keys(patterns).length > 0) {\n    for (const [, value] of documentEntries(patterns, request.context.options)) {\n      types.push(request.transformNested(value, request.location));\n    }\n  }\n  return types;\n}\n\n/**\n * Whether the schema declares property `key` and the type keeps it: `--exclude-deprecated` drops\n * a deprecated one.\n */\nexport function isKeptProperty(schema: SchemaObject, key: string, request: SchemaRequest): boolean {\n  const properties = schema.properties ?? {};\n  if (!Object.hasOwn(properties, key)) {\n    return false;\n  }\n  const value = properties[key] as Schema;\n  const isExcludable = request.context.options.excludeDeprecated && typeof value === \"object\";\n  return !isExcludable || !isExcluded(value, propertyFacts(value, request), request);\n}\n\n/**\n * The members for the discriminator and `properties`. A schema that declares the discriminator\n * property itself keeps its own declaration, required as the discriminator needs: both in one\n * object type do not compile (TS2300, the Apple SiriKit Cloud Media API). A declaration that\n * `--exclude-deprecated` drops does not count, so the discriminator property stays.\n */\nfunction discriminatorAndPropertyMembers(schema: SchemaObject, request: SchemaRequest): IrMember[] {\n  const inherited = inheritedDiscriminator(schema, request);\n  if (inherited === undefined) {\n    return propertyMembers(schema, request);\n  }\n  const name = inherited.discriminator.propertyName;\n  if (!isKeptProperty(schema, name, request)) {\n    return [discriminatorMember(inherited, request), ...propertyMembers(schema, request)];\n  }\n  // Without `required`, `--properties-required-by-default` requires every property already; a\n  // list of one would make the others optional.\n  const isAllRequired =\n    schema.required === undefined && request.context.options.propertiesRequiredByDefault;\n  const required = isAllRequired ? undefined : [...(schema.required ?? []), name];\n  return propertyMembers({ ...schema, required } as SchemaObject, request);\n}\n\n/**\n * Object keywords: discriminator, `properties`, `$defs`, and an index signature for\n * `additionalProperties` / `patternProperties` (or `--additional-properties`). Null when the schema\n * has none of them.\n */\nexport function objectType(schema: SchemaObject, request: SchemaRequest): IrType | null {\n  if (!hasObjectKeywords(schema)) {\n    const inherited = inheritedDiscriminator(schema, request);\n    return inherited ? irObject([discriminatorMember(inherited, request)]) : null;\n  }\n  const members = discriminatorAndPropertyMembers(schema, request);\n  // As in the original, a null `$defs` throws here (Object.keys) instead of being skipped.\n  if (\n    \"$defs\" in schema &&\n    typeof schema.$defs === \"object\" &&\n    Object.keys(schema.$defs).length > 0\n  ) {\n    members.push(defsMember(schema.$defs, request));\n  }\n  const valueTypes = indexValueTypes(schema, request);\n  if (valueTypes.length === 0) {\n    return members.length > 0 ? irObject(members) : null;\n  }\n  const index = irObject([\n    irStringIndexSignature(\"key\", unionOf(valueTypes), request.context.options.immutable),\n  ]);\n  return intersectionOf([...(members.length > 0 ? [irObject(members)] : []), index]);\n}\n"],"names":[],"mappings":";;;;;;;;;;;;AAsBA,MAAM,gBAAA,GAAmB,CAAC,YAAA,EAAc,aAAA,EAAe,eAAe,CAAA;AAE/D,MAAM,6BAA6B,oBAAA,CAAqB;AAAA,EAC7D,WAAA,CAAY,IAAA,EAA0B,GAAA,EAAa,KAAA,EAAgB;AACjE,IAAA,MAAM,WAAW,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,UAAU,OAAO,KAAA;AACzD,IAAA,KAAA,CAAM;AAAA,MACJ,MAAM,WAAA,CAAY,uBAAA;AAAA,MAClB,SACE,CAAA,EAAG,IAAI,CAAA,mBAAA,EAAsB,GAAG,4CAAiD,QAAQ,CAAA,CAAA;AAAA,MAC3F,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA,EAAU,KAAK,QAAA;AAAS,KAC1C,CAAA;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,sBAAA;AAAA,EACd;AACF;AAGA,SAAS,mBAAA,CAAoB,IAAA,EAAc,KAAA,EAAoB,OAAA,EAAgC;AAC7F,EAAA,IAAI,CAAC,OAAA,CAAQ,gBAAA,IAAoB,KAAA,CAAM,UAAA,KAAe,MAAM,WAAA,EAAa;AACvE,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,YAAY,KAAA,CAAM,UAAA,GAAa,UAAU,QAAA,EAAU,CAAC,IAAI,CAAC,CAAA;AAClE;AAGA,SAAS,cAAA,CACP,QAAA,EACA,MAAA,EACA,IAAA,EACA,OAAA,EACqB;AACrB,EAAA,MAAM,QAAA,GAAW,EAAE,GAAG,OAAA,CAAQ,UAAU,IAAA,EAAK;AAC7C,EAAA,MAAM,WAAA,GACJ,QAAQ,OAAA,CAAQ,SAAA,CAAU,kBAAkB,QAAA,EAAU,MAAA,EAAQ,QAAQ,CAAA,IAAK,QAAA;AAE7E,EAAA,OAAO,iBAAA;AAAA,IACL,WAAA;AAAA,IACA,MAAA;AAAA,IACA,sBAAA,CAAuB,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,KAAK;AAAA,GACtD;AACF;AASA,SAAS,aAAA,CAAc,OAAe,OAAA,EAAuC;AAC3E,EAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,IAAA,OAAO,EAAE,GAAA,EAAK,MAAA,EAAW,KAAA,EAAO,EAAE,UAAA,EAAY,KAAA,EAAO,WAAA,EAAa,KAAA,EAAM,EAAG,UAAA,EAAY,KAAA,EAAM;AAAA,EAC/F;AAEA,EAAA,MAAM,MAAM,MAAA,IAAU,KAAA,IAAS,KAAA,CAAM,IAAA,GAAO,MAAM,IAAA,GAAO,MAAA;AACzD,EAAA,MAAM,KAAA,GAAQ,mBAAA,CAAoB,KAAA,EAAO,OAAA,CAAQ,OAAO,CAAA;AACxD,EAAA,OAAO,EAAE,KAAK,KAAA,EAAO,UAAA,EAAY,aAAa,KAAA,IAAS,KAAA,CAAM,YAAY,MAAA,EAAU;AACrF;AAEA,SAAS,kBAAA,CACP,GAAA,EACA,KAAA,EACA,MAAA,EACA,OAAA,EACS;AACT,EAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,OAAA,CAAQ,OAAA;AAC5B,EAAA,MAAM,IAAA,GAAO,QAAQ,QAAA,CAAS,IAAA;AAC9B,EAAA,MAAM,iBAAA,GACJ,KAAA,CAAM,UAAA,IACN,OAAA,CAAQ,kBAAA,IACR,CAAC,gBAAA,CAAiB,IAAA,CAAK,CAAC,IAAA,KAAS,IAAA,EAAM,QAAA,CAAS,IAAI,CAAC,CAAA;AACvD,EAAA,MAAM,UAAA,GACJ,MAAA,CAAO,QAAA,EAAU,QAAA,CAAS,GAAG,KAC5B,MAAA,CAAO,QAAA,KAAa,MAAA,IAAa,OAAA,CAAQ,2BAAA,IAC1C,iBAAA;AACF,EAAA,OAAO,CAAC,UAAA;AACV;AAEA,SAAS,UAAA,CAAW,KAAA,EAAe,KAAA,EAAsB,OAAA,EAAiC;AACxF,EAAA,IAAI,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,iBAAA,EAAmB;AAC9C,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,MAAM,QAAA,GAAW,MAAM,GAAA,GAAM,OAAA,CAAQ,QAAQ,IAAA,CAAK,OAAA,CAAQ,KAAA,CAAM,GAAG,CAAA,GAAI,KAAA;AACvE,EAAA,OAAO,OAAA,CAAS,UAAuC,UAAU,CAAA;AACnE;AAQA,SAAS,YAAA,CACP,GAAA,EACA,KAAA,EACA,KAAA,EACA,OAAA,EACc;AACd,EAAA,MAAM,OAAO,SAAA,CAAU,CAAC,QAAQ,QAAA,CAAS,IAAA,EAAM,GAAG,CAAC,CAAA;AACnD,EAAA,MAAM,OAAO,KAAA,CAAM,GAAA,GACf,aAAA,CAAc,KAAA,CAAM,KAAK,OAAO,CAAA,GAChC,OAAA,CAAQ,eAAA,CAAgB,OAAO,EAAE,GAAG,OAAA,CAAQ,QAAA,EAAU,MAAM,CAAA;AAChE,EAAA,MAAM,SAAS,OAAA,CAAQ,OAAA,CAAQ,UAAU,SAAA,CAAU,KAAA,EAAO,QAAQ,QAAQ,CAAA;AAC1E,EAAA,OAAO,MAAA,KAAW,IAAA,GACd,EAAE,IAAA,EAAM,YAAY,IAAA,EAAK,GACzB,EAAE,IAAA,EAAM,MAAA,CAAO,IAAA,EAAM,UAAA,EAAY,MAAA,CAAO,cAAc,IAAA,EAAK;AACjE;AAEA,SAAS,cAAA,CACP,GAAA,EACA,KAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,EAAA,IAAK,OAAO,UAAU,QAAA,IAAY,OAAO,UAAU,SAAA,IAAc,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACrF,IAAA,MAAM,IAAI,oBAAA,CAAqB,OAAA,CAAQ,QAAA,CAAS,IAAA,EAAM,KAAK,KAAK,CAAA;AAAA,EAClE;AACA,EAAA,MAAM,KAAA,GAAQ,aAAA,CAAc,KAAA,EAAO,OAAO,CAAA;AAC1C,EAAA,IAAI,UAAA,CAAW,KAAA,EAAO,KAAA,EAAO,OAAO,CAAA,EAAG;AACrC,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,OAAA,CAAQ,OAAA;AAC5B,EAAA,MAAM,UAAA,GAAa,kBAAA,CAAmB,GAAA,EAAK,KAAA,EAAO,QAAQ,OAAO,CAAA;AACjE,EAAA,MAAM,MAAA,GAAS,YAAA,CAAa,GAAA,EAAK,KAAA,EAAO,OAAO,OAAO,CAAA;AACtD,EAAA,MAAM,QAAA,GAAW,UAAA;AAAA,IACf,eAAe,GAAG,CAAA;AAAA,IAClB,mBAAA,CAAoB,MAAA,CAAO,IAAA,EAAM,KAAA,CAAM,OAAO,OAAO,CAAA;AAAA,IACrD;AAAA,MACE,UAAA,EAAY,OAAO,UAAA,IAAc,UAAA;AAAA,MACjC,YAAY,OAAA,CAAQ,SAAA,IAAc,CAAC,OAAA,CAAQ,gBAAA,IAAoB,MAAM,KAAA,CAAM;AAAA;AAC7E,GACF;AACA,EAAA,OAAO,cAAA,CAAe,QAAA,EAAU,KAAA,EAAO,SAAA,CAAU,CAAC,OAAA,CAAQ,QAAA,CAAS,IAAA,EAAM,GAAG,CAAC,CAAA,EAAG,OAAO,CAAA;AACzF;AAEA,SAAS,eAAA,CAAgB,QAAsB,OAAA,EAAoC;AACjF,EAAA,MAAM,UAAsB,EAAC;AAC7B,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,CAAA,IAAK,eAAA,CAAgB,MAAA,CAAO,UAAA,IAAc,EAAC,EAAG,OAAA,CAAQ,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC5F,IAAA,MAAM,MAAA,GAAS,cAAA,CAAe,GAAA,EAAK,KAAA,EAAO,QAAQ,OAAO,CAAA;AACzD,IAAA,IAAI,WAAW,IAAA,EAAM;AACnB,MAAA,OAAA,CAAQ,KAAK,MAAM,CAAA;AAAA,IACrB;AAAA,EACF;AACA,EAAA,OAAO,OAAA;AACT;AAOA,SAAS,UAAA,CACP,MACA,OAAA,EACU;AACV,EAAA,MAAM,EAAE,OAAA,EAAQ,GAAI,OAAA,CAAQ,OAAA;AAC5B,EAAA,MAAM,OAAA,GAAU,MAAA,CAAO,OAAA,CAAQ,IAAI,CAAA,CAAE,IAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM;AACzD,IAAA,MAAM,IAAA,GAAO,UAAU,CAAC,OAAA,CAAQ,SAAS,IAAA,EAAM,OAAA,EAAS,GAAG,CAAC,CAAA;AAC5D,IAAA,MAAM,KAAA,GAAQ,mBAAA,CAAoB,KAAA,EAAO,OAAA,CAAQ,OAAO,CAAA;AACxD,IAAA,MAAM,IAAA,GAAO,mBAAA;AAAA,MACX,OAAA,CAAQ,gBAAgB,KAAA,EAAO,EAAE,GAAG,OAAA,CAAQ,QAAA,EAAU,MAAM,CAAA;AAAA,MAC5D,KAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,MAAM,QAAA,GAAW,UAAA,CAAW,cAAA,CAAe,GAAG,GAAG,IAAA,EAAM;AAAA,MACrD,YAAY,OAAA,CAAQ,SAAA,IAAc,CAAC,OAAA,CAAQ,oBAAoB,KAAA,CAAM;AAAA,KACtE,CAAA;AACD,IAAA,OAAO,cAAA,CAAe,QAAA,EAAU,KAAA,EAAO,IAAA,EAAM,OAAO,CAAA;AAAA,EACtD,CAAC,CAAA;AACD,EAAA,OAAO,UAAA,CAAW,cAAA,CAAe,OAAO,CAAA,EAAG,QAAA,CAAS,OAAO,CAAA,EAAG,EAAE,UAAA,EAAY,IAAA,EAAM,CAAA;AACpF;AAEA,SAAS,kBAAkB,MAAA,EAA+B;AACxD,EAAA,MAAM,aAAA,GAAgB,QAAQ,MAAA,CAAO,UAAA,IAAc,OAAO,IAAA,CAAK,MAAA,CAAO,UAAU,CAAA,CAAE,MAAM,CAAA;AACxF,EAAA,OACE,iBACA,OAAA,CAAQ,MAAA,CAAO,wBAAwB,MAAA,CAAO,iBAAA,IAAqB,OAAO,KAAK,CAAA;AAEnF;AAGA,SAAS,eAAA,CAAgB,QAAsB,OAAA,EAAkC;AAC/E,EAAA,MAAM,EAAE,sBAAqB,GAAI,MAAA;AACjC,EAAA,MAAM,QAAA,GAAW,OAAO,oBAAA,KAAyB,QAAA;AACjD,EAAA,MAAM,cAAc,QAAA,IAAY,MAAA,CAAO,IAAA,CAAK,oBAAoB,EAAE,MAAA,GAAS,CAAA;AAC3E,EAAA,MAAM,WAAA,GACJ,yBAAyB,IAAA,IAAS,QAAA,IAAY,OAAO,IAAA,CAAK,oBAAoB,EAAE,MAAA,KAAW,CAAA;AAC7F,EAAA,MAAM,QAAkB,EAAC;AACzB,EAAA,IAAI,WAAA,EAAa;AACf,IAAA,KAAA,CAAM,KAAK,OAAA,CAAQ,eAAA,CAAgB,sBAAgC,OAAA,CAAQ,QAAA,EAAU,IAAI,CAAC,CAAA;AAAA,EAC5F;AACA,EAAA,IAAI,eAAgB,CAAC,oBAAA,IAAwB,OAAA,CAAQ,OAAA,CAAQ,QAAQ,oBAAA,EAAuB;AAC1F,IAAA,KAAA,CAAM,KAAK,YAAY,CAAA;AAAA,EACzB;AACA,EAAA,MAAM,WAAW,MAAA,CAAO,iBAAA;AACxB,EAAA,IAAI,OAAO,QAAA,KAAa,QAAA,IAAY,QAAA,KAAa,IAAA,IAAQ,OAAO,IAAA,CAAK,QAAQ,CAAA,CAAE,MAAA,GAAS,CAAA,EAAG;AACzF,IAAA,KAAA,MAAW,GAAG,KAAK,CAAA,IAAK,gBAAgB,QAAA,EAAU,OAAA,CAAQ,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC1E,MAAA,KAAA,CAAM,KAAK,OAAA,CAAQ,eAAA,CAAgB,KAAA,EAAO,OAAA,CAAQ,QAAQ,CAAC,CAAA;AAAA,IAC7D;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAMO,SAAS,cAAA,CAAe,MAAA,EAAsB,GAAA,EAAa,OAAA,EAAiC;AACjG,EAAA,MAAM,UAAA,GAAa,MAAA,CAAO,UAAA,IAAc,EAAC;AACzC,EAAA,IAAI,CAAC,MAAA,CAAO,MAAA,CAAO,UAAA,EAAY,GAAG,CAAA,EAAG;AACnC,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,MAAM,KAAA,GAAQ,WAAW,GAAG,CAAA;AAC5B,EAAA,MAAM,eAAe,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,iBAAA,IAAqB,OAAO,KAAA,KAAU,QAAA;AACnF,EAAA,OAAO,CAAC,gBAAgB,CAAC,UAAA,CAAW,OAAO,aAAA,CAAc,KAAA,EAAO,OAAO,CAAA,EAAG,OAAO,CAAA;AACnF;AAQA,SAAS,+BAAA,CAAgC,QAAsB,OAAA,EAAoC;AACjG,EAAA,MAAM,SAAA,GAAY,sBAAA,CAAuB,MAAA,EAAQ,OAAO,CAAA;AACxD,EAAA,IAAI,cAAc,MAAA,EAAW;AAC3B,IAAA,OAAO,eAAA,CAAgB,QAAQ,OAAO,CAAA;AAAA,EACxC;AACA,EAAA,MAAM,IAAA,GAAO,UAAU,aAAA,CAAc,YAAA;AACrC,EAAA,IAAI,CAAC,cAAA,CAAe,MAAA,EAAQ,IAAA,EAAM,OAAO,CAAA,EAAG;AAC1C,IAAA,OAAO,CAAC,oBAAoB,SAAA,EAAW,OAAO,GAAG,GAAG,eAAA,CAAgB,MAAA,EAAQ,OAAO,CAAC,CAAA;AAAA,EACtF;AAGA,EAAA,MAAM,gBACJ,MAAA,CAAO,QAAA,KAAa,MAAA,IAAa,OAAA,CAAQ,QAAQ,OAAA,CAAQ,2BAAA;AAC3D,EAAA,MAAM,QAAA,GAAW,gBAAgB,MAAA,GAAY,CAAC,GAAI,MAAA,CAAO,QAAA,IAAY,EAAC,EAAI,IAAI,CAAA;AAC9E,EAAA,OAAO,gBAAgB,EAAE,GAAG,MAAA,EAAQ,QAAA,IAA4B,OAAO,CAAA;AACzE;AAOO,SAAS,UAAA,CAAW,QAAsB,OAAA,EAAuC;AACtF,EAAA,IAAI,CAAC,iBAAA,CAAkB,MAAM,CAAA,EAAG;AAC9B,IAAA,MAAM,SAAA,GAAY,sBAAA,CAAuB,MAAA,EAAQ,OAAO,CAAA;AACxD,IAAA,OAAO,SAAA,GAAY,SAAS,CAAC,mBAAA,CAAoB,WAAW,OAAO,CAAC,CAAC,CAAA,GAAI,IAAA;AAAA,EAC3E;AACA,EAAA,MAAM,OAAA,GAAU,+BAAA,CAAgC,MAAA,EAAQ,OAAO,CAAA;AAE/D,EAAA,IACE,OAAA,IAAW,MAAA,IACX,OAAO,MAAA,CAAO,KAAA,KAAU,QAAA,IACxB,MAAA,CAAO,IAAA,CAAK,MAAA,CAAO,KAAK,CAAA,CAAE,MAAA,GAAS,CAAA,EACnC;AACA,IAAA,OAAA,CAAQ,IAAA,CAAK,UAAA,CAAW,MAAA,CAAO,KAAA,EAAO,OAAO,CAAC,CAAA;AAAA,EAChD;AACA,EAAA,MAAM,UAAA,GAAa,eAAA,CAAgB,MAAA,EAAQ,OAAO,CAAA;AAClD,EAAA,IAAI,UAAA,CAAW,WAAW,CAAA,EAAG;AAC3B,IAAA,OAAO,OAAA,CAAQ,MAAA,GAAS,CAAA,GAAI,QAAA,CAAS,OAAO,CAAA,GAAI,IAAA;AAAA,EAClD;AACA,EAAA,MAAM,QAAQ,QAAA,CAAS;AAAA,IACrB,sBAAA,CAAuB,OAAO,OAAA,CAAQ,UAAU,GAAG,OAAA,CAAQ,OAAA,CAAQ,QAAQ,SAAS;AAAA,GACrF,CAAA;AACD,EAAA,OAAO,cAAA,CAAe,CAAC,GAAI,OAAA,CAAQ,SAAS,CAAA,GAAI,CAAC,QAAA,CAAS,OAAO,CAAC,CAAA,GAAI,EAAC,EAAI,KAAK,CAAC,CAAA;AACnF;;"}

package/dist/application/transform/schema/required-variants.cjs

@@ -0,0 +1,45 @@
+'use strict';
+
+const outputFixes = require('../../../domain/output-fixes.cjs');
+const typeCombinators = require('../type-combinators.cjs');
+const objectType = require('./object-type.cjs');
+
+const ANNOTATION_KEYS = /* @__PURE__ */ new Set(["required", "description", "title"]);
+function requiredOnlyKeys(variant) {
+  if (typeof variant !== "object" || variant === null || "$ref" in variant) {
+    return null;
+  }
+  const { required } = variant;
+  const isRequiredOnly = Object.keys(variant).every((key) => ANNOTATION_KEYS.has(key));
+  return isRequiredOnly && Array.isArray(required) && required.length > 0 ? required : null;
+}
+function isObjectTyped(schema) {
+  const { type } = schema;
+  return type === void 0 || type === "object" || Array.isArray(type) && type.includes("object");
+}
+function requiredKeyLists(schema, variants, request) {
+  const keyLists = variants.map(requiredOnlyKeys);
+  const isApplicable = keyLists.length > 0 && keyLists.every((keys) => keys?.every((key) => objectType.isKeptProperty(schema, key, request)) === true);
+  return isApplicable ? keyLists : null;
+}
+function hasRequiredVariants(schema, variants, request) {
+  return request.context.options.fixes.has(outputFixes.OutputFix.ANYOF_ONEOF_REQUIRED) && isObjectTyped(schema) && requiredKeyLists(schema, variants, request) !== null;
+}
+function requiredVariantsType(previous, schema, variants, request) {
+  if (!request.context.options.fixes.has(outputFixes.OutputFix.ANYOF_ONEOF_REQUIRED) || previous === null) {
+    return null;
+  }
+  const keyLists = isObjectTyped(schema) ? requiredKeyLists(schema, variants, request) : null;
+  if (keyLists === null) {
+    return null;
+  }
+  if (Array.isArray(schema.type)) {
+    return previous;
+  }
+  request.context.footer.requireWithRequired();
+  return typeCombinators.unionOf(keyLists.map((keys) => typeCombinators.withRequiredKeys(previous, keys)));
+}
+
+exports.hasRequiredVariants = hasRequiredVariants;
+exports.requiredVariantsType = requiredVariantsType;
+//# sourceMappingURL=required-variants.cjs.map

package/dist/application/transform/schema/required-variants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-variants.cjs","sources":["../../../../src/application/transform/schema/required-variants.ts"],"sourcesContent":["import type { IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { OutputFix } from \"../../../domain/output-fixes.js\";\nimport { unionOf, withRequiredKeys } from \"../type-combinators.js\";\nimport { isKeptProperty } from \"./object-type.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/**\n * The `anyof-oneof-required` fix. `anyOf: [{ required: [a] }, { required: [b] }]` next to\n * `properties` says which of the properties must be there. Each such variant has no type of its\n * own (`unknown`), so the original gives `Props | unknown`, which is `unknown`. With the fix each\n * variant is the parent with its keys required:\n * `WithRequired<Props, \"a\"> | WithRequired<Props, \"b\">`.\n */\n\n/** Keywords that do not change a value's type: a variant of these and `required` counts. */\nconst ANNOTATION_KEYS: ReadonlySet<string> = new Set([\"required\", \"description\", \"title\"]);\n\n/** The `required` keys of a variant that has nothing else, or null for any other variant. */\nfunction requiredOnlyKeys(variant: Schema): readonly string[] | null {\n  if (typeof variant !== \"object\" || variant === null || \"$ref\" in variant) {\n    return null;\n  }\n  const { required } = variant as SchemaObject;\n  const isRequiredOnly = Object.keys(variant).every((key) => ANNOTATION_KEYS.has(key));\n  return isRequiredOnly && Array.isArray(required) && required.length > 0 ? required : null;\n}\n\n/** Whether the schema's type is an object: no `type`, `object`, or a list with `object`. */\nfunction isObjectTyped(schema: SchemaObject): boolean {\n  const { type } = schema;\n  return (\n    type === undefined || type === \"object\" || (Array.isArray(type) && type.includes(\"object\"))\n  );\n}\n\n/** The variants' key lists, or null unless each requires only properties the type keeps. */\nfunction requiredKeyLists(\n  schema: SchemaObject,\n  variants: readonly Schema[],\n  request: SchemaRequest,\n): (readonly string[])[] | null {\n  const keyLists = variants.map(requiredOnlyKeys);\n  // A key of a property the type leaves out (`--exclude-deprecated`) is no key of `WithRequired`.\n  const isApplicable =\n    keyLists.length > 0 &&\n    keyLists.every((keys) => keys?.every((key) => isKeptProperty(schema, key, request)) === true);\n  return isApplicable ? (keyLists as (readonly string[])[]) : null;\n}\n\n/** Whether the fix gives `variants` of the schema their keys of its properties. */\nexport function hasRequiredVariants(\n  schema: SchemaObject,\n  variants: readonly Schema[],\n  request: SchemaRequest,\n): boolean {\n  return (\n    request.context.options.fixes.has(OutputFix.ANYOF_ONEOF_REQUIRED) &&\n    isObjectTyped(schema) &&\n    requiredKeyLists(schema, variants, request) !== null\n  );\n}\n\n/**\n * The union of the parent type with each variant's keys required, or null where the fix is off\n * or the variants are not all required-only ones over the parent's own, kept properties. Only an\n * object has the keys. For a `type` list, the `object` member has required them already\n * (`multipleTypes`), so the list is the whole type.\n */\nexport function requiredVariantsType(\n  previous: IrType | null,\n  schema: SchemaObject,\n  variants: readonly Schema[],\n  request: SchemaRequest,\n): IrType | null {\n  if (!request.context.options.fixes.has(OutputFix.ANYOF_ONEOF_REQUIRED) || previous === null) {\n    return null;\n  }\n  const keyLists = isObjectTyped(schema) ? requiredKeyLists(schema, variants, request) : null;\n  if (keyLists === null) {\n    return null;\n  }\n  if (Array.isArray(schema.type)) {\n    return previous;\n  }\n  request.context.footer.requireWithRequired();\n  return unionOf(keyLists.map((keys) => withRequiredKeys(previous, keys)));\n}\n"],"names":["isKeptProperty","OutputFix","unionOf","withRequiredKeys"],"mappings":";;;;;;AAgBA,MAAM,kCAAuC,IAAI,GAAA,CAAI,CAAC,UAAA,EAAY,aAAA,EAAe,OAAO,CAAC,CAAA;AAGzF,SAAS,iBAAiB,OAAA,EAA2C;AACnE,EAAA,IAAI,OAAO,OAAA,KAAY,QAAA,IAAY,OAAA,KAAY,IAAA,IAAQ,UAAU,OAAA,EAAS;AACxE,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,EAAE,UAAS,GAAI,OAAA;AACrB,EAAA,MAAM,cAAA,GAAiB,MAAA,CAAO,IAAA,CAAK,OAAO,CAAA,CAAE,KAAA,CAAM,CAAC,GAAA,KAAQ,eAAA,CAAgB,GAAA,CAAI,GAAG,CAAC,CAAA;AACnF,EAAA,OAAO,cAAA,IAAkB,MAAM,OAAA,CAAQ,QAAQ,KAAK,QAAA,CAAS,MAAA,GAAS,IAAI,QAAA,GAAW,IAAA;AACvF;AAGA,SAAS,cAAc,MAAA,EAA+B;AACpD,EAAA,MAAM,EAAE,MAAK,GAAI,MAAA;AACjB,EAAA,OACE,IAAA,KAAS,MAAA,IAAa,IAAA,KAAS,QAAA,IAAa,KAAA,CAAM,QAAQ,IAAI,CAAA,IAAK,IAAA,CAAK,QAAA,CAAS,QAAQ,CAAA;AAE7F;AAGA,SAAS,gBAAA,CACP,MAAA,EACA,QAAA,EACA,OAAA,EAC8B;AAC9B,EAAA,MAAM,QAAA,GAAW,QAAA,CAAS,GAAA,CAAI,gBAAgB,CAAA;AAE9C,EAAA,MAAM,eACJ,QAAA,CAAS,MAAA,GAAS,KAClB,QAAA,CAAS,KAAA,CAAM,CAAC,IAAA,KAAS,IAAA,EAAM,KAAA,CAAM,CAAC,QAAQA,yBAAA,CAAe,MAAA,EAAQ,KAAK,OAAO,CAAC,MAAM,IAAI,CAAA;AAC9F,EAAA,OAAO,eAAgB,QAAA,GAAqC,IAAA;AAC9D;AAGO,SAAS,mBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACS;AACT,EAAA,OACE,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,KAAA,CAAM,IAAIC,qBAAA,CAAU,oBAAoB,CAAA,IAChE,aAAA,CAAc,MAAM,CAAA,IACpB,gBAAA,CAAiB,MAAA,EAAQ,QAAA,EAAU,OAAO,CAAA,KAAM,IAAA;AAEpD;AAQO,SAAS,oBAAA,CACd,QAAA,EACA,MAAA,EACA,QAAA,EACA,OAAA,EACe;AACf,EAAA,IAAI,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,KAAA,CAAM,IAAIA,qBAAA,CAAU,oBAAoB,CAAA,IAAK,QAAA,KAAa,IAAA,EAAM;AAC3F,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,QAAA,GAAW,cAAc,MAAM,CAAA,GAAI,iBAAiB,MAAA,EAAQ,QAAA,EAAU,OAAO,CAAA,GAAI,IAAA;AACvF,EAAA,IAAI,aAAa,IAAA,EAAM;AACrB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,IAAI,CAAA,EAAG;AAC9B,IAAA,OAAO,QAAA;AAAA,EACT;AACA,EAAA,OAAA,CAAQ,OAAA,CAAQ,OAAO,mBAAA,EAAoB;AAC3C,EAAA,OAAOC,uBAAA,CAAQ,SAAS,GAAA,CAAI,CAAC,SAASC,gCAAA,CAAiB,QAAA,EAAU,IAAI,CAAC,CAAC,CAAA;AACzE;;;"}

package/dist/application/transform/schema/required-variants.mjs

@@ -0,0 +1,42 @@
+import { OutputFix } from '../../../domain/output-fixes.mjs';
+import { unionOf, withRequiredKeys } from '../type-combinators.mjs';
+import { isKeptProperty } from './object-type.mjs';
+
+const ANNOTATION_KEYS = /* @__PURE__ */ new Set(["required", "description", "title"]);
+function requiredOnlyKeys(variant) {
+  if (typeof variant !== "object" || variant === null || "$ref" in variant) {
+    return null;
+  }
+  const { required } = variant;
+  const isRequiredOnly = Object.keys(variant).every((key) => ANNOTATION_KEYS.has(key));
+  return isRequiredOnly && Array.isArray(required) && required.length > 0 ? required : null;
+}
+function isObjectTyped(schema) {
+  const { type } = schema;
+  return type === void 0 || type === "object" || Array.isArray(type) && type.includes("object");
+}
+function requiredKeyLists(schema, variants, request) {
+  const keyLists = variants.map(requiredOnlyKeys);
+  const isApplicable = keyLists.length > 0 && keyLists.every((keys) => keys?.every((key) => isKeptProperty(schema, key, request)) === true);
+  return isApplicable ? keyLists : null;
+}
+function hasRequiredVariants(schema, variants, request) {
+  return request.context.options.fixes.has(OutputFix.ANYOF_ONEOF_REQUIRED) && isObjectTyped(schema) && requiredKeyLists(schema, variants, request) !== null;
+}
+function requiredVariantsType(previous, schema, variants, request) {
+  if (!request.context.options.fixes.has(OutputFix.ANYOF_ONEOF_REQUIRED) || previous === null) {
+    return null;
+  }
+  const keyLists = isObjectTyped(schema) ? requiredKeyLists(schema, variants, request) : null;
+  if (keyLists === null) {
+    return null;
+  }
+  if (Array.isArray(schema.type)) {
+    return previous;
+  }
+  request.context.footer.requireWithRequired();
+  return unionOf(keyLists.map((keys) => withRequiredKeys(previous, keys)));
+}
+
+export { hasRequiredVariants, requiredVariantsType };
+//# sourceMappingURL=required-variants.mjs.map

package/dist/application/transform/schema/required-variants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-variants.mjs","sources":["../../../../src/application/transform/schema/required-variants.ts"],"sourcesContent":["import type { IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { OutputFix } from \"../../../domain/output-fixes.js\";\nimport { unionOf, withRequiredKeys } from \"../type-combinators.js\";\nimport { isKeptProperty } from \"./object-type.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/**\n * The `anyof-oneof-required` fix. `anyOf: [{ required: [a] }, { required: [b] }]` next to\n * `properties` says which of the properties must be there. Each such variant has no type of its\n * own (`unknown`), so the original gives `Props | unknown`, which is `unknown`. With the fix each\n * variant is the parent with its keys required:\n * `WithRequired<Props, \"a\"> | WithRequired<Props, \"b\">`.\n */\n\n/** Keywords that do not change a value's type: a variant of these and `required` counts. */\nconst ANNOTATION_KEYS: ReadonlySet<string> = new Set([\"required\", \"description\", \"title\"]);\n\n/** The `required` keys of a variant that has nothing else, or null for any other variant. */\nfunction requiredOnlyKeys(variant: Schema): readonly string[] | null {\n  if (typeof variant !== \"object\" || variant === null || \"$ref\" in variant) {\n    return null;\n  }\n  const { required } = variant as SchemaObject;\n  const isRequiredOnly = Object.keys(variant).every((key) => ANNOTATION_KEYS.has(key));\n  return isRequiredOnly && Array.isArray(required) && required.length > 0 ? required : null;\n}\n\n/** Whether the schema's type is an object: no `type`, `object`, or a list with `object`. */\nfunction isObjectTyped(schema: SchemaObject): boolean {\n  const { type } = schema;\n  return (\n    type === undefined || type === \"object\" || (Array.isArray(type) && type.includes(\"object\"))\n  );\n}\n\n/** The variants' key lists, or null unless each requires only properties the type keeps. */\nfunction requiredKeyLists(\n  schema: SchemaObject,\n  variants: readonly Schema[],\n  request: SchemaRequest,\n): (readonly string[])[] | null {\n  const keyLists = variants.map(requiredOnlyKeys);\n  // A key of a property the type leaves out (`--exclude-deprecated`) is no key of `WithRequired`.\n  const isApplicable =\n    keyLists.length > 0 &&\n    keyLists.every((keys) => keys?.every((key) => isKeptProperty(schema, key, request)) === true);\n  return isApplicable ? (keyLists as (readonly string[])[]) : null;\n}\n\n/** Whether the fix gives `variants` of the schema their keys of its properties. */\nexport function hasRequiredVariants(\n  schema: SchemaObject,\n  variants: readonly Schema[],\n  request: SchemaRequest,\n): boolean {\n  return (\n    request.context.options.fixes.has(OutputFix.ANYOF_ONEOF_REQUIRED) &&\n    isObjectTyped(schema) &&\n    requiredKeyLists(schema, variants, request) !== null\n  );\n}\n\n/**\n * The union of the parent type with each variant's keys required, or null where the fix is off\n * or the variants are not all required-only ones over the parent's own, kept properties. Only an\n * object has the keys. For a `type` list, the `object` member has required them already\n * (`multipleTypes`), so the list is the whole type.\n */\nexport function requiredVariantsType(\n  previous: IrType | null,\n  schema: SchemaObject,\n  variants: readonly Schema[],\n  request: SchemaRequest,\n): IrType | null {\n  if (!request.context.options.fixes.has(OutputFix.ANYOF_ONEOF_REQUIRED) || previous === null) {\n    return null;\n  }\n  const keyLists = isObjectTyped(schema) ? requiredKeyLists(schema, variants, request) : null;\n  if (keyLists === null) {\n    return null;\n  }\n  if (Array.isArray(schema.type)) {\n    return previous;\n  }\n  request.context.footer.requireWithRequired();\n  return unionOf(keyLists.map((keys) => withRequiredKeys(previous, keys)));\n}\n"],"names":[],"mappings":";;;;AAgBA,MAAM,kCAAuC,IAAI,GAAA,CAAI,CAAC,UAAA,EAAY,aAAA,EAAe,OAAO,CAAC,CAAA;AAGzF,SAAS,iBAAiB,OAAA,EAA2C;AACnE,EAAA,IAAI,OAAO,OAAA,KAAY,QAAA,IAAY,OAAA,KAAY,IAAA,IAAQ,UAAU,OAAA,EAAS;AACxE,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,EAAE,UAAS,GAAI,OAAA;AACrB,EAAA,MAAM,cAAA,GAAiB,MAAA,CAAO,IAAA,CAAK,OAAO,CAAA,CAAE,KAAA,CAAM,CAAC,GAAA,KAAQ,eAAA,CAAgB,GAAA,CAAI,GAAG,CAAC,CAAA;AACnF,EAAA,OAAO,cAAA,IAAkB,MAAM,OAAA,CAAQ,QAAQ,KAAK,QAAA,CAAS,MAAA,GAAS,IAAI,QAAA,GAAW,IAAA;AACvF;AAGA,SAAS,cAAc,MAAA,EAA+B;AACpD,EAAA,MAAM,EAAE,MAAK,GAAI,MAAA;AACjB,EAAA,OACE,IAAA,KAAS,MAAA,IAAa,IAAA,KAAS,QAAA,IAAa,KAAA,CAAM,QAAQ,IAAI,CAAA,IAAK,IAAA,CAAK,QAAA,CAAS,QAAQ,CAAA;AAE7F;AAGA,SAAS,gBAAA,CACP,MAAA,EACA,QAAA,EACA,OAAA,EAC8B;AAC9B,EAAA,MAAM,QAAA,GAAW,QAAA,CAAS,GAAA,CAAI,gBAAgB,CAAA;AAE9C,EAAA,MAAM,eACJ,QAAA,CAAS,MAAA,GAAS,KAClB,QAAA,CAAS,KAAA,CAAM,CAAC,IAAA,KAAS,IAAA,EAAM,KAAA,CAAM,CAAC,QAAQ,cAAA,CAAe,MAAA,EAAQ,KAAK,OAAO,CAAC,MAAM,IAAI,CAAA;AAC9F,EAAA,OAAO,eAAgB,QAAA,GAAqC,IAAA;AAC9D;AAGO,SAAS,mBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACS;AACT,EAAA,OACE,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,KAAA,CAAM,IAAI,SAAA,CAAU,oBAAoB,CAAA,IAChE,aAAA,CAAc,MAAM,CAAA,IACpB,gBAAA,CAAiB,MAAA,EAAQ,QAAA,EAAU,OAAO,CAAA,KAAM,IAAA;AAEpD;AAQO,SAAS,oBAAA,CACd,QAAA,EACA,MAAA,EACA,QAAA,EACA,OAAA,EACe;AACf,EAAA,IAAI,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,KAAA,CAAM,IAAI,SAAA,CAAU,oBAAoB,CAAA,IAAK,QAAA,KAAa,IAAA,EAAM;AAC3F,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,QAAA,GAAW,cAAc,MAAM,CAAA,GAAI,iBAAiB,MAAA,EAAQ,QAAA,EAAU,OAAO,CAAA,GAAI,IAAA;AACvF,EAAA,IAAI,aAAa,IAAA,EAAM;AACrB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,MAAA,CAAO,IAAI,CAAA,EAAG;AAC9B,IAAA,OAAO,QAAA;AAAA,EACT;AACA,EAAA,OAAA,CAAQ,OAAA,CAAQ,OAAO,mBAAA,EAAoB;AAC3C,EAAA,OAAO,OAAA,CAAQ,SAAS,GAAA,CAAI,CAAC,SAAS,gBAAA,CAAiB,QAAA,EAAU,IAAI,CAAC,CAAC,CAAA;AACzE;;"}

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

@@ -3,7 +3,7 @@
 const errors = require('../../../domain/errors.cjs');
 const constructors = require('../../../domain/ir/constructors.cjs');
 const literalType = require('../literal-type.cjs');
-const refType = require('../ref-type.cjs');
+const pointerType = require('../ref-pointer/pointer-type.cjs');
 const sharedTypes = require('../shared-types.cjs');
 const compositionType = require('./composition-type.cjs');
 const enumRule = require('./enum-rule.cjs');
@@ -23,7 +23,7 @@ const SHAPE_RULES = [
   {
     name: "$ref",
     matches: (schema) => "$ref" in schema,
-    transform: (schema) => refType.refType(schema.$ref)
+    transform: (schema, request2) => pointerType.schemaRefType(schema.$ref, request2)
   },
   {
     name: "const",

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

@@ -1 +1 @@
-{"version":3,"file":"schema-transform.cjs","sources":["../../../../src/application/transform/schema/schema-transform.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"../../../domain/errors.js\";\nimport { irKeyword } from \"../../../domain/ir/constructors.js\";\nimport type { IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { literalType } from \"../literal-type.js\";\nimport { refType } from \"../ref-type.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { compositionType } from \"./composition-type.js\";\nimport { enumRule } from \"./enum-rule.js\";\nimport type { SchemaContext, SchemaLocation } from \"./schema-context.js\";\nimport type { SchemaRequest, SchemaRule } from \"./schema-rule.js\";\n\nexport class InvalidSchemaError extends OpenAPITypesafeError {\n  constructor(schema: unknown, path: string | undefined) {\n    const received = Array.isArray(schema) ? \"Array\" : typeof schema;\n    super({\n      code: ERROR_CODES.SCHEMA_OBJECT_INVALID,\n      message: `Expected SchemaObject, received ${received} at ${path}`,\n      details: { path, received },\n    });\n    this.name = \"InvalidSchemaError\";\n  }\n}\n\n/** Shape rules in the original precedence; composition handles everything they do not match. */\nconst SHAPE_RULES: readonly SchemaRule[] = [\n  {\n    name: \"$ref\",\n    matches: (schema) => \"$ref\" in schema,\n    transform: (schema) => refType((schema as { $ref: string }).$ref),\n  },\n  {\n    name: \"const\",\n    matches: (schema) => schema.const !== null && schema.const !== undefined,\n    transform: (schema) => literalType(schema.const),\n  },\n  enumRule,\n];\n\n/** A schema checked for its input shape, or the type of a non-object schema. */\ntype CheckedSchema = { readonly type: IrType } | { readonly schema: SchemaObject };\n\n/** A missing schema is `never`; `true` allows anything; other non-objects are invalid. */\nfunction checkSchema(schema: unknown, path: string | undefined): CheckedSchema {\n  if (!schema) {\n    return { type: irKeyword(\"never\") };\n  }\n  if (schema === true) {\n    return { type: UNKNOWN_TYPE };\n  }\n  if (Array.isArray(schema) || typeof schema !== \"object\") {\n    throw new InvalidSchemaError(schema, path);\n  }\n  return { schema: schema as SchemaObject };\n}\n\nfunction request(\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties: boolean,\n): SchemaRequest {\n  return {\n    location,\n    context,\n    isFromAdditionalProperties,\n    transformNested: (schema, nestedLocation, isNestedFromAdditionalProperties = false) =>\n      transformSchema(schema, nestedLocation, context, isNestedFromAdditionalProperties),\n  };\n}\n\n/**\n * Transform a schema without the `postTransform` callback (the original\n * `transformSchemaObjectWithComposition`). Nested schemas still get `postTransform`.\n */\nexport function transformSchemaShape(\n  schema: Schema | null | undefined,\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties = false,\n): IrType {\n  const checked = checkSchema(schema, location.path);\n  if (\"type\" in checked) {\n    return checked.type;\n  }\n  const current = request(location, context, isFromAdditionalProperties);\n  const rule = SHAPE_RULES.find((candidate) => candidate.matches(checked.schema));\n  return rule ? rule.transform(checked.schema, current) : compositionType(checked.schema, current);\n}\n\n/** Transform a schema to IR, then apply `postTransform` (the original `transformSchemaObject`). */\nexport function transformSchema(\n  schema: Schema | null | undefined,\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties = false,\n): IrType {\n  const type = transformSchemaShape(schema, location, context, isFromAdditionalProperties);\n  return context.callbacks.postTransform(type, location) ?? type;\n}\n"],"names":["OpenAPITypesafeError","ERROR_CODES","refType","literalType","enumRule","irKeyword","UNKNOWN_TYPE","compositionType"],"mappings":";;;;;;;;;;AAYO,MAAM,2BAA2BA,2BAAA,CAAqB;AAAA,EAC3D,WAAA,CAAY,QAAiB,IAAA,EAA0B;AACrD,IAAA,MAAM,WAAW,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,UAAU,OAAO,MAAA;AAC1D,IAAA,KAAA,CAAM;AAAA,MACJ,MAAMC,kBAAA,CAAY,qBAAA;AAAA,MAClB,OAAA,EAAS,CAAA,gCAAA,EAAmC,QAAQ,CAAA,IAAA,EAAO,IAAI,CAAA,CAAA;AAAA,MAC/D,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA;AAAS,KAC3B,CAAA;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,oBAAA;AAAA,EACd;AACF;AAGA,MAAM,WAAA,GAAqC;AAAA,EACzC;AAAA,IACE,IAAA,EAAM,MAAA;AAAA,IACN,OAAA,EAAS,CAAC,MAAA,KAAW,MAAA,IAAU,MAAA;AAAA,IAC/B,SAAA,EAAW,CAAC,MAAA,KAAWC,eAAA,CAAS,OAA4B,IAAI;AAAA,GAClE;AAAA,EACA;AAAA,IACE,IAAA,EAAM,OAAA;AAAA,IACN,SAAS,CAAC,MAAA,KAAW,OAAO,KAAA,KAAU,IAAA,IAAQ,OAAO,KAAA,KAAU,MAAA;AAAA,IAC/D,SAAA,EAAW,CAAC,MAAA,KAAWC,uBAAA,CAAY,OAAO,KAAK;AAAA,GACjD;AAAA,EACAC;AACF,CAAA;AAMA,SAAS,WAAA,CAAY,QAAiB,IAAA,EAAyC;AAC7E,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,EAAE,IAAA,EAAMC,sBAAA,CAAU,OAAO,CAAA,EAAE;AAAA,EACpC;AACA,EAAA,IAAI,WAAW,IAAA,EAAM;AACnB,IAAA,OAAO,EAAE,MAAMC,wBAAA,EAAa;AAAA,EAC9B;AACA,EAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,WAAW,QAAA,EAAU;AACvD,IAAA,MAAM,IAAI,kBAAA,CAAmB,MAAA,EAAQ,IAAI,CAAA;AAAA,EAC3C;AACA,EAAA,OAAO,EAAE,MAAA,EAA+B;AAC1C;AAEA,SAAS,OAAA,CACP,QAAA,EACA,OAAA,EACA,0BAAA,EACe;AACf,EAAA,OAAO;AAAA,IACL,QAAA;AAAA,IACA,OAAA;AAAA,IACA,0BAAA;AAAA,IACA,eAAA,EAAiB,CAAC,MAAA,EAAQ,cAAA,EAAgB,gCAAA,GAAmC,UAC3E,eAAA,CAAgB,MAAA,EAAQ,cAAA,EAAgB,OAAA,EAAS,gCAAgC;AAAA,GACrF;AACF;AAMO,SAAS,oBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACA,6BAA6B,KAAA,EACrB;AACR,EAAA,MAAM,OAAA,GAAU,WAAA,CAAY,MAAA,EAAQ,QAAA,CAAS,IAAI,CAAA;AACjD,EAAA,IAAI,UAAU,OAAA,EAAS;AACrB,IAAA,OAAO,OAAA,CAAQ,IAAA;AAAA,EACjB;AACA,EAAA,MAAM,OAAA,GAAU,OAAA,CAAQ,QAAA,EAAU,OAAA,EAAS,0BAA0B,CAAA;AACrE,EAAA,MAAM,IAAA,GAAO,YAAY,IAAA,CAAK,CAAC,cAAc,SAAA,CAAU,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAC,CAAA;AAC9E,EAAA,OAAO,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQ,MAAA,EAAQ,OAAO,CAAA,GAAIC,+BAAA,CAAgB,OAAA,CAAQ,MAAA,EAAQ,OAAO,CAAA;AACjG;AAGO,SAAS,eAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACA,6BAA6B,KAAA,EACrB;AACR,EAAA,MAAM,IAAA,GAAO,oBAAA,CAAqB,MAAA,EAAQ,QAAA,EAAU,SAAS,0BAA0B,CAAA;AACvF,EAAA,OAAO,OAAA,CAAQ,SAAA,CAAU,aAAA,CAAc,IAAA,EAAM,QAAQ,CAAA,IAAK,IAAA;AAC5D;;;;"}
+{"version":3,"file":"schema-transform.cjs","sources":["../../../../src/application/transform/schema/schema-transform.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"../../../domain/errors.js\";\nimport { irKeyword } from \"../../../domain/ir/constructors.js\";\nimport type { IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { literalType } from \"../literal-type.js\";\nimport { schemaRefType } from \"../ref-pointer/pointer-type.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { compositionType } from \"./composition-type.js\";\nimport { enumRule } from \"./enum-rule.js\";\nimport type { SchemaContext, SchemaLocation } from \"./schema-context.js\";\nimport type { SchemaRequest, SchemaRule } from \"./schema-rule.js\";\n\nexport class InvalidSchemaError extends OpenAPITypesafeError {\n  constructor(schema: unknown, path: string | undefined) {\n    const received = Array.isArray(schema) ? \"Array\" : typeof schema;\n    super({\n      code: ERROR_CODES.SCHEMA_OBJECT_INVALID,\n      message: `Expected SchemaObject, received ${received} at ${path}`,\n      details: { path, received },\n    });\n    this.name = \"InvalidSchemaError\";\n  }\n}\n\n/** Shape rules in the original precedence; composition handles everything they do not match. */\nconst SHAPE_RULES: readonly SchemaRule[] = [\n  {\n    name: \"$ref\",\n    matches: (schema) => \"$ref\" in schema,\n    transform: (schema, request) => schemaRefType((schema as { $ref: string }).$ref, request),\n  },\n  {\n    name: \"const\",\n    matches: (schema) => schema.const !== null && schema.const !== undefined,\n    transform: (schema) => literalType(schema.const),\n  },\n  enumRule,\n];\n\n/** A schema checked for its input shape, or the type of a non-object schema. */\ntype CheckedSchema = { readonly type: IrType } | { readonly schema: SchemaObject };\n\n/** A missing schema is `never`; `true` allows anything; other non-objects are invalid. */\nfunction checkSchema(schema: unknown, path: string | undefined): CheckedSchema {\n  if (!schema) {\n    return { type: irKeyword(\"never\") };\n  }\n  if (schema === true) {\n    return { type: UNKNOWN_TYPE };\n  }\n  if (Array.isArray(schema) || typeof schema !== \"object\") {\n    throw new InvalidSchemaError(schema, path);\n  }\n  return { schema: schema as SchemaObject };\n}\n\nfunction request(\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties: boolean,\n): SchemaRequest {\n  return {\n    location,\n    context,\n    isFromAdditionalProperties,\n    transformNested: (schema, nestedLocation, isNestedFromAdditionalProperties = false) =>\n      transformSchema(schema, nestedLocation, context, isNestedFromAdditionalProperties),\n  };\n}\n\n/**\n * Transform a schema without the `postTransform` callback (the original\n * `transformSchemaObjectWithComposition`). Nested schemas still get `postTransform`.\n */\nexport function transformSchemaShape(\n  schema: Schema | null | undefined,\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties = false,\n): IrType {\n  const checked = checkSchema(schema, location.path);\n  if (\"type\" in checked) {\n    return checked.type;\n  }\n  const current = request(location, context, isFromAdditionalProperties);\n  const rule = SHAPE_RULES.find((candidate) => candidate.matches(checked.schema));\n  return rule ? rule.transform(checked.schema, current) : compositionType(checked.schema, current);\n}\n\n/** Transform a schema to IR, then apply `postTransform` (the original `transformSchemaObject`). */\nexport function transformSchema(\n  schema: Schema | null | undefined,\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties = false,\n): IrType {\n  const type = transformSchemaShape(schema, location, context, isFromAdditionalProperties);\n  return context.callbacks.postTransform(type, location) ?? type;\n}\n"],"names":["OpenAPITypesafeError","ERROR_CODES","request","schemaRefType","literalType","enumRule","irKeyword","UNKNOWN_TYPE","compositionType"],"mappings":";;;;;;;;;;AAYO,MAAM,2BAA2BA,2BAAA,CAAqB;AAAA,EAC3D,WAAA,CAAY,QAAiB,IAAA,EAA0B;AACrD,IAAA,MAAM,WAAW,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,UAAU,OAAO,MAAA;AAC1D,IAAA,KAAA,CAAM;AAAA,MACJ,MAAMC,kBAAA,CAAY,qBAAA;AAAA,MAClB,OAAA,EAAS,CAAA,gCAAA,EAAmC,QAAQ,CAAA,IAAA,EAAO,IAAI,CAAA,CAAA;AAAA,MAC/D,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA;AAAS,KAC3B,CAAA;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,oBAAA;AAAA,EACd;AACF;AAGA,MAAM,WAAA,GAAqC;AAAA,EACzC;AAAA,IACE,IAAA,EAAM,MAAA;AAAA,IACN,OAAA,EAAS,CAAC,MAAA,KAAW,MAAA,IAAU,MAAA;AAAA,IAC/B,WAAW,CAAC,MAAA,EAAQC,aAAYC,yBAAA,CAAe,MAAA,CAA4B,MAAMD,QAAO;AAAA,GAC1F;AAAA,EACA;AAAA,IACE,IAAA,EAAM,OAAA;AAAA,IACN,SAAS,CAAC,MAAA,KAAW,OAAO,KAAA,KAAU,IAAA,IAAQ,OAAO,KAAA,KAAU,MAAA;AAAA,IAC/D,SAAA,EAAW,CAAC,MAAA,KAAWE,uBAAA,CAAY,OAAO,KAAK;AAAA,GACjD;AAAA,EACAC;AACF,CAAA;AAMA,SAAS,WAAA,CAAY,QAAiB,IAAA,EAAyC;AAC7E,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,EAAE,IAAA,EAAMC,sBAAA,CAAU,OAAO,CAAA,EAAE;AAAA,EACpC;AACA,EAAA,IAAI,WAAW,IAAA,EAAM;AACnB,IAAA,OAAO,EAAE,MAAMC,wBAAA,EAAa;AAAA,EAC9B;AACA,EAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,WAAW,QAAA,EAAU;AACvD,IAAA,MAAM,IAAI,kBAAA,CAAmB,MAAA,EAAQ,IAAI,CAAA;AAAA,EAC3C;AACA,EAAA,OAAO,EAAE,MAAA,EAA+B;AAC1C;AAEA,SAAS,OAAA,CACP,QAAA,EACA,OAAA,EACA,0BAAA,EACe;AACf,EAAA,OAAO;AAAA,IACL,QAAA;AAAA,IACA,OAAA;AAAA,IACA,0BAAA;AAAA,IACA,eAAA,EAAiB,CAAC,MAAA,EAAQ,cAAA,EAAgB,gCAAA,GAAmC,UAC3E,eAAA,CAAgB,MAAA,EAAQ,cAAA,EAAgB,OAAA,EAAS,gCAAgC;AAAA,GACrF;AACF;AAMO,SAAS,oBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACA,6BAA6B,KAAA,EACrB;AACR,EAAA,MAAM,OAAA,GAAU,WAAA,CAAY,MAAA,EAAQ,QAAA,CAAS,IAAI,CAAA;AACjD,EAAA,IAAI,UAAU,OAAA,EAAS;AACrB,IAAA,OAAO,OAAA,CAAQ,IAAA;AAAA,EACjB;AACA,EAAA,MAAM,OAAA,GAAU,OAAA,CAAQ,QAAA,EAAU,OAAA,EAAS,0BAA0B,CAAA;AACrE,EAAA,MAAM,IAAA,GAAO,YAAY,IAAA,CAAK,CAAC,cAAc,SAAA,CAAU,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAC,CAAA;AAC9E,EAAA,OAAO,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQ,MAAA,EAAQ,OAAO,CAAA,GAAIC,+BAAA,CAAgB,OAAA,CAAQ,MAAA,EAAQ,OAAO,CAAA;AACjG;AAGO,SAAS,eAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACA,6BAA6B,KAAA,EACrB;AACR,EAAA,MAAM,IAAA,GAAO,oBAAA,CAAqB,MAAA,EAAQ,QAAA,EAAU,SAAS,0BAA0B,CAAA;AACvF,EAAA,OAAO,OAAA,CAAQ,SAAA,CAAU,aAAA,CAAc,IAAA,EAAM,QAAQ,CAAA,IAAK,IAAA;AAC5D;;;;"}

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

@@ -1,7 +1,7 @@
 import { OpenAPITypesafeError, ERROR_CODES } from '../../../domain/errors.mjs';
 import { irKeyword } from '../../../domain/ir/constructors.mjs';
 import { literalType } from '../literal-type.mjs';
-import { refType } from '../ref-type.mjs';
+import { schemaRefType } from '../ref-pointer/pointer-type.mjs';
 import { UNKNOWN_TYPE } from '../shared-types.mjs';
 import { compositionType } from './composition-type.mjs';
 import { enumRule } from './enum-rule.mjs';
@@ -21,7 +21,7 @@ const SHAPE_RULES = [
   {
     name: "$ref",
     matches: (schema) => "$ref" in schema,
-    transform: (schema) => refType(schema.$ref)
+    transform: (schema, request2) => schemaRefType(schema.$ref, request2)
   },
   {
     name: "const",

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

@@ -1 +1 @@
-{"version":3,"file":"schema-transform.mjs","sources":["../../../../src/application/transform/schema/schema-transform.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"../../../domain/errors.js\";\nimport { irKeyword } from \"../../../domain/ir/constructors.js\";\nimport type { IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { literalType } from \"../literal-type.js\";\nimport { refType } from \"../ref-type.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { compositionType } from \"./composition-type.js\";\nimport { enumRule } from \"./enum-rule.js\";\nimport type { SchemaContext, SchemaLocation } from \"./schema-context.js\";\nimport type { SchemaRequest, SchemaRule } from \"./schema-rule.js\";\n\nexport class InvalidSchemaError extends OpenAPITypesafeError {\n  constructor(schema: unknown, path: string | undefined) {\n    const received = Array.isArray(schema) ? \"Array\" : typeof schema;\n    super({\n      code: ERROR_CODES.SCHEMA_OBJECT_INVALID,\n      message: `Expected SchemaObject, received ${received} at ${path}`,\n      details: { path, received },\n    });\n    this.name = \"InvalidSchemaError\";\n  }\n}\n\n/** Shape rules in the original precedence; composition handles everything they do not match. */\nconst SHAPE_RULES: readonly SchemaRule[] = [\n  {\n    name: \"$ref\",\n    matches: (schema) => \"$ref\" in schema,\n    transform: (schema) => refType((schema as { $ref: string }).$ref),\n  },\n  {\n    name: \"const\",\n    matches: (schema) => schema.const !== null && schema.const !== undefined,\n    transform: (schema) => literalType(schema.const),\n  },\n  enumRule,\n];\n\n/** A schema checked for its input shape, or the type of a non-object schema. */\ntype CheckedSchema = { readonly type: IrType } | { readonly schema: SchemaObject };\n\n/** A missing schema is `never`; `true` allows anything; other non-objects are invalid. */\nfunction checkSchema(schema: unknown, path: string | undefined): CheckedSchema {\n  if (!schema) {\n    return { type: irKeyword(\"never\") };\n  }\n  if (schema === true) {\n    return { type: UNKNOWN_TYPE };\n  }\n  if (Array.isArray(schema) || typeof schema !== \"object\") {\n    throw new InvalidSchemaError(schema, path);\n  }\n  return { schema: schema as SchemaObject };\n}\n\nfunction request(\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties: boolean,\n): SchemaRequest {\n  return {\n    location,\n    context,\n    isFromAdditionalProperties,\n    transformNested: (schema, nestedLocation, isNestedFromAdditionalProperties = false) =>\n      transformSchema(schema, nestedLocation, context, isNestedFromAdditionalProperties),\n  };\n}\n\n/**\n * Transform a schema without the `postTransform` callback (the original\n * `transformSchemaObjectWithComposition`). Nested schemas still get `postTransform`.\n */\nexport function transformSchemaShape(\n  schema: Schema | null | undefined,\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties = false,\n): IrType {\n  const checked = checkSchema(schema, location.path);\n  if (\"type\" in checked) {\n    return checked.type;\n  }\n  const current = request(location, context, isFromAdditionalProperties);\n  const rule = SHAPE_RULES.find((candidate) => candidate.matches(checked.schema));\n  return rule ? rule.transform(checked.schema, current) : compositionType(checked.schema, current);\n}\n\n/** Transform a schema to IR, then apply `postTransform` (the original `transformSchemaObject`). */\nexport function transformSchema(\n  schema: Schema | null | undefined,\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties = false,\n): IrType {\n  const type = transformSchemaShape(schema, location, context, isFromAdditionalProperties);\n  return context.callbacks.postTransform(type, location) ?? type;\n}\n"],"names":[],"mappings":";;;;;;;;AAYO,MAAM,2BAA2B,oBAAA,CAAqB;AAAA,EAC3D,WAAA,CAAY,QAAiB,IAAA,EAA0B;AACrD,IAAA,MAAM,WAAW,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,UAAU,OAAO,MAAA;AAC1D,IAAA,KAAA,CAAM;AAAA,MACJ,MAAM,WAAA,CAAY,qBAAA;AAAA,MAClB,OAAA,EAAS,CAAA,gCAAA,EAAmC,QAAQ,CAAA,IAAA,EAAO,IAAI,CAAA,CAAA;AAAA,MAC/D,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA;AAAS,KAC3B,CAAA;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,oBAAA;AAAA,EACd;AACF;AAGA,MAAM,WAAA,GAAqC;AAAA,EACzC;AAAA,IACE,IAAA,EAAM,MAAA;AAAA,IACN,OAAA,EAAS,CAAC,MAAA,KAAW,MAAA,IAAU,MAAA;AAAA,IAC/B,SAAA,EAAW,CAAC,MAAA,KAAW,OAAA,CAAS,OAA4B,IAAI;AAAA,GAClE;AAAA,EACA;AAAA,IACE,IAAA,EAAM,OAAA;AAAA,IACN,SAAS,CAAC,MAAA,KAAW,OAAO,KAAA,KAAU,IAAA,IAAQ,OAAO,KAAA,KAAU,MAAA;AAAA,IAC/D,SAAA,EAAW,CAAC,MAAA,KAAW,WAAA,CAAY,OAAO,KAAK;AAAA,GACjD;AAAA,EACA;AACF,CAAA;AAMA,SAAS,WAAA,CAAY,QAAiB,IAAA,EAAyC;AAC7E,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,EAAE,IAAA,EAAM,SAAA,CAAU,OAAO,CAAA,EAAE;AAAA,EACpC;AACA,EAAA,IAAI,WAAW,IAAA,EAAM;AACnB,IAAA,OAAO,EAAE,MAAM,YAAA,EAAa;AAAA,EAC9B;AACA,EAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,WAAW,QAAA,EAAU;AACvD,IAAA,MAAM,IAAI,kBAAA,CAAmB,MAAA,EAAQ,IAAI,CAAA;AAAA,EAC3C;AACA,EAAA,OAAO,EAAE,MAAA,EAA+B;AAC1C;AAEA,SAAS,OAAA,CACP,QAAA,EACA,OAAA,EACA,0BAAA,EACe;AACf,EAAA,OAAO;AAAA,IACL,QAAA;AAAA,IACA,OAAA;AAAA,IACA,0BAAA;AAAA,IACA,eAAA,EAAiB,CAAC,MAAA,EAAQ,cAAA,EAAgB,gCAAA,GAAmC,UAC3E,eAAA,CAAgB,MAAA,EAAQ,cAAA,EAAgB,OAAA,EAAS,gCAAgC;AAAA,GACrF;AACF;AAMO,SAAS,oBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACA,6BAA6B,KAAA,EACrB;AACR,EAAA,MAAM,OAAA,GAAU,WAAA,CAAY,MAAA,EAAQ,QAAA,CAAS,IAAI,CAAA;AACjD,EAAA,IAAI,UAAU,OAAA,EAAS;AACrB,IAAA,OAAO,OAAA,CAAQ,IAAA;AAAA,EACjB;AACA,EAAA,MAAM,OAAA,GAAU,OAAA,CAAQ,QAAA,EAAU,OAAA,EAAS,0BAA0B,CAAA;AACrE,EAAA,MAAM,IAAA,GAAO,YAAY,IAAA,CAAK,CAAC,cAAc,SAAA,CAAU,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAC,CAAA;AAC9E,EAAA,OAAO,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQ,MAAA,EAAQ,OAAO,CAAA,GAAI,eAAA,CAAgB,OAAA,CAAQ,MAAA,EAAQ,OAAO,CAAA;AACjG;AAGO,SAAS,eAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACA,6BAA6B,KAAA,EACrB;AACR,EAAA,MAAM,IAAA,GAAO,oBAAA,CAAqB,MAAA,EAAQ,QAAA,EAAU,SAAS,0BAA0B,CAAA;AACvF,EAAA,OAAO,OAAA,CAAQ,SAAA,CAAU,aAAA,CAAc,IAAA,EAAM,QAAQ,CAAA,IAAK,IAAA;AAC5D;;"}
+{"version":3,"file":"schema-transform.mjs","sources":["../../../../src/application/transform/schema/schema-transform.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"../../../domain/errors.js\";\nimport { irKeyword } from \"../../../domain/ir/constructors.js\";\nimport type { IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { literalType } from \"../literal-type.js\";\nimport { schemaRefType } from \"../ref-pointer/pointer-type.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { compositionType } from \"./composition-type.js\";\nimport { enumRule } from \"./enum-rule.js\";\nimport type { SchemaContext, SchemaLocation } from \"./schema-context.js\";\nimport type { SchemaRequest, SchemaRule } from \"./schema-rule.js\";\n\nexport class InvalidSchemaError extends OpenAPITypesafeError {\n  constructor(schema: unknown, path: string | undefined) {\n    const received = Array.isArray(schema) ? \"Array\" : typeof schema;\n    super({\n      code: ERROR_CODES.SCHEMA_OBJECT_INVALID,\n      message: `Expected SchemaObject, received ${received} at ${path}`,\n      details: { path, received },\n    });\n    this.name = \"InvalidSchemaError\";\n  }\n}\n\n/** Shape rules in the original precedence; composition handles everything they do not match. */\nconst SHAPE_RULES: readonly SchemaRule[] = [\n  {\n    name: \"$ref\",\n    matches: (schema) => \"$ref\" in schema,\n    transform: (schema, request) => schemaRefType((schema as { $ref: string }).$ref, request),\n  },\n  {\n    name: \"const\",\n    matches: (schema) => schema.const !== null && schema.const !== undefined,\n    transform: (schema) => literalType(schema.const),\n  },\n  enumRule,\n];\n\n/** A schema checked for its input shape, or the type of a non-object schema. */\ntype CheckedSchema = { readonly type: IrType } | { readonly schema: SchemaObject };\n\n/** A missing schema is `never`; `true` allows anything; other non-objects are invalid. */\nfunction checkSchema(schema: unknown, path: string | undefined): CheckedSchema {\n  if (!schema) {\n    return { type: irKeyword(\"never\") };\n  }\n  if (schema === true) {\n    return { type: UNKNOWN_TYPE };\n  }\n  if (Array.isArray(schema) || typeof schema !== \"object\") {\n    throw new InvalidSchemaError(schema, path);\n  }\n  return { schema: schema as SchemaObject };\n}\n\nfunction request(\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties: boolean,\n): SchemaRequest {\n  return {\n    location,\n    context,\n    isFromAdditionalProperties,\n    transformNested: (schema, nestedLocation, isNestedFromAdditionalProperties = false) =>\n      transformSchema(schema, nestedLocation, context, isNestedFromAdditionalProperties),\n  };\n}\n\n/**\n * Transform a schema without the `postTransform` callback (the original\n * `transformSchemaObjectWithComposition`). Nested schemas still get `postTransform`.\n */\nexport function transformSchemaShape(\n  schema: Schema | null | undefined,\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties = false,\n): IrType {\n  const checked = checkSchema(schema, location.path);\n  if (\"type\" in checked) {\n    return checked.type;\n  }\n  const current = request(location, context, isFromAdditionalProperties);\n  const rule = SHAPE_RULES.find((candidate) => candidate.matches(checked.schema));\n  return rule ? rule.transform(checked.schema, current) : compositionType(checked.schema, current);\n}\n\n/** Transform a schema to IR, then apply `postTransform` (the original `transformSchemaObject`). */\nexport function transformSchema(\n  schema: Schema | null | undefined,\n  location: SchemaLocation,\n  context: SchemaContext,\n  isFromAdditionalProperties = false,\n): IrType {\n  const type = transformSchemaShape(schema, location, context, isFromAdditionalProperties);\n  return context.callbacks.postTransform(type, location) ?? type;\n}\n"],"names":["request"],"mappings":";;;;;;;;AAYO,MAAM,2BAA2B,oBAAA,CAAqB;AAAA,EAC3D,WAAA,CAAY,QAAiB,IAAA,EAA0B;AACrD,IAAA,MAAM,WAAW,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,GAAI,UAAU,OAAO,MAAA;AAC1D,IAAA,KAAA,CAAM;AAAA,MACJ,MAAM,WAAA,CAAY,qBAAA;AAAA,MAClB,OAAA,EAAS,CAAA,gCAAA,EAAmC,QAAQ,CAAA,IAAA,EAAO,IAAI,CAAA,CAAA;AAAA,MAC/D,OAAA,EAAS,EAAE,IAAA,EAAM,QAAA;AAAS,KAC3B,CAAA;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,oBAAA;AAAA,EACd;AACF;AAGA,MAAM,WAAA,GAAqC;AAAA,EACzC;AAAA,IACE,IAAA,EAAM,MAAA;AAAA,IACN,OAAA,EAAS,CAAC,MAAA,KAAW,MAAA,IAAU,MAAA;AAAA,IAC/B,WAAW,CAAC,MAAA,EAAQA,aAAY,aAAA,CAAe,MAAA,CAA4B,MAAMA,QAAO;AAAA,GAC1F;AAAA,EACA;AAAA,IACE,IAAA,EAAM,OAAA;AAAA,IACN,SAAS,CAAC,MAAA,KAAW,OAAO,KAAA,KAAU,IAAA,IAAQ,OAAO,KAAA,KAAU,MAAA;AAAA,IAC/D,SAAA,EAAW,CAAC,MAAA,KAAW,WAAA,CAAY,OAAO,KAAK;AAAA,GACjD;AAAA,EACA;AACF,CAAA;AAMA,SAAS,WAAA,CAAY,QAAiB,IAAA,EAAyC;AAC7E,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,OAAO,EAAE,IAAA,EAAM,SAAA,CAAU,OAAO,CAAA,EAAE;AAAA,EACpC;AACA,EAAA,IAAI,WAAW,IAAA,EAAM;AACnB,IAAA,OAAO,EAAE,MAAM,YAAA,EAAa;AAAA,EAC9B;AACA,EAAA,IAAI,MAAM,OAAA,CAAQ,MAAM,CAAA,IAAK,OAAO,WAAW,QAAA,EAAU;AACvD,IAAA,MAAM,IAAI,kBAAA,CAAmB,MAAA,EAAQ,IAAI,CAAA;AAAA,EAC3C;AACA,EAAA,OAAO,EAAE,MAAA,EAA+B;AAC1C;AAEA,SAAS,OAAA,CACP,QAAA,EACA,OAAA,EACA,0BAAA,EACe;AACf,EAAA,OAAO;AAAA,IACL,QAAA;AAAA,IACA,OAAA;AAAA,IACA,0BAAA;AAAA,IACA,eAAA,EAAiB,CAAC,MAAA,EAAQ,cAAA,EAAgB,gCAAA,GAAmC,UAC3E,eAAA,CAAgB,MAAA,EAAQ,cAAA,EAAgB,OAAA,EAAS,gCAAgC;AAAA,GACrF;AACF;AAMO,SAAS,oBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACA,6BAA6B,KAAA,EACrB;AACR,EAAA,MAAM,OAAA,GAAU,WAAA,CAAY,MAAA,EAAQ,QAAA,CAAS,IAAI,CAAA;AACjD,EAAA,IAAI,UAAU,OAAA,EAAS;AACrB,IAAA,OAAO,OAAA,CAAQ,IAAA;AAAA,EACjB;AACA,EAAA,MAAM,OAAA,GAAU,OAAA,CAAQ,QAAA,EAAU,OAAA,EAAS,0BAA0B,CAAA;AACrE,EAAA,MAAM,IAAA,GAAO,YAAY,IAAA,CAAK,CAAC,cAAc,SAAA,CAAU,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAC,CAAA;AAC9E,EAAA,OAAO,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQ,MAAA,EAAQ,OAAO,CAAA,GAAI,eAAA,CAAgB,OAAA,CAAQ,MAAA,EAAQ,OAAO,CAAA;AACjG;AAGO,SAAS,eAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACA,6BAA6B,KAAA,EACrB;AACR,EAAA,MAAM,IAAA,GAAO,oBAAA,CAAqB,MAAA,EAAQ,QAAA,EAAU,SAAS,0BAA0B,CAAA;AACvF,EAAA,OAAO,OAAA,CAAQ,SAAA,CAAU,aAAA,CAAc,IAAA,EAAM,QAAQ,CAAA,IAAK,IAAA;AAC5D;;"}

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

@@ -1,11 +1,22 @@
 'use strict';
 
+const outputFixes = require('../../domain/output-fixes.cjs');
+
 const LINE_BREAK_RE = /\r?\n/g;
 const CONTINUATION = "\n *     ";
 const COMMENT_END_RE = /\*\//g;
 const VALUE_TAGS = ["description", "default", "example"];
 const TAGS_KEEPING_EMPTY_STRING = /* @__PURE__ */ new Set(["default", "example"]);
 const JSON_INDENT = 2;
+const MEMBER_LISTS = [
+  ["anyOf", "Any of:"],
+  ["oneOf", "One of:"]
+];
+const BULLET_CONTINUATION = "\n  ";
+const ORIGINAL_SCHEMA_COMMENT = { hasMemberDescriptions: false };
+function schemaCommentOptionsOf(fixes) {
+  return { hasMemberDescriptions: fixes.has(outputFixes.OutputFix.ANYOF_ONEOF_DESCRIPTIONS) };
+}
 function formatValue(value) {
   const text = typeof value === "object" ? JSON.stringify(value, null, JSON_INDENT) : value;
   return String(text).trim().replace(LINE_BREAK_RE, CONTINUATION);
@@ -55,11 +66,44 @@ function constantAndEnumLines(schema) {
   }
   return lines;
 }
-function schemaComment(schema) {
-  if (!schema || typeof schema !== "object" || Array.isArray(schema)) {
+function memberDescriptions(members) {
+  if (!Array.isArray(members)) {
+    return [];
+  }
+  return members.flatMap((member) => {
+    const description = isSchemaObject(member) ? member.description : void 0;
+    return typeof description === "string" && description.trim() !== "" ? [description.trim()] : [];
+  });
+}
+function memberDescriptionLists(schema) {
+  return MEMBER_LISTS.flatMap(([keyword, heading]) => {
+    const descriptions = memberDescriptions(schema[keyword]);
+    if (descriptions.length === 0) {
+      return [];
+    }
+    const bullets = descriptions.map(
+      (description) => `- ${description.replace(LINE_BREAK_RE, BULLET_CONTINUATION)}`
+    );
+    return [[heading, ...bullets].join("\n")];
+  });
+}
+function withMemberDescriptions(schema) {
+  const lists = memberDescriptionLists(schema);
+  const own = schema.description;
+  if (lists.length === 0 || own !== void 0 && typeof own !== "string") {
+    return schema;
+  }
+  const ownLines = typeof own === "string" && own.trim() !== "" ? [own.trim()] : [];
+  return { ...schema, description: [...ownLines, ...lists].join("\n") };
+}
+function isSchemaObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function schemaComment(schema, options = ORIGINAL_SCHEMA_COMMENT) {
+  if (!isSchemaObject(schema)) {
     return null;
   }
-  const annotated = schema;
+  const annotated = options.hasMemberDescriptions ? withMemberDescriptions(schema) : schema;
   const lines = [
     ...plainLines(annotated),
     ...valueTagLines(annotated),
@@ -74,11 +118,13 @@ function schemaComment(schema) {
  `;
   return { kind: "block", text: text.replace(COMMENT_END_RE, "*\\/") };
 }
-function withSchemaComment(property, schema) {
-  const comment = schemaComment(schema);
+function withSchemaComment(property, schema, options = ORIGINAL_SCHEMA_COMMENT) {
+  const comment = schemaComment(schema, options);
   return comment === null ? property : { ...property, comments: [...property.comments, comment] };
 }
 
+exports.ORIGINAL_SCHEMA_COMMENT = ORIGINAL_SCHEMA_COMMENT;
 exports.schemaComment = schemaComment;
+exports.schemaCommentOptionsOf = schemaCommentOptionsOf;
 exports.withSchemaComment = withSchemaComment;
 //# sourceMappingURL=schema-comment.cjs.map

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\";\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\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/**\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(schema: unknown): IrComment | null {\n  if (!schema || typeof schema !== \"object\" || Array.isArray(schema)) {\n    return null;\n  }\n  const annotated = 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): IrPropertySignature {\n  const comment = schemaComment(schema);\n  return comment === null ? property : { ...property, comments: [...property.comments, comment] };\n}\n"],"names":[],"mappings":";;AAkBA,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,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;AAQO,SAAS,cAAc,MAAA,EAAmC;AAC/D,EAAA,IAAI,CAAC,UAAU,OAAO,MAAA,KAAW,YAAY,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AAClE,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,MAAA;AAClB,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,UACA,MAAA,EACqB;AACrB,EAAA,MAAM,OAAA,GAAU,cAAc,MAAM,CAAA;AACpC,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 type { IrComment, IrPropertySignature } from \"../../domain/ir/nodes.js\";\nimport { 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(OutputFix.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":["OutputFix"],"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,qBAAA,CAAU,wBAAwB,CAAA,EAAE;AAChF;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;;;;;"}

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

@@ -1,9 +1,20 @@
+import { OutputFix } from '../../domain/output-fixes.mjs';
+
 const LINE_BREAK_RE = /\r?\n/g;
 const CONTINUATION = "\n *     ";
 const COMMENT_END_RE = /\*\//g;
 const VALUE_TAGS = ["description", "default", "example"];
 const TAGS_KEEPING_EMPTY_STRING = /* @__PURE__ */ new Set(["default", "example"]);
 const JSON_INDENT = 2;
+const MEMBER_LISTS = [
+  ["anyOf", "Any of:"],
+  ["oneOf", "One of:"]
+];
+const BULLET_CONTINUATION = "\n  ";
+const ORIGINAL_SCHEMA_COMMENT = { hasMemberDescriptions: false };
+function schemaCommentOptionsOf(fixes) {
+  return { hasMemberDescriptions: fixes.has(OutputFix.ANYOF_ONEOF_DESCRIPTIONS) };
+}
 function formatValue(value) {
   const text = typeof value === "object" ? JSON.stringify(value, null, JSON_INDENT) : value;
   return String(text).trim().replace(LINE_BREAK_RE, CONTINUATION);
@@ -53,11 +64,44 @@ function constantAndEnumLines(schema) {
   }
   return lines;
 }
-function schemaComment(schema) {
-  if (!schema || typeof schema !== "object" || Array.isArray(schema)) {
+function memberDescriptions(members) {
+  if (!Array.isArray(members)) {
+    return [];
+  }
+  return members.flatMap((member) => {
+    const description = isSchemaObject(member) ? member.description : void 0;
+    return typeof description === "string" && description.trim() !== "" ? [description.trim()] : [];
+  });
+}
+function memberDescriptionLists(schema) {
+  return MEMBER_LISTS.flatMap(([keyword, heading]) => {
+    const descriptions = memberDescriptions(schema[keyword]);
+    if (descriptions.length === 0) {
+      return [];
+    }
+    const bullets = descriptions.map(
+      (description) => `- ${description.replace(LINE_BREAK_RE, BULLET_CONTINUATION)}`
+    );
+    return [[heading, ...bullets].join("\n")];
+  });
+}
+function withMemberDescriptions(schema) {
+  const lists = memberDescriptionLists(schema);
+  const own = schema.description;
+  if (lists.length === 0 || own !== void 0 && typeof own !== "string") {
+    return schema;
+  }
+  const ownLines = typeof own === "string" && own.trim() !== "" ? [own.trim()] : [];
+  return { ...schema, description: [...ownLines, ...lists].join("\n") };
+}
+function isSchemaObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function schemaComment(schema, options = ORIGINAL_SCHEMA_COMMENT) {
+  if (!isSchemaObject(schema)) {
     return null;
   }
-  const annotated = schema;
+  const annotated = options.hasMemberDescriptions ? withMemberDescriptions(schema) : schema;
   const lines = [
     ...plainLines(annotated),
     ...valueTagLines(annotated),
@@ -72,10 +116,10 @@ function schemaComment(schema) {
  `;
   return { kind: "block", text: text.replace(COMMENT_END_RE, "*\\/") };
 }
-function withSchemaComment(property, schema) {
-  const comment = schemaComment(schema);
+function withSchemaComment(property, schema, options = ORIGINAL_SCHEMA_COMMENT) {
+  const comment = schemaComment(schema, options);
   return comment === null ? property : { ...property, comments: [...property.comments, comment] };
 }
 
-export { schemaComment, withSchemaComment };
+export { ORIGINAL_SCHEMA_COMMENT, schemaComment, schemaCommentOptionsOf, withSchemaComment };
 //# sourceMappingURL=schema-comment.mjs.map

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\";\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\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/**\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(schema: unknown): IrComment | null {\n  if (!schema || typeof schema !== \"object\" || Array.isArray(schema)) {\n    return null;\n  }\n  const annotated = 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): IrPropertySignature {\n  const comment = schemaComment(schema);\n  return comment === null ? property : { ...property, comments: [...property.comments, comment] };\n}\n"],"names":[],"mappings":"AAkBA,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,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;AAQO,SAAS,cAAc,MAAA,EAAmC;AAC/D,EAAA,IAAI,CAAC,UAAU,OAAO,MAAA,KAAW,YAAY,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AAClE,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,SAAA,GAAY,MAAA;AAClB,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,UACA,MAAA,EACqB;AACrB,EAAA,MAAM,OAAA,GAAU,cAAc,MAAM,CAAA;AACpC,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 type { IrComment, IrPropertySignature } from \"../../domain/ir/nodes.js\";\nimport { 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(OutputFix.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,SAAA,CAAU,wBAAwB,CAAA,EAAE;AAChF;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;;"}

package/dist/application/transform/type-combinators.mjs

@@ -1,4 +1,4 @@
-import { irUnion, irKeyword, irIntersection, irReference } from '../../domain/ir/constructors.mjs';
+import { irKeyword, irUnion, irIntersection, irReference } from '../../domain/ir/constructors.mjs';
 import { dedupeTypes } from '../../domain/ir/normalize.mjs';
 import { literalType } from './literal-type.mjs';