@redocly/openapi-core 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @redocly/openapi-core
 
+## 1.1.0
+
+### Minor Changes
+
+- Added `ignoreCase` option for `tags-alphabetical` rule.
+
+### Patch Changes
+
+- Fixed an issue where the `--remove-unused-components` option removed used components that were referenced as child objects.
+- Updated Redocly config validation.
+- Fixed the location pointer when reporting on the `no-path-trailing-slash` rule.
+
 ## 1.0.2
 
 ## 1.0.1

package/lib/bundle.d.ts

@@ -39,4 +39,4 @@ export declare function bundleDocument(opts: {
     removeUnusedComponents?: boolean;
     keepUrlRefs?: boolean;
 }): Promise<BundleResult>;
-export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;
+export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "parameters" | "examples" | "headers" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | "definitions" | null;

package/lib/format/codeframes.d.ts

@@ -18,5 +18,5 @@ declare type YAMLScalar = yamlAst.YAMLScalar & {
 declare type YAMLNode = YAMLMapping | YAMLMap | YAMLAnchorReference | YAMLSequence | YAMLScalar;
 export declare function getCodeframe(location: LineColLocationObject, color: boolean): string;
 export declare function getLineColLocation(location: LocationObject): LineColLocationObject;
-export declare function getAstNodeByPointer(root: YAMLNode, pointer: string, reportOnKey: boolean): yamlAst.YAMLScalar | YAMLMapping | YAMLMap | YAMLAnchorReference | YAMLSequence | undefined;
+export declare function getAstNodeByPointer(root: YAMLNode, pointer: string, reportOnKey: boolean): YAMLMapping | YAMLMap | YAMLAnchorReference | YAMLSequence | yamlAst.YAMLScalar | undefined;
 export {};

package/lib/rules/common/no-path-trailing-slash.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NoPathTrailingSlash = void 0;
 const NoPathTrailingSlash = () => {
     return {
-        PathItem(_path, { report, key, location }) {
+        PathItem(_path, { report, key, rawLocation }) {
             if (key.endsWith('/') && key !== '/') {
                 report({
                     message: `\`${key}\` should not have a trailing slash.`,
-                    location: location.key(),
+                    location: rawLocation.key(),
                 });
             }
         },

package/lib/rules/common/tags-alphabetical.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TagsAlphabetical = void 0;
-const TagsAlphabetical = () => {
+const TagsAlphabetical = ({ ignoreCase = false }) => {
     return {
         Root(root, { report, location }) {
             if (!root.tags)
                 return;
             for (let i = 0; i < root.tags.length - 1; i++) {
-                if (root.tags[i].name > root.tags[i + 1].name) {
+                if (getTagName(root.tags[i], ignoreCase) > getTagName(root.tags[i + 1], ignoreCase)) {
                     report({
                         message: 'The `tags` array should be in alphabetical order.',
                         location: location.child(['tags', i]),
@@ -18,3 +18,6 @@ const TagsAlphabetical = () => {
     };
 };
 exports.TagsAlphabetical = TagsAlphabetical;
+function getTagName(tag, ignoreCase) {
+    return ignoreCase ? tag.name.toLowerCase() : tag.name;
+}

package/lib/rules/oas2/remove-unused-components.js

@@ -19,7 +19,10 @@ const RemoveUnusedComponents = () => {
                     const resolvedRef = resolve(ref);
                     if (!resolvedRef.location)
                         return;
-                    components.set(resolvedRef.location.absolutePointer, {
+                    const [fileLocation, localPointer] = resolvedRef.location.absolutePointer.split('#', 2);
+                    const componentLevelLocalPointer = localPointer.split('/').slice(0, 3).join('/');
+                    const pointer = `${fileLocation}#${componentLevelLocalPointer}`;
+                    components.set(pointer, {
                         used: true,
                         name: key.toString(),
                     });

package/lib/rules/oas3/remove-unused-components.js

@@ -19,7 +19,10 @@ const RemoveUnusedComponents = () => {
                     const resolvedRef = resolve(ref);
                     if (!resolvedRef.location)
                         return;
-                    components.set(resolvedRef.location.absolutePointer, {
+                    const [fileLocation, localPointer] = resolvedRef.location.absolutePointer.split('#', 2);
+                    const componentLevelLocalPointer = localPointer.split('/').slice(0, 4).join('/');
+                    const pointer = `${fileLocation}#${componentLevelLocalPointer}`;
+                    components.set(pointer, {
                         used: true,
                         name: key.toString(),
                     });

package/lib/rules/utils.d.ts

@@ -1,7 +1,7 @@
 import { UserContext } from '../walk';
 import { Location } from '../ref-utils';
 import { Oas3Schema, Referenced } from '../typings/openapi';
-export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "null" | "integer" | "array";
+export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "integer" | "array" | "null";
 /**
  * Checks if value matches specified JSON schema type
  *