add ExtractionFacade.supports to try and improve on language composition

LionWeb-io · Oct 14, 2023 · 0ee2f41 · 0ee2f41
1 parent fd6dc3f
commit 0ee2f41
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 8 deletions.
diff --git a/packages/core/src/dynamic-facade.ts b/packages/core/src/dynamic-facade.ts
@@ -17,6 +17,9 @@ export type DynamicNode = Node & {
  * An implementation of {@link ExtractionFacade} for {@link DynamicNode dynamic nodes}.
  */
 export const dynamicExtractionFacade: ExtractionFacade<DynamicNode> = ({
+    supports: (node) =>
+           "classifier" in node && node.classifier instanceof Classifier
+        && "settings" in node && typeof node.settings === "object" && !Array.isArray(node.settings),
     classifierOf: (node) => node.classifier,
     getFeatureValue: (node, feature) =>
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

diff --git a/packages/core/src/facade.ts b/packages/core/src/facade.ts
@@ -21,6 +21,11 @@ type ClassifierDeducer<NT extends Node> = (node: NT) => Classifier
 
 interface ExtractionFacade<NT extends Node> {
 
+    /**
+     * @return Whether the given {@link Node node} belongs to any of the languages supported by this {@link ReadModelAPI API}.
+     */
+    supports: (node: Node) => boolean
+
     /**
      * @return The {@link Concept concept} of the given node
      */

diff --git a/packages/core/src/m3/facade.ts b/packages/core/src/m3/facade.ts
@@ -8,6 +8,7 @@ import {
     Interface,
     Language,
     M3Concept,
+    M3Node,
     PrimitiveType,
     Property,
     Reference
@@ -22,6 +23,7 @@ const {inamed_name} = builtinFeatures
 
 
 export const lioncoreExtractionFacade: ExtractionFacade<M3Concept> = ({
+    supports: (node) => node instanceof M3Node,
     classifierOf: classBasedClassifierDeducerFor(lioncore),
     getFeatureValue: (node, feature) =>
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

diff --git a/packages/core/src/m3/types.ts b/packages/core/src/m3/types.ts
@@ -268,6 +268,7 @@ export {
     PrimitiveType,
     Property,
     Reference,
+    M3Node,
     isINamed,
     isIKeyed,
     lioncoreBuiltinsQName,
@@ -277,7 +278,6 @@ export {
 export type {
     IKeyed,
     INamed,
-    M3Concept,
-    M3Node
+    M3Concept
 }
 
diff --git a/packages/core/src/serializer.ts b/packages/core/src/serializer.ts
@@ -26,6 +26,10 @@ export const serializeNodes = <NT extends Node>(nodes: NT[], extractionFacade: E
             return
         }
 
+        if (!extractionFacade.supports(node)) {
+            throw new Error(`node with id "${node.id}" belongs to a language that's not supported by the ReadModelAPI`)
+        }
+
         const classifier = extractionFacade.classifierOf(node)
         const language = classifier.language
         registerLanguageUsed(language)

diff --git a/packages/test/src/instances/library.ts b/packages/test/src/instances/library.ts
@@ -3,7 +3,8 @@ import {
     Id,
     InstantiationFacade,
     nameBasedClassifierDeducerFor,
-    updateSettingsNameBased
+    Node,
+    updateSettingsNameBased,
 } from "@lionweb/core"
 import {hashingIdGen} from "@lionweb/utilities"
 import {libraryLanguage} from "../languages/library.js"
@@ -25,6 +26,12 @@ export type BaseNode = {
     classifier: string
 }
 
+
+export const isBaseNodeOfAnyOfTypes = (...types: string[]) =>
+    (node: Node) =>
+        "classifier" in node && typeof node.classifier === "string" && types.includes(node.classifier)
+
+
 export type Book = BaseNode & {
     classifier: "Book"
     title: string
@@ -55,6 +62,7 @@ export type SpecialistBookWriter = Writer & BaseNode & {
 
 
 export const libraryExtractionFacade: ExtractionFacade<BaseNode> = {
+    supports: isBaseNodeOfAnyOfTypes("Book", "Library", "GuideBookWriter", "SpecialistBook"),
     classifierOf: (node) => nameBasedClassifierDeducerFor(libraryLanguage)(node.classifier),
     getFeatureValue: (node, feature) =>
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

diff --git a/packages/test/src/instances/multi.ts b/packages/test/src/instances/multi.ts
@@ -1,8 +1,8 @@
 import {hashingIdGen} from "@lionweb/utilities"
 import {ExtractionFacade, nameBasedClassifierDeducerFor, Node} from "@lionweb/core"
-import {multiLanguage} from "../languages/multi.js"
-import {BaseNode, bobLibrary, jackLondon, Library, libraryExtractionFacade} from "./library.js"
 import {libraryLanguage} from "../languages/library.js"
+import {multiLanguage} from "../languages/multi.js"
+import {BaseNode, bobLibrary, isBaseNodeOfAnyOfTypes, jackLondon, Library, libraryExtractionFacade} from "./library.js"
 
 
 export type Container = Node & {
@@ -13,10 +13,12 @@ export type Container = Node & {
 
 export const multiExtractionFacade: ExtractionFacade<BaseNode> = {
     ...libraryExtractionFacade,
+    /* override */ supports: (node) =>
+        libraryExtractionFacade.supports(node) || isBaseNodeOfAnyOfTypes("Container")(node),
     /* override */ classifierOf: (node) =>
-        nameBasedClassifierDeducerFor(libraryLanguage)(node.classifier)
-        ??
-        nameBasedClassifierDeducerFor(multiLanguage)(node.classifier),
+        libraryExtractionFacade.supports(node)
+            ? nameBasedClassifierDeducerFor(libraryLanguage)(node.classifier)
+            : nameBasedClassifierDeducerFor(multiLanguage)(node.classifier),
 }