openapi-typesafe 0.0.0 → 1.0.0-rc.0

package/dist/domain/openapi/unsupported-features.cjs

@@ -0,0 +1,87 @@
+'use strict';
+
+const jsonPointer = require('./json-pointer.cjs');
+const parameterObject = require('./parameter-object.cjs');
+const pathItemObject = require('./path-item-object.cjs');
+
+const UnsupportedFeature = {
+  QUERYSTRING_NEXT_TO_QUERY: "querystring"
+};
+const QUERY_LOCATION = "query";
+const LOCAL_REF_PREFIX = "#/";
+function isObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function resolveLocal(document, value) {
+  if (!isObject(value) || typeof value.$ref !== "string") {
+    return value;
+  }
+  if (!value.$ref.startsWith(LOCAL_REF_PREFIX)) {
+    return null;
+  }
+  let node = document;
+  for (const segment of jsonPointer.parseRefPointer(value.$ref)) {
+    node = isObject(node) || Array.isArray(node) ? node[segment] : void 0;
+  }
+  return node ?? null;
+}
+function locatedParameters(document, parameters, segments) {
+  if (!Array.isArray(parameters)) {
+    return [];
+  }
+  return parameters.flatMap((entry, index) => {
+    const parameter = resolveLocal(document, entry);
+    const pointer = jsonPointer.createRef([...segments, String(index)]);
+    return isObject(parameter) ? [{ pointer, parameter }] : [];
+  });
+}
+function mergedParameters(shared, own) {
+  const byKey = /* @__PURE__ */ new Map();
+  for (const located of [...shared, ...own]) {
+    byKey.set(`${String(located.parameter.in)}-${String(located.parameter.name)}`, located);
+  }
+  return [...byKey.values()];
+}
+function querystringPointers(parameters) {
+  const hasQuery = parameters.some(({ parameter }) => parameter.in === QUERY_LOCATION);
+  return hasQuery ? parameters.filter(({ parameter }) => parameter.in === parameterObject.QUERYSTRING_LOCATION).map(({ pointer }) => pointer) : [];
+}
+function pathItemPointers(document, pathItem, segments) {
+  const shared = locatedParameters(document, pathItem.parameters, [...segments, "parameters"]);
+  return pathItemObject.pathItemOperations(pathItem).flatMap((entry) => {
+    const operation = resolveLocal(document, entry.operation);
+    if (!isObject(operation)) {
+      return [];
+    }
+    const operationSegments = [...segments, ...entry.segments, "parameters"];
+    const own = locatedParameters(document, operation.parameters, operationSegments);
+    return querystringPointers(mergedParameters(shared, own));
+  });
+}
+function pathItemsPointers(document, pathItems, root) {
+  if (!isObject(pathItems)) {
+    return [];
+  }
+  return Object.entries(pathItems).flatMap(
+    ([key, pathItem]) => isObject(pathItem) ? pathItemPointers(document, pathItem, [...root, key]) : []
+  );
+}
+function findUnsupportedFeatures(document) {
+  if (!isObject(document)) {
+    return [];
+  }
+  const components = isObject(document.components) ? document.components : {};
+  const pointers = [
+    ...pathItemsPointers(document, document.paths, ["paths"]),
+    ...pathItemsPointers(document, document.webhooks, ["webhooks"]),
+    ...pathItemsPointers(document, components.pathItems, ["components", "pathItems"])
+  ];
+  return [...new Set(pointers)].map((pointer) => ({
+    feature: UnsupportedFeature.QUERYSTRING_NEXT_TO_QUERY,
+    pointer
+  }));
+}
+
+exports.UnsupportedFeature = UnsupportedFeature;
+exports.findUnsupportedFeatures = findUnsupportedFeatures;
+//# sourceMappingURL=unsupported-features.cjs.map

