openapi-typesafe 0.0.0 → 1.0.0-rc.1

package/dist/domain/openapi/media-type-object.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-type-object.mjs","sources":["../../../src/domain/openapi/media-type-object.ts"],"sourcesContent":["import { parseRefPointer } from \"./json-pointer.js\";\nimport type { ReferenceSchema, Schema } from \"./schema-object.js\";\n\n/** The parts of a Media Type Object the generator reads (OpenAPI 3.2 §4.8.14). */\nexport interface MediaTypeObject {\n  /** The complete content. */\n  readonly schema?: Schema;\n  /** Each item of a sequential media type such as `application/jsonl` (OpenAPI 3.2). */\n  readonly itemSchema?: Schema;\n}\n\n/** A `content` map: media type name to a Media Type Object or a `$ref` to one. */\nexport type ContentMap = Readonly<Record<string, MediaTypeObject | ReferenceSchema>>;\n\nconst COMPONENTS_SEGMENT = \"components\";\n/** The OpenAPI 3.2 component map of reusable Media Type Objects. */\nexport const MEDIA_TYPES_COMPONENT_KIND = \"mediaTypes\";\n\n/**\n * Whether a `content` entry's `$ref` points into `components.mediaTypes` (OpenAPI 3.2). Other\n * `$ref`s in `content` keep the output they had before 3.2 (ADR-020).\n */\nexport function isMediaTypeComponentRef(ref: string): boolean {\n  const [root, kind] = parseRefPointer(ref);\n  return ref.startsWith(\"#/\") && root === COMPONENTS_SEGMENT && kind === MEDIA_TYPES_COMPONENT_KIND;\n}\n"],"names":[],"mappings":";;AAcA,MAAM,kBAAA,GAAqB,YAAA;AAEpB,MAAM,0BAAA,GAA6B;AAMnC,SAAS,wBAAwB,GAAA,EAAsB;AAC5D,EAAA,MAAM,CAAC,IAAA,EAAM,IAAI,CAAA,GAAI,gBAAgB,GAAG,CAAA;AACxC,EAAA,OAAO,IAAI,UAAA,CAAW,IAAI,CAAA,IAAK,IAAA,KAAS,sBAAsB,IAAA,KAAS,0BAAA;AACzE;;"}

package/dist/domain/openapi/parameter-object.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+const PARAMETER_LOCATIONS = Object.freeze([
+  "query",
+  "header",
+  "path",
+  "cookie"
+]);
+const QUERYSTRING_LOCATION = "querystring";
+
+exports.PARAMETER_LOCATIONS = PARAMETER_LOCATIONS;
+exports.QUERYSTRING_LOCATION = QUERYSTRING_LOCATION;
+//# sourceMappingURL=parameter-object.cjs.map

package/dist/domain/openapi/parameter-object.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter-object.cjs","sources":["../../../src/domain/openapi/parameter-object.ts"],"sourcesContent":["import type { ContentMap } from \"./media-type-object.js\";\nimport type { ReferenceSchema, Schema } from \"./schema-object.js\";\n\nexport type ParameterLocation = \"query\" | \"header\" | \"path\" | \"cookie\";\n\n/** Every parameter location, in the order the generated `parameters` type lists them. */\nexport const PARAMETER_LOCATIONS: readonly ParameterLocation[] = Object.freeze([\n  \"query\",\n  \"header\",\n  \"path\",\n  \"cookie\",\n]);\n\n/**\n * The OpenAPI 3.2 location of a parameter that is the whole query string, described by `content`.\n * Its type becomes the `query` member of `parameters` (ADR-020).\n */\nexport const QUERYSTRING_LOCATION = \"querystring\";\n\n/** The parts of a Parameter Object the generator reads (OpenAPI 3.2 §4.8.12). */\nexport interface ParameterObject {\n  readonly name: string;\n  readonly in: ParameterLocation | typeof QUERYSTRING_LOCATION;\n  readonly required?: boolean;\n  readonly deprecated?: boolean;\n  /** How the value is serialized; `form` for `in: query` when absent (§4.8.12.4). */\n  readonly style?: string;\n  /** Whether an array or object value is sent as several values; true for `form` when absent. */\n  readonly explode?: boolean;\n  readonly schema?: Schema;\n  readonly content?: ContentMap;\n}\n\nexport type ParameterOrReference = ParameterObject | ReferenceSchema;\n"],"names":[],"mappings":";;AAMO,MAAM,mBAAA,GAAoD,OAAO,MAAA,CAAO;AAAA,EAC7E,OAAA;AAAA,EACA,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAC;AAMM,MAAM,oBAAA,GAAuB;;;"}

