@fluidframework/tree 2.3.0-288113 → 2.3.0

package/lib/events/events.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events/events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAyI/C;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC5B,WAA6C;IAE7C,OAAO,IAAI,sBAAsB,CAAa,WAAW,CAAC,CAAC;AAC5D,CAAC;AA2BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,OAAO,YAAY;IAQxB,uJAAuJ;IACvJ,6FAA6F;IAC7F,YAAuC,WAA6C;QAA7C,gBAAW,GAAX,WAAW,CAAkC;QAPjE,cAAS,GAAG,IAAI,GAAG,EAGnC,CAAC;IAImF,CAAC;IAE9E,IAAI,CACb,SAAY,EACZ,GAAG,IAA+B;QAElC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,4GAA4G;YAC5G,MAAM,QAAQ,GAAc,IAAI,CAAC;YAEjC,qHAAqH;YACrH,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC;gBAC9C,6EAA6E;gBAC7E,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxB,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC;gBACvB,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAES,cAAc,CACvB,SAAY,EACZ,GAAG,IAA+B;QAElC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAc,IAAI,CAAC;YACjC,MAAM,WAAW,GAAgC,EAAE,CAAC;YACpD,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;gBAChD,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;YACzC,CAAC;YACD,OAAO,WAAW,CAAC;QACpB,CAAC;QACD,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;;OAMG;IACI,EAAE,CACR,SAAY,EACZ,QAAuB;QAEvB,MAAM,GAAG,GAAQ,GAAG,EAAE;YACrB,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACvD,IAAI,gBAAgB,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC5C,IAAI,gBAAgB,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;oBACjC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBACjC,IAAI,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC;gBAC/B,CAAC;YACF,CAAC;QACF,CAAC,CAAC;QAEF,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC3E,OAAO,GAAG,CAAC;IACZ,CAAC;IAEM,YAAY,CAAC,SAA4B;QAC/C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,sBACZ,SAAQ,YAAwB;IAGhC,YAAmB,WAA6C;QAC/D,KAAK,CAAC,WAAW,CAAC,CAAC;IACpB,CAAC;IAEe,IAAI,CACnB,SAAY,EACZ,GAAG,IAA+B;QAElC,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAEe,cAAc,CAC7B,SAAY,EACZ,GAAG,IAA+B;QAElC,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 { getOrCreate } from \"../util/index.js\";\n\n/**\n * Convert a union of types to an intersection of those types. Useful for `TransformEvents`.\n * @privateRemarks\n * First an always true extends clause is used (T extends T) to distribute T into to a union of types contravariant over each member of the T union.\n * Then the constraint on the type parameter in this new context is inferred, giving the intersection.\n */\nexport type UnionToIntersection<T> = (T extends T ? (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 a {@link Listeners | event} listener\n * @public\n */\nexport type IsListener<TListener> = TListener extends (...args: any[]) => void ? true : false;\n\n/**\n * Used to specify the kinds of events emitted by a {@link Listenable}.\n *\n * @remarks\n * Any object type is a valid {@link Listeners}, but only the {@link IsListener | event-like} properties of that\n * type will be included.\n *\n * @example\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 Listeners<T extends object> = {\n\t[P in (string | symbol) & keyof T as IsListener<T[P]> extends true ? P : never]: T[P];\n};\n\n/**\n * Converts a {@link Listeners} type (i.e. the event registry for a {@link Listenable}) 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 TransformListeners<\n\tTListeners extends Listeners<TListeners>,\n\tTTarget extends IEvent = IEvent,\n> = {\n\t[P in keyof Listeners<TListeners>]: (event: P, listener: TListeners[P]) => void;\n} extends Record<string | number | symbol, infer Z>\n\t? UnionToIntersection<Z> & TTarget\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 * @param TListeners - All the {@link Listeners | events} that this subscribable supports\n *\n * @privateRemarks\n * `EventEmitter` can be used as a base class to implement this via extension.\n * ```ts\n * type MyEventEmitter = IEventEmitter<{\n *   load: (user: string, data: IUserData) => void;\n *   error: (errorCode: number) => void;\n * }>\n * ```\n * {@link createEmitter} can help implement this interface via delegation.\n *\n * @sealed @public\n */\nexport interface Listenable<TListeners extends object> {\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 {@link Off | function} which will deregister the listener when called.\n\t * This deregistration function is idempotent and therefore may be safely called more than once with no effect.\n\t * @remarks Do not register the exact same `listener` object for the same event more than once.\n\t * Doing so will result in undefined behavior, and is not guaranteed to behave the same in future versions of this library.\n\t */\n\ton<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;\n}\n\n/**\n * A function that, when called, will deregister an event listener subscription that was previously registered.\n * @remarks\n * It is returned by the {@link Listenable.on | event registration function} when event registration occurs.\n * @public\n */\nexport type Off = () => void;\n\n/**\n * Interface for an event emitter that can emit typed events to subscribed listeners.\n * @sealed @alpha\n */\nexport interface IEmitter<TListeners extends Listeners<TListeners>> {\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 Listeners<TListeners>>(\n\t\teventName: K,\n\t\t...args: Parameters<TListeners[K]>\n\t): 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 Listeners<TListeners>>(\n\t\teventName: K,\n\t\t...args: Parameters<TListeners[K]>\n\t): ReturnType<TListeners[K]>[];\n}\n\n/**\n * Create a {@link Listenable} that can be instructed to emit events via the {@link IEmitter} interface.\n *\n * A class can delegate handling {@link Listenable} 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 Listenable} via extension.\n * @alpha\n */\nexport function createEmitter<TListeners extends object>(\n\tnoListeners?: NoListenersCallback<TListeners>,\n): Listenable<TListeners> & IEmitter<TListeners> & HasListeners<TListeners> {\n\treturn new ComposableEventEmitter<TListeners>(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 * @alpha\n */\nexport type NoListenersCallback<TListeners extends object> = (\n\teventName: keyof Listeners<TListeners>,\n) => void;\n\n/**\n * Allows querying if an object has listeners.\n * @sealed @alpha\n */\nexport interface HasListeners<TListeners extends Listeners<TListeners>> {\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 Listeners<TListeners>): 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 = createEmitter<MyEvents>();\n *\n *   private load() {\n *     this.events.emit(\"loaded\");\n *   }\n *\n *   public on<K extends keyof MyEvents>(eventName: K, listener: MyEvents[K]): Off {\n *     return this.events.on(eventName, listener);\n *   }\n * }\n * ```\n * @alpha\n */\nexport class EventEmitter<TListeners extends Listeners<TListeners>>\n\timplements Listenable<TListeners>, HasListeners<TListeners>\n{\n\tprotected readonly listeners = new Map<\n\t\tkeyof TListeners,\n\t\tMap<Off, (...args: any[]) => TListeners[keyof TListeners]>\n\t>();\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<TListeners>) {}\n\n\tprotected emit<K extends keyof TListeners>(\n\t\teventName: K,\n\t\t...args: Parameters<TListeners[K]>\n\t): void {\n\t\tconst listeners = this.listeners.get(eventName);\n\t\tif (listeners !== undefined) {\n\t\t\t// Current TS (5.4.5) cannot spread `args` into `listener()`, but assigning to an array first makes it work.\n\t\t\tconst argArray: unknown[] = args;\n\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 [off, 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(off)) {\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 TListeners>(\n\t\teventName: K,\n\t\t...args: Parameters<TListeners[K]>\n\t): ReturnType<TListeners[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<TListeners[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 */\n\tpublic on<K extends keyof Listeners<TListeners>>(\n\t\teventName: K,\n\t\tlistener: TListeners[K],\n\t): Off {\n\t\tconst off: Off = () => {\n\t\t\tconst currentListeners = this.listeners.get(eventName);\n\t\t\tif (currentListeners?.delete(off) === true) {\n\t\t\t\tif (currentListeners.size === 0) {\n\t\t\t\t\tthis.listeners.delete(eventName);\n\t\t\t\t\tthis.noListeners?.(eventName);\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\n\t\tgetOrCreate(this.listeners, eventName, () => new Map()).set(off, listener);\n\t\treturn off;\n\t}\n\n\tpublic hasListeners(eventName?: keyof TListeners): 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/**\n * This class exposes the constructor and the `emit` method of `EventEmitter`, elevating them from protected to public\n */\nexport class ComposableEventEmitter<TListeners extends Listeners<TListeners>>\n\textends EventEmitter<TListeners>\n\timplements IEmitter<TListeners>\n{\n\tpublic constructor(noListeners?: NoListenersCallback<TListeners>) {\n\t\tsuper(noListeners);\n\t}\n\n\tpublic override emit<K extends keyof TListeners>(\n\t\teventName: K,\n\t\t...args: Parameters<TListeners[K]>\n\t): void {\n\t\treturn super.emit(eventName, ...args);\n\t}\n\n\tpublic override emitAndCollect<K extends keyof TListeners>(\n\t\teventName: K,\n\t\t...args: Parameters<TListeners[K]>\n\t): ReturnType<TListeners[K]>[] {\n\t\treturn super.emitAndCollect(eventName, ...args);\n\t}\n}\n"]}

