@fluid-experimental/property-properties 0.58.1001 → 0.58.2000-58133

package/lib/propertyFactory.js

@@ -10,9 +10,11 @@
 const _ = require('lodash');
 const fastestJSONCopy = require('fastest-json-copy');
 const deepCopy = fastestJSONCopy.copy;
-const { Collection, ConsoleUtils, EventEmitter, SortedCollection, constants, GuidUtils } = require('@fluid-experimental/property-common');
+const { Collection, ConsoleUtils, EventEmitter, SortedCollection, constants, GuidUtils, } = require('@fluid-experimental/property-common');
 const { MSG } = constants;
-const { TypeIdHelper, TemplateValidator, PathHelper, ChangeSet } = require('@fluid-experimental/property-changeset');
+const { TypeIdHelper, TemplateValidator, PathHelper, ChangeSet, } = require('@fluid-experimental/property-changeset');
+const semver = require('semver');
+const async = require('async');
 const { PropertyTemplate } = require('./propertyTemplate');
 const { PropertyTemplateWrapper } = require('./propertyTemplateWrapper');
 // Include the property classes
@@ -24,8 +26,8 @@ const { ContainerProperty } = require('./properties/containerProperty');
 const { ValueProperty } = require('./properties/valueProperty');
 // Include all primitive properties –- will register at the end.
 const { Uint8Property, Uint16Property, Uint32Property, } = require('./properties/uintProperties');
-const { Float32Property, Float64Property } = require('./properties/floatProperties');
-const { Int8Property, Int16Property, Int32Property, Int64Property, Uint64Property } = require('./properties/intProperties');
+const { Float32Property, Float64Property, } = require('./properties/floatProperties');
+const { Int8Property, Int16Property, Int32Property, Int64Property, Uint64Property, } = require('./properties/intProperties');
 const { StringProperty } = require('./properties/stringProperty');
 const { BoolProperty } = require('./properties/boolProperty');
 const { ReferenceProperty } = require('./properties/referenceProperty');
@@ -41,9 +43,7 @@ const { Float32ArrayProperty, Float64ArrayProperty, Uint32ArrayProperty, Int32Ar
 const { ReferenceMapProperty } = require('./properties/referenceMapProperty');
 const { ReferenceArrayProperty } = require('./properties/referenceArrayProperty');
 const { EnumArrayProperty } = require('./properties/enumArrayProperty');
-const { Float64MapProperty, Float32MapProperty, Uint32MapProperty, Uint64MapProperty, Uint16MapProperty, Uint8MapProperty, Int32MapProperty, Int64MapProperty, Int16MapProperty, Int8MapProperty, StringMapProperty, BoolMapProperty } = require('./properties/valueMapProperty');
-const semver = require('semver');
-const async = require('async');
+const { Float64MapProperty, Float32MapProperty, Uint32MapProperty, Uint64MapProperty, Uint16MapProperty, Uint8MapProperty, Int32MapProperty, Int64MapProperty, Int16MapProperty, Int8MapProperty, StringMapProperty, BoolMapProperty, } = require('./properties/valueMapProperty');
 const { LazyLoadedProperties } = require('./properties/lazyLoadedProperties');
 /**
  * Creates an instance of the TemplateValidator
@@ -62,7 +62,7 @@ var _createTemplateValidator = function (skipSemver) {
     };
     var params = {
         inheritsFrom: this.inheritsFrom.bind(this),
-        hasSchema: hasSchema.bind(this)
+        hasSchema: hasSchema.bind(this),
     };
     if (skipSemver) {
         params.skipSemver = skipSemver;
@@ -277,7 +277,7 @@ class PropertyFactory {
         // Structure containing results the process of retrieving property set schemas from store
         this.templateRequestsResults = {
             errors: {},
-            schemas: {}
+            schemas: {},
         };
         // Cache of inheritsFrom() request results
         this._inheritanceCache = {};
@@ -294,7 +294,6 @@ class PropertyFactory {
         this._forceInstantion = false;
         this._init();
     }
-    ;
     /**
     * Add a listener for a given type of event.
     *
@@ -307,7 +306,6 @@ class PropertyFactory {
     addListener(eventName, eventListener) {
         this._eventEmitter.addListener(eventName, eventListener);
     }
-    ;
     /**
     * Remove a listener for a given type of event. Iff a listener was removed,
     * an event 'removeListener' will be emitted.
@@ -316,11 +314,10 @@ class PropertyFactory {
     *   listener was attached.
     * @param  {function} eventListener The function to remove from the list of functions
     * @public
-    **/
+    * */
     removeListener(eventName, eventListener) {
         this._eventEmitter.removeListener(eventName, eventListener);
     }
-    ;
     /**
      * Initialize the PropertyFactory by registering primitive types
      */
@@ -377,25 +374,24 @@ class PropertyFactory {
         var NamedPropertyTemplate = {
             typeid: 'NamedProperty',
             properties: [
-                { id: 'guid', typeid: 'String' }
-            ]
+                { id: 'guid', typeid: 'String' },
+            ],
         };
         var NamedNodePropertyTemplate = {
             typeid: 'NamedNodeProperty',
-            inherits: ['NodeProperty', 'NamedProperty']
+            inherits: ['NodeProperty', 'NamedProperty'],
         };
         var RelationshipPropertyTemplate = {
             typeid: 'RelationshipProperty',
             inherits: ['NodeProperty', 'NamedProperty'],
             properties: [
-                { id: 'to', typeid: 'Reference' }
-            ]
+                { id: 'to', typeid: 'Reference' },
+            ],
         };
         this._registerTypeId(NamedPropertyTemplate.typeid, NamedPropertyTemplate);
         this._registerTypeId(NamedNodePropertyTemplate.typeid, NamedNodePropertyTemplate);
         this._registerTypeId(RelationshipPropertyTemplate.typeid, RelationshipPropertyTemplate);
     }
