vovk 3.0.0-draft.46 → 3.0.0-draft.460

package/cjs/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/cjs/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/cjs/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/cjs/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;

package/cjs/openapi/vovkSchemaToOpenAPI.js

@@ -0,0 +1,238 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.vovkSchemaToOpenAPI = vovkSchemaToOpenAPI;
+const createCodeSamples_1 = require("../utils/createCodeSamples");
+const types_1 = require("../types");
+const getJSONSchemaSample_1 = require("../utils/getJSONSchemaSample");
+const resolveGeneratorConfigValues_1 = require("../utils/resolveGeneratorConfigValues");
+function extractComponents(schema) {
+    if (!schema)
+        return [undefined, {}];
+    const components = {};
+    // Function to collect components and replace $refs recursively
+    const process = (obj, path = []) => {
+        if (!obj || typeof obj !== 'object')
+            return obj;
+        // Handle arrays
+        if (Array.isArray(obj)) {
+            return obj.map((item) => process(item, path));
+        }
+        // Create a copy to modify
+        const result = {};
+        Object.entries({ ...obj.definitions, ...obj.$defs }).forEach(([key, value]) => {
+            components[key] = process(value, [...path, key]);
+        });
+        // Process all properties
+        for (const [key, value] of Object.entries(obj ?? {})) {
+            // Skip already processed special properties
+            if (key === '$defs' || key === 'definitions')
+                continue;
+            if (key === '$ref' && typeof value === 'string') {
+                // Extract the component name from the reference
+                const refParts = value.split('/');
+                const refName = refParts[refParts.length - 1];
+                // Replace with component reference
+                result[key] = `#/components/schemas/${refName}`;
+            }
+            else {
+                // Recursively process other properties
+                result[key] = process(value, [...path, key]);
+            }
+        }
+        return result;
+    };
+    const processedSchema = process(schema);
+    return [processedSchema, components];
+}
+function vovkSchemaToOpenAPI({ rootEntry = 'api', schema: fullSchema, configs, segmentName: givenSegmentName, }) {
+    const paths = {};
+    const components = {};
+    const { openAPIObject, samples: samplesConfig, package: packageJson, } = (0, resolveGeneratorConfigValues_1.resolveGeneratorConfigValues)({
+        schema: fullSchema,
+        configs,
+        segmentName: givenSegmentName ?? null,
+    });
+    for (const [segmentName, segmentSchema] of givenSegmentName
+        ? [[givenSegmentName, fullSchema.segments[givenSegmentName]]]
+        : Object.entries(fullSchema.segments ?? {})) {
+        for (const c of Object.values(segmentSchema.controllers)) {
+            for (const [handlerName, h] of Object.entries(c.handlers ?? {})) {
+                if (h.operationObject) {
+                    const [queryValidation, queryComponents] = extractComponents(h?.validation?.query);
+                    const [bodyValidation, bodyComponents] = extractComponents(h?.validation?.body);
+                    const [paramsValidation, paramsComponents] = extractComponents(h?.validation?.params);
+                    const [outputValidation, outputComponents] = extractComponents(h?.validation?.output);
+                    const [iterationValidation, iterationComponents] = extractComponents(h?.validation?.iteration);
+                    // TODO: Handle name conflicts?
+                    Object.assign(components, queryComponents, bodyComponents, paramsComponents, outputComponents, iterationComponents);
+                    const { ts, rs, py } = (0, createCodeSamples_1.createCodeSamples)({
+                        package: packageJson,
+                        handlerName,
+                        handlerSchema: h,
+                        controllerSchema: c,
+                        config: samplesConfig,
+                    });
+                    const queryParameters = queryValidation && 'type' in queryValidation && 'properties' in queryValidation
+                        ? Object.entries(queryValidation.properties ?? {}).map(([propName, propSchema]) => ({
+                            name: propName,
+                            in: 'query',
+                            required: queryValidation.required ? queryValidation.required.includes(propName) : false,
+                            schema: propSchema,
+                        }))
+                        : null;
+                    const pathParameters = paramsValidation && 'type' in paramsValidation && 'properties' in paramsValidation
+                        ? Object.entries(paramsValidation.properties ?? {}).map(([propName, propSchema]) => ({
+                            name: propName,
+                            in: 'path',
+                            required: paramsValidation.required ? paramsValidation.required.includes(propName) : false,
+                            schema: propSchema,
+                        }))
+                        : null;
+                    const path = h.misc?.originalPath ??
+                        '/' + [rootEntry.replace(/^\/+|\/+$/g, ''), segmentName, c.prefix, h.path].filter(Boolean).join('/');
+                    paths[path] = paths[path] ?? {};
+                    const httpMethod = h.httpMethod.toLowerCase();
+                    paths[path][httpMethod] ??= {};
+                    paths[path][httpMethod] = {
+                        ...h.operationObject,
+                        ...paths[path][httpMethod],
+                        'x-codeSamples': [
+                            ...(paths[path][httpMethod]['x-codeSamples'] ?? []),
+                            ...(h.operationObject?.['x-codeSamples'] ?? []),
+                            {
+                                label: 'TypeScript RPC',
+                                lang: 'typescript',
+                                source: ts,
+                            },
+                            {
+                                label: 'Python RPC',
+                                lang: 'python',
+                                source: py,
+                            },
+                            {
+                                label: 'Rust RPC',
+                                lang: 'rust',
+                                source: rs,
+                            },
+                        ],
+                        ...(queryParameters || pathParameters
+                            ? {
+                                parameters: h.operationObject?.parameters ?? [...(queryParameters || []), ...(pathParameters || [])],
+                            }
+                            : {}),
+                        ...(paths[path][httpMethod].parameters
+                            ? {
+                                parameters: paths[path][httpMethod].parameters,
+                            }
+                            : {}),
+                        ...(outputValidation && 'type' in outputValidation
+                            ? {
+                                responses: {
+                                    200: {
+                                        description: 'description' in outputValidation ? outputValidation.description : 'Success',
+                                        content: {
+                                            'application/json': {
+                                                schema: outputValidation,
+                                            },
+                                        },
+                                    },
+                                    ...h.operationObject?.responses,
+                                },
+                            }
+                            : {}),
+                        ...(iterationValidation && 'type' in iterationValidation
+                            ? {
+                                responses: {
+                                    200: {
+                                        description: 'description' in iterationValidation ? iterationValidation.description : 'JSON Lines response',
+                                        content: {
+                                            'application/jsonl': {
+                                                schema: {
+                                                    ...iterationValidation,
+                                                    examples: iterationValidation.examples ?? [
+                                                        [
+                                                            JSON.stringify((0, getJSONSchemaSample_1.getJSONSchemaSample)(iterationValidation)),
+                                                            JSON.stringify((0, getJSONSchemaSample_1.getJSONSchemaSample)(iterationValidation)),
+                                                            JSON.stringify((0, getJSONSchemaSample_1.getJSONSchemaSample)(iterationValidation)),
+                                                        ].join('\n'),
+                                                    ],
+                                                },
+                                            },
+                                        },
+                                    },
+                                    ...h.operationObject?.responses,
+                                },
+                            }
+                            : {}),
+                        ...(paths[path][httpMethod].responses
+                            ? {
+                                responses: paths[path][httpMethod].responses,
+                            }
+                            : {}),
+                        ...(bodyValidation && 'type' in bodyValidation
+                            ? {
+                                requestBody: h.operationObject?.requestBody ?? {
+                                    description: 'description' in bodyValidation ? bodyValidation.description : 'Request body',
+                                    required: true,
+                                    content: {
+                                        'application/json': {
+                                            schema: bodyValidation,
+                                        },
+                                    },
+                                },
+                            }
+                            : {}),
+                        ...(paths[path][httpMethod].requestBody
+                            ? {
+                                requestBody: paths[path][httpMethod].requestBody,
+                            }
+                            : {}),
+                        tags: paths[path][httpMethod].tags ?? h.operationObject?.tags,
+                    };
+                }
+            }
+        }
+    }
+    return {
+        ...openAPIObject,
+        components: {
+            ...openAPIObject?.components,
+            schemas: {
+                ...(openAPIObject?.components?.schemas ?? components),
+                HttpStatus: {
+                    type: 'integer',
+                    description: 'HTTP status code',
+                    enum: Object.keys(types_1.HttpStatus)
+                        .map((k) => types_1.HttpStatus[k])
+                        .filter(Boolean)
+                        .filter((v) => typeof v === 'number'),
+                },
+                VovkErrorResponse: {
+                    type: 'object',
+                    description: 'Vovk error response',
+                    properties: {
+                        cause: {
+                            description: 'Error cause of any shape',
+                        },
+                        statusCode: {
+                            $ref: '#/components/schemas/HttpStatus',
+                        },
+                        message: {
+                            type: 'string',
+                            description: 'Error message',
+                        },
+                        isError: {
+                            type: 'boolean',
+                            const: true,
+                            description: 'Indicates that this object represents an error',
+                        },
+                    },
+                    required: ['statusCode', 'message', 'isError'],
+                    additionalProperties: false,
+                },
+                ...openAPIObject?.components?.schemas,
+            },
+        },
+        paths,
+    };
+}