package/lib/feature-libraries/schemaBuilder.d.ts

@@ -1,31 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { ValueSchema } from "../core/index.js";
-import { FieldKinds } from "./default-schema/index.js";
-import { SchemaBuilderBase, type SchemaBuilderOptions } from "./schemaBuilderBase.js";
-import { LeafNodeSchema } from "./typed-schema/index.js";
-/**
- * Extends {@link SchemaBuilderBase} with functionality only used to create built in special libraries.
- * Defaults to "required" fields.
- * @privateRemarks Should not be package exported.
- */
-export declare class SchemaBuilderInternal<TScope extends `com.fluidframework.${string}`> extends SchemaBuilderBase<TScope, typeof FieldKinds.required> {
-    constructor(options: SchemaBuilderOptions<TScope>);
-    /**
-     * Define (and add to this library) a {@link TreeNodeSchema} for a node that wraps a value.
-     * Such nodes will be implicitly unwrapped to the value in some APIs.
-     *
-     * The name must be unique among all TreeNodeSchema in the the document schema.
-     *
-     * In addition to the normal properties of all nodes (having a schema for example),
-     * Leaf nodes only contain a value.
-     * Leaf nodes cannot have fields.
-     *
-     * TODO: Maybe ban undefined from allowed values here.
-     * TODO: Decide and document how unwrapping works for non-primitive terminals.
-     */
-    leaf<Name extends string, const T extends ValueSchema>(name: Name, t: T): LeafNodeSchema<`${TScope}.${Name}`, T>;
-}
-//# sourceMappingURL=schemaBuilder.d.ts.map

package/lib/feature-libraries/schemaBuilder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaBuilder.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/schemaBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,KAAK,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;;GAIG;AACH,qBAAa,qBAAqB,CACjC,MAAM,SAAS,sBAAsB,MAAM,EAAE,CAC5C,SAAQ,iBAAiB,CAAC,MAAM,EAAE,OAAO,UAAU,CAAC,QAAQ,CAAC;gBAC3C,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAIxD;;;;;;;;;;;;OAYG;IACI,IAAI,CAAC,IAAI,SAAS,MAAM,EAAE,KAAK,CAAC,CAAC,SAAS,WAAW,EAC3D,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,cAAc,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;CAKzC"}

package/lib/feature-libraries/schemaBuilder.js

@@ -1,36 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { FieldKinds } from "./default-schema/index.js";
-import { SchemaBuilderBase } from "./schemaBuilderBase.js";
-import { LeafNodeSchema } from "./typed-schema/index.js";
-/**
- * Extends {@link SchemaBuilderBase} with functionality only used to create built in special libraries.
- * Defaults to "required" fields.
- * @privateRemarks Should not be package exported.
- */
-export class SchemaBuilderInternal extends SchemaBuilderBase {
-    constructor(options) {
-        super(FieldKinds.required, options);
-    }
-    /**
-     * Define (and add to this library) a {@link TreeNodeSchema} for a node that wraps a value.
-     * Such nodes will be implicitly unwrapped to the value in some APIs.
-     *
-     * The name must be unique among all TreeNodeSchema in the the document schema.
-     *
-     * In addition to the normal properties of all nodes (having a schema for example),
-     * Leaf nodes only contain a value.
-     * Leaf nodes cannot have fields.
-     *
-     * TODO: Maybe ban undefined from allowed values here.
-     * TODO: Decide and document how unwrapping works for non-primitive terminals.
-     */
-    leaf(name, t) {
-        const schema = LeafNodeSchema.create(this, this.scoped(name), t);
-        this.addNodeSchema(schema);
-        return schema;
-    }
-}
-//# sourceMappingURL=schemaBuilder.js.map

package/lib/feature-libraries/schemaBuilder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaBuilder.js","sourceRoot":"","sources":["../../src/feature-libraries/schemaBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAA6B,MAAM,wBAAwB,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;;GAIG;AACH,MAAM,OAAO,qBAEX,SAAQ,iBAAqD;IAC9D,YAAmB,OAAqC;QACvD,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,IAAI,CACV,IAAU,EACV,CAAI;QAEJ,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ValueSchema } from \"../core/index.js\";\n\nimport { FieldKinds } from \"./default-schema/index.js\";\nimport { SchemaBuilderBase, type SchemaBuilderOptions } from \"./schemaBuilderBase.js\";\nimport { LeafNodeSchema } from \"./typed-schema/index.js\";\n\n/**\n * Extends {@link SchemaBuilderBase} with functionality only used to create built in special libraries.\n * Defaults to \"required\" fields.\n * @privateRemarks Should not be package exported.\n */\nexport class SchemaBuilderInternal<\n\tTScope extends `com.fluidframework.${string}`,\n> extends SchemaBuilderBase<TScope, typeof FieldKinds.required> {\n\tpublic constructor(options: SchemaBuilderOptions<TScope>) {\n\t\tsuper(FieldKinds.required, options);\n\t}\n\n\t/**\n\t * Define (and add to this library) a {@link TreeNodeSchema} for a node that wraps a value.\n\t * Such nodes will be implicitly unwrapped to the value in some APIs.\n\t *\n\t * The name must be unique among all TreeNodeSchema in the the document schema.\n\t *\n\t * In addition to the normal properties of all nodes (having a schema for example),\n\t * Leaf nodes only contain a value.\n\t * Leaf nodes cannot have fields.\n\t *\n\t * TODO: Maybe ban undefined from allowed values here.\n\t * TODO: Decide and document how unwrapping works for non-primitive terminals.\n\t */\n\tpublic leaf<Name extends string, const T extends ValueSchema>(\n\t\tname: Name,\n\t\tt: T,\n\t): LeafNodeSchema<`${TScope}.${Name}`, T> {\n\t\tconst schema = LeafNodeSchema.create(this, this.scoped(name), t);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n}\n"]}

package/lib/feature-libraries/schemaBuilderBase.d.ts

