@infinite-debugger/swagger-to-ts
Version:
swagger-to-ts is a powerful library that allows you to generate TypeScript code from Swagger documentation or OpenAPI specifications. It simplifies the process of integrating API definitions into your TypeScript projects, saving you time and effort.
87 lines • 8.6 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.defineOpenAPI = exports.OpenAPISpecificationValidationSchema = exports.ServerValidationSchema = exports.TagValidationSchema = exports.TagPermissionValidationSchema = exports.SecurityValidationSchema = exports.InfoValidationSchema = void 0;
const zod_1 = require("zod");
const Components_1 = require("./Components");
const Request_1 = require("./Request");
//#region OpenAPISpecificationInfo
exports.InfoValidationSchema = zod_1.z.object({
version: zod_1.z.string().describe('The open api version.'),
title: zod_1.z.string().describe('The open api title.'),
description: zod_1.z.string().optional().describe('The open api description.'),
license: zod_1.z
.object({
name: zod_1.z.string().describe('The open api license name.'),
url: zod_1.z.string().optional().describe('The open api license url.'),
})
.optional()
.describe('The open api license.'),
});
//#endregion
//#region SecurityScheme
exports.SecurityValidationSchema = zod_1.z.union([
zod_1.z.object({
APIKeyAuth: zod_1.z.array(zod_1.z.any()).describe('The API key authentication.'),
}),
zod_1.z.object({
apikeyAuth: zod_1.z.array(zod_1.z.any()).describe('The API key authentication.'),
}),
zod_1.z.object({
BearerAuth: zod_1.z.array(zod_1.z.any()).describe('The bearer authentication.'),
}),
]);
//#endregion
//#region Tag Permission
exports.TagPermissionValidationSchema = zod_1.z.object({
code: zod_1.z
.string()
.describe('The code that uniquely identifies the permission.'),
scope: zod_1.z.string().describe('The scope of the permission.'),
description: zod_1.z
.string()
.optional()
.describe('The description of the permission.'),
parentPermissionCode: zod_1.z
.string()
.optional()
.describe('The code of the permission that is the parent of this permission.'),
name: zod_1.z.string().describe('The name of the permission.'),
});
//#endregion
//#region Tag
exports.TagValidationSchema = zod_1.z.object({
name: zod_1.z.string().describe('The tag name.'),
description: zod_1.z.string().optional().describe('The tag description.'),
'x-permissions': zod_1.z.array(exports.TagPermissionValidationSchema).optional(),
});
//#endregion
//#region Server
exports.ServerValidationSchema = zod_1.z.object({
url: zod_1.z.string().describe('The server url.'),
description: zod_1.z.string().optional().describe('The server description.'),
});
//#endregion
exports.OpenAPISpecificationValidationSchema = zod_1.z.object({
openapi: zod_1.z
.string()
.describe('This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API info.version string.'),
info: exports.InfoValidationSchema.describe('Provides metadata about the API. The metadata MAY be used by tooling as required.'),
components: Components_1.ComponentsValidationSchema.describe('An element to hold various schemas for the document.'),
security: zod_1.z
.array(exports.SecurityValidationSchema)
.optional()
.describe('A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ({}) can be included in the array.'),
paths: zod_1.z
.record(zod_1.z.record(Request_1.RequestValidationSchema))
.describe('The available paths and operations for the API.'),
tags: zod_1.z
.array(exports.TagValidationSchema)
.describe("A list of tags used by the document with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the [Operation Object](https://swagger.io/specification/#operation-object) must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique."),
servers: zod_1.z
.array(exports.ServerValidationSchema)
.optional()
.describe('An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](https://swagger.io/specification/#server-object) with a [url](https://swagger.io/specification/#server-url) value of /.'),
});
const defineOpenAPI = (spec) => spec;
exports.defineOpenAPI = defineOpenAPI;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT3BlbkFQSVNwZWNpZmljYXRpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbW9kZWxzL09wZW5BUElTcGVjaWZpY2F0aW9uL09wZW5BUElTcGVjaWZpY2F0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDZCQUF3QjtBQUV4Qiw2Q0FBc0U7QUFDdEUsdUNBQTZEO0FBRTdELGtDQUFrQztBQUNyQixRQUFBLG9CQUFvQixHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQUM7SUFDM0MsT0FBTyxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLENBQUMsdUJBQXVCLENBQUM7SUFDckQsS0FBSyxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLENBQUMscUJBQXFCLENBQUM7SUFDakQsV0FBVyxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxRQUFRLENBQUMsMkJBQTJCLENBQUM7SUFDeEUsT0FBTyxFQUFFLE9BQUM7U0FDUCxNQUFNLENBQUM7UUFDTixJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsQ0FBQyw0QkFBNEIsQ0FBQztRQUN2RCxHQUFHLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRSxDQUFDLFFBQVEsQ0FBQywyQkFBMkIsQ0FBQztLQUNqRSxDQUFDO1NBQ0QsUUFBUSxFQUFFO1NBQ1YsUUFBUSxDQUFDLHVCQUF1QixDQUFDO0NBQ3JDLENBQUMsQ0FBQztBQUdILFlBQVk7QUFFWix3QkFBd0I7QUFDWCxRQUFBLHdCQUF3QixHQUFHLE9BQUMsQ0FBQyxLQUFLLENBQUM7SUFDOUMsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLFVBQVUsRUFBRSxPQUFDLENBQUMsS0FBSyxDQUFDLE9BQUMsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDLFFBQVEsQ0FBQyw2QkFBNkIsQ0FBQztLQUNyRSxDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLFVBQVUsRUFBRSxPQUFDLENBQUMsS0FBSyxDQUFDLE9BQUMsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDLFFBQVEsQ0FBQyw2QkFBNkIsQ0FBQztLQUNyRSxDQUFDO0lBQ0YsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLFVBQVUsRUFBRSxPQUFDLENBQUMsS0FBSyxDQUFDLE9BQUMsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDLFFBQVEsQ0FBQyw0QkFBNEIsQ0FBQztLQUNwRSxDQUFDO0NBQ0gsQ0FBQyxDQUFDO0FBR0gsWUFBWTtBQUVaLHdCQUF3QjtBQUNYLFFBQUEsNkJBQTZCLEdBQUcsT0FBQyxDQUFDLE1BQU0sQ0FBQztJQUNwRCxJQUFJLEVBQUUsT0FBQztTQUNKLE1BQU0sRUFBRTtTQUNSLFFBQVEsQ0FBQyxtREFBbUQsQ0FBQztJQUNoRSxLQUFLLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsQ0FBQyw4QkFBOEIsQ0FBQztJQUMxRCxXQUFXLEVBQUUsT0FBQztTQUNYLE1BQU0sRUFBRTtTQUNSLFFBQVEsRUFBRTtTQUNWLFFBQVEsQ0FBQyxvQ0FBb0MsQ0FBQztJQUNqRCxvQkFBb0IsRUFBRSxPQUFDO1NBQ3BCLE1BQU0sRUFBRTtTQUNSLFFBQVEsRUFBRTtTQUNWLFFBQVEsQ0FDUCxtRUFBbUUsQ0FDcEU7SUFDSCxJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsQ0FBQyw2QkFBNkIsQ0FBQztDQUN6RCxDQUFDLENBQUM7QUE0QkgsWUFBWTtBQUVaLGFBQWE7QUFDQSxRQUFBLG1CQUFtQixHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQUM7SUFDMUMsSUFBSSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLENBQUMsZUFBZSxDQUFDO0lBQzFDLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUFDLHNCQUFzQixDQUFDO0lBQ25FLGVBQWUsRUFBRSxPQUFDLENBQUMsS0FBSyxDQUFDLHFDQUE2QixDQUFDLENBQUMsUUFBUSxFQUFFO0NBQ25FLENBQUMsQ0FBQztBQWtCSCxZQUFZO0FBRVosZ0JBQWdCO0FBQ0gsUUFBQSxzQkFBc0IsR0FBRyxPQUFDLENBQUMsTUFBTSxDQUFDO0lBQzdDLEdBQUcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxDQUFDLGlCQUFpQixDQUFDO0lBQzNDLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUFDLHlCQUF5QixDQUFDO0NBQ3ZFLENBQUMsQ0FBQztBQUdILFlBQVk7QUFFQyxRQUFBLG9DQUFvQyxHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQUM7SUFDM0QsT0FBTyxFQUFFLE9BQUM7U0FDUCxNQUFNLEVBQUU7U0FDUixRQUFRLENBQ1Asd09BQXdPLENBQ3pPO0lBQ0gsSUFBSSxFQUFFLDRCQUFvQixDQUFDLFFBQVEsQ0FDakMsbUZBQW1GLENBQ3BGO0lBQ0QsVUFBVSxFQUFFLHVDQUEwQixDQUFDLFFBQVEsQ0FDN0Msc0RBQXNELENBQ3ZEO0lBQ0QsUUFBUSxFQUFFLE9BQUM7U0FDUixLQUFLLENBQUMsZ0NBQXdCLENBQUM7U0FDL0IsUUFBUSxFQUFFO1NBQ1YsUUFBUSxDQUNQLHlZQUF5WSxDQUMxWTtJQUNILEtBQUssRUFBRSxPQUFDO1NBQ0wsTUFBTSxDQUFDLE9BQUMsQ0FBQyxNQUFNLENBQUMsaUNBQXVCLENBQUMsQ0FBQztTQUN6QyxRQUFRLENBQUMsaURBQWlELENBQUM7SUFDOUQsSUFBSSxFQUFFLE9BQUM7U0FDSixLQUFLLENBQUMsMkJBQW1CLENBQUM7U0FDMUIsUUFBUSxDQUNQLDZZQUE2WSxDQUM5WTtJQUNILE9BQU8sRUFBRSxPQUFDO1NBQ1AsS0FBSyxDQUFDLDhCQUFzQixDQUFDO1NBQzdCLFFBQVEsRUFBRTtTQUNWLFFBQVEsQ0FDUCw4VEFBOFQsQ0FDL1Q7Q0FDSixDQUFDLENBQUM7QUFtREksTUFBTSxhQUFhLEdBQUcsQ0FBQyxJQUEwQixFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUM7QUFBckQsUUFBQSxhQUFhLGlCQUF3QyJ9