@fluidframework/shared-object-base 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/lib/shared-object-base-untrimmed.d.mts

@@ -0,0 +1,506 @@
+import { EventEmitterEventType } from '@fluid-internal/client-utils';
+import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
+import { IChannel } from '@fluidframework/datastore-definitions';
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelServices } from '@fluidframework/datastore-definitions';
+import { IChannelStorageService } from '@fluidframework/datastore-definitions';
+import { IErrorEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
+import { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidHandleContext } from '@fluidframework/core-interfaces';
+import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { ITelemetryContext } from '@fluidframework/runtime-definitions';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+
+/**
+ * Create a new summary containing one blob
+ * @param key - the key for the blob in the summary
+ * @param content - blob content
+ * @returns The summary containing the blob
+ * @internal
+ */
+export declare function createSingleBlobSummary(key: string, content: string | Uint8Array): ISummaryTreeWithStats;
+
+/**
+ * Data Store serializer implementation
+ * @internal
+ */
+export declare class FluidSerializer implements IFluidSerializer {
+    private readonly context;
+    private readonly handleParsedCb;
+    private readonly root;
+    constructor(context: IFluidHandleContext, handleParsedCb: (handle: IFluidHandle) => void);
+    get IFluidSerializer(): this;
+    /**
+     * Given a mostly-jsonable object tree that may have handle objects embedded within, will return a
+     * fully-jsonable object tree where any embedded IFluidHandles have been replaced with a serializable form.
+     *
+     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from
+     * the root to any replaced handles.  (If no handles are found, returns the original object.)
+     *
+     * Any unbound handles encountered are bound to the provided IFluidHandle.
+     */
+    encode(input: any, bind: IFluidHandle): any;
+    /**
+     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
+     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.
+     *
+     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from
+     * the root to any replaced handles.  (If no handles are found, returns the original object.)
+     *
+     * The decoded handles are implicitly bound to the handle context of this serializer.
+     */
+    decode(input: any): any;
+    stringify(input: any, bind: IFluidHandle): string;
+    parse(input: string): any;
+    private readonly encodeValue;
+    private readonly decodeValue;
+    private recursivelyReplace;
+    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle): {
+        type: string;
+        url: string;
+    };
+}
+
+/**
+ * @public
+ */
+export declare interface IFluidSerializer {
+    /**
+     * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
+     * where any embedded IFluidHandles have been replaced with a serializable form.
+     *
+     * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
+     * the root to any replaced handles.  (If no handles are found, returns the original object.)
+     */
+    encode(value: any, bind: IFluidHandle): any;
+    /**
+     * Given a fully-jsonable object tree that may have encoded handle objects embedded within, will return an
+     * equivalent object tree where any encoded IFluidHandles have been replaced with their decoded form.
+     *
+     * The original `input` object is not mutated.  This method will shallowly clone all objects in the path from
+     * the root to any replaced handles.  (If no handles are found, returns the original object.)
+     *
+     * The decoded handles are implicitly bound to the handle context of this serializer.
+     */
+    decode(input: any): any;
+    /**
+     * Stringifies a given value. Converts any IFluidHandle to its stringified equivalent.
+     */
+    stringify(value: any, bind: IFluidHandle): string;
+    /**
+     * Parses the given JSON input string and returns the JavaScript object defined by it. Any Fluid
+     * handles will be realized as part of the parse
+     */
+    parse(value: string): any;
+}
+
+/**
+ * JSON serialized form of an IFluidHandle
+ * @internal
+ */
+export declare interface ISerializedHandle {
+    type: "__fluid_handle__";
+    url: string;
+}
+
+/**
+ * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
+ * @public
+ */
+export declare interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends IChannel, IEventProvider<TEvent> {
+    /**
+     * Binds the given shared object to its containing data store runtime, causing it to attach once
+     * the runtime attaches.
+     */
+    bindToContext(): void;
+    /**
+     * Returns the GC data for this shared object. It contains a list of GC nodes that contains references to
+     * other GC nodes.
+     * @param fullGC - true to bypass optimizations and force full generation of GC data.
+     */
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+}
+
+/**
+ * Events emitted by {@link ISharedObject}.
+ * @public
+ */
+export declare interface ISharedObjectEvents extends IErrorEvent {
+    /**
+     * Fires before an incoming operation (op) is applied to the shared object.
+     *
+     * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external
+     * use.
+     *
+     * @eventProperty
+     */
+    (event: "pre-op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    /**
+     * Fires after an incoming op is applied to the shared object.
+     *
+     * @remarks Note: this should be considered an internal implementation detail. It is not recommended for external
+     * use.
+     *
+     * @eventProperty
+     */
+    (event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any;
+}
+
+/**
+ * @internal
+ */
+export declare const isSerializedHandle: (value: any) => value is ISerializedHandle;
+
+/**
+ * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
+ * where any embedded IFluidHandles have been replaced with a serializable form.
+ *
+ * The original `input` object is not mutated.  This method will shallowly clones all objects in the path from
+ * the root to any replaced handles.  (If no handles are found, returns the original object.)
+ *
+ * @param input - The mostly-plain object
+ * @param context - The handle context for the container
+ * @param bind - Bind any other handles we find in the object against this given handle.
+ * @returns The fully-plain object
+ * @alpha
+ */
+export declare function makeHandlesSerializable(value: any, serializer: IFluidSerializer, bind: IFluidHandle): any;
+
+/**
+ * Given a fully-plain object that may have serializable-form handles within, will return the mostly-plain object
+ * with handle objects created instead.
+ * @param value - The fully-plain object
+ * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects
+ * @param context - The handle context for the container
+ * @returns The mostly-plain object with handle objects within
+ * @alpha
+ */
+export declare function parseHandles(value: any, serializer: IFluidSerializer): any;
+
+/**
+ * Given a mostly-plain object that may have handle objects embedded within, return a string representation of an object
+ * where the handle objects have been replaced with a serializable form.
+ * @param value - The mostly-plain object
+ * @param serializer - The serializer that knows how to convert handles into serializable format
+ * @param context - The handle context for the container
+ * @param bind - Bind any other handles we find in the object against this given handle.
+ * @returns Result of strigifying an object
+ * @internal
+ */
+export declare function serializeHandles(value: any, serializer: IFluidSerializer, bind: IFluidHandle): string | undefined;
+
+/**
+ * SharedObject with simplified, synchronous summarization and GC.
+ * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
+ * @public
+ */
+export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
+    private readonly telemetryContextPrefix;
+    /**
+     * True while we are garbage collecting this object's data.
+     */
+    private _isGCing;
+    /**
+     * The serializer to use to serialize / parse handles, if any.
+     */
+    private readonly _serializer;
+    protected get serializer(): IFluidSerializer;
+    /**
+     * @param id - The id of the shared object
+     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
+     * @param attributes - Attributes of the shared object
+     */
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
+     */
+    getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
+     */
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): Promise<ISummaryTreeWithStats>;
+    /**
+     * {@inheritDoc (ISharedObject:interface).getGCData}
+     */
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+    /**
+     * Calls the serializer over all data in this object that reference other GC nodes.
+     * Derived classes must override this to provide custom list of references to other GC nodes.
+     */
+    protected processGCDataCore(serializer: IFluidSerializer): void;
+    /**
+     * Gets a form of the object that can be serialized.
+     * @returns A tree representing the snapshot of the shared object.
+     */
+    protected abstract summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): ISummaryTreeWithStats;
+    private incrementTelemetryMetric;
+}
+
+/**
+ * Base class from which all shared objects derive.
+ * @public
+ */
+export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {
+    id: string;
+    protected runtime: IFluidDataStoreRuntime;
+    readonly attributes: IChannelAttributes;
+    get IFluidLoadable(): this;
+    private readonly opProcessingHelper;
+    private readonly callbacksHelper;
+    /**
+     * The handle referring to this SharedObject
+     */
+    readonly handle: IFluidHandle;
+    /**
+     * Telemetry logger for the shared object
+     */
+    protected readonly logger: ITelemetryLoggerExt;
+    private readonly mc;
+    /**
+     * Connection state
+     */
+    private _connected;
+    /**
+     * Services used by the shared object
+     */
+    private services;
+    /**
+     * True if the dds is bound to its parent.
+     */
+    private _isBoundToContext;
+    /**
+     * Tracks error that closed this object.
+     */
+    private closeError?;
+    /**
+     * Gets the connection state
+     * @returns The state of the connection
+     */
+    get connected(): boolean;
+    /**
+     * @param id - The id of the shared object
+     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
+     * @param attributes - Attributes of the shared object
+     */
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * This function is only supposed to be called from SharedObjectCore's constructor and
+     * depends on a few things being set already. assert() calls make sure of it.
+     * @returns The telemetry sampling helpers, so the constructor can be the one to assign them
+     * to variables to avoid complaints from TypeScript.
+     */
+    private setUpSampledTelemetryHelpers;
+    /**
+     * Marks this objects as closed. Any attempt to change it (local changes or processing remote ops)
+     * would result in same error thrown. If called multiple times, only first error is remembered.
+     * @param error - error object that is thrown whenever an attempt is made to modify this object
+     */
+    private closeWithError;
+    /**
+     * Verifies that this object is not closed via closeWithError(). If it is, throws an error used to close it.
+     */
+    private verifyNotClosed;
+    /**
+     * Event listener handler helper that can be used to react to exceptions thrown from event listeners
+     * It wraps error with DataProcessingError, closes this object and throws resulting error.
+     * See closeWithError() for more details
+     * Ideally such situation never happens, as consumers of DDS should never throw exceptions
+     * in event listeners (i.e. catch any of the issues and make determination on how to handle it).
+     * When such exceptions propagate through, most likely data model is no longer consistent, i.e.
+     * DDS state does not match what user sees. Because of it DDS moves to "corrupted state" and does not
+     * allow processing of ops or local changes, which very quickly results in container closure.
+     */
+    private eventListenerErrorHandler;
+    private attachListeners;
+    /**
+     * A shared object, after construction, can either be loaded in the case that it is already part of
+     * a shared document. Or later attached if it is being newly added.
+     * @param services - Services used by the shared object
+     */
+    load(services: IChannelServices): Promise<void>;
+    /**
+     * Initializes the object as a local, non-shared object. This object can become shared after
+     * it is attached to the document.
+     */
+    initializeLocal(): void;
+    /**
+     * {@inheritDoc (ISharedObject:interface).bindToContext}
+     */
+    bindToContext(): void;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).connect}
+     */
+    connect(services: IChannelServices): void;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).isAttached}
+     */
+    isAttached(): boolean;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
+     */
+    abstract getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
+     */
+    abstract summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    /**
+     * {@inheritDoc (ISharedObject:interface).getGCData}
+     */
+    abstract getGCData(fullGC?: boolean): IGarbageCollectionData;
+    /**
+     * Called when a handle is decoded by this object. A handle in the object's data represents an outbound reference
+     * to another object in the container.
+     * @param decodedHandle - The handle of the Fluid object that is decoded.
+     */
+    protected handleDecoded(decodedHandle: IFluidHandle): void;
+    /**
+     * Allows the distributed data type to perform custom loading
+     * @param services - Storage used by the shared object
+     */
+    protected abstract loadCore(services: IChannelStorageService): Promise<void>;
+    /**
+     * Allows the distributed data type to perform custom local loading.
+     */
+    protected initializeLocalCore(): void;
+    /**
+     * Allows the distributive data type the ability to perform custom processing once an attach has happened.
+     * Also called after non-local data type get loaded.
+     */
+    protected didAttach(): void;
+    /**
+     * Derived classes must override this to do custom processing on a remote message.
+     * @param message - The message to process
+     * @param local - True if the shared object is local
+     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be undefined.
+     */
+    protected abstract processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): any;
+    /**
+     * Called when the object has disconnected from the delta stream.
+     */
+    protected abstract onDisconnect(): any;
+    /**
+     * Submits a message by the local client to the runtime.
+     * @param content - Content of the message
+     * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime
+     * and not sent to the server. This will be sent back when this message is received back from the server. This is
+     * also sent if we are asked to resubmit the message.
+     */
+    protected submitLocalMessage(content: any, localOpMetadata?: unknown): void;
+    /**
+     * Marks this object as dirty so that it is part of the next summary. It is called by a SharedSummaryBlock
+     * that want to be part of summary but does not generate ops.
+     */
+    protected dirty(): void;
+    /**
+     * Called when the object has fully connected to the delta stream
+     * Default implementation for DDS, override if different behavior is required.
+     */
+    protected onConnect(): void;
+    /**
+     * Called when a message has to be resubmitted. This typically happens after a reconnection for unacked messages.
+     * The default implementation here is to resubmit the same message. The client can override if different behavior
+     * is required. It can choose to resubmit the same message, submit different / multiple messages or not submit
+     * anything at all.
+     * @param content - The content of the original message.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    protected reSubmitCore(content: any, localOpMetadata: unknown): void;
+    /**
+     * Promises that are waiting for an ack from the server before resolving should use this instead of new Promise.
+     * It ensures that if something changes that will interrupt that ack (e.g. the FluidDataStoreRuntime disposes),
+     * the Promise will reject.
+     * If runtime is disposed when this call is made, executor is not run and promise is rejected right away.
+     */
+    protected newAckBasedPromise<T>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void): Promise<T>;
+    private attachDeltaHandler;
+    /**
+     * Set the state of connection to services.
+     * @param connected - true if connected, false otherwise.
+     */
+    private setConnectionState;
+    /**
+     * Handles a message being received from the remote delta server.
+     * @param message - The message to process
+     * @param local - Whether the message originated from the local client
+     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be undefined.
+     */
+    private process;
+    /**
+     * Called when a message has to be resubmitted. This typically happens for unacked messages after a
+     * reconnection.
+     * @param content - The content of the original message.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    private reSubmit;
+    /**
+     * Revert an op
+     */
+    protected rollback(content: any, localOpMetadata: unknown): void;
+    /**
+     * Apply changes from an op. Used when rehydrating an attached container
+     * with pending changes. This prepares the SharedObject for seeing an ACK
+     * for the op or resubmitting the op upon reconnection.
+     * @param content - Contents of a stashed op.
+     * @returns localMetadata of the op, to be passed to process() or resubmit()
+     * when the op is ACKed or resubmitted, respectively
+     */
+    protected abstract applyStashedOp(content: any): unknown;
+    /**
+     * Emit an event. This function is only intended for use by DDS classes that extend SharedObject/SharedObjectCore,
+     * specifically to emit events that are part of the public interface of the DDS (i.e. those that can have listeners
+     * attached to them by the consumers of the DDS). It should not be called from outside the class or to emit events
+     * which are only internal to the DDS. Support for calling it from outside the DDS instance might be removed in the
+     * future.
+     * @param event - The event to emit.
+     * @param args - Arguments to pass to the event listeners.
+     * @returns `true` if the event had listeners, `false` otherwise.
+     */
+    emit(event: EventEmitterEventType, ...args: any[]): boolean;
+    /**
+     * Use to emit events inside {@link SharedObjectCore}, with no telemetry measurement
+     * done on the duration of the callbacks. Simply calls `super.emit()`.
+     * @param event - Event to emit
+     * @param args - Arguments for the event
+     * @returns Whatever `super.emit()` returns.
+     */
+    private emitInternal;
+}
+
+/**
+ * Serializer implementation for serializing handles during summary.
+ * @internal
+ */
+export declare class SummarySerializer extends FluidSerializer {
+    private readonly serializedRoutes;
+    getSerializedRoutes(): string[];
+    protected serializeHandle(handle: IFluidHandle, bind: IFluidHandle): {
+        type: string;
+        url: string;
+    };
+}
+
+/**
+ * enum representing the possible types of a shared object
+ * @internal
+ */
+export declare enum ValueType {
+    /**
+     * The value is a shared object
+     * @deprecated Instead store the handle of the shared object, rather than the shared object itself.
+     */
+    Shared = 0,
+    /**
+     * The value is a plain JavaScript object or handle.  If a plain object, it may contain handles deeper within.
+     */
+    Plain = 1
+}
+
+export { }

