@fluidframework/runtime-definitions 2.0.0-dev-rc.5.0.0.265721 → 2.0.0-dev-rc.5.0.0.268409

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-dev-rc.5.0.0.265721",
+  "version": "2.0.0-dev-rc.5.0.0.268409",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -47,27 +47,27 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/id-compressor": "2.0.0-dev-rc.5.0.0.265721",
-    "@fluidframework/protocol-definitions": "^3.2.0"
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.268409",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.268409",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.268409",
+    "@fluidframework/id-compressor": "2.0.0-dev-rc.5.0.0.268409",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.268409"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@biomejs/biome": "^1.6.2",
+    "@biomejs/biome": "^1.7.3",
     "@fluid-tools/build-cli": "^0.39.0-264124",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.39.0-264124",
-    "@fluidframework/eslint-config-fluid": "^5.1.0",
+    "@fluidframework/eslint-config-fluid": "^5.3.0",
     "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-rc.4.0.0",
-    "@microsoft/api-extractor": "^7.43.1",
+    "@microsoft/api-extractor": "^7.45.1",
     "copyfiles": "^2.4.1",
     "eslint": "~8.55.0",
     "eslint-plugin-deprecation": "~2.0.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
-    "typescript": "~5.3.3"
+    "typescript": "~5.4.5"
   },
   "typeValidation": {
     "broken": {
@@ -87,6 +87,9 @@
         "forwardCompat": false,
         "backCompat": false
       },
+      "InterfaceDeclaration_ITelemetryContext": {
+        "backCompat": false
+      },
       "RemovedInterfaceDeclaration_IFluidDataStoreContextEvents": {
         "forwardCompat": false,
         "backCompat": false

package/src/attribution.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { IUser } from "@fluidframework/protocol-definitions";
+import type { IUser } from "@fluidframework/driver-definitions";
 
 /**
  * AttributionKey representing a reference to some op in the op stream.

package/src/dataStoreContext.ts

@@ -19,15 +19,17 @@ import type {
 	IFluidHandleInternal,
 	IProvideFluidHandleContext,
 } from "@fluidframework/core-interfaces/internal";
-import type { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
-import type { IIdCompressor } from "@fluidframework/id-compressor";
 import type {
 	IClientDetails,
-	IDocumentMessage,
 	IQuorumClients,
 	ISequencedDocumentMessage,
+} from "@fluidframework/driver-definitions";
+import type {
+	IDocumentStorageService,
+	IDocumentMessage,
 	ISnapshotTree,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions/internal";
+import type { IIdCompressor } from "@fluidframework/id-compressor";
 
 import type { IProvideFluidDataStoreFactory } from "./dataStoreFactory.js";
 import type { IProvideFluidDataStoreRegistry } from "./dataStoreRegistry.js";

package/src/index.ts

@@ -61,6 +61,7 @@ export type {
 	ISummaryStats,
 	ISummaryTreeWithStats,
 	ITelemetryContext,
+	ITelemetryContextExt,
 	SummarizeInternalFn,
 } from "./summary.js";
 export {

package/src/protocol.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import type { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
+import type { ISignalMessage } from "@fluidframework/driver-definitions";
+import type { ITree } from "@fluidframework/driver-definitions/internal";
 
 /**
  * An envelope wraps the contents with the intended target
@@ -47,10 +48,10 @@ export interface ISignalEnvelope {
 
 /**
  * Represents ISignalMessage with its type.
- * @public
+ * @alpha
  */
 export interface IInboundSignalMessage extends ISignalMessage {
-	type: string;
+	readonly type: string;
 }
 
 /**

package/src/summary.ts

@@ -4,13 +4,13 @@
  */
 
 import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
+import type { ISequencedDocumentMessage, ISummaryTree } from "@fluidframework/driver-definitions";
 import type {
-	ISequencedDocumentMessage,
 	ISnapshotTree,
-	ISummaryTree,
 	ITree,
 	SummaryTree,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions/internal";
+import type { TelemetryEventPropertyTypeExt } from "@fluidframework/telemetry-utils/internal";
 
 import type {
 	IGarbageCollectionData,
@@ -322,17 +322,17 @@ export const channelsTreeName = ".channels";
 
 /**
  * Contains telemetry data relevant to summarization workflows.
- * This object is expected to be modified directly by various summarize methods.
- * @alpha
+ * This object, in contrast to ITelemetryContext, is expected to be modified directly by various summarize methods.
+ * @internal
  */
-export interface ITelemetryContext {
+export interface ITelemetryContextExt {
 	/**
 	 * Sets value for telemetry data being tracked.
 	 * @param prefix - unique prefix to tag this data with (ex: "fluid:map:")
 	 * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
 	 * @param value - value to attribute to this summary telemetry data
 	 */
-	set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
+	set(prefix: string, property: string, value: TelemetryEventPropertyTypeExt): void;
 
 	/**
 	 * Sets multiple values for telemetry data being tracked.
@@ -343,28 +343,35 @@ export interface ITelemetryContext {
 	setMultiple(
 		prefix: string,
 		property: string,
-		values: Record<string, TelemetryBaseEventPropertyType>,
+		values: Record<string, TelemetryEventPropertyTypeExt>,
 	): void;
+}
 
+/**
+ * Contains telemetry data relevant to summarization workflows.
+ * This object is expected to be modified directly by various summarize methods.
+ * @alpha
+ */
+export interface ITelemetryContext {
 	/**
-	 * Get the telemetry data being tracked
-	 *
-	 * @deprecated This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.
-	 *
-	 * @param prefix - unique prefix for this data (ex: "fluid:map:")
+	 * Sets value for telemetry data being tracked.
+	 * @param prefix - unique prefix to tag this data with (ex: "fluid:map:")
 	 * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
-	 * @returns undefined if item not found
+	 * @param value - value to attribute to this summary telemetry data
 	 */
-	get(prefix: string, property: string): TelemetryBaseEventPropertyType;
+	set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
 
 	/**
-	 * Returns a serialized version of all the telemetry data.
-	 * Should be used when logging in telemetry events.
-	 *
-	 * @deprecated This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function
-	 * but this functionality should not be used by other code being given an ITelemetryContext.
+	 * Sets multiple values for telemetry data being tracked.
+	 * @param prefix - unique prefix to tag this data with (ex: "fluid:summarize:")
+	 * @param property - property name of the telemetry data being tracked (ex: "Options")
+	 * @param values - A set of values to attribute to this summary telemetry data.
 	 */
-	serialize(): string;
+	setMultiple(
+		prefix: string,
+		property: string,
+		values: Record<string, TelemetryBaseEventPropertyType>,
+	): void;
 }
 
 /**