openapi-typesafe 0.0.0 → 1.0.0-rc.1

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,72 @@
+'use strict';
+
+const errors = require('../../../domain/errors.cjs');
+const constructors = require('../../../domain/ir/constructors.cjs');
+const literalType = require('../literal-type.cjs');
+const pointerType = require('../ref-pointer/pointer-type.cjs');
+const sharedTypes = require('../shared-types.cjs');
+const compositionType = require('./composition-type.cjs');
+const enumRule = require('./enum-rule.cjs');
+
+class InvalidSchemaError extends errors.OpenAPITypesafeError {
+  constructor(schema, path) {
+    const received = Array.isArray(schema) ? "Array" : typeof schema;
+    super({
+      code: errors.ERROR_CODES.SCHEMA_OBJECT_INVALID,
+      message: `Expected SchemaObject, received ${received} at ${path}`,
+      details: { path, received }
+    });
+    this.name = "InvalidSchemaError";
+  }
+}
+const SHAPE_RULES = [
+  {
+    name: "$ref",
+    matches: (schema) => "$ref" in schema,
+    transform: (schema, request2) => pointerType.schemaRefType(schema.$ref, request2)
+  },
+  {
+    name: "const",
+    matches: (schema) => schema.const !== null && schema.const !== void 0,
+    transform: (schema) => literalType.literalType(schema.const)
+  },
+  enumRule.enumRule
+];
+function checkSchema(schema, path) {
+  if (!schema) {
+    return { type: constructors.irKeyword("never") };
+  }
+  if (schema === true) {
+    return { type: sharedTypes.UNKNOWN_TYPE };
+  }
+  if (Array.isArray(schema) || typeof schema !== "object") {
+    throw new InvalidSchemaError(schema, path);
+  }
+  return { schema };
+}
+function request(location, context, isFromAdditionalProperties) {
+  return {
+    location,
+    context,
+    isFromAdditionalProperties,
+    transformNested: (schema, nestedLocation, isNestedFromAdditionalProperties = false) => transformSchema(schema, nestedLocation, context, isNestedFromAdditionalProperties)
+  };
+}
+function transformSchemaShape(schema, location, context, isFromAdditionalProperties = false) {
+  const checked = checkSchema(schema, location.path);
+  if ("type" in checked) {
+    return checked.type;
+  }
+  const current = request(location, context, isFromAdditionalProperties);
+  const rule = SHAPE_RULES.find((candidate) => candidate.matches(checked.schema));
+  return rule ? rule.transform(checked.schema, current) : compositionType.compositionType(checked.schema, current);
+}
+function transformSchema(schema, location, context, isFromAdditionalProperties = false) {
+  const type = transformSchemaShape(schema, location, context, isFromAdditionalProperties);
+  return context.callbacks.postTransform(type, location) ?? type;
+}
+
+exports.InvalidSchemaError = InvalidSchemaError;
+exports.transformSchema = transformSchema;
+exports.transformSchemaShape = transformSchemaShape;
+//# sourceMappingURL=schema-transform.cjs.map

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

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

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

