@redocly/openapi-core 1.18.0 → 1.18.1

package/lib/types/arazzo.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArazzoTypes = exports.arazzoSchema = exports.ARAZZO_ROOT_TYPE = void 0;
+exports.ArazzoTypes = exports.arazzoSchema = exports.workflow = exports.step = exports.inherit = exports.criteriaObject = exports.requestBody = exports.replacement = exports.infoObject = exports.parameter = exports.sourceDescriptionSchema = exports.expectSchema = exports.operationMethod = exports.ARAZZO_ROOT_TYPE = void 0;
 const json_schema_adapter_1 = require("./json-schema-adapter");
 exports.ARAZZO_ROOT_TYPE = 'Root';
-const operationMethod = {
+exports.operationMethod = {
     type: 'string',
     enum: ['get', 'post', 'put', 'delete', 'patch'],
 };
-const expectSchema = {
+exports.expectSchema = {
     type: 'object',
     properties: {
         statusCode: { type: 'number' },
@@ -57,7 +57,7 @@ const arazzoSourceDescriptionSchema = {
     additionalProperties: false,
     required: ['name', 'type', 'url'],
 };
-const sourceDescriptionSchema = {
+exports.sourceDescriptionSchema = {
     type: 'object',
     oneOf: [
         openAPISourceDescriptionSchema,
@@ -67,20 +67,20 @@ const sourceDescriptionSchema = {
 };
 const sourceDescriptionsSchema = {
     type: 'array',
-    items: sourceDescriptionSchema,
+    items: exports.sourceDescriptionSchema,
 };
 const extendedOperation = {
     type: 'object',
     properties: {
         path: { type: 'string' },
-        method: operationMethod,
+        method: exports.operationMethod,
         sourceDescriptionName: { type: 'string' },
         serverUrl: { type: 'string' },
     },
     additionalProperties: false,
     required: ['path', 'method'],
 };
-const parameter = {
+exports.parameter = {
     type: 'object',
     oneOf: [
         {
@@ -95,17 +95,6 @@ const parameter = {
             required: ['name', 'value'],
             additionalProperties: false,
         },
-        {
-            type: 'object',
-            properties: {
-                $ref: { type: 'string' },
-                value: {
-                    oneOf: [{ type: 'string' }, { type: 'number' }, { type: 'boolean' }],
-                },
-            },
-            required: ['$ref'],
-            additionalProperties: false,
-        },
         {
             type: 'object',
             properties: {
@@ -121,9 +110,9 @@ const parameter = {
 };
 const parameters = {
     type: 'array',
-    items: parameter,
+    items: exports.parameter,
 };
-const infoObject = {
+exports.infoObject = {
     type: 'object',
     properties: {
         title: { type: 'string' },
@@ -134,7 +123,7 @@ const infoObject = {
     additionalProperties: false,
     required: ['title', 'version'],
 };
-const replacement = {
+exports.replacement = {
     type: 'object',
     properties: {
         target: { type: 'string' },
@@ -149,7 +138,7 @@ const replacement = {
         },
     },
 };
-const requestBody = {
+exports.requestBody = {
     type: 'object',
     properties: {
         contentType: { type: 'string' },
@@ -165,13 +154,13 @@ const requestBody = {
         encoding: { type: 'string' },
         replacements: {
             type: 'array',
-            items: replacement,
+            items: exports.replacement,
         },
     },
     additionalProperties: false,
     required: ['payload'],
 };
-const criteriaObject = {
+exports.criteriaObject = {
     type: 'object',
     properties: {
         condition: { type: 'string' },
@@ -201,9 +190,9 @@ const criteriaObject = {
 };
 const criteriaObjects = {
     type: 'array',
-    items: criteriaObject,
+    items: exports.criteriaObject,
 };
-const inherit = {
+exports.inherit = {
     type: 'string',
     enum: ['auto', 'none'],
 };
@@ -241,7 +230,7 @@ const onFailureList = {
     type: 'array',
     items: onFailureObject,
 };
-const step = {
+exports.step = {
     type: 'object',
     properties: {
         stepId: { type: 'string' },
@@ -256,14 +245,30 @@ const step = {
         outputs: {
             type: 'object',
             additionalProperties: {
-                type: 'string',
+                oneOf: [
+                    {
+                        type: 'string',
+                    },
+                    {
+                        type: 'object',
+                    },
+                    {
+                        type: 'array',
+                    },
+                    {
+                        type: 'boolean',
+                    },
+                    {
+                        type: 'number',
+                    },
+                ],
             },
         },
-        'x-inherit': inherit,
-        'x-expect': expectSchema,
+        'x-inherit': exports.inherit,
+        'x-expect': exports.expectSchema,
         'x-assert': { type: 'string' },
         'x-operation': extendedOperation,
-        requestBody: requestBody,
+        requestBody: exports.requestBody,
     },
     required: ['stepId'],
     oneOf: [
@@ -275,7 +280,7 @@ const step = {
 };
 const steps = {
     type: 'array',
-    items: step,
+    items: exports.step,
 };
 const JSONSchema = {
     type: 'object',
@@ -300,7 +305,7 @@ const JSONSchema = {
     required: ['type'],
     additionalProperties: true,
 };
-const workflow = {
+exports.workflow = {
     type: 'object',
     properties: {
         workflowId: { type: 'string' },
@@ -330,13 +335,13 @@ const workflow = {
 };
 const workflows = {
     type: 'array',
-    items: workflow,
+    items: exports.workflow,
 };
 exports.arazzoSchema = {
     type: 'object',
     properties: {
         arazzo: { type: 'string', enum: ['1.0.0'] },
-        info: infoObject,
+        info: exports.infoObject,
         sourceDescriptions: sourceDescriptionsSchema,
         'x-parameters': parameters,
         workflows: workflows,
@@ -362,7 +367,7 @@ exports.arazzoSchema = {
                 },
                 parameters: {
                     type: 'object',
-                    additionalProperties: parameter,
+                    additionalProperties: exports.parameter,
                 },
                 successActions: {
                     type: 'object',

package/lib/types/asyncapi.js

@@ -308,11 +308,8 @@ const MessageExample = {
 const Schema = {
     properties: {
         $id: { type: 'string' },
-        id: { type: 'string' },
         $schema: { type: 'string' },
         definitions: 'NamedSchemas',
-        $defs: 'NamedSchemas',
-        $vocabulary: { type: 'string' },
         externalDocs: 'ExternalDocs',
         discriminator: 'Discriminator',
         myArbitraryKeyword: { type: 'boolean' },
@@ -333,17 +330,14 @@ const Schema = {
         required: { type: 'array', items: { type: 'string' } },
         enum: { type: 'array' },
         type: (value) => {
-            if (Array.isArray(value)) {
-                return {
+            return Array.isArray(value)
+                ? {
                     type: 'array',
                     items: { enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'] },
-                };
-            }
-            else {
-                return {
+                }
+                : {
                     enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'],
                 };
-            }
         },
         allOf: (0, _1.listOf)('Schema'),
         anyOf: (0, _1.listOf)('Schema'),
@@ -352,38 +346,12 @@ const Schema = {
         if: 'Schema',
         then: 'Schema',
         else: 'Schema',
-        dependentSchemas: (0, _1.listOf)('Schema'),
-        prefixItems: (0, _1.listOf)('Schema'),
         contains: 'Schema',
-        minContains: { type: 'integer', minimum: 0 },
-        maxContains: { type: 'integer', minimum: 0 },
         patternProperties: { type: 'object' },
         propertyNames: 'Schema',
-        unevaluatedItems: (value) => {
-            if (typeof value === 'boolean') {
-                return { type: 'boolean' };
-            }
-            else {
-                return 'Schema';
-            }
-        },
-        unevaluatedProperties: (value) => {
-            if (typeof value === 'boolean') {
-                return { type: 'boolean' };
-            }
-            else {
-                return 'Schema';
-            }
-        },
-        summary: { type: 'string' },
         properties: 'SchemaProperties',
         items: (value) => {
-            if (typeof value === 'boolean') {
-                return { type: 'boolean' };
-            }
-            else {
-                return 'Schema';
-            }
+            return Array.isArray(value) ? (0, _1.listOf)('Schema') : 'Schema';
         },
         additionalProperties: (value) => {
             return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
@@ -395,22 +363,21 @@ const Schema = {
         default: null,
         readOnly: { type: 'boolean' },
         writeOnly: { type: 'boolean' },
-        // xml: 'Xml',
         examples: { type: 'array' },
         example: { isExample: true },
         deprecated: { type: 'boolean' },
         const: null,
         $comment: { type: 'string' },
-        dependencies: { type: 'object' }, // TODO
+        additionalItems: (value) => {
+            return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
+        },
+        dependencies: 'Dependencies',
     },
 };
 const SchemaProperties = {
     properties: {},
     additionalProperties: (value) => {
-        if (typeof value === 'boolean') {
-            return { type: 'boolean' };
-        }
-        return 'Schema';
+        return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
     },
 };
 const DiscriminatorMapping = {
@@ -552,6 +519,12 @@ const SecurityScheme = {
     },
     extensionsPrefix: 'x-',
 };
+const Dependencies = {
+    properties: {},
+    additionalProperties: (value) => {
+        return Array.isArray(value) ? { type: 'array', items: { type: 'string' } } : 'Schema';
+    },
+};
 // --- Per-protocol node types
 // http
 const HttpChannelBinding = {
@@ -1025,4 +998,5 @@ exports.AsyncApi2Types = {
     MessageTrait,
     MessageTraitList: (0, _1.listOf)('MessageTrait'),
     CorrelationId,
+    Dependencies,
 };

package/lib/types/oas3_1.js

@@ -128,13 +128,13 @@ const Schema = {
         if: 'Schema',
         then: 'Schema',
         else: 'Schema',
-        dependentSchemas: (0, _1.listOf)('Schema'),
+        dependentSchemas: (0, _1.mapOf)('Schema'),
         dependentRequired: 'DependentRequired',
         prefixItems: (0, _1.listOf)('Schema'),
         contains: 'Schema',
         minContains: { type: 'integer', minimum: 0 },
         maxContains: { type: 'integer', minimum: 0 },
-        patternProperties: { type: 'object' },
+        patternProperties: 'SchemaProperties',
         propertyNames: 'Schema',
         unevaluatedItems: (value) => {
             if (typeof value === 'boolean') {

package/lib/typings/arazzo.d.ts

@@ -1,3 +1,30 @@
 import type { FromSchema } from 'json-schema-to-ts';
-import type { arazzoSchema } from '../types/arazzo';
+import type { arazzoSchema, parameter, operationMethod, expectSchema, sourceDescriptionSchema, infoObject, requestBody, replacement, inherit, criteriaObject, step, workflow } from '../types/arazzo';
 export type ArazzoDefinition = FromSchema<typeof arazzoSchema>;
+export type OperationMethod = FromSchema<typeof operationMethod>;
+export type ResponseContext = {
+    statusCode: number;
+    body: any;
+    headers: Headers;
+    mimeType: string;
+} & Record<string, any>;
+export type Expect = FromSchema<typeof expectSchema>;
+export type SourceDescription = FromSchema<typeof sourceDescriptionSchema>;
+export type Parameter = FromSchema<typeof parameter>;
+export type InfoObject = FromSchema<typeof infoObject>;
+export type RequestBody = FromSchema<typeof requestBody>;
+export type Replacement = FromSchema<typeof replacement>;
+export type Inherit = FromSchema<typeof inherit>;
+export type CriteriaObject = FromSchema<typeof criteriaObject>;
+export type VerboseLog = {
+    method: OperationMethod;
+    path: string;
+    host: string;
+    body?: any;
+    headerParams?: Record<string, string>;
+    statusCode?: number;
+};
+export type Step = FromSchema<typeof step>;
+export type Workflow = FromSchema<typeof workflow> & {
+    steps: Step[];
+};

package/lib/utils.d.ts

@@ -1,6 +1,6 @@
-import { UserContext } from './walk';
-import { HttpResolveConfig } from './config';
 import { HttpsProxyAgent } from 'https-proxy-agent';
+import type { HttpResolveConfig } from './config';
+import type { UserContext } from './walk';
 export { parseYaml, stringifyYaml } from './js-yaml';
 export type StackFrame<T> = {
     prev: StackFrame<T> | null;
@@ -28,7 +28,6 @@ export declare function omitObjectProps<T extends Record<string, unknown>>(objec
 export declare function splitCamelCaseIntoWords(str: string): Set<string>;
 export declare function validateMimeType({ type, value }: any, { report, location }: UserContext, allowedValues: string[]): void;
 export declare function validateMimeTypeOAS3({ type, value }: any, { report, location }: UserContext, allowedValues: string[]): void;
-export declare function isSingular(path: string): boolean;
 export declare function readFileAsStringSync(filePath: string): string;
 export declare function yamlAndJsonSyncReader<T>(filePath: string): T;
 export declare function isPathParameter(pathSegment: string): boolean;
@@ -50,6 +49,11 @@ export declare function isTruthy<Truthy>(value: Truthy | Falsy): value is Truthy
 export declare function identity<T>(value: T): T;
 export declare function keysOf<T>(obj: T): (keyof T)[];
 export declare function pickDefined<T extends Record<string, unknown>>(obj?: T): Record<string, unknown> | undefined;
-export declare function nextTick(): void;
+export declare function nextTick(): Promise<unknown>;
 export declare function pause(ms: number): Promise<void>;
 export declare function getProxyAgent(): HttpsProxyAgent<string> | undefined;
+/**
+ * Checks if two objects are deeply equal.
+ * Borrowed the source code from https://github.com/lukeed/dequal.
+ */
+export declare function dequal(foo: any, bar: any): boolean;

package/lib/utils.js

@@ -9,12 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProxyAgent = exports.pause = exports.nextTick = exports.pickDefined = exports.keysOf = exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.yamlAndJsonSyncReader = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.dequal = exports.getProxyAgent = exports.pause = exports.nextTick = exports.pickDefined = exports.keysOf = exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.yamlAndJsonSyncReader = exports.readFileAsStringSync = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 const minimatch = require("minimatch");
 const node_fetch_1 = require("node-fetch");
-const pluralize = require("pluralize");
 const js_yaml_1 = require("./js-yaml");
 const env_1 = require("./env");
 const logger_1 = require("./logger");
@@ -132,10 +131,6 @@ function validateMimeTypeOAS3({ type, value }, { report, location }, allowedValu
     }
 }
 exports.validateMimeTypeOAS3 = validateMimeTypeOAS3;
-function isSingular(path) {
-    return pluralize.isSingular(path);
-}
-exports.isSingular = isSingular;
 function readFileAsStringSync(filePath) {
     return fs.readFileSync(filePath, 'utf-8');
 }
@@ -233,7 +228,7 @@ function pickDefined(obj) {
 }
 exports.pickDefined = pickDefined;
 function nextTick() {
-    new Promise((resolve) => {
+    return new Promise((resolve) => {
         setTimeout(resolve);
     });
 }
@@ -252,3 +247,39 @@ function getProxyAgent() {
     return proxy ? new https_proxy_agent_1.HttpsProxyAgent(proxy) : undefined;
 }
 exports.getProxyAgent = getProxyAgent;
+/**
+ * Checks if two objects are deeply equal.
+ * Borrowed the source code from https://github.com/lukeed/dequal.
+ */
+function dequal(foo, bar) {
+    let ctor, len;
+    if (foo === bar)
+        return true;
+    if (foo && bar && (ctor = foo.constructor) === bar.constructor) {
+        if (ctor === Date)
+            return foo.getTime() === bar.getTime();
+        if (ctor === RegExp)
+            return foo.toString() === bar.toString();
+        if (ctor === Array) {
+            if ((len = foo.length) === bar.length) {
+                while (len-- && dequal(foo[len], bar[len]))
+                    ;
+            }
+            return len === -1;
+        }
+        if (!ctor || typeof foo === 'object') {
+            len = 0;
+            for (ctor in foo) {
+                if (Object.prototype.hasOwnProperty.call(foo, ctor) &&
+                    ++len &&
+                    !Object.prototype.hasOwnProperty.call(bar, ctor))
+                    return false;
+                if (!(ctor in bar) || !dequal(foo[ctor], bar[ctor]))
+                    return false;
+            }
+            return Object.keys(bar).length === len;
+        }
+    }
+    return foo !== foo && bar !== bar;
+}
+exports.dequal = dequal;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.18.0",
+  "version": "1.18.1",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -36,7 +36,7 @@
   ],
   "dependencies": {
     "@redocly/ajv": "^8.11.0",
-    "@redocly/config": "^0.6.2",
+    "@redocly/config": "^0.7.0",
     "colorette": "^1.2.0",
     "https-proxy-agent": "^7.0.4",
     "js-levenshtein": "^1.1.6",

package/src/__tests__/lint.test.ts

@@ -104,14 +104,6 @@ const testPortalConfig = parseYamlToDocument(
         # configurationUrl: Must be reported as a missing required prop
         clientSecret: '{{ process.env.secret }}'
 
-      basic:
-        type: BASIC
-        credentials:
-          - teams:
-              - 789 # Must be a string
-              - correct
-            # username: Must be reported as a missing required prop
-
     sso:
       - WRONG # Does not match allowed options
 
@@ -393,20 +385,6 @@ describe('lint', () => {
           "severity": "error",
           "suggest": [],
         },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/theme/openapi/showConsole",
-              "reportOnKey": true,
-              "source": "",
-            },
-          ],
-          "message": "Property \`showConsole\` is not expected here.",
-          "ruleId": "configuration spec",
-          "severity": "error",
-          "suggest": [],
-        },
         {
           "from": undefined,
           "location": [
@@ -912,34 +890,6 @@ describe('lint', () => {
           "severity": "error",
           "suggest": [],
         },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/ssoOnPrem/basic/credentials/0",
-              "reportOnKey": true,
-              "source": "",
-            },
-          ],
-          "message": "The field \`username\` must be present on this level.",
-          "ruleId": "configuration spec",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/ssoOnPrem/basic/credentials/0/teams/0",
-              "reportOnKey": false,
-              "source": "",
-            },
-          ],
-          "message": "Expected type \`string\` but got \`integer\`.",
-          "ruleId": "configuration spec",
-          "severity": "error",
-          "suggest": [],
-        },
         {
           "from": undefined,
           "location": [

package/src/bundle.ts

@@ -1,4 +1,3 @@
-import isEqual = require('lodash.isequal');
 import { BaseResolver, resolveDocument, makeRefId, makeDocumentFromString } from './resolve';
 import { normalizeVisitors } from './visitors';
 import { normalizeTypes } from './types';
@@ -13,7 +12,7 @@ import {
 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 { dequal, isPlainObject, isTruthy } from './utils';
 import { isRedoclyRegistryURL } from './redocly/domains';
 import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './decorators/oas2/remove-unused-components';
 import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './decorators/oas3/remove-unused-components';
@@ -446,7 +445,7 @@ function makeBundleVisitor(
       return true;
     }
 
-    return isEqual(node, target.node);
+    return dequal(node, target.node);
   }
 
   function getComponentName(

package/src/config/load.ts

@@ -10,10 +10,9 @@ import { bundleConfig } from '../bundle';
 import { BaseResolver } from '../resolve';
 import { isBrowser } from '../env';
 
-import type { Document } from '../resolve';
+import type { Document, ResolvedRefMap } from '../resolve';
 import type { RegionalToken, RegionalTokenWithValidity } from '../redocly/redocly-client-types';
 import type { RawConfig, RawUniversalConfig, Region } from './types';
-import type { ResolvedRefMap } from '../resolve';
 import { DOMAINS } from '../redocly/domains';
 
 async function addConfigMetadata({

package/src/rules/common/__tests__/spec.test.ts

@@ -607,4 +607,51 @@ describe('Oas3.1 spec', () => {
       ]
     `);
   });
+
+  it('should flag invalid dependentSchemas', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      openapi: 3.1.0
+      info:
+        version: 1.0.0
+        title: Example.com
+        description: info,
+        license:
+          name: Apache 2.0
+          url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
+      components:
+        schemas:
+          withInvalidDependentSchemas:
+            dependentSchemas:
+              - invalid1
+              - invalid2
+      `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ spec: 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "from": undefined,
+          "location": [
+            {
+              "pointer": "#/components/schemas/withInvalidDependentSchemas/dependentSchemas",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Expected type \`SchemaMap\` (object) but got \`array\`",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
 });

package/src/rules/common/no-invalid-schema-examples.ts

@@ -1,7 +1,8 @@
-import { UserContext } from '../../walk';
-import { Oas3_1Schema } from '../../typings/openapi';
 import { getAdditionalPropertiesOption, validateExample } from '../utils';
 
+import type { UserContext } from '../../walk';
+import type { Oas3_1Schema } from '../../typings/openapi';
+
 export const NoInvalidSchemaExamples: any = (opts: any) => {
   const allowAdditionalProperties = getAdditionalPropertiesOption(opts) ?? false;
   return {