@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/lib/util/brand.js

@@ -0,0 +1,118 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Type } from "@sinclair/typebox";
+/**
+ * Helper for {@link Erased}.
+ * This is split out into its own as that's the only way to:
+ * - have doc comments for the member.
+ * - make the member protected (so you don't accidentally try and read it).
+ * - get nominal typing (so types produced without using this class can never be assignable to it).
+ *
+ * See `InternalTypes.MakeNominal` for some more details.
+ *
+ * Do not use this class with `instanceof`: this will always be false at runtime,
+ * but the compiler may think it's true in some cases.
+ *
+ * @sealed
+ * @internal
+ */
+export class ErasedType {
+    /**
+     * This class should never exist at runtime, so make it un-constructable.
+     */
+    constructor() { }
+}
+/**
+ * Helper for {@link Brand}.
+ * This is split out into its own as that's the only way to:
+ * - have doc comments for the member.
+ * - make the member protected (so you don't accidentally try and read it).
+ * - get nominal typing (so types produced without using this class can never be assignable to it).
+ * - allow use as {@link Opaque} branded type (not assignable to `ValueType`, but captures `ValueType`).
+ *
+ * See `InternalTypes.MakeNominal` for some more details.
+ *
+ * Do not use this class with `instanceof`: this will always be false at runtime,
+ * but the compiler may think it's true in some cases.
+ *
+ * @remarks
+ * This is covariant over ValueType.
+ * This is suitable for when ValueType is immutable (like string or number),
+ * which is the common use-case for branding.
+ *
+ * @sealed
+ * @internal
+ */
+export class BrandedType {
+    /**
+     * This class should never exist at runtime, so make it un-constructable.
+     */
+    constructor() { }
+}
+/**
+ * Converts a {@link Opaque} handle to the underlying branded type.
+ *
+ * It is assumed that only code that produces these "opaque" handles does this conversion,
+ * allowing these handles to be considered opaque.
+ * @internal
+ */
+export function extractFromOpaque(value) {
+    return value;
+}
+/**
+ * Converts a {@link Erased} handle to the underlying branded type.
+ *
+ * It is assumed that only code that produces these "opaque" handles does this conversion,
+ * allowing these handles to be considered opaque.
+ * @internal
+ */
+export function fromErased(value) {
+    return value;
+}
+/**
+ * Adds a type {@link Brand} to a value.
+ *
+ * Only do this when specifically allowed by the requirements of the type being converted to.
+ * @internal
+ */
+export function brand(value) {
+    return value;
+}
+/**
+ * Adds a type {@link Brand} to a value, returning it as a {@link Opaque} handle.
+ *
+ * Only do this when specifically allowed by the requirements of the type being converted to.
+ * @internal
+ */
+export function brandOpaque(value) {
+    return value;
+}
+/**
+ * Adds a type {@link Brand} to a value, returning it as a {@link Erased} handle.
+ *
+ * Only do this when specifically allowed by the requirements of the type being converted to.
+ * @internal
+ */
+export function brandErased(value) {
+    return value;
+}
+/**
+ * Create a TypeBox string schema for a branded string type.
+ * This only validates that the value is a string,
+ * and not that it came from the correct branded type (that information is lost when serialized).
+ */
+export function brandedStringType() {
+    // This could use:
+    // return TypeSystem.CreateType<T>(name, (options, value) => typeof value === "string")();
+    // Since there isn't any useful custom validation to do and
+    // TUnsafe is documented as unsupported in `typebox/compiler`,
+    // opt for the compile time behavior like the above, but the runtime behavior of the built in string type.
+    return Type.String();
+}
+export function brandedNumberType() {
+    // See comments on `brandedStringType`.
+    return Type.Number();
+}
+//# sourceMappingURL=brand.js.map

