fluid-framework 2.73.0 → 2.74.0-368706
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-report/fluid-framework.alpha.api.md +133 -86
- package/api-report/fluid-framework.beta.api.md +0 -2
- package/api-report/fluid-framework.legacy.beta.api.md +0 -2
- package/api-report/fluid-framework.legacy.public.api.md +0 -2
- package/api-report/fluid-framework.public.api.md +0 -2
- package/dist/alpha.d.ts +7 -2
- package/lib/alpha.d.ts +7 -2
- package/package.json +13 -13
|
@@ -93,17 +93,17 @@ Kind
|
|
|
93
93
|
] extends [FieldKind.Required] ? T : [Kind] extends [FieldKind.Optional] ? T | undefined : [Kind] extends [FieldKind.Identifier] ? DefaultsAreOptional extends true ? T | undefined : T : never;
|
|
94
94
|
|
|
95
95
|
// @alpha @sealed @system
|
|
96
|
-
export interface ArrayNodeCustomizableSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Array, TreeArrayNode<T> & WithType<TName, NodeKind.Array, T>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T>>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleArrayNodeSchema<TCustomMetadata> {
|
|
96
|
+
export interface ArrayNodeCustomizableSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Array, TreeArrayNode<T> & WithType<TName, NodeKind.Array, T>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T>>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleArrayNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
97
97
|
}
|
|
98
98
|
|
|
99
99
|
// @alpha @sealed @system
|
|
100
100
|
export interface ArrayNodeCustomizableSchemaUnsafe<out TName extends string, in out T extends System_Unsafe.ImplicitAllowedTypesUnsafe, out TCustomMetadata> extends TreeNodeSchemaClass<TName, NodeKind.Array, System_Unsafe.TreeArrayNodeUnsafe<T> & WithType<TName, NodeKind.Array, T>, {
|
|
101
101
|
[Symbol.iterator](): Iterator<System_Unsafe.InsertableTreeNodeFromImplicitAllowedTypesUnsafe<T>>;
|
|
102
|
-
}, false, T, undefined, TCustomMetadata>, SimpleArrayNodeSchema<TCustomMetadata> {
|
|
102
|
+
}, false, T, undefined, TCustomMetadata>, SimpleArrayNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
103
103
|
}
|
|
104
104
|
|
|
105
105
|
// @alpha @sealed @system
|
|
106
|
-
export interface ArrayNodePojoEmulationSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaNonClass<TName, NodeKind.Array, TreeArrayNode<T> & WithType<TName, NodeKind.Array, T>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T>>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleArrayNodeSchema<TCustomMetadata> {
|
|
106
|
+
export interface ArrayNodePojoEmulationSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaNonClass<TName, NodeKind.Array, TreeArrayNode<T> & WithType<TName, NodeKind.Array, T>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T>>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleArrayNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
107
107
|
}
|
|
108
108
|
|
|
109
109
|
// @alpha
|
|
@@ -179,6 +179,9 @@ export type ConciseTree<THandle = IFluidHandle> = Exclude<TreeLeafValue, IFluidH
|
|
|
179
179
|
// @alpha
|
|
180
180
|
export function configuredSharedTree(options: SharedTreeOptions): SharedObjectKind<ITree>;
|
|
181
181
|
|
|
182
|
+
// @alpha
|
|
183
|
+
export function configuredSharedTreeAlpha(options: SharedTreeOptions): SharedObjectKind<ITree>;
|
|
184
|
+
|
|
182
185
|
// @beta
|
|
183
186
|
export function configuredSharedTreeBeta(options: SharedTreeOptionsBeta): SharedObjectKind<ITree>;
|
|
184
187
|
|
|
@@ -247,7 +250,7 @@ export function createSimpleTreeIndex<TFieldSchema extends ImplicitFieldSchema,
|
|
|
247
250
|
export function createSimpleTreeIndex<TFieldSchema extends ImplicitFieldSchema, TKey extends TreeIndexKey, TValue, TSchema extends TreeNodeSchema>(view: TreeView<TFieldSchema>, indexer: Map<TreeNodeSchema, string>, getValue: (nodes: TreeIndexNodes<NodeFromSchema<TSchema>>) => TValue, isKeyValid: (key: TreeIndexKey) => key is TKey, indexableSchema: readonly TSchema[]): SimpleTreeIndex<TKey, TValue>;
|
|
248
251
|
|
|
249
252
|
// @alpha
|
|
250
|
-
export function
|
|
253
|
+
export function decodeSchemaCompatibilitySnapshot(encodedSchema: JsonCompatibleReadOnly, validator?: FormatValidator): SimpleTreeSchema;
|
|
251
254
|
|
|
252
255
|
// @public @sealed @system
|
|
253
256
|
interface DefaultProvider extends ErasedType<"@fluidframework/tree.FieldProvider"> {
|
|
@@ -265,7 +268,7 @@ export interface DirtyTreeMap {
|
|
|
265
268
|
export type DirtyTreeStatus = "new" | "changed" | "moved";
|
|
266
269
|
|
|
267
270
|
// @alpha
|
|
268
|
-
export function
|
|
271
|
+
export function encodeSchemaCompatibilitySnapshot(simpleSchema: SimpleTreeSchema): JsonCompatibleReadOnly;
|
|
269
272
|
|
|
270
273
|
// @beta
|
|
271
274
|
export function enumFromStrings<TScope extends string, const Members extends readonly string[]>(factory: SchemaFactory<TScope>, members: Members): (<TValue extends Members[number]>(value: TValue) => TValue extends unknown ? TreeNode & {
|
|
@@ -350,7 +353,7 @@ export class FieldSchema<out Kind extends FieldKind = FieldKind, out Types exten
|
|
|
350
353
|
}
|
|
351
354
|
|
|
352
355
|
// @alpha @sealed
|
|
353
|
-
export class FieldSchemaAlpha<Kind extends FieldKind = FieldKind, Types extends ImplicitAllowedTypes = ImplicitAllowedTypes, TCustomMetadata = unknown> extends FieldSchema<Kind, Types, TCustomMetadata> implements SimpleFieldSchema {
|
|
356
|
+
export class FieldSchemaAlpha<Kind extends FieldKind = FieldKind, Types extends ImplicitAllowedTypes = ImplicitAllowedTypes, TCustomMetadata = unknown> extends FieldSchema<Kind, Types, TCustomMetadata> implements SimpleFieldSchema<SchemaType.View> {
|
|
354
357
|
protected constructor(kind: Kind, types: Types, props?: FieldPropsAlpha<TCustomMetadata>);
|
|
355
358
|
readonly allowedTypesFull: AllowedTypesFull;
|
|
356
359
|
// (undocumented)
|
|
@@ -358,7 +361,7 @@ export class FieldSchemaAlpha<Kind extends FieldKind = FieldKind, Types extends
|
|
|
358
361
|
// (undocumented)
|
|
359
362
|
get persistedMetadata(): JsonCompatibleReadOnlyObject | undefined;
|
|
360
363
|
// (undocumented)
|
|
361
|
-
get simpleAllowedTypes(): ReadonlyMap<string, SimpleAllowedTypeAttributes
|
|
364
|
+
get simpleAllowedTypes(): ReadonlyMap<string, SimpleAllowedTypeAttributes<SchemaType.View>>;
|
|
362
365
|
}
|
|
363
366
|
|
|
364
367
|
// @alpha @sealed @system
|
|
@@ -392,6 +395,7 @@ export const FluidClientVersion: {
|
|
|
392
395
|
readonly v2_43: "2.43.0";
|
|
393
396
|
readonly v2_52: "2.52.0";
|
|
394
397
|
readonly v2_73: "2.73.0";
|
|
398
|
+
readonly v2_74: "2.74.0";
|
|
395
399
|
};
|
|
396
400
|
|
|
397
401
|
// @public
|
|
@@ -467,7 +471,7 @@ export function getBranch<T extends ImplicitFieldSchema | UnsafeUnknownSchema>(v
|
|
|
467
471
|
export function getJsonSchema(schema: ImplicitAllowedTypes, options: Required<TreeSchemaEncodingOptions>): JsonTreeSchema;
|
|
468
472
|
|
|
469
473
|
// @alpha
|
|
470
|
-
export function getSimpleSchema(schema: ImplicitFieldSchema): SimpleTreeSchema
|
|
474
|
+
export function getSimpleSchema(schema: ImplicitFieldSchema): SimpleTreeSchema<SchemaType.View>;
|
|
471
475
|
|
|
472
476
|
// @alpha
|
|
473
477
|
export type HandleConverter<TCustom> = (data: IFluidHandle) => TCustom;
|
|
@@ -741,11 +745,20 @@ export type ImplicitFieldSchema = FieldSchema | ImplicitAllowedTypes;
|
|
|
741
745
|
// @alpha
|
|
742
746
|
export function importCompatibilitySchemaSnapshot(config: JsonCompatibleReadOnly): TreeViewConfiguration;
|
|
743
747
|
|
|
748
|
+
// @alpha
|
|
749
|
+
export type IncrementalEncodingPolicy = (nodeIdentifier: string | undefined, fieldKey?: string) => boolean;
|
|
750
|
+
|
|
751
|
+
// @alpha
|
|
752
|
+
export function incrementalEncodingPolicyForAllowedTypes(rootSchema: TreeSchema): IncrementalEncodingPolicy;
|
|
753
|
+
|
|
754
|
+
// @alpha
|
|
755
|
+
export const incrementalSummaryHint: unique symbol;
|
|
756
|
+
|
|
744
757
|
// @alpha
|
|
745
758
|
export function independentInitializedView<const TSchema extends ImplicitFieldSchema>(config: TreeViewConfiguration<TSchema>, options: ForestOptions & ICodecOptions, content: ViewContent): TreeViewAlpha<TSchema>;
|
|
746
759
|
|
|
747
760
|
// @alpha
|
|
748
|
-
export function independentView<const TSchema extends ImplicitFieldSchema>(config: TreeViewConfiguration<TSchema>, options
|
|
761
|
+
export function independentView<const TSchema extends ImplicitFieldSchema>(config: TreeViewConfiguration<TSchema>, options?: ForestOptions & {
|
|
749
762
|
idCompressor?: IIdCompressor_2 | undefined;
|
|
750
763
|
}): TreeViewAlpha<TSchema>;
|
|
751
764
|
|
|
@@ -1012,7 +1025,6 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
|
|
|
1012
1025
|
// @public @sealed
|
|
1013
1026
|
export interface Listenable<TListeners extends object> {
|
|
1014
1027
|
off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
|
|
1015
|
-
// (undocumented)
|
|
1016
1028
|
on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
|
|
1017
1029
|
}
|
|
1018
1030
|
|
|
@@ -1026,7 +1038,7 @@ export interface MakeNominal {
|
|
|
1026
1038
|
}
|
|
1027
1039
|
|
|
1028
1040
|
// @alpha @sealed @system
|
|
1029
|
-
export interface MapNodeCustomizableSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Map, TreeMapNode<T> & WithType<TName, NodeKind.Map, T>, MapNodeInsertableData<T>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleMapNodeSchema<TCustomMetadata> {
|
|
1041
|
+
export interface MapNodeCustomizableSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Map, TreeMapNode<T> & WithType<TName, NodeKind.Map, T>, MapNodeInsertableData<T>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleMapNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
1030
1042
|
}
|
|
1031
1043
|
|
|
1032
1044
|
// @alpha @sealed @system
|
|
@@ -1037,14 +1049,14 @@ export interface MapNodeCustomizableSchemaUnsafe<out TName extends string, in ou
|
|
|
1037
1049
|
]>;
|
|
1038
1050
|
} | {
|
|
1039
1051
|
readonly [P in string]: System_Unsafe.InsertableTreeNodeFromImplicitAllowedTypesUnsafe<T>;
|
|
1040
|
-
}, false, T, undefined, TCustomMetadata>, SimpleMapNodeSchema<TCustomMetadata> {
|
|
1052
|
+
}, false, T, undefined, TCustomMetadata>, SimpleMapNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
1041
1053
|
}
|
|
1042
1054
|
|
|
1043
1055
|
// @public @system
|
|
1044
1056
|
export type MapNodeInsertableData<T extends ImplicitAllowedTypes> = Iterable<readonly [string, InsertableTreeNodeFromImplicitAllowedTypes<T>]> | RestrictiveStringRecord<InsertableTreeNodeFromImplicitAllowedTypes<T>>;
|
|
1045
1057
|
|
|
1046
1058
|
// @alpha @sealed @system
|
|
1047
|
-
export interface MapNodePojoEmulationSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaNonClass<TName, NodeKind.Map, TreeMapNode<T> & WithType<TName, NodeKind.Map, T>, MapNodeInsertableData<T>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleMapNodeSchema<TCustomMetadata> {
|
|
1059
|
+
export interface MapNodePojoEmulationSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaNonClass<TName, NodeKind.Map, TreeMapNode<T> & WithType<TName, NodeKind.Map, T>, MapNodeInsertableData<T>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleMapNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
1048
1060
|
}
|
|
1049
1061
|
|
|
1050
1062
|
// @alpha
|
|
@@ -1121,7 +1133,7 @@ export type ObjectFromSchemaRecord<T extends RestrictiveStringRecord<ImplicitFie
|
|
|
1121
1133
|
};
|
|
1122
1134
|
|
|
1123
1135
|
// @alpha @sealed
|
|
1124
|
-
export interface ObjectNodeSchema<out TName extends string = string, in out T extends RestrictiveStringRecord<ImplicitFieldSchema> = RestrictiveStringRecord<ImplicitFieldSchema>, ImplicitlyConstructable extends boolean = boolean, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Object, TreeObjectNode<T, TName>, InsertableObjectFromSchemaRecord<T>, ImplicitlyConstructable, T, never, TCustomMetadata>, SimpleObjectNodeSchema<TCustomMetadata> {
|
|
1136
|
+
export interface ObjectNodeSchema<out TName extends string = string, in out T extends RestrictiveStringRecord<ImplicitFieldSchema> = RestrictiveStringRecord<ImplicitFieldSchema>, ImplicitlyConstructable extends boolean = boolean, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Object, TreeObjectNode<T, TName>, InsertableObjectFromSchemaRecord<T>, ImplicitlyConstructable, T, never, TCustomMetadata>, SimpleObjectNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
1125
1137
|
readonly fields: ReadonlyMap<string, FieldSchemaAlpha & SimpleObjectFieldSchema>;
|
|
1126
1138
|
}
|
|
1127
1139
|
|
|
@@ -1170,14 +1182,14 @@ TSchema
|
|
|
1170
1182
|
] extends [ImplicitFieldSchema] ? TSchema : ImplicitFieldSchema;
|
|
1171
1183
|
|
|
1172
1184
|
// @alpha @sealed @system
|
|
1173
|
-
export interface RecordNodeCustomizableSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Record, TreeRecordNode<T> & WithType<TName, NodeKind.Record, T>, RecordNodeInsertableData<T>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleRecordNodeSchema<TCustomMetadata> {
|
|
1185
|
+
export interface RecordNodeCustomizableSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaClass<TName, NodeKind.Record, TreeRecordNode<T> & WithType<TName, NodeKind.Record, T>, RecordNodeInsertableData<T>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleRecordNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
1174
1186
|
}
|
|
1175
1187
|
|
|
1176
1188
|
// @beta @system
|
|
1177
1189
|
export type RecordNodeInsertableData<T extends ImplicitAllowedTypes> = RestrictiveStringRecord<InsertableTreeNodeFromImplicitAllowedTypes<T>>;
|
|
1178
1190
|
|
|
1179
1191
|
// @alpha @sealed @system
|
|
1180
|
-
export interface RecordNodePojoEmulationSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaNonClass<TName, NodeKind.Record, TreeRecordNode<T> & WithType<TName, NodeKind.Record, T>, RecordNodeInsertableData<T>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleRecordNodeSchema<TCustomMetadata> {
|
|
1192
|
+
export interface RecordNodePojoEmulationSchema<out TName extends string = string, in out T extends ImplicitAllowedTypes = ImplicitAllowedTypes, out ImplicitlyConstructable extends boolean = true, out TCustomMetadata = unknown> extends TreeNodeSchemaNonClass<TName, NodeKind.Record, TreeRecordNode<T> & WithType<TName, NodeKind.Record, T>, RecordNodeInsertableData<T>, ImplicitlyConstructable, T, undefined, TCustomMetadata>, SimpleRecordNodeSchema<SchemaType.View, TCustomMetadata> {
|
|
1181
1193
|
}
|
|
1182
1194
|
|
|
1183
1195
|
// @alpha
|
|
@@ -1305,15 +1317,15 @@ export const SchemaFactory_base: SchemaStatics & (new () => SchemaStatics);
|
|
|
1305
1317
|
export class SchemaFactoryAlpha<out TScope extends string | undefined = string | undefined, TName extends number | string = string> extends SchemaFactoryBeta<TScope, TName> {
|
|
1306
1318
|
arrayAlpha<const Name extends TName, const T extends ImplicitAllowedTypes, const TCustomMetadata = unknown>(name: Name, allowedTypes: T, options?: NodeSchemaOptionsAlpha<TCustomMetadata>): ArrayNodeCustomizableSchema<ScopedSchemaName<TScope, Name>, T, true, TCustomMetadata>;
|
|
1307
1319
|
arrayRecursive<const Name extends TName, const T extends System_Unsafe.ImplicitAllowedTypesUnsafe, const TCustomMetadata = unknown>(name: Name, allowedTypes: T, options?: NodeSchemaOptionsAlpha<TCustomMetadata>): ArrayNodeCustomizableSchemaUnsafe<ScopedSchemaName<TScope, Name>, T, TCustomMetadata>;
|
|
1308
|
-
static readonly identifier: <const TCustomMetadata = unknown>(props?: Omit<FieldProps<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlpha<FieldKind.Identifier, LeafSchema<"string", string> & SimpleLeafNodeSchema
|
|
1309
|
-
static readonly leaves: readonly [LeafSchema<"string", string> & SimpleLeafNodeSchema
|
|
1310
|
-
readonly leaves: readonly [LeafSchema<"string", string> & SimpleLeafNodeSchema
|
|
1320
|
+
static readonly identifier: <const TCustomMetadata = unknown>(props?: Omit<FieldProps<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlpha<FieldKind.Identifier, LeafSchema<"string", string> & SimpleLeafNodeSchema<SchemaType>, TCustomMetadata>;
|
|
1321
|
+
static readonly leaves: readonly [LeafSchema<"string", string> & SimpleLeafNodeSchema<SchemaType>, LeafSchema<"number", number> & SimpleLeafNodeSchema<SchemaType>, LeafSchema<"boolean", boolean> & SimpleLeafNodeSchema<SchemaType>, LeafSchema<"null", null> & SimpleLeafNodeSchema<SchemaType>, LeafSchema<"handle", IFluidHandle_2<unknown>> & SimpleLeafNodeSchema<SchemaType>];
|
|
1322
|
+
readonly leaves: readonly [LeafSchema<"string", string> & SimpleLeafNodeSchema<SchemaType>, LeafSchema<"number", number> & SimpleLeafNodeSchema<SchemaType>, LeafSchema<"boolean", boolean> & SimpleLeafNodeSchema<SchemaType>, LeafSchema<"null", null> & SimpleLeafNodeSchema<SchemaType>, LeafSchema<"handle", IFluidHandle_2<unknown>> & SimpleLeafNodeSchema<SchemaType>];
|
|
1311
1323
|
mapAlpha<Name extends TName, const T extends ImplicitAllowedTypes, const TCustomMetadata = unknown>(name: Name, allowedTypes: T, options?: NodeSchemaOptionsAlpha<TCustomMetadata>): MapNodeCustomizableSchema<ScopedSchemaName<TScope, Name>, T, true, TCustomMetadata>;
|
|
1312
1324
|
mapRecursive<Name extends TName, const T extends System_Unsafe.ImplicitAllowedTypesUnsafe, const TCustomMetadata = unknown>(name: Name, allowedTypes: T, options?: NodeSchemaOptionsAlpha<TCustomMetadata>): MapNodeCustomizableSchemaUnsafe<ScopedSchemaName<TScope, Name>, T, TCustomMetadata>;
|
|
1313
1325
|
objectAlpha<const Name extends TName, const T extends RestrictiveStringRecord<ImplicitFieldSchema>, const TCustomMetadata = unknown>(name: Name, fields: T, options?: ObjectSchemaOptionsAlpha<TCustomMetadata>): ObjectNodeSchema<ScopedSchemaName<TScope, Name>, T, true, TCustomMetadata> & {
|
|
1314
1326
|
readonly createFromInsertable: unknown;
|
|
1315
1327
|
};
|
|
1316
|
-
objectRecursive<const Name extends TName, const T extends RestrictiveStringRecord<System_Unsafe.ImplicitFieldSchemaUnsafe>, const TCustomMetadata = unknown>(name: Name, t: T, options?: ObjectSchemaOptionsAlpha<TCustomMetadata>): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Object, System_Unsafe.TreeObjectNodeUnsafe<T, ScopedSchemaName<TScope, Name>>, object & System_Unsafe.InsertableObjectFromSchemaRecordUnsafe<T>, false, T, never, TCustomMetadata> & SimpleObjectNodeSchema<TCustomMetadata> & Pick<ObjectNodeSchema, "fields">;
|
|
1328
|
+
objectRecursive<const Name extends TName, const T extends RestrictiveStringRecord<System_Unsafe.ImplicitFieldSchemaUnsafe>, const TCustomMetadata = unknown>(name: Name, t: T, options?: ObjectSchemaOptionsAlpha<TCustomMetadata>): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Object, System_Unsafe.TreeObjectNodeUnsafe<T, ScopedSchemaName<TScope, Name>>, object & System_Unsafe.InsertableObjectFromSchemaRecordUnsafe<T>, false, T, never, TCustomMetadata> & SimpleObjectNodeSchema<SchemaType.View, TCustomMetadata> & Pick<ObjectNodeSchema, "fields">;
|
|
1317
1329
|
static readonly optional: <const T extends ImplicitAllowedTypes, const TCustomMetadata = unknown>(t: T, props?: Omit<FieldPropsAlpha<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlpha<FieldKind.Optional, T, TCustomMetadata>;
|
|
1318
1330
|
readonly optional: <const T extends ImplicitAllowedTypes, const TCustomMetadata = unknown>(t: T, props?: Omit<FieldPropsAlpha<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlpha<FieldKind.Optional, T, TCustomMetadata>;
|
|
1319
1331
|
static readonly optionalRecursive: <const T extends System_Unsafe.ImplicitAllowedTypesUnsafe, const TCustomMetadata = unknown>(t: T, props?: Omit<FieldPropsAlpha<TCustomMetadata>, "defaultProvider"> | undefined) => FieldSchemaAlphaUnsafe<FieldKind.Optional, T, TCustomMetadata>;
|
|
@@ -1378,6 +1390,12 @@ export interface SchemaStaticsBeta {
|
|
|
1378
1390
|
readonly typesRecursive: <const T extends readonly Unenforced<AnnotatedAllowedType | LazyItem<TreeNodeSchema>>[]>(t: T, metadata?: AllowedTypesMetadata) => AllowedTypesFullFromMixedUnsafe<T>;
|
|
1379
1391
|
}
|
|
1380
1392
|
|
|
1393
|
+
// @alpha
|
|
1394
|
+
export enum SchemaType {
|
|
1395
|
+
Stored = 0,
|
|
1396
|
+
View = 1
|
|
1397
|
+
}
|
|
1398
|
+
|
|
1381
1399
|
// @beta @sealed
|
|
1382
1400
|
export class SchemaUpgrade {
|
|
1383
1401
|
// (undocumented)
|
|
@@ -1401,43 +1419,48 @@ export interface SharedTreeFormatOptions {
|
|
|
1401
1419
|
}
|
|
1402
1420
|
|
|
1403
1421
|
// @alpha @input
|
|
1404
|
-
export interface SharedTreeOptions extends Partial<CodecWriteOptions>, Partial<SharedTreeFormatOptions
|
|
1422
|
+
export interface SharedTreeOptions extends SharedTreeOptionsBeta, Partial<CodecWriteOptions>, Partial<SharedTreeFormatOptions> {
|
|
1423
|
+
readonly enableDetachedRootEditing?: boolean;
|
|
1405
1424
|
readonly enableSharedBranches?: boolean;
|
|
1425
|
+
shouldEncodeIncrementally?: IncrementalEncodingPolicy;
|
|
1406
1426
|
}
|
|
1407
1427
|
|
|
1408
1428
|
// @beta @input
|
|
1409
1429
|
export type SharedTreeOptionsBeta = ForestOptions;
|
|
1410
1430
|
|
|
1411
1431
|
// @alpha @sealed
|
|
1412
|
-
export interface SimpleAllowedTypeAttributes {
|
|
1413
|
-
readonly isStaged: false | SchemaUpgrade
|
|
1432
|
+
export interface SimpleAllowedTypeAttributes<out Type extends SchemaType = SchemaType> {
|
|
1433
|
+
readonly isStaged: Type extends SchemaType.Stored ? undefined : false | SchemaUpgrade;
|
|
1414
1434
|
}
|
|
1415
1435
|
|
|
1416
1436
|
// @alpha @sealed
|
|
1417
|
-
export interface SimpleArrayNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<NodeKind.Array, TCustomMetadata> {
|
|
1418
|
-
readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes
|
|
1437
|
+
export interface SimpleArrayNodeSchema<Type extends SchemaType = SchemaType, out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<Type, NodeKind.Array, TCustomMetadata> {
|
|
1438
|
+
readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes<Type>>;
|
|
1419
1439
|
}
|
|
1420
1440
|
|
|
1421
1441
|
// @alpha @sealed
|
|
1422
|
-
export interface SimpleFieldSchema {
|
|
1442
|
+
export interface SimpleFieldSchema<Type extends SchemaType = SchemaType> {
|
|
1423
1443
|
readonly kind: FieldKind;
|
|
1424
|
-
readonly metadata: FieldSchemaMetadata
|
|
1444
|
+
readonly metadata: FieldSchemaMetadata & (Type extends SchemaType.View ? unknown : {
|
|
1445
|
+
readonly custom?: undefined;
|
|
1446
|
+
readonly description?: undefined;
|
|
1447
|
+
});
|
|
1425
1448
|
readonly persistedMetadata?: JsonCompatibleReadOnlyObject | undefined;
|
|
1426
|
-
readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes
|
|
1449
|
+
readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes<Type>>;
|
|
1427
1450
|
}
|
|
1428
1451
|
|
|
1429
1452
|
// @alpha @sealed
|
|
1430
|
-
export interface SimpleLeafNodeSchema extends SimpleNodeSchemaBaseAlpha<NodeKind.Leaf> {
|
|
1453
|
+
export interface SimpleLeafNodeSchema<Type extends SchemaType = SchemaType> extends SimpleNodeSchemaBaseAlpha<Type, NodeKind.Leaf> {
|
|
1431
1454
|
readonly leafKind: ValueSchema;
|
|
1432
1455
|
}
|
|
1433
1456
|
|
|
1434
1457
|
// @alpha @sealed
|
|
1435
|
-
export interface SimpleMapNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<NodeKind.Map, TCustomMetadata> {
|
|
1436
|
-
readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes
|
|
1458
|
+
export interface SimpleMapNodeSchema<Type extends SchemaType = SchemaType, out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<Type, NodeKind.Map, TCustomMetadata> {
|
|
1459
|
+
readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes<Type>>;
|
|
1437
1460
|
}
|
|
1438
1461
|
|
|
1439
1462
|
// @alpha
|
|
1440
|
-
export type SimpleNodeSchema = SimpleLeafNodeSchema | SimpleMapNodeSchema | SimpleArrayNodeSchema | SimpleObjectNodeSchema | SimpleRecordNodeSchema
|
|
1463
|
+
export type SimpleNodeSchema<Type extends SchemaType = SchemaType> = SimpleLeafNodeSchema<Type> | SimpleMapNodeSchema<Type> | SimpleArrayNodeSchema<Type> | SimpleObjectNodeSchema<Type> | SimpleRecordNodeSchema<Type>;
|
|
1441
1464
|
|
|
1442
1465
|
// @public @sealed @system
|
|
1443
1466
|
export interface SimpleNodeSchemaBase<out TNodeKind extends NodeKind, out TCustomMetadata = unknown> {
|
|
@@ -1446,33 +1469,38 @@ export interface SimpleNodeSchemaBase<out TNodeKind extends NodeKind, out TCusto
|
|
|
1446
1469
|
}
|
|
1447
1470
|
|
|
1448
1471
|
// @alpha @sealed @system
|
|
1449
|
-
export interface SimpleNodeSchemaBaseAlpha<out TNodeKind extends NodeKind, out TCustomMetadata = unknown> extends SimpleNodeSchemaBase<TNodeKind, TCustomMetadata> {
|
|
1472
|
+
export interface SimpleNodeSchemaBaseAlpha<out Type extends SchemaType, out TNodeKind extends NodeKind, out TCustomMetadata = unknown> extends SimpleNodeSchemaBase<TNodeKind, TCustomMetadata> {
|
|
1473
|
+
// (undocumented)
|
|
1474
|
+
readonly metadata: SimpleNodeSchemaBase<TNodeKind, TCustomMetadata>["metadata"] & (Type extends SchemaType.View ? unknown : {
|
|
1475
|
+
readonly custom?: undefined;
|
|
1476
|
+
readonly description?: undefined;
|
|
1477
|
+
});
|
|
1450
1478
|
readonly persistedMetadata: JsonCompatibleReadOnlyObject | undefined;
|
|
1451
1479
|
}
|
|
1452
1480
|
|
|
1453
1481
|
// @alpha @sealed
|
|
1454
|
-
export interface SimpleObjectFieldSchema extends SimpleFieldSchema {
|
|
1482
|
+
export interface SimpleObjectFieldSchema<Type extends SchemaType = SchemaType> extends SimpleFieldSchema<Type> {
|
|
1455
1483
|
readonly storedKey: string;
|
|
1456
1484
|
}
|
|
1457
1485
|
|
|
1458
1486
|
// @alpha @sealed
|
|
1459
|
-
export interface SimpleObjectNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<NodeKind.Object, TCustomMetadata> {
|
|
1460
|
-
readonly allowUnknownOptionalFields: boolean
|
|
1461
|
-
readonly fields: ReadonlyMap<string, SimpleObjectFieldSchema
|
|
1487
|
+
export interface SimpleObjectNodeSchema<Type extends SchemaType = SchemaType, out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<Type, NodeKind.Object, TCustomMetadata> {
|
|
1488
|
+
readonly allowUnknownOptionalFields: Type extends SchemaType.View ? boolean : undefined;
|
|
1489
|
+
readonly fields: ReadonlyMap<string, SimpleObjectFieldSchema<Type>>;
|
|
1462
1490
|
}
|
|
1463
1491
|
|
|
1464
1492
|
// @alpha @sealed
|
|
1465
|
-
export interface SimpleRecordNodeSchema<out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<NodeKind.Record, TCustomMetadata> {
|
|
1466
|
-
readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes
|
|
1493
|
+
export interface SimpleRecordNodeSchema<Type extends SchemaType = SchemaType, out TCustomMetadata = unknown> extends SimpleNodeSchemaBaseAlpha<Type, NodeKind.Record, TCustomMetadata> {
|
|
1494
|
+
readonly simpleAllowedTypes: ReadonlyMap<string, SimpleAllowedTypeAttributes<Type>>;
|
|
1467
1495
|
}
|
|
1468
1496
|
|
|
1469
1497
|
// @alpha
|
|
1470
1498
|
export type SimpleTreeIndex<TKey extends TreeIndexKey, TValue> = TreeIndex<TKey, TValue>;
|
|
1471
1499
|
|
|
1472
1500
|
// @alpha @sealed
|
|
1473
|
-
export interface SimpleTreeSchema {
|
|
1474
|
-
readonly definitions: ReadonlyMap<string, SimpleNodeSchema
|
|
1475
|
-
readonly root: SimpleFieldSchema
|
|
1501
|
+
export interface SimpleTreeSchema<Type extends SchemaType = SchemaType> {
|
|
1502
|
+
readonly definitions: ReadonlyMap<string, SimpleNodeSchema<Type>>;
|
|
1503
|
+
readonly root: SimpleFieldSchema<Type>;
|
|
1476
1504
|
}
|
|
1477
1505
|
|
|
1478
1506
|
// @beta
|
|
@@ -1483,11 +1511,11 @@ export function singletonSchema<TScope extends string, TName extends string | nu
|
|
|
1483
1511
|
// @alpha @system
|
|
1484
1512
|
export namespace System_TableSchema {
|
|
1485
1513
|
// @sealed @system
|
|
1486
|
-
export type ColumnSchemaBase<
|
|
1514
|
+
export type ColumnSchemaBase<TUserScope extends string = string, TCellSchema extends ImplicitAllowedTypes = ImplicitAllowedTypes, TPropsSchema extends ImplicitFieldSchema = ImplicitFieldSchema> = ReturnType<typeof createColumnSchema<TUserScope, TCellSchema, TPropsSchema>>;
|
|
1487
1515
|
// @system
|
|
1488
|
-
export type CreateColumnOptionsBase<TSchemaFactory extends SchemaFactoryBeta = SchemaFactoryBeta
|
|
1516
|
+
export type CreateColumnOptionsBase<TUserScope extends string = string, TSchemaFactory extends SchemaFactoryBeta<TUserScope> = SchemaFactoryBeta<TUserScope>, TCellSchema extends ImplicitAllowedTypes = ImplicitAllowedTypes> = OptionsWithSchemaFactory<TSchemaFactory> & OptionsWithCellSchema<TCellSchema>;
|
|
1489
1517
|
// @system
|
|
1490
|
-
export function createColumnSchema<const
|
|
1518
|
+
export function createColumnSchema<const TUserScope extends string, const TCellSchema extends ImplicitAllowedTypes, const TPropsSchema extends ImplicitFieldSchema>(inputSchemaFactory: SchemaFactoryBeta<TUserScope>, propsSchema: TPropsSchema): TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Column">, NodeKind.Object, TreeNode & TableSchema.Column<TCellSchema, TPropsSchema> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Column">, NodeKind, unknown>, object & {
|
|
1491
1519
|
readonly id?: string | undefined;
|
|
1492
1520
|
} & (FieldHasDefault<TPropsSchema> extends true ? {
|
|
1493
1521
|
props?: InsertableTreeFieldFromImplicitField<TPropsSchema> | undefined;
|
|
@@ -1498,11 +1526,11 @@ export namespace System_TableSchema {
|
|
|
1498
1526
|
readonly id: FieldSchema_2<FieldKind_2.Identifier, LeafSchema_2<"string", string>, unknown>;
|
|
1499
1527
|
}>;
|
|
1500
1528
|
// @system
|
|
1501
|
-
export type CreateRowOptionsBase<TSchemaFactory extends SchemaFactoryBeta = SchemaFactoryBeta
|
|
1529
|
+
export type CreateRowOptionsBase<TUserScope extends string = string, TSchemaFactory extends SchemaFactoryBeta<TUserScope> = SchemaFactoryBeta<TUserScope>, TCellSchema extends ImplicitAllowedTypes = ImplicitAllowedTypes> = OptionsWithSchemaFactory<TSchemaFactory> & OptionsWithCellSchema<TCellSchema>;
|
|
1502
1530
|
// @sealed
|
|
1503
|
-
export function createRowSchema<const
|
|
1531
|
+
export function createRowSchema<const TUserScope extends string, const TCellSchema extends ImplicitAllowedTypes, const TPropsSchema extends ImplicitFieldSchema>(inputSchemaFactory: SchemaFactoryBeta<TUserScope>, cellSchema: TCellSchema, propsSchema: TPropsSchema): TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Row">, NodeKind.Object, TreeNode & TableSchema.Row<TCellSchema, TPropsSchema> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Row">, NodeKind, unknown>, object & {
|
|
1504
1532
|
readonly id?: string | undefined;
|
|
1505
|
-
readonly cells: (InsertableTypedNode_2<TreeNodeSchemaClass<ScopedSchemaName
|
|
1533
|
+
readonly cells: (InsertableTypedNode_2<TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Row.cells">, NodeKind.Record, TreeRecordNode<TCellSchema> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Row.cells">, NodeKind.Record, unknown>, RecordNodeInsertableData_2<TCellSchema>, true, TCellSchema, undefined, unknown>> | undefined) & InsertableTypedNode_2<TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Row.cells">, NodeKind.Record, TreeRecordNode<TCellSchema> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Row.cells">, NodeKind.Record, unknown>, RecordNodeInsertableData_2<TCellSchema>, true, TCellSchema, undefined, unknown>>;
|
|
1506
1534
|
} & (FieldHasDefault<TPropsSchema> extends true ? {
|
|
1507
1535
|
props?: InsertableTreeFieldFromImplicitField<TPropsSchema> | undefined;
|
|
1508
1536
|
} : {
|
|
@@ -1510,23 +1538,22 @@ export namespace System_TableSchema {
|
|
|
1510
1538
|
}), true, {
|
|
1511
1539
|
readonly props: TPropsSchema;
|
|
1512
1540
|
readonly id: FieldSchema_2<FieldKind_2.Identifier, LeafSchema_2<"string", string>, unknown>;
|
|
1513
|
-
readonly cells: FieldSchema_2<FieldKind_2.Required, TreeNodeSchemaClass<ScopedSchemaName
|
|
1541
|
+
readonly cells: FieldSchema_2<FieldKind_2.Required, TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Row.cells">, NodeKind.Record, TreeRecordNode<TCellSchema> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Row.cells">, NodeKind.Record, unknown>, RecordNodeInsertableData_2<TCellSchema>, true, TCellSchema, undefined, unknown>, unknown>;
|
|
1514
1542
|
}>;
|
|
1515
1543
|
// @system
|
|
1516
|
-
export function createTableSchema<const
|
|
1517
|
-
readonly
|
|
1518
|
-
readonly
|
|
1519
|
-
},
|
|
1520
|
-
|
|
1521
|
-
readonly
|
|
1522
|
-
}, unknown> & (new (data
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
}) => TreeNode & TableSchema.Table<TInputScope, TCellSchema, TColumnSchema, TRowSchema> & WithType<ScopedSchemaName<ScopedSchemaName<TInputScope, "table">, "Table">, NodeKind, unknown>>(this: TThis): InstanceType<TThis>;
|
|
1544
|
+
export function createTableSchema<const TUserScope extends string, const TCellSchema extends ImplicitAllowedTypes, const TColumnSchema extends ColumnSchemaBase<TUserScope, TCellSchema>, const TRowSchema extends RowSchemaBase<TUserScope, TCellSchema>>(inputSchemaFactory: SchemaFactoryBeta<TUserScope>, _cellSchema: TCellSchema, columnSchema: TColumnSchema, rowSchema: TRowSchema): TreeNodeSchemaCore_2<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "TableRoot">, NodeKind.Object, false, {
|
|
1545
|
+
readonly table: FieldSchema_2<FieldKind_2.Required, TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table">, NodeKind.Object, TreeObjectNode_2< {
|
|
1546
|
+
readonly rows: TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.rows">, NodeKind.Array, TreeArrayNode<TRowSchema, [TRowSchema] extends [ImplicitAllowedTypes] ? TreeNodeFromImplicitAllowedTypes<TRowSchema> : TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>, [TRowSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema> : never, ReadonlyArrayNode_2<TreeNode | TreeLeafValue_2>> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.rows">, NodeKind.Array, unknown>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema>>, true, TRowSchema, undefined>;
|
|
1547
|
+
readonly columns: TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.columns">, NodeKind.Array, TreeArrayNode<TColumnSchema, [TColumnSchema] extends [ImplicitAllowedTypes] ? TreeNodeFromImplicitAllowedTypes<TColumnSchema> : TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>, [TColumnSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema> : never, ReadonlyArrayNode_2<TreeNode | TreeLeafValue_2>> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.columns">, NodeKind.Array, unknown>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema>>, true, TColumnSchema, undefined>;
|
|
1548
|
+
}, ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table">>, object & {
|
|
1549
|
+
readonly rows: (InsertableTypedNode_2<TreeNodeSchemaCore_2<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.rows">, NodeKind.Array, true, TRowSchema, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema>>, unknown> & (new (data?: InternalTreeNode | Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema>> | undefined) => TreeArrayNode<TRowSchema, [TRowSchema] extends [ImplicitAllowedTypes] ? TreeNodeFromImplicitAllowedTypes<TRowSchema> : TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>, [TRowSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema> : never, ReadonlyArrayNode_2<TreeNode | TreeLeafValue_2>> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.rows">, NodeKind.Array, unknown>)> | undefined) & InsertableTypedNode_2<TreeNodeSchemaCore_2<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.rows">, NodeKind.Array, true, TRowSchema, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema>>, unknown> & (new (data?: InternalTreeNode | Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema>> | undefined) => TreeArrayNode<TRowSchema, [TRowSchema] extends [ImplicitAllowedTypes] ? TreeNodeFromImplicitAllowedTypes<TRowSchema> : TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>, [TRowSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema> : never, ReadonlyArrayNode_2<TreeNode | TreeLeafValue_2>> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.rows">, NodeKind.Array, unknown>)>;
|
|
1550
|
+
readonly columns: (InsertableTypedNode_2<TreeNodeSchemaCore_2<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.columns">, NodeKind.Array, true, TColumnSchema, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema>>, unknown> & (new (data?: InternalTreeNode | Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema>> | undefined) => TreeArrayNode<TColumnSchema, [TColumnSchema] extends [ImplicitAllowedTypes] ? TreeNodeFromImplicitAllowedTypes<TColumnSchema> : TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>, [TColumnSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema> : never, ReadonlyArrayNode_2<TreeNode | TreeLeafValue_2>> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.columns">, NodeKind.Array, unknown>)> | undefined) & InsertableTypedNode_2<TreeNodeSchemaCore_2<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.columns">, NodeKind.Array, true, TColumnSchema, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema>>, unknown> & (new (data?: InternalTreeNode | Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema>> | undefined) => TreeArrayNode<TColumnSchema, [TColumnSchema] extends [ImplicitAllowedTypes] ? TreeNodeFromImplicitAllowedTypes<TColumnSchema> : TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>, [TColumnSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema> : never, ReadonlyArrayNode_2<TreeNode | TreeLeafValue_2>> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.columns">, NodeKind.Array, unknown>)>;
|
|
1551
|
+
}, true, {
|
|
1552
|
+
readonly rows: TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.rows">, NodeKind.Array, TreeArrayNode<TRowSchema, [TRowSchema] extends [ImplicitAllowedTypes] ? TreeNodeFromImplicitAllowedTypes<TRowSchema> : TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>, [TRowSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema> : never, ReadonlyArrayNode_2<TreeNode | TreeLeafValue_2>> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.rows">, NodeKind.Array, unknown>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRowSchema>>, true, TRowSchema, undefined>;
|
|
1553
|
+
readonly columns: TreeNodeSchemaClass<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.columns">, NodeKind.Array, TreeArrayNode<TColumnSchema, [TColumnSchema] extends [ImplicitAllowedTypes] ? TreeNodeFromImplicitAllowedTypes<TColumnSchema> : TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>, [TColumnSchema] extends [ImplicitAllowedTypes] ? InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema> : never, ReadonlyArrayNode_2<TreeNode | TreeLeafValue_2>> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "Table.columns">, NodeKind.Array, unknown>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumnSchema>>, true, TColumnSchema, undefined>;
|
|
1554
|
+
}, never, unknown>, unknown>;
|
|
1555
|
+
}, never, unknown> & (new (data?: InternalTreeNode | undefined) => TreeNode & TableSchema.Table<TUserScope, TCellSchema, TColumnSchema, TRowSchema> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "TableRoot">, NodeKind, unknown>) & {
|
|
1556
|
+
create<TThis extends new (data?: InternalTreeNode | undefined) => TreeNode & TableSchema.Table<TUserScope, TCellSchema, TColumnSchema, TRowSchema> & WithType<ScopedSchemaName<`com.fluidframework.table<${TUserScope}>`, "TableRoot">, NodeKind, unknown>>(this: TThis, initialContents?: TableSchema.TableFactoryMethodParameters<TUserScope, TCellSchema, TColumnSchema, TRowSchema> | undefined): InstanceType<TThis>;
|
|
1530
1557
|
};
|
|
1531
1558
|
// @system
|
|
1532
1559
|
export type DefaultPropsType = ReturnType<typeof SchemaFactory.optional<[]>>;
|
|
@@ -1538,12 +1565,21 @@ export namespace System_TableSchema {
|
|
|
1538
1565
|
export interface OptionsWithSchemaFactory<TSchemaFactory extends SchemaFactoryBeta> {
|
|
1539
1566
|
readonly schemaFactory: TSchemaFactory;
|
|
1540
1567
|
}
|
|
1568
|
+
// @system
|
|
1569
|
+
export type RearrangeableList<TItemSchema extends ImplicitAllowedTypes> = TreeNode & readonly TreeNodeFromImplicitAllowedTypes<TItemSchema>[] & {
|
|
1570
|
+
moveToEnd(sourceIndex: number): void;
|
|
1571
|
+
moveToStart(sourceIndex: number): void;
|
|
1572
|
+
moveToIndex(sourceIndex: number, destinationIndex: number): void;
|
|
1573
|
+
moveRangeToEnd(startIndex: number, endIndex: number): void;
|
|
1574
|
+
moveRangeToStart(startIndex: number, endIndex: number): void;
|
|
1575
|
+
moveRangeToIndex(startIndex: number, endIndex: number, destinationIndex: number): void;
|
|
1576
|
+
};
|
|
1541
1577
|
// @sealed @system
|
|
1542
|
-
export type RowSchemaBase<
|
|
1578
|
+
export type RowSchemaBase<TUserScope extends string = string, TCellSchema extends ImplicitAllowedTypes = ImplicitAllowedTypes, TPropsSchema extends ImplicitFieldSchema = ImplicitFieldSchema> = ReturnType<typeof createRowSchema<TUserScope, TCellSchema, TPropsSchema>>;
|
|
1543
1579
|
// @system
|
|
1544
|
-
export type TableFactoryOptionsBase<TSchemaFactory extends SchemaFactoryBeta = SchemaFactoryBeta
|
|
1580
|
+
export type TableFactoryOptionsBase<TUserScope extends string = string, TSchemaFactory extends SchemaFactoryBeta<TUserScope> = SchemaFactoryBeta<TUserScope>, TCellSchema extends ImplicitAllowedTypes = ImplicitAllowedTypes> = OptionsWithSchemaFactory<TSchemaFactory> & OptionsWithCellSchema<TCellSchema>;
|
|
1545
1581
|
// @sealed @system
|
|
1546
|
-
export type TableSchemaBase<
|
|
1582
|
+
export type TableSchemaBase<TUserScope extends string, TCellSchema extends ImplicitAllowedTypes, TColumnSchema extends ColumnSchemaBase<TUserScope, TCellSchema>, TRowSchema extends RowSchemaBase<TUserScope, TCellSchema>> = ReturnType<typeof createTableSchema<TUserScope, TCellSchema, TColumnSchema, TRowSchema>>;
|
|
1547
1583
|
}
|
|
1548
1584
|
|
|
1549
1585
|
// @public @system
|
|
@@ -1631,6 +1667,7 @@ export namespace System_Unsafe {
|
|
|
1631
1667
|
|
|
1632
1668
|
// @alpha
|
|
1633
1669
|
export namespace TableSchema {
|
|
1670
|
+
// @input
|
|
1634
1671
|
export interface CellKey<TColumn extends ImplicitAllowedTypes, TRow extends ImplicitAllowedTypes> {
|
|
1635
1672
|
readonly column: string | number | TreeNodeFromImplicitAllowedTypes<TColumn>;
|
|
1636
1673
|
readonly row: string | number | TreeNodeFromImplicitAllowedTypes<TRow>;
|
|
@@ -1641,14 +1678,16 @@ export namespace TableSchema {
|
|
|
1641
1678
|
get props(): TreeFieldFromImplicitField<TProps>;
|
|
1642
1679
|
set props(value: InsertableTreeFieldFromImplicitField<TProps>);
|
|
1643
1680
|
}
|
|
1644
|
-
export function column<const
|
|
1645
|
-
export function column<const
|
|
1681
|
+
export function column<const TUserScope extends string, const TCell extends ImplicitAllowedTypes>(params: System_TableSchema.CreateColumnOptionsBase<TUserScope, SchemaFactoryBeta<TUserScope>, TCell>): System_TableSchema.ColumnSchemaBase<TUserScope, TCell, System_TableSchema.DefaultPropsType>;
|
|
1682
|
+
export function column<const TUserScope extends string, const TCell extends ImplicitAllowedTypes, const TProps extends ImplicitFieldSchema>(params: System_TableSchema.CreateColumnOptionsBase<TUserScope, SchemaFactoryBeta<TUserScope>, TCell> & {
|
|
1646
1683
|
readonly props: TProps;
|
|
1647
|
-
}): System_TableSchema.ColumnSchemaBase<
|
|
1684
|
+
}): System_TableSchema.ColumnSchemaBase<TUserScope, TCell, TProps>;
|
|
1685
|
+
// @input
|
|
1648
1686
|
export interface InsertColumnsParameters<TColumn extends ImplicitAllowedTypes> {
|
|
1649
1687
|
readonly columns: InsertableTreeNodeFromImplicitAllowedTypes<TColumn>[];
|
|
1650
1688
|
readonly index?: number | undefined;
|
|
1651
1689
|
}
|
|
1690
|
+
// @input
|
|
1652
1691
|
export interface InsertRowsParameters<TRow extends ImplicitAllowedTypes> {
|
|
1653
1692
|
readonly index?: number | undefined;
|
|
1654
1693
|
readonly rows: InsertableTreeNodeFromImplicitAllowedTypes<TRow>[];
|
|
@@ -1659,17 +1698,18 @@ export namespace TableSchema {
|
|
|
1659
1698
|
get props(): TreeFieldFromImplicitField<TProps>;
|
|
1660
1699
|
set props(value: InsertableTreeFieldFromImplicitField<TProps>);
|
|
1661
1700
|
}
|
|
1662
|
-
export function row<const
|
|
1663
|
-
export function row<const
|
|
1701
|
+
export function row<const TUserScope extends string, const TCell extends ImplicitAllowedTypes>(params: System_TableSchema.CreateRowOptionsBase<TUserScope, SchemaFactoryBeta<TUserScope>, TCell>): System_TableSchema.RowSchemaBase<TUserScope, TCell, System_TableSchema.DefaultPropsType>;
|
|
1702
|
+
export function row<const TUserScope extends string, const TCell extends ImplicitAllowedTypes, const TProps extends ImplicitFieldSchema>(params: System_TableSchema.CreateRowOptionsBase<TUserScope, SchemaFactoryBeta<TUserScope>, TCell> & {
|
|
1664
1703
|
readonly props: TProps;
|
|
1665
|
-
}): System_TableSchema.RowSchemaBase<
|
|
1704
|
+
}): System_TableSchema.RowSchemaBase<TUserScope, TCell, TProps>;
|
|
1705
|
+
// @input
|
|
1666
1706
|
export interface SetCellParameters<TCell extends ImplicitAllowedTypes, TColumn extends ImplicitAllowedTypes, TRow extends ImplicitAllowedTypes> {
|
|
1667
1707
|
readonly cell: InsertableTreeNodeFromImplicitAllowedTypes<TCell>;
|
|
1668
1708
|
readonly key: CellKey<TColumn, TRow>;
|
|
1669
1709
|
}
|
|
1670
1710
|
// @sealed
|
|
1671
|
-
export interface Table<
|
|
1672
|
-
readonly columns:
|
|
1711
|
+
export interface Table<TUserScope extends string, TCell extends ImplicitAllowedTypes, TColumn extends System_TableSchema.ColumnSchemaBase<TUserScope, TCell>, TRow extends System_TableSchema.RowSchemaBase<TUserScope, TCell>> {
|
|
1712
|
+
readonly columns: System_TableSchema.RearrangeableList<TColumn>;
|
|
1673
1713
|
getCell(key: CellKey<TColumn, TRow>): TreeNodeFromImplicitAllowedTypes<TCell> | undefined;
|
|
1674
1714
|
getColumn(id: string): TreeNodeFromImplicitAllowedTypes<TColumn> | undefined;
|
|
1675
1715
|
getColumn(index: number): TreeNodeFromImplicitAllowedTypes<TColumn> | undefined;
|
|
@@ -1684,20 +1724,25 @@ export namespace TableSchema {
|
|
|
1684
1724
|
removeRows(index?: number | undefined, count?: number | undefined): TreeNodeFromImplicitAllowedTypes<TRow>[];
|
|
1685
1725
|
removeRows(rows: readonly TreeNodeFromImplicitAllowedTypes<TRow>[]): TreeNodeFromImplicitAllowedTypes<TRow>[];
|
|
1686
1726
|
removeRows(rows: readonly string[]): TreeNodeFromImplicitAllowedTypes<TRow>[];
|
|
1687
|
-
readonly rows:
|
|
1727
|
+
readonly rows: System_TableSchema.RearrangeableList<TRow>;
|
|
1688
1728
|
setCell(params: SetCellParameters<TCell, TColumn, TRow>): void;
|
|
1689
1729
|
}
|
|
1690
|
-
export function table<const
|
|
1691
|
-
export function table<const
|
|
1730
|
+
export function table<const TUserScope extends string, const TCell extends ImplicitAllowedTypes>(params: System_TableSchema.TableFactoryOptionsBase<TUserScope, SchemaFactoryBeta<TUserScope>, TCell>): System_TableSchema.TableSchemaBase<TUserScope, TCell, System_TableSchema.ColumnSchemaBase<TUserScope, TCell, System_TableSchema.DefaultPropsType>, System_TableSchema.RowSchemaBase<TUserScope, TCell, System_TableSchema.DefaultPropsType>>;
|
|
1731
|
+
export function table<const TUserScope extends string, const TCell extends ImplicitAllowedTypes, const TColumn extends System_TableSchema.ColumnSchemaBase<TUserScope, TCell>>(params: System_TableSchema.TableFactoryOptionsBase<TUserScope, SchemaFactoryBeta<TUserScope>, TCell> & {
|
|
1692
1732
|
readonly column: TColumn;
|
|
1693
|
-
}): System_TableSchema.TableSchemaBase<
|
|
1694
|
-
export function table<const
|
|
1733
|
+
}): System_TableSchema.TableSchemaBase<TUserScope, TCell, TColumn, System_TableSchema.RowSchemaBase<TUserScope, TCell, System_TableSchema.DefaultPropsType>>;
|
|
1734
|
+
export function table<const TUserScope extends string, const TCell extends ImplicitAllowedTypes, const TRow extends System_TableSchema.RowSchemaBase<TUserScope, TCell>>(params: System_TableSchema.TableFactoryOptionsBase<TUserScope, SchemaFactoryBeta<TUserScope>, TCell> & {
|
|
1695
1735
|
readonly row: TRow;
|
|
1696
|
-
}): System_TableSchema.TableSchemaBase<
|
|
1697
|
-
export function table<const
|
|
1736
|
+
}): System_TableSchema.TableSchemaBase<TUserScope, TCell, System_TableSchema.ColumnSchemaBase<TUserScope, TCell, System_TableSchema.DefaultPropsType>, TRow>;
|
|
1737
|
+
export function table<const TUserScope extends string, const TCell extends ImplicitAllowedTypes, const TColumn extends System_TableSchema.ColumnSchemaBase<TUserScope, TCell>, const TRow extends System_TableSchema.RowSchemaBase<TUserScope, TCell>>(params: System_TableSchema.TableFactoryOptionsBase<TUserScope, SchemaFactoryBeta<TUserScope>, TCell> & {
|
|
1698
1738
|
readonly column: TColumn;
|
|
1699
1739
|
readonly row: TRow;
|
|
1700
|
-
}): System_TableSchema.TableSchemaBase<
|
|
1740
|
+
}): System_TableSchema.TableSchemaBase<TUserScope, TCell, TColumn, TRow>;
|
|
1741
|
+
// @input
|
|
1742
|
+
export interface TableFactoryMethodParameters<TUserScope extends string, TCell extends ImplicitAllowedTypes, TColumn extends System_TableSchema.ColumnSchemaBase<TUserScope, TCell>, TRow extends System_TableSchema.RowSchemaBase<TUserScope, TCell>> {
|
|
1743
|
+
readonly columns?: Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumn>> | undefined;
|
|
1744
|
+
readonly rows?: Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRow>> | undefined;
|
|
1745
|
+
}
|
|
1701
1746
|
}
|
|
1702
1747
|
|
|
1703
1748
|
// @public
|
|
@@ -1868,6 +1913,7 @@ export interface TreeChangeEventsBeta<TNode extends TreeNode = TreeNode> extends
|
|
|
1868
1913
|
// @alpha
|
|
1869
1914
|
export enum TreeCompressionStrategy {
|
|
1870
1915
|
Compressed = 0,
|
|
1916
|
+
CompressedIncremental = 2,
|
|
1871
1917
|
Uncompressed = 1
|
|
1872
1918
|
}
|
|
1873
1919
|
|
|
@@ -1988,8 +2034,8 @@ export interface TreeRecordNodeUnsafe<TAllowedTypes extends System_Unsafe.Implic
|
|
|
1988
2034
|
}
|
|
1989
2035
|
|
|
1990
2036
|
// @alpha @sealed (undocumented)
|
|
1991
|
-
export interface TreeSchema extends SimpleTreeSchema {
|
|
1992
|
-
readonly definitions: ReadonlyMap<string, SimpleNodeSchema & TreeNodeSchema>;
|
|
2037
|
+
export interface TreeSchema extends SimpleTreeSchema<SchemaType.View> {
|
|
2038
|
+
readonly definitions: ReadonlyMap<string, SimpleNodeSchema<SchemaType.View> & TreeNodeSchema>;
|
|
1993
2039
|
readonly root: FieldSchemaAlpha;
|
|
1994
2040
|
}
|
|
1995
2041
|
|
|
@@ -2039,7 +2085,6 @@ export interface TreeViewBeta<in out TSchema extends ImplicitFieldSchema> extend
|
|
|
2039
2085
|
// @public @sealed
|
|
2040
2086
|
export class TreeViewConfiguration<const TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> implements Required<ITreeViewConfiguration<TSchema>> {
|
|
2041
2087
|
constructor(props: ITreeViewConfiguration<TSchema>);
|
|
2042
|
-
protected readonly definitionsInternal: ReadonlyMap<string, TreeNodeSchema>;
|
|
2043
2088
|
readonly enableSchemaValidation: boolean;
|
|
2044
2089
|
readonly preventAmbiguity: boolean;
|
|
2045
2090
|
readonly schema: TSchema;
|
|
@@ -2050,7 +2095,9 @@ export class TreeViewConfiguration<const TSchema extends ImplicitFieldSchema = I
|
|
|
2050
2095
|
// @alpha @sealed
|
|
2051
2096
|
export class TreeViewConfigurationAlpha<const TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> extends TreeViewConfiguration<TSchema> implements TreeSchema {
|
|
2052
2097
|
constructor(props: ITreeViewConfiguration<TSchema>);
|
|
2053
|
-
|
|
2098
|
+
// (undocumented)
|
|
2099
|
+
readonly definitions: ReadonlyMap<string, SimpleNodeSchema<SchemaType.View> & TreeNodeSchema>;
|
|
2100
|
+
// (undocumented)
|
|
2054
2101
|
readonly root: FieldSchemaAlpha;
|
|
2055
2102
|
}
|
|
2056
2103
|
|
|
@@ -686,7 +686,6 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
|
|
|
686
686
|
// @public @sealed
|
|
687
687
|
export interface Listenable<TListeners extends object> {
|
|
688
688
|
off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
|
|
689
|
-
// (undocumented)
|
|
690
689
|
on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
|
|
691
690
|
}
|
|
692
691
|
|
|
@@ -1237,7 +1236,6 @@ export interface TreeViewBeta<in out TSchema extends ImplicitFieldSchema> extend
|
|
|
1237
1236
|
// @public @sealed
|
|
1238
1237
|
export class TreeViewConfiguration<const TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> implements Required<ITreeViewConfiguration<TSchema>> {
|
|
1239
1238
|
constructor(props: ITreeViewConfiguration<TSchema>);
|
|
1240
|
-
protected readonly definitionsInternal: ReadonlyMap<string, TreeNodeSchema>;
|
|
1241
1239
|
readonly enableSchemaValidation: boolean;
|
|
1242
1240
|
readonly preventAmbiguity: boolean;
|
|
1243
1241
|
readonly schema: TSchema;
|
|
@@ -964,7 +964,6 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
|
|
|
964
964
|
// @public @sealed
|
|
965
965
|
export interface Listenable<TListeners extends object> {
|
|
966
966
|
off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
|
|
967
|
-
// (undocumented)
|
|
968
967
|
on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
|
|
969
968
|
}
|
|
970
969
|
|
|
@@ -1595,7 +1594,6 @@ export interface TreeViewBeta<in out TSchema extends ImplicitFieldSchema> extend
|
|
|
1595
1594
|
// @public @sealed
|
|
1596
1595
|
export class TreeViewConfiguration<const TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> implements Required<ITreeViewConfiguration<TSchema>> {
|
|
1597
1596
|
constructor(props: ITreeViewConfiguration<TSchema>);
|
|
1598
|
-
protected readonly definitionsInternal: ReadonlyMap<string, TreeNodeSchema>;
|
|
1599
1597
|
readonly enableSchemaValidation: boolean;
|
|
1600
1598
|
readonly preventAmbiguity: boolean;
|
|
1601
1599
|
readonly schema: TSchema;
|
|
@@ -562,7 +562,6 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
|
|
|
562
562
|
// @public @sealed
|
|
563
563
|
export interface Listenable<TListeners extends object> {
|
|
564
564
|
off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
|
|
565
|
-
// (undocumented)
|
|
566
565
|
on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
|
|
567
566
|
}
|
|
568
567
|
|
|
@@ -1000,7 +999,6 @@ export interface TreeView<in out TSchema extends ImplicitFieldSchema> extends ID
|
|
|
1000
999
|
// @public @sealed
|
|
1001
1000
|
export class TreeViewConfiguration<const TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> implements Required<ITreeViewConfiguration<TSchema>> {
|
|
1002
1001
|
constructor(props: ITreeViewConfiguration<TSchema>);
|
|
1003
|
-
protected readonly definitionsInternal: ReadonlyMap<string, TreeNodeSchema>;
|
|
1004
1002
|
readonly enableSchemaValidation: boolean;
|
|
1005
1003
|
readonly preventAmbiguity: boolean;
|
|
1006
1004
|
readonly schema: TSchema;
|
|
@@ -528,7 +528,6 @@ export interface LeafSchema<Name extends string, T extends TreeLeafValue> extend
|
|
|
528
528
|
// @public @sealed
|
|
529
529
|
export interface Listenable<TListeners extends object> {
|
|
530
530
|
off<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): void;
|
|
531
|
-
// (undocumented)
|
|
532
531
|
on<K extends keyof Listeners<TListeners>>(eventName: K, listener: TListeners[K]): Off;
|
|
533
532
|
}
|
|
534
533
|
|
|
@@ -966,7 +965,6 @@ export interface TreeView<in out TSchema extends ImplicitFieldSchema> extends ID
|
|
|
966
965
|
// @public @sealed
|
|
967
966
|
export class TreeViewConfiguration<const TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> implements Required<ITreeViewConfiguration<TSchema>> {
|
|
968
967
|
constructor(props: ITreeViewConfiguration<TSchema>);
|
|
969
|
-
protected readonly definitionsInternal: ReadonlyMap<string, TreeNodeSchema>;
|
|
970
968
|
readonly enableSchemaValidation: boolean;
|
|
971
969
|
readonly preventAmbiguity: boolean;
|
|
972
970
|
readonly schema: TSchema;
|
package/dist/alpha.d.ts
CHANGED
|
@@ -211,6 +211,7 @@ export {
|
|
|
211
211
|
ICodecOptions,
|
|
212
212
|
ITreeAlpha,
|
|
213
213
|
IdentifierIndex,
|
|
214
|
+
IncrementalEncodingPolicy,
|
|
214
215
|
Insertable,
|
|
215
216
|
InsertableContent,
|
|
216
217
|
InsertableField,
|
|
@@ -249,6 +250,7 @@ export {
|
|
|
249
250
|
RevertibleAlphaFactory,
|
|
250
251
|
RunTransactionParams,
|
|
251
252
|
SchemaFactoryAlpha,
|
|
253
|
+
SchemaType,
|
|
252
254
|
SharedTreeFormatOptions,
|
|
253
255
|
SharedTreeOptions,
|
|
254
256
|
SimpleAllowedTypeAttributes,
|
|
@@ -297,12 +299,13 @@ export {
|
|
|
297
299
|
cloneWithReplacements,
|
|
298
300
|
comparePersistedSchema,
|
|
299
301
|
configuredSharedTree,
|
|
302
|
+
configuredSharedTreeAlpha,
|
|
300
303
|
contentSchemaSymbol,
|
|
301
304
|
createIdentifierIndex,
|
|
302
305
|
createIndependentTreeAlpha,
|
|
303
306
|
createSimpleTreeIndex,
|
|
304
|
-
|
|
305
|
-
|
|
307
|
+
decodeSchemaCompatibilitySnapshot,
|
|
308
|
+
encodeSchemaCompatibilitySnapshot,
|
|
306
309
|
evaluateLazySchema,
|
|
307
310
|
exportCompatibilitySchemaSnapshot,
|
|
308
311
|
extractPersistedSchema,
|
|
@@ -311,6 +314,8 @@ export {
|
|
|
311
314
|
getJsonSchema,
|
|
312
315
|
getSimpleSchema,
|
|
313
316
|
importCompatibilitySchemaSnapshot,
|
|
317
|
+
incrementalEncodingPolicyForAllowedTypes,
|
|
318
|
+
incrementalSummaryHint,
|
|
314
319
|
independentInitializedView,
|
|
315
320
|
independentView,
|
|
316
321
|
normalizeAllowedTypes,
|
package/lib/alpha.d.ts
CHANGED
|
@@ -211,6 +211,7 @@ export {
|
|
|
211
211
|
ICodecOptions,
|
|
212
212
|
ITreeAlpha,
|
|
213
213
|
IdentifierIndex,
|
|
214
|
+
IncrementalEncodingPolicy,
|
|
214
215
|
Insertable,
|
|
215
216
|
InsertableContent,
|
|
216
217
|
InsertableField,
|
|
@@ -249,6 +250,7 @@ export {
|
|
|
249
250
|
RevertibleAlphaFactory,
|
|
250
251
|
RunTransactionParams,
|
|
251
252
|
SchemaFactoryAlpha,
|
|
253
|
+
SchemaType,
|
|
252
254
|
SharedTreeFormatOptions,
|
|
253
255
|
SharedTreeOptions,
|
|
254
256
|
SimpleAllowedTypeAttributes,
|
|
@@ -297,12 +299,13 @@ export {
|
|
|
297
299
|
cloneWithReplacements,
|
|
298
300
|
comparePersistedSchema,
|
|
299
301
|
configuredSharedTree,
|
|
302
|
+
configuredSharedTreeAlpha,
|
|
300
303
|
contentSchemaSymbol,
|
|
301
304
|
createIdentifierIndex,
|
|
302
305
|
createIndependentTreeAlpha,
|
|
303
306
|
createSimpleTreeIndex,
|
|
304
|
-
|
|
305
|
-
|
|
307
|
+
decodeSchemaCompatibilitySnapshot,
|
|
308
|
+
encodeSchemaCompatibilitySnapshot,
|
|
306
309
|
evaluateLazySchema,
|
|
307
310
|
exportCompatibilitySchemaSnapshot,
|
|
308
311
|
extractPersistedSchema,
|
|
@@ -311,6 +314,8 @@ export {
|
|
|
311
314
|
getJsonSchema,
|
|
312
315
|
getSimpleSchema,
|
|
313
316
|
importCompatibilitySchemaSnapshot,
|
|
317
|
+
incrementalEncodingPolicyForAllowedTypes,
|
|
318
|
+
incrementalSummaryHint,
|
|
314
319
|
independentInitializedView,
|
|
315
320
|
independentView,
|
|
316
321
|
normalizeAllowedTypes,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fluid-framework",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.74.0-368706",
|
|
4
4
|
"description": "The main entry point into Fluid Framework public packages",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -57,17 +57,17 @@
|
|
|
57
57
|
"main": "lib/index.js",
|
|
58
58
|
"types": "lib/public.d.ts",
|
|
59
59
|
"dependencies": {
|
|
60
|
-
"@fluidframework/container-definitions": "
|
|
61
|
-
"@fluidframework/container-loader": "
|
|
62
|
-
"@fluidframework/core-interfaces": "
|
|
63
|
-
"@fluidframework/core-utils": "
|
|
64
|
-
"@fluidframework/driver-definitions": "
|
|
65
|
-
"@fluidframework/fluid-static": "
|
|
66
|
-
"@fluidframework/map": "
|
|
67
|
-
"@fluidframework/runtime-utils": "
|
|
68
|
-
"@fluidframework/sequence": "
|
|
69
|
-
"@fluidframework/shared-object-base": "
|
|
70
|
-
"@fluidframework/tree": "
|
|
60
|
+
"@fluidframework/container-definitions": "2.74.0-368706",
|
|
61
|
+
"@fluidframework/container-loader": "2.74.0-368706",
|
|
62
|
+
"@fluidframework/core-interfaces": "2.74.0-368706",
|
|
63
|
+
"@fluidframework/core-utils": "2.74.0-368706",
|
|
64
|
+
"@fluidframework/driver-definitions": "2.74.0-368706",
|
|
65
|
+
"@fluidframework/fluid-static": "2.74.0-368706",
|
|
66
|
+
"@fluidframework/map": "2.74.0-368706",
|
|
67
|
+
"@fluidframework/runtime-utils": "2.74.0-368706",
|
|
68
|
+
"@fluidframework/sequence": "2.74.0-368706",
|
|
69
|
+
"@fluidframework/shared-object-base": "2.74.0-368706",
|
|
70
|
+
"@fluidframework/tree": "2.74.0-368706"
|
|
71
71
|
},
|
|
72
72
|
"devDependencies": {
|
|
73
73
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
@@ -75,7 +75,7 @@
|
|
|
75
75
|
"@fluid-tools/build-cli": "^0.60.0",
|
|
76
76
|
"@fluidframework/build-common": "^2.0.3",
|
|
77
77
|
"@fluidframework/build-tools": "^0.60.0",
|
|
78
|
-
"@fluidframework/eslint-config-fluid": "
|
|
78
|
+
"@fluidframework/eslint-config-fluid": "2.74.0-368706",
|
|
79
79
|
"@microsoft/api-extractor": "7.52.11",
|
|
80
80
|
"@types/node": "^18.19.0",
|
|
81
81
|
"concurrently": "^8.2.1",
|