@fluidframework/container-definitions 0.45.0 → 0.47.0-55103

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "0.45.0",
+  "version": "0.47.0-55103",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -38,8 +38,8 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.0",
     "@fluidframework/core-interfaces": "^0.42.0",
-    "@fluidframework/driver-definitions": "^0.44.0",
-    "@fluidframework/protocol-definitions": "^0.1026.0"
+    "@fluidframework/driver-definitions": "^0.45.0-0",
+    "@fluidframework/protocol-definitions": "^0.1027.0-0"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
@@ -50,7 +50,9 @@
     "@fluidframework/container-definitions-0.42.0": "npm:@fluidframework/container-definitions@0.42.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",
+    "@fluidframework/container-definitions-0.45.0": "npm:@fluidframework/container-definitions@0.45.0",
+    "@fluidframework/container-definitions-0.46.0": "npm:@fluidframework/container-definitions@0.46.0",
+    "@fluidframework/eslint-config-fluid": "^0.26.0-0",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^8.2.2",
@@ -71,7 +73,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.45.0",
+    "version": "0.47.0",
     "broken": {
       "0.39.8": {
         "EnumDeclaration_ContainerErrorType": {
@@ -116,7 +118,6 @@
           "backCompat": false
         },
         "InterfaceDeclaration_IRuntime": {
-          "forwardCompat": false,
           "backCompat": false
         },
         "InterfaceDeclaration_IRuntimeFactory": {
@@ -162,6 +163,9 @@
           "forwardCompat": false,
           "backCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "forwardCompat": false,
           "backCompat": false
@@ -240,6 +244,9 @@
           "backCompat": false,
           "forwardCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "backCompat": false,
           "forwardCompat": false
@@ -286,6 +293,9 @@
           "backCompat": false,
           "forwardCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "backCompat": false,
           "forwardCompat": false
@@ -362,6 +372,9 @@
           "backCompat": false,
           "forwardCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "backCompat": false,
           "forwardCompat": false
@@ -418,6 +431,9 @@
           "backCompat": false,
           "forwardCompat": false
         },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
         "InterfaceDeclaration_IRuntimeFactory": {
           "backCompat": false,
           "forwardCompat": false
@@ -428,6 +444,76 @@
         "InterfaceDeclaration_IUsageError": {
           "backCompat": false
         }
+      },
+      "0.45.0": {
+        "InterfaceDeclaration_ICodeDetailsLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModuleWithDetails": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProvideRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IRuntime": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IContainer": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IContainerContext": {
+          "backCompat": false,
+          "forwardCompat": false
+        },
+        "InterfaceDeclaration_IHostLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ILoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProvideLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProxyLoaderFactory": {
+          "backCompat": false
+        }
+      },
+      "0.46.0": {
+        "InterfaceDeclaration_IContainerContext": {
+          "forwardCompat": false,
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeDetailsLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_ICodeLoader": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModule": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IFluidModuleWithDetails": {
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IProvideRuntimeFactory": {
+          "forwardCompat": false,
+          "backCompat": false
+        },
+        "InterfaceDeclaration_IRuntimeFactory": {
+          "backCompat": false,
+          "forwardCompat": false
+        }
       }
     }
   }

package/src/browserPackage.ts