package/dist/domain/openapi/parameter-object.mjs

@@ -0,0 +1,10 @@
+const PARAMETER_LOCATIONS = Object.freeze([
+  "query",
+  "header",
+  "path",
+  "cookie"
+]);
+const QUERYSTRING_LOCATION = "querystring";
+
+export { PARAMETER_LOCATIONS, QUERYSTRING_LOCATION };
+//# sourceMappingURL=parameter-object.mjs.map

package/dist/domain/openapi/parameter-object.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter-object.mjs","sources":["../../../src/domain/openapi/parameter-object.ts"],"sourcesContent":["import type { ContentMap } from \"./media-type-object.js\";\nimport type { ReferenceSchema, Schema } from \"./schema-object.js\";\n\nexport type ParameterLocation = \"query\" | \"header\" | \"path\" | \"cookie\";\n\n/** Every parameter location, in the order the generated `parameters` type lists them. */\nexport const PARAMETER_LOCATIONS: readonly ParameterLocation[] = Object.freeze([\n  \"query\",\n  \"header\",\n  \"path\",\n  \"cookie\",\n]);\n\n/**\n * The OpenAPI 3.2 location of a parameter that is the whole query string, described by `content`.\n * Its type becomes the `query` member of `parameters` (ADR-020).\n */\nexport const QUERYSTRING_LOCATION = \"querystring\";\n\n/** The parts of a Parameter Object the generator reads (OpenAPI 3.2 §4.8.12). */\nexport interface ParameterObject {\n  readonly name: string;\n  readonly in: ParameterLocation | typeof QUERYSTRING_LOCATION;\n  readonly required?: boolean;\n  readonly deprecated?: boolean;\n  /** How the value is serialized; `form` for `in: query` when absent (§4.8.12.4). */\n  readonly style?: string;\n  /** Whether an array or object value is sent as several values; true for `form` when absent. */\n  readonly explode?: boolean;\n  readonly schema?: Schema;\n  readonly content?: ContentMap;\n}\n\nexport type ParameterOrReference = ParameterObject | ReferenceSchema;\n"],"names":[],"mappings":"AAMO,MAAM,mBAAA,GAAoD,OAAO,MAAA,CAAO;AAAA,EAC7E,OAAA;AAAA,EACA,QAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAC;AAMM,MAAM,oBAAA,GAAuB;;"}

package/dist/domain/openapi/path-item-object.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+const HTTP_METHODS = Object.freeze([
+  "get",
+  "put",
+  "post",
+  "delete",
+  "options",
+  "head",
+  "patch",
+  "trace"
+]);
+const QUERY_METHOD = "query";
+const ADDITIONAL_OPERATIONS_KEY = "additionalOperations";
+function pathItemOperations(pathItem) {
+  const methods = [...HTTP_METHODS, QUERY_METHOD];
+  const fixed = methods.flatMap((method) => {
+    const operation = pathItem[method];
+    return operation ? [{ method, operation, segments: [method] }] : [];
+  });
+  const additional = Object.entries(pathItem.additionalOperations ?? {}).map(
+    ([method, operation]) => ({
+      method,
+      operation,
+      segments: [ADDITIONAL_OPERATIONS_KEY, method]
+    })
+  );
+  return [...fixed, ...additional];
+}
+
+exports.ADDITIONAL_OPERATIONS_KEY = ADDITIONAL_OPERATIONS_KEY;
+exports.HTTP_METHODS = HTTP_METHODS;
+exports.QUERY_METHOD = QUERY_METHOD;
+exports.pathItemOperations = pathItemOperations;
+//# sourceMappingURL=path-item-object.cjs.map

