@lionweb/io-lionweb-mps-specific 0.7.0-alpha.6 → 0.7.0-alpha.8

package/README.md

@@ -8,8 +8,8 @@
 ](https://www.npmjs.com/package/@lionweb/io-lionweb-mps-specific)
 
 This NPM package contains an implementation of the `io.lionweb.mps.specific` language.
-The MPS implementation of that language is part of the `lionweb-mps` plug-in.
-It's used to export MPS-specific language (structure) metadata as part of LionWeb language exports from MPS (in the LionCore M3 format).
+The MPS implementation of that language is part of [the `lionweb-mps` plug-in](https://github.com/LionWeb-io/lionweb-mps/tree/mps2021.3).
+The annotations in this language are used to export MPS-specific language (structure) metadata as part of LionWeb language exports from MPS (in the LionCore M3 format).
 More specifically, this pertains to metadata like the *alias*, *short description*, *documentation*, etc., of a language concept.
 
 It can be added to a TypeScript codebase as follows:
@@ -18,5 +18,17 @@ It can be added to a TypeScript codebase as follows:
 $ npm add @lionweb/io-lionweb-mps-specific
 ```
 
-[//]: # (TODO  document API)
+## API
+
+The API consists of the following things exported from this package:
+
+* The _implementation_ of the language consists of the following classes: `ConceptDescription`, `Deprecated`, `KeyedDescription`, `ShortDescription`, `VirtualPackage`.
+    Also see [this PlantUml diagram](meta/io.lionweb.mps.specific.puml) for some more information.
+* The language is _defined_ through the constant `ioLionWebMpsSpecificLanguage` (of type `Language`).
+    Its classifiers are exported separately through the `ioLionWebMpsSpecificClassifiers` dictionary.
+* The `deserializeLanguagesWithIoLionWebMpsSpecific` function deserializes a LionWeb serialization chunk as an array of `Language`s, potentially being annotated with instances of annotations from the `io.lionweb.mps.specific` language.
+* The `ioLionWebMpsSpecificAnnotationsFrom` function returns the (instances of the) `io.lionweb.mps.specific` language's annotations that annotate the given language element (of type `M3Concept`).
+* The `textualizationOfAnnotationsIn` function renders an textualization of all instances of `io.lionweb.mps.specific` annotations, in the given languages' tree structure.
+    **Note**: only language elements having annotations (at any nesting depth) are rendered.
+    This is useful to get a quick overview of the annotations.
 

package/dist/annotations.d.ts

@@ -1,7 +1,7 @@
-import { M3Node } from "@lionweb/core";
+import { M3Concept } from "@lionweb/core";
 import { IoLionWebMpsSpecificAnnotation } from "./implementation.js";
 /**
  * @return the `io.lionweb.mps.specific` annotations present on the given node.
  */
-export declare const ioLionWebMpsSpecificAnnotationsFrom: (node: M3Node) => IoLionWebMpsSpecificAnnotation[];
+export declare const ioLionWebMpsSpecificAnnotationsFrom: (node: M3Concept) => IoLionWebMpsSpecificAnnotation[];
 //# sourceMappingURL=annotations.d.ts.map

package/dist/annotations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../src/annotations.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AACtC,OAAO,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAA;AAEpE;;GAEG;AACH,eAAO,MAAM,mCAAmC,SAAU,MAAM,KAAG,8BAA8B,EAGwB,CAAA"}
+{"version":3,"file":"annotations.d.ts","sourceRoot":"","sources":["../src/annotations.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AACzC,OAAO,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAA;AAEpE;;GAEG;AACH,eAAO,MAAM,mCAAmC,SAAU,SAAS,KAAG,8BAA8B,EAGqB,CAAA"}

package/dist/annotations.js.map

@@ -1 +1 @@
-{"version":3,"file":"annotations.js","sourceRoot":"","sources":["../src/annotations.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAGtC,OAAO,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAA;AAEpE;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,IAAY,EAAoC,EAAE,CAClG,IAAI;KACC,WAAW;KACX,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,YAAY,8BAA8B,CAAqC,CAAA"}
+{"version":3,"file":"annotations.js","sourceRoot":"","sources":["../src/annotations.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAGtC,OAAO,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAA;AAEpE;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,IAAe,EAAoC,EAAE,CACrG,IAAI;KACC,WAAW;KACX,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,YAAY,8BAA8B,CAAqC,CAAA"}

package/dist/facade.js

@@ -14,7 +14,7 @@
 //
 // SPDX-FileCopyrightText: 2025 TRUMPF Laser SE and other contributors
 // SPDX-License-Identifier: Apache-2.0
-import { areSameClassifiers, areSameLanguages, lioncore, lioncoreInstantiationFacade, updateSettingsNameBased } from "@lionweb/core";
+import { areSameClassifiers, areSameLanguages, lioncore, lioncoreWriter, updateSettingsNameBased } from "@lionweb/core";
 import { ioLionWebMpsSpecificClassifiers, ioLionWebMpsSpecificLanguage } from "./definition.js";
 import { ConceptDescription, Deprecated, KeyedDescription, ShortDescription, VirtualPackage } from "./implementation.js";
 const ioLionWebMpsSpecificFactory = (parent, classifier, id, propertySettings) => {
@@ -62,7 +62,7 @@ export const combinedWriter = {
             return ioLionWebMpsSpecificFactory(parent, classifier, id, propertySettings);
         }
         if (areSameLanguages(classifier.language, lioncore)) {
-            return lioncoreInstantiationFacade.nodeFor(parent, classifier, id, propertySettings);
+            return lioncoreWriter.nodeFor(parent, classifier, id, propertySettings);
         }
         throw new Error(`don't know how to instantiate a ${classifier.name} from language ${classifier.language.name} (${classifier.language.key}, ${classifier.language.version})`);
     },

package/dist/facade.js.map

@@ -1 +1 @@
-{"version":3,"file":"facade.js","sourceRoot":"","sources":["../src/facade.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAEtC,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAGhB,QAAQ,EACR,2BAA2B,EAI3B,uBAAuB,EAC1B,MAAM,eAAe,CAAA;AAGtB,OAAO,EAAE,+BAA+B,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAA;AAC/F,OAAO,EACH,kBAAkB,EAClB,UAAU,EAEV,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACjB,MAAM,qBAAqB,CAAA;AAE5B,MAAM,2BAA2B,GAAG,CAAC,MAAwB,EAAE,UAAsB,EAAE,EAAa,EAAE,gBAAwD,EAAE,EAAE;IAE9J,MAAM,aAAa,GAAG,CAA2C,IAAO,EAAE,GAAG,+BAA4C,EAAE,EAAE;QACzH,+BAA+B,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACrD,IAAI,CAAC,YAAY,CAAC,GAAG,gBAAgB,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,YAAY,CAAC,EAAE,CAA2B,CAAA;QACtH,CAAC,CAAC,CAAA;IACN,CAAC,CAAA;IAED,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACrF,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAA;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,yBAAyB,EAAE,SAAS,CAAC,CAAA;QACzE,OAAO,IAAI,CAAA;IACf,CAAC;IACD,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7E,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAA;QACvC,OAAO,IAAI,CAAA;IACf,CAAC;IACD,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,GAAG,IAAI,gBAAgB,CAAC,EAAE,CAAC,CAAA;QACrC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAA;QACpC,OAAO,IAAI,CAAA;IACf,CAAC;IACD,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,GAAG,IAAI,gBAAgB,CAAC,EAAE,CAAC,CAAA;QACrC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;QAClC,OAAO,IAAI,CAAA;IACf,CAAC;IACD,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,cAAc,CAAC,EAAE,CAAC;QACjF,MAAM,IAAI,GAAG,IAAI,cAAc,CAAC,EAAE,CAAC,CAAA;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAA;IACf,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;AACzE,CAAC,CAAA;AAGD,MAAM,CAAC,MAAM,cAAc,GAAuE;IAC9F,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,EAAK,2EAA2E;IACnH,OAAO,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE;QAClD,IAAI,gBAAgB,CAAC,UAAU,CAAC,QAAQ,EAAE,4BAA4B,CAAC,EAAE,CAAC;YACtE,OAAO,2BAA2B,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAA;QAChF,CAAC;QACD,IAAI,gBAAgB,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;YAClD,OAAO,2BAA2B,CAAC,OAAO,CAAC,MAAmB,EAAE,UAAU,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAA;QACrG,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,CAAC,IAAI,kBAAkB,UAAU,CAAC,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,CAAC,GAAG,KAAK,UAAU,CAAC,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAA;IAChL,CAAC;IACD,eAAe,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACtC,uBAAuB,CAAC,IAA0C,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IACvF,CAAC;CACJ,CAAA"}
+{"version":3,"file":"facade.js","sourceRoot":"","sources":["../src/facade.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAEtC,OAAO,EACH,kBAAkB,EAClB,gBAAgB,EAGhB,QAAQ,EACR,cAAc,EAId,uBAAuB,EAC1B,MAAM,eAAe,CAAA;AAGtB,OAAO,EAAE,+BAA+B,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAA;AAC/F,OAAO,EACH,kBAAkB,EAClB,UAAU,EAEV,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACjB,MAAM,qBAAqB,CAAA;AAE5B,MAAM,2BAA2B,GAAG,CAAC,MAAwB,EAAE,UAAsB,EAAE,EAAa,EAAE,gBAAwD,EAAE,EAAE;IAE9J,MAAM,aAAa,GAAG,CAA2C,IAAO,EAAE,GAAG,+BAA4C,EAAE,EAAE;QACzH,+BAA+B,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACrD,IAAI,CAAC,YAAY,CAAC,GAAG,gBAAgB,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,YAAY,CAAC,EAAE,CAA2B,CAAA;QACtH,CAAC,CAAC,CAAA;IACN,CAAC,CAAA;IAED,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACrF,MAAM,IAAI,GAAG,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAA;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,yBAAyB,EAAE,SAAS,CAAC,CAAA;QACzE,OAAO,IAAI,CAAA;IACf,CAAC;IACD,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7E,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAA;QACvC,OAAO,IAAI,CAAA;IACf,CAAC;IACD,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,GAAG,IAAI,gBAAgB,CAAC,EAAE,CAAC,CAAA;QACrC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAA;QACpC,OAAO,IAAI,CAAA;IACf,CAAC;IACD,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,GAAG,IAAI,gBAAgB,CAAC,EAAE,CAAC,CAAA;QACrC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;QAClC,OAAO,IAAI,CAAA;IACf,CAAC;IACD,IAAI,kBAAkB,CAAC,UAAU,EAAE,+BAA+B,CAAC,cAAc,CAAC,EAAE,CAAC;QACjF,MAAM,IAAI,GAAG,IAAI,cAAc,CAAC,EAAE,CAAC,CAAA;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAA;IACf,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;AACzE,CAAC,CAAA;AAGD,MAAM,CAAC,MAAM,cAAc,GAAuE;IAC9F,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,EAAK,2EAA2E;IACnH,OAAO,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE;QAClD,IAAI,gBAAgB,CAAC,UAAU,CAAC,QAAQ,EAAE,4BAA4B,CAAC,EAAE,CAAC;YACtE,OAAO,2BAA2B,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAA;QAChF,CAAC;QACD,IAAI,gBAAgB,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;YAClD,OAAO,cAAc,CAAC,OAAO,CAAC,MAAmB,EAAE,UAAU,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAA;QACxF,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,CAAC,IAAI,kBAAkB,UAAU,CAAC,QAAQ,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,CAAC,GAAG,KAAK,UAAU,CAAC,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAA;IAChL,CAAC;IACD,eAAe,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACtC,uBAAuB,CAAC,IAA0C,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IACvF,CAAC;CACJ,CAAA"}

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export * from "./annotations.js";
 export * from "./definition.js";
 export * from "./deserializer.js";
 export * from "./implementation.js";
+export * from "./textualizer.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAiBA,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAiBA,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA"}

package/dist/index.js

@@ -18,4 +18,5 @@ export * from "./annotations.js";
 export * from "./definition.js";
 export * from "./deserializer.js";
 export * from "./implementation.js";
+export * from "./textualizer.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAEtC,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAEtC,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA"}

package/dist/textualizer.d.ts

@@ -0,0 +1,8 @@
+import { Language } from "@lionweb/core";
+/**
+ * @return textualization of all instances of io.lionweb.mps.specific annotations, in the given languages' tree structure.
+ * **Note**: only language elements having annotations (at any nesting depth) are rendered.
+ * This is useful to get a quick overview of the annotations.
+ */
+export declare const textualizationOfAnnotationsIn: (languages: Language[]) => string;
+//# sourceMappingURL=textualizer.d.ts.map

package/dist/textualizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textualizer.d.ts","sourceRoot":"","sources":["../src/textualizer.ts"],"names":[],"mappings":"AAiBA,OAAO,EAKH,QAAQ,EAKX,MAAM,eAAe,CAAA;AAsMtB;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,cAAe,QAAQ,EAAE,KAAG,MACH,CAAA"}

package/dist/textualizer.js

@@ -0,0 +1,187 @@
+// Copyright 2025 TRUMPF Laser SE and other contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License")
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-FileCopyrightText: 2025 TRUMPF Laser SE and other contributors
+// SPDX-License-Identifier: Apache-2.0
+import { Classifier, Enumeration, EnumerationLiteral, Feature, Language, LanguageEntity, PrimitiveType } from "@lionweb/core";
+import { indent, withFirstLower } from "@lionweb/textgen-utils";
+import { asString, when } from "littoral-templates";
+import { ConceptDescription, Deprecated, KeyedDescription, ShortDescription, VirtualPackage } from "./implementation.js";
+import { ioLionWebMpsSpecificAnnotationsFrom } from "./annotations.js";
+/**
+ * @return human-readable text of the location/“path to” the given {@link Node node},
+ * which is *assumed* to be a language element – i.e., a {@link M3Concept}.
+ */
+const pathTo = (node) => {
+    if (node instanceof LanguageEntity) {
+        return `${withFirstLower(node.metaType())} ${node.name} in ${pathTo(node.language)}`;
+    }
+    if (node instanceof EnumerationLiteral) {
+        return `literal ${node.name} of ${pathTo(node.enumeration)}`;
+    }
+    if (node instanceof Feature) {
+        return `${withFirstLower(node.metaType())} ${node.name} of ${pathTo(node.classifier)}`;
+    }
+    if (node instanceof Language) {
+        return `language ${node.name}`;
+    }
+    throw new Error(`don't know how to handle an instance of ${node.constructor.name}`);
+};
+/**
+ * @return a textualization of the given io.lionweb.mps.specific annotation.
+ */
+const textualizationOfAnnotation = (annotation) => {
+    const textualizeProperty = (propertyName, displayName) => {
+        const value = annotation[propertyName];
+        return value === undefined
+            ? undefined
+            : `${displayName}: ${value}`;
+    };
+    const textualizePropertiesWithDisplayNames = (properties) => Object.entries(properties)
+        .map(([displayName, propertyName]) => textualizeProperty(propertyName, displayName))
+        .filter((optStr) => optStr !== undefined);
+    const textualizeProperties = (...propertyNames) => propertyNames
+        .map((propertyName) => textualizeProperty(propertyName, propertyName))
+        .filter((optStr) => optStr !== undefined);
+    if (annotation instanceof ConceptDescription) {
+        const fragments = textualizePropertiesWithDisplayNames({ "short description": "conceptShortDescription", "alias": "conceptAlias", "help URL": "helpUrl" });
+        return fragments.length === 0
+            ? `@ConceptDescription: (no info)`
+            : [
+                `@ConceptDescription:`,
+                indent(fragments)
+            ];
+    }
+    if (annotation instanceof Deprecated) {
+        const fragments = textualizeProperties("comment", "build");
+        return fragments.length === 0
+            ? `@Deprecated: (no info)`
+            : [
+                `@Deprecated:`,
+                indent(fragments)
+            ];
+    }
+    if (annotation instanceof KeyedDescription) {
+        const fragments = textualizeProperties("documentation");
+        return (fragments.length === 0 && annotation.seeAlso.length === 0)
+            ? `@KeyedDescription: (no info)`
+            : [
+                `@KeyedDescription: `,
+                indent([
+                    fragments,
+                    when(annotation.seeAlso.length > 0)([
+                        `see also:`,
+                        indent(annotation.seeAlso.map(pathTo))
+                    ])
+                ])
+            ];
+    }
+    if (annotation instanceof ShortDescription) {
+        const fragments = textualizeProperties("description");
+        return fragments.length === 0
+            ? `@ShortDescription: (no info)`
+            : [
+                `@ShortDescription:`,
+                indent(fragments)
+            ];
+    }
+    if (annotation instanceof VirtualPackage) {
+        const fragments = textualizeProperties("name");
+        return fragments.length === 0
+            ? `@VirtualPackage: (no info)`
+            : [
+                `@VirtualPackage:`,
+                indent(fragments)
+            ];
+    }
+    throw new Error(`don't know how to handle an instance of ${annotation.constructor.name}`);
+};
+/**
+ * @return textualization of the given {@link M3Concept language element} provided it either has (1 or more) annotations itself,
+ * or if any of its nested language elements – i.e.: descendants – have (1 or more) annotations.
+ * Otherwise, it returns an empty array `[]`.
+ */
+const textualizationOfAnnotationsInM3Concept = (node) => {
+    const annotations = ioLionWebMpsSpecificAnnotationsFrom(node);
+    if (node instanceof Classifier) {
+        const annotatedFeatures = node.features.flatMap((feature) => textualizationOfAnnotationsInM3Concept(feature));
+        return (annotations.length > 0 || annotatedFeatures.length > 0)
+            ? [
+                `${withFirstLower(node.metaType())} ${node.name}:`,
+                indent([
+                    annotations.map(textualizationOfAnnotation),
+                    annotatedFeatures
+                ])
+            ]
+            : [];
+    }
+    if (node instanceof Enumeration) {
+        const annotatedLiterals = node.literals.flatMap((literal) => textualizationOfAnnotationsInM3Concept(literal));
+        return (annotations.length > 0 || annotatedLiterals.length > 0)
+            ? [
+                `enumeration ${node.name}:`,
+                indent([
+                    annotations.map(textualizationOfAnnotation),
+                    annotatedLiterals
+                ])
+            ]
+            : [];
+    }
+    if (node instanceof EnumerationLiteral) {
+        return annotations.length > 0
+            ? [
+                `enumeration literal ${node.name}:`,
+                indent(annotations.map(textualizationOfAnnotation))
+            ]
+            : [];
+    }
+    if (node instanceof Feature) {
+        return annotations.length > 0
+            ? [
+                `${withFirstLower(node.metaType())} ${node.name}:`,
+                indent(annotations.map(textualizationOfAnnotation))
+            ]
+            : [];
+    }
+    if (node instanceof Language) {
+        const annotatedEntities = node.entities.flatMap((entity) => textualizationOfAnnotationsInM3Concept(entity));
+        return (annotations.length > 0 || annotatedEntities.length > 0)
+            ? [
+                `language ${node.name}:`,
+                indent([
+                    annotations.map(textualizationOfAnnotation),
+                    annotatedEntities
+                ])
+            ]
+            : [];
+    }
+    if (node instanceof PrimitiveType) {
+        return annotations.length > 0
+            ? [
+                `primitive type ${node.name}:`,
+                indent(annotations.map(textualizationOfAnnotation))
+            ]
+            : [];
+    }
+    // can't happen as node has type 'never' at this point, because of type exhaustion,
+    // but need to return a Template:
+    return [];
+};
+/**
+ * @return textualization of all instances of io.lionweb.mps.specific annotations, in the given languages' tree structure.
+ * **Note**: only language elements having annotations (at any nesting depth) are rendered.
+ * This is useful to get a quick overview of the annotations.
+ */
+export const textualizationOfAnnotationsIn = (languages) => asString(languages.map(textualizationOfAnnotationsInM3Concept));
+//# sourceMappingURL=textualizer.js.map

package/dist/textualizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"textualizer.js","sourceRoot":"","sources":["../src/textualizer.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAEtC,OAAO,EACH,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,OAAO,EACP,QAAQ,EACR,cAAc,EAGd,aAAa,EAChB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,EAAE,QAAQ,EAAY,IAAI,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EACH,kBAAkB,EAClB,UAAU,EAEV,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACjB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,mCAAmC,EAAE,MAAM,kBAAkB,CAAA;AAGtE;;;GAGG;AACH,MAAM,MAAM,GAAG,CAAC,IAAU,EAAU,EAAE;IAClC,IAAI,IAAI,YAAY,cAAc,EAAE,CAAC;QACjC,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAA;IACxF,CAAC;IACD,IAAI,IAAI,YAAY,kBAAkB,EAAE,CAAC;QACrC,OAAO,WAAW,IAAI,CAAC,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAA;IAChE,CAAC;IACD,IAAI,IAAI,YAAY,OAAO,EAAE,CAAC;QAC1B,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAA;IAC1F,CAAC;IACD,IAAI,IAAI,YAAY,QAAQ,EAAE,CAAC;QAC3B,OAAO,YAAY,IAAI,CAAC,IAAI,EAAE,CAAA;IAClC,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,2CAA2C,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAA;AACvF,CAAC,CAAA;AAGD;;GAEG;AACH,MAAM,0BAA0B,GAAG,CAAC,UAA0C,EAAY,EAAE;IAExF,MAAM,kBAAkB,GAAG,CAA2C,YAAqB,EAAE,WAAmB,EAAwB,EAAE;QACtI,MAAM,KAAK,GAAI,UAAgB,CAAC,YAAY,CAAC,CAAA;QAC7C,OAAO,KAAK,KAAK,SAAS;YACtB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,GAAG,WAAW,KAAK,KAAK,EAAE,CAAA;IACpC,CAAC,CAAA;IAED,MAAM,oCAAoC,GAAG,CAA2C,UAA6C,EAAY,EAAE,CAC/I,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;SACrB,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;SACnF,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,SAAS,CAAa,CAAA;IAE7D,MAAM,oBAAoB,GAAG,CAA2C,GAAG,aAA0B,EAAY,EAAE,CAC/G,aAAa;SACR,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,kBAAkB,CAAC,YAAY,EAAE,YAAsB,CAAC,CAAC;SAC/E,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,SAAS,CAAa,CAAA;IAG7D,IAAI,UAAU,YAAY,kBAAkB,EAAE,CAAC;QAC3C,MAAM,SAAS,GAAG,oCAAoC,CAAqB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAA;QAC9K,OAAO,SAAS,CAAC,MAAM,KAAK,CAAC;YACzB,CAAC,CAAC,gCAAgC;YAClC,CAAC,CAAC;gBACE,sBAAsB;gBACtB,MAAM,CAAC,SAAS,CAAC;aACpB,CAAA;IACT,CAAC;IAED,IAAI,UAAU,YAAY,UAAU,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,oBAAoB,CAAa,SAAS,EAAE,OAAO,CAAC,CAAA;QACtE,OAAO,SAAS,CAAC,MAAM,KAAK,CAAC;YACzB,CAAC,CAAC,wBAAwB;YAC1B,CAAC,CAAC;gBACE,cAAc;gBACd,MAAM,CAAC,SAAS,CAAC;aACpB,CAAA;IACT,CAAC;IAED,IAAI,UAAU,YAAY,gBAAgB,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,oBAAoB,CAAmB,eAAe,CAAC,CAAA;QACzE,OAAO,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,8BAA8B;YAChC,CAAC,CAAC;gBACE,qBAAqB;gBACrB,MAAM,CAAC;oBACH,SAAS;oBACT,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;wBAChC,WAAW;wBACX,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;qBACzC,CAAC;iBACL,CAAC;aACT,CAAA;IACL,CAAC;IAED,IAAI,UAAU,YAAY,gBAAgB,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,oBAAoB,CAAmB,aAAa,CAAC,CAAA;QACvE,OAAO,SAAS,CAAC,MAAM,KAAK,CAAC;YACzB,CAAC,CAAC,8BAA8B;YAChC,CAAC,CAAC;gBACE,oBAAoB;gBACpB,MAAM,CAAC,SAAS,CAAC;aACpB,CAAA;IACT,CAAC;IAED,IAAI,UAAU,YAAY,cAAc,EAAE,CAAC;QACvC,MAAM,SAAS,GAAG,oBAAoB,CAAiB,MAAM,CAAC,CAAA;QAC9D,OAAO,SAAS,CAAC,MAAM,KAAK,CAAC;YACzB,CAAC,CAAC,4BAA4B;YAC9B,CAAC,CAAC;gBACE,kBAAkB;gBAClB,MAAM,CAAC,SAAS,CAAC;aACpB,CAAA;IACT,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,UAAU,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAA;AAC7F,CAAC,CAAA;AAGD;;;;GAIG;AACH,MAAM,sCAAsC,GAAG,CAAC,IAAe,EAAY,EAAE;IACzE,MAAM,WAAW,GAAG,mCAAmC,CAAC,IAAI,CAAC,CAAA;IAE7D,IAAI,IAAI,YAAY,UAAU,EAAE,CAAC;QAC7B,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,sCAAsC,CAAC,OAAoB,CAAC,CAAC,CAAA;QAC1H,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;YAC3D,CAAC,CAAC;gBACE,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG;gBAClD,MAAM,CAAC;oBACH,WAAW,CAAC,GAAG,CAAC,0BAA0B,CAAC;oBAC3C,iBAAiB;iBACpB,CAAC;aACL;YACD,CAAC,CAAC,EAAE,CAAA;IACZ,CAAC;IAED,IAAI,IAAI,YAAY,WAAW,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,sCAAsC,CAAC,OAAO,CAAC,CAAC,CAAA;QAC7G,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;YAC3D,CAAC,CAAC;gBACE,eAAe,IAAI,CAAC,IAAI,GAAG;gBAC3B,MAAM,CAAC;oBACH,WAAW,CAAC,GAAG,CAAC,0BAA0B,CAAC;oBAC3C,iBAAiB;iBACpB,CAAC;aACL;YACD,CAAC,CAAC,EAAE,CAAA;IACZ,CAAC;IAED,IAAI,IAAI,YAAY,kBAAkB,EAAE,CAAC;QACrC,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC;YACzB,CAAC,CAAC;gBACE,uBAAuB,IAAI,CAAC,IAAI,GAAG;gBACnC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;aACtD;YACD,CAAC,CAAC,EAAE,CAAA;IACZ,CAAC;IAED,IAAI,IAAI,YAAY,OAAO,EAAE,CAAC;QAC1B,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC;YACzB,CAAC,CAAC;gBACE,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG;gBAClD,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;aACtD;YACD,CAAC,CAAC,EAAE,CAAA;IACZ,CAAC;IAED,IAAI,IAAI,YAAY,QAAQ,EAAE,CAAC;QAC3B,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,sCAAsC,CAAC,MAAM,CAAC,CAAC,CAAA;QAC3G,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;YAC3D,CAAC,CAAC;gBACE,YAAY,IAAI,CAAC,IAAI,GAAG;gBACxB,MAAM,CAAC;oBACH,WAAW,CAAC,GAAG,CAAC,0BAA0B,CAAC;oBAC3C,iBAAiB;iBACpB,CAAC;aACL;YACD,CAAC,CAAC,EAAE,CAAA;IACZ,CAAC;IAED,IAAI,IAAI,YAAY,aAAa,EAAE,CAAC;QAChC,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC;YACzB,CAAC,CAAC;gBACE,kBAAkB,IAAI,CAAC,IAAI,GAAG;gBAC9B,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;aACtD;YACD,CAAC,CAAC,EAAE,CAAA;IACZ,CAAC;IAED,mFAAmF;IACnF,iCAAiC;IACjC,OAAO,EAAE,CAAA;AACb,CAAC,CAAA;AAGD;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,SAAqB,EAAU,EAAE,CAC3E,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC,CAAA"}

package/meta/io.lionweb.mps.specific.md

@@ -0,0 +1,35 @@
+```mermaid
+classDiagram
+
+  class ConceptDescription,<<Annotation>> ConceptDescription,ConceptDescription ..> Classifier {
+    +String? conceptAlias
+    +String? conceptShortDescription
+    +String? helpUrl
+  }
+
+  class Deprecated,<<Annotation>> Deprecated,Deprecated ..> IKeyed {
+    +String? comment
+    +String? build
+  }
+
+  class KeyedDescription,<<Annotation>> KeyedDescription,KeyedDescription ..> IKeyed {
+    +String? documentation
+  }
+
+  class ShortDescription,<<Annotation>> ShortDescription,ShortDescription ..> Node {
+    +String? description
+  }
+
+  class VirtualPackage
+  <<Annotation>> VirtualPackage
+  VirtualPackage ..> Node
+  INamed <|.. VirtualPackage
+
+
+
+
+  KeyedDescription "*" --> "*" Node: seeAlso
+
+
+
+```

package/meta/io.lionweb.mps.specific.puml

@@ -0,0 +1,39 @@
+@startuml
+hide empty members
+
+' qualified name: "io.lionweb.mps.specific"
+
+
+annotation ConceptDescription {
+  conceptAlias: String?
+  conceptShortDescription: String?
+  helpUrl: String?
+}
+
+annotation Deprecated {
+  comment: String?
+  build: String?
+}
+
+annotation KeyedDescription {
+  documentation: String?
+}
+
+annotation ShortDescription {
+  description: String?
+}
+
+annotation VirtualPackage implements INamed
+VirtualPackage ..> Node
+
+
+
+' relations:
+
+
+
+KeyedDescription "*" --> "*" Node: seeAlso
+
+
+
+@enduml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lionweb/io-lionweb-mps-specific",
-  "version": "0.7.0-alpha.6",
+  "version": "0.7.0-alpha.8",
   "description": "TypeScript implementation of the io.lionweb.mps.specific language",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,9 +15,10 @@
     "url": "https://github.com/LionWeb-io/lionweb-typescript/issues"
   },
   "dependencies": {
-    "@lionweb/core": "0.7.0-alpha.6",
-    "@lionweb/json": "0.7.0-alpha.6",
-    "@lionweb/ts-utils": "0.7.0-alpha.6",
+    "@lionweb/core": "0.7.0-alpha.8",
+    "@lionweb/json": "0.7.0-alpha.8",
+    "@lionweb/textgen-utils": "0.7.0-alpha.8",
+    "@lionweb/ts-utils": "0.7.0-alpha.8",
     "littoral-templates": "0.3.0",
     "nanoid": "5.0.9"
   },