update-openapi.js

#!/usr/bin/env node

/**
 * This script is used to update the openapi.json files in the client from source definitions
 *
 * npm usage: npm run openapi <path-to-openapi.yml>
 * direct usage: node ./update-openapi.js <default_source> <source>
 */
const { execSync } = require('child_process');

const defaultSrc = process.argv[2];
const overrideSrc = process.argv[3];
const includeEXT = process.argv.includes('--include-ext')
const sourceFile = overrideSrc || defaultSrc;

const OPENAPICMD = 'npx openapicmd';
const OUTPUT_FILE = './src/openapi.json';
const RUNTIME_FILE = './src/openapi-runtime.json';

// get server from default external source
console.log(`===> Reading server URL from ${defaultSrc}...`);
const definitionJSON = execSync(`${OPENAPICMD} read --json ${defaultSrc}`).toString();
const serverURL = JSON.parse(definitionJSON).servers?.[0]?.url;
console.log(`=====>> URL: ${serverURL}`);

// save full openapi.json from source
console.log(`===> Updating openapi.json from ${sourceFile}...`);
execSync(
  [
    OPENAPICMD,
    'read',
    includeEXT ? '' : '--exclude-ext x-internal',
    `--json ${sourceFile}`,
    serverURL ? `--server ${serverURL}` : '',
    '>',
    OUTPUT_FILE,
  ].join(' '),
  { stdio: 'inherit' },
);

// store optimized runtime version for client
console.log('===> Generating openapi-runtime.json');
execSync([OPENAPICMD, 'read', `--json ${OUTPUT_FILE}`, '--strip openapi_client_axios', '>', RUNTIME_FILE].join(' '), {
  stdio: 'inherit',
});

console.log('===> Done!');
process.exit(0);