@fluidframework/tree 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

package/dist/util/brand.d.ts

@@ -2,9 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { NumericOptions, TUnsafe } from "@sinclair/typebox";
-import { Covariant, isAny } from "./typeCheck.js";
-import { Assume } from "./utils.js";
+import type { Covariant } from "./typeCheck.js";
 /**
  * Constructs a "Branded" type, adding a type-checking only field to `ValueType`.
  *
@@ -18,58 +16,11 @@ import { Assume } from "./utils.js";
  * These branded types are not opaque: A `Brand<A, B>` can still be used as a `B`.
  * @internal
  */
-export type Brand<ValueType, Name extends string | ErasedType<string>> = ValueType & BrandedType<ValueType, Name extends Erased<infer TName> ? TName : Assume<Name, string>>;
-/**
- * "opaque" handle which can be used to expose a branded type without referencing its value type.
- *
- * Recommended usage is to use `interface` instead of `type` so tooling (such as tsc and refactoring tools)
- * uses the type name instead of expanding it:
- * ```typescript
- * export interface MyType extends Erased<"myPackage.MyType">{}
- * ```
- * @internal
- */
-export type Erased<Name extends string> = ErasedType<Name>;
-/**
- * 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 declare abstract class ErasedType<out Name extends string> {
-    /**
-     * Compile time only marker to make type checking more strict.
-     * This method will not exist at runtime and accessing it is invalid.
-     * See {@link Brand} for details.
-     *
-     * @privateRemarks
-     * `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`.
-     * The method takes in never to help emphasize that its not callable.
-     */
-    protected abstract brand(dummy: never): Name;
-    /**
-     * This class should never exist at runtime, so make it un-constructable.
-     */
-    private constructor();
-}
+export type Brand<ValueType, Name> = ValueType & BrandedType<ValueType, Name>;
 /**
  * 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.
+ * See `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.
@@ -79,10 +30,16 @@ export declare abstract class ErasedType<out Name extends string> {
  * This is suitable for when ValueType is immutable (like string or number),
  * which is the common use-case for branding.
  *
+ * @privateRemarks
+ * This is split out into its own type as that's the only way to:
+ *
+ * - make the member protected (so you can't accidentally try and access it).
+ * - get nominal typing (so types produced without using this class can never be assignable to it).
+ *
  * @sealed
  * @internal
  */
