docs-v2/api-docs/scripts/post-process-specs.ts

#!/usr/bin/env node
/**
 * Post-Process Specs
 *
 * Applies content overlays and tag configuration to bundled OpenAPI specs.
 * Runs after `getswagger.sh` bundles specs and before
 * `generate-openapi-articles.ts` generates Hugo pages.
 *
 * Replaces Redocly decorators for:
 * - info.yml overlays (title, description, version, license, contact, x-* fields)
 * - servers.yml overlays (replaces spec.servers array)
 * - tags.yml config (rename, describe, add x-related links to tags)
 *
 * Usage:
 *   node api-docs/scripts/dist/post-process-specs.js              # All products
 *   node api-docs/scripts/dist/post-process-specs.js influxdb3/core  # One product
 *
 * @module post-process-specs
 */

import * as fs from 'fs';
import * as path from 'path';
import * as yaml from 'js-yaml';

// ---------------------------------------------------------------------------
// Types
// ---------------------------------------------------------------------------

interface RelatedLink {
  title: string;
  href: string;
}

interface TagConfig {
  rename?: string;
  description?: string;
  'x-traitTag'?: boolean;
  'x-related'?: RelatedLink[];
}

interface TagsYml {
  tags: Record<string, TagConfig>;
}

interface ProductConfigApi {
  root: string;
  [key: string]: unknown;
}

interface ProductConfigYml {
  apis?: Record<string, ProductConfigApi>;
  [key: string]: unknown;
}

/** An OpenAPI tag object. */
interface OpenApiTag {
  name: string;
  description?: string;
  'x-related'?: RelatedLink[];
  [key: string]: unknown;
}

/** An OpenAPI info object. */
interface OpenApiInfo {
  title?: string;
  version?: string;
  summary?: string;
  description?: string;
  license?: Record<string, unknown>;
  contact?: Record<string, unknown>;
  [key: string]: unknown;
}

/** An OpenAPI server object. */
interface OpenApiServer {
  url: string;
  description?: string;
  variables?: Record<string, unknown>;
  [key: string]: unknown;
}

/** Minimal shape of an OpenAPI spec for post-processing. */
interface OpenApiSpec {
  info?: OpenApiInfo;
  servers?: OpenApiServer[];
  tags?: OpenApiTag[];
  paths?: Record<
    string,
    Record<string, { tags?: string[]; [k: string]: unknown }>
  >;
  [key: string]: unknown;
}

// ---------------------------------------------------------------------------
// Constants
// ---------------------------------------------------------------------------

const LOG_PREFIX = '[post-process]';

/** Product directories that contain a .config.yml with `apis:` entries. */
const PRODUCT_DIRS = [
  'influxdb3/core',
  'influxdb3/enterprise',
  'influxdb3/cloud-dedicated',
  'influxdb3/cloud-serverless',
  'influxdb3/clustered',
  'influxdb/cloud',
  'influxdb/v2',
  'influxdb/v1',
  'enterprise_influxdb/v1',
];

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

/**
 * Parse a YAML file and return the parsed object, or null if the file does
 * not exist.
 */
function loadYaml<T>(filePath: string): T | null {
  if (!fs.existsSync(filePath)) return null;
  const raw = fs.readFileSync(filePath, 'utf8');
  return yaml.load(raw) as T;
}

/**
 * Write an object to a YAML file.
 */
function writeYaml(filePath: string, data: unknown): void {
  fs.writeFileSync(filePath, yaml.dump(data, { lineWidth: -1 }), 'utf8');
}

function log(msg: string): void {
  process.stderr.write(`${LOG_PREFIX} ${msg}\n`);
}

// ---------------------------------------------------------------------------
// Content overlays
// ---------------------------------------------------------------------------

/**
 * Resolve a content file path using the same convention as the Redocly
 * docs-content.cjs helper: try API-specific directory first, fall back to
 * product-level directory.
 *
 * @param filename - e.g. 'info.yml' or 'servers.yml'
 * @param specDir - Absolute path to the directory containing the spec file.
 * @param productAbsDir - Absolute path to the product directory.
 * @returns Absolute path to the content file, or null if not found.
 */