@@ -52,7 +52,7 @@ export interface IFluidBrowserPackage extends IFluidPackage {
  * Determines if any object is an IFluidBrowserPackage
  * @param maybePkg - The object to check for compatibility with IFluidBrowserPackage
  */
-export const isFluidBrowserPackage = (maybePkg: any): maybePkg is Readonly<IFluidBrowserPackage>  =>
+export const isFluidBrowserPackage = (maybePkg: any): maybePkg is Readonly<IFluidBrowserPackage> =>
     isFluidPackage(maybePkg)
     && typeof maybePkg?.fluid?.browser?.umd?.library === "string"
     && Array.isArray(maybePkg?.fluid?.browser?.umd?.files);

package/src/deltas.ts

@@ -52,7 +52,7 @@ export interface IDeltaHandlerStrategy {
 }
 
 declare module "@fluidframework/core-interfaces" {
-    interface IFluidObject  {
+    interface IFluidObject {
         /** @deprecated - use `FluidObject<IDeltaSender>` instead */
         readonly IDeltaSender?: IDeltaSender
      }

package/src/error.ts

@@ -35,7 +35,8 @@ export enum ContainerErrorType {
      usageError = "usageError",
 
     /**
-     * Error indicating an client session has expired.
+     * Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and
+     * aids in safely deleting unused objects.
      */
     clientSessionExpiredError = "clientSessionExpiredError",
 }

package/src/fluidPackage.ts

@@ -48,7 +48,7 @@ export interface IFluidPackage {
          * The name of the of the environment. This should be something like browser, or node
          * and contain the necessary targets for loading this code in that environment.
          */
-        [environment: string]:  undefined | IFluidPackageEnvironment;
+        [environment: string]: undefined | IFluidPackageEnvironment;
     };
     /**
      * General access for extended fields as specific usages will

package/src/index.ts

@@ -4,8 +4,7 @@
  */
 export * from "./audience";
 export * from "./browserPackage";
-// eslint-disable-next-line import/no-internal-modules
-export * from "./legacy/chaincode";
+export * from "./legacy";
 export * from "./deltas";
 export * from "./error";
 export * from "./loader";

package/src/legacy/{chaincode.ts → index.ts}

@@ -25,7 +25,7 @@ export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
 }
 
 declare module "@fluidframework/core-interfaces" {
-    export interface IFluidObject  {
+    export interface IFluidObject {
         /** @deprecated - use `FluidObject<IRuntimeFactory>` instead */
         readonly IRuntimeFactory?: IRuntimeFactory;
         /** @deprecated - use `FluidObject<IFluidTokenProvider>` instead */

package/src/loader.ts

@@ -14,9 +14,9 @@ import {
 import {
     IClientDetails,
     IDocumentMessage,
-    IPendingProposal,
     IQuorumClients,
     ISequencedDocumentMessage,
+    ISequencedProposal,
 } from "@fluidframework/protocol-definitions";
 import { IResolvedUrl } from "@fluidframework/driver-definitions";
 import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
@@ -114,7 +114,7 @@ export interface ICodeAllowList {
 export interface IContainerEvents extends IEvent {
     (event: "readonly", listener: (readonly: boolean) => void): void;
     (event: "connected", listener: (clientId: string) => void);
-    (event: "codeDetailsProposed", listener: (codeDetails: IFluidCodeDetails, proposal: IPendingProposal) => void);
+    (event: "codeDetailsProposed", listener: (codeDetails: IFluidCodeDetails, proposal: ISequencedProposal) => void);
     (event: "contextChanged", listener: (codeDetails: IFluidCodeDetails) => void);
     (event: "disconnected" | "attached", listener: () => void);
     (event: "closed", listener: (error?: ICriticalContainerError) => void);
@@ -465,7 +465,7 @@ declare module "@fluidframework/core-interfaces" {
     // eslint-disable-next-line @typescript-eslint/no-empty-interface
     export interface IRequestHeader extends Partial<ILoaderHeader> { }
 
-    export interface IFluidObject  {
+    export interface IFluidObject {
         /**
          * @deprecated - use `FluidObject<ILoader>` instead
          */

package/src/runtime.ts

@@ -7,7 +7,6 @@ import { ITelemetryBaseLogger, IDisposable } from "@fluidframework/common-defini
 import {
     FluidObject,
     IFluidCodeDetails,
-    IFluidConfiguration,
     IFluidObject,
     IRequest,
     IResponse,
@@ -18,7 +17,6 @@ import {
     IClientDetails,
     ISequencedDocumentMessage,
     ISnapshotTree,
-    ITree,
     MessageType,
     ISummaryTree,
     IVersion,
@@ -71,11 +69,6 @@ export interface IRuntime extends IDisposable {
      */
     request(request: IRequest): Promise<IResponse>;
 
-    /**
-     * Snapshots the runtime
-     */
-    snapshot(tagMessage: string, fullTree?: boolean): Promise<ITree | null>;
-
     /**
      * Notifies the runtime of a change in the connection state
      */
@@ -123,10 +116,6 @@ export interface IRuntime extends IDisposable {
 export interface IContainerContext extends IDisposable {
     readonly existing: boolean | undefined;
     readonly options: ILoaderOptions;
-    /**
-     * @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;
@@ -147,15 +136,8 @@ export interface IContainerContext extends IDisposable {
     getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;
     readonly audience: IAudience | undefined;
     readonly loader: ILoader;
-    /** @deprecated - Use `taggedLogger` if present. Otherwise, be sure to handle tagged data
-     * before sending events to this logger. In time we will assume the presence of `taggedLogger`,
-     * but in the meantime, current and older loader versions buttress loggers that do not support tags.
-     * IContainerContext will retain both options, but hosts must now support tags as the loader
-     * will soon plumb taggedLogger's events (potentially tagged) to the host's logger.
-     */
-    readonly logger?: ITelemetryBaseLogger;
     // The logger implementation, which would support tagged events, should be provided by the loader.
-    readonly taggedLogger?: ITelemetryBaseLogger;
+    readonly taggedLogger: ITelemetryBaseLogger;
     readonly serviceConfiguration: IClientConfiguration | undefined;
     pendingLocalState?: unknown;
 
@@ -167,7 +149,7 @@ export interface IContainerContext extends IDisposable {
     /**
      * @deprecated 0.56, will be removed in the next release
      */
-    raiseContainerWarning(warning: ContainerWarning): void;
+    raiseContainerWarning?(warning: ContainerWarning): void;
 
     /**
      * Get an absolute url for a provided container-relative request.

package/dist/legacy/chaincode.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"chaincode.d.ts","sourceRoot":"","sources":["../../src/legacy/chaincode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACnE,YAAY,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CAC5C;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAC7C,UAAiB,YAAY;QACzB,+DAA+D;QAC/D,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;QAC3C,mEAAmE;QACnE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;KACtD;CACJ"}

package/dist/legacy/chaincode.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"chaincode.js","sourceRoot":"","sources":["../../src/legacy/chaincode.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRuntimeFactory } from \"../runtime\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport const IFluidTokenProvider: keyof IProvideFluidTokenProvider = \"IFluidTokenProvider\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IProvideFluidTokenProvider {\n    readonly IFluidTokenProvider: IFluidTokenProvider;\n}\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IFluidTokenProvider extends IProvideFluidTokenProvider {\n    intelligence: { [service: string]: any };\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n    export interface IFluidObject  {\n        /** @deprecated - use `FluidObject<IRuntimeFactory>` instead */\n        readonly IRuntimeFactory?: IRuntimeFactory;\n        /** @deprecated - use `FluidObject<IFluidTokenProvider>` instead */\n        readonly IFluidTokenProvider?: IFluidTokenProvider;\n    }\n}\n"]}

package/lib/legacy/chaincode.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"chaincode.d.ts","sourceRoot":"","sources":["../../src/legacy/chaincode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACnE,YAAY,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CAC5C;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAC7C,UAAiB,YAAY;QACzB,+DAA+D;QAC/D,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;QAC3C,mEAAmE;QACnE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;KACtD;CACJ"}

package/lib/legacy/chaincode.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"chaincode.js","sourceRoot":"","sources":["../../src/legacy/chaincode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAqC,qBAAqB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRuntimeFactory } from \"../runtime\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport const IFluidTokenProvider: keyof IProvideFluidTokenProvider = \"IFluidTokenProvider\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IProvideFluidTokenProvider {\n    readonly IFluidTokenProvider: IFluidTokenProvider;\n}\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IFluidTokenProvider extends IProvideFluidTokenProvider {\n    intelligence: { [service: string]: any };\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n    export interface IFluidObject  {\n        /** @deprecated - use `FluidObject<IRuntimeFactory>` instead */\n        readonly IRuntimeFactory?: IRuntimeFactory;\n        /** @deprecated - use `FluidObject<IFluidTokenProvider>` instead */\n        readonly IFluidTokenProvider?: IFluidTokenProvider;\n    }\n}\n"]}