@speclynx/apidom-ns-arazzo-1 1.12.1

package/src/predicates.mjs

@@ -0,0 +1,461 @@
+import { createPredicate } from '@speclynx/apidom-core';
+import { isJSONSchemaElement } from '@speclynx/apidom-ns-json-schema-2020-12';
+
+// Arazzo 1.0.1 elements
+import ArazzoElement from "./elements/Arazzo.mjs";
+import ArazzoSpecification1Element from "./elements/ArazzoSpecification1.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 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"; // NCE types
+import ComponentsFailureActionsElement from "./elements/nces/ComponentsFailureActions.mjs";
+import ComponentsInputsElement from "./elements/nces/ComponentsInputs.mjs";
+import ComponentsParametersElement from "./elements/nces/ComponentsParameters.mjs";
+import ComponentsSuccessActionsElement from "./elements/nces/ComponentsSuccessActions.mjs";
+import FailureActionCriteriaElement from "./elements/nces/FailureActionCriteria.mjs";
+import RequestBodyReplacementsElement from "./elements/nces/RequestBodyReplacements.mjs";
+import SourceDescriptionsElement from "./elements/nces/SourceDescriptions.mjs";
+import StepDependsOnElement from "./elements/nces/StepDependsOn.mjs";
+import StepOnFailureElement from "./elements/nces/StepOnFailure.mjs";
+import StepOnSuccessElement from "./elements/nces/StepOnSuccess.mjs";
+import StepOutputsElement from "./elements/nces/StepOutputs.mjs";
+import StepParametersElement from "./elements/nces/StepParameters.mjs";
+import StepSuccessCriteriaElement from "./elements/nces/StepSuccessCriteria.mjs";
+import SuccessActionCriteriaElement from "./elements/nces/SuccessActionCriteria.mjs";
+import WorkflowDependsOnElement from "./elements/nces/WorkflowDependsOn.mjs";
+import WorkflowFailureActionsElement from "./elements/nces/WorkflowFailureActions.mjs";
+import WorkflowOutputsElement from "./elements/nces/WorkflowOutputs.mjs";
+import WorkflowParametersElement from "./elements/nces/WorkflowParameters.mjs";
+import WorkflowsElement from "./elements/nces/Workflows.mjs";
+import WorkflowStepsElement from "./elements/nces/WorkflowSteps.mjs";
+import WorkflowSuccessActionsElement from "./elements/nces/WorkflowSuccessActions.mjs";
+export { isJSONSchemaElement };
+
+/**
+ * @public
+ */
+export const isArazzoElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof ArazzoElement || hasBasicElementProps(element) && isElementType('arazzo', element) && primitiveEq('string', element);
+});
+
+/**
+ * @public
+ */
+export const isArazzoSpecification1Element = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof ArazzoSpecification1Element || hasBasicElementProps(element) && isElementType('arazzoSpecification1', element) && primitiveEq('object', element) && hasClass('api', element) && hasClass('arazzo', element);
+});
+
+/**
+ * @public
+ */
+export const isComponentsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof ComponentsElement || hasBasicElementProps(element) && isElementType('components', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isCriterionElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof CriterionElement || hasBasicElementProps(element) && isElementType('criterion', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isCriterionExpressionTypeElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof CriterionExpressionTypeElement || hasBasicElementProps(element) && isElementType('criterionExpressionType', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isFailureActionElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof FailureActionElement || hasBasicElementProps(element) && isElementType('failureAction', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isInfoElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof InfoElement || hasBasicElementProps(element) && isElementType('info', element) && primitiveEq('object', element) && hasClass('info', element);
+});
+
+/**
+ * @public
+ */
+export const isParameterElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof ParameterElement || hasBasicElementProps(element) && isElementType('parameter', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isPayloadReplacementElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof PayloadReplacementElement || hasBasicElementProps(element) && isElementType('payloadReplacement', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isRequestBodyElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof RequestBodyElement || hasBasicElementProps(element) && isElementType('requestBody', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isReusableElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof ReusableElement || hasBasicElementProps(element) && isElementType('reusable', element) && primitiveEq('object', element) && hasClass('arazzo-reference', element);
+});
+
+/**
+ * @public
+ */
+export const isSourceDescriptionElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof SourceDescriptionElement || hasBasicElementProps(element) && isElementType('sourceDescription', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isStepElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof StepElement || hasBasicElementProps(element) && isElementType('step', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isSuccessActionElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof SuccessActionElement || hasBasicElementProps(element) && isElementType('successAction', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isWorkflowElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq
+}) => {
+  return element => element instanceof WorkflowElement || hasBasicElementProps(element) && isElementType('workflow', element) && primitiveEq('object', element);
+});
+
+/**
+ * @public
+ */
+export const isComponentsFailureActionsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof ComponentsFailureActionsElement || hasBasicElementProps(element) && isElementType('object', element) && primitiveEq('object', element) && hasClass('components-failure-actions', element);
+});
+
+/**
+ * @public
+ */
+export const isComponentsInputsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof ComponentsInputsElement || hasBasicElementProps(element) && isElementType('object', element) && primitiveEq('object', element) && hasClass('components-inputs', element);
+});
+
+/**
+ * @public
+ */
+export const isComponentsParametersElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof ComponentsParametersElement || hasBasicElementProps(element) && isElementType('object', element) && primitiveEq('object', element) && hasClass('components-parameters', element) && hasClass('parameters', element);
+});
+
+/**
+ * @public
+ */
+export const isComponentsSuccessActionsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof ComponentsSuccessActionsElement || hasBasicElementProps(element) && isElementType('object', element) && primitiveEq('object', element) && hasClass('components-success-actions', element);
+});
+
+/**
+ * @public
+ */
+export const isFailureActionCriteriaElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof FailureActionCriteriaElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('failure-action-criteria', element) && hasClass('criteria', element);
+});
+
+/**
+ * @public
+ */
+export const isRequestBodyReplacementsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof RequestBodyReplacementsElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('request-body-replacements', element);
+});
+
+/**
+ * @public
+ */
+export const isSourceDescriptionsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof SourceDescriptionsElement || hasBasicElementProps(element) && isElementType('sourceDescriptions', element) && primitiveEq('array', element) && hasClass('sourceDescriptions', element);
+});
+
+/**
+ * @public
+ */
+export const isStepDependsOnElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof StepDependsOnElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('step-depends-on', element);
+});
+
+/**
+ * @public
+ */
+export const isStepOnFailureElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof StepOnFailureElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('step-on-failure', element);
+});
+
+/**
+ * @public
+ */
+export const isStepOnSuccessElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof StepOnSuccessElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('step-on-success', element);
+});
+
+/**
+ * @public
+ */
+export const isStepOutputsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof StepOutputsElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('step-outputs', element);
+});
+
+/**
+ * @public
+ */
+export const isStepParametersElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof StepParametersElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('step-parameters', element);
+});
+
+/**
+ * @public
+ */
+export const isStepSuccessCriteriaElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof StepSuccessCriteriaElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('step-success-criteria', element) && hasClass('criteria', element);
+});
+
+/**
+ * @public
+ */
+export const isSuccessActionCriteriaElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof SuccessActionCriteriaElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('success-action-criteria', element) && hasClass('criteria', element);
+});
+
+/**
+ * @public
+ */
+export const isWorkflowDependsOnElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof WorkflowDependsOnElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('workflow-depends-on', element);
+});
+
+/**
+ * @public
+ */
+export const isWorkflowFailureActionsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof WorkflowFailureActionsElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('workflow-failure-actions', element);
+});
+
+/**
+ * @public
+ */
+export const isWorkflowOutputsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof WorkflowOutputsElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('workflow-outputs', element);
+});
+
+/**
+ * @public
+ */
+export const isWorkflowParametersElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof WorkflowParametersElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('workflow-parameters', element) && hasClass('parameters', element);
+});
+
+/**
+ * @public
+ */
+export const isWorkflowsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof WorkflowsElement || hasBasicElementProps(element) && isElementType('workflows', element) && primitiveEq('array', element) && hasClass('workflows', element);
+});
+
+/**
+ * @public
+ */
+export const isWorkflowStepsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof WorkflowStepsElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('workflow-steps', element);
+});
+
+/**
+ * @public
+ */
+export const isWorkflowSuccessActionsElement = createPredicate(({
+  hasBasicElementProps,
+  isElementType,
+  primitiveEq,
+  hasClass
+}) => {
+  return element => element instanceof WorkflowSuccessActionsElement || hasBasicElementProps(element) && isElementType('array', element) && primitiveEq('array', element) && hasClass('workflow-success-actions', element);
+});

