@fluidframework/shared-object-base 2.0.0-internal.8.0.0 → 2.0.0-rc.1.0.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.
Files changed (108) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +0 -6
  3. package/api-extractor-esm.json +4 -0
  4. package/api-extractor-lint.json +1 -10
  5. package/api-extractor.json +1 -9
  6. package/api-report/shared-object-base.api.md +11 -22
  7. package/dist/{handle.cjs → handle.js} +1 -1
  8. package/dist/handle.js.map +1 -0
  9. package/dist/index.d.ts +1 -1
  10. package/dist/index.d.ts.map +1 -1
  11. package/dist/{index.cjs → index.js} +7 -8
  12. package/dist/index.js.map +1 -0
  13. package/dist/packageVersion.d.ts +1 -1
  14. package/dist/packageVersion.d.ts.map +1 -1
  15. package/dist/{packageVersion.cjs → packageVersion.js} +2 -2
  16. package/dist/packageVersion.js.map +1 -0
  17. package/dist/{remoteObjectHandle.cjs → remoteObjectHandle.js} +1 -1
  18. package/dist/remoteObjectHandle.js.map +1 -0
  19. package/dist/serializer.d.ts +3 -15
  20. package/dist/serializer.d.ts.map +1 -1
  21. package/dist/{serializer.cjs → serializer.js} +6 -11
  22. package/dist/serializer.js.map +1 -0
  23. package/dist/shared-object-base-alpha.d.ts +32 -64
  24. package/dist/shared-object-base-beta.d.ts +353 -46
  25. package/dist/shared-object-base-public.d.ts +353 -46
  26. package/dist/shared-object-base-untrimmed.d.ts +11 -25
  27. package/dist/sharedObject.d.ts +3 -4
  28. package/dist/sharedObject.d.ts.map +1 -1
  29. package/dist/{sharedObject.cjs → sharedObject.js} +6 -6
  30. package/dist/{sharedObject.cjs.map → sharedObject.js.map} +1 -1
  31. package/dist/summarySerializer.d.ts +1 -1
  32. package/dist/{summarySerializer.cjs → summarySerializer.js} +3 -3
  33. package/dist/summarySerializer.js.map +1 -0
  34. package/dist/types.d.ts +2 -2
  35. package/dist/{types.cjs → types.js} +1 -1
  36. package/dist/types.js.map +1 -0
  37. package/dist/utils.d.ts +2 -2
  38. package/dist/{utils.cjs → utils.js} +3 -3
  39. package/dist/utils.js.map +1 -0
  40. package/dist/{valueType.cjs → valueType.js} +1 -1
  41. package/dist/valueType.js.map +1 -0
  42. package/lib/{handle.d.ts → handle.d.mts} +1 -1
  43. package/lib/handle.d.mts.map +1 -0
  44. package/lib/{index.d.ts → index.d.mts} +2 -2
  45. package/lib/index.d.mts.map +1 -0
  46. package/lib/index.mjs +1 -1
  47. package/lib/index.mjs.map +1 -1
  48. package/lib/{packageVersion.d.ts → packageVersion.d.mts} +2 -2
  49. package/lib/packageVersion.d.mts.map +1 -0
  50. package/lib/packageVersion.mjs +1 -1
  51. package/lib/packageVersion.mjs.map +1 -1
  52. package/lib/{remoteObjectHandle.d.ts → remoteObjectHandle.d.mts} +1 -1
  53. package/lib/remoteObjectHandle.d.mts.map +1 -0
  54. package/lib/{serializer.d.ts → serializer.d.mts} +4 -16
  55. package/lib/serializer.d.mts.map +1 -0
  56. package/lib/serializer.mjs +3 -7
  57. package/lib/serializer.mjs.map +1 -1
  58. package/lib/shared-object-base-alpha.d.mts +411 -0
  59. package/lib/{shared-object-base-alpha.d.ts → shared-object-base-beta.d.mts} +8 -62
  60. package/lib/shared-object-base-public.d.mts +389 -0
  61. package/lib/{shared-object-base-untrimmed.d.ts → shared-object-base-untrimmed.d.mts} +11 -25
  62. package/lib/{sharedObject.d.ts → sharedObject.d.mts} +4 -5
  63. package/lib/sharedObject.d.mts.map +1 -0
  64. package/lib/sharedObject.mjs +2 -2
  65. package/lib/sharedObject.mjs.map +1 -1
  66. package/lib/{summarySerializer.d.ts → summarySerializer.d.mts} +2 -2
  67. package/lib/summarySerializer.d.mts.map +1 -0
  68. package/lib/summarySerializer.mjs +1 -1
  69. package/lib/summarySerializer.mjs.map +1 -1
  70. package/lib/{types.d.ts → types.d.mts} +3 -3
  71. package/lib/types.d.mts.map +1 -0
  72. package/lib/types.mjs.map +1 -1
  73. package/lib/{utils.d.ts → utils.d.mts} +3 -3
  74. package/lib/utils.d.mts.map +1 -0
  75. package/lib/utils.mjs +2 -2
  76. package/lib/utils.mjs.map +1 -1
  77. package/lib/{valueType.d.ts → valueType.d.mts} +1 -1
  78. package/lib/valueType.d.mts.map +1 -0
  79. package/package.json +91 -29
  80. package/src/index.ts +1 -6
  81. package/src/packageVersion.ts +1 -1
  82. package/src/serializer.ts +4 -22
  83. package/src/sharedObject.ts +3 -3
  84. package/src/summarySerializer.ts +1 -1
  85. package/src/types.ts +2 -2
  86. package/src/utils.ts +2 -2
  87. package/dist/handle.cjs.map +0 -1
  88. package/dist/index.cjs.map +0 -1
  89. package/dist/packageVersion.cjs.map +0 -1
  90. package/dist/remoteObjectHandle.cjs.map +0 -1
  91. package/dist/serializer.cjs.map +0 -1
  92. package/dist/summarySerializer.cjs.map +0 -1
  93. package/dist/types.cjs.map +0 -1
  94. package/dist/utils.cjs.map +0 -1
  95. package/dist/valueType.cjs.map +0 -1
  96. package/lib/handle.d.ts.map +0 -1
  97. package/lib/index.d.ts.map +0 -1
  98. package/lib/packageVersion.d.ts.map +0 -1
  99. package/lib/remoteObjectHandle.d.ts.map +0 -1
  100. package/lib/serializer.d.ts.map +0 -1
  101. package/lib/shared-object-base-beta.d.ts +0 -82
  102. package/lib/shared-object-base-public.d.ts +0 -82
  103. package/lib/sharedObject.d.ts.map +0 -1
  104. package/lib/summarySerializer.d.ts.map +0 -1
  105. package/lib/types.d.ts.map +0 -1
  106. package/lib/utils.d.ts.map +0 -1
  107. package/lib/valueType.d.ts.map +0 -1
  108. package/tsc-multi.test.json +0 -4