-export declare abstract class BrandedType<out ValueType, Name extends string> {
+export declare abstract class BrandedType<out ValueType, Name> {
     protected _typeCheck?: Covariant<ValueType>;
     /**
      * Compile time only marker to make type checking more strict.
@@ -98,82 +55,37 @@ export declare abstract class BrandedType<out ValueType, Name extends string> {
      * This class should never exist at runtime, so make it un-constructable.
      */
     private constructor();
+    /**
+     * Since this class is a compile time only type brand, `instanceof` will never work with it.
+     * This `Symbol.hasInstance` implementation ensures that `instanceof` will error if used,
+     * and in TypeScript 5.3 and newer will produce a compile time error if used.
+     */
+    static [Symbol.hasInstance](value: never): value is never;
 }
-/**
- * Converts a Branded type into an "opaque" handle.
- * This prevents the value from being used directly, but does not fully type erase it
- * (and this its not really fully opaque):
- * The type can be recovered using {@link extractFromOpaque},
- * however if we assume only code that produces these "opaque" handles does that conversion,
- * they can function like opaque handles.
- *
- * Recommended usage is to use `interface` instead of `type` so tooling (such as tsc and refactoring tools)
- * uses the type name instead of expanding it:
- * ```typescript
- * export interface MyType extends Opaque<Brand<string, "myPackage.MyType">>{}
- * ```
- * @internal
- */
-export type Opaque<T extends Brand<any, string>> = T extends BrandedType<infer ValueType, infer Name> ? BrandedType<ValueType, Name> : never;
-/**
- * See {@link extractFromOpaque}.
- * @internal
- */
-export type ExtractFromOpaque<TOpaque extends BrandedType<any, string>> = TOpaque extends BrandedType<infer ValueType, infer Name> ? isAny<ValueType> extends true ? unknown : Brand<ValueType, Name> : never;
 /**
  * Implementation detail of type branding. Should not be used directly outside this file,
  * but shows up as part of branded types so API-Extractor requires it to be exported.
  * @internal
  */
-export type ValueFromBranded<T extends BrandedType<any, string>> = T extends BrandedType<infer ValueType, string> ? ValueType : never;
+export type ValueFromBranded<T extends BrandedType<unknown, unknown>> = T extends BrandedType<infer ValueType, unknown> ? ValueType : never;
 /**
  * Implementation detail of type branding. Should not be used directly outside this file,
  * but shows up as part of branded types so API-Extractor requires it to be exported.
  * @internal
  */
-export type NameFromBranded<T extends BrandedType<any, string>> = T extends BrandedType<any, infer Name> ? Name : never;
-/**
- * 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 declare function extractFromOpaque<TOpaque extends BrandedType<any, string>>(value: TOpaque): ExtractFromOpaque<TOpaque>;
-/**
- * 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 declare function fromErased<TBranded extends BrandedType<unknown, string>, TName extends string = NameFromBranded<TBranded>>(value: ErasedType<TName>): TBranded;
+export type NameFromBranded<T extends BrandedType<unknown, unknown>> = T extends BrandedType<unknown, infer Name> ? Name : never;
 /**
  * Adds a type {@link Brand} to a value.
  *
  * Only do this when specifically allowed by the requirements of the type being converted to.
+ * @privateRemarks
+ * Leaving `T` unconstrained here allows for better type inference when branding unions.
+ * For example when assigning `brand(number)` a number to an optional branded number field,
+ * constraining T to `BrandedType<unknown, string>` causes the inference to fail and requires explicitly providing the type parameter.
+ * For example leaving T unconstrained instead allows the union of `BrandedType | undefined` to distribute over the conditional allowing the branding only the the union members which should be branded.
+ * This does not permit branding an optional value into an optional field since non branded union members are still excluded from input to this function:
+ * this is an intended restriction as it causes compile errors for misuse of this function (like using brand when the relevant type is not a branded type).
  * @internal
  */
-export declare function brand<T extends Brand<any, string>>(value: T extends BrandedType<infer ValueType, string> ? ValueType : never): T;
-/**
- * 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 declare function brandOpaque<T extends BrandedType<any, string>>(value: isAny<ValueFromBranded<T>> extends true ? never : ValueFromBranded<T>): BrandedType<ValueFromBranded<T>, NameFromBranded<T>>;
-/**
- * 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 declare function brandErased<T extends BrandedType<any, string>>(value: isAny<ValueFromBranded<T>> extends true ? never : ValueFromBranded<T>): ErasedType<NameFromBranded<T>>;
-/**
- * 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 declare function brandedStringType<T extends string>(): TUnsafe<T>;
-export declare function brandedNumberType<T extends number>(options?: NumericOptions<number> | undefined): TUnsafe<T>;
+export declare function brand<T>(value: T extends BrandedType<infer ValueType, unknown> ? ValueType : never): T;
 //# sourceMappingURL=brand.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../../src/util/brand.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,OAAO,EAAQ,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,KAAK,CAAC,SAAS,EAAE,IAAI,SAAS,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,SAAS,GACjF,WAAW,CAAC,SAAS,EAAE,IAAI,SAAS,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAEzF;;;;;;;;;GASG;AACH,MAAM,MAAM,MAAM,CAAC,IAAI,SAAS,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;AAE3D;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,UAAU,CAAC,GAAG,CAAC,IAAI,SAAS,MAAM;IACvD;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAE5C;;OAEG;IACH,OAAO;CACP;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,SAAS,MAAM;IACnE,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAC5C;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAE5C;;OAEG;IACH,OAAO;CACP;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,WAAW,CACvE,MAAM,SAAS,EACf,MAAM,IAAI,CACV,GACE,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC,GAC5B,KAAK,CAAC;AAET;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,IACrE,OAAO,SAAS,WAAW,CAAC,MAAM,SAAS,EAAE,MAAM,IAAI,CAAC,GACrD,KAAK,CAAC,SAAS,CAAC,SAAS,IAAI,GAC5B,OAAO,GACP,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,GACvB,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,WAAW,CACvF,MAAM,SAAS,EACf,MAAM,CACN,GACE,SAAS,GACT,KAAK,CAAC;AAET;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,WAAW,CACtF,GAAG,EACH,MAAM,IAAI,CACV,GACE,IAAI,GACJ,KAAK,CAAC;AAET;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,SAAS,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EACzE,KAAK,EAAE,OAAO,GACZ,iBAAiB,CAAC,OAAO,CAAC,CAE5B;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACzB,QAAQ,SAAS,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,EAC7C,KAAK,SAAS,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAC,EAC/C,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,QAAQ,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,EACjD,KAAK,EAAE,CAAC,SAAS,WAAW,CAAC,MAAM,SAAS,EAAE,MAAM,CAAC,GAAG,SAAS,GAAG,KAAK,GACvE,CAAC,CAEH;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAC7D,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAC1E,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAEtD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAC7D,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAC1E,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAEhC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAOhE;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EACjD,OAAO,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,GAC1C,OAAO,CAAC,CAAC,CAAC,CAGZ"}
+{"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../../src/util/brand.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,KAAK,CAAC,SAAS,EAAE,IAAI,IAAI,SAAS,GAAG,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAE9E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,8BAAsB,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI;IACpD,SAAS,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;IAC5C;;;;;;;;OAQG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAE5C;;OAEG;IACH,OAAO;IAEP;;;;OAIG;WACW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,KAAK;CAKhE;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,WAAW,CAC5F,MAAM,SAAS,EACf,OAAO,CACP,GACE,SAAS,GACT,KAAK,CAAC;AAET;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,WAAW,CAC3F,OAAO,EACP,MAAM,IAAI,CACV,GACE,IAAI,GACJ,KAAK,CAAC;AAET;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,CAAC,EACtB,KAAK,EAAE,CAAC,SAAS,WAAW,CAAC,MAAM,SAAS,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,KAAK,GACxE,CAAC,CAEH"}

package/dist/util/brand.js

@@ -4,39 +4,12 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.brandedNumberType = exports.brandedStringType = exports.brandErased = exports.brandOpaque = exports.brand = exports.fromErased = exports.extractFromOpaque = exports.BrandedType = exports.ErasedType = void 0;
-const typebox_1 = require("@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
- */
-class ErasedType {
-    /**
-     * This class should never exist at runtime, so make it un-constructable.
-     */
-    constructor() { }
-}
-exports.ErasedType = ErasedType;
+exports.brand = exports.BrandedType = void 0;
+const internal_1 = require("@fluidframework/telemetry-utils/internal");
 /**
  * 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.
+ * See `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.
@@ -46,6 +19,12 @@ exports.ErasedType = ErasedType;
  * This is suitable for when ValueType is immutable (like string or number),
  * which is the common use-case for branding.
  *
+ * @privateRemarks
+ * This is split out into its own type as that's the only way to:
+ *
+ * - make the member protected (so you can't accidentally try and access it).
+ * - get nominal typing (so types produced without using this class can never be assignable to it).
+ *
  * @sealed
  * @internal
  */
@@ -54,77 +33,31 @@ class BrandedType {
      * This class should never exist at runtime, so make it un-constructable.
      */
     constructor() { }
+    /**
+     * Since this class is a compile time only type brand, `instanceof` will never work with it.
+     * This `Symbol.hasInstance` implementation ensures that `instanceof` will error if used,
+     * and in TypeScript 5.3 and newer will produce a compile time error if used.
+     */
+    static [Symbol.hasInstance](value) {
+        throw new internal_1.UsageError("BrandedType is a compile time type brand not a real class that can be used with `instancof` at runtime.");
+    }
 }
 exports.BrandedType = BrandedType;
-/**
- * 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
- */
-function extractFromOpaque(value) {
-    return value;
-}
-exports.extractFromOpaque = extractFromOpaque;
-/**
- * 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
- */
-function fromErased(value) {
-    return value;
-}
-exports.fromErased = fromErased;
 /**
  * Adds a type {@link Brand} to a value.
  *
  * Only do this when specifically allowed by the requirements of the type being converted to.
+ * @privateRemarks
+ * Leaving `T` unconstrained here allows for better type inference when branding unions.
+ * For example when assigning `brand(number)` a number to an optional branded number field,
+ * constraining T to `BrandedType<unknown, string>` causes the inference to fail and requires explicitly providing the type parameter.
+ * For example leaving T unconstrained instead allows the union of `BrandedType | undefined` to distribute over the conditional allowing the branding only the the union members which should be branded.
+ * This does not permit branding an optional value into an optional field since non branded union members are still excluded from input to this function:
+ * this is an intended restriction as it causes compile errors for misuse of this function (like using brand when the relevant type is not a branded type).
  * @internal
  */
 function brand(value) {
     return value;
 }
 exports.brand = brand;
-/**
- * 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
- */
-function brandOpaque(value) {
-    return value;
-}
-exports.brandOpaque = brandOpaque;
-/**
- * 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
- */
-function brandErased(value) {
-    return value;
-}
-exports.brandErased = brandErased;
-/**
- * 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).
- */
-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 typebox_1.Type.String();
-}
-exports.brandedStringType = brandedStringType;
-function brandedNumberType(options) {
-    // See comments on `brandedStringType`.
-    return typebox_1.Type.Number(options);
-}
-exports.brandedNumberType = brandedNumberType;
 //# sourceMappingURL=brand.js.map

