@redocly/openapi-core 1.23.1 → 1.24.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @redocly/openapi-core
 
+## 1.24.0
+
+### Minor Changes
+
+- Added Spot and Arazzo rules: `no-criteria-xpath`, `no-actions-type-end`, `criteria-unique`.
+
+### Patch Changes
+
+- Updated @redocly/ajv to v8.11.2.
+- Fixed an issue where custom rules were not applied to Arazzo descriptions.
+
 ## 1.23.1
 
 ## 1.23.0

package/lib/config/all.js

@@ -139,6 +139,9 @@ const all = {
         'step-onSuccess-unique': 'error',
         'step-onFailure-unique': 'error',
         'requestBody-replacements-unique': 'error',
+        'no-criteria-xpath': 'error',
+        'no-actions-type-end': 'error',
+        'criteria-unique': 'error',
     },
 };
 exports.default = all;

package/lib/config/config.js

@@ -38,7 +38,10 @@ class StyleguideConfig {
             [oas_types_1.SpecVersion.OAS3_1]: { ...rawConfig.rules, ...rawConfig.oas3_1Rules },
             [oas_types_1.SpecVersion.Async2]: { ...rawConfig.rules, ...rawConfig.async2Rules },
             [oas_types_1.SpecVersion.Async3]: { ...rawConfig.rules, ...rawConfig.async3Rules },
-            [oas_types_1.SpecVersion.Arazzo]: { ...rawConfig.arazzoRules },
+            [oas_types_1.SpecVersion.Arazzo]: {
+                ...rawConfig.arazzoRules,
+                ...(rawConfig.rules?.assertions ? { assertions: rawConfig.rules.assertions } : {}),
+            },
         };
         this.preprocessors = {
             [oas_types_1.SpecVersion.OAS2]: { ...rawConfig.preprocessors, ...rawConfig.oas2Preprocessors },

package/lib/config/minimal.js

@@ -121,6 +121,9 @@ const minimal = {
         'step-onSuccess-unique': 'off',
         'step-onFailure-unique': 'off',
         'requestBody-replacements-unique': 'off',
+        'no-criteria-xpath': 'off',
+        'no-actions-type-end': 'off',
+        'criteria-unique': 'off',
     },
 };
 exports.default = minimal;

package/lib/config/recommended-strict.js

@@ -121,6 +121,9 @@ const recommendedStrict = {
         'step-onSuccess-unique': 'error',
         'step-onFailure-unique': 'error',
         'requestBody-replacements-unique': 'error',
+        'no-criteria-xpath': 'error',
+        'no-actions-type-end': 'error',
+        'criteria-unique': 'error',
     },
 };
 exports.default = recommendedStrict;

package/lib/config/recommended.js

@@ -121,6 +121,9 @@ const recommended = {
         'step-onSuccess-unique': 'warn',
         'step-onFailure-unique': 'warn',
         'requestBody-replacements-unique': 'warn',
+        'no-criteria-xpath': 'warn',
+        'no-actions-type-end': 'warn',
+        'criteria-unique': 'warn',
     },
 };
 exports.default = recommended;

package/lib/rules/arazzo/criteria-unique.d.ts

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

package/lib/rules/arazzo/criteria-unique.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CriteriaUnique = void 0;
+const CriteriaUnique = () => {
+    return {
+        FailureActionObject: {
+            enter(action, { report, location }) {
+                const criterias = action.criteria;
+                const seen = new Set();
+                for (const criteria of criterias) {
+                    const key = JSON.stringify(criteria);
+                    if (seen.has(key)) {
+                        report({
+                            message: 'The FailureAction criteria items must be unique.',
+                            location: location.child(['criteria', criterias.indexOf(criteria)]),
+                        });
+                    }
+                    else {
+                        seen.add(key);
+                    }
+                }
+            },
+        },
+        SuccessActionObject: {
+            enter(action, { report, location }) {
+                const criterias = action.criteria;
+                const seen = new Set();
+                for (const criteria of criterias) {
+                    const key = JSON.stringify(criteria);
+                    if (seen.has(key)) {
+                        report({
+                            message: 'The SuccessAction criteria items must be unique.',
+                            location: location.child(['criteria', criterias.indexOf(criteria)]),
+                        });
+                    }
+                    else {
+                        seen.add(key);
+                    }
+                }
+            },
+        },
+        Step: {
+            enter(step, { report, location }) {
+                if (!step.successCriteria) {
+                    return;
+                }
+                const successCriterias = step.successCriteria;
+                const seen = new Set();
+                for (const criteria of successCriterias) {
+                    const key = JSON.stringify(criteria);
+                    if (seen.has(key)) {
+                        report({
+                            message: 'The Step SuccessCriteria items must be unique.',
+                            location: location.child(['successCriteria', successCriterias.indexOf(criteria)]),
+                        });
+                    }
+                    else {
+                        seen.add(key);
+                    }
+                }
+            },
+        },
+    };
+};
+exports.CriteriaUnique = CriteriaUnique;

package/lib/rules/arazzo/index.js

