@fluidframework/tree 2.12.0 → 2.20.0

package/lib/util/idAllocator.js.map

@@ -1 +1 @@
-{"version":3,"file":"idAllocator.js","sourceRoot":"","sources":["../../src/util/idAllocator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAqBlC;GACG;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,EAAU,EAAE;YAChC,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,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK;KAC3B,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,eAAe,GAAgB;IAC3C,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC;IAC/C,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;CACjB,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/internal\";\n\nimport { fail } from \"./utils.js\";\n\n/**\n * Used for allocating IDs unique to a particular instance of the allocator.\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 maximum ID that was generated by this allocator.\n\t */\n\tgetMaxId: () => TId;\n}\n\nexport interface IdAllocationState {\n\tmaxId: number;\n}\n\n/**\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): 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\tgetMaxId: () => state.maxId,\n\t};\n}\n\nexport const fakeIdAllocator: IdAllocator = {\n\tallocate: () => fail(\"Should not allocate IDs\"),\n\tgetMaxId: () => 0,\n};\n"]}
+{"version":3,"file":"idAllocator.js","sourceRoot":"","sources":["../../src/util/idAllocator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAqBlC,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,EAAU,EAAE;YAChC,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,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK;KAC3B,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,eAAe,GAAgB;IAC3C,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC;IAC/C,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;CACjB,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/internal\";\n\nimport { fail } from \"./utils.js\";\n\n/**\n * Used for allocating IDs unique to a particular instance of the allocator.\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 maximum ID that was generated by this allocator.\n\t */\n\tgetMaxId: () => TId;\n}\n\nexport interface IdAllocationState {\n\tmaxId: number;\n}\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): 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\tgetMaxId: () => state.maxId,\n\t};\n}\n\nexport const fakeIdAllocator: IdAllocator = {\n\tallocate: () => fail(\"Should not allocate IDs\"),\n\tgetMaxId: () => 0,\n};\n"]}

package/lib/util/index.d.ts

@@ -10,12 +10,13 @@ export { addToNestedSet, type NestedSet, nestedSetContains } from "./nestedSet.j
 export { type OffsetList, OffsetListFactory } from "./offsetList.js";
 export type { areSafelyAssignable, Contravariant, Covariant, eitherIsAny, EnforceTypeCheckTests, Invariant, isAny, isAssignableTo, isStrictSubset, MakeNominal, requireFalse, requireTrue, requireAssignableTo, areOnlyKeys, } from "./typeCheck.js";
 export { StackyIterator } from "./stackyIterator.js";
-export { asMutable, clone, compareSets, fail, getOrAddEmptyToMap, getOrCreate, isJsonObject, isReadonlyArray, type JsonCompatible, type JsonCompatibleObject, type JsonCompatibleReadOnly, type JsonCompatibleReadOnlyObject, JsonCompatibleReadOnlySchema, makeArray, mapIterable, filterIterable, type Mutable, type Populated, type RecursiveReadonly, assertValidIndex, assertValidRange, assertNonNegativeSafeInteger, objectToMap, invertMap, oneFromSet, type Named, compareNamed, disposeSymbol, type IDisposable, capitalize, assertValidRangeIndices, transformObjectMap, compareStrings, find, count, getLast, hasSome, hasSingle, defineLazyCachedProperty, } from "./utils.js";
+export { asMutable, clone, compareSets, fail, getOrAddEmptyToMap, getOrCreate, isJsonObject, isReadonlyArray, type JsonCompatible, type JsonCompatibleObject, type JsonCompatibleReadOnly, type JsonCompatibleReadOnlyObject, JsonCompatibleReadOnlySchema, makeArray, mapIterable, filterIterable, type Mutable, type Populated, type RecursiveReadonly, assertValidIndex, assertValidRange, assertNonNegativeSafeInteger, objectToMap, invertMap, oneFromSet, type Named, compareNamed, disposeSymbol, type IDisposable, capitalize, assertValidRangeIndices, transformObjectMap, compareStrings, find, count, getLast, hasSome, hasSingle, defineLazyCachedProperty, copyPropertyIfDefined as copyProperty, } from "./utils.js";
 export { ReferenceCountedBase, type ReferenceCounted } from "./referenceCounting.js";
 export type { _RecursiveTrick, RestrictiveReadonlyRecord, RestrictiveStringRecord, _InlineTrick, FlattenKeys, IsUnion, UnionToIntersection, UnionToTuple, PopUnion, } from "./typeUtils.js";
 export { unsafeArrayToTuple } from "./typeUtils.js";
 export { type BrandedKey, type BrandedKeyContent, type BrandedMapSubset, getOrCreateSlotContent, brandedSlot, } from "./brandedMap.js";
-export { getFirstEntryFromRangeMap, getFromRangeMap, type RangeEntry, type RangeMap, type RangeQueryResult, setInRangeMap, deleteFromRangeMap, } from "./rangeMap.js";
+export { RangeMap, type RangeQueryResult, newIntegerRangeMap, } from "./rangeMap.js";
 export { type IdAllocator, idAllocatorFromMaxId, idAllocatorFromState, type IdAllocationState, fakeIdAllocator, } from "./idAllocator.js";
 export { Breakable, type WithBreakable, breakingMethod, throwIfBroken, breakingClass, } from "./breakable.js";