package/lib/util/brand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brand.js","sourceRoot":"","sources":["../../src/util/brand.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAW,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAgClD;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAgB,UAAU;IAY/B;;OAEG;IACH,gBAAuB,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAgB,WAAW;IAahC;;OAEG;IACH,gBAAuB,CAAC;CACxB;AA2DD;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAChC,KAAc;IAEd,OAAO,KAAmC,CAAC;AAC5C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAGxB,KAAwB;IACzB,OAAO,KAA4B,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CACpB,KAAyE;IAEzE,OAAO,KAAU,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAC1B,KAA4E;IAE5E,OAAO,KAA6D,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAC1B,KAA4E;IAE5E,OAAO,KAAuC,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB;IAChC,kBAAkB;IAClB,0FAA0F;IAC1F,2DAA2D;IAC3D,8DAA8D;IAC9D,0GAA0G;IAC1G,OAAO,IAAI,CAAC,MAAM,EAA2B,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,iBAAiB;IAChC,uCAAuC;IACvC,OAAO,IAAI,CAAC,MAAM,EAA2B,CAAC;AAC/C,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TUnsafe, Type } from \"@sinclair/typebox\";\nimport { Covariant, isAny } from \"./typeCheck\";\nimport { Assume } from \"./utils\";\n\n/**\n * Constructs a \"Branded\" type, adding a type-checking only field to `ValueType`.\n *\n * Two usages of `Brand` should never use the same `Name`.\n * If they do, the resulting types will be assignable which defeats the point of this type.\n *\n * This type is constructed such that the first line of type errors when assigning\n * mismatched branded types will be:\n * `Type 'Name1' is not assignable to type 'Name2'.`\n *\n * These branded types are not opaque: A `Brand<A, B>` can still be used as a `B`.\n * @internal\n */\nexport type Brand<ValueType, Name extends string | ErasedType<string>> = ValueType &\n\tBrandedType<ValueType, Name extends Erased<infer TName> ? TName : Assume<Name, string>>;\n\n/**\n * \"opaque\" handle which can be used to expose a branded type without referencing its value type.\n *\n * Recommended usage is to use `interface` instead of `type` so tooling (such as tsc and refactoring tools)\n * uses the type name instead of expanding it:\n * ```typescript\n * export interface MyType extends Erased<\"myPackage.MyType\">{}\n * ```\n * @internal\n */\nexport type Erased<Name extends string> = ErasedType<Name>;\n\n/**\n * Helper for {@link Erased}.\n * This is split out into its own as that's the only way to:\n * - have doc comments for the member.\n * - make the member protected (so you don't accidentally try and read it).\n * - get nominal typing (so types produced without using this class can never be assignable to it).\n *\n * See `InternalTypes.MakeNominal` for some more details.\n *\n * Do not use this class with `instanceof`: this will always be false at runtime,\n * but the compiler may think it's true in some cases.\n *\n * @sealed\n * @internal\n */\nexport abstract class ErasedType<out Name extends string> {\n\t/**\n\t * Compile time only marker to make type checking more strict.\n\t * This method will not exist at runtime and accessing it is invalid.\n\t * See {@link Brand} for details.\n\t *\n\t * @privateRemarks\n\t * `Name` is used as the return type of a method rather than a a simple readonly member as this allows types with two brands to be intersected without getting `never`.\n\t * The method takes in never to help emphasize that its not callable.\n\t */\n\tprotected abstract brand(dummy: never): Name;\n\n\t/**\n\t * This class should never exist at runtime, so make it un-constructable.\n\t */\n\tprivate constructor() {}\n}\n\n/**\n * Helper for {@link Brand}.\n * This is split out into its own as that's the only way to:\n * - have doc comments for the member.\n * - make the member protected (so you don't accidentally try and read it).\n * - get nominal typing (so types produced without using this class can never be assignable to it).\n * - allow use as {@link Opaque} branded type (not assignable to `ValueType`, but captures `ValueType`).\n *\n * See `InternalTypes.MakeNominal` for some more details.\n *\n * Do not use this class with `instanceof`: this will always be false at runtime,\n * but the compiler may think it's true in some cases.\n *\n * @remarks\n * This is covariant over ValueType.\n * This is suitable for when ValueType is immutable (like string or number),\n * which is the common use-case for branding.\n *\n * @sealed\n * @internal\n */\nexport abstract class BrandedType<out ValueType, Name extends string> {\n\tprotected _typeCheck?: Covariant<ValueType>;\n\t/**\n\t * Compile time only marker to make type checking more strict.\n\t * This method will not exist at runtime and accessing it is invalid.\n\t * See {@link Brand} for details.\n\t *\n\t * @privateRemarks\n\t * `Name` is used as the return type of a method rather than a a simple readonly member as this allows types with two brands to be intersected without getting `never`.\n\t * The method takes in never to help emphasize that its not callable.\n\t */\n\tprotected abstract brand(dummy: never): Name;\n\n\t/**\n\t * This class should never exist at runtime, so make it un-constructable.\n\t */\n\tprivate constructor() {}\n}\n\n/**\n * Converts a Branded type into an \"opaque\" handle.\n * This prevents the value from being used directly, but does not fully type erase it\n * (and this its not really fully opaque):\n * The type can be recovered using {@link extractFromOpaque},\n * however if we assume only code that produces these \"opaque\" handles does that conversion,\n * they can function like opaque handles.\n *\n * Recommended usage is to use `interface` instead of `type` so tooling (such as tsc and refactoring tools)\n * uses the type name instead of expanding it:\n * ```typescript\n * export interface MyType extends Opaque<Brand<string, \"myPackage.MyType\">>{}\n * ```\n * @internal\n */\nexport type Opaque<T extends Brand<any, string>> = T extends BrandedType<\n\tinfer ValueType,\n\tinfer Name\n>\n\t? BrandedType<ValueType, Name>\n\t: never;\n\n/**\n * See {@link extractFromOpaque}.\n * @internal\n */\nexport type ExtractFromOpaque<TOpaque extends BrandedType<any, string>> =\n\tTOpaque extends BrandedType<infer ValueType, infer Name>\n\t\t? isAny<ValueType> extends true\n\t\t\t? unknown\n\t\t\t: Brand<ValueType, Name>\n\t\t: never;\n\n/**\n * Implementation detail of type branding. Should not be used directly outside this file,\n * but shows up as part of branded types so API-Extractor requires it to be exported.\n * @internal\n */\nexport type ValueFromBranded<T extends BrandedType<any, string>> = T extends BrandedType<\n\tinfer ValueType,\n\tstring\n>\n\t? ValueType\n\t: never;\n\n/**\n * Implementation detail of type branding. Should not be used directly outside this file,\n * but shows up as part of branded types so API-Extractor requires it to be exported.\n * @internal\n */\nexport type NameFromBranded<T extends BrandedType<any, string>> = T extends BrandedType<\n\tany,\n\tinfer Name\n>\n\t? Name\n\t: never;\n\n/**\n * Converts a {@link Opaque} handle to the underlying branded type.\n *\n * It is assumed that only code that produces these \"opaque\" handles does this conversion,\n * allowing these handles to be considered opaque.\n * @internal\n */\nexport function extractFromOpaque<TOpaque extends BrandedType<any, string>>(\n\tvalue: TOpaque,\n): ExtractFromOpaque<TOpaque> {\n\treturn value as ExtractFromOpaque<TOpaque>;\n}\n\n/**\n * Converts a {@link Erased} handle to the underlying branded type.\n *\n * It is assumed that only code that produces these \"opaque\" handles does this conversion,\n * allowing these handles to be considered opaque.\n * @internal\n */\nexport function fromErased<\n\tTBranded extends BrandedType<unknown, string>,\n\tTName extends string = NameFromBranded<TBranded>,\n>(value: ErasedType<TName>): TBranded {\n\treturn value as unknown as TBranded;\n}\n\n/**\n * Adds a type {@link Brand} to a value.\n *\n * Only do this when specifically allowed by the requirements of the type being converted to.\n * @internal\n */\nexport function brand<T extends Brand<any, string>>(\n\tvalue: T extends BrandedType<infer ValueType, string> ? ValueType : never,\n): T {\n\treturn value as T;\n}\n\n/**\n * Adds a type {@link Brand} to a value, returning it as a {@link Opaque} handle.\n *\n * Only do this when specifically allowed by the requirements of the type being converted to.\n * @internal\n */\nexport function brandOpaque<T extends BrandedType<any, string>>(\n\tvalue: isAny<ValueFromBranded<T>> extends true ? never : ValueFromBranded<T>,\n): BrandedType<ValueFromBranded<T>, NameFromBranded<T>> {\n\treturn value as BrandedType<ValueFromBranded<T>, NameFromBranded<T>>;\n}\n\n/**\n * Adds a type {@link Brand} to a value, returning it as a {@link Erased} handle.\n *\n * Only do this when specifically allowed by the requirements of the type being converted to.\n * @internal\n */\nexport function brandErased<T extends BrandedType<any, string>>(\n\tvalue: isAny<ValueFromBranded<T>> extends true ? never : ValueFromBranded<T>,\n): ErasedType<NameFromBranded<T>> {\n\treturn value as ErasedType<NameFromBranded<T>>;\n}\n\n/**\n * Create a TypeBox string schema for a branded string type.\n * This only validates that the value is a string,\n * and not that it came from the correct branded type (that information is lost when serialized).\n */\nexport function brandedStringType<T extends string>(): TUnsafe<T> {\n\t// This could use:\n\t// return TypeSystem.CreateType<T>(name, (options, value) => typeof value === \"string\")();\n\t// Since there isn't any useful custom validation to do and\n\t// TUnsafe is documented as unsupported in `typebox/compiler`,\n\t// opt for the compile time behavior like the above, but the runtime behavior of the built in string type.\n\treturn Type.String() as unknown as TUnsafe<T>;\n}\n\nexport function brandedNumberType<T extends number>(): TUnsafe<T> {\n\t// See comments on `brandedStringType`.\n\treturn Type.Number() as unknown as TUnsafe<T>;\n}\n"]}

