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

package/lib/domains/schemaBuilder.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { Any, FieldKinds, FlexFieldSchema, FlexImplicitAllowedTypes, NormalizeAllowedTypes, NormalizeField, SchemaBuilderOptions, FlexTreeNodeSchema, FlexMapFieldSchema, SchemaBuilderBase, FlexImplicitFieldSchema, FlexObjectNodeSchema, Unenforced, FlexAllowedTypes, FlexFieldNodeSchema, FlexMapNodeSchema } from "../feature-libraries/index.js";
+import { FieldKinds, FlexFieldNodeSchema, FlexFieldSchema, FlexImplicitAllowedTypes, FlexImplicitFieldSchema, FlexObjectNodeSchema, NormalizeAllowedTypes, SchemaBuilderBase, SchemaBuilderOptions, Unenforced } from "../feature-libraries/index.js";
 import { RestrictiveReadonlyRecord } from "../util/index.js";
 /**
  * Builds schema libraries, and the schema within them.
@@ -27,64 +27,18 @@ import { RestrictiveReadonlyRecord } from "../util/index.js";
  * @deprecated Users of this class should either use {@link SchemaBuilderBase} and explicitly work with {@link FlexFieldSchema}, or use SchemaFactory and work at its higher level of abstraction.
  */
 export declare class SchemaBuilder<TScope extends string = string, TName extends string | number = string> extends SchemaBuilderBase<TScope, typeof FieldKinds.required, TName> {
-    private readonly structuralTypes;
     constructor(options: SchemaBuilderOptions<TScope>);
     objectRecursive<const Name extends TName, const T extends Unenforced<RestrictiveReadonlyRecord<string, FlexImplicitFieldSchema>>>(name: Name, t: T): FlexObjectNodeSchema<`${TScope}.${Name}`, T>;
     /**
-     * Define (and add to this library if not already present) a structurally typed {@link FlexFieldNodeSchema} for a {@link (TreeListNode:interface)}.
-     *
-     * @remarks
-     * The {@link TreeNodeSchemaIdentifier} for this List is defined as a function of the provided types.
-     * It is still scoped to this SchemaBuilder, but multiple calls with the same arguments will return the same schema object, providing somewhat structural typing.
-     * This does not support recursive types.
-     *
-     * If using these structurally named lists, other types in this schema builder should avoid names of the form `List<${string}>`.
-     *
-     * @privateRemarks
-     * The name produced at the type level here is not as specific as it could be, however doing type level sorting and escaping is a real mess.
-     * There are cases where not having this full type provided will be less than ideal since TypeScript's structural types.
-     * For example attempts to narrow unions of structural lists by name won't work.
-     * Planned future changes to move to a class based schema system as well as factor function based node construction should mostly avoid these issues,
-     * though there may still be some problematic cases even after that work is done.
-     */
-    list<const T extends FlexTreeNodeSchema | Any | readonly FlexTreeNodeSchema[]>(allowedTypes: T): FlexFieldNodeSchema<`${TScope}.List<${string}>`, FlexFieldSchema<typeof FieldKinds.sequence, NormalizeAllowedTypes<T>>>;
-    /**
-     * Define (and add to this library) a {@link FlexFieldNodeSchema} for a {@link (TreeListNode:interface)}.
+     * Define (and add to this library) a {@link FlexFieldNodeSchema} for a {@link Sequence}.
      *
      * The name must be unique among all TreeNodeSchema in the the document schema.
      */
     list<Name extends TName, const T extends FlexImplicitAllowedTypes>(name: Name, allowedTypes: T): FlexFieldNodeSchema<`${TScope}.${Name}`, FlexFieldSchema<typeof FieldKinds.sequence, NormalizeAllowedTypes<T>>>;
-    /**
-     * Define (and add to this library) a {@link FlexFieldNodeSchema} for a {@link (TreeListNode:interface)}.
-     *
-     * The name must be unique among all TreeNodeSchema in the the document schema.
-     *
-     * @privateRemarks
-     * TODO: If A custom "List" API is added as a subtype of {@link FieldNode}, this would opt into that.
-     */
-    private namedList;
-    /**
-     * Define (and add to this library if not already present) a structurally typed {@link FlexMapNodeSchema} for a {@link TreeMapNode}.
-     *
-     * @remarks
-     * The {@link TreeNodeSchemaIdentifier} for this Map is defined as a function of the provided types.
-     * It is still scoped to this SchemaBuilder, but multiple calls with the same arguments will return the same schema object, providing somewhat structural typing.
-     * This does not support recursive types.
-     *
-     * If using these structurally named maps, other types in this schema builder should avoid names of the form `Map<${string}>`.
-     *
-     * @privateRemarks
-     * See note on list.
-     */
-    map<const T extends FlexTreeNodeSchema | Any | readonly FlexTreeNodeSchema[]>(allowedTypes: T): FlexMapNodeSchema<`${TScope}.Map<${string}>`, NormalizeField<T, typeof FieldKinds.optional>>;
-    /**
-     * Define (and add to this library) a {@link FlexMapNodeSchema} for a {@link TreeMapNode}.
-     */
-    map<Name extends TName, const T extends FlexMapFieldSchema | FlexImplicitAllowedTypes>(name: Name, fieldSchema: T): FlexMapNodeSchema<`${TScope}.${Name}`, NormalizeField<T, typeof FieldKinds.optional>>;
     /**
      * Define a schema for an {@link FieldKinds.optional|optional field}.
      * @remarks
-     * Shorthand or passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.
+     * Shorthand for passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.
      *
      * This method is also available as an instance method on {@link SchemaBuilder}.
      */
@@ -92,7 +46,7 @@ export declare class SchemaBuilder<TScope extends string = string, TName extends
     /**
      * Define a schema for an {@link FieldKinds.optional|optional field}.
      * @remarks
-     * Shorthand or passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.
+     * Shorthand for passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.
      *
      * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:
      * therefore this method is the same as the static version.
@@ -101,7 +55,7 @@ export declare class SchemaBuilder<TScope extends string = string, TName extends
     /**
      * Define a schema for a {@link FieldKinds.required|required field}.
      * @remarks
-     * Shorthand or passing `FieldKinds.required` to {@link FlexFieldSchema.create}.
+     * Shorthand for passing `FieldKinds.required` to {@link FlexFieldSchema.create}.
      *
      * This method is also available as an instance method on {@link SchemaBuilder}.
      */
@@ -109,7 +63,7 @@ export declare class SchemaBuilder<TScope extends string = string, TName extends
     /**
      * Define a schema for a {@link FieldKinds.required|required field}.
      * @remarks
-     * Shorthand or passing `FieldKinds.required` to {@link FlexFieldSchema.create}.
+     * Shorthand for passing `FieldKinds.required` to {@link FlexFieldSchema.create}.
      * Note that `FieldKinds.required` is the current default field kind, so APIs accepting {@link FlexImplicitFieldSchema}
      * can be passed the `allowedTypes` and will implicitly wrap it up in a {@link FieldKinds.required|required field}.
      *
@@ -120,7 +74,7 @@ export declare class SchemaBuilder<TScope extends string = string, TName extends
     /**
      * Define a schema for a {@link FieldKinds.sequence|sequence field}.
      * @remarks
-     * Shorthand or passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.
+     * Shorthand for passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.
      *
      * This method is also available as an instance method on {@link SchemaBuilder}
      */
@@ -128,44 +82,28 @@ export declare class SchemaBuilder<TScope extends string = string, TName extends
     /**
      * Define a schema for a {@link FieldKinds.sequence|sequence field}.
      * @remarks
-     * Shorthand or passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.
+     * Shorthand for passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.
      *
      * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:
      * therefore this method is the same as the static version.
      */
     readonly sequence: <const T extends FlexImplicitAllowedTypes>(allowedTypes: T) => FlexFieldSchema<import("../feature-libraries/index.js").Sequence, NormalizeAllowedTypes<T>>;
     /**
-     * {@link leaf.number}
-     */
-    readonly number: import("../feature-libraries/index.js").LeafNodeSchema<"com.fluidframework.leaf.number", import("../index.js").ValueSchema.Number>;
-    /**
-     * {@link leaf.boolean}
-     */
-    readonly boolean: import("../feature-libraries/index.js").LeafNodeSchema<"com.fluidframework.leaf.boolean", import("../index.js").ValueSchema.Boolean>;
-    /**
-     * {@link leaf.string}
-     */
-    readonly string: import("../feature-libraries/index.js").LeafNodeSchema<"com.fluidframework.leaf.string", import("../index.js").ValueSchema.String>;
-    /**
-     * {@link leaf.handle}
-     */
-    readonly handle: import("../feature-libraries/index.js").LeafNodeSchema<"com.fluidframework.leaf.handle", import("../index.js").ValueSchema.FluidHandle>;
-    /**
-     * {@link leaf.null}
+     * Define a schema for an {@link FieldKinds.identifier|identifier field}.
+     * @remarks
+     * Shorthand for passing `FieldKinds.identifier` to {@link TreeFieldSchema.create}.
+     *
+     * This method is also available as an instance method on {@link SchemaBuilder}
      */
-    readonly null: import("../feature-libraries/index.js").LeafNodeSchema<"com.fluidframework.leaf.null", import("../index.js").ValueSchema.Null>;
+    static identifier: <const T extends FlexImplicitAllowedTypes>(allowedTypes: T) => FlexFieldSchema<import("../feature-libraries/index.js").Identifier, NormalizeAllowedTypes<T>>;
     /**
-     * Function which can be used for its compile time side-effects to tweak the evaluation order of recursive types to make them compile.
+     * Define a schema for a {@link FieldKinds.identifier|identifier field}.
      * @remarks
-     * Some related information in https://github.com/microsoft/TypeScript/issues/55758.
+     * Shorthand for passing `FieldKinds.identifier` to {@link TreeFieldSchema.create}.
      *
-     * Also be aware that code which relies on this (or the "recursive" SchemaBuilder methods tends to break VSCode's IntelliSense every time anything related to that code (even comments) is edited.
-     * The command `TypeScript: Restart TS Server` should fix it.
-     * Sometimes this does not work: the exact cause has not been confirmed but if you have the file open multiple times (for example in both sides of a window split into two columns): closing the extra copy may help.
-     * Focusing the file with the errors before running `TypeScript: Restart TS Server` can also help.
-     * Real compile errors (for example elsewhere in the file) can also cause the IntelliSense to not work correctly ever after `TypeScript: Restart TS Server`.
+     * Since this creates a {@link TreeFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:
+     * therefore this method is the same as the static version.
      */
-    fixRecursiveReference<T extends FlexAllowedTypes>(...types: T): void;
+    readonly identifier: <const T extends FlexImplicitAllowedTypes>(allowedTypes: T) => FlexFieldSchema<import("../feature-libraries/index.js").Identifier, NormalizeAllowedTypes<T>>;
 }
-export declare function structuralName<const T extends string>(collectionName: T, allowedTypes: FlexTreeNodeSchema | Any | readonly FlexTreeNodeSchema[]): `${T}<${string}>`;
 //# sourceMappingURL=schemaBuilder.d.ts.map

