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

package/src/decorators/oas3/__tests__/remove-unused-components.test.ts

@@ -1,313 +0,0 @@
-import { outdent } from 'outdent';
-import { parseYamlToDocument, makeConfig } from '../../../../__tests__/utils';
-import { bundleDocument } from '../../../bundle';
-import { BaseResolver } from '../../../resolve';
-
-describe('oas3 remove-unused-components', () => {
-  it('should remove unused components', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: "3.0.0"
-        paths:
-          /pets:
-            get:
-              summary: List all pets
-              operationId: listPets
-              parameters:
-                - $ref: '#/components/parameters/used'
-        components:
-          parameters:
-            used:
-              name: used
-            unused:
-              name: unused
-          responses:
-            unused: {}
-          examples:
-            unused: {}
-          requestBodies:
-            unused: {}
-          headers:
-            unused: {}
-          schemas:
-            Unused:
-              type: integer
-              enum:
-                - 1
-                - 2
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-      removeUnusedComponents: true,
-    });
-
-    expect(results.bundle.parsed).toEqual({
-      openapi: '3.0.0',
-      paths: {
-        '/pets': {
-          get: {
-            summary: 'List all pets',
-            operationId: 'listPets',
-            parameters: [
-              {
-                $ref: '#/components/parameters/used',
-              },
-            ],
-          },
-        },
-      },
-      components: {
-        parameters: {
-          used: {
-            name: 'used',
-          },
-        },
-      },
-    });
-  });
-
-  it('should not remove components used child reference', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: "3.0.0"
-        paths:
-          /pets:
-            get:
-              summary: List all pets
-              operationId: listPets
-              responses:
-                '200':
-                  content:
-                    application/json:
-                      schema:
-                        $ref: '#/components/schemas/Used'
-        components:
-          parameters:
-            unused:
-              name: unused
-          responses:
-            unused: {}
-          examples:
-            unused: {}
-          requestBodies:
-            unused: {}
-          headers:
-            unused: {}
-          schemas:
-            InnerUsed:
-              type: object
-              properties:
-                link:
-                  type: string
-            Used:
-              type: object
-              properties:
-                link:
-                  $ref: '#/components/schemas/InnerUsed/properties/link'
-            Unused:
-              type: integer
-              enum:
-                - 1
-                - 2
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-      removeUnusedComponents: true,
-    });
-
-    expect(results.bundle.parsed).toEqual({
-      openapi: '3.0.0',
-      paths: {
-        '/pets': {
-          get: {
-            summary: 'List all pets',
-            operationId: 'listPets',
-            responses: {
-              '200': {
-                content: {
-                  'application/json': {
-                    schema: {
-                      $ref: '#/components/schemas/Used',
-                    },
-                  },
-                },
-              },
-            },
-          },
-        },
-      },
-      components: {
-        schemas: {
-          InnerUsed: {
-            type: 'object',
-            properties: {
-              link: {
-                type: 'string',
-              },
-            },
-          },
-          Used: {
-            type: 'object',
-            properties: {
-              link: {
-                $ref: '#/components/schemas/InnerUsed/properties/link',
-              },
-            },
-          },
-        },
-      },
-    });
-  });
-
-  it('should remove transitively unused components', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: "3.0.0"
-        paths:
-          /pets:
-            get:
-              summary: List all pets
-              operationId: listPets
-              parameters:
-                - $ref: '#/components/parameters/used'
-        components:
-          parameters:
-            used:
-              name: used
-            unused:
-              name: unused
-          schemas:
-            Unused:
-              type: integer
-              enum:
-                - 1
-                - 2
-            Transitive:
-              type: object
-              properties:
-                link:
-                  $ref: '#/components/schemas/Unused'
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-      removeUnusedComponents: true,
-    });
-
-    expect(results.bundle.parsed).toEqual({
-      openapi: '3.0.0',
-      paths: {
-        '/pets': {
-          get: {
-            summary: 'List all pets',
-            operationId: 'listPets',
-            parameters: [
-              {
-                $ref: '#/components/parameters/used',
-              },
-            ],
-          },
-        },
-      },
-      components: {
-        parameters: {
-          used: {
-            name: 'used',
-          },
-        },
-      },
-    });
-  });
-
-  it('should remove transitively unused components with colliding paths', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        openapi: "3.0.0"
-        paths:
-          /pets:
-            get:
-              responses: 
-                200:
-                  content: 
-                    application/json: 
-                      schema: 
-                        $ref: "#/components/schemas/Transitive2"
-        components:
-          schemas:
-            Unused: # <-- this will be removed correctly
-              type: integer
-            Transitive: # <-- this will be removed correctly
-              type: object
-              properties:
-                link:
-                  $ref: '#/components/schemas/Unused'
-            Used:
-              type: integer
-            Transitive2:
-              type: object
-              properties:
-                link:
-                  $ref: '#/components/schemas/Used'
-        `,
-
-      'foobar.yaml'
-    );
-
-    const results = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-      removeUnusedComponents: true,
-    });
-
-    expect(results.bundle.parsed).toEqual({
-      openapi: '3.0.0',
-      paths: {
-        '/pets': {
-          get: {
-            responses: {
-              200: {
-                content: {
-                  'application/json': {
-                    schema: {
-                      $ref: '#/components/schemas/Transitive2',
-                    },
-                  },
-                },
-              },
-            },
-          },
-        },
-      },
-      components: {
-        schemas: {
-          Transitive2: {
-            type: 'object',
-            properties: {
-              link: {
-                $ref: '#/components/schemas/Used',
-              },
-            },
-          },
-          Used: {
-            type: 'integer',
-          },
-        },
-      },
-    });
-  });
-});

package/src/decorators/oas3/index.ts

@@ -1,23 +0,0 @@
-import { RegistryDependencies } from '../common/registry-dependencies';
-import { OperationDescriptionOverride } from '../common/operation-description-override';
-import { TagDescriptionOverride } from '../common/tag-description-override';
-import { InfoDescriptionOverride } from '../common/info-description-override';
-import { InfoOverride } from '../common/info-override';
-import { RemoveXInternal } from '../common/remove-x-internal';
-import { FilterIn } from '../common/filters/filter-in';
-import { FilterOut } from '../common/filters/filter-out';
-import { MediaTypeExamplesOverride } from '../common/media-type-examples-override';
-
-import type { Oas3Decorator } from '../../visitors';
-
-export const decorators = {
-  'registry-dependencies': RegistryDependencies as Oas3Decorator,
-  'operation-description-override': OperationDescriptionOverride as Oas3Decorator,
-  'tag-description-override': TagDescriptionOverride as Oas3Decorator,
-  'info-description-override': InfoDescriptionOverride as Oas3Decorator,
-  'info-override': InfoOverride as Oas3Decorator,
-  'remove-x-internal': RemoveXInternal as Oas3Decorator,
-  'filter-in': FilterIn as Oas3Decorator,
-  'filter-out': FilterOut as Oas3Decorator,
-  'media-type-examples-override': MediaTypeExamplesOverride as Oas3Decorator,
-};

package/src/decorators/oas3/remove-unused-components.ts

@@ -1,138 +0,0 @@
-import { isEmptyObject } from '../../utils';
-
-import type { Location } from '../../ref-utils';
-import type { Oas3Decorator } from '../../visitors';
-import type {
-  Oas3Definition,
-  Oas3_1Definition,
-  Oas3Components,
-  Oas3_1Components,
-} from '../../typings/openapi';
-
-export const RemoveUnusedComponents: Oas3Decorator = () => {
-  const components = new Map<
-    string,
-    {
-      usedIn: Location[];
-      componentType?: keyof (Oas3Components | Oas3_1Components);
-      name: string;
-    }
-  >();
-
-  function registerComponent(
-    location: Location,
-    componentType: keyof (Oas3Components | Oas3_1Components),
-    name: string
-  ): void {
-    components.set(location.absolutePointer, {
-      usedIn: components.get(location.absolutePointer)?.usedIn ?? [],
-      componentType,
-      name,
-    });
-  }
-
-  function removeUnusedComponents(
-    root: Oas3Definition | Oas3_1Definition,
-    removedPaths: string[]
-  ): number {
-    const removedLengthStart = removedPaths.length;
-
-    for (const [path, { usedIn, name, componentType }] of components) {
-      const used = usedIn.some(
-        (location) =>
-          !removedPaths.some(
-            (removed) =>
-              location.absolutePointer.startsWith(removed) &&
-              (location.absolutePointer.length === removed.length ||
-                location.absolutePointer[removed.length] === '/')
-          )
-      );
-
-      if (!used && componentType && root.components) {
-        removedPaths.push(path);
-        const componentChild = root.components[componentType];
-        delete componentChild![name];
-        components.delete(path);
-        if (isEmptyObject(componentChild)) {
-          delete root.components[componentType];
-        }
-      }
-    }
-
-    return removedPaths.length > removedLengthStart
-      ? removeUnusedComponents(root, removedPaths)
-      : removedPaths.length;
-  }
-
-  return {
-    ref: {
-      leave(ref, { location, type, resolve, key }) {
-        if (
-          ['Schema', 'Header', 'Parameter', 'Response', 'Example', 'RequestBody'].includes(
-            type.name
-          )
-        ) {
-          const resolvedRef = resolve(ref);
-          if (!resolvedRef.location) return;
-
-          const [fileLocation, localPointer] = resolvedRef.location.absolutePointer.split('#', 2);
-          const componentLevelLocalPointer = localPointer.split('/').slice(0, 4).join('/');
-          const pointer = `${fileLocation}#${componentLevelLocalPointer}`;
-
-          const registered = components.get(pointer);
-
-          if (registered) {
-            registered.usedIn.push(location);
-          } else {
-            components.set(pointer, {
-              usedIn: [location],
-              name: key.toString(),
-            });
-          }
-        }
-      },
-    },
-    Root: {
-      leave(root, ctx) {
-        const data = ctx.getVisitorData() as { removedCount: number };
-        data.removedCount = removeUnusedComponents(root, []);
-
-        if (isEmptyObject(root.components)) {
-          delete root.components;
-        }
-      },
-    },
-    NamedSchemas: {
-      Schema(schema, { location, key }) {
-        if (!schema.allOf) {
-          registerComponent(location, 'schemas', key.toString());
-        }
-      },
-    },
-    NamedParameters: {
-      Parameter(_parameter, { location, key }) {
-        registerComponent(location, 'parameters', key.toString());
-      },
-    },
-    NamedResponses: {
-      Response(_response, { location, key }) {
-        registerComponent(location, 'responses', key.toString());
-      },
-    },
-    NamedExamples: {
-      Example(_example, { location, key }) {
-        registerComponent(location, 'examples', key.toString());
-      },
-    },
-    NamedRequestBodies: {
-      RequestBody(_requestBody, { location, key }) {
-        registerComponent(location, 'requestBodies', key.toString());
-      },
-    },
-    NamedHeaders: {
-      Header(_header, { location, key }) {
-        registerComponent(location, 'headers', key.toString());
-      },
-    },
-  };
-};

