@fluidframework/container-definitions 1.2.7 → 2.0.0-dev.1.3.0.96595

package/lib/runtime.js

@@ -23,12 +23,5 @@ export var AttachState;
      */
     AttachState["Attached"] = "Attached";
 })(AttachState || (AttachState = {}));
-// Represents the bind state of the entity.
-export var BindState;
-(function (BindState) {
-    BindState["NotBound"] = "NotBound";
-    BindState["Binding"] = "Binding";
-    BindState["Bound"] = "Bound";
-})(BindState || (BindState = {}));
 export const IRuntimeFactory = "IRuntimeFactory";
 //# sourceMappingURL=runtime.js.map

package/lib/runtime.js.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA0BH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACnB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACzB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAED,2CAA2C;AAC3C,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACnB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAwHD,MAAM,CAAC,MAAM,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger, IDisposable } from \"@fluidframework/common-definitions\";\nimport {\n    FluidObject,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    IClientConfiguration,\n    IClientDetails,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n    MessageType,\n    ISummaryTree,\n    IVersion,\n    IDocumentMessage,\n    IQuorumClients,\n} from \"@fluidframework/protocol-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError } from \"./error\";\nimport { ILoader, ILoaderOptions, ISnapshotTreeWithBlobContents } from \"./loader\";\nimport { IFluidCodeDetails } from \"./fluidPackage\";\n\n/**\n * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the\n * service.  The transition from detached to attached state is a one-way transition.\n */\nexport enum AttachState {\n    /**\n     * In detached state, the data is only present on the local client's machine.  It has not yet been uploaded\n     * to the service.\n     */\n    Detached = \"Detached\",\n\n    /**\n     * In attaching state, the data has started the upload to the service, but has not yet completed.\n     */\n    Attaching = \"Attaching\",\n\n    /**\n     * In attached state, the data has completed upload to the service.  It can be accessed by other clients after\n     * reaching attached state.\n     */\n    Attached = \"Attached\",\n}\n\n// Represents the bind state of the entity.\nexport enum BindState {\n    NotBound = \"NotBound\",\n    Binding = \"Binding\",\n    Bound = \"Bound\",\n}\n\n/**\n * The IRuntime represents an instantiation of a code package within a Container.\n * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.\n */\nexport interface IRuntime extends IDisposable {\n\n    /**\n     * Executes a request against the runtime\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Notifies the runtime of a change in the connection state\n     */\n    setConnectionState(connected: boolean, clientId?: string);\n\n    /**\n     * Processes the given op (message)\n     */\n    process(message: ISequencedDocumentMessage, local: boolean, context: any);\n\n    /**\n     * Processes the given signal\n     */\n    processSignal(message: any, local: boolean);\n\n    /**\n     * Create a summary. Used when attaching or serializing a detached container.\n     *\n     * @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n     * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n     * new storage IDs so requests can be redirected.\n     */\n    createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n    /**\n     * Propagate the container state when container is attaching or attached.\n     * @param attachState - State of the container.\n     */\n    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;\n\n    /**\n     * Get pending local state in a serializable format to be given back to a newly loaded container\n     */\n    getPendingLocalState(): unknown;\n\n    /**\n     * Notify runtime that container is moving to \"Attaching\" state\n     * @param snapshot - snapshot created at attach time\n     */\n    notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;\n}\n\n/**\n * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.\n * This allows the Container to terminate the connection to the IRuntime.\n *\n * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,\n * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,\n * and the Container has created a new ContainerContext.\n */\nexport interface IContainerContext extends IDisposable {\n    readonly existing: boolean | undefined;\n    readonly options: ILoaderOptions;\n    readonly clientId: string | undefined;\n    readonly clientDetails: IClientDetails;\n    readonly storage: IDocumentStorageService;\n    readonly connected: boolean;\n    readonly baseSnapshot: ISnapshotTree | undefined;\n    readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n    readonly submitSignalFn: (contents: any) => void;\n    readonly closeFn: (error?: ICriticalContainerError) => void;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    readonly quorum: IQuorumClients;\n    /**\n     * @deprecated This method is provided as a migration tool for customers currently reading the code details\n     * from within the Container by directly accessing the Quorum proposals.  The code details should not be accessed\n     * from within the Container as this requires coupling between the container contents and the code loader.\n     * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this\n     * migration tool will be removed.\n     */\n    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;\n    readonly audience: IAudience | undefined;\n    readonly loader: ILoader;\n    // The logger implementation, which would support tagged events, should be provided by the loader.\n    readonly taggedLogger: ITelemetryBaseLogger;\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n    pendingLocalState?: unknown;\n\n    /**\n     * Ambient services provided with the context\n     */\n    readonly scope: FluidObject;\n\n    /**\n     * Get an absolute url for a provided container-relative request.\n     * @param relativeUrl - A relative request within the container\n     *\n     * TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n     */\n    getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;\n\n    /**\n     * Indicates the attachment state of the container to a host service.\n     */\n    readonly attachState: AttachState;\n\n    getLoadedFromVersion(): IVersion | undefined;\n\n    updateDirtyContainerState(dirty: boolean): void;\n    /**\n     * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption\n     * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers\n     * and scenarios which can change in the future.\n     */\n    readonly id: string;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n    readonly IRuntimeFactory: IRuntimeFactory;\n}\n\n/**\n * Exported module definition\n *\n * Provides the entry point for the ContainerContext to load the proper IRuntime\n * to start up the running instance of the Container.\n */\nexport interface IRuntimeFactory extends IProvideRuntimeFactory {\n    /**\n     * Instantiates a new IRuntime for the given IContainerContext to proxy to\n     * This is the main entry point to the Container's business logic\n     *\n     * @param context - container context to be supplied to the runtime\n     * @param existing - whether to instantiate for the first time or from an existing context\n     */\n    instantiateRuntime(context: IContainerContext, existing?: boolean): Promise<IRuntime>;\n}\n"]}
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2BH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAiBX;AAjBD,WAAY,WAAW;IACnB;;;OAGG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;;OAGG;IACH,oCAAqB,CAAA;AACzB,CAAC,EAjBW,WAAW,KAAX,WAAW,QAiBtB;AAoID,MAAM,CAAC,MAAM,eAAe,GAAiC,iBAAiB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger, IDisposable } from \"@fluidframework/common-definitions\";\nimport {\n    FluidObject,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    IClientConfiguration,\n    IClientDetails,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n    MessageType,\n    ISummaryTree,\n    IVersion,\n    IDocumentMessage,\n    IQuorumClients,\n    ISummaryContent,\n} from \"@fluidframework/protocol-definitions\";\nimport { IAudience } from \"./audience\";\nimport { IDeltaManager } from \"./deltas\";\nimport { ICriticalContainerError } from \"./error\";\nimport { ILoader, ILoaderOptions, ISnapshotTreeWithBlobContents } from \"./loader\";\nimport { IFluidCodeDetails } from \"./fluidPackage\";\n\n/**\n * The attachment state of some Fluid data (e.g. a container or data store), denoting whether it is uploaded to the\n * service.  The transition from detached to attached state is a one-way transition.\n */\nexport enum AttachState {\n    /**\n     * In detached state, the data is only present on the local client's machine.  It has not yet been uploaded\n     * to the service.\n     */\n    Detached = \"Detached\",\n\n    /**\n     * In attaching state, the data has started the upload to the service, but has not yet completed.\n     */\n    Attaching = \"Attaching\",\n\n    /**\n     * In attached state, the data has completed upload to the service.  It can be accessed by other clients after\n     * reaching attached state.\n     */\n    Attached = \"Attached\",\n}\n\n/**\n * The IRuntime represents an instantiation of a code package within a Container.\n * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.\n */\nexport interface IRuntime extends IDisposable {\n\n    /**\n     * Executes a request against the runtime\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Notifies the runtime of a change in the connection state\n     */\n    setConnectionState(connected: boolean, clientId?: string);\n\n    /**\n     * Processes the given op (message)\n     */\n    process(message: ISequencedDocumentMessage, local: boolean, context: any);\n\n    /**\n     * Processes the given signal\n     */\n    processSignal(message: any, local: boolean);\n\n    /**\n     * Create a summary. Used when attaching or serializing a detached container.\n     *\n     * @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported\n     * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the\n     * new storage IDs so requests can be redirected.\n     */\n    createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;\n\n    /**\n     * Propagate the container state when container is attaching or attached.\n     * @param attachState - State of the container.\n     */\n    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;\n\n    /**\n     * Get pending local state in a serializable format to be given back to a newly loaded container\n     */\n    getPendingLocalState(): unknown;\n\n    /**\n     * Notify runtime that container is moving to \"Attaching\" state\n     * @param snapshot - snapshot created at attach time\n     */\n    notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;\n}\n\n/**\n * Payload type for IContainerContext.submitBatchFn()\n */\nexport interface IBatchMessage {\n    contents: string;\n    metadata: Record<string, unknown> | undefined;\n}\n\n/**\n * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.\n * This allows the Container to terminate the connection to the IRuntime.\n *\n * Specifically, there is an event on Container, onContextChanged, which mean a new code proposal has been loaded,\n * so the old IRuntime is no longer valid, as its ContainerContext has been revoked,\n * and the Container has created a new ContainerContext.\n */\nexport interface IContainerContext extends IDisposable {\n    readonly existing: boolean | undefined;\n    readonly options: ILoaderOptions;\n    readonly clientId: string | undefined;\n    readonly clientDetails: IClientDetails;\n    readonly storage: IDocumentStorageService;\n    readonly connected: boolean;\n    readonly baseSnapshot: ISnapshotTree | undefined;\n    /** @deprecated Please use submitBatchFn & submitSummaryFn */\n    readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;\n    /** @returns clientSequenceNumber of last message in a batch */\n    readonly submitBatchFn: (batch: IBatchMessage[]) => number;\n    readonly submitSummaryFn: (summaryOp: ISummaryContent) => number;\n    readonly submitSignalFn: (contents: any) => void;\n    readonly closeFn: (error?: ICriticalContainerError) => void;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    readonly quorum: IQuorumClients;\n    /**\n     * @deprecated This method is provided as a migration tool for customers currently reading the code details\n     * from within the Container by directly accessing the Quorum proposals.  The code details should not be accessed\n     * from within the Container as this requires coupling between the container contents and the code loader.\n     * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this\n     * migration tool will be removed.\n     */\n    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;\n    readonly audience: IAudience | undefined;\n    readonly loader: ILoader;\n    // The logger implementation, which would support tagged events, should be provided by the loader.\n    readonly taggedLogger: ITelemetryBaseLogger;\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n    pendingLocalState?: unknown;\n\n    /**\n     * Ambient services provided with the context\n     */\n    readonly scope: FluidObject;\n\n    /**\n     * Get an absolute url for a provided container-relative request.\n     * @param relativeUrl - A relative request within the container\n     *\n     * TODO: Optional for backwards compatibility. Make non-optional in version 0.19\n     */\n    getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;\n\n    /**\n     * Indicates the attachment state of the container to a host service.\n     */\n    readonly attachState: AttachState;\n\n    getLoadedFromVersion(): IVersion | undefined;\n\n    updateDirtyContainerState(dirty: boolean): void;\n    /**\n     * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption\n     * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers\n     * and scenarios which can change in the future.\n     */\n    readonly id: string;\n}\n\nexport const IRuntimeFactory: keyof IProvideRuntimeFactory = \"IRuntimeFactory\";\n\nexport interface IProvideRuntimeFactory {\n    readonly IRuntimeFactory: IRuntimeFactory;\n}\n\n/**\n * Exported module definition\n *\n * Provides the entry point for the ContainerContext to load the proper IRuntime\n * to start up the running instance of the Container.\n */\nexport interface IRuntimeFactory extends IProvideRuntimeFactory {\n    /**\n     * Instantiates a new IRuntime for the given IContainerContext to proxy to\n     * This is the main entry point to the Container's business logic\n     *\n     * @param context - container context to be supplied to the runtime\n     * @param existing - whether to instantiate for the first time or from an existing context\n     */\n    instantiateRuntime(context: IContainerContext, existing?: boolean): Promise<IRuntime>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "1.2.7",
+  "version": "2.0.0-dev.1.3.0.96595",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -40,27 +40,50 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/core-interfaces": "^1.2.7",
-    "@fluidframework/driver-definitions": "^1.2.7",
-    "@fluidframework/protocol-definitions": "^0.1028.2000"
+    "@fluidframework/core-interfaces": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/driver-definitions": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/protocol-definitions": "^1.0.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.2.74327",
-    "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@1.2.1",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/build-tools": "^0.4.6000",
+    "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@^1.1.0",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/node": "^14.18.0",
     "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "copyfiles": "^2.4.1",
     "eslint": "~8.6.0",
     "rimraf": "^2.6.2",
     "typescript": "~4.5.5",
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.2.2",
-    "broken": {}
+    "version": "2.0.0",
+    "broken": {
+      "InterfaceDeclaration_IConnectionDetails": {
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_ICodeLoader": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_ConnectionState.Connecting": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "TypeAliasDeclaration_ConnectionState.Connecting": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedEnumDeclaration_BindState": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IContainerContext": {
+        "forwardCompat": false
+      }
+    }
   }
 }

