@fluid-experimental/property-common 0.49.0 → 0.50.0-41540

package/lib/datastructures/collection.js

@@ -0,0 +1,377 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/* eslint accessor-pairs: [2, { "getWithoutSet": false }] */
+/**
+ * @fileoverview Collection class definition
+ */
+import _ from "lodash";
+const MSGS = {
+    TYPE_MISMATCH: "Type does not match this collection type",
+    KEY_ALREADY_EXISTS: "Collection key already exists. ",
+    KEY_DOES_NOT_EXIST: "Collection key does not exist in this collection.",
+    MUST_GIVE_KEY: "Collection missing key.",
+    MUST_GIVE_VALUE: "Collection missing value.",
+    KEY_NOT_VALID: "Key must be of type String or Number",
+};
+export class Collection {
+    /**
+     * @param _name - a friendly name to describe this collection. If undefined
+     * the collection will have a default "Untitled Collection" assigned to its name.
+     * @param _type - optional parameter pointing to the constructor
+     * of a type this Collection will host.
+     */
+    constructor(_name = "Untitled Collection", _type) {
+        this._name = _name;
+        this._type = _type;
+        this._items = {};
+        this._order = [];
+    }
+    // Pass-thru binding handles
+    onAdd(in_key, in_value) { }
+    onRemove(in_key, in_value) { }
+    onClear(in_items) { }
+    get items() {
+        return this._items;
+    }
+    get keys() {
+        return Object.keys(this._items);
+    }
+    /**
+     * @param in_key - Key to store the value under
+     * @param in_value - Value to store in the collection
+     * @returns Return the value passed in
+     */
+    add(in_key, in_value) {
+        this._checkType(in_value);
+        this._checkIsNewKey(in_key);
+        this._items[in_key] = in_value;
+        this._order.push(in_key);
+        this.onAdd(in_key, in_value);
+        return in_value;
+    }
+    /**
+     * Checks if in_value's type is equal to this Collection type. If this collection
+     * has no type set, the check will pass.
+     *
+     * @param in_value - A value that is equal to the type managed by this collection.
+     * @returns Return true if the type is a valid type for this
+     * collection, throw otherwise.
+     */
+    _checkType(in_value) {
+        if (this._type && !(in_value instanceof this._type)) {
+            throw new Error(MSGS.TYPE_MISMATCH);
+        }
+        else {
+            return true;
+        }
+    }
+    /**
+     * Bulk add items.
+     * @param in_items - List of key-value pairs to be stored in the collection
+     * @returns this collection after add
+     */
+    bulkAdd(in_items) {
+        _.each(in_items, (item, key) => {
+            this.add(key, item);
+        });
+        return this;
+    }
+    /**
+     * Bulk remove items.
+     * @param in_items - List of key-value items to be removed
+     * @returns this collection after add
+     */
+    bulkRemove(in_items) {
+        _.each(in_items, (item, key) => {
+            this.remove(key);
+        });
+        return this;
+    }
+    /**
+     * Test if this collection is empty
+     * @returns true if empty, false otherwise
+     * */
+    isEmpty() {
+        return _.isEmpty(this._items);
+    }
+    /**
+     * Return the first item in the collection, null if empty
+     * @returns first item, or undefined if empty
+     * */
+    getFirstItem() {
+        const index = _.first(this._order);
+        return index === undefined ? index : this._items[index];
+    }
+    /**
+     * Return the last item in the collection, null if empty
+     * @returns - last item, or undefined if empty
+     * */
+    getLastItem() {
+        const index = _.last(this._order);
+        return index === undefined ? index : this._items[index];
+    }
+    /**
+     * @returns Returns the type of collection (Array, etc.)
+     */
+    getType() {
+        return this._type;
+    }
+    /**
+     * @returns Returns the name of the collection
+     */
+    getName() {
+        return this._name;
+    }
+    /**
+     * Filter out by function
+     * @param in_filterFunction - with arguments key and item
+     * @returns  New filtered collection
+     */
+    filter(in_filterFunction) {
+        const rtn = new Collection();
+        const filterCb = function (in_key, in_item) {
+            const keeper = in_filterFunction(in_key, in_item);
+            if (keeper) {
+                rtn.add(in_key, in_item);
+            }
+        };
+        this.iterate(filterCb);
+        return rtn;
+    }
+    /**
+     * Filter out all keys NOT matching the in_filterKey
+     * @param in_filterKey - a single key or an array of keys, if the
+     * item matches any of the keys it will be filtered in.
+     * @returns New filtered collection with all the items
+     * matching at least one key.
+     */
+    filterByKey(in_filterKey) {
+        const rtn = new Collection();
+        let filterCb;
+        if (_.isArray(in_filterKey)) {
+            filterCb = function (in_key, in_item) {
+                if (in_filterKey.indexOf(in_key) >= 0) {
+                    rtn.add(in_key, in_item);
+                }
+            };
+        }
+        else {
+            // if in_filterKey is an array
+            filterCb = function (in_key, in_item) {
+                if (in_key === in_filterKey) {
+                    rtn.add(in_key, in_item);
+                }
+            };
+        }
+        this.iterate(filterCb);
+        return rtn;
+    }
+    /**
+     * Filter out all keys NOT matching the in_filterValue
+     * @param in_filterValue - Value to filter on
+     * @returns Return a filtered collection
+     */
+    filterByValue(in_filterValue) {
+        const rtn = new Collection();
+        const filterCb = function (in_key, in_item) {
+            if (in_item === in_filterValue) {
+                rtn.add(in_key, in_item);
+            }
+        };
+        this.iterate(filterCb);
+        return rtn;
+    }
+    /**
+     * Remove an item from this Collection. This method returns a Boolean indicating
+     * the success or failure of the removal. This is practical because if we were
+     * to throw an error when the key doesn't exist, it would require additional
+     * checks by the caller to make sure this key exists prior to removal. Which
+     * would make the attempt of removal more verbose and also costly because the
+     * caller would have to keep a list – somewhere else – of the things he can
+     * and cannot remove.
+     *
+     * @param in_key - the key we wish to remove
+     * @returns true if the key exists and was removed, false otherwise.
+     */
+    remove(in_key) {
+        if (!this.has(in_key)) {
+            return false;
+        }
+        const remember = this._items[in_key];
+        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+        delete this._items[in_key];
+        this._order.splice(this._order.indexOf(in_key), 1);
+        this.onRemove(in_key, remember);
+        return true;
+    }
+    /**
+     * Return the number of items in this Collection
+     * @returns the number of items in the collection
+     */
+    getCount() {
+        return this._order.length;
+    }
+    /**
+     * Returns this collection as an ordered Array
+     * @returns Array including the values
+     */
+    getAsArray() {
+        const rtnArr = new Array(this.getCount());
+        for (let i = 0; i < this._order.length; i++) {
+            rtnArr[i] = this._items[this._order[i]];
+        }
+        return rtnArr;
+    }
+    /**
+     * @param in_key - the key we are looking for
+     * @returns true if the item exists
+     */
+    has(in_key) {
+        return Object.prototype.hasOwnProperty.call(this._items, in_key);
+    }
+    /**
+     * Return an item associated with the given key
+     * @param in_key - the key for the item in this
+     * Collection
+     * @returns The item
+     */
+    item(in_key) {
+        return this._items[in_key];
+    }
+    /**
+     * Checks if this is a new key in the collection. Throw if already exists.
+     * @param in_key - The key to check against
+     * @returns true if key is new
+     */
+    _checkIsNewKey(in_key) {
+        if (this.has(in_key)) {
+            throw new Error(`${MSGS.KEY_ALREADY_EXISTS} ${in_key}`);
+        }
+        return true;
+    }
+    /**
+     * Checks if the key exists in the collection. Throw if not.
+     * @param in_key - the key to check against
+     * @returns true if key exists
+     */
+    _checkKeyExists(in_key) {
+        if (!this.has(in_key)) {
+            throw new Error(`${MSGS.KEY_DOES_NOT_EXIST} ${in_key}`);
+        }
+        return true;
+    }
+    /**
+     * Set an existing key to a value. If key doesn't exist this call will throw
+     * an error.
+     * @param in_key - the key we want to modify
+     * @param  in_value - the value we are to set at this key
+     * @returns the value passed in
+     */
+    set(in_key, in_value) {
+        this._checkKeyExists(in_key);
+        this._items[in_key] = in_value;
+        return in_value;
+    }
+    /**
+     * Iterate over this collection and run the callback with passing the key and
+     * item in the iteration loop.
+     * @param  in_callback - a function that we will call on each item
+     * of this collection. If the callback returns false then the iteration will exit early.
+     */
+    iterate(in_callback) {
+        for (const key of this._order) {
+            const continu = in_callback(key, this._items[key]);
+            if (continu === false) {
+                break;
+            }
+        }
+    }
+    /**
+     * Iterate over this collection starting from the tail and run the callback with passing the key and
+     * item in the iteration loop.
+     * @param in_callback - a function that we will call on each item
+     * of this collection. If the callback returns false then the iteration will exit early.
+     */
+    iterateFromTail(in_callback) {
+        let key;
+        let continu;
+        for (let i = this._order.length - 1; i >= 0; i--) {
+            key = this._order[i];
+            continu = in_callback(key, this._items[key]);
+            if (continu === false) {
+                break;
+            }
+        }
+    }
+    /**
+     * @returns Return an object containing the items of this collection
+     */
+    getItems() {
+        const result = {};
+        _.each(this._items, function (item, key) {
+            result[key] = item;
+        });
+        return result;
+    }
+    /**
+     * Return the list of keys
+     * @returns List of keys
+     */
+    getKeys() {
+        return Object.keys(this._items);
+    }
+    /**
+     * Method used to get the first element in the collection along with its key.
+     */
+    peak() {
+        return {
+            item: this._items[this._order[0]],
+            key: this._order[0],
+        };
+    }
+    /**
+     * Clear this collection
+     * @returns this collection
+     */
+    clear() {
+        if (_.isEmpty(this._items)) {
+            return this;
+        }
+        this.onClear(this._items);
+        // Best to just iterate through and remove everything, so that OnRemove
+        // handlers are called.
+        _.each(this.getKeys(), (key) => {
+            this.remove(key);
+        });
+        return this;
+    }
+    /**
+     * Copy the items of in_collection to this collection.
+     * @param in_collection - the collection we want to
+     * copy from.
+     * @returns new Collection
+     */
+    clone() {
+        const newCol = new Collection(this._name, this._type);
+        newCol.bulkAdd(this._items);
+        return newCol;
+    }
+    /**
+     * Copy the items of in_collection to this collection.
+     * @param in_collection - the collection we want to
+     * copy from.
+     */
+    copy(in_collection) {
+        this.clear();
+        const its = in_collection.items;
+        _.each(its, (item, key) => {
+            this.add(key, item);
+        });
+    }
+    get values() {
+        return this.getAsArray();
+    }
+}
+//# sourceMappingURL=collection.js.map

