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

package/src/decorators/common/registry-dependencies.ts

@@ -1,25 +0,0 @@
-import { isRedoclyRegistryURL } from '../../redocly/domains';
-
-import type { UserContext } from '../../walk';
-import type { Oas3Decorator, Oas2Decorator } from '../../visitors';
-
-export const RegistryDependencies: Oas3Decorator | Oas2Decorator = () => {
-  const registryDependencies = new Set<string>();
-
-  return {
-    Root: {
-      leave(_: any, ctx: UserContext) {
-        const data = ctx.getVisitorData();
-        data.links = Array.from(registryDependencies);
-      },
-    },
-    ref(node) {
-      if (node.$ref) {
-        const link = node.$ref.split('#/')[0];
-        if (isRedoclyRegistryURL(link)) {
-          registryDependencies.add(link);
-        }
-      }
-    },
-  };
-};

package/src/decorators/common/remove-x-internal.ts

@@ -1,77 +0,0 @@
-import { isEmptyArray, isEmptyObject, isPlainObject } from '../../utils';
-import { isRef } from '../../ref-utils';
-
-import type { Oas3Decorator, Oas2Decorator } from '../../visitors';
-import type { UserContext } from '../../walk';
-
-const DEFAULT_INTERNAL_PROPERTY_NAME = 'x-internal';
-
-export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({
-  internalFlagProperty = DEFAULT_INTERNAL_PROPERTY_NAME,
-}) => {
-  function removeInternal(
-    node: unknown,
-    ctx: UserContext,
-    originalMapping: Record<string, string>
-  ) {
-    const { parent, key } = ctx;
-    let didDelete = false;
-    if (Array.isArray(node)) {
-      for (let i = 0; i < node.length; i++) {
-        if (isRef(node[i])) {
-          const resolved = ctx.resolve(node[i]);
-          if (resolved.node?.[internalFlagProperty]) {
-            // First, remove the reference in the discriminator mapping, if it exists:
-            if (isPlainObject(parent.discriminator?.mapping)) {
-              for (const mapping in parent.discriminator.mapping) {
-                if (originalMapping?.[mapping] === node[i].$ref) {
-                  delete parent.discriminator.mapping[mapping];
-                }
-              }
-            }
-            node.splice(i, 1);
-            didDelete = true;
-            i--;
-          }
-        }
-        if (node[i]?.[internalFlagProperty]) {
-          node.splice(i, 1);
-          didDelete = true;
-          i--;
-        }
-      }
-    } else if (isPlainObject(node)) {
-      for (const key of Object.keys(node)) {
-        if (isRef(node[key])) {
-          const resolved = ctx.resolve(node[key]);
-          if (isPlainObject(resolved.node) && resolved.node?.[internalFlagProperty]) {
-            delete node[key];
-            didDelete = true;
-          }
-        }
-        if (isPlainObject(node[key]) && node[key]?.[internalFlagProperty]) {
-          delete node[key];
-          didDelete = true;
-        }
-      }
-    }
-
-    if (didDelete && (isEmptyObject(node) || isEmptyArray(node))) {
-      delete parent[key];
-    }
-  }
-
-  let originalMapping: Record<string, string> = {};
-  return {
-    DiscriminatorMapping: {
-      enter: (mapping: Record<string, string>) => {
-        originalMapping = JSON.parse(JSON.stringify(mapping));
-      },
-    },
-    any: {
-      enter: (node, ctx) => {
-        removeInternal(node, ctx, originalMapping);
-      },
-    },
-  };
-};

package/src/decorators/common/tag-description-override.ts

@@ -1,26 +0,0 @@
-import { readFileAsStringSync } from '../../utils';
-
-import type { Oas3Decorator, Oas2Decorator } from '../../visitors';
-import type { UserContext } from '../../walk';
-
-export const TagDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ tagNames }) => {
-  return {
-    Tag: {
-      leave(tag, { report }: UserContext) {
-        if (!tagNames)
-          throw new Error(
-            `Parameter "tagNames" is not provided for "tag-description-override" rule`
-          );
-        if (tagNames[tag.name]) {
-          try {
-            tag.description = readFileAsStringSync(tagNames[tag.name]);
-          } catch (e) {
-            report({
-              message: `Failed to read markdown override file for tag "${tag.name}".\n${e.message}`,
-            });
-          }
-        }
-      },
-    },
-  };
-};

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