package/dist/domain/openapi/path-item-object.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-item-object.cjs","sources":["../../../src/domain/openapi/path-item-object.ts"],"sourcesContent":["import type { OperationObject } from \"./operation-object.js\";\nimport type { ParameterOrReference } from \"./parameter-object.js\";\nimport type { ReferenceSchema } from \"./schema-object.js\";\n\n/** The methods every generated path item lists, with `?: never` when the document has none. */\nexport type HttpMethod = \"get\" | \"put\" | \"post\" | \"delete\" | \"options\" | \"head\" | \"patch\" | \"trace\";\n\n/** The operation fields of a path item, in the order the generated types list them. */\nexport const HTTP_METHODS: readonly HttpMethod[] = Object.freeze([\n  \"get\",\n  \"put\",\n  \"post\",\n  \"delete\",\n  \"options\",\n  \"head\",\n  \"patch\",\n  \"trace\",\n]);\n\n/**\n * The OpenAPI 3.2 QUERY method. Its member is written only when the path item declares it, so\n * documents without it keep their output (ADR-020).\n */\nexport const QUERY_METHOD = \"query\";\n\n/** Every operation field of a path item. */\nexport type PathItemMethod = HttpMethod | typeof QUERY_METHOD;\n\n/** The OpenAPI 3.2 path item field for methods other than the fixed fields, by exact name. */\nexport const ADDITIONAL_OPERATIONS_KEY = \"additionalOperations\";\n\nexport type OperationEntry = OperationObject | ReferenceSchema;\n\n/** The parts of a Path Item Object the generator reads (OpenAPI 3.2 §4.8.9). */\nexport type PathItemObject = {\n  readonly parameters?: readonly ParameterOrReference[];\n  readonly additionalOperations?: Readonly<Record<string, OperationEntry>>;\n} & { readonly [method in PathItemMethod]?: OperationEntry };\n\n/** Path items by URL template (OpenAPI 3.1 §4.8.8); webhooks use the same shape by name. */\nexport type PathsObject = Readonly<Record<string, PathItemObject | ReferenceSchema>>;\n\n/** One operation of a path item and the method it is declared under. */\nexport interface PathItemOperation {\n  /** A fixed field (`get`, `query`, …) or an `additionalOperations` name (`SUBSCRIBE`). */\n  readonly method: string;\n  readonly operation: OperationEntry;\n  /** JSON Pointer segments from the path item to the operation. */\n  readonly segments: readonly string[];\n}\n\n/**\n * Every operation of a path item: the fixed methods in output order, then `query`, then\n * `additionalOperations` in document order.\n */\nexport function pathItemOperations(pathItem: PathItemObject): PathItemOperation[] {\n  const methods: readonly PathItemMethod[] = [...HTTP_METHODS, QUERY_METHOD];\n  const fixed = methods.flatMap((method) => {\n    const operation = pathItem[method];\n    return operation ? [{ method, operation, segments: [method] }] : [];\n  });\n  const additional = Object.entries(pathItem.additionalOperations ?? {}).map(\n    ([method, operation]) => ({\n      method,\n      operation,\n      segments: [ADDITIONAL_OPERATIONS_KEY, method],\n    }),\n  );\n  return [...fixed, ...additional];\n}\n"],"names":[],"mappings":";;AAQO,MAAM,YAAA,GAAsC,OAAO,MAAA,CAAO;AAAA,EAC/D,KAAA;AAAA,EACA,KAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AAAA,EACA,OAAA;AAAA,EACA;AACF,CAAC;AAMM,MAAM,YAAA,GAAe;AAMrB,MAAM,yBAAA,GAA4B;AA0BlC,SAAS,mBAAmB,QAAA,EAA+C;AAChF,EAAA,MAAM,OAAA,GAAqC,CAAC,GAAG,YAAA,EAAc,YAAY,CAAA;AACzE,EAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,OAAA,CAAQ,CAAC,MAAA,KAAW;AACxC,IAAA,MAAM,SAAA,GAAY,SAAS,MAAM,CAAA;AACjC,IAAA,OAAO,SAAA,GAAY,CAAC,EAAE,MAAA,EAAQ,SAAA,EAAW,QAAA,EAAU,CAAC,MAAM,CAAA,EAAG,CAAA,GAAI,EAAC;AAAA,EACpE,CAAC,CAAA;AACD,EAAA,MAAM,aAAa,MAAA,CAAO,OAAA,CAAQ,SAAS,oBAAA,IAAwB,EAAE,CAAA,CAAE,GAAA;AAAA,IACrE,CAAC,CAAC,MAAA,EAAQ,SAAS,CAAA,MAAO;AAAA,MACxB,MAAA;AAAA,MACA,SAAA;AAAA,MACA,QAAA,EAAU,CAAC,yBAAA,EAA2B,MAAM;AAAA,KAC9C;AAAA,GACF;AACA,EAAA,OAAO,CAAC,GAAG,KAAA,EAAO,GAAG,UAAU,CAAA;AACjC;;;;;"}

package/dist/domain/openapi/path-item-object.mjs