package/dist/domain/openapi/unsupported-features.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsupported-features.cjs","sources":["../../../src/domain/openapi/unsupported-features.ts"],"sourcesContent":["import { createRef, parseRefPointer } from \"./json-pointer.js\";\nimport { QUERYSTRING_LOCATION } from \"./parameter-object.js\";\nimport { type PathItemObject, pathItemOperations } from \"./path-item-object.js\";\n\n/**\n * OpenAPI 3.2 uses that the generated types leave out, so each one gets a warning. The 3.2\n * features are typed (ADR-020); what is left is an `in: querystring` parameter next to\n * `in: query` parameters of the same operation, which 3.2 does not allow: the `query`\n * parameters keep their types and the `querystring` parameter is not in the output.\n */\nexport const UnsupportedFeature = {\n  QUERYSTRING_NEXT_TO_QUERY: \"querystring\",\n} as const;\nexport type UnsupportedFeature = (typeof UnsupportedFeature)[keyof typeof UnsupportedFeature];\n\n/** One place in the document that uses a feature the output leaves out. */\nexport interface UnsupportedFeatureUse {\n  readonly feature: UnsupportedFeature;\n  /** A JSON Pointer to the object that has the feature's key, such as `#/paths/~1items`. */\n  readonly pointer: string;\n}\n\nconst QUERY_LOCATION = \"query\";\nconst LOCAL_REF_PREFIX = \"#/\";\n\ntype JsonObject = Readonly<Record<string, unknown>>;\n\nfunction isObject(value: unknown): value is JsonObject {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/** The value at a local `$ref` (`#/...`) of the document; null for other or broken `$ref`s. */\nfunction resolveLocal(document: JsonObject, value: unknown): unknown {\n  if (!isObject(value) || typeof value.$ref !== \"string\") {\n    return value;\n  }\n  if (!value.$ref.startsWith(LOCAL_REF_PREFIX)) {\n    return null;\n  }\n  let node: unknown = document;\n  for (const segment of parseRefPointer(value.$ref)) {\n    node = isObject(node) || Array.isArray(node) ? (node as JsonObject)[segment] : undefined;\n  }\n  return node ?? null;\n}\n\n/** A parameter where it is written, with the object its `$ref` points to. */\ninterface LocatedParameter {\n  readonly pointer: string;\n  readonly parameter: JsonObject;\n}\n\nfunction locatedParameters(\n  document: JsonObject,\n  parameters: unknown,\n  segments: readonly string[],\n): LocatedParameter[] {\n  if (!Array.isArray(parameters)) {\n    return [];\n  }\n  return parameters.flatMap((entry, index) => {\n    const parameter = resolveLocal(document, entry);\n    const pointer = createRef([...segments, String(index)]);\n    return isObject(parameter) ? [{ pointer, parameter }] : [];\n  });\n}\n\n/** Path item parameters, then the operation's, which replace those of the same `in` and name. */\nfunction mergedParameters(\n  shared: readonly LocatedParameter[],\n  own: readonly LocatedParameter[],\n): LocatedParameter[] {\n  const byKey = new Map<string, LocatedParameter>();\n  for (const located of [...shared, ...own]) {\n    byKey.set(`${String(located.parameter.in)}-${String(located.parameter.name)}`, located);\n  }\n  return [...byKey.values()];\n}\n\n/** The `querystring` parameters of one operation that has `in: query` parameters as well. */\nfunction querystringPointers(parameters: readonly LocatedParameter[]): string[] {\n  const hasQuery = parameters.some(({ parameter }) => parameter.in === QUERY_LOCATION);\n  return hasQuery\n    ? parameters\n        .filter(({ parameter }) => parameter.in === QUERYSTRING_LOCATION)\n        .map(({ pointer }) => pointer)\n    : [];\n}\n\n/** Pointers of `querystring` parameters next to `query` ones in the operations of a path item. */\nfunction pathItemPointers(\n  document: JsonObject,\n  pathItem: JsonObject,\n  segments: readonly string[],\n): string[] {\n  const shared = locatedParameters(document, pathItem.parameters, [...segments, \"parameters\"]);\n  return pathItemOperations(pathItem as PathItemObject).flatMap((entry) => {\n    const operation = resolveLocal(document, entry.operation);\n    if (!isObject(operation)) {\n      return [];\n    }\n    const operationSegments = [...segments, ...entry.segments, \"parameters\"];\n    const own = locatedParameters(document, operation.parameters, operationSegments);\n    return querystringPointers(mergedParameters(shared, own));\n  });\n}\n\nfunction pathItemsPointers(\n  document: JsonObject,\n  pathItems: unknown,\n  root: readonly string[],\n): string[] {\n  if (!isObject(pathItems)) {\n    return [];\n  }\n  return Object.entries(pathItems).flatMap(([key, pathItem]) =>\n    isObject(pathItem) ? pathItemPointers(document, pathItem, [...root, key]) : [],\n  );\n}\n\n/**\n * Every use of a feature in `UnsupportedFeature`, once per pointer, in document order: `paths`,\n * then `webhooks`, then `components.pathItems`.\n */\nexport function findUnsupportedFeatures(document: unknown): UnsupportedFeatureUse[] {\n  if (!isObject(document)) {\n    return [];\n  }\n  const components = isObject(document.components) ? document.components : {};\n  const pointers = [\n    ...pathItemsPointers(document, document.paths, [\"paths\"]),\n    ...pathItemsPointers(document, document.webhooks, [\"webhooks\"]),\n    ...pathItemsPointers(document, components.pathItems, [\"components\", \"pathItems\"]),\n  ];\n  return [...new Set(pointers)].map((pointer) => ({\n    feature: UnsupportedFeature.QUERYSTRING_NEXT_TO_QUERY,\n    pointer,\n  }));\n}\n"],"names":["parseRefPointer","createRef","QUERYSTRING_LOCATION","pathItemOperations"],"mappings":";;;;;;AAUO,MAAM,kBAAA,GAAqB;AAAA,EAChC,yBAAA,EAA2B;AAC7B;AAUA,MAAM,cAAA,GAAiB,OAAA;AACvB,MAAM,gBAAA,GAAmB,IAAA;AAIzB,SAAS,SAAS,KAAA,EAAqC;AACrD,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAGA,SAAS,YAAA,CAAa,UAAsB,KAAA,EAAyB;AACnE,EAAA,IAAI,CAAC,QAAA,CAAS,KAAK,KAAK,OAAO,KAAA,CAAM,SAAS,QAAA,EAAU;AACtD,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,IAAI,CAAC,KAAA,CAAM,IAAA,CAAK,UAAA,CAAW,gBAAgB,CAAA,EAAG;AAC5C,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,IAAI,IAAA,GAAgB,QAAA;AACpB,EAAA,KAAA,MAAW,OAAA,IAAWA,2BAAA,CAAgB,KAAA,CAAM,IAAI,CAAA,EAAG;AACjD,IAAA,IAAA,GAAO,QAAA,CAAS,IAAI,CAAA,IAAK,KAAA,CAAM,QAAQ,IAAI,CAAA,GAAK,IAAA,CAAoB,OAAO,CAAA,GAAI,MAAA;AAAA,EACjF;AACA,EAAA,OAAO,IAAA,IAAQ,IAAA;AACjB;AAQA,SAAS,iBAAA,CACP,QAAA,EACA,UAAA,EACA,QAAA,EACoB;AACpB,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,UAAU,CAAA,EAAG;AAC9B,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,UAAA,CAAW,OAAA,CAAQ,CAAC,KAAA,EAAO,KAAA,KAAU;AAC1C,IAAA,MAAM,SAAA,GAAY,YAAA,CAAa,QAAA,EAAU,KAAK,CAAA;AAC9C,IAAA,MAAM,OAAA,GAAUC,sBAAU,CAAC,GAAG,UAAU,MAAA,CAAO,KAAK,CAAC,CAAC,CAAA;AACtD,IAAA,OAAO,QAAA,CAAS,SAAS,CAAA,GAAI,CAAC,EAAE,OAAA,EAAS,SAAA,EAAW,CAAA,GAAI,EAAC;AAAA,EAC3D,CAAC,CAAA;AACH;AAGA,SAAS,gBAAA,CACP,QACA,GAAA,EACoB;AACpB,EAAA,MAAM,KAAA,uBAAY,GAAA,EAA8B;AAChD,EAAA,KAAA,MAAW,WAAW,CAAC,GAAG,MAAA,EAAQ,GAAG,GAAG,CAAA,EAAG;AACzC,IAAA,KAAA,CAAM,GAAA,CAAI,CAAA,EAAG,MAAA,CAAO,OAAA,CAAQ,UAAU,EAAE,CAAC,CAAA,CAAA,EAAI,MAAA,CAAO,OAAA,CAAQ,SAAA,CAAU,IAAI,CAAC,IAAI,OAAO,CAAA;AAAA,EACxF;AACA,EAAA,OAAO,CAAC,GAAG,KAAA,CAAM,MAAA,EAAQ,CAAA;AAC3B;AAGA,SAAS,oBAAoB,UAAA,EAAmD;AAC9E,EAAA,MAAM,QAAA,GAAW,WAAW,IAAA,CAAK,CAAC,EAAE,SAAA,EAAU,KAAM,SAAA,CAAU,EAAA,KAAO,cAAc,CAAA;AACnF,EAAA,OAAO,WACH,UAAA,CACG,MAAA,CAAO,CAAC,EAAE,SAAA,OAAgB,SAAA,CAAU,EAAA,KAAOC,oCAAoB,CAAA,CAC/D,IAAI,CAAC,EAAE,SAAQ,KAAM,OAAO,IAC/B,EAAC;AACP;AAGA,SAAS,gBAAA,CACP,QAAA,EACA,QAAA,EACA,QAAA,EACU;AACV,EAAA,MAAM,MAAA,GAAS,kBAAkB,QAAA,EAAU,QAAA,CAAS,YAAY,CAAC,GAAG,QAAA,EAAU,YAAY,CAAC,CAAA;AAC3F,EAAA,OAAOC,iCAAA,CAAmB,QAA0B,CAAA,CAAE,OAAA,CAAQ,CAAC,KAAA,KAAU;AACvE,IAAA,MAAM,SAAA,GAAY,YAAA,CAAa,QAAA,EAAU,KAAA,CAAM,SAAS,CAAA;AACxD,IAAA,IAAI,CAAC,QAAA,CAAS,SAAS,CAAA,EAAG;AACxB,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,MAAM,oBAAoB,CAAC,GAAG,UAAU,GAAG,KAAA,CAAM,UAAU,YAAY,CAAA;AACvE,IAAA,MAAM,GAAA,GAAM,iBAAA,CAAkB,QAAA,EAAU,SAAA,CAAU,YAAY,iBAAiB,CAAA;AAC/E,IAAA,OAAO,mBAAA,CAAoB,gBAAA,CAAiB,MAAA,EAAQ,GAAG,CAAC,CAAA;AAAA,EAC1D,CAAC,CAAA;AACH;AAEA,SAAS,iBAAA,CACP,QAAA,EACA,SAAA,EACA,IAAA,EACU;AACV,EAAA,IAAI,CAAC,QAAA,CAAS,SAAS,CAAA,EAAG;AACxB,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,MAAA,CAAO,OAAA,CAAQ,SAAS,CAAA,CAAE,OAAA;AAAA,IAAQ,CAAC,CAAC,GAAA,EAAK,QAAQ,CAAA,KACtD,SAAS,QAAQ,CAAA,GAAI,gBAAA,CAAiB,QAAA,EAAU,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,IAAI;AAAC,GAC/E;AACF;AAMO,SAAS,wBAAwB,QAAA,EAA4C;AAClF,EAAA,IAAI,CAAC,QAAA,CAAS,QAAQ,CAAA,EAAG;AACvB,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,aAAa,QAAA,CAAS,QAAA,CAAS,UAAU,CAAA,GAAI,QAAA,CAAS,aAAa,EAAC;AAC1E,EAAA,MAAM,QAAA,GAAW;AAAA,IACf,GAAG,iBAAA,CAAkB,QAAA,EAAU,SAAS,KAAA,EAAO,CAAC,OAAO,CAAC,CAAA;AAAA,IACxD,GAAG,iBAAA,CAAkB,QAAA,EAAU,SAAS,QAAA,EAAU,CAAC,UAAU,CAAC,CAAA;AAAA,IAC9D,GAAG,kBAAkB,QAAA,EAAU,UAAA,CAAW,WAAW,CAAC,YAAA,EAAc,WAAW,CAAC;AAAA,GAClF;AACA,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,QAAQ,CAAC,CAAA,CAAE,GAAA,CAAI,CAAC,OAAA,MAAa;AAAA,IAC9C,SAAS,kBAAA,CAAmB,yBAAA;AAAA,IAC5B;AAAA,GACF,CAAE,CAAA;AACJ;;;"}

