fluid-framework 2.113.1 → 2.115.0

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.
@@ -135,6 +135,29 @@ type FlexList<Item = unknown> = readonly LazyItem<Item>[];
135
135
  // @public @system
136
136
  type FlexListToUnion<TList extends FlexList> = ExtractItemType<TList[number]>;
137
137
 
138
+ // @public @sealed
139
+ export interface FluidIterable<T> {
140
+ [Symbol.iterator](): FluidIterableIterator<T>;
141
+ }
142
+
143
+ // @public @sealed
144
+ export interface FluidIterableIterator<T> extends FluidIterable<T> {
145
+ next(): {
146
+ value: T;
147
+ done?: false;
148
+ } | {
149
+ value: any;
150
+ done: true;
151
+ };
152
+ }
153
+
154
+ // @public @sealed
155
+ export interface FluidMap<K, V> extends FluidReadonlyMap<K, V> {
156
+ delete(key: K): void;
157
+ forEach(callbackfn: (value: V, key: K, map: FluidMap<K, V>) => void, thisArg?: any): void;
158
+ set(key: K, value: V): void;
159
+ }
160
+
138
161
  // @public
139
162
  export type FluidObject<T = unknown> = {
140
163
  [P in FluidObjectProviderKeys<T>]?: T[P];
@@ -143,6 +166,62 @@ export type FluidObject<T = unknown> = {
143
166
  // @public
144
167
  export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
145
168
 
169
+ // @public @sealed
170
+ export interface FluidReadonlyArray<T> {
171
+ [Symbol.iterator](): FluidIterableIterator<T>;
172
+ readonly [Symbol.unscopables]: {
173
+ [K in keyof (readonly any[])]?: boolean;
174
+ };
175
+ readonly [n: number]: T;
176
+ at(index: number): T | undefined;
177
+ concat(...items: ConcatArray<T>[]): T[];
178
+ concat(...items: (T | ConcatArray<T>)[]): T[];
179
+ entries(): FluidIterableIterator<[number, T]>;
180
+ every<S extends T>(predicate: (value: T, index: number, array: readonly T[]) => value is S, thisArg?: any): this is FluidReadonlyArray<S>;
181
+ every(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): boolean;
182
+ filter<S extends T>(predicate: (value: T, index: number, array: readonly T[]) => value is S, thisArg?: any): S[];
183
+ filter(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): T[];
184
+ find<S extends T>(predicate: (value: T, index: number, obj: readonly T[]) => value is S, thisArg?: any): S | undefined;
185
+ find(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): T | undefined;
186
+ findIndex(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): number;
187
+ findLast<S extends T>(predicate: (value: T, index: number, obj: readonly T[]) => value is S, thisArg?: any): S | undefined;
188
+ findLast(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): T | undefined;
189
+ findLastIndex(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): number;
190
+ flat<A, D extends number = 1>(this: A, depth?: D): FlatArray<A, D>[];
191
+ flatMap<U, This = undefined>(callback: (this: This, value: T, index: number, array: T[]) => U | readonly U[], thisArg?: This): U[];
192
+ forEach(callbackfn: (value: T, index: number, array: readonly T[]) => void, thisArg?: any): void;
193
+ includes(searchElement: T, fromIndex?: number): boolean;
194
+ indexOf(searchElement: T, fromIndex?: number): number;
195
+ join(separator?: string): string;
196
+ keys(): FluidIterableIterator<number>;
197
+ lastIndexOf(searchElement: T, fromIndex?: number): number;
198
+ readonly length: number;
199
+ map<U>(callbackfn: (value: T, index: number, array: readonly T[]) => U, thisArg?: any): U[];
200
+ reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: readonly T[]) => T): T;
201
+ reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: readonly T[]) => U, initialValue: U): U;
202
+ reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: readonly T[]) => T): T;
203
+ reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: readonly T[]) => U, initialValue: U): U;
204
+ slice(start?: number, end?: number): T[];
205
+ some(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): boolean;
206
+ // (undocumented)
207
+ toLocaleString(): string;
208
+ toString(): string;
209
+ values(): FluidIterableIterator<T>;
210
+ }
211
+
212
+ // @public @sealed
213
+ export interface FluidReadonlyMap<K, V> {
214
+ [Symbol.iterator](): FluidIterableIterator<[K, V]>;
215
+ readonly [Symbol.toStringTag]: string;
216
+ entries(): FluidIterableIterator<[K, V]>;
217
+ forEach(callbackfn: (value: V, key: K, map: FluidReadonlyMap<K, V>) => void, thisArg?: any): void;
218
+ get(key: K): V | undefined;
219
+ has(key: K): boolean;
220
+ keys(): FluidIterableIterator<K>;
221
+ readonly size: number;
222
+ values(): FluidIterableIterator<V>;
223
+ }
224
+
146
225
  // @public
