@fluidframework/datastore-definitions 2.0.0-internal.3.0.0 → 2.0.0-internal.3.1.0

package/.eslintrc.js

@@ -4,10 +4,8 @@
  */
 
 module.exports = {
-    "parserOptions": {
-        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
-    },
-    "extends": [
-        "@fluidframework/eslint-config-fluid/minimal", "prettier"
-    ]
-}
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+	extends: ["@fluidframework/eslint-config-fluid/minimal", "prettier"],
+};

package/README.md

@@ -6,13 +6,13 @@ Interface `IFluidDataStoreRuntime` specifies the data store developer API.
 
 _TODO: The full set of functionality is under review_
 
-- DDS creation and management APIs
-- Container info and states (connection state, documentId, quorum, audience, etc.)
-- Loader
-- Op/Signal submission
-- Snapshotting
-- DeltaManager
-- Blob Management API.
+-   DDS creation and management APIs
+-   Container info and states (connection state, documentId, quorum, audience, etc.)
+-   Loader
+-   Op/Signal submission
+-   Snapshotting
+-   DeltaManager
+-   Blob Management API.
 
 ### Signals
 

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "@fluidframework/build-common/api-extractor-common-report.json"
 }

package/dist/channel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACpB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,WAAW,QAAS,SAAQ,cAAc;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CACZ,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB,CAAC;IAEzB;;;;;;;;OAQG;IACH,SAAS,CACL,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CACvD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,KAAK,IAAI,CAAC;IAEhG;;;OAGG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7C;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvD;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC;IAEtC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;OAKG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;CAC1F;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,eAAe,EAAE,gBAAgB,CAAC;IAElC,aAAa,EAAE,sBAAsB,CAAC;CACzC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACA,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,iBAAiB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GAChD,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,QAAQ,CAAC;CACjE"}
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../src/channel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,WAAW,QAAS,SAAQ,cAAc;IAC/C;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CACf,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB,CAAC;IAEzB;;;;;;;;OAQG;IACH,SAAS,CACR,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE1C;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,KAAK,IAAI,CAAC;IAEhG;;;OAGG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7C;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvD;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC;IAEtC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;OAKG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;CACvF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,eAAe,EAAE,gBAAgB,CAAC;IAElC,aAAa,EAAE,sBAAsB,CAAC;CACtC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAExC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACH,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,iBAAiB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GAC7C,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,QAAQ,CAAC;CAC9D"}

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.\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 * @example 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` obect.\n *\n * @remarks 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\tISummaryTreeWithStats,\n\tITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { IChannelAttributes } from \"./storage\";\nimport { IFluidDataStoreRuntime } from \"./dataStoreRuntime\";\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 owner?: 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 * Note: Since 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 ISummaryAttachment (handles to blobs uploaded async via the blob manager).\n\t * @param fullTree - flag indicating whether the attempt should generate a full\n\t * summary tree without any handles for unchanged subtrees.\n\t * @param trackState - optimization for tracking state of objects across summaries. If the state\n\t * of an object did not change since last successful summary, an 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 * Note: The goal is to remove the trackState and automatically decided whether the\n\t * handles will be used or not: https://github.com/microsoft/FluidFramework/issues/10455\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 * @param fullTree - flag indicating whether the attempt should generate a full\n\t * summary tree without any handles for unchanged subtrees. It is only set to true when generating\n\t * a summary from the entire container.\n\t * @param trackState - This tells whether we should track state from this summary.\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): 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 - 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 */\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 */\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 */\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 */\nexport interface IChannelServices {\n\tdeltaConnection: IDeltaConnection;\n\n\tobjectStorage: IChannelStorageService;\n}\n\n/**\n * Definitions of a channel factory.\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 * @example 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` obect.\n *\n * @remarks Factories follow a common model but enable custom behavior.\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.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,EACZ,WAAW,EACd,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,EACH,qBAAqB,EACrB,8BAA8B,EACjC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC;AAE7B,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IACxD,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;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;;;;;;;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,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;IAE9B;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CACnD"}
+{"version":3,"file":"dataStoreRuntime.d.ts","sourceRoot":"","sources":["../src/dataStoreRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,WAAW,EACX,MAAM,EACN,cAAc,EACd,gBAAgB,EAChB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACN,mBAAmB,EACnB,YAAY,EACZ,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,EACN,qBAAqB,EACrB,8BAA8B,EAC9B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC;AAE7B,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;;GAEG;AACH,MAAM,WAAW,sBAChB,SAAQ,YAAY,EACnB,cAAc,CAAC,4BAA4B,CAAC,EAC5C,WAAW,EACX,OAAO,CAAC,8BAA8B,CAAC;IACxC,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;;;;;;;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,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;IAE9B;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAChD"}

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    FluidObject,\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 {\n    IInboundSignalMessage,\n    IProvideFluidDataStoreRegistry,\n} from \"@fluidframework/runtime-definitions\";\nimport { IChannel } from \".\";\n\nexport interface IFluidDataStoreRuntimeEvents extends IEvent {\n    (event: \"disconnected\" | \"dispose\" | \"attaching\" | \"attached\", listener: () => void);\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     * Invokes the given callback and expects that no ops are submitted\n     * until execution finishes. If an op is submitted, an error will be raised.\n     *\n     * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`\n     *\n     * @param callback - the callback to be invoked\n     */\n    ensureNoDataModelChanges<T>(callback: () => T): T;\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    /**\n     * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting\n     * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a\n     * particular scenario) fall back to the current approach of requesting the root object through the request pattern.\n     *\n     * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property\n     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access\n     * the data store's entryPoint.\n     */\n    readonly entryPoint?: IFluidHandle<FluidObject>;\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\tIDisposable,\n\tIEvent,\n\tIEventProvider,\n\tITelemetryLogger,\n} from \"@fluidframework/common-definitions\";\nimport {\n\tIFluidHandleContext,\n\tIFluidRouter,\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 {\n\tIInboundSignalMessage,\n\tIProvideFluidDataStoreRegistry,\n} from \"@fluidframework/runtime-definitions\";\nimport { IChannel } from \".\";\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 */\nexport interface IFluidDataStoreRuntime\n\textends IFluidRouter,\n\t\tIEventProvider<IFluidDataStoreRuntimeEvents>,\n\t\tIDisposable,\n\t\tPartial<IProvideFluidDataStoreRegistry> {\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\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): 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 */\n\tsubmitSignal(type: string, content: any): 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. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a\n\t * particular scenario) fall back to the current approach of requesting the root object through the request pattern.\n\t *\n\t * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property\n\t * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access\n\t * the data store's entryPoint.\n\t */\n\treadonly entryPoint?: IFluidHandle<FluidObject>;\n}\n"]}

