@redocly/openapi-core 1.21.1 → 1.22.1

package/lib/types/redocly-yaml.js

@@ -93,7 +93,20 @@ const builtInAsync3Rules = [
     'channels-kebab-case',
     'no-channel-trailing-slash',
 ];
-const builtInArazzoRules = ['spec', 'parameters-no-body-inside-in'];
+const builtInArazzoRules = [
+    'spec',
+    'parameters-not-in-body',
+    'sourceDescription-type',
+    'version-enum',
+    'workflowId-unique',
+    'stepId-unique',
+    'sourceDescription-name-unique',
+    'workflow-dependsOn',
+    'parameters-unique',
+    'step-onSuccess-unique',
+    'step-onFailure-unique',
+    'requestBody-replacements-unique',
+];
 const builtInRules = [
     ...builtInCommonOASRules,
     ...builtInOAS2Rules,

package/lib/typings/arazzo.d.ts

@@ -146,3 +146,5 @@ export interface ArazzoDefinition {
         };
     };
 }
+export declare const VERSION_PATTERN: RegExp;
+export declare const ARAZZO_VERSIONS_SUPPORTED_BY_SPOT: string[];

package/lib/typings/arazzo.js

@@ -1,2 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ARAZZO_VERSIONS_SUPPORTED_BY_SPOT = exports.VERSION_PATTERN = void 0;
+exports.VERSION_PATTERN = /^1\.0\.\d+(-.+)?$/;
+exports.ARAZZO_VERSIONS_SUPPORTED_BY_SPOT = ['1.0.0'];

package/lib/utils.d.ts

@@ -12,6 +12,7 @@ export declare function pushStack<T, P extends Stack<T> = Stack<T>>(head: P, val
     prev: P;
     value: T;
 };
+export declare function pluralize(sentence: string, count?: number, inclusive?: boolean): string;
 export declare function popStack<T, P extends Stack<T>>(head: P): StackFrame<T> | null;
 export type BundleOutputFormat = 'json' | 'yml' | 'yaml';
 export declare function loadYaml<T>(filename: string): Promise<T>;

package/lib/utils.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stringifyYaml = exports.parseYaml = void 0;
 exports.pushStack = pushStack;
+exports.pluralize = pluralize;
 exports.popStack = popStack;
 exports.loadYaml = loadYaml;
 exports.isDefined = isDefined;
@@ -43,12 +44,19 @@ const js_yaml_1 = require("./js-yaml");
 const env_1 = require("./env");
 const logger_1 = require("./logger");
 const https_proxy_agent_1 = require("https-proxy-agent");
+const pluralizeOne = require("pluralize");
 var js_yaml_2 = require("./js-yaml");
 Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_2.parseYaml; } });
 Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_2.stringifyYaml; } });
 function pushStack(head, value) {
     return { prev: head, value };
 }
+function pluralize(sentence, count, inclusive) {
+    return sentence
+        .split(' ')
+        .map((word) => pluralizeOne(word, count, inclusive))
+        .join(' ');
+}
 function popStack(head) {
     return head?.prev ?? null;
 }

package/package.json

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

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -5,8 +5,18 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "arazzoDecorators": {},
   "arazzoPreprocessors": {},
   "arazzoRules": {
-    "parameters-no-body-inside-in": "off",
+    "parameters-not-in-body": "warn",
+    "parameters-unique": "error",
+    "requestBody-replacements-unique": "warn",
+    "sourceDescription-name-unique": "error",
+    "sourceDescription-type": "error",
     "spec": "error",
+    "step-onFailure-unique": "warn",
+    "step-onSuccess-unique": "warn",
+    "stepId-unique": "error",
+    "version-enum": "warn",
+    "workflow-dependsOn": "error",
+    "workflowId-unique": "error",
   },
   "async2Decorators": {},
   "async2Preprocessors": {},
