@speclynx/apidom-ns-arazzo-1 1.12.1

package/src/refractor/plugins/replace-empty-element.mjs

@@ -0,0 +1,83 @@
+import { isStringElement, isArrayElement, isElement, isMemberElement, includesClasses, cloneDeep, toValue } from '@speclynx/apidom-core';
+
+/**
+ * Arazzo 1.0.1 specification elements.
+ */
+import InfoElement from "../../elements/Info.mjs";
+import { getNodeType } from "../../traversal/visitor.mjs";
+/**
+ * This plugin is specific to YAML 1.2 format, which allows defining key-value pairs
+ * with empty key, empty value, or both. If the value is not provided in YAML format,
+ * this plugin compensates for this missing value with the most appropriate semantic element type.
+ *
+ * https://yaml.org/spec/1.2.2/#72-empty-nodes
+ *
+ * @example
+ *
+ * ```yaml
+ * arazzo: 1.0.1
+ * info:
+ * ```
+ * Refracting result without this plugin:
+ *
+ *  (ArazzoSpecification1Element
+ *    (MemberElement
+ *      (StringElement)
+ *      (ArazzoElement))
+ *    (MemberElement
+ *      (StringElement)
+ *      (StringElement))
+ *
+ * Refracting result with this plugin:
+ *
+ *  (ArazzoSpecification1Element
+ *    (MemberElement
+ *      (StringElement)
+ *      (ArazzoElement))
+ *    (MemberElement
+ *      (StringElement)
+ *      (InfoElement))
+ */
+const isEmptyElement = element => isStringElement(element) && includesClasses(['yaml-e-node', 'yaml-e-scalar'], element);
+const schema = {
+  // concrete types handling (CTs)
+  ArazzoSpecification1Element: {
+    info(...args) {
+      return new InfoElement(...args);
+    }
+  }
+};
+const findElementFactory = (ancestor, keyName) => {
+  const elementType = getNodeType(ancestor); // @ts-ignore
+  const keyMapping = schema[elementType] || schema[toValue(ancestor.classes.first)];
+  return typeof keyMapping === 'undefined' ? undefined : Object.hasOwn(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
+};
+
+/**
+ * @public
+ */
+const plugin = () => () => ({
+  visitor: {
+    StringElement(element, key, parent, path, ancestors) {
+      if (!isEmptyElement(element)) return undefined;
+      const lineage = [...ancestors, parent].filter(isElement);
+      const parentElement = lineage.at(-1);
+      let elementFactory;
+      let context;
+      if (isArrayElement(parentElement)) {
+        context = element;
+        elementFactory = findElementFactory(parentElement, '<*>');
+      } else if (isMemberElement(parentElement)) {
+        context = lineage.at(-2);
+        elementFactory = findElementFactory(context, toValue(parentElement.key));
+      }
+
+      // no element factory found
+      if (typeof elementFactory !== 'function') return undefined;
+      return elementFactory.call({
+        context
+      }, undefined, cloneDeep(element.meta), cloneDeep(element.attributes));
+    }
+  }
+});
+export default plugin;

package/src/refractor/predicates.cjs

@@ -0,0 +1,17 @@
+"use strict";
+
+exports.__esModule = true;
+exports.isReusableLikeElement = exports.isArazzoSpecificationExtension = void 0;
+var _ramda = require("ramda");
+var _apidomCore = require("@speclynx/apidom-core");
+/**
+ * @public
+ */
+const isArazzoSpecificationExtension = element => {
+  return (0, _apidomCore.isStringElement)(element.key) && (0, _ramda.startsWith)('x-', (0, _apidomCore.toValue)(element.key));
+};
+exports.isArazzoSpecificationExtension = isArazzoSpecificationExtension;
+const isReusableLikeElement = element => {
+  return (0, _apidomCore.isObjectElement)(element) && element.hasKey('reference');
+};
+exports.isReusableLikeElement = isReusableLikeElement;

package/src/refractor/predicates.mjs

@@ -0,0 +1,11 @@
+import { startsWith } from 'ramda';
+import { isStringElement, toValue, isObjectElement } from '@speclynx/apidom-core';
+/**
+ * @public
+ */
+export const isArazzoSpecificationExtension = element => {
+  return isStringElement(element.key) && startsWith('x-', toValue(element.key));
+};
+export const isReusableLikeElement = element => {
+  return isObjectElement(element) && element.hasKey('reference');
+};

package/src/refractor/registration.cjs

@@ -0,0 +1,53 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+var _ArazzoSpecification = _interopRequireDefault(require("../elements/ArazzoSpecification1.cjs"));
+exports.ArazzoSpecification1Element = _ArazzoSpecification.default;
+var _Arazzo = _interopRequireDefault(require("../elements/Arazzo.cjs"));
+exports.ArazzoElement = _Arazzo.default;
+var _Components = _interopRequireDefault(require("../elements/Components.cjs"));
+exports.ComponentsElement = _Components.default;
+var _Criterion = _interopRequireDefault(require("../elements/Criterion.cjs"));
+exports.CriterionElement = _Criterion.default;
+var _CriterionExpressionType = _interopRequireDefault(require("../elements/CriterionExpressionType.cjs"));
+exports.CriterionExpressionTypeElement = _CriterionExpressionType.default;
+var _FailureAction = _interopRequireDefault(require("../elements/FailureAction.cjs"));
+exports.FailureActionElement = _FailureAction.default;
+var _Info = _interopRequireDefault(require("../elements/Info.cjs"));
+exports.InfoElement = _Info.default;
+var _JSONSchema = _interopRequireDefault(require("../elements/JSONSchema.cjs"));
+exports.JSONSchemaElement = _JSONSchema.default;
+var _Parameter = _interopRequireDefault(require("../elements/Parameter.cjs"));
+exports.ParameterElement = _Parameter.default;
+var _PayloadReplacement = _interopRequireDefault(require("../elements/PayloadReplacement.cjs"));
+exports.PayloadReplacementElement = _PayloadReplacement.default;
+var _RequestBody = _interopRequireDefault(require("../elements/RequestBody.cjs"));
+exports.RequestBodyElement = _RequestBody.default;
+var _Reusable = _interopRequireDefault(require("../elements/Reusable.cjs"));
+exports.ReusableElement = _Reusable.default;
+var _SourceDescription = _interopRequireDefault(require("../elements/SourceDescription.cjs"));
+exports.SourceDescriptionElement = _SourceDescription.default;
+var _Step = _interopRequireDefault(require("../elements/Step.cjs"));
+exports.StepElement = _Step.default;
+var _SuccessAction = _interopRequireDefault(require("../elements/SuccessAction.cjs"));
+exports.SuccessActionElement = _SuccessAction.default;
+var _Workflow = _interopRequireDefault(require("../elements/Workflow.cjs"));
+exports.WorkflowElement = _Workflow.default;
+var _index = require("./index.cjs");
+_Arazzo.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'ArazzoSpecification', 'fixedFields', 'arazzo']);
+_ArazzoSpecification.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'ArazzoSpecification', '$visitor']);
+_Components.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'Components', '$visitor']);
+_Criterion.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'Criterion', '$visitor']);
+_CriterionExpressionType.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'CriterionExpressionType', '$visitor']);
+_FailureAction.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'FailureAction', '$visitor']);
+_Info.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'Info', '$visitor']);
+_JSONSchema.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'JSONSchema', '$visitor']);
+_Parameter.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'Parameter', '$visitor']);
+_PayloadReplacement.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'PayloadReplacement', '$visitor']);
+_RequestBody.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'RequestBody', '$visitor']);
+_Reusable.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'Reusable', '$visitor']);
+_SourceDescription.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'SourceDescription', '$visitor']);
+_Step.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'Step', '$visitor']);
+_SuccessAction.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'SuccessAction', '$visitor']);
+_Workflow.default.refract = (0, _index.createRefractor)(['visitors', 'document', 'objects', 'Workflow', '$visitor']);