@@ -0,0 +1,30 @@
+const HTTP_METHODS = Object.freeze([
+  "get",
+  "put",
+  "post",
+  "delete",
+  "options",
+  "head",
+  "patch",
+  "trace"
+]);
+const QUERY_METHOD = "query";
+const ADDITIONAL_OPERATIONS_KEY = "additionalOperations";
+function pathItemOperations(pathItem) {
+  const methods = [...HTTP_METHODS, QUERY_METHOD];
+  const fixed = methods.flatMap((method) => {
+    const operation = pathItem[method];
+    return operation ? [{ method, operation, segments: [method] }] : [];
+  });
+  const additional = Object.entries(pathItem.additionalOperations ?? {}).map(
+    ([method, operation]) => ({
+      method,
+      operation,
+      segments: [ADDITIONAL_OPERATIONS_KEY, method]
+    })
+  );
+  return [...fixed, ...additional];
+}
+
+export { ADDITIONAL_OPERATIONS_KEY, HTTP_METHODS, QUERY_METHOD, pathItemOperations };
+//# sourceMappingURL=path-item-object.mjs.map

package/dist/domain/openapi/path-item-object.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-item-object.mjs","sources":["../../../src/domain/openapi/path-item-object.ts"],"sourcesContent":["import type { OperationObject } from \"./operation-object.js\";\nimport type { ParameterOrReference } from \"./parameter-object.js\";\nimport type { ReferenceSchema } from \"./schema-object.js\";\n\n/** The methods every generated path item lists, with `?: never` when the document has none. */\nexport type HttpMethod = \"get\" | \"put\" | \"post\" | \"delete\" | \"options\" | \"head\" | \"patch\" | \"trace\";\n\n/** The operation fields of a path item, in the order the generated types list them. */\nexport const HTTP_METHODS: readonly HttpMethod[] = Object.freeze([\n  \"get\",\n  \"put\",\n  \"post\",\n  \"delete\",\n  \"options\",\n  \"head\",\n  \"patch\",\n  \"trace\",\n]);\n\n/**\n * The OpenAPI 3.2 QUERY method. Its member is written only when the path item declares it, so\n * documents without it keep their output (ADR-020).\n */\nexport const QUERY_METHOD = \"query\";\n\n/** Every operation field of a path item. */\nexport type PathItemMethod = HttpMethod | typeof QUERY_METHOD;\n\n/** The OpenAPI 3.2 path item field for methods other than the fixed fields, by exact name. */\nexport const ADDITIONAL_OPERATIONS_KEY = \"additionalOperations\";\n\nexport type OperationEntry = OperationObject | ReferenceSchema;\n\n/** The parts of a Path Item Object the generator reads (OpenAPI 3.2 §4.8.9). */\nexport type PathItemObject = {\n  readonly parameters?: readonly ParameterOrReference[];\n  readonly additionalOperations?: Readonly<Record<string, OperationEntry>>;\n} & { readonly [method in PathItemMethod]?: OperationEntry };\n\n/** Path items by URL template (OpenAPI 3.1 §4.8.8); webhooks use the same shape by name. */\nexport type PathsObject = Readonly<Record<string, PathItemObject | ReferenceSchema>>;\n\n/** One operation of a path item and the method it is declared under. */\nexport interface PathItemOperation {\n  /** A fixed field (`get`, `query`, …) or an `additionalOperations` name (`SUBSCRIBE`). */\n  readonly method: string;\n  readonly operation: OperationEntry;\n  /** JSON Pointer segments from the path item to the operation. */\n  readonly segments: readonly string[];\n}\n\n/**\n * Every operation of a path item: the fixed methods in output order, then `query`, then\n * `additionalOperations` in document order.\n */\nexport function pathItemOperations(pathItem: PathItemObject): PathItemOperation[] {\n  const methods: readonly PathItemMethod[] = [...HTTP_METHODS, QUERY_METHOD];\n  const fixed = methods.flatMap((method) => {\n    const operation = pathItem[method];\n    return operation ? [{ method, operation, segments: [method] }] : [];\n  });\n  const additional = Object.entries(pathItem.additionalOperations ?? {}).map(\n    ([method, operation]) => ({\n      method,\n      operation,\n      segments: [ADDITIONAL_OPERATIONS_KEY, method],\n    }),\n  );\n  return [...fixed, ...additional];\n}\n"],"names":[],"mappings":"AAQO,MAAM,YAAA,GAAsC,OAAO,MAAA,CAAO;AAAA,EAC/D,KAAA;AAAA,EACA,KAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA;AAAA,EACA,SAAA;AAAA,EACA,MAAA;AAAA,EACA,OAAA;AAAA,EACA;AACF,CAAC;AAMM,MAAM,YAAA,GAAe;AAMrB,MAAM,yBAAA,GAA4B;AA0BlC,SAAS,mBAAmB,QAAA,EAA+C;AAChF,EAAA,MAAM,OAAA,GAAqC,CAAC,GAAG,YAAA,EAAc,YAAY,CAAA;AACzE,EAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,OAAA,CAAQ,CAAC,MAAA,KAAW;AACxC,IAAA,MAAM,SAAA,GAAY,SAAS,MAAM,CAAA;AACjC,IAAA,OAAO,SAAA,GAAY,CAAC,EAAE,MAAA,EAAQ,SAAA,EAAW,QAAA,EAAU,CAAC,MAAM,CAAA,EAAG,CAAA,GAAI,EAAC;AAAA,EACpE,CAAC,CAAA;AACD,EAAA,MAAM,aAAa,MAAA,CAAO,OAAA,CAAQ,SAAS,oBAAA,IAAwB,EAAE,CAAA,CAAE,GAAA;AAAA,IACrE,CAAC,CAAC,MAAA,EAAQ,SAAS,CAAA,MAAO;AAAA,MACxB,MAAA;AAAA,MACA,SAAA;AAAA,MACA,QAAA,EAAU,CAAC,yBAAA,EAA2B,MAAM;AAAA,KAC9C;AAAA,GACF;AACA,EAAA,OAAO,CAAC,GAAG,KAAA,EAAO,GAAG,UAAU,CAAA;AACjC;;"}

