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

package/lib/datastructures/integer64.js

@@ -0,0 +1,140 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * @fileoverview implements (U)Int64 Datastructures
+ */
+import _ from "lodash";
+import { ConsoleUtils } from "../consoleUtils";
+import { constants } from "../constants";
+const BIT32 = 4294967296;
+const { MSG } = constants;
+/**
+ * A data representation class for 64 bit integer types.
+ * This is necessary since js doesn't support 64bit
+ * integers natively yet.
+ *
+ * Please note this class is immutable.
+ * There are and there won't be set functions!
+ * (see javascript String class)
+ *
+ * @param low  - lower 32 bit
+ * @param high - higher 32 bit
+ */
+export class Integer64 {
+    constructor(low = 0, high = 0) {
+        this.low = low;
+        this.high = high;
+    }
+    /**
+     * @returns the higher 32 bit integer part
+     */
+    getValueHigh() {
+        return this.high;
+    }
+    /**
+     * @returns the lower 32 bit integer part
+     */
+    getValueLow() {
+        return this.low;
+    }
+    _int64toString(isSigned, in_radix = 10) {
+        ConsoleUtils.assert(_.isNumber(in_radix), `${MSG.IN_RADIX_MUST_BE_NUMBER} ${in_radix}`);
+        ConsoleUtils.assert(in_radix >= 2 && 36 >= in_radix, `${MSG.BASE_OUT_OF_RANGE} ${in_radix}`);
+        let high = this.getValueHigh();
+        let low = this.getValueLow();
+        let result = "";
+        const sign = !!(isSigned && (high & 0x80000000)); // eslint-disable-line no-bitwise
+        if (sign) {
+            high = ~high; // eslint-disable-line no-bitwise
+            low = BIT32 - low;
+        }
+        do {
+            const mod = (high % in_radix) * BIT32 + low;
+            high = Math.floor(high / in_radix);
+            low = Math.floor(mod / in_radix);
+            result = (mod % in_radix).toString(in_radix) + result;
+        } while (high || low);
+        return sign ? `-${result}` : result;
+    }
+}
+/**
+ * stringToInt function parses a string argument updates object's lower and higher 32 bit integer parts.
+ *
+ * @param in_signed - If the expect response should be signed or unsigned.
+ * @param in_string - The value to parse. Leading whitespace in the string argument is ignored.
+ * @param in_radix - An integer between 2 and 36 that represents the
+ *     radix (the base in mathematical numeral systems) of the above mentioned string.
+ * @throws if in_string is not a string
+ * @throws if in_radix is entered but is not a number between 2 and 36
+ * @throws if the property is a Uint64 property and in_string is a negative number
+ * @throws if in_string contains characters other than numbers
+ * @returns low and high bits of Int64
+ */
+function _stringToInt64(in_signed, in_string, in_radix = 10) {
+    ConsoleUtils.assert(_.isString(in_string), MSG.IN_STRING_MUST_BE_STRING + in_string);
+    const string = in_string.trim();
+    ConsoleUtils.assert(_.isNumber(in_radix), `${MSG.IN_RADIX_BETWEEN_2_36}  ${in_radix}`);
+    ConsoleUtils.assert(in_radix >= 2 && 36 >= in_radix, `${MSG.BASE_OUT_OF_RANGE} ${in_radix}`);
+    let position = 0;
+    let negative = false;
+    let high = 0;
+    let low = 0;
+    if (string[0] === "-") {
+        negative = true;
+        position += 1;
+    }
+    ConsoleUtils.assert(!negative || in_signed, MSG.CANNOT_UPDATE_TO_NEGATIVE + string);
+    while (position < string.length) {
+        const digit = parseInt(string[position++], in_radix);
+        if (isNaN(digit)) {
+            throw new Error(MSG.CANNOT_PARSE_INVALID_CHARACTERS + string);
+        }
+        low = low * in_radix + digit;
+        high = high * in_radix + Math.floor(low / BIT32);
+        low %= BIT32;
+    }
+    if (negative) {
+        // eslint-disable-next-line no-bitwise
+        high = ~high;
+        if (low) {
+            low = BIT32 - low;
+        }
+        else {
+            high += 1;
+        }
+    }
+    return [low, high];
+}
+/**
+ * A data representation class for the signed 64 bit integer type
+ */
+export class Int64 extends Integer64 {
+    clone() {
+        return new Int64(this.low, this.high);
+    }
+    toString(radix = 10) {
+        return this._int64toString(true, radix);
+    }
+}
+Int64.fromString = function (in_string, radix = 10) {
+    const [low, high] = _stringToInt64(true, in_string, radix);
+    return new Int64(low, high);
+};
+/**
+ * A data representation class for the unsigned 64 bit integer type
+ */
+export class Uint64 extends Integer64 {
+    static fromString(in_string, in_radix = 10) {
+        const [low, high] = _stringToInt64.call(this, false, in_string, in_radix);
+        return new Uint64(low, high);
+    }
+    clone() {
+        return new Uint64(this.low, this.high);
+    }
+    toString(radix) {
+        return this._int64toString(false, radix);
+    }
+}
+//# sourceMappingURL=integer64.js.map

