@lionweb/validation 0.6.1-beta.0 → 0.6.1-beta.1

package/src/json/LionCore_builtins.json

@@ -0,0 +1,231 @@
+{
+  "serializationFormatVersion": "2023.1",
+  "languages": [],
+  "nodes": [
+    {
+      "id": "LionCore-builtins",
+      "classifier": {
+        "language": "LionCore-M3",
+        "version": "2023.1",
+        "key": "Language"
+      },
+      "properties": [
+        {
+          "property": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Language-version"
+          },
+          "value": "2023.1"
+        },
+        {
+          "property": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "IKeyed-key"
+          },
+          "value": "LionCore-builtins"
+        },
+        {
+          "property": {
+            "language": "LionCore-builtins",
+            "version": "2023.1",
+            "key": "LionCore-builtins-INamed-name"
+          },
+          "value": "LionCore_builtins"
+        }
+      ],
+      "containments": [
+        {
+          "containment": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Language-entities"
+          },
+          "children": [
+            "LionCore-builtins-Node",
+            "LionCore-builtins-INamed"
+          ]
+        }
+      ],
+      "references": [
+        {
+          "reference": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Language-dependsOn"
+          },
+          "targets": []
+        }
+      ],
+      "annotations": [],
+      "parent": null
+    },
+    {
+      "id": "LionCore-builtins-Node",
+      "classifier": {
+        "language": "LionCore-M3",
+        "version": "2023.1",
+        "key": "Concept"
+      },
+      "properties": [
+        {
+          "property": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Concept-abstract"
+          },
+          "value": "true"
+        },
+        {
+          "property": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Concept-partition"
+          },
+          "value": "false"
+        },
+        {
+          "property": {
+            "language": "LionCore-builtins",
+            "version": "2023.1",
+            "key": "LionCore-builtins-INamed-name"
+          },
+          "value": "Node"
+        },
+        {
+          "property": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "IKeyed-key"
+          },
+          "value": "LionCore-builtins-Node"
+        }
+      ],
+      "containments": [
+        {
+          "containment": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Classifier-features"
+          },
+          "children": []
+        }
+      ],
+      "references": [
+        {
+          "reference": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Concept-implements"
+          },
+          "targets": []
+        }
+      ],
+      "annotations": [],
+      "parent": "LionCore-builtins"
+    },
+    {
+      "id": "LionCore-builtins-INamed",
+      "classifier": {
+        "language": "LionCore-M3",
+        "version": "2023.1",
+        "key": "Interface"
+      },
+      "properties": [
+        {
+          "property": {
+            "language": "LionCore-builtins",
+            "version": "2023.1",
+            "key": "LionCore-builtins-INamed-name"
+          },
+          "value": "INamed"
+        },
+        {
+          "property": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "IKeyed-key"
+          },
+          "value": "LionCore-builtins-INamed"
+        }
+      ],
+      "containments": [
+        {
+          "containment": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Classifier-features"
+          },
+          "children": [
+            "LionCore-builtins-INamed-name"
+          ]
+        }
+      ],
+      "references": [
+        {
+          "reference": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Interface-extends"
+          },
+          "targets": []
+        }
+      ],
+      "annotations": [],
+      "parent": "LionCore-builtins"
+    },
+    {
+      "id": "LionCore-builtins-INamed-name",
+      "classifier": {
+        "language": "LionCore-M3",
+        "version": "2023.1",
+        "key": "Property"
+      },
+      "properties": [
+        {
+          "property": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Feature-optional"
+          },
+          "value": "false"
+        },
+        {
+          "property": {
+            "language": "LionCore-builtins",
+            "version": "2023.1",
+            "key": "LionCore-builtins-INamed-name"
+          },
+          "value": "name"
+        },
+        {
+          "property": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "IKeyed-key"
+          },
+          "value": "LionCore-builtins-INamed-name"
+        }
+      ],
+      "containments": [],
+      "references": [
+        {
+          "reference": {
+            "language": "LionCore-M3",
+            "version": "2023.1",
+            "key": "Property-type"
+          },
+          "targets": [
+            {
+              "resolveInfo": "String",
+              "reference": "LionCore-builtins-String"
+            }
+          ]
+        }
+      ],
+      "annotations": [],
+      "parent": "LionCore-builtins-INamed"
+    }
+  ]
+}

