@fluidframework/datastore 2.0.0-internal.6.4.0 → 2.0.0-internal.7.1.0

package/dist/datastore-public.d.ts

@@ -0,0 +1,327 @@
+import { AttachState } from '@fluidframework/container-definitions';
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { IAudience } from '@fluidframework/container-definitions';
+import { IChannel } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IClientDetails } from '@fluidframework/protocol-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntimeEvents } from '@fluidframework/datastore-definitions';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidHandleContext } from '@fluidframework/core-interfaces';
+import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { IIdCompressor } from '@fluidframework/runtime-definitions';
+import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
+import { ILoaderOptions } from '@fluidframework/container-definitions';
+import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResponse } from '@fluidframework/core-interfaces';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { ITelemetryContext } from '@fluidframework/runtime-definitions';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { VisibilityState } from '@fluidframework/runtime-definitions';
+
+/**
+ * @public
+ */
+export declare enum DataStoreMessageType {
+    Attach = "attach",
+    ChannelOp = "op"
+}
+
+/**
+ * Base data store class
+ *
+ * @public
+ */
+export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRuntimeEvents> implements IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
+    private readonly dataStoreContext;
+    private readonly sharedObjectRegistry;
+    /**
+     * @deprecated - Instantiate the class using its constructor instead.
+     *
+     * Loads the data store runtime
+     * @param context - The data store context
+     * @param sharedObjectRegistry - The registry of shared objects used by this data store
+     * @param existing - If loading from an existing file.
+     */
+    static load(context: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean): FluidDataStoreRuntime;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IFluidDataStoreRuntime.entryPoint}
+     */
+    readonly entryPoint: IFluidHandle<FluidObject>;
+    /**
+     * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+     */
+    get IFluidRouter(): this;
+    get connected(): boolean;
+    get clientId(): string | undefined;
+    get clientDetails(): IClientDetails;
+    get isAttached(): boolean;
+    get attachState(): AttachState;
+    get absolutePath(): string;
+    get routeContext(): IFluidHandleContext;
+    get idCompressor(): IIdCompressor | undefined;
+    get IFluidHandleContext(): this;
+    get rootRoutingContext(): this;
+    get channelsRoutingContext(): this;
+    get objectsRoutingContext(): this;
+    private _disposed;
+    get disposed(): boolean;
+    private readonly contexts;
+    private readonly pendingAttach;
+    private readonly deferredAttached;
+    private readonly localChannelContextQueue;
+    private readonly notBoundedChannelContextSet;
+    private _attachState;
+    visibilityState: VisibilityState;
+    private readonly pendingHandlesToMakeVisible;
+    readonly id: string;
+    readonly options: ILoaderOptions;
+    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+    private readonly quorum;
+    private readonly audience;
+    private readonly mc;
+    get logger(): ITelemetryLoggerExt;
+    /**
+     * If the summarizer makes local changes, a telemetry event is logged. This has the potential to be very noisy.
+     * So, adding a count of how many telemetry events are logged per data store context. This can be
+     * controlled via feature flags.
+     */
+    private localChangesTelemetryCount;
+    /**
+     * Invokes the given callback and expects that no ops are submitted
+     * until execution finishes. If an op is submitted, an error will be raised.
+     *
+     * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`
+     *
+     * @param callback - the callback to be invoked
+     */
+    ensureNoDataModelChanges<T>(callback: () => T): T;
+    /**
+     * Create an instance of a DataStore runtime.
+     *
+     * @param dataStoreContext - Context object for the runtime.
+     * @param sharedObjectRegistry - The registry of shared objects that this data store will be able to instantiate.
+     * @param existing - Pass 'true' if loading this datastore from an existing file; pass 'false' otherwise.
+     * @param provideEntryPoint - Function to initialize the entryPoint object for the data store runtime. The
+     * handle to this data store runtime will point to the object returned by this function. If this function is not
+     * provided, the handle will be left undefined. This is here so we can start making handles a first-class citizen
+     * and the primary way of interacting with some Fluid objects, and should be used if possible.
+     */
+    constructor(dataStoreContext: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean, provideEntryPoint: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>);
+    dispose(): void;
+    resolveHandle(request: IRequest): Promise<IResponse>;
+    request(request: IRequest): Promise<IResponse>;
+    getChannel(id: string): Promise<IChannel>;
+    createChannel(id: string | undefined, type: string): IChannel;
+    /**
+     * Binds a channel with the runtime. If the runtime is attached we will attach the channel right away.
+     * If the runtime is not attached we will defer the attach until the runtime attaches.
+     * @param channel - channel to be registered.
+     */
+    bindChannel(channel: IChannel): void;
+    /**
+     * This function is called when a data store becomes root. It does the following:
+     *
+     * 1. Marks the data store locally visible in the container.
+     *
+     * 2. Attaches the graph of all the handles bound to it.
+     *
+     * 3. Calls into the data store context to mark it visible in the container too. If the container is globally
+     * visible, it will mark us globally visible. Otherwise, it will mark us globally visible when it becomes
+     * globally visible.
+     */
+    makeVisibleAndAttachGraph(): void;
+    /**
+     * This function is called when a handle to this data store is added to a visible DDS.
+     */
+    attachGraph(): void;
+    bind(handle: IFluidHandle): void;
+    setConnectionState(connected: boolean, clientId?: string): void;
+    getQuorum(): IQuorumClients;
+    getAudience(): IAudience;
+    uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
+    private createRemoteChannelContext;
+    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    processSignal(message: IInboundSignalMessage, local: boolean): void;
+    private isChannelAttached;
+    /**
+     * Returns the outbound routes of this channel. Currently, all contexts in this channel are considered
+     * referenced and are hence outbound. This will change when we have root and non-root channel contexts.
+     * The only root contexts will be considered as referenced.
+     */
+    private getOutboundRoutes;
+    /**
+     * Updates the GC nodes of this channel. It does the following:
+     * - Adds a back route to self to all its child GC nodes.
+     * - Adds a node for this channel.
+     * @param builder - The builder that contains the GC nodes for this channel's children.
+     */
+    private updateGCNodes;
+    /**
+     * Generates data used for garbage collection. This includes a list of GC nodes that represent this channel
+     * including any of its child channel contexts. Each node has a set of outbound routes to other GC nodes in the
+     * document. It does the following:
+     *
+     * 1. Calls into each child context to get its GC data.
+     *
+     * 2. Prefixes the child context's id to the GC nodes in the child's GC data. This makes sure that the node can be
+     * identified as belonging to the child.
+     *
+     * 3. Adds a GC node for this channel to the nodes received from the children. All these nodes together represent
+     * the GC data of this channel.
+     *
+     * @param fullGC - true to bypass optimizations and force full generation of GC data.
+     */
+    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
+    /**
+     * After GC has run, called to notify this channel of routes that are used in it. It calls the child contexts to
+     * update their used routes.
+     * @param usedRoutes - The routes that are used in all contexts in this channel.
+     */
+    updateUsedRoutes(usedRoutes: string[]): void;
+    /**
+     * Called when a new outbound reference is added to another node. This is used by garbage collection to identify
+     * all references added in the system.
+     * @param srcHandle - The handle of the node that added the reference.
+     * @param outboundHandle - The handle of the outbound node that is referenced.
+     */
+    private addedGCOutboundReference;
+    /**
+     * Returns a summary at the current sequence number.
+     * @param fullTree - true to bypass optimizations and force a full summary tree
+     * @param trackState - This tells whether we should track state from this summary.
+     * @param telemetryContext - summary data passed through the layers for telemetry purposes
+     */
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    submitMessage(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
+    submitSignal(type: string, content: any): void;
+    /**
+     * Will return when the data store is attached.
+     */
+    waitAttached(): Promise<void>;
+    /**
+     * Attach channel should only be called after the data store has been attached
+     */
+    private attachChannel;
+    private submitChannelOp;
+    private submit;
+    /**
+     * For messages of type MessageType.Operation, finds the right channel and asks it to resubmit the message.
+     * For all other messages, just submit it again.
+     * This typically happens when we reconnect and there are unacked messages.
+     * @param content - The content of the original message.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    reSubmit(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
+    /**
+     * Revert a local op.
+     * @param content - The content of the original message.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    rollback?(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
+    applyStashedOp(content: any): Promise<unknown>;
+    private setChannelDirty;
+    private processChannelOp;
+    private attachListener;
+    private verifyNotClosed;
+    /**
+     * Summarizer client should not have local changes. These changes can become part of the summary and can break
+     * eventual consistency. For example, the next summary (say at ref seq# 100) may contain these changes whereas
+     * other clients that are up-to-date till seq# 100 may not have them yet.
+     */
+    private identifyLocalChangeInSummarizer;
+}
+
+/**
+ * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ *
+ * @public
+ */
+export declare class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
+    protected readonly value: T | Promise<T>;
+    readonly path: string;
+    readonly routeContext: IFluidHandleContext;
+    private readonly pendingHandlesToMakeVisible;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.absolutePath}
+     */
+    readonly absolutePath: string;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}
+     */
+    get IFluidHandle(): IFluidHandle;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.isAttached}
+     */
+    get isAttached(): boolean;
+    /**
+     * Tells whether the object of this handle is visible in the container locally or globally.
+     */
+    private get visible();
+    /**
+     * Tracks whether this handle is locally visible in the container.
+     */
+    private locallyVisible;
+    /**
+     * Creates a new `FluidObjectHandle`.
+     *
+     * @param value - The {@link @fluidframework/core-interfaces#FluidObject} object this handle is for.
+     * @param path - The path to this handle relative to the `routeContext`.
+     * @param routeContext - The parent {@link @fluidframework/core-interfaces#IFluidHandleContext} that has a route
+     * to this handle.
+     */
+    constructor(value: T | Promise<T>, path: string, routeContext: IFluidHandleContext);
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.get}
+     */
+    get(): Promise<any>;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.attachGraph }
+     */
+    attachGraph(): void;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.bind}
+     */
+    bind(handle: IFluidHandle): void;
+}
+
+/**
+ * @public
+ */
+export declare interface ISharedObjectRegistry {
+    get(name: string): IChannelFactory | undefined;
+}
+
+/**
+ * Mixin class that adds request handler to FluidDataStoreRuntime
+ * Request handler is only called when data store can't resolve request, i.e. for custom requests.
+ * @param Base - base class, inherits from FluidDataStoreRuntime
+ * @param requestHandler - request handler to mix in
+ *
+ * @public
+ */
+export declare const mixinRequestHandler: (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;
+
+/**
+ * Mixin class that adds await for DataObject to finish initialization before we proceed to summary.
+ * @param handler - handler that returns info about blob to be added to summary.
+ * Or undefined not to add anything to summary.
+ * @param Base - base class, inherits from FluidDataStoreRuntime
+ *
+ * @public
+ */
+export declare const mixinSummaryHandler: (handler: (runtime: FluidDataStoreRuntime) => Promise<{
+    path: string[];
+    content: string;
+} | undefined>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;
+
+/* Excluded from this release type: TypedEventEmitter */
+
+export { }

package/dist/datastore.d.ts

@@ -0,0 +1,326 @@
+import { AttachState } from '@fluidframework/container-definitions';
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { IAudience } from '@fluidframework/container-definitions';
+import { IChannel } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IClientDetails } from '@fluidframework/protocol-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidDataStoreRuntimeEvents } from '@fluidframework/datastore-definitions';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidHandleContext } from '@fluidframework/core-interfaces';
+import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { IIdCompressor } from '@fluidframework/runtime-definitions';
+import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
+import { ILoaderOptions } from '@fluidframework/container-definitions';
+import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResponse } from '@fluidframework/core-interfaces';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { ITelemetryContext } from '@fluidframework/runtime-definitions';
+import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+import { VisibilityState } from '@fluidframework/runtime-definitions';
+
+/**
+ * @public
+ */
+export declare enum DataStoreMessageType {
+    Attach = "attach",
+    ChannelOp = "op"
+}
+
+/**
+ * Base data store class
+ *
+ * @public
+ */
+export declare class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRuntimeEvents> implements IFluidDataStoreChannel, IFluidDataStoreRuntime, IFluidHandleContext {
+    private readonly dataStoreContext;
+    private readonly sharedObjectRegistry;
+    /**
+     * @deprecated - Instantiate the class using its constructor instead.
+     *
+     * Loads the data store runtime
+     * @param context - The data store context
+     * @param sharedObjectRegistry - The registry of shared objects used by this data store
+     * @param existing - If loading from an existing file.
+     */
+    static load(context: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean): FluidDataStoreRuntime;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IFluidDataStoreRuntime.entryPoint}
+     */
+    readonly entryPoint: IFluidHandle<FluidObject>;
+    /**
+     * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+     */
+    get IFluidRouter(): this;
+    get connected(): boolean;
+    get clientId(): string | undefined;
+    get clientDetails(): IClientDetails;
+    get isAttached(): boolean;
+    get attachState(): AttachState;
+    get absolutePath(): string;
+    get routeContext(): IFluidHandleContext;
+    get idCompressor(): IIdCompressor | undefined;
+    get IFluidHandleContext(): this;
+    get rootRoutingContext(): this;
+    get channelsRoutingContext(): this;
+    get objectsRoutingContext(): this;
+    private _disposed;
+    get disposed(): boolean;
+    private readonly contexts;
+    private readonly pendingAttach;
+    private readonly deferredAttached;
+    private readonly localChannelContextQueue;
+    private readonly notBoundedChannelContextSet;
+    private _attachState;
+    visibilityState: VisibilityState;
+    private readonly pendingHandlesToMakeVisible;
+    readonly id: string;
+    readonly options: ILoaderOptions;
+    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+    private readonly quorum;
+    private readonly audience;
+    private readonly mc;
+    get logger(): ITelemetryLoggerExt;
+    /**
+     * If the summarizer makes local changes, a telemetry event is logged. This has the potential to be very noisy.
+     * So, adding a count of how many telemetry events are logged per data store context. This can be
+     * controlled via feature flags.
+     */
+    private localChangesTelemetryCount;
+    /**
+     * Invokes the given callback and expects that no ops are submitted
+     * until execution finishes. If an op is submitted, an error will be raised.
+     *
+     * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`
+     *
+     * @param callback - the callback to be invoked
+     */
+    ensureNoDataModelChanges<T>(callback: () => T): T;
+    /**
+     * Create an instance of a DataStore runtime.
+     *
+     * @param dataStoreContext - Context object for the runtime.
+     * @param sharedObjectRegistry - The registry of shared objects that this data store will be able to instantiate.
+     * @param existing - Pass 'true' if loading this datastore from an existing file; pass 'false' otherwise.
+     * @param provideEntryPoint - Function to initialize the entryPoint object for the data store runtime. The
+     * handle to this data store runtime will point to the object returned by this function. If this function is not
+     * provided, the handle will be left undefined. This is here so we can start making handles a first-class citizen
+     * and the primary way of interacting with some Fluid objects, and should be used if possible.
+     */
+    constructor(dataStoreContext: IFluidDataStoreContext, sharedObjectRegistry: ISharedObjectRegistry, existing: boolean, provideEntryPoint: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>);
+    dispose(): void;
+    resolveHandle(request: IRequest): Promise<IResponse>;
+    request(request: IRequest): Promise<IResponse>;
+    getChannel(id: string): Promise<IChannel>;
+    createChannel(id: string | undefined, type: string): IChannel;
+    /**
+     * Binds a channel with the runtime. If the runtime is attached we will attach the channel right away.
+     * If the runtime is not attached we will defer the attach until the runtime attaches.
+     * @param channel - channel to be registered.
+     */
+    bindChannel(channel: IChannel): void;
+    /**
+     * This function is called when a data store becomes root. It does the following:
+     *
+     * 1. Marks the data store locally visible in the container.
+     *
+     * 2. Attaches the graph of all the handles bound to it.
+     *
+     * 3. Calls into the data store context to mark it visible in the container too. If the container is globally
+     * visible, it will mark us globally visible. Otherwise, it will mark us globally visible when it becomes
+     * globally visible.
+     */
+    makeVisibleAndAttachGraph(): void;
+    /**
+     * This function is called when a handle to this data store is added to a visible DDS.
+     */
+    attachGraph(): void;
+    bind(handle: IFluidHandle): void;
+    setConnectionState(connected: boolean, clientId?: string): void;
+    getQuorum(): IQuorumClients;
+    getAudience(): IAudience;
+    uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
+    private createRemoteChannelContext;
+    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    processSignal(message: IInboundSignalMessage, local: boolean): void;
+    private isChannelAttached;
+    /**
+     * Returns the outbound routes of this channel. Currently, all contexts in this channel are considered
+     * referenced and are hence outbound. This will change when we have root and non-root channel contexts.
+     * The only root contexts will be considered as referenced.
+     */
+    private getOutboundRoutes;
+    /**
+     * Updates the GC nodes of this channel. It does the following:
+     * - Adds a back route to self to all its child GC nodes.
+     * - Adds a node for this channel.
+     * @param builder - The builder that contains the GC nodes for this channel's children.
+     */
+    private updateGCNodes;
+    /**
+     * Generates data used for garbage collection. This includes a list of GC nodes that represent this channel
+     * including any of its child channel contexts. Each node has a set of outbound routes to other GC nodes in the
+     * document. It does the following:
+     *
+     * 1. Calls into each child context to get its GC data.
+     *
+     * 2. Prefixes the child context's id to the GC nodes in the child's GC data. This makes sure that the node can be
+     * identified as belonging to the child.
+     *
+     * 3. Adds a GC node for this channel to the nodes received from the children. All these nodes together represent
+     * the GC data of this channel.
+     *
+     * @param fullGC - true to bypass optimizations and force full generation of GC data.
+     */
+    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
+    /**
+     * After GC has run, called to notify this channel of routes that are used in it. It calls the child contexts to
+     * update their used routes.
+     * @param usedRoutes - The routes that are used in all contexts in this channel.
+     */
+    updateUsedRoutes(usedRoutes: string[]): void;
+    /**
+     * Called when a new outbound reference is added to another node. This is used by garbage collection to identify
+     * all references added in the system.
+     * @param srcHandle - The handle of the node that added the reference.
+     * @param outboundHandle - The handle of the outbound node that is referenced.
+     */
+    private addedGCOutboundReference;
+    /**
+     * Returns a summary at the current sequence number.
+     * @param fullTree - true to bypass optimizations and force a full summary tree
+     * @param trackState - This tells whether we should track state from this summary.
+     * @param telemetryContext - summary data passed through the layers for telemetry purposes
+     */
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    submitMessage(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
+    submitSignal(type: string, content: any): void;
+    /**
+     * Will return when the data store is attached.
+     */
+    waitAttached(): Promise<void>;
+    /**
+     * Attach channel should only be called after the data store has been attached
+     */
+    private attachChannel;
+    private submitChannelOp;
+    private submit;
+    /**
+     * For messages of type MessageType.Operation, finds the right channel and asks it to resubmit the message.
+     * For all other messages, just submit it again.
+     * This typically happens when we reconnect and there are unacked messages.
+     * @param content - The content of the original message.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    reSubmit(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
+    /**
+     * Revert a local op.
+     * @param content - The content of the original message.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    rollback?(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
+    applyStashedOp(content: any): Promise<unknown>;
+    private setChannelDirty;
+    private processChannelOp;
+    private attachListener;
+    private verifyNotClosed;
+    /**
+     * Summarizer client should not have local changes. These changes can become part of the summary and can break
+     * eventual consistency. For example, the next summary (say at ref seq# 100) may contain these changes whereas
+     * other clients that are up-to-date till seq# 100 may not have them yet.
+     */
+    private identifyLocalChangeInSummarizer;
+}
+
+/**
+ * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ *
+ * @public
+ */
+export declare class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
+    protected readonly value: T | Promise<T>;
+    readonly path: string;
+    readonly routeContext: IFluidHandleContext;
+    private readonly pendingHandlesToMakeVisible;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.absolutePath}
+     */
+    readonly absolutePath: string;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}
+     */
+    get IFluidHandle(): IFluidHandle;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.isAttached}
+     */
+    get isAttached(): boolean;
+    /**
+     * Tells whether the object of this handle is visible in the container locally or globally.
+     */
+    private get visible();
+    /**
+     * Tracks whether this handle is locally visible in the container.
+     */
+    private locallyVisible;
+    /**
+     * Creates a new `FluidObjectHandle`.
+     *
+     * @param value - The {@link @fluidframework/core-interfaces#FluidObject} object this handle is for.
+     * @param path - The path to this handle relative to the `routeContext`.
+     * @param routeContext - The parent {@link @fluidframework/core-interfaces#IFluidHandleContext} that has a route
+     * to this handle.
+     */
+    constructor(value: T | Promise<T>, path: string, routeContext: IFluidHandleContext);
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.get}
+     */
+    get(): Promise<any>;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.attachGraph }
+     */
+    attachGraph(): void;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IFluidHandle.bind}
+     */
+    bind(handle: IFluidHandle): void;
+}
+
+/**
+ * @public
+ */
+export declare interface ISharedObjectRegistry {
+    get(name: string): IChannelFactory | undefined;
+}
+
+/**
+ * Mixin class that adds request handler to FluidDataStoreRuntime
+ * Request handler is only called when data store can't resolve request, i.e. for custom requests.
+ * @param Base - base class, inherits from FluidDataStoreRuntime
+ * @param requestHandler - request handler to mix in
+ *
+ * @public
+ */
+export declare const mixinRequestHandler: (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;
+
+/**
+ * Mixin class that adds await for DataObject to finish initialization before we proceed to summary.
+ * @param handler - handler that returns info about blob to be added to summary.
+ * Or undefined not to add anything to summary.
+ * @param Base - base class, inherits from FluidDataStoreRuntime
+ *
+ * @public
+ */
+export declare const mixinSummaryHandler: (handler: (runtime: FluidDataStoreRuntime) => Promise<{
+    path: string[];
+    content: string;
+} | undefined>, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime;
+
+export { }

package/dist/fluidHandle.d.ts

@@ -5,6 +5,8 @@
 import { IFluidHandle, IFluidHandleContext, FluidObject } from "@fluidframework/core-interfaces";
 /**
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ *
+ * @public
  */
 export declare class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
     protected readonly value: T | Promise<T>;

package/dist/fluidHandle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidHandle.d.ts","sourceRoot":"","sources":["../src/fluidHandle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAGjG;;GAEG;AACH,qBAAa,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,YAAW,YAAY;IAuDzF,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;aACxB,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAxDlD,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAgC;IAE5E;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAclB;IAED;;OAEG;IACH,OAAO,CAAC,cAAc,CAAkB;IAExC;;;;;;;OAOG;gBAEiB,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB;IAKlD;;OAEG;IACU,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAKhC;;OAEG;IACI,WAAW,IAAI,IAAI;IAa1B;;OAEG;IACI,IAAI,CAAC,MAAM,EAAE,YAAY;CAQhC"}
+{"version":3,"file":"fluidHandle.d.ts","sourceRoot":"","sources":["../src/fluidHandle.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAGjG;;;;GAIG;AACH,qBAAa,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,YAAW,YAAY;IAuDzF,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;aACxB,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAxDlD,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAgC;IAE5E;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,OAAO,KAAK,OAAO,GAclB;IAED;;OAEG;IACH,OAAO,CAAC,cAAc,CAAkB;IAExC;;;;;;;OAOG;gBAEiB,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB;IAKlD;;OAEG;IACU,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAKhC;;OAEG;IACI,WAAW,IAAI,IAAI;IAa1B;;OAEG;IACI,IAAI,CAAC,MAAM,EAAE,YAAY;CAQhC"}