zod-openapi 2.6.2 → 2.7.0

package/lib-commonjs/api.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createParamOrRef = exports.createMediaTypeSchema = exports.getDefaultComponents = void 0;
+exports.createParamOrRef = exports.createMediaTypeSchema = exports.getDefaultComponents = exports.createComponents = void 0;
 var components_1 = require("./create/components");
+Object.defineProperty(exports, "createComponents", { enumerable: true, get: function () { return components_1.createComponents; } });
 Object.defineProperty(exports, "getDefaultComponents", { enumerable: true, get: function () { return components_1.getDefaultComponents; } });
 var content_1 = require("./create/content");
 Object.defineProperty(exports, "createMediaTypeSchema", { enumerable: true, get: function () { return content_1.createMediaTypeSchema; } });

package/lib-commonjs/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AAAA,kDAG6B;AAF3B,kHAAA,oBAAoB,OAAA;AAGtB,4CAAyD;AAAhD,gHAAA,qBAAqB,OAAA;AAC9B,kDAAuD;AAA9C,8GAAA,gBAAgB,OAAA"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AAAA,kDAI6B;AAH3B,8GAAA,gBAAgB,OAAA;AAChB,kHAAA,oBAAoB,OAAA;AAGtB,4CAAyD;AAAhD,gHAAA,qBAAqB,OAAA;AAC9B,kDAAuD;AAA9C,8GAAA,gBAAgB,OAAA"}

package/lib-commonjs/create/schema/record.js

@@ -1,10 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRecordSchema = void 0;
+const zod_1 = require("zod");
+const openapi_1 = require("../../openapi");
 const _1 = require(".");
-const createRecordSchema = (zodRecord, state) => ({
-    type: 'object',
-    additionalProperties: (0, _1.createSchemaOrRef)(zodRecord.valueSchema, state, ['record value']),
-});
+const createRecordSchema = (zodRecord, state) => {
+    const additionalProperties = (0, _1.createSchemaOrRef)(zodRecord.valueSchema, state, ['record value']);
+    if (zodRecord.keySchema instanceof zod_1.ZodEnum) {
+        return {
+            type: 'object',
+            properties: zodRecord.keySchema._def.values.reduce((acc, key) => {
+                acc[key] = additionalProperties;
+                return acc;
+            }, {}),
+            additionalProperties: false,
+        };
+    }
+    if ((0, openapi_1.satisfiesVersion)(state.components.openapi, '3.1.0') &&
+        zodRecord.keySchema instanceof zod_1.ZodString &&
+        zodRecord.keySchema._def.checks.length) {
+        return {
+            type: 'object',
+            // @ts-expect-error FIXME: https://github.com/metadevpro/openapi3-ts/pull/120
+            propertyNames: (0, _1.createSchemaOrRef)(zodRecord.keySchema, state, ['record key']),
+            additionalProperties,
+        };
+    }
+    return {
+        type: 'object',
+        additionalProperties,
+    };
+};
 exports.createRecordSchema = createRecordSchema;
 //# sourceMappingURL=record.js.map

package/lib-commonjs/create/schema/record.js.map

@@ -1 +1 @@
-{"version":3,"file":"record.js","sourceRoot":"","sources":["../../../src/create/schema/record.ts"],"names":[],"mappings":";;;AAIA,wBAAwD;AAEjD,MAAM,kBAAkB,GAAG,CAChC,SAA8B,EAC9B,KAAkB,EACE,EAAE,CAAC,CAAC;IACxB,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAA,oBAAiB,EACrC,SAAS,CAAC,WAAyB,EACnC,KAAK,EACL,CAAC,cAAc,CAAC,CACjB;CACF,CAAC,CAAC;AAVU,QAAA,kBAAkB,sBAU5B"}
+{"version":3,"file":"record.js","sourceRoot":"","sources":["../../../src/create/schema/record.ts"],"names":[],"mappings":";;;AAAA,6BAA0E;AAE1E,2CAAiD;AAGjD,wBAAwD;AAEjD,MAAM,kBAAkB,GAAG,CAChC,SAA8B,EAC9B,KAAkB,EACE,EAAE;IACtB,MAAM,oBAAoB,GAAG,IAAA,oBAAiB,EAC5C,SAAS,CAAC,WAAyB,EACnC,KAAK,EACL,CAAC,cAAc,CAAC,CACjB,CAAC;IAEF,IAAI,SAAS,CAAC,SAAS,YAAY,aAAO,EAAE;QAC1C,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAG,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,MAAmB,CAAC,MAAM,CAE9D,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACb,GAAG,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC;gBAChC,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAAE,CAAC;YACN,oBAAoB,EAAE,KAAK;SAC5B,CAAC;KACH;IAED,IACE,IAAA,0BAAgB,EAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC;QACnD,SAAS,CAAC,SAAS,YAAY,eAAS;QACxC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EACtC;QACA,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,6EAA6E;YAC7E,aAAa,EAAE,IAAA,oBAAiB,EAC9B,SAAS,CAAC,SAAuB,EACjC,KAAK,EACL,CAAC,YAAY,CAAC,CACf;YACD,oBAAoB;SACrB,CAAC;KACH;IAED,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,oBAAoB;KACrB,CAAC;AACJ,CAAC,CAAC;AA5CW,QAAA,kBAAkB,sBA4C7B"}