function resolveContentFile(
  filename: string,
  specDir: string,
  productAbsDir: string
): string | null {
  // API-specific: {specDir}/content/{filename}
  const apiSpecific = path.join(specDir, 'content', filename);
  if (fs.existsSync(apiSpecific)) return apiSpecific;

  // Product-level fallback: {productAbsDir}/content/{filename}
  const productLevel = path.join(productAbsDir, 'content', filename);
  if (fs.existsSync(productLevel)) return productLevel;

  return null;
}

/**
 * Apply info.yml overlay to the spec. Merges each field present in the
 * overlay into spec.info, preserving fields not mentioned in the overlay.
 *
 * @returns true if any fields were applied.
 */
function applyInfoOverlay(
  spec: OpenApiSpec,
  specDir: string,
  productAbsDir: string,
  label: string
): boolean {
  const infoPath = resolveContentFile('info.yml', specDir, productAbsDir);
  if (!infoPath) return false;

  const overlay = loadYaml<Record<string, unknown>>(infoPath);
  if (!overlay) return false;

  if (!spec.info) spec.info = {};

  let applied = 0;
  for (const [key, value] of Object.entries(overlay)) {
    (spec.info as Record<string, unknown>)[key] = value;
    applied++;
  }

  if (applied > 0) {
    log(
      `${label}: applied ${applied} info field(s) from ${path.relative(productAbsDir, infoPath)}`
    );
  }
  return applied > 0;
}

/**
 * Apply servers.yml overlay to the spec. Replaces spec.servers entirely.
 *
 * @returns true if servers were applied.
 */
function applyServersOverlay(
  spec: OpenApiSpec,
  specDir: string,
  productAbsDir: string,
  label: string
): boolean {
  const serversPath = resolveContentFile('servers.yml', specDir, productAbsDir);
  if (!serversPath) return false;

  const servers = loadYaml<OpenApiServer[]>(serversPath);
  if (!servers || !Array.isArray(servers)) return false;

  spec.servers = servers;
  log(
    `${label}: applied ${servers.length} server(s) from ${path.relative(productAbsDir, serversPath)}`
  );
  return true;
}

// ---------------------------------------------------------------------------
// Tag config
// ---------------------------------------------------------------------------

/**
 * Collect every tag name referenced across all operations in the spec.
 */
function collectOperationTags(spec: OpenApiSpec): Set<string> {
  const found = new Set<string>();
  for (const pathItem of Object.values(spec.paths ?? {})) {
    for (const operation of Object.values(pathItem)) {
      if (
        operation &&
        typeof operation === 'object' &&
        Array.isArray(operation.tags)
      ) {
        for (const t of operation.tags) found.add(t as string);
      }
    }
  }
  return found;
}

/**
 * Rename a tag throughout the spec: in `tags[]` and in every operation.
 */
function renameTag(spec: OpenApiSpec, oldName: string, newName: string): void {
  for (const tag of spec.tags ?? []) {
    if (tag.name === oldName) tag.name = newName;
  }
  for (const pathItem of Object.values(spec.paths ?? {})) {
    for (const operation of Object.values(pathItem)) {
      if (
        operation &&
        typeof operation === 'object' &&
        Array.isArray(operation.tags)
      ) {
        operation.tags = operation.tags.map((t: string) =>
          t === oldName ? newName : t
        );
      }
    }
  }
}

/**
 * Apply tag config from a `tags.yml` file to the spec.
 *
 * @returns true if any tags were patched.
 */