package/dist/util/brand.js.map

@@ -1 +1 @@
-{"version":3,"file":"brand.js","sourceRoot":"","sources":["../../src/util/brand.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+CAAkE;AAgClE;;;;;;;;;;;;;;GAcG;AACH,MAAsB,UAAU;IAY/B;;OAEG;IACH,gBAAuB,CAAC;CACxB;AAhBD,gCAgBC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAsB,WAAW;IAahC;;OAEG;IACH,gBAAuB,CAAC;CACxB;AAjBD,kCAiBC;AA2DD;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAChC,KAAc;IAEd,OAAO,KAAmC,CAAC;AAC5C,CAAC;AAJD,8CAIC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAGxB,KAAwB;IACzB,OAAO,KAA4B,CAAC;AACrC,CAAC;AALD,gCAKC;AAED;;;;;GAKG;AACH,SAAgB,KAAK,CACpB,KAAyE;IAEzE,OAAO,KAAU,CAAC;AACnB,CAAC;AAJD,sBAIC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAC1B,KAA4E;IAE5E,OAAO,KAA6D,CAAC;AACtE,CAAC;AAJD,kCAIC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAC1B,KAA4E;IAE5E,OAAO,KAAuC,CAAC;AAChD,CAAC;AAJD,kCAIC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB;IAChC,kBAAkB;IAClB,0FAA0F;IAC1F,2DAA2D;IAC3D,8DAA8D;IAC9D,0GAA0G;IAC1G,OAAO,cAAI,CAAC,MAAM,EAA2B,CAAC;AAC/C,CAAC;AAPD,8CAOC;AAED,SAAgB,iBAAiB,CAChC,OAA4C;IAE5C,uCAAuC;IACvC,OAAO,cAAI,CAAC,MAAM,CAAC,OAAO,CAA0B,CAAC;AACtD,CAAC;AALD,8CAKC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { NumericOptions, TUnsafe, Type } from \"@sinclair/typebox\";\nimport { Covariant, isAny } from \"./typeCheck.js\";\nimport { Assume } from \"./utils.js\";\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>(\n\toptions?: NumericOptions<number> | undefined,\n): TUnsafe<T> {\n\t// See comments on `brandedStringType`.\n\treturn Type.Number(options) as unknown as TUnsafe<T>;\n}\n"]}
+{"version":3,"file":"brand.js","sourceRoot":"","sources":["../../src/util/brand.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uEAAsE;AAmBtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAsB,WAAW;IAahC;;OAEG;IACH,gBAAuB,CAAC;IAExB;;;;OAIG;IACI,MAAM,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,KAAY;QAC9C,MAAM,IAAI,qBAAU,CACnB,yGAAyG,CACzG,CAAC;IACH,CAAC;CACD;AA5BD,kCA4BC;AA0BD;;;;;;;;;;;;GAYG;AACH,SAAgB,KAAK,CACpB,KAA0E;IAE1E,OAAO,KAAU,CAAC;AACnB,CAAC;AAJD,sBAIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport type { Covariant } from \"./typeCheck.js\";\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> = ValueType & BrandedType<ValueType, Name>;\n\n/**\n * Helper for {@link Brand}.\n *\n * See `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 * @privateRemarks\n * This is split out into its own type as that's the only way to:\n *\n * - make the member protected (so you can't accidentally try and access it).\n * - get nominal typing (so types produced without using this class can never be assignable to it).\n *\n * @sealed\n * @internal\n */\nexport abstract class BrandedType<out ValueType, Name> {\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\t/**\n\t * Since this class is a compile time only type brand, `instanceof` will never work with it.\n\t * This `Symbol.hasInstance` implementation ensures that `instanceof` will error if used,\n\t * and in TypeScript 5.3 and newer will produce a compile time error if used.\n\t */\n\tpublic static [Symbol.hasInstance](value: never): value is never {\n\t\tthrow new UsageError(\n\t\t\t\"BrandedType is a compile time type brand not a real class that can be used with `instancof` at runtime.\",\n\t\t);\n\t}\n}\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<unknown, unknown>> = T extends BrandedType<\n\tinfer ValueType,\n\tunknown\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<unknown, unknown>> = T extends BrandedType<\n\tunknown,\n\tinfer Name\n>\n\t? Name\n\t: never;\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 * @privateRemarks\n * Leaving `T` unconstrained here allows for better type inference when branding unions.\n * For example when assigning `brand(number)` a number to an optional branded number field,\n * constraining T to `BrandedType<unknown, string>` causes the inference to fail and requires explicitly providing the type parameter.\n * For example leaving T unconstrained instead allows the union of `BrandedType | undefined` to distribute over the conditional allowing the branding only the the union members which should be branded.\n * This does not permit branding an optional value into an optional field since non branded union members are still excluded from input to this function:\n * this is an intended restriction as it causes compile errors for misuse of this function (like using brand when the relevant type is not a branded type).\n * @internal\n */\nexport function brand<T>(\n\tvalue: T extends BrandedType<infer ValueType, unknown> ? ValueType : never,\n): T {\n\treturn value as T;\n}\n"]}

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