package/lib/util/brandedMap.d.ts

@@ -0,0 +1,46 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Invariant } from "./typeCheck";
+/**
+ * Key in a {@link BrandedMapSubset}.
+ * @internal
+ */
+export type BrandedKey<TKey, TContent> = TKey & Invariant<TContent>;
+/**
+ * @internal
+ */
+export type BrandedKeyContent<TKey extends BrandedKey<unknown, any>> = TKey extends BrandedKey<unknown, infer TContent> ? TContent : never;
+/**
+ * A Map where the keys carry the types of values which they correspond to.
+ *
+ * Example usage:
+ * ```typescript
+ * type FooSlot<TContent> = BrandedKey<Opaque<Brand<number, "FooSlot">>, TContent>;
+ * const counterSlot = brandedSlot<FooSlot<number>>();
+ * const slots: BrandedMapSubset<FooSlot<any>> = new Map();
+ * slots.set(counterSlot, slots.get(counterSlot) ?? 0 + 1);
+ * ```
+ *
+ * @remarks
+ * These APIs are designed so that a Map can be used to implement this type.
+ *
+ * @internal
+ */
+export interface BrandedMapSubset<K extends BrandedKey<unknown, any>> {
+    get<K2 extends K>(key: K2): BrandedKeyContent<K2> | undefined;
+    has(key: K): boolean;
+    set<K2 extends K>(key: K2, value: BrandedKeyContent<K2>): this;
+    delete(key: K): boolean;
+}
+/**
+ * Version of {@link getOrCreate} with better typing for {@link BrandedMapSubset}.
+ */
+export declare function getOrCreateSlotContent<M extends BrandedMapSubset<BrandedKey<unknown, any>>, K extends BrandedKey<unknown, any>>(map: M, key: K, defaultValue: (key: K) => BrandedKeyContent<K>): BrandedKeyContent<K>;
+/**
+ * Define a strongly typed slot in which data can be stored in a {@link BrandedMapSubset}.
+ * @internal
+ */
+export declare function brandedSlot<TSlot extends BrandedKey<any, any>>(): TSlot;
+//# sourceMappingURL=brandedMap.d.ts.map

package/lib/util/brandedMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brandedMap.d.ts","sourceRoot":"","sources":["../../src/util/brandedMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,IAAI,EAAE,QAAQ,IAAI,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,IAAI,SAAS,UAAU,CAC7F,OAAO,EACP,MAAM,QAAQ,CACd,GACE,QAAQ,GACR,KAAK,CAAC;AAET;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC;IACnE,GAAG,CAAC,EAAE,SAAS,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,iBAAiB,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IAC9D,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,SAAS,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,iBAAiB,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IAC/D,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACrC,CAAC,SAAS,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,EACpD,CAAC,SAAS,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,EACjC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAItF;AASD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,KAAK,CAEvE"}

