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

package/dist/domain/output-fixes.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"output-fixes.cjs","sources":["../../src/domain/output-fixes.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"./errors.js\";\n\n/**\n * Opt-in fixes of the output of valid schemas (ADR-021). Each one changes only the cases it names;\n * without any, the output is the same as openapi-typescript 7.13 gives. In 2.0 they become the\n * default. The object names the fixes for this package's code; the public API is the `OutputFix`\n * union and the `OUTPUT_FIXES` list (ADR-021, amendment 1).\n */\nexport const FIX = {\n  /** An `allOf` `$ref` to a discriminated union is the union, without `Omit` or a schema name. */\n  ALLOF_DISCRIMINATED_UNION: \"allof-discriminated-union\",\n  /** An `allOf` member with only `required` makes those properties of the others required. */\n  ALLOF_REQUIRED: \"allof-required\",\n  /** The JSDoc of a schema lists the descriptions of its `anyOf` and `oneOf` members. */\n  ANYOF_ONEOF_DESCRIPTIONS: \"anyof-oneof-descriptions\",\n  /** `anyOf` / `oneOf` variants with only `required` make those keys of the parent required. */\n  ANYOF_ONEOF_REQUIRED: \"anyof-oneof-required\",\n  /** `anyOf` next to object keywords or `allOf` is intersected with them, not added to a union. */\n  ANYOF_PROPERTIES: \"anyof-properties\",\n  /** `--array-length` tuples have `min` to `max` items, nest right and follow `--immutable`. */\n  ARRAY_LENGTH_TUPLES: \"array-length-tuples\",\n  /** `--dedupe-enums` names a shared enum by all of its schemas, not by the first one. */\n  DEDUPE_ENUM_NAMES: \"dedupe-enum-names\",\n  /** `required` next to an `allOf` `$ref` to a discriminator member still gives `WithRequired`. */\n  DISCRIMINATOR_MEMBER_REQUIRED: \"discriminator-member-required\",\n  /**\n   * The value a discriminator member gets: one enum of every discriminator's values, a mapping\n   * before the schema name, a schema's own mapping before an inherited one, none where the member\n   * declares it, and with `--enum` a member of the owner's enum.\n   */\n  DISCRIMINATOR_VALUES: \"discriminator-values\",\n  /** An exploded object query parameter's properties are keys of `query`, as they are sent. */\n  EXPLODED_QUERY_OBJECTS: \"exploded-query-objects\",\n  /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */\n  NULLABLE_ENUMS: \"nullable-enums\",\n  /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */\n  PATH_PARAM_TYPE_NAMES: \"path-param-type-names\",\n  /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */\n  PREFIX_ITEMS: \"prefix-items\",\n  /** `readOnly` and `writeOnly` of the schema a `$ref` names, or of `allOf` members, count. */\n  READ_WRITE_REFS: \"read-write-refs\",\n  /**\n   * A `$ref` into schema keywords (`content/<type>/schema`, `items`, `allOf/0`) gets the type it\n   * points at, also where the original type compiles through an index signature.\n   */\n  REF_POINTERS: \"ref-pointers\",\n  /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */\n  ROOT_TYPE_NUMBERING: \"root-type-numbering\",\n  /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */\n  UNEVALUATED_PROPERTIES: \"unevaluated-properties\",\n} as const;\n/** The name of one opt-in output fix. */\nexport type OutputFix = (typeof FIX)[keyof typeof FIX];\n\n/** Every fix of this version, in the order the docs list them. */\nexport const OUTPUT_FIXES: readonly OutputFix[] = Object.values(FIX);\n\n/** The name that turns on every fix of the installed version. */\nconst ALL_FIXES = \"all\";\n\n/** A name the `fix` option accepts: one fix, or `\"all\"`. */\nexport type OutputFixName = OutputFix | typeof ALL_FIXES;\n\nconst KNOWN_NAMES: ReadonlySet<string> = new Set<string>([...OUTPUT_FIXES, ALL_FIXES]);\n\nfunction isOutputFixName(value: unknown): value is OutputFixName {\n  return typeof value === \"string\" && KNOWN_NAMES.has(value);\n}\n\n/** The fix names as given; fails with `OPTION_FIX_UNKNOWN` for any other value. */\nexport function outputFixNamesOf(values: readonly unknown[]): readonly OutputFixName[] {\n  const unknown = values.filter((value) => !isOutputFixName(value));\n  if (unknown.length > 0) {\n    const names = unknown.map((value) => JSON.stringify(value)).join(\", \");\n    const known = [...KNOWN_NAMES].join(\", \");\n    throw new OpenAPITypesafeError({\n      code: ERROR_CODES.OPTION_FIX_UNKNOWN,\n      message: `Unknown fix ${names}. Known fixes: ${known}.`,\n      details: { unknown, known: [...KNOWN_NAMES] },\n    });\n  }\n  return values as readonly OutputFixName[];\n}\n\n/** The fixes the names turn on; `all` stands for every fix of this version. */\nexport function resolveOutputFixes(names: readonly OutputFixName[]): ReadonlySet<OutputFix> {\n  return new Set(names.flatMap((name) => (name === ALL_FIXES ? OUTPUT_FIXES : [name])));\n}\n\n/** A generator option that a fix works with; without it, the fix changes nothing (ADR-021). */\nexport interface OutputFixRequirement {\n  readonly option:\n    | \"arrayLength\"\n    | \"dedupeEnums\"\n    | \"enum\"\n    | \"pathParamsAsTypes\"\n    | \"rootTypes\"\n    | \"rootTypesNoSchemaPrefix\";\n  readonly flag: string;\n}\n\nconst ROOT_TYPES = { option: \"rootTypes\", flag: \"--root-types\" } as const;\nconst ENUM = { option: \"enum\", flag: \"--enum\" } as const;\nconst NO_SCHEMA_PREFIX = {\n  option: \"rootTypesNoSchemaPrefix\",\n  flag: \"--root-types-no-schema-prefix\",\n} as const;\n\n/** The options each fix needs, by fix name; `all` has none. */\nconst REQUIREMENTS: Readonly<Partial<Record<OutputFixName, readonly OutputFixRequirement[]>>> = {\n  [FIX.ARRAY_LENGTH_TUPLES]: [{ option: \"arrayLength\", flag: \"--array-length\" }],\n  [FIX.DEDUPE_ENUM_NAMES]: [ENUM, { option: \"dedupeEnums\", flag: \"--dedupe-enums\" }],\n  [FIX.NULLABLE_ENUMS]: [ENUM],\n  [FIX.PATH_PARAM_TYPE_NAMES]: [{ option: \"pathParamsAsTypes\", flag: \"--path-params-as-types\" }],\n  [FIX.ROOT_TYPE_NUMBERING]: [ROOT_TYPES, NO_SCHEMA_PREFIX],\n};\n\nfunction describeRequirement(requirement: OutputFixRequirement): string {\n  return `${requirement.option} (${requirement.flag})`;\n}\n\n/**\n * A notice for each fix given by name with an option it needs off; it names the options that are\n * off. `all` adds none: it means every fix that applies, so one that does not apply is expected.\n */\nexport function ineffectiveFixNotices(\n  names: readonly OutputFixName[],\n  isOptionOn: (option: OutputFixRequirement[\"option\"]) => boolean,\n): string[] {\n  return [...new Set(names)].flatMap((name) => {\n    const missing = (REQUIREMENTS[name] ?? []).filter(({ option }) => !isOptionOn(option));\n    return missing.length === 0\n      ? []\n      : [`Fix \"${name}\" has no effect without ${missing.map(describeRequirement).join(\" and \")}`];\n  });\n}\n"],"names":["OpenAPITypesafeError","ERROR_CODES"],"mappings":";;;;AAQO,MAAM,GAAA,GAAM;AAAA;AAAA,EAEjB,yBAAA,EAA2B,2BAAA;AAAA;AAAA,EAE3B,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,wBAAA,EAA0B,0BAAA;AAAA;AAAA,EAE1B,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,gBAAA,EAAkB,kBAAA;AAAA;AAAA,EAElB,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,iBAAA,EAAmB,mBAAA;AAAA;AAAA,EAEnB,6BAAA,EAA+B,+BAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,sBAAA,EAAwB,wBAAA;AAAA;AAAA,EAExB,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,qBAAA,EAAuB,uBAAA;AAAA;AAAA,EAEvB,YAAA,EAAc,cAAA;AAAA;AAAA,EAEd,eAAA,EAAiB,iBAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjB,YAAA,EAAc,cAAA;AAAA;AAAA,EAEd,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,sBAAA,EAAwB;AAC1B;AAKO,MAAM,YAAA,GAAqC,MAAA,CAAO,MAAA,CAAO,GAAG;AAGnE,MAAM,SAAA,GAAY,KAAA;AAKlB,MAAM,8BAAmC,IAAI,GAAA,CAAY,CAAC,GAAG,YAAA,EAAc,SAAS,CAAC,CAAA;AAErF,SAAS,gBAAgB,KAAA,EAAwC;AAC/D,EAAA,OAAO,OAAO,KAAA,KAAU,QAAA,IAAY,WAAA,CAAY,IAAI,KAAK,CAAA;AAC3D;AAGO,SAAS,iBAAiB,MAAA,EAAsD;AACrF,EAAA,MAAM,OAAA,GAAU,OAAO,MAAA,CAAO,CAAC,UAAU,CAAC,eAAA,CAAgB,KAAK,CAAC,CAAA;AAChE,EAAA,IAAI,OAAA,CAAQ,SAAS,CAAA,EAAG;AACtB,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,GAAA,CAAI,CAAC,KAAA,KAAU,IAAA,CAAK,SAAA,CAAU,KAAK,CAAC,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AACrE,IAAA,MAAM,QAAQ,CAAC,GAAG,WAAW,CAAA,CAAE,KAAK,IAAI,CAAA;AACxC,IAAA,MAAM,IAAIA,2BAAA,CAAqB;AAAA,MAC7B,MAAMC,kBAAA,CAAY,kBAAA;AAAA,MAClB,OAAA,EAAS,CAAA,YAAA,EAAe,KAAK,CAAA,eAAA,EAAkB,KAAK,CAAA,CAAA,CAAA;AAAA,MACpD,SAAS,EAAE,OAAA,EAAS,OAAO,CAAC,GAAG,WAAW,CAAA;AAAE,KAC7C,CAAA;AAAA,EACH;AACA,EAAA,OAAO,MAAA;AACT;AAGO,SAAS,mBAAmB,KAAA,EAAyD;AAC1F,EAAA,OAAO,IAAI,GAAA,CAAI,KAAA,CAAM,OAAA,CAAQ,CAAC,IAAA,KAAU,IAAA,KAAS,SAAA,GAAY,YAAA,GAAe,CAAC,IAAI,CAAE,CAAC,CAAA;AACtF;AAcA,MAAM,UAAA,GAAa,EAAE,MAAA,EAAQ,WAAA,EAAa,MAAM,cAAA,EAAe;AAC/D,MAAM,IAAA,GAAO,EAAE,MAAA,EAAQ,MAAA,EAAQ,MAAM,QAAA,EAAS;AAC9C,MAAM,gBAAA,GAAmB;AAAA,EACvB,MAAA,EAAQ,yBAAA;AAAA,EACR,IAAA,EAAM;AACR,CAAA;AAGA,MAAM,YAAA,GAA0F;AAAA,EAC9F,CAAC,GAAA,CAAI,mBAAmB,GAAG,CAAC,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EAC7E,CAAC,GAAA,CAAI,iBAAiB,GAAG,CAAC,IAAA,EAAM,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EACjF,CAAC,GAAA,CAAI,cAAc,GAAG,CAAC,IAAI,CAAA;AAAA,EAC3B,CAAC,GAAA,CAAI,qBAAqB,GAAG,CAAC,EAAE,MAAA,EAAQ,mBAAA,EAAqB,IAAA,EAAM,wBAAA,EAA0B,CAAA;AAAA,EAC7F,CAAC,GAAA,CAAI,mBAAmB,GAAG,CAAC,YAAY,gBAAgB;AAC1D,CAAA;AAEA,SAAS,oBAAoB,WAAA,EAA2C;AACtE,EAAA,OAAO,CAAA,EAAG,WAAA,CAAY,MAAM,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AACnD;AAMO,SAAS,qBAAA,CACd,OACA,UAAA,EACU;AACV,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,KAAK,CAAC,CAAA,CAAE,OAAA,CAAQ,CAAC,IAAA,KAAS;AAC3C,IAAA,MAAM,OAAA,GAAA,CAAW,YAAA,CAAa,IAAI,CAAA,IAAK,EAAC,EAAG,MAAA,CAAO,CAAC,EAAE,MAAA,EAAO,KAAM,CAAC,UAAA,CAAW,MAAM,CAAC,CAAA;AACrF,IAAA,OAAO,QAAQ,MAAA,KAAW,CAAA,GACtB,EAAC,GACD,CAAC,CAAA,KAAA,EAAQ,IAAI,CAAA,wBAAA,EAA2B,OAAA,CAAQ,IAAI,mBAAmB,CAAA,CAAE,IAAA,CAAK,OAAO,CAAC,CAAA,CAAE,CAAA;AAAA,EAC9F,CAAC,CAAA;AACH;;;;;;"}
+{"version":3,"file":"output-fixes.cjs","sources":["../../src/domain/output-fixes.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"./errors.js\";\n\n/**\n * Opt-in fixes of the output of valid schemas (ADR-021). Each one changes only the cases it names;\n * without any, the output is the same as openapi-typescript 7.13 gives. In 2.0 they become the\n * default. The object names the fixes for this package's code; the public API is the `OutputFix`\n * union and the `OUTPUT_FIXES` list (ADR-021, amendment 1).\n */\nexport const FIX = {\n  /** An `allOf` `$ref` to a discriminated union is the union, without `Omit` or a schema name. */\n  ALLOF_DISCRIMINATED_UNION: \"allof-discriminated-union\",\n  /** An `allOf` member with only `required` makes those properties of the others required. */\n  ALLOF_REQUIRED: \"allof-required\",\n  /** The JSDoc of a schema lists the descriptions of its `anyOf` and `oneOf` members. */\n  ANYOF_ONEOF_DESCRIPTIONS: \"anyof-oneof-descriptions\",\n  /** `anyOf` / `oneOf` variants with only `required` make those keys of the parent required. */\n  ANYOF_ONEOF_REQUIRED: \"anyof-oneof-required\",\n  /** `anyOf` next to object keywords or `allOf` is intersected with them, not added to a union. */\n  ANYOF_PROPERTIES: \"anyof-properties\",\n  /** `--array-length` tuples have `min` to `max` items, nest right and follow `--immutable`. */\n  ARRAY_LENGTH_TUPLES: \"array-length-tuples\",\n  /** `--dedupe-enums` names a shared enum by all of its schemas, not by the first one. */\n  DEDUPE_ENUM_NAMES: \"dedupe-enum-names\",\n  /** `required` next to an `allOf` `$ref` to a discriminator member still gives `WithRequired`. */\n  DISCRIMINATOR_MEMBER_REQUIRED: \"discriminator-member-required\",\n  /**\n   * The value a discriminator member gets: one enum of every discriminator's values, a mapping\n   * before the schema name, a schema's own mapping before an inherited one, none where the member\n   * declares it, and with `--enum` a member of the owner's enum.\n   */\n  DISCRIMINATOR_VALUES: \"discriminator-values\",\n  /** An exploded object query parameter's properties are keys of `query`, as they are sent. */\n  EXPLODED_QUERY_OBJECTS: \"exploded-query-objects\",\n  /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */\n  NULLABLE_ENUMS: \"nullable-enums\",\n  /** A parameter with `content` instead of `schema` is typed by the schema of its media type. */\n  PARAMETER_CONTENT: \"parameter-content\",\n  /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */\n  PATH_PARAM_TYPE_NAMES: \"path-param-type-names\",\n  /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */\n  PREFIX_ITEMS: \"prefix-items\",\n  /** `readOnly` and `writeOnly` of the schema a `$ref` names, or of `allOf` members, count. */\n  READ_WRITE_REFS: \"read-write-refs\",\n  /**\n   * A `$ref` into schema keywords (`content/<type>/schema`, `items`, `allOf/0`) gets the type it\n   * points at, also where the original type compiles through an index signature.\n   */\n  REF_POINTERS: \"ref-pointers\",\n  /**\n   * OpenAPI 3.1 and 3.2: keywords next to a `$ref` (`required`, `properties`) apply too, so the\n   * type is the reference intersected with them. OpenAPI 3.0 ignores them, as its spec says.\n   */\n  REF_SIBLINGS: \"ref-siblings\",\n  /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */\n  ROOT_TYPE_NUMBERING: \"root-type-numbering\",\n  /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */\n  UNEVALUATED_PROPERTIES: \"unevaluated-properties\",\n} as const;\n/** The name of one opt-in output fix. */\nexport type OutputFix = (typeof FIX)[keyof typeof FIX];\n\n/** Every fix of this version, in the order the docs list them. */\nexport const OUTPUT_FIXES: readonly OutputFix[] = Object.values(FIX);\n\n/** The name that turns on every fix of the installed version. */\nconst ALL_FIXES = \"all\";\n\n/** A name the `fix` option accepts: one fix, or `\"all\"`. */\nexport type OutputFixName = OutputFix | typeof ALL_FIXES;\n\nconst KNOWN_NAMES: ReadonlySet<string> = new Set<string>([...OUTPUT_FIXES, ALL_FIXES]);\n\nfunction isOutputFixName(value: unknown): value is OutputFixName {\n  return typeof value === \"string\" && KNOWN_NAMES.has(value);\n}\n\n/**\n * The fix names as given; fails with `OPTION_FIX_UNKNOWN` for any other value, and for a `fix`\n * option that is no list (`fix: \"all\"` from JavaScript), which must not be read letter by letter.\n */\nexport function outputFixNamesOf(values: unknown): readonly OutputFixName[] {\n  if (!Array.isArray(values)) {\n    throw new OpenAPITypesafeError({\n      code: ERROR_CODES.OPTION_FIX_UNKNOWN,\n      message:\n        'The fix option must be a list of fix names, such as [\"all\"]. ' +\n        `Got ${JSON.stringify(values)}.`,\n      details: { unknown: [values], known: [...KNOWN_NAMES] },\n    });\n  }\n  const unknown = values.filter((value) => !isOutputFixName(value));\n  if (unknown.length > 0) {\n    const names = unknown.map((value) => JSON.stringify(value)).join(\", \");\n    const known = [...KNOWN_NAMES].join(\", \");\n    throw new OpenAPITypesafeError({\n      code: ERROR_CODES.OPTION_FIX_UNKNOWN,\n      message: `Unknown fix ${names}. Known fixes: ${known}.`,\n      details: { unknown, known: [...KNOWN_NAMES] },\n    });\n  }\n  return values as readonly OutputFixName[];\n}\n\n/** The fixes the names turn on; `all` stands for every fix of this version. */\nexport function resolveOutputFixes(names: readonly OutputFixName[]): ReadonlySet<OutputFix> {\n  return new Set(names.flatMap((name) => (name === ALL_FIXES ? OUTPUT_FIXES : [name])));\n}\n\n/** A generator option that a fix works with; without it, the fix changes nothing (ADR-021). */\nexport interface OutputFixRequirement {\n  readonly option:\n    | \"arrayLength\"\n    | \"dedupeEnums\"\n    | \"enum\"\n    | \"pathParamsAsTypes\"\n    | \"rootTypes\"\n    | \"rootTypesNoSchemaPrefix\";\n  readonly flag: string;\n}\n\nconst ROOT_TYPES = { option: \"rootTypes\", flag: \"--root-types\" } as const;\nconst ENUM = { option: \"enum\", flag: \"--enum\" } as const;\nconst NO_SCHEMA_PREFIX = {\n  option: \"rootTypesNoSchemaPrefix\",\n  flag: \"--root-types-no-schema-prefix\",\n} as const;\n\n/** The options each fix needs, by fix name; `all` has none. */\nconst REQUIREMENTS: Readonly<Partial<Record<OutputFixName, readonly OutputFixRequirement[]>>> = {\n  [FIX.ARRAY_LENGTH_TUPLES]: [{ option: \"arrayLength\", flag: \"--array-length\" }],\n  [FIX.DEDUPE_ENUM_NAMES]: [ENUM, { option: \"dedupeEnums\", flag: \"--dedupe-enums\" }],\n  [FIX.NULLABLE_ENUMS]: [ENUM],\n  [FIX.PATH_PARAM_TYPE_NAMES]: [{ option: \"pathParamsAsTypes\", flag: \"--path-params-as-types\" }],\n  [FIX.ROOT_TYPE_NUMBERING]: [ROOT_TYPES, NO_SCHEMA_PREFIX],\n};\n\nfunction describeRequirement(requirement: OutputFixRequirement): string {\n  return `${requirement.option} (${requirement.flag})`;\n}\n\n/**\n * A notice for each fix given by name with an option it needs off; it names the options that are\n * off. `all` adds none: it means every fix that applies, so one that does not apply is expected.\n */\nexport function ineffectiveFixNotices(\n  names: readonly OutputFixName[],\n  isOptionOn: (option: OutputFixRequirement[\"option\"]) => boolean,\n): string[] {\n  return [...new Set(names)].flatMap((name) => {\n    const missing = (REQUIREMENTS[name] ?? []).filter(({ option }) => !isOptionOn(option));\n    return missing.length === 0\n      ? []\n      : [`Fix \"${name}\" has no effect without ${missing.map(describeRequirement).join(\" and \")}`];\n  });\n}\n"],"names":["OpenAPITypesafeError","ERROR_CODES"],"mappings":";;;;AAQO,MAAM,GAAA,GAAM;AAAA;AAAA,EAEjB,yBAAA,EAA2B,2BAAA;AAAA;AAAA,EAE3B,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,wBAAA,EAA0B,0BAAA;AAAA;AAAA,EAE1B,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,gBAAA,EAAkB,kBAAA;AAAA;AAAA,EAElB,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,iBAAA,EAAmB,mBAAA;AAAA;AAAA,EAEnB,6BAAA,EAA+B,+BAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,sBAAA,EAAwB,wBAAA;AAAA;AAAA,EAExB,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,iBAAA,EAAmB,mBAAA;AAAA;AAAA,EAEnB,qBAAA,EAAuB,uBAAA;AAAA;AAAA,EAEvB,YAAA,EAAc,cAAA;AAAA;AAAA,EAEd,eAAA,EAAiB,iBAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjB,YAAA,EAAc,cAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKd,YAAA,EAAc,cAAA;AAAA;AAAA,EAEd,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,sBAAA,EAAwB;AAC1B;AAKO,MAAM,YAAA,GAAqC,MAAA,CAAO,MAAA,CAAO,GAAG;AAGnE,MAAM,SAAA,GAAY,KAAA;AAKlB,MAAM,8BAAmC,IAAI,GAAA,CAAY,CAAC,GAAG,YAAA,EAAc,SAAS,CAAC,CAAA;AAErF,SAAS,gBAAgB,KAAA,EAAwC;AAC/D,EAAA,OAAO,OAAO,KAAA,KAAU,QAAA,IAAY,WAAA,CAAY,IAAI,KAAK,CAAA;AAC3D;AAMO,SAAS,iBAAiB,MAAA,EAA2C;AAC1E,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AAC1B,IAAA,MAAM,IAAIA,2BAAA,CAAqB;AAAA,MAC7B,MAAMC,kBAAA,CAAY,kBAAA;AAAA,MAClB,OAAA,EACE,CAAA,iEAAA,EACO,IAAA,CAAK,SAAA,CAAU,MAAM,CAAC,CAAA,CAAA,CAAA;AAAA,MAC/B,OAAA,EAAS,EAAE,OAAA,EAAS,CAAC,MAAM,GAAG,KAAA,EAAO,CAAC,GAAG,WAAW,CAAA;AAAE,KACvD,CAAA;AAAA,EACH;AACA,EAAA,MAAM,OAAA,GAAU,OAAO,MAAA,CAAO,CAAC,UAAU,CAAC,eAAA,CAAgB,KAAK,CAAC,CAAA;AAChE,EAAA,IAAI,OAAA,CAAQ,SAAS,CAAA,EAAG;AACtB,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,GAAA,CAAI,CAAC,KAAA,KAAU,IAAA,CAAK,SAAA,CAAU,KAAK,CAAC,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AACrE,IAAA,MAAM,QAAQ,CAAC,GAAG,WAAW,CAAA,CAAE,KAAK,IAAI,CAAA;AACxC,IAAA,MAAM,IAAID,2BAAA,CAAqB;AAAA,MAC7B,MAAMC,kBAAA,CAAY,kBAAA;AAAA,MAClB,OAAA,EAAS,CAAA,YAAA,EAAe,KAAK,CAAA,eAAA,EAAkB,KAAK,CAAA,CAAA,CAAA;AAAA,MACpD,SAAS,EAAE,OAAA,EAAS,OAAO,CAAC,GAAG,WAAW,CAAA;AAAE,KAC7C,CAAA;AAAA,EACH;AACA,EAAA,OAAO,MAAA;AACT;AAGO,SAAS,mBAAmB,KAAA,EAAyD;AAC1F,EAAA,OAAO,IAAI,GAAA,CAAI,KAAA,CAAM,OAAA,CAAQ,CAAC,IAAA,KAAU,IAAA,KAAS,SAAA,GAAY,YAAA,GAAe,CAAC,IAAI,CAAE,CAAC,CAAA;AACtF;AAcA,MAAM,UAAA,GAAa,EAAE,MAAA,EAAQ,WAAA,EAAa,MAAM,cAAA,EAAe;AAC/D,MAAM,IAAA,GAAO,EAAE,MAAA,EAAQ,MAAA,EAAQ,MAAM,QAAA,EAAS;AAC9C,MAAM,gBAAA,GAAmB;AAAA,EACvB,MAAA,EAAQ,yBAAA;AAAA,EACR,IAAA,EAAM;AACR,CAAA;AAGA,MAAM,YAAA,GAA0F;AAAA,EAC9F,CAAC,GAAA,CAAI,mBAAmB,GAAG,CAAC,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EAC7E,CAAC,GAAA,CAAI,iBAAiB,GAAG,CAAC,IAAA,EAAM,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EACjF,CAAC,GAAA,CAAI,cAAc,GAAG,CAAC,IAAI,CAAA;AAAA,EAC3B,CAAC,GAAA,CAAI,qBAAqB,GAAG,CAAC,EAAE,MAAA,EAAQ,mBAAA,EAAqB,IAAA,EAAM,wBAAA,EAA0B,CAAA;AAAA,EAC7F,CAAC,GAAA,CAAI,mBAAmB,GAAG,CAAC,YAAY,gBAAgB;AAC1D,CAAA;AAEA,SAAS,oBAAoB,WAAA,EAA2C;AACtE,EAAA,OAAO,CAAA,EAAG,WAAA,CAAY,MAAM,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AACnD;AAMO,SAAS,qBAAA,CACd,OACA,UAAA,EACU;AACV,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,KAAK,CAAC,CAAA,CAAE,OAAA,CAAQ,CAAC,IAAA,KAAS;AAC3C,IAAA,MAAM,OAAA,GAAA,CAAW,YAAA,CAAa,IAAI,CAAA,IAAK,EAAC,EAAG,MAAA,CAAO,CAAC,EAAE,MAAA,EAAO,KAAM,CAAC,UAAA,CAAW,MAAM,CAAC,CAAA;AACrF,IAAA,OAAO,QAAQ,MAAA,KAAW,CAAA,GACtB,EAAC,GACD,CAAC,CAAA,KAAA,EAAQ,IAAI,CAAA,wBAAA,EAA2B,OAAA,CAAQ,IAAI,mBAAmB,CAAA,CAAE,IAAA,CAAK,OAAO,CAAC,CAAA,CAAE,CAAA;AAAA,EAC9F,CAAC,CAAA;AACH;;;;;;"}

