@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/util/offsetList.js

@@ -0,0 +1,44 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OffsetListFactory = void 0;
+/**
+ * Helper class for constructing an offset list that...
+ *
+ * - Does not insert offsets if there is no content after them
+ *
+ * - Does not insert 0-sized offsets
+ *
+ * - Merges runs of offsets together
+ */
+class OffsetListFactory {
+    constructor() {
+        this.offset = 0;
+        this.list = [];
+    }
+    push(...offsetOrContent) {
+        for (const item of offsetOrContent) {
+            if (typeof item === "number") {
+                this.pushOffset(item);
+            }
+            else {
+                this.pushContent(item);
+            }
+        }
+    }
+    pushOffset(offset) {
+        this.offset += offset;
+    }
+    pushContent(content) {
+        if (this.offset > 0) {
+            this.list.push(this.offset);
+            this.offset = 0;
+        }
+        this.list.push(content);
+    }
+}
+exports.OffsetListFactory = OffsetListFactory;
+//# sourceMappingURL=offsetList.js.map

package/dist/util/offsetList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"offsetList.js","sourceRoot":"","sources":["../../src/util/offsetList.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH;;;;;;;;GAQG;AACH,MAAa,iBAAiB;IAA9B;QACS,WAAM,GAAG,CAAC,CAAC;QACH,SAAI,GAAyB,EAAE,CAAC;IAuBjD,CAAC;IArBO,IAAI,CAAC,GAAG,eAAsC;QACpD,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE;YACnC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC7B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;aACtB;iBAAM;gBACN,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;aACvB;SACD;IACF,CAAC;IAEM,UAAU,CAAC,MAAc;QAC/B,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC;IACvB,CAAC;IAEM,WAAW,CAAC,OAAiB;QACnC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SAChB;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;CACD;AAzBD,8CAyBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type OffsetList<TContent = Exclude<unknown, number>, TOffset = number> = (\n\t| TOffset\n\t| TContent\n)[];\n\n/**\n * Helper class for constructing an offset list that...\n *\n * - Does not insert offsets if there is no content after them\n *\n * - Does not insert 0-sized offsets\n *\n * - Merges runs of offsets together\n */\nexport class OffsetListFactory<TContent> {\n\tprivate offset = 0;\n\tpublic readonly list: OffsetList<TContent> = [];\n\n\tpublic push(...offsetOrContent: (number | TContent)[]): void {\n\t\tfor (const item of offsetOrContent) {\n\t\t\tif (typeof item === \"number\") {\n\t\t\t\tthis.pushOffset(item);\n\t\t\t} else {\n\t\t\t\tthis.pushContent(item);\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic pushOffset(offset: number): void {\n\t\tthis.offset += offset;\n\t}\n\n\tpublic pushContent(content: TContent): void {\n\t\tif (this.offset > 0) {\n\t\t\tthis.list.push(this.offset);\n\t\t\tthis.offset = 0;\n\t\t}\n\t\tthis.list.push(content);\n\t}\n}\n"]}

package/dist/util/rangeMap.d.ts

@@ -0,0 +1,40 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * A map keyed on integers allowing reading and writing contiguous ranges of integer keys.
+ */
+export type RangeMap<T> = RangeEntry<T>[];
+export interface RangeEntry<T> {
+    start: number;
+    length: number;
+    value: T;
+}
+/**
+ * The result of a query about a range of keys.
+ *
+ * @internal
+ */
+export interface RangeQueryResult<T> {
+    /**
+     * The value of the first key in the query range.
+     */
+    value: T | undefined;
+    /**
+     * The length of the prefix of the query range which have the same value.
+     * For example, if a RangeMap has the same value for keys 5, 6, and 7,
+     * a query about the range [5, 10] would give a result with length 3.
+     */
+    length: number;
+}
+/**
+ * See comments on `RangeQueryResult`.
+ */
+export declare function getFromRangeMap<T>(map: RangeMap<T>, start: number, length: number): RangeQueryResult<T>;
+export declare function getFirstEntryFromRangeMap<T>(map: RangeMap<T>, start: number, length: number): RangeEntry<T> | undefined;
+/**
+ * Sets the keys from `start` to `start + length - 1` to `value`.
+ */
+export declare function setInRangeMap<T>(map: RangeMap<T>, start: number, length: number, value: T): void;
+//# sourceMappingURL=rangeMap.d.ts.map

package/dist/util/rangeMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rangeMap.d.ts","sourceRoot":"","sources":["../../src/util/rangeMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;AAE1C,MAAM,WAAW,UAAU,CAAC,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,CAAC,CAAC;CACT;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC;IAClC;;OAEG;IACH,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC;IAErB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAChC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACZ,gBAAgB,CAAC,CAAC,CAAC,CAgBrB;AAED,wBAAgB,yBAAyB,CAAC,CAAC,EAC1C,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACZ,UAAU,CAAC,CAAC,CAAC,GAAG,SAAS,CAe3B;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAgEhG"}

package/dist/util/rangeMap.js