package/lib/util/brandedMap.js

@@ -0,0 +1,27 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { getOrCreate } from "./utils";
+/**
+ * Version of {@link getOrCreate} with better typing for {@link BrandedMapSubset}.
+ */
+export function getOrCreateSlotContent(map, key, defaultValue) {
+    const result = getOrCreate(map, key, defaultValue);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return result;
+}
+/**
+ * A counter used to allocate unique numbers (See {@link brandedSlot}) to use as {@link BrandedKey}s.
+ * This allows the keys to be small integers, which are efficient to use as keys in maps.
+ * See {@link BrandedMapSubset}.
+ */
+let slotCounter = 0;
+/**
+ * Define a strongly typed slot in which data can be stored in a {@link BrandedMapSubset}.
+ * @internal
+ */
+export function brandedSlot() {
+    return slotCounter++;
+}
+//# sourceMappingURL=brandedMap.js.map

package/lib/util/brandedMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brandedMap.js","sourceRoot":"","sources":["../../src/util/brandedMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAyCtC;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAGpC,GAAM,EAAE,GAAM,EAAE,YAA8C;IAC/D,MAAM,MAAM,GAAyB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IACzE,+DAA+D;IAC/D,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,IAAI,WAAW,GAAG,CAAC,CAAC;AAEpB;;;GAGG;AACH,MAAM,UAAU,WAAW;IAC1B,OAAO,WAAW,EAAW,CAAC;AAC/B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Invariant } from \"./typeCheck\";\nimport { getOrCreate } from \"./utils\";\n\n/**\n * Key in a {@link BrandedMapSubset}.\n * @internal\n */\nexport type BrandedKey<TKey, TContent> = TKey & Invariant<TContent>;\n\n/**\n * @internal\n */\nexport type BrandedKeyContent<TKey extends BrandedKey<unknown, any>> = TKey extends BrandedKey<\n\tunknown,\n\tinfer TContent\n>\n\t? TContent\n\t: never;\n\n/**\n * A Map where the keys carry the types of values which they correspond to.\n *\n * Example usage:\n * ```typescript\n * type FooSlot<TContent> = BrandedKey<Opaque<Brand<number, \"FooSlot\">>, TContent>;\n * const counterSlot = brandedSlot<FooSlot<number>>();\n * const slots: BrandedMapSubset<FooSlot<any>> = new Map();\n * slots.set(counterSlot, slots.get(counterSlot) ?? 0 + 1);\n * ```\n *\n * @remarks\n * These APIs are designed so that a Map can be used to implement this type.\n *\n * @internal\n */\nexport interface BrandedMapSubset<K extends BrandedKey<unknown, any>> {\n\tget<K2 extends K>(key: K2): BrandedKeyContent<K2> | undefined;\n\thas(key: K): boolean;\n\tset<K2 extends K>(key: K2, value: BrandedKeyContent<K2>): this;\n\tdelete(key: K): boolean;\n}\n\n/**\n * Version of {@link getOrCreate} with better typing for {@link BrandedMapSubset}.\n */\nexport function getOrCreateSlotContent<\n\tM extends BrandedMapSubset<BrandedKey<unknown, any>>,\n\tK extends BrandedKey<unknown, any>,\n>(map: M, key: K, defaultValue: (key: K) => BrandedKeyContent<K>): BrandedKeyContent<K> {\n\tconst result: BrandedKeyContent<K> = getOrCreate(map, key, defaultValue);\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\treturn result;\n}\n\n/**\n * A counter used to allocate unique numbers (See {@link brandedSlot}) to use as {@link BrandedKey}s.\n * This allows the keys to be small integers, which are efficient to use as keys in maps.\n * See {@link BrandedMapSubset}.\n */\nlet slotCounter = 0;\n\n/**\n * Define a strongly typed slot in which data can be stored in a {@link BrandedMapSubset}.\n * @internal\n */\nexport function brandedSlot<TSlot extends BrandedKey<any, any>>(): TSlot {\n\treturn slotCounter++ as TSlot;\n}\n"]}

package/lib/util/idAllocator.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Used for allocating IDs unique to a particular instance of the allocator.
+ * @internal
+ */
+export interface IdAllocator<TId = number> {
+    /**
+     * Allocates a block of `count` consecutive IDs and returns the first ID in the block.
+     * For convenience can be called with no parameters to allocate a single ID.
+     */
+    allocate: (count?: number) => TId;
+    /**
+     * @returns The next ID that will be allocated by this allocator.
+     */
+    getNextId: () => TId;
+}
+export interface IdAllocationState {
+    maxId: number;
+}
+/**
+ * @internal
+ */
+export declare function idAllocatorFromMaxId(maxId?: number | undefined): IdAllocator;
+export declare function idAllocatorFromState(state: IdAllocationState): IdAllocator;
+export declare const fakeIdAllocator: IdAllocator;
+//# sourceMappingURL=idAllocator.d.ts.map

package/lib/util/idAllocator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"idAllocator.d.ts","sourceRoot":"","sources":["../../src/util/idAllocator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,GAAG,GAAG,MAAM;IACxC;;;OAGG;IACH,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,GAAG,CAAC;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IACjC,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,GAAE,MAAM,GAAG,SAAqB,GAAG,WAAW,CAEvF;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,iBAAiB,GAAG,WAAW,CAW1E;AAED,eAAO,MAAM,eAAe,EAAE,WAG7B,CAAC"}

