@common-grants/cli/dist/commands/check/utils/convert-openapi-v3.js

The CommonGrants protocol CLI tool

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.convertOpenApiToV3 = convertOpenApiToV3;
/**
 * Script to transform OpenAPI specifications.
 *
 * This module provides functionality to transform OpenAPI specifications from one
 * version to another, e.g. v3.1 to v3.0
 */
// OpenAPI version constants
const OPENAPI_V3 = "3.0.0";
/**
 * Convert OpenAPI schema v3.1 to 3.0.
 *
 * @param schema - The base OpenAPI schema from FastAPI
 * @returns The schema converted to OpenAPI 3.0 format
 */
function convertOpenApiToV3(schema) {
    // Set OpenAPI version
    schema.openapi = OPENAPI_V3;
    // Move schemas from components to definitions
    moveSchemasToDefinitions(schema);
    // Convert all schema references
    return convertRefs(schema);
}
/**
 * Move schemas from components to definitions for OpenAPI 3.0.0 compatibility.
 *
 * @param schema - The OpenAPI schema to modify
 */
function moveSchemasToDefinitions(schema) {
    // Initialize definitions if it doesn't exist
    if (!schema.definitions) {
        schema.definitions = {};
    }
    // Move schemas from components to definitions
    if (schema.components && schema.components.schemas) {
        schema.definitions = { ...schema.definitions, ...schema.components.schemas };
        // Keep the components section but remove schemas
        if (Object.keys(schema.components).length === 1) {
            // Only had schemas
            delete schema.components;
        }
        else {
            delete schema.components.schemas;
        }
    }
    // Move $defs to definitions
    moveDefsToDefinitions(schema);
}
/**
 * Move $defs sections to definitions for OpenAPI 3.0.0 compatibility.
 *
 * @param obj - The object to process
 */
function moveDefsToDefinitions(obj) {
    if (typeof obj === "object" && obj !== null) {
        if (Array.isArray(obj)) {
            obj.forEach(item => moveDefsToDefinitions(item));
        }
        else {
            // Check if this object has $defs
            const o = obj;
            if (o.$defs && typeof o.$defs === "object") {
                // Move $defs to the root definitions
                if (!o.definitions) {
                    o.definitions = {};
                }
                o.definitions = { ...o.definitions, ...o.$defs };
                delete o.$defs;
            }
            // Recursively process all properties
            for (const value of Object.values(o)) {
                moveDefsToDefinitions(value);
            }
        }
    }
}
/**
 * Convert a schema reference to OpenAPI 3.0.0 format.
 *
 * @param ref - The reference string to convert
 * @returns The converted reference
 */
function convertRef(ref) {
    if (ref.includes("#/components/schemas/")) {
        return ref.replace("#/components/schemas/", "#/definitions/");
    }
    if (ref.includes("#/$defs/")) {
        return ref.replace("#/$defs/", "#/definitions/");
    }
    return ref;
}
/**
 * Convert all schema references from components to definitions.
 *
 * @param obj - The object to convert references in
 * @returns The object with converted references
 */
function convertRefs(obj) {
    if (typeof obj === "object" && obj !== null) {
        if (Array.isArray(obj)) {
            return obj.map(item => convertRefs(item));
        }
        else {
            const result = {};
            for (const [k, v] of Object.entries(obj)) {
                if (k === "$ref") {
                    result[k] = convertRef(v);
                }
                else {
                    result[k] = convertRefs(v);
                }
            }
            return result;
        }
    }
    return obj;
}