@redocly/openapi-core 1.0.0-beta.125 → 1.0.0-beta.127

package/src/bundle.ts

@@ -1,399 +0,0 @@
-import isEqual = require('lodash.isequal');
-import { BaseResolver, resolveDocument, Document, ResolvedRefMap, makeRefId } from './resolve';
-import { Oas3Rule, normalizeVisitors, Oas3Visitor, Oas2Visitor } from './visitors';
-import { Oas3Types } from './types/oas3';
-import { Oas2Types } from './types/oas2';
-import { Oas3_1Types } from './types/oas3_1';
-import { NormalizedNodeType, normalizeTypes, NodeType } from './types';
-import { WalkContext, walkDocument, UserContext, ResolveResult, NormalizedProblem } from './walk';
-import { detectOpenAPI, openAPIMajor, OasMajorVersion } from './oas-types';
-import { isAbsoluteUrl, isRef, Location, refBaseName } from './ref-utils';
-import { initRules } from './config/rules';
-import { reportUnresolvedRef } from './rules/no-unresolved-refs';
-import { isPlainObject, isTruthy } from './utils';
-import { OasRef } from './typings/openapi';
-import { isRedoclyRegistryURL } from './redocly';
-import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './rules/oas2/remove-unused-components';
-import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './rules/oas3/remove-unused-components';
-
-import type { Config, StyleguideConfig } from './config';
-
-export type Oas3RuleSet = Record<string, Oas3Rule>;
-
-export enum OasVersion {
-  Version2 = 'oas2',
-  Version3_0 = 'oas3_0',
-  Version3_1 = 'oas3_1',
-}
-
-export async function bundle(opts: {
-  ref?: string;
-  doc?: Document;
-  externalRefResolver?: BaseResolver;
-  config: Config;
-  dereference?: boolean;
-  base?: string;
-  skipRedoclyRegistryRefs?: boolean;
-  removeUnusedComponents?: boolean;
-  keepUrlRefs?: boolean;
-}) {
-  const {
-    ref,
-    doc,
-    externalRefResolver = new BaseResolver(opts.config.resolve),
-    base = null,
-  } = opts;
-  if (!(ref || doc)) {
-    throw new Error('Document or reference is required.\n');
-  }
-
-  const document =
-    doc !== undefined ? doc : await externalRefResolver.resolveDocument(base, ref!, true);
-
-  if (document instanceof Error) {
-    throw document;
-  }
-
-  return bundleDocument({
-    document,
-    ...opts,
-    config: opts.config.styleguide,
-    externalRefResolver,
-  });
-}
-
-type BundleContext = WalkContext;
-
-export type BundleResult = {
-  bundle: Document;
-  problems: NormalizedProblem[];
-  fileDependencies: Set<string>;
-  rootType: NormalizedNodeType;
-  refTypes?: Map<string, NormalizedNodeType>;
-  visitorsData: Record<string, Record<string, unknown>>;
-};
-
-export async function bundleDocument(opts: {
-  document: Document;
-  config: StyleguideConfig;
-  customTypes?: Record<string, NodeType>;
-  externalRefResolver: BaseResolver;
-  dereference?: boolean;
-  skipRedoclyRegistryRefs?: boolean;
-  removeUnusedComponents?: boolean;
-  keepUrlRefs?: boolean;
-}): Promise<BundleResult> {
-  const {
-    document,
-    config,
-    customTypes,
-    externalRefResolver,
-    dereference = false,
-    skipRedoclyRegistryRefs = false,
-    removeUnusedComponents = false,
-    keepUrlRefs = false,
-  } = opts;
-  const oasVersion = detectOpenAPI(document.parsed);
-  const oasMajorVersion = openAPIMajor(oasVersion);
-  const rules = config.getRulesForOasVersion(oasMajorVersion);
-  const types = normalizeTypes(
-    config.extendTypes(
-      customTypes ?? oasMajorVersion === OasMajorVersion.Version3
-        ? oasVersion === OasVersion.Version3_1
-          ? Oas3_1Types
-          : Oas3Types
-        : Oas2Types,
-      oasVersion
-    ),
-    config
-  );
-
-  const preprocessors = initRules(rules as any, config, 'preprocessors', oasVersion);
-  const decorators = initRules(rules as any, config, 'decorators', oasVersion);
-
-  const ctx: BundleContext = {
-    problems: [],
-    oasVersion: oasVersion,
-    refTypes: new Map<string, NormalizedNodeType>(),
-    visitorsData: {},
-  };
-
-  if (removeUnusedComponents) {
-    decorators.push({
-      severity: 'error',
-      ruleId: 'remove-unused-components',
-      visitor:
-        oasMajorVersion === OasMajorVersion.Version2
-          ? RemoveUnusedComponentsOas2({})
-          : RemoveUnusedComponentsOas3({}),
-    });
-  }
-
-  const resolvedRefMap = await resolveDocument({
-    rootDocument: document,
-    rootType: types.Root,
-    externalRefResolver,
-  });
-
-  const bundleVisitor = normalizeVisitors(
-    [
-      ...preprocessors,
-      {
-        severity: 'error',
-        ruleId: 'bundler',
-        visitor: makeBundleVisitor(
-          oasMajorVersion,
-          dereference,
-          skipRedoclyRegistryRefs,
-          document,
-          resolvedRefMap,
-          keepUrlRefs
-        ),
-      },
-      ...decorators,
-    ] as any,
-    types
-  );
-
-  walkDocument({
-    document,
-    rootType: types.Root as NormalizedNodeType,
-    normalizedVisitors: bundleVisitor,
-    resolvedRefMap,
-    ctx,
-  });
-
-  return {
-    bundle: document,
-    problems: ctx.problems.map((problem) => config.addProblemToIgnore(problem)),
-    fileDependencies: externalRefResolver.getFiles(),
-    rootType: types.Root,
-    refTypes: ctx.refTypes,
-    visitorsData: ctx.visitorsData,
-  };
-}
-
-export function mapTypeToComponent(typeName: string, version: OasMajorVersion) {
-  switch (version) {
-    case OasMajorVersion.Version3:
-      switch (typeName) {
-        case 'Schema':
-          return 'schemas';
-        case 'Parameter':
-          return 'parameters';
-        case 'Response':
-          return 'responses';
-        case 'Example':
-          return 'examples';
-        case 'RequestBody':
-          return 'requestBodies';
-        case 'Header':
-          return 'headers';
-        case 'SecuritySchema':
-          return 'securitySchemes';
-        case 'Link':
-          return 'links';
-        case 'Callback':
-          return 'callbacks';
-        default:
-          return null;
-      }
-    case OasMajorVersion.Version2:
-      switch (typeName) {
-        case 'Schema':
-          return 'definitions';
-        case 'Parameter':
-          return 'parameters';
-        case 'Response':
-          return 'responses';
-        default:
-          return null;
-      }
-  }
-}
-
-// function oas3Move
-
-function makeBundleVisitor(
-  version: OasMajorVersion,
-  dereference: boolean,
-  skipRedoclyRegistryRefs: boolean,
-  rootDocument: Document,
-  resolvedRefMap: ResolvedRefMap,
-  keepUrlRefs: boolean
-) {
-  let components: Record<string, Record<string, any>>;
-
-  const visitor: Oas3Visitor | Oas2Visitor = {
-    ref: {
-      leave(node, ctx, resolved) {
-        if (!resolved.location || resolved.node === undefined) {
-          reportUnresolvedRef(resolved, ctx.report, ctx.location);
-          return;
-        }
-        if (
-          resolved.location.source === rootDocument.source &&
-          resolved.location.source === ctx.location.source &&
-          ctx.type.name !== 'scalar' &&
-          !dereference
-        ) {
-          return;
-        }
-
-        // do not bundle registry URL before push, otherwise we can't record dependencies
-        if (skipRedoclyRegistryRefs && isRedoclyRegistryURL(node.$ref)) {
-          return;
-        }
-
-        if (keepUrlRefs && isAbsoluteUrl(node.$ref)) {
-          return;
-        }
-
-        const componentType = mapTypeToComponent(ctx.type.name, version);
-        if (!componentType) {
-          replaceRef(node, resolved, ctx);
-        } else {
-          if (dereference) {
-            saveComponent(componentType, resolved, ctx);
-            replaceRef(node, resolved, ctx);
-          } else {
-            node.$ref = saveComponent(componentType, resolved, ctx);
-            resolveBundledComponent(node, resolved, ctx);
-          }
-        }
-      },
-    },
-    Root: {
-      enter(root: any) {
-        if (version === OasMajorVersion.Version3) {
-          components = root.components = root.components || {};
-        } else if (version === OasMajorVersion.Version2) {
-          components = root;
-        }
-      },
-    },
-  };
-
-  if (version === OasMajorVersion.Version3) {
-    visitor.DiscriminatorMapping = {
-      leave(mapping: Record<string, string>, ctx: any) {
-        for (const name of Object.keys(mapping)) {
-          const $ref = mapping[name];
-          const resolved = ctx.resolve({ $ref });
-          if (!resolved.location || resolved.node === undefined) {
-            reportUnresolvedRef(resolved, ctx.report, ctx.location.child(name));
-            return;
-          }
-
-          const componentType = mapTypeToComponent('Schema', version)!;
-          if (dereference) {
-            saveComponent(componentType, resolved, ctx);
-          } else {
-            mapping[name] = saveComponent(componentType, resolved, ctx);
-          }
-        }
-      },
-    };
-  }
-
-  function resolveBundledComponent(node: OasRef, resolved: ResolveResult<any>, ctx: UserContext) {
-    const newRefId = makeRefId(ctx.location.source.absoluteRef, node.$ref);
-    resolvedRefMap.set(newRefId, {
-      document: rootDocument,
-      isRemote: false,
-      node: resolved.node,
-      nodePointer: node.$ref,
-      resolved: true,
-    });
-  }
-
-  function replaceRef(ref: OasRef, resolved: ResolveResult<any>, ctx: UserContext) {
-    if (!isPlainObject(resolved.node)) {
-      ctx.parent[ctx.key] = resolved.node;
-    } else {
-      // TODO: why $ref isn't optional in OasRef?
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      delete ref.$ref;
-      const obj = Object.assign({}, resolved.node, ref);
-      Object.assign(ref, obj); // assign ref itself again so ref fields take precedence
-    }
-  }
-
-  function saveComponent(
-    componentType: string,
-    target: { node: any; location: Location },
-    ctx: UserContext
-  ) {
-    components[componentType] = components[componentType] || {};
-    const name = getComponentName(target, componentType, ctx);
-    components[componentType][name] = target.node;
-    if (version === OasMajorVersion.Version3) {
-      return `#/components/${componentType}/${name}`;
-    } else {
-      return `#/${componentType}/${name}`;
-    }
-  }
-
-  function isEqualOrEqualRef(
-    node: any,
-    target: { node: any; location: Location },
-    ctx: UserContext
-  ) {
-    if (
-      isRef(node) &&
-      ctx.resolve(node).location?.absolutePointer === target.location.absolutePointer
-    ) {
-      return true;
-    }
-
-    return isEqual(node, target.node);
-  }
-
-  function getComponentName(
-    target: { node: any; location: Location },
-    componentType: string,
-    ctx: UserContext
-  ) {
-    const [fileRef, pointer] = [target.location.source.absoluteRef, target.location.pointer];
-    const componentsGroup = components[componentType];
-
-    let name = '';
-
-    const refParts = pointer.slice(2).split('/').filter(isTruthy); // slice(2) removes "#/"
-    while (refParts.length > 0) {
-      name = refParts.pop() + (name ? `-${name}` : '');
-      if (
-        !componentsGroup ||
-        !componentsGroup[name] ||
-        isEqualOrEqualRef(componentsGroup[name], target, ctx)
-      ) {
-        return name;
-      }
-    }
-
-    name = refBaseName(fileRef) + (name ? `_${name}` : '');
-    if (!componentsGroup[name] || isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
-      return name;
-    }
-
-    const prevName = name;
-    let serialId = 2;
-    while (componentsGroup[name] && !isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
-      name = `${prevName}-${serialId}`;
-      serialId++;
-    }
-
-    if (!componentsGroup[name]) {
-      ctx.report({
-        message: `Two schemas are referenced with the same name but different content. Renamed ${prevName} to ${name}.`,
-        location: ctx.location,
-        forceSeverity: 'warn',
-      });
-    }
-
-    return name;
-  }
-
-  return visitor;
-}

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -1,161 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`resolveConfig should ignore minimal from the root and read local file 1`] = `
-Object {
-  "decorators": Object {},
-  "doNotResolveExamples": undefined,
-  "oas2Decorators": Object {},
-  "oas2Preprocessors": Object {},
-  "oas2Rules": Object {},
-  "oas3_0Decorators": Object {},
-  "oas3_0Preprocessors": Object {},
-  "oas3_0Rules": Object {
-    "no-empty-servers": "error",
-    "no-example-value-and-externalValue": "error",
-    "no-invalid-media-type-examples": "error",
-    "no-server-example.com": "warn",
-    "no-server-trailing-slash": "error",
-    "no-server-variables-empty-enum": "error",
-    "no-undefined-server-variable": "error",
-    "no-unused-components": "warn",
-    "spec-components-invalid-map-name": "error",
-  },
-  "oas3_1Decorators": Object {},
-  "oas3_1Preprocessors": Object {},
-  "oas3_1Rules": Object {
-    "no-empty-servers": "error",
-    "no-example-value-and-externalValue": "error",
-    "no-invalid-media-type-examples": "error",
-    "no-server-example.com": "warn",
-    "no-server-trailing-slash": "error",
-    "no-server-variables-empty-enum": "error",
-    "no-undefined-server-variable": "error",
-    "no-unused-components": "warn",
-    "spec-components-invalid-map-name": "error",
-  },
-  "preprocessors": Object {},
-  "recommendedFallback": false,
-  "rules": Object {
-    "assertions": "warn",
-    "boolean-parameter-prefixes": "error",
-    "info-contact": "off",
-    "info-license": "warn",
-    "info-license-url": "warn",
-    "local/operation-id-not-test": "error",
-    "no-ambiguous-paths": "warn",
-    "no-enum-type-mismatch": "error",
-    "no-identical-paths": "error",
-    "no-invalid-media-type-examples": "error",
-    "no-path-trailing-slash": "error",
-    "no-unresolved-refs": "error",
-    "operation-2xx-response": "warn",
-    "operation-4xx-response": "error",
-    "operation-description": "error",
-    "operation-operationId": "warn",
-    "operation-operationId-unique": "error",
-    "operation-operationId-url-safe": "error",
-    "operation-parameters-unique": "error",
-    "operation-singular-tag": "off",
-    "operation-summary": "error",
-    "operation-tag-defined": "off",
-    "parameter-description": "off",
-    "path-declaration-must-exist": "error",
-    "path-http-verbs-order": "error",
-    "path-not-include-query": "error",
-    "path-parameters-defined": "error",
-    "paths-kebab-case": "off",
-    "security-defined": "error",
-    "spec": "error",
-    "tag-description": "warn",
-    "tags-alphabetical": "off",
-  },
-}
-`;
-
-exports[`resolveStyleguideConfig should resolve extends with local file config which contains path to nested config 1`] = `
-Object {
-  "decorators": Object {},
-  "doNotResolveExamples": undefined,
-  "oas2Decorators": Object {},
-  "oas2Preprocessors": Object {},
-  "oas2Rules": Object {},
-  "oas3_0Decorators": Object {},
-  "oas3_0Preprocessors": Object {},
-  "oas3_0Rules": Object {
-    "no-empty-servers": "error",
-    "no-example-value-and-externalValue": "error",
-    "no-invalid-media-type-examples": "warn",
-    "no-server-example.com": "warn",
-    "no-server-trailing-slash": "error",
-    "no-server-variables-empty-enum": "error",
-    "no-undefined-server-variable": "error",
-    "no-unused-components": "warn",
-    "spec-components-invalid-map-name": "error",
-  },
-  "oas3_1Decorators": Object {},
-  "oas3_1Preprocessors": Object {},
-  "oas3_1Rules": Object {
-    "no-empty-servers": "error",
-    "no-example-value-and-externalValue": "error",
-    "no-invalid-media-type-examples": "warn",
-    "no-server-example.com": "warn",
-    "no-server-trailing-slash": "error",
-    "no-server-variables-empty-enum": "error",
-    "no-undefined-server-variable": "error",
-    "no-unused-components": "warn",
-    "spec-components-invalid-map-name": "error",
-  },
-  "preprocessors": Object {},
-  "recommendedFallback": undefined,
-  "rules": Object {
-    "assertions": Array [
-      Object {
-        "assertionId": "path-item-get-defined",
-        "defined": true,
-        "message": "Every path item must have a GET operation.",
-        "property": "get",
-        "subject": "PathItem",
-      },
-      Object {
-        "assertionId": "tag-description",
-        "message": "Tag description must be at least 13 characters and end with a full stop.",
-        "minLength": 13,
-        "pattern": "/\\\\.$/",
-        "property": "description",
-        "severity": "error",
-        "subject": "Tag",
-      },
-    ],
-    "boolean-parameter-prefixes": "error",
-    "info-contact": "off",
-    "info-license": "warn",
-    "info-license-url": "warn",
-    "local/operation-id-not-test": "error",
-    "no-ambiguous-paths": "warn",
-    "no-enum-type-mismatch": "error",
-    "no-identical-paths": "error",
-    "no-invalid-media-type-examples": "warn",
-    "no-path-trailing-slash": "error",
-    "no-unresolved-refs": "error",
-    "operation-2xx-response": "error",
-    "operation-4xx-response": "off",
-    "operation-description": "off",
-    "operation-operationId": "warn",
-    "operation-operationId-unique": "error",
-    "operation-operationId-url-safe": "error",
-    "operation-parameters-unique": "error",
-    "operation-singular-tag": "off",
-    "operation-summary": "error",
-    "operation-tag-defined": "off",
-    "parameter-description": "off",
-    "path-declaration-must-exist": "error",
-    "path-not-include-query": "error",
-    "path-parameters-defined": "error",
-    "paths-kebab-case": "off",
-    "security-defined": "error",
-    "spec": "error",
-    "tag-description": "warn",
-    "tags-alphabetical": "off",
-  },
-}
-`;