package/lib/util/idAllocator.js

@@ -0,0 +1,29 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert } from "@fluidframework/core-utils";
+import { fail } from "./utils";
+/**
+ * @internal
+ */
+export function idAllocatorFromMaxId(maxId = undefined) {
+    return idAllocatorFromState({ maxId: maxId ?? -1 });
+}
+export function idAllocatorFromState(state) {
+    return {
+        allocate: (c) => {
+            const count = c ?? 1;
+            assert(count > 0, 0x5cf /* Must allocate at least one ID */);
+            const id = state.maxId + 1;
+            state.maxId += count;
+            return id;
+        },
+        getNextId: () => state.maxId,
+    };
+}
+export const fakeIdAllocator = {
+    allocate: () => fail("Should not allocate IDs"),
+    getNextId: () => 0,
+};
+//# sourceMappingURL=idAllocator.js.map

package/lib/util/idAllocator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"idAllocator.js","sourceRoot":"","sources":["../../src/util/idAllocator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAsB/B;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAA4B,SAAS;IACzE,OAAO,oBAAoB,CAAC,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAwB;IAC5D,OAAO;QACN,QAAQ,EAAE,CAAC,CAAU,EAAE,EAAE;YACxB,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;YACrB,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;YAC7D,MAAM,EAAE,GAAW,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;YACnC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC;YACrB,OAAO,EAAE,CAAC;QACX,CAAC;QACD,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK;KAC5B,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,eAAe,GAAgB;IAC3C,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC;IAC/C,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;CAClB,CAAC","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\";\nimport { fail } from \"./utils\";\n\n/**\n * Used for allocating IDs unique to a particular instance of the allocator.\n * @internal\n */\nexport interface IdAllocator<TId = number> {\n\t/**\n\t * Allocates a block of `count` consecutive IDs and returns the first ID in the block.\n\t * For convenience can be called with no parameters to allocate a single ID.\n\t */\n\tallocate: (count?: number) => TId;\n\t/**\n\t * @returns The next ID that will be allocated by this allocator.\n\t */\n\tgetNextId: () => TId;\n}\n\nexport interface IdAllocationState {\n\tmaxId: number;\n}\n\n/**\n * @internal\n */\nexport function idAllocatorFromMaxId(maxId: number | undefined = undefined): IdAllocator {\n\treturn idAllocatorFromState({ maxId: maxId ?? -1 });\n}\n\nexport function idAllocatorFromState(state: IdAllocationState): IdAllocator {\n\treturn {\n\t\tallocate: (c?: number) => {\n\t\t\tconst count = c ?? 1;\n\t\t\tassert(count > 0, 0x5cf /* Must allocate at least one ID */);\n\t\t\tconst id: number = state.maxId + 1;\n\t\t\tstate.maxId += count;\n\t\t\treturn id;\n\t\t},\n\t\tgetNextId: () => state.maxId,\n\t};\n}\n\nexport const fakeIdAllocator: IdAllocator = {\n\tallocate: () => fail(\"Should not allocate IDs\"),\n\tgetNextId: () => 0,\n};\n"]}

package/lib/util/index.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { brand, Brand, BrandedType, brandOpaque, brandedNumberType, brandedStringType, extractFromOpaque, ExtractFromOpaque, fromErased, Erased, ErasedType, NameFromBranded, Opaque, ValueFromBranded, brandErased, } from "./brand";
+export { deleteFromNestedMap, getOrAddInMap, getOrAddInNestedMap, getOrDefaultInNestedMap, forEachInNestedMap, NestedMap, SizedNestedMap, populateNestedMap, setInNestedMap, tryAddToNestedMap, tryGetFromNestedMap, nestedMapToFlatList, nestedMapFromFlatList, } from "./nestedMap";
+export { addToNestedSet, NestedSet, nestedSetContains } from "./nestedSet";
+export { OffsetList, OffsetListFactory } from "./offsetList";
+export { TransactionResult } from "./transactionResult";
+export { areSafelyAssignable, Contravariant, Covariant, eitherIsAny, EnforceTypeCheckTests, Invariant, isAny, isAssignableTo, isStrictSubset, MakeNominal, requireFalse, requireTrue, requireAssignableTo, } from "./typeCheck";
+export { StackyIterator } from "./stackyIterator";
+export { asMutable, clone, compareSets, fail, getOrAddEmptyToMap, getOrCreate, isJsonObject, isReadonlyArray, JsonCompatible, JsonCompatibleObject, JsonCompatibleReadOnly, JsonCompatibleReadOnlySchema, makeArray, mapIterable, Mutable, Populated, RecursiveReadonly, zipIterables, Assume, assertValidIndex, assertValidRange, assertNonNegativeSafeInteger, generateStableId, useDeterministicStableId, useAsyncDeterministicStableId, objectToMap, invertMap, oneFromSet, Named, compareNamed, disposeSymbol, IDisposable, capitalize, assertValidRangeIndices, transformObjectMap, compareStrings, } from "./utils";
+export { ReferenceCountedBase, ReferenceCounted } from "./referenceCounting";
+export { AllowOptional, RequiredFields, OptionalFields, _InlineTrick, _RecursiveTrick, FlattenKeys, AllowOptionalNotFlattened, RestrictiveReadonlyRecord, } from "./typeUtils";
+export { BrandedKey, BrandedKeyContent, BrandedMapSubset, getOrCreateSlotContent, brandedSlot, } from "./brandedMap";
+export { getFirstEntryFromRangeMap, getFromRangeMap, RangeEntry, RangeMap, RangeQueryResult, setInRangeMap, } from "./rangeMap";
+export { IdAllocator, idAllocatorFromMaxId, idAllocatorFromState, IdAllocationState, fakeIdAllocator, } from "./idAllocator";
+//# sourceMappingURL=index.d.ts.map