@@ -1,191 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { TreeNodeSchemaIdentifier } from "../core/index.js";
-import { type Assume, type RestrictiveReadonlyRecord } from "../util/index.js";
-import type { FlexFieldKind } from "./modular-schema/index.js";
-import { Any, type FlexAllowedTypes, FlexFieldSchema, type FlexList, type FlexMapFieldSchema, FlexMapNodeSchema, FlexObjectNodeSchema, type FlexTreeNodeSchema, type FlexTreeSchema, type SchemaCollection, type SchemaLibraryData, type SchemaLintConfiguration, type Unenforced } from "./typed-schema/index.js";
-/**
- * Configuration for a SchemaBuilder.
- */
-export interface SchemaBuilderOptions<TScope extends string = string> {
-    /**
-     * Prefix appended to the identifiers of all {@link FlexTreeNodeSchema} produced by this builder.
-     * Use of [Reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation) or a UUIDv4 is recommended to avoid collisions.
-     */
-    scope: TScope;
-    /**
-     * Name used to refer to this builder in error messages.
-     * Has no impact on the actual generated schema.
-     * Defaults to scope.
-     */
-    name?: string;
-    /**
-     * Optional configuration for "linting".
-     * See {@link SchemaLintConfiguration}. Currently defaults to enabling all lints.
-     */
-    lint?: Partial<SchemaLintConfiguration>;
-    /**
-     * Libraries to include in this one.
-     *
-     * @remarks
-     * Unlike adding of individual schema, adding of libraries is idempotent.
-     * If a single library is added multiple times (even indirectly via libraries it was added into),
-     * only a single copy will be included, so they will not conflict.
-     * This allows adding any library this one depends on without risk of conflicts for users of this library.
-     * Contents within the added libraries can still conflict however.
-     * Such errors will be reported when finalizing this builder into a library or document schema.
-     */
-    libraries?: SchemaLibrary[];
-}
-/**
- * Builds schema libraries, and the schema within them.
- * *
- * @privateRemarks
- * This class does not directly depend on any specific field kinds,
- * or bake in any defaults that might have compatibility implications.
- * All use of such implicit defaults is done by subclasses, which thus get versioning implications.
- */
-export declare class SchemaBuilderBase<TScope extends string, TDefaultKind extends FlexFieldKind, TName extends number | string = string> {
-    private readonly defaultKind;
-    private readonly lintConfiguration;
-    private readonly libraries;
-    private finalized;
-    private readonly treeNodeSchema;
-    private readonly adapters;
-    /**
-     * Prefix appended to the identifiers of all {@link FlexTreeNodeSchema} produced by this builder.
-     */
-    readonly scope: TScope;
-    /**
-     * Used in error messages to identify content produced by this builder.
-     */
-    readonly name: string;
-    /**
-     * @param defaultKind - The default field kind to use when inferring a {@link FlexFieldSchema} from {@link FlexImplicitAllowedTypes}.
-     */
-    constructor(defaultKind: TDefaultKind, options: SchemaBuilderOptions<TScope>);
-    protected scoped<Name extends TName>(name: Name): TreeNodeSchemaIdentifier<`${TScope}.${Name}`>;
-    /**
-     * Adds more libraries to this one.
-     *
-     * Unlike adding of individual schema, adding of libraries is idempotent.
-     * If a single library is added multiple times (even indirectly via libraries it was added into),
-     * only a single copy will be included, so they will not conflict.
-     * This allows adding any library this one depends on without risk of conflicts for users of this library.
-     * Contents within the added libraries can still conflict however.
-     * Such errors will be reported when finalizing this builder into a library of document schema.
-     */
-    private addLibraries;
-    protected addNodeSchema<T extends FlexTreeNodeSchema>(schema: T): void;
-    private finalizeCommon;
-    /**
-     * Produce SchemaLibraries which capture the content added to this builder, as well as any additional SchemaLibraries that were added to it.
-     * May only be called once after adding content to builder is complete.
-     */
-    intoLibrary(): SchemaLibrary;
-    /**
-     * Produce a TreeSchema which captures the content added to this builder, any additional SchemaLibraries that were added to it and a root field.
-     * Can be used with schematize to provide schema aware access to document content.
-     *
-     * @remarks
-     * May only be called once after adding content to builder is complete.
-     */
-    intoSchema<const TSchema extends FlexImplicitFieldSchema>(root: TSchema): FlexTreeSchema<NormalizeField<TSchema, TDefaultKind>>;
-    /**
-     * Define (and add to this library) a {@link FlexObjectNodeSchema}.
-     *
-     * The name must be unique among all TreeNodeSchema in the the document schema.
-     */
-    object<const Name extends TName, const T extends RestrictiveReadonlyRecord<string, FlexImplicitFieldSchema>>(name: Name, t: T): FlexObjectNodeSchema<`${TScope}.${Name}`, {
-        [key in keyof T]: NormalizeField<T[key], TDefaultKind>;
-    }>;
-    /**
-     * Same as `object` but with less type safety and works for recursive objects.
-     * Reduced type safety is a side effect of a workaround for a TypeScript limitation.
-     *
-     * See {@link Unenforced} for details.
-     *
-     * TODO: Make this work with ImplicitFieldSchema.
-     */
-    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) a {@link FlexMapNodeSchema}.
-     */
-    map<Name extends TName, const T extends FlexMapFieldSchema>(name: Name, fieldSchema: T): FlexMapNodeSchema<`${TScope}.${Name}`, T>;
-    /**
-     * Same as `map` but with less type safety and works for recursive objects.
-     * Reduced type safety is a side effect of a workaround for a TypeScript limitation.
-     *
-     * See {@link Unenforced} for details.
-     *
-     * TODO: Make this work with ImplicitFieldSchema.
-     */
-    mapRecursive<Name extends TName, const T extends Unenforced<FlexMapFieldSchema>>(name: Name, t: T): FlexMapNodeSchema<`${TScope}.${Name}`, T>;
-    /**
-     * Define a {@link FlexFieldSchema}.
-     *
-     * @param kind - The [kind](https://en.wikipedia.org/wiki/Kind_(type_theory)) of this field.
-     * Determine the multiplicity, viewing and editing APIs as well as the merge resolution policy.
-     * @param allowedTypes - What types of children are allowed in this field.
-     * @returns a {@link FlexFieldSchema} which can be used as a object field (see {@link SchemaBuilderBase.object}),
-     * a map field (see {@link SchemaBuilderBase.map}), a field node (see {@link SchemaBuilderBase.fieldNode}) or the root field (see {@link SchemaBuilderBase.intoSchema}).
-     *
-     * @privateRemarks
-     * TODO:
-     * If a solution to TreeFieldSchema not being able to have extends clauses gets found,
-     * consider just having users do `new TreeFieldSchema` instead?
-     */
-    static field<Kind extends FlexFieldKind, T extends FlexImplicitAllowedTypes>(kind: Kind, allowedTypes: T): FlexFieldSchema<Kind, NormalizeAllowedTypes<T>>;
-    /**
-     * Define a schema for a field.
-     * Same as {@link SchemaBuilderBase.field} but is less type safe and supports recursive types.
-     * This API is less safe to work around a [limitation of TypeScript](https://github.com/microsoft/TypeScript/issues/55758).
-     *
-     * T must extends `AllowedTypes`: This cannot be enforced via TypeScript since such an "extends" clauses cause recursive types to error with:
-     * "'theSchema' implicitly has type 'any' because it does not have a type annotation and is referenced directly or indirectly in its own initializer."
-     *
-     * TODO: Try and find a way to provide a more specific type without triggering the above error.
-     */
-    static fieldRecursive<Kind extends FlexFieldKind, T extends FlexList<Unenforced<FlexTreeNodeSchema>>>(kind: Kind, ...allowedTypes: T): FlexFieldSchema<Kind, T>;
-    /**
-     * Normalizes an {@link FlexImplicitFieldSchema} into a {@link FlexFieldSchema} using this schema builder's `defaultKind`.
-     */
-    protected normalizeField<TSchema extends FlexImplicitFieldSchema>(schema: TSchema): NormalizeField<TSchema, TDefaultKind>;
-}
-/**
- * Schema information collected by a SchemaBuilder, including referenced libraries.
- * Can be aggregated into other libraries by adding to their builders.
- */
-export interface SchemaLibrary extends SchemaCollection {
-    /**
-     * Schema data aggregated from a collection of libraries by a SchemaBuilder.
-     */
-    readonly libraries: ReadonlySet<SchemaLibraryData>;
-}
-/**
- * Generalized version of AllowedTypes allowing for more concise expressions in some cases.
- */
-export type FlexImplicitAllowedTypes = FlexAllowedTypes | FlexTreeNodeSchema | Any;
-/**
- * Normalizes an {@link FlexImplicitAllowedTypes} into  {@link FlexAllowedTypes}.
- */
-export type NormalizeAllowedTypes<TSchema extends FlexImplicitAllowedTypes> = TSchema extends FlexTreeNodeSchema ? readonly [TSchema] : TSchema extends Any ? readonly [Any] : TSchema;
-/**
- * Normalizes an {@link FlexImplicitAllowedTypes} into  {@link FlexAllowedTypes}.
- */
-export declare function normalizeAllowedTypes<TSchema extends FlexImplicitAllowedTypes>(schema: TSchema): NormalizeAllowedTypes<TSchema>;
-/**
- * Normalizes an {@link FlexImplicitFieldSchema} into a {@link FlexFieldSchema}.
- */
-export type NormalizeField<TSchema extends FlexImplicitFieldSchema, TDefault extends FlexFieldKind> = TSchema extends FlexFieldSchema ? TSchema : FlexFieldSchema<TDefault, NormalizeAllowedTypes<Assume<TSchema, FlexImplicitAllowedTypes>>>;
-/**
- * Normalizes an {@link FlexImplicitFieldSchema} into a {@link FlexFieldSchema}.
- */
-export declare function normalizeField<TSchema extends FlexImplicitFieldSchema, TDefault extends FlexFieldKind>(schema: TSchema, defaultKind: TDefault): NormalizeField<TSchema, TDefault>;
-/**
- * Type that when combined with a default {@link FlexFieldKind} can be normalized into a {@link FlexFieldSchema}.
- */
-export type FlexImplicitFieldSchema = FlexFieldSchema | FlexImplicitAllowedTypes;
-//# sourceMappingURL=schemaBuilderBase.d.ts.map

