vovk 3.0.0-draft.46 → 3.0.0-draft.461

package/mjs/openapi/error.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.error = void 0;
+const types_1 = require("../types");
+const createDecorator_1 = require("../utils/createDecorator");
+const statusDisplayText = {
+    [types_1.HttpStatus.NULL]: 'Error',
+    [types_1.HttpStatus.CONTINUE]: 'Continue',
+    [types_1.HttpStatus.SWITCHING_PROTOCOLS]: 'Switching Protocols',
+    [types_1.HttpStatus.PROCESSING]: 'Processing',
+    [types_1.HttpStatus.EARLYHINTS]: 'Early Hints',
+    [types_1.HttpStatus.OK]: 'OK',
+    [types_1.HttpStatus.CREATED]: 'Created',
+    [types_1.HttpStatus.ACCEPTED]: 'Accepted',
+    [types_1.HttpStatus.NON_AUTHORITATIVE_INFORMATION]: 'Non Authoritative Information',
+    [types_1.HttpStatus.NO_CONTENT]: 'No Content',
+    [types_1.HttpStatus.RESET_CONTENT]: 'Reset Content',
+    [types_1.HttpStatus.PARTIAL_CONTENT]: 'Partial Content',
+    [types_1.HttpStatus.AMBIGUOUS]: 'Ambiguous',
+    [types_1.HttpStatus.MOVED_PERMANENTLY]: 'Moved Permanently',
+    [types_1.HttpStatus.FOUND]: 'Found',
+    [types_1.HttpStatus.SEE_OTHER]: 'See Other',
+    [types_1.HttpStatus.NOT_MODIFIED]: 'Not Modified',
+    [types_1.HttpStatus.TEMPORARY_REDIRECT]: 'Temporary Redirect',
+    [types_1.HttpStatus.PERMANENT_REDIRECT]: 'Permanent Redirect',
+    [types_1.HttpStatus.BAD_REQUEST]: 'Bad Request',
+    [types_1.HttpStatus.UNAUTHORIZED]: 'Unauthorized',
+    [types_1.HttpStatus.PAYMENT_REQUIRED]: 'Payment Required',
+    [types_1.HttpStatus.FORBIDDEN]: 'Forbidden',
+    [types_1.HttpStatus.NOT_FOUND]: 'Not Found',
+    [types_1.HttpStatus.METHOD_NOT_ALLOWED]: 'Method Not Allowed',
+    [types_1.HttpStatus.NOT_ACCEPTABLE]: 'Not Acceptable',
+    [types_1.HttpStatus.PROXY_AUTHENTICATION_REQUIRED]: 'Proxy Authentication Required',
+    [types_1.HttpStatus.REQUEST_TIMEOUT]: 'Request Timeout',
+    [types_1.HttpStatus.CONFLICT]: 'Conflict',
+    [types_1.HttpStatus.GONE]: 'Gone',
+    [types_1.HttpStatus.LENGTH_REQUIRED]: 'Length Required',
+    [types_1.HttpStatus.PRECONDITION_FAILED]: 'Precondition Failed',
+    [types_1.HttpStatus.PAYLOAD_TOO_LARGE]: 'Payload Too Large',
+    [types_1.HttpStatus.URI_TOO_LONG]: 'URI Too Long',
+    [types_1.HttpStatus.UNSUPPORTED_MEDIA_TYPE]: 'Unsupported Media Type',
+    [types_1.HttpStatus.REQUESTED_RANGE_NOT_SATISFIABLE]: 'Requested Range Not Satisfiable',
+    [types_1.HttpStatus.EXPECTATION_FAILED]: 'Expectation Failed',
+    [types_1.HttpStatus.I_AM_A_TEAPOT]: 'I am a teapot',
+    [types_1.HttpStatus.MISDIRECTED]: 'Misdirected',
+    [types_1.HttpStatus.UNPROCESSABLE_ENTITY]: 'Unprocessable Entity',
+    [types_1.HttpStatus.FAILED_DEPENDENCY]: 'Failed Dependency',
+    [types_1.HttpStatus.PRECONDITION_REQUIRED]: 'Precondition Required',
+    [types_1.HttpStatus.TOO_MANY_TRequestS]: 'Too Many Requests',
+    [types_1.HttpStatus.INTERNAL_SERVER_ERROR]: 'Internal Server Error',
+    [types_1.HttpStatus.NOT_IMPLEMENTED]: 'Not Implemented',
+    [types_1.HttpStatus.BAD_GATEWAY]: 'Bad Gateway',
+    [types_1.HttpStatus.SERVICE_UNAVAILABLE]: 'Service Unavailable',
+    [types_1.HttpStatus.GATEWAY_TIMEOUT]: 'Gateway Timeout',
+    [types_1.HttpStatus.HTTP_VERSION_NOT_SUPPORTED]: 'HTTP Version Not Supported',
+};
+exports.error = (0, createDecorator_1.createDecorator)(null, (status, message) => {
+    return (handlerSchema) => {
+        return {
+            ...handlerSchema,
+            operationObject: {
+                ...handlerSchema?.operationObject,
+                responses: {
+                    ...handlerSchema?.operationObject?.responses,
+                    [status]: {
+                        description: `${status} ${statusDisplayText[status]}`,
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    allOf: [
+                                        {
+                                            $ref: '#/components/schemas/VovkErrorResponse',
+                                        },
+                                        {
+                                            type: 'object',
+                                            properties: {
+                                                message: {
+                                                    type: 'string',
+                                                    enum: [
+                                                        message,
+                                                        ...(handlerSchema?.operationObject?.responses?.[status]?.content?.['application/json']
+                                                            ?.schema?.allOf?.[1]?.properties?.message?.enum ?? []),
+                                                    ],
+                                                },
+                                                statusCode: {
+                                                    type: 'integer',
+                                                    enum: [status],
+                                                },
+                                            },
+                                        },
+                                    ],
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        };
+    };
+});

package/mjs/openapi/index.d.ts

@@ -0,0 +1,8 @@
+import { vovkSchemaToOpenAPI } from './vovkSchemaToOpenAPI';
+import { openAPIToVovkSchema } from './openAPIToVovkSchema/index';
+import type { VovkOperationObject } from '../types';
+export declare const operationDecorator: (openAPIOperationObject?: VovkOperationObject | undefined) => (target: import("../types").KnownAny, propertyKey: string) => void;
+export declare const operation: ((openAPIOperationObject?: VovkOperationObject | undefined) => (target: import("../types").KnownAny, propertyKey: string) => void) & {
+    error: (status: import("../types").HttpStatus, message: string) => (target: import("../types").KnownAny, propertyKey: string) => void;
+};
+export { vovkSchemaToOpenAPI, openAPIToVovkSchema };

package/mjs/openapi/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openAPIToVovkSchema = exports.vovkSchemaToOpenAPI = exports.operation = exports.operationDecorator = void 0;
+const vovkSchemaToOpenAPI_1 = require("./vovkSchemaToOpenAPI");
+Object.defineProperty(exports, "vovkSchemaToOpenAPI", { enumerable: true, get: function () { return vovkSchemaToOpenAPI_1.vovkSchemaToOpenAPI; } });
+const index_1 = require("./openAPIToVovkSchema/index");
+Object.defineProperty(exports, "openAPIToVovkSchema", { enumerable: true, get: function () { return index_1.openAPIToVovkSchema; } });
+const error_1 = require("./error");
+const createDecorator_1 = require("../utils/createDecorator");
+exports.operationDecorator = (0, createDecorator_1.createDecorator)(null, (openAPIOperationObject = {}) => {
+    return (handlerSchema) => {
+        return {
+            ...handlerSchema,
+            operationObject: {
+                ...handlerSchema?.operationObject,
+                ...openAPIOperationObject,
+            },
+        };
+    };
+});
+exports.operation = Object.assign(exports.operationDecorator, { error: error_1.error });

package/mjs/openapi/openAPIToVovkSchema/applyComponentsSchemas.d.ts

@@ -0,0 +1,3 @@
+import { ComponentsObject } from 'openapi3-ts/oas31';
+import { VovkBasicJSONSchema } from '../../types';
+export declare function applyComponentsSchemas(schema: VovkBasicJSONSchema, components: ComponentsObject['schemas'], mixinName: string): VovkBasicJSONSchema | VovkBasicJSONSchema[];

package/mjs/openapi/openAPIToVovkSchema/applyComponentsSchemas.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyComponentsSchemas = applyComponentsSchemas;
+const camelCase_1 = require("../../utils/camelCase");
+const upperFirst_1 = require("../../utils/upperFirst");
+// fast clone JSON object while ignoring Date, RegExp, and Function types
+function cloneJSON(obj) {
+    if (obj === null || typeof obj !== 'object')
+        return obj;
+    if (Array.isArray(obj))
+        return obj.map(cloneJSON);
+    const result = {};
+    for (const [key, value] of Object.entries(obj)) {
+        if (value instanceof Date || value instanceof RegExp || typeof value === 'function')
+            continue;
+        result[key] = cloneJSON(value);
+    }
+    return result;
+}
+function applyComponentsSchemas(schema, components, mixinName) {
+    const key = 'components/schemas';
+    if (!components || !Object.keys(components).length)
+        return schema;
+    // Create a deep copy of the schema
+    const result = cloneJSON(schema);
+    // Initialize $defs if it doesn't exist
+    result.$defs = result.$defs || {};
+    // Set to track components we've added to $defs
+    const addedComponents = new Set();
+    // Process a schema object and replace $refs
+    function processSchema(obj) {
+        if (!obj || typeof obj !== 'object')
+            return obj;
+        // Handle arrays first - they don't have $ref
+        if (Array.isArray(obj)) {
+            return obj.map((item) => processSchema(item));
+        }
+        // Now we know it's an object, so we can safely access $ref
+        const newObj = { ...obj };
+        const $ref = newObj.$ref;
+        if ($ref && typeof $ref === 'string' && $ref.startsWith(`#/${key}/`)) {
+            const componentName = $ref.replace(`#/${key}/`, '');
+            if (components[componentName]) {
+                newObj.$ref = `#/$defs/${componentName}`;
+                newObj['x-tsType'] ??= `Mixins.${(0, upperFirst_1.upperFirst)((0, camelCase_1.camelCase)(mixinName))}.${(0, upperFirst_1.upperFirst)((0, camelCase_1.camelCase)(componentName))}`;
+            }
+            else {
+                delete newObj.$ref; // Remove $ref if component not found (Telegram API has Type $refs that is not defined in components)
+            }
+            // Add the component to $defs if not already added
+            if (!addedComponents.has(componentName) && components[componentName]) {
+                addedComponents.add(componentName);
+                // TODO: Optimize
+                result.$defs[componentName] = processSchema(cloneJSON(components[componentName]));
+            }
+        }
+        // Process properties recursively
+        for (const key in newObj) {
+            if (Object.prototype.hasOwnProperty.call(newObj, key)) {
+                newObj[key] = processSchema(newObj[key]);
+            }
+        }
+        return newObj;
+    }
+    // Process the main schema
+    return processSchema(result);
+}

package/mjs/openapi/openAPIToVovkSchema/index.d.ts

@@ -0,0 +1,4 @@
+import { VovkOpenAPIMixinNormalized, type VovkSchema } from '../../types';
+export declare function openAPIToVovkSchema({ apiRoot, source: { object: openAPIObject }, getModuleName, getMethodName, errorMessageKey, segmentName, }: VovkOpenAPIMixinNormalized & {
+    segmentName?: string;
+}): VovkSchema;

package/mjs/openapi/openAPIToVovkSchema/index.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openAPIToVovkSchema = openAPIToVovkSchema;
+const types_1 = require("../../types");
+const applyComponentsSchemas_1 = require("./applyComponentsSchemas");
+const inlineRefs_1 = require("./inlineRefs");
+function openAPIToVovkSchema({ apiRoot, source: { object: openAPIObject }, getModuleName, getMethodName, errorMessageKey, segmentName, }) {
+    segmentName = segmentName ?? '';
+    const forceApiRoot = apiRoot ||
+        (openAPIObject.servers?.[0]?.url ??
+            ('host' in openAPIObject
+                ? `https://${openAPIObject.host}${'basePath' in openAPIObject ? openAPIObject.basePath : ''}`
+                : null));
+    if (!forceApiRoot) {
+        throw new Error('API root URL is required in OpenAPI configuration');
+    }
+    const { paths, ...noPathsOpenAPIObject } = openAPIObject;
+    const schema = {
+        $schema: types_1.VovkSchemaIdEnum.SCHEMA,
+        segments: {
+            [segmentName]: {
+                $schema: types_1.VovkSchemaIdEnum.SEGMENT,
+                emitSchema: true,
+                segmentName,
+                segmentType: 'mixin',
+                controllers: {},
+                forceApiRoot,
+                meta: {
+                    openAPIObject: noPathsOpenAPIObject,
+                },
+            },
+        },
+    };
+    const segment = schema.segments[segmentName];
+    return Object.entries(paths ?? {}).reduce((acc, [path, operations]) => {
+        Object.entries(operations ?? {})
+            .filter(([, operation]) => operation && typeof operation === 'object')
+            .forEach(([method, operation]) => {
+            const rpcModuleName = getModuleName({
+                method: method.toUpperCase(),
+                path,
+                openAPIObject,
+                operationObject: operation,
+            });
+            const handlerName = getMethodName({
+                method: method.toUpperCase(),
+                path,
+                openAPIObject,
+                operationObject: operation,
+            });
+            segment.controllers[rpcModuleName] ??= {
+                rpcModuleName,
+                handlers: {},
+            };
+            const parameters = (0, inlineRefs_1.inlineRefs)(operation.parameters ?? [], openAPIObject);
+            const queryProperties = parameters.filter((p) => p.in === 'query') ?? null;
+            const pathProperties = parameters.filter((p) => p.in === 'path') ?? null;
+            const query = queryProperties?.length
+                ? {
+                    type: 'object',
+                    properties: Object.fromEntries(queryProperties.map((p) => [p.name, p.schema])),
+                    required: queryProperties.filter((p) => p.required).map((p) => p.name),
+                }
+                : null;
+            const params = pathProperties?.length
+                ? {
+                    type: 'object',
+                    properties: Object.fromEntries(pathProperties.map((p) => [p.name, p.schema])),
+                    required: pathProperties.filter((p) => p.required).map((p) => p.name),
+                }
+                : null;
+            // TODO: how to utilize ReferenceObject?
+            const requestBodyContent = (0, inlineRefs_1.inlineRefs)(operation.requestBody, openAPIObject)?.content ?? {};
+            const jsonBody = requestBodyContent['application/json']?.schema ?? null;
+            const formDataBody = requestBodyContent['multipart/form-data']?.schema ?? null;
+            let urlEncodedBody = requestBodyContent['application/x-www-form-urlencoded']?.schema ?? null;
+            if (formDataBody && urlEncodedBody && JSON.stringify(formDataBody) === JSON.stringify(urlEncodedBody)) {
+                urlEncodedBody = null; // Avoid duplication if both form-data and url-encoded bodies are the same
+            }
+            if (formDataBody) {
+                Object.assign(formDataBody, {
+                    'x-isForm': true,
+                    'x-tsType': 'FormData',
+                });
+            }
+            if (urlEncodedBody) {
+                Object.assign(urlEncodedBody, {
+                    'x-isForm': true,
+                    'x-tsType': 'FormData',
+                });
+            }
+            const bodySchemas = [jsonBody, formDataBody, urlEncodedBody].filter(Boolean);
+            const body = !bodySchemas.length
+                ? null
+                : bodySchemas.length === 1
+                    ? bodySchemas[0]
+                    : {
+                        anyOf: bodySchemas,
+                    };
+            const output = operation.responses?.['200']?.content?.['application/json']?.schema ??
+                operation.responses?.['201']?.content?.['application/json']?.schema ??
+                null;
+            const iteration = operation.responses?.['200']?.content?.['application/jsonl']?.schema ??
+                operation.responses?.['201']?.content?.['application/jsonl']?.schema ??
+                operation.responses?.['200']?.content?.['application/jsonlines']?.schema ??
+                operation.responses?.['201']?.content?.['application/jsonlines']?.schema ??
+                null;
+            if (errorMessageKey) {
+                operation['x-errorMessageKey'] = errorMessageKey;
+            }
+            const componentsSchemas = openAPIObject.components?.schemas ??
+                ('definitions' in openAPIObject ? openAPIObject.definitions : {});
+            segment.controllers[rpcModuleName].handlers[handlerName] = {
+                httpMethod: method.toUpperCase(),
+                path,
+                operationObject: operation,
+                misc: {
+                    originalPath: path,
+                },
+                validation: {
+                    ...(query && {
+                        query: (0, applyComponentsSchemas_1.applyComponentsSchemas)(query, componentsSchemas, segmentName),
+                    }),
+                    ...(params && {
+                        params: (0, applyComponentsSchemas_1.applyComponentsSchemas)(params, componentsSchemas, segmentName),
+                    }),
+                    ...(body && {
+                        body: (0, applyComponentsSchemas_1.applyComponentsSchemas)(body, componentsSchemas, segmentName),
+                    }),
+                    ...(output && {
+                        output: (0, applyComponentsSchemas_1.applyComponentsSchemas)(output, componentsSchemas, segmentName),
+                    }),
+                    ...(iteration && {
+                        iteration: (0, applyComponentsSchemas_1.applyComponentsSchemas)(iteration, componentsSchemas, segmentName),
+                    }),
+                },
+            };
+        });
+        return acc;
+    }, schema);
+}

package/mjs/openapi/openAPIToVovkSchema/inlineRefs.d.ts

@@ -0,0 +1,10 @@
+import { OpenAPIObject } from 'openapi3-ts/oas31';
+import { KnownAny } from '../../types';
+/**
+ * Resolves $ref references at the first level only (except for components/schemas references)
+ * For arrays, checks each item at the first level
+ * @param obj - The object to process (may contain $ref properties)
+ * @param openAPIObject - The complete OpenAPI document containing definitions
+ * @returns The object with resolved references (except components/schemas)
+ */
+export declare function inlineRefs<T extends object>(obj: KnownAny, openAPIObject: OpenAPIObject): T;

package/mjs/openapi/openAPIToVovkSchema/inlineRefs.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inlineRefs = inlineRefs;
+/**
+ * Resolves $ref references at the first level only (except for components/schemas references)
+ * For arrays, checks each item at the first level
+ * @param obj - The object to process (may contain $ref properties)
+ * @param openAPIObject - The complete OpenAPI document containing definitions
+ * @returns The object with resolved references (except components/schemas)
+ */
+function inlineRefs(obj, openAPIObject) {
+    // Handle null or undefined
+    if (obj === null || obj === undefined) {
+        return obj;
+    }
+    // Handle arrays - check each item for $ref at first level only
+    if (Array.isArray(obj)) {
+        return obj.map((item) => {
+            // Only resolve if item is an object with $ref
+            if (item && typeof item === 'object' && '$ref' in item && typeof item.$ref === 'string') {
+                // Skip components/schemas references
+                if (item.$ref.startsWith('#/components/schemas/')) {
+                    return item;
+                }
+                // Resolve the reference
+                const resolved = resolveRef(item.$ref, openAPIObject);
+                // If resolution successful, return resolved value (with any additional properties merged)
+                if (resolved !== undefined) {
+                    // If there are additional properties besides $ref, merge them
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    const { $ref: _$ref, ...additionalProps } = item;
+                    if (Object.keys(additionalProps).length > 0) {
+                        return { ...resolved, ...additionalProps };
+                    }
+                    return resolved;
+                }
+            }
+            // Return item as-is if not a resolvable $ref
+            return item;
+        });
+    }
+    // Handle non-objects (primitives)
+    if (typeof obj !== 'object') {
+        return obj;
+    }
+    // Check if object has a $ref property at the first level
+    if ('$ref' in obj && typeof obj.$ref === 'string') {
+        // Check if the reference points to components/schemas
+        if (obj.$ref.startsWith('#/components/schemas/')) {
+            // Return as-is for schema references
+            return obj;
+        }
+        // Resolve the reference
+        const resolved = resolveRef(obj.$ref, openAPIObject);
+        // If resolution successful, return resolved value (with any additional properties merged)
+        if (resolved !== undefined) {
+            // If there are additional properties besides $ref, merge them
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const { $ref: _$ref, ...additionalProps } = obj;
+            if (Object.keys(additionalProps).length > 0) {
+                return { ...resolved, ...additionalProps };
+            }
+            return resolved;
+        }
+    }
+    // For regular objects without $ref, return as-is (no recursion)
+    return obj;
+}
+/**
+ * Resolves a JSON Reference ($ref) to its target value
+ * @param ref - The reference string (e.g., "#/components/parameters/id")
+ * @param openAPIObject - The complete OpenAPI document
+ * @returns The resolved value or undefined if not found
+ */
+function resolveRef(ref, openAPIObject) {
+    // Handle only local references (starting with #)
+    if (!ref.startsWith('#/')) {
+        // eslint-disable-next-line no-console
+        console.warn(`External references are not supported: ${ref}`);
+        return undefined;
+    }
+    // Remove the leading # and split the path
+    const path = ref
+        .substring(1)
+        .split('/')
+        .filter((p) => p !== '');
+    // Navigate through the object following the path
+    let current = openAPIObject;
+    for (const segment of path) {
+        // Decode the segment (handles encoded characters like ~0 for ~ and ~1 for /)
+        const decodedSegment = segment.replace(/~1/g, '/').replace(/~0/g, '~');
+        if (current && typeof current === 'object' && decodedSegment in current) {
+            current = current[decodedSegment];
+        }
+        else {
+            // eslint-disable-next-line no-console
+            console.warn(`Could not resolve reference: ${ref}`);
+            return undefined;
+        }
+    }
+    return current;
+}

package/mjs/openapi/vovkSchemaToOpenAPI.d.ts

@@ -0,0 +1,8 @@
+import type { OpenAPIObject } from 'openapi3-ts/oas31';
+import { type VovkSchema, type VovkGeneratorConfig } from '../types';
+export declare function vovkSchemaToOpenAPI({ rootEntry, schema: fullSchema, configs, segmentName: givenSegmentName, }: {
+    rootEntry?: string;
+    schema: VovkSchema;
+    configs?: VovkGeneratorConfig[];
+    segmentName?: string;
+}): OpenAPIObject;