package/lib/util/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,EACL,KAAK,EACL,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,MAAM,EACN,UAAU,EACV,eAAe,EACf,MAAM,EACN,gBAAgB,EAChB,WAAW,GACX,MAAM,SAAS,CAAC;AACjB,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAClB,SAAS,EACT,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,GACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,SAAS,EACT,WAAW,EACX,qBAAqB,EACrB,SAAS,EACT,KAAK,EACL,cAAc,EACd,cAAc,EACd,WAAW,EACX,YAAY,EACZ,WAAW,EACX,mBAAmB,GACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACN,SAAS,EACT,KAAK,EACL,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,eAAe,EACf,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,4BAA4B,EAC5B,SAAS,EACT,WAAW,EACX,OAAO,EACP,SAAS,EACT,iBAAiB,EACjB,YAAY,EACZ,MAAM,EACN,gBAAgB,EAChB,gBAAgB,EAChB,4BAA4B,EAC5B,gBAAgB,EAChB,wBAAwB,EACxB,6BAA6B,EAC7B,WAAW,EACX,SAAS,EACT,UAAU,EACV,KAAK,EACL,YAAY,EACZ,aAAa,EACb,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE7E,OAAO,EACN,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,eAAe,EACf,WAAW,EACX,yBAAyB,EACzB,yBAAyB,GACzB,MAAM,aAAa,CAAC;AAErB,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,WAAW,GACX,MAAM,cAAc,CAAC;AAEtB,OAAO,EACN,yBAAyB,EACzB,eAAe,EACf,UAAU,EACV,QAAQ,EACR,gBAAgB,EAChB,aAAa,GACb,MAAM,YAAY,CAAC;AAEpB,OAAO,EACN,WAAW,EACX,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,GACf,MAAM,eAAe,CAAC"}

package/lib/util/index.js

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { brand, BrandedType, brandOpaque, brandedNumberType, brandedStringType, extractFromOpaque, fromErased, ErasedType, brandErased, } from "./brand";
+export { deleteFromNestedMap, getOrAddInMap, getOrAddInNestedMap, getOrDefaultInNestedMap, forEachInNestedMap, SizedNestedMap, populateNestedMap, setInNestedMap, tryAddToNestedMap, tryGetFromNestedMap, nestedMapToFlatList, nestedMapFromFlatList, } from "./nestedMap";
+export { addToNestedSet, nestedSetContains } from "./nestedSet";
+export { OffsetListFactory } from "./offsetList";
+export { TransactionResult } from "./transactionResult";
+export { StackyIterator } from "./stackyIterator";
+export { asMutable, clone, compareSets, fail, getOrAddEmptyToMap, getOrCreate, isJsonObject, isReadonlyArray, JsonCompatibleReadOnlySchema, makeArray, mapIterable, zipIterables, assertValidIndex, assertValidRange, assertNonNegativeSafeInteger, generateStableId, useDeterministicStableId, useAsyncDeterministicStableId, objectToMap, invertMap, oneFromSet, compareNamed, disposeSymbol, capitalize, assertValidRangeIndices, transformObjectMap, compareStrings, } from "./utils";
+export { ReferenceCountedBase } from "./referenceCounting";
+export { getOrCreateSlotContent, brandedSlot, } from "./brandedMap";
+export { getFirstEntryFromRangeMap, getFromRangeMap, setInRangeMap, } from "./rangeMap";
+export { idAllocatorFromMaxId, idAllocatorFromState, fakeIdAllocator, } from "./idAllocator";
+//# sourceMappingURL=index.js.map