package/dist/domain/output-fixes.mjs

@@ -27,6 +27,8 @@ const FIX = {
   EXPLODED_QUERY_OBJECTS: "exploded-query-objects",
   /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */
   NULLABLE_ENUMS: "nullable-enums",
+  /** A parameter with `content` instead of `schema` is typed by the schema of its media type. */
+  PARAMETER_CONTENT: "parameter-content",
   /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */
   PATH_PARAM_TYPE_NAMES: "path-param-type-names",
   /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */
@@ -38,6 +40,11 @@ const FIX = {
    * points at, also where the original type compiles through an index signature.
    */
   REF_POINTERS: "ref-pointers",
+  /**
+   * OpenAPI 3.1 and 3.2: keywords next to a `$ref` (`required`, `properties`) apply too, so the
+   * type is the reference intersected with them. OpenAPI 3.0 ignores them, as its spec says.
+   */
+  REF_SIBLINGS: "ref-siblings",
   /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */
   ROOT_TYPE_NUMBERING: "root-type-numbering",
   /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */
@@ -50,6 +57,13 @@ function isOutputFixName(value) {
   return typeof value === "string" && KNOWN_NAMES.has(value);
 }
 function outputFixNamesOf(values) {
+  if (!Array.isArray(values)) {
+    throw new OpenAPITypesafeError({
+      code: ERROR_CODES.OPTION_FIX_UNKNOWN,
+      message: `The fix option must be a list of fix names, such as ["all"]. Got ${JSON.stringify(values)}.`,
+      details: { unknown: [values], known: [...KNOWN_NAMES] }
+    });
+  }
   const unknown = values.filter((value) => !isOutputFixName(value));
   if (unknown.length > 0) {
     const names = unknown.map((value) => JSON.stringify(value)).join(", ");

package/dist/domain/output-fixes.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"output-fixes.mjs","sources":["../../src/domain/output-fixes.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"./errors.js\";\n\n/**\n * Opt-in fixes of the output of valid schemas (ADR-021). Each one changes only the cases it names;\n * without any, the output is the same as openapi-typescript 7.13 gives. In 2.0 they become the\n * default. The object names the fixes for this package's code; the public API is the `OutputFix`\n * union and the `OUTPUT_FIXES` list (ADR-021, amendment 1).\n */\nexport const FIX = {\n  /** An `allOf` `$ref` to a discriminated union is the union, without `Omit` or a schema name. */\n  ALLOF_DISCRIMINATED_UNION: \"allof-discriminated-union\",\n  /** An `allOf` member with only `required` makes those properties of the others required. */\n  ALLOF_REQUIRED: \"allof-required\",\n  /** The JSDoc of a schema lists the descriptions of its `anyOf` and `oneOf` members. */\n  ANYOF_ONEOF_DESCRIPTIONS: \"anyof-oneof-descriptions\",\n  /** `anyOf` / `oneOf` variants with only `required` make those keys of the parent required. */\n  ANYOF_ONEOF_REQUIRED: \"anyof-oneof-required\",\n  /** `anyOf` next to object keywords or `allOf` is intersected with them, not added to a union. */\n  ANYOF_PROPERTIES: \"anyof-properties\",\n  /** `--array-length` tuples have `min` to `max` items, nest right and follow `--immutable`. */\n  ARRAY_LENGTH_TUPLES: \"array-length-tuples\",\n  /** `--dedupe-enums` names a shared enum by all of its schemas, not by the first one. */\n  DEDUPE_ENUM_NAMES: \"dedupe-enum-names\",\n  /** `required` next to an `allOf` `$ref` to a discriminator member still gives `WithRequired`. */\n  DISCRIMINATOR_MEMBER_REQUIRED: \"discriminator-member-required\",\n  /**\n   * The value a discriminator member gets: one enum of every discriminator's values, a mapping\n   * before the schema name, a schema's own mapping before an inherited one, none where the member\n   * declares it, and with `--enum` a member of the owner's enum.\n   */\n  DISCRIMINATOR_VALUES: \"discriminator-values\",\n  /** An exploded object query parameter's properties are keys of `query`, as they are sent. */\n  EXPLODED_QUERY_OBJECTS: \"exploded-query-objects\",\n  /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */\n  NULLABLE_ENUMS: \"nullable-enums\",\n  /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */\n  PATH_PARAM_TYPE_NAMES: \"path-param-type-names\",\n  /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */\n  PREFIX_ITEMS: \"prefix-items\",\n  /** `readOnly` and `writeOnly` of the schema a `$ref` names, or of `allOf` members, count. */\n  READ_WRITE_REFS: \"read-write-refs\",\n  /**\n   * A `$ref` into schema keywords (`content/<type>/schema`, `items`, `allOf/0`) gets the type it\n   * points at, also where the original type compiles through an index signature.\n   */\n  REF_POINTERS: \"ref-pointers\",\n  /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */\n  ROOT_TYPE_NUMBERING: \"root-type-numbering\",\n  /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */\n  UNEVALUATED_PROPERTIES: \"unevaluated-properties\",\n} as const;\n/** The name of one opt-in output fix. */\nexport type OutputFix = (typeof FIX)[keyof typeof FIX];\n\n/** Every fix of this version, in the order the docs list them. */\nexport const OUTPUT_FIXES: readonly OutputFix[] = Object.values(FIX);\n\n/** The name that turns on every fix of the installed version. */\nconst ALL_FIXES = \"all\";\n\n/** A name the `fix` option accepts: one fix, or `\"all\"`. */\nexport type OutputFixName = OutputFix | typeof ALL_FIXES;\n\nconst KNOWN_NAMES: ReadonlySet<string> = new Set<string>([...OUTPUT_FIXES, ALL_FIXES]);\n\nfunction isOutputFixName(value: unknown): value is OutputFixName {\n  return typeof value === \"string\" && KNOWN_NAMES.has(value);\n}\n\n/** The fix names as given; fails with `OPTION_FIX_UNKNOWN` for any other value. */\nexport function outputFixNamesOf(values: readonly unknown[]): readonly OutputFixName[] {\n  const unknown = values.filter((value) => !isOutputFixName(value));\n  if (unknown.length > 0) {\n    const names = unknown.map((value) => JSON.stringify(value)).join(\", \");\n    const known = [...KNOWN_NAMES].join(\", \");\n    throw new OpenAPITypesafeError({\n      code: ERROR_CODES.OPTION_FIX_UNKNOWN,\n      message: `Unknown fix ${names}. Known fixes: ${known}.`,\n      details: { unknown, known: [...KNOWN_NAMES] },\n    });\n  }\n  return values as readonly OutputFixName[];\n}\n\n/** The fixes the names turn on; `all` stands for every fix of this version. */\nexport function resolveOutputFixes(names: readonly OutputFixName[]): ReadonlySet<OutputFix> {\n  return new Set(names.flatMap((name) => (name === ALL_FIXES ? OUTPUT_FIXES : [name])));\n}\n\n/** A generator option that a fix works with; without it, the fix changes nothing (ADR-021). */\nexport interface OutputFixRequirement {\n  readonly option:\n    | \"arrayLength\"\n    | \"dedupeEnums\"\n    | \"enum\"\n    | \"pathParamsAsTypes\"\n    | \"rootTypes\"\n    | \"rootTypesNoSchemaPrefix\";\n  readonly flag: string;\n}\n\nconst ROOT_TYPES = { option: \"rootTypes\", flag: \"--root-types\" } as const;\nconst ENUM = { option: \"enum\", flag: \"--enum\" } as const;\nconst NO_SCHEMA_PREFIX = {\n  option: \"rootTypesNoSchemaPrefix\",\n  flag: \"--root-types-no-schema-prefix\",\n} as const;\n\n/** The options each fix needs, by fix name; `all` has none. */\nconst REQUIREMENTS: Readonly<Partial<Record<OutputFixName, readonly OutputFixRequirement[]>>> = {\n  [FIX.ARRAY_LENGTH_TUPLES]: [{ option: \"arrayLength\", flag: \"--array-length\" }],\n  [FIX.DEDUPE_ENUM_NAMES]: [ENUM, { option: \"dedupeEnums\", flag: \"--dedupe-enums\" }],\n  [FIX.NULLABLE_ENUMS]: [ENUM],\n  [FIX.PATH_PARAM_TYPE_NAMES]: [{ option: \"pathParamsAsTypes\", flag: \"--path-params-as-types\" }],\n  [FIX.ROOT_TYPE_NUMBERING]: [ROOT_TYPES, NO_SCHEMA_PREFIX],\n};\n\nfunction describeRequirement(requirement: OutputFixRequirement): string {\n  return `${requirement.option} (${requirement.flag})`;\n}\n\n/**\n * A notice for each fix given by name with an option it needs off; it names the options that are\n * off. `all` adds none: it means every fix that applies, so one that does not apply is expected.\n */\nexport function ineffectiveFixNotices(\n  names: readonly OutputFixName[],\n  isOptionOn: (option: OutputFixRequirement[\"option\"]) => boolean,\n): string[] {\n  return [...new Set(names)].flatMap((name) => {\n    const missing = (REQUIREMENTS[name] ?? []).filter(({ option }) => !isOptionOn(option));\n    return missing.length === 0\n      ? []\n      : [`Fix \"${name}\" has no effect without ${missing.map(describeRequirement).join(\" and \")}`];\n  });\n}\n"],"names":[],"mappings":";;AAQO,MAAM,GAAA,GAAM;AAAA;AAAA,EAEjB,yBAAA,EAA2B,2BAAA;AAAA;AAAA,EAE3B,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,wBAAA,EAA0B,0BAAA;AAAA;AAAA,EAE1B,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,gBAAA,EAAkB,kBAAA;AAAA;AAAA,EAElB,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,iBAAA,EAAmB,mBAAA;AAAA;AAAA,EAEnB,6BAAA,EAA+B,+BAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,sBAAA,EAAwB,wBAAA;AAAA;AAAA,EAExB,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,qBAAA,EAAuB,uBAAA;AAAA;AAAA,EAEvB,YAAA,EAAc,cAAA;AAAA;AAAA,EAEd,eAAA,EAAiB,iBAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjB,YAAA,EAAc,cAAA;AAAA;AAAA,EAEd,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,sBAAA,EAAwB;AAC1B;AAKO,MAAM,YAAA,GAAqC,MAAA,CAAO,MAAA,CAAO,GAAG;AAGnE,MAAM,SAAA,GAAY,KAAA;AAKlB,MAAM,8BAAmC,IAAI,GAAA,CAAY,CAAC,GAAG,YAAA,EAAc,SAAS,CAAC,CAAA;AAErF,SAAS,gBAAgB,KAAA,EAAwC;AAC/D,EAAA,OAAO,OAAO,KAAA,KAAU,QAAA,IAAY,WAAA,CAAY,IAAI,KAAK,CAAA;AAC3D;AAGO,SAAS,iBAAiB,MAAA,EAAsD;AACrF,EAAA,MAAM,OAAA,GAAU,OAAO,MAAA,CAAO,CAAC,UAAU,CAAC,eAAA,CAAgB,KAAK,CAAC,CAAA;AAChE,EAAA,IAAI,OAAA,CAAQ,SAAS,CAAA,EAAG;AACtB,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,GAAA,CAAI,CAAC,KAAA,KAAU,IAAA,CAAK,SAAA,CAAU,KAAK,CAAC,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AACrE,IAAA,MAAM,QAAQ,CAAC,GAAG,WAAW,CAAA,CAAE,KAAK,IAAI,CAAA;AACxC,IAAA,MAAM,IAAI,oBAAA,CAAqB;AAAA,MAC7B,MAAM,WAAA,CAAY,kBAAA;AAAA,MAClB,OAAA,EAAS,CAAA,YAAA,EAAe,KAAK,CAAA,eAAA,EAAkB,KAAK,CAAA,CAAA,CAAA;AAAA,MACpD,SAAS,EAAE,OAAA,EAAS,OAAO,CAAC,GAAG,WAAW,CAAA;AAAE,KAC7C,CAAA;AAAA,EACH;AACA,EAAA,OAAO,MAAA;AACT;AAGO,SAAS,mBAAmB,KAAA,EAAyD;AAC1F,EAAA,OAAO,IAAI,GAAA,CAAI,KAAA,CAAM,OAAA,CAAQ,CAAC,IAAA,KAAU,IAAA,KAAS,SAAA,GAAY,YAAA,GAAe,CAAC,IAAI,CAAE,CAAC,CAAA;AACtF;AAcA,MAAM,UAAA,GAAa,EAAE,MAAA,EAAQ,WAAA,EAAa,MAAM,cAAA,EAAe;AAC/D,MAAM,IAAA,GAAO,EAAE,MAAA,EAAQ,MAAA,EAAQ,MAAM,QAAA,EAAS;AAC9C,MAAM,gBAAA,GAAmB;AAAA,EACvB,MAAA,EAAQ,yBAAA;AAAA,EACR,IAAA,EAAM;AACR,CAAA;AAGA,MAAM,YAAA,GAA0F;AAAA,EAC9F,CAAC,GAAA,CAAI,mBAAmB,GAAG,CAAC,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EAC7E,CAAC,GAAA,CAAI,iBAAiB,GAAG,CAAC,IAAA,EAAM,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EACjF,CAAC,GAAA,CAAI,cAAc,GAAG,CAAC,IAAI,CAAA;AAAA,EAC3B,CAAC,GAAA,CAAI,qBAAqB,GAAG,CAAC,EAAE,MAAA,EAAQ,mBAAA,EAAqB,IAAA,EAAM,wBAAA,EAA0B,CAAA;AAAA,EAC7F,CAAC,GAAA,CAAI,mBAAmB,GAAG,CAAC,YAAY,gBAAgB;AAC1D,CAAA;AAEA,SAAS,oBAAoB,WAAA,EAA2C;AACtE,EAAA,OAAO,CAAA,EAAG,WAAA,CAAY,MAAM,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AACnD;AAMO,SAAS,qBAAA,CACd,OACA,UAAA,EACU;AACV,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,KAAK,CAAC,CAAA,CAAE,OAAA,CAAQ,CAAC,IAAA,KAAS;AAC3C,IAAA,MAAM,OAAA,GAAA,CAAW,YAAA,CAAa,IAAI,CAAA,IAAK,EAAC,EAAG,MAAA,CAAO,CAAC,EAAE,MAAA,EAAO,KAAM,CAAC,UAAA,CAAW,MAAM,CAAC,CAAA;AACrF,IAAA,OAAO,QAAQ,MAAA,KAAW,CAAA,GACtB,EAAC,GACD,CAAC,CAAA,KAAA,EAAQ,IAAI,CAAA,wBAAA,EAA2B,OAAA,CAAQ,IAAI,mBAAmB,CAAA,CAAE,IAAA,CAAK,OAAO,CAAC,CAAA,CAAE,CAAA;AAAA,EAC9F,CAAC,CAAA;AACH;;"}
+{"version":3,"file":"output-fixes.mjs","sources":["../../src/domain/output-fixes.ts"],"sourcesContent":["import { ERROR_CODES, OpenAPITypesafeError } from \"./errors.js\";\n\n/**\n * Opt-in fixes of the output of valid schemas (ADR-021). Each one changes only the cases it names;\n * without any, the output is the same as openapi-typescript 7.13 gives. In 2.0 they become the\n * default. The object names the fixes for this package's code; the public API is the `OutputFix`\n * union and the `OUTPUT_FIXES` list (ADR-021, amendment 1).\n */\nexport const FIX = {\n  /** An `allOf` `$ref` to a discriminated union is the union, without `Omit` or a schema name. */\n  ALLOF_DISCRIMINATED_UNION: \"allof-discriminated-union\",\n  /** An `allOf` member with only `required` makes those properties of the others required. */\n  ALLOF_REQUIRED: \"allof-required\",\n  /** The JSDoc of a schema lists the descriptions of its `anyOf` and `oneOf` members. */\n  ANYOF_ONEOF_DESCRIPTIONS: \"anyof-oneof-descriptions\",\n  /** `anyOf` / `oneOf` variants with only `required` make those keys of the parent required. */\n  ANYOF_ONEOF_REQUIRED: \"anyof-oneof-required\",\n  /** `anyOf` next to object keywords or `allOf` is intersected with them, not added to a union. */\n  ANYOF_PROPERTIES: \"anyof-properties\",\n  /** `--array-length` tuples have `min` to `max` items, nest right and follow `--immutable`. */\n  ARRAY_LENGTH_TUPLES: \"array-length-tuples\",\n  /** `--dedupe-enums` names a shared enum by all of its schemas, not by the first one. */\n  DEDUPE_ENUM_NAMES: \"dedupe-enum-names\",\n  /** `required` next to an `allOf` `$ref` to a discriminator member still gives `WithRequired`. */\n  DISCRIMINATOR_MEMBER_REQUIRED: \"discriminator-member-required\",\n  /**\n   * The value a discriminator member gets: one enum of every discriminator's values, a mapping\n   * before the schema name, a schema's own mapping before an inherited one, none where the member\n   * declares it, and with `--enum` a member of the owner's enum.\n   */\n  DISCRIMINATOR_VALUES: \"discriminator-values\",\n  /** An exploded object query parameter's properties are keys of `query`, as they are sent. */\n  EXPLODED_QUERY_OBJECTS: \"exploded-query-objects\",\n  /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */\n  NULLABLE_ENUMS: \"nullable-enums\",\n  /** A parameter with `content` instead of `schema` is typed by the schema of its media type. */\n  PARAMETER_CONTENT: \"parameter-content\",\n  /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */\n  PATH_PARAM_TYPE_NAMES: \"path-param-type-names\",\n  /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */\n  PREFIX_ITEMS: \"prefix-items\",\n  /** `readOnly` and `writeOnly` of the schema a `$ref` names, or of `allOf` members, count. */\n  READ_WRITE_REFS: \"read-write-refs\",\n  /**\n   * A `$ref` into schema keywords (`content/<type>/schema`, `items`, `allOf/0`) gets the type it\n   * points at, also where the original type compiles through an index signature.\n   */\n  REF_POINTERS: \"ref-pointers\",\n  /**\n   * OpenAPI 3.1 and 3.2: keywords next to a `$ref` (`required`, `properties`) apply too, so the\n   * type is the reference intersected with them. OpenAPI 3.0 ignores them, as its spec says.\n   */\n  REF_SIBLINGS: \"ref-siblings\",\n  /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */\n  ROOT_TYPE_NUMBERING: \"root-type-numbering\",\n  /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */\n  UNEVALUATED_PROPERTIES: \"unevaluated-properties\",\n} as const;\n/** The name of one opt-in output fix. */\nexport type OutputFix = (typeof FIX)[keyof typeof FIX];\n\n/** Every fix of this version, in the order the docs list them. */\nexport const OUTPUT_FIXES: readonly OutputFix[] = Object.values(FIX);\n\n/** The name that turns on every fix of the installed version. */\nconst ALL_FIXES = \"all\";\n\n/** A name the `fix` option accepts: one fix, or `\"all\"`. */\nexport type OutputFixName = OutputFix | typeof ALL_FIXES;\n\nconst KNOWN_NAMES: ReadonlySet<string> = new Set<string>([...OUTPUT_FIXES, ALL_FIXES]);\n\nfunction isOutputFixName(value: unknown): value is OutputFixName {\n  return typeof value === \"string\" && KNOWN_NAMES.has(value);\n}\n\n/**\n * The fix names as given; fails with `OPTION_FIX_UNKNOWN` for any other value, and for a `fix`\n * option that is no list (`fix: \"all\"` from JavaScript), which must not be read letter by letter.\n */\nexport function outputFixNamesOf(values: unknown): readonly OutputFixName[] {\n  if (!Array.isArray(values)) {\n    throw new OpenAPITypesafeError({\n      code: ERROR_CODES.OPTION_FIX_UNKNOWN,\n      message:\n        'The fix option must be a list of fix names, such as [\"all\"]. ' +\n        `Got ${JSON.stringify(values)}.`,\n      details: { unknown: [values], known: [...KNOWN_NAMES] },\n    });\n  }\n  const unknown = values.filter((value) => !isOutputFixName(value));\n  if (unknown.length > 0) {\n    const names = unknown.map((value) => JSON.stringify(value)).join(\", \");\n    const known = [...KNOWN_NAMES].join(\", \");\n    throw new OpenAPITypesafeError({\n      code: ERROR_CODES.OPTION_FIX_UNKNOWN,\n      message: `Unknown fix ${names}. Known fixes: ${known}.`,\n      details: { unknown, known: [...KNOWN_NAMES] },\n    });\n  }\n  return values as readonly OutputFixName[];\n}\n\n/** The fixes the names turn on; `all` stands for every fix of this version. */\nexport function resolveOutputFixes(names: readonly OutputFixName[]): ReadonlySet<OutputFix> {\n  return new Set(names.flatMap((name) => (name === ALL_FIXES ? OUTPUT_FIXES : [name])));\n}\n\n/** A generator option that a fix works with; without it, the fix changes nothing (ADR-021). */\nexport interface OutputFixRequirement {\n  readonly option:\n    | \"arrayLength\"\n    | \"dedupeEnums\"\n    | \"enum\"\n    | \"pathParamsAsTypes\"\n    | \"rootTypes\"\n    | \"rootTypesNoSchemaPrefix\";\n  readonly flag: string;\n}\n\nconst ROOT_TYPES = { option: \"rootTypes\", flag: \"--root-types\" } as const;\nconst ENUM = { option: \"enum\", flag: \"--enum\" } as const;\nconst NO_SCHEMA_PREFIX = {\n  option: \"rootTypesNoSchemaPrefix\",\n  flag: \"--root-types-no-schema-prefix\",\n} as const;\n\n/** The options each fix needs, by fix name; `all` has none. */\nconst REQUIREMENTS: Readonly<Partial<Record<OutputFixName, readonly OutputFixRequirement[]>>> = {\n  [FIX.ARRAY_LENGTH_TUPLES]: [{ option: \"arrayLength\", flag: \"--array-length\" }],\n  [FIX.DEDUPE_ENUM_NAMES]: [ENUM, { option: \"dedupeEnums\", flag: \"--dedupe-enums\" }],\n  [FIX.NULLABLE_ENUMS]: [ENUM],\n  [FIX.PATH_PARAM_TYPE_NAMES]: [{ option: \"pathParamsAsTypes\", flag: \"--path-params-as-types\" }],\n  [FIX.ROOT_TYPE_NUMBERING]: [ROOT_TYPES, NO_SCHEMA_PREFIX],\n};\n\nfunction describeRequirement(requirement: OutputFixRequirement): string {\n  return `${requirement.option} (${requirement.flag})`;\n}\n\n/**\n * A notice for each fix given by name with an option it needs off; it names the options that are\n * off. `all` adds none: it means every fix that applies, so one that does not apply is expected.\n */\nexport function ineffectiveFixNotices(\n  names: readonly OutputFixName[],\n  isOptionOn: (option: OutputFixRequirement[\"option\"]) => boolean,\n): string[] {\n  return [...new Set(names)].flatMap((name) => {\n    const missing = (REQUIREMENTS[name] ?? []).filter(({ option }) => !isOptionOn(option));\n    return missing.length === 0\n      ? []\n      : [`Fix \"${name}\" has no effect without ${missing.map(describeRequirement).join(\" and \")}`];\n  });\n}\n"],"names":[],"mappings":";;AAQO,MAAM,GAAA,GAAM;AAAA;AAAA,EAEjB,yBAAA,EAA2B,2BAAA;AAAA;AAAA,EAE3B,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,wBAAA,EAA0B,0BAAA;AAAA;AAAA,EAE1B,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,gBAAA,EAAkB,kBAAA;AAAA;AAAA,EAElB,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,iBAAA,EAAmB,mBAAA;AAAA;AAAA,EAEnB,6BAAA,EAA+B,+BAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,sBAAA,EAAwB,wBAAA;AAAA;AAAA,EAExB,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,iBAAA,EAAmB,mBAAA;AAAA;AAAA,EAEnB,qBAAA,EAAuB,uBAAA;AAAA;AAAA,EAEvB,YAAA,EAAc,cAAA;AAAA;AAAA,EAEd,eAAA,EAAiB,iBAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjB,YAAA,EAAc,cAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKd,YAAA,EAAc,cAAA;AAAA;AAAA,EAEd,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,sBAAA,EAAwB;AAC1B;AAKO,MAAM,YAAA,GAAqC,MAAA,CAAO,MAAA,CAAO,GAAG;AAGnE,MAAM,SAAA,GAAY,KAAA;AAKlB,MAAM,8BAAmC,IAAI,GAAA,CAAY,CAAC,GAAG,YAAA,EAAc,SAAS,CAAC,CAAA;AAErF,SAAS,gBAAgB,KAAA,EAAwC;AAC/D,EAAA,OAAO,OAAO,KAAA,KAAU,QAAA,IAAY,WAAA,CAAY,IAAI,KAAK,CAAA;AAC3D;AAMO,SAAS,iBAAiB,MAAA,EAA2C;AAC1E,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,MAAM,CAAA,EAAG;AAC1B,IAAA,MAAM,IAAI,oBAAA,CAAqB;AAAA,MAC7B,MAAM,WAAA,CAAY,kBAAA;AAAA,MAClB,OAAA,EACE,CAAA,iEAAA,EACO,IAAA,CAAK,SAAA,CAAU,MAAM,CAAC,CAAA,CAAA,CAAA;AAAA,MAC/B,OAAA,EAAS,EAAE,OAAA,EAAS,CAAC,MAAM,GAAG,KAAA,EAAO,CAAC,GAAG,WAAW,CAAA;AAAE,KACvD,CAAA;AAAA,EACH;AACA,EAAA,MAAM,OAAA,GAAU,OAAO,MAAA,CAAO,CAAC,UAAU,CAAC,eAAA,CAAgB,KAAK,CAAC,CAAA;AAChE,EAAA,IAAI,OAAA,CAAQ,SAAS,CAAA,EAAG;AACtB,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,GAAA,CAAI,CAAC,KAAA,KAAU,IAAA,CAAK,SAAA,CAAU,KAAK,CAAC,CAAA,CAAE,IAAA,CAAK,IAAI,CAAA;AACrE,IAAA,MAAM,QAAQ,CAAC,GAAG,WAAW,CAAA,CAAE,KAAK,IAAI,CAAA;AACxC,IAAA,MAAM,IAAI,oBAAA,CAAqB;AAAA,MAC7B,MAAM,WAAA,CAAY,kBAAA;AAAA,MAClB,OAAA,EAAS,CAAA,YAAA,EAAe,KAAK,CAAA,eAAA,EAAkB,KAAK,CAAA,CAAA,CAAA;AAAA,MACpD,SAAS,EAAE,OAAA,EAAS,OAAO,CAAC,GAAG,WAAW,CAAA;AAAE,KAC7C,CAAA;AAAA,EACH;AACA,EAAA,OAAO,MAAA;AACT;AAGO,SAAS,mBAAmB,KAAA,EAAyD;AAC1F,EAAA,OAAO,IAAI,GAAA,CAAI,KAAA,CAAM,OAAA,CAAQ,CAAC,IAAA,KAAU,IAAA,KAAS,SAAA,GAAY,YAAA,GAAe,CAAC,IAAI,CAAE,CAAC,CAAA;AACtF;AAcA,MAAM,UAAA,GAAa,EAAE,MAAA,EAAQ,WAAA,EAAa,MAAM,cAAA,EAAe;AAC/D,MAAM,IAAA,GAAO,EAAE,MAAA,EAAQ,MAAA,EAAQ,MAAM,QAAA,EAAS;AAC9C,MAAM,gBAAA,GAAmB;AAAA,EACvB,MAAA,EAAQ,yBAAA;AAAA,EACR,IAAA,EAAM;AACR,CAAA;AAGA,MAAM,YAAA,GAA0F;AAAA,EAC9F,CAAC,GAAA,CAAI,mBAAmB,GAAG,CAAC,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EAC7E,CAAC,GAAA,CAAI,iBAAiB,GAAG,CAAC,IAAA,EAAM,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EACjF,CAAC,GAAA,CAAI,cAAc,GAAG,CAAC,IAAI,CAAA;AAAA,EAC3B,CAAC,GAAA,CAAI,qBAAqB,GAAG,CAAC,EAAE,MAAA,EAAQ,mBAAA,EAAqB,IAAA,EAAM,wBAAA,EAA0B,CAAA;AAAA,EAC7F,CAAC,GAAA,CAAI,mBAAmB,GAAG,CAAC,YAAY,gBAAgB;AAC1D,CAAA;AAEA,SAAS,oBAAoB,WAAA,EAA2C;AACtE,EAAA,OAAO,CAAA,EAAG,WAAA,CAAY,MAAM,CAAA,EAAA,EAAK,YAAY,IAAI,CAAA,CAAA,CAAA;AACnD;AAMO,SAAS,qBAAA,CACd,OACA,UAAA,EACU;AACV,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,KAAK,CAAC,CAAA,CAAE,OAAA,CAAQ,CAAC,IAAA,KAAS;AAC3C,IAAA,MAAM,OAAA,GAAA,CAAW,YAAA,CAAa,IAAI,CAAA,IAAK,EAAC,EAAG,MAAA,CAAO,CAAC,EAAE,MAAA,EAAO,KAAM,CAAC,UAAA,CAAW,MAAM,CAAC,CAAA;AACrF,IAAA,OAAO,QAAQ,MAAA,KAAW,CAAA,GACtB,EAAC,GACD,CAAC,CAAA,KAAA,EAAQ,IAAI,CAAA,wBAAA,EAA2B,OAAA,CAAQ,IAAI,mBAAmB,CAAA,CAAE,IAAA,CAAK,OAAO,CAAC,CAAA,CAAE,CAAA;AAAA,EAC9F,CAAC,CAAA;AACH;;"}

package/dist/domain/url-secrets.cjs

@@ -0,0 +1,48 @@
+'use strict';
+
+const URL_AFTER_SCHEME = /:\/\/[^\s"'<>]*[^\s"'<>.,:;!?)]/g;
+const SCHEME_SEPARATOR = "://";
+const AUTHORITY_END = /[/?#]/;
+const QUERY_OR_FRAGMENT = /[?#]/;
+const QUERY_START = "?";
+const FRAGMENT_START = "#";
+const USER_INFO_END = "@";
+const HIDDEN = "***";
+function withoutUserInfo(rest) {
+  const authorityEnd = rest.search(AUTHORITY_END);
+  const authority = authorityEnd === -1 ? rest : rest.slice(0, authorityEnd);
+  const userInfoEnd = authority.lastIndexOf(USER_INFO_END);
+  return userInfoEnd === -1 ? rest : `${HIDDEN}${rest.slice(userInfoEnd)}`;
+}
+function withoutQuery(rest) {
+  const fragmentStart = rest.indexOf(FRAGMENT_START);
+  const beforeFragment = fragmentStart === -1 ? rest : rest.slice(0, fragmentStart);
+  const queryStart = beforeFragment.indexOf(QUERY_START);
+  if (queryStart === -1) {
+    return rest;
+  }
+  const fragment = fragmentStart === -1 ? "" : rest.slice(fragmentStart);
+  return `${rest.slice(0, queryStart + 1)}${HIDDEN}${fragment}`;
+}
+function redactUrlSecrets(text) {
+  return text.replace(URL_AFTER_SCHEME, (url) => {
+    const rest = url.slice(SCHEME_SEPARATOR.length);
+    return `${SCHEME_SEPARATOR}${withoutQuery(withoutUserInfo(rest))}`;
+  });
+}
+function redactUnparsedUrl(text) {
+  const separator = text.indexOf(SCHEME_SEPARATOR);
+  if (separator === -1) {
+    return text;
+  }
+  const rest = text.slice(separator + SCHEME_SEPARATOR.length);
+  const queryOrFragment = rest.search(QUERY_OR_FRAGMENT);
+  const beforeQuery = queryOrFragment === -1 ? rest : rest.slice(0, queryOrFragment);
+  const userInfoEnd = beforeQuery.lastIndexOf(USER_INFO_END);
+  const shown = userInfoEnd === -1 ? rest : `${HIDDEN}${rest.slice(userInfoEnd)}`;
+  return `${text.slice(0, separator)}${SCHEME_SEPARATOR}${withoutQuery(shown)}`;
+}
+
+exports.redactUnparsedUrl = redactUnparsedUrl;
+exports.redactUrlSecrets = redactUrlSecrets;
+//# sourceMappingURL=url-secrets.cjs.map

package/dist/domain/url-secrets.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-secrets.cjs","sources":["../../src/domain/url-secrets.ts"],"sourcesContent":["/**\n * URLs can reach a message: the CLI input, a `$ref`, a redirect. Messages end up in CI job logs, so\n * the parts of a URL that carry secrets are hidden in every one (audit B2, F12): the user info\n * (`https://user:token@host/…`), which fetch refuses anyway, and the query, which holds API keys\n * and signatures (`?api_key=…`, `?X-Amz-Signature=…`). Which query parameters are secret cannot be\n * told by their names, so the whole query is hidden; the path and the fragment (a JSON pointer)\n * stay, so the message still names the document and the place in it.\n */\n\n/**\n * A URL in a message, from its `://` to the first space, quote or angle bracket: a serialized URL\n * percent-encodes these, and messages put them around a URL. A match takes the rest of the URL,\n * also a later `://` in it, so the scan never starts again inside a URL; it stays linear. It ends\n * before punctuation that closes a sentence or a parenthesis (`… x.yaml?key=1: 404`, `(… ?key=1)`),\n * which the message puts after the URL; a hidden query would hide it too.\n */\nconst URL_AFTER_SCHEME = /:\\/\\/[^\\s\"'<>]*[^\\s\"'<>.,:;!?)]/g;\n\nconst SCHEME_SEPARATOR = \"://\";\nconst AUTHORITY_END = /[/?#]/;\nconst QUERY_OR_FRAGMENT = /[?#]/;\nconst QUERY_START = \"?\";\nconst FRAGMENT_START = \"#\";\nconst USER_INFO_END = \"@\";\nconst HIDDEN = \"***\";\n\n/** The part after `://` with the user info of its authority hidden: `***@host`. */\nfunction withoutUserInfo(rest: string): string {\n  const authorityEnd = rest.search(AUTHORITY_END);\n  const authority = authorityEnd === -1 ? rest : rest.slice(0, authorityEnd);\n  const userInfoEnd = authority.lastIndexOf(USER_INFO_END);\n  return userInfoEnd === -1 ? rest : `${HIDDEN}${rest.slice(userInfoEnd)}`;\n}\n\n/** The part after `://` with its query hidden: `/x.yaml?***#/a`. */\nfunction withoutQuery(rest: string): string {\n  const fragmentStart = rest.indexOf(FRAGMENT_START);\n  const beforeFragment = fragmentStart === -1 ? rest : rest.slice(0, fragmentStart);\n  const queryStart = beforeFragment.indexOf(QUERY_START);\n  if (queryStart === -1) {\n    return rest;\n  }\n  const fragment = fragmentStart === -1 ? \"\" : rest.slice(fragmentStart);\n  return `${rest.slice(0, queryStart + 1)}${HIDDEN}${fragment}`;\n}\n\n/** The text with the user info and the query of every URL in it replaced by `***`. */\nexport function redactUrlSecrets(text: string): string {\n  return text.replace(URL_AFTER_SCHEME, (url) => {\n    const rest = url.slice(SCHEME_SEPARATOR.length);\n    return `${SCHEME_SEPARATOR}${withoutQuery(withoutUserInfo(rest))}`;\n  });\n}\n\n/**\n * Text that starts like a URL but does not parse as one (`http://user:a/b@host/x`), with what may\n * be secret hidden. Without a parse there is no telling where the authority ends, so everything\n * from the `://` to the last `@` before the query counts as user info; the query is hidden as in\n * `redactUrlSecrets`.\n */\nexport function redactUnparsedUrl(text: string): string {\n  const separator = text.indexOf(SCHEME_SEPARATOR);\n  if (separator === -1) {\n    return text;\n  }\n  const rest = text.slice(separator + SCHEME_SEPARATOR.length);\n  const queryOrFragment = rest.search(QUERY_OR_FRAGMENT);\n  const beforeQuery = queryOrFragment === -1 ? rest : rest.slice(0, queryOrFragment);\n  const userInfoEnd = beforeQuery.lastIndexOf(USER_INFO_END);\n  const shown = userInfoEnd === -1 ? rest : `${HIDDEN}${rest.slice(userInfoEnd)}`;\n  return `${text.slice(0, separator)}${SCHEME_SEPARATOR}${withoutQuery(shown)}`;\n}\n"],"names":[],"mappings":";;AAgBA,MAAM,gBAAA,GAAmB,kCAAA;AAEzB,MAAM,gBAAA,GAAmB,KAAA;AACzB,MAAM,aAAA,GAAgB,OAAA;AACtB,MAAM,iBAAA,GAAoB,MAAA;AAC1B,MAAM,WAAA,GAAc,GAAA;AACpB,MAAM,cAAA,GAAiB,GAAA;AACvB,MAAM,aAAA,GAAgB,GAAA;AACtB,MAAM,MAAA,GAAS,KAAA;AAGf,SAAS,gBAAgB,IAAA,EAAsB;AAC7C,EAAA,MAAM,YAAA,GAAe,IAAA,CAAK,MAAA,CAAO,aAAa,CAAA;AAC9C,EAAA,MAAM,YAAY,YAAA,KAAiB,EAAA,GAAK,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,YAAY,CAAA;AACzE,EAAA,MAAM,WAAA,GAAc,SAAA,CAAU,WAAA,CAAY,aAAa,CAAA;AACvD,EAAA,OAAO,WAAA,KAAgB,KAAK,IAAA,GAAO,CAAA,EAAG,MAAM,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,WAAW,CAAC,CAAA,CAAA;AACxE;AAGA,SAAS,aAAa,IAAA,EAAsB;AAC1C,EAAA,MAAM,aAAA,GAAgB,IAAA,CAAK,OAAA,CAAQ,cAAc,CAAA;AACjD,EAAA,MAAM,iBAAiB,aAAA,KAAkB,EAAA,GAAK,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,aAAa,CAAA;AAChF,EAAA,MAAM,UAAA,GAAa,cAAA,CAAe,OAAA,CAAQ,WAAW,CAAA;AACrD,EAAA,IAAI,eAAe,EAAA,EAAI;AACrB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,WAAW,aAAA,KAAkB,EAAA,GAAK,EAAA,GAAK,IAAA,CAAK,MAAM,aAAa,CAAA;AACrE,EAAA,OAAO,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,CAAA,EAAG,UAAA,GAAa,CAAC,CAAC,CAAA,EAAG,MAAM,CAAA,EAAG,QAAQ,CAAA,CAAA;AAC7D;AAGO,SAAS,iBAAiB,IAAA,EAAsB;AACrD,EAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,gBAAA,EAAkB,CAAC,GAAA,KAAQ;AAC7C,IAAA,MAAM,IAAA,GAAO,GAAA,CAAI,KAAA,CAAM,gBAAA,CAAiB,MAAM,CAAA;AAC9C,IAAA,OAAO,GAAG,gBAAgB,CAAA,EAAG,aAAa,eAAA,CAAgB,IAAI,CAAC,CAAC,CAAA,CAAA;AAAA,EAClE,CAAC,CAAA;AACH;AAQO,SAAS,kBAAkB,IAAA,EAAsB;AACtD,EAAA,MAAM,SAAA,GAAY,IAAA,CAAK,OAAA,CAAQ,gBAAgB,CAAA;AAC/C,EAAA,IAAI,cAAc,EAAA,EAAI;AACpB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,IAAA,GAAO,IAAA,CAAK,KAAA,CAAM,SAAA,GAAY,iBAAiB,MAAM,CAAA;AAC3D,EAAA,MAAM,eAAA,GAAkB,IAAA,CAAK,MAAA,CAAO,iBAAiB,CAAA;AACrD,EAAA,MAAM,cAAc,eAAA,KAAoB,EAAA,GAAK,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,eAAe,CAAA;AACjF,EAAA,MAAM,WAAA,GAAc,WAAA,CAAY,WAAA,CAAY,aAAa,CAAA;AACzD,EAAA,MAAM,KAAA,GAAQ,WAAA,KAAgB,EAAA,GAAK,IAAA,GAAO,CAAA,EAAG,MAAM,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,WAAW,CAAC,CAAA,CAAA;AAC7E,EAAA,OAAO,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,CAAA,EAAG,SAAS,CAAC,CAAA,EAAG,gBAAgB,CAAA,EAAG,YAAA,CAAa,KAAK,CAAC,CAAA,CAAA;AAC7E;;;"}

package/dist/domain/url-secrets.mjs

@@ -0,0 +1,45 @@
+const URL_AFTER_SCHEME = /:\/\/[^\s"'<>]*[^\s"'<>.,:;!?)]/g;
+const SCHEME_SEPARATOR = "://";
+const AUTHORITY_END = /[/?#]/;
+const QUERY_OR_FRAGMENT = /[?#]/;
+const QUERY_START = "?";
+const FRAGMENT_START = "#";
+const USER_INFO_END = "@";
+const HIDDEN = "***";
+function withoutUserInfo(rest) {
+  const authorityEnd = rest.search(AUTHORITY_END);
+  const authority = authorityEnd === -1 ? rest : rest.slice(0, authorityEnd);
+  const userInfoEnd = authority.lastIndexOf(USER_INFO_END);
+  return userInfoEnd === -1 ? rest : `${HIDDEN}${rest.slice(userInfoEnd)}`;
+}
+function withoutQuery(rest) {
+  const fragmentStart = rest.indexOf(FRAGMENT_START);
+  const beforeFragment = fragmentStart === -1 ? rest : rest.slice(0, fragmentStart);
+  const queryStart = beforeFragment.indexOf(QUERY_START);
+  if (queryStart === -1) {
+    return rest;
+  }
+  const fragment = fragmentStart === -1 ? "" : rest.slice(fragmentStart);
+  return `${rest.slice(0, queryStart + 1)}${HIDDEN}${fragment}`;
+}
+function redactUrlSecrets(text) {
+  return text.replace(URL_AFTER_SCHEME, (url) => {
+    const rest = url.slice(SCHEME_SEPARATOR.length);
+    return `${SCHEME_SEPARATOR}${withoutQuery(withoutUserInfo(rest))}`;
+  });
+}
+function redactUnparsedUrl(text) {
+  const separator = text.indexOf(SCHEME_SEPARATOR);
+  if (separator === -1) {
+    return text;
+  }
+  const rest = text.slice(separator + SCHEME_SEPARATOR.length);
+  const queryOrFragment = rest.search(QUERY_OR_FRAGMENT);
+  const beforeQuery = queryOrFragment === -1 ? rest : rest.slice(0, queryOrFragment);
+  const userInfoEnd = beforeQuery.lastIndexOf(USER_INFO_END);
+  const shown = userInfoEnd === -1 ? rest : `${HIDDEN}${rest.slice(userInfoEnd)}`;
+  return `${text.slice(0, separator)}${SCHEME_SEPARATOR}${withoutQuery(shown)}`;
+}
+
+export { redactUnparsedUrl, redactUrlSecrets };
+//# sourceMappingURL=url-secrets.mjs.map

package/dist/domain/url-secrets.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-secrets.mjs","sources":["../../src/domain/url-secrets.ts"],"sourcesContent":["/**\n * URLs can reach a message: the CLI input, a `$ref`, a redirect. Messages end up in CI job logs, so\n * the parts of a URL that carry secrets are hidden in every one (audit B2, F12): the user info\n * (`https://user:token@host/…`), which fetch refuses anyway, and the query, which holds API keys\n * and signatures (`?api_key=…`, `?X-Amz-Signature=…`). Which query parameters are secret cannot be\n * told by their names, so the whole query is hidden; the path and the fragment (a JSON pointer)\n * stay, so the message still names the document and the place in it.\n */\n\n/**\n * A URL in a message, from its `://` to the first space, quote or angle bracket: a serialized URL\n * percent-encodes these, and messages put them around a URL. A match takes the rest of the URL,\n * also a later `://` in it, so the scan never starts again inside a URL; it stays linear. It ends\n * before punctuation that closes a sentence or a parenthesis (`… x.yaml?key=1: 404`, `(… ?key=1)`),\n * which the message puts after the URL; a hidden query would hide it too.\n */\nconst URL_AFTER_SCHEME = /:\\/\\/[^\\s\"'<>]*[^\\s\"'<>.,:;!?)]/g;\n\nconst SCHEME_SEPARATOR = \"://\";\nconst AUTHORITY_END = /[/?#]/;\nconst QUERY_OR_FRAGMENT = /[?#]/;\nconst QUERY_START = \"?\";\nconst FRAGMENT_START = \"#\";\nconst USER_INFO_END = \"@\";\nconst HIDDEN = \"***\";\n\n/** The part after `://` with the user info of its authority hidden: `***@host`. */\nfunction withoutUserInfo(rest: string): string {\n  const authorityEnd = rest.search(AUTHORITY_END);\n  const authority = authorityEnd === -1 ? rest : rest.slice(0, authorityEnd);\n  const userInfoEnd = authority.lastIndexOf(USER_INFO_END);\n  return userInfoEnd === -1 ? rest : `${HIDDEN}${rest.slice(userInfoEnd)}`;\n}\n\n/** The part after `://` with its query hidden: `/x.yaml?***#/a`. */\nfunction withoutQuery(rest: string): string {\n  const fragmentStart = rest.indexOf(FRAGMENT_START);\n  const beforeFragment = fragmentStart === -1 ? rest : rest.slice(0, fragmentStart);\n  const queryStart = beforeFragment.indexOf(QUERY_START);\n  if (queryStart === -1) {\n    return rest;\n  }\n  const fragment = fragmentStart === -1 ? \"\" : rest.slice(fragmentStart);\n  return `${rest.slice(0, queryStart + 1)}${HIDDEN}${fragment}`;\n}\n\n/** The text with the user info and the query of every URL in it replaced by `***`. */\nexport function redactUrlSecrets(text: string): string {\n  return text.replace(URL_AFTER_SCHEME, (url) => {\n    const rest = url.slice(SCHEME_SEPARATOR.length);\n    return `${SCHEME_SEPARATOR}${withoutQuery(withoutUserInfo(rest))}`;\n  });\n}\n\n/**\n * Text that starts like a URL but does not parse as one (`http://user:a/b@host/x`), with what may\n * be secret hidden. Without a parse there is no telling where the authority ends, so everything\n * from the `://` to the last `@` before the query counts as user info; the query is hidden as in\n * `redactUrlSecrets`.\n */\nexport function redactUnparsedUrl(text: string): string {\n  const separator = text.indexOf(SCHEME_SEPARATOR);\n  if (separator === -1) {\n    return text;\n  }\n  const rest = text.slice(separator + SCHEME_SEPARATOR.length);\n  const queryOrFragment = rest.search(QUERY_OR_FRAGMENT);\n  const beforeQuery = queryOrFragment === -1 ? rest : rest.slice(0, queryOrFragment);\n  const userInfoEnd = beforeQuery.lastIndexOf(USER_INFO_END);\n  const shown = userInfoEnd === -1 ? rest : `${HIDDEN}${rest.slice(userInfoEnd)}`;\n  return `${text.slice(0, separator)}${SCHEME_SEPARATOR}${withoutQuery(shown)}`;\n}\n"],"names":[],"mappings":"AAgBA,MAAM,gBAAA,GAAmB,kCAAA;AAEzB,MAAM,gBAAA,GAAmB,KAAA;AACzB,MAAM,aAAA,GAAgB,OAAA;AACtB,MAAM,iBAAA,GAAoB,MAAA;AAC1B,MAAM,WAAA,GAAc,GAAA;AACpB,MAAM,cAAA,GAAiB,GAAA;AACvB,MAAM,aAAA,GAAgB,GAAA;AACtB,MAAM,MAAA,GAAS,KAAA;AAGf,SAAS,gBAAgB,IAAA,EAAsB;AAC7C,EAAA,MAAM,YAAA,GAAe,IAAA,CAAK,MAAA,CAAO,aAAa,CAAA;AAC9C,EAAA,MAAM,YAAY,YAAA,KAAiB,EAAA,GAAK,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,YAAY,CAAA;AACzE,EAAA,MAAM,WAAA,GAAc,SAAA,CAAU,WAAA,CAAY,aAAa,CAAA;AACvD,EAAA,OAAO,WAAA,KAAgB,KAAK,IAAA,GAAO,CAAA,EAAG,MAAM,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,WAAW,CAAC,CAAA,CAAA;AACxE;AAGA,SAAS,aAAa,IAAA,EAAsB;AAC1C,EAAA,MAAM,aAAA,GAAgB,IAAA,CAAK,OAAA,CAAQ,cAAc,CAAA;AACjD,EAAA,MAAM,iBAAiB,aAAA,KAAkB,EAAA,GAAK,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,aAAa,CAAA;AAChF,EAAA,MAAM,UAAA,GAAa,cAAA,CAAe,OAAA,CAAQ,WAAW,CAAA;AACrD,EAAA,IAAI,eAAe,EAAA,EAAI;AACrB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,WAAW,aAAA,KAAkB,EAAA,GAAK,EAAA,GAAK,IAAA,CAAK,MAAM,aAAa,CAAA;AACrE,EAAA,OAAO,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,CAAA,EAAG,UAAA,GAAa,CAAC,CAAC,CAAA,EAAG,MAAM,CAAA,EAAG,QAAQ,CAAA,CAAA;AAC7D;AAGO,SAAS,iBAAiB,IAAA,EAAsB;AACrD,EAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,gBAAA,EAAkB,CAAC,GAAA,KAAQ;AAC7C,IAAA,MAAM,IAAA,GAAO,GAAA,CAAI,KAAA,CAAM,gBAAA,CAAiB,MAAM,CAAA;AAC9C,IAAA,OAAO,GAAG,gBAAgB,CAAA,EAAG,aAAa,eAAA,CAAgB,IAAI,CAAC,CAAC,CAAA,CAAA;AAAA,EAClE,CAAC,CAAA;AACH;AAQO,SAAS,kBAAkB,IAAA,EAAsB;AACtD,EAAA,MAAM,SAAA,GAAY,IAAA,CAAK,OAAA,CAAQ,gBAAgB,CAAA;AAC/C,EAAA,IAAI,cAAc,EAAA,EAAI;AACpB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,IAAA,GAAO,IAAA,CAAK,KAAA,CAAM,SAAA,GAAY,iBAAiB,MAAM,CAAA;AAC3D,EAAA,MAAM,eAAA,GAAkB,IAAA,CAAK,MAAA,CAAO,iBAAiB,CAAA;AACrD,EAAA,MAAM,cAAc,eAAA,KAAoB,EAAA,GAAK,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,eAAe,CAAA;AACjF,EAAA,MAAM,WAAA,GAAc,WAAA,CAAY,WAAA,CAAY,aAAa,CAAA;AACzD,EAAA,MAAM,KAAA,GAAQ,WAAA,KAAgB,EAAA,GAAK,IAAA,GAAO,CAAA,EAAG,MAAM,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,WAAW,CAAC,CAAA,CAAA;AAC7E,EAAA,OAAO,CAAA,EAAG,IAAA,CAAK,KAAA,CAAM,CAAA,EAAG,SAAS,CAAC,CAAA,EAAG,gBAAgB,CAAA,EAAG,YAAA,CAAa,KAAK,CAAC,CAAA,CAAA;AAC7E;;"}

package/dist/index.d.cts

@@ -280,6 +280,8 @@ declare const FIX: {
     readonly EXPLODED_QUERY_OBJECTS: "exploded-query-objects";
     /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */
     readonly NULLABLE_ENUMS: "nullable-enums";
+    /** A parameter with `content` instead of `schema` is typed by the schema of its media type. */
+    readonly PARAMETER_CONTENT: "parameter-content";
     /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */
     readonly PATH_PARAM_TYPE_NAMES: "path-param-type-names";
     /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */
@@ -291,6 +293,11 @@ declare const FIX: {
      * points at, also where the original type compiles through an index signature.
      */
     readonly REF_POINTERS: "ref-pointers";
+    /**
+     * OpenAPI 3.1 and 3.2: keywords next to a `$ref` (`required`, `properties`) apply too, so the
+     * type is the reference intersected with them. OpenAPI 3.0 ignores them, as its spec says.
+     */
+    readonly REF_SIBLINGS: "ref-siblings";
     /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */
     readonly ROOT_TYPE_NUMBERING: "root-type-numbering";
     /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */
@@ -1298,7 +1305,7 @@ interface OpenAPITSBaseOptions {
      * still fail the run.
      */
     lint?: boolean;
-    /** (optional) Should logging be suppressed? (necessary for STDOUT) */
+    /** Hide warnings (default: false). Every line of the logger goes to stderr, never to stdout. */
     silent?: boolean;
     /** Accepted for compatibility with openapi-typescript; not read. */
     version?: number;
@@ -1527,6 +1534,10 @@ declare const ERROR_CODES: {
     readonly CLI_CONFIG_OUTPUT_MISSING: "CLI_CONFIG_OUTPUT_MISSING";
     readonly CLI_CHECK_OUTPUT_MISSING: "CLI_CHECK_OUTPUT_MISSING";
     readonly CLI_INPUT_MISSING: "CLI_INPUT_MISSING";
+    readonly CLI_OUTPUT_IS_INPUT: "CLI_OUTPUT_IS_INPUT";
+    readonly CLI_OUTPUT_DUPLICATE: "CLI_OUTPUT_DUPLICATE";
+    readonly CLI_OUTPUT_INVALID: "CLI_OUTPUT_INVALID";
+    readonly CLI_LOCATION_INVALID: "CLI_LOCATION_INVALID";
     readonly OUTPUT_STALE: "OUTPUT_STALE";
     readonly OUTPUT_READ_FAILED: "OUTPUT_READ_FAILED";
     readonly OUTPUT_WRITE_FAILED: "OUTPUT_WRITE_FAILED";
@@ -1541,12 +1552,15 @@ interface OpenAPITypesafeErrorInit {
     readonly code: ErrorCode;
     readonly message: string;
     readonly details?: ErrorDetails;
-    /** The lower-level error this one reports, if any (kept as the standard `cause`). */
+    /**
+     * The lower-level error this one reports, if any (kept as the standard `cause`; a copy with URL
+     * secrets hidden when its chain names one, see cause-secrets.ts).
+     */
     readonly cause?: unknown;
 }
 /**
  * The base of every expected failure; check `code`, not the class or the message. The message
- * never shows the user info of a URL (`url-credentials.ts`).
+ * and the `cause` chain never show the user info or the query of a URL (`url-secrets.ts`).
  */
 declare class OpenAPITypesafeError extends Error {
     readonly code: ErrorCode;
@@ -1773,7 +1787,11 @@ declare function createDiscriminatorProperty(discriminator: DiscriminatorObject,
     path: string;
     readonly?: boolean;
 }): IrPropertySignature;
-/** Create a $ref pointer (even from other $refs) */
+/**
+ * Create a $ref pointer (even from other $refs). A part that contains `#/` is read as a `$ref`
+ * and contributes its decoded segments, so it throws URIError for a malformed percent escape; any
+ * other part is one segment. To append raw document keys, escape each one instead.
+ */
 declare function createRef(parts: (number | string | undefined | null)[]): string;
 /**
  * Print debug message (cribbed from the `debug` package, but without all the bells & whistles

package/dist/index.d.mts

@@ -280,6 +280,8 @@ declare const FIX: {
     readonly EXPLODED_QUERY_OBJECTS: "exploded-query-objects";
     /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */
     readonly NULLABLE_ENUMS: "nullable-enums";
+    /** A parameter with `content` instead of `schema` is typed by the schema of its media type. */
+    readonly PARAMETER_CONTENT: "parameter-content";
     /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */
     readonly PATH_PARAM_TYPE_NAMES: "path-param-type-names";
     /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */
@@ -291,6 +293,11 @@ declare const FIX: {
      * points at, also where the original type compiles through an index signature.
      */
     readonly REF_POINTERS: "ref-pointers";
+    /**
+     * OpenAPI 3.1 and 3.2: keywords next to a `$ref` (`required`, `properties`) apply too, so the
+     * type is the reference intersected with them. OpenAPI 3.0 ignores them, as its spec says.
+     */
+    readonly REF_SIBLINGS: "ref-siblings";
     /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */
     readonly ROOT_TYPE_NUMBERING: "root-type-numbering";
     /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */
@@ -1298,7 +1305,7 @@ interface OpenAPITSBaseOptions {
      * still fail the run.
      */
     lint?: boolean;
-    /** (optional) Should logging be suppressed? (necessary for STDOUT) */
+    /** Hide warnings (default: false). Every line of the logger goes to stderr, never to stdout. */
     silent?: boolean;
     /** Accepted for compatibility with openapi-typescript; not read. */
     version?: number;
@@ -1527,6 +1534,10 @@ declare const ERROR_CODES: {
     readonly CLI_CONFIG_OUTPUT_MISSING: "CLI_CONFIG_OUTPUT_MISSING";
     readonly CLI_CHECK_OUTPUT_MISSING: "CLI_CHECK_OUTPUT_MISSING";
     readonly CLI_INPUT_MISSING: "CLI_INPUT_MISSING";
+    readonly CLI_OUTPUT_IS_INPUT: "CLI_OUTPUT_IS_INPUT";
+    readonly CLI_OUTPUT_DUPLICATE: "CLI_OUTPUT_DUPLICATE";
+    readonly CLI_OUTPUT_INVALID: "CLI_OUTPUT_INVALID";
+    readonly CLI_LOCATION_INVALID: "CLI_LOCATION_INVALID";
     readonly OUTPUT_STALE: "OUTPUT_STALE";
     readonly OUTPUT_READ_FAILED: "OUTPUT_READ_FAILED";
     readonly OUTPUT_WRITE_FAILED: "OUTPUT_WRITE_FAILED";
@@ -1541,12 +1552,15 @@ interface OpenAPITypesafeErrorInit {
     readonly code: ErrorCode;
     readonly message: string;
     readonly details?: ErrorDetails;
-    /** The lower-level error this one reports, if any (kept as the standard `cause`). */
+    /**
+     * The lower-level error this one reports, if any (kept as the standard `cause`; a copy with URL
+     * secrets hidden when its chain names one, see cause-secrets.ts).
+     */
     readonly cause?: unknown;
 }
 /**
  * The base of every expected failure; check `code`, not the class or the message. The message
- * never shows the user info of a URL (`url-credentials.ts`).
+ * and the `cause` chain never show the user info or the query of a URL (`url-secrets.ts`).
  */
 declare class OpenAPITypesafeError extends Error {
     readonly code: ErrorCode;
@@ -1773,7 +1787,11 @@ declare function createDiscriminatorProperty(discriminator: DiscriminatorObject,
     path: string;
     readonly?: boolean;
 }): IrPropertySignature;
-/** Create a $ref pointer (even from other $refs) */
+/**
+ * Create a $ref pointer (even from other $refs). A part that contains `#/` is read as a `$ref`
+ * and contributes its decoded segments, so it throws URIError for a malformed percent escape; any
+ * other part is one segment. To append raw document keys, escape each one instead.
+ */
 declare function createRef(parts: (number | string | undefined | null)[]): string;
 /**
  * Print debug message (cribbed from the `debug` package, but without all the bells & whistles

package/dist/index.d.ts

@@ -280,6 +280,8 @@ declare const FIX: {
     readonly EXPLODED_QUERY_OBJECTS: "exploded-query-objects";
     /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */
     readonly NULLABLE_ENUMS: "nullable-enums";
+    /** A parameter with `content` instead of `schema` is typed by the schema of its media type. */
+    readonly PARAMETER_CONTENT: "parameter-content";
     /** `--path-params-as-types` gives each `{name}` its placeholder, `{number}` included. */
     readonly PATH_PARAM_TYPE_NAMES: "path-param-type-names";
     /** A `prefixItems` tuple is open unless `items` or `unevaluatedItems` closes it (2020-12). */
@@ -291,6 +293,11 @@ declare const FIX: {
      * points at, also where the original type compiles through an index signature.
      */
     readonly REF_POINTERS: "ref-pointers";
+    /**
+     * OpenAPI 3.1 and 3.2: keywords next to a `$ref` (`required`, `properties`) apply too, so the
+     * type is the reference intersected with them. OpenAPI 3.0 ignores them, as its spec says.
+     */
+    readonly REF_SIBLINGS: "ref-siblings";
     /** Schemas of one root type name without the prefix each get an alias, the earlier numbered. */
     readonly ROOT_TYPE_NUMBERING: "root-type-numbering";
     /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */
@@ -1298,7 +1305,7 @@ interface OpenAPITSBaseOptions {
      * still fail the run.
      */
     lint?: boolean;
-    /** (optional) Should logging be suppressed? (necessary for STDOUT) */
+    /** Hide warnings (default: false). Every line of the logger goes to stderr, never to stdout. */
     silent?: boolean;
     /** Accepted for compatibility with openapi-typescript; not read. */
     version?: number;
@@ -1527,6 +1534,10 @@ declare const ERROR_CODES: {
     readonly CLI_CONFIG_OUTPUT_MISSING: "CLI_CONFIG_OUTPUT_MISSING";
     readonly CLI_CHECK_OUTPUT_MISSING: "CLI_CHECK_OUTPUT_MISSING";
     readonly CLI_INPUT_MISSING: "CLI_INPUT_MISSING";
+    readonly CLI_OUTPUT_IS_INPUT: "CLI_OUTPUT_IS_INPUT";
+    readonly CLI_OUTPUT_DUPLICATE: "CLI_OUTPUT_DUPLICATE";
+    readonly CLI_OUTPUT_INVALID: "CLI_OUTPUT_INVALID";
+    readonly CLI_LOCATION_INVALID: "CLI_LOCATION_INVALID";
     readonly OUTPUT_STALE: "OUTPUT_STALE";
     readonly OUTPUT_READ_FAILED: "OUTPUT_READ_FAILED";
     readonly OUTPUT_WRITE_FAILED: "OUTPUT_WRITE_FAILED";
@@ -1541,12 +1552,15 @@ interface OpenAPITypesafeErrorInit {
     readonly code: ErrorCode;
     readonly message: string;
     readonly details?: ErrorDetails;
-    /** The lower-level error this one reports, if any (kept as the standard `cause`). */
+    /**
+     * The lower-level error this one reports, if any (kept as the standard `cause`; a copy with URL
+     * secrets hidden when its chain names one, see cause-secrets.ts).
+     */
     readonly cause?: unknown;
 }
 /**
  * The base of every expected failure; check `code`, not the class or the message. The message
- * never shows the user info of a URL (`url-credentials.ts`).
+ * and the `cause` chain never show the user info or the query of a URL (`url-secrets.ts`).
  */
 declare class OpenAPITypesafeError extends Error {
     readonly code: ErrorCode;
@@ -1773,7 +1787,11 @@ declare function createDiscriminatorProperty(discriminator: DiscriminatorObject,
     path: string;
     readonly?: boolean;
 }): IrPropertySignature;
-/** Create a $ref pointer (even from other $refs) */
+/**
+ * Create a $ref pointer (even from other $refs). A part that contains `#/` is read as a `$ref`
+ * and contributes its decoded segments, so it throws URIError for a malformed percent escape; any
+ * other part is one segment. To append raw document keys, escape each one instead.
+ */
 declare function createRef(parts: (number | string | undefined | null)[]): string;
 /**
  * Print debug message (cribbed from the `debug` package, but without all the bells & whistles

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openapi-typesafe",
   "description": "Convert OpenAPI 3.0, 3.1 & 3.2 schemas to TypeScript",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0-rc.4",
   "author": {
     "name": "Fedor Chishchin",
     "url": "https://github.com/fedorello"
@@ -35,6 +35,7 @@
     "./*": "./*"
   },
   "files": [
+    "CHANGELOG.md",
     "bin",
     "dist",
     "src"
@@ -61,7 +62,7 @@
   },
   "peerDependencies": {
     "@typescript/typescript6": "^6.0.0",
-    "typescript": ">=5.0.0"
+    "typescript": ">=5.4.0"
   },
   "peerDependenciesMeta": {
     "@typescript/typescript6": {
@@ -106,11 +107,9 @@
     "lint:ts": "tsc --noEmit && tsc -p tsconfig.strict.json",
     "test": "pnpm run test:js && pnpm run test:examples && pnpm run test:exports",
     "test:js": "vitest run",
-    "test:exports": "pnpm run build && ../../scripts/check-exports.sh",
+    "test:exports": "../../scripts/check-exports.sh",
     "test:examples": "tsc -p tsconfig.examples.json --noEmit",
     "update:examples": "pnpm run build && pnpm run download:schemas && vite-node ./scripts/update-examples.ts",
-    "prepublish": "pnpm run build",
-    "version": "pnpm run build",
     "lint:deps": "depcruise src --config .dependency-cruiser.cjs",
     "test:coverage": "vitest run --coverage",
     "lint:sizes": "vite-node scripts/size-rules/check-sizes.ts src"