@@ -19,51 +19,83 @@ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
19
19
 
20
20
  /* Excluded from this release type: createSingleBlobSummary */
21
21
 
22
- /* Excluded from this release type: EventEmitterEventType */
23
-
24
- /* Excluded from this release type: EventEmitterWithErrorHandling */
25
-
26
22
  /* Excluded from this release type: FluidSerializer */
27
23
 
28
- /* Excluded from this release type: IChannel */
29
-
30
- /* Excluded from this release type: IChannelAttributes */
31
-
32
- /* Excluded from this release type: IChannelServices */
33
-
34
- /* Excluded from this release type: IChannelStorageService */
35
-
36
- /* Excluded from this release type: IErrorEvent */
37
-
38
- /* Excluded from this release type: IEventProvider */
39
-
40
- /* Excluded from this release type: IEventThisPlaceHolder */
41
-
42
- /* Excluded from this release type: IExperimentalIncrementalSummaryContext */
43
-
44
- /* Excluded from this release type: IFluidDataStoreRuntime */
45
-
46
- /* Excluded from this release type: IFluidHandle */
47
-
48
- /* Excluded from this release type: IFluidHandleContext */
49
-
50
- /* Excluded from this release type: IFluidSerializer */
51
-
52
- /* Excluded from this release type: IGarbageCollectionData */
53
-
54
- /* Excluded from this release type: ISerializedHandle */
55
-
56
- /* Excluded from this release type: ISharedObject */
57
-
58
- /* Excluded from this release type: ISharedObjectEvents */
59
-
60
- /* Excluded from this release type: isSerializedHandle */
61
-
62
- /* Excluded from this release type: ISummaryTreeWithStats */
63
-
64
- /* Excluded from this release type: ITelemetryContext */
65
-
66
- /* Excluded from this release type: ITelemetryLoggerExt */
24
+ /**
25
+ * @public
26
+ */
27
+ export declare interface IFluidSerializer {
28
+ /**
29
+ * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
30
+ * where any embedded IFluidHandles have been replaced with a serializable form.
31
+ *
32
+ * The original `input` object is not mutated. This method will shallowly clones all objects in the path from
33
+ * the root to any replaced handles. (If no handles are found, returns the original object.)
34
+ */
35
+ encode(value: any, bind: IFluidHandle): any;
36
+ /**
37
+ * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
38
+ * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.
39
+ *
40
+ * The original `input` object is not mutated. This method will shallowly clone all objects in the path from
41
+ * the root to any replaced handles. (If no handles are found, returns the original object.)
42
+ *
43
+ * The decoded handles are implicitly bound to the handle context of this serializer.
44
+ */
45
+ decode(input: any): any;
46
+ /**
47
+ * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
48
+ */
49
+ stringify(value: any, bind: IFluidHandle): string;
50
+ /**
51
+ * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
52
+ * handles will be realized as part of the parse
53
+ */
54
+ parse(value: string): any;
55
+ }
56
+
57
+ /**
58
+ * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
59
+ * @public
60
+ */
61
+ export declare interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends IChannel, IEventProvider<TEvent> {
62
+ /**
63
+ * Binds the given shared object to its containing data store runtime, causing it to attach once
64
+ * the runtime attaches.
65
+ */
66
+ bindToContext(): void;
67
+ /**
68
+ * Returns the GC data for this shared object. It contains a list of GC nodes that contains references to
69
+ * other GC nodes.
70
+ * @param fullGC - true to bypass optimizations and force full generation of GC data.
71
+ */
72
+ getGCData(fullGC?: boolean): IGarbageCollectionData;
73
+ }
74
+
75
+ /**
76
+ * Events emitted by {@link ISharedObject}.
77
+ * @public
78
+ */
79
+ export declare interface ISharedObjectEvents extends IErrorEvent {
80
+ /**
81
+ * Fires before an incoming operation (op) is applied to the shared object.
82
+ *
83
+ * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external
84
+ * use.
85
+ *
86
+ * @eventProperty
87
+ */
88
+ (event: "pre-op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any;
89
+ /**
90
+ * Fires after an incoming op is applied to the shared object.
91
+ *
92
+ * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external
93
+ * use.
94
+ *
95
+ * @eventProperty
96
+ */
97
+ (event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any;
98
+ }
67
99
 
68
100
  /* Excluded from this release type: makeHandlesSerializable */
69
101
 
@@ -71,9 +103,284 @@ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
71
103
 
72
104
  /* Excluded from this release type: serializeHandles */
73
105
 
74
- /* Excluded from this release type: SharedObject */
75
-
76
- /* Excluded from this release type: SharedObjectCore */
106
+ /**
107
+ * SharedObject with simplified, synchronous summarization and GC.
108
+ * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
109
+ * @public
110
+ */
111
+ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
112
+ private readonly telemetryContextPrefix;
113
+ /**
114
+ * True while we are garbage collecting this object's data.
115
+ */
116
+ private _isGCing;
117
+ /**
118
+ * The serializer to use to serialize / parse handles, if any.
119
+ */
120
+ private readonly _serializer;
121
+ protected get serializer(): IFluidSerializer;
122
+ /**
123
+ * @param id - The id of the shared object
124
+ * @param runtime - The IFluidDataStoreRuntime which contains the shared object
125
+ * @param attributes - Attributes of the shared object
126
+ */
127
+ constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
128
+ /**
129
+ * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
130
+ */
131
+ getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
132
+ /**
133
+ * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
134
+ */
135
+ summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): Promise<ISummaryTreeWithStats>;
136
+ /**
137
+ * {@inheritDoc (ISharedObject:interface).getGCData}
138
+ */
139
+ getGCData(fullGC?: boolean): IGarbageCollectionData;
140
+ /**
141
+ * Calls the serializer over all data in this object that reference other GC nodes.
142
+ * Derived classes must override this to provide custom list of references to other GC nodes.
143
+ */
144
+ protected processGCDataCore(serializer: IFluidSerializer): void;
145
+ /**
146
+ * Gets a form of the object that can be serialized.
147
+ * @returns A tree representing the snapshot of the shared object.
148
+ */
149
+ protected abstract summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): ISummaryTreeWithStats;
150
+ private incrementTelemetryMetric;
151
+ }
152
+
153
+ /**
154
+ * Base class from which all shared objects derive.
155
+ * @public
156
+ */
157
+ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {
158
+ id: string;
159
+ protected runtime: IFluidDataStoreRuntime;
160
+ readonly attributes: IChannelAttributes;
161
+ get IFluidLoadable(): this;
162
+ private readonly opProcessingHelper;
163
+ private readonly callbacksHelper;
164
+ /**
165
+ * The handle referring to this SharedObject
166
+ */
167
+ readonly handle: IFluidHandle;
168
+ /**
169
+ * Telemetry logger for the shared object
170
+ */
171
+ protected readonly logger: ITelemetryLoggerExt;
172
+ private readonly mc;
173
+ /**
174
+ * Connection state
175
+ */
176
+ private _connected;
177
+ /**
178
+ * Services used by the shared object
179
+ */
180
+ private services;
181
+ /**
182
+ * True if the dds is bound to its parent.
183
+ */
184
+ private _isBoundToContext;
185
+ /**
186
+ * Tracks error that closed this object.
187
+ */
188
+ private closeError?;
189
+ /**
190
+ * Gets the connection state
191
+ * @returns The state of the connection
192
+ */
193
+ get connected(): boolean;
194
+ /**
195
+ * @param id - The id of the shared object
196
+ * @param runtime - The IFluidDataStoreRuntime which contains the shared object
197
+ * @param attributes - Attributes of the shared object
198
+ */
199
+ constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
200
+ /**
201
+ * This function is only supposed to be called from SharedObjectCore's constructor and
202
+ * depends on a few things being set already. assert() calls make sure of it.
203
+ * @returns The telemetry sampling helpers, so the constructor can be the one to assign them
204
+ * to variables to avoid complaints from TypeScript.
205
+ */
206
+ private setUpSampledTelemetryHelpers;
207
+ /**
208
+ * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)
209
+ * would result in same error thrown. If called multiple times, only first error is remembered.
210
+ * @param error - error object that is thrown whenever an attempt is made to modify this object
211
+ */
212
+ private closeWithError;
213
+ /**
214
+ * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.
215
+ */
216
+ private verifyNotClosed;
217
+ /**
218
+ * Event listener handler helper that can be used to react to exceptions thrown from event listeners
219
+ * It wraps error with DataProcessingError, closes this object and throws resulting error.
220
+ * See closeWithError() for more details
221
+ * Ideally such situation never happens, as consumers of DDS should never throw exceptions
222
+ * in event listeners (i.e. catch any of the issues and make determination on how to handle it).
223
+ * When such exceptions propagate through, most likely data model is no longer consistent, i.e.
224
+ * DDS state does not match what user sees. Because of it DDS moves to "corrupted state" and does not
225
+ * allow processing of ops or local changes, which very quickly results in container closure.
226
+ */
227
+ private eventListenerErrorHandler;
228
+ private attachListeners;
229
+ /**
230
+ * A shared object, after construction, can either be loaded in the case that it is already part of
231
+ * a shared document. Or later attached if it is being newly added.
232
+ * @param services - Services used by the shared object
233
+ */
234
+ load(services: IChannelServices): Promise<void>;
235
+ /**
236
+ * Initializes the object as a local, non-shared object. This object can become shared after
237
+ * it is attached to the document.
238
+ */
239
+ initializeLocal(): void;
240
+ /**
241
+ * {@inheritDoc (ISharedObject:interface).bindToContext}
242
+ */
243
+ bindToContext(): void;
244
+ /**
245
+ * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}
246
+ */
247
+ connect(services: IChannelServices): void;
248
+ /**
249
+ * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).isAttached}
250
+ */
251
+ isAttached(): boolean;
252
+ /**
253
+ * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
254
+ */
255
+ abstract getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
256
+ /**
257
+ * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
258
+ */
259
+ abstract summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
260
+ /**
261
+ * {@inheritDoc (ISharedObject:interface).getGCData}
262
+ */
263
+ abstract getGCData(fullGC?: boolean): IGarbageCollectionData;
264
+ /**
265
+ * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference
266
+ * to another object in the container.
267
+ * @param decodedHandle - The handle of the Fluid object that is decoded.
268
+ */
269
+ protected handleDecoded(decodedHandle: IFluidHandle): void;
270
+ /**
271
+ * Allows the distributed data type to perform custom loading
272
+ * @param services - Storage used by the shared object
273
+ */
274
+ protected abstract loadCore(services: IChannelStorageService): Promise<void>;
275
+ /**
276
+ * Allows the distributed data type to perform custom local loading.
277
+ */
278
+ protected initializeLocalCore(): void;
279
+ /**
280
+ * Allows the distributive data type the ability to perform custom processing once an attach has happened.
281
+ * Also called after non-local data type get loaded.
282
+ */
283
+ protected didAttach(): void;
284
+ /**
285
+ * Derived classes must override this to do custom processing on a remote message.
286
+ * @param message - The message to process
287
+ * @param local - True if the shared object is local
288
+ * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
289
+ * For messages from a remote client, this will be undefined.
290
+ */
291
+ protected abstract processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): any;
292
+ /**
293
+ * Called when the object has disconnected from the delta stream.
294
+ */
295
+ protected abstract onDisconnect(): any;
296
+ /**
297
+ * Submits a message by the local client to the runtime.
298
+ * @param content - Content of the message
299
+ * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime
300
+ * and not sent to the server. This will be sent back when this message is received back from the server. This is
301
+ * also sent if we are asked to resubmit the message.
302
+ */
303
+ protected submitLocalMessage(content: any, localOpMetadata?: unknown): void;
304
+ /**
305
+ * Marks this object as dirty so that it is part of the next summary. It is called by a SharedSummaryBlock
306
+ * that want to be part of summary but does not generate ops.
307
+ */
308
+ protected dirty(): void;
309
+ /**
310
+ * Called when the object has fully connected to the delta stream
311
+ * Default implementation for DDS, override if different behavior is required.
312
+ */
313
+ protected onConnect(): void;
314
+ /**
315
+ * Called when a message has to be resubmitted. This typically happens after a reconnection for unacked messages.
316
+ * The default implementation here is to resubmit the same message. The client can override if different behavior
317
+ * is required. It can choose to resubmit the same message, submit different / multiple messages or not submit
318
+ * anything at all.
319
+ * @param content - The content of the original message.
320
+ * @param localOpMetadata - The local metadata associated with the original message.
321
+ */
322
+ protected reSubmitCore(content: any, localOpMetadata: unknown): void;
323
+ /**
324
+ * Promises that are waiting for an ack from the server before resolving should use this instead of new Promise.
325
+ * It ensures that if something changes that will interrupt that ack (e.g. the FluidDataStoreRuntime disposes),
326
+ * the Promise will reject.
327
+ * If runtime is disposed when this call is made, executor is not run and promise is rejected right away.
328
+ */
329
+ protected newAckBasedPromise<T>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void): Promise<T>;
330
+ private attachDeltaHandler;
331
+ /**
332
+ * Set the state of connection to services.
333
+ * @param connected - true if connected, false otherwise.
334
+ */
335
+ private setConnectionState;
336
+ /**
337
+ * Handles a message being received from the remote delta server.
338
+ * @param message - The message to process
339
+ * @param local - Whether the message originated from the local client
340
+ * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
341
+ * For messages from a remote client, this will be undefined.
342
+ */
343
+ private process;
344
+ /**
345
+ * Called when a message has to be resubmitted. This typically happens for unacked messages after a
346
+ * reconnection.
347
+ * @param content - The content of the original message.
348
+ * @param localOpMetadata - The local metadata associated with the original message.
349
+ */
350
+ private reSubmit;
351
+ /**
352
+ * Revert an op
353
+ */
354
+ protected rollback(content: any, localOpMetadata: unknown): void;
355
+ /**
356
+ * Apply changes from an op. Used when rehydrating an attached container
357
+ * with pending changes. This prepares the SharedObject for seeing an ACK
358
+ * for the op or resubmitting the op upon reconnection.
359
+ * @param content - Contents of a stashed op.
360
+ * @returns localMetadata of the op, to be passed to process() or resubmit()
361
+ * when the op is ACKed or resubmitted, respectively
362
+ */
363
+ protected abstract applyStashedOp(content: any): unknown;
364
+ /**
365
+ * Emit an event. This function is only intended for use by DDS classes that extend SharedObject/SharedObjectCore,
366
+ * specifically to emit events that are part of the public interface of the DDS (i.e. those that can have listeners
367
+ * attached to them by the consumers of the DDS). It should not be called from outside the class or to emit events
368
+ * which are only internal to the DDS. Support for calling it from outside the DDS instance might be removed in the
369
+ * future.
370
+ * @param event - The event to emit.
371
+ * @param args - Arguments to pass to the event listeners.
372
+ * @returns `true` if the event had listeners, `false` otherwise.
373
+ */
374
+ emit(event: EventEmitterEventType, ...args: any[]): boolean;
375
+ /**
376
+ * Use to emit events inside {@link SharedObjectCore}, with no telemetry measurement
377
+ * done on the duration of the callbacks. Simply calls `super.emit()`.
378
+ * @param event - Event to emit
379
+ * @param args - Arguments for the event
380
+ * @returns Whatever `super.emit()` returns.
381
+ */
382
+ private emitInternal;
383
+ }
77
384
 