package/lib/domains/schemaBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schemaBuilder.d.ts","sourceRoot":"","sources":["../../src/domains/schemaBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,GAAG,EAEH,UAAU,EACV,eAAe,EACf,wBAAwB,EACxB,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAElB,iBAAiB,EACjB,uBAAuB,EACvB,oBAAoB,EACpB,UAAU,EACV,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EAEjB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,yBAAyB,EAAoC,MAAM,kBAAkB,CAAC;AAG/F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,aAAa,CACzB,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,CACrC,SAAQ,iBAAiB,CAAC,MAAM,EAAE,OAAO,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA8C;gBAE3D,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAOxC,eAAe,CAC9B,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,EACrF,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;IAOlB;;;;;;;;;;;;;;;;OAgBG;IACI,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,kBAAkB,GAAG,GAAG,GAAG,SAAS,kBAAkB,EAAE,EACnF,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,GAAG,MAAM,SAAS,MAAM,GAAG,EAC3B,eAAe,CAAC,OAAO,UAAU,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CACrE;IAED;;;;OAIG;IACI,IAAI,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,wBAAwB,EACvE,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,GAAG,MAAM,IAAI,IAAI,EAAE,EACnB,eAAe,CAAC,OAAO,UAAU,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CACrE;IA2BD;;;;;;;OAOG;IACH,OAAO,CAAC,SAAS;IAgBjB;;;;;;;;;;;;OAYG;IACa,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,kBAAkB,GAAG,GAAG,GAAG,SAAS,kBAAkB,EAAE,EAC3F,YAAY,EAAE,CAAC,GACb,iBAAiB,CAAC,GAAG,MAAM,QAAQ,MAAM,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC;IAE/F;;OAEG;IACa,GAAG,CAClB,IAAI,SAAS,KAAK,EAClB,KAAK,CAAC,CAAC,SAAS,kBAAkB,GAAG,wBAAwB,EAE7D,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,CAAC,GACZ,iBAAiB,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC,EAAE,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC;IAiCxF;;;;;;OAMG;IACH,OAAc,QAAQ,6JAAoC;IAE1D;;;;;;;OAOG;IACH,SAAgB,QAAQ,6JAA0B;IAElD;;;;;;OAMG;IACH,OAAc,QAAQ,6JAAoC;IAE1D;;;;;;;;;OASG;IACH,SAAgB,QAAQ,6JAA0B;IAElD;;;;;;OAMG;IACH,OAAc,QAAQ,6JAAoC;IAE1D;;;;;;;OAOG;IACH,SAAgB,QAAQ,6JAA0B;IAElD;;OAEG;IACH,SAAgB,MAAM,qIAAe;IAErC;;OAEG;IACH,SAAgB,OAAO,uIAAgB;IAEvC;;OAEG;IACH,SAAgB,MAAM,qIAAe;IAErC;;OAEG;IACH,SAAgB,MAAM,0IAAe;IAErC;;OAEG;IACH,SAAgB,IAAI,iIAAa;IAEjC;;;;;;;;;;OAUG;IACI,qBAAqB,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,KAAK,EAAE,CAAC,GAAG,IAAI;CAC3E;AAWD,wBAAgB,cAAc,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EACpD,cAAc,EAAE,CAAC,EACjB,YAAY,EAAE,kBAAkB,GAAG,GAAG,GAAG,SAAS,kBAAkB,EAAE,GACpE,GAAG,CAAC,IAAI,MAAM,GAAG,CA+BnB"}
+{"version":3,"file":"schemaBuilder.d.ts","sourceRoot":"","sources":["../../src/domains/schemaBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,UAAU,EAEV,mBAAmB,EACnB,eAAe,EACf,wBAAwB,EACxB,uBAAuB,EACvB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,oBAAoB,EACpB,UAAU,EACV,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAI7D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,aAAa,CACzB,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,CACrC,SAAQ,iBAAiB,CAAC,MAAM,EAAE,OAAO,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC;gBAClD,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAOxC,eAAe,CAC9B,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,EACrF,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;IAOlB;;;;OAIG;IACI,IAAI,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,wBAAwB,EACvE,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,GAAG,MAAM,IAAI,IAAI,EAAE,EACnB,eAAe,CAAC,OAAO,UAAU,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CACrE;IAUD;;;;;;OAMG;IACH,OAAc,QAAQ,6JAAoC;IAE1D;;;;;;;OAOG;IACH,SAAgB,QAAQ,6JAA0B;IAElD;;;;;;OAMG;IACH,OAAc,QAAQ,6JAAoC;IAE1D;;;;;;;;;OASG;IACH,SAAgB,QAAQ,6JAA0B;IAElD;;;;;;OAMG;IACH,OAAc,QAAQ,6JAAoC;IAE1D;;;;;;;OAOG;IACH,SAAgB,QAAQ,6JAA0B;IAElD;;;;;;OAMG;IACH,OAAc,UAAU,+JAAsC;IAE9D;;;;;;;OAOG;IACH,SAAgB,UAAU,+JAA4B;CACtD"}

package/lib/domains/schemaBuilder.js

@@ -2,9 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { assert } from "@fluidframework/core-utils";
-import { Any, FieldKinds, normalizeField, SchemaBuilderBase, FlexFieldNodeSchema, TreeNodeSchemaBase, } from "../feature-libraries/index.js";
-import { getOrCreate } from "../util/index.js";
+import { FieldKinds, FlexFieldNodeSchema, SchemaBuilderBase, } from "../feature-libraries/index.js";
 import { leaf } from "./leafDomain.js";
 /**
  * Builds schema libraries, and the schema within them.
@@ -34,11 +32,10 @@ export class SchemaBuilder extends SchemaBuilderBase {
             ...options,
             libraries: [...(options.libraries ?? []), leaf.library],
         });
-        this.structuralTypes = new Map();
         /**
          * Define a schema for an {@link FieldKinds.optional|optional field}.
          * @remarks
-         * Shorthand or passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.
+         * Shorthand for passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.
          *
          * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:
          * therefore this method is the same as the static version.
@@ -47,7 +44,7 @@ export class SchemaBuilder extends SchemaBuilderBase {
         /**
          * Define a schema for a {@link FieldKinds.required|required field}.
          * @remarks
-         * Shorthand or passing `FieldKinds.required` to {@link FlexFieldSchema.create}.
+         * Shorthand for passing `FieldKinds.required` to {@link FlexFieldSchema.create}.
          * Note that `FieldKinds.required` is the current default field kind, so APIs accepting {@link FlexImplicitFieldSchema}
          * can be passed the `allowedTypes` and will implicitly wrap it up in a {@link FieldKinds.required|required field}.
          *
@@ -58,82 +55,40 @@ export class SchemaBuilder extends SchemaBuilderBase {
         /**
          * Define a schema for a {@link FieldKinds.sequence|sequence field}.
          * @remarks
-         * Shorthand or passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.
+         * Shorthand for passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.
          *
          * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:
          * therefore this method is the same as the static version.
          */
         this.sequence = SchemaBuilder.sequence;
         /**
-         * {@link leaf.number}
-         */
-        this.number = leaf.number;
-        /**
-         * {@link leaf.boolean}
-         */
-        this.boolean = leaf.boolean;
-        /**
-         * {@link leaf.string}
-         */
-        this.string = leaf.string;
-        /**
-         * {@link leaf.handle}
-         */
-        this.handle = leaf.handle;
-        /**
-         * {@link leaf.null}
+         * Define a schema for a {@link FieldKinds.identifier|identifier field}.
+         * @remarks
+         * Shorthand for passing `FieldKinds.identifier` to {@link TreeFieldSchema.create}.
+         *
+         * Since this creates a {@link TreeFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:
+         * therefore this method is the same as the static version.
          */
-        this.null = leaf.null;
+        this.identifier = SchemaBuilder.identifier;
     }
     objectRecursive(name, t) {
         return this.object(name, t);
     }
-    list(nameOrAllowedTypes, allowedTypes) {
-        if (allowedTypes === undefined) {
-            const types = nameOrAllowedTypes;
-            const fullName = structuralName("List", types);
-            return getOrCreate(this.structuralTypes, fullName, () => this.namedList(fullName, nameOrAllowedTypes));
-        }
-        return this.namedList(nameOrAllowedTypes, allowedTypes);
-    }
     /**
-     * Define (and add to this library) a {@link FlexFieldNodeSchema} for a {@link (TreeListNode:interface)}.
+     * Define (and add to this library) a {@link FlexFieldNodeSchema} for a {@link Sequence}.
      *
      * The name must be unique among all TreeNodeSchema in the the document schema.
-     *
-     * @privateRemarks
-     * TODO: If A custom "List" API is added as a subtype of {@link FieldNode}, this would opt into that.
      */
-    namedList(name, allowedTypes) {
+    list(name, allowedTypes) {
         const schema = FlexFieldNodeSchema.create(this, this.scoped(name), this.sequence(allowedTypes));
         this.addNodeSchema(schema);
         return schema;
     }
-    map(nameOrAllowedTypes, allowedTypes) {
-        if (allowedTypes === undefined) {
-            const types = nameOrAllowedTypes;
-            const fullName = structuralName("Map", types);
-            return getOrCreate(this.structuralTypes, fullName, () => super.map(fullName, normalizeField(nameOrAllowedTypes, FieldKinds.optional)));
-        }
-        return super.map(nameOrAllowedTypes, normalizeField(allowedTypes, FieldKinds.optional));
-    }
-    /**
-     * Function which can be used for its compile time side-effects to tweak the evaluation order of recursive types to make them compile.
-     * @remarks
-     * Some related information in https://github.com/microsoft/TypeScript/issues/55758.
-     *
-     * Also be aware that code which relies on this (or the "recursive" SchemaBuilder methods tends to break VSCode's IntelliSense every time anything related to that code (even comments) is edited.
-     * The command `TypeScript: Restart TS Server` should fix it.
-     * Sometimes this does not work: the exact cause has not been confirmed but if you have the file open multiple times (for example in both sides of a window split into two columns): closing the extra copy may help.
-     * Focusing the file with the errors before running `TypeScript: Restart TS Server` can also help.
-     * Real compile errors (for example elsewhere in the file) can also cause the IntelliSense to not work correctly ever after `TypeScript: Restart TS Server`.
-     */
-    fixRecursiveReference(...types) { }
 }
 /**
  * Define a schema for an {@link FieldKinds.optional|optional field}.
  * @remarks
- * Shorthand or passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.
+ * Shorthand for passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.
  *
  * This method is also available as an instance method on {@link SchemaBuilder}.
  */
@@ -141,7 +96,7 @@ SchemaBuilder.optional = fieldHelper(FieldKinds.optional);
 /**
  * Define a schema for a {@link FieldKinds.required|required field}.
  * @remarks
- * Shorthand or passing `FieldKinds.required` to {@link FlexFieldSchema.create}.
+ * Shorthand for passing `FieldKinds.required` to {@link FlexFieldSchema.create}.
  *
  * This method is also available as an instance method on {@link SchemaBuilder}.
  */
@@ -149,46 +104,23 @@ SchemaBuilder.required = fieldHelper(FieldKinds.required);
 /**
  * Define a schema for a {@link FieldKinds.sequence|sequence field}.
  * @remarks
- * Shorthand or passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.
+ * Shorthand for passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.
  *
  * This method is also available as an instance method on {@link SchemaBuilder}
  */
 SchemaBuilder.sequence = fieldHelper(FieldKinds.sequence);
+/**
+ * Define a schema for an {@link FieldKinds.identifier|identifier field}.
+ * @remarks
+ * Shorthand for passing `FieldKinds.identifier` to {@link TreeFieldSchema.create}.
+ *
+ * This method is also available as an instance method on {@link SchemaBuilder}
+ */
+SchemaBuilder.identifier = fieldHelper(FieldKinds.identifier);
 /**
  * Returns a wrapper around SchemaBuilder.field for a specific FieldKind.
  */
 function fieldHelper(kind) {
     return (allowedTypes) => SchemaBuilder.field(kind, allowedTypes);
 }
