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

package/dist/properties/baseProperty.js

@@ -12,7 +12,6 @@ exports.BaseProperty = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const property_changeset_1 = require("@fluid-experimental/property-changeset");
 const property_common_1 = require("@fluid-experimental/property-common");
-const property_common_2 = require("@fluid-experimental/property-common");
 const lazyLoadedProperties_1 = require("./lazyLoadedProperties");
 const { MSG, PROPERTY_PATH_DELIMITER } = property_common_1.constants;
 const BREAK_TRAVERSAL = 'BREAK';
@@ -40,7 +39,6 @@ var MODIFIED_STATE_FLAGS;
     /** The property has been modified and the result has not yet been reported to the application for scene updates */
     MODIFIED_STATE_FLAGS[MODIFIED_STATE_FLAGS["DIRTY"] = 2] = "DIRTY";
 })(MODIFIED_STATE_FLAGS || (MODIFIED_STATE_FLAGS = {}));
-;
 /**
  * Token Types
  * @enum Object
@@ -52,7 +50,7 @@ const PATH_TOKENS = {
     /** A * that indicates a dereferencing operation */ // note: reversed!
     REF: { 'token': 'REF' },
     /** A ../ that indicates one step above the current path */
-    UP: { 'token': 'UP' }
+    UP: { 'token': 'UP' },
 };
 /**
  * The options to selectively create only a subset of a property.
@@ -91,21 +89,18 @@ class BaseProperty {
             this._dirty = MODIFIED_STATE_FLAGS.CLEAN;
         }
     }
-    ;
     /**
      * @returns The typeid of this property
      */
     getTypeid() {
         return this._typeid;
     }
-    ;
     /**
      * @returns The context of this property
      */
     getContext() {
         return this._context;
     }