@@ -14,6 +14,9 @@ const parameters_unique_1 = require("./parameters-unique");
 const step_onSuccess_unique_1 = require("./step-onSuccess-unique");
 const step_onFailure_unique_1 = require("./step-onFailure-unique");
 const requestBody_replacements_unique_1 = require("./requestBody-replacements-unique");
+const no_criteria_xpath_1 = require("../spot/no-criteria-xpath");
+const no_actions_type_end_1 = require("../spot/no-actions-type-end");
+const criteria_unique_1 = require("./criteria-unique");
 exports.rules = {
     spec: spec_1.Spec,
     assertions: assertions_1.Assertions,
@@ -28,5 +31,8 @@ exports.rules = {
     'step-onSuccess-unique': step_onSuccess_unique_1.StepOnSuccessUnique,
     'step-onFailure-unique': step_onFailure_unique_1.StepOnFailureUnique,
     'requestBody-replacements-unique': requestBody_replacements_unique_1.RequestBodyReplacementsUnique,
+    'no-criteria-xpath': no_criteria_xpath_1.NoCriteriaXpath,
+    'no-actions-type-end': no_actions_type_end_1.NoActionsTypeEnd,
+    'criteria-unique': criteria_unique_1.CriteriaUnique,
 };
 exports.preprocessors = {};

package/lib/rules/spot/no-actions-type-end.d.ts

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

package/lib/rules/spot/no-actions-type-end.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoActionsTypeEnd = void 0;
+const NoActionsTypeEnd = () => {
+    return {
+        FailureActionObject: {
+            enter(action, { report, location }) {
+                if (action.type === 'end') {
+                    report({
+                        message: 'The `end` type action is not supported by Spot.',
+                        location: location.child(['type']),
+                    });
+                }
+            },
+        },
+        SuccessActionObject: {
+            enter(action, { report, location }) {
+                if (action.type === 'end') {
+                    report({
+                        message: 'The `end` type action is not supported by Spot.',
+                        location: location.child(['type']),
+                    });
+                }
+            },
+        },
+    };
+};
+exports.NoActionsTypeEnd = NoActionsTypeEnd;

package/lib/rules/spot/no-criteria-xpath.d.ts

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

package/lib/rules/spot/no-criteria-xpath.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoCriteriaXpath = void 0;
+const NoCriteriaXpath = () => {
+    return {
+        CriterionObject: {
+            enter(criteria, { report, location }) {
+                if (!criteria.type) {
+                    return;
+                }
+                if (criteria?.type?.type === 'xpath' || criteria?.type === 'xpath') {
+                    report({
+                        message: 'The `xpath` type criteria is not supported by Spot.',
+                        location: location.child(['type']),
+                    });
+                }
+            },
+        },
+    };
+};
+exports.NoCriteriaXpath = NoCriteriaXpath;

package/lib/types/arazzo.js

@@ -212,7 +212,7 @@ const CriterionObject = {
             else if (typeof value === 'string') {
                 return { enum: ['regex', 'jsonpath', 'simple', 'xpath'] };
             }
-            else if (value.type === 'jsonpath') {
+            else if (value?.type === 'jsonpath') {
                 return 'JSONPathCriterion';
             }
             else {

package/lib/types/redocly-yaml.d.ts

@@ -11,7 +11,7 @@ declare const builtInAsync2Rules: readonly ["spec", "info-contact", "info-licens
 declare const builtInAsync3Rules: readonly ["spec", "info-contact", "info-license-strict", "operation-operationId", "tag-description", "tags-alphabetical", "channels-kebab-case", "no-channel-trailing-slash"];
 export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
 export type BuiltInAsync3RuleId = typeof builtInAsync3Rules[number];
-declare const builtInArazzoRules: readonly ["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"];
+declare const builtInArazzoRules: readonly ["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", "no-criteria-xpath", "no-actions-type-end", "criteria-unique"];
 export type BuiltInArazzoRuleId = typeof builtInArazzoRules[number];
 declare const oas2NodeTypesList: readonly ["Root", "Tag", "TagList", "ExternalDocs", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Paths", "PathItem", "Parameter", "ParameterList", "ParameterItems", "Operation", "Example", "ExamplesMap", "Examples", "Header", "Responses", "Response", "Schema", "Xml", "SchemaProperties", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedSecuritySchemes", "SecurityScheme", "TagGroup", "TagGroups", "EnumDescriptions", "Logo", "XCodeSample", "XCodeSampleList", "XServer", "XServerList"];
 export type Oas2NodeType = typeof oas2NodeTypesList[number];

package/lib/types/redocly-yaml.js

@@ -106,6 +106,9 @@ const builtInArazzoRules = [
     'step-onSuccess-unique',
     'step-onFailure-unique',
     'requestBody-replacements-unique',
+    'no-criteria-xpath',
+    'no-actions-type-end',
+    'criteria-unique',
 ];
 const builtInRules = [
     ...builtInCommonOASRules,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.23.1",
+  "version": "1.24.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -35,7 +35,7 @@
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/ajv": "^8.11.0",
+    "@redocly/ajv": "^8.11.2",
     "@redocly/config": "^0.10.1",
     "colorette": "^1.2.0",
     "https-proxy-agent": "^7.0.4",

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

@@ -5,6 +5,9 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "arazzoDecorators": {},
   "arazzoPreprocessors": {},
   "arazzoRules": {
+    "criteria-unique": "warn",
+    "no-actions-type-end": "warn",
+    "no-criteria-xpath": "warn",
     "parameters-not-in-body": "warn",
     "parameters-unique": "error",
     "requestBody-replacements-unique": "warn",
@@ -147,6 +150,9 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "arazzoDecorators": {},
   "arazzoPreprocessors": {},
   "arazzoRules": {
+    "criteria-unique": "warn",
+    "no-actions-type-end": "warn",
+    "no-criteria-xpath": "warn",
     "parameters-not-in-body": "warn",
     "parameters-unique": "error",
     "requestBody-replacements-unique": "warn",

package/src/config/all.ts

@@ -139,6 +139,9 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'error',
     'step-onFailure-unique': 'error',
     'requestBody-replacements-unique': 'error',
+    'no-criteria-xpath': 'error',
+    'no-actions-type-end': 'error',
+    'criteria-unique': 'error',
   },
 };
 

package/src/config/config.ts

@@ -73,7 +73,10 @@ export class StyleguideConfig {
       [SpecVersion.OAS3_1]: { ...rawConfig.rules, ...rawConfig.oas3_1Rules },
       [SpecVersion.Async2]: { ...rawConfig.rules, ...rawConfig.async2Rules },
       [SpecVersion.Async3]: { ...rawConfig.rules, ...rawConfig.async3Rules },
-      [SpecVersion.Arazzo]: { ...rawConfig.arazzoRules },
+      [SpecVersion.Arazzo]: {
+        ...rawConfig.arazzoRules,
+        ...(rawConfig.rules?.assertions ? { assertions: rawConfig.rules.assertions } : {}),
+      },
     };
 
     this.preprocessors = {

package/src/config/minimal.ts

@@ -121,6 +121,9 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'off',
     'step-onFailure-unique': 'off',
     'requestBody-replacements-unique': 'off',
+    'no-criteria-xpath': 'off',
+    'no-actions-type-end': 'off',
+    'criteria-unique': 'off',
   },
 };
 

package/src/config/recommended-strict.ts

@@ -121,6 +121,9 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'error',
     'step-onFailure-unique': 'error',
     'requestBody-replacements-unique': 'error',
+    'no-criteria-xpath': 'error',
+    'no-actions-type-end': 'error',
+    'criteria-unique': 'error',
   },
 };
 

package/src/config/recommended.ts

@@ -121,6 +121,9 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'step-onSuccess-unique': 'warn',
     'step-onFailure-unique': 'warn',
     'requestBody-replacements-unique': 'warn',
+    'no-criteria-xpath': 'warn',
+    'no-actions-type-end': 'warn',
+    'criteria-unique': 'warn',
   },
 };
 

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

@@ -0,0 +1,161 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Arazzo criteria-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:
+                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 == 200
+                - condition: $statusCode == 200
+                - context: $response.body
+                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
+                  type: jsonpath
+                - context: $response.body
+                  condition: $.name == 'Mermaid Treasure Identification and Analysis'
+                  type: jsonpath
+              onSuccess:
+                - name: 'onSuccessActionName'
+                  type: 'goto'
+                  stepId: 'buy-ticket'
+                  criteria:
+                    - condition: $response.body.open == true
+                    - condition: $response.body.open == true
+              onFailure:
+                - name: 'onFailureActionName'
+                  type: 'goto'
+                  stepId: 'buy-ticket'
+                  criteria:
+                    - condition: $response.body.open == true
+                    - condition: $response.body.open == true
+              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 duplicated criteria exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'criteria-unique': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/successCriteria/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The Step SuccessCriteria items must be unique.",
+          "ruleId": "criteria-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/successCriteria/3",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The Step SuccessCriteria items must be unique.",
+          "ruleId": "criteria-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/onSuccess/0/criteria/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The SuccessAction criteria items must be unique.",
+          "ruleId": "criteria-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/onFailure/0/criteria/1",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The FailureAction criteria items must be unique.",
+          "ruleId": "criteria-unique",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report when the duplicated criteria exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+});

package/src/rules/arazzo/__tests__/no-actions-type-end.test.ts

@@ -0,0 +1,122 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('Arazzo no-actions-type-end', () => {
+  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:
+                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
+              onSuccess:
+                - name: 'onSuccessActionName'
+                  type: 'end'
+                  stepId: 'buy-ticket'
+              onFailure:
+                - name: 'onFailureActionName'
+                  type: 'end'
+                  stepId: 'buy-ticket'
+              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 type `end` action exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'no-actions-type-end': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/onSuccess/0/type",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The \`end\` type action is not supported by Spot.",
+          "ruleId": "no-actions-type-end",
+          "severity": "error",
+          "suggest": [],
+        },
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/steps/0/onFailure/0/type",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The \`end\` type action is not supported by Spot.",
+          "ruleId": "no-actions-type-end",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report when the type `end` action exists', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+});