package/src/audience.ts

@@ -6,6 +6,22 @@
 import { EventEmitter } from "events";
 import { IClient } from "@fluidframework/protocol-definitions";
 
+/**
+ * Manages the state and the members for {@link IAudience}
+ */
+export interface IAudienceOwner extends IAudience {
+    /**
+     * Adds a new client to the audience
+     */
+     addMember(clientId: string, details: IClient): void;
+
+     /**
+     * Removes a client from the audience. Only emits an event if a client is actually removed
+     * @returns if a client was removed from the audience
+     */
+     removeMember(clientId: string): boolean;
+}
+
 /**
  * Audience represents all clients connected to the op stream, both read-only and read/write.
  *

package/src/browserPackage.ts

@@ -11,18 +11,18 @@ import { IFluidPackage, isFluidPackage, IFluidPackageEnvironment } from "./fluid
 export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment{
     /**
      * The Universal Module Definition (umd) target specifics the scripts necessary for
-     *  loading a packages in a browser environment and finding its entry point
+     * loading a packages in a browser environment and finding its entry point.
      */
     umd: {
         /**
-         * The bundled js files for loading this package. These files will be loaded
-         * and executed in order
+         * The bundled js files for loading this package.
+         * These files will be loaded and executed in order.
          */
         files: string[];
 
         /**
          * The global name that the script entry points will be exposed.
-         * This entry point should be an IFluidModule
+         * This entry point should be an {@link @fluidframework/container-definitions#IFluidModule}.
          */
         library: string;
 

package/src/deltas.ts

@@ -29,7 +29,7 @@ export interface IConnectionDetails {
     /**
      * Last known sequence number to ordering service at the time of connection
      * It may lap actual last sequence number (quite a bit, if container  is very active).
-     * But it's best information for client to figure out how far it is behind, at least
+     * But it's the best information for client to figure out how far it is behind, at least
      * for "read" connections. "write" connections may use own "join" op to similar information,
      * that is likely to be more up-to-date.
      */
@@ -106,7 +106,7 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
     readonly initialSequenceNumber: number;
 
     /**
-     * Tells if  current connection has checkpoint information.
+     * Tells if current connection has checkpoint information.
      * I.e. we know how far behind the client was at the time of establishing connection
      */
     readonly hasCheckpointSequenceNumber: boolean;
@@ -182,7 +182,11 @@ export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, ID
      */
     toArray(): T[];
 
-    waitTillProcessingDone(): Promise<void>;
+    /**
+     * returns number of ops processed and time it took to process these ops.
+     * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)
+     */
+    waitTillProcessingDone(): Promise<{ count: number; duration: number; }>;
 }
 
 export type ReadOnlyInfo = {

package/src/fluidPackage.ts

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
- /**
-  * Specifies an environment on Fluid property of a IFluidPackage
-  */
+/**
+ * Specifies an environment on Fluid property of a IFluidPackage.
+ */
 export interface IFluidPackageEnvironment {
 
     /**
@@ -23,7 +23,7 @@ export interface IFluidPackageEnvironment {
         /**
          * General access for extended fields as specific usages will
          * likely have additional infornamation like a definition
-         * of Library, the entrypoint for umd packages
+         * of Library, the entrypoint for umd packages.
          */
         [key: string]: unknown;
     };
@@ -119,17 +119,21 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa
      */
     satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise<boolean>;
 
-/* eslint-disable max-len */
+    /* eslint-disable max-len */
     /**
-     * Return a number representing the ascending sort order of the `a` and `b` code details;
-     *      `< 0` if `a < b`.
-     *      `= 0` if `a === b`.
-     *      `> 0` if `a > b`.
-     *      `undefined` if `a` is not comparable to `b`.
+     * Return a number representing the ascending sort order of the `a` and `b` code details:
+     *
+     * - `< 0` if `a < b`.
+     *
+     * - `= 0` if `a === b`.
+     *
+     * - `> 0` if `a > b`.
+     *
+     * - `undefined` if `a` is not comparable to `b`.
      *
      * Similar semantics to:
-     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Description | Array.sort}
+     * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description | Array.sort}
      */
     compare(a: IFluidCodeDetails, b: IFluidCodeDetails): Promise<number | undefined>;
-/* eslint-enable max-len */
+    /* eslint-enable max-len */
 }

package/src/index.ts

@@ -4,7 +4,7 @@
  */
 
 /**
- * This package contains the interfaces and types concerning the `Loader` and loading the `Container`.
+ * This library contains the interfaces and types concerning the `Loader` and loading the `Container`.
  *
  * @packageDocumentation
  */

package/src/loader.ts

@@ -29,28 +29,20 @@ import {
     IProvideFluidCodeDetailsComparer,
 } from "./fluidPackage";
 
-/**
- * Code loading interface
- *
- * @deprecated in favor of {@link @fluidframework/container-loader#ICodeDetailsLoader}
- */
-export interface ICodeLoader extends Partial<IProvideFluidCodeDetailsComparer> {
-    /**
-     * Loads the package specified by code details and returns a promise to its entry point exports.
-     */
-    load(source: IFluidCodeDetails): Promise<IFluidModule>;
-}
-
 /**
  * Encapsulates a module entry point with corresponding code details.
  */
 export interface IFluidModuleWithDetails {
-    /** Fluid code module that implements the runtime factory needed to instantiate the container runtime. */
+    /**
+     * Fluid code module that implements the runtime factory needed to instantiate the container runtime.
+     */
     module: IFluidModule;
+
     /**
      * Code details associated with the module. Represents a document schema this module supports.
-     * If the code loader implements the {@link @fluidframework/core-interfaces#IFluidCodeDetailsComparer} interface,
-     * it'll be called to determine whether the module code details satisfy the new code proposal in the quorum.
+     * If the code loader implements the {@link @fluidframework/core-interfaces#(IFluidCodeDetailsComparer:interface)}
+     * interface, it'll be called to determine whether the module code details satisfy the new code proposal in the
+     * quorum.
      */
     details: IFluidCodeDetails;
 }
@@ -94,12 +86,10 @@ export interface IResolvedFluidCodeDetails extends IFluidCodeDetails {
  */
 export interface IFluidCodeResolver {
     /**
-     * Resolves a Fluid code details into a form that can be loaded
-     * @param details - The Fluid code details to resolve
-     * @returns - A IResolvedFluidCodeDetails where the
-     *            resolvedPackage's Fluid file entries are absolute urls, and
-     *            an optional resolvedPackageCacheId if the loaded package should be
-     *            cached.
+     * Resolves a Fluid code details into a form that can be loaded.
+     * @param details - The Fluid code details to resolve.
+     * @returns - A IResolvedFluidCodeDetails where the resolvedPackage's Fluid file entries are absolute urls, and
+     * an optional resolvedPackageCacheId if the loaded package should be cached.
      */
     resolveCodeDetails(details: IFluidCodeDetails): Promise<IResolvedFluidCodeDetails>;
 }
@@ -130,17 +120,18 @@ export interface IContainerEvents extends IEvent {
  * Namespace for the different connection states a container can be in
  * PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression
  */
+// eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace ConnectionState {
     /**
-     * The container is not connected to the delta server
+     * The container is not connected to the delta server.
      * Note - When in this state the container may be about to reconnect,
      * or may remain disconnected until explicitly told to connect.
      */
     export type Disconnected = 0;
 
     /**
-     * The container is disconnected but actively trying to establish a new connection
-     * PLEASE NOTE that this numerical value falls out of the order you may expect for this state
+     * The container is disconnected but actively trying to establish a new connection.
+     * PLEASE NOTE that this numerical value falls out of the order you may expect for this state.
      */
     export type EstablishingConnection = 3;
 
@@ -150,25 +141,18 @@ export namespace ConnectionState {
     export type CatchingUp = 1;
 
     /**
-     * See ConnectionState.CatchingUp, which is the new name for this state.
-     * @deprecated - This state itself is not gone, just being renamed. Please use ConnectionState.CatchingUp.
-     */
-    export type Connecting = 1;
-
-    /**
-     * The container is fully connected and syncing
+     * The container is fully connected and syncing.
      */
     export type Connected = 2;
 }
 
 /**
- * Type defining the different states of connectivity a container can be in
+ * Type defining the different states of connectivity a container can be in.
  */
 export type ConnectionState =
     | ConnectionState.Disconnected
     | ConnectionState.EstablishingConnection
     | ConnectionState.CatchingUp
-    | ConnectionState.Connecting
     | ConnectionState.Connected;
 
 /**

package/src/runtime.ts

@@ -20,6 +20,7 @@ import {
     IVersion,
     IDocumentMessage,
     IQuorumClients,
+    ISummaryContent,
 } from "@fluidframework/protocol-definitions";
 import { IAudience } from "./audience";
 import { IDeltaManager } from "./deltas";
@@ -50,13 +51,6 @@ export enum AttachState {
     Attached = "Attached",
 }
 
-// Represents the bind state of the entity.
-export enum BindState {
-    NotBound = "NotBound",
-    Binding = "Binding",
-    Bound = "Bound",
-}
-
 /**
  * The IRuntime represents an instantiation of a code package within a Container.
  * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.
@@ -110,6 +104,14 @@ export interface IRuntime extends IDisposable {
     notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;
 }
 
+/**
+ * Payload type for IContainerContext.submitBatchFn()
+ */
+export interface IBatchMessage {
+    contents: string;
+    metadata: Record<string, unknown> | undefined;
+}
+
 /**
  * The ContainerContext is a proxy standing between the Container and the Container's IRuntime.
  * This allows the Container to terminate the connection to the IRuntime.
@@ -126,7 +128,11 @@ export interface IContainerContext extends IDisposable {
     readonly storage: IDocumentStorageService;
     readonly connected: boolean;
     readonly baseSnapshot: ISnapshotTree | undefined;
+    /** @deprecated Please use submitBatchFn & submitSummaryFn */
     readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;
+    /** @returns clientSequenceNumber of last message in a batch */
+    readonly submitBatchFn: (batch: IBatchMessage[]) => number;
+    readonly submitSummaryFn: (summaryOp: ISummaryContent) => number;
     readonly submitSignalFn: (contents: any) => void;
     readonly closeFn: (error?: ICriticalContainerError) => void;
     readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;

package/BREAKING.md

@@ -1,41 +0,0 @@
-## 0.48 Upcoming changes
-- [IProxyLoader interface to be removed](#IProxyLoader-interface-to-be-removed)
-
-### IProxyLoader interface to be removed
-The `IProxyLoader` interface has been deprecated in 0.48 and will be removed in an upcoming release.
-
-## 0.49.1000 Breaking changes
-- [IContainer.connectionState yields finer-grained ConnectionState values](#icontainerconnectionstate-yields-finer-grained-connectionstate-values)
-
-### IContainer.connectionState yields finer-grained ConnectionState values
-The `ConnectionState` types have been updated to include a new state which previously was
-encompassed by the `Disconnected` state. The new state is `EstablishingConnection` and indicates that the container is
-attempting to connect to the ordering service, but is not yet connected.
-
-Any logic based on the `Disconnected` state (e.g. checking the value of `IContainer.connectionState`)
-should be updated depending on how you want to treat this new `EstablishingConnection` state.
-
-Additionally, please note that the `Connecting` state is being renamed to `CatchingUp`.
-`ConnectionState.Connecting` is marked as deprecated, please use `ConnectionState.CatchingUp` instead.
-`ConnectionState.Connecting` will be removed in the following major release.
-
-## 0.45 Breaking changes
-- [ContainerErrorType.clientSessionExpiredError added](#ContainerErrorType.clientSessionExpiredError-added)
-
-### ContainerErrorType.clientSessionExpiredError added
-We have session expiry for GC purposes. Once the session has expired, we want to throw this new clientSessionExpiredError to clear out any stale in-memory data that may still be on the container.
-
-## 0.40 Breaking changes
-
-- [IErrorBase.sequenceNumber removed](#IErrorBase.sequenceNumber-removed)
-- [IContainerContext.logger deprecated](#IContainerContext.logger-deprecated)
-
-### IErrorBase.sequenceNumber removed
-This field was used for logging and this was probably not the right abstraction for it to live in.
-But practically speaking, the only places it was set have been updated to log not just sequenceNumber
-but a large number of useful properties off the offending message, via `CreateProcessingError`.
-
-### IContainerContext.logger deprecated
-Use `IContainerContext.taggedLogger` instead if present. If it's missing and you must use `logger`,
-be sure to handle tagged data before sending events to it.
-`logger` won't be removed for a very long time since old loaders could remain in production for quite some time.