package/src/json/LionWebJson.ts

@@ -1,30 +1,21 @@
+import { LION_CORE_M3_KEY, LION_CORE_M3_VERSION } from "./M3definitions.js"
+
 /**
  * The types defining the structure of the LionWeb JSON format.
  * @see https://lionweb-io.github.io/specification/serialization/serialization.html
  * We use types instead of classes, because the purpose is to define the Lionweb JSON to be sent over the line.
  */
-export const LION_CORE_BUILTINS_KEY = "LionCore-builtins"
-export const LION_CORE_BUILTINS_INAMED_NAME = "LionCore-builtins-INamed-name"
-export const LION_CORE_M3_KEY = "LionCore-M3"
-export const LION_CORE_M3_NAME = "LionCore_M3"
-export const LION_CORE_M3_VERSION = "2023.1"
 
-export const LIONWEB_BOOLEAN_TYPE = "LionCore-builtins-Boolean"
-export const LIONWEB_JSON_TYPE = "LionCore-builtins-JSON"
-export const LIONWEB_INTEGER_TYPE = "LionCore-builtins-Integer"
-export const LIONWEB_STRING_TYPE = "LionCore-builtins-String"
 
-export const LIONWEB_M3_INAMED_PROPERTY = {
-    language: LION_CORE_BUILTINS_KEY,
-    version: LION_CORE_M3_VERSION,
-    key: LION_CORE_BUILTINS_INAMED_NAME
+export function isLionWebM3Language(language: LwJsonUsedLanguage): boolean {
+    return language.key === LION_CORE_M3_KEY && language.version === LION_CORE_M3_VERSION
 }
 export type LionWebId = string
 
 export type LionWebJsonMetaPointer = {
     language: string
     version: string
-    key: string
+    key: string             // key of concept, property, containment, referenve or property
 }
 
 export function isEqualMetaPointer(p1: LionWebJsonMetaPointer, p2: LionWebJsonMetaPointer): boolean {

package/src/json/LionWebJsonChunkWrapper.ts

@@ -1,36 +1,42 @@
 import {
-    LIONWEB_M3_INAMED_PROPERTY,
+    isEqualMetaPointer,
     LionWebId,
     LionWebJsonChunk,
+    LionWebJsonContainment,
+    LionWebJsonMetaPointer,
     LionWebJsonNode,
-    LionWebJsonProperty
+    LionWebJsonReference
 } from "./LionWebJson.js"
-import { LionWebLanguageDefinition } from "./LionWebLanguageDefinition.js"
+import { MetaPointers } from "./M3definitions.js"
 import { NodeUtils } from "./NodeUtils.js"
 
 /**
- * Wraps around a LionWebJsonChunk, providing access to information inside, using caches to improve performance.
+ * Wraps around a LionWebJsonChunk, providing access to information inside, might be using caches to improve performance.
  * NB Make sure that the contents of the chunk are not changed after creating the wrapper!
+ * NB BE aware that with `pushChunk(...)` the original chunk will be changed.
  */
 export class LionWebJsonChunkWrapper {
     jsonChunk: LionWebJsonChunk
-    language: LionWebLanguageDefinition | null = null
     /**
      * Map to get quick access to nodes by id.
      * @protected
      */
     protected nodesIdMap: Map<LionWebId, LionWebJsonNode> = new Map<LionWebId, LionWebJsonNode>()
 
-    constructor(chunk: unknown) {
-        this.jsonChunk = chunk as LionWebJsonChunk
-        this.prepareNodeIds()
+    /**
+     * Create a wrapper with `chunk` as its chunk
+     * @param chunk
+     */
+    constructor(chunk: LionWebJsonChunk) {
+        this.jsonChunk = chunk
+        this.prepareNodeIds(chunk)
     }
 
     /** Put all nodes in a map, validate that there are no two nodes with the same id.
      *  The check should logically be in LionWebReferenceValidator, but the created map is needed here.
      */
-    prepareNodeIds() {
-        this.jsonChunk.nodes.forEach(node => {
+    prepareNodeIds(chunk: LionWebJsonChunk) {
+        chunk.nodes.forEach(node => {
             this.nodesIdMap.set(node.id, node)
         })
     }
@@ -39,23 +45,44 @@ export class LionWebJsonChunkWrapper {
         return this.nodesIdMap.get(id)
     }
 
-    findNodesOfConcept(conceptKey: string): LionWebJsonNode[] {
-        return this.jsonChunk.nodes.filter(node => node.classifier.key === conceptKey)
+    findNodesOfClassifier(concept: LionWebJsonMetaPointer): LionWebJsonNode[] {
+        return this.jsonChunk.nodes.filter(node => isEqualMetaPointer(node.classifier, concept))
     }
 
-    allProperties(conceptNode: LionWebJsonNode): LionWebJsonProperty[] {
-        const result: LionWebJsonProperty[] = []
-        result.push(...conceptNode.properties)
-        const extendsReference = NodeUtils.findLwReference(conceptNode, "Concept-extends")
-        if (extendsReference !== null) {
-            // extendsReference.targets.forEach(target => {
-            //     // Find the extended concept
-            //     if (this.language !== null) {
-            //         // const targetNode = this.language.languageChunkWrapper.getNode(target.reference);
-            //         // TODO etc., but need to cleanup LanguageDefinition first.
-            //     }
-            // });
+    /**
+     * Return the target nodes inside `reference` as a list of actual nodes (LionWebJsonNode[])
+     * @param reference
+     */
+    getReferredNodes(reference: LionWebJsonReference | undefined) {
+        if (reference === undefined) {
+            return []
         }
+        const result = reference.targets.flatMap(target => {
+            if (target.reference === null) {
+                return []
+            } else {
+                const referredNode = this.getNode(target.reference)
+                return referredNode === undefined ? [] : [referredNode]
+            }
+        })
+        return result
+    }
+
+    /**
+     * Return the target nodes inside `reference` as a list of actual nodes (LionWebJsonNode[])
+     * @param reference
+     */
+    getChildrenAsNodes(containment: LionWebJsonContainment | undefined) {
+        if (containment === undefined) {
+            return []
+        }
+        const result: LionWebJsonNode[] = []
+        containment.children.forEach(ch => {
+            const childNode = this.getNode(ch)
+            if (childNode !== undefined) {
+                result.push(childNode)
+            }
+        })
         return result
     }
 
@@ -71,10 +98,10 @@ export class LionWebJsonChunkWrapper {
 
     private recursiveToString(node: LionWebJsonNode | undefined, depth: number): string {
         if (node === undefined) {
-            return "";
+            return ""
         }
         let result: string = ""
-        const nameProperty = NodeUtils.findProperty(node, LIONWEB_M3_INAMED_PROPERTY)
+        const nameProperty = NodeUtils.findProperty(node, MetaPointers.INamedName)
         const name = nameProperty === undefined ? "" : " " + nameProperty.value
         result += this.indent(depth) + "(" + node.id + ")" + name + "\n"
         if (node.annotations !== undefined && node.annotations.length !== 0) {
@@ -84,9 +111,11 @@ export class LionWebJsonChunkWrapper {
                 // result += this.indent(depth) + "[[" + JSON.stringify(ann) + "]]\n"
             })
         }
-        node.properties.filter(p => p !== nameProperty).forEach(property => {
-            result += this.indent(depth + 1) + "*property* " + property.property.key + ": " + property.value + "\n"
-        })
+        node.properties
+            .filter(p => p !== nameProperty)
+            .forEach(property => {
+                result += this.indent(depth + 1) + "*property* " + property.property.key + ": " + property.value + "\n"
+            })
         node.references.forEach(ref => {
             result += this.indent(depth + 1) + "*" + ref.reference.key + "*: " + JSON.stringify(ref.targets) + "\n"
         })
@@ -100,7 +129,7 @@ export class LionWebJsonChunkWrapper {
         })
         return result
     }
-    
+
     private indent(depth: number): string {
         return Array(depth).join("    ")
     }

package/src/json/M3definitions.ts

@@ -0,0 +1,177 @@
+/**
+ * This file contains LionWeb defined M3 keys and identifications.
+ */
+export const LION_CORE_BUILTINS_INAMED_NAME = "LionCore-builtins-INamed-name"
+export const LION_CORE_BUILTINS_KEY = "LionCore-builtins"
+
+export const LION_CORE_M3_KEY = "LionCore-M3"
+export const LION_CORE_M3_NAME = "LionCore_M3"
+
+export const LION_CORE_M3_VERSION = "2023.1"
+// Builtin datatypes
+export const LIONWEB_BOOLEAN_TYPE = "LionCore-builtins-Boolean"
+export const LIONWEB_JSON_TYPE = "LionCore-builtins-JSON"
+export const LIONWEB_INTEGER_TYPE = "LionCore-builtins-Integer"
+export const LIONWEB_STRING_TYPE = "LionCore-builtins-String"
+
+export const M3_Keys = {
+    Property: "Property",
+    Reference: "Reference",
+    Concept: "Concept",
+    conceptExtends: "Concept-extends",
+    conceptImplements: "Concept-implements",
+    concept2: {
+        key: "Concept",
+        extends: { key: "Concept-extends" },
+        implements: { key: "Concept-implements" }
+    },
+    conceptAbstract: "Concept-abstract",
+    conceptPartition: "Concept-partition",
+    classifierFeatures: "Classifier-features",
+    Interface: "Interface",
+    InterfaceExtends: "Interface-extends",
+    Containment: "Containment",
+    Language: "Language",
+    languageVersion: "Language-version",
+    IKeyedKey: "IKeyed-key",
+    PropertyType: "Property-type",
+    Enumeration: "Enumeration",
+    EnumerationLiterals: "Enumeration-literals",
+    EnumerationLiteral: "EnumerationLiteral",
+    INamed: "LionCore-builtins-INamed",
+    INamedName: "LionCore-builtins-INamed-name",
+    Annotation: "Annotation",
+    AnnotationAnnotates: "Annotation-annotates",
+    AnnotationExtends: "Annotation-extends",
+    AnnotationImplements: "Annotation-implements",
+    Node: "LionCore-builtins-Node"
+}
+
+export const MetaPointers = {
+    Language: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.Language
+    },
+    LanguageVersion: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.languageVersion
+    },
+    ClassifierFeatures: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.classifierFeatures
+    },
+    Concept: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.concept2.key
+    },
+    ConceptAbstract: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.conceptAbstract
+    },
+    ConceptPartition: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.conceptPartition
+    },
+    ConceptExtends: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.concept2.extends.key
+    },
+    ConceptImplements: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.concept2.implements.key
+    },
+    Annotation: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.Annotation
+    },
+    AnnotationAnnotates: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.AnnotationAnnotates
+    },
+    AnnotationExtends: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.AnnotationExtends
+    },
+    AnnotationImplements: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.AnnotationImplements
+    },
+    Interface: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.Interface
+    },
+    InterfaceExtends: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.InterfaceExtends
+    },
+    Enumeration: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.Enumeration
+    },
+    EnumerationLiteral: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.EnumerationLiteral
+    },
+    EnumerationLiterals: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.EnumerationLiterals
+    },
+    Containment: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.Containment
+    },
+    Property: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.Property
+    },
+    PropertyType: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.PropertyType
+    },
+    Reference: {
+        version: LION_CORE_M3_VERSION,
+        language: LION_CORE_M3_KEY,
+        key: M3_Keys.Reference
+    },
+    IKeyedKey: {
+        language: LION_CORE_M3_KEY,
+        version: LION_CORE_M3_VERSION,
+        key: M3_Keys.IKeyedKey
+    },
+    // Builtins:
+    Node: {
+        language: LION_CORE_BUILTINS_KEY,
+        version: LION_CORE_M3_VERSION,
+        key: M3_Keys.Node
+    },
+    INamed: {
+        language: LION_CORE_BUILTINS_KEY,
+        version: LION_CORE_M3_VERSION,
+        key: M3_Keys.INamed
+    },
+    INamedName: {
+        language: LION_CORE_BUILTINS_KEY,
+        version: LION_CORE_M3_VERSION,
+        key: M3_Keys.INamedName
+    }
+}