@@ -0,0 +1,68 @@
+import { OpenAPITypesafeError, ERROR_CODES } from '../../../domain/errors.mjs';
+import { irKeyword } from '../../../domain/ir/constructors.mjs';
+import { literalType } from '../literal-type.mjs';
+import { schemaRefType } from '../ref-pointer/pointer-type.mjs';
+import { UNKNOWN_TYPE } from '../shared-types.mjs';
+import { compositionType } from './composition-type.mjs';
+import { enumRule } from './enum-rule.mjs';
+
+class InvalidSchemaError extends OpenAPITypesafeError {
+  constructor(schema, path) {
+    const received = Array.isArray(schema) ? "Array" : typeof schema;
+    super({
+      code: ERROR_CODES.SCHEMA_OBJECT_INVALID,
+      message: `Expected SchemaObject, received ${received} at ${path}`,
+      details: { path, received }
+    });
+    this.name = "InvalidSchemaError";
+  }
+}
+const SHAPE_RULES = [
+  {
+    name: "$ref",
+    matches: (schema) => "$ref" in schema,
+    transform: (schema, request2) => schemaRefType(schema.$ref, request2)
+  },
+  {
+    name: "const",
+    matches: (schema) => schema.const !== null && schema.const !== void 0,
+    transform: (schema) => literalType(schema.const)
+  },
+  enumRule
+];
+function checkSchema(schema, path) {
+  if (!schema) {
+    return { type: irKeyword("never") };
+  }
+  if (schema === true) {
+    return { type: UNKNOWN_TYPE };
+  }
+  if (Array.isArray(schema) || typeof schema !== "object") {
+    throw new InvalidSchemaError(schema, path);
+  }
+  return { schema };
+}
+function request(location, context, isFromAdditionalProperties) {
+  return {
+    location,
+    context,
+    isFromAdditionalProperties,
+    transformNested: (schema, nestedLocation, isNestedFromAdditionalProperties = false) => transformSchema(schema, nestedLocation, context, isNestedFromAdditionalProperties)
+  };
+}
+function transformSchemaShape(schema, location, context, isFromAdditionalProperties = false) {
+  const checked = checkSchema(schema, location.path);
+  if ("type" in checked) {
+    return checked.type;
+  }
+  const current = request(location, context, isFromAdditionalProperties);
+  const rule = SHAPE_RULES.find((candidate) => candidate.matches(checked.schema));
+  return rule ? rule.transform(checked.schema, current) : compositionType(checked.schema, current);
+}
+function transformSchema(schema, location, context, isFromAdditionalProperties = false) {
+  const type = transformSchemaShape(schema, location, context, isFromAdditionalProperties);
+  return context.callbacks.postTransform(type, location) ?? type;
+}
+
+export { InvalidSchemaError, transformSchema, transformSchemaShape };
+//# sourceMappingURL=schema-transform.mjs.map

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

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

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

