@fluidframework/container-definitions 0.43.0 → 0.45.0-49378

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "0.43.0",
+  "version": "0.45.0-49378",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -27,7 +27,7 @@
     "ci:test:coverage": "echo No test for this package",
     "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
     "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "lint": "npm run eslint",
     "lint:fix": "npm run eslint:fix",
     "tsc": "tsc",
@@ -38,37 +38,40 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.0",
     "@fluidframework/core-interfaces": "^0.41.0",
-    "@fluidframework/driver-definitions": "^0.43.0",
+    "@fluidframework/driver-definitions": "^0.44.0-0",
     "@fluidframework/protocol-definitions": "^0.1026.0"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.44827",
+    "@fluidframework/build-tools": "^0.2.49276",
     "@fluidframework/container-definitions-0.39.8": "npm:@fluidframework/container-definitions@0.39.8",
     "@fluidframework/container-definitions-0.40.0": "npm:@fluidframework/container-definitions@0.40.0",
     "@fluidframework/container-definitions-0.41.0": "npm:@fluidframework/container-definitions@0.41.0",
     "@fluidframework/container-definitions-0.42.0": "npm:@fluidframework/container-definitions@0.42.0",
-    "@fluidframework/eslint-config-fluid": "^0.24.0",
+    "@fluidframework/container-definitions-0.43.0": "npm:@fluidframework/container-definitions@0.43.0",
+    "@fluidframework/container-definitions-0.44.0": "npm:@fluidframework/container-definitions@0.44.0",
+    "@fluidframework/eslint-config-fluid": "^0.25.0",
     "@microsoft/api-extractor": "^7.16.1",
+    "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",
-    "@types/node": "^12.19.0",
-    "@typescript-eslint/eslint-plugin": "~4.14.0",
-    "@typescript-eslint/parser": "~4.14.0",
+    "@types/node": "^14.18.0",
+    "@typescript-eslint/eslint-plugin": "~5.9.0",
+    "@typescript-eslint/parser": "~5.9.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
-    "eslint": "~7.18.0",
+    "eslint": "~8.6.0",
+    "eslint-plugin-editorconfig": "~3.2.0",
     "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.22.1",
+    "eslint-plugin-import": "~2.25.4",
     "eslint-plugin-no-null": "~1.0.2",