78
385
  /* Excluded from this release type: SummarySerializer */
79
386
 
@@ -28,13 +28,13 @@ export declare function createSingleBlobSummary(key: string, content: string | U
28
28
 
29
29
  /**
30
30
  * Data Store serializer implementation
31
- * @alpha
31
+ * @internal
32
32
  */
33
33
  export declare class FluidSerializer implements IFluidSerializer {
34
34
  private readonly context;
35
35
  private readonly handleParsedCb;
36
36
  private readonly root;
37
- constructor(context: IFluidHandleContext, handleParsedCb: (handle: IFluidHandle) => void);
37
+ constructor(context: IFluidHandleContext, handleParsedCb?: (handle: IFluidHandle) => void);
38
38
  get IFluidSerializer(): this;
39
39
  /**
40
40
  * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a
@@ -68,7 +68,7 @@ export declare class FluidSerializer implements IFluidSerializer {
68
68
  }
69
69
 
70
70
  /**
71
- * @alpha
71
+ * @public
72
72
  */
73
73
  export declare interface IFluidSerializer {
74
74
  /**
@@ -100,18 +100,9 @@ export declare interface IFluidSerializer {
100
100
  parse(value: string): any;
101
101
  }
102
102
 
103
- /**
104
- * JSON serialized form of an IFluidHandle
105
- * @internal
106
- */
107
- export declare interface ISerializedHandle {
108
- type: "__fluid_handle__";
109
- url: string;
110
- }
111
-
112
103
  /**
113
104
  * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
114
- * @alpha
105
+ * @public
115
106
  */
116
107
  export declare interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends IChannel, IEventProvider<TEvent> {
117
108
  /**
@@ -129,7 +120,7 @@ export declare interface ISharedObject<TEvent extends ISharedObjectEvents = ISha
129
120
 
130
121
  /**
131
122
  * Events emitted by {@link ISharedObject}.
132
- * @alpha
123
+ * @public
133
124
  */
134
125
  export declare interface ISharedObjectEvents extends IErrorEvent {
135
126
  /**
@@ -152,11 +143,6 @@ export declare interface ISharedObjectEvents extends IErrorEvent {
152
143
  (event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any;
153
144
  }
154
145
 
155
- /**
156
- * @internal
157
- */
158
- export declare const isSerializedHandle: (value: any) => value is ISerializedHandle;
159
-
160
146
  /**
161
147
  * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
162
148
  * where any embedded IFluidHandles have been replaced with a serializable form.
@@ -168,7 +154,7 @@ export declare const isSerializedHandle: (value: any) => value is ISerializedHan
168
154
  * @param context - The handle context for the container
169
155
  * @param bind - Bind any other handles we find in the object against this given handle.
170
156
  * @returns The fully-plain object
171
- * @internal
157
+ * @alpha
172
158
  */
173
159
  export declare function makeHandlesSerializable(value: any, serializer: IFluidSerializer, bind: IFluidHandle): any;
174
160
 
@@ -179,7 +165,7 @@ export declare function makeHandlesSerializable(value: any, serializer: IFluidSe
179
165
  * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects
180
166
  * @param context - The handle context for the container
181
167
  * @returns The mostly-plain object with handle objects within
182
- * @internal
168
+ * @alpha
183
169
  */
184
170
  export declare function parseHandles(value: any, serializer: IFluidSerializer): any;
185
171
 
@@ -198,7 +184,7 @@ export declare function serializeHandles(value: any, serializer: IFluidSerialize
198
184
  /**
199
185
  * SharedObject with simplified, synchronous summarization and GC.
200
186
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
201
- * @alpha
187
+ * @public
202
188
  */
203
189
  export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
204
190
  private readonly telemetryContextPrefix;
@@ -233,7 +219,7 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
233
219
  * Calls the serializer over all data in this object that reference other GC nodes.
234
220
  * Derived classes must override this to provide custom list of references to other GC nodes.
235
221
  */
236
- protected processGCDataCore(serializer: SummarySerializer): void;
222
+ protected processGCDataCore(serializer: IFluidSerializer): void;
237
223
  /**
238
224
  * Gets a form of the object that can be serialized.
239
225
  * @returns A tree representing the snapshot of the shared object.
@@ -244,7 +230,7 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
244
230
 
245
231
  /**
246
232
  * Base class from which all shared objects derive.
247
- * @alpha
233
+ * @public
248
234
  */
249
235
  export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {
250
236
  id: string;
@@ -476,7 +462,7 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
476
462
 
477
463
  /**
478
464
  * Serializer implementation for serializing handles during summary.
479
- * @alpha
465
+ * @internal
480
466
  */
481
467
  export declare class SummarySerializer extends FluidSerializer {
482
468
  private readonly serializedRoutes;
@@ -9,11 +9,10 @@ import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService, ICh
9
9
  import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
10
10
  import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext, IExperimentalIncrementalSummaryContext } from "@fluidframework/runtime-definitions";
11
11
  import { IFluidSerializer } from "./serializer";
12
- import { SummarySerializer } from "./summarySerializer";
13
12
  import { ISharedObject, ISharedObjectEvents } from "./types";
14
13
  /**
15
14
  * Base class from which all shared objects derive.
16
- * @alpha
15
+ * @public
17
16
  */
18
17
  export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {
19
18
  id: string;
@@ -245,7 +244,7 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
245
244
  /**
246
245
  * SharedObject with simplified, synchronous summarization and GC.
247
246
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
248
- * @alpha
247
+ * @public
249
248
  */
250
249
  export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
251
250
  private readonly telemetryContextPrefix;
@@ -280,7 +279,7 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
280
279
  * Calls the serializer over all data in this object that reference other GC nodes.
281
280
  * Derived classes must override this to provide custom list of references to other GC nodes.
282
281
  */
283
- protected processGCDataCore(serializer: SummarySerializer): void;
282
+ protected processGCDataCore(serializer: IFluidSerializer): void;
284
283
  /**
285
284
  * Gets a form of the object that can be serialized.
286
285
  * @returns A tree representing the snapshot of the shared object.
@@ -1 +1 @@
1
- {"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,YAAY,EAAwB,MAAM,iCAAiC,CAAC;AACrF,OAAO,EACN,mBAAmB,EAGnB,6BAA6B,EAK7B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EAChB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EAGjB,sCAAsC,EACtC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAmB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE7D;;;GAGG;AACH,8BAAsB,gBAAgB,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAC9F,SAAQ,6BAA6B,CAAC,MAAM,CAC5C,YAAW,aAAa,CAAC,MAAM,CAAC;IAsDxB,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IAtD/C,IAAW,cAAc,SAExB;IAED,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAyB;IAC5D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAyB;IAEzD;;OAEG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAC/C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;gBAEK,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IA0B/C;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IAoCpC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,eAAe;IAWvB;;;;OAIG;IACU,IAAI,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D;;;OAGG;IACI,eAAe,IAAI,IAAI;IAI9B;;OAEG;IACI,aAAa,IAAI,IAAI;IAU5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAC/B,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAExB;;OAEG;aACa,SAAS,CACxB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAEjC;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,YAAY;IAOnD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;;OAGG;IACH,SAAS,CAAC,SAAS;IAInB;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,CAC7B,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IAGzB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY;IAE/B;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,GAAE,OAAmB,GAAG,IAAI;IAQtF;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;IASvB;;;OAGG;IACH,SAAS,CAAC,SAAS;IAEnB;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAI7D;;;;;OAKG;cACa,kBAAkB,CAAC,CAAC,EACnC,QAAQ,EAAE,CACT,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAC5C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,KAC1B,IAAI,GACP,OAAO,CAAC,CAAC,CAAC;IAuBb,OAAO,CAAC,kBAAkB;IAsC1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAcf;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAIzD;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;IAExD;;;;;;;;;OASG;IACI,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAkBlE;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;CAGpB;AAED;;;;GAIG;AACH,8BAAsB,YAAY,CACjC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvD,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IAmChC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAlCxC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAa3C;IAED;;;;OAIG;gBAEF,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EACb,sBAAsB,EAAE,MAAM;IAUhD;;OAEG;IACI,gBAAgB,CACtB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAexB;;OAEG;IACU,SAAS,CACrB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,OAAO,CAAC,qBAAqB,CAAC;IAmBjC;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IA8BjE;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,iBAAiB;IAOzD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAC/B,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,qBAAqB;IAExB,OAAO,CAAC,wBAAwB;CAShC"}
1
+ {"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,YAAY,EAAwB,MAAM,iCAAiC,CAAC;AACrF,OAAO,EACN,mBAAmB,EAGnB,6BAA6B,EAK7B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EAChB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EAGjB,sCAAsC,EACtC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAmB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGjE,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE7D;;;GAGG;AACH,8BAAsB,gBAAgB,CAAC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CAC9F,SAAQ,6BAA6B,CAAC,MAAM,CAC5C,YAAW,aAAa,CAAC,MAAM,CAAC;IAsDxB,EAAE,EAAE,MAAM;IACjB,SAAS,CAAC,OAAO,EAAE,sBAAsB;aACzB,UAAU,EAAE,kBAAkB;IAtD/C,IAAW,cAAc,SAExB;IAED,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAyB;IAC5D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAyB;IAEzD;;OAEG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAC/C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA+B;IAE/C;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkB;IAE3C;;OAEG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4D;IAE/E;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;gBAEK,EAAE,EAAE,MAAM,EACP,OAAO,EAAE,sBAAsB,EACzB,UAAU,EAAE,kBAAkB;IA0B/C;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IAoCpC;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;;;;OASG;IACH,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,eAAe;IAWvB;;;;OAIG;IACU,IAAI,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5D;;;OAGG;IACI,eAAe,IAAI,IAAI;IAI9B;;OAEG;IACI,aAAa,IAAI,IAAI;IAU5B;;OAEG;IACI,OAAO,CAAC,QAAQ,EAAE,gBAAgB;IAKzC;;OAEG;IACI,UAAU,IAAI,OAAO;IAI5B;;OAEG;aACa,gBAAgB,CAC/B,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAExB;;OAEG;aACa,SAAS,CACxB,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAEjC;;OAEG;aACa,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAEnE;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,YAAY;IAOnD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE5E;;OAEG;IACH,SAAS,CAAC,mBAAmB;IAI7B;;;OAGG;IACH,SAAS,CAAC,SAAS;IAInB;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,CAC7B,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IAGzB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY;IAE/B;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,GAAE,OAAmB,GAAG,IAAI;IAQtF;;;OAGG;IACH,SAAS,CAAC,KAAK,IAAI,IAAI;IASvB;;;OAGG;IACH,SAAS,CAAC,SAAS;IAEnB;;;;;;;OAOG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAI7D;;;;;OAKG;cACa,kBAAkB,CAAC,CAAC,EACnC,QAAQ,EAAE,CACT,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,EAC5C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,KAC1B,IAAI,GACP,OAAO,CAAC,CAAC,CAAC;IAuBb,OAAO,CAAC,kBAAkB;IAsC1B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAcf;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAIzD;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;IAExD;;;;;;;;;OASG;IACI,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;IAkBlE;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;CAGpB;AAED;;;;GAIG;AACH,8BAAsB,YAAY,CACjC,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,CACvD,SAAQ,gBAAgB,CAAC,MAAM,CAAC;IAmChC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAlCxC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAkB;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,SAAS,KAAK,UAAU,IAAI,gBAAgB,CAa3C;IAED;;;;OAIG;gBAEF,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EACb,sBAAsB,EAAE,MAAM;IAUhD;;OAEG;IACI,gBAAgB,CACtB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAexB;;OAEG;IACU,SAAS,CACrB,QAAQ,GAAE,OAAe,EACzB,UAAU,GAAE,OAAe,EAC3B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,OAAO,CAAC,qBAAqB,CAAC;IAmBjC;;OAEG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IA8BjE;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,gBAAgB;IAOxD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAC/B,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,qBAAqB;IAExB,OAAO,CAAC,wBAAwB;CAShC"}
@@ -10,12 +10,12 @@ const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
10
10
  const core_utils_1 = require("@fluidframework/core-utils");
11
11
  const container_definitions_1 = require("@fluidframework/container-definitions");
12
12
  const runtime_definitions_1 = require("@fluidframework/runtime-definitions");
13
- const serializer_1 = require("./serializer.cjs");
14
- const handle_1 = require("./handle.cjs");
15
- const summarySerializer_1 = require("./summarySerializer.cjs");
13
+ const serializer_1 = require("./serializer");
14
+ const handle_1 = require("./handle");
15
+ const summarySerializer_1 = require("./summarySerializer");
16
16
  /**
17
17
  * Base class from which all shared objects derive.
18
- * @alpha
18
+ * @public
19
19
  */
20
20
  class SharedObjectCore extends telemetry_utils_1.EventEmitterWithErrorHandling {
21
21
  get IFluidLoadable() {
@@ -387,7 +387,7 @@ exports.SharedObjectCore = SharedObjectCore;
387
387
  /**
388
388
  * SharedObject with simplified, synchronous summarization and GC.
389
389
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
390
- * @alpha
390
+ * @public
391
391
  */
392
392
  class SharedObject extends SharedObjectCore {
393
393
  get serializer() {
@@ -472,4 +472,4 @@ class SharedObject extends SharedObjectCore {
472
472
  }
473
473
  }
474
474
  exports.SharedObject = SharedObject;
475
- //# sourceMappingURL=sharedObject.cjs.map
475
+ //# sourceMappingURL=sharedObject.js.map