package/lib/datastructures/integer64.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integer64.js","sourceRoot":"","sources":["../../src/datastructures/integer64.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AAEH,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,KAAK,GAAG,UAAU,CAAC;AACzB,MAAM,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC;AAC1B;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,SAAS;IAClB,YAAsB,MAAM,CAAC,EAAY,OAAO,CAAC;QAA3B,QAAG,GAAH,GAAG,CAAI;QAAY,SAAI,GAAJ,IAAI,CAAI;IACjD,CAAC;IAED;;OAEG;IACH,YAAY;QACR,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,WAAW;QACP,OAAO,IAAI,CAAC,GAAG,CAAC;IACpB,CAAC;IAES,cAAc,CAAC,QAAiB,EAAE,QAAQ,GAAG,EAAE;QACrD,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,GAAG,GAAG,CAAC,uBAAuB,IAAI,QAAQ,EAAE,CAAC,CAAC;QACxF,YAAY,CAAC,MAAM,CAAC,QAAQ,IAAI,CAAC,IAAI,EAAE,IAAI,QAAQ,EAAE,GAAG,GAAG,CAAC,iBAAiB,IAAI,QAAQ,EAAE,CAAC,CAAC;QAE7F,IAAI,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAC/B,IAAI,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC7B,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,iCAAiC;QACnF,IAAI,IAAI,EAAE;YACN,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,iCAAiC;YAC/C,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC;SACrB;QACD,GAAG;YACC,MAAM,GAAG,GAAG,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,KAAK,GAAG,GAAG,CAAC;YAC5C,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC;YACnC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC;YACjC,MAAM,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACzD,QAAQ,IAAI,IAAI,GAAG,EAAE;QAEtB,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IACxC,CAAC;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,cAAc,CAAC,SAAkB,EAAE,SAAiB,EAAE,QAAQ,GAAG,EAAE;IACxE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;IACrF,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;IAEhC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,GAAG,GAAG,CAAC,qBAAqB,KAAK,QAAQ,EAAE,CAAC,CAAC;IACvF,YAAY,CAAC,MAAM,CAAC,QAAQ,IAAI,CAAC,IAAI,EAAE,IAAI,QAAQ,EAAE,GAAG,GAAG,CAAC,iBAAiB,IAAI,QAAQ,EAAE,CAAC,CAAC;IAE7F,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;QACnB,QAAQ,GAAG,IAAI,CAAC;QAChB,QAAQ,IAAI,CAAC,CAAC;KACjB;IAED,YAAY,CAAC,MAAM,CAAC,CAAC,QAAQ,IAAI,SAAS,EAAE,GAAG,CAAC,yBAAyB,GAAG,MAAM,CAAC,CAAC;IAEpF,OAAO,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE;QAC7B,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,+BAA+B,GAAG,MAAM,CAAC,CAAC;SACjE;QACD,GAAG,GAAG,GAAG,GAAG,QAAQ,GAAG,KAAK,CAAC;QAC7B,IAAI,GAAG,IAAI,GAAG,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;QACjD,GAAG,IAAI,KAAK,CAAC;KAChB;IAED,IAAI,QAAQ,EAAE;QACV,sCAAsC;QACtC,IAAI,GAAG,CAAC,IAAI,CAAC;QACb,IAAI,GAAG,EAAE;YACL,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC;SACrB;aAAM;YACH,IAAI,IAAI,CAAC,CAAC;SACb;KACJ;IAED,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,SAAS;IAMhC,KAAK;QACD,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,QAAQ,CAAC,KAAK,GAAG,EAAE;QACf,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;;AAXM,gBAAU,GAAG,UAAS,SAAiB,EAAE,KAAK,GAAG,EAAE;IACtD,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAC3D,OAAO,IAAI,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AAChC,CAAC,CAAC;AAWN;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,SAAS;IACjC,MAAM,CAAC,UAAU,CAAC,SAAiB,EAAE,QAAQ,GAAG,EAAE;QAC9C,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC1E,OAAO,IAAI,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,KAAK;QACD,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,QAAQ,CAAC,KAAK;QACV,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * @fileoverview implements (U)Int64 Datastructures\n */\n\nimport _ from \"lodash\";\nimport { ConsoleUtils } from \"../consoleUtils\";\nimport { constants } from \"../constants\";\n\nconst BIT32 = 4294967296;\nconst { MSG } = constants;\n/**\n * A data representation class for 64 bit integer types.\n * This is necessary since js doesn't support 64bit\n * integers natively yet.\n *\n * Please note this class is immutable.\n * There are and there won't be set functions!\n * (see javascript String class)\n *\n * @param low  - lower 32 bit\n * @param high - higher 32 bit\n */\nexport class Integer64 {\n    constructor(protected low = 0, protected high = 0) {\n    }\n\n    /**\n     * @returns the higher 32 bit integer part\n     */\n    getValueHigh() {\n        return this.high;\n    }\n\n    /**\n     * @returns the lower 32 bit integer part\n     */\n    getValueLow() {\n        return this.low;\n    }\n\n    protected _int64toString(isSigned: boolean, in_radix = 10): string {\n        ConsoleUtils.assert(_.isNumber(in_radix), `${MSG.IN_RADIX_MUST_BE_NUMBER} ${in_radix}`);\n        ConsoleUtils.assert(in_radix >= 2 && 36 >= in_radix, `${MSG.BASE_OUT_OF_RANGE} ${in_radix}`);\n\n        let high = this.getValueHigh();\n        let low = this.getValueLow();\n        let result = \"\";\n        const sign = !!(isSigned && (high & 0x80000000)); // eslint-disable-line no-bitwise\n        if (sign) {\n            high = ~high; // eslint-disable-line no-bitwise\n            low = BIT32 - low;\n        }\n        do {\n            const mod = (high % in_radix) * BIT32 + low;\n            high = Math.floor(high / in_radix);\n            low = Math.floor(mod / in_radix);\n            result = (mod % in_radix).toString(in_radix) + result;\n        } while (high || low);\n\n        return sign ? `-${result}` : result;\n    }\n}\n\n/**\n * stringToInt function parses a string argument updates object's lower and higher 32 bit integer parts.\n *\n * @param in_signed - If the expect response should be signed or unsigned.\n * @param in_string - The value to parse. Leading whitespace in the string argument is ignored.\n * @param in_radix - An integer between 2 and 36 that represents the\n *     radix (the base in mathematical numeral systems) of the above mentioned string.\n * @throws if in_string is not a string\n * @throws if in_radix is entered but is not a number between 2 and 36\n * @throws if the property is a Uint64 property and in_string is a negative number\n * @throws if in_string contains characters other than numbers\n * @returns low and high bits of Int64\n */\nfunction _stringToInt64(in_signed: boolean, in_string: string, in_radix = 10): number[] {\n    ConsoleUtils.assert(_.isString(in_string), MSG.IN_STRING_MUST_BE_STRING + in_string);\n    const string = in_string.trim();\n\n    ConsoleUtils.assert(_.isNumber(in_radix), `${MSG.IN_RADIX_BETWEEN_2_36}  ${in_radix}`);\n    ConsoleUtils.assert(in_radix >= 2 && 36 >= in_radix, `${MSG.BASE_OUT_OF_RANGE} ${in_radix}`);\n\n    let position = 0;\n    let negative = false;\n    let high = 0;\n    let low = 0;\n    if (string[0] === \"-\") {\n        negative = true;\n        position += 1;\n    }\n\n    ConsoleUtils.assert(!negative || in_signed, MSG.CANNOT_UPDATE_TO_NEGATIVE + string);\n\n    while (position < string.length) {\n        const digit = parseInt(string[position++], in_radix);\n        if (isNaN(digit)) {\n            throw new Error(MSG.CANNOT_PARSE_INVALID_CHARACTERS + string);\n        }\n        low = low * in_radix + digit;\n        high = high * in_radix + Math.floor(low / BIT32);\n        low %= BIT32;\n    }\n\n    if (negative) {\n        // eslint-disable-next-line no-bitwise\n        high = ~high;\n        if (low) {\n            low = BIT32 - low;\n        } else {\n            high += 1;\n        }\n    }\n\n    return [low, high];\n}\n\n/**\n * A data representation class for the signed 64 bit integer type\n */\nexport class Int64 extends Integer64 {\n    static fromString = function(in_string: string, radix = 10) {\n        const [low, high] = _stringToInt64(true, in_string, radix);\n        return new Int64(low, high);\n    };\n\n    clone() {\n        return new Int64(this.low, this.high);\n    }\n\n    toString(radix = 10) {\n        return this._int64toString(true, radix);\n    }\n}\n\n/**\n * A data representation class for the unsigned 64 bit integer type\n */\nexport class Uint64 extends Integer64 {\n    static fromString(in_string: string, in_radix = 10) {\n        const [low, high] = _stringToInt64.call(this, false, in_string, in_radix);\n        return new Uint64(low, high);\n    }\n\n    clone() {\n        return new Uint64(this.low, this.high);\n    }\n\n    toString(radix) {\n        return this._int64toString(false, radix);\n    }\n}\n"]}