@@ -137,8 +147,18 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "arazzoDecorators": {},
   "arazzoPreprocessors": {},
   "arazzoRules": {
-    "parameters-no-body-inside-in": "off",
+    "parameters-not-in-body": "warn",
+    "parameters-unique": "error",
+    "requestBody-replacements-unique": "warn",
+    "sourceDescription-name-unique": "error",
+    "sourceDescription-type": "error",
     "spec": "error",
+    "step-onFailure-unique": "warn",
+    "step-onSuccess-unique": "warn",
+    "stepId-unique": "error",
+    "version-enum": "warn",
+    "workflow-dependsOn": "error",
+    "workflowId-unique": "error",
   },
   "async2Decorators": {},
   "async2Preprocessors": {},

package/src/config/all.ts

@@ -126,7 +126,20 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'channels-kebab-case': 'error',
     'no-channel-trailing-slash': 'error',
   },
-  arazzoRules: { spec: 'error', 'parameters-no-body-inside-in': 'off' },
+  arazzoRules: {
+    spec: 'error',
+    'parameters-not-in-body': 'error',
+    'sourceDescription-type': 'error',
+    'version-enum': 'error',
+    'workflowId-unique': 'error',
+    'stepId-unique': 'error',
+    'sourceDescription-name-unique': 'error',
+    'workflow-dependsOn': 'error',
+    'parameters-unique': 'error',
+    'step-onSuccess-unique': 'error',
+    'step-onFailure-unique': 'error',
+    'requestBody-replacements-unique': 'error',
+  },
 };
 
 export default all;

package/src/config/config-resolvers.ts

@@ -117,7 +117,7 @@ function getDefaultPluginPath(configPath: string): string | undefined {
       return pluginPath;
     }
   }
-  return undefined;
+  return;
 }
 
 export async function resolvePlugins(
@@ -128,12 +128,6 @@ export async function resolvePlugins(
 
   // TODO: implement or reuse Resolver approach so it will work in node and browser envs
   const requireFunc = async (plugin: string | Plugin): Promise<ImportedPlugin | undefined> => {
-    if (isBrowser && isString(plugin)) {
-      logger.error(`Cannot load ${plugin}. Plugins aren't supported in browser yet.`);
-
-      return undefined;
-    }
-
     if (isString(plugin)) {
       try {
         const maybeAbsolutePluginPath = path.resolve(path.dirname(configPath), plugin);
@@ -372,9 +366,12 @@ async function resolveAndMergeNestedStyleguideConfig(
   if (parentConfigPaths.includes(configPath)) {
     throw new Error(`Circular dependency in config file: "${configPath}"`);
   }
-  const plugins = getUniquePlugins(
-    await resolvePlugins([...(styleguideConfig?.plugins || []), defaultPlugin], configPath)
-  );
+  const plugins = isBrowser
+    ? // In browser, we don't support plugins from config file yet
+      [defaultPlugin]
+    : getUniquePlugins(
+        await resolvePlugins([...(styleguideConfig?.plugins || []), defaultPlugin], configPath)
+      );
   const pluginPaths = styleguideConfig?.plugins
     ?.filter(isString)
     .map((p) => path.resolve(path.dirname(configPath), p));

package/src/config/minimal.ts

@@ -110,7 +110,17 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
   },
   arazzoRules: {
     spec: 'error',
-    'parameters-no-body-inside-in': 'off',
+    'parameters-not-in-body': 'off',
+    'sourceDescription-type': 'off',
+    'version-enum': 'warn',
+    'workflowId-unique': 'error',
+    'stepId-unique': 'error',
+    'sourceDescription-name-unique': 'off',
+    'workflow-dependsOn': 'off',
+    'parameters-unique': 'off',
+    'step-onSuccess-unique': 'off',
+    'step-onFailure-unique': 'off',
+    'requestBody-replacements-unique': 'off',
   },
 };
 

package/src/config/recommended-strict.ts

@@ -110,7 +110,17 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
   },
   arazzoRules: {
     spec: 'error',
-    'parameters-no-body-inside-in': 'off',
+    'parameters-not-in-body': 'error',
+    'sourceDescription-type': 'error',
+    'version-enum': 'error',
+    'workflowId-unique': 'error',
+    'stepId-unique': 'error',
+    'sourceDescription-name-unique': 'error',
+    'workflow-dependsOn': 'error',
+    'parameters-unique': 'error',
+    'step-onSuccess-unique': 'error',
+    'step-onFailure-unique': 'error',
+    'requestBody-replacements-unique': 'error',
   },
 };
 

package/src/config/recommended.ts

@@ -110,7 +110,17 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
   },
   arazzoRules: {
     spec: 'error',
-    'parameters-no-body-inside-in': 'off',
+    'parameters-not-in-body': 'warn',
+    'sourceDescription-type': 'error',
+    'version-enum': 'warn',
+    'workflowId-unique': 'error',
+    'stepId-unique': 'error',
+    'sourceDescription-name-unique': 'error',
+    'workflow-dependsOn': 'error',
+    'parameters-unique': 'error',
+    'step-onSuccess-unique': 'warn',
+    'step-onFailure-unique': 'warn',
+    'requestBody-replacements-unique': 'warn',
   },
 };
 

