Merge pull request #22 from Exabyte-io/update/SOF-6251

SOF-6251: custom schema resolving

Author: timurbazhirov

src/JSONSchemasInterface.js

@@ -24,6 +24,14 @@ export class JSONSchemasInterface {
         return schemasCache.get(schemaId);
     }
 
+    /**
+     *
+     * @param {Object} - external schema
+     */
+    static registerSchema(schema) {
+        schemasCache.set(schema.schemaId, schema);
+    }
+
     /**
      * @example <caption>Search by schemaId regex</caption>
      * JSONSchemasInterface.matchSchema({

src/utils/schemas.js

@@ -24,31 +24,35 @@ export const baseSchemas = {
     Unit: "workflow-unit",
 };
 
-const entityMix = [
+export const entityMix = [
     "system-description-object",
     "system-base-entity-set",
     "system-sharing",
     "system-metadata",
     "system-defaultable",
 ];
 
-const subWorkflowMix = ["system-system-name", "system-is-multi-material"];
+export const subWorkflowMix = ["system-system-name", "system-is-multi-material"];
 
-const workflowMix = ["workflow-base-flow", "system-history", "system-is-outdated"];
+export const workflowMix = ["workflow-base-flow", "system-history", "system-is-outdated"];
 
-const bankMaterialMix = ["material-conventional", "system-creator-account"];
+export const bankMaterialMix = ["material-conventional", "system-creator-account"];
 
-const bankWorkflowMix = ["system-creator-account"];
+export const bankWorkflowMix = ["system-creator-account"];
 
-const jobMix = ["system-status", "system-job-extended"];
+export const jobMix = ["system-status", "system-job-extended"];
 
-const unitMix = ["system-unit-extended", "system-status", "workflow-unit-runtime-runtime-items"];
+export const unitMix = [
+    "system-unit-extended",
+    "system-status",
+    "workflow-unit-runtime-runtime-items",
+];
 
-const assignmentUnitMix = ["system-scope"];
+export const assignmentUnitMix = ["system-scope"];
 
-const flavorMix = ["system-is-multi-material"];
+export const flavorMix = ["system-is-multi-material"];
 
-const systemEntityMix = ["system-entity"];
+export const systemEntityMix = ["system-entity"];
 
 export const mixSchemas = {
     Entity: [...entityMix],
@@ -83,3 +87,14 @@ export function getMixSchemasByClassName(className) {
         ? mixSchemas[className].map((schemaId) => JSONSchemasInterface.schemaById(schemaId))
         : [];
 }
+
+/**
+ * Register additional Entity classes to be resolved with jsonSchema property
+ * @param {String} className - class name derived from InMemoryEntity
+ * @param {String} classBaseSchema - base schemaId
+ * @param {Array} classMixSchemas - array of schemaId to mix
+ */
+export function registerClassName(className, classBaseSchema, classMixSchemas) {
+    baseSchemas[className] = classBaseSchema;
+    mixSchemas[className] = classMixSchemas;
+}

tests/JSONSchemasInterface.tests.js

@@ -30,4 +30,18 @@ describe("JSONSchemasInterface", () => {
 
         expect(schema).to.be.an("object");
     });
+
+    it("can find registered schemas", () => {
+        JSONSchemasInterface.registerSchema({
+            schemaId: "test-schema-id",
+            properties: {
+                testProp: {
+                    type: "string",
+                },
+            },
+        });
+
+        const schema = JSONSchemasInterface.schemaById("test-schema-id");
+        expect(schema).to.be.an("object");
+    });
 });

tests/in_memory.tests.js

@@ -1,6 +1,7 @@
 import { expect } from "chai";
 
 import { InMemoryEntity } from "../src/entity/in_memory";
+import { entityMix, registerClassName } from "../src/utils/schemas";
 
 describe("InMemoryEntity", () => {
     const obj = {
@@ -60,4 +61,22 @@ describe("InMemoryEntity", () => {
         expect(Entity.jsonSchema).to.have.nested.property("properties.isDefault"); // check mix schemas
         expect(Entity.jsonSchema).to.have.nested.property("properties.nested.type"); // check custom properties
     });
+
+    it("jsonSchema returns correct registered schema", () => {
+        class RegisteredEntity extends InMemoryEntity {
+            static get customJsonSchemaProperties() {
+                return {
+                    nested: {
+                        type: "string",
+                    },
+                };
+            }
+        }
+
+        registerClassName(RegisteredEntity.name, "system-entity", entityMix);
+
+        expect(RegisteredEntity.jsonSchema).to.be.an("object");
+        expect(RegisteredEntity.jsonSchema).to.have.nested.property("properties.isDefault"); // check mix schemas
+        expect(RegisteredEntity.jsonSchema).to.have.nested.property("properties.nested.type"); // check custom properties
+    });
 });