package/lib/datastructures/sortedCollection.d.ts

@@ -0,0 +1,77 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Collection } from "./collection";
+export declare class SortedCollection<T> extends Collection<T> {
+    private _sortedKeys;
+    private _comparisonFunction?;
+    /**
+     * A sorted collection class.
+     * @param in_name - a friendly name to describe this collection. If undefined
+     * the collection will have a default "Untitled Collection" assigned to its name.
+     * @param in_type - optional parameter pointing to the constructor
+     * of a type this Collection will host.
+     */
+    constructor(in_name?: string, in_type?: any);
+    /**
+     * Set the comparison function. By default the keys will be sorted wrt their ASCII code.
+     * @param in_fn - The function to compare two entries.
+     *  the return value of this function must convey to the following cases:
+     *  - if a \> b, then the return value must be greater than 0
+     *  - if a \< b, then the return value must be less than 0
+     *  - if a == b, then the return value must be 0
+     */
+    setComparisonFunction(in_fn?: (x: string, y: string) => number): void;
+    /**
+     * Add an item to the collection. Sort the list of keys in an ascending order.
+     * @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: string | number, in_value: T): T;
+    /**
+     * 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: string): boolean;
+    /**
+     * Copy the items of in_collection to this collection.
+     * @returns cloned SortedCollection
+     */
+    clone(): SortedCollection<T>;
+    /**
+     * Internal function use to search (binary search) for the nearest index that
+     * the given key would be inserted.
+     * i.e. given the array [10, 20, 30, 40, 50] the index that 35 should be inserted at is 3
+     * @param in_array - Target array
+     * @param in_key - Key to check against
+     * @returns The index at which the key would be inserted in
+     */
+    private _binarySearchNearestIndex;
+    /**
+     * Return the nearest next item to the given key i.e.
+     * For the given list of keys ['1.0.1', '2.0.0', '2.2.0', '7.0.1'] the nearest next item to 6.0.1 is
+     * the item mapped by '7.0.1'
+     * @param in_key - The key to check against in order to get the nearest next item
+     * @returns  The nearest next item
+     */
+    getNearestNextItem(in_key: string): T | undefined;
+    /**
+     * Return the nearest previous item to the given key i.e.
+     * For the given list of keys ['1.0.1', '2.0.0', '2.2.0', '7.0.1'] the nearest previous item to 6.0.1 is
+     * the item mapped by '7.0.1'
+     * @param in_key - The key to check against in order to get the nearest previous item
+     * @returns The nearest previous item
+     */
+    getNearestPreviousItem(in_key: string | number): T | undefined;
+}
+//# sourceMappingURL=sortedCollection.d.ts.map