package/src/refractor/registration.mjs

@@ -0,0 +1,34 @@
+import ArazzoSpecification1Element from "../elements/ArazzoSpecification1.mjs";
+import ArazzoElement from "../elements/Arazzo.mjs";
+import ComponentsElement from "../elements/Components.mjs";
+import CriterionElement from "../elements/Criterion.mjs";
+import CriterionExpressionTypeElement from "../elements/CriterionExpressionType.mjs";
+import FailureActionElement from "../elements/FailureAction.mjs";
+import InfoElement from "../elements/Info.mjs";
+import JSONSchemaElement from "../elements/JSONSchema.mjs";
+import ParameterElement from "../elements/Parameter.mjs";
+import PayloadReplacementElement from "../elements/PayloadReplacement.mjs";
+import RequestBodyElement from "../elements/RequestBody.mjs";
+import ReusableElement from "../elements/Reusable.mjs";
+import SourceDescriptionElement from "../elements/SourceDescription.mjs";
+import StepElement from "../elements/Step.mjs";
+import SuccessActionElement from "../elements/SuccessAction.mjs";
+import WorkflowElement from "../elements/Workflow.mjs";
+import { createRefractor } from "./index.mjs";
+ArazzoElement.refract = createRefractor(['visitors', 'document', 'objects', 'ArazzoSpecification', 'fixedFields', 'arazzo']);
+ArazzoSpecification1Element.refract = createRefractor(['visitors', 'document', 'objects', 'ArazzoSpecification', '$visitor']);
+ComponentsElement.refract = createRefractor(['visitors', 'document', 'objects', 'Components', '$visitor']);
+CriterionElement.refract = createRefractor(['visitors', 'document', 'objects', 'Criterion', '$visitor']);
+CriterionExpressionTypeElement.refract = createRefractor(['visitors', 'document', 'objects', 'CriterionExpressionType', '$visitor']);
+FailureActionElement.refract = createRefractor(['visitors', 'document', 'objects', 'FailureAction', '$visitor']);
+InfoElement.refract = createRefractor(['visitors', 'document', 'objects', 'Info', '$visitor']);
+JSONSchemaElement.refract = createRefractor(['visitors', 'document', 'objects', 'JSONSchema', '$visitor']);
+ParameterElement.refract = createRefractor(['visitors', 'document', 'objects', 'Parameter', '$visitor']);
+PayloadReplacementElement.refract = createRefractor(['visitors', 'document', 'objects', 'PayloadReplacement', '$visitor']);
+RequestBodyElement.refract = createRefractor(['visitors', 'document', 'objects', 'RequestBody', '$visitor']);
+ReusableElement.refract = createRefractor(['visitors', 'document', 'objects', 'Reusable', '$visitor']);
+SourceDescriptionElement.refract = createRefractor(['visitors', 'document', 'objects', 'SourceDescription', '$visitor']);
+StepElement.refract = createRefractor(['visitors', 'document', 'objects', 'Step', '$visitor']);
+SuccessActionElement.refract = createRefractor(['visitors', 'document', 'objects', 'SuccessAction', '$visitor']);
+WorkflowElement.refract = createRefractor(['visitors', 'document', 'objects', 'Workflow', '$visitor']);
+export { ArazzoElement, ArazzoSpecification1Element, ComponentsElement, CriterionElement, CriterionExpressionTypeElement, FailureActionElement, InfoElement, JSONSchemaElement, ParameterElement, PayloadReplacementElement, RequestBodyElement, ReusableElement, SourceDescriptionElement, StepElement, SuccessActionElement, WorkflowElement };