package/dist/domain/openapi/unsupported-features.mjs

@@ -0,0 +1,84 @@
+import { createRef, parseRefPointer } from './json-pointer.mjs';
+import { QUERYSTRING_LOCATION } from './parameter-object.mjs';
+import { pathItemOperations } from './path-item-object.mjs';
+
+const UnsupportedFeature = {
+  QUERYSTRING_NEXT_TO_QUERY: "querystring"
+};
+const QUERY_LOCATION = "query";
+const LOCAL_REF_PREFIX = "#/";
+function isObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function resolveLocal(document, value) {
+  if (!isObject(value) || typeof value.$ref !== "string") {
+    return value;
+  }
+  if (!value.$ref.startsWith(LOCAL_REF_PREFIX)) {
+    return null;
+  }
+  let node = document;
+  for (const segment of parseRefPointer(value.$ref)) {
+    node = isObject(node) || Array.isArray(node) ? node[segment] : void 0;
+  }
+  return node ?? null;
+}
+function locatedParameters(document, parameters, segments) {
+  if (!Array.isArray(parameters)) {
+    return [];
+  }
+  return parameters.flatMap((entry, index) => {
+    const parameter = resolveLocal(document, entry);
+    const pointer = createRef([...segments, String(index)]);
+    return isObject(parameter) ? [{ pointer, parameter }] : [];
+  });
+}
+function mergedParameters(shared, own) {
+  const byKey = /* @__PURE__ */ new Map();
+  for (const located of [...shared, ...own]) {
+    byKey.set(`${String(located.parameter.in)}-${String(located.parameter.name)}`, located);
+  }
+  return [...byKey.values()];
+}
+function querystringPointers(parameters) {
+  const hasQuery = parameters.some(({ parameter }) => parameter.in === QUERY_LOCATION);
+  return hasQuery ? parameters.filter(({ parameter }) => parameter.in === QUERYSTRING_LOCATION).map(({ pointer }) => pointer) : [];
+}
+function pathItemPointers(document, pathItem, segments) {
+  const shared = locatedParameters(document, pathItem.parameters, [...segments, "parameters"]);
+  return pathItemOperations(pathItem).flatMap((entry) => {
+    const operation = resolveLocal(document, entry.operation);
+    if (!isObject(operation)) {
+      return [];
+    }
+    const operationSegments = [...segments, ...entry.segments, "parameters"];
+    const own = locatedParameters(document, operation.parameters, operationSegments);
+    return querystringPointers(mergedParameters(shared, own));
+  });
+}
+function pathItemsPointers(document, pathItems, root) {
+  if (!isObject(pathItems)) {
+    return [];
+  }
+  return Object.entries(pathItems).flatMap(
+    ([key, pathItem]) => isObject(pathItem) ? pathItemPointers(document, pathItem, [...root, key]) : []
+  );
+}
+function findUnsupportedFeatures(document) {
+  if (!isObject(document)) {
+    return [];
+  }
+  const components = isObject(document.components) ? document.components : {};
+  const pointers = [
+    ...pathItemsPointers(document, document.paths, ["paths"]),
+    ...pathItemsPointers(document, document.webhooks, ["webhooks"]),
+    ...pathItemsPointers(document, components.pathItems, ["components", "pathItems"])
+  ];
+  return [...new Set(pointers)].map((pointer) => ({
+    feature: UnsupportedFeature.QUERYSTRING_NEXT_TO_QUERY,
+    pointer
+  }));
+}
+
+export { UnsupportedFeature, findUnsupportedFeatures };
+//# sourceMappingURL=unsupported-features.mjs.map