package/dist/domain/openapi/path-templates.cjs

@@ -0,0 +1,23 @@
+'use strict';
+
+const PATH_PARAMETER_RE = /\{[^}]+\}/g;
+const PATH_PREFIX = "/";
+const UNNAMED_PARAMETER = "{}";
+function isObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function findIdenticalPathTemplates(document) {
+  const paths = isObject(document) && isObject(document.paths) ? document.paths : {};
+  const byHierarchy = /* @__PURE__ */ new Map();
+  for (const url of Object.keys(paths)) {
+    if (!url.startsWith(PATH_PREFIX) || !url.includes("{")) {
+      continue;
+    }
+    const hierarchy = url.replace(PATH_PARAMETER_RE, UNNAMED_PARAMETER);
+    byHierarchy.set(hierarchy, [...byHierarchy.get(hierarchy) ?? [], url]);
+  }
+  return [...byHierarchy.values()].filter((urls) => urls.length > 1);
+}
+
+exports.findIdenticalPathTemplates = findIdenticalPathTemplates;
+//# sourceMappingURL=path-templates.cjs.map

package/dist/domain/openapi/path-templates.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-templates.cjs","sources":["../../../src/domain/openapi/path-templates.ts"],"sourcesContent":["/**\n * The Paths Object rule (OpenAPI 3.1 §4.8.8): \"Templated paths with the same hierarchy but\n * different templated names MUST NOT exist as they are identical.\" Such paths, `/a/{id}` and\n * `/a/{name}`, match the same URLs, so a client cannot tell which one a request is for.\n */\n\nconst PATH_PARAMETER_RE = /\\{[^}]+\\}/g;\nconst PATH_PREFIX = \"/\";\nconst UNNAMED_PARAMETER = \"{}\";\n\nfunction isObject(value: unknown): value is Readonly<Record<string, unknown>> {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/**\n * The groups of paths that differ only in the names of their template parameters, each group in\n * document order, the groups in the order of their first path. Keys that are no path, such as an\n * `x-` extension, are left out.\n */\nexport function findIdenticalPathTemplates(document: unknown): string[][] {\n  const paths = isObject(document) && isObject(document.paths) ? document.paths : {};\n  const byHierarchy = new Map<string, string[]>();\n  for (const url of Object.keys(paths)) {\n    if (!url.startsWith(PATH_PREFIX) || !url.includes(\"{\")) {\n      continue;\n    }\n    const hierarchy = url.replace(PATH_PARAMETER_RE, UNNAMED_PARAMETER);\n    byHierarchy.set(hierarchy, [...(byHierarchy.get(hierarchy) ?? []), url]);\n  }\n  return [...byHierarchy.values()].filter((urls) => urls.length > 1);\n}\n"],"names":[],"mappings":";;AAMA,MAAM,iBAAA,GAAoB,YAAA;AAC1B,MAAM,WAAA,GAAc,GAAA;AACpB,MAAM,iBAAA,GAAoB,IAAA;AAE1B,SAAS,SAAS,KAAA,EAA4D;AAC5E,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAOO,SAAS,2BAA2B,QAAA,EAA+B;AACxE,EAAA,MAAM,KAAA,GAAQ,QAAA,CAAS,QAAQ,CAAA,IAAK,QAAA,CAAS,SAAS,KAAK,CAAA,GAAI,QAAA,CAAS,KAAA,GAAQ,EAAC;AACjF,EAAA,MAAM,WAAA,uBAAkB,GAAA,EAAsB;AAC9C,EAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,KAAK,CAAA,EAAG;AACpC,IAAA,IAAI,CAAC,IAAI,UAAA,CAAW,WAAW,KAAK,CAAC,GAAA,CAAI,QAAA,CAAS,GAAG,CAAA,EAAG;AACtD,MAAA;AAAA,IACF;AACA,IAAA,MAAM,SAAA,GAAY,GAAA,CAAI,OAAA,CAAQ,iBAAA,EAAmB,iBAAiB,CAAA;AAClE,IAAA,WAAA,CAAY,GAAA,CAAI,SAAA,EAAW,CAAC,GAAI,WAAA,CAAY,GAAA,CAAI,SAAS,CAAA,IAAK,EAAC,EAAI,GAAG,CAAC,CAAA;AAAA,EACzE;AACA,EAAA,OAAO,CAAC,GAAG,WAAA,CAAY,MAAA,EAAQ,CAAA,CAAE,MAAA,CAAO,CAAC,IAAA,KAAS,IAAA,CAAK,MAAA,GAAS,CAAC,CAAA;AACnE;;"}