@@ -0,0 +1,61 @@
+'use strict';
+
+const constructors = require('../../../domain/ir/constructors.cjs');
+const outputFixes = require('../../../domain/output-fixes.cjs');
+const helperTypes = require('../helper-types.cjs');
+const sharedTypes = require('../shared-types.cjs');
+const typeCombinators = require('../type-combinators.cjs');
+
+function unevaluatedSchemaOf(schema, request) {
+  const { unevaluatedProperties } = schema;
+  if (!request.context.options.fixes.has(outputFixes.OutputFix.UNEVALUATED_PROPERTIES) || unevaluatedProperties === void 0 || unevaluatedProperties === false || schema.additionalProperties !== void 0) {
+    return null;
+  }
+  return schema.type === void 0 || schema.type === "object" ? unevaluatedProperties : null;
+}
+function isAnySchema(schema) {
+  return schema === true || typeof schema === "object" && Object.keys(schema).length === 0;
+}
+function memberValueTypes(member) {
+  if (member.kind === "indexSignature") {
+    return [member.type];
+  }
+  return member.isOptional ? [member.type, constructors.irKeyword("undefined")] : [member.type];
+}
+function declaredValueTypes(type, request) {
+  switch (type.kind) {
+    case "object":
+      return type.members.flatMap(memberValueTypes);
+    case "union":
+    case "intersection":
+      return type.types.flatMap((member) => declaredValueTypes(member, request));
+    case "reference":
+    case "indexedAccess":
+    case "raw":
+      request.context.footer.requirePropertyValues();
+      return [constructors.irReference(helperTypes.HELPER_TYPES.propertyValues.name, [type])];
+    case "keyword":
+    case "stringLiteral":
+    case "numberLiteral":
+    case "booleanLiteral":
+    case "array":
+    case "tuple":
+    case "readonly":
+      return [];
+  }
+}
+function unevaluatedPropertiesType(schema, composed, request) {
+  const unevaluated = unevaluatedSchemaOf(schema, request);
+  if (unevaluated === null) {
+    return null;
+  }
+  const valueTypes = isAnySchema(unevaluated) ? [sharedTypes.UNKNOWN_TYPE] : [
+    request.transformNested(unevaluated, request.location, true),
+    ...composed === null ? [] : declaredValueTypes(composed, request)
+  ];
+  const { immutable } = request.context.options;
+  return constructors.irObject([constructors.irStringIndexSignature("key", typeCombinators.unionOf(valueTypes), immutable)]);
+}
+
+exports.unevaluatedPropertiesType = unevaluatedPropertiesType;
+//# sourceMappingURL=unevaluated-properties.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"unevaluated-properties.cjs","sources":["../../../../src/application/transform/schema/unevaluated-properties.ts"],"sourcesContent":["import {\n  irKeyword,\n  irObject,\n  irReference,\n  irStringIndexSignature,\n} from \"../../../domain/ir/constructors.js\";\nimport type { IrMember, IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { OutputFix } from \"../../../domain/output-fixes.js\";\nimport { HELPER_TYPES } from \"../helper-types.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { unionOf } from \"../type-combinators.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/**\n * The `unevaluated-properties` fix (ADR-021, roadmap R11; upstream #2839, #2880). Without it\n * `unevaluatedProperties` is ignored, so its value type is lost and an object with only that\n * keyword is `Record<string, never>`. With it the composed type is intersected with an index\n * signature, as `additionalProperties` gives: every key that no other keyword declares has the\n * `unevaluatedProperties` type. TypeScript checks that index signature against every key of a\n * value, declared ones included, so its type also holds the types of the declared properties\n * (of this schema and of its `allOf`, `anyOf` and `oneOf` members); otherwise a valid value would\n * not be assignable. `false` adds nothing, like `additionalProperties: false`: TypeScript has no\n * closed object type.\n */\n\n/**\n * Whether `unevaluatedProperties` applies. It types the keys left over at this level, so it\n * does nothing next to `additionalProperties` (which already types them all), and only an object\n * schema has keys. A `type` list is typed one listed type at a time, so its object gets it.\n */\nfunction unevaluatedSchemaOf(schema: SchemaObject, request: SchemaRequest): Schema | null {\n  const { unevaluatedProperties } = schema;\n  if (\n    !request.context.options.fixes.has(OutputFix.UNEVALUATED_PROPERTIES) ||\n    unevaluatedProperties === undefined ||\n    unevaluatedProperties === false ||\n    schema.additionalProperties !== undefined\n  ) {\n    return null;\n  }\n  return schema.type === undefined || schema.type === \"object\" ? unevaluatedProperties : null;\n}\n\nfunction isAnySchema(schema: Schema): boolean {\n  return schema === true || (typeof schema === \"object\" && Object.keys(schema).length === 0);\n}\n\nfunction memberValueTypes(member: IrMember): IrType[] {\n  if (member.kind === \"indexSignature\") {\n    return [member.type];\n  }\n  return member.isOptional ? [member.type, irKeyword(\"undefined\")] : [member.type];\n}\n\n/**\n * The value types a key of the composed type can have, read from its IR: the members of object\n * types, through unions and intersections. A reference (a `$ref`, `Omit`, `WithRequired`) or a raw\n * type is read with `PropertyValues`. Primitives, literals and arrays declare no keys.\n */\nfunction declaredValueTypes(type: IrType, request: SchemaRequest): IrType[] {\n  switch (type.kind) {\n    case \"object\":\n      return type.members.flatMap(memberValueTypes);\n    case \"union\":\n    case \"intersection\":\n      return type.types.flatMap((member) => declaredValueTypes(member, request));\n    case \"reference\":\n    case \"indexedAccess\":\n    case \"raw\":\n      request.context.footer.requirePropertyValues();\n      return [irReference(HELPER_TYPES.propertyValues.name, [type])];\n    case \"keyword\":\n    case \"stringLiteral\":\n    case \"numberLiteral\":\n    case \"booleanLiteral\":\n    case \"array\":\n    case \"tuple\":\n    case \"readonly\":\n      return [];\n  }\n}\n\n/**\n * The index signature object for `unevaluatedProperties`, given the composed type of the other\n * keywords (null when there is none). Null when the fix is off or the keyword does not apply.\n */\nexport function unevaluatedPropertiesType(\n  schema: SchemaObject,\n  composed: IrType | null,\n  request: SchemaRequest,\n): IrType | null {\n  const unevaluated = unevaluatedSchemaOf(schema, request);\n  if (unevaluated === null) {\n    return null;\n  }\n  const valueTypes = isAnySchema(unevaluated)\n    ? [UNKNOWN_TYPE]\n    : [\n        request.transformNested(unevaluated, request.location, true),\n        ...(composed === null ? [] : declaredValueTypes(composed, request)),\n      ];\n  const { immutable } = request.context.options;\n  return irObject([irStringIndexSignature(\"key\", unionOf(valueTypes), immutable)]);\n}\n"],"names":["OutputFix","irKeyword","irReference","HELPER_TYPES","UNKNOWN_TYPE","irObject","irStringIndexSignature","unionOf"],"mappings":";;;;;;;;AA+BA,SAAS,mBAAA,CAAoB,QAAsB,OAAA,EAAuC;AACxF,EAAA,MAAM,EAAE,uBAAsB,GAAI,MAAA;AAClC,EAAA,IACE,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAA,CAAIA,qBAAA,CAAU,sBAAsB,CAAA,IACnE,0BAA0B,MAAA,IAC1B,qBAAA,KAA0B,KAAA,IAC1B,MAAA,CAAO,yBAAyB,MAAA,EAChC;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,IAAA,KAAS,MAAA,IAAa,MAAA,CAAO,IAAA,KAAS,WAAW,qBAAA,GAAwB,IAAA;AACzF;AAEA,SAAS,YAAY,MAAA,EAAyB;AAC5C,EAAA,OAAO,MAAA,KAAW,QAAS,OAAO,MAAA,KAAW,YAAY,MAAA,CAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA;AAC1F;AAEA,SAAS,iBAAiB,MAAA,EAA4B;AACpD,EAAA,IAAI,MAAA,CAAO,SAAS,gBAAA,EAAkB;AACpC,IAAA,OAAO,CAAC,OAAO,IAAI,CAAA;AAAA,EACrB;AACA,EAAA,OAAO,MAAA,CAAO,UAAA,GAAa,CAAC,MAAA,CAAO,IAAA,EAAMC,sBAAA,CAAU,WAAW,CAAC,CAAA,GAAI,CAAC,MAAA,CAAO,IAAI,CAAA;AACjF;AAOA,SAAS,kBAAA,CAAmB,MAAc,OAAA,EAAkC;AAC1E,EAAA,QAAQ,KAAK,IAAA;AAAM,IACjB,KAAK,QAAA;AACH,MAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,gBAAgB,CAAA;AAAA,IAC9C,KAAK,OAAA;AAAA,IACL,KAAK,cAAA;AACH,MAAA,OAAO,IAAA,CAAK,MAAM,OAAA,CAAQ,CAAC,WAAW,kBAAA,CAAmB,MAAA,EAAQ,OAAO,CAAC,CAAA;AAAA,IAC3E,KAAK,WAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,KAAA;AACH,MAAA,OAAA,CAAQ,OAAA,CAAQ,OAAO,qBAAA,EAAsB;AAC7C,MAAA,OAAO,CAACC,yBAAYC,wBAAA,CAAa,cAAA,CAAe,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AAAA,IAC/D,KAAK,SAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,gBAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,UAAA;AACH,MAAA,OAAO,EAAC;AAAA;AAEd;AAMO,SAAS,yBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACe;AACf,EAAA,MAAM,WAAA,GAAc,mBAAA,CAAoB,MAAA,EAAQ,OAAO,CAAA;AACvD,EAAA,IAAI,gBAAgB,IAAA,EAAM;AACxB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,aAAa,WAAA,CAAY,WAAW,CAAA,GACtC,CAACC,wBAAY,CAAA,GACb;AAAA,IACE,OAAA,CAAQ,eAAA,CAAgB,WAAA,EAAa,OAAA,CAAQ,UAAU,IAAI,CAAA;AAAA,IAC3D,GAAI,QAAA,KAAa,IAAA,GAAO,EAAC,GAAI,kBAAA,CAAmB,UAAU,OAAO;AAAA,GACnE;AACJ,EAAA,MAAM,EAAE,SAAA,EAAU,GAAI,OAAA,CAAQ,OAAA,CAAQ,OAAA;AACtC,EAAA,OAAOC,qBAAA,CAAS,CAACC,mCAAA,CAAuB,KAAA,EAAOC,wBAAQ,UAAU,CAAA,EAAG,SAAS,CAAC,CAAC,CAAA;AACjF;;"}

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