@@ -0,0 +1,103 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setInRangeMap = exports.getFirstEntryFromRangeMap = exports.getFromRangeMap = void 0;
+/**
+ * See comments on `RangeQueryResult`.
+ */
+function getFromRangeMap(map, start, length) {
+    for (const range of map) {
+        if (range.start > start) {
+            return { value: undefined, length: Math.min(range.start - start, length) };
+        }
+        const lastRangeKey = range.start + range.length - 1;
+        if (lastRangeKey >= start) {
+            // This range contains `start`.
+            const overlapLength = lastRangeKey - start + 1;
+            return { value: range.value, length: Math.min(overlapLength, length) };
+        }
+    }
+    // There were no entries intersecting the query range, so the entire query range has undefined value.
+    return { value: undefined, length };
+}
+exports.getFromRangeMap = getFromRangeMap;
+function getFirstEntryFromRangeMap(map, start, length) {
+    const lastQueryKey = start + length - 1;
+    for (const range of map) {
+        if (range.start > lastQueryKey) {
+            // We've passed the end of the query range.
+            break;
+        }
+        const lastRangeKey = range.start + range.length - 1;
+        if (lastRangeKey >= start) {
+            return range;
+        }
+    }
+    return undefined;
+}
+exports.getFirstEntryFromRangeMap = getFirstEntryFromRangeMap;
+/**
+ * Sets the keys from `start` to `start + length - 1` to `value`.
+ */
+function setInRangeMap(map, start, length, value) {
+    const end = start + length - 1;
+    const newEntry = { start, length, value };
+    let iBefore = -1;
+    let iAfter = map.length;
+    for (const [i, entry] of map.entries()) {
+        const entryLastKey = entry.start + entry.length - 1;
+        if (entryLastKey < start) {
+            iBefore = i;
+        }
+        else if (entry.start > end) {
+            iAfter = i;
+            break;
+        }
+    }
+    const numOverlappingEntries = iAfter - iBefore - 1;
+    if (numOverlappingEntries === 0) {
+        map.splice(iAfter, 0, newEntry);
+        return;
+    }
+    const iFirst = iBefore + 1;
+    const firstEntry = map[iFirst];
+    const iLast = iAfter - 1;
+    const lastEntry = map[iLast];
+    const lengthBeforeFirst = start - firstEntry.start;
+    const lastEntryKey = lastEntry.start + lastEntry.length - 1;
+    const lengthAfterLast = lastEntryKey - end;
+    if (lengthBeforeFirst > 0 && lengthAfterLast > 0 && iFirst === iLast) {
+        // The new entry fits in the middle of an existing entry.
+        // We replace the existing entry with:
+        // 1) the portion which comes before `newEntry`
+        // 2) `newEntry`
+        // 3) the portion which comes after `newEntry`
+        map.splice(iFirst, 1, { ...firstEntry, length: lengthBeforeFirst }, newEntry, {
+            ...lastEntry,
+            start: end + 1,
+            length: lengthAfterLast,
+        });
+        return;
+    }
+    if (lengthBeforeFirst > 0) {
+        map[iFirst] = { ...firstEntry, length: lengthBeforeFirst };
+        // The entry at `iFirst` is no longer overlapping with `newEntry`.
+        iBefore = iFirst;
+    }
+    if (lengthAfterLast > 0) {
+        map[iLast] = {
+            ...lastEntry,
+            start: end + 1,
+            length: lengthAfterLast,
+        };
+        // The entry at `iLast` is no longer overlapping with `newEntry`.
+        iAfter = iLast;
+    }
+    const numContainedEntries = iAfter - iBefore - 1;
+    map.splice(iBefore + 1, numContainedEntries, newEntry);
+}
+exports.setInRangeMap = setInRangeMap;
+//# sourceMappingURL=rangeMap.js.map

