@fluidframework/datastore-definitions 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/dist/channel.js.map

@@ -1 +1 @@
-{"version":3,"file":"channel.js","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    ISummaryTreeWithStats,\n    ITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { IChannelAttributes } from \"./storage\";\nimport { IFluidDataStoreRuntime } from \"./dataStoreRuntime\";\n\nexport interface IChannel extends IFluidLoadable {\n    /**\n     * A readonly identifier for the channel\n     */\n    readonly id: string;\n\n    readonly owner?: string;\n\n    readonly attributes: IChannelAttributes;\n\n    /**\n     * Generates summary of the channel synchronously. It is called when an `attach message`\n     * for a local channel is generated. In other words, when the channel is being attached\n     * to make it visible to other clients.\n     * Note: Since Attach Summary is generated for local channels when making them visible to\n     * remote clients, they don't have any previous summaries to compare against. For this reason,\n     * The attach summary cannot contain summary handles (paths to sub-trees or blobs).\n     * It can, however, contain ISummaryAttachment (handles to blobs uploaded async via the blob manager).\n     * @param fullTree - flag indicating whether the attempt should generate a full\n     * summary tree without any handles for unchanged subtrees.\n     * @param trackState - optimization for tracking state of objects across summaries. If the state\n     * of an object did not change since last successful summary, an ISummaryHandle can be used\n     * instead of re-summarizing it. If this is false, the expectation is that you should never\n     * send an ISummaryHandle since you are not expected to track state.\n     * Note: The goal is to remove the trackState and automatically decided whether the\n     * handles will be used or not: https://github.com/microsoft/FluidFramework/issues/10455\n     * @returns A summary capturing the current state of the channel.\n     */\n    getAttachSummary(\n        fullTree?: boolean,\n        trackState?: boolean,\n        telemetryContext?: ITelemetryContext,\n    ): ISummaryTreeWithStats;\n\n    /**\n     * Generates summary of the channel asynchronously.\n     * This should not be called where the channel can be modified while summarization is in progress.\n     * @param fullTree - flag indicating whether the attempt should generate a full\n     * summary tree without any handles for unchanged subtrees. It is only set to true when generating\n     * a summary from the entire container.\n     * @param trackState - This tells whether we should track state from this summary.\n     * @returns A summary capturing the current state of the channel.\n     */\n    summarize(\n        fullTree?: boolean,\n        trackState?: boolean,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * Checks if the channel is attached to storage.\n     * @returns True iff the channel is attached.\n     */\n    isAttached(): boolean;\n\n    /**\n     * Enables the channel to send and receive ops.\n     * @param services - Services to connect to\n     */\n    connect(services: IChannelServices): void;\n\n    /**\n     * Returns the GC data for this channel. It contains a list of GC nodes that contains references to\n     * other GC nodes.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    getGCData(fullGC?: boolean): IGarbageCollectionData;\n}\n\n/**\n * Handler provided by shared data structure to process requests from the runtime.\n */\nexport interface IDeltaHandler {\n    /**\n     * Processes the op.\n     * @param message - The message to process\n     * @param local - Whether the message originated from the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    process: (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => void;\n\n    /**\n     * State change events to indicate changes to the delta connection\n     * @param connected - true if connected, false otherwise\n     */\n    setConnectionState(connected: boolean): void;\n\n    /**\n     * Called when the runtime asks the client to resubmit an op. This may be because the Container reconnected and\n     * this op was not acked.\n     * The client can choose to resubmit the same message, submit different / multiple messages or not submit anything\n     * at all.\n     * @param message - The original message that was submitted.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    reSubmit(message: any, localOpMetadata: unknown): void;\n\n    /**\n     * Apply changes from an op. Used when rehydrating an attached container\n     * with pending changes. This prepares the SharedObject for seeing an ACK\n     * for the op or resubmitting the op upon reconnection.\n     * @param message - Contents of a stashed op.\n     * @returns localMetadata of the op, to be passed to process() or resubmit()\n     * when the op is ACKed or resubmitted, respectively\n     */\n    applyStashedOp(message: any): unknown;\n\n    /**\n     * Revert a local op.\n     * @param message - The original message that was submitted.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    rollback?(message: any, localOpMetadata: unknown): void;\n}\n\n/**\n * Interface to represent a connection to a delta notification stream.\n */\nexport interface IDeltaConnection {\n    connected: boolean;\n\n    /**\n     * Send new messages to the server.\n     * @param messageContent - The content of the message to be sent.\n     * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime\n     * and not sent to the server. It will be provided back when this message is acknowledged by the server. It will\n     * also be provided back when asked to resubmit the message.\n     */\n    submit(messageContent: any, localOpMetadata: unknown): void;\n\n    /**\n     * Attaches a message handler to the delta connection\n     */\n    attach(handler: IDeltaHandler): void;\n\n    /**\n     * Indicates that the channel is dirty and needs to be part of the summary. It is called by a SharedSummaryBlock\n     * that needs to be part of the summary but does not generate ops.\n     */\n    dirty(): void;\n\n    /**\n     * Called when a new outbound reference is added to another node. This is used by garbage collection to identify\n     * all references added in the system.\n     * @param srcHandle - The handle of the node that added the reference.\n     * @param outboundHandle - The handle of the outbound node that is referenced.\n     */\n    addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;\n}\n\n/**\n * Storage services to read the objects at a given path.\n */\nexport interface IChannelStorageService {\n    /**\n     * Reads the object contained at the given path. Returns a buffer representation for the object.\n     */\n    readBlob(path: string): Promise<ArrayBufferLike>;\n\n    /**\n     * Determines if there is an object contained at the given path.\n     */\n    contains(path: string): Promise<boolean>;\n\n    /**\n     * Lists the blobs that exist at a specific path.\n     */\n    list(path: string): Promise<string[]>;\n}\n\n/**\n * Storage services to read the objects at a given path using the given delta connection.\n */\nexport interface IChannelServices {\n    deltaConnection: IDeltaConnection;\n\n    objectStorage: IChannelStorageService;\n}\n\n/**\n * Definitions of a channel factory. Factories follow a common model but enable custom behavior.\n */\nexport interface IChannelFactory {\n    /**\n     * String representing the type of the factory.\n     */\n    readonly type: string;\n\n    /**\n     * Attributes of the channel.\n     */\n    readonly attributes: IChannelAttributes;\n\n    /**\n     * Loads the given channel. This call is only ever invoked internally as the only thing\n     * that is ever directly loaded is the document itself. Load will then only be called on documents that\n     * were created and added to a channel.\n     * @param runtime - Data store runtime containing state/info/helper methods about the data store.\n     * @param id - ID of the channel.\n     * @param services - Services to read objects at a given path using the delta connection.\n     * @param channelAttributes - The attributes for the the channel to be loaded.\n     * @returns The loaded object\n     *\n     * @privateRemarks\n     * Thought: should the storage object include the version information and limit access to just files\n     * for the given object? The latter seems good in general. But both are probably good things. We then just\n     * need a way to allow the document to provide later storage for the object.\n     */\n    load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        channelAttributes: Readonly<IChannelAttributes>,\n    ): Promise<IChannel>;\n\n    /**\n     * Creates a local version of the channel.\n     * Calling attach on the object later will insert it into the object stream.\n     * @param runtime - The runtime the new object will be associated with\n     * @param id - The unique ID of the new object\n     * @returns The newly created object.\n     *\n     * @privateRemarks\n     * NOTE here - When we attach we need to submit all the pending ops prior to actually doing the attach\n     * for consistency.\n     */\n    create(runtime: IFluidDataStoreRuntime, id: string): IChannel;\n}\n"]}
+{"version":3,"file":"channel.js","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport {\n\tIGarbageCollectionData,\n\tIExperimentalIncrementalSummaryContext,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { IChannelAttributes } from \"./storage\";\nimport { IFluidDataStoreRuntime } from \"./dataStoreRuntime\";\n\n/**\n * @public\n */\nexport interface IChannel extends IFluidLoadable {\n\t/**\n\t * A readonly identifier for the channel\n\t */\n\treadonly id: string;\n\n\treadonly attributes: IChannelAttributes;\n\n\t/**\n\t * Generates summary of the channel synchronously. It is called when an `attach message`\n\t * for a local channel is generated. In other words, when the channel is being attached\n\t * to make it visible to other clients.\n\t *\n\t * @remarks\n\t *\n\t * Note: Since the Attach Summary is generated for local channels when making them visible to\n\t * remote clients, they don't have any previous summaries to compare against. For this reason,\n\t * the attach summary cannot contain summary handles (paths to sub-trees or blobs).\n\t * It can, however, contain {@link @fluidframework/protocol-definitions#ISummaryAttachment}\n\t * (handles to blobs uploaded async via the blob manager).\n\t *\n\t * @param fullTree - A flag indicating whether the attempt should generate a full\n\t * summary tree without any handles for unchanged subtrees.\n\t *\n\t * Default: `false`\n\t *\n\t * @param trackState - An optimization for tracking state of objects across summaries. If the state\n\t * of an object did not change since last successful summary, an\n\t * {@link @fluidframework/protocol-definitions#ISummaryHandle} can be used\n\t * instead of re-summarizing it. If this is `false`, the expectation is that you should never\n\t * send an `ISummaryHandle`, since you are not expected to track state.\n\t *\n\t * Note: The goal is to remove the trackState and automatically decided whether the\n\t * handles will be used or not: {@link https://github.com/microsoft/FluidFramework/issues/10455}\n\t *\n\t * Default: `false`\n\t *\n\t * @param telemetryContext - See {@link @fluidframework/runtime-definitions#ITelemetryContext}.\n\t *\n\t * @returns A summary capturing the current state of the channel.\n\t */\n\tgetAttachSummary(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): ISummaryTreeWithStats;\n\n\t/**\n\t * Generates summary of the channel asynchronously.\n\t * This should not be called where the channel can be modified while summarization is in progress.\n\t *\n\t * @param fullTree - flag indicating whether the attempt should generate a full\n\t * summary tree without any handles for unchanged subtrees. It should only be set to true when generating\n\t * a summary from the entire container.\n\t *\n\t * Default: `false`\n\t *\n\t * @param trackState - An optimization for tracking state of objects across summaries. If the state\n\t * of an object did not change since last successful summary, an\n\t * {@link @fluidframework/protocol-definitions#ISummaryHandle} can be used\n\t * instead of re-summarizing it. If this is `false`, the expectation is that you should never\n\t * send an `ISummaryHandle`, since you are not expected to track state.\n\t *\n\t * Default: `false`\n\t *\n\t * Note: The goal is to remove the trackState and automatically decided whether the\n\t * handles will be used or not: {@link https://github.com/microsoft/FluidFramework/issues/10455}\n\t *\n\t * @param telemetryContext - See {@link @fluidframework/runtime-definitions#ITelemetryContext}.\n\t *\n\t * @returns A summary capturing the current state of the channel.\n\t */\n\tsummarize(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext,\n\t): Promise<ISummaryTreeWithStats>;\n\n\t/**\n\t * Checks if the channel is attached to storage.\n\t * @returns True iff the channel is attached.\n\t */\n\tisAttached(): boolean;\n\n\t/**\n\t * Enables the channel to send and receive ops.\n\t * @param services - The services to connect to.\n\t */\n\tconnect(services: IChannelServices): void;\n\n\t/**\n\t * Returns the GC data for this channel. It contains a list of GC nodes that contains references to\n\t * other GC nodes.\n\t * @param fullGC - true to bypass optimizations and force full generation of GC data.\n\t */\n\tgetGCData(fullGC?: boolean): IGarbageCollectionData;\n}\n\n/**\n * Handler provided by shared data structure to process requests from the runtime.\n * @public\n */\nexport interface IDeltaHandler {\n\t/**\n\t * Processes the op.\n\t * @param message - The message to process\n\t * @param local - Whether the message originated from the local client\n\t * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n\t * For messages from a remote client, this will be undefined.\n\t */\n\tprocess: (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => void;\n\n\t/**\n\t * State change events to indicate changes to the delta connection\n\t * @param connected - true if connected, false otherwise\n\t */\n\tsetConnectionState(connected: boolean): void;\n\n\t/**\n\t * Called when the runtime asks the client to resubmit an op. This may be because the Container reconnected and\n\t * this op was not acked.\n\t * The client can choose to resubmit the same message, submit different / multiple messages or not submit anything\n\t * at all.\n\t * @param message - The original message that was submitted.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\treSubmit(message: any, localOpMetadata: unknown): void;\n\n\t/**\n\t * Apply changes from an op. Used when rehydrating an attached container\n\t * with pending changes. This prepares the SharedObject for seeing an ACK\n\t * for the op or resubmitting the op upon reconnection.\n\t * @param message - Contents of a stashed op.\n\t * @returns localMetadata of the op, to be passed to process() or resubmit()\n\t * when the op is ACKed or resubmitted, respectively\n\t */\n\tapplyStashedOp(message: any): unknown;\n\n\t/**\n\t * Revert a local op.\n\t * @param message - The original message that was submitted.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\trollback?(message: any, localOpMetadata: unknown): void;\n}\n\n/**\n * Interface to represent a connection to a delta notification stream.\n * @public\n */\nexport interface IDeltaConnection {\n\tconnected: boolean;\n\n\t/**\n\t * Send new messages to the server.\n\t * @param messageContent - The content of the message to be sent.\n\t * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime\n\t * and not sent to the server. It will be provided back when this message is acknowledged by the server. It will\n\t * also be provided back when asked to resubmit the message.\n\t */\n\tsubmit(messageContent: any, localOpMetadata: unknown): void;\n\n\t/**\n\t * Attaches a message handler to the delta connection\n\t */\n\tattach(handler: IDeltaHandler): void;\n\n\t/**\n\t * Indicates that the channel is dirty and needs to be part of the summary. It is called by a SharedSummaryBlock\n\t * that needs to be part of the summary but does not generate ops.\n\t */\n\tdirty(): void;\n\n\t/**\n\t * Called when a new outbound reference is added to another node. This is used by garbage collection to identify\n\t * all references added in the system.\n\t * @param srcHandle - The handle of the node that added the reference.\n\t * @param outboundHandle - The handle of the outbound node that is referenced.\n\t */\n\taddedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;\n}\n\n/**\n * Storage services to read the objects at a given path.\n * @public\n */\nexport interface IChannelStorageService {\n\t/**\n\t * Reads the object contained at the given path. Returns a buffer representation for the object.\n\t */\n\treadBlob(path: string): Promise<ArrayBufferLike>;\n\n\t/**\n\t * Determines if there is an object contained at the given path.\n\t */\n\tcontains(path: string): Promise<boolean>;\n\n\t/**\n\t * Lists the blobs that exist at a specific path.\n\t */\n\tlist(path: string): Promise<string[]>;\n}\n\n/**\n * Storage services to read the objects at a given path using the given delta connection.\n * @public\n */\nexport interface IChannelServices {\n\tdeltaConnection: IDeltaConnection;\n\n\tobjectStorage: IChannelStorageService;\n}\n\n/**\n * Definitions of a channel factory.\n *\n * @remarks\n *\n * The runtime must be able to produce \"channels\" of the correct in-memory object type for the collaborative session.\n * Here \"channels\" are typically distributed data structures (DDSs).\n *\n * The runtime will consult with a registry of such factories during\n * {@link https://fluidframework.com/docs/build/containers/ | Container} load and when receiving \"attach\" operations\n * (ops), which indicate a new instance of a channel being introduced to the collaboration session, to produce the\n * appropriate in-memory object.\n *\n * Factories follow a common model but enable custom behavior.\n *\n * @example\n *\n * If a collaboration includes a {@link https://fluidframework.com/docs/data-structures/map/ | SharedMap},\n * the collaborating clients will need to have access to a factory that can produce the `SharedMap` object.\n * @public\n */\nexport interface IChannelFactory {\n\t/**\n\t * String representing the type of the factory.\n\t */\n\treadonly type: string;\n\n\t/**\n\t * Attributes of the channel.\n\t */\n\treadonly attributes: IChannelAttributes;\n\n\t/**\n\t * Loads the given channel. This call is only ever invoked internally as the only thing\n\t * that is ever directly loaded is the document itself. Load will then only be called on documents that\n\t * were created and added to a channel.\n\t * @param runtime - Data store runtime containing state/info/helper methods about the data store.\n\t * @param id - ID of the channel.\n\t * @param services - Services to read objects at a given path using the delta connection.\n\t * @param channelAttributes - The attributes for the the channel to be loaded.\n\t * @returns The loaded object\n\t *\n\t * @privateRemarks\n\t * Thought: should the storage object include the version information and limit access to just files\n\t * for the given object? The latter seems good in general. But both are probably good things. We then just\n\t * need a way to allow the document to provide later storage for the object.\n\t */\n\tload(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tchannelAttributes: Readonly<IChannelAttributes>,\n\t): Promise<IChannel>;\n\n\t/**\n\t * Creates a local version of the channel.\n\t * Calling attach on the object later will insert it into the object stream.\n\t * @param runtime - The runtime the new object will be associated with\n\t * @param id - The unique ID of the new object\n\t * @returns The newly created object.\n\t *\n\t * @privateRemarks\n\t * NOTE here - When we attach we need to submit all the pending ops prior to actually doing the attach\n\t * for consistency.\n\t */\n\tcreate(runtime: IFluidDataStoreRuntime, id: string): IChannel;\n}\n"]}