@@ -0,0 +1,59 @@
+import { irObject, irStringIndexSignature, irReference, irKeyword } from '../../../domain/ir/constructors.mjs';
+import { OutputFix } from '../../../domain/output-fixes.mjs';
+import { HELPER_TYPES } from '../helper-types.mjs';
+import { UNKNOWN_TYPE } from '../shared-types.mjs';
+import { unionOf } from '../type-combinators.mjs';
+
+function unevaluatedSchemaOf(schema, request) {
+  const { unevaluatedProperties } = schema;
+  if (!request.context.options.fixes.has(OutputFix.UNEVALUATED_PROPERTIES) || unevaluatedProperties === void 0 || unevaluatedProperties === false || schema.additionalProperties !== void 0) {
+    return null;
+  }
+  return schema.type === void 0 || schema.type === "object" ? unevaluatedProperties : null;
+}
+function isAnySchema(schema) {
+  return schema === true || typeof schema === "object" && Object.keys(schema).length === 0;
+}
+function memberValueTypes(member) {
+  if (member.kind === "indexSignature") {
+    return [member.type];
+  }
+  return member.isOptional ? [member.type, irKeyword("undefined")] : [member.type];
+}
+function declaredValueTypes(type, request) {
+  switch (type.kind) {
+    case "object":
+      return type.members.flatMap(memberValueTypes);
+    case "union":
+    case "intersection":
+      return type.types.flatMap((member) => declaredValueTypes(member, request));
+    case "reference":
+    case "indexedAccess":
+    case "raw":
+      request.context.footer.requirePropertyValues();
+      return [irReference(HELPER_TYPES.propertyValues.name, [type])];
+    case "keyword":
+    case "stringLiteral":
+    case "numberLiteral":
+    case "booleanLiteral":
+    case "array":
+    case "tuple":
+    case "readonly":
+      return [];
+  }
+}
+function unevaluatedPropertiesType(schema, composed, request) {
+  const unevaluated = unevaluatedSchemaOf(schema, request);
+  if (unevaluated === null) {
+    return null;
+  }
+  const valueTypes = isAnySchema(unevaluated) ? [UNKNOWN_TYPE] : [
+    request.transformNested(unevaluated, request.location, true),
+    ...composed === null ? [] : declaredValueTypes(composed, request)
+  ];
+  const { immutable } = request.context.options;
+  return irObject([irStringIndexSignature("key", unionOf(valueTypes), immutable)]);
+}
+
+export { unevaluatedPropertiesType };
+//# sourceMappingURL=unevaluated-properties.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"unevaluated-properties.mjs","sources":["../../../../src/application/transform/schema/unevaluated-properties.ts"],"sourcesContent":["import {\n  irKeyword,\n  irObject,\n  irReference,\n  irStringIndexSignature,\n} from \"../../../domain/ir/constructors.js\";\nimport type { IrMember, IrType } from \"../../../domain/ir/nodes.js\";\nimport type { Schema, SchemaObject } from \"../../../domain/openapi/schema-object.js\";\nimport { OutputFix } from \"../../../domain/output-fixes.js\";\nimport { HELPER_TYPES } from \"../helper-types.js\";\nimport { UNKNOWN_TYPE } from \"../shared-types.js\";\nimport { unionOf } from \"../type-combinators.js\";\nimport type { SchemaRequest } from \"./schema-rule.js\";\n\n/**\n * The `unevaluated-properties` fix (ADR-021, roadmap R11; upstream #2839, #2880). Without it\n * `unevaluatedProperties` is ignored, so its value type is lost and an object with only that\n * keyword is `Record<string, never>`. With it the composed type is intersected with an index\n * signature, as `additionalProperties` gives: every key that no other keyword declares has the\n * `unevaluatedProperties` type. TypeScript checks that index signature against every key of a\n * value, declared ones included, so its type also holds the types of the declared properties\n * (of this schema and of its `allOf`, `anyOf` and `oneOf` members); otherwise a valid value would\n * not be assignable. `false` adds nothing, like `additionalProperties: false`: TypeScript has no\n * closed object type.\n */\n\n/**\n * Whether `unevaluatedProperties` applies. It types the keys left over at this level, so it\n * does nothing next to `additionalProperties` (which already types them all), and only an object\n * schema has keys. A `type` list is typed one listed type at a time, so its object gets it.\n */\nfunction unevaluatedSchemaOf(schema: SchemaObject, request: SchemaRequest): Schema | null {\n  const { unevaluatedProperties } = schema;\n  if (\n    !request.context.options.fixes.has(OutputFix.UNEVALUATED_PROPERTIES) ||\n    unevaluatedProperties === undefined ||\n    unevaluatedProperties === false ||\n    schema.additionalProperties !== undefined\n  ) {\n    return null;\n  }\n  return schema.type === undefined || schema.type === \"object\" ? unevaluatedProperties : null;\n}\n\nfunction isAnySchema(schema: Schema): boolean {\n  return schema === true || (typeof schema === \"object\" && Object.keys(schema).length === 0);\n}\n\nfunction memberValueTypes(member: IrMember): IrType[] {\n  if (member.kind === \"indexSignature\") {\n    return [member.type];\n  }\n  return member.isOptional ? [member.type, irKeyword(\"undefined\")] : [member.type];\n}\n\n/**\n * The value types a key of the composed type can have, read from its IR: the members of object\n * types, through unions and intersections. A reference (a `$ref`, `Omit`, `WithRequired`) or a raw\n * type is read with `PropertyValues`. Primitives, literals and arrays declare no keys.\n */\nfunction declaredValueTypes(type: IrType, request: SchemaRequest): IrType[] {\n  switch (type.kind) {\n    case \"object\":\n      return type.members.flatMap(memberValueTypes);\n    case \"union\":\n    case \"intersection\":\n      return type.types.flatMap((member) => declaredValueTypes(member, request));\n    case \"reference\":\n    case \"indexedAccess\":\n    case \"raw\":\n      request.context.footer.requirePropertyValues();\n      return [irReference(HELPER_TYPES.propertyValues.name, [type])];\n    case \"keyword\":\n    case \"stringLiteral\":\n    case \"numberLiteral\":\n    case \"booleanLiteral\":\n    case \"array\":\n    case \"tuple\":\n    case \"readonly\":\n      return [];\n  }\n}\n\n/**\n * The index signature object for `unevaluatedProperties`, given the composed type of the other\n * keywords (null when there is none). Null when the fix is off or the keyword does not apply.\n */\nexport function unevaluatedPropertiesType(\n  schema: SchemaObject,\n  composed: IrType | null,\n  request: SchemaRequest,\n): IrType | null {\n  const unevaluated = unevaluatedSchemaOf(schema, request);\n  if (unevaluated === null) {\n    return null;\n  }\n  const valueTypes = isAnySchema(unevaluated)\n    ? [UNKNOWN_TYPE]\n    : [\n        request.transformNested(unevaluated, request.location, true),\n        ...(composed === null ? [] : declaredValueTypes(composed, request)),\n      ];\n  const { immutable } = request.context.options;\n  return irObject([irStringIndexSignature(\"key\", unionOf(valueTypes), immutable)]);\n}\n"],"names":[],"mappings":";;;;;;AA+BA,SAAS,mBAAA,CAAoB,QAAsB,OAAA,EAAuC;AACxF,EAAA,MAAM,EAAE,uBAAsB,GAAI,MAAA;AAClC,EAAA,IACE,CAAC,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,MAAM,GAAA,CAAI,SAAA,CAAU,sBAAsB,CAAA,IACnE,0BAA0B,MAAA,IAC1B,qBAAA,KAA0B,KAAA,IAC1B,MAAA,CAAO,yBAAyB,MAAA,EAChC;AACA,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,OAAO,OAAO,IAAA,KAAS,MAAA,IAAa,MAAA,CAAO,IAAA,KAAS,WAAW,qBAAA,GAAwB,IAAA;AACzF;AAEA,SAAS,YAAY,MAAA,EAAyB;AAC5C,EAAA,OAAO,MAAA,KAAW,QAAS,OAAO,MAAA,KAAW,YAAY,MAAA,CAAO,IAAA,CAAK,MAAM,CAAA,CAAE,MAAA,KAAW,CAAA;AAC1F;AAEA,SAAS,iBAAiB,MAAA,EAA4B;AACpD,EAAA,IAAI,MAAA,CAAO,SAAS,gBAAA,EAAkB;AACpC,IAAA,OAAO,CAAC,OAAO,IAAI,CAAA;AAAA,EACrB;AACA,EAAA,OAAO,MAAA,CAAO,UAAA,GAAa,CAAC,MAAA,CAAO,IAAA,EAAM,SAAA,CAAU,WAAW,CAAC,CAAA,GAAI,CAAC,MAAA,CAAO,IAAI,CAAA;AACjF;AAOA,SAAS,kBAAA,CAAmB,MAAc,OAAA,EAAkC;AAC1E,EAAA,QAAQ,KAAK,IAAA;AAAM,IACjB,KAAK,QAAA;AACH,MAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,gBAAgB,CAAA;AAAA,IAC9C,KAAK,OAAA;AAAA,IACL,KAAK,cAAA;AACH,MAAA,OAAO,IAAA,CAAK,MAAM,OAAA,CAAQ,CAAC,WAAW,kBAAA,CAAmB,MAAA,EAAQ,OAAO,CAAC,CAAA;AAAA,IAC3E,KAAK,WAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,KAAA;AACH,MAAA,OAAA,CAAQ,OAAA,CAAQ,OAAO,qBAAA,EAAsB;AAC7C,MAAA,OAAO,CAAC,YAAY,YAAA,CAAa,cAAA,CAAe,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AAAA,IAC/D,KAAK,SAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,eAAA;AAAA,IACL,KAAK,gBAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,OAAA;AAAA,IACL,KAAK,UAAA;AACH,MAAA,OAAO,EAAC;AAAA;AAEd;AAMO,SAAS,yBAAA,CACd,MAAA,EACA,QAAA,EACA,OAAA,EACe;AACf,EAAA,MAAM,WAAA,GAAc,mBAAA,CAAoB,MAAA,EAAQ,OAAO,CAAA;AACvD,EAAA,IAAI,gBAAgB,IAAA,EAAM;AACxB,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,MAAM,aAAa,WAAA,CAAY,WAAW,CAAA,GACtC,CAAC,YAAY,CAAA,GACb;AAAA,IACE,OAAA,CAAQ,eAAA,CAAgB,WAAA,EAAa,OAAA,CAAQ,UAAU,IAAI,CAAA;AAAA,IAC3D,GAAI,QAAA,KAAa,IAAA,GAAO,EAAC,GAAI,kBAAA,CAAmB,UAAU,OAAO;AAAA,GACnE;AACJ,EAAA,MAAM,EAAE,SAAA,EAAU,GAAI,OAAA,CAAQ,OAAA,CAAQ,OAAA;AACtC,EAAA,OAAO,QAAA,CAAS,CAAC,sBAAA,CAAuB,KAAA,EAAO,QAAQ,UAAU,CAAA,EAAG,SAAS,CAAC,CAAC,CAAA;AACjF;;"}

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