package/dist/domain/openapi/path-templates.mjs

@@ -0,0 +1,21 @@
+const PATH_PARAMETER_RE = /\{[^}]+\}/g;
+const PATH_PREFIX = "/";
+const UNNAMED_PARAMETER = "{}";
+function isObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function findIdenticalPathTemplates(document) {
+  const paths = isObject(document) && isObject(document.paths) ? document.paths : {};
+  const byHierarchy = /* @__PURE__ */ new Map();
+  for (const url of Object.keys(paths)) {
+    if (!url.startsWith(PATH_PREFIX) || !url.includes("{")) {
+      continue;
+    }
+    const hierarchy = url.replace(PATH_PARAMETER_RE, UNNAMED_PARAMETER);
+    byHierarchy.set(hierarchy, [...byHierarchy.get(hierarchy) ?? [], url]);
+  }
+  return [...byHierarchy.values()].filter((urls) => urls.length > 1);
+}
+
+export { findIdenticalPathTemplates };
+//# sourceMappingURL=path-templates.mjs.map

package/dist/domain/openapi/path-templates.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-templates.mjs","sources":["../../../src/domain/openapi/path-templates.ts"],"sourcesContent":["/**\n * The Paths Object rule (OpenAPI 3.1 §4.8.8): \"Templated paths with the same hierarchy but\n * different templated names MUST NOT exist as they are identical.\" Such paths, `/a/{id}` and\n * `/a/{name}`, match the same URLs, so a client cannot tell which one a request is for.\n */\n\nconst PATH_PARAMETER_RE = /\\{[^}]+\\}/g;\nconst PATH_PREFIX = \"/\";\nconst UNNAMED_PARAMETER = \"{}\";\n\nfunction isObject(value: unknown): value is Readonly<Record<string, unknown>> {\n  return typeof value === \"object\" && value !== null && !Array.isArray(value);\n}\n\n/**\n * The groups of paths that differ only in the names of their template parameters, each group in\n * document order, the groups in the order of their first path. Keys that are no path, such as an\n * `x-` extension, are left out.\n */\nexport function findIdenticalPathTemplates(document: unknown): string[][] {\n  const paths = isObject(document) && isObject(document.paths) ? document.paths : {};\n  const byHierarchy = new Map<string, string[]>();\n  for (const url of Object.keys(paths)) {\n    if (!url.startsWith(PATH_PREFIX) || !url.includes(\"{\")) {\n      continue;\n    }\n    const hierarchy = url.replace(PATH_PARAMETER_RE, UNNAMED_PARAMETER);\n    byHierarchy.set(hierarchy, [...(byHierarchy.get(hierarchy) ?? []), url]);\n  }\n  return [...byHierarchy.values()].filter((urls) => urls.length > 1);\n}\n"],"names":[],"mappings":"AAMA,MAAM,iBAAA,GAAoB,YAAA;AAC1B,MAAM,WAAA,GAAc,GAAA;AACpB,MAAM,iBAAA,GAAoB,IAAA;AAE1B,SAAS,SAAS,KAAA,EAA4D;AAC5E,EAAA,OAAO,OAAO,UAAU,QAAA,IAAY,KAAA,KAAU,QAAQ,CAAC,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5E;AAOO,SAAS,2BAA2B,QAAA,EAA+B;AACxE,EAAA,MAAM,KAAA,GAAQ,QAAA,CAAS,QAAQ,CAAA,IAAK,QAAA,CAAS,SAAS,KAAK,CAAA,GAAI,QAAA,CAAS,KAAA,GAAQ,EAAC;AACjF,EAAA,MAAM,WAAA,uBAAkB,GAAA,EAAsB;AAC9C,EAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,KAAK,CAAA,EAAG;AACpC,IAAA,IAAI,CAAC,IAAI,UAAA,CAAW,WAAW,KAAK,CAAC,GAAA,CAAI,QAAA,CAAS,GAAG,CAAA,EAAG;AACtD,MAAA;AAAA,IACF;AACA,IAAA,MAAM,SAAA,GAAY,GAAA,CAAI,OAAA,CAAQ,iBAAA,EAAmB,iBAAiB,CAAA;AAClE,IAAA,WAAA,CAAY,GAAA,CAAI,SAAA,EAAW,CAAC,GAAI,WAAA,CAAY,GAAA,CAAI,SAAS,CAAA,IAAK,EAAC,EAAI,GAAG,CAAC,CAAA;AAAA,EACzE;AACA,EAAA,OAAO,CAAC,GAAG,WAAA,CAAY,MAAA,EAAQ,CAAA,CAAE,MAAA,CAAO,CAAC,IAAA,KAAS,IAAA,CAAK,MAAA,GAAS,CAAC,CAAA;AACnE;;"}

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,101 @@
+'use strict';
+
+const errors = require('./errors.cjs');
+
+const OutputFix = {
+  /** An `allOf` `$ref` to a discriminated union is the union, without `Omit` or a schema name. */
+  ALLOF_DISCRIMINATED_UNION: "allof-discriminated-union",
+  /** An `allOf` member with only `required` makes those properties of the others required. */
+  ALLOF_REQUIRED: "allof-required",
+  /** The JSDoc of a schema lists the descriptions of its `anyOf` and `oneOf` members. */
+  ANYOF_ONEOF_DESCRIPTIONS: "anyof-oneof-descriptions",
+  /** `anyOf` / `oneOf` variants with only `required` make those keys of the parent required. */
+  ANYOF_ONEOF_REQUIRED: "anyof-oneof-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",
+  /** `--dedupe-enums` names a shared enum by all of its schemas, not by the first one. */
+  DEDUPE_ENUM_NAMES: "dedupe-enum-names",
+  /** `required` next to an `allOf` `$ref` to a discriminator member still gives `WithRequired`. */
+  DISCRIMINATOR_MEMBER_REQUIRED: "discriminator-member-required",
+  /**
+   * The value a discriminator member gets: one enum of every discriminator's values, a mapping
+   * before the schema name, a schema's own mapping before an inherited one, none where the member
+   * declares it, and with `--enum` a member of the owner's enum.
+   */
+  DISCRIMINATOR_VALUES: "discriminator-values",
+  /** An exploded object query parameter's properties are keys of `query`, as they are sent. */
+  EXPLODED_QUERY_OBJECTS: "exploded-query-objects",
+  /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */
+  NULLABLE_ENUMS: "nullable-enums",
+  /** `--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). */
+  PREFIX_ITEMS: "prefix-items",
+  /** `readOnly` and `writeOnly` of the schema a `$ref` names, or of `allOf` members, count. */
+  READ_WRITE_REFS: "read-write-refs",
+  /**
+   * A `$ref` into schema keywords (`content/<type>/schema`, `items`, `allOf/0`) gets the type it
+   * points at, also where the original type compiles through an index signature.
+   */
+  REF_POINTERS: "ref-pointers",
+  /** 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 ENUM = { option: "enum", flag: "--enum" };
+const NO_SCHEMA_PREFIX = {
+  option: "rootTypesNoSchemaPrefix",
+  flag: "--root-types-no-schema-prefix"
+};
+const REQUIREMENTS = {
+  [OutputFix.ARRAY_LENGTH_TUPLES]: [{ option: "arrayLength", flag: "--array-length" }],
+  [OutputFix.DEDUPE_ENUM_NAMES]: [ENUM, { option: "dedupeEnums", flag: "--dedupe-enums" }],
+  [OutputFix.NULLABLE_ENUMS]: [ENUM],
+  [OutputFix.PATH_PARAM_TYPE_NAMES]: [
+    { option: "pathParamsAsTypes", flag: "--path-params-as-types" }
+  ],
+  [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` `$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;\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:\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  [OutputFix.ARRAY_LENGTH_TUPLES]: [{ option: \"arrayLength\", flag: \"--array-length\" }],\n  [OutputFix.DEDUPE_ENUM_NAMES]: [ENUM, { option: \"dedupeEnums\", flag: \"--dedupe-enums\" }],\n  [OutputFix.NULLABLE_ENUMS]: [ENUM],\n  [OutputFix.PATH_PARAM_TYPE_NAMES]: [\n    { option: \"pathParamsAsTypes\", flag: \"--path-params-as-types\" },\n  ],\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,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;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;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,SAAA,CAAU,mBAAmB,GAAG,CAAC,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EACnF,CAAC,SAAA,CAAU,iBAAiB,GAAG,CAAC,IAAA,EAAM,EAAE,MAAA,EAAQ,aAAA,EAAe,IAAA,EAAM,gBAAA,EAAkB,CAAA;AAAA,EACvF,CAAC,SAAA,CAAU,cAAc,GAAG,CAAC,IAAI,CAAA;AAAA,EACjC,CAAC,SAAA,CAAU,qBAAqB,GAAG;AAAA,IACjC,EAAE,MAAA,EAAQ,mBAAA,EAAqB,IAAA,EAAM,wBAAA;AAAyB,GAChE;AAAA,EACA,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,94 @@
+import { OpenAPITypesafeError, ERROR_CODES } from './errors.mjs';
+
+const OutputFix = {
+  /** An `allOf` `$ref` to a discriminated union is the union, without `Omit` or a schema name. */
+  ALLOF_DISCRIMINATED_UNION: "allof-discriminated-union",
+  /** An `allOf` member with only `required` makes those properties of the others required. */
+  ALLOF_REQUIRED: "allof-required",
+  /** The JSDoc of a schema lists the descriptions of its `anyOf` and `oneOf` members. */
+  ANYOF_ONEOF_DESCRIPTIONS: "anyof-oneof-descriptions",
+  /** `anyOf` / `oneOf` variants with only `required` make those keys of the parent required. */
+  ANYOF_ONEOF_REQUIRED: "anyof-oneof-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",
+  /** `--dedupe-enums` names a shared enum by all of its schemas, not by the first one. */
+  DEDUPE_ENUM_NAMES: "dedupe-enum-names",
+  /** `required` next to an `allOf` `$ref` to a discriminator member still gives `WithRequired`. */
+  DISCRIMINATOR_MEMBER_REQUIRED: "discriminator-member-required",
+  /**
+   * The value a discriminator member gets: one enum of every discriminator's values, a mapping
+   * before the schema name, a schema's own mapping before an inherited one, none where the member
+   * declares it, and with `--enum` a member of the owner's enum.
+   */
+  DISCRIMINATOR_VALUES: "discriminator-values",
+  /** An exploded object query parameter's properties are keys of `query`, as they are sent. */
+  EXPLODED_QUERY_OBJECTS: "exploded-query-objects",
+  /** `--enum` declares an enum that lists `null` without it, and the type adds `| null`. */
+  NULLABLE_ENUMS: "nullable-enums",
+  /** `--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). */
+  PREFIX_ITEMS: "prefix-items",
+  /** `readOnly` and `writeOnly` of the schema a `$ref` names, or of `allOf` members, count. */
+  READ_WRITE_REFS: "read-write-refs",
+  /**
+   * A `$ref` into schema keywords (`content/<type>/schema`, `items`, `allOf/0`) gets the type it
+   * points at, also where the original type compiles through an index signature.
+   */
+  REF_POINTERS: "ref-pointers",
+  /** 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 ENUM = { option: "enum", flag: "--enum" };
+const NO_SCHEMA_PREFIX = {
+  option: "rootTypesNoSchemaPrefix",
+  flag: "--root-types-no-schema-prefix"
+};
+const REQUIREMENTS = {
+  [OutputFix.ARRAY_LENGTH_TUPLES]: [{ option: "arrayLength", flag: "--array-length" }],
+  [OutputFix.DEDUPE_ENUM_NAMES]: [ENUM, { option: "dedupeEnums", flag: "--dedupe-enums" }],
+  [OutputFix.NULLABLE_ENUMS]: [ENUM],
+  [OutputFix.PATH_PARAM_TYPE_NAMES]: [
+    { option: "pathParamsAsTypes", flag: "--path-params-as-types" }
+  ],
+  [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