package/lib/feature-libraries/schemaBuilderBase.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaBuilderBase.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/schemaBuilderBase.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAY,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EACN,KAAK,MAAM,EACX,KAAK,yBAAyB,EAE9B,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EACN,GAAG,EACH,KAAK,gBAAgB,EACrB,eAAe,EACf,KAAK,QAAQ,EACb,KAAK,kBAAkB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,uBAAuB,EAE5B,KAAK,UAAU,EAGf,MAAM,yBAAyB,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IACnE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAExC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,qBAAa,iBAAiB,CAC7B,MAAM,SAAS,MAAM,EACrB,YAAY,SAAS,aAAa,EAClC,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM;IAsBrC,OAAO,CAAC,QAAQ,CAAC,WAAW;IApB7B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA0B;IAC5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IACnD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CACpB;IACX,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC;;OAEG;IACH,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;gBAEe,WAAW,EAAE,YAAY,EAC1C,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAStC,SAAS,CAAC,MAAM,CAAC,IAAI,SAAS,KAAK,EAClC,IAAI,EAAE,IAAI,GACR,wBAAwB,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;IAIhD;;;;;;;;;OASG;IACH,OAAO,CAAC,YAAY;IAQpB,SAAS,CAAC,aAAa,CAAC,CAAC,SAAS,kBAAkB,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI;IAQtE,OAAO,CAAC,cAAc;IAatB;;;OAGG;IACI,WAAW,IAAI,aAAa;IAOnC;;;;;;OAMG;IACI,UAAU,CAAC,KAAK,CAAC,OAAO,SAAS,uBAAuB,EAC9D,IAAI,EAAE,OAAO,GACX,cAAc,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAcxD;;;;OAIG;IACI,MAAM,CACZ,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,yBAAyB,CAAC,MAAM,EAAE,uBAAuB,CAAC,EAE1E,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,oBAAoB,CACtB,GAAG,MAAM,IAAI,IAAI,EAAE,EACnB;SAAG,GAAG,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC;KAAE,CAC1D;IAYD;;;;;;;OAOG;IACI,eAAe,CACrB,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,GAAG,oBAAoB,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAOjE;;OAEG;IACI,GAAG,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAChE,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,CAAC,GACZ,iBAAiB,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAM5C;;;;;;;OAOG;IACI,YAAY,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,kBAAkB,CAAC,EACrF,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,iBAAiB,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAO5C;;;;;;;;;;;;;OAaG;WACW,KAAK,CAAC,IAAI,SAAS,aAAa,EAAE,CAAC,SAAS,wBAAwB,EACjF,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,eAAe,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAIlD;;;;;;;;;OASG;WACW,cAAc,CAC3B,IAAI,SAAS,aAAa,EAE1B,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,EACjD,IAAI,EAAE,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC;IAI3D;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,SAAS,uBAAuB,EAC/D,MAAM,EAAE,OAAO,GACb,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC;CAGxC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACtD;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,iBAAiB,CAAC,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,GAAG,CAAC;AAEnF;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,wBAAwB,IACzE,OAAO,SAAS,kBAAkB,GAC/B,SAAS,CAAC,OAAO,CAAC,GAClB,OAAO,SAAS,GAAG,GAClB,SAAS,CAAC,GAAG,CAAC,GACd,OAAO,CAAC;AAEb;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,SAAS,wBAAwB,EAC7E,MAAM,EAAE,OAAO,GACb,qBAAqB,CAAC,OAAO,CAAC,CAShC;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CACzB,OAAO,SAAS,uBAAuB,EACvC,QAAQ,SAAS,aAAa,IAC3B,OAAO,SAAS,eAAe,GAChC,OAAO,GACP,eAAe,CACf,QAAQ,EACR,qBAAqB,CAAC,MAAM,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAChE,CAAC;AAEJ;;GAEG;AACH,wBAAgB,cAAc,CAC7B,OAAO,SAAS,uBAAuB,EACvC,QAAQ,SAAS,aAAa,EAC7B,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAS3E;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,eAAe,GAAG,wBAAwB,CAAC"}

package/lib/feature-libraries/schemaBuilderBase.js