-export function structuralName(collectionName, allowedTypes) {
-    let inner;
-    if (allowedTypes === Any) {
-        inner = "Any";
-    }
-    else if (allowedTypes instanceof TreeNodeSchemaBase) {
-        return structuralName(collectionName, [allowedTypes]);
-    }
-    else {
-        assert(Array.isArray(allowedTypes), 0x7c7 /* Types should be an array */);
-        const names = allowedTypes.map((t) => {
-            // Ensure that lazy types (functions) don't slip through here.
-            assert(t instanceof TreeNodeSchemaBase, 0x7c8 /* invalid type provided */);
-            // Adding `as string` here would silence the linter, but make this code less type safe (since if this became not a string, it would still build).
-            // Thus we explicitly check that this satisfies string.
-            // This would best be done by appending `satisfies string`, but the linter also rejects this.
-            // Therefor introducing a variable to do the same thing as `satisfies string` but such that the linter can understand:
-            const name = t.name;
-            // Just incase the compiler and linter really are onto something and this might sometimes not be a string, validate it:
-            assert(typeof name === "string", 0x7c9 /* Name should be a string */);
-            return name;
-        });
-        // Ensure name is order independent
-        names.sort();
-        // Ensure name can't have collisions by quoting and escaping any quotes in the names of types.
-        // Using JSON is a simple way to accomplish this.
-        // The outer `[]` around the result are also needed so that a single type name "Any" would not collide with the "any" case above.
-        inner = JSON.stringify(names);
-    }
-    return `${collectionName}<${inner}>`;
-}
 //# sourceMappingURL=schemaBuilder.js.map

