@redocly/openapi-core 1.0.2 → 1.2.0

package/lib/oas-types.js

@@ -1,45 +1,71 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openAPIMajor = exports.detectOpenAPI = exports.OasMajorVersion = exports.OasVersion = void 0;
-var OasVersion;
-(function (OasVersion) {
-    OasVersion["Version2"] = "oas2";
-    OasVersion["Version3_0"] = "oas3_0";
-    OasVersion["Version3_1"] = "oas3_1";
-})(OasVersion = exports.OasVersion || (exports.OasVersion = {}));
-var OasMajorVersion;
-(function (OasMajorVersion) {
-    OasMajorVersion["Version2"] = "oas2";
-    OasMajorVersion["Version3"] = "oas3";
-})(OasMajorVersion = exports.OasMajorVersion || (exports.OasMajorVersion = {}));
-function detectOpenAPI(root) {
+exports.getTypes = exports.getMajorSpecVersion = exports.detectSpec = exports.SpecMajorVersion = exports.SpecVersion = void 0;
+const oas2_1 = require("./types/oas2");
+const oas3_1 = require("./types/oas3");
+const oas3_1_1 = require("./types/oas3_1");
+const asyncapi_1 = require("./types/asyncapi");
+var SpecVersion;
+(function (SpecVersion) {
+    SpecVersion["OAS2"] = "oas2";
+    SpecVersion["OAS3_0"] = "oas3_0";
+    SpecVersion["OAS3_1"] = "oas3_1";
+    SpecVersion["Async2"] = "async2";
+})(SpecVersion = exports.SpecVersion || (exports.SpecVersion = {}));
+var SpecMajorVersion;
+(function (SpecMajorVersion) {
+    SpecMajorVersion["OAS2"] = "oas2";
+    SpecMajorVersion["OAS3"] = "oas3";
+    SpecMajorVersion["Async2"] = "async2";
+})(SpecMajorVersion = exports.SpecMajorVersion || (exports.SpecMajorVersion = {}));
+const typesMap = {
+    [SpecVersion.OAS2]: oas2_1.Oas2Types,
+    [SpecVersion.OAS3_0]: oas3_1.Oas3Types,
+    [SpecVersion.OAS3_1]: oas3_1_1.Oas3_1Types,
+    [SpecVersion.Async2]: asyncapi_1.AsyncApi2Types,
+};
+function detectSpec(root) {
     if (typeof root !== 'object') {
         throw new Error(`Document must be JSON object, got ${typeof root}`);
     }
-    if (!(root.openapi || root.swagger)) {
-        throw new Error('This doesn’t look like an OpenAPI document.\n');
-    }
     if (root.openapi && typeof root.openapi !== 'string') {
         throw new Error(`Invalid OpenAPI version: should be a string but got "${typeof root.openapi}"`);
     }
     if (root.openapi && root.openapi.startsWith('3.0')) {
-        return OasVersion.Version3_0;
+        return SpecVersion.OAS3_0;
     }
     if (root.openapi && root.openapi.startsWith('3.1')) {
-        return OasVersion.Version3_1;
+        return SpecVersion.OAS3_1;
     }
     if (root.swagger && root.swagger === '2.0') {
-        return OasVersion.Version2;
+        return SpecVersion.OAS2;
+    }
+    // if not detected yet
+    if (root.openapi || root.swagger) {
+        throw new Error(`Unsupported OpenAPI version: ${root.openapi || root.swagger}`);
+    }
+    if (root.asyncapi && root.asyncapi.startsWith('2.')) {
+        return SpecVersion.Async2;
     }
-    throw new Error(`Unsupported OpenAPI Version: ${root.openapi || root.swagger}`);
+    if (root.asyncapi) {
+        throw new Error(`Unsupported AsyncAPI version: ${root.asyncapi}`);
+    }
+    throw new Error(`Unsupported specification`);
 }
-exports.detectOpenAPI = detectOpenAPI;
-function openAPIMajor(version) {
-    if (version === OasVersion.Version2) {
-        return OasMajorVersion.Version2;
+exports.detectSpec = detectSpec;
+function getMajorSpecVersion(version) {
+    if (version === SpecVersion.OAS2) {
+        return SpecMajorVersion.OAS2;
+    }
+    else if (version === SpecVersion.Async2) {
+        return SpecMajorVersion.Async2;
     }
     else {
-        return OasMajorVersion.Version3;
+        return SpecMajorVersion.OAS3;
     }
 }
-exports.openAPIMajor = openAPIMajor;
+exports.getMajorSpecVersion = getMajorSpecVersion;
+function getTypes(spec) {
+    return typesMap[spec];
+}
+exports.getTypes = getTypes;

package/lib/rules/async2/channels-kebab-case.d.ts

@@ -0,0 +1,2 @@
+import { Async2Rule } from '../../visitors';
+export declare const ChannelsKebabCase: Async2Rule;

package/lib/rules/async2/channels-kebab-case.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChannelsKebabCase = void 0;
+const ChannelsKebabCase = () => {
+    return {
+        Channel(_channel, { report, key }) {
+            const segments = key
+                .split(/[/.:]/) // split on / or : as likely channel namespacers
+                .filter((s) => s !== ''); // filter out empty segments
+            if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
+                report({
+                    message: `\`${key}\` does not use kebab-case.`,
+                    location: { reportOnKey: true },
+                });
+            }
+        },
+    };
+};
+exports.ChannelsKebabCase = ChannelsKebabCase;

package/lib/rules/async2/index.d.ts

@@ -0,0 +1,12 @@
+import { Async2Rule } from '../../visitors';
+export declare const rules: {
+    spec: Async2Rule;
+    assertions: (opts: Record<string, import("../common/assertions").Assertion>) => (import("../../visitors").Oas3Visitor | import("../../visitors").Oas2Visitor)[];
+    'info-contact': import("../../visitors").Oas3Rule | import("../../visitors").Oas2Rule;
+    'operation-operationId': import("../../visitors").Oas3Rule | import("../../visitors").Oas2Rule;
+    'channels-kebab-case': Async2Rule;
+    'no-channel-trailing-slash': Async2Rule;
+    'tag-description': import("../../visitors").Oas3Rule | import("../../visitors").Oas2Rule;
+    'tags-alphabetical': import("../../visitors").Oas3Rule | import("../../visitors").Oas2Rule;
+};
+export declare const preprocessors: {};

package/lib/rules/async2/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preprocessors = exports.rules = void 0;
+const assertions_1 = require("../common/assertions");
+const spec_1 = require("../common/spec");
+const info_contact_1 = require("../common/info-contact");
+const operation_operationId_1 = require("../common/operation-operationId");
+const tag_description_1 = require("../common/tag-description");
+const tags_alphabetical_1 = require("../common/tags-alphabetical");
+const channels_kebab_case_1 = require("./channels-kebab-case");
+const no_channel_trailing_slash_1 = require("./no-channel-trailing-slash");
+exports.rules = {
+    spec: spec_1.Spec,
+    assertions: assertions_1.Assertions,
+    'info-contact': info_contact_1.InfoContact,
+    'operation-operationId': operation_operationId_1.OperationOperationId,
+    'channels-kebab-case': channels_kebab_case_1.ChannelsKebabCase,
+    'no-channel-trailing-slash': no_channel_trailing_slash_1.NoChannelTrailingSlash,
+    'tag-description': tag_description_1.TagDescription,
+    'tags-alphabetical': tags_alphabetical_1.TagsAlphabetical,
+};
+exports.preprocessors = {};

package/lib/rules/async2/no-channel-trailing-slash.d.ts

@@ -0,0 +1,2 @@
+import { Async2Rule } from '../../visitors';
+export declare const NoChannelTrailingSlash: Async2Rule;

package/lib/rules/async2/no-channel-trailing-slash.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoChannelTrailingSlash = void 0;
+const NoChannelTrailingSlash = () => {
+    return {
+        Channel(_channel, { report, key, location }) {
+            if (key.endsWith('/') && key !== '/') {
+                report({
+                    message: `\`${key}\` should not have a trailing slash.`,
+                    location: location.key(),
+                });
+            }
+        },
+    };
+};
+exports.NoChannelTrailingSlash = NoChannelTrailingSlash;

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/scalar-property-missing-example.js

@@ -14,7 +14,7 @@ const ScalarPropertyMissingExample = () => {
                 if (propSchema.example === undefined &&
                     propSchema.examples === undefined) {
                     report({
-                        message: `Scalar property should have "example"${oasVersion === oas_types_1.OasVersion.Version3_1 ? ' or "examples"' : ''} defined.`,
+                        message: `Scalar property should have "example"${oasVersion === oas_types_1.SpecVersion.OAS3_1 ? ' or "examples"' : ''} defined.`,
                         location: location.child(propName).key(),
                     });
                 }

package/lib/rules/common/spec.d.ts

@@ -1,2 +1,2 @@
-import type { Oas3Rule, Oas2Rule } from '../../visitors';
-export declare const OasSpec: Oas3Rule | Oas2Rule;
+import type { Oas3Rule, Oas2Rule, Async2Rule } from '../../visitors';
+export declare const Spec: Oas3Rule | Oas2Rule | Async2Rule;

package/lib/rules/common/spec.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OasSpec = void 0;
+exports.Spec = void 0;
 const types_1 = require("../../types");
 const utils_1 = require("../utils");
 const ref_utils_1 = require("../../ref-utils");
 const utils_2 = require("../../utils");
-const OasSpec = () => {
+const Spec = () => {
     return {
         any(node, { report, type, location, rawLocation, key, resolve, ignoreNextVisitorsOnNode }) {
             var _a, _b, _c, _d, _e, _f;
@@ -156,4 +156,4 @@ const OasSpec = () => {
         },
     };
 };
-exports.OasSpec = OasSpec;
+exports.Spec = Spec;

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/index.js

@@ -44,7 +44,7 @@ const scalar_property_missing_example_1 = require("../common/scalar-property-mis
 const required_string_property_missing_min_length_1 = require("../common/required-string-property-missing-min-length");
 const spec_strict_refs_1 = require("../common/spec-strict-refs");
 exports.rules = {
-    spec: spec_1.OasSpec,
+    spec: spec_1.Spec,
     'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
     'no-invalid-parameter-examples': no_invalid_parameter_examples_1.NoInvalidParameterExamples,
     'info-contact': info_contact_1.InfoContact,

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/index.js

@@ -55,7 +55,7 @@ const required_string_property_missing_min_length_1 = require("../common/require
 const spec_strict_refs_1 = require("../common/spec-strict-refs");
 const component_name_unique_1 = require("./component-name-unique");
 exports.rules = {
-    spec: spec_1.OasSpec,
+    spec: spec_1.Spec,
     'info-contact': info_contact_1.InfoContact,
     'info-license': info_license_1.InfoLicense,
     'info-license-url': info_license_url_1.InfoLicenseUrl,

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
  *

package/lib/types/asyncapi.d.ts

@@ -0,0 +1,2 @@
+import { NodeType } from '.';
+export declare const AsyncApi2Types: Record<string, NodeType>;