@redocly/openapi-core 1.34.4 → 2.0.0-next.1

package/src/config/utils.ts

@@ -1,439 +0,0 @@
-import {
-  assignOnlyExistingConfig,
-  assignConfig,
-  isDefined,
-  isTruthy,
-  showErrorForDeprecatedField,
-  showWarningForDeprecatedField,
-} from '../utils';
-import { Config } from './config';
-import { logger, colorize } from '../logger';
-
-import type {
-  Api,
-  DeprecatedInApi,
-  DeprecatedInRawConfig,
-  ImportedPlugin,
-  FlatApi,
-  FlatRawConfig,
-  RawConfig,
-  RawResolveConfig,
-  ResolveConfig,
-  ResolvedStyleguideConfig,
-  RulesFields,
-  StyleguideRawConfig,
-  ThemeConfig,
-  Plugin,
-  PluginCreator,
-} from './types';
-
-export function parsePresetName(presetName: string): { pluginId: string; configName: string } {
-  if (presetName.indexOf('/') > -1) {
-    const [pluginId, configName] = presetName.split('/');
-    return { pluginId, configName };
-  } else {
-    return { pluginId: '', configName: presetName };
-  }
-}
-
-export function transformApiDefinitionsToApis(
-  apiDefinitions?: DeprecatedInRawConfig['apiDefinitions']
-): Record<string, Api> | undefined {
-  if (!apiDefinitions) return undefined;
-  const apis: Record<string, Api> = {};
-  for (const [apiName, apiPath] of Object.entries(apiDefinitions)) {
-    apis[apiName] = { root: apiPath };
-  }
-  return apis;
-}
-
-function extractFlatConfig<
-  T extends Partial<
-    (Api & DeprecatedInApi & FlatApi) & (DeprecatedInRawConfig & RawConfig & FlatRawConfig)
-  >
->({
-  plugins,
-  extends: _extends,
-
-  rules,
-  oas2Rules,
-  oas3_0Rules,
-  oas3_1Rules,
-  async2Rules,
-  async3Rules,
-  arazzo1Rules,
-  overlay1Rules,
-
-  preprocessors,
-  oas2Preprocessors,
-  oas3_0Preprocessors,
-  oas3_1Preprocessors,
-  async2Preprocessors,
-  async3Preprocessors,
-  arazzo1Preprocessors,
-  overlay1Preprocessors,
-
-  decorators,
-  oas2Decorators,
-  oas3_0Decorators,
-  oas3_1Decorators,
-  async2Decorators,
-  async3Decorators,
-  arazzo1Decorators,
-  overlay1Decorators,
-
-  ...rawConfigRest
-}: T): {
-  styleguideConfig?: StyleguideRawConfig;
-  rawConfigRest: Omit<T, 'plugins' | 'extends' | RulesFields>;
-} {
-  const styleguideConfig = {
-    plugins,
-    extends: _extends,
-
-    rules,
-    oas2Rules,
-    oas3_0Rules,
-    oas3_1Rules,
-    async2Rules,
-    async3Rules,
-    arazzo1Rules,
-    overlay1Rules,
-
-    preprocessors,
-    oas2Preprocessors,
-    oas3_0Preprocessors,
-    oas3_1Preprocessors,
-    async2Preprocessors,
-    async3Preprocessors,
-    arazzo1Preprocessors,
-    overlay1Preprocessors,
-
-    decorators,
-    oas2Decorators,
-    oas3_0Decorators,
-    oas3_1Decorators,
-    async2Decorators,
-    async3Decorators,
-    arazzo1Decorators,
-    overlay1Decorators,
-
-    doNotResolveExamples: rawConfigRest.resolve?.doNotResolveExamples,
-  };
-
-  if (
-    (rawConfigRest.lint && rawConfigRest.styleguide) ||
-    (Object.values(styleguideConfig).some(isDefined) &&
-      (rawConfigRest.lint || rawConfigRest.styleguide))
-  ) {
-    throw new Error(
-      `Do not use 'lint', 'styleguide' and flat syntax together. \nSee more about the configuration in the docs: https://redocly.com/docs/cli/configuration/ \n`
-    );
-  }
-
-  return {
-    styleguideConfig: Object.values(styleguideConfig).some(isDefined)
-      ? styleguideConfig
-      : undefined,
-
-    rawConfigRest,
-  };
-}
-
-function transformApis(
-  legacyApis?: Record<string, Api & DeprecatedInApi & FlatApi>
-): Record<string, Api> | undefined {
-  if (!legacyApis) return undefined;
-  const apis: Record<string, Api> = {};
-  for (const [apiName, { lint, ...apiContent }] of Object.entries(legacyApis)) {
-    const { styleguideConfig, rawConfigRest } = extractFlatConfig(apiContent);
-    apis[apiName] = {
-      styleguide: styleguideConfig || lint,
-      ...rawConfigRest,
-    };
-  }
-  return apis;
-}
-
-export function prefixRules<T extends Record<string, any>>(rules: T, prefix: string) {
-  if (!prefix) return rules;
-
-  const res: any = {};
-  for (const name of Object.keys(rules)) {
-    res[`${prefix}/${name}`] = rules[name];
-  }
-
-  return res;
-}
-
-export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
-  const result: Omit<ResolvedStyleguideConfig, RulesFields> &
-    Required<Pick<ResolvedStyleguideConfig, RulesFields>> = {
-    rules: {},
-    oas2Rules: {},
-    oas3_0Rules: {},
-    oas3_1Rules: {},
-    async2Rules: {},
-    async3Rules: {},
-    arazzo1Rules: {},
-    overlay1Rules: {},
-
-    preprocessors: {},
-    oas2Preprocessors: {},
-    oas3_0Preprocessors: {},
-    oas3_1Preprocessors: {},
-    async2Preprocessors: {},
-    async3Preprocessors: {},
-    arazzo1Preprocessors: {},
-    overlay1Preprocessors: {},
-
-    decorators: {},
-    oas2Decorators: {},
-    oas3_0Decorators: {},
-    oas3_1Decorators: {},
-    async2Decorators: {},
-    async3Decorators: {},
-    arazzo1Decorators: {},
-    overlay1Decorators: {},
-
-    plugins: [],
-    pluginPaths: [],
-    extendPaths: [],
-  };
-
-  for (const rulesConf of rulesConfList) {
-    if (rulesConf.extends) {
-      throw new Error(
-        `'extends' is not supported in shared configs yet:\n${JSON.stringify(rulesConf, null, 2)}`
-      );
-    }
-
-    assignConfig(result.rules, rulesConf.rules);
-    assignConfig(result.oas2Rules, rulesConf.oas2Rules);
-    assignOnlyExistingConfig(result.oas2Rules, rulesConf.rules);
-    assignConfig(result.oas3_0Rules, rulesConf.oas3_0Rules);
-    assignOnlyExistingConfig(result.oas3_0Rules, rulesConf.rules);
-    assignConfig(result.oas3_1Rules, rulesConf.oas3_1Rules);
-    assignOnlyExistingConfig(result.oas3_1Rules, rulesConf.rules);
-    assignConfig(result.async2Rules, rulesConf.async2Rules);
-    assignOnlyExistingConfig(result.async2Rules, rulesConf.rules);
-    assignConfig(result.async3Rules, rulesConf.async3Rules);
-    assignOnlyExistingConfig(result.async3Rules, rulesConf.rules);
-    assignConfig(result.arazzo1Rules, rulesConf.arazzo1Rules);
-    assignOnlyExistingConfig(result.arazzo1Rules, rulesConf.rules);
-    assignConfig(result.overlay1Rules, rulesConf.overlay1Rules);
-    assignOnlyExistingConfig(result.overlay1Rules, rulesConf.rules);
-
-    assignConfig(result.preprocessors, rulesConf.preprocessors);
-    assignConfig(result.oas2Preprocessors, rulesConf.oas2Preprocessors);
-    assignOnlyExistingConfig(result.oas2Preprocessors, rulesConf.preprocessors);
-    assignConfig(result.oas3_0Preprocessors, rulesConf.oas3_0Preprocessors);
-    assignOnlyExistingConfig(result.oas3_0Preprocessors, rulesConf.preprocessors);
-    assignConfig(result.oas3_1Preprocessors, rulesConf.oas3_1Preprocessors);
-    assignOnlyExistingConfig(result.oas3_1Preprocessors, rulesConf.preprocessors);
-    assignConfig(result.async2Preprocessors, rulesConf.async2Preprocessors);
-    assignOnlyExistingConfig(result.async2Preprocessors, rulesConf.preprocessors);
-    assignConfig(result.async3Preprocessors, rulesConf.async3Preprocessors);
-    assignOnlyExistingConfig(result.async3Preprocessors, rulesConf.preprocessors);
-    assignConfig(result.arazzo1Preprocessors, rulesConf.arazzo1Preprocessors);
-    assignOnlyExistingConfig(result.arazzo1Preprocessors, rulesConf.preprocessors);
-    assignConfig(result.overlay1Preprocessors, rulesConf.overlay1Preprocessors);
-    assignOnlyExistingConfig(result.overlay1Preprocessors, rulesConf.preprocessors);
-
-    assignConfig(result.decorators, rulesConf.decorators);
-    assignConfig(result.oas2Decorators, rulesConf.oas2Decorators);
-    assignOnlyExistingConfig(result.oas2Decorators, rulesConf.decorators);
-    assignConfig(result.oas3_0Decorators, rulesConf.oas3_0Decorators);
-    assignOnlyExistingConfig(result.oas3_0Decorators, rulesConf.decorators);
-    assignConfig(result.oas3_1Decorators, rulesConf.oas3_1Decorators);
-    assignOnlyExistingConfig(result.oas3_1Decorators, rulesConf.decorators);
-    assignConfig(result.async2Decorators, rulesConf.async2Decorators);
-    assignOnlyExistingConfig(result.async2Decorators, rulesConf.decorators);
-    assignConfig(result.async3Decorators, rulesConf.async3Decorators);
-    assignOnlyExistingConfig(result.async3Decorators, rulesConf.decorators);
-    assignConfig(result.arazzo1Decorators, rulesConf.arazzo1Decorators);
-    assignOnlyExistingConfig(result.arazzo1Decorators, rulesConf.decorators);
-    assignConfig(result.overlay1Decorators, rulesConf.overlay1Decorators);
-    assignOnlyExistingConfig(result.overlay1Decorators, rulesConf.decorators);
-
-    result.plugins!.push(...(rulesConf.plugins || []));
-    result.pluginPaths!.push(...(rulesConf.pluginPaths || []));
-    result.extendPaths!.push(...new Set(rulesConf.extendPaths));
-  }
-
-  return result;
-}
-
-export function getMergedConfig(config: Config, apiName?: string): Config {
-  const extendPaths = [
-    ...Object.values(config.apis).map((api) => api?.styleguide?.extendPaths),
-    config.rawConfig?.styleguide?.extendPaths,
-  ]
-    .flat()
-    .filter(isTruthy);
-
-  const pluginPaths = [
-    ...Object.values(config.apis).map((api) => api?.styleguide?.pluginPaths),
-    config.rawConfig?.styleguide?.pluginPaths,
-  ]
-    .flat()
-    .filter(isTruthy);
-
-  return apiName
-    ? new Config(
-        {
-          ...config.rawConfig,
-          styleguide: {
-            ...(config.apis[apiName]
-              ? config.apis[apiName].styleguide
-              : config.rawConfig.styleguide),
-            extendPaths,
-            pluginPaths,
-          },
-          theme: {
-            ...config.rawConfig.theme,
-            ...config.apis[apiName]?.theme,
-          },
-          files: [...config.files, ...(config.apis?.[apiName]?.files ?? [])],
-          // TODO: merge everything else here
-        },
-        config.configFile
-      )
-    : config;
-}
-
-export function checkForDeprecatedFields(
-  deprecatedField: keyof (DeprecatedInRawConfig & RawConfig),
-  updatedField: keyof FlatRawConfig | undefined,
-  rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig,
-  updatedObject: keyof FlatRawConfig | undefined,
-  link?: string | undefined
-): void {
-  const isDeprecatedFieldInApis =
-    rawConfig.apis &&
-    Object.values(rawConfig.apis).some(
-      (api: Api & FlatApi & DeprecatedInApi & DeprecatedInRawConfig & RawConfig & FlatRawConfig) =>
-        api[deprecatedField]
-    );
-
-  if (rawConfig[deprecatedField] && updatedField === null) {
-    showWarningForDeprecatedField(deprecatedField, undefined, updatedObject, link);
-  }
-
-  if (rawConfig[deprecatedField] && updatedField && rawConfig[updatedField]) {
-    showErrorForDeprecatedField(deprecatedField, updatedField);
-  }
-
-  if (rawConfig[deprecatedField] && updatedObject && rawConfig[updatedObject]) {
-    showErrorForDeprecatedField(deprecatedField, updatedField, updatedObject);
-  }
-
-  if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
-    showWarningForDeprecatedField(deprecatedField, updatedField, updatedObject, link);
-  }
-}
-
-export function transformConfig(
-  rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig
-): RawConfig {
-  const migratedFields: [
-    keyof (DeprecatedInRawConfig & RawConfig),
-    keyof FlatRawConfig | undefined,
-    keyof ThemeConfig | undefined,
-    string | undefined
-  ][] = [
-    ['apiDefinitions', 'apis', undefined, undefined],
-    ['referenceDocs', 'openapi', 'theme', undefined],
-    [
-      'lint',
-      undefined,
-      undefined,
-      'https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties',
-    ],
-    [
-      'styleguide',
-      undefined,
-      undefined,
-      'https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties',
-    ],
-    ['features.openapi', 'openapi', 'theme', undefined],
-  ];
-
-  for (const [deprecatedField, updatedField, updatedObject, link] of migratedFields) {
-    checkForDeprecatedFields(deprecatedField, updatedField, rawConfig, updatedObject, link);
-  }
-
-  const { apis, apiDefinitions, referenceDocs, lint, ...rest } = rawConfig;
-
-  const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);
-
-  const transformedConfig: RawConfig = {
-    theme: {
-      openapi: {
-        ...referenceDocs,
-        ...rawConfig['features.openapi'],
-        ...rawConfig.theme?.openapi,
-      },
-      mockServer: {
-        ...rawConfig['features.mockServer'],
-        ...rawConfig.theme?.mockServer,
-      },
-    },
-    apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions),
-    styleguide: styleguideConfig || lint,
-    ...rawConfigRest,
-  };
-  showDeprecationMessages(transformedConfig);
-  return transformedConfig;
-}
-
-function showDeprecationMessages(config: RawConfig) {
-  let allRules = { ...config.styleguide?.rules };
-  for (const api of Object.values(config.apis || {})) {
-    allRules = { ...allRules, ...api?.styleguide?.rules };
-  }
-  for (const ruleKey of Object.keys(allRules)) {
-    if (ruleKey.startsWith('assert/')) {
-      logger.warn(
-        `\nThe 'assert/' syntax in ${ruleKey} is deprecated. Update your configuration to use 'rule/' instead. Examples and more information: https://redocly.com/docs/cli/rules/configurable-rules/\n`
-      );
-    }
-  }
-}
-
-export function getResolveConfig(resolve?: RawResolveConfig): ResolveConfig {
-  return {
-    http: {
-      headers: resolve?.http?.headers ?? [],
-      customFetch: undefined,
-    },
-  };
-}
-
-export function getUniquePlugins(plugins: Plugin[]): Plugin[] {
-  const seen = new Set();
-  const results = [];
-  for (const p of plugins) {
-    if (!seen.has(p.id)) {
-      results.push(p);
-      seen.add(p.id);
-    } else if (p.id) {
-      logger.warn(`Duplicate plugin id "${colorize.red(p.id)}".\n`);
-    }
-  }
-  return results;
-}
-
-export class ConfigValidationError extends Error {}
-
-export function deepCloneMapWithJSON<K, V>(originalMap: Map<K, V>): Map<K, V> {
-  return new Map(JSON.parse(JSON.stringify([...originalMap])));
-}
-
-export function isDeprecatedPluginFormat(plugin: ImportedPlugin | undefined): plugin is Plugin {
-  return plugin !== undefined && typeof plugin === 'object' && 'id' in plugin;
-}
-
-export function isCommonJsPlugin(plugin: ImportedPlugin | undefined): plugin is PluginCreator {
-  return typeof plugin === 'function';
-}