package/dist/index.d.ts

@@ -3,11 +3,11 @@
  * Licensed under the MIT License.
  */
 /**
-* This library defines the interfaces required to implement and/or communicate
-* with a data store.
-*
-* @packageDocumentation
-*/
+ * This library defines the interfaces required to implement and/or communicate
+ * with a data store.
+ *
+ * @packageDocumentation
+ */
 export { IChannel, IChannelFactory, IChannelServices, IChannelStorageService, IDeltaConnection, IDeltaHandler, } from "./channel";
 export { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents } from "./dataStoreRuntime";
 export { Jsonable } from "./jsonable";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;EAKE;AAEF,OAAO,EACN,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,OAAO,EACN,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,GACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,sBAAsB,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAC1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n* This library defines the interfaces required to implement and/or communicate\n* with a data store.\n*\n* @packageDocumentation\n*/\n\nexport {\n\tIChannel,\n\tIChannelFactory,\n\tIChannelServices,\n\tIChannelStorageService,\n\tIDeltaConnection,\n\tIDeltaHandler,\n} from \"./channel\";\nexport { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents } from \"./dataStoreRuntime\";\nexport { Jsonable } from \"./jsonable\";\nexport { Serializable } from \"./serializable\";\nexport { IChannelAttributes } from \"./storage\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This library defines the interfaces required to implement and/or communicate\n * with a data store.\n *\n * @packageDocumentation\n */\n\nexport {\n\tIChannel,\n\tIChannelFactory,\n\tIChannelServices,\n\tIChannelStorageService,\n\tIDeltaConnection,\n\tIDeltaHandler,\n} from \"./channel\";\nexport { IFluidDataStoreRuntime, IFluidDataStoreRuntimeEvents } from \"./dataStoreRuntime\";\nexport { Jsonable } from \"./jsonable\";\nexport { Serializable } from \"./serializable\";\nexport { IChannelAttributes } from \"./storage\";\n"]}