package/lib/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,EAEL,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EAEjB,UAAU,EAEV,UAAU,EAIV,WAAW,GACX,MAAM,SAAS,CAAC;AACjB,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAElB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,GACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAa,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAc,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAgBxD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACN,SAAS,EACT,KAAK,EACL,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,eAAe,EAIf,4BAA4B,EAC5B,SAAS,EACT,WAAW,EAIX,YAAY,EAEZ,gBAAgB,EAChB,gBAAgB,EAChB,4BAA4B,EAC5B,gBAAgB,EAChB,wBAAwB,EACxB,6BAA6B,EAC7B,WAAW,EACX,SAAS,EACT,UAAU,EAEV,YAAY,EACZ,aAAa,EAEb,UAAU,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,oBAAoB,EAAoB,MAAM,qBAAqB,CAAC;AAa7E,OAAO,EAIN,sBAAsB,EACtB,WAAW,GACX,MAAM,cAAc,CAAC;AAEtB,OAAO,EACN,yBAAyB,EACzB,eAAe,EAIf,aAAa,GACb,MAAM,YAAY,CAAC;AAEpB,OAAO,EAEN,oBAAoB,EACpB,oBAAoB,EAEpB,eAAe,GACf,MAAM,eAAe,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tbrand,\n\tBrand,\n\tBrandedType,\n\tbrandOpaque,\n\tbrandedNumberType,\n\tbrandedStringType,\n\textractFromOpaque,\n\tExtractFromOpaque,\n\tfromErased,\n\tErased,\n\tErasedType,\n\tNameFromBranded,\n\tOpaque,\n\tValueFromBranded,\n\tbrandErased,\n} from \"./brand\";\nexport {\n\tdeleteFromNestedMap,\n\tgetOrAddInMap,\n\tgetOrAddInNestedMap,\n\tgetOrDefaultInNestedMap,\n\tforEachInNestedMap,\n\tNestedMap,\n\tSizedNestedMap,\n\tpopulateNestedMap,\n\tsetInNestedMap,\n\ttryAddToNestedMap,\n\ttryGetFromNestedMap,\n\tnestedMapToFlatList,\n\tnestedMapFromFlatList,\n} from \"./nestedMap\";\nexport { addToNestedSet, NestedSet, nestedSetContains } from \"./nestedSet\";\nexport { OffsetList, OffsetListFactory } from \"./offsetList\";\nexport { TransactionResult } from \"./transactionResult\";\nexport {\n\tareSafelyAssignable,\n\tContravariant,\n\tCovariant,\n\teitherIsAny,\n\tEnforceTypeCheckTests,\n\tInvariant,\n\tisAny,\n\tisAssignableTo,\n\tisStrictSubset,\n\tMakeNominal,\n\trequireFalse,\n\trequireTrue,\n\trequireAssignableTo,\n} from \"./typeCheck\";\nexport { StackyIterator } from \"./stackyIterator\";\nexport {\n\tasMutable,\n\tclone,\n\tcompareSets,\n\tfail,\n\tgetOrAddEmptyToMap,\n\tgetOrCreate,\n\tisJsonObject,\n\tisReadonlyArray,\n\tJsonCompatible,\n\tJsonCompatibleObject,\n\tJsonCompatibleReadOnly,\n\tJsonCompatibleReadOnlySchema,\n\tmakeArray,\n\tmapIterable,\n\tMutable,\n\tPopulated,\n\tRecursiveReadonly,\n\tzipIterables,\n\tAssume,\n\tassertValidIndex,\n\tassertValidRange,\n\tassertNonNegativeSafeInteger,\n\tgenerateStableId,\n\tuseDeterministicStableId,\n\tuseAsyncDeterministicStableId,\n\tobjectToMap,\n\tinvertMap,\n\toneFromSet,\n\tNamed,\n\tcompareNamed,\n\tdisposeSymbol,\n\tIDisposable,\n\tcapitalize,\n\tassertValidRangeIndices,\n\ttransformObjectMap,\n\tcompareStrings,\n} from \"./utils\";\nexport { ReferenceCountedBase, ReferenceCounted } from \"./referenceCounting\";\n\nexport {\n\tAllowOptional,\n\tRequiredFields,\n\tOptionalFields,\n\t_InlineTrick,\n\t_RecursiveTrick,\n\tFlattenKeys,\n\tAllowOptionalNotFlattened,\n\tRestrictiveReadonlyRecord,\n} from \"./typeUtils\";\n\nexport {\n\tBrandedKey,\n\tBrandedKeyContent,\n\tBrandedMapSubset,\n\tgetOrCreateSlotContent,\n\tbrandedSlot,\n} from \"./brandedMap\";\n\nexport {\n\tgetFirstEntryFromRangeMap,\n\tgetFromRangeMap,\n\tRangeEntry,\n\tRangeMap,\n\tRangeQueryResult,\n\tsetInRangeMap,\n} from \"./rangeMap\";\n\nexport {\n\tIdAllocator,\n\tidAllocatorFromMaxId,\n\tidAllocatorFromState,\n\tIdAllocationState,\n\tfakeIdAllocator,\n} from \"./idAllocator\";\n"]}

package/lib/util/nestedMap.d.ts