package/src/json/NodeUtils.ts

@@ -17,16 +17,10 @@ export class NodeUtils {
      * @param node
      * @param key
      */
-    static findLwProperty(node: LionWebJsonNode, key: string): LionWebJsonProperty | null {
-        for (const property of node.properties) {
-            if (property.property.key === key) {
-                return property
-            }
-        }
-        return null
-    }
-
     static findProperty(node: LionWebJsonNode, property: LionWebJsonMetaPointer): LionWebJsonProperty | undefined {
+        if (node === undefined) {
+            return undefined
+        }
         return node.properties.find(
             prop => isEqualMetaPointer(prop.property, property)
         )
@@ -37,56 +31,44 @@ export class NodeUtils {
      * @param node
      * @param key
      */
-    static findLwChild(node: LionWebJsonNode, key: string): LionWebJsonContainment | null {
+    static findChild(node: LionWebJsonNode, key: string): LionWebJsonContainment | undefined {
+        if (node === undefined) {
+            return undefined
+        }
         for (const containment of node.containments) {
             if (containment.containment.key === key) {
                 return containment
             }
         }
-        return null
+        return undefined
     }
 
     static findContainment(node: LionWebJsonNode, containment: LionWebJsonMetaPointer): LionWebJsonContainment | undefined {
-        return node.containments.find(
-            cont => isEqualMetaPointer(cont.containment, containment)
-        )
+        if (node === undefined) {
+            return undefined
+        }
+        return node.containments.find(cont => isEqualMetaPointer(cont.containment, containment))
     }
 
-
-    static findLwReference(node: LionWebJsonNode, key: string): LionWebJsonReference | null {
-        for (const reference of node.references) {
-            if (reference.reference.key === key) {
-                return reference
-            }
+    static findReference(node: LionWebJsonNode, reference: LionWebJsonMetaPointer): LionWebJsonReference | undefined {
+        if (node === undefined) {
+            return undefined
         }
-        return null
+        return node.references.find(ref => isEqualMetaPointer(ref.reference, reference))
     }
 
-    static findLwReferenceTarget(
-        lwReferenceTargets: LionWebJsonReferenceTarget[],
+    static findReferenceTarget(
+        referenceTargets: LionWebJsonReferenceTarget[],
         target: LionWebJsonReferenceTarget,
-    ): LionWebJsonReferenceTarget | null {
-        for (const refTarget of lwReferenceTargets) {
+    ): LionWebJsonReferenceTarget | undefined {
+        for (const refTarget of referenceTargets) {
             if (isEqualReferenceTarget(refTarget, target)) {
                 return refTarget
             }
         }
-        return null
+        return undefined
     }
     
-    /**
-     * Get all nodes that are children for _node_: both the containment and annotation children
-     * @param node
-     */
-    static allDirectChildren(node: LionWebJsonNode): string[] {
-        const result: string[] = []
-        for (const containment of node.containments) {
-            result.push(...containment.children)
-        }
-        result.push(...node.annotations)
-        return result
-    }
-
     static findContainmentContainingChild(containments: LionWebJsonContainment[], childId: string): LionWebJsonContainment | undefined {
         return containments.find(cont => cont.children.includes(childId))
     }

package/src/json/index.ts

@@ -3,5 +3,4 @@ export * from "./NodeUtils.js"
 export * from "./ChunkUtils.js"
 export * from "./LionWebJson.js"
 export * from "./LionWebJsonChunkWrapper.js"
-export * from "./LionWebLanguageDefinition.js"
-export * from "./LanguageUtils.js"
+export * from "./M3definitions.js"