package/lib/datastructures/collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection.js","sourceRoot":"","sources":["../../src/datastructures/collection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,4DAA4D;AAC5D;;GAEG;AACH,OAAO,CAAC,MAAM,QAAQ,CAAC;AAEvB,MAAM,IAAI,GAAG;IACT,aAAa,EAAE,0CAA0C;IACzD,kBAAkB,EAAE,iCAAiC;IACrD,kBAAkB,EAAE,mDAAmD;IACvE,aAAa,EAAE,yBAAyB;IACxC,eAAe,EAAE,2BAA2B;IAC5C,aAAa,EAAE,sCAAsC;CACxD,CAAC;AAEF,MAAM,OAAO,UAAU;IAInB;;;;;OAKG;IACH,YAAsB,QAAQ,qBAAqB,EAAY,KAAqB;QAA9D,UAAK,GAAL,KAAK,CAAwB;QAAY,UAAK,GAAL,KAAK,CAAgB;QAT1E,WAAM,GAAyB,EAAE,CAAC;QAClC,WAAM,GAAwB,EAAE,CAAC;IAS3C,CAAC;IAED,4BAA4B;IAC5B,KAAK,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,QAAQ,IAAI,CAAC;IAC9B,OAAO,CAAC,QAAQ,IAAI,CAAC;IAErB,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAW,IAAI;QACX,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,MAAuB,EAAE,QAAW;QACpC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC1B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAE5B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEzB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAE7B,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACK,UAAU,CAAC,QAAW;QAC1B,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,QAAQ,YAAY,IAAI,CAAC,KAAK,CAAC,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACvC;aAAM;YACH,OAAO,IAAI,CAAC;SACf;IACL,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAA8B;QAClC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC3B,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,QAA8B;QACrC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC3B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;SAGK;IACL,OAAO;QACH,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED;;;SAGK;IACL,YAAY;QACR,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED;;;SAGK;IACL,WAAW;QACP,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,OAAO;QACH,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,OAAO;QACH,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,iBAAoD;QACvD,MAAM,GAAG,GAAG,IAAI,UAAU,EAAK,CAAC;QAEhC,MAAM,QAAQ,GAAG,UAAS,MAAM,EAAE,OAAO;YACrC,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClD,IAAI,MAAM,EAAE;gBACR,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aAC5B;QACL,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEvB,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,YAA+B;QACvC,MAAM,GAAG,GAAG,IAAI,UAAU,EAAK,CAAC;QAEhC,IAAI,QAAQ,CAAC;QAEb,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YACzB,QAAQ,GAAG,UAAS,MAAM,EAAE,OAAO;gBAC/B,IAAI,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBACnC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBAC5B;YACL,CAAC,CAAC;SACL;aAAM;YACH,8BAA8B;YAC9B,QAAQ,GAAG,UAAS,MAAM,EAAE,OAAO;gBAC/B,IAAI,MAAM,KAAK,YAAY,EAAE;oBACzB,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBAC5B;YACL,CAAC,CAAC;SACL;QAED,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEvB,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,cAAiB;QAC3B,MAAM,GAAG,GAAG,IAAI,UAAU,EAAK,CAAC;QAEhC,MAAM,QAAQ,GAAG,UAAS,MAAM,EAAE,OAAO;YACrC,IAAI,OAAO,KAAK,cAAc,EAAE;gBAC5B,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aAC5B;QACL,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEvB,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAuB;QAC1B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnB,OAAO,KAAK,CAAC;SAChB;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAErC,gEAAgE;QAChE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAEnD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEhC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,QAAQ;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,UAAU;QACN,MAAM,MAAM,GAAQ,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACzC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;SAC3C;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,MAAuB;QACvB,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,MAAuB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,MAAuB;QAC1C,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,kBAAkB,IAAI,MAAM,EAAE,CAAC,CAAC;SAC3D;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACK,eAAe,CAAC,MAAuB;QAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,kBAAkB,IAAI,MAAM,EAAE,CAAC,CAAC;SAC3D;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,MAAc,EAAE,QAAW;QAC3B,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE7B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;QAE/B,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,WAAW;QACf,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;YAC3B,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YACnD,IAAI,OAAO,KAAK,KAAK,EAAE;gBACnB,MAAM;aACT;SACJ;IACL,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,WAAW;QACvB,IAAI,GAAG,CAAC;QAAC,IAAI,OAAO,CAAC;QACrB,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAC9C,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACrB,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7C,IAAI,OAAO,KAAK,KAAK,EAAE;gBACnB,MAAM;aACT;SACJ;IACL,CAAC;IAED;;OAEG;IACH,QAAQ;QACJ,MAAM,MAAM,GAAG,EAAE,CAAC;QAElB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAS,IAAI,EAAE,GAAG;YAClC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,OAAO;QACH,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAI;QACA,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACjC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SACtB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK;QACD,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;YACxB,OAAO,IAAI,CAAC;SACf;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1B,uEAAuE;QACvE,uBAAuB;QAEvB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;YAC3B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,KAAK;QACD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAI,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,aAA4B;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,MAAM,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC;QAEhC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACtB,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC7B,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/* eslint accessor-pairs: [2, { \"getWithoutSet\": false }] */\n/**\n * @fileoverview Collection class definition\n */\nimport _ from \"lodash\";\n\nconst MSGS = {\n    TYPE_MISMATCH: \"Type does not match this collection type\",\n    KEY_ALREADY_EXISTS: \"Collection key already exists. \",\n    KEY_DOES_NOT_EXIST: \"Collection key does not exist in this collection.\",\n    MUST_GIVE_KEY: \"Collection missing key.\",\n    MUST_GIVE_VALUE: \"Collection missing value.\",\n    KEY_NOT_VALID: \"Key must be of type String or Number\",\n};\n\nexport class Collection<T> {\n    protected _items: { [key: string]: T } = {};\n    protected _order: (string | number)[] = [];\n\n    /**\n     * @param _name - a friendly name to describe this collection. If undefined\n     * the collection will have a default \"Untitled Collection\" assigned to its name.\n     * @param _type - optional parameter pointing to the constructor\n     * of a type this Collection will host.\n     */\n    constructor(protected _name = \"Untitled Collection\", protected _type?: new () => any) {\n    }\n\n    // Pass-thru binding handles\n    onAdd(in_key, in_value) { }\n    onRemove(in_key, in_value) { }\n    onClear(in_items) { }\n\n    public get items() {\n        return this._items;\n    }\n\n    public get keys() {\n        return Object.keys(this._items);\n    }\n\n    /**\n     * @param in_key - Key to store the value under\n     * @param in_value - Value to store in the collection\n     * @returns Return the value passed in\n     */\n    add(in_key: number | string, in_value: T): T {\n        this._checkType(in_value);\n        this._checkIsNewKey(in_key);\n\n        this._items[in_key] = in_value;\n        this._order.push(in_key);\n\n        this.onAdd(in_key, in_value);\n\n        return in_value;\n    }\n\n    /**\n     * Checks if in_value's type is equal to this Collection type. If this collection\n     * has no type set, the check will pass.\n     *\n     * @param in_value - A value that is equal to the type managed by this collection.\n     * @returns Return true if the type is a valid type for this\n     * collection, throw otherwise.\n     */\n    private _checkType(in_value: T) {\n        if (this._type && !(in_value instanceof this._type)) {\n            throw new Error(MSGS.TYPE_MISMATCH);\n        } else {\n            return true;\n        }\n    }\n\n    /**\n     * Bulk add items.\n     * @param in_items - List of key-value pairs to be stored in the collection\n     * @returns this collection after add\n     */\n    bulkAdd(in_items: { [key: string]: T }) {\n        _.each(in_items, (item, key) => {\n            this.add(key, item);\n        });\n        return this;\n    }\n\n    /**\n     * Bulk remove items.\n     * @param in_items - List of key-value items to be removed\n     * @returns this collection after add\n     */\n    bulkRemove(in_items: { [key: string]: T }) {\n        _.each(in_items, (item, key) => {\n            this.remove(key);\n        });\n\n        return this;\n    }\n\n    /**\n     * Test if this collection is empty\n     * @returns true if empty, false otherwise\n     * */\n    isEmpty() {\n        return _.isEmpty(this._items);\n    }\n\n    /**\n     * Return the first item in the collection, null if empty\n     * @returns first item, or undefined if empty\n     * */\n    getFirstItem(): T | undefined {\n        const index = _.first(this._order);\n        return index === undefined ? index : this._items[index];\n    }\n\n    /**\n     * Return the last item in the collection, null if empty\n     * @returns - last item, or undefined if empty\n     * */\n    getLastItem(): T | undefined {\n        const index = _.last(this._order);\n        return index === undefined ? index : this._items[index];\n    }\n\n    /**\n     * @returns Returns the type of collection (Array, etc.)\n     */\n    getType() {\n        return this._type;\n    }\n\n    /**\n     * @returns Returns the name of the collection\n     */\n    getName(): string {\n        return this._name;\n    }\n\n    /**\n     * Filter out by function\n     * @param in_filterFunction - with arguments key and item\n     * @returns  New filtered collection\n     */\n    filter(in_filterFunction: (key: string, item: T) => boolean): Collection<T> {\n        const rtn = new Collection<T>();\n\n        const filterCb = function(in_key, in_item) {\n            const keeper = in_filterFunction(in_key, in_item);\n            if (keeper) {\n                rtn.add(in_key, in_item);\n            }\n        };\n\n        this.iterate(filterCb);\n\n        return rtn;\n    }\n\n    /**\n     * Filter out all keys NOT matching the in_filterKey\n     * @param in_filterKey - a single key or an array of keys, if the\n     * item matches any of the keys it will be filtered in.\n     * @returns New filtered collection with all the items\n     * matching at least one key.\n     */\n    filterByKey(in_filterKey: string | string[]): Collection<T> {\n        const rtn = new Collection<T>();\n\n        let filterCb;\n\n        if (_.isArray(in_filterKey)) {\n            filterCb = function(in_key, in_item) {\n                if (in_filterKey.indexOf(in_key) >= 0) {\n                    rtn.add(in_key, in_item);\n                }\n            };\n        } else {\n            // if in_filterKey is an array\n            filterCb = function(in_key, in_item) {\n                if (in_key === in_filterKey) {\n                    rtn.add(in_key, in_item);\n                }\n            };\n        }\n\n        this.iterate(filterCb);\n\n        return rtn;\n    }\n\n    /**\n     * Filter out all keys NOT matching the in_filterValue\n     * @param in_filterValue - Value to filter on\n     * @returns Return a filtered collection\n     */\n    filterByValue(in_filterValue: T): Collection<T> {\n        const rtn = new Collection<T>();\n\n        const filterCb = function(in_key, in_item) {\n            if (in_item === in_filterValue) {\n                rtn.add(in_key, in_item);\n            }\n        };\n\n        this.iterate(filterCb);\n\n        return rtn;\n    }\n\n    /**\n     * Remove an item from this Collection. This method returns a Boolean indicating\n     * the success or failure of the removal. This is practical because if we were\n     * to throw an error when the key doesn't exist, it would require additional\n     * checks by the caller to make sure this key exists prior to removal. Which\n     * would make the attempt of removal more verbose and also costly because the\n     * caller would have to keep a list – somewhere else – of the things he can\n     * and cannot remove.\n     *\n     * @param in_key - the key we wish to remove\n     * @returns true if the key exists and was removed, false otherwise.\n     */\n    remove(in_key: number | string): boolean {\n        if (!this.has(in_key)) {\n            return false;\n        }\n\n        const remember = this._items[in_key];\n\n        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete\n        delete this._items[in_key];\n        this._order.splice(this._order.indexOf(in_key), 1);\n\n        this.onRemove(in_key, remember);\n\n        return true;\n    }\n\n    /**\n     * Return the number of items in this Collection\n     * @returns the number of items in the collection\n     */\n    getCount(): number {\n        return this._order.length;\n    }\n\n    /**\n     * Returns this collection as an ordered Array\n     * @returns Array including the values\n     */\n    getAsArray() {\n        const rtnArr: T[] = new Array(this.getCount());\n\n        for (let i = 0; i < this._order.length; i++) {\n            rtnArr[i] = this._items[this._order[i]];\n        }\n\n        return rtnArr;\n    }\n\n    /**\n     * @param in_key - the key we are looking for\n     * @returns true if the item exists\n     */\n    has(in_key: string | number): boolean {\n        return Object.prototype.hasOwnProperty.call(this._items, in_key);\n    }\n\n    /**\n     * Return an item associated with the given key\n     * @param in_key - the key for the item in this\n     * Collection\n     * @returns The item\n     */\n    item(in_key: number | string) {\n        return this._items[in_key];\n    }\n\n    /**\n     * Checks if this is a new key in the collection. Throw if already exists.\n     * @param in_key - The key to check against\n     * @returns true if key is new\n     */\n    private _checkIsNewKey(in_key: number | string) {\n        if (this.has(in_key)) {\n            throw new Error(`${MSGS.KEY_ALREADY_EXISTS} ${in_key}`);\n        }\n\n        return true;\n    }\n\n    /**\n     * Checks if the key exists in the collection. Throw if not.\n     * @param in_key - the key to check against\n     * @returns true if key exists\n     */\n    private _checkKeyExists(in_key: number | string) {\n        if (!this.has(in_key)) {\n            throw new Error(`${MSGS.KEY_DOES_NOT_EXIST} ${in_key}`);\n        }\n\n        return true;\n    }\n\n    /**\n     * Set an existing key to a value. If key doesn't exist this call will throw\n     * an error.\n     * @param in_key - the key we want to modify\n     * @param  in_value - the value we are to set at this key\n     * @returns the value passed in\n     */\n    set(in_key: string, in_value: T) {\n        this._checkKeyExists(in_key);\n\n        this._items[in_key] = in_value;\n\n        return in_value;\n    }\n\n    /**\n     * Iterate over this collection and run the callback with passing the key and\n     * item in the iteration loop.\n     * @param  in_callback - a function that we will call on each item\n     * of this collection. If the callback returns false then the iteration will exit early.\n     */\n    iterate(in_callback) {\n        for (const key of this._order) {\n            const continu = in_callback(key, this._items[key]);\n            if (continu === false) {\n                break;\n            }\n        }\n    }\n\n    /**\n     * Iterate over this collection starting from the tail and run the callback with passing the key and\n     * item in the iteration loop.\n     * @param in_callback - a function that we will call on each item\n     * of this collection. If the callback returns false then the iteration will exit early.\n     */\n    iterateFromTail(in_callback) {\n        let key; let continu;\n        for (let i = this._order.length - 1; i >= 0; i--) {\n            key = this._order[i];\n            continu = in_callback(key, this._items[key]);\n            if (continu === false) {\n                break;\n            }\n        }\n    }\n\n    /**\n     * @returns Return an object containing the items of this collection\n     */\n    getItems(): { [key: string]: T } {\n        const result = {};\n\n        _.each(this._items, function(item, key) {\n            result[key] = item;\n        });\n\n        return result;\n    }\n\n    /**\n     * Return the list of keys\n     * @returns List of keys\n     */\n    getKeys(): string[] {\n        return Object.keys(this._items);\n    }\n\n    /**\n     * Method used to get the first element in the collection along with its key.\n     */\n    peak() {\n        return {\n            item: this._items[this._order[0]],\n            key: this._order[0],\n        };\n    }\n\n    /**\n     * Clear this collection\n     * @returns this collection\n     */\n    clear() {\n        if (_.isEmpty(this._items)) {\n            return this;\n        }\n\n        this.onClear(this._items);\n\n        // Best to just iterate through and remove everything, so that OnRemove\n        // handlers are called.\n\n        _.each(this.getKeys(), (key) => {\n            this.remove(key);\n        });\n\n        return this;\n    }\n\n    /**\n     * Copy the items of in_collection to this collection.\n     * @param in_collection - the collection we want to\n     * copy from.\n     * @returns new Collection\n     */\n    clone(): Collection<T> {\n        const newCol = new Collection<T>(this._name, this._type);\n        newCol.bulkAdd(this._items);\n        return newCol;\n    }\n\n    /**\n     * Copy the items of in_collection to this collection.\n     * @param in_collection - the collection we want to\n     * copy from.\n     */\n    copy(in_collection: Collection<T>) {\n        this.clear();\n        const its = in_collection.items;\n\n        _.each(its, (item, key) => {\n            this.add(key, item);\n        });\n    }\n\n    get values() {\n        return this.getAsArray();\n    }\n}\n"]}