package/dist/jsonable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jsonable.d.ts","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,oBAAY,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,SAAS,GAAG,IAAI,IAC1C,CAAC,SAAS,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAC5D,CAAC,GAED,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,KAAK,GAC9B;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,KAAK,GAC1C,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GACzB,KAAK;CACd,GACC,KAAK,CAAC"}
+{"version":3,"file":"jsonable.d.ts","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,oBAAY,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,SAAS,GAAG,IAAI,IAAI,CAAC,SAChD,SAAS,GACT,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,SAAS,GACT,CAAC,GAEH,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,KAAK,GAChC;KACC,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,KAAK;CACnF,GACD,KAAK,CAAC"}

package/dist/jsonable.js.map

@@ -1 +1 @@
-{"version":3,"file":"jsonable.js","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Used to constrain a type `T` to types that are serializable as JSON.\n * Produces a compile-time error if `T` contains non-Jsonable members.\n *\n * @remarks\n * Note that this does NOT prevent using of values with non-json compatible data,\n * it only prevents using values with types that include non-json compatible data.\n * This means that one can, for example, pass an a value typed with json compatible\n * interface into this function,\n * that could actually be a class with lots on non-json compatible fields and methods.\n *\n * Important: `T extends Jsonable<T>` is incorrect (does not even compile).\n * `T extends Jsonable` is also incorrect since `Jsonable` is just `any` and thus applies no constraint at all.\n *\n * The optional 'TReplaced' parameter may be used to permit additional leaf types to support\n * situations where a `replacer` is used to handle special values (e.g., `Jsonable<{ x: IFluidHandle }, IFluidHandle>`).\n *\n * Note that `Jsonable<T>` does not protect against the following pitfalls when serializing with JSON.stringify():\n *\n * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).\n *\n * - When `undefined` appears as the root object or as an array element it is coerced to `null`.\n *\n * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.\n *\n * - prototypes and non-enumerable properties are lost.\n *\n * Also, `Jsonable<T>` does not prevent the construction of circular references.\n *\n * Using `Jsonable` (with no type parameters) or `Jsonable<any>` is just a type alias for `any`\n * and should not be used if type safety is desired.\n *\n * @example\n * Typical usage:\n * ```ts\n *      function foo<T>(value: Jsonable<T>) { ... }\n * ```\n */\nexport type Jsonable<T = any, TReplaced = void> =\n    T extends undefined | null | boolean | number | string | TReplaced\n        ? T\n        // eslint-disable-next-line @typescript-eslint/ban-types\n        : Extract<T, Function> extends never\n            ? {\n                [K in keyof T]: Extract<K, symbol> extends never\n                    ? Jsonable<T[K], TReplaced>\n                    : never\n            }\n            : never;\n"]}
+{"version":3,"file":"jsonable.js","sourceRoot":"","sources":["../src/jsonable.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Used to constrain a type `T` to types that are serializable as JSON.\n * Produces a compile-time error if `T` contains non-Jsonable members.\n *\n * @remarks\n * Note that this does NOT prevent using of values with non-json compatible data,\n * it only prevents using values with types that include non-json compatible data.\n * This means that one can, for example, pass an a value typed with json compatible\n * interface into this function,\n * that could actually be a class with lots on non-json compatible fields and methods.\n *\n * Important: `T extends Jsonable<T>` is incorrect (does not even compile).\n * `T extends Jsonable` is also incorrect since `Jsonable` is just `any` and thus applies no constraint at all.\n *\n * The optional 'TReplaced' parameter may be used to permit additional leaf types to support\n * situations where a `replacer` is used to handle special values (e.g., `Jsonable<{ x: IFluidHandle }, IFluidHandle>`).\n *\n * Note that `Jsonable<T>` does not protect against the following pitfalls when serializing with JSON.stringify():\n *\n * - `undefined` properties on objects are omitted (i.e., properties become undefined instead of equal to undefined).\n *\n * - When `undefined` appears as the root object or as an array element it is coerced to `null`.\n *\n * - Non-finite numbers (`NaN`, `+/-Infinity`) are also coerced to `null`.\n *\n * - prototypes and non-enumerable properties are lost.\n *\n * Also, `Jsonable<T>` does not prevent the construction of circular references.\n *\n * Using `Jsonable` (with no type parameters) or `Jsonable<any>` is just a type alias for `any`\n * and should not be used if type safety is desired.\n *\n * @example\n * Typical usage:\n * ```ts\n *      function foo<T>(value: Jsonable<T>) { ... }\n * ```\n */\nexport type Jsonable<T = any, TReplaced = void> = T extends\n\t| undefined\n\t| null\n\t| boolean\n\t| number\n\t| string\n\t| TReplaced\n\t? T\n\t: // eslint-disable-next-line @typescript-eslint/ban-types\n\tExtract<T, Function> extends never\n\t? {\n\t\t\t[K in keyof T]: Extract<K, symbol> extends never ? Jsonable<T[K], TReplaced> : never;\n\t  }\n\t: never;\n"]}