package/dist/util/rangeMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rangeMap.js","sourceRoot":"","sources":["../../src/util/rangeMap.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAgCH;;GAEG;AACH,SAAgB,eAAe,CAC9B,GAAgB,EAChB,KAAa,EACb,MAAc;IAEd,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE;QACxB,IAAI,KAAK,CAAC,KAAK,GAAG,KAAK,EAAE;YACxB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;SAC3E;QAED,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QACpD,IAAI,YAAY,IAAI,KAAK,EAAE;YAC1B,+BAA+B;YAC/B,MAAM,aAAa,GAAG,YAAY,GAAG,KAAK,GAAG,CAAC,CAAC;YAC/C,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC;SACvE;KACD;IAED,qGAAqG;IACrG,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;AACrC,CAAC;AApBD,0CAoBC;AAED,SAAgB,yBAAyB,CACxC,GAAgB,EAChB,KAAa,EACb,MAAc;IAEd,MAAM,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE;QACxB,IAAI,KAAK,CAAC,KAAK,GAAG,YAAY,EAAE;YAC/B,2CAA2C;YAC3C,MAAM;SACN;QAED,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QACpD,IAAI,YAAY,IAAI,KAAK,EAAE;YAC1B,OAAO,KAAK,CAAC;SACb;KACD;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAnBD,8DAmBC;AAED;;GAEG;AACH,SAAgB,aAAa,CAAI,GAAgB,EAAE,KAAa,EAAE,MAAc,EAAE,KAAQ;IACzF,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC;IAC/B,MAAM,QAAQ,GAAkB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAEzD,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC;IACjB,IAAI,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IACxB,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE;QACvC,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QACpD,IAAI,YAAY,GAAG,KAAK,EAAE;YACzB,OAAO,GAAG,CAAC,CAAC;SACZ;aAAM,IAAI,KAAK,CAAC,KAAK,GAAG,GAAG,EAAE;YAC7B,MAAM,GAAG,CAAC,CAAC;YACX,MAAM;SACN;KACD;IAED,MAAM,qBAAqB,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,CAAC;IACnD,IAAI,qBAAqB,KAAK,CAAC,EAAE;QAChC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;QAChC,OAAO;KACP;IAED,MAAM,MAAM,GAAG,OAAO,GAAG,CAAC,CAAC;IAC3B,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC;IACzB,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7B,MAAM,iBAAiB,GAAG,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;IACnD,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5D,MAAM,eAAe,GAAG,YAAY,GAAG,GAAG,CAAC;IAE3C,IAAI,iBAAiB,GAAG,CAAC,IAAI,eAAe,GAAG,CAAC,IAAI,MAAM,KAAK,KAAK,EAAE;QACrE,yDAAyD;QACzD,sCAAsC;QACtC,+CAA+C;QAC/C,gBAAgB;QAChB,8CAA8C;QAC9C,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,EAAE,QAAQ,EAAE;YAC7E,GAAG,SAAS;YACZ,KAAK,EAAE,GAAG,GAAG,CAAC;YACd,MAAM,EAAE,eAAe;SACvB,CAAC,CAAC;QACH,OAAO;KACP;IAED,IAAI,iBAAiB,GAAG,CAAC,EAAE;QAC1B,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;QAE3D,kEAAkE;QAClE,OAAO,GAAG,MAAM,CAAC;KACjB;IAED,IAAI,eAAe,GAAG,CAAC,EAAE;QACxB,GAAG,CAAC,KAAK,CAAC,GAAG;YACZ,GAAG,SAAS;YACZ,KAAK,EAAE,GAAG,GAAG,CAAC;YACd,MAAM,EAAE,eAAe;SACvB,CAAC;QAEF,iEAAiE;QACjE,MAAM,GAAG,KAAK,CAAC;KACf;IAED,MAAM,mBAAmB,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,CAAC;IACjD,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;AACxD,CAAC;AAhED,sCAgEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * A map keyed on integers allowing reading and writing contiguous ranges of integer keys.\n */\nexport type RangeMap<T> = RangeEntry<T>[];\n\nexport interface RangeEntry<T> {\n\tstart: number;\n\tlength: number;\n\tvalue: T;\n}\n\n/**\n * The result of a query about a range of keys.\n *\n * @internal\n */\nexport interface RangeQueryResult<T> {\n\t/**\n\t * The value of the first key in the query range.\n\t */\n\tvalue: T | undefined;\n\n\t/**\n\t * The length of the prefix of the query range which have the same value.\n\t * For example, if a RangeMap has the same value for keys 5, 6, and 7,\n\t * a query about the range [5, 10] would give a result with length 3.\n\t */\n\tlength: number;\n}\n\n/**\n * See comments on `RangeQueryResult`.\n */\nexport function getFromRangeMap<T>(\n\tmap: RangeMap<T>,\n\tstart: number,\n\tlength: number,\n): RangeQueryResult<T> {\n\tfor (const range of map) {\n\t\tif (range.start > start) {\n\t\t\treturn { value: undefined, length: Math.min(range.start - start, length) };\n\t\t}\n\n\t\tconst lastRangeKey = range.start + range.length - 1;\n\t\tif (lastRangeKey >= start) {\n\t\t\t// This range contains `start`.\n\t\t\tconst overlapLength = lastRangeKey - start + 1;\n\t\t\treturn { value: range.value, length: Math.min(overlapLength, length) };\n\t\t}\n\t}\n\n\t// There were no entries intersecting the query range, so the entire query range has undefined value.\n\treturn { value: undefined, length };\n}\n\nexport function getFirstEntryFromRangeMap<T>(\n\tmap: RangeMap<T>,\n\tstart: number,\n\tlength: number,\n): RangeEntry<T> | undefined {\n\tconst lastQueryKey = start + length - 1;\n\tfor (const range of map) {\n\t\tif (range.start > lastQueryKey) {\n\t\t\t// We've passed the end of the query range.\n\t\t\tbreak;\n\t\t}\n\n\t\tconst lastRangeKey = range.start + range.length - 1;\n\t\tif (lastRangeKey >= start) {\n\t\t\treturn range;\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\n/**\n * Sets the keys from `start` to `start + length - 1` to `value`.\n */\nexport function setInRangeMap<T>(map: RangeMap<T>, start: number, length: number, value: T): void {\n\tconst end = start + length - 1;\n\tconst newEntry: RangeEntry<T> = { start, length, value };\n\n\tlet iBefore = -1;\n\tlet iAfter = map.length;\n\tfor (const [i, entry] of map.entries()) {\n\t\tconst entryLastKey = entry.start + entry.length - 1;\n\t\tif (entryLastKey < start) {\n\t\t\tiBefore = i;\n\t\t} else if (entry.start > end) {\n\t\t\tiAfter = i;\n\t\t\tbreak;\n\t\t}\n\t}\n\n\tconst numOverlappingEntries = iAfter - iBefore - 1;\n\tif (numOverlappingEntries === 0) {\n\t\tmap.splice(iAfter, 0, newEntry);\n\t\treturn;\n\t}\n\n\tconst iFirst = iBefore + 1;\n\tconst firstEntry = map[iFirst];\n\tconst iLast = iAfter - 1;\n\tconst lastEntry = map[iLast];\n\tconst lengthBeforeFirst = start - firstEntry.start;\n\tconst lastEntryKey = lastEntry.start + lastEntry.length - 1;\n\tconst lengthAfterLast = lastEntryKey - end;\n\n\tif (lengthBeforeFirst > 0 && lengthAfterLast > 0 && iFirst === iLast) {\n\t\t// The new entry fits in the middle of an existing entry.\n\t\t// We replace the existing entry with:\n\t\t// 1) the portion which comes before `newEntry`\n\t\t// 2) `newEntry`\n\t\t// 3) the portion which comes after `newEntry`\n\t\tmap.splice(iFirst, 1, { ...firstEntry, length: lengthBeforeFirst }, newEntry, {\n\t\t\t...lastEntry,\n\t\t\tstart: end + 1,\n\t\t\tlength: lengthAfterLast,\n\t\t});\n\t\treturn;\n\t}\n\n\tif (lengthBeforeFirst > 0) {\n\t\tmap[iFirst] = { ...firstEntry, length: lengthBeforeFirst };\n\n\t\t// The entry at `iFirst` is no longer overlapping with `newEntry`.\n\t\tiBefore = iFirst;\n\t}\n\n\tif (lengthAfterLast > 0) {\n\t\tmap[iLast] = {\n\t\t\t...lastEntry,\n\t\t\tstart: end + 1,\n\t\t\tlength: lengthAfterLast,\n\t\t};\n\n\t\t// The entry at `iLast` is no longer overlapping with `newEntry`.\n\t\tiAfter = iLast;\n\t}\n\n\tconst numContainedEntries = iAfter - iBefore - 1;\n\tmap.splice(iBefore + 1, numContainedEntries, newEntry);\n}\n"]}

package/dist/util/referenceCounting.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export interface ReferenceCounted {
+    referenceAdded(): void;
+    referenceRemoved(): void;
+    /**
+     * @returns true if mutating this object may impact other users of it.
+     *
+     * Implementations can return true if the refcount is 1 OR the content is logically immutable.
+     */
+    isShared(): boolean;
+}
+/**
+ * Base class to assist with implementing ReferenceCounted.
+ */
+export declare abstract class ReferenceCountedBase implements ReferenceCounted {
+    private refCount;
+    protected constructor(refCount?: number);
+    referenceAdded(count?: number): void;
+    referenceRemoved(count?: number): void;
+    isShared(): boolean;
+    isUnreferenced(): boolean;
+    /**
+     * Called when refcount reaches 0.
+     */
+    protected abstract dispose(): void;
+}
+//# sourceMappingURL=referenceCounting.d.ts.map

package/dist/util/referenceCounting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referenceCounting.d.ts","sourceRoot":"","sources":["../../src/util/referenceCounting.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,MAAM,WAAW,gBAAgB;IAChC,cAAc,IAAI,IAAI,CAAC;IAEvB,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,8BAAsB,oBAAqB,YAAW,gBAAgB;IAC/C,OAAO,CAAC,QAAQ;IAAtC,SAAS,aAAqB,QAAQ,GAAE,MAAU;IAE3C,cAAc,CAAC,KAAK,SAAI,GAAG,IAAI;IAI/B,gBAAgB,CAAC,KAAK,SAAI,GAAG,IAAI;IAQjC,QAAQ,IAAI,OAAO;IAInB,cAAc,IAAI,OAAO;IAIhC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI;CAClC"}

package/dist/util/referenceCounting.js

@@ -0,0 +1,34 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferenceCountedBase = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+/**
+ * Base class to assist with implementing ReferenceCounted.
+ */
+class ReferenceCountedBase {
+    constructor(refCount = 1) {
+        this.refCount = refCount;
+    }
+    referenceAdded(count = 1) {
+        this.refCount += count;
+    }
+    referenceRemoved(count = 1) {
+        this.refCount -= count;
+        (0, core_utils_1.assert)(this.refCount >= 0, 0x4c4 /* Negative ref count */);
+        if (this.refCount === 0) {
+            this.dispose();
+        }
+    }
+    isShared() {
+        return this.refCount > 1;
+    }
+    isUnreferenced() {
+        return this.refCount === 0;
+    }
+}
+exports.ReferenceCountedBase = ReferenceCountedBase;
+//# sourceMappingURL=referenceCounting.js.map

package/dist/util/referenceCounting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"referenceCounting.js","sourceRoot":"","sources":["../../src/util/referenceCounting.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAepD;;GAEG;AACH,MAAsB,oBAAoB;IACzC,YAA8B,WAAmB,CAAC;QAApB,aAAQ,GAAR,QAAQ,CAAY;IAAG,CAAC;IAE/C,cAAc,CAAC,KAAK,GAAG,CAAC;QAC9B,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;IACxB,CAAC;IAEM,gBAAgB,CAAC,KAAK,GAAG,CAAC;QAChC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;QACvB,IAAA,mBAAM,EAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC3D,IAAI,IAAI,CAAC,QAAQ,KAAK,CAAC,EAAE;YACxB,IAAI,CAAC,OAAO,EAAE,CAAC;SACf;IACF,CAAC;IAEM,QAAQ;QACd,OAAO,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;IAC1B,CAAC;IAEM,cAAc;QACpB,OAAO,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAC;IAC5B,CAAC;CAMD;AA3BD,oDA2BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\n\nexport interface ReferenceCounted {\n\treferenceAdded(): void;\n\n\treferenceRemoved(): void;\n\n\t/**\n\t * @returns true if mutating this object may impact other users of it.\n\t *\n\t * Implementations can return true if the refcount is 1 OR the content is logically immutable.\n\t */\n\tisShared(): boolean;\n}\n\n/**\n * Base class to assist with implementing ReferenceCounted.\n */\nexport abstract class ReferenceCountedBase implements ReferenceCounted {\n\tprotected constructor(private refCount: number = 1) {}\n\n\tpublic referenceAdded(count = 1): void {\n\t\tthis.refCount += count;\n\t}\n\n\tpublic referenceRemoved(count = 1): void {\n\t\tthis.refCount -= count;\n\t\tassert(this.refCount >= 0, 0x4c4 /* Negative ref count */);\n\t\tif (this.refCount === 0) {\n\t\t\tthis.dispose();\n\t\t}\n\t}\n\n\tpublic isShared(): boolean {\n\t\treturn this.refCount > 1;\n\t}\n\n\tpublic isUnreferenced(): boolean {\n\t\treturn this.refCount === 0;\n\t}\n\n\t/**\n\t * Called when refcount reaches 0.\n\t */\n\tprotected abstract dispose(): void;\n}\n"]}

package/dist/util/stackyIterator.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * An iterator that supports having items pushed onto it for later iteration.
+ */
+export declare class StackyIterator<T> implements Iterator<T>, Iterable<T> {
+    private readonly list;
+    private readonly stack;
+    private index;
+    constructor(list: readonly T[]);
+    [Symbol.iterator](): Iterator<T>;
+    next(): IteratorResult<T>;
+    get done(): boolean;
+    push(item: T): void;
+    pop(): T | undefined;
+    peek(): T | undefined;
+}
+//# sourceMappingURL=stackyIterator.d.ts.map

package/dist/util/stackyIterator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stackyIterator.d.ts","sourceRoot":"","sources":["../../src/util/stackyIterator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,qBAAa,cAAc,CAAC,CAAC,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;IACjE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAe;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAW;IACjC,OAAO,CAAC,KAAK,CAAK;gBAEC,IAAI,EAAE,SAAS,CAAC,EAAE;IAI9B,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;IAIhC,IAAI,IAAI,cAAc,CAAC,CAAC,CAAC;IAOhC,IAAW,IAAI,IAAI,OAAO,CAEzB;IAEM,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI;IAInB,GAAG,IAAI,CAAC,GAAG,SAAS;IAUpB,IAAI,IAAI,CAAC,GAAG,SAAS;CAM5B"}

package/dist/util/stackyIterator.js

@@ -0,0 +1,49 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StackyIterator = void 0;
+/**
+ * An iterator that supports having items pushed onto it for later iteration.
+ */
+class StackyIterator {
+    constructor(list) {
+        this.stack = [];
+        this.index = 0;
+        this.list = list;
+    }
+    [Symbol.iterator]() {
+        return this;
+    }
+    next() {
+        if (this.done) {
+            return { value: undefined, done: true };
+        }
+        return { value: this.pop() };
+    }
+    get done() {
+        return this.index >= this.list.length && this.stack.length === 0;
+    }
+    push(item) {
+        this.stack.push(item);
+    }
+    pop() {
+        if (this.stack.length > 0) {
+            return this.stack.pop();
+        }
+        if (this.index >= this.list.length) {
+            return undefined;
+        }
+        return this.list[this.index++];
+    }
+    peek() {
+        if (this.stack.length > 0) {
+            return this.stack[this.stack.length - 1];
+        }
+        return this.list[this.index];
+    }
+}
+exports.StackyIterator = StackyIterator;
+//# sourceMappingURL=stackyIterator.js.map

package/dist/util/stackyIterator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stackyIterator.js","sourceRoot":"","sources":["../../src/util/stackyIterator.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,MAAa,cAAc;IAK1B,YAAmB,IAAkB;QAHpB,UAAK,GAAQ,EAAE,CAAC;QACzB,UAAK,GAAG,CAAC,CAAC;QAGjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,IAAI;QACV,IAAI,IAAI,CAAC,IAAI,EAAE;YACd,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;SACxC;QACD,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAO,EAAE,CAAC;IACnC,CAAC;IAED,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;IAClE,CAAC;IAEM,IAAI,CAAC,IAAO;QAClB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAEM,GAAG;QACT,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;SACxB;QACD,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACnC,OAAO,SAAS,CAAC;SACjB;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAChC,CAAC;IAEM,IAAI;QACV,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;CACD;AA5CD,wCA4CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * An iterator that supports having items pushed onto it for later iteration.\n */\nexport class StackyIterator<T> implements Iterator<T>, Iterable<T> {\n\tprivate readonly list: readonly T[];\n\tprivate readonly stack: T[] = [];\n\tprivate index = 0;\n\n\tpublic constructor(list: readonly T[]) {\n\t\tthis.list = list;\n\t}\n\n\tpublic [Symbol.iterator](): Iterator<T> {\n\t\treturn this;\n\t}\n\n\tpublic next(): IteratorResult<T> {\n\t\tif (this.done) {\n\t\t\treturn { value: undefined, done: true };\n\t\t}\n\t\treturn { value: this.pop() as T };\n\t}\n\n\tpublic get done(): boolean {\n\t\treturn this.index >= this.list.length && this.stack.length === 0;\n\t}\n\n\tpublic push(item: T): void {\n\t\tthis.stack.push(item);\n\t}\n\n\tpublic pop(): T | undefined {\n\t\tif (this.stack.length > 0) {\n\t\t\treturn this.stack.pop();\n\t\t}\n\t\tif (this.index >= this.list.length) {\n\t\t\treturn undefined;\n\t\t}\n\t\treturn this.list[this.index++];\n\t}\n\n\tpublic peek(): T | undefined {\n\t\tif (this.stack.length > 0) {\n\t\t\treturn this.stack[this.stack.length - 1];\n\t\t}\n\t\treturn this.list[this.index];\n\t}\n}\n"]}

package/dist/util/transactionResult.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Describes the result of a transaction.
+ * Transactions may either succeed and commit, or fail and abort.
+ * @internal
+ */
+export declare enum TransactionResult {
+    /**
+     * Indicates the transaction failed.
+     */
+    Abort = 0,
+    /**
+     * Indicates the transaction succeeded.
+     */
+    Commit = 1
+}
+//# sourceMappingURL=transactionResult.d.ts.map

package/dist/util/transactionResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionResult.d.ts","sourceRoot":"","sources":["../../src/util/transactionResult.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,oBAAY,iBAAiB;IAC5B;;OAEG;IACH,KAAK,IAAA;IACL;;OAEG;IACH,MAAM,IAAA;CACN"}

package/dist/util/transactionResult.js

@@ -0,0 +1,24 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionResult = void 0;
+/**
+ * Describes the result of a transaction.
+ * Transactions may either succeed and commit, or fail and abort.
+ * @internal
+ */
+var TransactionResult;
+(function (TransactionResult) {
+    /**
+     * Indicates the transaction failed.
+     */
+    TransactionResult[TransactionResult["Abort"] = 0] = "Abort";
+    /**
+     * Indicates the transaction succeeded.
+     */
+    TransactionResult[TransactionResult["Commit"] = 1] = "Commit";
+})(TransactionResult || (exports.TransactionResult = TransactionResult = {}));
+//# sourceMappingURL=transactionResult.js.map

package/dist/util/transactionResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionResult.js","sourceRoot":"","sources":["../../src/util/transactionResult.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;GAIG;AACH,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC5B;;OAEG;IACH,2DAAK,CAAA;IACL;;OAEG;IACH,6DAAM,CAAA;AACP,CAAC,EATW,iBAAiB,iCAAjB,iBAAiB,QAS5B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Describes the result of a transaction.\n * Transactions may either succeed and commit, or fail and abort.\n * @internal\n */\nexport enum TransactionResult {\n\t/**\n\t * Indicates the transaction failed.\n\t */\n\tAbort,\n\t/**\n\t * Indicates the transaction succeeded.\n\t */\n\tCommit,\n}\n"]}

package/dist/util/typeCheck.d.ts

@@ -0,0 +1,183 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export type { EnforceTypeCheckTests } from "./typeCheckTests";
+/**
+ * Utilities for manipulating the typescript typechecker.
+ *
+ * @remarks
+ * While it appears the the variance parts of this library are made obsolete by TypeScript 4.7's explicit variance annotations,
+ * many cases still type check with incorrect variance even when using the explicit annotations,
+ * and are fixed by using the patterns in this library.
+ *
+ * TypeScript uses structural typing if there are no private or protected members,
+ * and variance of generic type parameters depends on their usages.
+ * Thus when trying to constrain code by adding extra type information,
+ * it often fails to actually constrain as desired, and these utilities can help with those cases.
+ *
+ * This library is designed so that the desired variance can be documented in a way that is easy to read, concise,
+ * and allows easy navigation to documentation explaining what is being done
+ * for readers who are not familiar with this library.
+ * Additionally it constrains the types so the undesired usage patterns will not compile,
+ * and will give somewhat intelligible errors.
+ *
+ * Additionally this library provides the tools needed to test that the type constraints are working as expected,
+ * or test any other similar typing constraints in an application.
+ *
+ * This library assumes you are compiling with --strictFunctionTypes:
+ * (Covariance and Contravariance is explained along with how these helpers cause it in typescript at this link)
+ * {@link https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-6.html#strict-function-types}.
+ * If compiled with a TypeScript configuration that is not strict enough for these features to work,
+ * the test suite should fail to build.
+ *
+ * Classes in TypeScript by default allow all assignments:
+ * its only though adding members that any type constraints actually get applied.
+ * This library provides types that can be used on a protected member of a class to add the desired constraints.
+ *
+ * Typical usages (use one field like this at the top of a class):
+ * ```typescript
+ * protected _typeCheck?: MakeNominal;
+ * protected _typeCheck?: Contravariant<T>;
+ * protected _typeCheck?: Covariant<T>;
+ * protected _typeCheck?: Invariant<T>;
+ * protected _typeCheck?: Contravariant<T> & Invariant<K>;
+ * ```
+ *
+ * See tests for examples.
+ *
+ * Note that all of these cause nominal typing.
+ * If constraints on generic type parameter variance are desired, but nominal typing is not,
+ * these types can be used on a public field. This case also works with interfaces.
+ *
+ * Be aware that other members of your type might apply further constraints
+ * (ex: you might try and write a Contravariant<T> class, but it ends up being Invariant<T> due to a field of type T).
+ *
+ * Be aware of TypeScript Bug:
+ * {@link https://github.com/microsoft/TypeScript/issues/36906}.
+ * This bug is why the fields here are protected not private.
+ * Note that this bug is closed as a duplicate of {@link https://github.com/microsoft/TypeScript/issues/20979}
+ * which was closed because fixing it would be too large of a breaking change.
+ * Thus we expect this bug to be part of TypeScript for the forseeable future.
+ */
+/**
+ * Use this as the type of a protected field to cause a type to use nominal typing instead of structural.
+ *
+ * @remarks
+ * Using nominal typing in this way prevents assignment of objects which are not instances of this class to values of this class's type.
+ * Classes which are used with "instanceof", or are supposed to be instantiated in particular ways (not just made with object literals)
+ * can use this to prevent undesired assignments.
+ * @example
+ * ```typescript
+ * protected _typeCheck?: MakeNominal;
+ * ```
+ * @privateRemarks
+ * See: {@link https://dev.azure.com/intentional/intent/_wiki/wikis/NP%20Platform/7146/Nominal-vs-Structural-Types}
+ * @beta
+ */
+export interface MakeNominal {
+}
+/**
+ * Constrain generic type parameters to Contravariant.
+ *
+ * @example
+ *
+ * ```typescript
+ * protected _typeCheck?: Contravariant<T>;
+ * ```
+ *
+ * @internal
+ */
+export interface Contravariant<in T> {
+    _removeCovariance?: (_: T) => void;
+}
+/**
+ * Constrain generic type parameters to Covariant.
+ *
+ * @example
+ *
+ * ```typescript
+ * protected _typeCheck?: Covariant<T>;
+ * ```
+ *
+ * @internal
+ */
+export interface Covariant<out T> {
+    _removeContravariance?: T;
+}
+/**
+ * Constrain generic type parameters to Invariant.
+ *
+ * @example
+ *
+ * ```typescript
+ * protected _typeCheck?: Invariant<T>;
+ * ```
+ *
+ * @internal
+ */
+export interface Invariant<in out T> extends Contravariant<T>, Covariant<T> {
+}
+/**
+ * Compile time assert that X is True.
+ * To use, simply define a type:
+ * `type _check = requireTrue<your type check>;`
+ *
+ * @internal
+ */
+export type requireTrue<_X extends true> = true;
+/**
+ * Compile time assert that X is False.
+ * To use, simply define a type:
+ * `type _check = requireFalse<your type check>;`
+ *
+ * @internal
+ */
+export type requireFalse<_X extends false> = true;
+/**
+ * Returns a type parameter that is true iff Source is assignable to Destination.
+ *
+ * @privateRemarks
+ * Use of [] in the extends clause prevents unions from being distributed over this conditional and returning `boolean` in some cases.
+ * @see {@link https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types | distributive-conditional-types} for details.
+ * @internal
+ */
+export type isAssignableTo<Source, Destination> = [Source] extends [Destination] ? true : false;
+/**
+ * Returns a type parameter that is true iff Subset is a strict subset of Superset.
+ *
+ * @internal
+ */
+export type isStrictSubset<Subset, Superset> = isAssignableTo<Subset, Superset> extends false ? false : isAssignableTo<Superset, Subset> extends true ? false : true;
+/**
+ * Returns a type parameter that is true iff A and B are assignable to each other, and neither is any.
+ * This is useful for checking if the output of a type meta-function is the expected type.
+ *
+ * @internal
+ */
+export type areSafelyAssignable<A, B> = eitherIsAny<A, B> extends true ? false : isAssignableTo<A, B> extends true ? isAssignableTo<B, A> : false;
+/**
+ * Returns a type parameter that is true iff A is any or B is any.
+ *
+ * @internal
+ */
+export type eitherIsAny<A, B> = true extends isAny<A> | isAny<B> ? true : false;
+/**
+ * Returns a type parameter that is true iff T is any.
+ *
+ * @privateRemarks
+ * Only `never` is assignable to `never` (`any` isn't),
+ * but `any` distributes over the `extends` here while nothing else should.
+ * This can be used to detect `any`.
+ * @internal
+ */
+export type isAny<T> = boolean extends (T extends never ? true : false) ? true : false;
+/**
+ * Compile time assert that A is assignable to (extends) B.
+ * To use, simply define a type:
+ * `type _check = requireAssignableTo<T, Expected>;`
+ *
+ * @internal
+ */
+export type requireAssignableTo<_A extends B, B> = true;
+//# sourceMappingURL=typeCheck.d.ts.map

package/dist/util/typeCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeCheck.d.ts","sourceRoot":"","sources":["../../src/util/typeCheck.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,YAAY,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AAEH;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,WAAW;CAAG;AAE/B;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa,CAAC,EAAE,CAAC,CAAC;IAClC,iBAAiB,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;CACnC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,SAAS,CAAC,GAAG,CAAC,CAAC;IAC/B,qBAAqB,CAAC,EAAE,CAAC,CAAC;CAC1B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;CAAG;AAE9E;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,IAAI,IAAI,IAAI,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,KAAK,IAAI,IAAI,CAAC;AAElD;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,EAAE,WAAW,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEhG;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,EAAE,QAAQ,IAAI,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,KAAK,GAC1F,KAAK,GACL,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,SAAS,IAAI,GAC7C,KAAK,GACL,IAAI,CAAC;AAER;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GACnE,KAAK,GACL,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GACjC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GACpB,KAAK,CAAC;AAET;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,SAAS,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEhF;;;;;;;;GAQG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,OAAO,SAAS,CAAC,CAAC,SAAS,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEvF;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC"}

package/dist/util/typeCheck.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=typeCheck.js.map

package/dist/util/typeCheck.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeCheck.js","sourceRoot":"","sources":["../../src/util/typeCheck.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// Normally we would put tests in the test directory.\n// However in this case,\n// it's important that the tests are run with the same compiler settings this library is being used with,\n// since this library does not work for some configurations (ex: with strictNullChecks disabled).\n// Since the tests don't generate any JS: they only produce types,\n// importing them here gets us the validation of the compiler settings we want, with no JS size overhead.\nexport type { EnforceTypeCheckTests } from \"./typeCheckTests\";\n\n/**\n * Utilities for manipulating the typescript typechecker.\n *\n * @remarks\n * While it appears the the variance parts of this library are made obsolete by TypeScript 4.7's explicit variance annotations,\n * many cases still type check with incorrect variance even when using the explicit annotations,\n * and are fixed by using the patterns in this library.\n *\n * TypeScript uses structural typing if there are no private or protected members,\n * and variance of generic type parameters depends on their usages.\n * Thus when trying to constrain code by adding extra type information,\n * it often fails to actually constrain as desired, and these utilities can help with those cases.\n *\n * This library is designed so that the desired variance can be documented in a way that is easy to read, concise,\n * and allows easy navigation to documentation explaining what is being done\n * for readers who are not familiar with this library.\n * Additionally it constrains the types so the undesired usage patterns will not compile,\n * and will give somewhat intelligible errors.\n *\n * Additionally this library provides the tools needed to test that the type constraints are working as expected,\n * or test any other similar typing constraints in an application.\n *\n * This library assumes you are compiling with --strictFunctionTypes:\n * (Covariance and Contravariance is explained along with how these helpers cause it in typescript at this link)\n * {@link https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-6.html#strict-function-types}.\n * If compiled with a TypeScript configuration that is not strict enough for these features to work,\n * the test suite should fail to build.\n *\n * Classes in TypeScript by default allow all assignments:\n * its only though adding members that any type constraints actually get applied.\n * This library provides types that can be used on a protected member of a class to add the desired constraints.\n *\n * Typical usages (use one field like this at the top of a class):\n * ```typescript\n * protected _typeCheck?: MakeNominal;\n * protected _typeCheck?: Contravariant<T>;\n * protected _typeCheck?: Covariant<T>;\n * protected _typeCheck?: Invariant<T>;\n * protected _typeCheck?: Contravariant<T> & Invariant<K>;\n * ```\n *\n * See tests for examples.\n *\n * Note that all of these cause nominal typing.\n * If constraints on generic type parameter variance are desired, but nominal typing is not,\n * these types can be used on a public field. This case also works with interfaces.\n *\n * Be aware that other members of your type might apply further constraints\n * (ex: you might try and write a Contravariant<T> class, but it ends up being Invariant<T> due to a field of type T).\n *\n * Be aware of TypeScript Bug:\n * {@link https://github.com/microsoft/TypeScript/issues/36906}.\n * This bug is why the fields here are protected not private.\n * Note that this bug is closed as a duplicate of {@link https://github.com/microsoft/TypeScript/issues/20979}\n * which was closed because fixing it would be too large of a breaking change.\n * Thus we expect this bug to be part of TypeScript for the forseeable future.\n */\n\n/**\n * Use this as the type of a protected field to cause a type to use nominal typing instead of structural.\n *\n * @remarks\n * Using nominal typing in this way prevents assignment of objects which are not instances of this class to values of this class's type.\n * Classes which are used with \"instanceof\", or are supposed to be instantiated in particular ways (not just made with object literals)\n * can use this to prevent undesired assignments.\n * @example\n * ```typescript\n * protected _typeCheck?: MakeNominal;\n * ```\n * @privateRemarks\n * See: {@link https://dev.azure.com/intentional/intent/_wiki/wikis/NP%20Platform/7146/Nominal-vs-Structural-Types}\n * @beta\n */\nexport interface MakeNominal {}\n\n/**\n * Constrain generic type parameters to Contravariant.\n *\n * @example\n *\n * ```typescript\n * protected _typeCheck?: Contravariant<T>;\n * ```\n *\n * @internal\n */\nexport interface Contravariant<in T> {\n\t_removeCovariance?: (_: T) => void;\n}\n\n/**\n * Constrain generic type parameters to Covariant.\n *\n * @example\n *\n * ```typescript\n * protected _typeCheck?: Covariant<T>;\n * ```\n *\n * @internal\n */\nexport interface Covariant<out T> {\n\t_removeContravariance?: T;\n}\n\n/**\n * Constrain generic type parameters to Invariant.\n *\n * @example\n *\n * ```typescript\n * protected _typeCheck?: Invariant<T>;\n * ```\n *\n * @internal\n */\nexport interface Invariant<in out T> extends Contravariant<T>, Covariant<T> {}\n\n/**\n * Compile time assert that X is True.\n * To use, simply define a type:\n * `type _check = requireTrue<your type check>;`\n *\n * @internal\n */\nexport type requireTrue<_X extends true> = true;\n\n/**\n * Compile time assert that X is False.\n * To use, simply define a type:\n * `type _check = requireFalse<your type check>;`\n *\n * @internal\n */\nexport type requireFalse<_X extends false> = true;\n\n/**\n * Returns a type parameter that is true iff Source is assignable to Destination.\n *\n * @privateRemarks\n * Use of [] in the extends clause prevents unions from being distributed over this conditional and returning `boolean` in some cases.\n * @see {@link https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types | distributive-conditional-types} for details.\n * @internal\n */\nexport type isAssignableTo<Source, Destination> = [Source] extends [Destination] ? true : false;\n\n/**\n * Returns a type parameter that is true iff Subset is a strict subset of Superset.\n *\n * @internal\n */\nexport type isStrictSubset<Subset, Superset> = isAssignableTo<Subset, Superset> extends false\n\t? false\n\t: isAssignableTo<Superset, Subset> extends true\n\t? false\n\t: true;\n\n/**\n * Returns a type parameter that is true iff A and B are assignable to each other, and neither is any.\n * This is useful for checking if the output of a type meta-function is the expected type.\n *\n * @internal\n */\nexport type areSafelyAssignable<A, B> = eitherIsAny<A, B> extends true\n\t? false\n\t: isAssignableTo<A, B> extends true\n\t? isAssignableTo<B, A>\n\t: false;\n\n/**\n * Returns a type parameter that is true iff A is any or B is any.\n *\n * @internal\n */\nexport type eitherIsAny<A, B> = true extends isAny<A> | isAny<B> ? true : false;\n\n/**\n * Returns a type parameter that is true iff T is any.\n *\n * @privateRemarks\n * Only `never` is assignable to `never` (`any` isn't),\n * but `any` distributes over the `extends` here while nothing else should.\n * This can be used to detect `any`.\n * @internal\n */\nexport type isAny<T> = boolean extends (T extends never ? true : false) ? true : false;\n\n/**\n * Compile time assert that A is assignable to (extends) B.\n * To use, simply define a type:\n * `type _check = requireAssignableTo<T, Expected>;`\n *\n * @internal\n */\nexport type requireAssignableTo<_A extends B, B> = true;\n"]}