package/lib-es2015/api.js

@@ -1,4 +1,4 @@
-export { getDefaultComponents, } from './create/components';
+export { createComponents, getDefaultComponents, } from './create/components';
 export { createMediaTypeSchema } from './create/content';
 export { createParamOrRef } from './create/parameters';
 //# sourceMappingURL=api.js.map

package/lib-es2015/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAErB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,oBAAoB,GAErB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC"}

package/lib-es2015/create/schema/record.js

@@ -1,6 +1,31 @@
+import { ZodEnum, ZodString } from 'zod';
+import { satisfiesVersion } from '../../openapi';
 import { createSchemaOrRef } from '.';
-export const createRecordSchema = (zodRecord, state) => ({
-    type: 'object',
-    additionalProperties: createSchemaOrRef(zodRecord.valueSchema, state, ['record value']),
-});
+export const createRecordSchema = (zodRecord, state) => {
+    const additionalProperties = createSchemaOrRef(zodRecord.valueSchema, state, ['record value']);
+    if (zodRecord.keySchema instanceof ZodEnum) {
+        return {
+            type: 'object',
+            properties: zodRecord.keySchema._def.values.reduce((acc, key) => {
+                acc[key] = additionalProperties;
+                return acc;
+            }, {}),
+            additionalProperties: false,
+        };
+    }
+    if (satisfiesVersion(state.components.openapi, '3.1.0') &&
+        zodRecord.keySchema instanceof ZodString &&
+        zodRecord.keySchema._def.checks.length) {
+        return {
+            type: 'object',
+            // @ts-expect-error FIXME: https://github.com/metadevpro/openapi3-ts/pull/120
+            propertyNames: createSchemaOrRef(zodRecord.keySchema, state, ['record key']),
+            additionalProperties,
+        };
+    }
+    return {
+        type: 'object',
+        additionalProperties,
+    };
+};
 //# sourceMappingURL=record.js.map

package/lib-es2015/create/schema/record.js.map

@@ -1 +1 @@
-{"version":3,"file":"record.js","sourceRoot":"","sources":["../../../src/create/schema/record.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoB,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAExD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,SAA8B,EAC9B,KAAkB,EACE,EAAE,CAAC,CAAC;IACxB,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,iBAAiB,CACrC,SAAS,CAAC,WAAyB,EACnC,KAAK,EACL,CAAC,cAAc,CAAC,CACjB;CACF,CAAC,CAAC"}
+{"version":3,"file":"record.js","sourceRoot":"","sources":["../../../src/create/schema/record.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAkB,SAAS,EAAmB,MAAM,KAAK,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAGjD,OAAO,EAAoB,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAExD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,SAA8B,EAC9B,KAAkB,EACE,EAAE;IACtB,MAAM,oBAAoB,GAAG,iBAAiB,CAC5C,SAAS,CAAC,WAAyB,EACnC,KAAK,EACL,CAAC,cAAc,CAAC,CACjB,CAAC;IAEF,IAAI,SAAS,CAAC,SAAS,YAAY,OAAO,EAAE;QAC1C,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAG,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,MAAmB,CAAC,MAAM,CAE9D,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACb,GAAG,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC;gBAChC,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAAE,CAAC;YACN,oBAAoB,EAAE,KAAK;SAC5B,CAAC;KACH;IAED,IACE,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC;QACnD,SAAS,CAAC,SAAS,YAAY,SAAS;QACxC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EACtC;QACA,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,6EAA6E;YAC7E,aAAa,EAAE,iBAAiB,CAC9B,SAAS,CAAC,SAAuB,EACjC,KAAK,EACL,CAAC,YAAY,CAAC,CACf;YACD,oBAAoB;SACrB,CAAC;KACH;IAED,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,oBAAoB;KACrB,CAAC;AACJ,CAAC,CAAC"}

package/lib-types/api.d.ts

@@ -1,3 +1,3 @@
-export { getDefaultComponents, type ComponentsObject, } from './create/components';
+export { createComponents, getDefaultComponents, type ComponentsObject, } from './create/components';
 export { createMediaTypeSchema } from './create/content';
 export { createParamOrRef } from './create/parameters';

package/lib-types/create/schema/record.d.ts

@@ -1,4 +1,4 @@
-import type { ZodRecord } from 'zod';
+import { type ZodRecord } from 'zod';
 import type { oas31 } from '../../openapi3-ts/dist';
 import { type SchemaState } from '.';
 export declare const createRecordSchema: (zodRecord: ZodRecord<any, any>, state: SchemaState) => oas31.SchemaObject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "2.6.2",
+  "version": "2.7.0",
   "description": "Convert Zod Schemas to OpenAPI v3.x documentation",
   "keywords": [
     "typescript",
@@ -43,7 +43,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@redocly/cli": "1.0.0-beta.129",
+    "@redocly/cli": "1.0.0-beta.131",
     "@types/node": "^20.3.0",
     "eslint-plugin-zod-openapi": "^0.1.0",
     "openapi3-ts": "4.1.2",