@fluidframework/runtime-definitions 2.0.0-dev-rc.1.0.0.225277 → 2.0.0-dev-rc.1.0.0.232845

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-dev-rc.1.0.0.225277",
+  "version": "2.0.0-dev-rc.1.0.0.232845",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -18,63 +18,39 @@
       "default": "./dist/index.js"
     },
     "./alpha": {
-      "import": {
-        "types": "./lib/runtime-definitions-alpha.d.mts",
-        "default": "./lib/index.mjs"
-      },
-      "require": {
-        "types": "./dist/runtime-definitions-alpha.d.ts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/runtime-definitions-alpha.d.ts",
+      "default": "./dist/index.js"
     },
     "./beta": {
-      "import": {
-        "types": "./lib/runtime-definitions-beta.d.mts",
-        "default": "./lib/index.mjs"
-      },
-      "require": {
-        "types": "./dist/runtime-definitions-beta.d.ts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/runtime-definitions-beta.d.ts",
+      "default": "./dist/index.js"
     },
     "./internal": {
-      "import": {
-        "types": "./lib/index.d.mts",
-        "default": "./lib/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./public": {
-      "import": {
-        "types": "./lib/runtime-definitions-public.d.mts",
-        "default": "./lib/index.mjs"
-      },
-      "require": {
-        "types": "./dist/runtime-definitions-public.d.ts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/runtime-definitions-public.d.ts",
+      "default": "./dist/index.js"
     }
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/id-compressor": "2.0.0-dev-rc.1.0.0.225277",
-    "@fluidframework/protocol-definitions": "^3.1.0-223007"
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/id-compressor": "2.0.0-dev-rc.1.0.0.232845",
+    "@fluidframework/protocol-definitions": "^3.2.0-231454"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluid-tools/build-cli": "^0.29.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "0.29.0-222379",
-    "@fluidframework/eslint-config-fluid": "^3.1.0",
+    "@fluidframework/build-tools": "^0.29.0",
+    "@fluidframework/eslint-config-fluid": "^3.3.0",
     "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-internal.8.0.0",
-    "@microsoft/api-extractor": "^7.38.3",
+    "@microsoft/api-extractor": "^7.39.1",
     "copyfiles": "^2.4.1",
     "eslint": "~8.50.0",
     "eslint-plugin-deprecation": "~2.0.0",
@@ -94,7 +70,52 @@
     }
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "RemovedInterfaceDeclaration_IIdCompressorCore": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedClassDeclaration_IdCompressor": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_IIdCompressor": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_IdCreationRange": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_OpSpaceCompressedId": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_SerializedIdCompressor": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_SerializedIdCompressorWithNoSession": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_SerializedIdCompressorWithOngoingSession": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_SessionId": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_SessionSpaceCompressedId": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_StableId": {
+        "forwardCompat": false,
+        "backCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",

package/src/dataStoreContext.ts

@@ -170,7 +170,9 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
 
 	/**
 	 * Invokes the given callback and guarantees that all operations generated within the callback will be ordered
-	 * sequentially. Total size of all messages must be less than maxOpSize.
+	 * sequentially.
+	 *
+	 * If the callback throws an error, the container will close and the error will be logged.
 	 */
 	orderSequentially(callback: () => void): void;
 
@@ -197,14 +199,22 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
 	 * already attached DDS (or non-attached DDS that will eventually get attached to storage) will result in this
 	 * store being attached to storage.
 	 * @param pkg - Package name of the data store factory
+	 * @param groupId - group to which this data stores belongs to. This is also known at service side and can be used to
+	 * fetch snapshot contents like snapshot tree, blobs using this id from the storage.
 	 */
-	createDataStore(pkg: string | string[]): Promise<IDataStore>;
+	createDataStore(pkg: string | string[], groupId?: string): Promise<IDataStore>;
 
 	/**
 	 * Creates detached data store context. Only after context.attachRuntime() is called,
 	 * data store initialization is considered complete.
+	 * @param pkg - Package name of the data store factory
+	 * @param groupId - group to which this data stores belongs to. This is also known at service side and can be used to
+	 * fetch snapshot contents like snapshot tree, blobs using this id from the storage.
 	 */
-	createDetachedDataStore(pkg: Readonly<string[]>): IFluidDataStoreContextDetached;
+	createDetachedDataStore(
+		pkg: Readonly<string[]>,
+		groupId?: string,
+	): IFluidDataStoreContextDetached;
 
 	/**
 	 * Get an absolute url for a provided container-relative request.
@@ -382,6 +392,8 @@ export interface IFluidDataStoreContext
 	readonly logger: ITelemetryBaseLogger;
 	readonly clientDetails: IClientDetails;
 	readonly idCompressor?: IIdCompressor;
+	// Represents the group to which the data store belongs too.
+	readonly groupId?: string;
 	/**
 	 * Indicates the attachment state of the data store to a host service.
 	 */
@@ -481,6 +493,9 @@ export interface IFluidDataStoreContext
 	getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
 
 	/**
+	 * @deprecated There is no replacement for this, its functionality is no longer needed at this layer.
+	 * It will be removed in a future release, sometime after 2.0.0-internal.8.0.0
+	 *
 	 * Called when a new outbound reference is added to another node. This is used by garbage collection to identify
 	 * all references added in the system.
 	 * @param srcHandle - The handle of the node that added the reference.

package/src/index.ts

@@ -65,52 +65,3 @@ export {
 	SummarizeInternalFn,
 	totalBlobSizePropertyName,
 } from "./summary";
-
-// Re-exports for backwards compatibility.
-// Will be removed in the future.
-export {
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	IdCompressor,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	IIdCompressor,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	IIdCompressorCore,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	IdCreationRange,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	OpSpaceCompressedId,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	SerializedIdCompressor,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	SerializedIdCompressorWithNoSession,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	SerializedIdCompressorWithOngoingSession,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	SessionId,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	SessionSpaceCompressedId,
-	/**
-	 * @deprecated Import from `@fluidframework/id-compressor` instead.
-	 */
-	StableId,
-} from "@fluidframework/id-compressor";

package/src/protocol.ts

@@ -23,6 +23,7 @@ export interface IEnvelope {
 
 /**
  * @internal
+ * @deprecated - This interface is now moved to `@fluidframework/container-definitions` package. Please import from that package.
  */
 export interface ISignalEnvelope {
 	/**

package/src/summary.ts

@@ -125,16 +125,6 @@ export interface ISummarizerNodeConfig {
 	 * Defaults to true.
 	 */
 	readonly canReuseHandle?: boolean;
-	/**
-	 * True to always stop execution on error during summarize, or false to
-	 * attempt creating a summary that is a pointer ot the last acked summary
-	 * plus outstanding ops in case of internal summarize failure.
-	 * Defaults to false.
-	 *
-	 * BUG BUG: Default to true while we investigate problem
-	 * with differential summaries
-	 */
-	readonly throwOnFailure?: true;
 }
 
 /**
@@ -187,9 +177,6 @@ export interface ISummarizerNode {
 	invalidate(sequenceNumber: number): void;
 	/**
 	 * Calls the internal summarize function and handles internal state tracking.
-	 * If unchanged and fullTree is false, it will reuse previous summary subtree.
-	 * If an error is encountered and throwOnFailure is false, it will try to make
-	 * a summary with a pointer to the previous summary + a blob of outstanding ops.
 	 * @param fullTree - true to skip optimizations and always generate the full tree
 	 * @param trackState - indicates whether the summarizer node should track the state of the summary or not
 	 * @param telemetryContext - summary data passed through the layers for telemetry purposes