@lionweb/json 0.7.0-beta.8 → 0.7.0

package/dist/version.d.ts

@@ -1,5 +1,5 @@
 /**
- * The <em>current</em> version of the serialization format.
+ * The *current* version of the serialization format.
  */
 export declare const currentSerializationFormatVersion = "2023.1";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,5 +1,5 @@
 /**
- * The <em>current</em> version of the serialization format.
+ * The *current* version of the serialization format.
  */
 export const currentSerializationFormatVersion = "2023.1";
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,29 +1,29 @@
 {
-  "name": "@lionweb/json",
-  "version": "0.7.0-beta.8",
-  "description": "TypeScript types for LionWeb JSON",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "typings": "dist/index.d.ts",
-  "type": "module",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/LionWeb-io/lionweb-typescript.git"
-  },
-  "bugs": {
-    "url": "https://github.com/LionWeb-io/lionweb-typescript/issues"
-  },
-  "scripts": {
-    "clean": "npx rimraf dist node_modules -g lionweb-json-*.tgz",
-    "build": "tsc",
-    "lint": "eslint src",
-    "prep:pre-release": "npm run clean && npm install && npm run build",
-    "prerelease-alpha": "npm run prep:pre-release",
-    "release-alpha": "npm publish --tag alpha",
-    "prerelease-beta": "npm run prep:pre-release",
-    "release-beta": "npm publish --tag beta",
-    "prerelease": "npm run prep:pre-release",
-    "release": "npm publish"
-  }
+    "name": "@lionweb/json",
+    "version": "0.7.0",
+    "description": "TypeScript types for LionWeb JSON",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "typings": "dist/index.d.ts",
+    "type": "module",
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/LionWeb-io/lionweb-typescript.git"
+    },
+    "bugs": {
+        "url": "https://github.com/LionWeb-io/lionweb-typescript/issues"
+    },
+    "scripts": {
+        "clean": "npx rimraf dist node_modules -g lionweb-json-*.tgz",
+        "build": "tsc",
+        "lint": "eslint src",
+        "prep:pre-release": "npm run clean && npm install && npm run build",
+        "prerelease-alpha": "npm run prep:pre-release",
+        "release-alpha": "npm publish --tag alpha",
+        "prerelease-beta": "npm run prep:pre-release",
+        "release-beta": "npm publish --tag beta",
+        "prerelease": "npm run prep:pre-release",
+        "release": "npm publish"
+    }
 }

package/src/functions.ts

@@ -0,0 +1,20 @@
+import { LionWebJsonMetaPointer, LionWebJsonReferenceTarget } from "./types.js"
+
+/**
+ * Tests whether all the properties of the two meta pointers are identical.
+ * @param p1
+ * @param p2
+ */
+export function isEqualMetaPointer(p1: LionWebJsonMetaPointer, p2: LionWebJsonMetaPointer): boolean {
+    return p1.key === p2.key && p1.version === p2.version && p1.language === p2.language
+}
+
+/**
+ * Tests whether all the properties of the two JSON objects are identical.
+ * @param first
+ * @param second
+ */
+export function isEqualReferenceTarget(first: LionWebJsonReferenceTarget, second: LionWebJsonReferenceTarget): boolean {
+    return first.reference === second.reference && first.resolveInfo === second.resolveInfo
+}
+

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./version.js"
+export * from "./types.js"
+export * from "./functions.js"

package/src/types.ts

@@ -0,0 +1,70 @@
+/**
+ * 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.
+ */
+
+/**
+ * LionWebId of LionWeb node.
+ */
+export type LionWebId = string
+
+/**
+ * Key of classifier or feature.
+ */
+export type LionWebKey = string
+
+
+/**
+ * Pointer to a classifier or feature in a version of a language.
+ */
+export type LionWebJsonMetaPointer = {
+    language: LionWebKey
+    version: string
+    /**
+     * The key of the classifier or feature pointed to.
+     */
+    key: LionWebKey
+}
+
+export type LionWebJsonChunk = {
+    serializationFormatVersion: string
+    languages: LionWebJsonUsedLanguage[]
+    nodes: LionWebJsonNode[]
+}
+
+export type LionWebJsonUsedLanguage = {
+    key: LionWebKey
+    version: string
+}
+
+export type LionWebJsonNode = {
+    id: LionWebId
+    classifier: LionWebJsonMetaPointer
+    properties: LionWebJsonProperty[]
+    containments: LionWebJsonContainment[]
+    references: LionWebJsonReference[]
+    annotations: LionWebId[]
+    parent: LionWebId | null
+}
+
+export type LionWebJsonProperty = {
+    property: LionWebJsonMetaPointer
+    value: string | null
+}
+
+export type LionWebJsonContainment = {
+    containment: LionWebJsonMetaPointer
+    children: LionWebId[]
+}
+
+export type LionWebJsonReference = {
+    reference: LionWebJsonMetaPointer
+    targets: LionWebJsonReferenceTarget[]
+}
+
+export type LionWebJsonReferenceTarget = {
+    reference: LionWebId
+    resolveInfo: string | null
+}
+

package/src/version.ts

@@ -0,0 +1,4 @@
+/**
+ * The *current* version of the serialization format.
+ */
+export const currentSerializationFormatVersion = "2023.1"