package/lib/domains/schemaBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemaBuilder.js","sourceRoot":"","sources":["../../src/domains/schemaBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EACN,GAAG,EAEH,UAAU,EAQV,cAAc,EACd,iBAAiB,EAKjB,mBAAmB,EAEnB,kBAAkB,GAClB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAA6B,WAAW,EAAuB,MAAM,kBAAkB,CAAC;AAC/F,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,aAGX,SAAQ,iBAA4D;IAGrE,YAAmB,OAAqC;QACvD,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE;YAC1B,GAAG,OAAO;YACV,SAAS,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;SACvD,CAAC,CAAC;QANa,oBAAe,GAAoC,IAAI,GAAG,EAAE,CAAC;QA6K9E;;;;;;;WAOG;QACa,aAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QAWlD;;;;;;;;;WASG;QACa,aAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QAWlD;;;;;;;WAOG;QACa,aAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QAElD;;WAEG;QACa,WAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAErC;;WAEG;QACa,YAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAEvC;;WAEG;QACa,WAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAErC;;WAEG;QACa,WAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAErC;;WAEG;QACa,SAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IA/OjC,CAAC;IAEe,eAAe,CAG7B,IAAU,EAAE,CAAI;QACjB,OAAO,IAAI,CAAC,MAAM,CACjB,IAAI,EACJ,CAA0E,CACf,CAAC;IAC9D,CAAC;IAuCM,IAAI,CACV,kBAEmE,EACnE,YAAgB;QAKhB,IAAI,YAAY,KAAK,SAAS,EAAE;YAC/B,MAAM,KAAK,GAAG,kBAGkB,CAAC;YACjC,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC/C,OAAO,WAAW,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,EAAE,CACvD,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,kBAAuB,CAAC,CAIjD,CAAC;SACF;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,kBAA2B,EAAE,YAAY,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACK,SAAS,CAChB,IAAU,EACV,YAAe;QAKf,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,CACxC,IAAI,EACJ,IAAI,CAAC,MAAM,CAAC,IAAoB,CAAC,EACjC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAC3B,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;IA8Be,GAAG,CAClB,kBAEmE,EACnE,YAAgB;QAEhB,IAAI,YAAY,KAAK,SAAS,EAAE;YAC/B,MAAM,KAAK,GAAG,kBAGkB,CAAC;YACjC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO,WAAW,CACjB,IAAI,CAAC,eAAe,EACpB,QAAQ,EACR,GAAG,EAAE,CACJ,KAAK,CAAC,GAAG,CACR,QAAiB,EACjB,cAAc,CAAC,kBAAuB,EAAE,UAAU,CAAC,QAAQ,CAAC,CACtC,CAIxB,CAAC;SACF;QACD,OAAO,KAAK,CAAC,GAAG,CACf,kBAA2B,EAC3B,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CACjD,CAAC;IACH,CAAC;IAsFD;;;;;;;;;;OAUG;IACI,qBAAqB,CAA6B,GAAG,KAAQ,IAAS,CAAC;;AA/F9E;;;;;;GAMG;AACW,sBAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,AAAnC,CAAoC;AAY1D;;;;;;GAMG;AACW,sBAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,AAAnC,CAAoC;AAc1D;;;;;;GAMG;AACW,sBAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,AAAnC,CAAoC;AAmD3D;;GAEG;AACH,SAAS,WAAW,CAA6B,IAAU;IAC1D,OAAO,CACN,YAAe,EACmC,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC/F,CAAC;AAED,MAAM,UAAU,cAAc,CAC7B,cAAiB,EACjB,YAAsE;IAEtE,IAAI,KAAa,CAAC;IAClB,IAAI,YAAY,KAAK,GAAG,EAAE;QACzB,KAAK,GAAG,KAAK,CAAC;KACd;SAAM,IAAI,YAAY,YAAY,kBAAkB,EAAE;QACtD,OAAO,cAAc,CAAC,cAAc,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;KACtD;SAAM;QACN,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAU,EAAE;YAC5C,8DAA8D;YAC9D,MAAM,CAAC,CAAC,YAAY,kBAAkB,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAI3E,iJAAiJ;YACjJ,uDAAuD;YACvD,6FAA6F;YAC7F,sHAAsH;YACtH,MAAM,IAAI,GAAW,CAAC,CAAC,IAAI,CAAC;YAC5B,uHAAuH;YACvH,MAAM,CAAC,OAAO,IAAI,KAAK,QAAQ,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;YACtE,OAAO,IAAI,CAAC;QACb,CAAC,CAAC,CAAC;QACH,mCAAmC;QACnC,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,8FAA8F;QAC9F,iDAAiD;QACjD,iIAAiI;QACjI,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;KAC9B;IACD,OAAO,GAAG,cAAc,IAAI,KAAK,GAAG,CAAC;AACtC,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 {\n\tAny,\n\tFlexFieldKind,\n\tFieldKinds,\n\tFlexFieldSchema,\n\tFlexImplicitAllowedTypes,\n\tNormalizeAllowedTypes,\n\tNormalizeField,\n\tSchemaBuilderOptions,\n\tFlexTreeNodeSchema,\n\tFlexMapFieldSchema,\n\tnormalizeField,\n\tSchemaBuilderBase,\n\tFlexImplicitFieldSchema,\n\tFlexObjectNodeSchema,\n\tUnenforced,\n\tFlexAllowedTypes,\n\tFlexFieldNodeSchema,\n\tFlexMapNodeSchema,\n\tTreeNodeSchemaBase,\n} from \"../feature-libraries/index.js\";\nimport { RestrictiveReadonlyRecord, getOrCreate, isAny, requireFalse } from \"../util/index.js\";\nimport { leaf } from \"./leafDomain.js\";\n\n/**\n * Builds schema libraries, and the schema within them.\n *\n * @remarks\n * Fields, when inferred from {@link FlexImplicitFieldSchema}, default to the `Required` {@link FlexFieldKind} (except for in Maps, which default to `Optional`).\n * Implicitly includes `leaf` schema library by default.\n *\n * This type has some built in defaults which impact compatibility.\n * This includes which {@link FlexFieldKind}s it uses.\n * To ensure that these defaults can be updated without compatibility issues,\n * this class is versioned: the number in its name indicates its compatibility,\n * and if its defaults are changed to ones that would not be compatible with a version of the application using the previous versions,\n * this number will be updated to make it impossible for an app to implicitly do a compatibility breaking change by updating this package.\n * Major package version updates are allowed to break API compatibility, but must not break content compatibility unless a corresponding code change is made in the app to opt in.\n *\n * @privateRemarks\n * TODO: Maybe rename to DefaultSchemaBuilder1 because of the versioning implications above.\n * Same applies to SchemaBuilder.\n * TODO: figure out a way to link `leaf` above without breaking API Extractor.\n * @sealed\n * @deprecated Users of this class should either use {@link SchemaBuilderBase} and explicitly work with {@link FlexFieldSchema}, or use SchemaFactory and work at its higher level of abstraction.\n */\nexport class SchemaBuilder<\n\tTScope extends string = string,\n\tTName extends string | number = string,\n> extends SchemaBuilderBase<TScope, typeof FieldKinds.required, TName> {\n\tprivate readonly structuralTypes: Map<string, FlexTreeNodeSchema> = new Map();\n\n\tpublic constructor(options: SchemaBuilderOptions<TScope>) {\n\t\tsuper(FieldKinds.required, {\n\t\t\t...options,\n\t\t\tlibraries: [...(options.libraries ?? []), leaf.library],\n\t\t});\n\t}\n\n\tpublic override objectRecursive<\n\t\tconst Name extends TName,\n\t\tconst T extends Unenforced<RestrictiveReadonlyRecord<string, FlexImplicitFieldSchema>>,\n\t>(name: Name, t: T) {\n\t\treturn this.object(\n\t\t\tname,\n\t\t\tt as unknown as RestrictiveReadonlyRecord<string, FlexImplicitFieldSchema>,\n\t\t) as unknown as FlexObjectNodeSchema<`${TScope}.${Name}`, T>;\n\t}\n\n\t/**\n\t * Define (and add to this library if not already present) a structurally typed {@link FlexFieldNodeSchema} for a {@link (TreeListNode:interface)}.\n\t *\n\t * @remarks\n\t * The {@link TreeNodeSchemaIdentifier} for this List is defined as a function of the provided types.\n\t * It is still scoped to this SchemaBuilder, but multiple calls with the same arguments will return the same schema object, providing somewhat structural typing.\n\t * This does not support recursive types.\n\t *\n\t * If using these structurally named lists, other types in this schema builder should avoid names of the form `List<${string}>`.\n\t *\n\t * @privateRemarks\n\t * The name produced at the type level here is not as specific as it could be, however doing type level sorting and escaping is a real mess.\n\t * There are cases where not having this full type provided will be less than ideal since TypeScript's structural types.\n\t * For example attempts to narrow unions of structural lists by name won't work.\n\t * Planned future changes to move to a class based schema system as well as factor function based node construction should mostly avoid these issues,\n\t * though there may still be some problematic cases even after that work is done.\n\t */\n\tpublic list<const T extends FlexTreeNodeSchema | Any | readonly FlexTreeNodeSchema[]>(\n\t\tallowedTypes: T,\n\t): FlexFieldNodeSchema<\n\t\t`${TScope}.List<${string}>`,\n\t\tFlexFieldSchema<typeof FieldKinds.sequence, NormalizeAllowedTypes<T>>\n\t>;\n\n\t/**\n\t * Define (and add to this library) a {@link FlexFieldNodeSchema} for a {@link (TreeListNode:interface)}.\n\t *\n\t * The name must be unique among all TreeNodeSchema in the the document schema.\n\t */\n\tpublic list<Name extends TName, const T extends FlexImplicitAllowedTypes>(\n\t\tname: Name,\n\t\tallowedTypes: T,\n\t): FlexFieldNodeSchema<\n\t\t`${TScope}.${Name}`,\n\t\tFlexFieldSchema<typeof FieldKinds.sequence, NormalizeAllowedTypes<T>>\n\t>;\n\n\tpublic list<const T extends FlexImplicitAllowedTypes>(\n\t\tnameOrAllowedTypes:\n\t\t\t| TName\n\t\t\t| ((T & FlexTreeNodeSchema) | Any | readonly FlexTreeNodeSchema[]),\n\t\tallowedTypes?: T,\n\t): FlexFieldNodeSchema<\n\t\t`${TScope}.${string}`,\n\t\tFlexFieldSchema<typeof FieldKinds.sequence, NormalizeAllowedTypes<T>>\n\t> {\n\t\tif (allowedTypes === undefined) {\n\t\t\tconst types = nameOrAllowedTypes as\n\t\t\t\t| (T & FlexTreeNodeSchema)\n\t\t\t\t| Any\n\t\t\t\t| readonly FlexTreeNodeSchema[];\n\t\t\tconst fullName = structuralName(\"List\", types);\n\t\t\treturn getOrCreate(this.structuralTypes, fullName, () =>\n\t\t\t\tthis.namedList(fullName, nameOrAllowedTypes as T),\n\t\t\t) as FlexFieldNodeSchema<\n\t\t\t\t`${TScope}.${string}`,\n\t\t\t\tFlexFieldSchema<typeof FieldKinds.sequence, NormalizeAllowedTypes<T>>\n\t\t\t>;\n\t\t}\n\t\treturn this.namedList(nameOrAllowedTypes as TName, allowedTypes);\n\t}\n\n\t/**\n\t * Define (and add to this library) a {@link FlexFieldNodeSchema} for a {@link (TreeListNode:interface)}.\n\t *\n\t * The name must be unique among all TreeNodeSchema in the the document schema.\n\t *\n\t * @privateRemarks\n\t * TODO: If A custom \"List\" API is added as a subtype of {@link FieldNode}, this would opt into that.\n\t */\n\tprivate namedList<Name extends TName | string, const T extends FlexImplicitAllowedTypes>(\n\t\tname: Name,\n\t\tallowedTypes: T,\n\t): FlexFieldNodeSchema<\n\t\t`${TScope}.${Name}`,\n\t\tFlexFieldSchema<typeof FieldKinds.sequence, NormalizeAllowedTypes<T>>\n\t> {\n\t\tconst schema = FlexFieldNodeSchema.create(\n\t\t\tthis,\n\t\t\tthis.scoped(name as TName & Name),\n\t\t\tthis.sequence(allowedTypes),\n\t\t);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Define (and add to this library if not already present) a structurally typed {@link FlexMapNodeSchema} for a {@link TreeMapNode}.\n\t *\n\t * @remarks\n\t * The {@link TreeNodeSchemaIdentifier} for this Map is defined as a function of the provided types.\n\t * It is still scoped to this SchemaBuilder, but multiple calls with the same arguments will return the same schema object, providing somewhat structural typing.\n\t * This does not support recursive types.\n\t *\n\t * If using these structurally named maps, other types in this schema builder should avoid names of the form `Map<${string}>`.\n\t *\n\t * @privateRemarks\n\t * See note on list.\n\t */\n\tpublic override map<const T extends FlexTreeNodeSchema | Any | readonly FlexTreeNodeSchema[]>(\n\t\tallowedTypes: T,\n\t): FlexMapNodeSchema<`${TScope}.Map<${string}>`, NormalizeField<T, typeof FieldKinds.optional>>;\n\n\t/**\n\t * Define (and add to this library) a {@link FlexMapNodeSchema} for a {@link TreeMapNode}.\n\t */\n\tpublic override map<\n\t\tName extends TName,\n\t\tconst T extends FlexMapFieldSchema | FlexImplicitAllowedTypes,\n\t>(\n\t\tname: Name,\n\t\tfieldSchema: T,\n\t): FlexMapNodeSchema<`${TScope}.${Name}`, NormalizeField<T, typeof FieldKinds.optional>>;\n\n\tpublic override map<const T extends FlexMapFieldSchema | FlexImplicitAllowedTypes>(\n\t\tnameOrAllowedTypes:\n\t\t\t| TName\n\t\t\t| ((T & FlexTreeNodeSchema) | Any | readonly FlexTreeNodeSchema[]),\n\t\tallowedTypes?: T,\n\t): FlexMapNodeSchema<`${TScope}.${string}`, NormalizeField<T, typeof FieldKinds.optional>> {\n\t\tif (allowedTypes === undefined) {\n\t\t\tconst types = nameOrAllowedTypes as\n\t\t\t\t| (T & FlexTreeNodeSchema)\n\t\t\t\t| Any\n\t\t\t\t| readonly FlexTreeNodeSchema[];\n\t\t\tconst fullName = structuralName(\"Map\", types);\n\t\t\treturn getOrCreate(\n\t\t\t\tthis.structuralTypes,\n\t\t\t\tfullName,\n\t\t\t\t() =>\n\t\t\t\t\tsuper.map(\n\t\t\t\t\t\tfullName as TName,\n\t\t\t\t\t\tnormalizeField(nameOrAllowedTypes as T, FieldKinds.optional),\n\t\t\t\t\t) as FlexTreeNodeSchema,\n\t\t\t) as FlexMapNodeSchema<\n\t\t\t\t`${TScope}.${string}`,\n\t\t\t\tNormalizeField<T, typeof FieldKinds.optional>\n\t\t\t>;\n\t\t}\n\t\treturn super.map(\n\t\t\tnameOrAllowedTypes as TName,\n\t\t\tnormalizeField(allowedTypes, FieldKinds.optional),\n\t\t);\n\t}\n\n\t/**\n\t * Define a schema for an {@link FieldKinds.optional|optional field}.\n\t * @remarks\n\t * Shorthand or passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.\n\t *\n\t * This method is also available as an instance method on {@link SchemaBuilder}.\n\t */\n\tpublic static optional = fieldHelper(FieldKinds.optional);\n\n\t/**\n\t * Define a schema for an {@link FieldKinds.optional|optional field}.\n\t * @remarks\n\t * Shorthand or passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.\n\t *\n\t * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:\n\t * therefore this method is the same as the static version.\n\t */\n\tpublic readonly optional = SchemaBuilder.optional;\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.required|required field}.\n\t * @remarks\n\t * Shorthand or passing `FieldKinds.required` to {@link FlexFieldSchema.create}.\n\t *\n\t * This method is also available as an instance method on {@link SchemaBuilder}.\n\t */\n\tpublic static required = fieldHelper(FieldKinds.required);\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.required|required field}.\n\t * @remarks\n\t * Shorthand or passing `FieldKinds.required` to {@link FlexFieldSchema.create}.\n\t * Note that `FieldKinds.required` is the current default field kind, so APIs accepting {@link FlexImplicitFieldSchema}\n\t * can be passed the `allowedTypes` and will implicitly wrap it up in a {@link FieldKinds.required|required field}.\n\t *\n\t * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:\n\t * therefore this method is the same as the static version.\n\t */\n\tpublic readonly required = SchemaBuilder.required;\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.sequence|sequence field}.\n\t * @remarks\n\t * Shorthand or passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.\n\t *\n\t * This method is also available as an instance method on {@link SchemaBuilder}\n\t */\n\tpublic static sequence = fieldHelper(FieldKinds.sequence);\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.sequence|sequence field}.\n\t * @remarks\n\t * Shorthand or passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.\n\t *\n\t * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:\n\t * therefore this method is the same as the static version.\n\t */\n\tpublic readonly sequence = SchemaBuilder.sequence;\n\n\t/**\n\t * {@link leaf.number}\n\t */\n\tpublic readonly number = leaf.number;\n\n\t/**\n\t * {@link leaf.boolean}\n\t */\n\tpublic readonly boolean = leaf.boolean;\n\n\t/**\n\t * {@link leaf.string}\n\t */\n\tpublic readonly string = leaf.string;\n\n\t/**\n\t * {@link leaf.handle}\n\t */\n\tpublic readonly handle = leaf.handle;\n\n\t/**\n\t * {@link leaf.null}\n\t */\n\tpublic readonly null = leaf.null;\n\n\t/**\n\t * Function which can be used for its compile time side-effects to tweak the evaluation order of recursive types to make them compile.\n\t * @remarks\n\t * Some related information in https://github.com/microsoft/TypeScript/issues/55758.\n\t *\n\t * Also be aware that code which relies on this (or the \"recursive\" SchemaBuilder methods tends to break VSCode's IntelliSense every time anything related to that code (even comments) is edited.\n\t * The command `TypeScript: Restart TS Server` should fix it.\n\t * Sometimes this does not work: the exact cause has not been confirmed but if you have the file open multiple times (for example in both sides of a window split into two columns): closing the extra copy may help.\n\t * Focusing the file with the errors before running `TypeScript: Restart TS Server` can also help.\n\t * Real compile errors (for example elsewhere in the file) can also cause the IntelliSense to not work correctly ever after `TypeScript: Restart TS Server`.\n\t */\n\tpublic fixRecursiveReference<T extends FlexAllowedTypes>(...types: T): void {}\n}\n\n/**\n * Returns a wrapper around SchemaBuilder.field for a specific FieldKind.\n */\nfunction fieldHelper<Kind extends FlexFieldKind>(kind: Kind) {\n\treturn <const T extends FlexImplicitAllowedTypes>(\n\t\tallowedTypes: T,\n\t): FlexFieldSchema<Kind, NormalizeAllowedTypes<T>> => SchemaBuilder.field(kind, allowedTypes);\n}\n\nexport function structuralName<const T extends string>(\n\tcollectionName: T,\n\tallowedTypes: FlexTreeNodeSchema | Any | readonly FlexTreeNodeSchema[],\n): `${T}<${string}>` {\n\tlet inner: string;\n\tif (allowedTypes === Any) {\n\t\tinner = \"Any\";\n\t} else if (allowedTypes instanceof TreeNodeSchemaBase) {\n\t\treturn structuralName(collectionName, [allowedTypes]);\n\t} else {\n\t\tassert(Array.isArray(allowedTypes), 0x7c7 /* Types should be an array */);\n\t\tconst names = allowedTypes.map((t): string => {\n\t\t\t// Ensure that lazy types (functions) don't slip through here.\n\t\t\tassert(t instanceof TreeNodeSchemaBase, 0x7c8 /* invalid type provided */);\n\t\t\t// TypeScript should know `t.name` is a string (from the extends constraint on TreeNodeSchema's name), but the linter objects.\n\t\t\t// @ts-expect-error: Apparently TypeScript also fails to apply this constraint for some reason and is giving any:\n\t\t\ttype _check = requireFalse<isAny<typeof t.name>>;\n\t\t\t// Adding `as string` here would silence the linter, but make this code less type safe (since if this became not a string, it would still build).\n\t\t\t// Thus we explicitly check that this satisfies string.\n\t\t\t// This would best be done by appending `satisfies string`, but the linter also rejects this.\n\t\t\t// Therefor introducing a variable to do the same thing as `satisfies string` but such that the linter can understand:\n\t\t\tconst name: string = t.name;\n\t\t\t// Just incase the compiler and linter really are onto something and this might sometimes not be a string, validate it:\n\t\t\tassert(typeof name === \"string\", 0x7c9 /* Name should be a string */);\n\t\t\treturn name;\n\t\t});\n\t\t// Ensure name is order independent\n\t\tnames.sort();\n\t\t// Ensure name can't have collisions by quoting and escaping any quotes in the names of types.\n\t\t// Using JSON is a simple way to accomplish this.\n\t\t// The outer `[]` around the result are also needed so that a single type name \"Any\" would not collide with the \"any\" case above.\n\t\tinner = JSON.stringify(names);\n\t}\n\treturn `${collectionName}<${inner}>`;\n}\n"]}
+{"version":3,"file":"schemaBuilder.js","sourceRoot":"","sources":["../../src/domains/schemaBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,UAAU,EAEV,mBAAmB,EAMnB,iBAAiB,GAGjB,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,aAGX,SAAQ,iBAA4D;IACrE,YAAmB,OAAqC;QACvD,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE;YAC1B,GAAG,OAAO;YACV,SAAS,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;SACvD,CAAC,CAAC;QA2CJ;;;;;;;WAOG;QACa,aAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QAWlD;;;;;;;;;WASG;QACa,aAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QAWlD;;;;;;;WAOG;QACa,aAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QAWlD;;;;;;;WAOG;QACa,eAAU,GAAG,aAAa,CAAC,UAAU,CAAC;IA7GtD,CAAC;IAEe,eAAe,CAG7B,IAAU,EAAE,CAAI;QACjB,OAAO,IAAI,CAAC,MAAM,CACjB,IAAI,EACJ,CAA0E,CACf,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,IAAI,CACV,IAAU,EACV,YAAe;QAKf,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,CACxC,IAAI,EACJ,IAAI,CAAC,MAAM,CAAC,IAAoB,CAAC,EACjC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAC3B,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;;AAED;;;;;;GAMG;AACW,sBAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,AAAnC,CAAoC;AAY1D;;;;;;GAMG;AACW,sBAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,AAAnC,CAAoC;AAc1D;;;;;;GAMG;AACW,sBAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,AAAnC,CAAoC;AAY1D;;;;;;GAMG;AACW,wBAAU,GAAG,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,AAArC,CAAsC;AAa/D;;GAEG;AACH,SAAS,WAAW,CAA6B,IAAU;IAC1D,OAAO,CACN,YAAe,EACmC,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC/F,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tFieldKinds,\n\tFlexFieldKind,\n\tFlexFieldNodeSchema,\n\tFlexFieldSchema,\n\tFlexImplicitAllowedTypes,\n\tFlexImplicitFieldSchema,\n\tFlexObjectNodeSchema,\n\tNormalizeAllowedTypes,\n\tSchemaBuilderBase,\n\tSchemaBuilderOptions,\n\tUnenforced,\n} from \"../feature-libraries/index.js\";\nimport { RestrictiveReadonlyRecord } from \"../util/index.js\";\n\nimport { leaf } from \"./leafDomain.js\";\n\n/**\n * Builds schema libraries, and the schema within them.\n *\n * @remarks\n * Fields, when inferred from {@link FlexImplicitFieldSchema}, default to the `Required` {@link FlexFieldKind} (except for in Maps, which default to `Optional`).\n * Implicitly includes `leaf` schema library by default.\n *\n * This type has some built in defaults which impact compatibility.\n * This includes which {@link FlexFieldKind}s it uses.\n * To ensure that these defaults can be updated without compatibility issues,\n * this class is versioned: the number in its name indicates its compatibility,\n * and if its defaults are changed to ones that would not be compatible with a version of the application using the previous versions,\n * this number will be updated to make it impossible for an app to implicitly do a compatibility breaking change by updating this package.\n * Major package version updates are allowed to break API compatibility, but must not break content compatibility unless a corresponding code change is made in the app to opt in.\n *\n * @privateRemarks\n * TODO: Maybe rename to DefaultSchemaBuilder1 because of the versioning implications above.\n * Same applies to SchemaBuilder.\n * TODO: figure out a way to link `leaf` above without breaking API Extractor.\n * @sealed\n * @deprecated Users of this class should either use {@link SchemaBuilderBase} and explicitly work with {@link FlexFieldSchema}, or use SchemaFactory and work at its higher level of abstraction.\n */\nexport class SchemaBuilder<\n\tTScope extends string = string,\n\tTName extends string | number = string,\n> extends SchemaBuilderBase<TScope, typeof FieldKinds.required, TName> {\n\tpublic constructor(options: SchemaBuilderOptions<TScope>) {\n\t\tsuper(FieldKinds.required, {\n\t\t\t...options,\n\t\t\tlibraries: [...(options.libraries ?? []), leaf.library],\n\t\t});\n\t}\n\n\tpublic override objectRecursive<\n\t\tconst Name extends TName,\n\t\tconst T extends Unenforced<RestrictiveReadonlyRecord<string, FlexImplicitFieldSchema>>,\n\t>(name: Name, t: T) {\n\t\treturn this.object(\n\t\t\tname,\n\t\t\tt as unknown as RestrictiveReadonlyRecord<string, FlexImplicitFieldSchema>,\n\t\t) as unknown as FlexObjectNodeSchema<`${TScope}.${Name}`, T>;\n\t}\n\n\t/**\n\t * Define (and add to this library) a {@link FlexFieldNodeSchema} for a {@link Sequence}.\n\t *\n\t * The name must be unique among all TreeNodeSchema in the the document schema.\n\t */\n\tpublic list<Name extends TName, const T extends FlexImplicitAllowedTypes>(\n\t\tname: Name,\n\t\tallowedTypes: T,\n\t): FlexFieldNodeSchema<\n\t\t`${TScope}.${Name}`,\n\t\tFlexFieldSchema<typeof FieldKinds.sequence, NormalizeAllowedTypes<T>>\n\t> {\n\t\tconst schema = FlexFieldNodeSchema.create(\n\t\t\tthis,\n\t\t\tthis.scoped(name as TName & Name),\n\t\t\tthis.sequence(allowedTypes),\n\t\t);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Define a schema for an {@link FieldKinds.optional|optional field}.\n\t * @remarks\n\t * Shorthand for passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.\n\t *\n\t * This method is also available as an instance method on {@link SchemaBuilder}.\n\t */\n\tpublic static optional = fieldHelper(FieldKinds.optional);\n\n\t/**\n\t * Define a schema for an {@link FieldKinds.optional|optional field}.\n\t * @remarks\n\t * Shorthand for passing `FieldKinds.optional` to {@link FlexFieldSchema.create}.\n\t *\n\t * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:\n\t * therefore this method is the same as the static version.\n\t */\n\tpublic readonly optional = SchemaBuilder.optional;\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.required|required field}.\n\t * @remarks\n\t * Shorthand for passing `FieldKinds.required` to {@link FlexFieldSchema.create}.\n\t *\n\t * This method is also available as an instance method on {@link SchemaBuilder}.\n\t */\n\tpublic static required = fieldHelper(FieldKinds.required);\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.required|required field}.\n\t * @remarks\n\t * Shorthand for passing `FieldKinds.required` to {@link FlexFieldSchema.create}.\n\t * Note that `FieldKinds.required` is the current default field kind, so APIs accepting {@link FlexImplicitFieldSchema}\n\t * can be passed the `allowedTypes` and will implicitly wrap it up in a {@link FieldKinds.required|required field}.\n\t *\n\t * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:\n\t * therefore this method is the same as the static version.\n\t */\n\tpublic readonly required = SchemaBuilder.required;\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.sequence|sequence field}.\n\t * @remarks\n\t * Shorthand for passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.\n\t *\n\t * This method is also available as an instance method on {@link SchemaBuilder}\n\t */\n\tpublic static sequence = fieldHelper(FieldKinds.sequence);\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.sequence|sequence field}.\n\t * @remarks\n\t * Shorthand for passing `FieldKinds.sequence` to {@link FlexFieldSchema.create}.\n\t *\n\t * Since this creates a {@link FlexFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:\n\t * therefore this method is the same as the static version.\n\t */\n\tpublic readonly sequence = SchemaBuilder.sequence;\n\n\t/**\n\t * Define a schema for an {@link FieldKinds.identifier|identifier field}.\n\t * @remarks\n\t * Shorthand for passing `FieldKinds.identifier` to {@link TreeFieldSchema.create}.\n\t *\n\t * This method is also available as an instance method on {@link SchemaBuilder}\n\t */\n\tpublic static identifier = fieldHelper(FieldKinds.identifier);\n\n\t/**\n\t * Define a schema for a {@link FieldKinds.identifier|identifier field}.\n\t * @remarks\n\t * Shorthand for passing `FieldKinds.identifier` to {@link TreeFieldSchema.create}.\n\t *\n\t * Since this creates a {@link TreeFieldSchema} (and not a {@link FlexTreeNodeSchema}), the resulting schema is structurally typed, and not impacted by the {@link SchemaBuilderBase.scope}:\n\t * therefore this method is the same as the static version.\n\t */\n\tpublic readonly identifier = SchemaBuilder.identifier;\n}\n\n/**\n * Returns a wrapper around SchemaBuilder.field for a specific FieldKind.\n */\nfunction fieldHelper<Kind extends FlexFieldKind>(kind: Kind) {\n\treturn <const T extends FlexImplicitAllowedTypes>(\n\t\tallowedTypes: T,\n\t): FlexFieldSchema<Kind, NormalizeAllowedTypes<T>> => SchemaBuilder.field(kind, allowedTypes);\n}\n"]}

