@fluidframework/container-definitions 0.49.1000-64278 → 0.49.1000-69950

package/src/loader.ts

@@ -128,20 +128,35 @@ 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
  */
 export namespace ConnectionState {
     /**
-     * The document is no longer 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 document has an inbound connection but is still pending for outbound deltas
+     * 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;
+
+     /**
+     * The container has an inbound connection only, and is catching up to the latest known state from the service.
+     */
+    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 document is fully connected
+     * The container is fully connected and syncing
      */
      export type Connected = 2;
 }
@@ -149,7 +164,12 @@ export namespace ConnectionState {
 /**
  * Type defining the different states of connectivity a container can be in
  */
-export type ConnectionState = ConnectionState.Disconnected | ConnectionState.Connecting | ConnectionState.Connected;
+export type ConnectionState =
+    | ConnectionState.Disconnected
+    | ConnectionState.EstablishingConnection
+    | ConnectionState.CatchingUp
+    | ConnectionState.Connecting
+    | ConnectionState.Connected;
 
 /**
  * The Host's view of the Container and its connection to storage
@@ -219,7 +239,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      * be true when the proposal is accepted, and false if
      * the proposal is rejected.
      */
-    proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>
+    proposeCodeDetails(codeDetails: IFluidCodeDetails): Promise<boolean>;
 
     /**
      * Attaches the Container to the Container specified by the given Request.
@@ -249,18 +269,10 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
     request(request: IRequest): Promise<IResponse>;
 
     /**
-     * Provides the current connected state of the container
+     * Provides the current state of the container's connection to the ordering service
      */
     readonly connectionState: ConnectionState;
 
-    /**
-     * Boolean indicating whether the container is currently connected or not
-     * @deprecated - 0.58, This API will be removed in 1.0
-     * Check `connectionState === ConnectionState.Connected` instead
-     * See https://github.com/microsoft/FluidFramework/issues/9167 for context
-     */
-    readonly connected: boolean;
-
     /**
      * Attempts to connect the container to the delta stream and process ops
      */
@@ -271,24 +283,6 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
      */
     disconnect(): void;
 
-    /**
-     * Dictates whether or not the current container will automatically attempt to reconnect to the delta stream
-     * after receiving a disconnect event
-     * @param reconnect - Boolean indicating if reconnect should automatically occur
-     * @deprecated - 0.58, This API will be removed in 1.0
-     * Use `connect()` and `disconnect()` instead of `setAutoReconnect(true)` and `setAutoReconnect(false)` respectively
-     * See https://github.com/microsoft/FluidFramework/issues/9167 for context
-     */
-    setAutoReconnect?(reconnect: boolean): void;
-
-    /**
-     * Have the container attempt to resume processing ops
-     * @deprecated - 0.58, This API will be removed in 1.0
-     * Use `connect()` instead
-     * See https://github.com/microsoft/FluidFramework/issues/9167 for context
-     */
-    resume?(): void;
-
     /**
      * The audience information for all clients currently associated with the document in the current session
      */
@@ -296,7 +290,7 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
 
     /**
      * The server provided ID of the client.
-     * Set once this.connected is true, otherwise undefined
+     * Set once this.connectionState === ConnectionState.Connected is true, otherwise undefined
      * @alpha
      */
     readonly clientId?: string | undefined;
@@ -393,7 +387,7 @@ export type ILoaderOptions = {
     /**
      * Max time(in ms) container will wait for a leave message of a disconnected client.
     */
-    maxClientLeaveWaitTime?: number,
+    maxClientLeaveWaitTime?: number;
 };
 
 /**
@@ -443,15 +437,15 @@ export interface IContainerLoadMode {
          * Also there might be a lot of trailing ops and applying them might take time, so hosts are
          * recommended to have some progress UX / cancellation built into loading flow when using this option.
          */
-        | "all"
+        | "all";
     deltaConnection?:
         /*
-         * Connection to delta stream is made only when Container.resume() call is made. Op processing
-         * is paused (when container is returned from Loader.resolve()) until Container.resume() call is made.
+         * Connection to delta stream is made only when Container.connect() call is made. Op processing
+         * is paused (when container is returned from Loader.resolve()) until Container.connect() call is made.
          */
         | "none"
         /*
-         * Connection to delta stream is made only when Container.resume() call is made.
+         * Connection to delta stream is made only when Container.connect() call is made.
          * Op fetching from storage is performed and ops are applied as they come in.
          * This is useful option if connection to delta stream is expensive and thus it's beneficial to move it
          * out from critical boot sequence, but it's beneficial to allow catch up to happen as fast as possible.
@@ -462,7 +456,7 @@ export interface IContainerLoadMode {
          * Ops processing is enabled and ops are flowing through the system.
          * Default value.
          */
-        | undefined
+        | undefined;
 }
 
 /**
@@ -509,6 +503,6 @@ export interface IPendingLocalState {
  * when attaching.
  */
 export interface ISnapshotTreeWithBlobContents extends ISnapshotTree {
-    blobsContents: {[path: string]: ArrayBufferLike},
-    trees: {[path: string]: ISnapshotTreeWithBlobContents},
+    blobsContents: { [path: string]: ArrayBufferLike },
+    trees: { [path: string]: ISnapshotTreeWithBlobContents },
 }

package/src/proxyLoader.ts

@@ -8,15 +8,18 @@ import { ILoader, ILoaderOptions } from "./loader";
 
 /**
  * Abstraction layer to support different Loaders in different Node execution contexts
+ * @deprecated Not recommended for general use and will be removed in an upcoming release.
  */
 export interface IProxyLoaderFactory {
     /**
      * Loader environment
+     * @deprecated Not recommended for general use and will be removed in an upcoming release.
      */
     environment: string;
 
     /**
      * Returns an instance of ILoader loaded inside an execution context.
+     * @deprecated Not recommended for general use and will be removed in an upcoming release.
      */
     createProxyLoader(
         id: string,

package/src/runtime.ts

@@ -167,6 +167,12 @@ export interface IContainerContext extends IDisposable {
     getLoadedFromVersion(): IVersion | undefined;
 
     updateDirtyContainerState(dirty: boolean): void;
+    /**
+     * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption
+     * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers
+     * and scenarios which can change in the future.
+     */
+    readonly id: string;
 }
 
 export const IRuntimeFactory: keyof IProvideRuntimeFactory = "IRuntimeFactory";

package/src/tokenProvider.ts

@@ -10,5 +10,5 @@ export interface IProvideFluidTokenProvider {
 }
 
 export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
-    intelligence: { [service: string]: any };
+    intelligence: { [service: string]: any; };
 }