swagger-typed-express-docs
Version:
Simple express runtime parser and documentation swagger generator with 100% support of Typescript static types
313 lines (312 loc) • 13.5 kB
JavaScript
;
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
var __values = (this && this.__values) || function(o) {
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
if (m) return m.call(o);
if (o && typeof o.length === "number") return {
next: function () {
if (o && i >= o.length) o = void 0;
return { value: o && o[i++], done: !o };
}
};
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.zod_getTSchemaValidator = exports.zod_convertSchemaToZodValidationObject = exports.normalizeZodError = void 0;
var zod_1 = require("zod");
var normalizeZodError = function (obj) {
if (!obj)
return undefined;
try {
var zodErrors = obj.errors || [];
var errorsList = zodErrors.map(function (err) {
var _a;
return ({
path: ((_a = err.path) === null || _a === void 0 ? void 0 : _a.join('.')) || '',
errors: err.message || String(err),
});
});
return errorsList.length > 0 ? errorsList : [{ errors: [String(obj)], path: '' }];
}
catch (err) {
return [{ errors: [String(obj)], path: '' }];
}
};
exports.normalizeZodError = normalizeZodError;
var zod_convertSchemaToZodValidationObject = function (schema, extra) {
var _a;
var transformTypeMode = (_a = extra === null || extra === void 0 ? void 0 : extra.transformTypeMode) !== null && _a !== void 0 ? _a : 'decode';
var zodSchema;
if (schema.type === 'object') {
var zodProperties = Object.entries(schema.properties).reduce(function (acc, _a) {
var _b = __read(_a, 2), key = _b[0], value = _b[1];
var zodSchema = (0, exports.zod_convertSchemaToZodValidationObject)(value, extra);
acc[key] = value.required ? zodSchema : zodSchema.nullable().optional();
return acc;
}, {});
zodSchema = zod_1.z.object(zodProperties);
}
else if (schema.type === 'array') {
var itemSchema = (0, exports.zod_convertSchemaToZodValidationObject)(schema.items, extra);
zodSchema = zod_1.z.array(itemSchema);
}
else if (schema.type === 'string') {
zodSchema = zod_1.z.string();
}
else if (schema.type === 'number') {
zodSchema = zod_1.z.number();
}
else if (schema.type === 'boolean') {
zodSchema = zod_1.z.boolean();
}
else if (schema.type === 'enum') {
zodSchema = zod_1.z.enum(schema.options);
}
else if (schema.type === 'any') {
zodSchema = zod_1.z.any();
}
else if (schema.type === 'oneOf') {
var optionSchemas = schema.options.map(function (option) {
return (0, exports.zod_convertSchemaToZodValidationObject)(option, extra);
});
var discriminatorKey = getOneOfEnumDiscriminator(schema);
if (discriminatorKey &&
optionSchemas.length >= 2 &&
optionSchemas.every(function (schema) { return schema instanceof zod_1.z.ZodObject; })) {
zodSchema = zod_1.z.discriminatedUnion(discriminatorKey, optionSchemas);
}
else {
zodSchema = zod_1.z.union(optionSchemas);
}
}
else if (schema.type === 'hashMap') {
var valueSchema = (0, exports.zod_convertSchemaToZodValidationObject)(schema.property, extra);
zodSchema = zod_1.z.record(zod_1.z.string(), valueSchema);
}
else if (schema.type === 'lazy') {
zodSchema = zod_1.z.lazy(function () { return (0, exports.zod_convertSchemaToZodValidationObject)(schema.getSchema(), extra); });
}
else if (schema.type === 'transformType') {
if (transformTypeMode === 'decode') {
zodSchema = zod_1.z.preprocess(function (value) {
console.log('decode', value, typeof value, schema);
if (schema.required === false && (value === null || value === undefined)) {
return value;
}
try {
var encodedSchema = (0, exports.zod_convertSchemaToZodValidationObject)(schema.encodedTSchema, {
transformTypeMode: 'keep-decoded',
});
console.log('dpc0', value);
var transformedItem = encodedSchema.parse(value);
console.log('dpc1', typeof transformedItem, transformedItem);
var newValue = void 0;
try {
newValue = schema.syncDecoder(transformedItem);
}
catch (error) {
throw new zod_1.z.ZodError([
{
code: zod_1.z.ZodIssueCode.custom,
path: [],
message: (error === null || error === void 0 ? void 0 : error.message) || 'Error while decoding value',
},
]);
}
var decodedSchema = (0, exports.zod_convertSchemaToZodValidationObject)(schema.decodedTSchema, {
transformTypeMode: 'keep-encoded',
});
console.log('kuba', newValue);
decodedSchema.parse(newValue);
console.log('kuba2', newValue);
return newValue;
}
catch (error) {
if (error instanceof zod_1.z.ZodError) {
throw error;
}
throw new zod_1.z.ZodError([
{
code: zod_1.z.ZodIssueCode.custom,
path: [],
message: (error === null || error === void 0 ? void 0 : error.message) || 'Unknown error during transformation',
},
]);
}
}, zod_1.z.any());
}
else if (transformTypeMode === 'encode') {
zodSchema = zod_1.z.preprocess(function (value) {
if (schema.required === false && (value === null || value === undefined)) {
return value;
}
try {
var decodedSchema = (0, exports.zod_convertSchemaToZodValidationObject)(schema.decodedTSchema, __assign({}, extra));
var transformedItem = decodedSchema.parse(value);
var newValue = void 0;
try {
newValue = schema.syncEncoder(transformedItem);
}
catch (error) {
throw new zod_1.z.ZodError([
{
code: zod_1.z.ZodIssueCode.custom,
path: [],
message: (error === null || error === void 0 ? void 0 : error.message) || 'Error while encoding value',
},
]);
}
var encodedSchema = (0, exports.zod_convertSchemaToZodValidationObject)(schema.encodedTSchema, __assign(__assign({}, extra), { transformTypeMode: 'keep-decoded' }));
encodedSchema.parse(newValue);
return newValue;
}
catch (error) {
if (error instanceof zod_1.z.ZodError) {
throw error;
}
throw new zod_1.z.ZodError([
{
code: zod_1.z.ZodIssueCode.custom,
path: [],
message: (error === null || error === void 0 ? void 0 : error.message) || 'Unknown error during transformation',
},
]);
}
}, zod_1.z.any());
}
else if (transformTypeMode === 'keep-encoded') {
var encodedSchema = (0, exports.zod_convertSchemaToZodValidationObject)(schema.encodedTSchema, __assign(__assign({}, extra), { transformTypeMode: 'keep-decoded' }));
zodSchema = encodedSchema;
}
else if (transformTypeMode === 'keep-decoded') {
var decodedSchema = (0, exports.zod_convertSchemaToZodValidationObject)(schema.decodedTSchema, __assign(__assign({}, extra), { transformTypeMode: 'keep-encoded' }));
zodSchema = decodedSchema;
}
else {
throw new Error('invalid transformTypeMode');
}
}
else {
zodSchema = zod_1.z.any();
}
if (schema.required === false) {
zodSchema = zodSchema.nullable().optional();
}
if (schema.validator) {
zodSchema = zodSchema.refine(function (value) {
if (schema.required === false && (value === null || value === undefined))
return true;
try {
if (schema.validator) {
schema.validator(value);
}
return true;
}
catch (err) {
return false;
}
}, {
message: function (value) {
var _a;
try {
if (schema.validator) {
schema.validator(value);
}
return 'Validation failed';
}
catch (err) {
return (_a = err === null || err === void 0 ? void 0 : err.message) !== null && _a !== void 0 ? _a : 'Validation failed';
}
},
});
}
return zodSchema;
};
exports.zod_convertSchemaToZodValidationObject = zod_convertSchemaToZodValidationObject;
var getOneOfEnumDiscriminator = function (schema) {
var e_1, _a;
var allItemsAreObjects = schema.options.every(function (option) { return option.type === 'object'; });
if (!allItemsAreObjects || schema.options.length === 0) {
return null;
}
var firstObjectProperties = schema.options[0].properties;
var potentialDiscriminators = Object.entries(firstObjectProperties)
.filter(function (_a) {
var _b = __read(_a, 2), _ = _b[0], v = _b[1];
return v.type === 'enum';
})
.map(function (_a) {
var _b = __read(_a, 1), k = _b[0];
return k;
});
var _loop_1 = function (discriminatorKey) {
var allHaveDiscriminator = schema.options.every(function (option) { var _a; return ((_a = option.properties[discriminatorKey]) === null || _a === void 0 ? void 0 : _a.type) === 'enum'; });
if (allHaveDiscriminator) {
var discriminatorValues = schema.options.map(function (option) { return option.properties[discriminatorKey].options[0]; });
var uniqueValues = new Set(discriminatorValues);
if (uniqueValues.size === discriminatorValues.length) {
return { value: discriminatorKey };
}
}
};
try {
for (var potentialDiscriminators_1 = __values(potentialDiscriminators), potentialDiscriminators_1_1 = potentialDiscriminators_1.next(); !potentialDiscriminators_1_1.done; potentialDiscriminators_1_1 = potentialDiscriminators_1.next()) {
var discriminatorKey = potentialDiscriminators_1_1.value;
var state_1 = _loop_1(discriminatorKey);
if (typeof state_1 === "object")
return state_1.value;
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (potentialDiscriminators_1_1 && !potentialDiscriminators_1_1.done && (_a = potentialDiscriminators_1.return)) _a.call(potentialDiscriminators_1);
}
finally { if (e_1) throw e_1.error; }
}
return null;
};
var zod_getTSchemaValidator = function (tSchema, extra) {
var zodValidator = (0, exports.zod_convertSchemaToZodValidationObject)(tSchema, extra);
var validate = function (value, _a) {
var _b = _a === void 0 ? {} : _a, _c = _b.stripUnknown, stripUnknown = _c === void 0 ? true : _c;
return zodValidator.parse(value);
};
var isValid = function (value) {
try {
zodValidator.parse(value);
return true;
}
catch (err) {
return false;
}
};
return { validate: validate, isValid: isValid };
};
exports.zod_getTSchemaValidator = zod_getTSchemaValidator;