@fluidframework/container-definitions - npm Package Compare versions

Comparing version 2.0.0-dev-rc.4.0.0.261659 to 2.0.0-dev-rc.5.0.0.263932

api-report/container-definitions.api.md

@@ -8,3 +8,3 @@ ## API Report File for "@fluidframework/container-definitions"
 import type { FluidObject } from '@fluidframework/core-interfaces';
-import type { IAnyDriverError } from '@fluidframework/driver-definitions';
+import type { IAnyDriverError } from '@fluidframework/driver-definitions/internal';
 import type { IClient } from '@fluidframework/protocol-definitions';
@@ -112,3 +112,3 @@ import type { IClientConfiguration } from '@fluidframework/protocol-definitions';
 
-// @public
+// @alpha
 export interface IConnectionDetails {
@@ -221,3 +221,3 @@ checkpointSequenceNumber: number | undefined;
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IContainerLoadMode {
@@ -233,3 +233,3 @@ // (undocumented)
 
-// @public @sealed
+// @alpha @sealed
 export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender {
@@ -257,3 +257,3 @@ readonly active: boolean;
 
-// @public @sealed
+// @alpha @sealed
 export interface IDeltaManagerEvents extends IEvent {
@@ -274,3 +274,3 @@ // @deprecated (undocumented)
 
-// @public @sealed
+// @alpha @sealed
 export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {
@@ -290,3 +290,3 @@ idle: boolean;
 
-// @public @sealed
+// @alpha @sealed
 export interface IDeltaQueueEvents<T> extends IErrorEvent {
@@ -298,3 +298,3 @@ (event: "push", listener: (task: T) => void): any;
 
-// @public @sealed
+// @alpha @sealed
 export interface IDeltaSender {
@@ -515,3 +515,3 @@ flush(): void;
 
-// @public (undocumented)
+// @alpha (undocumented)
 export type ReadOnlyInfo = {
@@ -518,0 +518,0 @@ readonly readonly: false | undefined;

CHANGELOG.md

 # @fluidframework/container-definitions
 
+## 2.0.0-rc.4.0.0
+
+### Major Changes
+
+-   Audience & connection sequencing improvements [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
+
+    Here are breaking changes in Audience behavior:
+
+    1. IAudience no longer implements EventEmmiter. If you used addListener() or removeListener(), please replace with on() & off() respectively.
+    2. IAudience interface implements getSelf() method and "selfChanged" event.
+    3. IContainerContext.audience is no longer optional
+    4. "connected" events are now raised (various API surfaces - IContainer, IContainerRuntime, IFluidDataStoreRuntime, etc.) a bit later in reconnection sequence for "read" connections - only after client receives its own "join" signal and caught up on ops, which makes it symmetrical with "write" connections.
+
+    -   If this change in behavior breaks some scenario, please let us know immediately, but you can revert that behavior using the following feature gates:
+        -   "Fluid.Container.DisableCatchUpBeforeDeclaringConnected"
+        -   "Fluid.Container.DisableJoinSignalWait"
+
+### Minor Changes
+
+-   Type Erase IFluidDataStoreRuntime.deltaManager [96872186d0](https://github.com/microsoft/FluidFramework/commit/96872186d0d0f245c1fece7d19b3743e501679b6)
+
+    Make IFluidDataStoreRuntime.deltaManager have an opaque type.
+    Marks the following types which were reachable from it as alpha:
+
+    -   IConnectionDetails
+    -   IDeltaSender
+    -   IDeltaManagerEvents
+    -   IDeltaManager
+    -   IDeltaQueueEvents
+    -   IDeltaQueue
+    -   ReadOnlyInfo
+
+    As a temporary workaround, users needing access to the full delta manager API can use the `@alpha` `toDeltaManagerInternal` API to retrieve its members, but should migrate away from requiring access to those APIs.
+
+    Implementing a custom `IFluidDataStoreRuntime` is not supported: this is now indicated by it being marked with `@sealed`.
+
 ## 2.0.0-rc.3.0.0
@@ -4,0 +40,0 @@

dist/deltas.d.ts

@@ -6,7 +6,7 @@ /*!
 import type { IDisposable, IErrorBase, IErrorEvent, IEvent, IEventProvider } from "@fluidframework/core-interfaces";
-import type { IAnyDriverError } from "@fluidframework/driver-definitions";
+import type { IAnyDriverError } from "@fluidframework/driver-definitions/internal";
 import type { IClientConfiguration, IClientDetails, IDocumentMessage, ISequencedDocumentMessage, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
 /**
  * Contract representing the result of a newly established connection to the server for syncing deltas.
- * @public
+ * @alpha
  */
@@ -37,3 +37,3 @@ export interface IConnectionDetails {
  * @sealed
- * @public
+ * @alpha
  */
@@ -49,3 +49,3 @@ export interface IDeltaSender {
  * @sealed
- * @public
+ * @alpha
  */
@@ -120,3 +120,3 @@ export interface IDeltaManagerEvents extends IEvent {
  * @sealed
- * @public
+ * @alpha
  */
@@ -194,3 +194,3 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender {
  * @sealed
- * @public
+ * @alpha
  */
@@ -236,3 +236,3 @@ export interface IDeltaQueueEvents<T> extends IErrorEvent {
  * @sealed
- * @public
+ * @alpha
  */
@@ -281,3 +281,3 @@ export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {
 /**
- * @public
+ * @alpha
  */
@@ -284,0 +284,0 @@ export type ReadOnlyInfo = {

dist/legacy.d.ts

@@ -17,12 +17,5 @@ /*!
 	IAudienceEvents, 
-	IConnectionDetails, 
 	ICriticalContainerError, 
-	IDeltaManager, 
-	IDeltaManagerEvents, 
-	IDeltaQueue, 
-	IDeltaQueueEvents, 
-	IDeltaSender, 
 	IErrorBase, 
-	ISelf, 
-	ReadOnlyInfo,
+	ISelf,
  
@@ -35,5 +28,12 @@ // @alpha APIs
 	ICodeDetailsLoader, 
+	IConnectionDetails, 
 	IContainer, 
 	IContainerContext, 
 	IContainerEvents, 
+	IContainerLoadMode, 
+	IDeltaManager, 
+	IDeltaManagerEvents, 
+	IDeltaQueue, 
+	IDeltaQueueEvents, 
+	IDeltaSender, 
 	IFluidBrowserPackage, 
@@ -60,4 +60,5 @@ IFluidBrowserPackageEnvironment,
 	LoaderHeader, 
+	ReadOnlyInfo, 
 	isFluidBrowserPackage, 
 	isFluidPackage
 } from "./index.js";

dist/loader.d.ts

@@ -552,3 +552,3 @@ /*!
 /**
- * @internal
+ * @alpha
  */
@@ -555,0 +555,0 @@ export interface IContainerLoadMode {

dist/public.d.ts

@@ -17,12 +17,5 @@ /*!
 	IAudienceEvents, 
-	IConnectionDetails, 
 	ICriticalContainerError, 
-	IDeltaManager, 
-	IDeltaManagerEvents, 
-	IDeltaQueue, 
-	IDeltaQueueEvents, 
-	IDeltaSender, 
 	IErrorBase, 
-	ISelf, 
-	ReadOnlyInfo
+	ISelf
 } from "./index.js";

lib/deltas.d.ts

@@ -6,7 +6,7 @@ /*!
 import type { IDisposable, IErrorBase, IErrorEvent, IEvent, IEventProvider } from "@fluidframework/core-interfaces";
-import type { IAnyDriverError } from "@fluidframework/driver-definitions";
+import type { IAnyDriverError } from "@fluidframework/driver-definitions/internal";
 import type { IClientConfiguration, IClientDetails, IDocumentMessage, ISequencedDocumentMessage, ISignalMessage, ITokenClaims } from "@fluidframework/protocol-definitions";
 /**
  * Contract representing the result of a newly established connection to the server for syncing deltas.
- * @public
+ * @alpha
  */
@@ -37,3 +37,3 @@ export interface IConnectionDetails {
  * @sealed
- * @public
+ * @alpha
  */
@@ -49,3 +49,3 @@ export interface IDeltaSender {
  * @sealed
- * @public
+ * @alpha
  */
@@ -120,3 +120,3 @@ export interface IDeltaManagerEvents extends IEvent {
  * @sealed
- * @public
+ * @alpha
  */
@@ -194,3 +194,3 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender {
  * @sealed
- * @public
+ * @alpha
  */
@@ -236,3 +236,3 @@ export interface IDeltaQueueEvents<T> extends IErrorEvent {
  * @sealed
- * @public
+ * @alpha
  */
@@ -281,3 +281,3 @@ export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {
 /**
- * @public
+ * @alpha
  */
@@ -284,0 +284,0 @@ export type ReadOnlyInfo = {

lib/legacy.d.ts

@@ -17,12 +17,5 @@ /*!
 	IAudienceEvents, 
-	IConnectionDetails, 
 	ICriticalContainerError, 
-	IDeltaManager, 
-	IDeltaManagerEvents, 
-	IDeltaQueue, 
-	IDeltaQueueEvents, 
-	IDeltaSender, 
 	IErrorBase, 
-	ISelf, 
-	ReadOnlyInfo,
+	ISelf,
  
@@ -35,5 +28,12 @@ // @alpha APIs
 	ICodeDetailsLoader, 
+	IConnectionDetails, 
 	IContainer, 
 	IContainerContext, 
 	IContainerEvents, 
+	IContainerLoadMode, 
+	IDeltaManager, 
+	IDeltaManagerEvents, 
+	IDeltaQueue, 
+	IDeltaQueueEvents, 
+	IDeltaSender, 
 	IFluidBrowserPackage, 
@@ -60,4 +60,5 @@ IFluidBrowserPackageEnvironment,
 	LoaderHeader, 
+	ReadOnlyInfo, 
 	isFluidBrowserPackage, 
 	isFluidPackage
 } from "./index.js";

lib/loader.d.ts

@@ -552,3 +552,3 @@ /*!
 /**
- * @internal
+ * @alpha
  */
@@ -555,0 +555,0 @@ export interface IContainerLoadMode {

lib/public.d.ts

@@ -17,12 +17,5 @@ /*!
 	IAudienceEvents, 
-	IConnectionDetails, 
 	ICriticalContainerError, 
-	IDeltaManager, 
-	IDeltaManagerEvents, 
-	IDeltaQueue, 
-	IDeltaQueueEvents, 
-	IDeltaSender, 
 	IErrorBase, 
-	ISelf, 
-	ReadOnlyInfo
+	ISelf
 } from "./index.js";

lib/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.3"
+      "packageVersion": "7.43.1"
     }
   ]
 }

package.json

 {
   "name": "@fluidframework/container-definitions",
-  "version": "2.0.0-dev-rc.4.0.0.261659",
+  "version": "2.0.0-dev-rc.5.0.0.263932",
   "description": "Fluid container definitions",
@@ -50,4 +50,4 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/driver-definitions": "2.0.0-dev-rc.4.0.0.261659",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.263932",
     "@fluidframework/protocol-definitions": "^3.2.0"
@@ -58,8 +58,8 @@ },
     "@biomejs/biome": "^1.6.2",
-    "@fluid-tools/build-cli": "0.38.0-259537",
+    "@fluid-tools/build-cli": "^0.38.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "0.38.0-259537",
+    "@fluidframework/build-tools": "^0.38.0",
     "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.0.0-rc.3.0.0",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@microsoft/api-extractor": "^7.42.3",
+    "@microsoft/api-extractor": "^7.43.1",
     "copyfiles": "^2.4.1",
@@ -129,4 +129,5 @@ "eslint": "~8.55.0",
     "lint:fix": "fluid-build . --task eslint:fix --task format",
-    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
-    "tsc:watch": "copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist && fluid-tsc commonjs --watch",
+    "place:cjs:package-stub": "copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && npm run place:cjs:package-stub",
+    "tsc:watch": "npm run place:cjs:package-stub && fluid-tsc commonjs --project ./tsconfig.cjs.json --watch",
     "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
@@ -133,0 +134,0 @@ "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"

src/deltas.ts

@@ -13,3 +13,3 @@ /*!
 } from "@fluidframework/core-interfaces";
-import type { IAnyDriverError } from "@fluidframework/driver-definitions";
+import type { IAnyDriverError } from "@fluidframework/driver-definitions/internal";
 import type {
@@ -26,3 +26,3 @@ IClientConfiguration,
  * Contract representing the result of a newly established connection to the server for syncing deltas.
- * @public
+ * @alpha
  */
@@ -56,3 +56,3 @@ export interface IConnectionDetails {
  * @sealed
- * @public
+ * @alpha
  */
@@ -69,3 +69,3 @@ export interface IDeltaSender {
  * @sealed
- * @public
+ * @alpha
  */
@@ -151,3 +151,3 @@ export interface IDeltaManagerEvents extends IEvent {
  * @sealed
- * @public
+ * @alpha
  */
@@ -243,3 +243,3 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender {
  * @sealed
- * @public
+ * @alpha
  */
@@ -288,3 +288,3 @@ export interface IDeltaQueueEvents<T> extends IErrorEvent {
  * @sealed
- * @public
+ * @alpha
  */
@@ -338,3 +338,3 @@ export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {
 /**
- * @public
+ * @alpha
  */
@@ -341,0 +341,0 @@ export type ReadOnlyInfo =

src/loader.ts

@@ -647,3 +647,3 @@ /*!
 /**
- * @internal
+ * @alpha
  */
@@ -650,0 +650,0 @@ export interface IContainerLoadMode {

No alert changes

Improved metrics

Total package byte prevSize

452182

increased by0.39%

Worsened metrics

Lines of code

5483

decreased by-0.22%

Dependency changes

• + Added@fluidframework/core-interfaces@2.0.0-dev-rc.5.0.0.263932(transitive)

• + Added@fluidframework/driver-definitions@2.0.0-dev-rc.5.0.0.263932(transitive)

• - Removed@fluidframework/core-interfaces@2.0.0-dev-rc.4.0.0.261659(transitive)

• - Removed@fluidframework/driver-definitions@2.0.0-dev-rc.4.0.0.261659(transitive)

• Updated@fluidframework/core-interfaces@2.0.0-dev-rc.5.0.0.263932

• Updated@fluidframework/driver-definitions@2.0.0-dev-rc.5.0.0.263932