package/lib/datastructures/sortedCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortedCollection.d.ts","sourceRoot":"","sources":["../../src/datastructures/sortedCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,gBAAgB,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAC;IAClD,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,mBAAmB,CAAC,CAA+C;IAE3E;;;;;;OAMG;gBACS,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,KAAA;IAItC;;;;;;;OAOG;IACH,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,MAAM;IAK9D;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC;IASxC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM;IAMrB;;;OAGG;IACH,KAAK,IAAI,gBAAgB,CAAC,CAAC,CAAC;IAO5B;;;;;;;OAOG;IACH,OAAO,CAAC,yBAAyB;IAiCjC;;;;;;OAMG;IACH,kBAAkB,CAAC,MAAM,EAAE,MAAM;IASjC;;;;;;OAMG;IACH,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;CAQjD"}

package/lib/datastructures/sortedCollection.js

@@ -0,0 +1,140 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * @fileoverview
+ * Declaration of the SortedCollection class
+ */
+import _ from "lodash";
+import { Collection } from "./collection";
+export class SortedCollection extends Collection {
+    /**
+     * A sorted collection class.
+     * @param in_name - a friendly name to describe this collection. If undefined
+     * the collection will have a default "Untitled Collection" assigned to its name.
+     * @param in_type - optional parameter pointing to the constructor
+     * of a type this Collection will host.
+     */
+    constructor(in_name, in_type) {
+        super(in_name, in_type);
+        this._sortedKeys = [];
+        this._comparisonFunction = undefined;
+    }
+    /**
+     * Set the comparison function. By default the keys will be sorted wrt their ASCII code.
+     * @param in_fn - The function to compare two entries.
+     *  the return value of this function must convey to the following cases:
+     *  - if a \> b, then the return value must be greater than 0
+     *  - if a \< b, then the return value must be less than 0
+     *  - if a == b, then the return value must be 0
+     */
+    setComparisonFunction(in_fn) {
+        console.assert(_.isFunction(in_fn), "Must provide a function");
+        this._comparisonFunction = in_fn;
+    }
+    /**
+     * Add an item to the collection. Sort the list of keys in an ascending order.
+     * @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) {
+        const toReturn = super.add(in_key, in_value);
+        this._sortedKeys.push(in_key.toString());
+        this._sortedKeys.sort(this._comparisonFunction);
+        return toReturn;
+    }
+    /**
+     * 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) {
+        const toReturn = super.remove(in_key);
+        this._sortedKeys = _.without(this._sortedKeys, in_key);
+        return toReturn;
+    }
+    /**
+     * Copy the items of in_collection to this collection.
+     * @returns cloned SortedCollection
+     */
+    clone() {
+        const newCol = new SortedCollection(this._name, this._type);
+        newCol.setComparisonFunction(this._comparisonFunction);
+        newCol.bulkAdd(this._items);
+        return newCol;
+    }
+    /**
+     * Internal function use to search (binary search) for the nearest index that
+     * the given key would be inserted.
+     * i.e. given the array [10, 20, 30, 40, 50] the index that 35 should be inserted at is 3
+     * @param in_array - Target array
+     * @param in_key - Key to check against
+     * @returns The index at which the key would be inserted in
+     */
+    _binarySearchNearestIndex(in_array, in_key) {
+        if (this._comparisonFunction === undefined) {
+            return _.sortedIndex(in_array, in_key);
+        }
+        else {
+            const middleIndex = Math.floor((in_array.length - 1) / 2);
+            if (middleIndex < 0) {
+                return 0;
+            }
+            if (this._comparisonFunction(in_array[middleIndex], in_key) > 0) {
+                if (in_array.length === 1) {
+                    return 0;
+                }
+                return this._binarySearchNearestIndex(in_array.slice(0, middleIndex), in_key);
+            }
+            if (this._comparisonFunction(in_array[middleIndex], in_key) < 0) {
+                if (in_array.length === 1) {
+                    return 1;
+                }
+                return (middleIndex + 1) + this._binarySearchNearestIndex(in_array.slice(middleIndex + 1, in_array.length), in_key);
+            }
+            return middleIndex;
+        }
+    }
+    /**
+     * Return the nearest next item to the given key i.e.
+     * For the given list of keys ['1.0.1', '2.0.0', '2.2.0', '7.0.1'] the nearest next item to 6.0.1 is
+     * the item mapped by '7.0.1'
+     * @param in_key - The key to check against in order to get the nearest next item
+     * @returns  The nearest next item
+     */
+    getNearestNextItem(in_key) {
+        const closestNextIndex = this._binarySearchNearestIndex(this._sortedKeys, in_key.toString());
+        if (closestNextIndex === this.getCount()) {
+            return undefined;
+        }
+        else {
+            return this.item(this._sortedKeys[closestNextIndex]);
+        }
+    }
+    /**
+     * Return the nearest previous item to the given key i.e.
+     * For the given list of keys ['1.0.1', '2.0.0', '2.2.0', '7.0.1'] the nearest previous item to 6.0.1 is
+     * the item mapped by '7.0.1'
+     * @param in_key - The key to check against in order to get the nearest previous item
+     * @returns The nearest previous item
+     */
+    getNearestPreviousItem(in_key) {
+        const closestPreviousIndex = this._binarySearchNearestIndex(this._sortedKeys, in_key.toString());
+        if (closestPreviousIndex === 0) {
+            return undefined;
+        }
+        else {
+            return this.item(this._sortedKeys[closestPreviousIndex - 1]);
+        }
+    }
+}
+//# sourceMappingURL=sortedCollection.js.map