package/dist/domain/openapi/unsupported-features.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsupported-features.mjs","sources":["../../../src/domain/openapi/unsupported-features.ts"],"sourcesContent":["import { createRef, parseRefPointer } from \"./json-pointer.js\";\nimport { QUERYSTRING_LOCATION } from \"./parameter-object.js\";\nimport { type PathItemObject, pathItemOperations } from \"./path-item-object.js\";\n\n/**\n * OpenAPI 3.2 uses that the generated types leave out, so each one gets a warning. The 3.2\n * features are typed (ADR-020); what is left is an `in: querystring` parameter next to\n * `in: query` parameters of the same operation, which 3.2 does not allow: the `query`\n * parameters keep their types and the `querystring` parameter is not in the output.\n */\nexport const UnsupportedFeature = {\n  QUERYSTRING_NEXT_TO_QUERY: \"querystring\",\n} as const;\nexport type UnsupportedFeature = (typeof UnsupportedFeature)[keyof typeof UnsupportedFeature];\n\n/** One place in the document that uses a feature the output leaves out. */\nexport interface UnsupportedFeatureUse {\n  readonly feature: UnsupportedFeature;\n  /** A JSON Pointer to the object that has the feature's key, such as `#/paths/~1items`. */\n  readonly pointer: string;\n}\n\nconst QUERY_LOCATION = \"query\";\nconst LOCAL_REF_PREFIX = \"#/\";\n\ntype JsonObject = Readonly<Record<string, unknown>>;\n\nfunction isObject(value: unknown): value is JsonObject {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/** The value at a local `$ref` (`#/...`) of the document; null for other or broken `$ref`s. */\nfunction resolveLocal(document: JsonObject, value: unknown): unknown {\n  if (!isObject(value) || typeof value.$ref !== \"string\") {\n    return value;\n  }\n  if (!value.$ref.startsWith(LOCAL_REF_PREFIX)) {\n    return null;\n  }\n  let node: unknown = document;\n  for (const segment of parseRefPointer(value.$ref)) {\n    node = isObject(node) || Array.isArray(node) ? (node as JsonObject)[segment] : undefined;\n  }\n  return node ?? null;\n}\n\n/** A parameter where it is written, with the object its `$ref` points to. */\ninterface LocatedParameter {\n  readonly pointer: string;\n  readonly parameter: JsonObject;\n}\n\nfunction locatedParameters(\n  document: JsonObject,\n  parameters: unknown,\n  segments: readonly string[],\n): LocatedParameter[] {\n  if (!Array.isArray(parameters)) {\n    return [];\n  }\n  return parameters.flatMap((entry, index) => {\n    const parameter = resolveLocal(document, entry);\n    const pointer = createRef([...segments, String(index)]);\n    return isObject(parameter) ? [{ pointer, parameter }] : [];\n  });\n}\n\n/** Path item parameters, then the operation's, which replace those of the same `in` and name. */\nfunction mergedParameters(\n  shared: readonly LocatedParameter[],\n  own: readonly LocatedParameter[],\n): LocatedParameter[] {\n  const byKey = new Map<string, LocatedParameter>();\n  for (const located of [...shared, ...own]) {\n    byKey.set(`${String(located.parameter.in)}-${String(located.parameter.name)}`, located);\n  }\n  return [...byKey.values()];\n}\n\n/** The `querystring` parameters of one operation that has `in: query` parameters as well. */\nfunction querystringPointers(parameters: readonly LocatedParameter[]): string[] {\n  const hasQuery = parameters.some(({ parameter }) => parameter.in === QUERY_LOCATION);\n  return hasQuery\n    ? parameters\n        .filter(({ parameter }) => parameter.in === QUERYSTRING_LOCATION)\n        .map(({ pointer }) => pointer)\n    : [];\n}\n\n/** Pointers of `querystring` parameters next to `query` ones in the operations of a path item. */\nfunction pathItemPointers(\n  document: JsonObject,\n  pathItem: JsonObject,\n  segments: readonly string[],\n): string[] {\n  const shared = locatedParameters(document, pathItem.parameters, [...segments, \"parameters\"]);\n  return pathItemOperations(pathItem as PathItemObject).flatMap((entry) => {\n    const operation = resolveLocal(document, entry.operation);\n    if (!isObject(operation)) {\n      return [];\n    }\n    const operationSegments = [...segments, ...entry.segments, \"parameters\"];\n    const own = locatedParameters(document, operation.parameters, operationSegments);\n    return querystringPointers(mergedParameters(shared, own));\n  });\n}\n\nfunction pathItemsPointers(\n  document: JsonObject,\n  pathItems: unknown,\n  root: readonly string[],\n): string[] {\n  if (!isObject(pathItems)) {\n    return [];\n  }\n  return Object.entries(pathItems).flatMap(([key, pathItem]) =>\n    isObject(pathItem) ? pathItemPointers(document, pathItem, [...root, key]) : [],\n  );\n}\n\n/**\n * Every use of a feature in `UnsupportedFeature`, once per pointer, in document order: `paths`,\n * then `webhooks`, then `components.pathItems`.\n */\nexport function findUnsupportedFeatures(document: unknown): UnsupportedFeatureUse[] {\n  if (!isObject(document)) {\n    return [];\n  }\n  const components = isObject(document.components) ? document.components : {};\n  const pointers = [\n    ...pathItemsPointers(document, document.paths, [\"paths\"]),\n    ...pathItemsPointers(document, document.webhooks, [\"webhooks\"]),\n    ...pathItemsPointers(document, components.pathItems, [\"components\", \"pathItems\"]),\n  ];\n  return [...new Set(pointers)].map((pointer) => ({\n    feature: UnsupportedFeature.QUERYSTRING_NEXT_TO_QUERY,\n    pointer,\n  }));\n}\n"],"names":[],"mappings":";;;;AAUO,MAAM,kBAAA,GAAqB;AAAA,EAChC,yBAAA,EAA2B;AAC7B;AAUA,MAAM,cAAA,GAAiB,OAAA;AACvB,MAAM,gBAAA,GAAmB,IAAA;AAIzB,SAAS,SAAS,KAAA,EAAqC;AACrD,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAGA,SAAS,YAAA,CAAa,UAAsB,KAAA,EAAyB;AACnE,EAAA,IAAI,CAAC,QAAA,CAAS,KAAK,KAAK,OAAO,KAAA,CAAM,SAAS,QAAA,EAAU;AACtD,IAAA,OAAO,KAAA;AAAA,EACT;AACA,EAAA,IAAI,CAAC,KAAA,CAAM,IAAA,CAAK,UAAA,CAAW,gBAAgB,CAAA,EAAG;AAC5C,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,IAAI,IAAA,GAAgB,QAAA;AACpB,EAAA,KAAA,MAAW,OAAA,IAAW,eAAA,CAAgB,KAAA,CAAM,IAAI,CAAA,EAAG;AACjD,IAAA,IAAA,GAAO,QAAA,CAAS,IAAI,CAAA,IAAK,KAAA,CAAM,QAAQ,IAAI,CAAA,GAAK,IAAA,CAAoB,OAAO,CAAA,GAAI,MAAA;AAAA,EACjF;AACA,EAAA,OAAO,IAAA,IAAQ,IAAA;AACjB;AAQA,SAAS,iBAAA,CACP,QAAA,EACA,UAAA,EACA,QAAA,EACoB;AACpB,EAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,UAAU,CAAA,EAAG;AAC9B,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,UAAA,CAAW,OAAA,CAAQ,CAAC,KAAA,EAAO,KAAA,KAAU;AAC1C,IAAA,MAAM,SAAA,GAAY,YAAA,CAAa,QAAA,EAAU,KAAK,CAAA;AAC9C,IAAA,MAAM,OAAA,GAAU,UAAU,CAAC,GAAG,UAAU,MAAA,CAAO,KAAK,CAAC,CAAC,CAAA;AACtD,IAAA,OAAO,QAAA,CAAS,SAAS,CAAA,GAAI,CAAC,EAAE,OAAA,EAAS,SAAA,EAAW,CAAA,GAAI,EAAC;AAAA,EAC3D,CAAC,CAAA;AACH;AAGA,SAAS,gBAAA,CACP,QACA,GAAA,EACoB;AACpB,EAAA,MAAM,KAAA,uBAAY,GAAA,EAA8B;AAChD,EAAA,KAAA,MAAW,WAAW,CAAC,GAAG,MAAA,EAAQ,GAAG,GAAG,CAAA,EAAG;AACzC,IAAA,KAAA,CAAM,GAAA,CAAI,CAAA,EAAG,MAAA,CAAO,OAAA,CAAQ,UAAU,EAAE,CAAC,CAAA,CAAA,EAAI,MAAA,CAAO,OAAA,CAAQ,SAAA,CAAU,IAAI,CAAC,IAAI,OAAO,CAAA;AAAA,EACxF;AACA,EAAA,OAAO,CAAC,GAAG,KAAA,CAAM,MAAA,EAAQ,CAAA;AAC3B;AAGA,SAAS,oBAAoB,UAAA,EAAmD;AAC9E,EAAA,MAAM,QAAA,GAAW,WAAW,IAAA,CAAK,CAAC,EAAE,SAAA,EAAU,KAAM,SAAA,CAAU,EAAA,KAAO,cAAc,CAAA;AACnF,EAAA,OAAO,WACH,UAAA,CACG,MAAA,CAAO,CAAC,EAAE,SAAA,OAAgB,SAAA,CAAU,EAAA,KAAO,oBAAoB,CAAA,CAC/D,IAAI,CAAC,EAAE,SAAQ,KAAM,OAAO,IAC/B,EAAC;AACP;AAGA,SAAS,gBAAA,CACP,QAAA,EACA,QAAA,EACA,QAAA,EACU;AACV,EAAA,MAAM,MAAA,GAAS,kBAAkB,QAAA,EAAU,QAAA,CAAS,YAAY,CAAC,GAAG,QAAA,EAAU,YAAY,CAAC,CAAA;AAC3F,EAAA,OAAO,kBAAA,CAAmB,QAA0B,CAAA,CAAE,OAAA,CAAQ,CAAC,KAAA,KAAU;AACvE,IAAA,MAAM,SAAA,GAAY,YAAA,CAAa,QAAA,EAAU,KAAA,CAAM,SAAS,CAAA;AACxD,IAAA,IAAI,CAAC,QAAA,CAAS,SAAS,CAAA,EAAG;AACxB,MAAA,OAAO,EAAC;AAAA,IACV;AACA,IAAA,MAAM,oBAAoB,CAAC,GAAG,UAAU,GAAG,KAAA,CAAM,UAAU,YAAY,CAAA;AACvE,IAAA,MAAM,GAAA,GAAM,iBAAA,CAAkB,QAAA,EAAU,SAAA,CAAU,YAAY,iBAAiB,CAAA;AAC/E,IAAA,OAAO,mBAAA,CAAoB,gBAAA,CAAiB,MAAA,EAAQ,GAAG,CAAC,CAAA;AAAA,EAC1D,CAAC,CAAA;AACH;AAEA,SAAS,iBAAA,CACP,QAAA,EACA,SAAA,EACA,IAAA,EACU;AACV,EAAA,IAAI,CAAC,QAAA,CAAS,SAAS,CAAA,EAAG;AACxB,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,OAAO,MAAA,CAAO,OAAA,CAAQ,SAAS,CAAA,CAAE,OAAA;AAAA,IAAQ,CAAC,CAAC,GAAA,EAAK,QAAQ,CAAA,KACtD,SAAS,QAAQ,CAAA,GAAI,gBAAA,CAAiB,QAAA,EAAU,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,IAAI;AAAC,GAC/E;AACF;AAMO,SAAS,wBAAwB,QAAA,EAA4C;AAClF,EAAA,IAAI,CAAC,QAAA,CAAS,QAAQ,CAAA,EAAG;AACvB,IAAA,OAAO,EAAC;AAAA,EACV;AACA,EAAA,MAAM,aAAa,QAAA,CAAS,QAAA,CAAS,UAAU,CAAA,GAAI,QAAA,CAAS,aAAa,EAAC;AAC1E,EAAA,MAAM,QAAA,GAAW;AAAA,IACf,GAAG,iBAAA,CAAkB,QAAA,EAAU,SAAS,KAAA,EAAO,CAAC,OAAO,CAAC,CAAA;AAAA,IACxD,GAAG,iBAAA,CAAkB,QAAA,EAAU,SAAS,QAAA,EAAU,CAAC,UAAU,CAAC,CAAA;AAAA,IAC9D,GAAG,kBAAkB,QAAA,EAAU,UAAA,CAAW,WAAW,CAAC,YAAA,EAAc,WAAW,CAAC;AAAA,GAClF;AACA,EAAA,OAAO,CAAC,GAAG,IAAI,GAAA,CAAI,QAAQ,CAAC,CAAA,CAAE,GAAA,CAAI,CAAC,OAAA,MAAa;AAAA,IAC9C,SAAS,kBAAA,CAAmB,yBAAA;AAAA,IAC5B;AAAA,GACF,CAAE,CAAA;AACJ;;"}