package/src/oas-types.ts

@@ -5,6 +5,7 @@ import { AsyncApi2Types } from './types/asyncapi2';
 import { AsyncApi3Types } from './types/asyncapi3';
 import { ArazzoTypes } from './types/arazzo';
 import { isPlainObject } from './utils';
+import { VERSION_PATTERN } from './typings/arazzo';
 
 import type {
   BuiltInAsync2RuleId,
@@ -132,7 +133,7 @@ export function detectSpec(root: unknown): SpecVersion {
     throw new Error(`Unsupported AsyncAPI version: ${root.asyncapi}`);
   }
 
-  if (typeof root.arazzo === 'string' && root.arazzo.startsWith('1.')) {
+  if (typeof root.arazzo === 'string' && VERSION_PATTERN.test(root.arazzo)) {
     return SpecVersion.Arazzo;
   }
 

package/src/rules/arazzo/__tests__/{parameters-no-body-inside-in.test.ts → parameters-not-in-body.test.ts}

@@ -2,10 +2,8 @@ import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
-import { StyleguideConfig } from '../../../config';
-import { ArazzoRule } from '../../../visitors';
 
-describe('Arazzo parameters-no-body-inside-in', () => {
+describe('Spot parameters-not-in-body', () => {
   const document = parseYamlToDocument(
     outdent`
       arazzo: '1.0.0'
@@ -51,7 +49,7 @@ describe('Arazzo parameters-no-body-inside-in', () => {
       document,
       config: await makeConfig({
         rules: {},
-        arazzoRules: { 'parameters-no-body-inside-in': 'error' },
+        arazzoRules: { 'parameters-not-in-body': 'error' },
       }),
     });
 
@@ -66,7 +64,7 @@ describe('Arazzo parameters-no-body-inside-in', () => {
             },
           ],
           "message": "The \`body\` value of the \`in\` property is not supported by Spot.",
-          "ruleId": "parameters-no-body-inside-in",
+          "ruleId": "parameters-not-in-body",
           "severity": "error",
           "suggest": [],
         },

package/src/rules/arazzo/__tests__/parameters-unique.test.ts

@@ -0,0 +1,114 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Arazzo parameters-unique', () => {
+  const document = parseYamlToDocument(
+    outdent`
+      arazzo: '1.0.0'
+      info:
+        title: Cool API
+        version: 1.0.0
+        description: A cool API
+      sourceDescriptions:
+        - name: museum-api
+          type: openapi
+          url: openapi.yaml
+      workflows:
+        - workflowId: get-museum-hours
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: get-museum-hours
+              description: >-
+                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
+              operationId: museum-api.getMuseumHours
+              parameters:
+                - in: header
+                  name: Secret
+                  value: Basic Og==
+                - in: header
+                  name: Secret
+                  value: Basic Og==
+                - reference: $components.parameters.notify
+                  value: 12
+                - reference: $components.parameters.notify
+                  value: 12
+              successCriteria:
+                - condition: $statusCode == 200
+    `,
+    'arazzo.yaml'
+  );
+
+  it('should not report on `parameters` duplication', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ rules: {} }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+
+  it('should report on `parameters` duplication', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'parameters-unique': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/parameters/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The parameter \`name\` must be unique amongst listed parameters.",
+          "ruleId": "parameters-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/parameters/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The parameter \`name\` must be unique amongst listed parameters.",
+          "ruleId": "parameters-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/parameters/3",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The parameter \`reference\` must be unique amongst listed parameters.",
+          "ruleId": "parameters-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+});

package/src/rules/arazzo/__tests__/requestBody-replacements-unique.test.ts

@@ -0,0 +1,109 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Arazzo requestBody-replacements-unique', () => {
+  const document = parseYamlToDocument(
+    outdent`
+      arazzo: '1.0.0'
+      info:
+        title: Cool API
+        version: 1.0.0
+        description: A cool API
+      sourceDescriptions:
+        - name: museum-api
+          type: openapi
+          url: openapi.yaml
+      workflows:
+        - workflowId: get-museum-hours
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: create-event
+              description: >-
+                Create a new special event.
+              operationPath: $sourceDescriptions.museum-api#/paths/~1special-events/post
+              requestBody:
+                replacements:
+                  - target: $randomString
+                    value: $randomString
+                  - target: $randomString
+                    value: $randomString
+                payload:
+                  name: 'Mermaid Treasure Identification and Analysis'
+                  location: 'Under the seaaa 🦀 🎶 🌊.'
+                  eventDescription: 'Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.'
+                  dates:
+                    - '2023-09-05'
+                    - '2023-09-08'
+                  price: 0
+              successCriteria:
+                - condition: $statusCode == 201
+                - context: $response.body
+                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
+                  type: jsonpath
+              outputs:
+                createdEventId: $response.body.eventId
+                name: $response.body.name
+        - workflowId: get-museum-hours-2
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: get-museum-hours
+              description: >-
+                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
+              operationId: museum-api.getMuseumHours
+              successCriteria:
+                - condition: $statusCode == 200
+    `,
+    'arazzo.yaml'
+  );
+
+  it('should report when the `replacement` is not unique amongst all `replacements` in the RequestBody', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'requestBody-replacements-unique': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/requestBody/replacements/1/target",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "Every \`replacement\` in \`requestBody\` must be unique.",
+          "ruleId": "requestBody-replacements-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report when the `replacement` is not unique amongst all `replacements` in the RequestBody', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+});

package/src/rules/arazzo/__tests__/source-description-type.test.ts

@@ -0,0 +1,80 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Arazzo sourceDescription-type', () => {
+  const document = parseYamlToDocument(
+    outdent`
+      arazzo: '1.0.0'
+      info:
+        title: Cool API
+        version: 1.0.0
+        description: A cool API
+      sourceDescriptions:
+        - name: museum-api
+          type: openapi
+          url: openapi.yaml
+        - name: api
+          type: none
+          x-serverUrl: 'http://localhost/api'
+      workflows:
+        - workflowId: get-museum-hours
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: header
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: get-museum-hours
+              description: >-
+                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
+              operationId: museum-api.getMuseumHours
+              successCriteria:
+                - condition: $statusCode == 200
+    `,
+    'arazzo.yaml'
+  );
+
+  it('should report on sourceDescription with type `none`', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'sourceDescription-type': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/sourceDescriptions/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The \`type\` property of the \`sourceDescription\` object must be either \`openapi\` or \`arazzo\`.",
+          "ruleId": "sourceDescription-type",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report on sourceDescription with type `none`', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'sourceDescription-type': 'off' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+});