@@ -1,195 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { assert } from "@fluidframework/core-utils/internal";
-import { transformObjectMap, } from "../util/index.js";
-import { defaultSchemaPolicy } from "./default-schema/index.js";
-import { Any, FlexFieldSchema, FlexMapNodeSchema, FlexObjectNodeSchema, TreeNodeSchemaBase, aggregateSchemaLibraries, schemaLintDefault, } from "./typed-schema/index.js";
-/**
- * Builds schema libraries, and the schema within them.
- * *
- * @privateRemarks
- * This class does not directly depend on any specific field kinds,
- * or bake in any defaults that might have compatibility implications.
- * All use of such implicit defaults is done by subclasses, which thus get versioning implications.
- */
-export class SchemaBuilderBase {
-    /**
-     * @param defaultKind - The default field kind to use when inferring a {@link FlexFieldSchema} from {@link FlexImplicitAllowedTypes}.
-     */
-    constructor(defaultKind, options) {
-        this.defaultKind = defaultKind;
-        this.finalized = false;
-        this.treeNodeSchema = new Map();
-        this.adapters = {};
-        this.name = options.name ?? options.scope;
-        this.lintConfiguration = { ...schemaLintDefault, ...options.lint };
-        this.libraries = new Set();
-        this.addLibraries(...(options.libraries ?? []));
-        this.scope = options.scope;
-    }
-    scoped(name) {
-        return `${this.scope}.${name}`;
-    }
-    /**
-     * Adds more libraries to this one.
-     *
-     * Unlike adding of individual schema, adding of libraries is idempotent.
-     * If a single library is added multiple times (even indirectly via libraries it was added into),
-     * only a single copy will be included, so they will not conflict.
-     * This allows adding any library this one depends on without risk of conflicts for users of this library.
-     * Contents within the added libraries can still conflict however.
-     * Such errors will be reported when finalizing this builder into a library of document schema.
-     */
-    addLibraries(...libraries) {
-        for (const libs of libraries) {
-            for (const lib of libs.libraries) {
-                this.libraries.add(lib);
-            }
-        }
-    }
-    addNodeSchema(schema) {
-        assert(!this.treeNodeSchema.has(schema.name), 0x799 /* Conflicting TreeNodeSchema names */);
-        this.treeNodeSchema.set(schema.name, schema);
-    }
-    finalizeCommon(field) {
-        assert(!this.finalized, 0x79a /* SchemaBuilder can only be finalized once. */);
-        this.finalized = true;
-        this.libraries.add({
-            name: this.name,
-            nodeSchema: this.treeNodeSchema,
-            adapters: this.adapters,
-        });
-        // Check for errors and aggregate data
-        return aggregateSchemaLibraries(this.name, this.lintConfiguration, this.libraries, field);
-    }
-    /**
-     * Produce SchemaLibraries which capture the content added to this builder, as well as any additional SchemaLibraries that were added to it.
-     * May only be called once after adding content to builder is complete.
-     */
-    intoLibrary() {
-        const aggregated = this.finalizeCommon();
-        // Full library set (instead of just aggregated) is kept since it is required to handle deduplication of libraries included through different paths.
-        return { nodeSchema: aggregated.nodeSchema, libraries: this.libraries };
-    }
-    /**
-     * Produce a TreeSchema which captures the content added to this builder, any additional SchemaLibraries that were added to it and a root field.
-     * Can be used with schematize to provide schema aware access to document content.
-     *
-     * @remarks
-     * May only be called once after adding content to builder is complete.
-     */
-    intoSchema(root) {
-        // return this.toDocumentSchemaInternal(normalizeField(root, DefaultFieldKind));
-        const field = this.normalizeField(root);
-        const library = this.finalizeCommon(field);
-        const typed = {
-            nodeSchema: library.nodeSchema,
-            adapters: library.adapters,
-            rootFieldSchema: field,
-            policy: defaultSchemaPolicy,
-        };
-        return typed;
-    }
-    /**
-     * Define (and add to this library) a {@link FlexObjectNodeSchema}.
-     *
-     * The name must be unique among all TreeNodeSchema in the the document schema.
-     */
-    object(name, t) {
-        const schema = FlexObjectNodeSchema.create(this, this.scoped(name), transformObjectMap(t, (field) => this.normalizeField(field)));
-        this.addNodeSchema(schema);
-        return schema;
-    }
-    /**
-     * Same as `object` but with less type safety and works for recursive objects.
-     * Reduced type safety is a side effect of a workaround for a TypeScript limitation.
-     *
-     * See {@link Unenforced} for details.
-     *
-     * TODO: Make this work with ImplicitFieldSchema.
-     */
-    objectRecursive(name, t) {
-        return this.object(name, t);
-    }
-    /**
-     * Define (and add to this library) a {@link FlexMapNodeSchema}.
-     */
-    map(name, fieldSchema) {
-        const schema = FlexMapNodeSchema.create(this, this.scoped(name), fieldSchema);
-        this.addNodeSchema(schema);
-        return schema;
-    }
-    /**
-     * Same as `map` but with less type safety and works for recursive objects.
-     * Reduced type safety is a side effect of a workaround for a TypeScript limitation.
-     *
-     * See {@link Unenforced} for details.
-     *
-     * TODO: Make this work with ImplicitFieldSchema.
-     */
-    mapRecursive(name, t) {
-        return this.map(name, t);
-    }
-    /**
-     * Define a {@link FlexFieldSchema}.
-     *
-     * @param kind - The [kind](https://en.wikipedia.org/wiki/Kind_(type_theory)) of this field.
-     * Determine the multiplicity, viewing and editing APIs as well as the merge resolution policy.
-     * @param allowedTypes - What types of children are allowed in this field.
-     * @returns a {@link FlexFieldSchema} which can be used as a object field (see {@link SchemaBuilderBase.object}),
-     * a map field (see {@link SchemaBuilderBase.map}), a field node (see {@link SchemaBuilderBase.fieldNode}) or the root field (see {@link SchemaBuilderBase.intoSchema}).
-     *
-     * @privateRemarks
-     * TODO:
-     * If a solution to TreeFieldSchema not being able to have extends clauses gets found,
-     * consider just having users do `new TreeFieldSchema` instead?
-     */
-    static field(kind, allowedTypes) {
-        return FlexFieldSchema.create(kind, normalizeAllowedTypes(allowedTypes));
-    }
-    /**
-     * Define a schema for a field.
-     * Same as {@link SchemaBuilderBase.field} but is less type safe and supports recursive types.
-     * This API is less safe to work around a [limitation of TypeScript](https://github.com/microsoft/TypeScript/issues/55758).
-     *
-     * T must extends `AllowedTypes`: This cannot be enforced via TypeScript since such an "extends" clauses cause recursive types to error with:
-     * "'theSchema' implicitly has type 'any' because it does not have a type annotation and is referenced directly or indirectly in its own initializer."
-     *
-     * TODO: Try and find a way to provide a more specific type without triggering the above error.
-     */
-    static fieldRecursive(kind, ...allowedTypes) {
-        return FlexFieldSchema.createUnsafe(kind, allowedTypes);
-    }
-    /**
-     * Normalizes an {@link FlexImplicitFieldSchema} into a {@link FlexFieldSchema} using this schema builder's `defaultKind`.
-     */
-    normalizeField(schema) {
-        return normalizeField(schema, this.defaultKind);
-    }
-}
-/**
- * Normalizes an {@link FlexImplicitAllowedTypes} into  {@link FlexAllowedTypes}.
- */
-export function normalizeAllowedTypes(schema) {
-    if (schema === Any) {
-        return [Any];
-    }
-    if (schema instanceof TreeNodeSchemaBase) {
-        return [schema];
-    }
-    assert(Array.isArray(schema), 0x7c6 /* invalid ImplicitAllowedTypes */);
-    return schema;
-}
-/**
- * Normalizes an {@link FlexImplicitFieldSchema} into a {@link FlexFieldSchema}.
- */
-export function normalizeField(schema, defaultKind) {
-    if (schema instanceof FlexFieldSchema) {
-        return schema;
-    }
-    const allowedTypes = normalizeAllowedTypes(schema);
-    return FlexFieldSchema.create(defaultKind, allowedTypes);
-}
-//# sourceMappingURL=schemaBuilderBase.js.map