package/dist/domain/output-fixes.cjs

@@ -0,0 +1,66 @@
+'use strict';
+
+const errors = require('./errors.cjs');
+
+const OutputFix = {
+  /** An `allOf` member with only `required` makes those properties of the others required. */
+  ALLOF_REQUIRED: "allof-required",
+  /** `anyOf` next to object keywords or `allOf` is intersected with them, not added to a union. */
+  ANYOF_PROPERTIES: "anyof-properties",
+  /** `--array-length` tuples have `min` to `max` items, nest right and follow `--immutable`. */
+  ARRAY_LENGTH_TUPLES: "array-length-tuples",
+  /** A schema two discriminators name gets one enum of their values, a mapping before its name. */
+  DISCRIMINATOR_VALUES: "discriminator-values",
+  /** 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). */
+  UNEVALUATED_PROPERTIES: "unevaluated-properties"
+};
+const OUTPUT_FIXES = Object.values(OutputFix);
+const ALL_OUTPUT_FIXES = "all";
+const KNOWN_NAMES = /* @__PURE__ */ new Set([...OUTPUT_FIXES, ALL_OUTPUT_FIXES]);
+function isOutputFixName(value) {
+  return typeof value === "string" && KNOWN_NAMES.has(value);
+}
+function outputFixNamesOf(values) {
+  const unknown = values.filter((value) => !isOutputFixName(value));
+  if (unknown.length > 0) {
+    const names = unknown.map((value) => JSON.stringify(value)).join(", ");
+    const known = [...KNOWN_NAMES].join(", ");
+    throw new errors.OpenAPITypesafeError({
+      code: errors.ERROR_CODES.OPTION_FIX_UNKNOWN,
+      message: `Unknown fix ${names}. Known fixes: ${known}.`,
+      details: { unknown, known: [...KNOWN_NAMES] }
+    });
+  }
+  return values;
+}
+function resolveOutputFixes(names) {
+  return new Set(names.flatMap((name) => name === ALL_OUTPUT_FIXES ? OUTPUT_FIXES : [name]));
+}
+const ROOT_TYPES = { option: "rootTypes", flag: "--root-types" };
+const NO_SCHEMA_PREFIX = {
+  option: "rootTypesNoSchemaPrefix",
+  flag: "--root-types-no-schema-prefix"
+};
+const REQUIREMENTS = {
+  [OutputFix.ARRAY_LENGTH_TUPLES]: [{ option: "arrayLength", flag: "--array-length" }],
+  [OutputFix.ROOT_TYPE_NUMBERING]: [ROOT_TYPES, NO_SCHEMA_PREFIX]
+};
+function describeRequirement(requirement) {
+  return `${requirement.option} (${requirement.flag})`;
+}
+function ineffectiveFixNotices(names, isOptionOn) {
+  return [...new Set(names)].flatMap((name) => {
+    const missing = (REQUIREMENTS[name] ?? []).filter(({ option }) => !isOptionOn(option));
+    return missing.length === 0 ? [] : [`Fix "${name}" has no effect without ${missing.map(describeRequirement).join(" and ")}`];
+  });
+}
+
+exports.ALL_OUTPUT_FIXES = ALL_OUTPUT_FIXES;
+exports.OUTPUT_FIXES = OUTPUT_FIXES;
+exports.OutputFix = OutputFix;
+exports.ineffectiveFixNotices = ineffectiveFixNotices;
+exports.outputFixNamesOf = outputFixNamesOf;
+exports.resolveOutputFixes = resolveOutputFixes;
+//# sourceMappingURL=output-fixes.cjs.map

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