package/lib/domains/testRecursiveDomain.d.ts

@@ -13,9 +13,5 @@ export declare const recursiveObject: import("../feature-libraries/index.js").Fl
     readonly recursive: FlexFieldSchema<import("../feature-libraries/index.js").Optional, readonly [() => import("../feature-libraries/index.js").FlexObjectNodeSchema<"Test Recursive Domain.object", any>]>;
     readonly number: import("../feature-libraries/index.js").LeafNodeSchema<"com.fluidframework.leaf.number", import("../index.js").ValueSchema.Number>;
 }>;
-export declare const recursiveObject2: import("../feature-libraries/index.js").FlexObjectNodeSchema<"Test Recursive Domain.object2", {
-    readonly recursive: FlexFieldSchema<import("../feature-libraries/index.js").Optional, readonly [() => import("../feature-libraries/index.js").FlexObjectNodeSchema<"Test Recursive Domain.object2", any>]>;
-    readonly number: FlexFieldSchema<import("../feature-libraries/index.js").Optional, readonly [import("../feature-libraries/index.js").LeafNodeSchema<"com.fluidframework.leaf.number", import("../index.js").ValueSchema.Number>]>;
-}>;
 export declare const library: import("../feature-libraries/schemaBuilderBase.js").SchemaLibrary;
 //# sourceMappingURL=testRecursiveDomain.d.ts.map