-    ;
     /**
      * Register a template which are used to instantiate properties. To find out more about templates,
      * see https://docs.google.com/document/d/1-7kXkKTu3AZLjKyKl7XK2VuAJRSbUxo3ZuPA8bzWocs/edit
@@ -459,7 +455,6 @@ class PropertyFactory {
             }
         }
     }
-    ;
     /**
      * Recursively parses the object of the specified type and returns the created
      * array of PropertySets Templates. It does the same thing as the registerFrom()
@@ -479,7 +474,6 @@ class PropertyFactory {
                 throw new Error(MSG.UNKNOWN_TYPE + in_fromType);
         }
     }
-    ;
     /**
      * Recursively parses the object of the specified type and registers the created
      * Property Sets Templates. It does the same work as the convertToTemplates()
@@ -498,7 +492,6 @@ class PropertyFactory {
             this.register(psetsTemplates[i]);
         }
     }
-    ;
     /**
      * Validate semver.
      * Here we compare the incoming template with its previous/next version in the
@@ -562,7 +555,6 @@ class PropertyFactory {
                 ' is valid but with the following warnings = ' + JSON.stringify(warnings, 0, 2));
         }
     }
-    ;
     /**
      * Internal method used to register remote templates coming over the wire.
      * @param {property-properties.PropertyTemplate|object} in_remoteTemplate - The remote template to register
@@ -619,7 +611,6 @@ class PropertyFactory {
             throw new Error(MSG.UNVERSIONED_REMOTE_TEMPLATE + ' \n' + JSON.stringify(in_remoteTemplate, 0, 2));
         }
     }
-    ;
     /**
      * Remove the scope from the remote templates collection
      * @param {string} in_scope The scope to remove
@@ -637,14 +628,13 @@ class PropertyFactory {
             this._remoteScopedAndVersionedTemplates.remove(in_scope);
         }
     }
-    ;
     /**
      * Triggered when a template is registered.
      * @event property-properties.PropertyFactory#registered
      * @param {property-properties.Template} Template - The template being registered.
      * @memberof property-properties.PropertyFactory
      *
-     **/
+     * */
     /**
      * Register a template or a primitive property
      *
@@ -682,7 +672,6 @@ class PropertyFactory {
         }
         this._eventEmitter.emit('registered', in_templateOrProperty);
     }
-    ;
     /**
      * Validate a template
      * Check that the template is syntactically correct as well as semantically correct.
@@ -705,7 +694,6 @@ class PropertyFactory {
     validate(in_template) {
         return this._templateValidator.validate(in_template);
     }
-    ;
     /**
      * Get a template or property object based on a typeid and a context
      *
@@ -723,7 +711,6 @@ class PropertyFactory {
         }
         return templateOrProperty;
     }
-    ;
     /**
      * Get a template or property object based on a typeid and a context
      *
@@ -758,7 +745,6 @@ class PropertyFactory {
         }
         return undefined;
     }
-    ;
     /**
      * Get template based on typeid
      *
@@ -769,10 +755,10 @@ class PropertyFactory {
         if (this._localPrimitivePropertiesAndTemplates.has(in_typeid) && !TypeIdHelper.isPrimitiveType(in_typeid)) {
             return this._localPrimitivePropertiesAndTemplates.item(in_typeid).getPropertyTemplate();
         }
-        else
+        else {
             return undefined;
+        }
     }
-    ;
     /**
      * Get remote templates based on typeid
      * @private
@@ -792,7 +778,6 @@ class PropertyFactory {
         });
         return templatesFound;
     }
-    ;
     /**
      * Create an instance of the given property typeid if there is a template registered for it.
      * Otherwise, this method returns undefined. Searches also in scoped templates.
@@ -832,7 +817,7 @@ class PropertyFactory {
             propertyDef = {};
             this._createDefFromPropertyDeclaration({
                 typeid: in_typeid,
-                context: context || 'single'
+                context: context || 'single',
             }, in_scope, propertyDef);
         }
         let property;
@@ -846,19 +831,18 @@ class PropertyFactory {
             // default initialized property
             if (in_initialProperties !== undefined) {
                 this._setInitialValue(property, {
-                    value: in_initialProperties
+                    value: in_initialProperties,
                 }, false);
             }
         }
         else {
             // Directly instantiate the property from the definition (without using) a precompield function
             property = this._instantiatePropertyDef(propertyDef, in_scope, in_initialProperties && {
-                value: in_initialProperties
+                value: in_initialProperties,
             });
         }
         return property;
     }
-    ;
     /**
      * Creates an instance of the property described in the property definition.
      *
@@ -878,7 +862,7 @@ class PropertyFactory {
         const creationStack = [{
                 id: undefined,
                 entry: propertyDef,
-                parent: undefined
+                parent: undefined,
             }];
         while (creationStack.length > 0) {
             const currentEntry = creationStack.pop();
@@ -924,7 +908,7 @@ class PropertyFactory {
                 const parentStackEntry = {
                     signalChildrenFinished: true,
                     initialValue: currentEntry.entry.initialValue,
-                    property
+                    property,
                 };
                 creationStack.push(parentStackEntry);
                 for (let [id, child] of currentEntry.entry.children) {
@@ -933,7 +917,7 @@ class PropertyFactory {
                         id: id,
                         entry: child,
                         setGuid: currentEntry.entry.assignGuid && id ===
-                            'guid'
+                            'guid',
                     });
                 }
             }
@@ -968,7 +952,7 @@ class PropertyFactory {
         const creationStack = [{
                 id: null,
                 def: propertyDef,
-                parent: undefined
+                parent: undefined,
             }];
         let creationFunctionSource = "";
         let currentParameterIndex = 0;
@@ -1008,7 +992,7 @@ class PropertyFactory {
                             if (initialValue === undefined) {
                                 initialValue = {
                                     typed: false,
-                                    value: filteredChangeSet
+                                    value: filteredChangeSet,
                                 };
                             }
                             else if (_.isObject(initialValue)) {
@@ -1022,7 +1006,7 @@ class PropertyFactory {
                             if (initialValue === undefined) {
                                 initialValue = {
                                     value: undefined,
-                                    typed: false
+                                    typed: false,
                                 };
                             }
                             initialValue.value = filteredChangeSet;
@@ -1123,7 +1107,7 @@ class PropertyFactory {
                             def: child,
                             signalParent: false,
                             setGuid: currentEntry.def.assignGuid && id === 'guid',
-                            parentStackEntry
+                            parentStackEntry,
                         });
                     }
                 }
@@ -1207,7 +1191,6 @@ class PropertyFactory {
             property._setValues(valueParsed.value, false, true);
         }
     }
-    ;
     /**
      * Create an instance of the given property typeid if there is a template registered for it.
      * Otherwise, this method returns undefined.
@@ -1223,7 +1206,6 @@ class PropertyFactory {
     create(in_typeid, in_context, in_initialProperties) {
         return this._createProperty(in_typeid, in_context, in_initialProperties, null);
     }
-    ;
     /**
      * Creates a  constructor function for the given typeid and id. The function will inherit from the
      * passed base constructor, but have the typeid and id assigned in its constructor. This way, we
@@ -1267,7 +1249,6 @@ class PropertyFactory {
         this._typedPropertyConstructorCache[key] = propertyConstructorFunction;
         return propertyConstructorFunction;
     }
-    ;
     /**
      * Creates a property definition for a non-collection property with the entry and constructor function assigned
      * Children will be added later by parseTemplate.
@@ -1285,7 +1266,7 @@ class PropertyFactory {
         let ConstructorFunction;
         const params = {
             typeid: in_typeid,
-            id: in_id
+            id: in_id,
         };
         if (this.inheritsFrom(in_typeid, 'NamedProperty', { scope: in_scope })) {
             params.id = in_id || null; // An id of NULL means that the GUID of the property is used if it is a named property
@@ -1316,7 +1297,6 @@ class PropertyFactory {
         propertyDef.context = 'single';
         propertyDef.typeid = in_typeid;
     }
-    ;
     /**
      * Check whether a typeid is registered
      * @param {string} in_typeid The type unique identifier
@@ -1327,7 +1307,6 @@ class PropertyFactory {
     _isRegisteredTypeid(in_typeid, in_scope) {
         return !!this._get(in_typeid, undefined, in_scope);
     }
-    ;
     /**
      * Checks if there exists a registered template with a corresponding typeid
      * example:example would match to example:example-1.0.0
@@ -1348,7 +1327,6 @@ class PropertyFactory {
         }
         return registered;
     }
-    ;
     /**
      * Check whether the given typeid is a specialized constructor
      * Specialized constructors are of Array or Map types
@@ -1359,7 +1337,6 @@ class PropertyFactory {
     _isSpecializedConstructor(in_typeid) {
         return this._localPrimitivePropertiesAndTemplates.item(in_typeid) instanceof Collection;
     }
-    ;
     /**
      * Generate the typeid according to multiple settings
      *
@@ -1392,7 +1369,6 @@ class PropertyFactory {
         }
         return typeid;
     }
-    ;
     /**
      * Creates a propertyDef for the given properties entry
      *
@@ -1505,7 +1481,6 @@ class PropertyFactory {
             out_propertyDef.assignGuid = true;
         }
     }
-    ;
     /**
      * Method used to determine whether the given object is a property constructor
      *
@@ -1518,7 +1493,6 @@ class PropertyFactory {
         //       overwritten in the derived classes (which it probably should be)
         return (in_obj.constructor && in_obj.constructor === ContainerProperty.constructor);
     }
-    ;
     /**
      * Checks whether the property has a typedValue and replaces the value and the typeid
      * with the ones in the typedValue.
@@ -1533,7 +1507,7 @@ class PropertyFactory {
         var res = {
             typed: false,
             value: in_property.value,
-            typeid: in_property.typeid
+            typeid: in_property.typeid,
         };
         if (in_property.typedValue) {
             var typeid = in_property.typeid || 'ContainerProperty';
@@ -1559,7 +1533,6 @@ class PropertyFactory {
         }
         return res;
     }
-    ;
     /**
      * Parse a given property template appending its property and constant objects to the given propertyDef
      *
@@ -1590,7 +1563,7 @@ class PropertyFactory {
                         const newChildEntry = {
                             initialValue: valueParsed,
                             optional,
-                            allowChildMerges: in_allowChildMerges
+                            allowChildMerges: in_allowChildMerges,
                         };
                         propertyDef.children = propertyDef.children || [];
                         propertyDef.children.unshift([properties[i].id, newChildEntry]);
@@ -1598,7 +1571,7 @@ class PropertyFactory {
                     }
                     else if (!optional) {
                         const newChildEntry = {
-                            initialValue: undefined
+                            initialValue: undefined,
                         };
                         propertyDef.children = propertyDef.children || [];
                         propertyDef.children.unshift([properties[i].id, newChildEntry]);
@@ -1613,7 +1586,7 @@ class PropertyFactory {
                     const valueParsed = this._parseTypedValue(constants[i], in_scope, context);
                     const newChildEntry = {
                         initialValue: undefined,
-                        constant: true
+                        constant: true,
                     };
                     propertyDef.children = propertyDef.children || [];
                     propertyDef.children.unshift([constants[i].id, newChildEntry]);
@@ -1625,7 +1598,6 @@ class PropertyFactory {
             }
         }
     }
-    ;
     // private params:
     // @param {string} [in_options.scope]    - The scope in which the property typeid is defined
     /**
@@ -1671,7 +1643,6 @@ class PropertyFactory {
             return parents[in_baseTypeid] !== undefined;
         }
     }
-    ;
     // private params:
     // @param {string|undefined}  [in_options.scope] - The scope in which the template was stored.
     /**
@@ -1700,7 +1671,6 @@ class PropertyFactory {
         this._getAllParentsForTemplateInternal(in_typeid, parents, !!in_options.includeBaseProperty, scope);
         return _.keys(parents);
     }
-    ;
     /**
      * Returns all the typeids the template inherits from (including all possible paths through multiple inheritance).
      *
@@ -1741,7 +1711,6 @@ class PropertyFactory {
             }
         }
     }
-    ;
     /**
      * Internal function used to clear and reinitialize the PropertyFactory
      * @private
@@ -1754,7 +1723,6 @@ class PropertyFactory {
         this._typedPropertyConstructorCache = {};
         this._init();
     }
-    ;
     /**
      * Reregisters a template (by overwriting the existing template).
      *
@@ -1792,7 +1760,6 @@ class PropertyFactory {
         // And repeat the registration
         registerLocal.call(this, in_template);
     }
-    ;
     /**
     * Initializes the schema store.
     * @public
@@ -1803,7 +1770,7 @@ class PropertyFactory {
     *
     * @return {Promise} Return an empty promise when checkout resolve or reject with error.
     */
