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

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;
 }
 
 /**