-    "eslint-plugin-prefer-arrow": "~1.2.2",
-    "eslint-plugin-react": "~7.22.0",
-    "eslint-plugin-unicorn": "~26.0.1",
+    "eslint-plugin-react": "~7.28.0",
+    "eslint-plugin-unicorn": "~40.0.0",
     "rimraf": "^2.6.2",
     "typescript": "~4.1.3",
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.43.0",
+    "version": "0.45.0",
     "broken": {
       "0.39.8": {
         "EnumDeclaration_ContainerErrorType": {
@@ -131,6 +134,18 @@
         }
       },
       "0.40.0": {
+        "InterfaceDeclaration_IUsageError": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IThrottlingWarning": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IGenericError": {
+          "backCompat": false
+        },
+        "EnumDeclaration_ContainerErrorType": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_ICodeLoader": {
           "forwardCompat": false,
           "backCompat": false
@@ -152,16 +167,20 @@
           "backCompat": false
         },
         "InterfaceDeclaration_ILoader": {
-          "backCompat": false
+          "backCompat": false,
+          "forwardCompat": false
         },
         "InterfaceDeclaration_IProxyLoaderFactory": {
-          "backCompat": false
+          "backCompat": false,
+          "forwardCompat": false
         },
         "InterfaceDeclaration_IHostLoader": {
-          "backCompat": false
+          "backCompat": false,
+          "forwardCompat": false
         },
         "InterfaceDeclaration_IContainer": {
-          "backCompat": false
+          "backCompat": false,
+          "forwardCompat": false
         },
         "InterfaceDeclaration_IDeltaManager": {
           "backCompat": false
@@ -171,57 +190,232 @@
         }
       },
       "0.41.0": {
-        "InterfaceDeclaration_ILoader": {
+        "InterfaceDeclaration_IUsageError": {
           "backCompat": false
         },
-        "InterfaceDeclaration_IProxyLoaderFactory": {
+        "InterfaceDeclaration_IThrottlingWarning": {
           "backCompat": false
         },
-        "InterfaceDeclaration_IHostLoader": {
+        "InterfaceDeclaration_IGenericError": {
           "backCompat": false
         },
-        "InterfaceDeclaration_IFluidModule": {
+        "EnumDeclaration_ContainerErrorType": {
           "backCompat": false
         },
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
         "InterfaceDeclaration_IContainerContext": {
-          "backCompat": false
+          "backCompat": false,
+          "forwardCompat": false
         },
         "InterfaceDeclaration_IContainer": {
-          "backCompat": false
+          "backCompat": false,
+          "forwardCompat": false
         },
         "InterfaceDeclaration_ICodeLoader": {
-          "backCompat": false
+          "backCompat": false,
+          "forwardCompat": false
         },
         "InterfaceDeclaration_IDeltaManager": {
           "backCompat": false
         },
         "InterfaceDeclaration_IConnectionDetails": {
           "backCompat": false
+        },
+        "InterfaceDeclaration_IProvideRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
         }
       },
       "0.42.0": {
-        "InterfaceDeclaration_ILoader": {
+        "InterfaceDeclaration_IUsageError": {
           "backCompat": false
         },
-        "InterfaceDeclaration_IProxyLoaderFactory": {
+        "InterfaceDeclaration_IThrottlingWarning": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IGenericError": {
+          "backCompat": false
+        },
+        "EnumDeclaration_ContainerErrorType": {
           "backCompat": false
         },
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
         "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IContainerContext": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProvideLoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProvideRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IDeltaManager": {
           "backCompat": false
         },
+        "InterfaceDeclaration_IConnectionDetails": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
+          "backCompat": false
+        }
+      },
+      "0.43.0": {
+        "InterfaceDeclaration_IUsageError": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IThrottlingWarning": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IGenericError": {
+          "backCompat": false
+        },
+        "EnumDeclaration_ContainerErrorType": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
         "InterfaceDeclaration_IContainerContext": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProvideLoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_ICodeDetailsLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModuleWithDetails": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProvideRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        }
+      },
+      "0.44.0": {
+        "EnumDeclaration_ContainerErrorType": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeDetailsLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeLoader": {
           "backCompat": false
         },
         "InterfaceDeclaration_IContainer": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IContainerContext": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
           "backCompat": false
         },
-        "InterfaceDeclaration_IProvideLoader": {
+        "InterfaceDeclaration_IFluidModuleWithDetails": {
           "backCompat": false
         },
-        "InterfaceDeclaration_IDeltaManager": {
+        "InterfaceDeclaration_IGenericError": {
           "backCompat": false
         },
-        "InterfaceDeclaration_IConnectionDetails": {
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProvideLoader": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProvideRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IThrottlingWarning": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IUsageError": {
           "backCompat": false
         }
       }

package/src/deltas.ts

@@ -148,24 +148,9 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
     /** Flag to indicate whether the client can write or not. */
     readonly active: boolean;
 
-    /**
-     * Tells if container is in read-only mode.
-     * Data stores should listen for "readonly" notifications and disallow user making changes to data stores.
-     * Readonly state can be because of no storage write permission,
-     * or due to host forcing readonly mode for container.
-     *
-     * We do not differentiate here between no write access to storage vs. host disallowing changes to container -
-     * in all cases container runtime and data stores should respect readonly state and not allow local changes.
-     *
-     * It is undefined if we have not yet established websocket connection
-     * and do not know if user has write access to a file.
-     * @deprecated - use readOnlyInfo
-     */
-    readonly readonly?: boolean;
-
     readonly readOnlyInfo: ReadOnlyInfo;
 
-    /** Terminate the connection to storage */
+    /** @deprecated - Use Container.close() or IContainerContext.closeFn() */
     close(): void;
 
     /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */

package/src/error.ts

@@ -33,7 +33,12 @@ export enum ContainerErrorType {
      * Error indicating an API is being used improperly resulting in an invalid operation.
      */
      usageError = "usageError",
-    }
+
+    /**
+     * Error indicating an client session has expired.
+     */
+    clientSessionExpiredError = "clientSessionExpiredError",
+}
 
 /**
  * Base interface for all errors and warnings at container level

package/src/loader.ts

@@ -15,7 +15,7 @@ import {
     IClientDetails,
     IDocumentMessage,
     IPendingProposal,
-    IQuorum,
+    IQuorumClients,
     ISequencedDocumentMessage,
 } from "@fluidframework/protocol-definitions";
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
@@ -162,7 +162,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * The collection of write clients which were connected as of the current sequence number.
      * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.
      */
-    getQuorum(): IQuorum;
+    getQuorum(): IQuorumClients;
 
     /**
      * Represents the resolved url to the Container
@@ -174,27 +174,18 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      */
     readonly attachState: AttachState;
 
-    /**
-     * The current code details for the container's runtime
-     * @deprecated use getSpecifiedCodeDetails for the code details currently specified for this container, or
-     * getLoadedCodeDetails for the code details that the container's context was loaded with.
-     * To be removed after getSpecifiedCodeDetails and getLoadedCodeDetails become ubiquitous.
-     * This is now marked as optional and due to be removed in next release.
-     */
-    readonly codeDetails?: IFluidCodeDetails | undefined;
-
     /**
      * Get the code details that are currently specified for the container.
      * @returns The current code details if any are specified, undefined if none are specified.
      */
-    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;
+    getSpecifiedCodeDetails(): IFluidCodeDetails | undefined;
 
     /**
      * Get the code details that were used to load the container.
      * @returns The code details that were used to load the container if it is loaded, undefined if it is not yet
      * loaded.
      */
-    getLoadedCodeDetails?(): IFluidCodeDetails | undefined;
+    getLoadedCodeDetails(): IFluidCodeDetails | undefined;
 
     /**
      * Returns true if the container has been closed, otherwise false
@@ -257,12 +248,12 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
     /**
      * Provides the current connected state of the container
      */
-    readonly connectionState?: ConnectionState;
+    readonly connectionState: ConnectionState;
 
     /**
      * Boolean indicating whether the container is currently connected or not
      */
-    readonly connected?: boolean;
+    readonly connected: boolean;
 
     /**
      * Dictates whether or not the current container will automatically attempt to reconnect to the delta stream
@@ -281,7 +272,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
     /**
      * The audience information for all clients currently associated with the document in the current session
      */
-    readonly audience?: IAudience;
+    readonly audience: IAudience;
 
     /**
      * The server provided ID of the client.
@@ -302,7 +293,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * It is undefined if we have not yet established websocket connection
      * and do not know if user has write access to a file.
      */
-    readonly readOnlyInfo?: ReadOnlyInfo;
+    readonly readOnlyInfo: ReadOnlyInfo;
 
     /**
      * Allows the host to have the container force to be in read-only mode

package/src/runtime.ts

@@ -16,7 +16,6 @@ import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import {
     IClientConfiguration,
     IClientDetails,
-    IQuorum,
     ISequencedDocumentMessage,
     ISnapshotTree,
     ITree,
@@ -24,6 +23,7 @@ import {
     ISummaryTree,
     IVersion,
     IDocumentMessage,
+    IQuorumClients,
 } from "@fluidframework/protocol-definitions";
 import { IAudience } from "./audience";
 import { IDeltaManager } from "./deltas";
@@ -121,10 +121,12 @@ export interface IRuntime extends IDisposable {
  * and the Container has created a new ContainerContext.
  */
 export interface IContainerContext extends IDisposable {
-    readonly id: string;
     readonly existing: boolean | undefined;
     readonly options: ILoaderOptions;
-    readonly configuration: IFluidConfiguration;
+    /**
+     * @deprecated 0.45 - Configuration is not recommended to be used and will be removed in an upcoming release.
+     */
+    readonly configuration?: IFluidConfiguration;
     readonly clientId: string | undefined;
     readonly clientDetails: IClientDetails;
     readonly storage: IDocumentStorageService;
@@ -134,7 +136,7 @@ export interface IContainerContext extends IDisposable {
     readonly submitSignalFn: (contents: any) => void;
     readonly closeFn: (error?: ICriticalContainerError) => void;
     readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
-    readonly quorum: IQuorum;
+    readonly quorum: IQuorumClients;
     /**
      * @deprecated This method is provided as a migration tool for customers currently reading the code details
      * from within the Container by directly accessing the Quorum proposals.  The code details should not be accessed