package/lib/datastructures/sortedCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortedCollection.js","sourceRoot":"","sources":["../../src/datastructures/sortedCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AAEH,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,OAAO,gBAAoB,SAAQ,UAAa;IAIlD;;;;;;OAMG;IACH,YAAY,OAAgB,EAAE,OAAQ;QAClC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAXpB,gBAAW,GAAa,EAAE,CAAC;QAC3B,wBAAmB,GAAsC,SAAS,CAAC;IAW3E,CAAC;IAED;;;;;;;OAOG;IACH,qBAAqB,CAAC,KAAwC;QAC1D,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,yBAAyB,CAAC,CAAC;QAC/D,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,MAAuB,EAAE,QAAW;QACpC,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAE7C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAEhD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAc;QACjB,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACvD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,KAAK;QACD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAI,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/D,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACvD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACK,yBAAyB,CAAC,QAAkB,EAAE,MAAc;QAChE,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE;YACxC,OAAO,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SAC1C;aAAM;YACH,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAE1D,IAAI,WAAW,GAAG,CAAC,EAAE;gBACjB,OAAO,CAAC,CAAC;aACZ;YAED,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE;gBAC7D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;oBACvB,OAAO,CAAC,CAAC;iBACZ;gBAED,OAAO,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC;aACjF;YAED,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE;gBAC7D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;oBACvB,OAAO,CAAC,CAAC;iBACZ;gBAED,OAAO,CAAC,WAAW,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,yBAAyB,CACrD,QAAQ,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,EAChD,MAAM,CACT,CAAC;aACL;YAED,OAAO,WAAW,CAAC;SACtB;IACL,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAAC,MAAc;QAC7B,MAAM,gBAAgB,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7F,IAAI,gBAAgB,KAAK,IAAI,CAAC,QAAQ,EAAE,EAAE;YACtC,OAAO,SAAS,CAAC;SACpB;aAAM;YACH,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC;SACxD;IACL,CAAC;IAED;;;;;;OAMG;IACH,sBAAsB,CAAC,MAAuB;QAC1C,MAAM,oBAAoB,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjG,IAAI,oBAAoB,KAAK,CAAC,EAAE;YAC5B,OAAO,SAAS,CAAC;SACpB;aAAM;YACH,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,oBAAoB,GAAG,CAAC,CAAC,CAAC,CAAC;SAChE;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * @fileoverview\n * Declaration of the SortedCollection class\n */\n\nimport _ from \"lodash\";\nimport { Collection } from \"./collection\";\n\nexport class SortedCollection<T> extends Collection<T> {\n    private _sortedKeys: string[] = [];\n    private _comparisonFunction?: (x: string, y: string) => number = undefined;\n\n    /**\n     * A sorted collection class.\n     * @param in_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 in_type - optional parameter pointing to the constructor\n     * of a type this Collection will host.\n     */\n    constructor(in_name?: string, in_type?) {\n        super(in_name, in_type);\n    }\n\n    /**\n     * Set the comparison function. By default the keys will be sorted wrt their ASCII code.\n     * @param in_fn - The function to compare two entries.\n     *  the return value of this function must convey to the following cases:\n     *  - if a \\> b, then the return value must be greater than 0\n     *  - if a \\< b, then the return value must be less than 0\n     *  - if a == b, then the return value must be 0\n     */\n    setComparisonFunction(in_fn?: (x: string, y: string) => number) {\n        console.assert(_.isFunction(in_fn), \"Must provide a function\");\n        this._comparisonFunction = in_fn;\n    }\n\n    /**\n     * Add an item to the collection. Sort the list of keys in an ascending order.\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: string | number, in_value: T) {\n        const toReturn = super.add(in_key, in_value);\n\n        this._sortedKeys.push(in_key.toString());\n        this._sortedKeys.sort(this._comparisonFunction);\n\n        return toReturn;\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: string) {\n        const toReturn = super.remove(in_key);\n        this._sortedKeys = _.without(this._sortedKeys, in_key);\n        return toReturn;\n    }\n\n    /**\n     * Copy the items of in_collection to this collection.\n     * @returns cloned SortedCollection\n     */\n    clone(): SortedCollection<T> {\n        const newCol = new SortedCollection<T>(this._name, this._type);\n        newCol.setComparisonFunction(this._comparisonFunction);\n        newCol.bulkAdd(this._items);\n        return newCol;\n    }\n\n    /**\n     * Internal function use to search (binary search) for the nearest index that\n     * the given key would be inserted.\n     * i.e. given the array [10, 20, 30, 40, 50] the index that 35 should be inserted at is 3\n     * @param in_array - Target array\n     * @param in_key - Key to check against\n     * @returns The index at which the key would be inserted in\n     */\n    private _binarySearchNearestIndex(in_array: string[], in_key: string): number {\n        if (this._comparisonFunction === undefined) {\n            return _.sortedIndex(in_array, in_key);\n        } else {\n            const middleIndex = Math.floor((in_array.length - 1) / 2);\n\n            if (middleIndex < 0) {\n                return 0;\n            }\n\n            if (this._comparisonFunction(in_array[middleIndex], in_key) > 0) {\n                if (in_array.length === 1) {\n                    return 0;\n                }\n\n                return this._binarySearchNearestIndex(in_array.slice(0, middleIndex), in_key);\n            }\n\n            if (this._comparisonFunction(in_array[middleIndex], in_key) < 0) {\n                if (in_array.length === 1) {\n                    return 1;\n                }\n\n                return (middleIndex + 1) + this._binarySearchNearestIndex(\n                    in_array.slice(middleIndex + 1, in_array.length),\n                    in_key,\n                );\n            }\n\n            return middleIndex;\n        }\n    }\n\n    /**\n     * Return the nearest next item to the given key i.e.\n     * For the given list of keys ['1.0.1', '2.0.0', '2.2.0', '7.0.1'] the nearest next item to 6.0.1 is\n     * the item mapped by '7.0.1'\n     * @param in_key - The key to check against in order to get the nearest next item\n     * @returns  The nearest next item\n     */\n    getNearestNextItem(in_key: string) {\n        const closestNextIndex = this._binarySearchNearestIndex(this._sortedKeys, in_key.toString());\n        if (closestNextIndex === this.getCount()) {\n            return undefined;\n        } else {\n            return this.item(this._sortedKeys[closestNextIndex]);\n        }\n    }\n\n    /**\n     * Return the nearest previous item to the given key i.e.\n     * For the given list of keys ['1.0.1', '2.0.0', '2.2.0', '7.0.1'] the nearest previous item to 6.0.1 is\n     * the item mapped by '7.0.1'\n     * @param in_key - The key to check against in order to get the nearest previous item\n     * @returns The nearest previous item\n     */\n    getNearestPreviousItem(in_key: string | number) {\n        const closestPreviousIndex = this._binarySearchNearestIndex(this._sortedKeys, in_key.toString());\n        if (closestPreviousIndex === 0) {\n            return undefined;\n        } else {\n            return this.item(this._sortedKeys[closestPreviousIndex - 1]);\n        }\n    }\n}\n"]}