package/lib/feature-libraries/schemaBuilderBase.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaBuilderBase.js","sourceRoot":"","sources":["../../src/feature-libraries/schemaBuilderBase.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAG7D,OAAO,EAGN,kBAAkB,GAClB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EACN,GAAG,EAEH,eAAe,EAGf,iBAAiB,EACjB,oBAAoB,EAMpB,kBAAkB,EAElB,wBAAwB,EACxB,iBAAiB,GACjB,MAAM,yBAAyB,CAAC;AAuCjC;;;;;;;GAOG;AACH,MAAM,OAAO,iBAAiB;IAqB7B;;OAEG;IACH,YACkB,WAAyB,EAC1C,OAAqC;QADpB,gBAAW,GAAX,WAAW,CAAc;QAlBnC,cAAS,GAAY,KAAK,CAAC;QAClB,mBAAc,GAC9B,IAAI,GAAG,EAAE,CAAC;QACM,aAAQ,GAAa,EAAE,CAAC;QAkBxC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QACnE,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;IAES,MAAM,CACf,IAAU;QAEV,OAAO,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,EAAmD,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACK,YAAY,CAAC,GAAG,SAA0B;QACjD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBAClC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;QACF,CAAC;IACF,CAAC;IAES,aAAa,CAA+B,MAAS;QAC9D,MAAM,CACL,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EACrC,KAAK,CAAC,sCAAsC,CAC5C,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAEO,cAAc,CAAC,KAAuB;QAC7C,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC/E,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;YAClB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,UAAU,EAAE,IAAI,CAAC,cAAc;YAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC,CAAC;QAEH,sCAAsC;QACtC,OAAO,wBAAwB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACI,WAAW;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEzC,oJAAoJ;QACpJ,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAChB,IAAa;QAEb,gFAAgF;QAChF,MAAM,KAAK,GAA0C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC/E,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE3C,MAAM,KAAK,GAA0D;YACpE,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,eAAe,EAAE,KAAK;YACtB,MAAM,EAAE,mBAAmB;SAC3B,CAAC;QACF,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAIZ,IAAU,EACV,CAAI;QAKJ,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,CACzC,IAAI,EACJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EACjB,kBAAkB,CAAC,CAAC,EAAE,CAAC,KAAK,EAAmB,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAE3E,CACD,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAGpB,IAAU,EAAE,CAAI;QACjB,OAAO,IAAI,CAAC,MAAM,CACjB,IAAI,EACJ,CAA0E,CACf,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,GAAG,CACT,IAAU,EACV,WAAc;QAEd,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC;QAC9E,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CAClB,IAAU,EACV,CAAI;QAEJ,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAuB,CAG5C,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,KAAK,CAClB,IAAU,EACV,YAAe;QAEf,OAAO,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,cAAc,CAI1B,IAAU,EAAE,GAAG,YAAe;QAC/B,OAAO,eAAe,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACO,cAAc,CACvB,MAAe;QAEf,OAAO,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;CACD;AA4BD;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACpC,MAAe;IAEf,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAA8C,CAAC;IAC3D,CAAC;IACD,IAAI,MAAM,YAAY,kBAAkB,EAAE,CAAC;QAC1C,OAAO,CAAC,MAAM,CAA8C,CAAC;IAC9D,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACxE,OAAO,MAAmD,CAAC;AAC5D,CAAC;AAeD;;GAEG;AACH,MAAM,UAAU,cAAc,CAG5B,MAAe,EAAE,WAAqB;IACvC,IAAI,MAAM,YAAY,eAAe,EAAE,CAAC;QACvC,OAAO,MAA2C,CAAC;IACpD,CAAC;IACD,MAAM,YAAY,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACnD,OAAO,eAAe,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAGtD,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport type { Adapters, TreeNodeSchemaIdentifier } from \"../core/index.js\";\nimport {\n\ttype Assume,\n\ttype RestrictiveReadonlyRecord,\n\ttransformObjectMap,\n} from \"../util/index.js\";\n\nimport { defaultSchemaPolicy } from \"./default-schema/index.js\";\nimport type { FlexFieldKind } from \"./modular-schema/index.js\";\nimport {\n\tAny,\n\ttype FlexAllowedTypes,\n\tFlexFieldSchema,\n\ttype FlexList,\n\ttype FlexMapFieldSchema,\n\tFlexMapNodeSchema,\n\tFlexObjectNodeSchema,\n\ttype FlexTreeNodeSchema,\n\ttype FlexTreeSchema,\n\ttype SchemaCollection,\n\ttype SchemaLibraryData,\n\ttype SchemaLintConfiguration,\n\tTreeNodeSchemaBase,\n\ttype Unenforced,\n\taggregateSchemaLibraries,\n\tschemaLintDefault,\n} from \"./typed-schema/index.js\";\n\n/**\n * Configuration for a SchemaBuilder.\n */\nexport interface SchemaBuilderOptions<TScope extends string = string> {\n\t/**\n\t * Prefix appended to the identifiers of all {@link FlexTreeNodeSchema} produced by this builder.\n\t * Use of [Reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation) or a UUIDv4 is recommended to avoid collisions.\n\t */\n\tscope: TScope;\n\n\t/**\n\t * Name used to refer to this builder in error messages.\n\t * Has no impact on the actual generated schema.\n\t * Defaults to scope.\n\t */\n\tname?: string;\n\n\t/**\n\t * Optional configuration for \"linting\".\n\t * See {@link SchemaLintConfiguration}. Currently defaults to enabling all lints.\n\t */\n\tlint?: Partial<SchemaLintConfiguration>;\n\n\t/**\n\t * Libraries to include in this one.\n\t *\n\t * @remarks\n\t * Unlike adding of individual schema, adding of libraries is idempotent.\n\t * If a single library is added multiple times (even indirectly via libraries it was added into),\n\t * only a single copy will be included, so they will not conflict.\n\t * This allows adding any library this one depends on without risk of conflicts for users of this library.\n\t * Contents within the added libraries can still conflict however.\n\t * Such errors will be reported when finalizing this builder into a library or document schema.\n\t */\n\tlibraries?: SchemaLibrary[];\n}\n\n/**\n * Builds schema libraries, and the schema within them.\n * *\n * @privateRemarks\n * This class does not directly depend on any specific field kinds,\n * or bake in any defaults that might have compatibility implications.\n * All use of such implicit defaults is done by subclasses, which thus get versioning implications.\n */\nexport class SchemaBuilderBase<\n\tTScope extends string,\n\tTDefaultKind extends FlexFieldKind,\n\tTName extends number | string = string,\n> {\n\tprivate readonly lintConfiguration: SchemaLintConfiguration;\n\tprivate readonly libraries: Set<SchemaLibraryData>;\n\tprivate finalized: boolean = false;\n\tprivate readonly treeNodeSchema: Map<TreeNodeSchemaIdentifier, FlexTreeNodeSchema> =\n\t\tnew Map();\n\tprivate readonly adapters: Adapters = {};\n\t/**\n\t * Prefix appended to the identifiers of all {@link FlexTreeNodeSchema} produced by this builder.\n\t */\n\tpublic readonly scope: TScope;\n\n\t/**\n\t * Used in error messages to identify content produced by this builder.\n\t */\n\tpublic readonly name: string;\n\n\t/**\n\t * @param defaultKind - The default field kind to use when inferring a {@link FlexFieldSchema} from {@link FlexImplicitAllowedTypes}.\n\t */\n\tpublic constructor(\n\t\tprivate readonly defaultKind: TDefaultKind,\n\t\toptions: SchemaBuilderOptions<TScope>,\n\t) {\n\t\tthis.name = options.name ?? options.scope;\n\t\tthis.lintConfiguration = { ...schemaLintDefault, ...options.lint };\n\t\tthis.libraries = new Set();\n\t\tthis.addLibraries(...(options.libraries ?? []));\n\t\tthis.scope = options.scope;\n\t}\n\n\tprotected scoped<Name extends TName>(\n\t\tname: Name,\n\t): TreeNodeSchemaIdentifier<`${TScope}.${Name}`> {\n\t\treturn `${this.scope}.${name}` as TreeNodeSchemaIdentifier<`${TScope}.${Name}`>;\n\t}\n\n\t/**\n\t * Adds more libraries to this one.\n\t *\n\t * Unlike adding of individual schema, adding of libraries is idempotent.\n\t * If a single library is added multiple times (even indirectly via libraries it was added into),\n\t * only a single copy will be included, so they will not conflict.\n\t * This allows adding any library this one depends on without risk of conflicts for users of this library.\n\t * Contents within the added libraries can still conflict however.\n\t * Such errors will be reported when finalizing this builder into a library of document schema.\n\t */\n\tprivate addLibraries(...libraries: SchemaLibrary[]): void {\n\t\tfor (const libs of libraries) {\n\t\t\tfor (const lib of libs.libraries) {\n\t\t\t\tthis.libraries.add(lib);\n\t\t\t}\n\t\t}\n\t}\n\n\tprotected addNodeSchema<T extends FlexTreeNodeSchema>(schema: T): void {\n\t\tassert(\n\t\t\t!this.treeNodeSchema.has(schema.name),\n\t\t\t0x799 /* Conflicting TreeNodeSchema names */,\n\t\t);\n\t\tthis.treeNodeSchema.set(schema.name, schema);\n\t}\n\n\tprivate finalizeCommon(field?: FlexFieldSchema): SchemaLibraryData {\n\t\tassert(!this.finalized, 0x79a /* SchemaBuilder can only be finalized once. */);\n\t\tthis.finalized = true;\n\t\tthis.libraries.add({\n\t\t\tname: this.name,\n\t\t\tnodeSchema: this.treeNodeSchema,\n\t\t\tadapters: this.adapters,\n\t\t});\n\n\t\t// Check for errors and aggregate data\n\t\treturn aggregateSchemaLibraries(this.name, this.lintConfiguration, this.libraries, field);\n\t}\n\n\t/**\n\t * Produce SchemaLibraries which capture the content added to this builder, as well as any additional SchemaLibraries that were added to it.\n\t * May only be called once after adding content to builder is complete.\n\t */\n\tpublic intoLibrary(): SchemaLibrary {\n\t\tconst aggregated = this.finalizeCommon();\n\n\t\t// Full library set (instead of just aggregated) is kept since it is required to handle deduplication of libraries included through different paths.\n\t\treturn { nodeSchema: aggregated.nodeSchema, libraries: this.libraries };\n\t}\n\n\t/**\n\t * Produce a TreeSchema which captures the content added to this builder, any additional SchemaLibraries that were added to it and a root field.\n\t * Can be used with schematize to provide schema aware access to document content.\n\t *\n\t * @remarks\n\t * May only be called once after adding content to builder is complete.\n\t */\n\tpublic intoSchema<const TSchema extends FlexImplicitFieldSchema>(\n\t\troot: TSchema,\n\t): FlexTreeSchema<NormalizeField<TSchema, TDefaultKind>> {\n\t\t// return this.toDocumentSchemaInternal(normalizeField(root, DefaultFieldKind));\n\t\tconst field: NormalizeField<TSchema, TDefaultKind> = this.normalizeField(root);\n\t\tconst library = this.finalizeCommon(field);\n\n\t\tconst typed: FlexTreeSchema<NormalizeField<TSchema, TDefaultKind>> = {\n\t\t\tnodeSchema: library.nodeSchema,\n\t\t\tadapters: library.adapters,\n\t\t\trootFieldSchema: field,\n\t\t\tpolicy: defaultSchemaPolicy,\n\t\t};\n\t\treturn typed;\n\t}\n\n\t/**\n\t * Define (and add to this library) a {@link FlexObjectNodeSchema}.\n\t *\n\t * The name must be unique among all TreeNodeSchema in the the document schema.\n\t */\n\tpublic object<\n\t\tconst Name extends TName,\n\t\tconst T extends RestrictiveReadonlyRecord<string, FlexImplicitFieldSchema>,\n\t>(\n\t\tname: Name,\n\t\tt: T,\n\t): FlexObjectNodeSchema<\n\t\t`${TScope}.${Name}`,\n\t\t{ [key in keyof T]: NormalizeField<T[key], TDefaultKind> }\n\t> {\n\t\tconst schema = FlexObjectNodeSchema.create(\n\t\t\tthis,\n\t\t\tthis.scoped(name),\n\t\t\ttransformObjectMap(t, (field): FlexFieldSchema => this.normalizeField(field)) as {\n\t\t\t\t[key in keyof T]: NormalizeField<T[key], TDefaultKind>;\n\t\t\t},\n\t\t);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Same as `object` but with less type safety and works for recursive objects.\n\t * Reduced type safety is a side effect of a workaround for a TypeScript limitation.\n\t *\n\t * See {@link Unenforced} for details.\n\t *\n\t * TODO: Make this work with ImplicitFieldSchema.\n\t */\n\tpublic objectRecursive<\n\t\tconst Name extends TName,\n\t\tconst T extends Unenforced<RestrictiveReadonlyRecord<string, FlexImplicitFieldSchema>>,\n\t>(name: Name, t: T): FlexObjectNodeSchema<`${TScope}.${Name}`, 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 FlexMapNodeSchema}.\n\t */\n\tpublic map<Name extends TName, const T extends FlexMapFieldSchema>(\n\t\tname: Name,\n\t\tfieldSchema: T,\n\t): FlexMapNodeSchema<`${TScope}.${Name}`, T> {\n\t\tconst schema = FlexMapNodeSchema.create(this, this.scoped(name), fieldSchema);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Same as `map` but with less type safety and works for recursive objects.\n\t * Reduced type safety is a side effect of a workaround for a TypeScript limitation.\n\t *\n\t * See {@link Unenforced} for details.\n\t *\n\t * TODO: Make this work with ImplicitFieldSchema.\n\t */\n\tpublic mapRecursive<Name extends TName, const T extends Unenforced<FlexMapFieldSchema>>(\n\t\tname: Name,\n\t\tt: T,\n\t): FlexMapNodeSchema<`${TScope}.${Name}`, T> {\n\t\treturn this.map(name, t as FlexMapFieldSchema) as FlexMapNodeSchema<\n\t\t\t`${TScope}.${Name}`,\n\t\t\tT\n\t\t>;\n\t}\n\n\t/**\n\t * Define a {@link FlexFieldSchema}.\n\t *\n\t * @param kind - The [kind](https://en.wikipedia.org/wiki/Kind_(type_theory)) of this field.\n\t * Determine the multiplicity, viewing and editing APIs as well as the merge resolution policy.\n\t * @param allowedTypes - What types of children are allowed in this field.\n\t * @returns a {@link FlexFieldSchema} which can be used as a object field (see {@link SchemaBuilderBase.object}),\n\t * a map field (see {@link SchemaBuilderBase.map}), a field node (see {@link SchemaBuilderBase.fieldNode}) or the root field (see {@link SchemaBuilderBase.intoSchema}).\n\t *\n\t * @privateRemarks\n\t * TODO:\n\t * If a solution to TreeFieldSchema not being able to have extends clauses gets found,\n\t * consider just having users do `new TreeFieldSchema` instead?\n\t */\n\tpublic static field<Kind extends FlexFieldKind, T extends FlexImplicitAllowedTypes>(\n\t\tkind: Kind,\n\t\tallowedTypes: T,\n\t): FlexFieldSchema<Kind, NormalizeAllowedTypes<T>> {\n\t\treturn FlexFieldSchema.create(kind, normalizeAllowedTypes(allowedTypes));\n\t}\n\n\t/**\n\t * Define a schema for a field.\n\t * Same as {@link SchemaBuilderBase.field} but is less type safe and supports recursive types.\n\t * This API is less safe to work around a [limitation of TypeScript](https://github.com/microsoft/TypeScript/issues/55758).\n\t *\n\t * T must extends `AllowedTypes`: This cannot be enforced via TypeScript since such an \"extends\" clauses cause recursive types to error with:\n\t * \"'theSchema' implicitly has type 'any' because it does not have a type annotation and is referenced directly or indirectly in its own initializer.\"\n\t *\n\t * TODO: Try and find a way to provide a more specific type without triggering the above error.\n\t */\n\tpublic static fieldRecursive<\n\t\tKind extends FlexFieldKind,\n\t\t// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n\t\tT extends FlexList<Unenforced<FlexTreeNodeSchema>>,\n\t>(kind: Kind, ...allowedTypes: T): FlexFieldSchema<Kind, T> {\n\t\treturn FlexFieldSchema.createUnsafe(kind, allowedTypes);\n\t}\n\n\t/**\n\t * Normalizes an {@link FlexImplicitFieldSchema} into a {@link FlexFieldSchema} using this schema builder's `defaultKind`.\n\t */\n\tprotected normalizeField<TSchema extends FlexImplicitFieldSchema>(\n\t\tschema: TSchema,\n\t): NormalizeField<TSchema, TDefaultKind> {\n\t\treturn normalizeField(schema, this.defaultKind);\n\t}\n}\n\n/**\n * Schema information collected by a SchemaBuilder, including referenced libraries.\n * Can be aggregated into other libraries by adding to their builders.\n */\nexport interface SchemaLibrary extends SchemaCollection {\n\t/**\n\t * Schema data aggregated from a collection of libraries by a SchemaBuilder.\n\t */\n\treadonly libraries: ReadonlySet<SchemaLibraryData>;\n}\n\n/**\n * Generalized version of AllowedTypes allowing for more concise expressions in some cases.\n */\nexport type FlexImplicitAllowedTypes = FlexAllowedTypes | FlexTreeNodeSchema | Any;\n\n/**\n * Normalizes an {@link FlexImplicitAllowedTypes} into  {@link FlexAllowedTypes}.\n */\nexport type NormalizeAllowedTypes<TSchema extends FlexImplicitAllowedTypes> =\n\tTSchema extends FlexTreeNodeSchema\n\t\t? readonly [TSchema]\n\t\t: TSchema extends Any\n\t\t\t? readonly [Any]\n\t\t\t: TSchema;\n\n/**\n * Normalizes an {@link FlexImplicitAllowedTypes} into  {@link FlexAllowedTypes}.\n */\nexport function normalizeAllowedTypes<TSchema extends FlexImplicitAllowedTypes>(\n\tschema: TSchema,\n): NormalizeAllowedTypes<TSchema> {\n\tif (schema === Any) {\n\t\treturn [Any] as unknown as NormalizeAllowedTypes<TSchema>;\n\t}\n\tif (schema instanceof TreeNodeSchemaBase) {\n\t\treturn [schema] as unknown as NormalizeAllowedTypes<TSchema>;\n\t}\n\tassert(Array.isArray(schema), 0x7c6 /* invalid ImplicitAllowedTypes */);\n\treturn schema as unknown as NormalizeAllowedTypes<TSchema>;\n}\n\n/**\n * Normalizes an {@link FlexImplicitFieldSchema} into a {@link FlexFieldSchema}.\n */\nexport type NormalizeField<\n\tTSchema extends FlexImplicitFieldSchema,\n\tTDefault extends FlexFieldKind,\n> = TSchema extends FlexFieldSchema\n\t? TSchema\n\t: FlexFieldSchema<\n\t\t\tTDefault,\n\t\t\tNormalizeAllowedTypes<Assume<TSchema, FlexImplicitAllowedTypes>>\n\t\t>;\n\n/**\n * Normalizes an {@link FlexImplicitFieldSchema} into a {@link FlexFieldSchema}.\n */\nexport function normalizeField<\n\tTSchema extends FlexImplicitFieldSchema,\n\tTDefault extends FlexFieldKind,\n>(schema: TSchema, defaultKind: TDefault): NormalizeField<TSchema, TDefault> {\n\tif (schema instanceof FlexFieldSchema) {\n\t\treturn schema as NormalizeField<TSchema, TDefault>;\n\t}\n\tconst allowedTypes = normalizeAllowedTypes(schema);\n\treturn FlexFieldSchema.create(defaultKind, allowedTypes) as unknown as NormalizeField<\n\t\tTSchema,\n\t\tTDefault\n\t>;\n}\n\n/**\n * Type that when combined with a default {@link FlexFieldKind} can be normalized into a {@link FlexFieldSchema}.\n */\nexport type FlexImplicitFieldSchema = FlexFieldSchema | FlexImplicitAllowedTypes;\n"]}

