@infinite-debugger/swagger-to-ts/models/OpenAPISpecification/Request.js

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.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RequestValidationSchema = exports.RequestConfigValidationSchema = exports.RequestBodyValidationSchema = exports.RequestParameterValidationSchema = exports.requestParameterLocations = exports.BaseRequestParameterValidationSchema = exports.requestMethods = void 0;
const zod_1 = require("zod");
const Content_1 = require("./Content");
const Response_1 = require("./Response");
const Schema_1 = require("./Schema");
//#region Request methods
exports.requestMethods = [
    'get',
    'post',
    'put',
    'delete',
    'patch',
];
//#endregion
//#region BaseRequestParameter
exports.BaseRequestParameterValidationSchema = zod_1.z.object({
    required: zod_1.z
        .boolean()
        .optional()
        .describe('The base request parameter required.'),
    name: zod_1.z.string().describe('The base request parameter name.'),
    description: zod_1.z
        .string()
        .optional()
        .describe('The base request parameter description.'),
    schema: Schema_1.SchemaValidationSchema.describe('The base request parameter schema.'),
    example: zod_1.z.any().optional().describe('The base request parameter example.'),
});
//#endregion
//#region RequestParameter
exports.requestParameterLocations = [
    'query',
    'header',
    'path',
    'cookie',
];
exports.RequestParameterValidationSchema = exports.BaseRequestParameterValidationSchema.extend({
    in: zod_1.z
        .enum(exports.requestParameterLocations)
        .describe('The request parameter location.'),
});
//#endregion
//#region RequestBody
exports.RequestBodyValidationSchema = zod_1.z.object({
    required: zod_1.z.boolean().optional().describe('The request body required.'),
    content: Content_1.ContentValidationSchema.optional().describe('The request body content.'),
    description: zod_1.z.string().optional().describe('The request body description.'),
});
//#endregion
//#region RequstConfig
exports.RequestConfigValidationSchema = zod_1.z.object({
    tsedControllerConfig: zod_1.z
        .object({
        permissions: zod_1.z
            .array(zod_1.z.string())
            .optional()
            .describe('The request permissions.'),
        path: zod_1.z.string().optional().describe('The request path.'),
        responseHeaders: zod_1.z
            .record(zod_1.z.string())
            .optional()
            .describe('The response headers to add'),
        streamAPIResponse: zod_1.z
            .boolean()
            .optional()
            .describe('Whether to stream the response or not.'),
    })
        .optional(),
    apiFunctionConfig: zod_1.z
        .object({
        responseType: zod_1.z.string().optional().describe('The response type.'),
    })
        .optional(),
});
//#endregion
//#region Request
exports.RequestValidationSchema = zod_1.z.object({
    description: zod_1.z.string().optional().describe('The request description.'),
    operationId: zod_1.z.string().optional().describe('The request operation id.'),
    parameters: zod_1.z
        .array(exports.RequestParameterValidationSchema)
        .optional()
        .describe('The request parameters.'),
    requestBody: exports.RequestBodyValidationSchema.optional().describe('The request body.'),
    responses: Response_1.ResponsesValidationSchema.describe('The request responses.'),
    summary: zod_1.z.string().optional().describe('The request summary.'),
    deprecated: zod_1.z
        .boolean()
        .optional()
        .describe('Whether the request is deprecated.'),
    tags: zod_1.z.array(zod_1.z.string()).describe('The request tags.'),
    'x-requestConfig': exports.RequestConfigValidationSchema.optional().describe('The custom request configuration.'),
});
//#endregion
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVxdWVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9tb2RlbHMvT3BlbkFQSVNwZWNpZmljYXRpb24vUmVxdWVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw2QkFBd0I7QUFFeEIsdUNBQTZEO0FBQzdELHlDQUFrRTtBQUNsRSxxQ0FBMEQ7QUFFMUQseUJBQXlCO0FBQ1osUUFBQSxjQUFjLEdBQUc7SUFDNUIsS0FBSztJQUNMLE1BQU07SUFDTixLQUFLO0lBQ0wsUUFBUTtJQUNSLE9BQU87Q0FDQyxDQUFDO0FBR1gsWUFBWTtBQUVaLDhCQUE4QjtBQUNqQixRQUFBLG9DQUFvQyxHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQU07SUFDaEUsUUFBUSxFQUFFLE9BQUM7U0FDUixPQUFPLEVBQUU7U0FDVCxRQUFRLEVBQUU7U0FDVixRQUFRLENBQUMsc0NBQXNDLENBQUM7SUFDbkQsSUFBSSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLENBQUMsa0NBQWtDLENBQUM7SUFDN0QsV0FBVyxFQUFFLE9BQUM7U0FDWCxNQUFNLEVBQUU7U0FDUixRQUFRLEVBQUU7U0FDVixRQUFRLENBQUMseUNBQXlDLENBQUM7SUFDdEQsTUFBTSxFQUFFLCtCQUFzQixDQUFDLFFBQVEsQ0FBQyxvQ0FBb0MsQ0FBQztJQUM3RSxPQUFPLEVBQUUsT0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLFFBQVEsRUFBRSxDQUFDLFFBQVEsQ0FBQyxxQ0FBcUMsQ0FBQztDQUM1RSxDQUFDLENBQUM7QUFTSCxZQUFZO0FBRVosMEJBQTBCO0FBQ2IsUUFBQSx5QkFBeUIsR0FBRztJQUN2QyxPQUFPO0lBQ1AsUUFBUTtJQUNSLE1BQU07SUFDTixRQUFRO0NBQ0EsQ0FBQztBQUlFLFFBQUEsZ0NBQWdDLEdBQzNDLDRDQUFvQyxDQUFDLE1BQU0sQ0FBTTtJQUMvQyxFQUFFLEVBQUUsT0FBQztTQUNGLElBQUksQ0FBQyxpQ0FBeUIsQ0FBQztTQUMvQixRQUFRLENBQUMsaUNBQWlDLENBQUM7Q0FDL0MsQ0FBQyxDQUFDO0FBUUwsWUFBWTtBQUVaLHFCQUFxQjtBQUNSLFFBQUEsMkJBQTJCLEdBQVEsT0FBQyxDQUFDLE1BQU0sQ0FBQztJQUN2RCxRQUFRLEVBQUUsT0FBQyxDQUFDLE9BQU8sRUFBRSxDQUFDLFFBQVEsRUFBRSxDQUFDLFFBQVEsQ0FBQyw0QkFBNEIsQ0FBQztJQUN2RSxPQUFPLEVBQUUsaUNBQXVCLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUNsRCwyQkFBMkIsQ0FDNUI7SUFDRCxXQUFXLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRSxDQUFDLFFBQVEsQ0FBQywrQkFBK0IsQ0FBQztDQUM3RSxDQUFDLENBQUM7QUFPSCxZQUFZO0FBRVosc0JBQXNCO0FBQ1QsUUFBQSw2QkFBNkIsR0FBRyxPQUFDLENBQUMsTUFBTSxDQUFDO0lBQ3BELG9CQUFvQixFQUFFLE9BQUM7U0FDcEIsTUFBTSxDQUFDO1FBQ04sV0FBVyxFQUFFLE9BQUM7YUFDWCxLQUFLLENBQUMsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDO2FBQ2pCLFFBQVEsRUFBRTthQUNWLFFBQVEsQ0FBQywwQkFBMEIsQ0FBQztRQUN2QyxJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRSxDQUFDLFFBQVEsQ0FBQyxtQkFBbUIsQ0FBQztRQUN6RCxlQUFlLEVBQUUsT0FBQzthQUNmLE1BQU0sQ0FBQyxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUM7YUFDbEIsUUFBUSxFQUFFO2FBQ1YsUUFBUSxDQUFDLDZCQUE2QixDQUFDO1FBQzFDLGlCQUFpQixFQUFFLE9BQUM7YUFDakIsT0FBTyxFQUFFO2FBQ1QsUUFBUSxFQUFFO2FBQ1YsUUFBUSxDQUFDLHdDQUF3QyxDQUFDO0tBQ3RELENBQUM7U0FDRCxRQUFRLEVBQUU7SUFDYixpQkFBaUIsRUFBRSxPQUFDO1NBQ2pCLE1BQU0sQ0FBQztRQUNOLFlBQVksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUFDLG9CQUFvQixDQUFDO0tBQ25FLENBQUM7U0FDRCxRQUFRLEVBQUU7Q0FDZCxDQUFDLENBQUM7QUFHSCxZQUFZO0FBRVosaUJBQWlCO0FBQ0osUUFBQSx1QkFBdUIsR0FBRyxPQUFDLENBQUMsTUFBTSxDQUFNO0lBQ25ELFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUFDLDBCQUEwQixDQUFDO0lBQ3ZFLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUFDLDJCQUEyQixDQUFDO0lBQ3hFLFVBQVUsRUFBRSxPQUFDO1NBQ1YsS0FBSyxDQUFDLHdDQUFnQyxDQUFDO1NBQ3ZDLFFBQVEsRUFBRTtTQUNWLFFBQVEsQ0FBQyx5QkFBeUIsQ0FBQztJQUN0QyxXQUFXLEVBQ1QsbUNBQTJCLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxDQUFDLG1CQUFtQixDQUFDO0lBQ3RFLFNBQVMsRUFBRSxvQ0FBeUIsQ0FBQyxRQUFRLENBQUMsd0JBQXdCLENBQUM7SUFDdkUsT0FBTyxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxRQUFRLENBQUMsc0JBQXNCLENBQUM7SUFDL0QsVUFBVSxFQUFFLE9BQUM7U0FDVixPQUFPLEVBQUU7U0FDVCxRQUFRLEVBQUU7U0FDVixRQUFRLENBQUMsb0NBQW9DLENBQUM7SUFDakQsSUFBSSxFQUFFLE9BQUMsQ0FBQyxLQUFLLENBQUMsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsUUFBUSxDQUFDLG1CQUFtQixDQUFDO0lBQ3ZELGlCQUFpQixFQUFFLHFDQUE2QixDQUFDLFFBQVEsRUFBRSxDQUFDLFFBQVEsQ0FDbEUsbUNBQW1DLENBQ3BDO0NBQ0YsQ0FBQyxDQUFDO0FBZ0RILFlBQVkifQ==