+export { type TupleBTree, newTupleBTree, mergeTupleBTrees } from "./bTreeUtils.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,EACL,KAAK,KAAK,EACV,WAAW,EACX,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACrB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EACN,WAAW,EACX,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,MAAM,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAClB,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,mBAAmB,EACnB,qBAAqB,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,KAAK,SAAS,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EAAE,KAAK,UAAU,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACrE,YAAY,EACX,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,EACnB,WAAW,GACX,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EACN,SAAS,EACT,KAAK,EACL,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,eAAe,EACf,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,4BAA4B,EACjC,4BAA4B,EAC5B,SAAS,EACT,WAAW,EACX,cAAc,EACd,KAAK,OAAO,EACZ,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,gBAAgB,EAChB,gBAAgB,EAChB,4BAA4B,EAC5B,WAAW,EACX,SAAS,EACT,UAAU,EACV,KAAK,KAAK,EACV,YAAY,EACZ,aAAa,EACb,KAAK,WAAW,EAChB,UAAU,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,IAAI,EACJ,KAAK,EACL,OAAO,EACP,OAAO,EACP,SAAS,EACT,wBAAwB,GACxB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAErF,YAAY,EACX,eAAe,EACf,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,WAAW,EACX,OAAO,EACP,mBAAmB,EACnB,YAAY,EACZ,QAAQ,GACR,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,EACN,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,sBAAsB,EACtB,WAAW,GACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,yBAAyB,EACzB,eAAe,EACf,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACrB,aAAa,EACb,kBAAkB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACN,KAAK,WAAW,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACN,SAAS,EACT,KAAK,aAAa,EAClB,cAAc,EACd,aAAa,EACb,aAAa,GACb,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,EACL,KAAK,KAAK,EACV,WAAW,EACX,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACrB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EACN,WAAW,EACX,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,MAAM,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAClB,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,mBAAmB,EACnB,qBAAqB,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,KAAK,SAAS,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EAAE,KAAK,UAAU,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACrE,YAAY,EACX,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,EACnB,WAAW,GACX,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EACN,SAAS,EACT,KAAK,EACL,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,eAAe,EACf,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,4BAA4B,EACjC,4BAA4B,EAC5B,SAAS,EACT,WAAW,EACX,cAAc,EACd,KAAK,OAAO,EACZ,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,gBAAgB,EAChB,gBAAgB,EAChB,4BAA4B,EAC5B,WAAW,EACX,SAAS,EACT,UAAU,EACV,KAAK,KAAK,EACV,YAAY,EACZ,aAAa,EACb,KAAK,WAAW,EAChB,UAAU,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,IAAI,EACJ,KAAK,EACL,OAAO,EACP,OAAO,EACP,SAAS,EACT,wBAAwB,EACxB,qBAAqB,IAAI,YAAY,GACrC,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAErF,YAAY,EACX,eAAe,EACf,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,WAAW,EACX,OAAO,EACP,mBAAmB,EACnB,YAAY,EACZ,QAAQ,GACR,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,EACN,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,sBAAsB,EACtB,WAAW,GACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,QAAQ,EACR,KAAK,gBAAgB,EACrB,kBAAkB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACN,KAAK,WAAW,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACN,SAAS,EACT,KAAK,aAAa,EAClB,cAAc,EACd,aAAa,EACb,aAAa,GACb,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,KAAK,UAAU,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC"}

package/lib/util/index.js