package/lib/shared-tree/treeView.d.ts

@@ -1,73 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { type Context, type FlexFieldSchema, type FlexTreeContext, type FlexTreeSchema, type FlexTreeTypedField, type NodeKeyManager } from "../feature-libraries/index.js";
-import { type IDisposable, disposeSymbol } from "../util/index.js";
-import type { ITreeCheckout, ITreeCheckoutFork } from "./treeCheckout.js";
-/**
- * The portion of {@link FlexTreeView} that does not depend on the schema's type.
- * @privateRemarks
- * Since {@link FlexTreeView}'s schema is invariant, `FlexTreeView<FlexFieldSchema>` does not cover this use case.
- */
-export interface FlexTreeViewGeneric extends IDisposable {
-    /**
-     * Context for controlling the FlexTree nodes produced from {@link FlexTreeView.flexTree}.
-     *
-     * @remarks
-     * This is an owning reference: disposing of this view disposes its context.
-     */
-    readonly context: FlexTreeContext;
-    /**
-     * Access non-view schema specific aspects of of this branch.
-     *
-     * @remarks
-     * This is a non-owning reference: disposing of this view does not impact the branch.
-     */
-    readonly checkout: ITreeCheckout;
-}
-/**
- * An editable view of a (version control style) branch of a shared tree.
- * @privateRemarks
- * TODO:
- * If schema aware APIs are removed from flex tree, this can be combined with {@link FlexTreeViewGeneric}.
- */
-export interface FlexTreeView<in out TRoot extends FlexFieldSchema> extends FlexTreeViewGeneric {
-    /**
-     * Get a typed view of the tree content using the flex-tree API.
-     */
-    readonly flexTree: FlexTreeTypedField<TRoot>;
-    /**
-     * Spawn a new view which is based off of the current state of this view.
-     * Any mutations of the new view will not apply to this view until the new view is merged back into this view via `merge()`.
-     */
-    fork(): ITreeViewFork<TRoot>;
-}
-/**
- * Branch (like in a version control system) of SharedTree.
- *
- * {@link FlexTreeView} that has forked off of the main trunk/branch.
- */
-export interface ITreeViewFork<in out TRoot extends FlexFieldSchema> extends FlexTreeView<TRoot> {
-    readonly checkout: ITreeCheckoutFork;
-}
-/**
- * Implementation of FlexTreeView wrapping a ITreeCheckout.
- */
-export declare class CheckoutFlexTreeView<in out TRoot extends FlexFieldSchema, out TCheckout extends ITreeCheckout = ITreeCheckout> implements FlexTreeView<TRoot> {
-    readonly checkout: TCheckout;
-    readonly schema: FlexTreeSchema<TRoot>;
-    readonly nodeKeyManager: NodeKeyManager;
-    private readonly onDispose?;
-    readonly context: Context;
-    readonly flexTree: FlexTreeTypedField<TRoot>;
-    constructor(checkout: TCheckout, schema: FlexTreeSchema<TRoot>, nodeKeyManager: NodeKeyManager, onDispose?: (() => void) | undefined);
-    [disposeSymbol](): void;
-    fork(): CheckoutFlexTreeView<TRoot, ITreeCheckout & ITreeCheckoutFork>;
-}
-/**
- * Maps the context of every {@link CheckoutFlexTreeView} to the view.
- * In practice, this allows the view or checkout to be obtained from a flex node by first getting the context from the flex node and then using this map.
- */
-export declare const contextToTreeView: WeakMap<Context, FlexTreeViewGeneric>;
-//# sourceMappingURL=treeView.d.ts.map