package/src/decorators/overlay1/index.ts

@@ -1 +0,0 @@
-export const decorators = {};

package/src/env.ts

@@ -1,5 +0,0 @@
-export const isBrowser =
-  typeof window !== 'undefined' ||
-  typeof process === 'undefined' ||
-  (process?.platform as any) === 'browser'; // main and worker thread
-export const env = isBrowser ? {} : process.env || {};

package/src/format/codeframes.ts

@@ -1,217 +0,0 @@
-import * as yamlAst from 'yaml-ast-parser';
-import { unescapePointer } from '../ref-utils';
-import { colorize, colorOptions } from '../logger';
-
-import type { LineColLocationObject, Loc, LocationObject } from '../walk';
-
-type YAMLMapping = yamlAst.YAMLMapping & { kind: yamlAst.Kind.MAPPING };
-type YAMLMap = yamlAst.YamlMap & { kind: yamlAst.Kind.MAP };
-type YAMLAnchorReference = yamlAst.YAMLAnchorReference & { kind: yamlAst.Kind.ANCHOR_REF };
-type YAMLSequence = yamlAst.YAMLSequence & { kind: yamlAst.Kind.SEQ };
-type YAMLScalar = yamlAst.YAMLScalar & { kind: yamlAst.Kind.SCALAR };
-type YAMLNode = YAMLMapping | YAMLMap | YAMLAnchorReference | YAMLSequence | YAMLScalar;
-
-const MAX_LINE_LENGTH = 150;
-const MAX_CODEFRAME_LINES = 3;
-
-// TODO: temporary
-function parsePointer(pointer: string) {
-  return pointer.substr(2).split('/').map(unescapePointer);
-}
-
-export function getCodeframe(location: LineColLocationObject, color: boolean) {
-  colorOptions.enabled = color;
-  const { start, end = { line: start.line, col: start.col + 1 }, source } = location;
-  const lines = source.getLines();
-  const startLineNum = start.line;
-  const endLineNum = Math.max(Math.min(end.line, lines.length), start.line);
-  let skipLines = Math.max(endLineNum - startLineNum - MAX_CODEFRAME_LINES + 1, 0);
-  if (skipLines < 2) skipLines = 0; // do not skip one line
-
-  // Lines specified like this: ["prefix", "string"],
-  const prefixedLines: [string, string][] = [];
-
-  let currentPad = 0;
-
-  for (let i = startLineNum; i <= endLineNum; i++) {
-    if (skipLines > 0 && i >= endLineNum - skipLines) break;
-    const line = lines[i - 1] || '';
-    if (line !== '') currentPad = padSize(line);
-    const startIdx = i === startLineNum ? start.col - 1 : currentPad;
-    const endIdx = i === endLineNum ? end.col - 1 : line.length;
-
-    prefixedLines.push([`${i}`, markLine(line, startIdx, endIdx, colorize.red)]);
-    if (!color) prefixedLines.push(['', underlineLine(line, startIdx, endIdx)]);
-  }
-
-  if (skipLines > 0) {
-    prefixedLines.push([
-      `…`,
-      `${whitespace(currentPad)}${colorize.gray(`< ${skipLines} more lines >`)}`,
-    ]);
-    // print last line
-    prefixedLines.push([
-      `${endLineNum}`,
-      markLine(lines[endLineNum - 1], -1, end.col - 1, colorize.red),
-    ]);
-
-    if (!color) prefixedLines.push(['', underlineLine(lines[endLineNum - 1], -1, end.col - 1)]);
-  }
-
-  return printPrefixedLines([
-    [`${startLineNum - 2}`, markLine(lines[startLineNum - 1 - 2])],
-    [`${startLineNum - 1}`, markLine(lines[startLineNum - 1 - 1])],
-    ...prefixedLines,
-    [`${endLineNum + 1}`, markLine(lines[endLineNum - 1 + 1])],
-    [`${endLineNum + 2}`, markLine(lines[endLineNum - 1 + 2])],
-  ]);
-
-  function markLine(
-    line: string,
-    startIdx: number = -1,
-    endIdx: number = +Infinity,
-    variant = colorize.gray
-  ) {
-    if (!color) return line;
-    if (!line) return line;
-
-    if (startIdx === -1) {
-      startIdx = padSize(line);
-    }
-
-    endIdx = Math.min(endIdx, line.length);
-    return (
-      line.substr(0, startIdx) + variant(line.substring(startIdx, endIdx)) + line.substr(endIdx)
-    );
-  }
-}
-
-function printPrefixedLines(lines: [string, string][]): string {
-  const existingLines = lines.filter(([_, line]) => line !== undefined);
-
-  const padLen = Math.max(...existingLines.map(([prefix]) => prefix.length));
-  const dedentLen = Math.min(
-    ...existingLines.map(([_, line]) => (line === '' ? Infinity : padSize(line)))
-  );
-
-  return existingLines
-    .map(
-      ([prefix, line]) =>
-        colorize.gray(leftPad(padLen, prefix) + ' |') +
-        (line ? ' ' + limitLineLength(line.substring(dedentLen)) : '')
-    )
-    .join('\n');
-}
-
-function limitLineLength(line: string, maxLen: number = MAX_LINE_LENGTH) {
-  const overflowLen = line.length - maxLen;
-  if (overflowLen > 0) {
-    const charsMoreText = colorize.gray(`...<${overflowLen} chars>`);
-    return line.substring(0, maxLen - charsMoreText.length) + charsMoreText;
-  } else {
-    return line;
-  }
-}
-
-function underlineLine(line: string, startIdx: number = -1, endIdx: number = +Infinity) {
-  if (startIdx === -1) {
-    startIdx = padSize(line);
-  }
-
-  endIdx = Math.min(endIdx, line.length);
-  return whitespace(startIdx) + '^'.repeat(Math.max(endIdx - startIdx, 1));
-}
-
-function whitespace(len: number): string {
-  return ' '.repeat(len);
-}
-
-function leftPad(len: number, str: string): string {
-  return whitespace(len - str.length) + str;
-}
-
-function padSize(line: string): number {
-  for (let i = 0; i < line.length; i++) {
-    if (line[i] !== ' ') return i;
-  }
-  return line.length;
-}
-
-export function getLineColLocation(location: LocationObject): LineColLocationObject {
-  if (location.pointer === undefined) return location;
-
-  const { source, pointer, reportOnKey } = location;
-  const ast = source.getAst(yamlAst.safeLoad) as YAMLNode;
-  const astNode = getAstNodeByPointer(ast, pointer, !!reportOnKey);
-  return {
-    ...location,
-    pointer: undefined,
-    ...positionsToLoc(source.body, astNode?.startPosition ?? 1, astNode?.endPosition ?? 1),
-  };
-}
-
-function positionsToLoc(
-  source: string,
-  startPos: number,
-  endPos: number
-): { start: Loc; end: Loc } {
-  let currentLine = 1;
-  let currentCol = 1;
-  let start: Loc = { line: 1, col: 1 };
-
-  for (let i = 0; i < endPos - 1; i++) {
-    if (i === startPos - 1) {
-      start = { line: currentLine, col: currentCol + 1 };
-    }
-    if (source[i] === '\n') {
-      currentLine++;
-      currentCol = 1;
-      if (i === startPos - 1) {
-        start = { line: currentLine, col: currentCol };
-      }
-
-      if (source[i + 1] === '\r') i++; // TODO: test it
-      continue;
-    }
-    currentCol++;
-  }
-
-  const end = startPos === endPos ? { ...start } : { line: currentLine, col: currentCol + 1 };
-  return { start, end };
-}
-
-export function getAstNodeByPointer(root: YAMLNode, pointer: string, reportOnKey: boolean) {
-  const pointerSegments = parsePointer(pointer);
-  if (root === undefined) {
-    return undefined;
-  }
-
-  let currentNode = root;
-  for (const key of pointerSegments) {
-    if (currentNode.kind === yamlAst.Kind.MAP) {
-      const mapping = currentNode.mappings.find((m) => m.key.value === key);
-      if (!mapping) break;
-      currentNode = mapping as YAMLNode;
-      if (!mapping?.value) break; // If node has value - return value, if not - return node itself
-      currentNode = mapping.value as YAMLNode;
-    } else if (currentNode.kind === yamlAst.Kind.SEQ) {
-      const elem = currentNode.items[parseInt(key, 10)] as YAMLNode;
-      if (!elem) break;
-      currentNode = elem as YAMLNode;
-    }
-  }
-
-  if (!reportOnKey) {
-    return currentNode;
-  } else {
-    const parent = currentNode.parent as YAMLNode;
-    if (!parent) return currentNode;
-    if (parent.kind === yamlAst.Kind.SEQ) {
-      return currentNode;
-    } else if (parent.kind === yamlAst.Kind.MAPPING) {
-      return parent.key;
-    } else {
-      return currentNode;
-    }
-  }
-}