package/dist/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CACpC"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CACjC"}

package/dist/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Represents the attributes of a channel/DDS.\n */\nexport interface IChannelAttributes {\n    /**\n     * Type name of the DDS for factory look up with ISharedObjectRegistry\n     */\n    readonly type: string;\n\n    /**\n     * Format version of the snapshot\n     * Currently, only use to display a debug message if the version is incompatible\n     */\n    readonly snapshotFormatVersion: string;\n\n    /**\n     * The package version of the code of the DDS, for debug only\n     */\n    readonly packageVersion?: string;\n}\n"]}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Represents the attributes of a channel/DDS.\n */\nexport interface IChannelAttributes {\n\t/**\n\t * Type name of the DDS for factory look up with ISharedObjectRegistry\n\t */\n\treadonly type: string;\n\n\t/**\n\t * Format version of the snapshot\n\t * Currently, only use to display a debug message if the version is incompatible\n\t */\n\treadonly snapshotFormatVersion: string;\n\n\t/**\n\t * The package version of the code of the DDS, for debug only\n\t */\n\treadonly packageVersion?: string;\n}\n"]}

package/package.json

@@ -1,69 +1,66 @@
 {
-  "name": "@fluidframework/datastore-definitions",
-  "version": "2.0.0-internal.3.0.0",
-  "description": "Fluid data store definitions",
-  "homepage": "https://fluidframework.com",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/microsoft/FluidFramework.git",
-    "directory": "packages/runtime/datastore-definitions"
-  },
-  "license": "MIT",
-  "author": "Microsoft and contributors",
-  "sideEffects": false,
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:compile": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "npm run prettier:fix",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
-    "tsc": "tsc",
-    "typetests:gen": "flub generate typetests --generate --dir .",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-  },
-  "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.3.0.0 <2.0.0-internal.4.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.3.0.0 <2.0.0-internal.4.0.0",
-    "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.3.0.0 <2.0.0-internal.4.0.0"
-  },
-  "devDependencies": {
-    "@fluid-tools/build-cli": "^0.8.0",
-    "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.8.0",
-    "@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.0.0-internal.2.2.0",
-    "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.4.1",
-    "eslint": "~8.6.0",
-    "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
-    "typescript": "~4.5.5"
-  },
-  "typeValidation": {
-    "version": "2.0.0-internal.3.0.0",
-    "baselineRange": ">=2.0.0-internal.2.0.0 <2.0.0-internal.3.0.0",
-    "baselineVersion": "2.0.0-internal.2.1.1",
-    "broken": {
-      "InterfaceDeclaration_IFluidDataStoreRuntime": {
-        "forwardCompat": false
-      }
-    }
-  }
+	"name": "@fluidframework/datastore-definitions",
+	"version": "2.0.0-internal.3.1.0",
+	"description": "Fluid data store definitions",
+	"homepage": "https://fluidframework.com",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/microsoft/FluidFramework.git",
+		"directory": "packages/runtime/datastore-definitions"
+	},
+	"license": "MIT",
+	"author": "Microsoft and contributors",
+	"sideEffects": false,
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"scripts": {
+		"build": "concurrently npm:build:compile npm:lint && npm run build:docs",
+		"build:compile": "npm run tsc && npm run typetests:gen && npm run build:test",
+		"build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+		"build:full": "npm run build",
+		"build:full:compile": "npm run build:compile",
+		"build:test": "tsc --project ./src/test/tsconfig.json",
+		"ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+		"clean": "rimraf dist *.tsbuildinfo *.build.log",
+		"eslint": "eslint --format stylish src",
+		"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+		"format": "npm run prettier:fix",
+		"lint": "npm run prettier && npm run eslint",
+		"lint:fix": "npm run prettier:fix && npm run eslint:fix",
+		"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
+		"prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+		"tsc": "tsc",
+		"typetests:gen": "flub generate typetests --generate --dir .",
+		"typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+	},
+	"dependencies": {
+		"@fluidframework/common-definitions": "^0.20.1",
+		"@fluidframework/common-utils": "^1.0.0",
+		"@fluidframework/container-definitions": ">=2.0.0-internal.3.1.0 <2.0.0-internal.4.0.0",
+		"@fluidframework/core-interfaces": ">=2.0.0-internal.3.1.0 <2.0.0-internal.4.0.0",
+		"@fluidframework/protocol-definitions": "^1.1.0",
+		"@fluidframework/runtime-definitions": ">=2.0.0-internal.3.1.0 <2.0.0-internal.4.0.0"
+	},
+	"devDependencies": {
+		"@fluid-tools/build-cli": "^0.9.0",
+		"@fluidframework/build-common": "^1.1.0",
+		"@fluidframework/build-tools": "^0.9.0",
+		"@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.0.0-internal.3.0.0",
+		"@fluidframework/eslint-config-fluid": "^2.0.0",
+		"@microsoft/api-extractor": "^7.22.2",
+		"@rushstack/eslint-config": "^2.5.1",
+		"concurrently": "^6.2.0",
+		"copyfiles": "^2.4.1",
+		"eslint": "~8.6.0",
+		"prettier": "~2.6.2",
+		"rimraf": "^2.6.2",
+		"typescript": "~4.5.5"
+	},
+	"typeValidation": {
+		"version": "2.0.0-internal.3.1.0",
+		"previousVersionStyle": "~previousMinor",
+		"baselineRange": ">=2.0.0-internal.3.0.0 <2.0.0-internal.3.1.0",
+		"baselineVersion": "2.0.0-internal.3.0.0",
+		"broken": {}
+	}
 }