package/lib/deferredPromise.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Creates a Promise that can be fulfilled or rejected later in an arbitrary manner (rather than
+ * through the constructor's executor).
+ * For example, a deferred promise could be fulfilled after waiting for many asynchronous
+ * tasks to terminate. This class becomes useful when combining classic async calls with promises.
+ */
+export declare class DeferredPromise<T> implements Promise<T> {
+    private _resolveSelf;
+    private _rejectSelf;
+    private readonly promise;
+    constructor();
+    [Symbol.toStringTag]: string;
+    finally(onfinally?: () => void): Promise<T>;
+    /**
+     * Fetches a node style callback that fulfills the promise when called.
+     * @returns A node style callback that fulfills the promise when called.
+     */
+    getCb(): (error: any, result: any) => void;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
+    resolve(val: T): void;
+    reject(reason: any): void;
+}
+//# sourceMappingURL=deferredPromise.d.ts.map

package/lib/deferredPromise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deferredPromise.d.ts","sourceRoot":"","sources":["../src/deferredPromise.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AACH,qBAAa,eAAe,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IACjD,OAAO,CAAC,YAAY,CAAC;IACrB,OAAO,CAAC,WAAW,CAAC;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;;IAQrC,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC;IAIxD;;;OAGG;IACH,KAAK;IAUQ,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EAC5C,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,KACpB,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,EACxD,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,KACtB,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,GACzD,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAIlB,KAAK,CAAC,OAAO,GAAG,KAAK,EAC9B,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,KACtB,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,GACvD,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC;IAIhB,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,MAAM,CAAC,MAAM,EAAE,GAAG;CAC5B"}

package/lib/deferredPromise.js

@@ -0,0 +1,43 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Creates a Promise that can be fulfilled or rejected later in an arbitrary manner (rather than
+ * through the constructor's executor).
+ * For example, a deferred promise could be fulfilled after waiting for many asynchronous
+ * tasks to terminate. This class becomes useful when combining classic async calls with promises.
+ */
+export class DeferredPromise {
+    constructor() {
+        this.promise = new Promise((resolve, reject) => {
+            this._resolveSelf = resolve;
+            this._rejectSelf = reject;
+        });
+    }
+    async finally(onfinally) {
+        throw new Error("Method not implemented.");
+    }
+    /**
+     * Fetches a node style callback that fulfills the promise when called.
+     * @returns A node style callback that fulfills the promise when called.
+     */
+    getCb() {
+        return (error, result) => {
+            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+            if (error) {
+                return this.reject(error);
+            }
+            return this.resolve(result);
+        };
+    }
+    async then(onfulfilled, onrejected) {
+        return this.promise.then(onfulfilled, onrejected);
+    }
+    async catch(onrejected) {
+        return this.promise.then(onrejected);
+    }
+    resolve(val) { this._resolveSelf(val); }
+    reject(reason) { this._rejectSelf(reason); }
+}
+//# sourceMappingURL=deferredPromise.js.map

package/lib/deferredPromise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deferredPromise.js","sourceRoot":"","sources":["../src/deferredPromise.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAKxB;QACI,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAGM,KAAK,CAAC,OAAO,CAAC,SAAsB;QACvC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,KAAK;QACD,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACrB,yEAAyE;YACzE,IAAI,KAAK,EAAE;gBACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC7B;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChC,CAAC,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,IAAI,CACb,WACwD,EACxD,UACwD;QAExD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACtD,CAAC;IAEM,KAAK,CAAC,KAAK,CACd,UACsD;QAEtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAEM,OAAO,CAAC,GAAM,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,MAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC3D","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Creates a Promise that can be fulfilled or rejected later in an arbitrary manner (rather than\n * through the constructor's executor).\n * For example, a deferred promise could be fulfilled after waiting for many asynchronous\n * tasks to terminate. This class becomes useful when combining classic async calls with promises.\n */\nexport class DeferredPromise<T> implements Promise<T> {\n    private _resolveSelf;\n    private _rejectSelf;\n    private readonly promise: Promise<T>;\n\n    constructor() {\n        this.promise = new Promise((resolve, reject) => {\n            this._resolveSelf = resolve;\n            this._rejectSelf = reject;\n        });\n    }\n    [Symbol.toStringTag]: string;\n\n    public async finally(onfinally?: () => void): Promise<T> {\n        throw new Error(\"Method not implemented.\");\n    }\n\n    /**\n     * Fetches a node style callback that fulfills the promise when called.\n     * @returns A node style callback that fulfills the promise when called.\n     */\n    getCb() {\n        return (error, result) => {\n            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n            if (error) {\n                return this.reject(error);\n            }\n            return this.resolve(result);\n        };\n    }\n\n    public async then<TResult1 = T, TResult2 = never>(\n        onfulfilled?: ((value: T) =>\n            TResult1 | PromiseLike<TResult1>) | undefined | null,\n        onrejected?: ((reason: any) =>\n            TResult2 | PromiseLike<TResult2>) | undefined | null,\n    ): Promise<TResult1 | TResult2> {\n        return this.promise.then(onfulfilled, onrejected);\n    }\n\n    public async catch<TResult = never>(\n        onrejected?: ((reason: any) =>\n            TResult | PromiseLike<TResult>) | undefined | null,\n    ): Promise<T | TResult> {\n        return this.promise.then(onrejected);\n    }\n\n    public resolve(val: T) { this._resolveSelf(val); }\n    public reject(reason: any) { this._rejectSelf(reason); }\n}\n"]}

package/lib/deterministicRandomGenerator.d.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Random number generator that creates a deterministic sequence of random numbers based on an initial seed GUID
+ *
+ * Warning: This is a very straight forward implementation based on the hashCombine4xUint32 function. It probably
+ *          doesn't produce very high quality random numbers (do not use this for cryptography!) and it is not very
+ *          efficient.
+ */
+export declare class DeterministicRandomGenerator {
+    _guid1: Uint32Array;
+    _guid2: Uint32Array;
+    _result: Uint32Array;
+    /**
+     * @param in_seed - The initial seed (it can be either a GUID or a number)
+     * which is used to initialize the random number generator
+     *
+     */
+    constructor(in_seed: string | number);
+    /**
+     * Creates a floating point random number
+     *
+     * @param in_max - If supplied the returned number will be 0 \<= number \< in_max. If none is given
+     *                               in_max = 1 is assumed
+     * @returns The random number
+     */
+    random(in_max?: number): number;
+    /**
+     * Creates an integer point random number
+     *
+     * @param in_max - If supplied the returned number will be 0 \<= number \< in_max. If none is given
+     *                                      in_max = 14294967296 (2^32) is assumed
+     * @returns The random number
+     */
+    irandom(in_max?: number): number;
+}
+//# sourceMappingURL=deterministicRandomGenerator.d.ts.map

package/lib/deterministicRandomGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deterministicRandomGenerator.d.ts","sourceRoot":"","sources":["../src/deterministicRandomGenerator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH;;;;;;GAMG;AACH,qBAAa,4BAA4B;IACrC,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,EAAE,WAAW,CAAC;IAErB;;;;OAIG;gBACS,OAAO,EAAE,MAAM,GAAG,MAAM;IAgBpC;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,SAAM;IAKnB;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;CAwBnC"}

package/lib/deterministicRandomGenerator.js

@@ -0,0 +1,83 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * @fileoverview Helper class to create a deterministic sequence of random numbers.
+ */
+/* eslint-disable no-bitwise */
+import _ from "lodash";
+import { GuidUtils } from "./guidUtils";
+import { calculateHash } from "./hashCalculator";
+/**
+ * Random number generator that creates a deterministic sequence of random numbers based on an initial seed GUID
+ *
+ * Warning: This is a very straight forward implementation based on the hashCombine4xUint32 function. It probably
+ *          doesn't produce very high quality random numbers (do not use this for cryptography!) and it is not very
+ *          efficient.
+ */
+export class DeterministicRandomGenerator {
+    /**
+     * @param in_seed - The initial seed (it can be either a GUID or a number)
+     * which is used to initialize the random number generator
+     *
+     */
+    constructor(in_seed) {
+        // Initialize the internal state from the given initial guid
+        if (_.isString(in_seed)) {
+            this._guid1 = GuidUtils.guidToUint32x4(in_seed);
+        }
+        else {
+            this._guid1 = GuidUtils.guidToUint32x4(calculateHash(String(in_seed)));
+        }
+        this._guid2 = new Uint32Array(4);
+        this._guid2[0] = (this._guid1[0] + 1) >>> 0;
+        this._guid2[1] = (this._guid1[1] + 1) >>> 0;
+        this._guid2[2] = (this._guid1[2] + 1) >>> 0;
+        this._guid2[3] = (this._guid1[3] + 1) >>> 0;
+        this._result = new Uint32Array(4);
+    }
+    /**
+     * Creates a floating point random number
+     *
+     * @param in_max - If supplied the returned number will be 0 \<= number \< in_max. If none is given
+     *                               in_max = 1 is assumed
+     * @returns The random number
+     */
+    random(in_max = 1.0) {
+        const randomInteger = this.irandom();
+        return randomInteger / 4294967296 * in_max;
+    }
+    /**
+     * Creates an integer point random number
+     *
+     * @param in_max - If supplied the returned number will be 0 \<= number \< in_max. If none is given
+     *                                      in_max = 14294967296 (2^32) is assumed
+     * @returns The random number
+     */
+    irandom(in_max) {
+        // Create a new hash
+        GuidUtils.hashCombine4xUint32(this._guid1, this._guid2, this._result);
+        // Permute the hashes
+        for (let i = 0; i < 4; i++) {
+            this._guid1[i] = this._guid2[i];
+            this._guid2[i] = this._result[i];
+        }
+        if (in_max === undefined) {
+            return this._guid1[0];
+        }
+        else {
+            if (in_max < 16777619) {
+                // The random generator doesn't seem to be very good.
+                // It is quite biased (e.g. it generates too many even numbers)
+                // this is a hack to solve at least this problem, but we probably should
+                // instead use a different approach alltogether
+                return ((this._guid1[0]) % 16777619) % in_max;
+            }
+            else {
+                return this._guid1[0] % in_max;
+            }
+        }
+    }
+}
+//# sourceMappingURL=deterministicRandomGenerator.js.map

package/lib/deterministicRandomGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deterministicRandomGenerator.js","sourceRoot":"","sources":["../src/deterministicRandomGenerator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AAEH,+BAA+B;AAE/B,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;;;;;GAMG;AACH,MAAM,OAAO,4BAA4B;IAKrC;;;;OAIG;IACH,YAAY,OAAwB;QAChC,4DAA4D;QAC5D,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YACrB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;SACnD;aAAM;YACH,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,cAAc,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;SAC1E;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAE5C,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,GAAG,GAAG;QACf,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,OAAO,aAAa,GAAG,UAAU,GAAG,MAAM,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,MAAe;QACnB,oBAAoB;QACpB,SAAS,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAEtE,qBAAqB;QACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACxB,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;SACpC;QAED,IAAI,MAAM,KAAK,SAAS,EAAE;YACtB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SACzB;aAAM;YACH,IAAI,MAAM,GAAG,QAAQ,EAAE;gBACnB,qDAAqD;gBACrD,+DAA+D;gBAC/D,wEAAwE;gBACxE,+CAA+C;gBAC/C,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,MAAM,CAAC;aACjD;iBAAM;gBACH,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;aAClC;SACJ;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * @fileoverview Helper class to create a deterministic sequence of random numbers.\n */\n\n/* eslint-disable no-bitwise */\n\nimport _ from \"lodash\";\nimport { GuidUtils } from \"./guidUtils\";\nimport { calculateHash } from \"./hashCalculator\";\n\n/**\n * Random number generator that creates a deterministic sequence of random numbers based on an initial seed GUID\n *\n * Warning: This is a very straight forward implementation based on the hashCombine4xUint32 function. It probably\n *          doesn't produce very high quality random numbers (do not use this for cryptography!) and it is not very\n *          efficient.\n */\nexport class DeterministicRandomGenerator {\n    _guid1: Uint32Array;\n    _guid2: Uint32Array;\n    _result: Uint32Array;\n\n    /**\n     * @param in_seed - The initial seed (it can be either a GUID or a number)\n     * which is used to initialize the random number generator\n     *\n     */\n    constructor(in_seed: string | number) {\n        // Initialize the internal state from the given initial guid\n        if (_.isString(in_seed)) {\n            this._guid1 = GuidUtils.guidToUint32x4(in_seed);\n        } else {\n            this._guid1 = GuidUtils.guidToUint32x4(calculateHash(String(in_seed)));\n        }\n        this._guid2 = new Uint32Array(4);\n        this._guid2[0] = (this._guid1[0] + 1) >>> 0;\n        this._guid2[1] = (this._guid1[1] + 1) >>> 0;\n        this._guid2[2] = (this._guid1[2] + 1) >>> 0;\n        this._guid2[3] = (this._guid1[3] + 1) >>> 0;\n\n        this._result = new Uint32Array(4);\n    }\n\n    /**\n     * Creates a floating point random number\n     *\n     * @param in_max - If supplied the returned number will be 0 \\<= number \\< in_max. If none is given\n     *                               in_max = 1 is assumed\n     * @returns The random number\n     */\n    random(in_max = 1.0) {\n        const randomInteger = this.irandom();\n        return randomInteger / 4294967296 * in_max;\n    }\n\n    /**\n     * Creates an integer point random number\n     *\n     * @param in_max - If supplied the returned number will be 0 \\<= number \\< in_max. If none is given\n     *                                      in_max = 14294967296 (2^32) is assumed\n     * @returns The random number\n     */\n    irandom(in_max?: number): number {\n        // Create a new hash\n        GuidUtils.hashCombine4xUint32(this._guid1, this._guid2, this._result);\n\n        // Permute the hashes\n        for (let i = 0; i < 4; i++) {\n            this._guid1[i] = this._guid2[i];\n            this._guid2[i] = this._result[i];\n        }\n\n        if (in_max === undefined) {\n            return this._guid1[0];\n        } else {\n            if (in_max < 16777619) {\n                // The random generator doesn't seem to be very good.\n                // It is quite biased (e.g. it generates too many even numbers)\n                // this is a hack to solve at least this problem, but we probably should\n                // instead use a different approach alltogether\n                return ((this._guid1[0]) % 16777619) % in_max;\n            } else {\n                return this._guid1[0] % in_max;\n            }\n        }\n    }\n}\n"]}