@@ -1,228 +0,0 @@
-import { outdent } from 'outdent';
-import { parseYamlToDocument, makeConfig } from '../../../../__tests__/utils';
-import { bundleDocument } from '../../../bundle';
-import { BaseResolver } from '../../../resolve';
-
-describe('oas2 remove-unused-components', () => {
-  it('should remove unused components', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        swagger: '2.0'
-        paths:
-          /pets:
-            get:
-              produces:
-                - application/json
-              parameters: []
-              responses:
-                '200':
-                  schema:
-                    $ref: '#/definitions/Used'
-              operationId: listPets
-              summary: List all pets
-        definitions:
-          Unused:
-            enum:
-              - 1
-              - 2
-            type: integer
-          Used:
-            properties:
-              link:
-                type: string
-            type: object
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-      removeUnusedComponents: true,
-    });
-
-    expect(results.bundle.parsed).toEqual({
-      swagger: '2.0',
-      definitions: {
-        Used: {
-          properties: {
-            link: { type: 'string' },
-          },
-          type: 'object',
-        },
-      },
-      paths: {
-        '/pets': {
-          get: {
-            produces: ['application/json'],
-            parameters: [],
-            summary: 'List all pets',
-            operationId: 'listPets',
-            responses: {
-              '200': {
-                schema: {
-                  $ref: '#/definitions/Used',
-                },
-              },
-            },
-          },
-        },
-      },
-    });
-  });
-
-  it('should not remove components used child reference', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        swagger: '2.0'
-        paths:
-          /pets:
-            get:
-              produces:
-                - application/json
-              parameters: []
-              responses:
-                '200':
-                  schema:
-                    $ref: '#/definitions/Used'
-              operationId: listPets
-              summary: List all pets
-        definitions:
-          InnerUsed:
-            properties:
-              link:
-                type: string
-            type: object
-          Unused:
-            enum:
-              - 1
-              - 2
-            type: integer
-          Used:
-            properties:
-              link:
-                $ref: '#/definitions/InnerUsed/properties/link'
-            type: object
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-      removeUnusedComponents: true,
-    });
-
-    expect(results.bundle.parsed).toEqual({
-      swagger: '2.0',
-      definitions: {
-        InnerUsed: {
-          properties: {
-            link: {
-              type: 'string',
-            },
-          },
-          type: 'object',
-        },
-        Used: {
-          properties: {
-            link: { $ref: '#/definitions/InnerUsed/properties/link' },
-          },
-          type: 'object',
-        },
-      },
-      paths: {
-        '/pets': {
-          get: {
-            produces: ['application/json'],
-            parameters: [],
-            summary: 'List all pets',
-            operationId: 'listPets',
-            responses: {
-              '200': {
-                schema: {
-                  $ref: '#/definitions/Used',
-                },
-              },
-            },
-          },
-        },
-      },
-    });
-  });
-
-  it('should remove transitively unused components', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        swagger: '2.0'
-        paths:
-          /pets:
-            get:
-              produces:
-                - application/json
-              parameters: []
-              responses:
-                '200':
-                  schema:
-                    $ref: '#/definitions/Used'
-              operationId: listPets
-              summary: List all pets
-        definitions:
-          Unused:
-            enum:
-              - 1
-              - 2
-            type: integer
-          UnusedTransitive:
-            type: object
-            properties:
-              link:
-                $ref: '#/definitions/Unused'
-          Used:
-            properties:
-              link:
-                type: string
-            type: object
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ rules: {} }),
-      removeUnusedComponents: true,
-    });
-
-    expect(results.bundle.parsed).toEqual({
-      swagger: '2.0',
-      definitions: {
-        Used: {
-          properties: {
-            link: { type: 'string' },
-          },
-          type: 'object',
-        },
-      },
-      paths: {
-        '/pets': {
-          get: {
-            produces: ['application/json'],
-            parameters: [],
-            summary: 'List all pets',
-            operationId: 'listPets',
-            responses: {
-              '200': {
-                schema: {
-                  $ref: '#/definitions/Used',
-                },
-              },
-            },
-          },
-        },
-      },
-    });
-  });
-});