@@ -9,11 +9,12 @@ export { deleteFromNestedMap, getOrAddInMap, getOrAddInMapLazy, getOrAddInNested
 export { addToNestedSet, nestedSetContains } from "./nestedSet.js";
 export { OffsetListFactory } from "./offsetList.js";
 export { StackyIterator } from "./stackyIterator.js";
-export { asMutable, clone, compareSets, fail, getOrAddEmptyToMap, getOrCreate, isJsonObject, isReadonlyArray, JsonCompatibleReadOnlySchema, makeArray, mapIterable, filterIterable, assertValidIndex, assertValidRange, assertNonNegativeSafeInteger, objectToMap, invertMap, oneFromSet, compareNamed, disposeSymbol, capitalize, assertValidRangeIndices, transformObjectMap, compareStrings, find, count, getLast, hasSome, hasSingle, defineLazyCachedProperty, } from "./utils.js";
+export { asMutable, clone, compareSets, fail, getOrAddEmptyToMap, getOrCreate, isJsonObject, isReadonlyArray, JsonCompatibleReadOnlySchema, makeArray, mapIterable, filterIterable, assertValidIndex, assertValidRange, assertNonNegativeSafeInteger, objectToMap, invertMap, oneFromSet, compareNamed, disposeSymbol, capitalize, assertValidRangeIndices, transformObjectMap, compareStrings, find, count, getLast, hasSome, hasSingle, defineLazyCachedProperty, copyPropertyIfDefined as copyProperty, } from "./utils.js";
 export { ReferenceCountedBase } from "./referenceCounting.js";
 export { unsafeArrayToTuple } from "./typeUtils.js";
 export { getOrCreateSlotContent, brandedSlot, } from "./brandedMap.js";
-export { getFirstEntryFromRangeMap, getFromRangeMap, setInRangeMap, deleteFromRangeMap, } from "./rangeMap.js";
+export { RangeMap, newIntegerRangeMap, } from "./rangeMap.js";
 export { idAllocatorFromMaxId, idAllocatorFromState, fakeIdAllocator, } from "./idAllocator.js";
 export { Breakable, breakingMethod, throwIfBroken, breakingClass, } from "./breakable.js";
+export { newTupleBTree, mergeTupleBTrees } from "./bTreeUtils.js";
 //# sourceMappingURL=index.js.map

package/lib/util/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,EAEL,WAAW,GAGX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EACN,WAAW,EACX,iBAAiB,GAGjB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAGlB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,mBAAmB,EACnB,qBAAqB,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAkB,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EAAmB,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAiBrE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EACN,SAAS,EACT,KAAK,EACL,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,eAAe,EAKf,4BAA4B,EAC5B,SAAS,EACT,WAAW,EACX,cAAc,EAId,gBAAgB,EAChB,gBAAgB,EAChB,4BAA4B,EAC5B,WAAW,EACX,SAAS,EACT,UAAU,EAEV,YAAY,EACZ,aAAa,EAEb,UAAU,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,IAAI,EACJ,KAAK,EACL,OAAO,EACP,OAAO,EACP,SAAS,EACT,wBAAwB,GACxB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAcrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,EAIN,sBAAsB,EACtB,WAAW,GACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,yBAAyB,EACzB,eAAe,EAIf,aAAa,EACb,kBAAkB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAEN,oBAAoB,EACpB,oBAAoB,EAEpB,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACN,SAAS,EAET,cAAc,EACd,aAAa,EACb,aAAa,GACb,MAAM,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tbrand,\n\ttype Brand,\n\tBrandedType,\n\ttype NameFromBranded,\n\ttype ValueFromBranded,\n} from \"./brand.js\";\nexport { brandedNumberType, brandedStringType } from \"./typeboxBrand.js\";\nexport {\n\tbrandOpaque,\n\textractFromOpaque,\n\ttype ExtractFromOpaque,\n\ttype Opaque,\n} from \"./opaque.js\";\nexport {\n\tdeleteFromNestedMap,\n\tgetOrAddInMap,\n\tgetOrAddInMapLazy,\n\tgetOrAddInNestedMap,\n\tgetOrDefaultInNestedMap,\n\tforEachInNestedMap,\n\ttype NestedMap,\n\ttype ReadonlyNestedMap,\n\tSizedNestedMap,\n\tpopulateNestedMap,\n\tsetInNestedMap,\n\ttryAddToNestedMap,\n\ttryGetFromNestedMap,\n\tmapNestedMap,\n\tnestedMapToFlatList,\n\tnestedMapFromFlatList,\n} from \"./nestedMap.js\";\nexport { addToNestedSet, type NestedSet, nestedSetContains } from \"./nestedSet.js\";\nexport { type OffsetList, OffsetListFactory } from \"./offsetList.js\";\nexport type {\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\tareOnlyKeys,\n} from \"./typeCheck.js\";\nexport { StackyIterator } from \"./stackyIterator.js\";\nexport {\n\tasMutable,\n\tclone,\n\tcompareSets,\n\tfail,\n\tgetOrAddEmptyToMap,\n\tgetOrCreate,\n\tisJsonObject,\n\tisReadonlyArray,\n\ttype JsonCompatible,\n\ttype JsonCompatibleObject,\n\ttype JsonCompatibleReadOnly,\n\ttype JsonCompatibleReadOnlyObject,\n\tJsonCompatibleReadOnlySchema,\n\tmakeArray,\n\tmapIterable,\n\tfilterIterable,\n\ttype Mutable,\n\ttype Populated,\n\ttype RecursiveReadonly,\n\tassertValidIndex,\n\tassertValidRange,\n\tassertNonNegativeSafeInteger,\n\tobjectToMap,\n\tinvertMap,\n\toneFromSet,\n\ttype Named,\n\tcompareNamed,\n\tdisposeSymbol,\n\ttype IDisposable,\n\tcapitalize,\n\tassertValidRangeIndices,\n\ttransformObjectMap,\n\tcompareStrings,\n\tfind,\n\tcount,\n\tgetLast,\n\thasSome,\n\thasSingle,\n\tdefineLazyCachedProperty,\n} from \"./utils.js\";\nexport { ReferenceCountedBase, type ReferenceCounted } from \"./referenceCounting.js\";\n\nexport type {\n\t_RecursiveTrick,\n\tRestrictiveReadonlyRecord,\n\tRestrictiveStringRecord,\n\t_InlineTrick,\n\tFlattenKeys,\n\tIsUnion,\n\tUnionToIntersection,\n\tUnionToTuple,\n\tPopUnion,\n} from \"./typeUtils.js\";\n\nexport { unsafeArrayToTuple } from \"./typeUtils.js\";\n\nexport {\n\ttype BrandedKey,\n\ttype BrandedKeyContent,\n\ttype BrandedMapSubset,\n\tgetOrCreateSlotContent,\n\tbrandedSlot,\n} from \"./brandedMap.js\";\n\nexport {\n\tgetFirstEntryFromRangeMap,\n\tgetFromRangeMap,\n\ttype RangeEntry,\n\ttype RangeMap,\n\ttype RangeQueryResult,\n\tsetInRangeMap,\n\tdeleteFromRangeMap,\n} from \"./rangeMap.js\";\n\nexport {\n\ttype IdAllocator,\n\tidAllocatorFromMaxId,\n\tidAllocatorFromState,\n\ttype IdAllocationState,\n\tfakeIdAllocator,\n} from \"./idAllocator.js\";\n\nexport {\n\tBreakable,\n\ttype WithBreakable,\n\tbreakingMethod,\n\tthrowIfBroken,\n\tbreakingClass,\n} from \"./breakable.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,EAEL,WAAW,GAGX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EACN,WAAW,EACX,iBAAiB,GAGjB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAGlB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,mBAAmB,EACnB,qBAAqB,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAkB,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EAAmB,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAiBrE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EACN,SAAS,EACT,KAAK,EACL,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,eAAe,EAKf,4BAA4B,EAC5B,SAAS,EACT,WAAW,EACX,cAAc,EAId,gBAAgB,EAChB,gBAAgB,EAChB,4BAA4B,EAC5B,WAAW,EACX,SAAS,EACT,UAAU,EAEV,YAAY,EACZ,aAAa,EAEb,UAAU,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,EACd,IAAI,EACJ,KAAK,EACL,OAAO,EACP,OAAO,EACP,SAAS,EACT,wBAAwB,EACxB,qBAAqB,IAAI,YAAY,GACrC,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAcrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,EAIN,sBAAsB,EACtB,WAAW,GACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,QAAQ,EAER,kBAAkB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAEN,oBAAoB,EACpB,oBAAoB,EAEpB,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACN,SAAS,EAET,cAAc,EACd,aAAa,EACb,aAAa,GACb,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAmB,aAAa,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tbrand,\n\ttype Brand,\n\tBrandedType,\n\ttype NameFromBranded,\n\ttype ValueFromBranded,\n} from \"./brand.js\";\nexport { brandedNumberType, brandedStringType } from \"./typeboxBrand.js\";\nexport {\n\tbrandOpaque,\n\textractFromOpaque,\n\ttype ExtractFromOpaque,\n\ttype Opaque,\n} from \"./opaque.js\";\nexport {\n\tdeleteFromNestedMap,\n\tgetOrAddInMap,\n\tgetOrAddInMapLazy,\n\tgetOrAddInNestedMap,\n\tgetOrDefaultInNestedMap,\n\tforEachInNestedMap,\n\ttype NestedMap,\n\ttype ReadonlyNestedMap,\n\tSizedNestedMap,\n\tpopulateNestedMap,\n\tsetInNestedMap,\n\ttryAddToNestedMap,\n\ttryGetFromNestedMap,\n\tmapNestedMap,\n\tnestedMapToFlatList,\n\tnestedMapFromFlatList,\n} from \"./nestedMap.js\";\nexport { addToNestedSet, type NestedSet, nestedSetContains } from \"./nestedSet.js\";\nexport { type OffsetList, OffsetListFactory } from \"./offsetList.js\";\nexport type {\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\tareOnlyKeys,\n} from \"./typeCheck.js\";\nexport { StackyIterator } from \"./stackyIterator.js\";\nexport {\n\tasMutable,\n\tclone,\n\tcompareSets,\n\tfail,\n\tgetOrAddEmptyToMap,\n\tgetOrCreate,\n\tisJsonObject,\n\tisReadonlyArray,\n\ttype JsonCompatible,\n\ttype JsonCompatibleObject,\n\ttype JsonCompatibleReadOnly,\n\ttype JsonCompatibleReadOnlyObject,\n\tJsonCompatibleReadOnlySchema,\n\tmakeArray,\n\tmapIterable,\n\tfilterIterable,\n\ttype Mutable,\n\ttype Populated,\n\ttype RecursiveReadonly,\n\tassertValidIndex,\n\tassertValidRange,\n\tassertNonNegativeSafeInteger,\n\tobjectToMap,\n\tinvertMap,\n\toneFromSet,\n\ttype Named,\n\tcompareNamed,\n\tdisposeSymbol,\n\ttype IDisposable,\n\tcapitalize,\n\tassertValidRangeIndices,\n\ttransformObjectMap,\n\tcompareStrings,\n\tfind,\n\tcount,\n\tgetLast,\n\thasSome,\n\thasSingle,\n\tdefineLazyCachedProperty,\n\tcopyPropertyIfDefined as copyProperty,\n} from \"./utils.js\";\nexport { ReferenceCountedBase, type ReferenceCounted } from \"./referenceCounting.js\";\n\nexport type {\n\t_RecursiveTrick,\n\tRestrictiveReadonlyRecord,\n\tRestrictiveStringRecord,\n\t_InlineTrick,\n\tFlattenKeys,\n\tIsUnion,\n\tUnionToIntersection,\n\tUnionToTuple,\n\tPopUnion,\n} from \"./typeUtils.js\";\n\nexport { unsafeArrayToTuple } from \"./typeUtils.js\";\n\nexport {\n\ttype BrandedKey,\n\ttype BrandedKeyContent,\n\ttype BrandedMapSubset,\n\tgetOrCreateSlotContent,\n\tbrandedSlot,\n} from \"./brandedMap.js\";\n\nexport {\n\tRangeMap,\n\ttype RangeQueryResult,\n\tnewIntegerRangeMap,\n} from \"./rangeMap.js\";\n\nexport {\n\ttype IdAllocator,\n\tidAllocatorFromMaxId,\n\tidAllocatorFromState,\n\ttype IdAllocationState,\n\tfakeIdAllocator,\n} from \"./idAllocator.js\";\n\nexport {\n\tBreakable,\n\ttype WithBreakable,\n\tbreakingMethod,\n\tthrowIfBroken,\n\tbreakingClass,\n} from \"./breakable.js\";\n\nexport { type TupleBTree, newTupleBTree, mergeTupleBTrees } from \"./bTreeUtils.js\";\n"]}

