@redocly/openapi-core 1.23.1 → 1.25.0

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

@@ -0,0 +1,63 @@
+import type { ArazzoRule } from '../../visitors';
+import type { UserContext } from '../../walk';
+
+export const CriteriaUnique: ArazzoRule = () => {
+  return {
+    FailureActionObject: {
+      enter(action, { report, location }: UserContext) {
+        const criterias = action.criteria;
+        const seen = new Set<string>();
+        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 }: UserContext) {
+        const criterias = action.criteria;
+        const seen = new Set<string>();
+        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 }: UserContext) {
+        if (!step.successCriteria) {
+          return;
+        }
+
+        const successCriterias = step.successCriteria;
+        const seen = new Set<string>();
+
+        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);
+          }
+        }
+      },
+    },
+  };
+};

package/src/rules/arazzo/index.ts

@@ -11,6 +11,9 @@ import { ParametersUnique } from './parameters-unique';
 import { StepOnSuccessUnique } from './step-onSuccess-unique';
 import { StepOnFailureUnique } from './step-onFailure-unique';
 import { RequestBodyReplacementsUnique } from './requestBody-replacements-unique';
+import { NoCriteriaXpath } from '../spot/no-criteria-xpath';
+import { NoActionsTypeEnd } from '../spot/no-actions-type-end';
+import { CriteriaUnique } from './criteria-unique';
 
 import type { ArazzoRule } from '../../visitors';
 import type { ArazzoRuleSet } from '../../oas-types';
@@ -29,6 +32,9 @@ export const rules: ArazzoRuleSet<'built-in'> = {
   'step-onSuccess-unique': StepOnSuccessUnique as ArazzoRule,
   'step-onFailure-unique': StepOnFailureUnique as ArazzoRule,
   'requestBody-replacements-unique': RequestBodyReplacementsUnique as ArazzoRule,
+  'no-criteria-xpath': NoCriteriaXpath as ArazzoRule,
+  'no-actions-type-end': NoActionsTypeEnd as ArazzoRule,
+  'criteria-unique': CriteriaUnique as ArazzoRule,
 };
 
 export const preprocessors = {};

package/src/rules/spot/no-actions-type-end.ts

@@ -0,0 +1,27 @@
+import type { ArazzoRule } from '../../visitors';
+import type { UserContext } from '../../walk';
+
+export const NoActionsTypeEnd: ArazzoRule = () => {
+  return {
+    FailureActionObject: {
+      enter(action, { report, location }: UserContext) {
+        if (action.type === 'end') {
+          report({
+            message: 'The `end` type action is not supported by Spot.',
+            location: location.child(['type']),
+          });
+        }
+      },
+    },
+    SuccessActionObject: {
+      enter(action, { report, location }: UserContext) {
+        if (action.type === 'end') {
+          report({
+            message: 'The `end` type action is not supported by Spot.',
+            location: location.child(['type']),
+          });
+        }
+      },
+    },
+  };
+};

package/src/rules/spot/no-criteria-xpath.ts

@@ -0,0 +1,20 @@
+import type { ArazzoRule } from '../../visitors';
+import type { UserContext } from '../../walk';
+
+export const NoCriteriaXpath: ArazzoRule = () => {
+  return {
+    CriterionObject: {
+      enter(criteria, { report, location }: UserContext) {
+        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']),
+          });
+        }
+      },
+    },
+  };
+};

package/src/types/arazzo.ts

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

package/src/types/redocly-yaml.ts

@@ -122,6 +122,9 @@ const builtInArazzoRules = [
   'step-onSuccess-unique',
   'step-onFailure-unique',
   'requestBody-replacements-unique',
+  'no-criteria-xpath',
+  'no-actions-type-end',
+  'criteria-unique',
 ] as const;
 
 export type BuiltInArazzoRuleId = typeof builtInArazzoRules[number];