package/lib/domains/testRecursiveDomain.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testRecursiveDomain.d.ts","sourceRoot":"","sources":["../../src/domains/testRecursiveDomain.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,OAAO,EAIN,eAAe,EACf,MAAM,+BAA+B,CAAC;AAMvC,eAAO,MAAM,eAAe;;;EAG1B,CAAC;AAOH,eAAO,MAAM,gBAAgB;;;EAG3B,CAAC;AAUH,eAAO,MAAM,OAAO,mEAAwB,CAAC"}
+{"version":3,"file":"testRecursiveDomain.d.ts","sourceRoot":"","sources":["../../src/domains/testRecursiveDomain.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,OAAO,EAAc,eAAe,EAAqB,MAAM,+BAA+B,CAAC;AAM/F,eAAO,MAAM,eAAe;;;EAG1B,CAAC;AAEH,eAAO,MAAM,OAAO,mEAAwB,CAAC"}

package/lib/domains/testRecursiveDomain.js

@@ -8,20 +8,13 @@
  * Unfortunately our recursive schema types are an example of types that have this kind of issue: the d.ts files tend to get "any" instead of the recursive type reference.
  * Currently we do not have tooling in place to test this in our test suite, and exporting these types here is a temporary crutch to aid in diagnosing this issue.
  */
-import { FieldKinds, SchemaBuilderBase, FlexFieldSchema, } from "../feature-libraries/index.js";
+import { FieldKinds, FlexFieldSchema, SchemaBuilderBase } from "../feature-libraries/index.js";
 import { leaf } from "./leafDomain.js";
 const builder = new SchemaBuilderBase(FieldKinds.optional, { scope: "Test Recursive Domain" });
 export const recursiveObject = builder.objectRecursive("object", {
     recursive: FlexFieldSchema.createUnsafe(FieldKinds.optional, [() => recursiveObject]),
     number: leaf.number,
 });
-function fixRecursiveReference(...types) { }
-const recursiveReference = () => recursiveObject2;
-fixRecursiveReference(recursiveReference);
-export const recursiveObject2 = builder.object("object2", {
-    recursive: FlexFieldSchema.create(FieldKinds.optional, [recursiveReference]),
-    number: leaf.number,
-});
 export const library = builder.intoLibrary();
 {
     const b = new SchemaBuilderBase(FieldKinds.optional, { scope: "Test Recursive Domain" });

package/lib/domains/testRecursiveDomain.js.map

@@ -1 +1 @@
-{"version":3,"file":"testRecursiveDomain.js","sourceRoot":"","sources":["../../src/domains/testRecursiveDomain.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,OAAO,EAEN,UAAU,EACV,iBAAiB,EACjB,eAAe,GACf,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC,CAAC;AAE/F,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE;IAChE,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,CAAC;IACrF,MAAM,EAAE,IAAI,CAAC,MAAM;CACnB,CAAC,CAAC;AAEH,SAAS,qBAAqB,CAA6B,GAAG,KAAQ,IAAS,CAAC;AAEhF,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,gBAAgB,CAAC;AAClD,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;AAE1C,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE;IACzD,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAC5E,MAAM,EAAE,IAAI,CAAC,MAAM;CACnB,CAAC,CAAC;AAUH,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;AAE7C;IACC,MAAM,CAAC,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC,CAAC;IACzF,MAAM,IAAI,GAAG,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE;QACxC,KAAK,EAAE,eAAe,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;KACtE,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,eAAe,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACzE,wEAAwE;IACxE,uEAAuE;IACvE,oCAAoC;IACpC,gDAAgD;IAChD,sCAAsC;IACtC,uCAAuC;CACvC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This file exists and is package exported to aid in testing of exporting recursive types across package boundaries.\n * Sometimes when TypeScript generates d.ts files, they type check significantly differently than the original source (One example of this: https://github.com/microsoft/TypeScript/issues/20979).\n * Unfortunately our recursive schema types are an example of types that have this kind of issue: the d.ts files tend to get \"any\" instead of the recursive type reference.\n * Currently we do not have tooling in place to test this in our test suite, and exporting these types here is a temporary crutch to aid in diagnosing this issue.\n */\n\nimport {\n\tFlexAllowedTypes,\n\tFieldKinds,\n\tSchemaBuilderBase,\n\tFlexFieldSchema,\n} from \"../feature-libraries/index.js\";\nimport { areSafelyAssignable, isAny, requireFalse, requireTrue } from \"../util/index.js\";\nimport { leaf } from \"./leafDomain.js\";\n\nconst builder = new SchemaBuilderBase(FieldKinds.optional, { scope: \"Test Recursive Domain\" });\n\nexport const recursiveObject = builder.objectRecursive(\"object\", {\n\trecursive: FlexFieldSchema.createUnsafe(FieldKinds.optional, [() => recursiveObject]),\n\tnumber: leaf.number,\n});\n\nfunction fixRecursiveReference<T extends FlexAllowedTypes>(...types: T): void {}\n\nconst recursiveReference = () => recursiveObject2;\nfixRecursiveReference(recursiveReference);\n\nexport const recursiveObject2 = builder.object(\"object2\", {\n\trecursive: FlexFieldSchema.create(FieldKinds.optional, [recursiveReference]),\n\tnumber: leaf.number,\n});\n\ntype _0 = requireFalse<isAny<typeof recursiveObject2>>;\ntype _1 = requireTrue<\n\tareSafelyAssignable<\n\t\ttypeof recursiveObject2,\n\t\tReturnType<(typeof recursiveObject2.objectNodeFieldsObject.recursive.allowedTypes)[0]>\n\t>\n>;\n\nexport const library = builder.intoLibrary();\n\n{\n\tconst b = new SchemaBuilderBase(FieldKinds.optional, { scope: \"Test Recursive Domain\" });\n\tconst node = b.objectRecursive(\"object\", {\n\t\tchild: FlexFieldSchema.createUnsafe(FieldKinds.optional, [() => node]),\n\t});\n\tconst _field = FlexFieldSchema.createUnsafe(FieldKinds.optional, [node]);\n\t// All these cause TSC to \"RangeError: Maximum call stack size exceeded\"\n\t// const _field4 = FlexFieldSchema.create(FieldKinds.optional, [node]);\n\t// const _field2 = b.optional(node);\n\t// const _field3 = SchemaBuilder.optional(node);\n\t// const schema = b.intoSchema(field);\n\t// const schema = b.intoSchema(_field);\n}\n"]}
+{"version":3,"file":"testRecursiveDomain.js","sourceRoot":"","sources":["../../src/domains/testRecursiveDomain.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAE/F,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC,CAAC;AAE/F,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE;IAChE,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,CAAC;IACrF,MAAM,EAAE,IAAI,CAAC,MAAM;CACnB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;AAE7C;IACC,MAAM,CAAC,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC,CAAC;IACzF,MAAM,IAAI,GAAG,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE;QACxC,KAAK,EAAE,eAAe,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;KACtE,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,eAAe,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACzE,wEAAwE;IACxE,uEAAuE;IACvE,oCAAoC;IACpC,gDAAgD;IAChD,sCAAsC;IACtC,uCAAuC;CACvC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This file exists and is package exported to aid in testing of exporting recursive types across package boundaries.\n * Sometimes when TypeScript generates d.ts files, they type check significantly differently than the original source (One example of this: https://github.com/microsoft/TypeScript/issues/20979).\n * Unfortunately our recursive schema types are an example of types that have this kind of issue: the d.ts files tend to get \"any\" instead of the recursive type reference.\n * Currently we do not have tooling in place to test this in our test suite, and exporting these types here is a temporary crutch to aid in diagnosing this issue.\n */\n\nimport { FieldKinds, FlexFieldSchema, SchemaBuilderBase } from \"../feature-libraries/index.js\";\n\nimport { leaf } from \"./leafDomain.js\";\n\nconst builder = new SchemaBuilderBase(FieldKinds.optional, { scope: \"Test Recursive Domain\" });\n\nexport const recursiveObject = builder.objectRecursive(\"object\", {\n\trecursive: FlexFieldSchema.createUnsafe(FieldKinds.optional, [() => recursiveObject]),\n\tnumber: leaf.number,\n});\n\nexport const library = builder.intoLibrary();\n\n{\n\tconst b = new SchemaBuilderBase(FieldKinds.optional, { scope: \"Test Recursive Domain\" });\n\tconst node = b.objectRecursive(\"object\", {\n\t\tchild: FlexFieldSchema.createUnsafe(FieldKinds.optional, [() => node]),\n\t});\n\tconst _field = FlexFieldSchema.createUnsafe(FieldKinds.optional, [node]);\n\t// All these cause TSC to \"RangeError: Maximum call stack size exceeded\"\n\t// const _field4 = FlexFieldSchema.create(FieldKinds.optional, [node]);\n\t// const _field2 = b.optional(node);\n\t// const _field3 = SchemaBuilder.optional(node);\n\t// const schema = b.intoSchema(field);\n\t// const schema = b.intoSchema(_field);\n}\n"]}

package/lib/events/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAI9D;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,GAAG,KAAK,CAAC,SAAS,CACxF,CAAC,EAAE,MAAM,CAAC,KACN,OAAO,GACT,CAAC,GACD,KAAK,CAAC;AAET;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI;KACtB,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CAClF,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI;KACjF,CAAC,IAAI,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;CAC1D,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,GAC3B,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,GAC/B,KAAK,CAAC;AAET;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IACjD;;;;;;OAMG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC;CACxE;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IAC5C;;;;OAIG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAE/E;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EACvC,SAAS,EAAE,CAAC,EACZ,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;CACtB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,EAChD,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAClC,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAElD;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IAChD;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;IASpE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAJnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwD;IAIlF,SAAS,aAA8B,WAAW,CAAC,oCAAwB;IAE3E,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAcxF,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EACjD,SAAS,EAAE,CAAC,EACZ,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;IAarB;;;;;;;;;;OAUG;IACI,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IAK9E,OAAO,CAAC,GAAG;IAiBJ,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO;CAMzD"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAK9D;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,GAAG,KAAK,CAAC,SAAS,CACxF,CAAC,EAAE,MAAM,CAAC,KACN,OAAO,GACT,CAAC,GACD,KAAK,CAAC;AAET;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI;KACtB,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;CAClF,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI;KACjF,CAAC,IAAI,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI;CAC1D,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,GAC3B,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,GAC/B,KAAK,CAAC;AAET;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IACjD;;;;;;OAMG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC;CACxE;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IAC5C;;;;OAIG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAE/E;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EACvC,SAAS,EAAE,CAAC,EACZ,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;CACtB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,EAChD,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAClC,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAElD;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC;IAChD;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,CAAC,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;IASpE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAJnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwD;IAIlF,SAAS,aAA8B,WAAW,CAAC,oCAAwB;IAE3E,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAcxF,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EACjD,SAAS,EAAE,CAAC,EACZ,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;IAarB;;;;;;;;;;OAUG;IACI,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IAK9E,OAAO,CAAC,GAAG;IAiBJ,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO;CAMzD"}

package/lib/events/events.js

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { assert } from "@fluidframework/core-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 import { fail, getOrCreate } from "../util/index.js";
 /**
  * Create an {@link ISubscribable} that can be instructed to emit events via the {@link IEmitter} interface.

package/lib/events/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAyHrD;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC5B,WAAoC;IAEpC,OAAO,IAAI,sBAAsB,CAAI,WAAW,CAAC,CAAC;AACnD,CAAC;AAwBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,OAAO,YAAY;IAOxB,uJAAuJ;IACvJ,6FAA6F;IAC7F,YAAuC,WAAoC;QAApC,gBAAW,GAAX,WAAW,CAAyB;QAR3E,uGAAuG;QACvG,+EAA+E;QAC/E,8GAA8G;QAC9G,yEAAyE;QACxD,cAAS,GAAG,IAAI,GAAG,EAA6C,CAAC;IAIJ,CAAC;IAErE,IAAI,CAA4B,SAAY,EAAE,GAAG,IAAsB;QAChF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,MAAM,QAAQ,GAAc,IAAI,CAAC,CAAC,yGAAyG;YAC3I,qHAAqH;YACrH,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,SAAS,CAAC,EAAE;gBACtC,6EAA6E;gBAC7E,IAAI,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;oBAC5B,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC;iBACtB;aACD;SACD;IACF,CAAC;IAES,cAAc,CACvB,SAAY,EACZ,GAAG,IAAsB;QAEzB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,MAAM,QAAQ,GAAc,IAAI,CAAC;YACjC,MAAM,WAAW,GAAuB,EAAE,CAAC;YAC3C,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,MAAM,EAAE,EAAE;gBAC1C,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;aACxC;YACD,OAAO,WAAW,CAAC;SACnB;QACD,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;;;;OAUG;IACI,EAAE,CAA4B,SAAY,EAAE,QAAc;QAChE,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtE,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAEO,GAAG,CAA4B,SAAY,EAAE,QAAc;QAClE,MAAM,SAAS,GACd,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC;YAC7B,4JAA4J;YAC5J,IAAI,CACH,kFAAkF,CAClF,CAAC;QACH,MAAM,CACL,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC1B,KAAK,CAAC,uFAAuF,CAC7F,CAAC;QACF,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;YACzB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACjC,IAAI,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC;SAC9B;IACF,CAAC;IAEM,YAAY,CAAC,SAA2B;QAC9C,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC;SACjC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;CACD;AAED,sHAAsH;AACtH,MAAM,sBAA4C,SAAQ,YAAe;IACxE,YAAmB,WAAoC;QACtD,KAAK,CAAC,WAAW,CAAC,CAAC;IACpB,CAAC;IAEe,IAAI,CAA4B,SAAY,EAAE,GAAG,IAAsB;QACtF,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAEe,cAAc,CAC7B,SAAY,EACZ,GAAG,IAAsB;QAEzB,OAAO,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IEvent } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { fail, getOrCreate } from \"../util/index.js\";\n\n/**\n * Convert a union of types to an intersection of those types. Useful for `TransformEvents`.\n */\nexport type UnionToIntersection<T> = (T extends any ? (k: T) => unknown : never) extends (\n\tk: infer U,\n) => unknown\n\t? U\n\t: never;\n\n/**\n * `true` iff the given type is an acceptable shape for an event\n * @public\n */\nexport type IsEvent<Event> = Event extends (...args: any[]) => any ? true : false;\n\n/**\n * Used to specify the kinds of events emitted by an {@link ISubscribable}.\n *\n * @remarks\n *\n * Any object type is a valid {@link Events}, but only the event-like properties of that\n * type will be included.\n *\n * @example\n *\n * ```typescript\n * interface MyEvents {\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }\n * ```\n *\n * @public\n */\nexport type Events<E> = {\n\t[P in (string | symbol) & keyof E as IsEvent<E[P]> extends true ? P : never]: E[P];\n};\n\n/**\n * Converts an `Events` type (i.e. the event registry for an {@link ISubscribable}) into a type consumable\n * by an IEventProvider from `@fluidframework/core-interfaces`.\n * @param E - the `Events` type to transform\n * @param Target - an optional `IEvent` type that will be merged into the result along with the transformed `E`\n *\n * @example\n *\n * ```typescript\n * interface MyEvents {\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }\n *\n * class MySharedObject extends SharedObject<TransformEvents<MyEvents, ISharedObjectEvents>> {\n *    // ...\n * }\n * ```\n */\nexport type TransformEvents<E extends Events<E>, Target extends IEvent = IEvent> = {\n\t[P in keyof Events<E>]: (event: P, listener: E[P]) => void;\n} extends Record<any, infer Z>\n\t? UnionToIntersection<Z> & Target\n\t: never;\n\n/**\n * An object which allows the registration of listeners so that subscribers can be notified when an event happens.\n *\n * `EventEmitter` can be used as a base class to implement this via extension.\n * @param E - All the events that this emitter supports\n * @example\n * ```ts\n * type MyEventEmitter = IEventEmitter<{\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }>\n * ```\n * @privateRemarks\n * {@link createEmitter} can help implement this interface via delegation.\n *\n * @public\n */\nexport interface ISubscribable<E extends Events<E>> {\n\t/**\n\t * Register an event listener.\n\t * @param eventName - the name of the event\n\t * @param listener - the handler to run when the event is fired by the emitter\n\t * @returns a function which will deregister the listener when run. This function has undefined behavior\n\t * if called more than once.\n\t */\n\ton<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void;\n}\n\n/**\n * Interface for an event emitter that can emit typed events to subscribed listeners.\n * @internal\n */\nexport interface IEmitter<E extends Events<E>> {\n\t/**\n\t * Emits an event with the specified name and arguments, notifying all subscribers by calling their registered listener functions.\n\t * @param eventName - the name of the event to fire\n\t * @param args - the arguments passed to the event listener functions\n\t */\n\temit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void;\n\n\t/**\n\t * Emits an event with the specified name and arguments, notifying all subscribers by calling their registered listener functions.\n\t * It also collects the return values of all listeners into an array.\n\t *\n\t * Warning: This method should be used with caution. It deviates from the standard event-based integration pattern as creates substantial coupling between the emitter and its listeners.\n\t * For the majority of use-cases it is recommended to use the standard {@link IEmitter.emit} functionality.\n\t * @param eventName - the name of the event to fire\n\t * @param args - the arguments passed to the event listener functions\n\t * @returns An array of the return values of each listener, preserving the order listeners were called.\n\t */\n\temitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[];\n}\n\n/**\n * Create an {@link ISubscribable} that can be instructed to emit events via the {@link IEmitter} interface.\n *\n * A class can delegate handling {@link ISubscribable} to the returned value while using it to emit the events.\n * See also `EventEmitter` which be used as a base class to implement {@link ISubscribable} via extension.\n * @internal\n */\nexport function createEmitter<E extends Events<E>>(\n\tnoListeners?: NoListenersCallback<E>,\n): ISubscribable<E> & IEmitter<E> & HasListeners<E> {\n\treturn new ComposableEventEmitter<E>(noListeners);\n}\n\n/**\n * Called when the last listener for `eventName` is removed.\n * Useful for determining when to clean up resources related to detecting when the event might occurs.\n * @internal\n */\nexport type NoListenersCallback<E extends Events<E>> = (eventName: keyof Events<E>) => void;\n\n/**\n * @internal\n */\nexport interface HasListeners<E extends Events<E>> {\n\t/**\n\t * When no `eventName` is provided, returns true iff there are any listeners.\n\t *\n\t * When `eventName` is provided, returns true iff there are listeners for that event.\n\t *\n\t * @remarks\n\t * This can be used to know when its safe to cleanup data-structures which only exist to fire events for their listeners.\n\t */\n\thasListeners(eventName?: keyof Events<E>): boolean;\n}\n\n/**\n * Provides an API for subscribing to and listening to events.\n *\n * @remarks Classes wishing to emit events may either extend this class or compose over it.\n *\n * @example Extending this class\n *\n * ```typescript\n * interface MyEvents {\n *   \"loaded\": () => void;\n * }\n *\n * class MyClass extends EventEmitter<MyEvents> {\n *   private load() {\n *     this.emit(\"loaded\");\n *   }\n * }\n * ```\n *\n * @example Composing over this class\n *\n * ```typescript\n * class MyClass implements ISubscribable<MyEvents> {\n *   private readonly events = EventEmitter.create<MyEvents>();\n *\n *   private load() {\n *     this.events.emit(\"loaded\");\n *   }\n *\n *   public on<K extends keyof MyEvents>(eventName: K, listener: MyEvents[K]): () => void {\n *     return this.events.on(eventName, listener);\n *   }\n * }\n * ```\n */\nexport class EventEmitter<E extends Events<E>> implements ISubscribable<E>, HasListeners<E> {\n\t// TODO: because the inner data-structure here is a set, adding the same callback twice does not error,\n\t// but only calls it once, and unsubscribing will stop calling it all together.\n\t// This is surprising since it makes subscribing and unsubscribing not inverses (but instead both idempotent).\n\t// This might be desired, but if so the documentation should indicate it.\n\tprivate readonly listeners = new Map<keyof E, Set<(...args: unknown[]) => any>>();\n\n\t// Because this is protected and not public, calling this externally (not from a subclass) makes sending events to the constructed instance impossible.\n\t// Instead, use the static `create` function to get an instance which allows emitting events.\n\tprotected constructor(private readonly noListeners?: NoListenersCallback<E>) {}\n\n\tprotected emit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void {\n\t\tconst listeners = this.listeners.get(eventName);\n\t\tif (listeners !== undefined) {\n\t\t\tconst argArray: unknown[] = args; // TODO: Current TS (4.5.5) cannot spread `args` into `listener()`, but future versions (e.g. 4.8.4) can.\n\t\t\t// This explicitly copies listeners so that new listeners added during this call to emit will not receive this event.\n\t\t\tfor (const listener of [...listeners]) {\n\t\t\t\t// If listener has been unsubscribed while invoking other listeners, skip it.\n\t\t\t\tif (listeners.has(listener)) {\n\t\t\t\t\tlistener(...argArray);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tprotected emitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[] {\n\t\tconst listeners = this.listeners.get(eventName);\n\t\tif (listeners !== undefined) {\n\t\t\tconst argArray: unknown[] = args;\n\t\t\tconst resultArray: ReturnType<E[K]>[] = [];\n\t\t\tfor (const listener of listeners.values()) {\n\t\t\t\tresultArray.push(listener(...argArray));\n\t\t\t}\n\t\t\treturn resultArray;\n\t\t}\n\t\treturn [];\n\t}\n\n\t/**\n\t * Register an event listener.\n\t * @param eventName - the name of the event\n\t * @param listener - the handler to run when the event is fired by the emitter\n\t * @returns a function which will deregister the listener when run.\n\t * This function will error if called more than once.\n\t * @privateRemarks\n\t * TODO:\n\t * invoking the returned callback can error even if its only called once if the same listener was provided to two calls to \"on\".\n\t * This behavior is not documented and its unclear if its a bug or not: see note on listeners.\n\t */\n\tpublic on<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void {\n\t\tgetOrCreate(this.listeners, eventName, () => new Set()).add(listener);\n\t\treturn () => this.off(eventName, listener);\n\t}\n\n\tprivate off<K extends keyof Events<E>>(eventName: K, listener: E[K]): void {\n\t\tconst listeners =\n\t\t\tthis.listeners.get(eventName) ??\n\t\t\t// TODO: consider making this (and assert below) a usage error since it can be triggered by users of the public API: maybe separate those use cases somehow?\n\t\t\tfail(\n\t\t\t\t\"Event has no listeners. Event deregistration functions may only be invoked once.\",\n\t\t\t);\n\t\tassert(\n\t\t\tlisteners.delete(listener),\n\t\t\t0x4c1 /* Listener does not exist. Event deregistration functions may only be invoked once. */,\n\t\t);\n\t\tif (listeners.size === 0) {\n\t\t\tthis.listeners.delete(eventName);\n\t\t\tthis.noListeners?.(eventName);\n\t\t}\n\t}\n\n\tpublic hasListeners(eventName?: keyof Events<E>): boolean {\n\t\tif (eventName === undefined) {\n\t\t\treturn this.listeners.size !== 0;\n\t\t}\n\t\treturn this.listeners.has(eventName);\n\t}\n}\n\n// This class exposes the constructor and the `emit` method of `EventEmitter`, elevating them from protected to public\nclass ComposableEventEmitter<E extends Events<E>> extends EventEmitter<E> implements IEmitter<E> {\n\tpublic constructor(noListeners?: NoListenersCallback<E>) {\n\t\tsuper(noListeners);\n\t}\n\n\tpublic override emit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void {\n\t\treturn super.emit(eventName, ...args);\n\t}\n\n\tpublic override emitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[] {\n\t\treturn super.emitAndCollect(eventName, ...args);\n\t}\n}\n"]}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAyHrD;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC5B,WAAoC;IAEpC,OAAO,IAAI,sBAAsB,CAAI,WAAW,CAAC,CAAC;AACnD,CAAC;AAwBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,OAAO,YAAY;IAOxB,uJAAuJ;IACvJ,6FAA6F;IAC7F,YAAuC,WAAoC;QAApC,gBAAW,GAAX,WAAW,CAAyB;QAR3E,uGAAuG;QACvG,+EAA+E;QAC/E,8GAA8G;QAC9G,yEAAyE;QACxD,cAAS,GAAG,IAAI,GAAG,EAA6C,CAAC;IAIJ,CAAC;IAErE,IAAI,CAA4B,SAAY,EAAE,GAAG,IAAsB;QAChF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,MAAM,QAAQ,GAAc,IAAI,CAAC,CAAC,yGAAyG;YAC3I,qHAAqH;YACrH,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,SAAS,CAAC,EAAE;gBACtC,6EAA6E;gBAC7E,IAAI,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;oBAC5B,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC;iBACtB;aACD;SACD;IACF,CAAC;IAES,cAAc,CACvB,SAAY,EACZ,GAAG,IAAsB;QAEzB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,MAAM,QAAQ,GAAc,IAAI,CAAC;YACjC,MAAM,WAAW,GAAuB,EAAE,CAAC;YAC3C,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,MAAM,EAAE,EAAE;gBAC1C,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;aACxC;YACD,OAAO,WAAW,CAAC;SACnB;QACD,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;;;;;;OAUG;IACI,EAAE,CAA4B,SAAY,EAAE,QAAc;QAChE,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtE,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAEO,GAAG,CAA4B,SAAY,EAAE,QAAc;QAClE,MAAM,SAAS,GACd,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC;YAC7B,4JAA4J;YAC5J,IAAI,CACH,kFAAkF,CAClF,CAAC;QACH,MAAM,CACL,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC1B,KAAK,CAAC,uFAAuF,CAC7F,CAAC;QACF,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;YACzB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACjC,IAAI,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC;SAC9B;IACF,CAAC;IAEM,YAAY,CAAC,SAA2B;QAC9C,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC;SACjC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;CACD;AAED,sHAAsH;AACtH,MAAM,sBAA4C,SAAQ,YAAe;IACxE,YAAmB,WAAoC;QACtD,KAAK,CAAC,WAAW,CAAC,CAAC;IACpB,CAAC;IAEe,IAAI,CAA4B,SAAY,EAAE,GAAG,IAAsB;QACtF,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAEe,cAAc,CAC7B,SAAY,EACZ,GAAG,IAAsB;QAEzB,OAAO,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IEvent } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport { fail, getOrCreate } from \"../util/index.js\";\n\n/**\n * Convert a union of types to an intersection of those types. Useful for `TransformEvents`.\n */\nexport type UnionToIntersection<T> = (T extends any ? (k: T) => unknown : never) extends (\n\tk: infer U,\n) => unknown\n\t? U\n\t: never;\n\n/**\n * `true` iff the given type is an acceptable shape for an event\n * @public\n */\nexport type IsEvent<Event> = Event extends (...args: any[]) => any ? true : false;\n\n/**\n * Used to specify the kinds of events emitted by an {@link ISubscribable}.\n *\n * @remarks\n *\n * Any object type is a valid {@link Events}, but only the event-like properties of that\n * type will be included.\n *\n * @example\n *\n * ```typescript\n * interface MyEvents {\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }\n * ```\n *\n * @public\n */\nexport type Events<E> = {\n\t[P in (string | symbol) & keyof E as IsEvent<E[P]> extends true ? P : never]: E[P];\n};\n\n/**\n * Converts an `Events` type (i.e. the event registry for an {@link ISubscribable}) into a type consumable\n * by an IEventProvider from `@fluidframework/core-interfaces`.\n * @param E - the `Events` type to transform\n * @param Target - an optional `IEvent` type that will be merged into the result along with the transformed `E`\n *\n * @example\n *\n * ```typescript\n * interface MyEvents {\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }\n *\n * class MySharedObject extends SharedObject<TransformEvents<MyEvents, ISharedObjectEvents>> {\n *    // ...\n * }\n * ```\n */\nexport type TransformEvents<E extends Events<E>, Target extends IEvent = IEvent> = {\n\t[P in keyof Events<E>]: (event: P, listener: E[P]) => void;\n} extends Record<any, infer Z>\n\t? UnionToIntersection<Z> & Target\n\t: never;\n\n/**\n * An object which allows the registration of listeners so that subscribers can be notified when an event happens.\n *\n * `EventEmitter` can be used as a base class to implement this via extension.\n * @param E - All the events that this emitter supports\n * @example\n * ```ts\n * type MyEventEmitter = IEventEmitter<{\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }>\n * ```\n * @privateRemarks\n * {@link createEmitter} can help implement this interface via delegation.\n *\n * @public\n */\nexport interface ISubscribable<E extends Events<E>> {\n\t/**\n\t * Register an event listener.\n\t * @param eventName - the name of the event\n\t * @param listener - the handler to run when the event is fired by the emitter\n\t * @returns a function which will deregister the listener when run. This function has undefined behavior\n\t * if called more than once.\n\t */\n\ton<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void;\n}\n\n/**\n * Interface for an event emitter that can emit typed events to subscribed listeners.\n * @internal\n */\nexport interface IEmitter<E extends Events<E>> {\n\t/**\n\t * Emits an event with the specified name and arguments, notifying all subscribers by calling their registered listener functions.\n\t * @param eventName - the name of the event to fire\n\t * @param args - the arguments passed to the event listener functions\n\t */\n\temit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void;\n\n\t/**\n\t * Emits an event with the specified name and arguments, notifying all subscribers by calling their registered listener functions.\n\t * It also collects the return values of all listeners into an array.\n\t *\n\t * Warning: This method should be used with caution. It deviates from the standard event-based integration pattern as creates substantial coupling between the emitter and its listeners.\n\t * For the majority of use-cases it is recommended to use the standard {@link IEmitter.emit} functionality.\n\t * @param eventName - the name of the event to fire\n\t * @param args - the arguments passed to the event listener functions\n\t * @returns An array of the return values of each listener, preserving the order listeners were called.\n\t */\n\temitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[];\n}\n\n/**\n * Create an {@link ISubscribable} that can be instructed to emit events via the {@link IEmitter} interface.\n *\n * A class can delegate handling {@link ISubscribable} to the returned value while using it to emit the events.\n * See also `EventEmitter` which be used as a base class to implement {@link ISubscribable} via extension.\n * @internal\n */\nexport function createEmitter<E extends Events<E>>(\n\tnoListeners?: NoListenersCallback<E>,\n): ISubscribable<E> & IEmitter<E> & HasListeners<E> {\n\treturn new ComposableEventEmitter<E>(noListeners);\n}\n\n/**\n * Called when the last listener for `eventName` is removed.\n * Useful for determining when to clean up resources related to detecting when the event might occurs.\n * @internal\n */\nexport type NoListenersCallback<E extends Events<E>> = (eventName: keyof Events<E>) => void;\n\n/**\n * @internal\n */\nexport interface HasListeners<E extends Events<E>> {\n\t/**\n\t * When no `eventName` is provided, returns true iff there are any listeners.\n\t *\n\t * When `eventName` is provided, returns true iff there are listeners for that event.\n\t *\n\t * @remarks\n\t * This can be used to know when its safe to cleanup data-structures which only exist to fire events for their listeners.\n\t */\n\thasListeners(eventName?: keyof Events<E>): boolean;\n}\n\n/**\n * Provides an API for subscribing to and listening to events.\n *\n * @remarks Classes wishing to emit events may either extend this class or compose over it.\n *\n * @example Extending this class\n *\n * ```typescript\n * interface MyEvents {\n *   \"loaded\": () => void;\n * }\n *\n * class MyClass extends EventEmitter<MyEvents> {\n *   private load() {\n *     this.emit(\"loaded\");\n *   }\n * }\n * ```\n *\n * @example Composing over this class\n *\n * ```typescript\n * class MyClass implements ISubscribable<MyEvents> {\n *   private readonly events = EventEmitter.create<MyEvents>();\n *\n *   private load() {\n *     this.events.emit(\"loaded\");\n *   }\n *\n *   public on<K extends keyof MyEvents>(eventName: K, listener: MyEvents[K]): () => void {\n *     return this.events.on(eventName, listener);\n *   }\n * }\n * ```\n */\nexport class EventEmitter<E extends Events<E>> implements ISubscribable<E>, HasListeners<E> {\n\t// TODO: because the inner data-structure here is a set, adding the same callback twice does not error,\n\t// but only calls it once, and unsubscribing will stop calling it all together.\n\t// This is surprising since it makes subscribing and unsubscribing not inverses (but instead both idempotent).\n\t// This might be desired, but if so the documentation should indicate it.\n\tprivate readonly listeners = new Map<keyof E, Set<(...args: unknown[]) => any>>();\n\n\t// Because this is protected and not public, calling this externally (not from a subclass) makes sending events to the constructed instance impossible.\n\t// Instead, use the static `create` function to get an instance which allows emitting events.\n\tprotected constructor(private readonly noListeners?: NoListenersCallback<E>) {}\n\n\tprotected emit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void {\n\t\tconst listeners = this.listeners.get(eventName);\n\t\tif (listeners !== undefined) {\n\t\t\tconst argArray: unknown[] = args; // TODO: Current TS (4.5.5) cannot spread `args` into `listener()`, but future versions (e.g. 4.8.4) can.\n\t\t\t// This explicitly copies listeners so that new listeners added during this call to emit will not receive this event.\n\t\t\tfor (const listener of [...listeners]) {\n\t\t\t\t// If listener has been unsubscribed while invoking other listeners, skip it.\n\t\t\t\tif (listeners.has(listener)) {\n\t\t\t\t\tlistener(...argArray);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tprotected emitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[] {\n\t\tconst listeners = this.listeners.get(eventName);\n\t\tif (listeners !== undefined) {\n\t\t\tconst argArray: unknown[] = args;\n\t\t\tconst resultArray: ReturnType<E[K]>[] = [];\n\t\t\tfor (const listener of listeners.values()) {\n\t\t\t\tresultArray.push(listener(...argArray));\n\t\t\t}\n\t\t\treturn resultArray;\n\t\t}\n\t\treturn [];\n\t}\n\n\t/**\n\t * Register an event listener.\n\t * @param eventName - the name of the event\n\t * @param listener - the handler to run when the event is fired by the emitter\n\t * @returns a function which will deregister the listener when run.\n\t * This function will error if called more than once.\n\t * @privateRemarks\n\t * TODO:\n\t * invoking the returned callback can error even if its only called once if the same listener was provided to two calls to \"on\".\n\t * This behavior is not documented and its unclear if its a bug or not: see note on listeners.\n\t */\n\tpublic on<K extends keyof Events<E>>(eventName: K, listener: E[K]): () => void {\n\t\tgetOrCreate(this.listeners, eventName, () => new Set()).add(listener);\n\t\treturn () => this.off(eventName, listener);\n\t}\n\n\tprivate off<K extends keyof Events<E>>(eventName: K, listener: E[K]): void {\n\t\tconst listeners =\n\t\t\tthis.listeners.get(eventName) ??\n\t\t\t// TODO: consider making this (and assert below) a usage error since it can be triggered by users of the public API: maybe separate those use cases somehow?\n\t\t\tfail(\n\t\t\t\t\"Event has no listeners. Event deregistration functions may only be invoked once.\",\n\t\t\t);\n\t\tassert(\n\t\t\tlisteners.delete(listener),\n\t\t\t0x4c1 /* Listener does not exist. Event deregistration functions may only be invoked once. */,\n\t\t);\n\t\tif (listeners.size === 0) {\n\t\t\tthis.listeners.delete(eventName);\n\t\t\tthis.noListeners?.(eventName);\n\t\t}\n\t}\n\n\tpublic hasListeners(eventName?: keyof Events<E>): boolean {\n\t\tif (eventName === undefined) {\n\t\t\treturn this.listeners.size !== 0;\n\t\t}\n\t\treturn this.listeners.has(eventName);\n\t}\n}\n\n// This class exposes the constructor and the `emit` method of `EventEmitter`, elevating them from protected to public\nclass ComposableEventEmitter<E extends Events<E>> extends EventEmitter<E> implements IEmitter<E> {\n\tpublic constructor(noListeners?: NoListenersCallback<E>) {\n\t\tsuper(noListeners);\n\t}\n\n\tpublic override emit<K extends keyof Events<E>>(eventName: K, ...args: Parameters<E[K]>): void {\n\t\treturn super.emit(eventName, ...args);\n\t}\n\n\tpublic override emitAndCollect<K extends keyof Events<E>>(\n\t\teventName: K,\n\t\t...args: Parameters<E[K]>\n\t): ReturnType<E[K]>[] {\n\t\treturn super.emitAndCollect(eventName, ...args);\n\t}\n}\n"]}

package/lib/external-utilities/typeboxValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typeboxValidator.d.ts","sourceRoot":"","sources":["../../src/external-utilities/typeboxValidator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAO9B,CAAC"}
+{"version":3,"file":"typeboxValidator.d.ts","sourceRoot":"","sources":["../../src/external-utilities/typeboxValidator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAO9B,CAAC"}