@@ -0,0 +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.\n */\nexport const OutputFix = {\n  /** An `allOf` member with only `required` makes those properties of the others required. */\n  ALLOF_REQUIRED: \"allof-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  /** A schema two discriminators name gets one enum of their values, a mapping before its name. */\n  DISCRIMINATOR_VALUES: \"discriminator-values\",\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;\nexport type OutputFix = (typeof OutputFix)[keyof typeof OutputFix];\n\n/** Every fix of this version, in the order the docs list them. */\nexport const OUTPUT_FIXES: readonly OutputFix[] = Object.values(OutputFix);\n\n/** The name that turns on every fix of the installed version. */\nexport const ALL_OUTPUT_FIXES = \"all\";\n\n/** A name the `fix` option accepts: one fix, or `all`. */\nexport type OutputFixName = OutputFix | typeof ALL_OUTPUT_FIXES;\n\nconst KNOWN_NAMES: ReadonlySet<string> = new Set<string>([...OUTPUT_FIXES, ALL_OUTPUT_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_OUTPUT_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: \"arrayLength\" | \"rootTypes\" | \"rootTypesNoSchemaPrefix\";\n  readonly flag: string;\n}\n\nconst ROOT_TYPES = { option: \"rootTypes\", flag: \"--root-types\" } 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  [OutputFix.ARRAY_LENGTH_TUPLES]: [{ option: \"arrayLength\", flag: \"--array-length\" }],\n  [OutputFix.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":";;;;AAOO,MAAM,SAAA,GAAY;AAAA;AAAA,EAEvB,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,gBAAA,EAAkB,kBAAA;AAAA;AAAA,EAElB,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,sBAAA,EAAwB;AAC1B;AAIO,MAAM,YAAA,GAAqC,MAAA,CAAO,MAAA,CAAO,SAAS;AAGlE,MAAM,gBAAA,GAAmB;AAKhC,MAAM,8BAAmC,IAAI,GAAA,CAAY,CAAC,GAAG,YAAA,EAAc,gBAAgB,CAAC,CAAA;AAE5F,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,gBAAA,GAAmB,YAAA,GAAe,CAAC,IAAI,CAAE,CAAC,CAAA;AAC7F;AAQA,MAAM,UAAA,GAAa,EAAE,MAAA,EAAQ,WAAA,EAAa,MAAM,cAAA,EAAe;AAC/D,MAAM,gBAAA,GAAmB;AAAA,EACvB,MAAA,EAAQ,yBAAA;AAAA,EACR,IAAA,EAAM;AACR,CAAA;AAGA,MAAM,YAAA,GAA0F;AAAA,EAC9F,CAAC,SAAA,CAAU,mBAAmB,GAAG,CAAC,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EACnF,CAAC,SAAA,CAAU,mBAAmB,GAAG,CAAC,YAAY,gBAAgB;AAChE,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

@@ -0,0 +1,59 @@
+import { OpenAPITypesafeError, ERROR_CODES } from './errors.mjs';
+
+const OutputFix = {
+  /** An `allOf` member with only `required` makes those properties of the others required. */
+  ALLOF_REQUIRED: "allof-required",
+  /** `anyOf` next to object keywords or `allOf` is intersected with them, not added to a union. */
+  ANYOF_PROPERTIES: "anyof-properties",
+  /** `--array-length` tuples have `min` to `max` items, nest right and follow `--immutable`. */
+  ARRAY_LENGTH_TUPLES: "array-length-tuples",
+  /** A schema two discriminators name gets one enum of their values, a mapping before its name. */
+  DISCRIMINATOR_VALUES: "discriminator-values",
+  /** 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). */
+  UNEVALUATED_PROPERTIES: "unevaluated-properties"
+};
+const OUTPUT_FIXES = Object.values(OutputFix);
+const ALL_OUTPUT_FIXES = "all";
+const KNOWN_NAMES = /* @__PURE__ */ new Set([...OUTPUT_FIXES, ALL_OUTPUT_FIXES]);
+function isOutputFixName(value) {
+  return typeof value === "string" && KNOWN_NAMES.has(value);
+}
+function outputFixNamesOf(values) {
+  const unknown = values.filter((value) => !isOutputFixName(value));
+  if (unknown.length > 0) {
+    const names = unknown.map((value) => JSON.stringify(value)).join(", ");
+    const known = [...KNOWN_NAMES].join(", ");
+    throw new OpenAPITypesafeError({
+      code: ERROR_CODES.OPTION_FIX_UNKNOWN,
+      message: `Unknown fix ${names}. Known fixes: ${known}.`,
+      details: { unknown, known: [...KNOWN_NAMES] }
+    });
+  }
+  return values;
+}
+function resolveOutputFixes(names) {
+  return new Set(names.flatMap((name) => name === ALL_OUTPUT_FIXES ? OUTPUT_FIXES : [name]));
+}
+const ROOT_TYPES = { option: "rootTypes", flag: "--root-types" };
+const NO_SCHEMA_PREFIX = {
+  option: "rootTypesNoSchemaPrefix",
+  flag: "--root-types-no-schema-prefix"
+};
+const REQUIREMENTS = {
+  [OutputFix.ARRAY_LENGTH_TUPLES]: [{ option: "arrayLength", flag: "--array-length" }],
+  [OutputFix.ROOT_TYPE_NUMBERING]: [ROOT_TYPES, NO_SCHEMA_PREFIX]
+};
+function describeRequirement(requirement) {
+  return `${requirement.option} (${requirement.flag})`;
+}
+function ineffectiveFixNotices(names, isOptionOn) {
+  return [...new Set(names)].flatMap((name) => {
+    const missing = (REQUIREMENTS[name] ?? []).filter(({ option }) => !isOptionOn(option));
+    return missing.length === 0 ? [] : [`Fix "${name}" has no effect without ${missing.map(describeRequirement).join(" and ")}`];
+  });
+}
+
+export { ALL_OUTPUT_FIXES, OUTPUT_FIXES, OutputFix, ineffectiveFixNotices, outputFixNamesOf, resolveOutputFixes };
+//# sourceMappingURL=output-fixes.mjs.map

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

@@ -0,0 +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.\n */\nexport const OutputFix = {\n  /** An `allOf` member with only `required` makes those properties of the others required. */\n  ALLOF_REQUIRED: \"allof-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  /** A schema two discriminators name gets one enum of their values, a mapping before its name. */\n  DISCRIMINATOR_VALUES: \"discriminator-values\",\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;\nexport type OutputFix = (typeof OutputFix)[keyof typeof OutputFix];\n\n/** Every fix of this version, in the order the docs list them. */\nexport const OUTPUT_FIXES: readonly OutputFix[] = Object.values(OutputFix);\n\n/** The name that turns on every fix of the installed version. */\nexport const ALL_OUTPUT_FIXES = \"all\";\n\n/** A name the `fix` option accepts: one fix, or `all`. */\nexport type OutputFixName = OutputFix | typeof ALL_OUTPUT_FIXES;\n\nconst KNOWN_NAMES: ReadonlySet<string> = new Set<string>([...OUTPUT_FIXES, ALL_OUTPUT_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_OUTPUT_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: \"arrayLength\" | \"rootTypes\" | \"rootTypesNoSchemaPrefix\";\n  readonly flag: string;\n}\n\nconst ROOT_TYPES = { option: \"rootTypes\", flag: \"--root-types\" } 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  [OutputFix.ARRAY_LENGTH_TUPLES]: [{ option: \"arrayLength\", flag: \"--array-length\" }],\n  [OutputFix.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":";;AAOO,MAAM,SAAA,GAAY;AAAA;AAAA,EAEvB,cAAA,EAAgB,gBAAA;AAAA;AAAA,EAEhB,gBAAA,EAAkB,kBAAA;AAAA;AAAA,EAElB,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,oBAAA,EAAsB,sBAAA;AAAA;AAAA,EAEtB,mBAAA,EAAqB,qBAAA;AAAA;AAAA,EAErB,sBAAA,EAAwB;AAC1B;AAIO,MAAM,YAAA,GAAqC,MAAA,CAAO,MAAA,CAAO,SAAS;AAGlE,MAAM,gBAAA,GAAmB;AAKhC,MAAM,8BAAmC,IAAI,GAAA,CAAY,CAAC,GAAG,YAAA,EAAc,gBAAgB,CAAC,CAAA;AAE5F,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,gBAAA,GAAmB,YAAA,GAAe,CAAC,IAAI,CAAE,CAAC,CAAA;AAC7F;AAQA,MAAM,UAAA,GAAa,EAAE,MAAA,EAAQ,WAAA,EAAa,MAAM,cAAA,EAAe;AAC/D,MAAM,gBAAA,GAAmB;AAAA,EACvB,MAAA,EAAQ,yBAAA;AAAA,EACR,IAAA,EAAM;AACR,CAAA;AAGA,MAAM,YAAA,GAA0F;AAAA,EAC9F,CAAC,SAAA,CAAU,mBAAmB,GAAG,CAAC,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EACnF,CAAC,SAAA,CAAU,mBAAmB,GAAG,CAAC,YAAY,gBAAgB;AAChE,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/index.cjs

@@ -0,0 +1,98 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const openapiTs = require('./api/openapi-ts.cjs');
+const astToString = require('./api/ast-to-string.cjs');
+const commentHeader = require('./api/comment-header.cjs');
+const discriminatorScan = require('./api/discriminator-scan.cjs');
+const legacyTsHelpers = require('./api/legacy-ts-helpers.cjs');
+const legacyUtils = require('./api/legacy-utils.cjs');
+const stringToAst = require('./api/string-to-ast.cjs');
+const transformSchema = require('./api/transform-schema.cjs');
+const typeHelpers = require('./api/type-helpers.cjs');
+const errors = require('./domain/errors.cjs');
+const outputFixes = require('./domain/output-fixes.cjs');
+const componentsObject = require('./transform/components-object.cjs');
+const headerObject = require('./transform/header-object.cjs');
+const mediaTypeObject = require('./transform/media-type-object.cjs');
+const operationObject = require('./transform/operation-object.cjs');
+const parameterObject = require('./transform/parameter-object.cjs');
+const pathItemObject = require('./transform/path-item-object.cjs');
+const pathsObject = require('./transform/paths-object.cjs');
+const requestBodyObject = require('./transform/request-body-object.cjs');
+const responseObject = require('./transform/response-object.cjs');
+const responsesObject = require('./transform/responses-object.cjs');
+const schemaObject = require('./transform/schema-object.cjs');
+
+
+
+exports.default = openapiTs.default;
+exports.astToString = astToString.astToString;
+exports.COMMENT_HEADER = commentHeader.COMMENT_HEADER;
+exports.scanDiscriminators = discriminatorScan.scanDiscriminators;
+exports.JS_ENUM_INVALID_CHARS_RE = legacyTsHelpers.JS_ENUM_INVALID_CHARS_RE;
+exports.JS_PROPERTY_INDEX_INVALID_CHARS_RE = legacyTsHelpers.JS_PROPERTY_INDEX_INVALID_CHARS_RE;
+exports.JS_PROPERTY_INDEX_RE = legacyTsHelpers.JS_PROPERTY_INDEX_RE;
+exports.QUESTION_TOKEN = legacyTsHelpers.QUESTION_TOKEN;
+exports.SPECIAL_CHARACTER_MAP = legacyTsHelpers.SPECIAL_CHARACTER_MAP;
+exports.addJSDocComment = legacyTsHelpers.addJSDocComment;
+exports.enumCache = legacyTsHelpers.enumCache;
+exports.tsArrayLiteralExpression = legacyTsHelpers.tsArrayLiteralExpression;
+exports.tsDedupe = legacyTsHelpers.tsDedupe;
+exports.tsEnum = legacyTsHelpers.tsEnum;
+exports.tsEnumMember = legacyTsHelpers.tsEnumMember;
+exports.tsIsPrimitive = legacyTsHelpers.tsIsPrimitive;
+exports.tsModifiers = legacyTsHelpers.tsModifiers;
+exports.tsPropertyIndex = legacyTsHelpers.tsPropertyIndex;
+exports.tsReadonlyArray = legacyTsHelpers.tsReadonlyArray;
+exports.c = legacyUtils.c;
+exports.createDiscriminatorProperty = legacyUtils.createDiscriminatorProperty;
+exports.createRef = legacyUtils.createRef;
+exports.debug = legacyUtils.debug;
+exports.error = legacyUtils.error;
+exports.formatTime = legacyUtils.formatTime;
+exports.getEntries = legacyUtils.getEntries;
+exports.resolveRef = legacyUtils.resolveRef;
+exports.walk = legacyUtils.walk;
+exports.warn = legacyUtils.warn;
+exports.STRING_TO_AST_DEPRECATION_CODE = stringToAst.STRING_TO_AST_DEPRECATION_CODE;
+exports.stringToAST = stringToAst.stringToAST;
+exports.transformSchema = transformSchema.default;
+exports.BOOLEAN = typeHelpers.BOOLEAN;
+exports.FALSE = typeHelpers.FALSE;
+exports.NEVER = typeHelpers.NEVER;
+exports.NULL = typeHelpers.NULL;
+exports.NUMBER = typeHelpers.NUMBER;
+exports.STRING = typeHelpers.STRING;
+exports.TRUE = typeHelpers.TRUE;
+exports.UNDEFINED = typeHelpers.UNDEFINED;
+exports.UNKNOWN = typeHelpers.UNKNOWN;
+exports.oapiRef = typeHelpers.oapiRef;
+exports.tsIntersection = typeHelpers.tsIntersection;
+exports.tsLiteral = typeHelpers.tsLiteral;
+exports.tsNullable = typeHelpers.tsNullable;
+exports.tsOmit = typeHelpers.tsOmit;
+exports.tsRecord = typeHelpers.tsRecord;
+exports.tsUnion = typeHelpers.tsUnion;
+exports.tsWithRequired = typeHelpers.tsWithRequired;
+exports.ERROR_CODES = errors.ERROR_CODES;
+exports.OpenAPITypesafeError = errors.OpenAPITypesafeError;
+exports.isOpenAPITypesafeError = errors.isOpenAPITypesafeError;
+exports.ALL_OUTPUT_FIXES = outputFixes.ALL_OUTPUT_FIXES;
+exports.OUTPUT_FIXES = outputFixes.OUTPUT_FIXES;
+exports.OutputFix = outputFixes.OutputFix;
+exports.transformComponentsObject = componentsObject.default;
+exports.transformHeaderObject = headerObject;
+exports.transformMediaTypeObject = mediaTypeObject;
+exports.injectOperationObject = operationObject.injectOperationObject;
+exports.transformOperationObject = operationObject.default;
+exports.transformParameterObject = parameterObject;
+exports.transformPathItemObject = pathItemObject;
+exports.transformPathsObject = pathsObject;
+exports.transformRequestBodyObject = requestBodyObject;
+exports.transformResponseObject = responseObject;
+exports.transformResponsesObject = responsesObject;
+exports.transformSchemaObject = schemaObject.default;
+exports.transformSchemaObjectWithComposition = schemaObject.transformSchemaObjectWithComposition;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}