147
226
  export const getPresence: (fluidContainer: IFluidContainer) => Presence;
148
227
 
@@ -135,6 +135,29 @@ type FlexList<Item = unknown> = readonly LazyItem<Item>[];
135
135
  // @public @system
136
136
  type FlexListToUnion<TList extends FlexList> = ExtractItemType<TList[number]>;
137
137
 
138
+ // @public @sealed
139
+ export interface FluidIterable<T> {
140
+ [Symbol.iterator](): FluidIterableIterator<T>;
141
+ }
142
+
143
+ // @public @sealed
144
+ export interface FluidIterableIterator<T> extends FluidIterable<T> {
145
+ next(): {
146
+ value: T;
147
+ done?: false;
148
+ } | {
149
+ value: any;
150
+ done: true;
151
+ };
152
+ }
153
+
154
+ // @public @sealed
155
+ export interface FluidMap<K, V> extends FluidReadonlyMap<K, V> {
156
+ delete(key: K): void;
157
+ forEach(callbackfn: (value: V, key: K, map: FluidMap<K, V>) => void, thisArg?: any): void;
158
+ set(key: K, value: V): void;
159
+ }
160
+
138
161
  // @public
139
162
  export type FluidObject<T = unknown> = {
140
163
  [P in FluidObjectProviderKeys<T>]?: T[P];
@@ -143,6 +166,62 @@ export type FluidObject<T = unknown> = {
143
166
  // @public
144
167
  export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
145
168
 
169
+ // @public @sealed
170
+ export interface FluidReadonlyArray<T> {
171
+ [Symbol.iterator](): FluidIterableIterator<T>;
172
+ readonly [Symbol.unscopables]: {
173
+ [K in keyof (readonly any[])]?: boolean;
174
+ };
175
+ readonly [n: number]: T;
176
+ at(index: number): T | undefined;
177
+ concat(...items: ConcatArray<T>[]): T[];
178
+ concat(...items: (T | ConcatArray<T>)[]): T[];
179
+ entries(): FluidIterableIterator<[number, T]>;
180
+ every<S extends T>(predicate: (value: T, index: number, array: readonly T[]) => value is S, thisArg?: any): this is FluidReadonlyArray<S>;
181
+ every(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): boolean;
182
+ filter<S extends T>(predicate: (value: T, index: number, array: readonly T[]) => value is S, thisArg?: any): S[];
183
+ filter(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): T[];
184
+ find<S extends T>(predicate: (value: T, index: number, obj: readonly T[]) => value is S, thisArg?: any): S | undefined;
185
+ find(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): T | undefined;
186
+ findIndex(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): number;
187
+ findLast<S extends T>(predicate: (value: T, index: number, obj: readonly T[]) => value is S, thisArg?: any): S | undefined;
188
+ findLast(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): T | undefined;
189
+ findLastIndex(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): number;
190
+ flat<A, D extends number = 1>(this: A, depth?: D): FlatArray<A, D>[];
191
+ flatMap<U, This = undefined>(callback: (this: This, value: T, index: number, array: T[]) => U | readonly U[], thisArg?: This): U[];
192
+ forEach(callbackfn: (value: T, index: number, array: readonly T[]) => void, thisArg?: any): void;
193
+ includes(searchElement: T, fromIndex?: number): boolean;
194
+ indexOf(searchElement: T, fromIndex?: number): number;
195
+ join(separator?: string): string;
196
+ keys(): FluidIterableIterator<number>;
197
+ lastIndexOf(searchElement: T, fromIndex?: number): number;
198
+ readonly length: number;
199
+ map<U>(callbackfn: (value: T, index: number, array: readonly T[]) => U, thisArg?: any): U[];
200
+ reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: readonly T[]) => T): T;
201
+ reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: readonly T[]) => U, initialValue: U): U;
202
+ reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: readonly T[]) => T): T;
203
+ reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: readonly T[]) => U, initialValue: U): U;
204
+ slice(start?: number, end?: number): T[];
205
+ some(predicate: (value: T, index: number, array: readonly T[]) => unknown, thisArg?: any): boolean;
206
+ // (undocumented)
207
+ toLocaleString(): string;
208
+ toString(): string;
209
+ values(): FluidIterableIterator<T>;
210
+ }
211
+
212
+ // @public @sealed
213
+ export interface FluidReadonlyMap<K, V> {
214
+ [Symbol.iterator](): FluidIterableIterator<[K, V]>;
215
+ readonly [Symbol.toStringTag]: string;
216
+ entries(): FluidIterableIterator<[K, V]>;
217
+ forEach(callbackfn: (value: V, key: K, map: FluidReadonlyMap<K, V>) => void, thisArg?: any): void;
218
+ get(key: K): V | undefined;
219
+ has(key: K): boolean;
220
+ keys(): FluidIterableIterator<K>;
221
+ readonly size: number;
222
+ values(): FluidIterableIterator<V>;
223
+ }
224
+
146
225
  // @public
