@fluid-experimental/property-changeset 1.2.7 → 2.0.0-dev.1.3.0.96595

package/dist/templateValidator.d.ts

@@ -57,7 +57,7 @@ export interface TemplateValidatorOptions {
     hasSchemaAsync?: (schema: PropertySchema, typeid: string) => Promise<boolean>;
 }
 /**
- *  @description Instantiates a new TemplateValidator. Must be provided with a set of inheritsFrom and hasSchema
+ * Instantiates a new TemplateValidator. Must be provided with a set of inheritsFrom and hasSchema
  * function or inheritsFromAsync and hasSchemaAsync, but not both.
  */
 export declare class TemplateValidator {
@@ -73,56 +73,88 @@ export declare class TemplateValidator {
     private readonly _skipSemver;
     constructor(in_params?: TemplateValidatorOptions);
     /**
- * Validates that all templates conform to the following mandatory rules:
- * 1. Must have a typeid attribute.
- * 2. typeid must end in a valid semver string.
- * 3. When both in_template (B) and in_templatePrevious (A) are supplied:
- *    3a. Semver is identical only if content is identical.
- *    3b. B's semver >= A's semver
- * Additionally, the following soft rules will produce warnings when violated:
- * 3.5 Elements of sets must eventually inherit from 'NamedProperty'
- * 4. PATCH revision should be increased when _only_ the template description changes.
- * 5. Adding one or more template attributes is a MINOR change.
- * 6. Removing one or more template attributes is a MAJOR change.
- * @param in_template The latest template version, as a JSON object.
- * @param in_templatePrevious The previous template version, as a JSON object. Optional.
- * @returns The validation results. Example: {
- *   isValid: false,
- *   errors: ['Something went wrong. Validation failed.'],
- *   warnings: ['A non-fatal warning'],
- *   typeid: 'SomeNamespace:PointID-1.0.0'
- * }
- * It's possible for 'isValid' to be true while 'warnings' contains one or more messages.
- */
+     * Validates that all templates conform to the following mandatory rules:
+     *
+     * 1. Must have a typeid attribute.
+     *
+     * 2. typeid must end in a valid semver string.
+     *
+     * 3. When both in_template (B) and in_templatePrevious (A) are supplied:
+     *
+     * - 3a. Semver is identical only if content is identical.
+     *
+     * - 3b. B's semver >= A's semver
+     *
+     * Additionally, the following soft rules will produce warnings when violated:
+     *
+     * 3.5. Elements of sets must eventually inherit from 'NamedProperty'
+     *
+     * 4. PATCH revision should be increased when _only_ the template description changes.
+     *
+     * 5. Adding one or more template attributes is a MINOR change.
+     *
+     * 6. Removing one or more template attributes is a MAJOR change.
+     *
+     * @param in_template - The latest template version, as a JSON object.
+     * @param in_templatePrevious - The previous template version, as a JSON object. Optional.
+     * @returns The validation results. Example:
+     *
+     * ```json
+     * {
+     *   isValid: false,
+     *   errors: ['Something went wrong. Validation failed.'],
+     *   warnings: ['A non-fatal warning'],
+     *   typeid: 'SomeNamespace:PointID-1.0.0'
+     * }
+     * ```
+     *
+     * It's possible for 'isValid' to be true while 'warnings' contains one or more messages.
+     */
     validate(in_template: PropertySchema, in_templatePrevious?: PropertySchema): SchemaValidationResult;
     /**
      * Validates that all templates conform to the following mandatory rules:
+     *
      * 1. Must have a typeid attribute.
+     *
      * 2. typeid must end in a valid semver string.
+     *
      * 3. When both in_template (B) and in_templatePrevious (A) are supplied:
-     *    3a. Semver is identical only if content is identical.
-     *    3b. B's semver >= A's semver
+     *
+     * - 3a. Semver is identical only if content is identical.
+     *
+     * - 3b. B's semver >= A's semver
+     *
      * Additionally, the following soft rules will produce warnings when violated:
-     * 3.5 Elements of sets must eventually inherit from 'NamedProperty'
+     *
+     * 3.5. Elements of sets must eventually inherit from 'NamedProperty'
+     *
      * 4. PATCH revision should be increased when _only_ the template description changes.
+     *
      * 5. Adding one or more template attributes is a MINOR change.
+     *
      * 6. Removing one or more template attributes is a MAJOR change.
-     * @param in_template The latest template version, as a JSON object.
-     * @param in_templatePrevious The previous template version, as a JSON object. Optional.
-     * @returns A promise that resolves to the validation results as an object. Example: {
+     *
+     * @param in_template - The latest template version, as a JSON object.
+     * @param in_templatePrevious - The previous template version, as a JSON object. Optional.
+     * @returns A promise that resolves to the validation results as an object. Example:
+     *
+     * ```json
+     * {
      *   isValid: false,
      *   errors: ['Something went wrong. Validation failed.'],
      *   warnings: ['A non-fatal warning'],
      *   typeid: 'SomeNamespace:PointID-1.0.0'
      * }
+     * ```
+     *
      * It's possible for 'isValid' to be true while 'warnings' contains one or more messages.
      */
     validateAsync(in_template: PropertySchema, in_templatePrevious?: PropertySchema): Promise<SchemaValidationResult>;
     /**
      * Called by validateAsync if a previous schema is passed in argument
      *
-     * @param in_template The latest template version, as a JSON object.
-     * @param in_templatePrevious The previous template version, as a JSON object. Optional.
+     * @param in_template - The latest template version, as a JSON object.
+     * @param in_templatePrevious - The previous template version, as a JSON object. Optional.
      *
      * @returns promise that resolves to the validation results as an objet. See validateAsync
      * @ignore

package/dist/templateValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"templateValidator.d.ts","sourceRoot":"","sources":["../src/templateValidator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH;;;;GAIG;AA4BH,OAAO,EAAE,sBAAsB,EAA2B,MAAM,2BAA2B,CAAC;AAc5F,aAAK,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;CAAE,CAAC;AAEjD,aAAK,YAAY,GAAG;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;CACtB,CAAC;AAEF,aAAK,cAAc,GAAG,YAAY,EAAE,CAAC;AAErC,MAAM,WAAW,cAAc;IAC3B,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IACxC,UAAU,EAAE,cAAc,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;CACtB;AA+0BD,MAAM,WAAW,wBAAwB;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC;IAC3E;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAChE;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACzF;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAEjF;AAQD;;;GAGG;AACH,qBAAa,iBAAiB;IAC1B,MAAM,CAAC,KAAK;;MAAS;IACrB,OAAO,CAAC,cAAc,CAA0B;IACzC,aAAa,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC;IAC3E,UAAU,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAChE,kBAAkB,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACzF,eAAe,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACrF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;gBAC1B,SAAS,GAAE,wBAAmE;IAe1F;;;;;;;;;;;;;;;;;;;;;GAqBD;IACC,QAAQ,CAAC,WAAW,EAAE,cAAc,EAAE,mBAAmB,CAAC,EAAE,cAAc,GAAG,sBAAsB;IAiFnG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,aAAa,CAAC,WAAW,EAAE,cAAc,EAAE,mBAAmB,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAcvH;;;;;;;;OAQG;YACW,gCAAgC;CAwCjD"}
+{"version":3,"file":"templateValidator.d.ts","sourceRoot":"","sources":["../src/templateValidator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH;;;;GAIG;AA4BH,OAAO,EAAE,sBAAsB,EAA2B,MAAM,2BAA2B,CAAC;AAc5F,aAAK,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;CAAE,CAAC;AAEjD,aAAK,YAAY,GAAG;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;CACtB,CAAC;AAEF,aAAK,cAAc,GAAG,YAAY,EAAE,CAAC;AAErC,MAAM,WAAW,cAAc;IAC3B,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IACxC,UAAU,EAAE,cAAc,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;CACtB;AAm1BD,MAAM,WAAW,wBAAwB;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC;IAC3E;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAChE;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACzF;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAEjF;AAQD;;;GAGG;AACH,qBAAa,iBAAiB;IAC1B,MAAM,CAAC,KAAK;;MAAS;IACrB,OAAO,CAAC,cAAc,CAA0B;IACzC,aAAa,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC;IAC3E,UAAU,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAChE,kBAAkB,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACzF,eAAe,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACrF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;gBAC1B,SAAS,GAAE,wBAAmE;IAe9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACC,QAAQ,CAAC,WAAW,EAAE,cAAc,EAAE,mBAAmB,CAAC,EAAE,cAAc,GAAG,sBAAsB;IAiFnG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACG,aAAa,CAAC,WAAW,EAAE,cAAc,EAAE,mBAAmB,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAcvH;;;;;;;;OAQG;YACW,gCAAgC;CAwCjD"}

package/dist/templateValidator.js

@@ -77,9 +77,8 @@ const _extractTypeid = function (typeidOrReference) {
 };
 /**
  * Given a typeid string, fetches the semver 'x.y.z' version string.
- * @param in_typeid A PropertySet typeid. For example: 'TeamLeoValidation2:ColorID-1.0.0'.
- * @returns The semver 'x.y.z' version string, or null if in_typeid is not a valid
- *   PropertySet typeid.
+ * @param in_typeid - A PropertySet typeid. For example: 'TeamLeoValidation2:ColorID-1.0.0'.
+ * @returns The semver 'x.y.z' version string, or null if in_typeid is not a valid PropertySet typeid.
  */
 const _getSemverFromTypeId = function (in_typeid) {
     const semverRegex = /.*-(.*)$/g;
@@ -88,7 +87,7 @@ const _getSemverFromTypeId = function (in_typeid) {
 };
 /**
  * Fetches the type name of a javascript entity.
- * @param in_obj A javascript entity.
+ * @param in_obj - A javascript entity.
  * @returns The type name for in_obj.
  */
 const _getType = (in_obj) => Object.prototype.toString.call(in_obj).slice(8, -1);
@@ -102,12 +101,14 @@ function isPropertyArray(source) {
  * An object deep compare with special handling for pset property arrays.
  * pset property arrays are allowed to be out of order as long as elements can be matched with
  * their id.
- * @param in_source The source entity to test for deep equality.
- * @param in_target The target entity to test for deep equality.
+ * @param in_source - The source entity to test for deep equality.
+ * @param in_target - The target entity to test for deep equality.
  * @returns {isEqual: false, path: 'foo.properties[1].x'}
- *   isEqual: true if in_source and in_target property sets are equal, even if the individual
- *     property arrays differ but contain the same out of order elements.
- *   path: path to the property that is not equal.
+ *
+ * - isEqual: true if in_source and in_target property sets are equal, even if the individual property arrays
+ * differ but contain the same out of order elements.
+ *
+ * - path: path to the property that is not equal.
  */
 const _psetDeepEquals = function (in_source, in_target) {
     const idPath = [];
@@ -116,11 +117,11 @@ const _psetDeepEquals = function (in_source, in_target) {
     }
     /**
      * Create the _psetDeepEquals result.
-     * @param isEqual Whether or not a PropertySet result is being constructed for
-     *   PropertySets that are deeply equal.
+     * @param isEqual - Whether or not a PropertySet result is being constructed for
+     * PropertySets that are deeply equal.
      * @returns {{isEqual: boolean, path: string}} An object that indicates whether or not the source
-     *   and target PropertySets are deeply equal. If they're not, it also contains a path to the
-     *   property that is not equal.
+     * and target PropertySets are deeply equal. If they're not, it also contains a path to the
+     * property that is not equal.
      */
     const _getPSetDeepEqualsResult = (isEqual) => ({
         isEqual,
@@ -128,9 +129,9 @@ const _psetDeepEquals = function (in_source, in_target) {
     });
     /**
      * Performs a recursive, depth first deep equal test against two PropertySets.
-     * @param source The source entity to test for deep equality.
-     * @param target The target entity to test for deep equality.
-     * @param id The current path element being compared.
+     * @param source - The source entity to test for deep equality.
+     * @param target - The target entity to test for deep equality.
+     * @param id - The current path element being compared.
      * @return The result of _getPSetDeepEqualsResult
      */
     let _depthFirstDeepEquals = function (source, target, id) {
@@ -208,7 +209,7 @@ const _psetDeepEquals = function (in_source, in_target) {
 };
 /**
  * Fetches the non semver part of a typeid string.
- * @param in_typeid A PropertySet typeid. For example: 'TeamLeoValidation2:ColorID-1.0.0'.
+ * @param in_typeid - A PropertySet typeid. For example: 'TeamLeoValidation2:ColorID-1.0.0'.
  * @returns The typeid, without a semver.
  */
 const _stripSemverFromTypeId = function (in_typeid) {
@@ -236,7 +237,7 @@ const _unresolvedTypes = function (in_template) {
 };
 /**
  * Performs basic template validation.
- * @param in_template The template object to validate.
+ * @param in_template - The template object to validate.
  */
 const _validateBasic = function (in_template) {
     if (!in_template) {
@@ -248,14 +249,17 @@ const _validateBasic = function (in_template) {
 };
 /**
  * Validations performed when the version increases between consecutive templates.
+ *
+ * @remarks
  * For example: 1.1.3 -> 2.0.0
  * This function checks the change level (PATCH, MINOR, MAJOR) and analyses the template content
  * to emit warnings if the change level should be higher, given the content that changed.
- * This function assumes that: in_versionPrevious < in_version
- * @param in_template The latest template object.
- * @param in_templatePrevious The previous template object.
- * @param in_version The latest template version. Ex.: '2.0.0'.
- * @param in_versionPrevious The previous template version. Ex.: '1.1.3'.
+ * This function assumes that: in_versionPrevious < in_version.
+ *
+ * @param in_template - The latest template object.
+ * @param in_templatePrevious - The previous template object.
+ * @param in_version - The latest template version. Ex.: '2.0.0'.
+ * @param in_versionPrevious - The previous template version. Ex.: '1.1.3'.
  */
 const _validatePositiveIncrement = function (in_template, in_templatePrevious, in_version, in_versionPrevious) {
     property_common_1.ConsoleUtils.assert((0, semver_1.gt)(in_version, in_versionPrevious), "property-changeset.TemplateValidator._validatePositiveIncrement called on non incremental " +
@@ -437,8 +441,8 @@ const _validatePositiveIncrement = function (in_template, in_templatePrevious, i
  * Validations performed when the version between consecutive templates doesn't change.
  * For example: 1.1.3 -> 1.1.3.
  * Templates whose version didn't change should have identical content.
- * @param in_template The latest template object.
- * @param in_templatePrevious The previous template object.
+ * @param in_template - The latest template object.
+ * @param in_templatePrevious - The previous template object.
  */
 const _validateSameVersion = function (in_template, in_templatePrevious) {
     const result = _psetDeepEquals.call(this, in_templatePrevious, in_template);
@@ -450,21 +454,25 @@ const _validateSameVersion = function (in_template, in_templatePrevious) {
 /**
  * Validate a template
  * Check that the template is syntactically correct as well as semantically correct.
- * @param in_template The template to check against
- * Produces an {object|undefined} map of key-value pairs
- *  where the path of the invalid property is the key and the value is the error message
- *  i.e.
- *  <pre>
- *    {
- *      'isValid': true or false,
- *      'typeid': 'The typeid of the object being parsed',
- *      'unresolvedTypes': [ 'An array', 'of strong typeids', 'that were found',
- *        'in the document', 'but not resolved from the local cache' ],
- *      'resolvedTypes': [ 'Array of', 'strong types resolved', 'during template parsing'],
- *      'errors': [ 'Array of', 'objects describing', 'syntax errors in the template' ]
- *      ...
- *    }
- *  </pre>
+ * @param in_template - The template to check against.
+ * Produces an {object|undefined} map of key-value pairs where the path of the invalid property is the key and the
+ * value is the error message.
+ *
+ * i.e.
+ *
+ * ```
+ * <pre>
+ *   {
+ *     'isValid': true or false,
+ *     'typeid': 'The typeid of the object being parsed',
+ *     'unresolvedTypes': [ 'An array', 'of strong typeids', 'that were found',
+ *       'in the document', 'but not resolved from the local cache' ],
+ *     'resolvedTypes': [ 'Array of', 'strong types resolved', 'during template parsing'],
+ *     'errors': [ 'Array of', 'objects describing', 'syntax errors in the template' ]
+ *     ...
+ *   }
+ * </pre>
+ * ```
  * @throws if context validation fails
  */
 const _validateSemanticAndSyntax = function (in_template) {
@@ -475,7 +483,7 @@ const _validateSemanticAndSyntax = function (in_template) {
 /**
  * Validate a template
  * Check that the template is syntactically correct as well as semantically correct.
- * @param in_template The template to check against
+ * @param in_template - The template to check against
  * @return {Promise} a promise that resolved to nothing
  * @ignore
  */
@@ -484,7 +492,7 @@ const _validateSemanticAndSyntaxAsync = async function (in_template) {
 };
 /**
  * Validates that the semver part of a template's typeid is valid.
- * @param {Object} in_template The template object to validate.
+ * @param {Object} in_template - The template object to validate.
  * @return {string} The semver string. For example: '1.0.0'.
  * @private
  * @this TemplateValidator
@@ -503,8 +511,8 @@ const _validateSemverFormat = function (in_template) {
 /**
  * Skip semver validation. Verify that the content is the same for both templates, while ignoring
  * the root 'typeid' property.
- * @param {Object} in_template The latest template object.
- * @param {Object} in_templatePrevious The previous template object.
+ * @param {Object} in_template - The latest template object.
+ * @param {Object} in_templatePrevious - The previous template object.
  * @private
  * @this TemplateValidator
  */
@@ -518,8 +526,8 @@ const _validateSkipSemver = function (in_template, in_templatePrevious) {
 };
 /**
  * Checks if an invalid context error should be signified
-
- * @param {String} in_context The latest template object.
+ *
+ * @param {String} in_context - The latest template object.
  * @return {Error|undefined} If exists returns the InvalidContext error
  * @private
  * @this TemplateValidator
@@ -533,7 +541,7 @@ const getInvalidContextError = function (in_context) {
 /**
  * Validate that the context is valid
  * Validate that only Named Properties are in sets
- * @param {object} in_template The template to check against
+ * @param {object} in_template - The template to check against
  * @ignore
  * @throws if the context is invalid.
  */
@@ -550,7 +558,7 @@ const _validateContext = function (in_template) {
 /**
  * Validate just the syntax of a template
  * Check that the template is well-formed, according to the schema.
- * @param {object} in_template The template to check against
+ * @param {object} in_template - The template to check against
  *
  * Context validation makes sure that elements of sets eventually inherit from NamedProperty.
  * If this is not the case, a promise rejection will occur with the appropriate error.
@@ -614,7 +622,7 @@ const _validateContextAsync = async function (in_template) {
 /**
  * Validate that the context is valid
  * Validate that only Named Properties are in sets
- * @param {object} in_template The template to check against
+ * @param {object} in_template - The template to check against
  * @ignore
  * @throws if the context is invalid.
  */
@@ -637,7 +645,7 @@ let _validateConstants = function (in_template) {
 /**
  * Analyze output of the syntax validation and build error messages
  *
- * @param in_template The template that was analyzed
+ * @param in_template - The template that was analyzed
  */
 const _processValidationResults = function (in_template) {
     let that = this;
@@ -655,25 +663,19 @@ const _processValidationResults = function (in_template) {
                         error.message = `typeid should have a pattern like: my.example:point-1.0.0 ${error.data} does not match that pattern`;
                     }
                     else if ("pattern" && regexTypeId.test(error.dataPath)) {
-                        if (error.schemaPath === "#/definitions/typed-reference-typeid/pattern") {
-                            error.message = "";
-                        }
-                        else {
-                            error.message = `${error.dataPath} should follow this pattern: <namespace>:<typeid>-<version> ` +
+                        error.message = error.schemaPath === "#/definitions/typed-reference-typeid/pattern"
+                            ? ""
+                            : `${error.dataPath} should follow this pattern: <namespace>:<typeid>-<version> ` +
                                 `(for example: Sample:Rectangle-1.0.0) or match one of the Primitive Types (Float32, Float64, ` +
                                 `Int8, Uint8, Int16, Uint16, Int32, Uint32, Bool, String, Reference, Enum, Int64, Uint64) or ` +
                                 `Reserved Types (BaseProperty, NamedProperty, NodeProperty, NamedNodeProperty, ` +
                                 `RelationshipProperty). '${error.data}' is not valid`;
-                        }
                     }
                     break;
                 case "enum":
-                    if (regexTypeId.test(error.dataPath)) {
-                        error.message = "";
-                    }
-                    else {
-                        error.message = `${error.dataPath} should match one of the following: ${error.schema}`;
-                    }
+                    error.message = regexTypeId.test(error.dataPath)
+                        ? ""
+                        : `${error.dataPath} should match one of the following: ${error.schema}`;
                     break;
                 case "type":
                     error.message = `${error.dataPath} should be a ${error.schema}`;
@@ -709,7 +711,7 @@ const _processValidationResults = function (in_template) {
 /**
  * Validate just the syntax of a template
  * Check that the template is well-formed, according to the schema.
- * @param in_template The template to check against
+ * @param in_template - The template to check against
  * @throws if a property with context set is not an instance of NamedProperties
  * @ignore
  */
@@ -746,7 +748,7 @@ const createContextCheckAsyncQueue = function () {
  * Validate just the syntax of a template
  * Check that the template is well-formed, according to the schema.
  *
- * @param in_template The template to check against
+ * @param in_template - The template to check against
  * Mainly checks context. See _validateContextAsync
  * @returns Promise that resolves without any result
  * @ignore
@@ -791,7 +793,7 @@ const Utils = {
     },
 };
 /**
- *  @description Instantiates a new TemplateValidator. Must be provided with a set of inheritsFrom and hasSchema
+ * Instantiates a new TemplateValidator. Must be provided with a set of inheritsFrom and hasSchema
  * function or inheritsFromAsync and hasSchemaAsync, but not both.
  */
 class TemplateValidator {
@@ -812,27 +814,43 @@ class TemplateValidator {
         }
     }
     /**
- * Validates that all templates conform to the following mandatory rules:
- * 1. Must have a typeid attribute.
- * 2. typeid must end in a valid semver string.
- * 3. When both in_template (B) and in_templatePrevious (A) are supplied:
- *    3a. Semver is identical only if content is identical.
- *    3b. B's semver >= A's semver
- * Additionally, the following soft rules will produce warnings when violated:
- * 3.5 Elements of sets must eventually inherit from 'NamedProperty'
- * 4. PATCH revision should be increased when _only_ the template description changes.
- * 5. Adding one or more template attributes is a MINOR change.
- * 6. Removing one or more template attributes is a MAJOR change.
- * @param in_template The latest template version, as a JSON object.
- * @param in_templatePrevious The previous template version, as a JSON object. Optional.
- * @returns The validation results. Example: {
- *   isValid: false,
- *   errors: ['Something went wrong. Validation failed.'],
- *   warnings: ['A non-fatal warning'],
- *   typeid: 'SomeNamespace:PointID-1.0.0'
- * }
- * It's possible for 'isValid' to be true while 'warnings' contains one or more messages.
- */
+     * Validates that all templates conform to the following mandatory rules:
+     *
+     * 1. Must have a typeid attribute.
+     *
+     * 2. typeid must end in a valid semver string.
+     *
+     * 3. When both in_template (B) and in_templatePrevious (A) are supplied:
+     *
+     * - 3a. Semver is identical only if content is identical.
+     *
+     * - 3b. B's semver >= A's semver
+     *
+     * Additionally, the following soft rules will produce warnings when violated:
+     *
+     * 3.5. Elements of sets must eventually inherit from 'NamedProperty'
+     *
+     * 4. PATCH revision should be increased when _only_ the template description changes.
+     *
+     * 5. Adding one or more template attributes is a MINOR change.
+     *
+     * 6. Removing one or more template attributes is a MAJOR change.
+     *
+     * @param in_template - The latest template version, as a JSON object.
+     * @param in_templatePrevious - The previous template version, as a JSON object. Optional.
+     * @returns The validation results. Example:
+     *
+     * ```json
+     * {
+     *   isValid: false,
+     *   errors: ['Something went wrong. Validation failed.'],
+     *   warnings: ['A non-fatal warning'],
+     *   typeid: 'SomeNamespace:PointID-1.0.0'
+     * }
+     * ```
+     *
+     * It's possible for 'isValid' to be true while 'warnings' contains one or more messages.
+     */
     validate(in_template, in_templatePrevious) {
         this._resultBuilder = new validationResultBuilder_1.ValidationResultBuilder(in_template ? in_template.typeid : "");
         let isDraft = false;
@@ -901,24 +919,40 @@ class TemplateValidator {
     }
     /**
      * Validates that all templates conform to the following mandatory rules:
+     *
      * 1. Must have a typeid attribute.
+     *
      * 2. typeid must end in a valid semver string.
+     *
      * 3. When both in_template (B) and in_templatePrevious (A) are supplied:
-     *    3a. Semver is identical only if content is identical.
-     *    3b. B's semver >= A's semver
+     *
+     * - 3a. Semver is identical only if content is identical.
+     *
+     * - 3b. B's semver >= A's semver
+     *
      * Additionally, the following soft rules will produce warnings when violated:
-     * 3.5 Elements of sets must eventually inherit from 'NamedProperty'
+     *
+     * 3.5. Elements of sets must eventually inherit from 'NamedProperty'
+     *
      * 4. PATCH revision should be increased when _only_ the template description changes.
+     *
      * 5. Adding one or more template attributes is a MINOR change.
+     *
      * 6. Removing one or more template attributes is a MAJOR change.
-     * @param in_template The latest template version, as a JSON object.
-     * @param in_templatePrevious The previous template version, as a JSON object. Optional.
-     * @returns A promise that resolves to the validation results as an object. Example: {
+     *
+     * @param in_template - The latest template version, as a JSON object.
+     * @param in_templatePrevious - The previous template version, as a JSON object. Optional.
+     * @returns A promise that resolves to the validation results as an object. Example:
+     *
+     * ```json
+     * {
      *   isValid: false,
      *   errors: ['Something went wrong. Validation failed.'],
      *   warnings: ['A non-fatal warning'],
      *   typeid: 'SomeNamespace:PointID-1.0.0'
      * }
+     * ```
+     *
      * It's possible for 'isValid' to be true while 'warnings' contains one or more messages.
      */
     async validateAsync(in_template, in_templatePrevious) {
@@ -937,8 +971,8 @@ class TemplateValidator {
     /**
      * Called by validateAsync if a previous schema is passed in argument
      *
-     * @param in_template The latest template version, as a JSON object.
-     * @param in_templatePrevious The previous template version, as a JSON object. Optional.
+     * @param in_template - The latest template version, as a JSON object.
+     * @param in_templatePrevious - The previous template version, as a JSON object. Optional.
      *
      * @returns promise that resolves to the validation results as an objet. See validateAsync
      * @ignore