## Beta API Report File for "fluid-framework" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts // @beta export function adaptEnum>(factory: SchemaFactory, members: TEnum): ((value: TValue) => TValue extends unknown ? NodeFromSchema>> : never) & { readonly [Property in keyof TEnum]: TreeNodeSchemaClass, NodeKind.Object, TreeNode & { readonly value: TEnum[Property]; }, Record, true, Record, undefined>; } & { readonly schema: UnionToTuple<{ readonly [Property in keyof TEnum]: TreeNodeSchemaClass, NodeKind.Object, TreeNode & { readonly value: TEnum[Property]; }, Record, true, Record, undefined>; }[keyof TEnum]>; }; // @beta @input export interface AllowedTypeMetadata { readonly custom?: unknown; readonly stagedSchemaUpgrade?: SchemaUpgrade; } // @public @system export type AllowedTypes = readonly LazyItem[]; // @beta @sealed export type AllowedTypesFull = AnnotatedAllowedTypes & UnannotateAllowedTypesList; // @beta @sealed export type AllowedTypesFullEvaluated = AllowedTypesFull[]>; // @beta @sealed @system export type AllowedTypesFullFromMixed)[]> = UnannotateAllowedTypesList & AnnotatedAllowedTypes>; // @beta @sealed @system export type AllowedTypesFullFromMixedUnsafe>[]> = UnannotateAllowedTypesListUnsafe & AnnotatedAllowedTypes>; // @beta @input export interface AllowedTypesMetadata { readonly custom?: unknown; } // @beta @system export type AnnotateAllowedTypesList)[]> = { [I in keyof T]: T[I] extends AnnotatedAllowedType ? T[I] : AnnotatedAllowedType; }; // @beta @sealed @system export type AnnotateAllowedTypesListUnsafe>[]> = { [I in keyof T]: T[I] extends AnnotatedAllowedTypeUnsafe ? T[I] : AnnotatedAllowedTypeUnsafe; }; // @beta @sealed export interface AnnotatedAllowedType> { readonly metadata: AllowedTypeMetadata; readonly type: T; } // @beta @sealed export interface AnnotatedAllowedTypes extends ErasedBaseType<"tree.AnnotatedAllowedTypes"> { evaluate(): AllowedTypesFullEvaluated; evaluateIdentifiers(): ReadonlySet; evaluateSet(): ReadonlySet; readonly metadata: AllowedTypesMetadata; readonly types: T; } // @beta @sealed @system export interface AnnotatedAllowedTypesUnsafe extends AnnotatedAllowedTypes> { } // @beta @sealed @system export interface AnnotatedAllowedTypeUnsafe>> extends AnnotatedAllowedType { } // @public @system type ApplyKind = { [FieldKind.Required]: T; [FieldKind.Optional]: T | undefined; [FieldKind.Identifier]: T; }[Kind]; // @public @system type ApplyKindInput = [ Kind ] extends [FieldKind.Required] ? T : [Kind] extends [FieldKind.Optional] ? T | undefined : [Kind] extends [FieldKind.Identifier] ? DefaultsAreOptional extends true ? T | undefined : T : never; // @beta @sealed export type ArrayNodeDeltaOp = ArrayNodeRetainOp | ArrayNodeInsertOp | ArrayNodeRemoveOp; // @beta @sealed export interface ArrayNodeInsertOp { // (undocumented) readonly count: number; // (undocumented) readonly type: "insert"; } // @beta @sealed export interface ArrayNodeRemoveOp { // (undocumented) readonly count: number; // (undocumented) readonly type: "remove"; } // @beta @sealed export interface ArrayNodeRetainOp { // (undocumented) readonly count: number; // (undocumented) readonly type: "retain"; } // @beta export type ArrayNodeTreeChangedDeltaOp = ArrayNodeTreeChangedRetainOp | ArrayNodeInsertOp | ArrayNodeRemoveOp; // @beta @sealed export interface ArrayNodeTreeChangedRetainOp extends ArrayNodeRetainOp { readonly subtreeChanged: boolean; } // @beta export function asBeta(view: TreeView): TreeViewBeta; // @public export enum AttachState { Attached = "Attached", Attaching = "Attaching", Detached = "Detached" } // @beta @sealed export type ChangeMetadataBeta = CommitMetadata & ({ readonly isLocal: true; readonly events: Listenable; } | { readonly isLocal: false; }); // @beta @input export interface CodecWriteOptionsBeta { readonly minVersionForCollab: OldestSupportedClientVersion; } // @public export enum CommitKind { Default = 0, Redo = 2, Undo = 1 } // @public @sealed export interface CommitMetadata { readonly isLocal: boolean; readonly kind: CommitKind; } // @beta export enum CommitOutcome { FullyApplied = 0, FullyDropped = 1, NewContentOnly = 2 } // @beta export type ConciseTree = Exclude | THandle | ConciseTree[] | { [key: string]: ConciseTree; }; // @beta @legacy export function configuredSharedString(options: SharedStringOptions): ISharedObjectKind & SharedObjectKind; // @beta export function configuredSharedTreeBeta(options: SharedTreeOptionsBeta): SharedObjectKind; // @public export enum ConnectionState { CatchingUp = 1, Connected = 2, Disconnected = 0, EstablishingConnection = 3 } // @public export namespace ConnectionStateType { const Disconnected = 0; export type CatchingUp = typeof CatchingUp; const EstablishingConnection = 3; export type Connected = typeof Connected; const CatchingUp = 1; export type Disconnected = typeof Disconnected; const Connected = 2; export type EstablishingConnection = typeof EstablishingConnection; } // @public export type ConnectionStateType = ConnectionStateType.Disconnected | ConnectionStateType.EstablishingConnection | ConnectionStateType.CatchingUp | ConnectionStateType.Connected; // @public export type ContainerAttachProps = T; // @public export interface ContainerSchema { readonly dynamicObjectTypes?: readonly SharedObjectKind[]; readonly initialObjects: Record; } // @beta export function createIdentifierIndex(view: TreeView): IdentifierIndex; // @beta export function createIndependentTreeBeta(options?: ForestOptions): ViewableTree; // @beta export function createIndependentTreeView(config: TreeViewConfiguration, options?: ForestOptions): TreeViewBeta; // @beta export function createTreeIndex(view: TreeView, keyFieldSelector: TreeIndexKeyFieldSelector, getValue: (nodes: TreeIndexNodes) => TValue, isKeyValid: (key: TreeIndexKey) => key is TKey): TreeIndex; // @beta export function createTreeIndex(view: TreeView, keyFieldSelector: TreeIndexKeyFieldSelector, getValue: (nodes: TreeIndexNodes>) => TValue, isKeyValid: (key: TreeIndexKey) => key is TKey, indexableSchema: readonly TSchema[]): TreeIndex; // @public @sealed @system interface DefaultProvider extends ErasedType<"@fluidframework/tree.FieldProvider"> { } // @beta @legacy (undocumented) export type DeserializeCallback = (properties: PropertySet) => void; // @beta export function enumFromStrings(factory: SchemaFactory, members: Members): ((value: TValue) => TValue extends unknown ? NodeFromSchema>> : never) & { [Index in Extract extends `${infer N extends number}` ? N : never as Members[Index]]: TreeNodeSchemaClass, NodeKind.Object, TreeNode & { readonly value: Members[Index]; }, Record, true, Record, undefined>; } & { readonly schema: { -readonly [Position in keyof Members]: TreeNodeSchemaClass, NodeKind.Object, TreeNode & { readonly value: Members[Position]; }, Record, true, Record, undefined>; }; }; // @beta @sealed @system export abstract class ErasedBaseType { protected constructor(); protected abstract brand(dummy: never): Name; } // @public @sealed export abstract class ErasedType { static [Symbol.hasInstance](value: never): value is never; protected abstract brand(dummy: never): Name; } // @beta export namespace ExtensibleUnionNode { export function createSchema(types: T, inputSchemaFactory: SchemaFactoryBeta, name: TName): Statics & TreeNodeSchemaCore`, TName>, NodeKind, false, unknown, never, unknown> & (new (data: InternalTreeNode) => Members> & TreeNode & WithType`, TName>, NodeKind, unknown>); export interface Members { isValid(): boolean; readonly union: T | undefined; } export interface Statics { create(this: TThis, child: TreeNodeFromImplicitAllowedTypes): TreeFieldFromImplicitField; } } // @public @system type ExtractItemType = Item extends () => infer Result ? Result : Item; // @public @system type FieldHasDefault = [T] extends [ FieldSchema ] ? true : false; // @public export enum FieldKind { Identifier = 2, Optional = 0, Required = 1 } // @public export interface FieldProps { readonly defaultProvider?: DefaultProvider; readonly key?: string; readonly metadata?: FieldSchemaMetadata; } // @public @sealed export class FieldSchema { protected constructor( kind: Kind, allowedTypes: Types, props?: FieldProps | undefined); readonly allowedTypes: Types; get allowedTypeSet(): ReadonlySet; readonly kind: Kind; get metadata(): FieldSchemaMetadata; readonly props?: FieldProps | undefined; readonly requiresValue: boolean; protected _typeCheck: MakeNominal; } // @public @sealed export interface FieldSchemaMetadata { readonly custom?: TCustomMetadata; readonly description?: string | undefined; } // @beta export type FixRecursiveArraySchema = T extends TreeNodeSchema ? undefined : undefined; // @public @system type FlattenKeys = [{ [Property in keyof T]: T[Property]; }][_InlineTrick]; // @public @system type FlexList = readonly LazyItem[]; // @public @system type FlexListToUnion = ExtractItemType; // @public @sealed export interface FluidIterable { [Symbol.iterator](): FluidIterableIterator; } // @public @sealed export interface FluidIterableIterator extends FluidIterable { next(): { value: T; done?: false; } | { value: any; done: true; }; } // @public @sealed export interface FluidMap extends FluidReadonlyMap { delete(key: K): void; forEach(callbackfn: (value: V, key: K, map: FluidMap) => void, thisArg?: any): void; set(key: K, value: V): void; } // @public export type FluidObject = { [P in FluidObjectProviderKeys]?: T[P]; }; // @public export type FluidObjectProviderKeys = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required[TProp] ? Required[TProp] extends Required[TProp]>[TProp] ? TProp : never : never; // @public @sealed export interface FluidReadonlyArray { [Symbol.iterator](): FluidIterableIterator; readonly [Symbol.unscopables]: { [K in keyof (readonly any[])]?: boolean; }; readonly [n: number]: T; at(index: number): T | undefined; concat(...items: ConcatArray[]): T[]; concat(...items: (T | ConcatArray)[]): T[]; entries(): FluidIterableIterator<[number, T]>; every(predicate: (value: T, index: number, array: readonly T[]) => value is S, thisArg?: any): this is FluidReadonlyArray; every(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): boolean; filter(predicate: (value: T, index: number, array: readonly T[]) => value is S, thisArg?: any): S[]; filter(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): T[]; find(predicate: (value: T, index: number, obj: readonly T[]) => value is S, thisArg?: any): S | undefined; find(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): T | undefined; findIndex(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): number; findLast(predicate: (value: T, index: number, obj: readonly T[]) => value is S, thisArg?: any): S | undefined; findLast(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): T | undefined; findLastIndex(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): number; flat(this: A, depth?: D): FlatArray[]; flatMap(callback: (this: This, value: T, index: number, array: T[]) => U | readonly U[], thisArg?: This): U[]; forEach(callbackfn: (value: T, index: number, array: readonly T[]) => void, thisArg?: any): void; includes(searchElement: T, fromIndex?: number): boolean; indexOf(searchElement: T, fromIndex?: number): number; join(separator?: string): string; keys(): FluidIterableIterator; lastIndexOf(searchElement: T, fromIndex?: number): number; readonly length: number; map(callbackfn: (value: T, index: number, array: readonly T[]) => U, thisArg?: any): U[]; reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: readonly T[]) => T): T; reduce(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: readonly T[]) => U, initialValue: U): U; reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: readonly T[]) => T): T; reduceRight(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: readonly T[]) => U, initialValue: U): U; slice(start?: number, end?: number): T[]; some(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): boolean; // (undocumented) toLocaleString(): string; toString(): string; values(): FluidIterableIterator; } // @public @sealed export interface FluidReadonlyMap { [Symbol.iterator](): FluidIterableIterator<[K, V]>; readonly [Symbol.toStringTag]: string; entries(): FluidIterableIterator<[K, V]>; forEach(callbackfn: (value: V, key: K, map: FluidReadonlyMap) => void, thisArg?: any): void; get(key: K): V | undefined; has(key: K): boolean; keys(): FluidIterableIterator; readonly size: number; values(): FluidIterableIterator; } // @beta export namespace FluidSerializableAsTree { // @sealed export class Array extends _APIExtractorWorkaroundArrayBase { } const Tree: readonly [() => typeof FluidSerializableObject, () => typeof Array, LeafSchema<"string", string>, LeafSchema<"number", number>, LeafSchema<"boolean", boolean>, LeafSchema<"null", null>, LeafSchema<"handle", IFluidHandle>]; export type Data = JsonCompatible; const // @system _APIExtractorWorkaroundObjectBase: TreeNodeSchemaClass<"com.fluidframework.serializable.object", NodeKind.Record, TreeRecordNodeUnsafe typeof FluidSerializableObject, () => typeof Array, LeafSchema<"string", string>, LeafSchema<"number", number>, LeafSchema<"boolean", boolean>, LeafSchema<"null", null>, LeafSchema<"handle", IFluidHandle>]> & WithType<"com.fluidframework.serializable.object", NodeKind.Record, unknown>, { readonly [x: string]: string | number | IFluidHandle | System_Unsafe.InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | FluidSerializableObject | Array | null; }, false, readonly [() => typeof FluidSerializableObject, () => typeof Array, LeafSchema<"string", string>, LeafSchema<"number", number>, LeafSchema<"boolean", boolean>, LeafSchema<"null", null>, LeafSchema<"handle", IFluidHandle>], undefined, unknown>; // @sealed export class FluidSerializableObject extends _APIExtractorWorkaroundObjectBase { } // @system export type _RecursiveArrayWorkaroundJsonArray = FixRecursiveArraySchema; const // @system _APIExtractorWorkaroundArrayBase: TreeNodeSchemaClass<"com.fluidframework.serializable.array", NodeKind.Array, System_Unsafe.TreeArrayNodeUnsafe typeof FluidSerializableObject, () => typeof Array, LeafSchema<"string", string>, LeafSchema<"number", number>, LeafSchema<"boolean", boolean>, LeafSchema<"null", null>, LeafSchema<"handle", IFluidHandle>]> & WithType<"com.fluidframework.serializable.array", NodeKind.Array, unknown>, { [Symbol.iterator](): Iterator | System_Unsafe.InsertableTypedNodeUnsafe, LeafSchema<"boolean", boolean>> | FluidSerializableObject | Array | null, any, any>; }, false, readonly [() => typeof FluidSerializableObject, () => typeof Array, LeafSchema<"string", string>, LeafSchema<"number", number>, LeafSchema<"boolean", boolean>, LeafSchema<"null", null>, LeafSchema<"handle", IFluidHandle>], undefined>; // (undocumented) export type Tree = TreeNodeFromImplicitAllowedTypes; } // @beta @input export interface ForestOptions { readonly forest?: ForestType; } // @beta @sealed export interface ForestType extends ErasedType<"ForestType"> { } // @beta export const ForestTypeExpensiveDebug: ForestType; // @beta export const ForestTypeOptimized: ForestType; // @beta export const ForestTypeReference: ForestType; // @public export const getPresence: (fluidContainer: IFluidContainer) => Presence; // @beta @legacy export interface IBranchOrigin { id: string; minimumSequenceNumber: number; sequenceNumber: number; } // @public export interface IConnection { readonly id: string; readonly mode: "write" | "read"; } // @public export type ICriticalContainerError = IErrorBase; // @beta export type IdentifierIndex = TreeIndex; // @public @sealed @legacy export interface IDirectory extends FluidMap, IEventProvider, Partial { readonly absolutePath: string; clear(): void; countSubDirectory?(): number; createSubDirectory(subdirName: string): IDirectory; delete(key: string): boolean; deleteSubDirectory(subdirName: string): boolean; get(key: string): T | undefined; getSubDirectory(subdirName: string): IDirectory | undefined; getWorkingDirectory(relativePath: string): IDirectory | undefined; hasSubDirectory(subdirName: string): boolean; set(key: string, value: T): this; subdirectories(): FluidIterableIterator<[string, IDirectory]>; } // @public @sealed @legacy export interface IDirectoryEvents extends IEvent { (event: "containedValueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any; (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any; (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any; (event: "disposed", listener: (target: IEventThisPlaceHolder) => void): any; (event: "undisposed", listener: (target: IEventThisPlaceHolder) => void): any; } // @public @sealed @legacy export interface IDirectoryValueChanged extends IValueChanged { path: string; } // @public @sealed export interface IDisposable { dispose(error?: Error): void; readonly disposed: boolean; } // @public export interface IErrorBase extends Partial { readonly errorType: string; getTelemetryProperties?(): ITelemetryBaseProperties; readonly message: string; readonly name?: string; readonly stack?: string; } // @public export interface IErrorEvent extends IEvent { // @eventProperty (event: "error", listener: (message: any) => void): any; } // @public export interface IEvent { // @eventProperty (event: string, listener: (...args: any[]) => void): any; } // @public @sealed export interface IEventProvider { readonly off: IEventTransformer; readonly on: IEventTransformer; readonly once: IEventTransformer; } // @public export type IEventThisPlaceHolder = { thisPlaceHolder: "thisPlaceHolder"; }; // @public export type IEventTransformer = TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: infer E7, listener: (...args: infer A7) => void): any; (event: infer E8, listener: (...args: infer A8) => void): any; (event: infer E9, listener: (...args: infer A9) => void): any; (event: infer E10, listener: (...args: infer A10) => void): any; (event: infer E11, listener: (...args: infer A11) => void): any; (event: infer E12, listener: (...args: infer A12) => void): any; (event: infer E13, listener: (...args: infer A13) => void): any; (event: infer E14, listener: (...args: infer A14) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: infer E7, listener: (...args: infer A7) => void): any; (event: infer E8, listener: (...args: infer A8) => void): any; (event: infer E9, listener: (...args: infer A9) => void): any; (event: infer E10, listener: (...args: infer A10) => void): any; (event: infer E11, listener: (...args: infer A11) => void): any; (event: infer E12, listener: (...args: infer A12) => void): any; (event: infer E13, listener: (...args: infer A13) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: infer E7, listener: (...args: infer A7) => void): any; (event: infer E8, listener: (...args: infer A8) => void): any; (event: infer E9, listener: (...args: infer A9) => void): any; (event: infer E10, listener: (...args: infer A10) => void): any; (event: infer E11, listener: (...args: infer A11) => void): any; (event: infer E12, listener: (...args: infer A12) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: infer E7, listener: (...args: infer A7) => void): any; (event: infer E8, listener: (...args: infer A8) => void): any; (event: infer E9, listener: (...args: infer A9) => void): any; (event: infer E10, listener: (...args: infer A10) => void): any; (event: infer E11, listener: (...args: infer A11) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: infer E7, listener: (...args: infer A7) => void): any; (event: infer E8, listener: (...args: infer A8) => void): any; (event: infer E9, listener: (...args: infer A9) => void): any; (event: infer E10, listener: (...args: infer A10) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: infer E7, listener: (...args: infer A7) => void): any; (event: infer E8, listener: (...args: infer A8) => void): any; (event: infer E9, listener: (...args: infer A9) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: infer E7, listener: (...args: infer A7) => void): any; (event: infer E8, listener: (...args: infer A8) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: infer E7, listener: (...args: infer A7) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: infer E6, listener: (...args: infer A6) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: infer E5, listener: (...args: infer A5) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: infer E4, listener: (...args: infer A4) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: infer E3, listener: (...args: infer A3) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: infer E2, listener: (...args: infer A2) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent & TransformedEvent : TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent : TransformedEvent; // @public @sealed export interface IFluidContainer extends IEventProvider { attach(props?: ContainerAttachProps): Promise; readonly attachState: AttachState; connect(): void; readonly connectionState: ConnectionStateType; create(objectClass: SharedObjectKind): Promise; disconnect(): void; dispose(): void; readonly disposed: boolean; readonly initialObjects: InitialObjects; readonly isDirty: boolean; } // @public @sealed export interface IFluidContainerEvents extends IEvent { (event: "connected", listener: () => void): void; (event: "disconnected", listener: () => void): void; (event: "saved", listener: () => void): void; (event: "dirty", listener: () => void): void; (event: "disposed", listener: (error?: ICriticalContainerError) => void): any; } // @public (undocumented) export const IFluidHandle = "IFluidHandle"; // @public @sealed export interface IFluidHandle { readonly [fluidHandleSymbol]: IFluidHandleErased; get(): Promise; readonly isAttached: boolean; } // @public @sealed export interface IFluidHandleErased extends ErasedType { } // @public (undocumented) export const IFluidLoadable: keyof IProvideFluidLoadable; // @public @sealed export interface IFluidLoadable extends IProvideFluidLoadable { readonly handle: IFluidHandle; } // @beta @legacy export interface IInterval { compare(b: IInterval): number; compareEnd(b: IInterval): number; compareStart(b: IInterval): number; // (undocumented) overlaps(b: IInterval): boolean; } // @public export interface IMember { readonly connections: IConnection[]; readonly id: string; } // @public export type ImplicitAllowedTypes = AllowedTypes | TreeNodeSchema; // @public export type ImplicitFieldSchema = FieldSchema | ImplicitAllowedTypes; // @public export type InitialObjects = { [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends SharedObjectKind ? TChannel : never; }; // @public @system type _InlineTrick = 0; // @public @system export type Input = T; // @public @system type InsertableObjectFromSchemaRecord> = RestrictiveStringRecord extends T ? { arbitraryKey: "arbitraryValue"; } extends T ? Record : never : FlattenKeys<{ readonly [Property in keyof T]?: InsertableTreeFieldFromImplicitField; } & { readonly [Property in keyof T as FieldHasDefault extends false ? Property : never]: InsertableTreeFieldFromImplicitField; }>; // @public export type InsertableTreeFieldFromImplicitField> = [TSchema] extends [FieldSchema] ? ApplyKindInput, Kind, true> : [TSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes : never; // @public @system export type InsertableTreeNodeFromAllowedTypes = IsUnion extends true ? never : { readonly [Property in keyof TList]: [TList[Property]] extends [ LazyItem ] ? InsertableTypedNode : never; }[NumberKeys]; // @public export type InsertableTreeNodeFromImplicitAllowedTypes = [ TSchema ] extends [TreeNodeSchema] ? InsertableTypedNode : [TSchema] extends [AllowedTypes] ? InsertableTreeNodeFromAllowedTypes : never; // @public export type InsertableTypedNode> = (T extends TreeNodeSchema ? NodeBuilderData : never) | (T extends TreeNodeSchema ? Unhydrated ? never : NodeFromSchema> : never); export { InteriorSequencePlace } // @public @sealed export interface InternalTreeNode extends ErasedType<"@fluidframework/tree.InternalTreeNode"> { } declare namespace InternalTypes { export { _InlineTrick, FlattenKeys, ApplyKind, ApplyKindInput, NodeBuilderData, FieldHasDefault, ScopedSchemaName, DefaultProvider, schemaIdentifierBrand, InsertableObjectFromSchemaRecord, FlexList, FlexListToUnion, ExtractItemType } } export { InternalTypes } // @beta @legacy export const IntervalStickiness: { readonly NONE: 0; readonly START: 1; readonly END: 2; readonly FULL: 3; }; // @beta @legacy export type IntervalStickiness = (typeof IntervalStickiness)[keyof typeof IntervalStickiness]; // @beta @legacy (undocumented) export enum IntervalType { // (undocumented) Simple = 0, SlideOnRemove = 2,// SlideOnRemove is default behavior - all intervals are SlideOnRemove } // @public (undocumented) export interface IProvideFluidLoadable { // (undocumented) readonly IFluidLoadable: IFluidLoadable; } // @beta @legacy export interface ISequencedDocumentMessage { clientId: string | null; clientSequenceNumber: number; // @deprecated compression?: string; contents: unknown; data?: string; // @deprecated expHash1?: string; metadata?: unknown; minimumSequenceNumber: number; origin?: IBranchOrigin; referenceSequenceNumber: number; sequenceNumber: number; serverMetadata?: unknown; timestamp: number; traces?: ITrace[]; type: string; } // @beta @legacy export interface ISequenceDeltaRange { operation: TOperation; position: number; propertyDeltas: PropertySet; segment: ISegment; } // @beta @legacy export interface ISequenceIntervalCollection extends TypedEventEmitter { // (undocumented) [Symbol.iterator](): Iterator; add(input: { start: SequencePlace; end: SequencePlace; props?: PropertySet; }): SequenceInterval; // @deprecated (undocumented) attachDeserializer(onDeserialize: DeserializeCallback): void; // (undocumented) readonly attached: boolean; attachIndex(index: SequenceIntervalIndex): void; change(id: string, input: { start?: SequencePlace; end?: SequencePlace; props?: PropertySet; }): SequenceInterval | undefined; // (undocumented) CreateBackwardIteratorWithEndPosition(endPosition: number): Iterator; // (undocumented) CreateBackwardIteratorWithStartPosition(startPosition: number): Iterator; // (undocumented) CreateForwardIteratorWithEndPosition(endPosition: number): Iterator; // (undocumented) CreateForwardIteratorWithStartPosition(startPosition: number): Iterator; detachIndex(index: SequenceIntervalIndex): boolean; // @deprecated (undocumented) findOverlappingIntervals(startPosition: number, endPosition: number): SequenceInterval[]; gatherIterationResults(results: SequenceInterval[], iteratesForward: boolean, start?: number, end?: number): void; // (undocumented) getIntervalById(id: string): SequenceInterval | undefined; map(fn: (interval: SequenceInterval) => void): void; // @deprecated (undocumented) nextInterval(pos: number): SequenceInterval | undefined; // @deprecated (undocumented) previousInterval(pos: number): SequenceInterval | undefined; removeIntervalById(id: string): SequenceInterval | undefined; } // @beta @legacy export interface ISequenceIntervalCollectionEvents extends IEvent { (event: "changeInterval", listener: (interval: SequenceInterval, previousInterval: SequenceInterval, local: boolean, op: ISequencedDocumentMessage | undefined, slide: boolean) => void): void; (event: "addInterval" | "deleteInterval", listener: (interval: SequenceInterval, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void; (event: "propertyChanged", listener: (interval: SequenceInterval, propertyDeltas: PropertySet, local: boolean, op: ISequencedDocumentMessage | undefined) => void): void; (event: "changed", listener: (interval: SequenceInterval, propertyDeltas: PropertySet, previousInterval: SequenceInterval | undefined, local: boolean, slide: boolean) => void): void; } // @beta @legacy export interface ISerializedInterval { end: number | "start" | "end"; // (undocumented) endSide?: Side; intervalType: IntervalType; properties?: PropertySet; sequenceNumber: number; start: number | "start" | "end"; // (undocumented) startSide?: Side; stickiness?: IntervalStickiness; } // @public export interface IServiceAudience extends IEventProvider> { getMembers(): ReadonlyMap; getMyself(): Myself | undefined; } // @public export interface IServiceAudienceEvents extends IEvent { // @eventProperty (event: "membersChanged", listener: () => void): void; // @eventProperty (event: "memberAdded", listener: MemberChangedListener): void; // @eventProperty (event: "memberRemoved", listener: MemberChangedListener): void; } // @public export function isFluidHandle(value: unknown): value is IFluidHandle; // @beta @sealed @legacy export interface ISharedDirectory extends ISharedObject, Omit { // (undocumented) [Symbol.iterator](): FluidIterableIterator<[string, any]>; // (undocumented) readonly [Symbol.toStringTag]: string; } // @beta @sealed @legacy export interface ISharedDirectoryEvents extends ISharedObjectEvents { (event: "valueChanged", listener: (changed: IDirectoryValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any; // @deprecated (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any; (event: "cleared", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any; (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any; (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any; } // @beta @sealed @legacy export interface ISharedMap extends ISharedObject, FluidMap { clear(): void; delete(key: string): boolean; get(key: string): T | undefined; set(key: string, value: T): this; } // @beta @sealed @legacy export interface ISharedMapEvents extends ISharedObjectEvents { (event: "valueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any; (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any; } // @beta @legacy export interface ISharedObject extends IChannel, IEventProvider { bindToContext(): void; } // @beta @legacy export interface ISharedObjectEvents extends IErrorEvent { // @eventProperty (event: "pre-op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any; // @eventProperty (event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any; } // @beta @legacy export interface ISharedObjectKind { create(runtime: IFluidDataStoreRuntime, id?: string): TSharedObject; getFactory(): IChannelFactory; } // @beta @legacy (undocumented) export interface ISharedSegmentSequence extends ISharedObject, MergeTreeRevertibleDriver { annotateAdjustRange(start: number, end: number, adjust: MapLike): void; annotateRange(start: number, end: number, props: PropertySet): void; createLocalReferencePosition(segment: T | "start" | "end", offset: number | undefined, refType: ReferenceType, properties: PropertySet | undefined, slidingPreference?: SlidingPreference, canSlideToEndpoint?: boolean): LocalReferencePosition; getContainingSegment(pos: number): { segment: T | undefined; offset: number | undefined; }; // (undocumented) getCurrentSeq(): number; getIntervalCollection(label: string): ISequenceIntervalCollection; // (undocumented) getIntervalCollectionLabels(): IterableIterator; getLength(): number; getPosition(segment: ISegment): number; // (undocumented) getPropertiesAtPosition(pos: number): PropertySet | undefined; // (undocumented) getRangeExtentsOfPosition(pos: number): { posStart: number | undefined; posAfterEnd: number | undefined; }; // @deprecated (undocumented) groupOperation(groupOp: IMergeTreeGroupMsg): void; initializeLocal(): void; insertAtReferencePosition(pos: ReferencePosition, segment: T): void; insertFromSpec(pos: number, spec: IJSONSegment): void; localReferencePositionToPosition(lref: ReferencePosition): number; obliterateRange(start: number | InteriorSequencePlace, end: number | InteriorSequencePlace): void; posFromRelativePos(relativePos: IRelativePosition): number; removeLocalReferencePosition(lref: LocalReferencePosition): LocalReferencePosition | undefined; // (undocumented) removeRange(start: number, end: number): void; resolveRemoteClientPosition(remoteClientPosition: number, remoteClientRefSeq: number, remoteClientId: string): number | undefined; walkSegments(handler: ISegmentAction, start?: number, end?: number, accum?: TClientData, splitRange?: boolean): void; } // @beta @legacy export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents { // (undocumented) (event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): void; // (undocumented) (event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): void; // (undocumented) (event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): void; } // @beta @legacy export interface ISharedString extends ISharedSegmentSequence { annotateMarker(marker: Marker, props: PropertySet): void; getMarkerFromId(id: string): ISegment | undefined; getText(start?: number, end?: number): string; // (undocumented) getTextRangeWithMarkers(start: number, end: number): string; getTextWithPlaceholders(start?: number, end?: number): string; insertMarker(pos: number, refType: ReferenceType, props?: PropertySet): void; insertMarkerRelative(relativePos1: IRelativePosition, refType: ReferenceType, props?: PropertySet): void; insertText(pos: number, text: string, props?: PropertySet): void; insertTextRelative(relativePos1: IRelativePosition, text: string, props?: PropertySet): void; removeText(start: number, end: number): void; replaceText(start: number, end: number, text: string, props?: PropertySet): void; searchForMarker(startPos: number, markerLabel: string, forwards?: boolean): Marker | undefined; } // @public export type IsListener = TListener extends (...args: any[]) => void ? true : false; // @public @system export type IsUnion = T extends unknown ? [T2] extends [T] ? false : true : "error"; // @public export interface ITelemetryBaseEvent extends ITelemetryBaseProperties { // (undocumented) category: string; // (undocumented) eventName: string; } // @public @input export interface ITelemetryBaseLogger { minLogLevel?: LogLevel | undefined; send(event: ITelemetryBaseEvent, logLevel: LogLevel): void; } // @public export interface ITelemetryBaseProperties { [index: string]: TelemetryBaseEventPropertyType | Tagged; } // @public @sealed export class IterableTreeArrayContent implements Iterable { [Symbol.iterator](): Iterator; } // @beta @legacy export interface ITrace { action: string; service: string; timestamp: number; } // @public @sealed export interface ITree extends ViewableTree, IFluidLoadable { } // @public export interface ITreeConfigurationOptions { enableSchemaValidation?: boolean; readonly preventAmbiguity?: boolean; } // @public export interface ITreeViewConfiguration extends ITreeConfigurationOptions { readonly schema: TSchema; } // @public @sealed @legacy export interface IValueChanged { readonly key: string; readonly previousValue: any; } // @beta export type JsonCompatible = string | number | boolean | null | JsonCompatible[] | JsonCompatibleObject | TExtra; // @beta export type JsonCompatibleObject = { [P in string]?: JsonCompatible; }; // @beta @input export enum KeyEncodingOptions { allStoredKeys = "allStoredKeys", knownStoredKeys = "knownStoredKeys", usePropertyKeys = "usePropertyKeys" } // @public export type LazyItem = Item | (() => Item); // @public @sealed @system export interface LeafSchema extends TreeNodeSchemaNonClass<`com.fluidframework.leaf.${Name}`, NodeKind.Leaf, T, T, true> { } // @public @sealed export interface Listenable { off>(eventName: K, listener: TListeners[K]): void; on>(eventName: K, listener: TListeners[K]): Off; } // @public export type Listeners = { [P in (string | symbol) & keyof T as IsListener extends true ? P : never]: T[P]; }; // @beta @sealed export interface LocalCommitEvents { settled(outcome: CommitOutcome): void; } // @public export const LogLevel: LogLevelConst; // @public export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel]; // @public export interface LogLevelConst { readonly essential: 30; readonly info: 20; readonly verbose: 10; } // @public @sealed export interface MakeNominal { } // @public @system export type MapNodeInsertableData = Iterable]> | RestrictiveStringRecord>; // @public export type MemberChangedListener = (clientId: string, member: M) => void; // @public export type Myself = M & { readonly currentConnection: string; }; // @beta export interface NoChangeConstraint { // (undocumented) readonly type: "noChange"; } // @public @system type NodeBuilderData> = T extends TreeNodeSchemaCore ? TBuild : never; // @beta @sealed export interface NodeChangedData { readonly changedProperties?: ReadonlySet ? string & keyof TInfo : string>; readonly changedUnknownProperties?: ReadonlySet; readonly delta?: readonly ArrayNodeDeltaOp[] | undefined; } // @beta @sealed export interface NodeChangedDataDelta extends NodeChangedData { readonly delta: readonly ArrayNodeDeltaOp[] | undefined; } // @beta @sealed export interface NodeChangedDataProperties extends NodeChangedData { readonly changedProperties: ReadonlySet ? string & keyof TInfo : string>; } // @beta @sealed export interface NodeChangedDataTreeDelta { readonly delta: readonly ArrayNodeTreeChangedDeltaOp[] | undefined; } // @public export type NodeFromSchema = T extends TreeNodeSchemaClass ? TNode : T extends TreeNodeSchemaNonClass ? TNode : never; // @public export interface NodeInDocumentConstraint { // (undocumented) readonly node: TreeNode; // (undocumented) readonly type: "nodeInDocument"; } // @public export enum NodeKind { Array = 1, Leaf = 3, Map = 0, Object = 2, Record = 4 } // @public @sealed export interface NodeSchemaMetadata { readonly custom?: TCustomMetadata | undefined; readonly description?: string | undefined; } // @public @input export interface NodeSchemaOptions { readonly metadata?: NodeSchemaMetadata | undefined; } // @public @system export type NumberKeys = Transformed[`${number}` & keyof Transformed]; // @public @system export type ObjectFromSchemaRecord> = RestrictiveStringRecord extends T ? {} : { -readonly [Property in keyof T]: Property extends string ? TreeFieldFromImplicitField : unknown; }; // @public @input export interface ObjectSchemaOptions { readonly allowUnknownOptionalFields?: boolean; } // @beta @input export interface ObjectSchemaOptionsBeta extends ObjectSchemaOptions, NodeSchemaOptions { } // @public export type Off = () => void; // @beta export function onAssertionFailure(handler: (error: Error) => void): () => void; // @beta @system export type PopUnion void : never>> = AsOverloadedFunction extends (a: infer First) => void ? First : never; // @public @sealed @system export interface ReadonlyArrayNode extends FluidReadonlyArray, Awaited> { } // @beta @system export type RecordNodeInsertableData = RestrictiveStringRecord>; // @public export type ReplaceIEventThisPlaceHolder = L extends any[] ? { [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K]; } : L; // @public @deprecated export type RestrictiveReadonlyRecord = { readonly [P in symbol | string]: P extends K ? T : never; }; // @public @system export type RestrictiveStringRecord = { readonly [P in string]: T; } & { readonly [P in symbol]?: never; }; // @public @sealed export interface Revertible { dispose(): void; revert(): void; revert(dispose: boolean): void; readonly status: RevertibleStatus; } // @public @sealed export type RevertibleFactory = (onRevertibleDisposed?: (revertible: Revertible) => void) => Revertible; // @public export enum RevertibleStatus { Disposed = 1, Valid = 0 } // @public export const rollback: unique symbol; // @public @sealed export interface RunTransaction { (node: TNode, transaction: (node: TNode) => TResult): TResult; , TResult>(tree: TView, transaction: (root: TView["root"]) => TResult): TResult; (node: TNode, transaction: (node: TNode) => TResult | typeof rollback): TResult | typeof rollback; , TResult>(tree: TView, transaction: (root: TView["root"]) => TResult | typeof rollback): TResult | typeof rollback; (node: TNode, transaction: (node: TNode) => void): void; >(tree: TView, transaction: (root: TView["root"]) => void): void; (node: TNode, transaction: (node: TNode) => TResult, preconditions?: readonly TransactionConstraint[]): TResult; , TResult>(tree: TView, transaction: (root: TView["root"]) => TResult, preconditions?: readonly TransactionConstraint[]): TResult; (node: TNode, transaction: (node: TNode) => TResult | typeof rollback, preconditions?: readonly TransactionConstraint[]): TResult | typeof rollback; , TResult>(tree: TView, transaction: (root: TView["root"]) => TResult | typeof rollback, preconditions?: readonly TransactionConstraint[]): TResult | typeof rollback; (node: TNode, transaction: (node: TNode) => void, preconditions?: readonly TransactionConstraint[]): void; >(tree: TView, transaction: (root: TView["root"]) => void, preconditions?: readonly TransactionConstraint[]): void; readonly rollback: typeof rollback; } // @beta @input export interface RunTransactionParamsBeta { readonly label?: unknown; readonly preconditions?: readonly TransactionConstraintBeta[]; } // @public @sealed export interface SchemaCompatibilityStatus { readonly canInitialize: boolean; readonly canUpgrade: boolean; readonly canView: boolean; // @deprecated readonly isEquivalent: boolean; } // @beta @sealed export interface SchemaCompatibilityStatusBeta extends SchemaCompatibilityStatus { readonly discrepancies: readonly SchemaDiscrepancy[] | undefined; } // @beta @sealed export type SchemaDiscrepancy = { readonly mismatch: "allowedTypes"; readonly location: "root" | { readonly nodeType: string; readonly fieldKey: string | undefined; }; readonly view: readonly string[]; readonly stagedView?: readonly string[]; readonly stored: readonly string[]; readonly viewIsStagedOptional?: true; } | { readonly mismatch: "fieldKind"; readonly location: "root" | { readonly nodeType: string; readonly fieldKey: string | undefined; }; readonly view: string; readonly stored: string; readonly viewIsStagedOptional?: true; } | { readonly mismatch: "valueSchema"; readonly nodeType: string; readonly view: string | undefined; readonly stored: string | undefined; } | { readonly mismatch: "nodeKind"; readonly nodeType: string; readonly view: string; readonly stored: string; }; // @public @sealed export class SchemaFactory extends SchemaFactory_base { constructor(scopeOrOptions: TScope | (SchemaFactoryOptions & { readonly scope: TScope; })); array(allowedTypes: T): TreeNodeSchemaNonClass`>, NodeKind.Array, TreeArrayNode & WithType`>, NodeKind.Array>, Iterable>, true, T, undefined>; array(name: Name, allowedTypes: T): TreeNodeSchemaClass, NodeKind.Array, TreeArrayNode & WithType, NodeKind.Array>, Iterable>, true, T, undefined>; arrayRecursive(name: Name, allowedTypes: T): TreeNodeSchemaClass, NodeKind.Array, System_Unsafe.TreeArrayNodeUnsafe & WithType, NodeKind.Array>, { [Symbol.iterator](): Iterator>; }, false, T, undefined>; protected getStructuralType(fullName: string, types: TreeNodeSchema | readonly TreeNodeSchema[], builder: () => TreeNodeSchema): TreeNodeSchema; get identifier(): FieldSchema; map(allowedTypes: T): TreeNodeSchemaNonClass`>, NodeKind.Map, TreeMapNode & WithType`>, NodeKind.Map>, MapNodeInsertableData, true, T, undefined>; map(name: Name, allowedTypes: T): TreeNodeSchemaClass, NodeKind.Map, TreeMapNode & WithType, NodeKind.Map>, MapNodeInsertableData, true, T, undefined>; mapRecursive(name: Name, allowedTypes: T): TreeNodeSchemaClass, NodeKind.Map, System_Unsafe.TreeMapNodeUnsafe & WithType, NodeKind.Map>, { [Symbol.iterator](): Iterator<[string, System_Unsafe.InsertableTreeNodeFromImplicitAllowedTypesUnsafe]>; } | { readonly [P in string]: System_Unsafe.InsertableTreeNodeFromImplicitAllowedTypesUnsafe; }, false, T, undefined>; object>(name: Name, fields: T, options?: ObjectSchemaOptions): TreeNodeSchemaClass, NodeKind.Object, TreeObjectNode>, object & InsertableObjectFromSchemaRecord, true, T>; objectRecursive>(name: Name, t: T, options?: ObjectSchemaOptions): TreeNodeSchemaClass, NodeKind.Object, System_Unsafe.TreeObjectNodeUnsafe>, object & System_Unsafe.InsertableObjectFromSchemaRecordUnsafe, false, T>; readonly scope: TScope; scopedFactory(name: T, settings?: SchemaFactoryOptions): SchemaFactory>; readonly settings: SchemaFactoryOptions; } // @public @system export const SchemaFactory_base: SchemaStatics & (new () => SchemaStatics); // @beta export class SchemaFactoryBeta extends SchemaFactory { constructor(scopeOrOptions: TScope | (SchemaFactoryBetaOptions & { readonly scope: TScope; })); object, const TCustomMetadata = unknown>(name: Name, fields: T, options?: ObjectSchemaOptionsBeta): TreeNodeSchemaClass, NodeKind.Object, TreeObjectNode>, object & InsertableObjectFromSchemaRecord, true, T, never, TCustomMetadata>; objectRecursive, const TCustomMetadata = unknown>(name: Name, t: T, options?: ObjectSchemaOptionsBeta): TreeNodeSchemaClass, NodeKind.Object, System_Unsafe.TreeObjectNodeUnsafe>, object & System_Unsafe.InsertableObjectFromSchemaRecordUnsafe, false, T, never, TCustomMetadata>; record(allowedTypes: T): TreeNodeSchemaNonClass`>, NodeKind.Record, TreeRecordNode & WithType`>, NodeKind.Record>, RecordNodeInsertableData, true, T, undefined>; record(name: Name, allowedTypes: T, options?: NodeSchemaOptions): TreeNodeSchemaClass, NodeKind.Record, TreeRecordNode & WithType, NodeKind.Record>, RecordNodeInsertableData, true, T, undefined, TCustomMetadata>; recordRecursive(name: Name, allowedTypes: T, options?: NodeSchemaOptions): TreeNodeSchemaClass, NodeKind.Record, TreeRecordNodeUnsafe & WithType, NodeKind.Record>, { readonly [P in string]: System_Unsafe.InsertableTreeNodeFromImplicitAllowedTypesUnsafe; }, false, T, undefined, TCustomMetadata>; scopedFactory(name: T, settings?: SchemaFactoryBetaOptions): SchemaFactoryBeta>; readonly settings: SchemaFactoryBetaOptions; static staged: >(t: T | AnnotatedAllowedType) => AnnotatedAllowedType; staged: >(t: T | AnnotatedAllowedType) => AnnotatedAllowedType; static stagedRecursive: >>(t: T) => AnnotatedAllowedTypeUnsafe>; stagedRecursive: >>(t: T) => AnnotatedAllowedTypeUnsafe>; static types: )[]>(t: T, metadata?: AllowedTypesMetadata) => AllowedTypesFullFromMixed; types: )[]>(t: T, metadata?: AllowedTypesMetadata) => AllowedTypesFullFromMixed; static typesRecursive: >[]>(t: T, metadata?: AllowedTypesMetadata) => AllowedTypesFullFromMixedUnsafe; typesRecursive: >[]>(t: T, metadata?: AllowedTypesMetadata) => AllowedTypesFullFromMixedUnsafe; } // @beta @input export interface SchemaFactoryBetaOptions extends SchemaFactoryOptions { readonly objectOptions?: ObjectSchemaOptionsBeta; } // @public @input export interface SchemaFactoryOptions { readonly objectOptions?: ObjectSchemaOptions; } // @public @system const schemaIdentifierBrand: unique symbol; // @public @sealed @system export interface SchemaStatics { readonly boolean: LeafSchema<"boolean", boolean>; readonly handle: LeafSchema<"handle", IFluidHandle>; readonly leaves: readonly [ SchemaStatics["string"], SchemaStatics["number"], SchemaStatics["boolean"], SchemaStatics["null"], SchemaStatics["handle"] ]; readonly null: LeafSchema<"null", null>; readonly number: LeafSchema<"number", number>; readonly optional: (t: T, props?: Omit, "defaultProvider">) => FieldSchema; readonly optionalRecursive: (t: T, props?: Omit, "defaultProvider">) => System_Unsafe.FieldSchemaUnsafe; readonly required: (t: T, props?: Omit, "defaultProvider">) => FieldSchema; readonly requiredRecursive: (t: T, props?: Omit, "defaultProvider">) => System_Unsafe.FieldSchemaUnsafe; readonly string: LeafSchema<"string", string>; } // @beta @sealed @system export interface SchemaStaticsBeta { readonly staged: >(t: T | AnnotatedAllowedType) => AnnotatedAllowedType; stagedRecursive: >>(t: T) => AnnotatedAllowedTypeUnsafe>; readonly types: )[]>(t: T, metadata?: AllowedTypesMetadata) => AllowedTypesFullFromMixed; readonly typesRecursive: >[]>(t: T, metadata?: AllowedTypesMetadata) => AllowedTypesFullFromMixedUnsafe; } // @beta @sealed export class SchemaUpgrade { // (undocumented) protected _typeCheck: MakeNominal; } // @public @system type ScopedSchemaName = TScope extends undefined ? `${TName}` : `${TScope}.${TName}`; // @beta @legacy export interface SequenceDeltaEvent extends SequenceEvent { readonly isLocal: boolean; // (undocumented) readonly opArgs: IMergeTreeDeltaOpArgs; } // @beta @legacy export interface SequenceEvent { readonly clientId: string | undefined; // (undocumented) readonly deltaArgs: IMergeTreeDeltaCallbackArgs; // (undocumented) readonly deltaOperation: TOperation; readonly first: Readonly>; readonly last: Readonly>; readonly ranges: readonly Readonly>[]; } // @beta @legacy export interface SequenceInterval extends IInterval { compare(b: SequenceInterval): number; compareEnd(b: SequenceInterval): number; compareStart(b: SequenceInterval): number; readonly end: LocalReferencePosition; // (undocumented) readonly endSide: Side; getIntervalId(): string; // (undocumented) readonly intervalType: IntervalType; // (undocumented) overlaps(b: SequenceInterval): boolean; // (undocumented) overlapsPos(bstart: number, bend: number): boolean; properties: PropertySet; // (undocumented) readonly start: LocalReferencePosition; // (undocumented) readonly startSide: Side; // (undocumented) readonly stickiness: IntervalStickiness; } // @beta @legacy export interface SequenceIntervalIndex { add(interval: SequenceInterval): void; remove(interval: SequenceInterval): void; } // @beta @legacy export interface SequenceMaintenanceEvent extends SequenceEvent { // (undocumented) readonly opArgs: IMergeTreeDeltaOpArgs | undefined; } export { SequencePlace } // @beta @legacy export const SharedDirectory: ISharedObjectKind & SharedObjectKind; // @beta @legacy export type SharedDirectory = ISharedDirectory; // @beta @legacy export const SharedMap: ISharedObjectKind & SharedObjectKind; // @beta @legacy export type SharedMap = ISharedMap; // @public @sealed export interface SharedObjectKind extends ErasedType { is(value: IFluidLoadable): value is IFluidLoadable & TSharedObject; } // @beta @legacy export const SharedString: ISharedObjectKind & SharedObjectKind; // @beta @legacy export type SharedString = ISharedString; // @beta @legacy export interface SharedStringOptions { readonly newMergeTreeSnapshotFormat?: boolean; } // @beta @legacy (undocumented) export type SharedStringSegment = TextSegment | Marker; // @public export const SharedTree: SharedObjectKind; // @beta @input export interface SharedTreeOptionsBeta extends ForestOptions, Partial { readonly healUnresolvableIdentifiersOnDecode?: boolean; } export { Side } // @public @sealed @system export interface SimpleNodeSchemaBase { readonly kind: TNodeKind; readonly metadata: NodeSchemaMetadata; } // @beta export function singletonSchema(factory: SchemaFactory, name: TName): TreeNodeSchemaClass, NodeKind.Object, TreeNode & { readonly value: TName; }, Record, true, Record, undefined>; // @beta @input export interface SnapshotFileSystem { join(parentPath: string, childPath: string): string; mkdirSync(dir: string, options: { recursive: true; }): void; readdirSync(dir: string): readonly string[]; readFileSync(file: string, encoding: "utf8"): string; writeFileSync(file: string, data: string, options: { encoding: "utf8"; }): void; } // @beta export function snapshotSchemaCompatibility(options: SnapshotSchemaCompatibilityOptions): void; // @beta @input export interface SnapshotSchemaCompatibilityOptions { readonly fileSystem: SnapshotFileSystem; readonly minVersionForCollaboration: string; readonly mode: "assert" | "update"; readonly rejectSchemaChangesWithNoVersionChange?: true; readonly rejectVersionsWithNoSchemaChange?: true; readonly schema: TreeViewConfiguration; readonly snapshotDirectory: string; readonly snapshotFileNameFormat?: { readonly prefix?: string; readonly suffix?: string; }; readonly snapshotUnchangedVersions?: true; readonly version: string; readonly versionComparer?: (a: string, b: string) => number; } // @beta @system export namespace System_TableSchema { // @sealed @system export type ColumnSchemaBase = ReturnType>; // @system export type CreateColumnOptionsBase = SchemaFactoryBeta, TCellSchema extends ImplicitAllowedTypes = ImplicitAllowedTypes> = OptionsWithSchemaFactory & OptionsWithCellSchema; // @system export function createColumnSchema(inputSchemaFactory: SchemaFactoryBeta, propsSchema: TPropsSchema): TreeNodeSchemaClass`, "Column">, NodeKind.Object, TreeNode & TableSchema.Column & WithType`, "Column">, NodeKind, unknown>, object & { readonly id?: string | undefined; } & (FieldHasDefault extends true ? { props?: InsertableTreeFieldFromImplicitField; } : { props: InsertableTreeFieldFromImplicitField; }), true, { readonly props: TPropsSchema; readonly id: FieldSchema, unknown>; }>; // @system export type CreateRowOptionsBase = SchemaFactoryBeta, TCellSchema extends ImplicitAllowedTypes = ImplicitAllowedTypes> = OptionsWithSchemaFactory & OptionsWithCellSchema; // @system export function createRowSchema(inputSchemaFactory: SchemaFactoryBeta, cellSchema: TCellSchema, propsSchema: TPropsSchema): TreeNodeSchemaClass`, "Row">, NodeKind.Object, TreeNode & TableSchema.Row & WithType`, "Row">, NodeKind, unknown>, object & { readonly id?: string | undefined; readonly cells: (InsertableTypedNode`, "Row.cells">, NodeKind.Record, TreeRecordNode & WithType`, "Row.cells">, NodeKind.Record, unknown>, RecordNodeInsertableData, true, TCellSchema, undefined, unknown>> | undefined) & InsertableTypedNode`, "Row.cells">, NodeKind.Record, TreeRecordNode & WithType`, "Row.cells">, NodeKind.Record, unknown>, RecordNodeInsertableData, true, TCellSchema, undefined, unknown>>; } & (FieldHasDefault extends true ? { props?: InsertableTreeFieldFromImplicitField; } : { props: InsertableTreeFieldFromImplicitField; }), true, { readonly props: TPropsSchema; readonly id: FieldSchema, unknown>; readonly cells: FieldSchema`, "Row.cells">, NodeKind.Record, TreeRecordNode & WithType`, "Row.cells">, NodeKind.Record, unknown>, RecordNodeInsertableData, true, TCellSchema, undefined, unknown>, unknown>; }>; // @system export function createTableSchema, const TRowSchema extends RowSchemaBase>(inputSchemaFactory: SchemaFactoryBeta, _cellSchema: TCellSchema, columnSchema: TColumnSchema, rowSchema: TRowSchema): { create TreeNode & TableSchema.Table & WithType`, "TableRoot">, NodeKind, unknown>>(this: TThis, initialContents?: TableSchema.TableFactoryMethodParameters | undefined): InstanceType; } & (new (data?: InternalTreeNode | undefined) => TreeNode & TableSchema.Table & WithType`, "TableRoot">, NodeKind, unknown>) & TreeNodeSchemaCore`, "TableRoot"> & string, NodeKind, false, unknown, never, unknown> & (new (data: InternalTreeNode) => TreeNode & TableSchema.Table & WithType`, "TableRoot">, NodeKind, unknown> & WithType`, "TableRoot"> & string, NodeKind, unknown>); // @system export type DefaultPropsType = ReturnType>; // @system export interface OptionsWithCellSchema { readonly cell: TCellSchema; } // @system export interface OptionsWithSchemaFactory { readonly schemaFactory: TSchemaFactory; } // @system export type RearrangeableList = TreeNode & readonly TreeNodeFromImplicitAllowedTypes[] & { moveToEnd(sourceIndex: number): void; moveToStart(sourceIndex: number): void; moveToIndex(sourceIndex: number, destinationIndex: number): void; moveRangeToEnd(startIndex: number, endIndex: number): void; moveRangeToStart(startIndex: number, endIndex: number): void; moveRangeToIndex(startIndex: number, endIndex: number, destinationIndex: number): void; }; // @sealed @system export type RowSchemaBase = ReturnType>; // @system export type TableFactoryOptionsBase = SchemaFactoryBeta, TCellSchema extends ImplicitAllowedTypes = ImplicitAllowedTypes> = OptionsWithSchemaFactory & OptionsWithCellSchema; // @sealed @system export type TableSchemaBase, TRowSchema extends RowSchemaBase> = ReturnType>; } // @public @system export namespace System_Unsafe { // @system export type AllowedTypesUnsafe = readonly LazyItem[]; // @sealed @system export type FieldHasDefaultUnsafe = T extends FieldSchemaUnsafe ? true : false; // @sealed @system export interface FieldSchemaUnsafe extends FieldSchema { // (undocumented) readonly allowedTypes: Types; // (undocumented) readonly allowedTypeSet: ReadonlySet; // (undocumented) readonly kind: Kind; } // @system export type ImplicitAllowedTypesUnsafe = TreeNodeSchemaUnsafe | readonly LazyItem>[]; // @system export type ImplicitFieldSchemaUnsafe = FieldSchemaUnsafe | ImplicitAllowedTypesUnsafe; // @system export type InsertableObjectFromSchemaRecordUnsafe> = { readonly [Property in keyof T as FieldHasDefaultUnsafe extends false ? Property : never]: InsertableTreeFieldFromImplicitFieldUnsafe; } & { readonly [Property in keyof T as FieldHasDefaultUnsafe extends true ? Property : never]?: InsertableTreeFieldFromImplicitFieldUnsafe; }; // @system export type InsertableTreeFieldFromImplicitFieldUnsafe> = [TSchema] extends [FieldSchemaUnsafe] ? ApplyKindInput, Kind, true> : [TSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypesUnsafe : never; // @system export type InsertableTreeNodeFromAllowedTypesUnsafe = IsUnion extends true ? never : { readonly [Property in keyof TList]: TList[Property] extends LazyItem ? InsertableTypedNodeUnsafe : never; }[NumberKeys]; // @system export type InsertableTreeNodeFromImplicitAllowedTypesUnsafe = [TSchema] extends [TreeNodeSchemaUnsafe] ? InsertableTypedNodeUnsafe : [TSchema] extends [AllowedTypesUnsafe] ? InsertableTreeNodeFromAllowedTypesUnsafe : never; // @system export type InsertableTypedNodeUnsafe> = (T extends TreeNodeSchemaUnsafe ? NodeBuilderDataUnsafe : never) | (T extends TreeNodeSchemaUnsafe ? NodeFromSchemaUnsafe : never); // @system export type NodeBuilderDataUnsafe> = T extends TreeNodeSchemaUnsafe ? TBuild : never; // @system export type NodeFromSchemaUnsafe> = T extends TreeNodeSchemaUnsafe ? TNode : never; // @system export type ObjectFromSchemaRecordUnsafe> = { -readonly [Property in keyof T]: Property extends string ? TreeFieldFromImplicitFieldUnsafe : unknown; }; // @sealed @system export interface ReadonlyMapInlined { [Symbol.iterator](): FluidIterableIterator<[K, TreeNodeFromImplicitAllowedTypesUnsafe]>; // (undocumented) readonly [Symbol.toStringTag]: string; entries(): FluidIterableIterator<[K, TreeNodeFromImplicitAllowedTypesUnsafe]>; // (undocumented) forEach(callbackfn: (value: TreeNodeFromImplicitAllowedTypesUnsafe, key: K, map: FluidReadonlyMap>) => void, thisArg?: any): void; // (undocumented) get(key: K): TreeNodeFromImplicitAllowedTypesUnsafe | undefined; // (undocumented) has(key: K): boolean; keys(): FluidIterableIterator; // (undocumented) readonly size: number; values(): FluidIterableIterator>; } // @sealed @system export interface TreeArrayNodeUnsafe extends TreeArrayNode, InsertableTreeNodeFromImplicitAllowedTypesUnsafe> { } // @system export type TreeFieldFromImplicitFieldUnsafe = TSchema extends FieldSchemaUnsafe ? ApplyKind, Kind> : TSchema extends ImplicitAllowedTypesUnsafe ? TreeNodeFromImplicitAllowedTypesUnsafe : unknown; // @sealed @system export interface TreeMapNodeUnsafe extends ReadonlyMapInlined, TreeNode { delete(key: string): void; set(key: string, value: InsertableTreeNodeFromImplicitAllowedTypesUnsafe | undefined): void; } // @system export type TreeNodeFromImplicitAllowedTypesUnsafe = TSchema extends TreeNodeSchemaUnsafe ? NodeFromSchemaUnsafe : TSchema extends AllowedTypesUnsafe ? NodeFromSchemaUnsafe> : unknown; // @system export interface TreeNodeSchemaClassUnsafe, in TInsertable, out ImplicitlyConstructable extends boolean, out Info, out TCustomMetadata = unknown> extends TreeNodeSchemaCore { // @sealed new (data: TInsertable | InternalTreeNode): Unhydrated; } // @system export interface TreeNodeSchemaNonClassUnsafe, in TInsertable, out ImplicitlyConstructable extends boolean, out Info = unknown> extends TreeNodeSchemaCore { // (undocumented) create(data: TInsertable): TNode; } // @system export type TreeNodeSchemaUnsafe = unknown, TBuild = never, ImplicitlyConstructable extends boolean = boolean, Info = unknown> = TreeNodeSchemaClassUnsafe | TreeNodeSchemaNonClassUnsafe; // @system export type TreeObjectNodeUnsafe, TypeName extends string = string> = TreeNode & ObjectFromSchemaRecordUnsafe & WithType; } // @beta export namespace TableSchema { // @input export interface CellKey { readonly column: string | number | TreeNodeFromImplicitAllowedTypes; readonly row: string | number | TreeNodeFromImplicitAllowedTypes; } // @sealed export interface Column { readonly id: string; get props(): TreeFieldFromImplicitField; set props(value: InsertableTreeFieldFromImplicitField); } export function column(params: System_TableSchema.CreateColumnOptionsBase, TCell>): System_TableSchema.ColumnSchemaBase; export function column(params: System_TableSchema.CreateColumnOptionsBase, TCell> & { readonly props: TProps; }): System_TableSchema.ColumnSchemaBase; // @sealed export interface Row { readonly id: string; get props(): TreeFieldFromImplicitField; set props(value: InsertableTreeFieldFromImplicitField); } export function row(params: System_TableSchema.CreateRowOptionsBase, TCell>): System_TableSchema.RowSchemaBase; export function row(params: System_TableSchema.CreateRowOptionsBase, TCell> & { readonly props: TProps; }): System_TableSchema.RowSchemaBase; // @sealed export interface Table, TRow extends System_TableSchema.RowSchemaBase> { readonly columns: System_TableSchema.RearrangeableList; getCell(key: CellKey): TreeNodeFromImplicitAllowedTypes | undefined; getColumn(id: string): TreeNodeFromImplicitAllowedTypes | undefined; getColumn(index: number): TreeNodeFromImplicitAllowedTypes | undefined; getRow(id: string): TreeNodeFromImplicitAllowedTypes | undefined; getRow(index: number): TreeNodeFromImplicitAllowedTypes | undefined; insertColumns(columns: readonly InsertableTreeNodeFromImplicitAllowedTypes[], index?: number): TreeNodeFromImplicitAllowedTypes[]; insertRows(rows: readonly InsertableTreeNodeFromImplicitAllowedTypes[], index?: number): TreeNodeFromImplicitAllowedTypes[]; removeCell(row: string | number | TreeNodeFromImplicitAllowedTypes, column: string | number | TreeNodeFromImplicitAllowedTypes): TreeNodeFromImplicitAllowedTypes | undefined; removeColumns(index?: number | undefined, count?: number | undefined): TreeNodeFromImplicitAllowedTypes[]; removeColumns(columns: readonly TreeNodeFromImplicitAllowedTypes[]): TreeNodeFromImplicitAllowedTypes[]; removeColumns(columns: readonly string[]): TreeNodeFromImplicitAllowedTypes[]; removeRows(index?: number | undefined, count?: number | undefined): TreeNodeFromImplicitAllowedTypes[]; removeRows(rows: readonly TreeNodeFromImplicitAllowedTypes[]): TreeNodeFromImplicitAllowedTypes[]; removeRows(rows: readonly string[]): TreeNodeFromImplicitAllowedTypes[]; readonly rows: System_TableSchema.RearrangeableList; setCell(row: string | number | TreeNodeFromImplicitAllowedTypes, column: string | number | TreeNodeFromImplicitAllowedTypes, cell: InsertableTreeNodeFromImplicitAllowedTypes): void; } export function table(params: System_TableSchema.TableFactoryOptionsBase, TCell>): System_TableSchema.TableSchemaBase, System_TableSchema.RowSchemaBase>; export function table>(params: System_TableSchema.TableFactoryOptionsBase, TCell> & { readonly column: TColumn; }): System_TableSchema.TableSchemaBase>; export function table>(params: System_TableSchema.TableFactoryOptionsBase, TCell> & { readonly row: TRow; }): System_TableSchema.TableSchemaBase, TRow>; export function table, const TRow extends System_TableSchema.RowSchemaBase>(params: System_TableSchema.TableFactoryOptionsBase, TCell> & { readonly column: TColumn; readonly row: TRow; }): System_TableSchema.TableSchemaBase; // @input export interface TableFactoryMethodParameters, TRow extends System_TableSchema.RowSchemaBase> { readonly columns?: Iterable> | undefined; readonly rows?: Iterable> | undefined; } } // @public export interface Tagged { // (undocumented) tag: T; // (undocumented) value: V; } // @public export type TelemetryBaseEventPropertyType = string | number | boolean | undefined; // @beta @input export type TransactionCallbackStatusBeta = ((WithValue & { readonly rollback?: false; }) | (WithValue & { readonly rollback: true; })) & { readonly preconditionsOnRevert?: readonly TransactionConstraintBeta[]; }; // @public export type TransactionConstraint = NodeInDocumentConstraint; // @beta @sealed export type TransactionConstraintBeta = TransactionConstraint | NoChangeConstraint; // @beta @sealed export interface TransactionResultFailed extends WithValue { readonly success: false; } // @beta @sealed export interface TransactionResultSuccess extends WithValue { readonly success: true; } // @beta @sealed export type TransactionValueResult = TransactionResultSuccess | TransactionResultFailed; // @beta @sealed export type TransactionVoidResult = Omit, "value"> | Omit, "value">; // @public export type TransformedEvent = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder) => void) => TThis; // @public @sealed export interface Tree extends TreeNodeApi { contains(node: TreeNode, other: TreeNode): boolean; readonly runTransaction: RunTransaction; } // @public export const Tree: Tree; // @public @sealed export interface TreeArrayNode : TreeNodeFromImplicitAllowedTypes, in TNew = [TAllowedTypes] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes : InsertableTreeNodeFromImplicitAllowedTypes, in TMoveFrom = ReadonlyArrayNode> extends ReadonlyArrayNode { insertAt(index: number, ...value: readonly (TNew | IterableTreeArrayContent)[]): void; insertAtEnd(...value: readonly (TNew | IterableTreeArrayContent)[]): void; insertAtStart(...value: readonly (TNew | IterableTreeArrayContent)[]): void; moveRangeToEnd(sourceStart: number, sourceEnd: number): void; moveRangeToEnd(sourceStart: number, sourceEnd: number, source: TMoveFrom): void; moveRangeToIndex(destinationGap: number, sourceStart: number, sourceEnd: number): void; moveRangeToIndex(destinationGap: number, sourceStart: number, sourceEnd: number, source: TMoveFrom): void; moveRangeToStart(sourceStart: number, sourceEnd: number): void; moveRangeToStart(sourceStart: number, sourceEnd: number, source: TMoveFrom): void; moveToEnd(sourceIndex: number): void; moveToEnd(sourceIndex: number, source: TMoveFrom): void; moveToIndex(destinationGap: number, sourceIndex: number): void; moveToIndex(destinationGap: number, sourceIndex: number, source: TMoveFrom): void; moveToStart(sourceIndex: number): void; moveToStart(sourceIndex: number, source: TMoveFrom): void; push(...value: readonly (TNew | IterableTreeArrayContent)[]): void; removeAt(index: number): void; removeRange(start?: number, end?: number): void; values(): FluidIterableIterator; } // @public export const TreeArrayNode: { readonly spread: (content: Iterable) => IterableTreeArrayContent; }; // @beta @sealed export interface TreeBeta { clone(node: TreeFieldFromImplicitField): TreeFieldFromImplicitField; context(node: TreeNode): TreeContextBeta; create(schema: TSchema, data: InsertableTreeFieldFromImplicitField): Unhydrated>; exportConcise(node: TreeNode | TreeLeafValue, options?: TreeEncodingOptions): ConciseTree; exportConcise(node: TreeNode | TreeLeafValue | undefined, options?: TreeEncodingOptions): ConciseTree | undefined; importConcise(schema: TSchema, data: ConciseTree | undefined): Unhydrated>; on, TNode extends TreeNode>(node: TNode, eventName: K, listener: NoInfer[K]>): () => void; } // @beta export const TreeBeta: TreeBeta; // @beta @sealed export interface TreeBranchEventsBeta { changed(data: ChangeMetadataBeta): void; } // @public @sealed export interface TreeChangeEvents { nodeChanged(unstable?: unknown): void; treeChanged(unstable?: unknown): void; } // @beta @sealed export interface TreeChangeEventsBeta extends Omit { nodeChanged: (data: TNode extends WithType ? NodeChangedDataDelta : TNode extends WithType ? NodeChangedDataProperties : NodeChangedData) => void; treeChanged: TNode extends WithType ? (data: NodeChangedDataTreeDelta) => void : TreeChangeEvents["treeChanged"]; } // @beta @sealed export interface TreeContextBeta { isView(): this is UntypedTreeView; runTransaction(transaction: () => WithValue, params?: RunTransactionParamsBeta): TransactionValueResult; runTransaction(transaction: () => void, params?: RunTransactionParamsBeta): TransactionVoidResult; runTransactionAsync(transaction: () => Promise>, params?: RunTransactionParamsBeta): Promise>; runTransactionAsync(transaction: () => Promise, params?: RunTransactionParamsBeta): Promise; } // @beta @input export interface TreeEncodingOptions { readonly keys?: TKeyOptions; } // @public export type TreeFieldFromImplicitField = TSchema extends FieldSchema ? ApplyKind, Kind> : TSchema extends ImplicitAllowedTypes ? TreeNodeFromImplicitAllowedTypes : TreeNode | TreeLeafValue | undefined; // @beta @sealed export interface TreeIndex extends FluidReadonlyMap { dispose(): void; } // @beta export type TreeIndexKey = TreeLeafValue; // @beta export type TreeIndexKeyFieldSelector = ((schema: TSchema) => string | undefined) | { get(schema: TSchema): string | undefined; }; // @beta export type TreeIndexNodes = readonly [first: TNode, ...rest: TNode[]]; // @public export type TreeLeafValue = number | string | boolean | IFluidHandle | null; // @public @sealed export interface TreeMapNode extends FluidReadonlyMap>, TreeNode { delete(key: string): void; entries(): FluidIterableIterator<[string, TreeNodeFromImplicitAllowedTypes]>; forEach(callbackfn: (value: TreeNodeFromImplicitAllowedTypes, key: string, map: FluidReadonlyMap>) => void, thisArg?: any): void; keys(): FluidIterableIterator; set(key: string, value: InsertableTreeNodeFromImplicitAllowedTypes | undefined): void; values(): FluidIterableIterator>; } // @public @sealed export abstract class TreeNode implements WithType { abstract get [schemaIdentifierBrand](): string; static [Symbol.hasInstance](value: unknown): value is TreeNode; static [Symbol.hasInstance] TreeNode>(this: TSchema, value: unknown): value is InstanceType; abstract get [typeSchemaSymbol](): TreeNodeSchemaClass; protected constructor(token: unknown); } // @public @sealed export interface TreeNodeApi { is(value: unknown, schema: TSchema): value is TreeNodeFromImplicitAllowedTypes; key(node: TreeNode): string | number; on(node: TreeNode, eventName: K, listener: TreeChangeEvents[K]): () => void; parent(node: TreeNode): TreeNode | undefined; schema(node: TreeNode | TreeLeafValue): TreeNodeSchema; shortId(node: TreeNode): number | string | undefined; status(node: TreeNode): TreeStatus; } // @public export type TreeNodeFromImplicitAllowedTypes = TSchema extends TreeNodeSchema ? NodeFromSchema : TSchema extends AllowedTypes ? NodeFromSchema> : unknown; // @public @sealed export type TreeNodeSchema = (TNode extends TreeNode ? TreeNodeSchemaClass : never) | TreeNodeSchemaNonClass; // @public @sealed export type TreeNodeSchemaClass = TreeNodeSchemaCore & (undefined extends TConstructorExtra ? { new (data?: TInsertable | InternalTreeNode | TConstructorExtra): Unhydrated; } : { new (data: TInsertable | InternalTreeNode | TConstructorExtra): Unhydrated; }); // @public @sealed export interface TreeNodeSchemaCore extends SimpleNodeSchemaBase { // @system readonly childTypes: ReadonlySet; // @sealed @system createFromInsertable(data: TInsertable): Unhydrated; readonly identifier: Name; readonly implicitlyConstructable: ImplicitlyConstructable; readonly info: Info; } // @public @sealed @system export type TreeNodeSchemaNonClass = TreeNodeSchemaCore & (undefined extends TConstructorExtra ? { create(data?: TInsertable | TConstructorExtra): TNode; } : { create(data: TInsertable | TConstructorExtra): TNode; }); // @public export type TreeObjectNode, TypeName extends string = string> = TreeNode & ObjectFromSchemaRecord & WithType; // @beta export interface TreeRecordNode extends TreeNode, Record | undefined> { [Symbol.iterator](): FluidIterableIterator<[ string, TreeNodeFromImplicitAllowedTypes ]>; } // @beta @sealed @system export interface TreeRecordNodeUnsafe extends Record | undefined>, TreeNode { // (undocumented) [Symbol.iterator](): FluidIterableIterator<[ string, System_Unsafe.TreeNodeFromImplicitAllowedTypesUnsafe ]>; } // @public export enum TreeStatus { Deleted = 2, InDocument = 0, New = 3, Removed = 1 } // @public @sealed export interface TreeView extends IDisposable { readonly compatibility: SchemaCompatibilityStatus; readonly events: Listenable; initialize(content: InsertableTreeFieldFromImplicitField): void; get root(): TreeFieldFromImplicitField; set root(newRoot: InsertableTreeFieldFromImplicitField); readonly schema: TSchema; upgradeSchema(): void; } // @beta @sealed export interface TreeViewBeta extends TreeView, UntypedTreeView { // (undocumented) readonly compatibility: SchemaCompatibilityStatusBeta; readonly events: Listenable; // (undocumented) fork(): ReturnType & TreeViewBeta; } // @public @sealed export class TreeViewConfiguration implements Required> { constructor(props: ITreeViewConfiguration); readonly enableSchemaValidation: boolean; readonly preventAmbiguity: boolean; readonly schema: TSchema; // (undocumented) protected _typeCheck: MakeNominal; } // @public @sealed export interface TreeViewEvents { commitApplied(data: CommitMetadata, getRevertible?: RevertibleFactory): void; rootChanged(): void; schemaChanged(): void; } // @public @system export const typeSchemaSymbol: unique symbol; // @beta @system export type UnannotateAllowedTypesList)[]> = { [I in keyof T]: T[I] extends AnnotatedAllowedType ? X : T[I]; }; // @beta @sealed @system export type UnannotateAllowedTypesListUnsafe>[]> = { readonly [I in keyof T]: T[I] extends { type: infer X; } ? X : T[I]; }; // @beta @sealed @system export type UnannotateAllowedTypeUnsafe>> = T extends AnnotatedAllowedTypeUnsafe ? X : T; // @public export type Unenforced<_DesiredExtendsConstraint> = unknown; // @public export type Unhydrated = T; // @public @system export type UnionToIntersection = (T extends T ? (k: T) => unknown : never) extends (k: infer U) => unknown ? U : never; // @beta @system export type UnionToTuple> = IsUnion extends true ? UnionToTuple, [First, ...A]> : [Union, ...A]; // @beta @sealed export interface UntypedTreeView extends IDisposable, TreeContextBeta { dispose(error?: Error): void; readonly events: Listenable; fork(): UntypedTreeView; merge(view: UntypedTreeView, disposeMerged?: boolean): void; rebaseOnto(view: UntypedTreeView): void; // (undocumented) runTransaction(transaction: () => WithValue, params?: RunTransactionParamsBeta): TransactionValueResult; // (undocumented) runTransaction(transaction: () => void, params?: RunTransactionParamsBeta): TransactionVoidResult; runTransaction | VoidTransactionCallbackStatusBeta | void>(transaction: () => TOut, params?: RunTransactionParamsBeta): TOut extends TransactionCallbackStatusBeta ? TransactionValueResult : TransactionVoidResult; // (undocumented) runTransactionAsync(transaction: () => Promise>, params?: RunTransactionParamsBeta): Promise>; // (undocumented) runTransactionAsync(transaction: () => Promise, params?: RunTransactionParamsBeta): Promise; runTransactionAsync | VoidTransactionCallbackStatusBeta | void>(transaction: () => Promise, params?: RunTransactionParamsBeta): Promise ? TransactionValueResult : TransactionVoidResult>; } // @public export type ValidateRecursiveSchema> = true; // @public @system export type ValidateRecursiveSchemaTemplate = TreeNodeSchemaClass, { [NodeKind.Object]: T["info"] extends RestrictiveStringRecord ? InsertableObjectFromSchemaRecord : unknown; [NodeKind.Array]: T["info"] extends ImplicitAllowedTypes ? Iterable> : unknown; [NodeKind.Map]: T["info"] extends ImplicitAllowedTypes ? Iterable<[string, InsertableTreeNodeFromImplicitAllowedTypes]> : unknown; [NodeKind.Record]: { readonly [P in string]: InsertableTreeNodeFromImplicitAllowedTypes; }; [NodeKind.Leaf]: unknown; }[T["kind"]], false, { [NodeKind.Object]: RestrictiveStringRecord; [NodeKind.Array]: ImplicitAllowedTypes; [NodeKind.Map]: ImplicitAllowedTypes; [NodeKind.Record]: ImplicitAllowedTypes; [NodeKind.Leaf]: unknown; }[T["kind"]]>; // @public @sealed @system export interface ViewableTree { viewWith(config: TreeViewConfiguration): TreeView; } // @beta @input export type VoidTransactionCallbackStatusBeta = Omit, "value">; // @public @sealed export interface WithType { get [schemaIdentifierBrand](): TName; get [typeSchemaSymbol](): TreeNodeSchemaClass; } // @beta @input export interface WithValue { readonly value: TValue; } ```