package/src/refractor/specification.cjs

@@ -0,0 +1,294 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomNsJsonSchema = require("@speclynx/apidom-ns-json-schema-2020-12");
+var _index = _interopRequireDefault(require("./visitors/arazzo-1/index.cjs"));
+var _ArazzoVisitor = _interopRequireDefault(require("./visitors/arazzo-1/ArazzoVisitor.cjs"));
+var _SourceDescriptionsVisitor = _interopRequireDefault(require("./visitors/arazzo-1/SourceDescriptionsVisitor.cjs"));
+var _WorkflowsVisitor = _interopRequireDefault(require("./visitors/arazzo-1/WorkflowsVisitor.cjs"));
+var _index2 = _interopRequireDefault(require("./visitors/arazzo-1/info/index.cjs"));
+var _VersionVisitor = _interopRequireDefault(require("./visitors/arazzo-1/info/VersionVisitor.cjs"));
+var _index3 = _interopRequireDefault(require("./visitors/arazzo-1/source-description/index.cjs"));
+var _UrlVisitor = _interopRequireDefault(require("./visitors/arazzo-1/source-description/UrlVisitor.cjs"));
+var _index4 = _interopRequireDefault(require("./visitors/arazzo-1/workflow/index.cjs"));
+var _DependsOnVisitor = _interopRequireDefault(require("./visitors/arazzo-1/workflow/DependsOnVisitor.cjs"));
+var _StepsVisitor = _interopRequireDefault(require("./visitors/arazzo-1/workflow/StepsVisitor.cjs"));
+var _SuccessActionsVisitor = _interopRequireDefault(require("./visitors/arazzo-1/workflow/SuccessActionsVisitor.cjs"));
+var _FailureActionsVisitor = _interopRequireDefault(require("./visitors/arazzo-1/workflow/FailureActionsVisitor.cjs"));
+var _OutputsVisitor = _interopRequireDefault(require("./visitors/arazzo-1/workflow/OutputsVisitor.cjs"));
+var _ParametersVisitor = _interopRequireDefault(require("./visitors/arazzo-1/workflow/ParametersVisitor.cjs"));
+var _index5 = _interopRequireDefault(require("./visitors/arazzo-1/step/index.cjs"));
+var _ParametersVisitor2 = _interopRequireDefault(require("./visitors/arazzo-1/step/ParametersVisitor.cjs"));
+var _SuccessCriteriaVisitor = _interopRequireDefault(require("./visitors/arazzo-1/step/SuccessCriteriaVisitor.cjs"));
+var _OnSuccessVisitor = _interopRequireDefault(require("./visitors/arazzo-1/step/OnSuccessVisitor.cjs"));
+var _OnFailureVisitor = _interopRequireDefault(require("./visitors/arazzo-1/step/OnFailureVisitor.cjs"));
+var _OutputsVisitor2 = _interopRequireDefault(require("./visitors/arazzo-1/step/OutputsVisitor.cjs"));
+var _index6 = _interopRequireDefault(require("./visitors/arazzo-1/parameter/index.cjs"));
+var _index7 = _interopRequireDefault(require("./visitors/arazzo-1/success-action/index.cjs"));
+var _CriteriaVisitor = _interopRequireDefault(require("./visitors/arazzo-1/success-action/CriteriaVisitor.cjs"));
+var _index8 = _interopRequireDefault(require("./visitors/arazzo-1/failure-action/index.cjs"));
+var _CriteriaVisitor2 = _interopRequireDefault(require("./visitors/arazzo-1/failure-action/CriteriaVisitor.cjs"));
+var _index9 = _interopRequireDefault(require("./visitors/arazzo-1/components/index.cjs"));
+var _InputsVisitor = _interopRequireDefault(require("./visitors/arazzo-1/components/InputsVisitor.cjs"));
+var _ParametersVisitor3 = _interopRequireDefault(require("./visitors/arazzo-1/components/ParametersVisitor.cjs"));
+var _SuccessActionsVisitor2 = _interopRequireDefault(require("./visitors/arazzo-1/components/SuccessActionsVisitor.cjs"));
+var _FailureActionsVisitor2 = _interopRequireDefault(require("./visitors/arazzo-1/components/FailureActionsVisitor.cjs"));
+var _index0 = _interopRequireDefault(require("./visitors/arazzo-1/reusable/index.cjs"));
+var _ReferenceVisitor = _interopRequireDefault(require("./visitors/arazzo-1/reusable/ReferenceVisitor.cjs"));
+var _index1 = _interopRequireDefault(require("./visitors/arazzo-1/criterion/index.cjs"));
+var _TypeVisitor = _interopRequireDefault(require("./visitors/arazzo-1/criterion/TypeVisitor.cjs"));
+var _index10 = _interopRequireDefault(require("./visitors/arazzo-1/criterion-expression-type/index.cjs"));
+var _VersionVisitor2 = _interopRequireDefault(require("./visitors/arazzo-1/criterion-expression-type/VersionVisitor.cjs"));
+var _index11 = _interopRequireDefault(require("./visitors/arazzo-1/request-body/index.cjs"));
+var _Replacements = _interopRequireDefault(require("./visitors/arazzo-1/request-body/Replacements.cjs"));
+var _index12 = _interopRequireDefault(require("./visitors/arazzo-1/payload-replacement/index.cjs"));
+var _index13 = _interopRequireDefault(require("./visitors/arazzo-1/json-schema/index.cjs"));
+var _SpecificationExtensionVisitor = _interopRequireDefault(require("./visitors/SpecificationExtensionVisitor.cjs"));
+var _FallbackVisitor = _interopRequireDefault(require("./visitors/FallbackVisitor.cjs"));
+const {
+  JSONSchema: {
+    fixedFields: jsonSchemaFixedFields
+  }
+} = _apidomNsJsonSchema.specificationObj.visitors.document.objects;
+
+/**
+ * Specification object allows us to have complete control over visitors
+ * when traversing the ApiDOM.
+ * Specification also allows us to create amended refractors from
+ * existing ones by manipulating it.
+ *
+ * Note: Specification object allows to use absolute internal JSON pointers.
+ */
+
+/**
+ * @public
+ */
+const specification = {
+  visitors: {
+    value: _FallbackVisitor.default,
+    document: {
+      objects: {
+        ArazzoSpecification: {
+          $visitor: _index.default,
+          fixedFields: {
+            arazzo: _ArazzoVisitor.default,
+            info: {
+              $ref: '#/visitors/document/objects/Info'
+            },
+            sourceDescriptions: _SourceDescriptionsVisitor.default,
+            workflows: _WorkflowsVisitor.default,
+            components: {
+              $ref: '#/visitors/document/objects/Components'
+            }
+          }
+        },
+        Info: {
+          $visitor: _index2.default,
+          fixedFields: {
+            title: {
+              $ref: '#/visitors/value'
+            },
+            summary: {
+              $ref: '#/visitors/value'
+            },
+            description: {
+              $ref: '#/visitors/value'
+            },
+            version: _VersionVisitor.default
+          }
+        },
+        SourceDescription: {
+          $visitor: _index3.default,
+          fixedFields: {
+            name: {
+              $ref: '#/visitors/value'
+            },
+            url: _UrlVisitor.default,
+            type: {
+              $ref: '#/visitors/value'
+            }
+          }
+        },
+        Workflow: {
+          $visitor: _index4.default,
+          fixedFields: {
+            workflowId: {
+              $ref: '#/visitors/value'
+            },
+            summary: {
+              $ref: '#/visitors/value'
+            },
+            description: {
+              $ref: '#/visitors/value'
+            },
+            inputs: _index13.default,
+            dependsOn: _DependsOnVisitor.default,
+            steps: _StepsVisitor.default,
+            successActions: _SuccessActionsVisitor.default,
+            failureActions: _FailureActionsVisitor.default,
+            outputs: _OutputsVisitor.default,
+            parameters: _ParametersVisitor.default
+          }
+        },
+        Step: {
+          $visitor: _index5.default,
+          fixedFields: {
+            description: {
+              $ref: '#/visitors/value'
+            },
+            stepId: {
+              $ref: '#/visitors/value'
+            },
+            operationId: {
+              $ref: '#/visitors/value'
+            },
+            operationPath: {
+              $ref: '#/visitors/value'
+            },
+            workflowId: {
+              $ref: '#/visitors/value'
+            },
+            parameters: _ParametersVisitor2.default,
+            requestBody: {
+              $ref: '#/visitors/document/objects/RequestBody'
+            },
+            successCriteria: _SuccessCriteriaVisitor.default,
+            onSuccess: _OnSuccessVisitor.default,
+            onFailure: _OnFailureVisitor.default,
+            outputs: _OutputsVisitor2.default
+          }
+        },
+        Parameter: {
+          $visitor: _index6.default,
+          fixedFields: {
+            name: {
+              $ref: '#/visitors/value'
+            },
+            in: {
+              $ref: '#/visitors/value'
+            },
+            value: {
+              $ref: '#/visitors/value'
+            }
+          }
+        },
+        SuccessAction: {
+          $visitor: _index7.default,
+          fixedFields: {
+            name: {
+              $ref: '#/visitors/value'
+            },
+            type: {
+              $ref: '#/visitors/value'
+            },
+            workflowId: {
+              $ref: '#/visitors/value'
+            },
+            stepId: {
+              $ref: '#/visitors/value'
+            },
+            criteria: _CriteriaVisitor.default
+          }
+        },
+        FailureAction: {
+          $visitor: _index8.default,
+          fixedFields: {
+            name: {
+              $ref: '#/visitors/value'
+            },
+            type: {
+              $ref: '#/visitors/value'
+            },
+            workflowId: {
+              $ref: '#/visitors/value'
+            },
+            stepId: {
+              $ref: '#/visitors/value'
+            },
+            retryAfter: {
+              $ref: '#/visitors/value'
+            },
+            retryLimit: {
+              $ref: '#/visitors/value'
+            },
+            criteria: _CriteriaVisitor2.default
+          }
+        },
+        Components: {
+          $visitor: _index9.default,
+          fixedFields: {
+            inputs: _InputsVisitor.default,
+            parameters: _ParametersVisitor3.default,
+            successActions: _SuccessActionsVisitor2.default,
+            failureActions: _FailureActionsVisitor2.default
+          }
+        },
+        Reusable: {
+          $visitor: _index0.default,
+          fixedFields: {
+            reference: _ReferenceVisitor.default,
+            value: {
+              $ref: '#/visitors/value'
+            }
+          }
+        },
+        Criterion: {
+          $visitor: _index1.default,
+          fixedFields: {
+            context: {
+              $ref: '#/visitors/value'
+            },
+            condition: {
+              $ref: '#/visitors/value'
+            },
+            type: _TypeVisitor.default
+          }
+        },
+        CriterionExpressionType: {
+          $visitor: _index10.default,
+          fixedFields: {
+            type: {
+              $ref: '#/visitors/value'
+            },
+            version: _VersionVisitor2.default
+          }
+        },
+        RequestBody: {
+          $visitor: _index11.default,
+          fixedFields: {
+            contentType: {
+              $ref: '#/visitors/value'
+            },
+            payload: {
+              $ref: '#/visitors/value'
+            },
+            replacements: _Replacements.default
+          }
+        },
+        PayloadReplacement: {
+          $visitor: _index12.default,
+          fixedFields: {
+            target: {
+              $ref: '#/visitors/value'
+            },
+            value: {
+              $ref: '#/visitors/value'
+            }
+          }
+        },
+        JSONSchema: {
+          $visitor: _index13.default,
+          fixedFields: {
+            ...jsonSchemaFixedFields
+          }
+        }
+      },
+      extension: {
+        $visitor: _SpecificationExtensionVisitor.default
+      }
+    }
+  }
+};
+var _default = exports.default = specification;