@svengroup/openapi-to-pdf/dist/config/index.js

Create PDF API reference documentation from OpenAPI 3.0.x specification files.

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.base_config = void 0;
exports.getConfigFromFile = getConfigFromFile;
exports.getConfig = getConfig;
exports.getPdfConfigWithHeaderFooter = getPdfConfigWithHeaderFooter;
const merge_1 = require("../utils/merge");
const fs = __importStar(require("fs"));
exports.base_config = {
    include_cover: true,
    include_toc: true,
    headings: {
        toc: 'Contents',
        info: 'General Information',
        servers: 'Servers',
        security: 'Security',
        endpoints: 'Operations',
        untagged_endpoints: 'Others'
    },
    pdf_config: {
        page_media_type: 'print',
        highlight_style: 'github-dark',
        pdf_options: {
            printBackground: true, // eslint-disable-line @typescript-eslint/naming-convention
            outline: true,
            format: "A4",
            margin: {
                top: "15mm",
                bottom: "15mm",
                right: "15mm",
                left: "15mm",
            }
        }
    }
};
function getConfigFromFile(file) {
    if (file) {
        const config_file_contents = fs.readFileSync(file, 'utf8');
        return JSON.parse(config_file_contents);
    }
    return {};
}
function getConfig(config) {
    const templated_pdf_config = getPdfConfigWithHeaderFooter(config?.pdf_config ?? {}, config?.texts);
    const templated_config = (0, merge_1.deepMerge)(config, { pdf_config: templated_pdf_config });
    return (0, merge_1.deepMerge)(templated_config, exports.base_config);
}
function getPdfConfigWithHeaderFooter(pdf_config, texts) {
    if (!texts?.footer && !texts?.header) {
        return {};
    }
    const configured = {
        pdf_options: {
            displayHeaderFooter: true, // eslint-disable-line @typescript-eslint/naming-convention
            headerTemplate: `<style>#footer, #header {margin-right: 14.5mm; margin-left: 14.5mm; font-family: system-ui; font-size: 8px; }</style><section id="header"><div>${texts?.header ?? ''}</div></section>`, // eslint-disable-line @typescript-eslint/naming-convention
            footerTemplate: `<section id="#footer"><div>${texts?.footer ?? ''}</div></section>`, // eslint-disable-line @typescript-eslint/naming-convention
        }
    };
    return (0, merge_1.deepMerge)(configured, pdf_config);
}