package/src/config/__tests__/__snapshots__/config.test.ts.snap

@@ -1,144 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`generation ignore object should generate config with absoluteUri for ignore 1`] = `
-StyleguideConfig {
-  "_usedRules": Set {},
-  "_usedVersions": Set {},
-  "configFile": undefined,
-  "decorators": Object {
-    "oas2": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas3_0": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas3_1": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-  },
-  "doNotResolveExamples": false,
-  "extendPaths": Array [],
-  "ignore": Object {
-    "https://some-path.yaml": Object {
-      "no-unused-components": Set {
-        "#/components/schemas/Foo",
-      },
-    },
-    "some-path/openapi.yaml": Object {
-      "no-unused-components": Set {
-        "#/components/schemas/Foo",
-      },
-    },
-  },
-  "pluginPaths": Array [],
-  "plugins": Array [],
-  "preprocessors": Object {
-    "oas2": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas3_0": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "oas3_1": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-  },
-  "rawConfig": Object {
-    "_usedRules": Set {},
-    "_usedVersions": Set {},
-    "configFile": "redocly.yaml",
-    "decorators": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "doNotResolveExamples": false,
-    "ignore": Object {},
-    "plugins": Array [],
-    "preprocessors": Object {
-      "oas2": Object {},
-      "oas3_0": Object {},
-      "oas3_1": Object {},
-    },
-    "rawConfig": Object {
-      "plugins": Array [],
-      "rules": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-    },
-    "recommendedFallback": false,
-    "rules": Object {
-      "oas2": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-      "oas3_0": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-      "oas3_1": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-    },
-  },
-  "recommendedFallback": false,
-  "rules": Object {
-    "oas2": Object {
-      "oas2": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-      "oas3_0": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-      "oas3_1": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-    },
-    "oas3_0": Object {
-      "oas2": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-      "oas3_0": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-      "oas3_1": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-    },
-    "oas3_1": Object {
-      "oas2": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-      "oas3_0": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-      "oas3_1": Object {
-        "no-empty-servers": "error",
-        "operation-summary": "error",
-      },
-    },
-  },
-}
-`;