fluid-framework 2.63.0-359286 → 2.63.0-359734
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 +99 -98
- package/api-report/fluid-framework.beta.api.md +37 -2
- package/api-report/fluid-framework.legacy.beta.api.md +37 -2
- package/api-report/fluid-framework.legacy.public.api.md +9 -2
- package/api-report/fluid-framework.public.api.md +9 -2
- package/dist/alpha.d.ts +12 -13
- package/dist/beta.d.ts +5 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/legacy.d.ts +5 -0
- package/dist/public.d.ts +1 -0
- package/lib/alpha.d.ts +12 -13
- package/lib/beta.d.ts +5 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/lib/legacy.d.ts +5 -0
- package/lib/public.d.ts +1 -0
- package/package.json +12 -12
- package/src/index.ts +2 -0
|
@@ -50,6 +50,11 @@ export interface CommitMetadata {
|
|
|
50
50
|
readonly kind: CommitKind;
|
|
51
51
|
}
|
|
52
52
|
|
|
53
|
+
// @beta
|
|
54
|
+
export type ConciseTree<THandle = IFluidHandle> = Exclude<TreeLeafValue, IFluidHandle> | THandle | ConciseTree<THandle>[] | {
|
|
55
|
+
[key: string]: ConciseTree<THandle>;
|
|
56
|
+
};
|
|
57
|
+
|
|
53
58
|
// @beta
|
|
54
59
|
export function configuredSharedTreeBeta(options: SharedTreeOptionsBeta): SharedObjectKind<ITree>;
|
|
55
60
|
|
|
@@ -516,8 +521,10 @@ export type InsertableTreeFieldFromImplicitField<TSchemaInput extends ImplicitFi
|
|
|
516
521
|
|
|
517
522
|
// @public @system
|
|
518
523
|
export type InsertableTreeNodeFromAllowedTypes<TList extends AllowedTypes> = IsUnion<TList> extends true ? never : {
|
|
519
|
-
readonly [Property in keyof TList]: TList[Property] extends
|
|
520
|
-
|
|
524
|
+
readonly [Property in keyof TList]: [TList[Property]] extends [
|
|
525
|
+
LazyItem<infer TSchema extends TreeNodeSchema>
|
|
526
|
+
] ? InsertableTypedNode<TSchema> : never;
|
|
527
|
+
}[NumberKeys<TList>];
|
|
521
528
|
|
|
522
529
|
// @public
|
|
523
530
|
export type InsertableTreeNodeFromImplicitAllowedTypes<TSchema extends ImplicitAllowedTypes> = [
|
|
@@ -837,6 +844,13 @@ export interface IValueChanged {
|
|
|
837
844
|
readonly previousValue: any;
|
|
838
845
|
}
|
|
839
846
|
|
|
847
|
+
// @beta @input
|
|
848
|
+
export enum KeyEncodingOptions {
|
|
849
|
+
allStoredKeys = "allStoredKeys",
|
|
850
|
+
knownStoredKeys = "knownStoredKeys",
|
|
851
|
+
usePropertyKeys = "usePropertyKeys"
|
|
852
|
+
}
|
|
853
|
+
|
|
840
854
|
// @public
|
|
841
855
|
export type LazyItem<Item = unknown> = Item | (() => Item);
|
|
842
856
|
|
|
@@ -909,11 +923,21 @@ export interface NodeSchemaOptions<out TCustomMetadata = unknown> {
|
|
|
909
923
|
readonly metadata?: NodeSchemaMetadata<TCustomMetadata> | undefined;
|
|
910
924
|
}
|
|
911
925
|
|
|
926
|
+
// @public @system
|
|
927
|
+
export type NumberKeys<T, Transformed = {
|
|
928
|
+
readonly [Property in keyof T as number extends Property ? never : Property]: Property;
|
|
929
|
+
}> = Transformed[`${number}` & keyof Transformed];
|
|
930
|
+
|
|
912
931
|
// @public @system
|
|
913
932
|
export type ObjectFromSchemaRecord<T extends RestrictiveStringRecord<ImplicitFieldSchema>> = RestrictiveStringRecord<ImplicitFieldSchema> extends T ? {} : {
|
|
914
933
|
-readonly [Property in keyof T]: Property extends string ? TreeFieldFromImplicitField<T[Property]> : unknown;
|
|
915
934
|
};
|
|
916
935
|
|
|
936
|
+
// @beta @input
|
|
937
|
+
export interface ObjectSchemaOptions<TCustomMetadata = unknown> extends NodeSchemaOptions<TCustomMetadata> {
|
|
938
|
+
readonly allowUnknownOptionalFields?: boolean;
|
|
939
|
+
}
|
|
940
|
+
|
|
917
941
|
// @public
|
|
918
942
|
export type Off = () => void;
|
|
919
943
|
|
|
@@ -1020,6 +1044,9 @@ export const SchemaFactory_base: SchemaStatics & (new () => SchemaStatics);
|
|
|
1020
1044
|
|
|
1021
1045
|
// @beta
|
|
1022
1046
|
export class SchemaFactoryBeta<out TScope extends string | undefined = string | undefined, TName extends number | string = string> extends SchemaFactory<TScope, TName> {
|
|
1047
|
+
object<const Name extends TName, const T extends RestrictiveStringRecord<ImplicitFieldSchema>, const TCustomMetadata = unknown>(name: Name, fields: T, options?: ObjectSchemaOptions<TCustomMetadata>): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Object, TreeObjectNode<T, ScopedSchemaName<TScope, Name>>, object & InsertableObjectFromSchemaRecord<T>, true, T>;
|
|
1048
|
+
// (undocumented)
|
|
1049
|
+
objectRecursive<const Name extends TName, const T extends RestrictiveStringRecord<System_Unsafe.ImplicitFieldSchemaUnsafe>, const TCustomMetadata = unknown>(name: Name, t: T, options?: ObjectSchemaOptions<TCustomMetadata>): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Object, System_Unsafe.TreeObjectNodeUnsafe<T, ScopedSchemaName<TScope, Name>>, object & System_Unsafe.InsertableObjectFromSchemaRecordUnsafe<T>, false, T>;
|
|
1023
1050
|
record<const T extends TreeNodeSchema | readonly TreeNodeSchema[]>(allowedTypes: T): TreeNodeSchemaNonClass<ScopedSchemaName<TScope, `Record<${string}>`>, NodeKind.Record, TreeRecordNode<T> & WithType<ScopedSchemaName<TScope, `Record<${string}>`>, NodeKind.Record>, RecordNodeInsertableData<T>, true, T, undefined>;
|
|
1024
1051
|
record<const Name extends TName, const T extends ImplicitAllowedTypes>(name: Name, allowedTypes: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Record, TreeRecordNode<T> & WithType<ScopedSchemaName<TScope, Name>, NodeKind.Record>, RecordNodeInsertableData<T>, true, T, undefined>;
|
|
1025
1052
|
recordRecursive<Name extends TName, const T extends System_Unsafe.ImplicitAllowedTypesUnsafe, const TCustomMetadata = unknown>(name: Name, allowedTypes: T, options?: NodeSchemaOptions<TCustomMetadata>): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Record, TreeRecordNodeUnsafe<T> & WithType<ScopedSchemaName<TScope, Name>, NodeKind.Record, unknown>, {
|
|
@@ -1293,6 +1320,9 @@ export const TreeArrayNode: {
|
|
|
1293
1320
|
export interface TreeBeta {
|
|
1294
1321
|
clone<const TSchema extends ImplicitFieldSchema>(node: TreeFieldFromImplicitField<TSchema>): TreeFieldFromImplicitField<TSchema>;
|
|
1295
1322
|
create<const TSchema extends ImplicitFieldSchema>(schema: TSchema, data: InsertableTreeFieldFromImplicitField<TSchema>): Unhydrated<TreeFieldFromImplicitField<TSchema>>;
|
|
1323
|
+
exportConcise(node: TreeNode | TreeLeafValue, options?: TreeEncodingOptions): ConciseTree;
|
|
1324
|
+
exportConcise(node: TreeNode | TreeLeafValue | undefined, options?: TreeEncodingOptions): ConciseTree | undefined;
|
|
1325
|
+
importConcise<const TSchema extends ImplicitFieldSchema>(schema: TSchema, data: ConciseTree | undefined): Unhydrated<TreeFieldFromImplicitField<TSchema>>;
|
|
1296
1326
|
on<K extends keyof TreeChangeEventsBeta<TNode>, TNode extends TreeNode>(node: TNode, eventName: K, listener: NoInfer<TreeChangeEventsBeta<TNode>[K]>): () => void;
|
|
1297
1327
|
}
|
|
1298
1328
|
|
|
@@ -1310,6 +1340,11 @@ export interface TreeChangeEventsBeta<TNode extends TreeNode = TreeNode> extends
|
|
|
1310
1340
|
nodeChanged: (data: NodeChangedData<TNode> & (TNode extends WithType<string, NodeKind.Map | NodeKind.Object | NodeKind.Record> ? Required<Pick<NodeChangedData<TNode>, "changedProperties">> : unknown)) => void;
|
|
1311
1341
|
}
|
|
1312
1342
|
|
|
1343
|
+
// @beta @input
|
|
1344
|
+
export interface TreeEncodingOptions<TKeyOptions = KeyEncodingOptions> {
|
|
1345
|
+
readonly keys?: TKeyOptions;
|
|
1346
|
+
}
|
|
1347
|
+
|
|
1313
1348
|
// @public
|
|
1314
1349
|
export type TreeFieldFromImplicitField<TSchema extends ImplicitFieldSchema = FieldSchema> = TSchema extends FieldSchema<infer Kind, infer Types> ? ApplyKind<TreeNodeFromImplicitAllowedTypes<Types>, Kind> : TSchema extends ImplicitAllowedTypes ? TreeNodeFromImplicitAllowedTypes<TSchema> : TreeNode | TreeLeafValue | undefined;
|
|
1315
1350
|
|
|
@@ -454,8 +454,10 @@ export type InsertableTreeFieldFromImplicitField<TSchemaInput extends ImplicitFi
|
|
|
454
454
|
|
|
455
455
|
// @public @system
|
|
456
456
|
export type InsertableTreeNodeFromAllowedTypes<TList extends AllowedTypes> = IsUnion<TList> extends true ? never : {
|
|
457
|
-
readonly [Property in keyof TList]: TList[Property] extends
|
|
458
|
-
|
|
457
|
+
readonly [Property in keyof TList]: [TList[Property]] extends [
|
|
458
|
+
LazyItem<infer TSchema extends TreeNodeSchema>
|
|
459
|
+
] ? InsertableTypedNode<TSchema> : never;
|
|
460
|
+
}[NumberKeys<TList>];
|
|
459
461
|
|
|
460
462
|
// @public
|
|
461
463
|
export type InsertableTreeNodeFromImplicitAllowedTypes<TSchema extends ImplicitAllowedTypes> = [
|
|
@@ -617,6 +619,11 @@ export interface NodeSchemaOptions<out TCustomMetadata = unknown> {
|
|
|
617
619
|
readonly metadata?: NodeSchemaMetadata<TCustomMetadata> | undefined;
|
|
618
620
|
}
|
|
619
621
|
|
|
622
|
+
// @public @system
|
|
623
|
+
export type NumberKeys<T, Transformed = {
|
|
624
|
+
readonly [Property in keyof T as number extends Property ? never : Property]: Property;
|
|
625
|
+
}> = Transformed[`${number}` & keyof Transformed];
|
|
626
|
+
|
|
620
627
|
// @public @system
|
|
621
628
|
export type ObjectFromSchemaRecord<T extends RestrictiveStringRecord<ImplicitFieldSchema>> = RestrictiveStringRecord<ImplicitFieldSchema> extends T ? {} : {
|
|
622
629
|
-readonly [Property in keyof T]: Property extends string ? TreeFieldFromImplicitField<T[Property]> : unknown;
|
|
@@ -426,8 +426,10 @@ export type InsertableTreeFieldFromImplicitField<TSchemaInput extends ImplicitFi
|
|
|
426
426
|
|
|
427
427
|
// @public @system
|
|
428
428
|
export type InsertableTreeNodeFromAllowedTypes<TList extends AllowedTypes> = IsUnion<TList> extends true ? never : {
|
|
429
|
-
readonly [Property in keyof TList]: TList[Property] extends
|
|
430
|
-
|
|
429
|
+
readonly [Property in keyof TList]: [TList[Property]] extends [
|
|
430
|
+
LazyItem<infer TSchema extends TreeNodeSchema>
|
|
431
|
+
] ? InsertableTypedNode<TSchema> : never;
|
|
432
|
+
}[NumberKeys<TList>];
|
|
431
433
|
|
|
432
434
|
// @public
|
|
433
435
|
export type InsertableTreeNodeFromImplicitAllowedTypes<TSchema extends ImplicitAllowedTypes> = [
|
|
@@ -583,6 +585,11 @@ export interface NodeSchemaOptions<out TCustomMetadata = unknown> {
|
|
|
583
585
|
readonly metadata?: NodeSchemaMetadata<TCustomMetadata> | undefined;
|
|
584
586
|
}
|
|
585
587
|
|
|
588
|
+
// @public @system
|
|
589
|
+
export type NumberKeys<T, Transformed = {
|
|
590
|
+
readonly [Property in keyof T as number extends Property ? never : Property]: Property;
|
|
591
|
+
}> = Transformed[`${number}` & keyof Transformed];
|
|
592
|
+
|
|
586
593
|
// @public @system
|
|
587
594
|
export type ObjectFromSchemaRecord<T extends RestrictiveStringRecord<ImplicitFieldSchema>> = RestrictiveStringRecord<ImplicitFieldSchema> extends T ? {} : {
|
|
588
595
|
-readonly [Property in keyof T]: Property extends string ? TreeFieldFromImplicitField<T[Property]> : unknown;
|
package/dist/alpha.d.ts
CHANGED
|
@@ -83,6 +83,7 @@ export {
|
|
|
83
83
|
NodeKind,
|
|
84
84
|
NodeSchemaMetadata,
|
|
85
85
|
NodeSchemaOptions,
|
|
86
|
+
NumberKeys,
|
|
86
87
|
ObjectFromSchemaRecord,
|
|
87
88
|
Off,
|
|
88
89
|
ReadonlyArrayNode,
|
|
@@ -136,18 +137,22 @@ export {
|
|
|
136
137
|
// #endregion
|
|
137
138
|
|
|
138
139
|
// #region @beta APIs
|
|
140
|
+
ConciseTree,
|
|
139
141
|
ForestOptions,
|
|
140
142
|
ForestType,
|
|
141
143
|
ForestTypeExpensiveDebug,
|
|
142
144
|
ForestTypeOptimized,
|
|
143
145
|
ForestTypeReference,
|
|
146
|
+
KeyEncodingOptions,
|
|
144
147
|
NodeChangedData,
|
|
148
|
+
ObjectSchemaOptions,
|
|
145
149
|
PopUnion,
|
|
146
150
|
RecordNodeInsertableData,
|
|
147
151
|
SchemaFactoryBeta,
|
|
148
152
|
SharedTreeOptionsBeta,
|
|
149
153
|
TreeBeta,
|
|
150
154
|
TreeChangeEventsBeta,
|
|
155
|
+
TreeEncodingOptions,
|
|
151
156
|
TreeRecordNode,
|
|
152
157
|
TreeRecordNodeUnsafe,
|
|
153
158
|
UnionToTuple,
|
|
@@ -159,7 +164,11 @@ export {
|
|
|
159
164
|
|
|
160
165
|
// #region @alpha APIs
|
|
161
166
|
AllowedTypeMetadata,
|
|
167
|
+
AllowedTypesFull,
|
|
168
|
+
AllowedTypesFullEvaluated,
|
|
169
|
+
AllowedTypesFullFromMixed,
|
|
162
170
|
AllowedTypesMetadata,
|
|
171
|
+
AnnotateAllowedTypesList,
|
|
163
172
|
AnnotatedAllowedType,
|
|
164
173
|
AnnotatedAllowedTypes,
|
|
165
174
|
ArrayNodeCustomizableSchema,
|
|
@@ -168,9 +177,9 @@ export {
|
|
|
168
177
|
ArrayNodeSchema,
|
|
169
178
|
BranchableTree,
|
|
170
179
|
CodecWriteOptions,
|
|
171
|
-
ConciseTree,
|
|
172
180
|
DirtyTreeMap,
|
|
173
181
|
DirtyTreeStatus,
|
|
182
|
+
ErasedBaseType,
|
|
174
183
|
FactoryContent,
|
|
175
184
|
FactoryContentObject,
|
|
176
185
|
FieldPropsAlpha,
|
|
@@ -186,12 +195,9 @@ export {
|
|
|
186
195
|
ICodecOptions,
|
|
187
196
|
ITreeAlpha,
|
|
188
197
|
IdentifierIndex,
|
|
189
|
-
ImplicitAnnotatedAllowedTypes,
|
|
190
|
-
ImplicitAnnotatedFieldSchema,
|
|
191
198
|
Insertable,
|
|
192
199
|
InsertableContent,
|
|
193
200
|
InsertableField,
|
|
194
|
-
InsertableObjectFromAnnotatedSchemaRecord,
|
|
195
201
|
JsonArrayNodeSchema,
|
|
196
202
|
JsonAsTree,
|
|
197
203
|
JsonCompatible,
|
|
@@ -212,14 +218,13 @@ export {
|
|
|
212
218
|
JsonSchemaType,
|
|
213
219
|
JsonStringKeyPatternProperties,
|
|
214
220
|
JsonTreeSchema,
|
|
215
|
-
KeyEncodingOptions,
|
|
216
221
|
MapNodeCustomizableSchema,
|
|
217
222
|
MapNodeCustomizableSchemaUnsafe,
|
|
218
223
|
MapNodePojoEmulationSchema,
|
|
219
224
|
MapNodeSchema,
|
|
220
225
|
NodeSchemaOptionsAlpha,
|
|
221
|
-
NormalizedAnnotatedAllowedTypes,
|
|
222
226
|
ObjectNodeSchema,
|
|
227
|
+
ObjectSchemaOptionsAlpha,
|
|
223
228
|
ObservationResults,
|
|
224
229
|
ReadSchema,
|
|
225
230
|
ReadableField,
|
|
@@ -230,7 +235,6 @@ export {
|
|
|
230
235
|
RevertibleAlphaFactory,
|
|
231
236
|
RunTransactionParams,
|
|
232
237
|
SchemaFactoryAlpha,
|
|
233
|
-
SchemaFactoryObjectOptions,
|
|
234
238
|
SchemaStaticsAlpha,
|
|
235
239
|
SchemaUpgrade,
|
|
236
240
|
SharedTreeFormatOptions,
|
|
@@ -259,7 +263,6 @@ export {
|
|
|
259
263
|
TreeBranchEvents,
|
|
260
264
|
TreeBranchFork,
|
|
261
265
|
TreeCompressionStrategy,
|
|
262
|
-
TreeEncodingOptions,
|
|
263
266
|
TreeIdentifierUtils,
|
|
264
267
|
TreeIndex,
|
|
265
268
|
TreeIndexKey,
|
|
@@ -269,12 +272,7 @@ export {
|
|
|
269
272
|
TreeSchemaEncodingOptions,
|
|
270
273
|
TreeViewAlpha,
|
|
271
274
|
TreeViewConfigurationAlpha,
|
|
272
|
-
UnannotateAllowedType,
|
|
273
|
-
UnannotateAllowedTypes,
|
|
274
275
|
UnannotateAllowedTypesList,
|
|
275
|
-
UnannotateImplicitAllowedTypes,
|
|
276
|
-
UnannotateImplicitFieldSchema,
|
|
277
|
-
UnannotateSchemaRecord,
|
|
278
276
|
UnsafeUnknownSchema,
|
|
279
277
|
ValueSchema,
|
|
280
278
|
VerboseTree,
|
|
@@ -297,6 +295,7 @@ export {
|
|
|
297
295
|
getSimpleSchema,
|
|
298
296
|
independentInitializedView,
|
|
299
297
|
independentView,
|
|
298
|
+
normalizeAllowedTypes,
|
|
300
299
|
onAssertionFailure,
|
|
301
300
|
persistedToSimpleSchema,
|
|
302
301
|
replaceConciseTreeHandles,
|
package/dist/beta.d.ts
CHANGED
|
@@ -83,6 +83,7 @@ export {
|
|
|
83
83
|
NodeKind,
|
|
84
84
|
NodeSchemaMetadata,
|
|
85
85
|
NodeSchemaOptions,
|
|
86
|
+
NumberKeys,
|
|
86
87
|
ObjectFromSchemaRecord,
|
|
87
88
|
Off,
|
|
88
89
|
ReadonlyArrayNode,
|
|
@@ -136,18 +137,22 @@ export {
|
|
|
136
137
|
// #endregion
|
|
137
138
|
|
|
138
139
|
// #region @beta APIs
|
|
140
|
+
ConciseTree,
|
|
139
141
|
ForestOptions,
|
|
140
142
|
ForestType,
|
|
141
143
|
ForestTypeExpensiveDebug,
|
|
142
144
|
ForestTypeOptimized,
|
|
143
145
|
ForestTypeReference,
|
|
146
|
+
KeyEncodingOptions,
|
|
144
147
|
NodeChangedData,
|
|
148
|
+
ObjectSchemaOptions,
|
|
145
149
|
PopUnion,
|
|
146
150
|
RecordNodeInsertableData,
|
|
147
151
|
SchemaFactoryBeta,
|
|
148
152
|
SharedTreeOptionsBeta,
|
|
149
153
|
TreeBeta,
|
|
150
154
|
TreeChangeEventsBeta,
|
|
155
|
+
TreeEncodingOptions,
|
|
151
156
|
TreeRecordNode,
|
|
152
157
|
TreeRecordNodeUnsafe,
|
|
153
158
|
UnionToTuple,
|
package/dist/index.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ export type { SharedObjectKind } from "@fluidframework/shared-object-base";
|
|
|
17
17
|
export type { IErrorBase, IEventProvider, IDisposable, IEvent, IEventThisPlaceHolder, IErrorEvent, ErasedType, IFluidHandle, IFluidLoadable, ITelemetryBaseProperties, IEventTransformer, IProvideFluidLoadable, IFluidHandleErased, TransformedEvent, TelemetryBaseEventPropertyType, Tagged, ReplaceIEventThisPlaceHolder, FluidObject, // Linked in doc comment
|
|
18
18
|
FluidObjectProviderKeys, // Used by FluidObject
|
|
19
19
|
Listeners, IsListener, Listenable, Off, } from "@fluidframework/core-interfaces";
|
|
20
|
+
export type { ErasedBaseType } from "@fluidframework/core-interfaces/internal";
|
|
20
21
|
export { onAssertionFailure } from "@fluidframework/core-utils/internal";
|
|
21
22
|
export type { isFluidHandle } from "@fluidframework/runtime-utils";
|
|
22
23
|
export * from "@fluidframework/tree/alpha";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAMH,YAAY,EACX,eAAe,IAAI,mBAAmB,EAAE,0CAA0C;AAClF,uBAAuB,GACvB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,GACN,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EACX,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,MAAM,EACN,4BAA4B,EAC5B,WAAW,EAAE,wBAAwB;AACrC,uBAAuB,EAAE,sBAAsB;AAE/C,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,GAEH,MAAM,iCAAiC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAMH,YAAY,EACX,eAAe,IAAI,mBAAmB,EAAE,0CAA0C;AAClF,uBAAuB,GACvB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,GACN,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EACX,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,MAAM,EACN,4BAA4B,EAC5B,WAAW,EAAE,wBAAwB;AACrC,uBAAuB,EAAE,sBAAsB;AAE/C,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,GAEH,MAAM,iCAAiC,CAAC;AACzC,YAAY,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAG/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,YAAY,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AASnE,cAAc,4BAA4B,CAAC;AAQ3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAsB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAExF;AAQD,YAAY,EACX,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,sBAAsB,EACtB,UAAU,EACV,gBAAgB,EAChB,aAAa,GACb,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAE1E,YAAY,EACX,mBAAmB,EACnB,qBAAqB,EACrB,SAAS,EACT,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,IAAI,EACJ,sBAAsB,EACtB,2BAA2B,EAC3B,iCAAiC,EACjC,qBAAqB,GACrB,MAAM,mCAAmC,CAAC;AAE3C,YAAY,EACX,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,wBAAwB,GACxB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE,YAAY,EACX,aAAa,EACb,mBAAmB,GACnB,MAAM,6CAA6C,CAAC;AAErD,YAAY,EACX,yBAAyB,EAAE,iCAAiC;AAC5D,aAAa,EAAE,yCAAyC;AACxD,MAAM,GACN,MAAM,6CAA6C,CAAC"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;AAiBH,+EAAoE;AAA3D,oHAAA,WAAW,OAAA;AACpB,qEAAmE;AAA1D,mHAAA,eAAe,OAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;AAiBH,+EAAoE;AAA3D,oHAAA,WAAW,OAAA;AACpB,qEAAmE;AAA1D,mHAAA,eAAe,OAAA;AA4CxB,4GAA4G;AAC5G,gEAAyE;AAAhE,8GAAA,kBAAkB,OAAA;AAI3B,mDAAmD;AACnD,4FAA4F;AAC5F;;;;MAIG;AACH,6DAA2C;AAU3C,4DAIuC;AAEvC;;;;;;;;;GASG;AACU,QAAA,UAAU,GAA4B,qBAAkB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,oBAAoB,CAAC,OAA0B;IAC9D,OAAO,IAAA,+BAA4B,EAAC,OAAO,CAAC,CAAC;AAC9C,CAAC;AAFD,oDAEC;AAmBD,yDAA0E;AAAjE,2GAAA,eAAe,OAAA;AAAE,qGAAA,SAAS,OAAA;AA4BnC,8DAAiE;AAAxD,wGAAA,YAAY,OAAA;AAarB,4BAA4B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client\n * package (e.g. `@fluidframework/azure-client`, `@fluidframework/tinylicious-client`, or `@fluidframework/odsp-client (BETA)`).\n *\n * @packageDocumentation\n */\n\n// ===============================================================\n// #region Public, Beta and Alpha (non-legacy) exports\n// #region Basic re-exports\n\nexport type {\n\tConnectionState as ConnectionStateType, // TODO: deduplicate ConnectionState types\n\tICriticalContainerError,\n} from \"@fluidframework/container-definitions\";\nexport { AttachState } from \"@fluidframework/container-definitions\";\nexport { ConnectionState } from \"@fluidframework/container-loader\";\nexport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIConnection,\n\tIFluidContainer,\n\tIFluidContainerEvents,\n\tIMember,\n\tInitialObjects,\n\tIServiceAudience,\n\tIServiceAudienceEvents,\n\tMemberChangedListener,\n\tMyself,\n} from \"@fluidframework/fluid-static\";\nexport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nexport type {\n\tIErrorBase,\n\tIEventProvider,\n\tIDisposable,\n\tIEvent,\n\tIEventThisPlaceHolder,\n\tIErrorEvent,\n\tErasedType,\n\tIFluidHandle,\n\tIFluidLoadable,\n\tITelemetryBaseProperties,\n\tIEventTransformer,\n\tIProvideFluidLoadable,\n\tIFluidHandleErased,\n\tTransformedEvent,\n\tTelemetryBaseEventPropertyType,\n\tTagged,\n\tReplaceIEventThisPlaceHolder,\n\tFluidObject, // Linked in doc comment\n\tFluidObjectProviderKeys, // Used by FluidObject\n\t/* eslint-disable import/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */\n\tListeners,\n\tIsListener,\n\tListenable,\n\tOff,\n\t/* eslint-enable import/export */\n} from \"@fluidframework/core-interfaces\";\nexport type { ErasedBaseType } from \"@fluidframework/core-interfaces/internal\";\n\n// This is an alpha API, but this package doesn't have an alpha entry point so its imported from \"internal\".\nexport { onAssertionFailure } from \"@fluidframework/core-utils/internal\";\n\nexport type { isFluidHandle } from \"@fluidframework/runtime-utils\";\n\n// Let the tree package manage its own API surface.\n// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.\n/* eslint-disable-next-line\n\tno-restricted-syntax,\n\timport/no-internal-modules,\n\timport/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.\n\t*/\nexport * from \"@fluidframework/tree/alpha\";\n\n// End of basic public+beta+alpha exports - nothing above this line should\n// depend on an /internal path.\n// #endregion Basic re-exports\n// ---------------------------------------------------------------\n// #region Custom re-exports\n\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nimport type { ITree } from \"@fluidframework/tree\";\nimport {\n\tSharedTree as OriginalSharedTree,\n\tconfiguredSharedTree as originalConfiguredSharedTree,\n\ttype SharedTreeOptions,\n} from \"@fluidframework/tree/internal\";\n\n/**\n * A hierarchical data structure for collaboratively editing strongly typed JSON-like trees\n * of objects, arrays, and other data types.\n * @privateRemarks\n * Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.\n * Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.\n * The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.\n * This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.\n * @public\n */\nexport const SharedTree: SharedObjectKind<ITree> = OriginalSharedTree;\n\n/**\n * {@link SharedTree} but allowing a non-default configuration.\n * @remarks\n * This is useful for debugging and testing.\n * For example, it can be used to opt into extra validation or see if opting out of some optimizations fixes an issue.\n *\n * With great care, and knowledge of the support and stability of the options exposed here,\n * this can also be used to opt into some features early or for performance tuning.\n *\n * @example\n * ```typescript\n * import {\n * \tTreeCompressionStrategy,\n * \tconfiguredSharedTree,\n * \tFormatValidatorBasic,\n * \tForestTypeReference,\n * } from \"fluid-framework/alpha\";\n * const SharedTree = configuredSharedTree({\n * \tforest: ForestTypeReference,\n * \tjsonValidator: FormatValidatorBasic,\n * \ttreeEncodeType: TreeCompressionStrategy.Uncompressed,\n * });\n * ```\n * @alpha\n */\nexport function configuredSharedTree(options: SharedTreeOptions): SharedObjectKind<ITree> {\n\treturn originalConfiguredSharedTree(options);\n}\n\n// #endregion Custom re-exports\n// #endregion\n\n// ===============================================================\n// #region Legacy exports\n\nexport type {\n\tIDirectory,\n\tIDirectoryEvents,\n\tIDirectoryValueChanged,\n\tISharedDirectory,\n\tISharedDirectoryEvents,\n\tISharedMap,\n\tISharedMapEvents,\n\tIValueChanged,\n} from \"@fluidframework/map/internal\";\n\nexport { SharedDirectory, SharedMap } from \"@fluidframework/map/internal\";\n\nexport type {\n\tDeserializeCallback,\n\tInteriorSequencePlace,\n\tIInterval,\n\tIntervalStickiness,\n\tISequenceDeltaRange,\n\tISerializedInterval,\n\tISharedSegmentSequenceEvents,\n\tISharedString,\n\tSequencePlace,\n\tSharedStringSegment,\n\tSide,\n\tISharedSegmentSequence,\n\tISequenceIntervalCollection,\n\tISequenceIntervalCollectionEvents,\n\tSequenceIntervalIndex,\n} from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tIntervalType,\n\tSequenceDeltaEvent,\n\tSequenceEvent,\n\tSequenceInterval,\n\tSequenceMaintenanceEvent,\n} from \"@fluidframework/sequence/internal\";\n\nexport { SharedString } from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tISharedObject,\n\tISharedObjectEvents,\n} from \"@fluidframework/shared-object-base/internal\";\n\nexport type {\n\tISequencedDocumentMessage, // Leaked via ISharedObjectEvents\n\tIBranchOrigin, // Required for ISequencedDocumentMessage\n\tITrace, // Required for ISequencedDocumentMessage\n} from \"@fluidframework/driver-definitions/internal\";\n\n// #endregion Legacy exports\n"]}
|
package/dist/legacy.d.ts
CHANGED
|
@@ -83,6 +83,7 @@ export {
|
|
|
83
83
|
NodeKind,
|
|
84
84
|
NodeSchemaMetadata,
|
|
85
85
|
NodeSchemaOptions,
|
|
86
|
+
NumberKeys,
|
|
86
87
|
ObjectFromSchemaRecord,
|
|
87
88
|
Off,
|
|
88
89
|
ReadonlyArrayNode,
|
|
@@ -143,18 +144,22 @@ export {
|
|
|
143
144
|
// #endregion
|
|
144
145
|
|
|
145
146
|
// #region @beta APIs
|
|
147
|
+
ConciseTree,
|
|
146
148
|
ForestOptions,
|
|
147
149
|
ForestType,
|
|
148
150
|
ForestTypeExpensiveDebug,
|
|
149
151
|
ForestTypeOptimized,
|
|
150
152
|
ForestTypeReference,
|
|
153
|
+
KeyEncodingOptions,
|
|
151
154
|
NodeChangedData,
|
|
155
|
+
ObjectSchemaOptions,
|
|
152
156
|
PopUnion,
|
|
153
157
|
RecordNodeInsertableData,
|
|
154
158
|
SchemaFactoryBeta,
|
|
155
159
|
SharedTreeOptionsBeta,
|
|
156
160
|
TreeBeta,
|
|
157
161
|
TreeChangeEventsBeta,
|
|
162
|
+
TreeEncodingOptions,
|
|
158
163
|
TreeRecordNode,
|
|
159
164
|
TreeRecordNodeUnsafe,
|
|
160
165
|
UnionToTuple,
|
package/dist/public.d.ts
CHANGED
package/lib/alpha.d.ts
CHANGED
|
@@ -83,6 +83,7 @@ export {
|
|
|
83
83
|
NodeKind,
|
|
84
84
|
NodeSchemaMetadata,
|
|
85
85
|
NodeSchemaOptions,
|
|
86
|
+
NumberKeys,
|
|
86
87
|
ObjectFromSchemaRecord,
|
|
87
88
|
Off,
|
|
88
89
|
ReadonlyArrayNode,
|
|
@@ -136,18 +137,22 @@ export {
|
|
|
136
137
|
// #endregion
|
|
137
138
|
|
|
138
139
|
// #region @beta APIs
|
|
140
|
+
ConciseTree,
|
|
139
141
|
ForestOptions,
|
|
140
142
|
ForestType,
|
|
141
143
|
ForestTypeExpensiveDebug,
|
|
142
144
|
ForestTypeOptimized,
|
|
143
145
|
ForestTypeReference,
|
|
146
|
+
KeyEncodingOptions,
|
|
144
147
|
NodeChangedData,
|
|
148
|
+
ObjectSchemaOptions,
|
|
145
149
|
PopUnion,
|
|
146
150
|
RecordNodeInsertableData,
|
|
147
151
|
SchemaFactoryBeta,
|
|
148
152
|
SharedTreeOptionsBeta,
|
|
149
153
|
TreeBeta,
|
|
150
154
|
TreeChangeEventsBeta,
|
|
155
|
+
TreeEncodingOptions,
|
|
151
156
|
TreeRecordNode,
|
|
152
157
|
TreeRecordNodeUnsafe,
|
|
153
158
|
UnionToTuple,
|
|
@@ -159,7 +164,11 @@ export {
|
|
|
159
164
|
|
|
160
165
|
// #region @alpha APIs
|
|
161
166
|
AllowedTypeMetadata,
|
|
167
|
+
AllowedTypesFull,
|
|
168
|
+
AllowedTypesFullEvaluated,
|
|
169
|
+
AllowedTypesFullFromMixed,
|
|
162
170
|
AllowedTypesMetadata,
|
|
171
|
+
AnnotateAllowedTypesList,
|
|
163
172
|
AnnotatedAllowedType,
|
|
164
173
|
AnnotatedAllowedTypes,
|
|
165
174
|
ArrayNodeCustomizableSchema,
|
|
@@ -168,9 +177,9 @@ export {
|
|
|
168
177
|
ArrayNodeSchema,
|
|
169
178
|
BranchableTree,
|
|
170
179
|
CodecWriteOptions,
|
|
171
|
-
ConciseTree,
|
|
172
180
|
DirtyTreeMap,
|
|
173
181
|
DirtyTreeStatus,
|
|
182
|
+
ErasedBaseType,
|
|
174
183
|
FactoryContent,
|
|
175
184
|
FactoryContentObject,
|
|
176
185
|
FieldPropsAlpha,
|
|
@@ -186,12 +195,9 @@ export {
|
|
|
186
195
|
ICodecOptions,
|
|
187
196
|
ITreeAlpha,
|
|
188
197
|
IdentifierIndex,
|
|
189
|
-
ImplicitAnnotatedAllowedTypes,
|
|
190
|
-
ImplicitAnnotatedFieldSchema,
|
|
191
198
|
Insertable,
|
|
192
199
|
InsertableContent,
|
|
193
200
|
InsertableField,
|
|
194
|
-
InsertableObjectFromAnnotatedSchemaRecord,
|
|
195
201
|
JsonArrayNodeSchema,
|
|
196
202
|
JsonAsTree,
|
|
197
203
|
JsonCompatible,
|
|
@@ -212,14 +218,13 @@ export {
|
|
|
212
218
|
JsonSchemaType,
|
|
213
219
|
JsonStringKeyPatternProperties,
|
|
214
220
|
JsonTreeSchema,
|
|
215
|
-
KeyEncodingOptions,
|
|
216
221
|
MapNodeCustomizableSchema,
|
|
217
222
|
MapNodeCustomizableSchemaUnsafe,
|
|
218
223
|
MapNodePojoEmulationSchema,
|
|
219
224
|
MapNodeSchema,
|
|
220
225
|
NodeSchemaOptionsAlpha,
|
|
221
|
-
NormalizedAnnotatedAllowedTypes,
|
|
222
226
|
ObjectNodeSchema,
|
|
227
|
+
ObjectSchemaOptionsAlpha,
|
|
223
228
|
ObservationResults,
|
|
224
229
|
ReadSchema,
|
|
225
230
|
ReadableField,
|
|
@@ -230,7 +235,6 @@ export {
|
|
|
230
235
|
RevertibleAlphaFactory,
|
|
231
236
|
RunTransactionParams,
|
|
232
237
|
SchemaFactoryAlpha,
|
|
233
|
-
SchemaFactoryObjectOptions,
|
|
234
238
|
SchemaStaticsAlpha,
|
|
235
239
|
SchemaUpgrade,
|
|
236
240
|
SharedTreeFormatOptions,
|
|
@@ -259,7 +263,6 @@ export {
|
|
|
259
263
|
TreeBranchEvents,
|
|
260
264
|
TreeBranchFork,
|
|
261
265
|
TreeCompressionStrategy,
|
|
262
|
-
TreeEncodingOptions,
|
|
263
266
|
TreeIdentifierUtils,
|
|
264
267
|
TreeIndex,
|
|
265
268
|
TreeIndexKey,
|
|
@@ -269,12 +272,7 @@ export {
|
|
|
269
272
|
TreeSchemaEncodingOptions,
|
|
270
273
|
TreeViewAlpha,
|
|
271
274
|
TreeViewConfigurationAlpha,
|
|
272
|
-
UnannotateAllowedType,
|
|
273
|
-
UnannotateAllowedTypes,
|
|
274
275
|
UnannotateAllowedTypesList,
|
|
275
|
-
UnannotateImplicitAllowedTypes,
|
|
276
|
-
UnannotateImplicitFieldSchema,
|
|
277
|
-
UnannotateSchemaRecord,
|
|
278
276
|
UnsafeUnknownSchema,
|
|
279
277
|
ValueSchema,
|
|
280
278
|
VerboseTree,
|
|
@@ -297,6 +295,7 @@ export {
|
|
|
297
295
|
getSimpleSchema,
|
|
298
296
|
independentInitializedView,
|
|
299
297
|
independentView,
|
|
298
|
+
normalizeAllowedTypes,
|
|
300
299
|
onAssertionFailure,
|
|
301
300
|
persistedToSimpleSchema,
|
|
302
301
|
replaceConciseTreeHandles,
|
package/lib/beta.d.ts
CHANGED
|
@@ -83,6 +83,7 @@ export {
|
|
|
83
83
|
NodeKind,
|
|
84
84
|
NodeSchemaMetadata,
|
|
85
85
|
NodeSchemaOptions,
|
|
86
|
+
NumberKeys,
|
|
86
87
|
ObjectFromSchemaRecord,
|
|
87
88
|
Off,
|
|
88
89
|
ReadonlyArrayNode,
|
|
@@ -136,18 +137,22 @@ export {
|
|
|
136
137
|
// #endregion
|
|
137
138
|
|
|
138
139
|
// #region @beta APIs
|
|
140
|
+
ConciseTree,
|
|
139
141
|
ForestOptions,
|
|
140
142
|
ForestType,
|
|
141
143
|
ForestTypeExpensiveDebug,
|
|
142
144
|
ForestTypeOptimized,
|
|
143
145
|
ForestTypeReference,
|
|
146
|
+
KeyEncodingOptions,
|
|
144
147
|
NodeChangedData,
|
|
148
|
+
ObjectSchemaOptions,
|
|
145
149
|
PopUnion,
|
|
146
150
|
RecordNodeInsertableData,
|
|
147
151
|
SchemaFactoryBeta,
|
|
148
152
|
SharedTreeOptionsBeta,
|
|
149
153
|
TreeBeta,
|
|
150
154
|
TreeChangeEventsBeta,
|
|
155
|
+
TreeEncodingOptions,
|
|
151
156
|
TreeRecordNode,
|
|
152
157
|
TreeRecordNodeUnsafe,
|
|
153
158
|
UnionToTuple,
|
package/lib/index.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ export type { SharedObjectKind } from "@fluidframework/shared-object-base";
|
|
|
17
17
|
export type { IErrorBase, IEventProvider, IDisposable, IEvent, IEventThisPlaceHolder, IErrorEvent, ErasedType, IFluidHandle, IFluidLoadable, ITelemetryBaseProperties, IEventTransformer, IProvideFluidLoadable, IFluidHandleErased, TransformedEvent, TelemetryBaseEventPropertyType, Tagged, ReplaceIEventThisPlaceHolder, FluidObject, // Linked in doc comment
|
|
18
18
|
FluidObjectProviderKeys, // Used by FluidObject
|
|
19
19
|
Listeners, IsListener, Listenable, Off, } from "@fluidframework/core-interfaces";
|
|
20
|
+
export type { ErasedBaseType } from "@fluidframework/core-interfaces/internal";
|
|
20
21
|
export { onAssertionFailure } from "@fluidframework/core-utils/internal";
|
|
21
22
|
export type { isFluidHandle } from "@fluidframework/runtime-utils";
|
|
22
23
|
export * from "@fluidframework/tree/alpha";
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAMH,YAAY,EACX,eAAe,IAAI,mBAAmB,EAAE,0CAA0C;AAClF,uBAAuB,GACvB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,GACN,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EACX,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,MAAM,EACN,4BAA4B,EAC5B,WAAW,EAAE,wBAAwB;AACrC,uBAAuB,EAAE,sBAAsB;AAE/C,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,GAEH,MAAM,iCAAiC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAMH,YAAY,EACX,eAAe,IAAI,mBAAmB,EAAE,0CAA0C;AAClF,uBAAuB,GACvB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACnE,YAAY,EACX,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,OAAO,EACP,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,MAAM,GACN,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,YAAY,EACX,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,qBAAqB,EACrB,WAAW,EACX,UAAU,EACV,YAAY,EACZ,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,8BAA8B,EAC9B,MAAM,EACN,4BAA4B,EAC5B,WAAW,EAAE,wBAAwB;AACrC,uBAAuB,EAAE,sBAAsB;AAE/C,SAAS,EACT,UAAU,EACV,UAAU,EACV,GAAG,GAEH,MAAM,iCAAiC,CAAC;AACzC,YAAY,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAG/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,YAAY,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AASnE,cAAc,4BAA4B,CAAC;AAQ3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAsB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAExF;AAQD,YAAY,EACX,UAAU,EACV,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,sBAAsB,EACtB,UAAU,EACV,gBAAgB,EAChB,aAAa,GACb,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAE1E,YAAY,EACX,mBAAmB,EACnB,qBAAqB,EACrB,SAAS,EACT,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,IAAI,EACJ,sBAAsB,EACtB,2BAA2B,EAC3B,iCAAiC,EACjC,qBAAqB,GACrB,MAAM,mCAAmC,CAAC;AAE3C,YAAY,EACX,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,wBAAwB,GACxB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE,YAAY,EACX,aAAa,EACb,mBAAmB,GACnB,MAAM,6CAA6C,CAAC;AAErD,YAAY,EACX,yBAAyB,EAAE,iCAAiC;AAC5D,aAAa,EAAE,yCAAyC;AACxD,MAAM,GACN,MAAM,6CAA6C,CAAC"}
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AA4CnE,4GAA4G;AAC5G,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAIzE,mDAAmD;AACnD,4FAA4F;AAC5F;;;;MAIG;AACH,cAAc,4BAA4B,CAAC;AAU3C,OAAO,EACN,UAAU,IAAI,kBAAkB,EAChC,oBAAoB,IAAI,4BAA4B,GAEpD,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAA4B,kBAAkB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA0B;IAC9D,OAAO,4BAA4B,CAAC,OAAO,CAAC,CAAC;AAC9C,CAAC;AAmBD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AA4B1E,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAajE,4BAA4B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client\n * package (e.g. `@fluidframework/azure-client`, `@fluidframework/tinylicious-client`, or `@fluidframework/odsp-client (BETA)`).\n *\n * @packageDocumentation\n */\n\n// ===============================================================\n// #region Public, Beta and Alpha (non-legacy) exports\n// #region Basic re-exports\n\nexport type {\n\tConnectionState as ConnectionStateType, // TODO: deduplicate ConnectionState types\n\tICriticalContainerError,\n} from \"@fluidframework/container-definitions\";\nexport { AttachState } from \"@fluidframework/container-definitions\";\nexport { ConnectionState } from \"@fluidframework/container-loader\";\nexport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIConnection,\n\tIFluidContainer,\n\tIFluidContainerEvents,\n\tIMember,\n\tInitialObjects,\n\tIServiceAudience,\n\tIServiceAudienceEvents,\n\tMemberChangedListener,\n\tMyself,\n} from \"@fluidframework/fluid-static\";\nexport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nexport type {\n\tIErrorBase,\n\tIEventProvider,\n\tIDisposable,\n\tIEvent,\n\tIEventThisPlaceHolder,\n\tIErrorEvent,\n\tErasedType,\n\tIFluidHandle,\n\tIFluidLoadable,\n\tITelemetryBaseProperties,\n\tIEventTransformer,\n\tIProvideFluidLoadable,\n\tIFluidHandleErased,\n\tTransformedEvent,\n\tTelemetryBaseEventPropertyType,\n\tTagged,\n\tReplaceIEventThisPlaceHolder,\n\tFluidObject, // Linked in doc comment\n\tFluidObjectProviderKeys, // Used by FluidObject\n\t/* eslint-disable import/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */\n\tListeners,\n\tIsListener,\n\tListenable,\n\tOff,\n\t/* eslint-enable import/export */\n} from \"@fluidframework/core-interfaces\";\nexport type { ErasedBaseType } from \"@fluidframework/core-interfaces/internal\";\n\n// This is an alpha API, but this package doesn't have an alpha entry point so its imported from \"internal\".\nexport { onAssertionFailure } from \"@fluidframework/core-utils/internal\";\n\nexport type { isFluidHandle } from \"@fluidframework/runtime-utils\";\n\n// Let the tree package manage its own API surface.\n// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.\n/* eslint-disable-next-line\n\tno-restricted-syntax,\n\timport/no-internal-modules,\n\timport/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.\n\t*/\nexport * from \"@fluidframework/tree/alpha\";\n\n// End of basic public+beta+alpha exports - nothing above this line should\n// depend on an /internal path.\n// #endregion Basic re-exports\n// ---------------------------------------------------------------\n// #region Custom re-exports\n\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nimport type { ITree } from \"@fluidframework/tree\";\nimport {\n\tSharedTree as OriginalSharedTree,\n\tconfiguredSharedTree as originalConfiguredSharedTree,\n\ttype SharedTreeOptions,\n} from \"@fluidframework/tree/internal\";\n\n/**\n * A hierarchical data structure for collaboratively editing strongly typed JSON-like trees\n * of objects, arrays, and other data types.\n * @privateRemarks\n * Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.\n * Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.\n * The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.\n * This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.\n * @public\n */\nexport const SharedTree: SharedObjectKind<ITree> = OriginalSharedTree;\n\n/**\n * {@link SharedTree} but allowing a non-default configuration.\n * @remarks\n * This is useful for debugging and testing.\n * For example, it can be used to opt into extra validation or see if opting out of some optimizations fixes an issue.\n *\n * With great care, and knowledge of the support and stability of the options exposed here,\n * this can also be used to opt into some features early or for performance tuning.\n *\n * @example\n * ```typescript\n * import {\n * \tTreeCompressionStrategy,\n * \tconfiguredSharedTree,\n * \tFormatValidatorBasic,\n * \tForestTypeReference,\n * } from \"fluid-framework/alpha\";\n * const SharedTree = configuredSharedTree({\n * \tforest: ForestTypeReference,\n * \tjsonValidator: FormatValidatorBasic,\n * \ttreeEncodeType: TreeCompressionStrategy.Uncompressed,\n * });\n * ```\n * @alpha\n */\nexport function configuredSharedTree(options: SharedTreeOptions): SharedObjectKind<ITree> {\n\treturn originalConfiguredSharedTree(options);\n}\n\n// #endregion Custom re-exports\n// #endregion\n\n// ===============================================================\n// #region Legacy exports\n\nexport type {\n\tIDirectory,\n\tIDirectoryEvents,\n\tIDirectoryValueChanged,\n\tISharedDirectory,\n\tISharedDirectoryEvents,\n\tISharedMap,\n\tISharedMapEvents,\n\tIValueChanged,\n} from \"@fluidframework/map/internal\";\n\nexport { SharedDirectory, SharedMap } from \"@fluidframework/map/internal\";\n\nexport type {\n\tDeserializeCallback,\n\tInteriorSequencePlace,\n\tIInterval,\n\tIntervalStickiness,\n\tISequenceDeltaRange,\n\tISerializedInterval,\n\tISharedSegmentSequenceEvents,\n\tISharedString,\n\tSequencePlace,\n\tSharedStringSegment,\n\tSide,\n\tISharedSegmentSequence,\n\tISequenceIntervalCollection,\n\tISequenceIntervalCollectionEvents,\n\tSequenceIntervalIndex,\n} from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tIntervalType,\n\tSequenceDeltaEvent,\n\tSequenceEvent,\n\tSequenceInterval,\n\tSequenceMaintenanceEvent,\n} from \"@fluidframework/sequence/internal\";\n\nexport { SharedString } from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tISharedObject,\n\tISharedObjectEvents,\n} from \"@fluidframework/shared-object-base/internal\";\n\nexport type {\n\tISequencedDocumentMessage, // Leaked via ISharedObjectEvents\n\tIBranchOrigin, // Required for ISequencedDocumentMessage\n\tITrace, // Required for ISequencedDocumentMessage\n} from \"@fluidframework/driver-definitions/internal\";\n\n// #endregion Legacy exports\n"]}
|
package/lib/legacy.d.ts
CHANGED
|
@@ -83,6 +83,7 @@ export {
|
|
|
83
83
|
NodeKind,
|
|
84
84
|
NodeSchemaMetadata,
|
|
85
85
|
NodeSchemaOptions,
|
|
86
|
+
NumberKeys,
|
|
86
87
|
ObjectFromSchemaRecord,
|
|
87
88
|
Off,
|
|
88
89
|
ReadonlyArrayNode,
|
|
@@ -143,18 +144,22 @@ export {
|
|
|
143
144
|
// #endregion
|
|
144
145
|
|
|
145
146
|
// #region @beta APIs
|
|
147
|
+
ConciseTree,
|
|
146
148
|
ForestOptions,
|
|
147
149
|
ForestType,
|
|
148
150
|
ForestTypeExpensiveDebug,
|
|
149
151
|
ForestTypeOptimized,
|
|
150
152
|
ForestTypeReference,
|
|
153
|
+
KeyEncodingOptions,
|
|
151
154
|
NodeChangedData,
|
|
155
|
+
ObjectSchemaOptions,
|
|
152
156
|
PopUnion,
|
|
153
157
|
RecordNodeInsertableData,
|
|
154
158
|
SchemaFactoryBeta,
|
|
155
159
|
SharedTreeOptionsBeta,
|
|
156
160
|
TreeBeta,
|
|
157
161
|
TreeChangeEventsBeta,
|
|
162
|
+
TreeEncodingOptions,
|
|
158
163
|
TreeRecordNode,
|
|
159
164
|
TreeRecordNodeUnsafe,
|
|
160
165
|
UnionToTuple,
|