package/src/refractor/index.cjs

@@ -0,0 +1,52 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = exports.createRefractor = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _ramda = require("ramda");
+var _specification = _interopRequireDefault(require("./specification.cjs"));
+var _visitor = require("../traversal/visitor.cjs");
+var _toolbox = _interopRequireDefault(require("./toolbox.cjs"));
+/**
+ * @public
+ */
+const refract = (value, {
+  specPath = ['visitors', 'document', 'objects', 'ArazzoSpecification', '$visitor'],
+  plugins = []
+} = {}) => {
+  const element = (0, _apidomCore.refract)(value);
+  const resolvedSpec = (0, _apidomCore.dereference)(_specification.default);
+
+  /**
+   * This is where generic ApiDOM becomes semantic (namespace applied).
+   * We don't allow consumers to hook into this translation.
+   * Though we allow consumers to define their onw plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = (0, _ramda.path)(specPath, resolvedSpec);
+  const rootVisitor = new RootVisitorClass({
+    specObj: resolvedSpec
+  });
+  (0, _apidomCore.visit)(element, rootVisitor);
+
+  /**
+   * Running plugins visitors means extra single traversal === performance hit.
+   */
+  return (0, _apidomCore.dispatchRefractorPlugins)(rootVisitor.element, plugins, {
+    toolboxCreator: _toolbox.default,
+    visitorOptions: {
+      keyMap: _visitor.keyMap,
+      nodeTypeGetter: _visitor.getNodeType
+    }
+  });
+};
+
+/**
+ * @public
+ */
+const createRefractor = specPath => (value, options = {}) => refract(value, {
+  specPath,
+  ...options
+});
+exports.createRefractor = createRefractor;
+var _default = exports.default = refract;