package/lib/util/rangeMap.d.ts

@@ -3,59 +3,111 @@
  * Licensed under the MIT License.
  */
 /**
- * A map keyed on integers allowing reading and writing contiguous ranges of integer keys.
- *
- * TODO: We should avoid the direct exposure of RangeEntry. AB#7414
+ * RangeMap represents a mapping from keys of type K to values of type V or undefined.
+ * The set of all possible keys is assumed to be fully ordered,
+ * and for each key there should be a single next higher key.
+ * The values for a range of consecutive keys can be changed or queried in a single operation.
+ * The structure of the keys is described by the `offsetKey` and `subtractKeys` functions provided in the constructor.
  */
-export type RangeMap<T> = RangeEntry<T>[];
-export interface RangeEntry<T> {
-    start: number;
-    length: number;
-    value: T;
+export declare class RangeMap<K, V> {
+    private readonly offsetKey;
+    private readonly subtractKeys;
+    private tree;
+    /**
+     * @param offsetKey - Function which returns a new key which is `offset` keys after `key`.
+     * When `offset` is negative, the returned key should come before `key`.
+     *
+     * @param subtractKeys - Function which returns the difference between `b` and `a`.
+     * Offsetting `b` by this difference should return `a`.
+     * The difference can be infinite if `a` cannot be reached from `b` by offsetting,
+     * but the difference should still be positive if `a` is larger than `b` and negative if smaller.
+     */
+    constructor(offsetKey: (key: K, offset: number) => K, subtractKeys: (a: K, b: K) => number);
+    /**
+     * Retrieves all entries from the RangeMap.
+     */
+    entries(): RangeQueryEntry<K, V>[];
+    clear(): void;
+    /**
+     * Retrieves the values for all keys in the query range.
+     *
+     * @param start - The first key in the range being queried
+     * @param length  - The length of the query range
+     * @returns A list of entries, each describing the value for some subrange of the query.
+     * The entries are in the same order as the keys, and there is an entry for every key with a non `undefined` value.
+     */
+    getAll(start: K, length: number): RangeQueryEntry<K, V>[];
+    /**
+     * Retrieves the value for some prefix of the query range.
+     *
+     * @param start - The first key in the query range.
+     * @param length - The length of the query range.
+     * @returns A RangeQueryResult containing the value associated with `start`,
+     * and the number of consecutive keys with that same value (at least 1, at most `length`).
+     */
+    getFirst(start: K, length: number): RangeQueryResult<K, V>;
+    /**
+     * Sets the value for a specified range.
+     *
+     * @param start - The first key in the range being set.
+     * @param length - The length of the range.
+     * @param value - The value to associate with the range.
+     */
+    set(start: K, length: number, value: V | undefined): void;
+    /**
+     * Deletes values within a specified range, updating or removing existing entries.
+     *
+     * 1. If an entry is completely included in the deletion range, the whole entry will be deleted
+     * e.g.: map = [[1, 2], [4, 6]], delete range: [3, 6]
+     * map becomes [[1, 2]] after deletion
+     * (Note: the notation [a, b] represents start = a, end = b for simpler visualization, instead of `b`
+     * representing the length)
+     *
+     * 2. If an entry is partially overlapped with the deletion range, the start or end point will be shifted
+     * e.g.: map = [[1, 2], [4, 6]], delete range: [2, 4]
+     * map becomes [[1, 1], [5, 6]] after deletion
+     *
+     * 3. If an entry completely includes the deletion range, the original entry may be split into two.
+     * e.g.: map = [[1, 6]], delete range: [2, 4]
+     * map becomes [[1, 1], [5, 6]]
+     *
+     * @param start - The start of the range to delete (inclusive).
+     * @param length - The length of the range to delete.
+     */
+    delete(start: K, length: number): void;
+    clone(): RangeMap<K, V>;
+    /**
+     * Returns a new map which contains the entries from both input maps.
+     */
+    static union<K, V>(a: RangeMap<K, V>, b: RangeMap<K, V>): RangeMap<K, V>;
+    private getIntersectingEntries;
+    private gt;
+    private ge;
+    private lt;
+    private le;
 }
 /**
- * The result of a query about a range of keys.
+ * Describes the result of a range query, including the value and length of the matching prefix.
  */
-export interface RangeQueryResult<T> {
+export interface RangeQueryResult<K, V> {
+    /**
+     * The key for the first element in the range.
+     */
+    readonly start: K;
     /**
      * The value of the first key in the query range.
+     * If no matching range is found, this will be undefined.
      */
-    value: T | undefined;
+    readonly value: V | undefined;
     /**
-     * The length of the prefix of the query range which have the same value.
+     * The length of the prefix of the query range which has 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;
+    readonly 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;
-/**
- * Delete the keys from `start` to `start + length - 1`
- *
- * 1. If an entry is completely included in the deletion range, the whole entry will be deleted
- * e.g.: map = [[1, 2], [4, 6]], delete range: [3, 6]
- * map becomes [[1, 2]] after deletion
- * (Note: the notation [a, b] represents start = a, end = b for simpler visiualization, instead of `b`
- * representing the length)
- *
- * 2. If an entry is partially overlapped with the deletion range, the start or end point will be shifted
- * e.g.: map = [[1, 2], [4, 6]], delete range: [2, 4]
- * map becomes [[1, 1], [5, 6]] after deletion
- *
- * 3. If an entry completely includes the deletion range, the original entry may be split into two.
- * e.g.: map = [[1, 6]], delete range: [2, 4]
- * map becomes [[1, 1], [5, 6]]
- *
- * TODO: We may find ways to mitigate the code duplication between set and delete, and we need to better
- * document the API.  AB#7413
- */
-export declare function deleteFromRangeMap<T>(map: RangeMap<T>, start: number, length: number): void;
+export interface RangeQueryEntry<K, V> extends RangeQueryResult<K, V> {
+    readonly value: V;
+}
+export declare function newIntegerRangeMap<V>(): RangeMap<number, V>;
 //# sourceMappingURL=rangeMap.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rangeMap.d.ts","sourceRoot":"","sources":["../../src/util/rangeMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;;GAIG;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;;GAEG;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,EAC9B,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,GACN,IAAI,CAgEN;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAwD3F"}
+{"version":3,"file":"rangeMap.d.ts","sourceRoot":"","sources":["../../src/util/rangeMap.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;;;;;GAMG;AACH,qBAAa,QAAQ,CAAC,CAAC,EAAE,CAAC;IAaxB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAb9B,OAAO,CAAC,IAAI,CAA0B;IAEtC;;;;;;;;OAQG;gBAEe,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC,EACxC,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM;IAKtD;;OAEG;IACI,OAAO,IAAI,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;IASlC,KAAK,IAAI,IAAI;IAIpB;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;IAuBhE;;;;;;;OAOG;IACI,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IAiCjE;;;;;;OAMG;IACI,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,GAAG,IAAI;IAOhE;;;;;;;;;;;;;;;;;;;OAmBG;IACI,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAsBtC,KAAK,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAM9B;;OAEG;WACW,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAkB/E,OAAO,CAAC,sBAAsB;IAkC9B,OAAO,CAAC,EAAE;IAIV,OAAO,CAAC,EAAE;IAIV,OAAO,CAAC,EAAE;IAIV,OAAO,CAAC,EAAE;CAGV;AAiBD;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,EAAE,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IACpE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;CAClB;AAED,wBAAgB,kBAAkB,CAAC,CAAC,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAE3D"}

package/lib/util/rangeMap.js

@@ -2,168 +2,224 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { oob } from "@fluidframework/core-utils/internal";
+import { assert, oob } from "@fluidframework/core-utils/internal";
+import { BTree } from "@tylerbu/sorted-btree-es6";
 /**
- * See comments on `RangeQueryResult`.
+ * RangeMap represents a mapping from keys of type K to values of type V or undefined.
+ * The set of all possible keys is assumed to be fully ordered,
+ * and for each key there should be a single next higher key.
+ * The values for a range of consecutive keys can be changed or queried in a single operation.
+ * The structure of the keys is described by the `offsetKey` and `subtractKeys` functions provided in the constructor.
  */
-export 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) };
+export class RangeMap {
+    /**
+     * @param offsetKey - Function which returns a new key which is `offset` keys after `key`.
+     * When `offset` is negative, the returned key should come before `key`.
+     *
+     * @param subtractKeys - Function which returns the difference between `b` and `a`.
+     * Offsetting `b` by this difference should return `a`.
+     * The difference can be infinite if `a` cannot be reached from `b` by offsetting,
+     * but the difference should still be positive if `a` is larger than `b` and negative if smaller.
+     */
+    constructor(offsetKey, subtractKeys) {
+        this.offsetKey = offsetKey;
+        this.subtractKeys = subtractKeys;
+        this.tree = new BTree(undefined, subtractKeys);
+    }
+    /**
+     * Retrieves all entries from the RangeMap.
+     */
+    entries() {
+        const entries = [];
+        for (const [start, entry] of this.tree.entries()) {
+            entries.push({ start, length: entry.length, value: entry.value });
         }
+        return entries;
     }
-    // There were no entries intersecting the query range, so the entire query range has undefined value.
-    return { value: undefined, length };
-}
-export 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;
+    clear() {
+        this.tree.clear();
+    }
+    /**
+     * Retrieves the values for all keys in the query range.
+     *
+     * @param start - The first key in the range being queried
+     * @param length  - The length of the query range
+     * @returns A list of entries, each describing the value for some subrange of the query.
+     * The entries are in the same order as the keys, and there is an entry for every key with a non `undefined` value.
+     */
+    getAll(start, length) {
+        const entries = this.getIntersectingEntries(start, length);
+        if (entries.length === 0) {
+            return entries;
         }
-        const lastRangeKey = range.start + range.length - 1;
-        if (lastRangeKey >= start) {
-            return range;
+        const firstEntry = entries[0] ?? oob();
+        const lengthBefore = this.subtractKeys(start, firstEntry.start);
+        if (lengthBefore > 0) {
+            entries[0] = { ...firstEntry, start, length: firstEntry.length - lengthBefore };
         }
+        const lastEntry = entries[entries.length - 1] ?? oob();
+        const lastEntryKey = this.offsetKey(lastEntry.start, lastEntry.length - 1);
+        const lastQueryKey = this.offsetKey(start, length - 1);
+        const lengthAfter = this.subtractKeys(lastEntryKey, lastQueryKey);
+        if (lengthAfter > 0) {
+            entries[entries.length - 1] = { ...lastEntry, length: lastEntry.length - lengthAfter };
+        }
+        return entries;
     }
-    return undefined;
-}
-/**
- * Sets the keys from `start` to `start + length - 1` to `value`.
- */
-export 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;
+    /**
+     * Retrieves the value for some prefix of the query range.
+     *
+     * @param start - The first key in the query range.
+     * @param length - The length of the query range.
+     * @returns A RangeQueryResult containing the value associated with `start`,
+     * and the number of consecutive keys with that same value (at least 1, at most `length`).
+     */
+    getFirst(start, length) {
+        {
+            // We first check for an entry with a key less than or equal to `start`.
+            const entry = this.tree.getPairOrNextLower(start);
+            if (entry !== undefined) {
+                const entryKey = entry[0];
+                const { value, length: entryLength } = entry[1];
+                const entryLastKey = this.offsetKey(entryKey, entryLength - 1);
+                const overlappingLength = Math.min(this.subtractKeys(entryLastKey, start) + 1, length);
+                if (overlappingLength > 0) {
+                    return { value, start, length: overlappingLength };
+                }
+            }
         }
-        else if (entry.start > end) {
-            iAfter = i;
-            break;
+        {
+            // There is no value associated with `start`.
+            // Now we need to determine how many of the following keys are also undefined.
+            const key = this.tree.nextHigherKey(start);
+            if (key !== undefined) {
+                const entryKey = key;
+                const lastQueryKey = this.offsetKey(start, length - 1);
+                if (this.le(entryKey, lastQueryKey)) {
+                    return { value: undefined, start, length: this.subtractKeys(entryKey, start) };
+                }
+            }
+            return { value: undefined, start, length };
         }
     }
-    const numOverlappingEntries = iAfter - iBefore - 1;
-    if (numOverlappingEntries === 0) {
-        map.splice(iAfter, 0, newEntry);
-        return;
-    }
-    const iFirst = iBefore + 1;
-    const firstEntry = map[iFirst] ?? oob();
-    const iLast = iAfter - 1;
-    const lastEntry = map[iLast] ?? oob();
-    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);
-}
-/**
- * Delete the keys from `start` to `start + length - 1`
- *
- * 1. If an entry is completely included in the deletion range, the whole entry will be deleted
- * e.g.: map = [[1, 2], [4, 6]], delete range: [3, 6]
- * map becomes [[1, 2]] after deletion
- * (Note: the notation [a, b] represents start = a, end = b for simpler visiualization, instead of `b`
- * representing the length)
- *
- * 2. If an entry is partially overlapped with the deletion range, the start or end point will be shifted
- * e.g.: map = [[1, 2], [4, 6]], delete range: [2, 4]
- * map becomes [[1, 1], [5, 6]] after deletion
- *
- * 3. If an entry completely includes the deletion range, the original entry may be split into two.
- * e.g.: map = [[1, 6]], delete range: [2, 4]
- * map becomes [[1, 1], [5, 6]]
- *
- * TODO: We may find ways to mitigate the code duplication between set and delete, and we need to better
- * document the API.  AB#7413
- */
-export function deleteFromRangeMap(map, start, length) {
-    const end = start + length - 1;
-    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;
+    /**
+     * Sets the value for a specified range.
+     *
+     * @param start - The first key in the range being set.
+     * @param length - The length of the range.
+     * @param value - The value to associate with the range.
+     */
+    set(start, length, value) {
+        this.delete(start, length);
+        if (value !== undefined) {
+            this.tree.set(start, { value, length });
         }
-        else if (entry.start > end) {
-            iAfter = i;
-            break;
+    }
+    /**
+     * Deletes values within a specified range, updating or removing existing entries.
+     *
+     * 1. If an entry is completely included in the deletion range, the whole entry will be deleted
+     * e.g.: map = [[1, 2], [4, 6]], delete range: [3, 6]
+     * map becomes [[1, 2]] after deletion
+     * (Note: the notation [a, b] represents start = a, end = b for simpler visualization, instead of `b`
+     * representing the length)
+     *
+     * 2. If an entry is partially overlapped with the deletion range, the start or end point will be shifted
+     * e.g.: map = [[1, 2], [4, 6]], delete range: [2, 4]
+     * map becomes [[1, 1], [5, 6]] after deletion
+     *
+     * 3. If an entry completely includes the deletion range, the original entry may be split into two.
+     * e.g.: map = [[1, 6]], delete range: [2, 4]
+     * map becomes [[1, 1], [5, 6]]
+     *
+     * @param start - The start of the range to delete (inclusive).
+     * @param length - The length of the range to delete.
+     */
+    delete(start, length) {
+        const lastDeleteKey = this.offsetKey(start, length - 1);
+        for (const { start: key, length: entryLength, value } of this.getIntersectingEntries(start, length)) {
+            this.tree.delete(key);
+            const lengthBefore = this.subtractKeys(start, key);
+            if (lengthBefore > 0) {
+                // A portion of this entry comes before the deletion range, so we reinsert that portion.
+                this.tree.set(key, { length: lengthBefore, value });
+            }
+            const lastEntryKey = this.offsetKey(key, entryLength - 1);
+            const lengthAfter = this.subtractKeys(lastEntryKey, lastDeleteKey);
+            if (lengthAfter > 0) {
+                // A portion of this entry comes after the deletion range, so we reinsert that portion.
+                this.tree.set(this.offsetKey(lastDeleteKey, 1), { length: lengthAfter, value });
+            }
         }
     }
-    const numOverlappingEntries = iAfter - iBefore - 1;
-    if (numOverlappingEntries === 0) {
-        // No entry will be removed
-        return;
+    clone() {
+        const cloned = new RangeMap(this.offsetKey, this.subtractKeys);
+        cloned.tree = this.tree.clone();
+        return cloned;
     }
-    const iFirst = iBefore + 1;
-    const iLast = iAfter - 1;
-    // Update or remove the overlapping entries
-    for (let i = iFirst; i <= iLast; ++i) {
-        const entry = map[i] ?? oob();
-        const entryLastKey = entry.start + entry.length - 1;
-        let isDirty = false;
-        // If the entry lies within the range to be deleted, remove it
-        if (entry.start >= start && entryLastKey <= end) {
-            map.splice(i, 1);
+    /**
+     * Returns a new map which contains the entries from both input maps.
+     */
+    static union(a, b) {
+        assert(a.offsetKey === b.offsetKey && a.subtractKeys === b.subtractKeys, 0xaae /* Maps should have the same behavior */);
+        const merged = new RangeMap(a.offsetKey, a.subtractKeys);
+        // TODO: Is there a good pattern that lets us make `tree` readonly?
+        merged.tree = a.tree.clone();
+        for (const [key, value] of b.tree.entries()) {
+            // TODO: Handle key collisions
+            merged.tree.set(key, value);
         }
-        else {
-            // If the entry partially or completely overlaps with the range to be deleted
-            if (entry.start < start) {
-                // Update the endpoint and length of the portion before the range to be deleted
-                const lengthBefore = start - entry.start;
-                map[i] = { ...entry, length: lengthBefore };
-                isDirty = true;
+        return merged;
+    }
+    getIntersectingEntries(start, length) {
+        const entries = [];
+        const lastQueryKey = this.offsetKey(start, length - 1);
+        {
+            const entry = this.tree.getPairOrNextLower(start);
+            if (entry !== undefined) {
+                const key = entry[0];
+                const { length: entryLength, value } = entry[1];
+                const lastEntryKey = this.offsetKey(key, entryLength - 1);
+                if (this.ge(lastEntryKey, start)) {
+                    entries.push({ start: key, length: entryLength, value });
+                }
             }
-            if (entryLastKey > end) {
-                // Update the startpoint and length of the portion after the range to be deleted
-                const newStart = end + 1;
-                const newLength = entryLastKey - end;
-                map.splice(isDirty ? i + 1 : i, isDirty ? 0 : 1, {
-                    start: newStart,
-                    length: newLength,
-                    value: entry.value,
-                });
+        }
+        {
+            let entry = this.tree.nextHigherPair(start);
+            while (entry !== undefined) {
+                const key = entry[0];
+                if (this.gt(key, lastQueryKey)) {
+                    break;
+                }
+                const { length: entryLength, value } = entry[1];
+                const lastEntryKey = this.offsetKey(key, entryLength - 1);
+                entries.push({ start: key, length: entryLength, value });
+                entry = this.tree.nextHigherPair(lastEntryKey);
             }
         }
+        return entries;
     }
+    gt(a, b) {
+        return this.subtractKeys(a, b) > 0;
+    }
+    ge(a, b) {
+        return this.subtractKeys(a, b) >= 0;
+    }
+    lt(a, b) {
+        return this.subtractKeys(a, b) < 0;
+    }
+    le(a, b) {
+        return this.subtractKeys(a, b) <= 0;
+    }
+}
+export function newIntegerRangeMap() {
+    return new RangeMap(offsetInteger, subtractIntegers);
+}
+function offsetInteger(key, offset) {
+    return key + offset;
+}
+function subtractIntegers(a, b) {
+    return a - b;
 }
 //# sourceMappingURL=rangeMap.js.map