package/prettier.config.cjs

@@ -4,5 +4,5 @@
  */
 
 module.exports = {
-    ...require("@fluidframework/build-common/prettier.config.cjs"),
+	...require("@fluidframework/build-common/prettier.config.cjs"),
 };

package/src/channel.ts

@@ -6,191 +6,191 @@
 import { IFluidHandle, IFluidLoadable } from "@fluidframework/core-interfaces";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import {
-    IGarbageCollectionData,
-    ISummaryTreeWithStats,
-    ITelemetryContext,
+	IGarbageCollectionData,
+	ISummaryTreeWithStats,
+	ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
 import { IChannelAttributes } from "./storage";
 import { IFluidDataStoreRuntime } from "./dataStoreRuntime";
 
 export interface IChannel extends IFluidLoadable {
-    /**
-     * A readonly identifier for the channel
-     */
-    readonly id: string;
+	/**
+	 * A readonly identifier for the channel
+	 */
+	readonly id: string;
 
-    readonly owner?: string;
+	readonly owner?: string;
 
-    readonly attributes: IChannelAttributes;
+	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.
-     * Note: Since 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 ISummaryAttachment (handles to blobs uploaded async via the blob manager).
-     * @param fullTree - flag indicating whether the attempt should generate a full
-     * summary tree without any handles for unchanged subtrees.
-     * @param trackState - optimization for tracking state of objects across summaries. If the state
-     * of an object did not change since last successful summary, an 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: https://github.com/microsoft/FluidFramework/issues/10455
-     * @returns A summary capturing the current state of the channel.
-     */
-    getAttachSummary(
-        fullTree?: boolean,
-        trackState?: boolean,
-        telemetryContext?: ITelemetryContext,
-    ): ISummaryTreeWithStats;
+	/**
+	 * 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.
+	 * Note: Since 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 ISummaryAttachment (handles to blobs uploaded async via the blob manager).
+	 * @param fullTree - flag indicating whether the attempt should generate a full
+	 * summary tree without any handles for unchanged subtrees.
+	 * @param trackState - optimization for tracking state of objects across summaries. If the state
+	 * of an object did not change since last successful summary, an 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: https://github.com/microsoft/FluidFramework/issues/10455
+	 * @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 is only set to true when generating
-     * a summary from the entire container.
-     * @param trackState - This tells whether we should track state from this summary.
-     * @returns A summary capturing the current state of the channel.
-     */
-    summarize(
-        fullTree?: boolean,
-        trackState?: boolean,
-        telemetryContext?: ITelemetryContext,
-    ): Promise<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 is only set to true when generating
+	 * a summary from the entire container.
+	 * @param trackState - This tells whether we should track state from this summary.
+	 * @returns A summary capturing the current state of the channel.
+	 */
+	summarize(
+		fullTree?: boolean,
+		trackState?: boolean,
+		telemetryContext?: ITelemetryContext,
+	): Promise<ISummaryTreeWithStats>;
 
-    /**
-     * Checks if the channel is attached to storage.
-     * @returns True iff the channel is attached.
-     */
-    isAttached(): boolean;
+	/**
+	 * 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 - Services to connect to
-     */
-    connect(services: IChannelServices): void;
+	/**
+	 * Enables the channel to send and receive ops.
+	 * @param services - 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;
+	/**
+	 * 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;
 }
 
 /**
  * Handler provided by shared data structure to process requests from the runtime.
  */
 export 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;
+	/**
+	 * 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;
+	/**
+	 * 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;
+	/**
+	 * 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;
+	/**
+	 * 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;
+	/**
+	 * 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;
 }
 
 /**
  * Interface to represent a connection to a delta notification stream.
  */
 export interface IDeltaConnection {
-    connected: boolean;
+	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;
+	/**
+	 * 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;
+	/**
+	 * 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;
+	/**
+	 * 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;
+	/**
+	 * 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;
 }
 
 /**
  * Storage services to read the objects at a given path.
  */
 export interface IChannelStorageService {
-    /**
-     * Reads the object contained at the given path. Returns a buffer representation for the object.
-     */
-    readBlob(path: string): Promise<ArrayBufferLike>;
+	/**
+	 * 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>;
+	/**
+	 * 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[]>;
+	/**
+	 * Lists the blobs that exist at a specific path.
+	 */
+	list(path: string): Promise<string[]>;
 }
 
 /**
  * Storage services to read the objects at a given path using the given delta connection.
  */
 export interface IChannelServices {
-    deltaConnection: IDeltaConnection;
+	deltaConnection: IDeltaConnection;
 
-    objectStorage: IChannelStorageService;
+	objectStorage: IChannelStorageService;
 }
 
 /**
@@ -210,48 +210,48 @@ export interface IChannelServices {
  * @remarks Factories follow a common model but enable custom behavior.
  */
 export interface IChannelFactory {
-    /**
-     * String representing the type of the factory.
-     */
-    readonly type: string;
+	/**
+	 * String representing the type of the factory.
+	 */
+	readonly type: string;
 
-    /**
-     * Attributes of the channel.
-     */
-    readonly attributes: IChannelAttributes;
+	/**
+	 * 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>;
+	/**
+	 * 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;
+	/**
+	 * 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;
 }

package/src/dataStoreRuntime.ts

@@ -3,134 +3,138 @@
  * Licensed under the MIT License.
  */
 
-import { IDisposable, IEvent, IEventProvider, ITelemetryLogger } from "@fluidframework/common-definitions";
 import {
-    IFluidHandleContext,
-    IFluidRouter,
-    IFluidHandle,
-    FluidObject,
+	IDisposable,
+	IEvent,
+	IEventProvider,
+	ITelemetryLogger,
+} from "@fluidframework/common-definitions";
+import {
+	IFluidHandleContext,
+	IFluidRouter,
+	IFluidHandle,
+	FluidObject,
 } from "@fluidframework/core-interfaces";
 import {
-    IAudience,
-    IDeltaManager,
-    AttachState,
-    ILoaderOptions,
+	IAudience,
+	IDeltaManager,
+	AttachState,
+	ILoaderOptions,
 } from "@fluidframework/container-definitions";
 import {
-    IDocumentMessage,
-    IQuorumClients,
-    ISequencedDocumentMessage,
+	IDocumentMessage,
+	IQuorumClients,
+	ISequencedDocumentMessage,
 } from "@fluidframework/protocol-definitions";
 import {
-    IInboundSignalMessage,
-    IProvideFluidDataStoreRegistry,
+	IInboundSignalMessage,
+	IProvideFluidDataStoreRegistry,
 } from "@fluidframework/runtime-definitions";
 import { IChannel } from ".";
 
 export interface IFluidDataStoreRuntimeEvents extends IEvent {
-    (event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void);
-    (event: "op", listener: (message: ISequencedDocumentMessage) => void);
-    (event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void);
-    (event: "connected", listener: (clientId: string) => void);
+	(event: "disconnected" | "dispose" | "attaching" | "attached", listener: () => void);
+	(event: "op", listener: (message: ISequencedDocumentMessage) => void);
+	(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void);
+	(event: "connected", listener: (clientId: string) => void);
 }
 
 /**
  * Represents the runtime for the data store. Contains helper functions/state of the data store.
  */
-export interface IFluidDataStoreRuntime extends
-    IFluidRouter,
-    IEventProvider<IFluidDataStoreRuntimeEvents>,
-    IDisposable,
-    Partial<IProvideFluidDataStoreRegistry> {
-
-    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;
-
-    /**
-     * 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;
-
-    // Blob related calls
-    /**
-     * Api to upload a blob of data.
-     * @param blob - blob to be uploaded.
-     */
-    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
-
-    /**
-     * Submits the signal to be sent to other clients.
-     * @param type - Type of the signal.
-     * @param content - Content of the signal.
-     */
-    submitSignal(type: string, content: any): 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. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a
-     * particular scenario) fall back to the current approach of requesting the root object through the request pattern.
-     *
-     * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property
-     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
-     * the data store's entryPoint.
-     */
-    readonly entryPoint?: IFluidHandle<FluidObject>;
+export interface IFluidDataStoreRuntime
+	extends IFluidRouter,
+		IEventProvider<IFluidDataStoreRuntimeEvents>,
+		IDisposable,
+		Partial<IProvideFluidDataStoreRegistry> {
+	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;
+
+	/**
+	 * 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;
+
+	// Blob related calls
+	/**
+	 * Api to upload a blob of data.
+	 * @param blob - blob to be uploaded.
+	 */
+	uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
+
+	/**
+	 * Submits the signal to be sent to other clients.
+	 * @param type - Type of the signal.
+	 * @param content - Content of the signal.
+	 */
+	submitSignal(type: string, content: any): 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. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a
+	 * particular scenario) fall back to the current approach of requesting the root object through the request pattern.
+	 *
+	 * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property
+	 * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
+	 * the data store's entryPoint.
+	 */
+	readonly entryPoint?: IFluidHandle<FluidObject>;
 }

package/src/index.ts

@@ -4,11 +4,11 @@
  */
 
 /**
-* This library defines the interfaces required to implement and/or communicate
-* with a data store.
-*
-* @packageDocumentation
-*/
+ * This library defines the interfaces required to implement and/or communicate
+ * with a data store.
+ *
+ * @packageDocumentation
+ */
 
 export {
 	IChannel,

package/src/jsonable.ts

@@ -41,14 +41,17 @@
  *      function foo<T>(value: Jsonable<T>) { ... }
  * ```
  */
-export type Jsonable<T = any, TReplaced = void> =
-    T extends undefined | null | boolean | number | string | TReplaced
-        ? T
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        : Extract<T, Function> extends never
-            ? {
-                [K in keyof T]: Extract<K, symbol> extends never
-                    ? Jsonable<T[K], TReplaced>
-                    : never
-            }
-            : never;
+export type Jsonable<T = any, TReplaced = void> = T extends
+	| undefined
+	| null
+	| boolean
+	| number
+	| string
+	| TReplaced
+	? T
+	: // eslint-disable-next-line @typescript-eslint/ban-types
+	Extract<T, Function> extends never
+	? {
+			[K in keyof T]: Extract<K, symbol> extends never ? Jsonable<T[K], TReplaced> : never;
+	  }
+	: never;

package/src/storage.ts

@@ -7,19 +7,19 @@
  * Represents the attributes of a channel/DDS.
  */
 export interface IChannelAttributes {
-    /**
-     * Type name of the DDS for factory look up with ISharedObjectRegistry
-     */
-    readonly type: string;
+	/**
+	 * 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;
+	/**
+	 * 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;
+	/**
+	 * The package version of the code of the DDS, for debug only
+	 */
+	readonly packageVersion?: string;
 }

package/tsconfig.json

@@ -1,14 +1,10 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "src/test/**/*"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "composite": true,
-    },
-    "include": [
-        "src/**/*"
-    ]
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"composite": true,
+	},
+	"include": ["src/**/*"],
 }