@@ -1 +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,QAAQ,EAAE,MAAM,GAAG,CAAC;CACpB;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"}
+{"version":3,"file":"idAllocator.d.ts","sourceRoot":"","sources":["../../src/util/idAllocator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH;;;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,QAAQ,EAAE,MAAM,GAAG,CAAC;CACpB;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/dist/util/idAllocator.js

@@ -5,7 +5,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fakeIdAllocator = exports.idAllocatorFromState = exports.idAllocatorFromMaxId = void 0;
-const core_utils_1 = require("@fluidframework/core-utils");
+const internal_1 = require("@fluidframework/core-utils/internal");
 const utils_js_1 = require("./utils.js");
 /**
  * @internal
@@ -18,7 +18,7 @@ function idAllocatorFromState(state) {
     return {
         allocate: (c) => {
             const count = c ?? 1;
-            (0, core_utils_1.assert)(count > 0, 0x5cf /* Must allocate at least one ID */);
+            (0, internal_1.assert)(count > 0, 0x5cf /* Must allocate at least one ID */);
             const id = state.maxId + 1;
             state.maxId += count;
             return id;

package/dist/util/idAllocator.js.map

@@ -1 +1 @@
-{"version":3,"file":"idAllocator.js","sourceRoot":"","sources":["../../src/util/idAllocator.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AACpD,yCAAkC;AAsBlC;;GAEG;AACH,SAAgB,oBAAoB,CAAC,QAA4B,SAAS;IACzE,OAAO,oBAAoB,CAAC,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;AACrD,CAAC;AAFD,oDAEC;AAED,SAAgB,oBAAoB,CAAC,KAAwB;IAC5D,OAAO;QACN,QAAQ,EAAE,CAAC,CAAU,EAAE,EAAE;YACxB,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;YACrB,IAAA,mBAAM,EAAC,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;AAXD,oDAWC;AAEY,QAAA,eAAe,GAAgB;IAC3C,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,eAAI,EAAC,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\";\nimport { fail } from \"./utils.js\";\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 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 * @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\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,kEAA6D;AAE7D,yCAAkC;AAsBlC;;GAEG;AACH,SAAgB,oBAAoB,CAAC,QAA4B,SAAS;IACzE,OAAO,oBAAoB,CAAC,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;AACrD,CAAC;AAFD,oDAEC;AAED,SAAgB,oBAAoB,CAAC,KAAwB;IAC5D,OAAO;QACN,QAAQ,EAAE,CAAC,CAAU,EAAE,EAAE;YACxB,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;YACrB,IAAA,iBAAM,EAAC,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;AAXD,oDAWC;AAEY,QAAA,eAAe,GAAgB;IAC3C,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAA,eAAI,EAAC,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 * @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 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 * @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\tgetMaxId: () => state.maxId,\n\t};\n}\n\nexport const fakeIdAllocator: IdAllocator = {\n\tallocate: () => fail(\"Should not allocate IDs\"),\n\tgetMaxId: () => 0,\n};\n"]}

package/dist/util/index.d.ts

@@ -2,16 +2,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.js";
+export { brand, Brand, BrandedType, NameFromBranded, ValueFromBranded } from "./brand.js";
+export { brandedNumberType, brandedStringType } from "./typeboxBrand.js";
+export { brandOpaque, extractFromOpaque, ExtractFromOpaque, Opaque } from "./opaque.js";
 export { deleteFromNestedMap, getOrAddInMap, getOrAddInNestedMap, getOrDefaultInNestedMap, forEachInNestedMap, NestedMap, SizedNestedMap, populateNestedMap, setInNestedMap, tryAddToNestedMap, tryGetFromNestedMap, nestedMapToFlatList, nestedMapFromFlatList, } from "./nestedMap.js";
 export { addToNestedSet, NestedSet, nestedSetContains } from "./nestedSet.js";
 export { OffsetList, OffsetListFactory } from "./offsetList.js";
 export { TransactionResult } from "./transactionResult.js";
 export { areSafelyAssignable, Contravariant, Covariant, eitherIsAny, EnforceTypeCheckTests, Invariant, isAny, isAssignableTo, isStrictSubset, MakeNominal, requireFalse, requireTrue, requireAssignableTo, } from "./typeCheck.js";
 export { StackyIterator } from "./stackyIterator.js";
-export { asMutable, clone, compareSets, fail, getOrAddEmptyToMap, getOrCreate, isJsonObject, isReadonlyArray, JsonCompatible, JsonCompatibleObject, JsonCompatibleReadOnly, JsonCompatibleReadOnlySchema, makeArray, mapIterable, Mutable, Populated, RecursiveReadonly, zipIterables, Assume, assertValidIndex, assertValidRange, assertNonNegativeSafeInteger, objectToMap, invertMap, oneFromSet, Named, compareNamed, disposeSymbol, IDisposable, capitalize, assertValidRangeIndices, transformObjectMap, compareStrings, } from "./utils.js";
+export { asMutable, clone, compareSets, fail, getOrAddEmptyToMap, getOrCreate, isJsonObject, isReadonlyArray, JsonCompatible, JsonCompatibleObject, JsonCompatibleReadOnly, JsonCompatibleReadOnlySchema, makeArray, mapIterable, Mutable, Populated, RecursiveReadonly, zipIterables, assertValidIndex, assertValidRange, assertNonNegativeSafeInteger, objectToMap, invertMap, oneFromSet, Named, compareNamed, disposeSymbol, IDisposable, capitalize, assertValidRangeIndices, transformObjectMap, compareStrings, } from "./utils.js";
 export { ReferenceCountedBase, ReferenceCounted } from "./referenceCounting.js";
-export { AllowOptional, RequiredFields, OptionalFields, _InlineTrick, _RecursiveTrick, FlattenKeys, AllowOptionalNotFlattened, RestrictiveReadonlyRecord, } from "./typeUtils.js";
+export { AllowOptional, RequiredFields, OptionalFields, _InlineTrick, _RecursiveTrick, FlattenKeys, AllowOptionalNotFlattened, RestrictiveReadonlyRecord, Assume, } from "./typeUtils.js";
 export { BrandedKey, BrandedKeyContent, BrandedMapSubset, getOrCreateSlotContent, brandedSlot, } from "./brandedMap.js";
 export { getFirstEntryFromRangeMap, getFromRangeMap, RangeEntry, RangeMap, RangeQueryResult, setInRangeMap, deleteFromRangeMap, } from "./rangeMap.js";
 export { IdAllocator, idAllocatorFromMaxId, idAllocatorFromState, IdAllocationState, fakeIdAllocator, } from "./idAllocator.js";

package/dist/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,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,YAAY,CAAC;AACpB,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,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,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,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,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,WAAW,EACX,SAAS,EACT,UAAU,EACV,KAAK,EACL,YAAY,EACZ,aAAa,EACb,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,GACd,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,EACN,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,eAAe,EACf,WAAW,EACX,yBAAyB,EACzB,yBAAyB,GACzB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,WAAW,GACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,yBAAyB,EACzB,eAAe,EACf,UAAU,EACV,QAAQ,EACR,gBAAgB,EAChB,aAAa,EACb,kBAAkB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACN,WAAW,EACX,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,GACf,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC1F,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACxF,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,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,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,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,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,4BAA4B,EAC5B,SAAS,EACT,WAAW,EACX,OAAO,EACP,SAAS,EACT,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,4BAA4B,EAC5B,WAAW,EACX,SAAS,EACT,UAAU,EACV,KAAK,EACL,YAAY,EACZ,aAAa,EACb,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,kBAAkB,EAClB,cAAc,GACd,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,OAAO,EACN,aAAa,EACb,cAAc,EACd,cAAc,EACd,YAAY,EACZ,eAAe,EACf,WAAW,EACX,yBAAyB,EACzB,yBAAyB,EACzB,MAAM,GACN,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,sBAAsB,EACtB,WAAW,GACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACN,yBAAyB,EACzB,eAAe,EACf,UAAU,EACV,QAAQ,EACR,gBAAgB,EAChB,aAAa,EACb,kBAAkB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACN,WAAW,EACX,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,GACf,MAAM,kBAAkB,CAAC"}

package/dist/util/index.js

@@ -4,18 +4,17 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareStrings = exports.transformObjectMap = exports.assertValidRangeIndices = exports.capitalize = exports.disposeSymbol = exports.compareNamed = exports.oneFromSet = exports.invertMap = exports.objectToMap = exports.assertNonNegativeSafeInteger = exports.assertValidRange = exports.assertValidIndex = exports.zipIterables = exports.mapIterable = exports.makeArray = exports.JsonCompatibleReadOnlySchema = exports.isReadonlyArray = exports.isJsonObject = exports.getOrCreate = exports.getOrAddEmptyToMap = exports.fail = exports.compareSets = exports.clone = exports.asMutable = exports.StackyIterator = exports.TransactionResult = exports.OffsetListFactory = exports.nestedSetContains = exports.addToNestedSet = exports.nestedMapFromFlatList = exports.nestedMapToFlatList = exports.tryGetFromNestedMap = exports.tryAddToNestedMap = exports.setInNestedMap = exports.populateNestedMap = exports.SizedNestedMap = exports.forEachInNestedMap = exports.getOrDefaultInNestedMap = exports.getOrAddInNestedMap = exports.getOrAddInMap = exports.deleteFromNestedMap = exports.brandErased = exports.ErasedType = exports.fromErased = exports.extractFromOpaque = exports.brandedStringType = exports.brandedNumberType = exports.brandOpaque = exports.BrandedType = exports.brand = void 0;
-exports.fakeIdAllocator = exports.idAllocatorFromState = exports.idAllocatorFromMaxId = exports.deleteFromRangeMap = exports.setInRangeMap = exports.getFromRangeMap = exports.getFirstEntryFromRangeMap = exports.brandedSlot = exports.getOrCreateSlotContent = exports.ReferenceCountedBase = void 0;
+exports.brandedSlot = exports.getOrCreateSlotContent = exports.ReferenceCountedBase = exports.compareStrings = exports.transformObjectMap = exports.assertValidRangeIndices = exports.capitalize = exports.disposeSymbol = exports.compareNamed = exports.oneFromSet = exports.invertMap = exports.objectToMap = exports.assertNonNegativeSafeInteger = exports.assertValidRange = exports.assertValidIndex = exports.zipIterables = exports.mapIterable = exports.makeArray = exports.JsonCompatibleReadOnlySchema = exports.isReadonlyArray = exports.isJsonObject = exports.getOrCreate = exports.getOrAddEmptyToMap = exports.fail = exports.compareSets = exports.clone = exports.asMutable = exports.StackyIterator = exports.TransactionResult = exports.OffsetListFactory = exports.nestedSetContains = exports.addToNestedSet = exports.nestedMapFromFlatList = exports.nestedMapToFlatList = exports.tryGetFromNestedMap = exports.tryAddToNestedMap = exports.setInNestedMap = exports.populateNestedMap = exports.SizedNestedMap = exports.forEachInNestedMap = exports.getOrDefaultInNestedMap = exports.getOrAddInNestedMap = exports.getOrAddInMap = exports.deleteFromNestedMap = exports.extractFromOpaque = exports.brandOpaque = exports.brandedStringType = exports.brandedNumberType = exports.BrandedType = exports.brand = void 0;
+exports.fakeIdAllocator = exports.idAllocatorFromState = exports.idAllocatorFromMaxId = exports.deleteFromRangeMap = exports.setInRangeMap = exports.getFromRangeMap = exports.getFirstEntryFromRangeMap = void 0;
 var brand_js_1 = require("./brand.js");
 Object.defineProperty(exports, "brand", { enumerable: true, get: function () { return brand_js_1.brand; } });
 Object.defineProperty(exports, "BrandedType", { enumerable: true, get: function () { return brand_js_1.BrandedType; } });
-Object.defineProperty(exports, "brandOpaque", { enumerable: true, get: function () { return brand_js_1.brandOpaque; } });
-Object.defineProperty(exports, "brandedNumberType", { enumerable: true, get: function () { return brand_js_1.brandedNumberType; } });
-Object.defineProperty(exports, "brandedStringType", { enumerable: true, get: function () { return brand_js_1.brandedStringType; } });
-Object.defineProperty(exports, "extractFromOpaque", { enumerable: true, get: function () { return brand_js_1.extractFromOpaque; } });
-Object.defineProperty(exports, "fromErased", { enumerable: true, get: function () { return brand_js_1.fromErased; } });
-Object.defineProperty(exports, "ErasedType", { enumerable: true, get: function () { return brand_js_1.ErasedType; } });
-Object.defineProperty(exports, "brandErased", { enumerable: true, get: function () { return brand_js_1.brandErased; } });
+var typeboxBrand_js_1 = require("./typeboxBrand.js");
+Object.defineProperty(exports, "brandedNumberType", { enumerable: true, get: function () { return typeboxBrand_js_1.brandedNumberType; } });
+Object.defineProperty(exports, "brandedStringType", { enumerable: true, get: function () { return typeboxBrand_js_1.brandedStringType; } });
+var opaque_js_1 = require("./opaque.js");
+Object.defineProperty(exports, "brandOpaque", { enumerable: true, get: function () { return opaque_js_1.brandOpaque; } });
+Object.defineProperty(exports, "extractFromOpaque", { enumerable: true, get: function () { return opaque_js_1.extractFromOpaque; } });
 var nestedMap_js_1 = require("./nestedMap.js");
 Object.defineProperty(exports, "deleteFromNestedMap", { enumerable: true, get: function () { return nestedMap_js_1.deleteFromNestedMap; } });
 Object.defineProperty(exports, "getOrAddInMap", { enumerable: true, get: function () { return nestedMap_js_1.getOrAddInMap; } });

package/dist/util/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,uCAgBoB;AAfnB,iGAAA,KAAK,OAAA;AAEL,uGAAA,WAAW,OAAA;AACX,uGAAA,WAAW,OAAA;AACX,6GAAA,iBAAiB,OAAA;AACjB,6GAAA,iBAAiB,OAAA;AACjB,6GAAA,iBAAiB,OAAA;AAEjB,sGAAA,UAAU,OAAA;AAEV,sGAAA,UAAU,OAAA;AAIV,uGAAA,WAAW,OAAA;AAEZ,+CAcwB;AAbvB,mHAAA,mBAAmB,OAAA;AACnB,6GAAA,aAAa,OAAA;AACb,mHAAA,mBAAmB,OAAA;AACnB,uHAAA,uBAAuB,OAAA;AACvB,kHAAA,kBAAkB,OAAA;AAElB,8GAAA,cAAc,OAAA;AACd,iHAAA,iBAAiB,OAAA;AACjB,8GAAA,cAAc,OAAA;AACd,iHAAA,iBAAiB,OAAA;AACjB,mHAAA,mBAAmB,OAAA;AACnB,mHAAA,mBAAmB,OAAA;AACnB,qHAAA,qBAAqB,OAAA;AAEtB,+CAA8E;AAArE,8GAAA,cAAc,OAAA;AAAa,iHAAA,iBAAiB,OAAA;AACrD,iDAAgE;AAA3C,kHAAA,iBAAiB,OAAA;AACtC,+DAA2D;AAAlD,yHAAA,iBAAiB,OAAA;AAgB1B,yDAAqD;AAA5C,mHAAA,cAAc,OAAA;AACvB,uCAkCoB;AAjCnB,qGAAA,SAAS,OAAA;AACT,iGAAA,KAAK,OAAA;AACL,uGAAA,WAAW,OAAA;AACX,gGAAA,IAAI,OAAA;AACJ,8GAAA,kBAAkB,OAAA;AAClB,uGAAA,WAAW,OAAA;AACX,wGAAA,YAAY,OAAA;AACZ,2GAAA,eAAe,OAAA;AAIf,wHAAA,4BAA4B,OAAA;AAC5B,qGAAA,SAAS,OAAA;AACT,uGAAA,WAAW,OAAA;AAIX,wGAAA,YAAY,OAAA;AAEZ,4GAAA,gBAAgB,OAAA;AAChB,4GAAA,gBAAgB,OAAA;AAChB,wHAAA,4BAA4B,OAAA;AAC5B,uGAAA,WAAW,OAAA;AACX,qGAAA,SAAS,OAAA;AACT,sGAAA,UAAU,OAAA;AAEV,wGAAA,YAAY,OAAA;AACZ,yGAAA,aAAa,OAAA;AAEb,sGAAA,UAAU,OAAA;AACV,mHAAA,uBAAuB,OAAA;AACvB,8GAAA,kBAAkB,OAAA;AAClB,0GAAA,cAAc,OAAA;AAEf,+DAAgF;AAAvE,4HAAA,oBAAoB,OAAA;AAa7B,iDAMyB;AAFxB,uHAAA,sBAAsB,OAAA;AACtB,4GAAA,WAAW,OAAA;AAGZ,6CAQuB;AAPtB,wHAAA,yBAAyB,OAAA;AACzB,8GAAA,eAAe,OAAA;AAIf,4GAAA,aAAa,OAAA;AACb,iHAAA,kBAAkB,OAAA;AAGnB,mDAM0B;AAJzB,sHAAA,oBAAoB,OAAA;AACpB,sHAAA,oBAAoB,OAAA;AAEpB,iHAAA,eAAe,OAAA","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.js\";\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.js\";\nexport { addToNestedSet, NestedSet, nestedSetContains } from \"./nestedSet.js\";\nexport { OffsetList, OffsetListFactory } from \"./offsetList.js\";\nexport { TransactionResult } from \"./transactionResult.js\";\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.js\";\nexport { StackyIterator } from \"./stackyIterator.js\";\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\tobjectToMap,\n\tinvertMap,\n\toneFromSet,\n\tNamed,\n\tcompareNamed,\n\tdisposeSymbol,\n\tIDisposable,\n\tcapitalize,\n\tassertValidRangeIndices,\n\ttransformObjectMap,\n\tcompareStrings,\n} from \"./utils.js\";\nexport { ReferenceCountedBase, ReferenceCounted } from \"./referenceCounting.js\";\n\nexport {\n\tAllowOptional,\n\tRequiredFields,\n\tOptionalFields,\n\t_InlineTrick,\n\t_RecursiveTrick,\n\tFlattenKeys,\n\tAllowOptionalNotFlattened,\n\tRestrictiveReadonlyRecord,\n} from \"./typeUtils.js\";\n\nexport {\n\tBrandedKey,\n\tBrandedKeyContent,\n\tBrandedMapSubset,\n\tgetOrCreateSlotContent,\n\tbrandedSlot,\n} from \"./brandedMap.js\";\n\nexport {\n\tgetFirstEntryFromRangeMap,\n\tgetFromRangeMap,\n\tRangeEntry,\n\tRangeMap,\n\tRangeQueryResult,\n\tsetInRangeMap,\n\tdeleteFromRangeMap,\n} from \"./rangeMap.js\";\n\nexport {\n\tIdAllocator,\n\tidAllocatorFromMaxId,\n\tidAllocatorFromState,\n\tIdAllocationState,\n\tfakeIdAllocator,\n} from \"./idAllocator.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAEH,uCAA0F;AAAjF,iGAAA,KAAK,OAAA;AAAS,uGAAA,WAAW,OAAA;AAClC,qDAAyE;AAAhE,oHAAA,iBAAiB,OAAA;AAAE,oHAAA,iBAAiB,OAAA;AAC7C,yCAAwF;AAA/E,wGAAA,WAAW,OAAA;AAAE,8GAAA,iBAAiB,OAAA;AACvC,+CAcwB;AAbvB,mHAAA,mBAAmB,OAAA;AACnB,6GAAA,aAAa,OAAA;AACb,mHAAA,mBAAmB,OAAA;AACnB,uHAAA,uBAAuB,OAAA;AACvB,kHAAA,kBAAkB,OAAA;AAElB,8GAAA,cAAc,OAAA;AACd,iHAAA,iBAAiB,OAAA;AACjB,8GAAA,cAAc,OAAA;AACd,iHAAA,iBAAiB,OAAA;AACjB,mHAAA,mBAAmB,OAAA;AACnB,mHAAA,mBAAmB,OAAA;AACnB,qHAAA,qBAAqB,OAAA;AAEtB,+CAA8E;AAArE,8GAAA,cAAc,OAAA;AAAa,iHAAA,iBAAiB,OAAA;AACrD,iDAAgE;AAA3C,kHAAA,iBAAiB,OAAA;AACtC,+DAA2D;AAAlD,yHAAA,iBAAiB,OAAA;AAgB1B,yDAAqD;AAA5C,mHAAA,cAAc,OAAA;AACvB,uCAiCoB;AAhCnB,qGAAA,SAAS,OAAA;AACT,iGAAA,KAAK,OAAA;AACL,uGAAA,WAAW,OAAA;AACX,gGAAA,IAAI,OAAA;AACJ,8GAAA,kBAAkB,OAAA;AAClB,uGAAA,WAAW,OAAA;AACX,wGAAA,YAAY,OAAA;AACZ,2GAAA,eAAe,OAAA;AAIf,wHAAA,4BAA4B,OAAA;AAC5B,qGAAA,SAAS,OAAA;AACT,uGAAA,WAAW,OAAA;AAIX,wGAAA,YAAY,OAAA;AACZ,4GAAA,gBAAgB,OAAA;AAChB,4GAAA,gBAAgB,OAAA;AAChB,wHAAA,4BAA4B,OAAA;AAC5B,uGAAA,WAAW,OAAA;AACX,qGAAA,SAAS,OAAA;AACT,sGAAA,UAAU,OAAA;AAEV,wGAAA,YAAY,OAAA;AACZ,yGAAA,aAAa,OAAA;AAEb,sGAAA,UAAU,OAAA;AACV,mHAAA,uBAAuB,OAAA;AACvB,8GAAA,kBAAkB,OAAA;AAClB,0GAAA,cAAc,OAAA;AAEf,+DAAgF;AAAvE,4HAAA,oBAAoB,OAAA;AAc7B,iDAMyB;AAFxB,uHAAA,sBAAsB,OAAA;AACtB,4GAAA,WAAW,OAAA;AAGZ,6CAQuB;AAPtB,wHAAA,yBAAyB,OAAA;AACzB,8GAAA,eAAe,OAAA;AAIf,4GAAA,aAAa,OAAA;AACb,iHAAA,kBAAkB,OAAA;AAGnB,mDAM0B;AAJzB,sHAAA,oBAAoB,OAAA;AACpB,sHAAA,oBAAoB,OAAA;AAEpB,iHAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { brand, Brand, BrandedType, NameFromBranded, ValueFromBranded } from \"./brand.js\";\nexport { brandedNumberType, brandedStringType } from \"./typeboxBrand.js\";\nexport { brandOpaque, extractFromOpaque, ExtractFromOpaque, Opaque } from \"./opaque.js\";\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.js\";\nexport { addToNestedSet, NestedSet, nestedSetContains } from \"./nestedSet.js\";\nexport { OffsetList, OffsetListFactory } from \"./offsetList.js\";\nexport { TransactionResult } from \"./transactionResult.js\";\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.js\";\nexport { StackyIterator } from \"./stackyIterator.js\";\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\tassertValidIndex,\n\tassertValidRange,\n\tassertNonNegativeSafeInteger,\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.js\";\nexport { ReferenceCountedBase, ReferenceCounted } from \"./referenceCounting.js\";\n\nexport {\n\tAllowOptional,\n\tRequiredFields,\n\tOptionalFields,\n\t_InlineTrick,\n\t_RecursiveTrick,\n\tFlattenKeys,\n\tAllowOptionalNotFlattened,\n\tRestrictiveReadonlyRecord,\n\tAssume,\n} from \"./typeUtils.js\";\n\nexport {\n\tBrandedKey,\n\tBrandedKeyContent,\n\tBrandedMapSubset,\n\tgetOrCreateSlotContent,\n\tbrandedSlot,\n} from \"./brandedMap.js\";\n\nexport {\n\tgetFirstEntryFromRangeMap,\n\tgetFromRangeMap,\n\tRangeEntry,\n\tRangeMap,\n\tRangeQueryResult,\n\tsetInRangeMap,\n\tdeleteFromRangeMap,\n} from \"./rangeMap.js\";\n\nexport {\n\tIdAllocator,\n\tidAllocatorFromMaxId,\n\tidAllocatorFromState,\n\tIdAllocationState,\n\tfakeIdAllocator,\n} from \"./idAllocator.js\";\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"nestedSet.d.ts","sourceRoot":"","sources":["../../src/util/nestedSet.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAA2B,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAEpF,MAAM,MAAM,SAAS,CAAC,IAAI,EAAE,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAEnE,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EACxC,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,EAC1B,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,GACR,IAAI,CAEN;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAC3C,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,EAC1B,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,GACR,OAAO,CAET"}
+{"version":3,"file":"nestedSet.d.ts","sourceRoot":"","sources":["../../src/util/nestedSet.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAA2C,MAAM,gBAAgB,CAAC;AAEpF,MAAM,MAAM,SAAS,CAAC,IAAI,EAAE,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AAEnE,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,EACxC,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,EAC1B,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,GACR,IAAI,CAEN;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAC3C,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,EAC1B,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,GACR,OAAO,CAET"}

package/dist/util/nestedSet.js.map

@@ -1 +1 @@
-{"version":3,"file":"nestedSet.js","sourceRoot":"","sources":["../../src/util/nestedSet.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAAoF;AAIpF,SAAgB,cAAc,CAC7B,GAA0B,EAC1B,IAAU,EACV,IAAU;IAEV,IAAA,6BAAc,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AAND,wCAMC;AAED,SAAgB,iBAAiB,CAChC,GAA0B,EAC1B,IAAU,EACV,IAAU;IAEV,OAAO,IAAA,sCAAuB,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC;AAND,8CAMC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { getOrDefaultInNestedMap, NestedMap, setInNestedMap } from \"./nestedMap.js\";\n\nexport type NestedSet<Key1, Key2> = NestedMap<Key1, Key2, boolean>;\n\nexport function addToNestedSet<Key1, Key2>(\n\tset: NestedSet<Key1, Key2>,\n\tkey1: Key1,\n\tkey2: Key2,\n): void {\n\tsetInNestedMap(set, key1, key2, true);\n}\n\nexport function nestedSetContains<Key1, Key2>(\n\tset: NestedSet<Key1, Key2>,\n\tkey1: Key1,\n\tkey2: Key2,\n): boolean {\n\treturn getOrDefaultInNestedMap(set, key1, key2, false);\n}\n"]}
+{"version":3,"file":"nestedSet.js","sourceRoot":"","sources":["../../src/util/nestedSet.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAAoF;AAIpF,SAAgB,cAAc,CAC7B,GAA0B,EAC1B,IAAU,EACV,IAAU;IAEV,IAAA,6BAAc,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AAND,wCAMC;AAED,SAAgB,iBAAiB,CAChC,GAA0B,EAC1B,IAAU,EACV,IAAU;IAEV,OAAO,IAAA,sCAAuB,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AACxD,CAAC;AAND,8CAMC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { NestedMap, getOrDefaultInNestedMap, setInNestedMap } from \"./nestedMap.js\";\n\nexport type NestedSet<Key1, Key2> = NestedMap<Key1, Key2, boolean>;\n\nexport function addToNestedSet<Key1, Key2>(\n\tset: NestedSet<Key1, Key2>,\n\tkey1: Key1,\n\tkey2: Key2,\n): void {\n\tsetInNestedMap(set, key1, key2, true);\n}\n\nexport function nestedSetContains<Key1, Key2>(\n\tset: NestedSet<Key1, Key2>,\n\tkey1: Key1,\n\tkey2: Key2,\n): boolean {\n\treturn getOrDefaultInNestedMap(set, key1, key2, false);\n}\n"]}

package/dist/util/opaque.d.ts

@@ -0,0 +1,46 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { Brand, BrandedType, NameFromBranded, ValueFromBranded } from "./brand.js";
+import type { isAny } from "./typeCheck.js";
+/**
+ * Converts a Branded type into an "opaque" handle.
+ * This prevents the value from being used directly, but does not fully type erase it.
+ * @remarks
+ * Like {@link @fluidframework/core-interfaces#ErasedType},
+ * but more type safe and cannot be used to hide the internal type from API extractor at package boundaries.
+ *
+ * The type can be recovered using {@link extractFromOpaque},
+ * however if we assume only code that produces these "opaque" handles does that conversion,
+ * they can function like opaque handles.
+ *
+ * Recommended usage is to use `interface` instead of `type` so tooling (such as tsc and refactoring tools)
+ * uses the type name instead of expanding it:
+ * ```typescript
+ * export interface MyType extends Opaque<Brand<string, "myPackage.MyType">>{}
+ * ```
+ * @internal
+ */
+export type Opaque<T extends Brand<any, unknown>> = T extends BrandedType<infer ValueType, infer Name> ? BrandedType<ValueType, Name> : never;
+/**
+ * See {@link extractFromOpaque}.
+ * @internal
+ */
+export type ExtractFromOpaque<TOpaque extends BrandedType<any, unknown>> = TOpaque extends BrandedType<infer ValueType, infer Name> ? isAny<ValueType> extends true ? unknown : Brand<ValueType, Name> : never;
+/**
+ * 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 declare function extractFromOpaque<TOpaque extends BrandedType<any, unknown>>(value: TOpaque): ExtractFromOpaque<TOpaque>;
+/**
+ * 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 declare function brandOpaque<T extends BrandedType<any, unknown>>(value: isAny<ValueFromBranded<T>> extends true ? never : ValueFromBranded<T>): BrandedType<ValueFromBranded<T>, NameFromBranded<T>>;
+//# sourceMappingURL=opaque.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"opaque.d.ts","sourceRoot":"","sources":["../../src/util/opaque.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACxF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,WAAW,CACxE,MAAM,SAAS,EACf,MAAM,IAAI,CACV,GACE,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC,GAC5B,KAAK,CAAC;AAET;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,IACtE,OAAO,SAAS,WAAW,CAAC,MAAM,SAAS,EAAE,MAAM,IAAI,CAAC,GACrD,KAAK,CAAC,SAAS,CAAC,SAAS,IAAI,GAC5B,OAAO,GACP,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,GACvB,KAAK,CAAC;AAEV;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,SAAS,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,EAC1E,KAAK,EAAE,OAAO,GACZ,iBAAiB,CAAC,OAAO,CAAC,CAE5B;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,EAC9D,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAC1E,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAEtD"}

package/dist/util/opaque.js

@@ -0,0 +1,29 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.brandOpaque = exports.extractFromOpaque = void 0;
+/**
+ * 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
+ */
+function extractFromOpaque(value) {
+    return value;
+}
+exports.extractFromOpaque = extractFromOpaque;
+/**
+ * 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
+ */
+function brandOpaque(value) {
+    return value;
+}
+exports.brandOpaque = brandOpaque;
+//# sourceMappingURL=opaque.js.map