-    ;
     /**
      * Get the scope to which this property belongs to.
      * @returns The guid representing the scope in which the
@@ -119,7 +114,6 @@ class BaseProperty {
             return undefined;
         }
     }
-    ;
     /**
      * Returns the full property type identifier for the ChangeSet including the enum type id
      * @param in_hideCollection - if true the collection type (if applicable) will be omitted
@@ -129,7 +123,6 @@ class BaseProperty {
     getFullTypeid(in_hideCollection = false) {
         return this._typeid;
     }
-    ;
     /**
      * Updates the parent for the property
      *
@@ -144,7 +137,6 @@ class BaseProperty {
             this._parent._setDirty(false, this);
         }
     }
-    ;
     /**
      * Is this property the root of the property set tree?
      *
@@ -155,7 +147,6 @@ class BaseProperty {
         // (all other properties should have a parent property)
         return this._parent === undefined;
     }
-    ;
     /**
      * Is this property the ancestor of in_otherProperty?
      * Note: A property is not considered an ancestor of itself
@@ -164,7 +155,7 @@ class BaseProperty {
      * @returns True if it is a ancestor, otherwise false.
      */
     isAncestorOf(in_otherProperty) {
-        property_common_2.ConsoleUtils.assert(in_otherProperty, MSG.MISSING_IN_OTHERPROP);
+        property_common_1.ConsoleUtils.assert(in_otherProperty, MSG.MISSING_IN_OTHERPROP);
         var parent = in_otherProperty.getParent();
         while (parent) {
             if (parent === this) {
@@ -176,7 +167,6 @@ class BaseProperty {
         }
         return false;
     }
-    ;
     /**
      * Is this property the descendant of in_otherProperty?
      * Note: A property is not considered a descendant of itself
@@ -185,10 +175,9 @@ class BaseProperty {
      * @returns True if it is a descendant, otherwise false.
      */
     isDescendantOf(in_otherProperty) {
-        property_common_2.ConsoleUtils.assert(in_otherProperty, MSG.MISSING_IN_OTHERPROP);
+        property_common_1.ConsoleUtils.assert(in_otherProperty, MSG.MISSING_IN_OTHERPROP);
         return in_otherProperty.isAncestorOf(this);
     }
-    ;
     /**
      * Is this property a leaf node with regard to flattening?
      *
@@ -199,7 +188,6 @@ class BaseProperty {
     _isFlattenLeaf() {
         return false;
     }
-    ;
     /**
      * Get the parent of this property
      *
@@ -208,7 +196,6 @@ class BaseProperty {
     getParent() {
         return this._parent;
     }
-    ;
     /**
      * checks whether the property is dynamic (only properties inherting from NodeProperty are)
      * @returns True if it is a dynamic property.
@@ -216,7 +203,6 @@ class BaseProperty {
     isDynamic() {
         return false;
     }
-    ;
     /**
      * Sets the property as dirty and/or pending. This will add one or both flags if not already set and will
      * do the same for its parent. This does not clear any flag, it only sets.
@@ -250,7 +236,6 @@ class BaseProperty {
             this._reportDirtinessToView();
         }
     }
-    ;
     /**
      * Sets the dirty flags for this property
      * @param in_flags - The dirty flags
@@ -258,7 +243,6 @@ class BaseProperty {
     _setDirtyFlags(in_flags) {
         this._dirty = in_flags;
     }
-    ;
     /**
      * Gets the dirty flags for this property
      * @returns The dirty flags
@@ -266,7 +250,6 @@ class BaseProperty {
     _getDirtyFlags() {
         return this._dirty;
     }
-    ;
     /**
      * Helper function, which reports the fact that a property has been dirtied to the checkout view
      * @private
@@ -289,7 +272,6 @@ class BaseProperty {
             currentNode._tree._reportDirtinessToView();
         }
     }
-    ;
     /**
      * Modifies the property according to the given changeset
      *
@@ -303,7 +285,6 @@ class BaseProperty {
         // We just forward the call to the internal function
         this._applyChangeset(in_changeSet, true);
     }
-    ;
     /**
      * Modifies the property according to the given changeset
      *
@@ -339,7 +320,6 @@ class BaseProperty {
             this._reportDirtinessToView();
         }
     }
-    ;
     /**
      * Re-apply dirty flags from changesets
      *
@@ -375,7 +355,6 @@ class BaseProperty {
     resolvePath(path, params) {
         throw new Error("Method not implemented.");
     }
-    ;
     /**
      * Removes the dirtiness flag from this property
      * @param {property-properties.BaseProperty.MODIFIED_STATE_FLAGS} [in_flags] - The flags to clean, if none are supplied all
@@ -386,7 +365,6 @@ class BaseProperty {
         this._setDirtyFlags(in_flags === undefined ? MODIFIED_STATE_FLAGS.CLEAN :
             (this._getDirtyFlags() & ~in_flags));
     }
-    ;
     /**
      * Removes the dirtiness flag from this property and recursively from all of its children
      *
@@ -403,7 +381,6 @@ class BaseProperty {
         // after all paths are clean, we are also clean!
         this._cleanDirty(in_flags);
     }
-    ;
     /**
      * Indicates that the property has been modified and a corresponding modified call has not yet been sent to the
      * application for runtime scene updates.
@@ -414,7 +391,6 @@ class BaseProperty {
     _isDirty(in_dirtinessType = MODIFIED_STATE_FLAGS.DIRTY) {
         return !!(this._getDirtyFlags() & in_dirtinessType);
     }
-    ;
     /**
      * Indicates that the property has been modified and a corresponding modified call has not yet been sent to the
      * application for runtime scene updates.
@@ -424,7 +400,6 @@ class BaseProperty {
     isDirty() {
         return this._isDirty();
     }
-    ;
     /**
      * The property has pending changes in the current ChangeSet.
      * @returns True if the property has pending changes. False otherwise.
@@ -432,7 +407,6 @@ class BaseProperty {
     hasPendingChanges() {
         return this._isDirty(MODIFIED_STATE_FLAGS.PENDING_CHANGE);
     }
-    ;
     /**
      * Returns the ChangeSet of all sub-properties
      *
@@ -442,7 +416,6 @@ class BaseProperty {
         var serialized = this._serialize(true, false, BaseProperty.MODIFIED_STATE_FLAGS.PENDING_CHANGE);
         return new property_changeset_1.ChangeSet(serialized);
     }
-    ;
     /**
      * Get the id of this property
      *
@@ -451,7 +424,6 @@ class BaseProperty {
     getId() {
         return this._id;
     }
-    ;
     /**
      * Sets the checkedOutRepositoryInfo.
      * @param {property-properties.CheckoutView~CheckedOutRepositoryInfo} value - The checkedOut repository info.
@@ -460,7 +432,6 @@ class BaseProperty {
     _setCheckoutView(value) {
         this._checkoutView = value;
     }
-    ;
     /**
      * Returns the checkoutView
      * @return {property-properties.CheckoutView} - the checkout view
@@ -469,7 +440,6 @@ class BaseProperty {
         let checkedOutRepositoryInfo = this._getCheckedOutRepositoryInfo();
         return checkedOutRepositoryInfo ? checkedOutRepositoryInfo.getCheckoutView() : undefined;
     }
-    ;
     /**
      * Returns the checkedOutRepositoryInfo.
      * @return {property-properties.CheckoutView~CheckedOutRepositoryInfo} The checkedOut repository info.
@@ -483,7 +453,6 @@ class BaseProperty {
             return this.getRoot() ? this.getRoot()._getCheckedOutRepositoryInfo() : undefined;
         }
     }
-    ;
     /**
      * Returns the Workspace
      * @returns The workspace containing the property.
@@ -492,7 +461,6 @@ class BaseProperty {
         const root = this.getRoot();
         return root ? root._tree : undefined;
     }
-    ;
     /**
      * Returns the path segment for a child
      *
@@ -503,7 +471,6 @@ class BaseProperty {
     _getPathSegmentForChildNode(in_childNode) {
         return PROPERTY_PATH_DELIMITER + property_changeset_1.PathHelper.quotePathSegmentIfNeeded(in_childNode.getId());
     }
-    ;
     /**
      * Resolves a direct child node based on the given path segment
      *
@@ -520,7 +487,6 @@ class BaseProperty {
         }
         return this.get(in_segment, { referenceResolutionMode: BaseProperty.REFERENCE_RESOLUTION.NEVER });
     }
-    ;
     /**
      * Set the id of this property
      *
@@ -541,7 +507,6 @@ class BaseProperty {
         this._setDirty();
         return in_id;
     }
-    ;
     /**
      * Return a clone of this property
      * @returns The cloned property
@@ -556,7 +521,6 @@ class BaseProperty {
             BaseProperty.MODIFIED_STATE_FLAGS.DIRTY);
         return clone;
     }
-    ;
     /**
      * Returns true if the property is a primitive type
      * @return {boolean} true if the property is a primitive type
@@ -564,7 +528,6 @@ class BaseProperty {
     isPrimitiveType() {
         return property_changeset_1.TypeIdHelper.isPrimitiveType(this._typeid);
     }
-    ;
     /**
      * Get a flattened, tree like representation of this object and all of it's
      * descendants. The flattening will stop at primitive properties and collections.
@@ -579,7 +542,6 @@ class BaseProperty {
     _flatten() {
         return { propertyNode: this };
     }
-    ;
     /**
      * Repeatedly calls back the given function with human-readable string representations
      * of the property and of its sub-properties. By default it logs to the console.
@@ -592,7 +554,6 @@ class BaseProperty {
         }
         this._prettyPrint('', '', printFct);
     }
-    ;
     /**
      * Return a JSON representation of the properties and its children.
      * @return {object} A JSON representation of the properties and its children.
@@ -604,7 +565,7 @@ class BaseProperty {
             context: this._context,
             typeid: this.getTypeid(),
             isConstant: this._isConstant,
-            value: []
+            value: [],
         };
         var ids = this.getIds();
         for (const id of ids) {
@@ -612,7 +573,6 @@ class BaseProperty {
         }
         return json;
     }
-    ;
     getIds() {
         return [];
     }
@@ -641,7 +601,6 @@ class BaseProperty {
         printFct(indent + externalId + this.getId() + ' (' + context + this.getTypeid() + '):');
         this._prettyPrintChildren(indent, printFct);
     }
-    ;
     /**
      * Repeatedly calls back the given function with human-readable string
      * representations of the property's sub-properties.
@@ -655,7 +614,6 @@ class BaseProperty {
             this.get(ids[i], { referenceResolutionMode: BaseProperty.REFERENCE_RESOLUTION.NEVER })._prettyPrint(indent, '', printFct);
         }
     }
-    ;
     /**
      * Returns the possible paths from the given from_property to this property. If multiple paths
      * through multiple repository references are possible, returns more than one path.
@@ -709,7 +667,6 @@ class BaseProperty {
         }
         return [];
     }
-    ;
     /**
      * Returns the possible paths from the given in_fromProperty to this property. If no direct paths
      * exist, it returns an indirect path between the two properties.
@@ -742,7 +699,6 @@ class BaseProperty {
             return undefined;
         }
     }
-    ;
     /**
      * Returns the path from the given in_fromProperty to this property if a direct path
      * exists between the two properties. Otherwise returns undefined.
@@ -783,7 +739,6 @@ class BaseProperty {
             return undefined;
         }
     }
-    ;
     /**
      * Returns the possible paths from the given in_fromProperty to this property.
      *
@@ -808,7 +763,6 @@ class BaseProperty {
             }
         }
     }
-    ;
     /**
      * Returns the path from the given fron_property to this node if such a path exists.
      * If more than one paths exist (as might be the case with multiple repository references
@@ -825,7 +779,7 @@ class BaseProperty {
      * @throws if in_fromProperty is not a property
      */
     getRelativePath(in_fromProperty) {
-        property_common_2.ConsoleUtils.assert(in_fromProperty instanceof BaseProperty, MSG.IN_FROMPROPERTY_MUST_BE_PROPERTY);
+        property_common_1.ConsoleUtils.assert(in_fromProperty instanceof BaseProperty, MSG.IN_FROMPROPERTY_MUST_BE_PROPERTY);
         var paths = this._getAllRelativePaths(in_fromProperty) || [];
         if (paths.length === 0) {
             console.warn(MSG.NO_PATH_BETWEEN +
@@ -839,7 +793,6 @@ class BaseProperty {
         }
         return paths[0];
     }
-    ;
     /**
      * Returns the path from the root of the workspace to this node
      * (including a slash at the beginning)
@@ -894,7 +847,6 @@ class BaseProperty {
         absolutePath = '/' + absolutePath;
         return absolutePath;
     }
-    ;
     /**
      * Traverses the property hierarchy upwards until the a node without parent is reached
      *
@@ -905,7 +857,7 @@ class BaseProperty {
      *                            otherwise undefined
      */
     traverseUp(in_callback) {
-        property_common_2.ConsoleUtils.assert(lodash_1.default.isFunction(in_callback), MSG.CALLBACK_NOT_FCT);
+        property_common_1.ConsoleUtils.assert(lodash_1.default.isFunction(in_callback), MSG.CALLBACK_NOT_FCT);
         if (this._parent) {
             var result = in_callback(this._parent);
             if (result !== BREAK_TRAVERSAL) {
@@ -917,7 +869,6 @@ class BaseProperty {
         }
         return undefined;
     }
-    ;
     /**
      * Returns all children which are dirty (this only returns direct children, it does not travers recursively)
      *
@@ -929,7 +880,6 @@ class BaseProperty {
     _getDirtyChildren(in_flags) {
         return [];
     }
-    ;
     /**
      * Returns the root of the property hierarchy
      * @returns The root property
@@ -937,7 +887,6 @@ class BaseProperty {
     getRoot() {
         return this._parent ? this._parent.getRoot() : this;
     }
-    ;
     /**
      * Traverses all children in the child hierarchy
      * TODO: How should this behave for collections?
@@ -951,7 +900,6 @@ class BaseProperty {
     _traverse(in_callback, in_pathFromTraversalStart) {
         return undefined;
     }
-    ;
     /**
      * Deserialize takes a currently existing property and sets it to the hierarchy described in the normalized
      * ChangeSet passed as parameter. It will return a ChangeSet that describes the difference between the
@@ -975,7 +923,6 @@ class BaseProperty {
         this._checkIsNotReadOnly(false);
         return this._deserialize(in_serializedObj, in_reportToView, in_filteringOptions, in_createChangeSet);
     }
-    ;
     /**
      * Sets the property to the state in the given normalized changeset
      *
@@ -993,7 +940,6 @@ class BaseProperty {
     _deserialize(in_serializedObj, in_reportToView, in_filteringOptions = {}, in_createChangeSet = true) {
         return {};
     }
-    ;
     /**
      * Serialize the property into a changeSet
      *
@@ -1011,7 +957,6 @@ class BaseProperty {
     _serialize(in_dirtyOnly = false, in_includeRootTypeid = false, in_dirtinessType = MODIFIED_STATE_FLAGS.PENDING_CHANGE, in_includeReferencedRepositories = false) {
         return {};
     }
-    ;
     /**
      * Serialize the property
      *
@@ -1024,16 +969,16 @@ class BaseProperty {
             dirtyOnly: false,
             includeRootTypeid: false,
             dirtinessType: MODIFIED_STATE_FLAGS.PENDING_CHANGE,
-            includeReferencedRepositories: false
+            includeReferencedRepositories: false,
         };
         if (in_options !== undefined) {
-            if (typeof in_options !== 'object')
+            if (typeof in_options !== 'object') {
                 throw new Error(MSG.SERIALIZE_TAKES_OBJECT);
+            }
             Object.assign(opts, in_options);
         }
         return this._serialize(opts.dirtyOnly, opts.includeRootTypeid, opts.dirtinessType, opts.includeReferencedRepositories);
     }
-    ;
     /**
      * Indicate that all static members have been added to the property
      *
@@ -1041,7 +986,6 @@ class BaseProperty {
      * @protected
      */
     _signalAllStaticMembersHaveBeenAdded() { }
-    ;
     /**
      * Tests whether this property may be modified
      * @param {checkConstant} in_checkConstant - Check if is readonly constant property
@@ -1058,7 +1002,6 @@ class BaseProperty {
             }
         }
     }
-    ;
     /**
      * Set a property and its children as constants (readonly properties)
      */
@@ -1074,7 +1017,6 @@ class BaseProperty {
     traverseDown(arg0) {
         throw new Error("Method not implemented.");
     }
-    ;
     /**
      * Unsets a property and its children as constants
      */
@@ -1091,7 +1033,6 @@ class BaseProperty {
             });
         }
     }
-    ;
     /**
      * Dirties this node and all of its children
      *
@@ -1110,7 +1051,6 @@ class BaseProperty {
             this._reportDirtinessToView();
         }
     }
-    ;
     /**
      * Determines whether a property can be inserted as a child of another property
      * This does NOT validate if the parent can accept the child property, it only validates if
@@ -1136,7 +1076,6 @@ class BaseProperty {
             throw new Error(MSG.INSERTED_ENTRY_WITH_PARENT);
         }
     }
-    ;
     /**
      * TODO: Remove it later. Kept not to modify tests
      *
@@ -1185,7 +1124,6 @@ class BaseProperty {
         }
         return false;
     }
-    ;
     get _properties() {
         return this._flatten();
     }