package/lib/datastructures/dataArray.d.ts

@@ -0,0 +1,275 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ @fileoverview The data arrays definition file.
+ */
+/**
+  * A typed data container that is persistable, high-performance, and can be used
+  * as a backing store for collaborative property sets.
+ */
+declare class BaseDataArray {
+    protected _buffer: any;
+    private readonly bufferConstructor;
+    protected size: number;
+    constructor(size: number);
+    /**
+     * @param bufferConstructor - This is the constructor to be used to
+     *    setup the internal buffer of the DataArray.
+     * @param size - The initial size with which to allocate the array.
+     */
+    constructor(bufferConstructor: any, size: number);
+    /**
+     * Get the value at an index. If no index is passed, return zeroth item.
+     * @param in_idx -  the specific item in the data array.
+     * @returns the value at that index
+     */
+    getValue(in_idx?: number): any;
+    /**
+     * Return a range of values in the array.
+     * @param in_idxStart - the starting index
+     * @param in_idxEnd - the end index
+     * @returns the array of values in the range
+     */
+    getValueRange(in_idxStart: number, in_idxEnd: number): any;
+    /**
+     * Return the serialized form of Data Arrays.
+     * @returns An object containing an array of the values.
+     */
+    serialize(): number[];
+    /**
+     * Deserialize data from a serialized representation
+     * @param in_serialized - the serialized representation
+     */
+    deserialize(in_serialized: any): void;
+    /**
+     * Set value at an index.
+     * @param in_idx - the index
+     * @param in_value - the value we want to set at index
+     */
+    setValue(in_idx: number, in_value: any): void;
+    /**
+     * creates a copy of a typed array with removed elements
+     * @param in_arr - the input array (won't be modified)
+     * @param in_offset - starting index of range that will be removed
+     * @param in_deleteCount - number of removed elements
+     * @returns a copy of the input array without the selected range
+     */
+    private _removeElementsFromArray;
+    /**
+     * remove a range of elements from the array
+     * @param in_offset - start of the range
+     * @param in_deleteCount - number of elements to be removed
+     */
+    removeRange(in_offset: number, in_deleteCount: number): void;
+    /**
+     * copy an array with elements inserted into the copy
+     * @param in_arr - the input array (won't be modified)
+     * @param in_offset - the index where the new elements will be inserted
+     * @param in_addedArray - the array with the elements that will be added
+     * @returns the combined array
+     */
+    private _insert;
+    /**
+     * insert the content of an array into the DataArray
+     * @param in_offset - the target index
+     * @param in_array - the array to be inserted
+     */
+    insertRange(in_offset: number, in_array: any): void;
+    /**
+     * Set this array values to be equal to in_array values
+     * @param in_offset - An optional offset in this array to begin start
+     *                  setting this arrays values to in_array values.
+     * @param in_array - the input array
+     */
+    set(in_offset: number, in_array: any): void;
+    /**
+     * insert a value at the end of the array, creates a new element at the end and sets the value
+     * @param in_value - the new value
+     */
+    push(in_value: any): void;
+    /**
+     * get direct access to the data (for performance reasons)
+     * this should be uses read only
+     * @returns the (read only) raw data
+     */
+    getBuffer(): any;
+    /**
+     * get the constructor of the underlying TypedArray
+     * @returns the constructor for the data buffer
+     */
+    getBufferCtor(): any;
+    /**
+     * apply a given function to all elements of the array
+     * @param in_fn - the function that will be applied to every element
+     */
+    iterate(in_fn: any): void;
+    /**
+     * get a resized buffer copy
+     * @param in_bufferCtor - the constructor for the returned buffer
+     * @param in_buffer - the input buffer (won't be modified)
+     * @param in_newSize - the target size
+     * @returns the buffer with the new size
+     */
+    private resizeBuffer;
+    /**
+     * allocate memory for the array (for performance reasons, you can allocate more space than the current length,
+     * which makes pushes to the array less expensive later)
+     * @param size - the target allocated space
+     * @returns the DataArray itself
+     */
+    protected _alloc(size: number): any;
+    /**
+     * change the size of the array
+     * @param size - the target size
+     * @returns  the DataArray itself
+     */
+    resize(size: number): this;
+    copy(): any;
+    get length(): number;
+}
+declare class Int8DataArray extends BaseDataArray {
+    constructor(size: number);
+}
+declare class Int16DataArray extends BaseDataArray {
+    constructor(size: number);
+}
+declare class Int32DataArray extends BaseDataArray {
+    constructor(size: number);
+}
+declare class Uint8DataArray extends BaseDataArray {
+    constructor(size: number);
+}
+declare class Uint16DataArray extends BaseDataArray {
+    constructor(size: number);
+}
+declare class Uint32DataArray extends BaseDataArray {
+    constructor(size: number);
+}
+declare class Float32DataArray extends BaseDataArray {
+    constructor(size: number);
+}
+declare class Float64DataArray extends BaseDataArray {
+    constructor(size: number);
+}
+/**
+ * A data container that can contain every native type
+ *
+ * @param size - The initial size with which to allocate the array.
+ */
+declare class UniversalDataArray extends BaseDataArray {
+    constructor(bufferConstructor: any, size: number);
+    constructor(size: number);
+    /**
+ * helper function to write array values into another array at a given offset
+ * @param array - target array
+ * @param values - the values we need to write
+ * @param offset - starting index in target array
+ */
+    private arraySet;
+    /**
+     * insert the content of an array into the DataArray
+     * @param in_offset - the target index
+     * @param  in_array - the array to be inserted
+     */
+    insertRange(in_offset: number, in_array: any[]): void;
+    /**
+     * remove a range of elements from the array
+     * @param in_offset - start of the range
+     * @param in_deleteCount - number of elements to be removed
+     */
+    removeRange(in_offset: number, in_deleteCount: number): void;
+    /**
+     * Set this array values to be equal to in_array values
+     * @param in_offset - An optional offset in this array to begin start
+     *                  setting this arrays values to in_array values.
+     * @param in_array - the input array
+     */
+    set(in_offset: number, in_array: any): void;
+    /**
+     * Return a range of values in the array.
+     * @param in_idxStart - the starting index
+     * @param in_idxEnd - the end index - this offset is exclusive
+     * @returns the array of values in the range
+     */
+    getValueRange(in_idxStart: number, in_idxEnd: number): any;
+    /**
+     * change the size of a javascript array and keep the content, if possible. Keeps the input buffer.
+     * @param in_buffer - input buffer - not changed
+     * @param in_newSize - target size
+     * @returns an Array of the new size
+     */
+    private resizeBufferArray;
+    /**
+     * allocate memory for the array (for performance reasons, you can allocate more space than the current length,
+     * which makes pushes to the array less expensive later)
+     * @param size - the target allocated space
+     * @returns the DataArray itself
+     */
+    protected _alloc(size: number): any;
+}
+/**
+ * A data container that contains a string
+ */
+declare class StringDataArray extends BaseDataArray {
+    constructor();
+    /**
+     * insert the content of a string into the StringDataArray
+     * @param in_offset - the target index
+     * @param in_string - the string to be inserted
+     */
+    insertRange(in_offset: number, in_string: string): void;
+    /**
+     * remove a range of elements from the string
+     * @param in_offset - start of the range
+     * @param in_deleteCount - number of elements to be removed
+     */
+    removeRange(in_offset: number, in_deleteCount: number): void;
+    /**
+     * Set this array values to be equal to in_string values
+     * @param in_offset - The offset in this array to begin start
+     *                  setting this arrays values to in_string values.
+     * @param in_string - the input string
+     */
+    set(in_offset: number, in_string: string): void;
+    /**
+     * Return a range of characters in the string.
+     * @param in_idxStart - the starting index
+     * @param in_idxEnd - the end index - this offset is exclusive
+     * @returns the characters in the range
+     */
+    getValueRange(in_idxStart: number, in_idxEnd: number): string;
+    get length(): any;
+}
+/**
+ * A data container that can contain boolean type
+ */
+declare class BoolDataArray extends UniversalDataArray {
+    /**
+     * @param size - The initial size with which to allocate the array.
+     */
+    constructor(size: number);
+    /**
+     * helper function to write and cast to boolean array values into another array at a given offset
+     * @param array - target array
+     * @param values - the values we need to write
+     * @param offset - starting index in target array
+     */
+    private arraySetBool;
+    /**
+     * insert the content of an array into the DataArray
+     * @param in_offset - the target index
+     * @param in_array - the array to be inserted
+     */
+    insertRange(in_offset: number, in_array: any[]): void;
+    /**
+     * Set this array values to be equal to in_array values
+     * @param in_offset - An optional offset in this array to begin start
+     *                  setting this arrays values to in_array values.
+     * @param in_array - the input array
+     */
+    set(in_offset: number, in_array: any): void;
+}
+export { BaseDataArray, Float32DataArray, Float64DataArray, Int8DataArray, Int16DataArray, Int32DataArray, Uint8DataArray, Uint16DataArray, Uint32DataArray, UniversalDataArray, StringDataArray, BoolDataArray, };
+//# sourceMappingURL=dataArray.d.ts.map