function applyTagConfig(
  spec: OpenApiSpec,
  tagConfigPath: string,
  label: string
): boolean {
  const tagsCfg = loadYaml<TagsYml>(tagConfigPath);
  if (!tagsCfg || !tagsCfg.tags) {
    log(`${label}: tags.yml has no 'tags' key — skipping`);
    return false;
  }

  if (!Array.isArray(spec.tags)) spec.tags = [];

  const operationTags = collectOperationTags(spec);
  const configKeys = Object.keys(tagsCfg.tags);

  // Warn: config references a tag not in the spec
  for (const cfgKey of configKeys) {
    const effectiveName = tagsCfg.tags[cfgKey]?.rename ?? cfgKey;
    if (!operationTags.has(cfgKey) && !operationTags.has(effectiveName)) {
      log(`WARN ${label}: config tag '${cfgKey}' not found in spec operations`);
    }
  }

  // Warn: spec has operation tags with no config entry
  Array.from(operationTags).forEach((opTag) => {
    const hasEntry = configKeys.some(
      (k) => k === opTag || tagsCfg.tags[k]?.rename === opTag
    );
    if (!hasEntry) {
      log(`WARN ${label}: spec tag '${opTag}' has no config entry in tags.yml`);
    }
  });

  // Apply transformations
  for (const [tagKey, cfg] of Object.entries(tagsCfg.tags)) {
    if (cfg.rename) {
      log(`${label}: renaming tag '${tagKey}' → '${cfg.rename}'`);
      renameTag(spec, tagKey, cfg.rename);
    }

    const resolvedName = cfg.rename ?? tagKey;
    let tagObj = spec.tags!.find((t) => t.name === resolvedName);
    if (!tagObj) {
      tagObj = { name: resolvedName };
      spec.tags!.push(tagObj);
    }

    if (cfg.description !== undefined)
      tagObj.description = cfg.description.trim();
    if (cfg['x-traitTag'] !== undefined)
      tagObj['x-traitTag'] = cfg['x-traitTag'];
    if (cfg['x-related'] !== undefined) tagObj['x-related'] = cfg['x-related'];
  }

  log(`${label}: patched ${configKeys.length} tag(s)`);
  return true;
}

// ---------------------------------------------------------------------------
// Core logic
// ---------------------------------------------------------------------------

/**
 * Process a single product directory: read `.config.yml`, find spec files,
 * apply content overlays and tag configs.
 */
function processProduct(apiDocsRoot: string, productDir: string): void {
  const productAbsDir = path.join(apiDocsRoot, productDir);
  const configPath = path.join(productAbsDir, '.config.yml');

  const config = loadYaml<ProductConfigYml>(configPath);
  if (!config || !config.apis) {
    log(`${productDir}: no .config.yml or no 'apis' key — skipping`);
    return;
  }

  for (const [apiKey, apiEntry] of Object.entries(config.apis)) {
    const specRelPath = apiEntry.root;
    const specAbsPath = path.join(productAbsDir, specRelPath);
    const specDir = path.join(productAbsDir, path.dirname(specRelPath));
    const label = `${productDir}/${apiKey}`;

    if (!fs.existsSync(specAbsPath)) {
      log(`${label}: spec not found at ${specAbsPath} — skipping`);
      continue;
    }

    // Load spec once
    const spec = loadYaml<OpenApiSpec>(specAbsPath);
    if (!spec) {
      log(`${label}: failed to parse spec — skipping`);
      continue;
    }

    // Apply all transforms
    let modified = false;
    modified =
      applyInfoOverlay(spec, specDir, productAbsDir, label) || modified;
    modified =
      applyServersOverlay(spec, specDir, productAbsDir, label) || modified;

    const tagConfigPath = path.join(specDir, 'tags.yml');
    if (fs.existsSync(tagConfigPath)) {
      modified = applyTagConfig(spec, tagConfigPath, label) || modified;
    }

    // Write only if something changed
    if (modified) {
      writeYaml(specAbsPath, spec);
      log(`${label}: wrote ${path.basename(specAbsPath)}`);
    }
  }
}

// ---------------------------------------------------------------------------
// Entry point
// ---------------------------------------------------------------------------

function main(): void {
  const args = process.argv.slice(2);

  // Optional --root <path> flag for testing — overrides the default resolution.
  let apiDocsRoot = path.resolve(__dirname, '../..'); // api-docs/scripts/dist -> api-docs/
  let targetProduct: string | undefined;

  for (let i = 0; i < args.length; i++) {
    if (args[i] === '--root' && args[i + 1]) {
      apiDocsRoot = path.resolve(args[i + 1]!);
      i++;
    } else {
      targetProduct = args[i];
    }
  }

  const products = targetProduct ? [targetProduct] : PRODUCT_DIRS;

  let hasError = false;
  for (const productDir of products) {
    try {
      processProduct(apiDocsRoot, productDir);
    } catch (err) {
      log(`ERROR ${productDir}: ${(err as Error).message}`);
      hasError = true;
    }
  }

  process.exit(hasError ? 1 : 0);
}

main();