-    initializeSchemaStore(in_options) {
+    async initializeSchemaStore(in_options) {
         // https://regex101.com/r/TlgGJp/2
         var regexBaseUrl = /^(https?:)?\/\/((.[-a-zA-Z0-9@:%_+~#=.]{2,256}){1,2}\.[a-z]{2,6}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})(:\d{1,5})?(\/[-a-zA-Z0-9@:%_+.~#?&/=]*)*$/; // eslint-disable-line max-len
         if (!in_options || !in_options.getBearerToken || !_.isFunction(in_options.getBearerToken) || !in_options.url) {
@@ -1818,7 +1785,6 @@ class PropertyFactory {
         this._templateStore = new ForgeSchemaStore(in_options);
         return Promise.resolve();
     }
-    ;
     /**
      * Pushes a template request task onto the template requests queue
      *
@@ -1840,7 +1806,6 @@ class PropertyFactory {
             throw new Error(MSG.INVALID_TEMPLATE_STORE);
         }
     }
-    ;
     /**
      * Tries to resolve dependencies after some calls to register() have been made
      *
@@ -1861,7 +1826,7 @@ class PropertyFactory {
      * }
      *
      */
-    resolveSchemas() {
+    async resolveSchemas() {
         // Only one queue at a time can be processed.
         if (this.templateRequestsQueue !== undefined) {
             return Promise.reject(new Error(MSG.DEPENDENCIES_RESOLUTION_IN_PROGRESS));
@@ -1959,7 +1924,6 @@ class PropertyFactory {
             }
         });
     }
-    ;
     /**
      * Determines whether the given property is an instance of the property type corresponding to the given native
      * property typeid and context.
@@ -1978,7 +1942,6 @@ class PropertyFactory {
         }
         return result;
     }
-    ;
 }
 const PropertyFactorySingleton = new PropertyFactory();
 export { PropertyFactorySingleton as PropertyFactory };