package/src/refractor/index.mjs

@@ -0,0 +1,46 @@
+import { visit, dereference, refract as baseRefract, dispatchRefractorPlugins } from '@speclynx/apidom-core';
+import { path } from 'ramda';
+import specification from "./specification.mjs";
+import { keyMap, getNodeType } from "../traversal/visitor.mjs";
+import createToolbox from "./toolbox.mjs";
+/**
+ * @public
+ */
+const refract = (value, {
+  specPath = ['visitors', 'document', 'objects', 'ArazzoSpecification', '$visitor'],
+  plugins = []
+} = {}) => {
+  const element = baseRefract(value);
+  const resolvedSpec = dereference(specification);
+
+  /**
+   * This is where generic ApiDOM becomes semantic (namespace applied).
+   * We don't allow consumers to hook into this translation.
+   * Though we allow consumers to define their onw plugins on already transformed ApiDOM.
+   */
+  const RootVisitorClass = path(specPath, resolvedSpec);
+  const rootVisitor = new RootVisitorClass({
+    specObj: resolvedSpec
+  });
+  visit(element, rootVisitor);
+
+  /**
+   * Running plugins visitors means extra single traversal === performance hit.
+   */
+  return dispatchRefractorPlugins(rootVisitor.element, plugins, {
+    toolboxCreator: createToolbox,
+    visitorOptions: {
+      keyMap,
+      nodeTypeGetter: getNodeType
+    }
+  });
+};
+
+/**
+ * @public
+ */
+export const createRefractor = specPath => (value, options = {}) => refract(value, {
+  specPath,
+  ...options
+});
+export default refract;

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

@@ -0,0 +1,89 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _Info = _interopRequireDefault(require("../../elements/Info.cjs"));
+var _visitor = require("../../traversal/visitor.cjs");
+/**
+ * Arazzo 1.0.1 specification elements.
+ */
+
+/**
+ * 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 => (0, _apidomCore.isStringElement)(element) && (0, _apidomCore.includesClasses)(['yaml-e-node', 'yaml-e-scalar'], element);
+const schema = {
+  // concrete types handling (CTs)
+  ArazzoSpecification1Element: {
+    info(...args) {
+      return new _Info.default(...args);
+    }
+  }
+};
+const findElementFactory = (ancestor, keyName) => {
+  const elementType = (0, _visitor.getNodeType)(ancestor); // @ts-ignore
+  const keyMapping = schema[elementType] || schema[(0, _apidomCore.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(_apidomCore.isElement);
+      const parentElement = lineage.at(-1);
+      let elementFactory;
+      let context;
+      if ((0, _apidomCore.isArrayElement)(parentElement)) {
+        context = element;
+        elementFactory = findElementFactory(parentElement, '<*>');
+      } else if ((0, _apidomCore.isMemberElement)(parentElement)) {
+        context = lineage.at(-2);
+        elementFactory = findElementFactory(context, (0, _apidomCore.toValue)(parentElement.key));
+      }
+
+      // no element factory found
+      if (typeof elementFactory !== 'function') return undefined;
+      return elementFactory.call({
+        context
+      }, undefined, (0, _apidomCore.cloneDeep)(element.meta), (0, _apidomCore.cloneDeep)(element.attributes));
+    }
+  }
+});
+var _default = exports.default = plugin;