package/dist/dataStoreRuntime.d.ts

@@ -2,12 +2,16 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from "@fluidframework/common-definitions";
-import { IFluidHandleContext, IFluidRouter, IFluidHandle } from "@fluidframework/core-interfaces";
+import { IEvent, IEventProvider, ITelemetryLogger, IDisposable, IFluidHandleContext, IFluidHandle, FluidObject } from "@fluidframework/core-interfaces";
 import { IAudience, IDeltaManager, AttachState, ILoaderOptions } from "@fluidframework/container-definitions";
 import { IDocumentMessage, IQuorumClients, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
-import { IInboundSignalMessage, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions";
-import { IChannel } from ".";
+import { IInboundSignalMessage } from "@fluidframework/runtime-definitions";
+import { IIdCompressor } from "@fluidframework/id-compressor";
+import { IChannel } from "./channel";
+/**
+ * Events emitted by {@link IFluidDataStoreRuntime}.
+ * @public
+ */
 export interface IFluidDataStoreRuntimeEvents extends IEvent {
     (event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
     (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
@@ -16,8 +20,9 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
 }
 /**
  * Represents the runtime for the data store. Contains helper functions/state of the data store.
+ * @public
  */
-export interface IFluidDataStoreRuntime extends IFluidRouter, IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable, Partial<IProvideFluidDataStoreRegistry> {
+export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
     readonly id: string;
     readonly IFluidHandleContext: IFluidHandleContext;
     readonly rootRoutingContext: IFluidHandleContext;
@@ -32,10 +37,20 @@ export interface IFluidDataStoreRuntime extends IFluidRouter, IEventProvider<IFl
      * Indicates the attachment state of the data store to a host service.
      */
     readonly attachState: AttachState;
+    readonly idCompressor?: IIdCompressor;
     /**
      * Returns the channel with the given id
      */
     getChannel(id: string): Promise<IChannel>;
+    /**
+     * 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;
     /**
      * Creates a new channel of the given type.
      * @param id - ID of the channel to be created.  A unique ID will be generated if left undefined.
@@ -51,13 +66,14 @@ export interface IFluidDataStoreRuntime extends IFluidRouter, IEventProvider<IFl
      * Api to upload a blob of data.
      * @param blob - blob to be uploaded.
      */
-    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
+    uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
     /**
      * Submits the signal to be sent to other clients.
      * @param type - Type of the signal.
      * @param content - Content of the signal.
+     * @param targetClientId - When specified, the signal is only sent to the provided client id.
      */
-    submitSignal(type: string, content: any): void;
+    submitSignal(type: string, content: any, targetClientId?: string): void;
     /**
      * Returns the current quorum.
      */
@@ -70,5 +86,10 @@ export interface IFluidDataStoreRuntime extends IFluidRouter, IEventProvider<IFl
      * Resolves when a local data store is attached.
      */
     waitAttached(): Promise<void>;
+    /**
+     * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting
+     * with it.
+     */
+    readonly entryPoint: IFluidHandle<FluidObject>;
 }
 //# sourceMappingURL=dataStoreRuntime.d.ts.map

package/dist/dataStoreRuntime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3G,OAAO,EACH,mBAAmB,EACnB,YAAY,EACZ,YAAY,EACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,SAAS,EACT,aAAa,EACb,WAAW,EACX,cAAc,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACH,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAC5G,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC;AAE7B,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IACxD,CAEI,KAAK,EAAE,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,EAC5D,QAAQ,EAAE,MAAM,IAAI,OACtB;IACF,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SACpC,YAAY,EACZ,cAAc,CAAC,4BAA4B,CAAC,EAC5C,WAAW,EACX,OAAO,CAAC,8BAA8B,CAAC;IAEvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAEpD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAEjC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAElF,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1E;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC"}
+{"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,MAAM,EACN,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,mBAAmB,EACnB,YAAY,EACZ,WAAW,EACX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACN,SAAS,EACT,aAAa,EACb,WAAW,EACX,cAAc,EACd,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACN,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IACrF,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACtE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;IACtF,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;GAGG;AACH,MAAM,WAAW,sBAChB,SAAQ,cAAc,CAAC,4BAA4B,CAAC,EACnD,WAAW;IACZ,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAElD,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;IACjD,QAAQ,CAAC,sBAAsB,EAAE,mBAAmB,CAAC;IACrD,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC;IAEpD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAEjC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAElF,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,wBAAwB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAElD;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE9D;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAGrC;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAEhG;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExE;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAC/C"}

package/dist/dataStoreRuntime.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreRuntime.js","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    IFluidHandleContext,\n    IFluidRouter,\n    IFluidHandle,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IAudience,\n    IDeltaManager,\n    AttachState,\n    ILoaderOptions,\n} from \"@fluidframework/container-definitions\";\nimport {\n    IDocumentMessage,\n    IQuorumClients,\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IInboundSignalMessage, IProvideFluidDataStoreRegistry } from \"@fluidframework/runtime-definitions\";\nimport { IChannel } from \".\";\n\nexport interface IFluidDataStoreRuntimeEvents extends IEvent {\n    (\n        // eslint-disable-next-line @typescript-eslint/unified-signatures\n        event: \"disconnected\" | \"dispose\" | \"attaching\" | \"attached\",\n        listener: () => void,\n    );\n    (event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n    (event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n    (event: \"connected\", listener: (clientId: string) => void);\n}\n\n/**\n * Represents the runtime for the data store. Contains helper functions/state of the data store.\n */\nexport interface IFluidDataStoreRuntime extends\n    IFluidRouter,\n    IEventProvider<IFluidDataStoreRuntimeEvents>,\n    IDisposable,\n    Partial<IProvideFluidDataStoreRegistry> {\n\n    readonly id: string;\n\n    readonly IFluidHandleContext: IFluidHandleContext;\n\n    readonly rootRoutingContext: IFluidHandleContext;\n    readonly channelsRoutingContext: IFluidHandleContext;\n    readonly objectsRoutingContext: IFluidHandleContext;\n\n    readonly options: ILoaderOptions;\n\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n    readonly clientId: string | undefined;\n\n    readonly connected: boolean;\n\n    readonly logger: ITelemetryLogger;\n\n    /**\n     * Indicates the attachment state of the data store to a host service.\n     */\n    readonly attachState: AttachState;\n\n    /**\n     * Returns the channel with the given id\n     */\n    getChannel(id: string): Promise<IChannel>;\n\n    /**\n     * Creates a new channel of the given type.\n     * @param id - ID of the channel to be created.  A unique ID will be generated if left undefined.\n     * @param type - Type of the channel.\n     */\n    createChannel(id: string | undefined, type: string): IChannel;\n\n    /**\n     * Bind the channel with the data store runtime. If the runtime\n     * is attached then we attach the channel to make it live.\n     */\n    bindChannel(channel: IChannel): void;\n\n    // Blob related calls\n    /**\n     * Api to upload a blob of data.\n     * @param blob - blob to be uploaded.\n     */\n    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n    /**\n     * Submits the signal to be sent to other clients.\n     * @param type - Type of the signal.\n     * @param content - Content of the signal.\n     */\n    submitSignal(type: string, content: any): void;\n\n    /**\n     * Returns the current quorum.\n     */\n    getQuorum(): IQuorumClients;\n\n    /**\n     * Returns the current audience.\n     */\n    getAudience(): IAudience;\n\n    /**\n     * Resolves when a local data store is attached.\n     */\n    waitAttached(): Promise<void>;\n}\n"]}
+{"version":3,"file":"dataStoreRuntime.js","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIEvent,\n\tIEventProvider,\n\tITelemetryLogger,\n\tIDisposable,\n\tIFluidHandleContext,\n\tIFluidHandle,\n\tFluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport {\n\tIAudience,\n\tIDeltaManager,\n\tAttachState,\n\tILoaderOptions,\n} from \"@fluidframework/container-definitions\";\nimport {\n\tIDocumentMessage,\n\tIQuorumClients,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { IInboundSignalMessage } from \"@fluidframework/runtime-definitions\";\nimport { IIdCompressor } from \"@fluidframework/id-compressor\";\nimport { IChannel } from \"./channel\";\n\n/**\n * Events emitted by {@link IFluidDataStoreRuntime}.\n * @public\n */\nexport interface IFluidDataStoreRuntimeEvents extends IEvent {\n\t(event: \"disconnected\" | \"dispose\" | \"attaching\" | \"attached\", listener: () => void);\n\t(event: \"op\", listener: (message: ISequencedDocumentMessage) => void);\n\t(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n\t(event: \"connected\", listener: (clientId: string) => void);\n}\n\n/**\n * Represents the runtime for the data store. Contains helper functions/state of the data store.\n * @public\n */\nexport interface IFluidDataStoreRuntime\n\textends IEventProvider<IFluidDataStoreRuntimeEvents>,\n\t\tIDisposable {\n\treadonly id: string;\n\n\treadonly IFluidHandleContext: IFluidHandleContext;\n\n\treadonly rootRoutingContext: IFluidHandleContext;\n\treadonly channelsRoutingContext: IFluidHandleContext;\n\treadonly objectsRoutingContext: IFluidHandleContext;\n\n\treadonly options: ILoaderOptions;\n\n\treadonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\n\treadonly clientId: string | undefined;\n\n\treadonly connected: boolean;\n\n\treadonly logger: ITelemetryLogger;\n\n\t/**\n\t * Indicates the attachment state of the data store to a host service.\n\t */\n\treadonly attachState: AttachState;\n\n\treadonly idCompressor?: IIdCompressor;\n\n\t/**\n\t * Returns the channel with the given id\n\t */\n\tgetChannel(id: string): Promise<IChannel>;\n\n\t/**\n\t * Invokes the given callback and expects that no ops are submitted\n\t * until execution finishes. If an op is submitted, an error will be raised.\n\t *\n\t * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`\n\t *\n\t * @param callback - the callback to be invoked\n\t */\n\tensureNoDataModelChanges<T>(callback: () => T): T;\n\n\t/**\n\t * Creates a new channel of the given type.\n\t * @param id - ID of the channel to be created.  A unique ID will be generated if left undefined.\n\t * @param type - Type of the channel.\n\t */\n\tcreateChannel(id: string | undefined, type: string): IChannel;\n\n\t/**\n\t * Bind the channel with the data store runtime. If the runtime\n\t * is attached then we attach the channel to make it live.\n\t */\n\tbindChannel(channel: IChannel): void;\n\n\t// Blob related calls\n\t/**\n\t * Api to upload a blob of data.\n\t * @param blob - blob to be uploaded.\n\t */\n\tuploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/**\n\t * Submits the signal to be sent to other clients.\n\t * @param type - Type of the signal.\n\t * @param content - Content of the signal.\n\t * @param targetClientId - When specified, the signal is only sent to the provided client id.\n\t */\n\tsubmitSignal(type: string, content: any, targetClientId?: string): void;\n\n\t/**\n\t * Returns the current quorum.\n\t */\n\tgetQuorum(): IQuorumClients;\n\n\t/**\n\t * Returns the current audience.\n\t */\n\tgetAudience(): IAudience;\n\n\t/**\n\t * Resolves when a local data store is attached.\n\t */\n\twaitAttached(): Promise<void>;\n\n\t/**\n\t * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting\n\t * with it.\n\t */\n\treadonly entryPoint: IFluidHandle<FluidObject>;\n}\n"]}