package/lib/shared-tree/treeView.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"treeView.d.ts","sourceRoot":"","sources":["../../src/shared-tree/treeView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EAEnB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,KAAK,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACvD;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAElC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS,eAAe,CACjE,SAAQ,mBAAmB;IAC3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAE7C;;;OAGG;IACH,IAAI,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS,eAAe,CAClE,SAAQ,YAAY,CAAC,KAAK,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,CAAC;CACrC;AAED;;GAEG;AACH,qBAAa,oBAAoB,CAChC,EAAE,CAAC,GAAG,CAAC,KAAK,SAAS,eAAe,EACpC,GAAG,CAAC,SAAS,SAAS,aAAa,GAAG,aAAa,CAClD,YAAW,YAAY,CAAC,KAAK,CAAC;aAKd,QAAQ,EAAE,SAAS;aACnB,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC;aAC7B,cAAc,EAAE,cAAc;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAN5B,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,SAAgB,QAAQ,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAEnC,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,EAC7B,cAAc,EAAE,cAAc,EAC7B,SAAS,CAAC,SAAQ,IAAI,aAAA;IAOjC,CAAC,aAAa,CAAC,IAAI,IAAI;IASvB,IAAI,IAAI,oBAAoB,CAAC,KAAK,EAAE,aAAa,GAAG,iBAAiB,CAAC;CAI7E;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,uCAA8C,CAAC"}