feat(workflows-1): use JSON Schema 2020-12 namespace

Refs #1822
swagger-api · Jan 26, 2025 · e843473 · e843473
1 parent a69a698
commit e843473
Show file tree

Hide file tree

Showing 15 changed files with 60 additions and 185 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/apidom-ns-workflows-1/package.json b/packages/apidom-ns-workflows-1/package.json
@@ -43,7 +43,7 @@
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.7",
     "@swagger-api/apidom-core": "^1.0.0-beta.10",
-    "@swagger-api/apidom-ns-openapi-3-1": "^1.0.0-beta.10",
+    "@swagger-api/apidom-ns-json-schema-2020-12": "^1.0.0-beta.10",
     "@types/ramda": "~0.30.0",
     "ramda": "~0.30.0",
     "ramda-adjunct": "^5.0.0",

diff --git a/packages/apidom-ns-workflows-1/src/elements/JSONSchema.ts b/packages/apidom-ns-workflows-1/src/elements/JSONSchema.ts
diff --git a/packages/apidom-ns-workflows-1/src/elements/Workflow.ts b/packages/apidom-ns-workflows-1/src/elements/Workflow.ts
@@ -5,8 +5,7 @@ import {
   Attributes,
   Meta,
 } from '@swagger-api/apidom-core';
-
-import JSONSchemaElement from './JSONSchema.ts';
+import { JSONSchemaElement } from '@swagger-api/apidom-ns-json-schema-2020-12';
 
 /**
  * @public

diff --git a/packages/apidom-ns-workflows-1/src/namespace.ts b/packages/apidom-ns-workflows-1/src/namespace.ts
@@ -1,4 +1,5 @@
 import { NamespacePluginOptions } from '@swagger-api/apidom-core';
+import { JSONSchemaElement } from '@swagger-api/apidom-ns-json-schema-2020-12';
 
 import WorkflowsSpecification1Element from './elements/WorkflowsSpecification1.ts';
 import WorkflowsSpecElement from './elements/WorkflowsSpec.ts';
@@ -12,7 +13,6 @@ import FailureActionElement from './elements/FailureAction.ts';
 import ComponentsElement from './elements/Components.ts';
 import CriterionElement from './elements/Criterion.ts';
 import ReferenceElement from './elements/Reference.ts';
-import JSONSchemaElement from './elements/JSONSchema.ts';
 
 /**
  * @public
@@ -33,7 +33,7 @@ const workflows1 = {
     base.register('components', ComponentsElement);
     base.register('criterion', CriterionElement);
     base.register('reference', ReferenceElement);
-    base.register('jSONSchemaDraft202012', JSONSchemaElement);
+    base.register('jSONSchema202012', JSONSchemaElement);
 
     return base;
   },

diff --git a/packages/apidom-ns-workflows-1/src/predicates.ts b/packages/apidom-ns-workflows-1/src/predicates.ts
@@ -1,4 +1,5 @@
 import { createPredicate } from '@swagger-api/apidom-core';
+import { isJSONSchemaElement } from '@swagger-api/apidom-ns-json-schema-2020-12';
 
 import WorkflowsSpecification1Element from './elements/WorkflowsSpecification1.ts';
 import WorkflowsSpecElement from './elements/WorkflowsSpec.ts';
@@ -12,7 +13,6 @@ import FailureActionElement from './elements/FailureAction.ts';
 import ComponentsElement from './elements/Components.ts';
 import CriterionElement from './elements/Criterion.ts';
 import ReferenceElement from './elements/Reference.ts';
-import JSONSchemaElement from './elements/JSONSchema.ts';
 // NCE types
 import WorkflowsElement from './elements/nces/Workflows.ts';
 import SourceDescriptionsElement from './elements/nces/SourceDescriptions.ts';
@@ -27,6 +27,8 @@ import StepOutputsElement from './elements/nces/StepOutputs.ts';
 import SuccessActionCriteriaElement from './elements/nces/SuccessActionCriteria.ts';
 import FailureActionCriteriaElement from './elements/nces/FailureActionCriteria.ts';
 
+export { isJSONSchemaElement };
+
 /**
  * @public
  */
@@ -356,16 +358,3 @@ export const isFailureActionCriteriaElement = createPredicate(
         hasClass('criteria', element));
   },
 );
-
-/**
- * @public
- */
-export const isJSONSchemaElement = createPredicate(
-  ({ hasBasicElementProps, isElementType, primitiveEq }) => {
-    return (element: unknown): element is JSONSchemaElement =>
-      element instanceof JSONSchemaElement ||
-      (hasBasicElementProps(element) &&
-        isElementType('jSONSchemaDraft202012', element) &&
-        primitiveEq('object', element));
-  },
-);
diff --git a/packages/apidom-ns-workflows-1/src/refractor/registration.ts b/packages/apidom-ns-workflows-1/src/refractor/registration.ts
@@ -1,3 +1,5 @@
+import { JSONSchemaElement } from '@swagger-api/apidom-ns-json-schema-2020-12';
+
 import WorkflowsSpecification1Element from '../elements/WorkflowsSpecification1.ts';
 import WorkflowsSpecElement from '../elements/WorkflowsSpec.ts';
 import InfoElement from '../elements/Info.ts';