@@ -0,0 +1,130 @@
+'use strict';
+
+const outputFixes = require('../../domain/output-fixes.cjs');
+
+const LINE_BREAK_RE = /\r?\n/g;
+const CONTINUATION = "\n *     ";
+const COMMENT_END_RE = /\*\//g;
+const VALUE_TAGS = ["description", "default", "example"];
+const TAGS_KEEPING_EMPTY_STRING = /* @__PURE__ */ new Set(["default", "example"]);
+const JSON_INDENT = 2;
+const MEMBER_LISTS = [
+  ["anyOf", "Any of:"],
+  ["oneOf", "One of:"]
+];
+const BULLET_CONTINUATION = "\n  ";
+const ORIGINAL_SCHEMA_COMMENT = { hasMemberDescriptions: false };
+function schemaCommentOptionsOf(fixes) {
+  return { hasMemberDescriptions: fixes.has(outputFixes.OutputFix.ANYOF_ONEOF_DESCRIPTIONS) };
+}
+function formatValue(value) {
+  const text = typeof value === "object" ? JSON.stringify(value, null, JSON_INDENT) : value;
+  return String(text).trim().replace(LINE_BREAK_RE, CONTINUATION);
+}
+function plainLines(schema) {
+  const lines = [];
+  for (const text of [schema.title, schema.summary]) {
+    if (typeof text === "string" && text) {
+      lines.push(text.trim().replace(LINE_BREAK_RE, CONTINUATION));
+    }
+  }
+  if (schema.format) {
+    lines.push(`Format: ${schema.format}`);
+  }
+  if (schema.deprecated) {
+    lines.push("@deprecated");
+  }
+  return lines;
+}
+function valueTagLines(schema) {
+  const lines = [];
+  for (const tag of VALUE_TAGS) {
+    const value = schema[tag];
+    if (value === void 0 || value === "" && !TAGS_KEEPING_EMPTY_STRING.has(tag)) {
+      continue;
+    }
+    lines.push(`@${tag} ${formatValue(value)}`);
+  }
+  if (Array.isArray(schema.examples)) {
+    lines.push(...schema.examples.map((example) => `@example ${formatValue(example)}`));
+  }
+  return lines;
+}
+function enumTypeName(schema) {
+  if (Array.isArray(schema.type)) {
+    return schema.type.join("|");
+  }
+  return typeof schema.type === "string" ? schema.type : "unknown";
+}
+function constantAndEnumLines(schema) {
+  const lines = [];
+  if ("const" in schema) {
+    lines.push("@constant");
+  }
+  if (schema.enum) {
+    lines.push(`@enum {${enumTypeName(schema)}${schema.nullable ? "|null" : ""}}`);
+  }
+  return lines;
+}
+function memberDescriptions(members) {
+  if (!Array.isArray(members)) {
+    return [];
+  }
+  return members.flatMap((member) => {
+    const description = isSchemaObject(member) ? member.description : void 0;
+    return typeof description === "string" && description.trim() !== "" ? [description.trim()] : [];
+  });
+}
+function memberDescriptionLists(schema) {
+  return MEMBER_LISTS.flatMap(([keyword, heading]) => {
+    const descriptions = memberDescriptions(schema[keyword]);
+    if (descriptions.length === 0) {
+      return [];
+    }
+    const bullets = descriptions.map(
+      (description) => `- ${description.replace(LINE_BREAK_RE, BULLET_CONTINUATION)}`
+    );
+    return [[heading, ...bullets].join("\n")];
+  });
+}
+function withMemberDescriptions(schema) {
+  const lists = memberDescriptionLists(schema);
+  const own = schema.description;
+  if (lists.length === 0 || own !== void 0 && typeof own !== "string") {
+    return schema;
+  }
+  const ownLines = typeof own === "string" && own.trim() !== "" ? [own.trim()] : [];
+  return { ...schema, description: [...ownLines, ...lists].join("\n") };
+}
+function isSchemaObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function schemaComment(schema, options = ORIGINAL_SCHEMA_COMMENT) {
+  if (!isSchemaObject(schema)) {
+    return null;
+  }
+  const annotated = options.hasMemberDescriptions ? withMemberDescriptions(schema) : schema;
+  const lines = [
+    ...plainLines(annotated),
+    ...valueTagLines(annotated),
+    ...constantAndEnumLines(annotated)
+  ];
+  if (lines.length === 0) {
+    return null;
+  }
+  const isSingleLine = lines.length === 1 && !lines.some((line) => line.includes("\n"));
+  const text = isSingleLine ? `* ${lines.join("\n")} ` : `*
+ * ${lines.join("\n * ")}
+ `;
+  return { kind: "block", text: text.replace(COMMENT_END_RE, "*\\/") };
+}
+function withSchemaComment(property, schema, options = ORIGINAL_SCHEMA_COMMENT) {
+  const comment = schemaComment(schema, options);
+  return comment === null ? property : { ...property, comments: [...property.comments, comment] };
+}
+
+exports.ORIGINAL_SCHEMA_COMMENT = ORIGINAL_SCHEMA_COMMENT;
+exports.schemaComment = schemaComment;
+exports.schemaCommentOptionsOf = schemaCommentOptionsOf;
+exports.withSchemaComment = withSchemaComment;
+//# sourceMappingURL=schema-comment.cjs.map

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

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