@accordproject/concerto-vocabulary 2.0.0-alpha.2 → 2.0.0-beta.1

package/index.js

@@ -21,5 +21,10 @@
  * @module concerto-vocabulary
  */
 
-module.exports.VocabularyManager = require('./lib/vocabularymanager');
-module.exports.Vocabulary = require('./lib/vocabulary');
+const VocabularyManager = require('./lib/vocabularymanager');
+const Vocabulary = require('./lib/vocabulary');
+
+module.exports = {
+    VocabularyManager,
+    Vocabulary
+};

package/lib/vocabularymanager.js

@@ -23,7 +23,7 @@ const Vocabulary = require('./vocabulary');
  * @returns {string} modified string
  */
 function camelCaseToSentence(text) {
-    const result = text.replace( /([A-Z])/g, ' $1' );
+    const result = text.replace(/([A-Z]+)/g, ' $1').trim();
     return result.charAt(0).toUpperCase() + result.slice(1);
 }
 
@@ -57,7 +57,7 @@ class VocabularyManager {
      * @returns {string} the term or null if it does not exist
      */
     static englishMissingTermGenerator(namespace, locale, declarationName, propertyName) {
-        const firstPart = propertyName ? propertyName + ' of the' : '';
+        const firstPart = propertyName ? propertyName.replace('$', '') + ' of the' : '';
         return camelCaseToSentence(firstPart + declarationName);
     }
 
@@ -80,6 +80,7 @@ class VocabularyManager {
     /**
      * Adds a vocabulary to the vocabulary manager
      * @param {string} contents the YAML string for the vocabulary
+     * @returns {Vocabulary} the vocabulary the was added
      */
     addVocabulary(contents) {
         if (!contents) {
@@ -92,6 +93,7 @@ class VocabularyManager {
             throw new Error('Vocabulary has already been added.');
         }
         this.vocabularies[voc.getIdentifier()] = voc;
+        return voc;
     }
 
     /**
@@ -206,10 +208,84 @@ class VocabularyManager {
         }
     }
 
+    /**
+     * Creates a DecoractorCommandSet with @Term decorators
+     * to decorate all model elements based on the vocabulary for a locale.
+     * Pass the return value to the DecoratorManager.decorateModel to apply
+     * the decorators to a ModelManager.
+     * @param {ModelManager} modelManager - the Model Manager
+     * @param {string} locale the BCP-47 locale identifier
+     * @returns {*} the decorator command set used to decorate the model.
+     */
+    generateDecoratorCommands(modelManager, locale) {
+        const decoratorCommandSet = {
+            '$class': 'org.accordproject.decoratorcommands.DecoratorCommandSet',
+            'name': `terms-${locale}`,
+            'version': '1.0.0',
+            'commands': []
+        };
+
+        modelManager.getModelFiles().forEach(model => {
+            model.getAllDeclarations().forEach(decl => {
+                const term = this.resolveTerm(modelManager, model.getNamespace(), locale, decl.getName());
+                if (term) {
+                    decoratorCommandSet.commands.push({
+                        '$class': 'org.accordproject.decoratorcommands.Command',
+                        'type': 'UPSERT',
+                        'target': {
+                            '$class': 'org.accordproject.decoratorcommands.CommandTarget',
+                            'namespace': model.getNamespace(),
+                            'declaration': decl.getName(),
+                        },
+                        'decorator': {
+                            '$class': 'concerto.metamodel.Decorator',
+                            'name': 'Term',
+                            'arguments': [
+                                {
+                                    '$class': 'concerto.metamodel.DecoratorString',
+                                    'value': term
+                                },
+                            ]
+                        }
+                    });
+                }
+
+                decl.getProperties().forEach(property => {
+                    const propertyTerm = this.resolveTerm(modelManager, model.getNamespace(), locale, decl.getName(), property.getName());
+
+                    if (propertyTerm) {
+                        decoratorCommandSet.commands.push({
+                            '$class': 'org.accordproject.decoratorcommands.Command',
+                            'type': 'UPSERT',
+                            'target': {
+                                '$class': 'org.accordproject.decoratorcommands.CommandTarget',
+                                'namespace': model.getNamespace(),
+                                'declaration': decl.getName(),
+                                'property': property.getName()
+                            },
+                            'decorator': {
+                                '$class': 'concerto.metamodel.Decorator',
+                                'name': 'Term',
+                                'arguments': [
+                                    {
+                                        '$class': 'concerto.metamodel.DecoratorString',
+                                        'value': propertyTerm
+                                    },
+                                ]
+                            }
+                        });
+                    }
+                });
+            });
+        });
+        return decoratorCommandSet;
+    }
+
     /**
      * Validates the terms in the vocabulary against the namespaces and declarations
      * within a ModelManager
      * @param {ModelManager} modelManager - the Model Manager
+     * @param {string} locale the BCP-47 locale identifier
      * @returns {*} the result of validation
      */
     validate(modelManager) {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@accordproject/concerto-vocabulary",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-beta.1",
   "description": "Associate human-readable text to model declarations",
   "homepage": "https://github.com/accordproject/concerto",
   "engines": {
-    "node": ">=12",
+    "node": ">=14",
     "npm": ">=6"
   },
   "main": "index.js",
@@ -16,11 +16,12 @@
     "licchk": "license-check-and-add",
     "postlicchk": "npm run doc",
     "doc": "jsdoc --pedantic --recurse -c jsdoc.json",
+    "postdoc": "npm run build:types",
     "test": "nyc mocha --recursive -t 10000",
     "test:watch": "nyc mocha --watch --recursive -t 10000",
     "mocha": "mocha --recursive -t 10000",
     "nyc": "nyc mocha --recursive -t 10000",
-    "build:types": "npx -p typescript tsc ./lib/*.js index.js --declaration --allowJs --emitDeclarationOnly --outDir types"
+    "build:types": "tsc index.js --declaration --allowJs --emitDeclarationOnly --outDir types"
   },
   "repository": {
     "type": "git",
@@ -44,7 +45,8 @@
     "mocha": "8.3.2",
     "nyc": "15.1.0",
     "sinon": "12.0.0",
-    "sinon-chai": "3.7.0"
+    "sinon-chai": "3.7.0",
+    "typescript": "4.6.3"
   },
   "dependencies": {
     "yaml": "2.0.0-9"

package/types/index.d.ts

@@ -1,2 +1,3 @@
-export var VocabularyManager: typeof import("./lib/vocabularymanager");
-export var Vocabulary: typeof import("./lib/vocabulary");
+import VocabularyManager = require("./lib/vocabularymanager");
+import Vocabulary = require("./lib/vocabulary");
+export { VocabularyManager, Vocabulary };

package/types/lib/vocabularymanager.d.ts

@@ -51,8 +51,9 @@ declare class VocabularyManager {
     /**
      * Adds a vocabulary to the vocabulary manager
      * @param {string} contents the YAML string for the vocabulary
+     * @returns {Vocabulary} the vocabulary the was added
      */
-    addVocabulary(contents: string): void;
+    addVocabulary(contents: string): Vocabulary;
     /**
      * Gets a vocabulary for a given namespace plus locale
      * @param {string} namespace the namespace for the vocabulary
@@ -96,10 +97,21 @@ declare class VocabularyManager {
      * @returns {string} the term or null if it does not exist
      */
     getTerm(namespace: string, locale: string, declarationName: string, propertyName?: string): string;
+    /**
+     * Creates a DecoractorCommandSet with @Term decorators
+     * to decorate all model elements based on the vocabulary for a locale.
+     * Pass the return value to the DecoratorManager.decorateModel to apply
+     * the decorators to a ModelManager.
+     * @param {ModelManager} modelManager - the Model Manager
+     * @param {string} locale the BCP-47 locale identifier
+     * @returns {*} the decorator command set used to decorate the model.
+     */
+    generateDecoratorCommands(modelManager: ModelManager, locale: string): any;
     /**
      * Validates the terms in the vocabulary against the namespaces and declarations
      * within a ModelManager
      * @param {ModelManager} modelManager - the Model Manager
+     * @param {string} locale the BCP-47 locale identifier
      * @returns {*} the result of validation
      */
     validate(modelManager: ModelManager): any;