@@ -10,7 +12,6 @@ import FailureActionElement from '../elements/FailureAction.ts';
 import ComponentsElement from '../elements/Components.ts';
 import CriterionElement from '../elements/Criterion.ts';
 import ReferenceElement from '../elements/Reference.ts';
-import JSONSchemaElement from '../elements/JSONSchema.ts';
 import { createRefractor } from './index.ts';
 
 InfoElement.refract = createRefractor(['visitors', 'document', 'objects', 'Info', '$visitor']);

diff --git a/packages/apidom-ns-workflows-1/src/refractor/specification.ts b/packages/apidom-ns-workflows-1/src/refractor/specification.ts
@@ -1,5 +1,4 @@
-import { omit } from 'ramda';
-import { specificationObj as OpenApi3_1Specification } from '@swagger-api/apidom-ns-openapi-3-1';
+import { specificationObj as jsonSchemaSpecificationObj } from '@swagger-api/apidom-ns-json-schema-2020-12';
 
 import WorkflowsSpecificationVisitor from './visitors/workflows-1/index.ts';
 import WorkflowsSpecVisitor from './visitors/workflows-1/WorkflowsSpecVisitor.ts';
@@ -30,7 +29,6 @@ import ComponentsParametersVisitor from './visitors/workflows-1/components/Param
 import CriterionVisitor from './visitors/workflows-1/criterion/index.ts';
 import ReferenceVisitor from './visitors/workflows-1/reference/index.ts';
 import Reference$RefVisitor from './visitors/workflows-1/reference/$RefVisitor.ts';
-import JSONSchemaVisitor from './visitors/workflows-1/json-schema/index.ts';
 import SpecificationExtensionVisitor from './visitors/SpecificationExtensionVisitor.ts';
 import FallbackVisitor from './visitors/FallbackVisitor.ts';
 
@@ -43,11 +41,7 @@ import FallbackVisitor from './visitors/FallbackVisitor.ts';
  * Note: Specification object allows to use absolute internal JSON pointers.
  */
 
-const { fixedFields: schemaFixedFields } = OpenApi3_1Specification.visitors.document.objects.Schema;
-const jsonSchemaFixedFields = omit(
-  ['discriminator', 'xml', 'externalDocs', 'example'],
-  schemaFixedFields,
-); // getting rid of OAS base dialect keywords
+const { JSONSchema: JSONSchemaVisitor } = jsonSchemaSpecificationObj.visitors.document.objects;
 
 /**
  * @public
@@ -167,19 +161,7 @@ const specification = {
             value: { $ref: '#/visitors/value' },
           },
         },
-        Schema: {
-          /**
-           * Internally the fixed field visitors are using references to `/document/objects/Schema`.
-           * Schema spec make sure it's pointing to our JSONSchema visitor and basically acts like
-           * an alias for it.
-           */
-          $visitor: JSONSchemaVisitor,
-          fixedFields: jsonSchemaFixedFields,
-        },
-        JSONSchema: {
-          $visitor: JSONSchemaVisitor,
-          fixedFields: jsonSchemaFixedFields,
-        },
+        JSONSchema: JSONSchemaVisitor,
       },
       extension: {
         $visitor: SpecificationExtensionVisitor,

diff --git a/packages/apidom-ns-workflows-1/src/refractor/visitors/workflows-1/json-schema/index.ts b/packages/apidom-ns-workflows-1/src/refractor/visitors/workflows-1/json-schema/index.ts
diff --git a/packages/apidom-ns-workflows-1/src/traversal/visitor.ts b/packages/apidom-ns-workflows-1/src/traversal/visitor.ts
@@ -27,6 +27,6 @@ export const keyMap = {
   ComponentsElement: ['content'],
   CriterionElement: ['content'],
   ReferenceElement: ['content'],
-  JSONSchemaDraft202012Element: ['content'],
+  JSONSchema202012Element: ['content'],
   ...keyMapBase,
 };
diff --git a/...ges/apidom-ns-workflows-1/test/refractor/elements/Components/__snapshots__/index.mjs.snap b/...ges/apidom-ns-workflows-1/test/refractor/elements/Components/__snapshots__/index.mjs.snap
@@ -7,7 +7,7 @@ exports[`refractor elements ComponentsElement should refract to semantic ApiDOM
     (ObjectElement
       (MemberElement
         (StringElement)
-        (JSONSchemaDraft202012Element))))
+        (JSONSchema202012Element))))
   (MemberElement
     (StringElement)
     (ObjectElement