package/lib/{sharedObject.d.ts → sharedObject.d.mts}

@@ -2,18 +2,17 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { EventEmitterEventType } from "@fluidframework/common-utils";
 import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { ITelemetryLoggerExt, EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
+import { EventEmitterEventType } from "@fluid-internal/client-utils";
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService, IChannelServices } from "@fluidframework/datastore-definitions";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
-import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
-import { EventEmitterWithErrorHandling } from "@fluidframework/telemetry-utils";
-import { IFluidSerializer } from "./serializer";
-import { SummarySerializer } from "./summarySerializer";
-import { ISharedObject, ISharedObjectEvents } from "./types";
+import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext, IExperimentalIncrementalSummaryContext } from "@fluidframework/runtime-definitions";
+import { IFluidSerializer } from "./serializer.mjs";
+import { ISharedObject, ISharedObjectEvents } from "./types.mjs";
 /**
- *  Base class from which all shared objects derive
+ * Base class from which all shared objects derive.
+ * @public
  */
 export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends EventEmitterWithErrorHandling<TEvent> implements ISharedObject<TEvent> {
     id: string;
@@ -29,7 +28,7 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
     /**
      * Telemetry logger for the shared object
      */
-    protected readonly logger: ITelemetryLogger;
+    protected readonly logger: ITelemetryLoggerExt;
     private readonly mc;
     /**
      * Connection state
@@ -228,9 +227,6 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
      * attached to them by the consumers of the DDS). It should not be called from outside the class or to emit events
      * which are only internal to the DDS. Support for calling it from outside the DDS instance might be removed in the
      * future.
-     *
-     * @internal
-     *
      * @param event - The event to emit.
      * @param args - Arguments to pass to the event listeners.
      * @returns `true` if the event had listeners, `false` otherwise.
@@ -248,6 +244,7 @@ export declare abstract class SharedObjectCore<TEvent extends ISharedObjectEvent
 /**
  * SharedObject with simplified, synchronous summarization and GC.
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
+ * @public
  */
 export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent> {
     private readonly telemetryContextPrefix;
@@ -273,7 +270,7 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
     /**
      * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
      */
-    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): Promise<ISummaryTreeWithStats>;
     /**
      * {@inheritDoc (ISharedObject:interface).getGCData}
      */
@@ -282,12 +279,12 @@ export declare abstract class SharedObject<TEvent extends ISharedObjectEvents =
      * Calls the serializer over all data in this object that reference other GC nodes.
      * Derived classes must override this to provide custom list of references to other GC nodes.
      */
-    protected processGCDataCore(serializer: SummarySerializer): void;
+    protected processGCDataCore(serializer: IFluidSerializer): void;
     /**
      * Gets a form of the object that can be serialized.
      * @returns A tree representing the snapshot of the shared object.
      */
-    protected abstract summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    protected abstract summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): ISummaryTreeWithStats;
     private incrementTelemetryMetric;
 }
 //# sourceMappingURL=sharedObject.d.ts.map

package/lib/sharedObject.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedObject.d.ts","sourceRoot":"","sources":["../src/sharedObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAGI,EAAE,YAAY,EAAwB,MAAM,iCAAiC;OAC7E,EACN,mBAAmB,EAGnB,6BAA6B,EAK7B,MAAM,iCAAiC;OAEjC,EAAE,qBAAqB,EAAE,MAAM,8BAA8B;OAE7D,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EAChB,MAAM,uCAAuC;OACvC,EAAE,yBAAyB,EAAE,MAAM,sCAAsC;OACzE,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EAGjB,sCAAsC,EACtC,MAAM,qCAAqC;OACrC,EAAmB,gBAAgB,EAAE;OAGrC,EAAE,aAAa,EAAE,mBAAmB,EAAE;AAE7C;;;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"}