147
226
  export const getPresence: (fluidContainer: IFluidContainer) => Presence;
148
227
 
package/dist/alpha.d.ts CHANGED
@@ -34,8 +34,13 @@ export {
34
34
  FieldProps,
35
35
  FieldSchema,
36
36
  FieldSchemaMetadata,
37
+ FluidIterable,
38
+ FluidIterableIterator,
39
+ FluidMap,
37
40
  FluidObject,
38
41
  FluidObjectProviderKeys,
42
+ FluidReadonlyArray,
43
+ FluidReadonlyMap,
39
44
  IConnection,
40
45
  ICriticalContainerError,
41
46
  IDisposable,
@@ -159,10 +164,6 @@ export {
159
164
  ErasedBaseType,
160
165
  ExtensibleUnionNode,
161
166
  FixRecursiveArraySchema,
162
- FluidIterable,
163
- FluidIterableIterator,
164
- FluidMap,
165
- FluidReadonlyMap,
166
167
  FluidSerializableAsTree,
167
168
  ForestOptions,
168
169
  ForestType,
@@ -236,8 +237,15 @@ export {
236
237
  ChangeMetadata,
237
238
  CodecName,
238
239
  CodecWriteOptions,
240
+ CommitOutcome,
239
241
  Component,
240
242
  CreateIndependentTreeAlphaOptions,
243
+ DataStoreContext,
244
+ DataStoreCreator,
245
+ DataStoreKey,
246
+ DataStoreKind,
247
+ DataStoreOptions,
248
+ DataStoreRegistry,
241
249
  DirtyTreeMap,
242
250
  DirtyTreeStatus,
243
251
  ErasedNode,
@@ -251,10 +259,14 @@ export {
251
259
  FieldSchemaAlpha,
252
260
  FieldSchemaAlphaUnsafe,
253
261
  FluidClientVersion,
262
+ FluidContainer,
263
+ FluidContainerAttached,
264
+ FluidContainerWithService,
254
265
  FormatValidator,
255
266
  FormatValidatorBasic,
256
267
  FormatValidatorNoOp,
257
268
  FormatVersion,
269
+ FormattedText,
258
270
  HandleConverter,
259
271
  ICodecOptions,
260
272
  ITreeAlpha,
@@ -287,10 +299,12 @@ export {
287
299
  JsonTreeSchema,
288
300
  LabelTree,
289
301
  LocalChangeMetadata,
302
+ LocalCommitEvents,
290
303
  MapNodeCustomizableSchema,
291
304
  MapNodeCustomizableSchemaUnsafe,
292
305
  MapNodePojoEmulationSchema,
293
306
  MapNodeSchema,
307
+ MinimumVersionForCollaboration,
294
308
  NoChangeConstraint,
295
309
  NodeChangedDataAlpha,
296
310
  NodeChangedDataDelta,
@@ -302,11 +316,14 @@ export {
302
316
  ObjectNodeSchemaWorkaround,
303
317
  ObjectSchemaOptionsAlpha,
304
318
  ObservationResults,
319
+ PlainText,
305
320
  ReadSchema,
306
321
  ReadableField,
307
322
  RecordNodeCustomizableSchema,
308
323
  RecordNodePojoEmulationSchema,
309
324
  RecordNodeSchema,
325
+ Registry,
326
+ RegistryKey,
310
327
  RemoteChangeMetadata,
311
328
  RevertibleAlpha,
312
329
  RevertibleAlphaFactory,
@@ -314,6 +331,13 @@ export {
314
331
  SchemaFactoryAlpha,
315
332
  SchemaStaticsAlpha,
316
333
  SchemaType,
334
+ ServiceClient,
335
+ ServiceOptions,
336
+ SharedObjectCreator,
337
+ SharedObjectKey,
338
+ SharedObjectKindAlpha,
339
+ SharedObjectRegistry,
340
+ SharedTreeAlpha,
317
341
  SharedTreeFormatOptions,
318
342
  SharedTreeOptions,
319
343
  SimpleAllowedTypeAttributes,
@@ -329,7 +353,7 @@ export {
329
353
  SimpleTreeSchema,
330
354
  StagedSchemaUpgradePolicy,
331
355
  StagedSchemaUpgradePolicyFactory,
332
- TextAsTree,
356
+ StringSchema,
333
357
  TransactionCallbackStatusAlpha,
334
358
  TransactionConstraintAlpha,
335
359
  TransactionLabels,
@@ -341,6 +365,7 @@ export {
341
365
  TreeChangeEventsAlpha,
342
366
  TreeCompressionStrategy,
343
367
  TreeContextAlpha,
368
+ TreeDataStoreOptions,
344
369
  TreeIdentifierUtils,
345
370
  TreeMapNodeAlpha,
346
371
  TreeParsingOptions,
@@ -364,8 +389,11 @@ export {
364
389
  configuredSharedTreeAlpha,
365
390
  contentSchemaSymbol,
366
391
  createArrayInsertionAnchor,
392
+ createBasicRegistryKey,
367
393
  createIndependentTreeAlpha,
368
394
  decodeSchemaCompatibilitySnapshot,
395
+ defineDataStore,
396
+ defineTreeDataStore,
369
397
  encodeSchemaCompatibilitySnapshot,
370
398
  eraseSchemaDetails,
371
399
  eraseSchemaDetailsSubclassable,
@@ -381,12 +409,15 @@ export {
381
409
  incrementalSummaryHint,
382
410
  independentInitializedView,
383
411
  independentView,
412
+ instantiateTreeFirstTime,
413
+ lookupInRegistry,
384
414
  minimize,
385
415
  normalizeAllowedTypes,
386
416
  persistedToSimpleSchema,
387
417
  replaceConciseTreeHandles,
388
418
  replaceHandles,
389
419
  replaceVerboseTreeHandles,
420
+ sharedObjectRegistryFromIterable,
390
421
  trackDirtyNodes
391
422
  // #endregion
392
423
  } from "./index.js";
package/dist/beta.d.ts CHANGED
@@ -34,8 +34,13 @@ export {
34
34
  FieldProps,
35
35
  FieldSchema,
36
36
  FieldSchemaMetadata,
37
+ FluidIterable,
38
+ FluidIterableIterator,
39
+ FluidMap,
37
40
  FluidObject,
38
41
  FluidObjectProviderKeys,
42
+ FluidReadonlyArray,
43
+ FluidReadonlyMap,
39
44
  IConnection,
40
45
  ICriticalContainerError,
41
46
  IDisposable,
@@ -159,10 +164,6 @@ export {
159
164
  ErasedBaseType,
160
165
  ExtensibleUnionNode,
161
166
  FixRecursiveArraySchema,
162
- FluidIterable,
163
- FluidIterableIterator,
164
- FluidMap,
165
- FluidReadonlyMap,
166
167
  FluidSerializableAsTree,
167
168
  ForestOptions,
168
169
  ForestType,
package/dist/index.d.ts CHANGED
@@ -18,10 +18,14 @@ export type { SharedObjectKind } from "@fluidframework/shared-object-base";
18
18
  export type { IErrorBase, IEventProvider, IDisposable, IEvent, IEventThisPlaceHolder, IErrorEvent, ErasedType, IFluidHandle, IFluidLoadable, ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryBaseProperties, IEventTransformer, IProvideFluidLoadable, IFluidHandleErased, LogLevel, LogLevelConst, TransformedEvent, TelemetryBaseEventPropertyType, Tagged, ReplaceIEventThisPlaceHolder, FluidObject, // Linked in doc comment
19
19
  FluidObjectProviderKeys, // Used by FluidObject
20
20
  Listeners, IsListener, Listenable, Off, } from "@fluidframework/core-interfaces";
21
- export type { ErasedBaseType, FluidIterable, FluidIterableIterator, FluidMap, FluidReadonlyMap, } from "@fluidframework/core-interfaces/internal";
21
+ export type { ErasedBaseType, FluidIterable, FluidIterableIterator, FluidMap, FluidReadonlyArray, FluidReadonlyMap, } from "@fluidframework/core-interfaces/internal";
22
22
  export { onAssertionFailure } from "@fluidframework/core-utils/internal";
23
23
  export type { isFluidHandle } from "@fluidframework/runtime-utils";
24
24
  export * from "@fluidframework/tree/alpha";
25
+ export { defineDataStore, sharedObjectRegistryFromIterable, } from "@fluidframework/shared-object-base/internal";
26
+ export type { DataStoreOptions, SharedObjectCreator, SharedObjectRegistry, SharedObjectKey, SharedObjectKindAlpha, DataStoreContext, } from "@fluidframework/shared-object-base/internal";
27
+ export type { DataStoreCreator, DataStoreKey, DataStoreKind, DataStoreRegistry, FluidContainer, FluidContainerAttached, FluidContainerWithService, MinimumVersionForCollaboration, Registry, RegistryKey, ServiceClient, ServiceOptions, } from "@fluidframework/driver-definitions/internal";
28
+ export { createBasicRegistryKey, lookupInRegistry, } from "@fluidframework/driver-definitions/internal";
25
29
  import type { SharedObjectKind } from "@fluidframework/shared-object-base";
26
30
  import type { ITree } from "@fluidframework/tree";
27
31
  import { type SharedTreeOptions } from "@fluidframework/tree/internal";
@@ -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,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACtF,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,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACb,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,EACX,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,gBAAgB,GAChB,MAAM,0CAA0C,CAAC;AAClD,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,EACnB,iBAAiB,GACjB,MAAM,6CAA6C,CAAC;AAErD,YAAY,EACX,yBAAyB,EAAE,iCAAiC;AAC5D,aAAa,EAAE,yCAAyC;AACxD,MAAM,GACN,MAAM,6CAA6C,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,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACtF,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,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACb,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,EACX,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,QAAQ,EACR,kBAAkB,EAClB,gBAAgB,GAChB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAEzE,YAAY,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AASnE,cAAc,4BAA4B,CAAC;AAS3C,OAAO,EACN,eAAe,EACf,gCAAgC,GAChC,MAAM,6CAA6C,CAAC;AACrD,YAAY,EACX,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,gBAAgB,GAChB,MAAM,6CAA6C,CAAC;AACrD,YAAY,EACX,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,sBAAsB,EACtB,yBAAyB,EACzB,8BAA8B,EAC9B,QAAQ,EACR,WAAW,EACX,aAAa,EACb,cAAc,GACd,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACN,sBAAsB,EACtB,gBAAgB,GAIhB,MAAM,6CAA6C,CAAC;AAErD,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,EACnB,iBAAiB,GACjB,MAAM,6CAA6C,CAAC;AAErD,YAAY,EACX,yBAAyB,EAAE,iCAAiC;AAC5D,aAAa,EAAE,yCAAyC;AACxD,MAAM,GACN,MAAM,6CAA6C,CAAC"}
package/dist/index.js CHANGED
@@ -18,7 +18,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
18
18
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
19
19
  };
20
20
  Object.defineProperty(exports, "__esModule", { value: true });
21
- exports.SharedString = exports.SharedMap = exports.SharedDirectory = exports.configuredSharedTree = exports.SharedTree = exports.onAssertionFailure = exports.getPresenceAlpha = exports.getPresence = exports.ConnectionState = exports.AttachState = void 0;
21
+ exports.SharedString = exports.SharedMap = exports.SharedDirectory = exports.configuredSharedTree = exports.SharedTree = exports.lookupInRegistry = exports.createBasicRegistryKey = exports.sharedObjectRegistryFromIterable = exports.defineDataStore = exports.onAssertionFailure = exports.getPresenceAlpha = exports.getPresence = exports.ConnectionState = exports.AttachState = void 0;
22
22
  var container_definitions_1 = require("@fluidframework/container-definitions");
23
23
  Object.defineProperty(exports, "AttachState", { enumerable: true, get: function () { return container_definitions_1.AttachState; } });
24
24
  var container_loader_1 = require("@fluidframework/container-loader");
@@ -36,7 +36,19 @@ Object.defineProperty(exports, "onAssertionFailure", { enumerable: true, get: fu
36
36
  import-x/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-x/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`.
37
37
  */
38
38
  __exportStar(require("@fluidframework/tree/alpha"), exports);
39
- const internal_3 = require("@fluidframework/tree/internal");
39
+ // End of basic public+beta+alpha exports - nothing above this line should
40
+ // depend on an /internal path.
41
+ // #endregion Basic re-exports
42
+ // ---------------------------------------------------------------
43
+ // #region Custom re-exports
44
+ // These are alpha APIs, but this package doesn't have an alpha entry point so they are imported from "internal".
45
+ var internal_3 = require("@fluidframework/shared-object-base/internal");
46
+ Object.defineProperty(exports, "defineDataStore", { enumerable: true, get: function () { return internal_3.defineDataStore; } });
47
+ Object.defineProperty(exports, "sharedObjectRegistryFromIterable", { enumerable: true, get: function () { return internal_3.sharedObjectRegistryFromIterable; } });
48
+ var internal_4 = require("@fluidframework/driver-definitions/internal");
49
+ Object.defineProperty(exports, "createBasicRegistryKey", { enumerable: true, get: function () { return internal_4.createBasicRegistryKey; } });
50
+ Object.defineProperty(exports, "lookupInRegistry", { enumerable: true, get: function () { return internal_4.lookupInRegistry; } });
51
+ const internal_5 = require("@fluidframework/tree/internal");
40
52
  /**
41
53
  * A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
42
54
  * of objects, arrays, and other data types.
@@ -47,7 +59,7 @@ const internal_3 = require("@fluidframework/tree/internal");
47
59
  * This package however is not intended for use by users of the encapsulated API, and therefore it can discard that interface.
48
60
  * @public
49
61
  */
50
- exports.SharedTree = internal_3.SharedTree;
62
+ exports.SharedTree = internal_5.SharedTree;
51
63
  /**
52
64
  * {@link SharedTree} but allowing a non-default configuration.
53
65
  * @remarks
@@ -74,13 +86,13 @@ exports.SharedTree = internal_3.SharedTree;
74
86
  * @alpha
75
87
  */
76
88
  function configuredSharedTree(options) {
77
- return (0, internal_3.configuredSharedTree)(options);
89
+ return (0, internal_5.configuredSharedTree)(options);
78
90
  }
79
91
  exports.configuredSharedTree = configuredSharedTree;
80
- var internal_4 = require("@fluidframework/map/internal");
81
- Object.defineProperty(exports, "SharedDirectory", { enumerable: true, get: function () { return internal_4.SharedDirectory; } });
82
- Object.defineProperty(exports, "SharedMap", { enumerable: true, get: function () { return internal_4.SharedMap; } });
83
- var internal_5 = require("@fluidframework/sequence/internal");
84
- Object.defineProperty(exports, "SharedString", { enumerable: true, get: function () { return internal_5.SharedString; } });
92
+ var internal_6 = require("@fluidframework/map/internal");
93
+ Object.defineProperty(exports, "SharedDirectory", { enumerable: true, get: function () { return internal_6.SharedDirectory; } });
94
+ Object.defineProperty(exports, "SharedMap", { enumerable: true, get: function () { return internal_6.SharedMap; } });
95
+ var internal_7 = require("@fluidframework/sequence/internal");
96
+ Object.defineProperty(exports, "SharedString", { enumerable: true, get: function () { return internal_7.SharedString; } });
85
97
  // #endregion Legacy exports
86
98
  //# sourceMappingURL=index.js.map
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;AAcxB,kEAAsF;AAA7E,uGAAA,WAAW,OAAA;AAAE,4GAAA,gBAAgB,OAAA;AAwCtC,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;AAcrB,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 { getPresence, getPresenceAlpha } from \"@fluidframework/fluid-static/internal\";\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\tITelemetryBaseEvent,\n\tITelemetryBaseLogger,\n\tITelemetryBaseProperties,\n\tIEventTransformer,\n\tIProvideFluidLoadable,\n\tIFluidHandleErased,\n\tLogLevel,\n\tLogLevelConst,\n\tTransformedEvent,\n\tTelemetryBaseEventPropertyType,\n\tTagged,\n\tReplaceIEventThisPlaceHolder,\n\tFluidObject, // Linked in doc comment\n\tFluidObjectProviderKeys, // Used by FluidObject\n\t/* eslint-disable import-x/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-x/export */\n} from \"@fluidframework/core-interfaces\";\nexport type {\n\tErasedBaseType,\n\tFluidIterable,\n\tFluidIterableIterator,\n\tFluidMap,\n\tFluidReadonlyMap,\n} from \"@fluidframework/core-interfaces/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-x/no-internal-modules,\n\timport-x/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-x/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 `@legacy` 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 therefore 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\tISharedObjectKind,\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"]}
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;AAcxB,kEAAsF;AAA7E,uGAAA,WAAW,OAAA;AAAE,4GAAA,gBAAgB,OAAA;AAyCtC,gEAAyE;AAAhE,8GAAA,kBAAkB,OAAA;AAI3B,mDAAmD;AACnD,4FAA4F;AAC5F;;;;MAIG;AACH,6DAA2C;AAE3C,0EAA0E;AAC1E,+BAA+B;AAC/B,8BAA8B;AAC9B,kEAAkE;AAClE,4BAA4B;AAE5B,iHAAiH;AACjH,wEAGqD;AAFpD,2GAAA,eAAe,OAAA;AACf,4HAAA,gCAAgC,OAAA;AAwBjC,wEAMqD;AALpD,kHAAA,sBAAsB,OAAA;AACtB,4GAAA,gBAAgB,OAAA;AAQjB,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;AAcrB,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 { getPresence, getPresenceAlpha } from \"@fluidframework/fluid-static/internal\";\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\tITelemetryBaseEvent,\n\tITelemetryBaseLogger,\n\tITelemetryBaseProperties,\n\tIEventTransformer,\n\tIProvideFluidLoadable,\n\tIFluidHandleErased,\n\tLogLevel,\n\tLogLevelConst,\n\tTransformedEvent,\n\tTelemetryBaseEventPropertyType,\n\tTagged,\n\tReplaceIEventThisPlaceHolder,\n\tFluidObject, // Linked in doc comment\n\tFluidObjectProviderKeys, // Used by FluidObject\n\t/* eslint-disable import-x/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-x/export */\n} from \"@fluidframework/core-interfaces\";\nexport type {\n\tErasedBaseType,\n\tFluidIterable,\n\tFluidIterableIterator,\n\tFluidMap,\n\tFluidReadonlyArray,\n\tFluidReadonlyMap,\n} from \"@fluidframework/core-interfaces/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-x/no-internal-modules,\n\timport-x/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-x/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\n// These are alpha APIs, but this package doesn't have an alpha entry point so they are imported from \"internal\".\nexport {\n\tdefineDataStore,\n\tsharedObjectRegistryFromIterable,\n} from \"@fluidframework/shared-object-base/internal\";\nexport type {\n\tDataStoreOptions,\n\tSharedObjectCreator,\n\tSharedObjectRegistry,\n\tSharedObjectKey,\n\tSharedObjectKindAlpha,\n\tDataStoreContext,\n} from \"@fluidframework/shared-object-base/internal\";\nexport type {\n\tDataStoreCreator,\n\tDataStoreKey,\n\tDataStoreKind,\n\tDataStoreRegistry,\n\tFluidContainer,\n\tFluidContainerAttached,\n\tFluidContainerWithService,\n\tMinimumVersionForCollaboration,\n\tRegistry,\n\tRegistryKey,\n\tServiceClient,\n\tServiceOptions,\n} from \"@fluidframework/driver-definitions/internal\";\nexport {\n\tcreateBasicRegistryKey,\n\tlookupInRegistry,\n\t// Due to this currently referencing several existing public types we do not want to stabilize as reexports from here,\n\t// do not reexport getContainerAudience for now.\n\t// getContainerAudience,\n} from \"@fluidframework/driver-definitions/internal\";\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 `@legacy` 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 therefore 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\tISharedObjectKind,\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
@@ -34,8 +34,13 @@ export {
34
34
  FieldProps,
35
35
  FieldSchema,
36
36
  FieldSchemaMetadata,
37
+ FluidIterable,
38
+ FluidIterableIterator,
39
+ FluidMap,
37
40
  FluidObject,
38
41
  FluidObjectProviderKeys,
42
+ FluidReadonlyArray,
43
+ FluidReadonlyMap,
39
44
  IConnection,
40
45
  ICriticalContainerError,
41
46
  IDisposable,
@@ -166,10 +171,6 @@ export {
166
171
  ErasedBaseType,
167
172
  ExtensibleUnionNode,
168
173
  FixRecursiveArraySchema,
169
- FluidIterable,
170
- FluidIterableIterator,
171
- FluidMap,
172
- FluidReadonlyMap,
173
174
  FluidSerializableAsTree,
174
175
  ForestOptions,
175
176
  ForestType,
package/dist/public.d.ts CHANGED
@@ -34,8 +34,13 @@ export {
34
34
  FieldProps,
35
35
  FieldSchema,
36
36
  FieldSchemaMetadata,
37
+ FluidIterable,
38
+ FluidIterableIterator,
39
+ FluidMap,
37
40
  FluidObject,
38
41
  FluidObjectProviderKeys,
42
+ FluidReadonlyArray,
43
+ FluidReadonlyMap,
39
44
  IConnection,
40
45
  ICriticalContainerError,
41
46
  IDisposable,
package/lib/alpha.d.ts CHANGED
@@ -34,8 +34,13 @@ export {
34
34
  FieldProps,
35
35
  FieldSchema,
36
36
  FieldSchemaMetadata,
37
+ FluidIterable,
38
+ FluidIterableIterator,
39
+ FluidMap,
37
40
  FluidObject,
38
41
  FluidObjectProviderKeys,
42
+ FluidReadonlyArray,
43
+ FluidReadonlyMap,
39
44
  IConnection,
40
45
  ICriticalContainerError,
41
46
  IDisposable,
@@ -159,10 +164,6 @@ export {
159
164
  ErasedBaseType,
160
165
  ExtensibleUnionNode,
161
166
  FixRecursiveArraySchema,
162
- FluidIterable,
163
- FluidIterableIterator,
164
- FluidMap,
165
- FluidReadonlyMap,
166
167
  FluidSerializableAsTree,
167
168
  ForestOptions,
168
169
  ForestType,
@@ -236,8 +237,15 @@ export {
236
237
  ChangeMetadata,
237
238
  CodecName,
238
239
  CodecWriteOptions,
240
+ CommitOutcome,
239
241
  Component,
240
242
  CreateIndependentTreeAlphaOptions,
243
+ DataStoreContext,
244
+ DataStoreCreator,
245
+ DataStoreKey,
246
+ DataStoreKind,
247
+ DataStoreOptions,
248
+ DataStoreRegistry,
241
249
  DirtyTreeMap,
242
250
  DirtyTreeStatus,
243
251
  ErasedNode,
@@ -251,10 +259,14 @@ export {
251
259
  FieldSchemaAlpha,
252
260
  FieldSchemaAlphaUnsafe,
253
261
  FluidClientVersion,
262
+ FluidContainer,
263
+ FluidContainerAttached,
264
+ FluidContainerWithService,
254
265
  FormatValidator,
255
266
  FormatValidatorBasic,
256
267
  FormatValidatorNoOp,
257
268
  FormatVersion,
269
+ FormattedText,
258
270
  HandleConverter,
259
271
  ICodecOptions,
260
272
  ITreeAlpha,
@@ -287,10 +299,12 @@ export {
287
299
  JsonTreeSchema,
288
300
  LabelTree,
289
301
  LocalChangeMetadata,
302
+ LocalCommitEvents,
290
303
  MapNodeCustomizableSchema,
291
304
  MapNodeCustomizableSchemaUnsafe,
292
305
  MapNodePojoEmulationSchema,
293
306
  MapNodeSchema,
307
+ MinimumVersionForCollaboration,
294
308
  NoChangeConstraint,
295
309
  NodeChangedDataAlpha,
296
310
  NodeChangedDataDelta,
@@ -302,11 +316,14 @@ export {
302
316
  ObjectNodeSchemaWorkaround,
303
317
  ObjectSchemaOptionsAlpha,
304
318
  ObservationResults,
319
+ PlainText,
305
320
  ReadSchema,
306
321
  ReadableField,
307
322
  RecordNodeCustomizableSchema,
308
323
  RecordNodePojoEmulationSchema,
309
324
  RecordNodeSchema,
325
+ Registry,
326
+ RegistryKey,
310
327
  RemoteChangeMetadata,
311
328
  RevertibleAlpha,
312
329
  RevertibleAlphaFactory,
@@ -314,6 +331,13 @@ export {
314
331
  SchemaFactoryAlpha,
315
332
  SchemaStaticsAlpha,
316
333
  SchemaType,
334
+ ServiceClient,
335
+ ServiceOptions,
336
+ SharedObjectCreator,
337
+ SharedObjectKey,
338
+ SharedObjectKindAlpha,
339
+ SharedObjectRegistry,
340
+ SharedTreeAlpha,
317
341
  SharedTreeFormatOptions,
318
342
  SharedTreeOptions,
319
343
  SimpleAllowedTypeAttributes,
@@ -329,7 +353,7 @@ export {
329
353
  SimpleTreeSchema,
330
354
  StagedSchemaUpgradePolicy,
331
355
  StagedSchemaUpgradePolicyFactory,
332
- TextAsTree,
356
+ StringSchema,
333
357
  TransactionCallbackStatusAlpha,
334
358
  TransactionConstraintAlpha,
335
359
  TransactionLabels,
@@ -341,6 +365,7 @@ export {
341
365
  TreeChangeEventsAlpha,
342
366
  TreeCompressionStrategy,
343
367
  TreeContextAlpha,
368
+ TreeDataStoreOptions,
344
369
  TreeIdentifierUtils,
345
370
  TreeMapNodeAlpha,
346
371
  TreeParsingOptions,
@@ -364,8 +389,11 @@ export {
364
389
  configuredSharedTreeAlpha,
365
390
  contentSchemaSymbol,
366
391
  createArrayInsertionAnchor,
392
+ createBasicRegistryKey,
367
393
  createIndependentTreeAlpha,
368
394
  decodeSchemaCompatibilitySnapshot,
395
+ defineDataStore,
396
+ defineTreeDataStore,
369
397
  encodeSchemaCompatibilitySnapshot,
370
398
  eraseSchemaDetails,
371
399
  eraseSchemaDetailsSubclassable,
@@ -381,12 +409,15 @@ export {
381
409
  incrementalSummaryHint,
382
410
  independentInitializedView,
383
411
  independentView,
412
+ instantiateTreeFirstTime,
413
+ lookupInRegistry,
384
414
  minimize,
385
415
  normalizeAllowedTypes,
386
416
  persistedToSimpleSchema,
387
417
  replaceConciseTreeHandles,
388
418
  replaceHandles,
389
419
  replaceVerboseTreeHandles,
420
+ sharedObjectRegistryFromIterable,
390
421
  trackDirtyNodes
391
422
  // #endregion
392
423
  } from "./index.js";