Merge pull request #67 from Exabyte-io/feature/SOF-6588

Feature/sof-6588 feat: add ConsistencyChecks mixin

Author: VsevolodX

package-lock.json

@@ -56,7 +56,7 @@
         "@babel/preset-react": "7.16.7",
         "@babel/register": "^7.16.0",
         "@babel/runtime-corejs3": "7.16.8",
-        "@exabyte-io/esse.js": "2023.10.31-0",
+        "@exabyte-io/esse.js": "2023.11.1-0",
         "@types/chai": "^4.3.5",
         "@types/crypto-js": "^4.1.1",
         "@types/js-yaml": "^4.0.5",

package.json

@@ -5,6 +5,7 @@ import { FlowchartEntityMixin, FlowchartItemMixin } from "./mixins/flowchart";
 import { HashedInputArrayMixin } from "./mixins/hash";
 import {
     DefaultableMixin,
+    HasConsistencyChecksMixin,
     HasDescriptionMixin,
     HasMetadataMixin,
     HasScopeTrackMixin,
@@ -14,6 +15,7 @@ import {
 import { RuntimeItemsMixin } from "./mixins/runtime_items";
 import {
     DefaultableInMemoryEntity,
+    HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity,
     HasMetadataNamedDefaultableInMemoryEntity,
     NamedDefaultableInMemoryEntity,
     NamedDefaultableRepetitionContextAndRenderInMemoryEntity,
@@ -40,6 +42,8 @@ export {
     NamedDefaultableRepetitionContextAndRenderInMemoryEntity,
     NamedDefaultableRepetitionImportantSettingsInMemoryEntity,
     NamedDefaultableRepetitionRuntimeItemsImportantSettingsContextAndRenderHashedInMemoryEntity,
+    HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity,
+    HasConsistencyChecksMixin,
     DefaultableMixin,
     HasDescriptionMixin,
     HasMetadataMixin,

src/entity/index.ts

@@ -98,3 +98,19 @@ export function NamedEntityMixin<T extends InMemoryEntityConstructor>(superclass
         }
     };
 }
+
+export function HasConsistencyChecksMixin<T extends InMemoryEntityConstructor>(superclass: T) {
+    return class extends superclass {
+        get consistencyChecks(): object[] {
+            return this.prop("consistencyChecks", []);
+        }
+
+        set consistencyChecks(array: object[]) {
+            this.setProp("consistencyChecks", array);
+        }
+
+        addConsistencyChecks(array: object[]) {
+            this.consistencyChecks = [...this.consistencyChecks, ...array];
+        }
+    };
+}

src/entity/mixins/props.ts

@@ -1,7 +1,12 @@
 import { InMemoryEntity } from "./in_memory";
 import { ContextAndRenderFieldsMixin, ImportantSettingsProviderMixin } from "./mixins/context";
 import { HashedEntityMixin } from "./mixins/hash";
-import { DefaultableMixin, HasMetadataMixin, NamedEntityMixin } from "./mixins/props";
+import {
+    DefaultableMixin,
+    HasConsistencyChecksMixin,
+    HasMetadataMixin,
+    NamedEntityMixin,
+} from "./mixins/props";
 import { HasRepetitionMixin } from "./mixins/repetition";
 import { RuntimeItemsUIAllowedMixin, RuntimeItemsUILogicMixin } from "./mixins/runtime_items";
 
@@ -15,6 +20,9 @@ export const HasMetadataNamedDefaultableInMemoryEntity = HasMetadataMixin(
     NamedEntityMixin(DefaultableMixin(InMemoryEntity)),
 );
 
+export const HasConsistencyChecksHasMetadataNamedDefaultableInMemoryEntity =
+    HasConsistencyChecksMixin(HasMetadataNamedDefaultableInMemoryEntity);
+
 export const NamedDefaultableRepetitionImportantSettingsInMemoryEntity =
     ImportantSettingsProviderMixin(
         HasRepetitionMixin(NamedEntityMixin(DefaultableMixin(InMemoryEntity))),