package/src/decorators/oas2/index.ts

@@ -1,21 +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 type { Oas2Decorator } from '../../visitors';
-
-export const decorators = {
-  'registry-dependencies': RegistryDependencies as Oas2Decorator,
-  'operation-description-override': OperationDescriptionOverride as Oas2Decorator,
-  'tag-description-override': TagDescriptionOverride as Oas2Decorator,
-  'info-description-override': InfoDescriptionOverride as Oas2Decorator,
-  'info-override': InfoOverride as Oas2Decorator,
-  'remove-x-internal': RemoveXInternal as Oas2Decorator,
-  'filter-in': FilterIn as Oas2Decorator,
-  'filter-out': FilterOut as Oas2Decorator,
-};

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

@@ -1,109 +0,0 @@
-import { isEmptyObject } from '../../utils';
-
-import type { Location } from '../../ref-utils';
-import type { Oas2Decorator } from '../../visitors';
-import type { Oas2Components, Oas2Definition } from '../../typings/swagger';
-
-export const RemoveUnusedComponents: Oas2Decorator = () => {
-  const components = new Map<
-    string,
-    { usedIn: Location[]; componentType?: keyof Oas2Components; name: string }
-  >();
-
-  function registerComponent(
-    location: Location,
-    componentType: keyof Oas2Components,
-    name: string
-  ): void {
-    components.set(location.absolutePointer, {
-      usedIn: components.get(location.absolutePointer)?.usedIn ?? [],
-      componentType,
-      name,
-    });
-  }
-
-  function removeUnusedComponents(root: Oas2Definition, removedPaths: string[]): number {
-    const removedLengthStart = removedPaths.length;
-
-    for (const [path, { usedIn, name, componentType }] of components) {
-      const used = usedIn.some(
-        (location) =>
-          !removedPaths.some(
-            (removed) =>
-              // Check if the current location's absolute pointer starts with the 'removed' path
-              // and either its length matches exactly with 'removed' or the character after the 'removed' path is a '/'
-              location.absolutePointer.startsWith(removed) &&
-              (location.absolutePointer.length === removed.length ||
-                location.absolutePointer[removed.length] === '/')
-          )
-      );
-      if (!used && componentType) {
-        removedPaths.push(path);
-        delete root[componentType]![name];
-        components.delete(path);
-
-        if (isEmptyObject(root[componentType])) {
-          delete root[componentType];
-        }
-      }
-    }
-
-    return removedPaths.length > removedLengthStart
-      ? removeUnusedComponents(root, removedPaths)
-      : removedPaths.length;
-  }
-
-  return {
-    ref: {
-      leave(ref, { location, type, resolve, key }) {
-        if (['Schema', 'Parameter', 'Response', 'SecurityScheme'].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, 3).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, []);
-      },
-    },
-    NamedSchemas: {
-      Schema(schema, { location, key }) {
-        if (!schema.allOf) {
-          registerComponent(location, 'definitions', key.toString());
-        }
-      },
-    },
-    NamedParameters: {
-      Parameter(_parameter, { location, key }) {
-        registerComponent(location, 'parameters', key.toString());
-      },
-    },
-    NamedResponses: {
-      Response(_response, { location, key }) {
-        registerComponent(location, 'responses', key.toString());
-      },
-    },
-    NamedSecuritySchemes: {
-      SecurityScheme(_securityScheme, { location, key }) {
-        registerComponent(location, 'securityDefinitions', key.toString());
-      },
-    },
-  };
-};