package/dist/datastore-definitions-alpha.d.ts

@@ -0,0 +1,480 @@
+/**
+ * This library defines the interfaces required to implement and/or communicate
+ * with a data store.
+ *
+ * @packageDocumentation
+ */
+
+import { AttachState } from '@fluidframework/container-definitions';
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { IAudience } from '@fluidframework/container-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDisposable } from '@fluidframework/core-interfaces';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IExperimentalIncrementalSummaryContext } from '@fluidframework/runtime-definitions';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidHandleContext } from '@fluidframework/core-interfaces';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { IGarbageCollectionData } from '@fluidframework/runtime-definitions';
+import { IIdCompressor } from '@fluidframework/id-compressor';
+import { IInboundSignalMessage } from '@fluidframework/runtime-definitions';
+import { ILoaderOptions } from '@fluidframework/container-definitions';
+import { IQuorumClients } from '@fluidframework/protocol-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
+import { ITelemetryContext } from '@fluidframework/runtime-definitions';
+import { ITelemetryLogger } from '@fluidframework/core-interfaces';
+
+/**
+ * @public
+ */
+export declare interface IChannel extends IFluidLoadable {
+    /**
+     * A readonly identifier for the channel
+     */
+    readonly id: string;
+    readonly attributes: IChannelAttributes;
+    /**
+     * Generates summary of the channel synchronously. It is called when an `attach message`
+     * for a local channel is generated. In other words, when the channel is being attached
+     * to make it visible to other clients.
+     *
+     * @remarks
+     *
+     * Note: Since the Attach Summary is generated for local channels when making them visible to
+     * remote clients, they don't have any previous summaries to compare against. For this reason,
+     * the attach summary cannot contain summary handles (paths to sub-trees or blobs).
+     * It can, however, contain {@link @fluidframework/protocol-definitions#ISummaryAttachment}
+     * (handles to blobs uploaded async via the blob manager).
+     *
+     * @param fullTree - A flag indicating whether the attempt should generate a full
+     * summary tree without any handles for unchanged subtrees.
+     *
+     * Default: `false`
+     *
+     * @param trackState - An optimization for tracking state of objects across summaries. If the state
+     * of an object did not change since last successful summary, an
+     * {@link @fluidframework/protocol-definitions#ISummaryHandle} can be used
+     * instead of re-summarizing it. If this is `false`, the expectation is that you should never
+     * send an `ISummaryHandle`, since you are not expected to track state.
+     *
+     * Note: The goal is to remove the trackState and automatically decided whether the
+     * handles will be used or not: {@link https://github.com/microsoft/FluidFramework/issues/10455}
+     *
+     * Default: `false`
+     *
+     * @param telemetryContext - See {@link @fluidframework/runtime-definitions#ITelemetryContext}.
+     *
+     * @returns A summary capturing the current state of the channel.
+     */
+    getAttachSummary(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    /**
+     * Generates summary of the channel asynchronously.
+     * This should not be called where the channel can be modified while summarization is in progress.
+     *
+     * @param fullTree - flag indicating whether the attempt should generate a full
+     * summary tree without any handles for unchanged subtrees. It should only be set to true when generating
+     * a summary from the entire container.
+     *
+     * Default: `false`
+     *
+     * @param trackState - An optimization for tracking state of objects across summaries. If the state
+     * of an object did not change since last successful summary, an
+     * {@link @fluidframework/protocol-definitions#ISummaryHandle} can be used
+     * instead of re-summarizing it. If this is `false`, the expectation is that you should never
+     * send an `ISummaryHandle`, since you are not expected to track state.
+     *
+     * Default: `false`
+     *
+     * Note: The goal is to remove the trackState and automatically decided whether the
+     * handles will be used or not: {@link https://github.com/microsoft/FluidFramework/issues/10455}
+     *
+     * @param telemetryContext - See {@link @fluidframework/runtime-definitions#ITelemetryContext}.
+     *
+     * @returns A summary capturing the current state of the channel.
+     */
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): Promise<ISummaryTreeWithStats>;
+    /**
+     * Checks if the channel is attached to storage.
+     * @returns True iff the channel is attached.
+     */
+    isAttached(): boolean;
+    /**
+     * Enables the channel to send and receive ops.
+     * @param services - The services to connect to.
+     */
+    connect(services: IChannelServices): void;
+    /**
+     * Returns the GC data for this channel. 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;
+}
+
+/**
+ * Represents the attributes of a channel/DDS.
+ * @public
+ */
+export declare interface IChannelAttributes {
+    /**
+     * Type name of the DDS for factory look up with ISharedObjectRegistry
+     */
+    readonly type: string;
+    /**
+     * Format version of the snapshot
+     * Currently, only use to display a debug message if the version is incompatible
+     */
+    readonly snapshotFormatVersion: string;
+    /**
+     * The package version of the code of the DDS, for debug only
+     */
+    readonly packageVersion?: string;
+}
+
+/**
+ * Definitions of a channel factory.
+ *
+ * @remarks
+ *
+ * The runtime must be able to produce "channels" of the correct in-memory object type for the collaborative session.
+ * Here "channels" are typically distributed data structures (DDSs).
+ *
+ * The runtime will consult with a registry of such factories during
+ * {@link https://fluidframework.com/docs/build/containers/ | Container} load and when receiving "attach" operations
+ * (ops), which indicate a new instance of a channel being introduced to the collaboration session, to produce the
+ * appropriate in-memory object.
+ *
+ * Factories follow a common model but enable custom behavior.
+ *
+ * @example
+ *
+ * If a collaboration includes a {@link https://fluidframework.com/docs/data-structures/map/ | SharedMap},
+ * the collaborating clients will need to have access to a factory that can produce the `SharedMap` object.
+ * @public
+ */
+export declare interface IChannelFactory {
+    /**
+     * String representing the type of the factory.
+     */
+    readonly type: string;
+    /**
+     * Attributes of the channel.
+     */
+    readonly attributes: IChannelAttributes;
+    /**
+     * Loads the given channel. This call is only ever invoked internally as the only thing
+     * that is ever directly loaded is the document itself. Load will then only be called on documents that
+     * were created and added to a channel.
+     * @param runtime - Data store runtime containing state/info/helper methods about the data store.
+     * @param id - ID of the channel.
+     * @param services - Services to read objects at a given path using the delta connection.
+     * @param channelAttributes - The attributes for the the channel to be loaded.
+     * @returns The loaded object
+     *
+     * @privateRemarks
+     * Thought: should the storage object include the version information and limit access to just files
+     * for the given object? The latter seems good in general. But both are probably good things. We then just
+     * need a way to allow the document to provide later storage for the object.
+     */
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, channelAttributes: Readonly<IChannelAttributes>): Promise<IChannel>;
+    /**
+     * Creates a local version of the channel.
+     * Calling attach on the object later will insert it into the object stream.
+     * @param runtime - The runtime the new object will be associated with
+     * @param id - The unique ID of the new object
+     * @returns The newly created object.
+     *
+     * @privateRemarks
+     * NOTE here - When we attach we need to submit all the pending ops prior to actually doing the attach
+     * for consistency.
+     */
+    create(runtime: IFluidDataStoreRuntime, id: string): IChannel;
+}
+
+/**
+ * Storage services to read the objects at a given path using the given delta connection.
+ * @public
+ */
+export declare interface IChannelServices {
+    deltaConnection: IDeltaConnection;
+    objectStorage: IChannelStorageService;
+}
+
+/**
+ * Storage services to read the objects at a given path.
+ * @public
+ */
+export declare interface IChannelStorageService {
+    /**
+     * Reads the object contained at the given path. Returns a buffer representation for the object.
+     */
+    readBlob(path: string): Promise<ArrayBufferLike>;
+    /**
+     * Determines if there is an object contained at the given path.
+     */
+    contains(path: string): Promise<boolean>;
+    /**
+     * Lists the blobs that exist at a specific path.
+     */
+    list(path: string): Promise<string[]>;
+}
+
+/**
+ * Interface to represent a connection to a delta notification stream.
+ * @public
+ */
+export declare interface IDeltaConnection {
+    connected: boolean;
+    /**
+     * Send new messages to the server.
+     * @param messageContent - The content of the message to be sent.
+     * @param localOpMetadata - The local metadata associated with the message. This is kept locally by the runtime
+     * and not sent to the server. It will be provided back when this message is acknowledged by the server. It will
+     * also be provided back when asked to resubmit the message.
+     */
+    submit(messageContent: any, localOpMetadata: unknown): void;
+    /**
+     * Attaches a message handler to the delta connection
+     */
+    attach(handler: IDeltaHandler): void;
+    /**
+     * Indicates that the channel is dirty and needs to be part of the summary. It is called by a SharedSummaryBlock
+     * that needs to be part of the summary but does not generate ops.
+     */
+    dirty(): 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.
+     */
+    addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;
+}
+
+/**
+ * Handler provided by shared data structure to process requests from the runtime.
+ * @public
+ */
+export declare interface IDeltaHandler {
+    /**
+     * Processes the op.
+     * @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.
+     */
+    process: (message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) => void;
+    /**
+     * State change events to indicate changes to the delta connection
+     * @param connected - true if connected, false otherwise
+     */
+    setConnectionState(connected: boolean): void;
+    /**
+     * Called when the runtime asks the client to resubmit an op. This may be because the Container reconnected and
+     * this op was not acked.
+     * The client can choose to resubmit the same message, submit different / multiple messages or not submit anything
+     * at all.
+     * @param message - The original message that was submitted.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    reSubmit(message: 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 message - 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
+     */
+    applyStashedOp(message: any): unknown;
+    /**
+     * Revert a local op.
+     * @param message - The original message that was submitted.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    rollback?(message: any, localOpMetadata: unknown): void;
+}
+
+/**
+ * Represents the runtime for the data store. Contains helper functions/state of the data store.
+ * @public
+ */
+export declare interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRuntimeEvents>, IDisposable {
+    readonly id: string;
+    readonly IFluidHandleContext: IFluidHandleContext;
+    readonly rootRoutingContext: IFluidHandleContext;
+    readonly channelsRoutingContext: IFluidHandleContext;
+    readonly objectsRoutingContext: IFluidHandleContext;
+    readonly options: ILoaderOptions;
+    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+    readonly clientId: string | undefined;
+    readonly connected: boolean;
+    readonly logger: ITelemetryLogger;
+    /**
+     * Indicates the attachment state of the data store to a host service.
+     */
+    readonly attachState: AttachState;
+    readonly idCompressor?: IIdCompressor;
+    /**
+     * Returns the channel with the given id
+     */
+    getChannel(id: string): Promise<IChannel>;
+    /**
+     * 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;
+    /**
+     * Creates a new channel of the given type.
+     * @param id - ID of the channel to be created.  A unique ID will be generated if left undefined.
+     * @param type - Type of the channel.
+     */
+    createChannel(id: string | undefined, type: string): IChannel;
+    /**
+     * Bind the channel with the data store runtime. If the runtime
+     * is attached then we attach the channel to make it live.
+     */
+    bindChannel(channel: IChannel): void;
+    /**
+     * Api to upload a blob of data.
+     * @param blob - blob to be uploaded.
+     */
+    uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
+    /**
+     * Submits the signal to be sent to other clients.
+     * @param type - Type of the signal.
+     * @param content - Content of the signal.
+     * @param targetClientId - When specified, the signal is only sent to the provided client id.
+     */
+    submitSignal(type: string, content: any, targetClientId?: string): void;
+    /**
+     * Returns the current quorum.
+     */
+    getQuorum(): IQuorumClients;
+    /**
+     * Returns the current audience.
+     */
+    getAudience(): IAudience;
+    /**
+     * Resolves when a local data store is attached.
+     */
+    waitAttached(): Promise<void>;
+    /**
+     * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting
+     * with it.
+     */
+    readonly entryPoint: IFluidHandle<FluidObject>;
+}
+
+/**
+ * Events emitted by {@link IFluidDataStoreRuntime}.
+ * @public
+ */
+export declare interface IFluidDataStoreRuntimeEvents extends IEvent {
+    (event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void): any;
+    (event: "op", listener: (message: ISequencedDocumentMessage) => void): any;
+    (event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;
+    (event: "connected", listener: (clientId: string) => void): any;
+}
+
+/**
+ * @remarks
+ * This type is a kludge and not intended for general use.
+ *
+ * @privateRemarks
+ * Internal type testing for compatibility uses TypeOnly filter which cannot handle recursive "pure" types.
+ * This interface along with ArrayLike above avoids pure type recursion issues, but introduces a limitation on
+ * the ability of {@link Jsonable} to detect array-like types that are not handled naively ({@link JSON.stringify}).
+ * The TypeOnly filter is not useful for {@link JsonableTypeWith}; so, if type testing improves, this can be removed.
+ * @alpha
+ */
+export declare interface Internal_InterfaceOfJsonableTypesWith<T> {
+    [index: string | number]: JsonableTypeWith<T>;
+}
+
+/**
+ * Used to constrain a type `T` to types that are serializable as JSON.
+ * Produces a compile-time error if `T` contains non-Jsonable members.
+ *
+ * @remarks
+ * Note that this does NOT prevent using of values with non-json compatible data,
+ * it only prevents using values with types that include non-json compatible data.
+ * This means that one can, for example, pass in a value typed with json compatible
+ * interface into this function,
+ * that could actually be a class with lots on non-json compatible fields and methods.
+ *
+ * Important: `T extends Jsonable<T>` is incorrect (does not even compile).
+ *
+ * The optional 'TReplaced' parameter may be used to permit additional leaf types to support
+ * situations where a `replacer` is used to handle special values (e.g., `Jsonable<{ x: IFluidHandle }, IFluidHandle>`).
+ *
+ * Note that `Jsonable<T>` does not protect against the following pitfalls when serializing with JSON.stringify():
+ *
+ * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).
+ *
+ * - When `undefined` appears as the root object or as an array element it is coerced to `null`.
+ *
+ * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.
+ *
+ * - prototypes and non-enumerable properties are lost.
+ *
+ * - `ArrayLike` types that are not arrays and are serialized as `{ length: number }`.
+ *
+ * Also, `Jsonable<T>` does not prevent the construction of circular references.
+ *
+ * Using `Jsonable<unknown>` or `Jsonable<any>` is a type alias for
+ * {@link JsonableTypeWith}`<never>` and should not be used if precise type safety is desired.
+ *
+ * @example Typical usage
+ *
+ * ```typescript
+ * function foo<T>(value: Jsonable<T>) { ... }
+ * ```
+ * @alpha
+ */
+export declare type Jsonable<T, TReplaced = never> = boolean extends (T extends never ? true : false) ? JsonableTypeWith<TReplaced> : unknown extends T ? JsonableTypeWith<TReplaced> : T extends undefined | null | boolean | number | string | TReplaced ? T : Extract<T, Function> extends never ? T extends object ? T extends (infer U)[] ? Jsonable<U, TReplaced>[] : {
+    [K in keyof T]: Extract<K, symbol> extends never ? Jsonable<T[K], TReplaced> : never;
+} : never : never;
+
+/**
+ * Type constraint for types that are likely serializable as JSON or have a custom
+ * alternate type.
+ *
+ * @remarks
+ * Use `JsonableTypeWith<never>` for just JSON serializable types.
+ * See {@link Jsonable} for serialization pitfalls.
+ *
+ * @privateRemarks
+ * Perfer using `Jsonable<unknown>` over this type that is an implementation detail.
+ * @alpha
+ */
+export declare type JsonableTypeWith<T> = undefined | null | boolean | number | string | T | Internal_InterfaceOfJsonableTypesWith<T> | ArrayLike<JsonableTypeWith<T>>;
+
+/**
+ * Used to constrain a type 'T' to types that Fluid can intrinsically serialize.  Produces a
+ * compile-time error if `T` contains non-serializable members.
+ *
+ * @remarks
+ * See Jsonable for caveats regarding serialization of `undefined`, non-finite numbers,
+ * and circular references.
+ *
+ * Important: `T extends Serializable<T>` is generally incorrect.
+ * (Any value of `T` extends the serializable subset of itself.)
+ *
+ * @example Typical usage
+ *
+ * ```typescript
+ * function serialize<T>(value: Serializable<T>) { ... }
+ * ```
+ * @alpha
+ */
+export declare type Serializable<T> = Jsonable<T, IFluidHandle>;
+
+export { }