@accordproject/concerto-vocabulary 5.0.0 → 5.2.0

package/dist/esm-browser/{chunk-CKXQ5OWJ.mjs → chunk-LCSHHQ7B.mjs}

@@ -11,7 +11,7 @@ var Vocabulary = class _Vocabulary {
    * @param {VocabularyManager} vocabularyManager - the manager for this vocabulary
    * @param {object} voc - the JSON representation of the vocabulary
    */
-  constructor(vocabularyManager, voc) {
+  constructor(vocabularyManager, voc, options) {
     if (!vocabularyManager) {
       throw new Error("VocabularyManager must be specified");
     }
@@ -27,7 +27,9 @@ var Vocabulary = class _Vocabulary {
     if (!voc.locale) {
       throw new Error("A vocabulary must specify a locale");
     }
-    _Vocabulary.validateLocale(voc.locale);
+    if (!options?.skipLocaleValidation) {
+      _Vocabulary.validateLocale(voc.locale);
+    }
     this.vocabularyManager = vocabularyManager;
     this.content = voc;
   }
@@ -184,4 +186,4 @@ export {
   Vocabulary,
   vocabulary_default
 };
-//# sourceMappingURL=chunk-CKXQ5OWJ.mjs.map
+//# sourceMappingURL=chunk-LCSHHQ7B.mjs.map

package/dist/esm-browser/chunk-LCSHHQ7B.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/vocabulary.ts"],
+  "sourcesContent": ["/*\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ModelFile, ClassDeclaration, Declaration, Property } from '@accordproject/concerto-core';\nimport type VocabularyManager from './vocabularymanager';\n\n/**\n* A vocabulary for a concerto model\n* @class\n* @memberof module:concerto-vocabulary\n*/\nclass Vocabulary {\n    public vocabularyManager: VocabularyManager;\n    public content: any;\n\n    /**\n     * Create the Vocabulary\n     * @constructor\n     * @param {VocabularyManager} vocabularyManager - the manager for this vocabulary\n     * @param {object} voc - the JSON representation of the vocabulary\n     */\n    constructor(vocabularyManager: VocabularyManager, voc: any, options?: { skipLocaleValidation?: boolean }) {\n        if(!vocabularyManager) {\n            throw new Error('VocabularyManager must be specified');\n        }\n        if(!voc) {\n            throw new Error('Vocabulary object must be specified');\n        }\n\n        if(!voc.declarations) {\n            throw new Error('Vocabulary object must have declarations');\n        }\n\n        if(!voc.namespace) {\n            throw new Error('A vocabulary must specify a namespace');\n        }\n\n        if(!voc.locale) {\n            throw new Error('A vocabulary must specify a locale');\n        }\n\n        if (!options?.skipLocaleValidation) {\n            Vocabulary.validateLocale(voc.locale);\n        }\n\n        this.vocabularyManager = vocabularyManager;\n        this.content = voc;\n    }\n\n    /**\n     * Returns the namespace for the vocabulary\n     * @returns {string} the namespace for this vocabulary\n     */\n    getNamespace(): string {\n        return this.content.namespace;\n    }\n\n    /**\n     * Validates a locale\n     * @param {string} locale the locale to validate\n     * @throws {Error} if the locale is invalid\n     */\n    static validateLocale(locale: string) {\n        // @ts-ignore\n        new Intl.Locale(locale);\n        if(locale !== locale.toLowerCase()) {\n            throw new Error('Locale should be lowercase with dashes');\n        }\n    }\n\n    /**\n     * Returns the locale for the vocabulary\n     * @returns {string} the locale for this vocabulary\n     */\n    getLocale(): string {\n        return this.content.locale;\n    }\n\n    /**\n     * Returns the identifier for the vocabulary, composed of the namespace plus the locale\n     * @returns {string} the identifier for this vocabulary\n     */\n    getIdentifier(): string {\n        return `${this.getNamespace()}/${this.content.locale}`;\n    }\n\n    /**\n     * Returns all the declarations for this vocabulary\n     * @returns {Array} an array of objects\n     */\n    getTerms(): any[] {\n        return this.content.declarations;\n    }\n\n    /**\n     * Gets the terms of Namespace\n     * @returns {string} the term or null if it does not exist\n     * @private\n     */\n    getNamespaceTerms(): any {\n        const namespaceTerms = Object.entries(this.content).filter(([key]) => key !== 'namespace' && key !== 'locale' && key !== 'declarations');\n        return namespaceTerms.length > 0 ? Object.fromEntries(namespaceTerms) : null;\n    }\n\n    /**\n     * Gets the term for a concept, enum or property\n     * @param {string} declarationName the name of a concept or enum\n     * @param {string} [propertyName] the name of a property (optional)\n     * @param {string} [identifier] the identifier of the term (optional)\n     * @returns {string|number|boolean|null} the term or null if it does not exist\n     */\n    getTerm(declarationName?: string, propertyName?: string, identifier?: string): string | number | boolean | null {\n        if(!declarationName){\n            const namespaceTerms = this.getNamespaceTerms();\n            return identifier ? namespaceTerms?.[identifier]:namespaceTerms?.term;\n        }\n        const decl = this.content.declarations.find((d: any) => Object.keys(d)[0] === declarationName);\n        if(!decl) {\n            return null;\n        }\n        if(!propertyName) {\n            return identifier ? decl[identifier] : decl[declarationName];\n        }\n        else {\n            const property = decl.properties ? decl.properties.find((d: any) => propertyName in d) : null;\n            return property ? identifier ? property[identifier] : property[propertyName] : null;\n        }\n    }\n\n    /**\n     * Gets the terms for a concept, enum or property\n     * @param {string} declarationName the name of a concept or enum\n     * @param {string} [propertyName] the name of a property (optional)\n     * @returns {string} the term or null if it does not exist\n     */\n    getElementTerms(declarationName: string, propertyName?: string): any {\n        if(!declarationName){\n            return this.getNamespaceTerms();\n        }\n        const decl = this.content.declarations.find((d: any) => Object.keys(d)[0] === declarationName);\n        if(!decl) {\n            return null;\n        }\n        if(!propertyName) {\n            return decl;\n        }\n        else {\n            const property = decl.properties ? decl.properties.find((d: any) => propertyName in d) : null;\n            return property;\n        }\n    }\n\n    /**\n     * Validates a vocabulary against a ModelFile, returning errors for\n     * missing and additional terms.\n     * @param {ModelFile} modelFile the model file for this vocabulary\n     * @returns {*} an object with missingTerms and additionalTerms properties\n     */\n    validate(modelFile: ModelFile): any {\n        const getOwnProperties = (declaration: any) => {\n            // ensures we have a valid return, even for scalars and map-declarations\n            if(declaration.isMapDeclaration()) {\n                return [declaration.getKey(), declaration.getValue()];\n            } else {\n                return declaration.getOwnProperties?.() ? declaration.getOwnProperties?.() : [];\n            }\n        };\n\n        const getPropertyName = (property: any) => {\n            if(property.isKey?.()) {\n                return 'KEY';\n            } else if(property.isValue?.()) {\n                return 'VALUE';\n            } else {\n                return property.getName();\n            }\n        };\n\n        const checkPropertyExists = (k: any, p: any) => {\n            // only reached for keys that getLocalType has already resolved\n            const declaration = modelFile.getLocalType(Object.keys(k)[0]) as ClassDeclaration;\n            const property = Object.keys(p)[0];\n            if(declaration.isMapDeclaration()) {\n                if (property === 'KEY') {\n                    return true;\n                } else if(property === 'VALUE') {\n                    return true;\n                } else {\n                    return false;\n                }\n            } else {\n                return declaration.getOwnProperty(Object.keys(p)[0]);\n            }\n        };\n\n        const result = {\n            missingTerms: modelFile.getAllDeclarations().flatMap( (d: Declaration) => this.getTerm(d.getName())\n                ? getOwnProperties(d).flatMap( (p: Property) => this.getTerm(d.getName(), getPropertyName(p)) ? null : `${d.getName()}.${getPropertyName(p)}`)\n                : d.getName() ).filter( (i: any) => i !== null),\n            additionalTerms: this.content.declarations.flatMap( (k: any) => modelFile.getLocalType(Object.keys(k)[0])\n                ? Array.isArray(k.properties) ? k.properties.flatMap( (p: any) => checkPropertyExists(k, p) ? null : `${Object.keys(k)[0]}.${Object.keys(p)[0]}`) : null\n                : k ).filter( (i: any) => i !== null)\n        };\n\n        if(!this.content.term){\n            result.missingTerms.push('namespace');\n        }\n\n        return result;\n    }\n\n    /**\n     * Converts the object to JSON\n     * @returns {*} the contens of this vocabulary\n     */\n    toJSON() {\n        return this.content;\n    }\n}\n\nexport { Vocabulary };\nexport default Vocabulary;\n"],
+  "mappings": ";;;;;AAAA;AAsBA,IAAM,aAAN,MAAM,YAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUb,YAAY,mBAAsC,KAAU,SAA8C;AACtG,QAAG,CAAC,mBAAmB;AACnB,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACzD;AACA,QAAG,CAAC,KAAK;AACL,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACzD;AAEA,QAAG,CAAC,IAAI,cAAc;AAClB,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC9D;AAEA,QAAG,CAAC,IAAI,WAAW;AACf,YAAM,IAAI,MAAM,uCAAuC;AAAA,IAC3D;AAEA,QAAG,CAAC,IAAI,QAAQ;AACZ,YAAM,IAAI,MAAM,oCAAoC;AAAA,IACxD;AAEA,QAAI,CAAC,SAAS,sBAAsB;AAChC,kBAAW,eAAe,IAAI,MAAM;AAAA,IACxC;AAEA,SAAK,oBAAoB;AACzB,SAAK,UAAU;AAAA,EACnB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,eAAuB;AACnB,WAAO,KAAK,QAAQ;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,eAAe,QAAgB;AAElC,QAAI,KAAK,OAAO,MAAM;AACtB,QAAG,WAAW,OAAO,YAAY,GAAG;AAChC,YAAM,IAAI,MAAM,wCAAwC;AAAA,IAC5D;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAoB;AAChB,WAAO,KAAK,QAAQ;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAwB;AACpB,WAAO,GAAG,KAAK,aAAa,CAAC,IAAI,KAAK,QAAQ,MAAM;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAkB;AACd,WAAO,KAAK,QAAQ;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,oBAAyB;AACrB,UAAM,iBAAiB,OAAO,QAAQ,KAAK,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM,QAAQ,eAAe,QAAQ,YAAY,QAAQ,cAAc;AACvI,WAAO,eAAe,SAAS,IAAI,OAAO,YAAY,cAAc,IAAI;AAAA,EAC5E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,QAAQ,iBAA0B,cAAuB,YAAuD;AAC5G,QAAG,CAAC,iBAAgB;AAChB,YAAM,iBAAiB,KAAK,kBAAkB;AAC9C,aAAO,aAAa,iBAAiB,UAAU,IAAE,gBAAgB;AAAA,IACrE;AACA,UAAM,OAAO,KAAK,QAAQ,aAAa,KAAK,CAAC,MAAW,OAAO,KAAK,CAAC,EAAE,CAAC,MAAM,eAAe;AAC7F,QAAG,CAAC,MAAM;AACN,aAAO;AAAA,IACX;AACA,QAAG,CAAC,cAAc;AACd,aAAO,aAAa,KAAK,UAAU,IAAI,KAAK,eAAe;AAAA,IAC/D,OACK;AACD,YAAM,WAAW,KAAK,aAAa,KAAK,WAAW,KAAK,CAAC,MAAW,gBAAgB,CAAC,IAAI;AACzF,aAAO,WAAW,aAAa,SAAS,UAAU,IAAI,SAAS,YAAY,IAAI;AAAA,IACnF;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,gBAAgB,iBAAyB,cAA4B;AACjE,QAAG,CAAC,iBAAgB;AAChB,aAAO,KAAK,kBAAkB;AAAA,IAClC;AACA,UAAM,OAAO,KAAK,QAAQ,aAAa,KAAK,CAAC,MAAW,OAAO,KAAK,CAAC,EAAE,CAAC,MAAM,eAAe;AAC7F,QAAG,CAAC,MAAM;AACN,aAAO;AAAA,IACX;AACA,QAAG,CAAC,cAAc;AACd,aAAO;AAAA,IACX,OACK;AACD,YAAM,WAAW,KAAK,aAAa,KAAK,WAAW,KAAK,CAAC,MAAW,gBAAgB,CAAC,IAAI;AACzF,aAAO;AAAA,IACX;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,SAAS,WAA2B;AAChC,UAAM,mBAAmB,CAAC,gBAAqB;AAE3C,UAAG,YAAY,iBAAiB,GAAG;AAC/B,eAAO,CAAC,YAAY,OAAO,GAAG,YAAY,SAAS,CAAC;AAAA,MACxD,OAAO;AACH,eAAO,YAAY,mBAAmB,IAAI,YAAY,mBAAmB,IAAI,CAAC;AAAA,MAClF;AAAA,IACJ;AAEA,UAAM,kBAAkB,CAAC,aAAkB;AACvC,UAAG,SAAS,QAAQ,GAAG;AACnB,eAAO;AAAA,MACX,WAAU,SAAS,UAAU,GAAG;AAC5B,eAAO;AAAA,MACX,OAAO;AACH,eAAO,SAAS,QAAQ;AAAA,MAC5B;AAAA,IACJ;AAEA,UAAM,sBAAsB,CAAC,GAAQ,MAAW;AAE5C,YAAM,cAAc,UAAU,aAAa,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC;AAC5D,YAAM,WAAW,OAAO,KAAK,CAAC,EAAE,CAAC;AACjC,UAAG,YAAY,iBAAiB,GAAG;AAC/B,YAAI,aAAa,OAAO;AACpB,iBAAO;AAAA,QACX,WAAU,aAAa,SAAS;AAC5B,iBAAO;AAAA,QACX,OAAO;AACH,iBAAO;AAAA,QACX;AAAA,MACJ,OAAO;AACH,eAAO,YAAY,eAAe,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC;AAAA,MACvD;AAAA,IACJ;AAEA,UAAM,SAAS;AAAA,MACX,cAAc,UAAU,mBAAmB,EAAE,QAAS,CAAC,MAAmB,KAAK,QAAQ,EAAE,QAAQ,CAAC,IAC5F,iBAAiB,CAAC,EAAE,QAAS,CAAC,MAAgB,KAAK,QAAQ,EAAE,QAAQ,GAAG,gBAAgB,CAAC,CAAC,IAAI,OAAO,GAAG,EAAE,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,EAAE,IAC3I,EAAE,QAAQ,CAAE,EAAE,OAAQ,CAAC,MAAW,MAAM,IAAI;AAAA,MAClD,iBAAiB,KAAK,QAAQ,aAAa,QAAS,CAAC,MAAW,UAAU,aAAa,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,IAClG,MAAM,QAAQ,EAAE,UAAU,IAAI,EAAE,WAAW,QAAS,CAAC,MAAW,oBAAoB,GAAG,CAAC,IAAI,OAAO,GAAG,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,OAClJ,CAAE,EAAE,OAAQ,CAAC,MAAW,MAAM,IAAI;AAAA,IAC5C;AAEA,QAAG,CAAC,KAAK,QAAQ,MAAK;AAClB,aAAO,aAAa,KAAK,WAAW;AAAA,IACxC;AAEA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAS;AACL,WAAO,KAAK;AAAA,EAChB;AACJ;AAGA,IAAO,qBAAQ;",
+  "names": []
+}

package/dist/esm-browser/{chunk-2FE6COGH.mjs → chunk-LF5LTG3B.mjs}

@@ -1,10 +1,15 @@
 import {
   vocabulary_default
-} from "./chunk-CKXQ5OWJ.mjs";
+} from "./chunk-LCSHHQ7B.mjs";
+import {
+  validateVocabularyYaml
+} from "./chunk-PFDH5LIN.mjs";
 import {
-  browser_default,
   parseVocabularyYaml
-} from "./chunk-DSN2E4MW.mjs";
+} from "./chunk-NPUAPXXA.mjs";
+import {
+  browser_default
+} from "./chunk-CSZFRMP7.mjs";
 import {
   __commonJS,
   __toESM,
@@ -1710,14 +1715,16 @@ function camelCaseToSentence(text) {
 var VocabularyManager = class _VocabularyManager {
   /**
    * Create the VocabularyManager
-   * @param {*} [options] options to configure vocabulary lookup
-   * @param {*} [options.missingTermGenerator] A function to call for missing terms. The function
+   * @param {VocabularyManagerOptions} [options] options to configure vocabulary lookup
+   * @param {Function} [options.missingTermGenerator] A function to call for missing terms. The function
    * should accept namespace, locale, declarationName, propertyName as arguments
+   * @param {boolean} [options.enableVocValidator] When true, validates vocabulary YAML before parsing
    * @constructor
    */
   constructor(options) {
     this.vocabularies = {};
-    this.missingTermGenerator = options ? options.missingTermGenerator : null;
+    this.missingTermGenerator = options?.missingTermGenerator ?? null;
+    this.options = options ?? {};
   }
   /**
    * Computes a term in English based on declaration and property name.
@@ -1759,7 +1766,15 @@ var VocabularyManager = class _VocabularyManager {
     if (!contents) {
       throw new Error("Vocabulary contents must be specified");
     }
-    const voc = new vocabulary_default(this, options?.enableSafeVocabParsing ? parseVocabularyYaml(contents) : browser_default.parse(contents));
+    if (this.options.enableVocValidator) {
+      const { errors } = validateVocabularyYaml(contents);
+      if (errors.length > 0) {
+        throw new Error(errors.map((e) => e.message).join(", "));
+      }
+    }
+    const useRawParse = this.options.enableVocValidator || !options?.enableSafeVocabParsing;
+    const parsed = useRawParse ? browser_default.parse(contents) : parseVocabularyYaml(contents);
+    const voc = new vocabulary_default(this, parsed, { skipLocaleValidation: !!this.options.enableVocValidator });
     if (this.vocabularies[voc.getIdentifier()]) {
       throw new Error("Vocabulary has already been added.");
     }
@@ -2086,4 +2101,4 @@ export {
   VocabularyManager,
   vocabularymanager_default
 };
-//# sourceMappingURL=chunk-2FE6COGH.mjs.map
+//# sourceMappingURL=chunk-LF5LTG3B.mjs.map