@@ -0,0 +1,129 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { MapGetSet } from "./utils";
+/**
+ * A dictionary whose values are keyed off of two objects (key1, key2).
+ * As it is a nested map, size() will return the number of distinct key1s.
+ * If you need constant-time access to the number of values, use SizedNestedMap instead.
+ *
+ * This code assumes values will not be undefined (keys can be undefined).
+ *
+ * @internal
+ */
+export type NestedMap<Key1, Key2, Value> = Map<Key1, Map<Key2, Value>>;
+/**
+ * If (key1, key2) already has a value in the map, it is returned, otherwise value is added under (key1, key2) and undefined is returned.
+ *
+ * @internal
+ */
+export declare function tryAddToNestedMap<Key1, Key2, Value>(map: NestedMap<Key1, Key2, Value>, key1: Key1, key2: Key2, value: Value): Value | undefined;
+/**
+ * Copies over all entries from the source map into the destination map.
+ *
+ * @internal
+ */
+export declare function populateNestedMap<Key1, Key2, Value>(source: NestedMap<Key1, Key2, Value>, destination: NestedMap<Key1, Key2, Value>): void;
+/**
+ * Sets the value at (key1, key2) in map to value.
+ * If there already is a value for (key1, key2), it is replaced with the provided one.
+ *
+ * @internal
+ */
+export declare function setInNestedMap<Key1, Key2, Value>(map: NestedMap<Key1, Key2, Value>, key1: Key1, key2: Key2, value: Value): void;
+/**
+ * Sets the value at `key` in map to value if not already present.
+ * Returns the value at `key` after setting it.
+ * This is equivalent to a get or default that adds the default to the map.
+ */
+export declare function getOrAddInMap<Key, Value>(map: MapGetSet<Key, Value>, key: Key, value: Value): Value;
+/**
+ * Returns the value at (key1, key2) in map, or undefined if not present.
+ *
+ * @internal
+ */
+export declare function tryGetFromNestedMap<Key1, Key2, Value>(map: NestedMap<Key1, Key2, Value>, key1: Key1, key2: Key2): Value | undefined;
+/**
+ * If (key1, key2) is not in the map, add value to the map.
+ * Returns whatever is at (key1, key2) in map (which will be value if it was empty before).
+ *
+ * @internal
+ */
+export declare function getOrAddInNestedMap<Key1, Key2, Value>(map: NestedMap<Key1, Key2, Value>, key1: Key1, key2: Key2, value: Value): Value;
+/**
+ * Does not change map.
+ * If (key1, key2) is not in map, returns value.
+ * If (key1, key2) is in map, return its entry.
+ *
+ * @internal
+ */
+export declare function getOrDefaultInNestedMap<Key1, Key2, Value>(map: NestedMap<Key1, Key2, Value>, key1: Key1, key2: Key2, value: Value): Value;
+/**
+ * Removes the value at (key1, key2) from the map.
+ *
+ * @returns true iff found.
+ *
+ * @internal
+ */
+export declare function deleteFromNestedMap<Key1, Key2, Value>(map: NestedMap<Key1, Key2, Value>, key1: Key1, key2: Key2): boolean;
+/**
+ * Converts a nested map to a flat list of triplets.
+ */
+export declare function nestedMapToFlatList<Key1, Key2, Value>(map: NestedMap<Key1, Key2, Value>): [Key1, Key2, Value][];
+/**
+ * Builds a nested map from a flat list of triplets.
+ */
+export declare function nestedMapFromFlatList<Key1, Key2, Value>(list: readonly (readonly [Key1, Key2, Value])[]): NestedMap<Key1, Key2, Value>;
+export declare function forEachInNestedMap<Key1, Key2, Value>(map: NestedMap<Key1, Key2, Value>, delegate: (value: Value, key1: Key1, key2: Key2) => void): void;
+/**
+ * Map with two keys; same semantics as NestedMap, but maintains a size count for the entire collection.
+ * Note: undefined is not supported as a value, and will cause incorrect behavior.
+ *
+ * @internal
+ */
+export declare class SizedNestedMap<Key1, Key2, Value> {
+    private readonly nestedMap;
+    private count;
+    /**
+     * Returns the total number of elements in this nested map.
+     */
+    get size(): number;
+    /**
+     * If (key1, key2) already has a value in the map, it is returned, otherwise value is added under (key1, key2) and undefined is
+     * returned.
+     */
+    tryGet(key1: Key1, key2: Key2): Value | undefined;
+    /**
+     * Does not change map.
+     * If (key1, key2) is not in map, returns value.
+     * If (key1, key2) is in map, return its entry.
+     */
+    getOrDefault(key1: Key1, key2: Key2, value: Value): Value;
+    /**
+     * If (key1, key2) already has a value in the map, it is returned, otherwise value is added under (key1, key2) and undefined is
+     * returned.
+     */
+    tryAdd(key1: Key1, key2: Key2, value: Value): Value | undefined;
+    /**
+     * Sets the value at (key1, key2) in map to value.
+     * If there already is a value for (key1, key2), it is replaced with the provided one.
+     */
+    set(key1: Key1, key2: Key2, value: Value): void;
+    /**
+     * Removes the value at (key1, key2) from the map.
+     * Returns true iff found.
+     */
+    delete(key1: Key1, key2: Key2): boolean;
+    /**
+     * Runs the supplied delegate for every (value, key1, key2).
+     */
+    forEach(delegate: (value: Value, key1: Key1, key2: Key2) => void): void;
+    /**
+     * Clears the map.
+     */
+    clear(): void;
+    values(): IterableIterator<Value>;
+    [Symbol.iterator](): IterableIterator<[Key1, Map<Key2, Value>]>;
+}
+//# sourceMappingURL=nestedMap.d.ts.map

package/lib/util/nestedMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestedMap.d.ts","sourceRoot":"","sources":["../../src/util/nestedMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,IAAI,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AAEvE;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAClD,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EACjC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,KAAK,GACV,KAAK,GAAG,SAAS,CAWnB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAClD,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EACpC,WAAW,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,GACvC,IAAI,CAIN;AACD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAC/C,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EACjC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,KAAK,GACV,IAAI,CAGN;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,KAAK,EACvC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,EAC1B,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,GACV,KAAK,CAOP;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EACpD,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EACjC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,GACR,KAAK,GAAG,SAAS,CAMnB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EACpD,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EACjC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,KAAK,GACV,KAAK,CAMP;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EACxD,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EACjC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,KAAK,GACV,KAAK,CAMP;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EACpD,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EACjC,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,GACR,OAAO,CAUT;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EACpD,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,GAC/B,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,CAQvB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EACtD,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,GAC7C,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAM9B;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EACnD,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EACjC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,GACtD,IAAI,CAMN;AAED;;;;;GAKG;AACH,qBAAa,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA2C;IACrE,OAAO,CAAC,KAAK,CAAK;IAElB;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,KAAK,GAAG,SAAS;IAIxD;;;;OAIG;IACI,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK;IAIhE;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS;IAQtE;;;OAGG;IACI,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAMtD;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO;IAQ9C;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI;IAI9E;;OAEG;IACI,KAAK,IAAI,IAAI;IAKb,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC;IAIjC,CAAC,MAAM,CAAC,QAAQ,CAAC;CAGxB"}