@fluidframework/runtime-definitions - npm Package Compare versions

Comparing version 2.0.0-rc.4.0.6 to 2.0.0-rc.5.0.0

api-extractor.json

 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.current.json"
 }

CHANGELOG.md

 # @fluidframework/runtime-definitions
 
+## 2.0.0-rc.5.0.0
+
+### Minor Changes
+
+-   fluid-framework: Type Erase ISharedObjectKind ([#21081](https://github.com/microsoft/FluidFramework/pull/21081)) [78f228e370](https://github.com/microsoft/FluidFramework/commit/78f228e37055bd4d9a8f02b3a1eefebf4da9c59c)
+
+    A new type, `SharedObjectKind` is added as a type erased version of `ISharedObjectKind` and `DataObjectClass`.
+
+    This type fills the role of both `ISharedObjectKind` and `DataObjectClass` in the `@public` "declarative API" exposed in the `fluid-framework` package.
+
+    This allows several types referenced by `ISharedObjectKind` to be made `@alpha` as they should only need to be used by legacy code and users of the unstable/alpha/legacy "encapsulated API".
+
+    Access to these now less public types should not be required for users of the `@public` "declarative API" exposed in the `fluid-framework` package, but can still be accessed for those who need them under the `/legacy` import paths.
+    The full list of such types is:
+
+    -   `SharedTree` as exported from `@fluidframwork/tree`: It is still exported as `@public` from `fluid-framework` as `SharedObjectKind`.
+    -   `ISharedObjectKind`: See new `SharedObjectKind` type for use in `@public` APIs.
+        `ISharedObject`
+    -   `IChannel`
+    -   `IChannelAttributes`
+    -   `IChannelFactory`
+    -   `IExperimentalIncrementalSummaryContext`
+    -   `IGarbageCollectionData`
+    -   `ISummaryStats`
+    -   `ISummaryTreeWithStats`
+    -   `ITelemetryContext`
+    -   `IDeltaManagerErased`
+    -   `IFluidDataStoreRuntimeEvents`
+    -   `IFluidHandleContext`
+    -   `IProvideFluidHandleContext`
+
+    Removed APIs:
+
+    -   `DataObjectClass`: Usages replaced with `SharedObjectKind`.
+    -   `LoadableObjectClass`: Replaced with `SharedObjectKind`.
+    -   `LoadableObjectClassRecord`: Replaced with `Record<string, SharedObjectKind>`.
+    -
+
+-   Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
+
+    Update package implementations to use TypeScript 5.4.5.
+
+-   runtime-definitions: Remove deprecated 'get' and 'serialize' members on the ITelemetryContext interface ([#21009](https://github.com/microsoft/FluidFramework/pull/21009)) [c0483b49a3](https://github.com/microsoft/FluidFramework/commit/c0483b49a31df87b3a7d3eafd4175efd5eb1762f)
+
+    The `ITelemetryContext` interface was not intended to allow getting properties that had been added to it, so it is now "write-only". Internal usage within FluidFramework should use the new `ITelemetryContextExt`.
+
+-   runtime-definitions: Make IInboundSignalMessage alpha and readonly ([#21226](https://github.com/microsoft/FluidFramework/pull/21226)) [1df91dd844](https://github.com/microsoft/FluidFramework/commit/1df91dd844bebcb6c837370827b244a01eca8295)
+
+    Users of `IInboundSignalMessage` will need to import it from the `/legacy` scope and should not mutate it.
+    Only users of existing `@alpha` APIs like `IFluidDataStoreRuntime` should be able to use this type, so it should not introduce new `/legacy` usage.
+
 ## 2.0.0-rc.4.0.0
@@ -4,0 +55,0 @@

dist/attribution.d.ts

@@ -5,3 +5,3 @@ /*!
  */
-import type { IUser } from "@fluidframework/protocol-definitions";
+import type { IUser } from "@fluidframework/driver-definitions";
 /**
@@ -8,0 +8,0 @@ * AttributionKey representing a reference to some op in the op stream.

dist/dataStoreContext.d.ts

@@ -7,6 +7,7 @@ /*!
 import type { IDeltaManager } from "@fluidframework/container-definitions/internal";
-import type { FluidObject, IDisposable, IEvent, IEventProvider, IFluidHandle, IFluidHandleInternal, IProvideFluidHandleContext, IRequest, IResponse, ITelemetryBaseLogger } from "@fluidframework/core-interfaces/internal";
-import type { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
+import type { FluidObject, IDisposable, IEvent, IEventProvider, IFluidHandle, IRequest, IResponse, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type { IFluidHandleInternal, IProvideFluidHandleContext } from "@fluidframework/core-interfaces/internal";
+import type { IClientDetails, IQuorumClients } from "@fluidframework/driver-definitions";
+import type { IDocumentStorageService, IDocumentMessage, ISnapshotTree, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
-import type { IClientDetails, IDocumentMessage, IQuorumClients, ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
 import type { IProvideFluidDataStoreFactory } from "./dataStoreFactory.js";
@@ -135,3 +136,3 @@ import type { IProvideFluidDataStoreRegistry } from "./dataStoreRegistry.js";
 export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
-    readonly logger: ITelemetryBaseLogger;
+    readonly baseLogger: ITelemetryBaseLogger;
     readonly clientDetails: IClientDetails;
@@ -236,7 +237,7 @@ readonly disposed: boolean;
      */
-    getAttachGCData?(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
+    getAttachGCData(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
     /**
      * Processes the op.
      */
-    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown, addedOutboundReference?: (fromNodePath: string, toNodePath: string) => void): void;
+    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
     /**
@@ -317,3 +318,3 @@ * Processes the signal.
     readonly storage: IDocumentStorageService;
-    readonly logger: ITelemetryBaseLogger;
+    readonly baseLogger: ITelemetryBaseLogger;
     readonly clientDetails: IClientDetails;
@@ -399,18 +400,2 @@ readonly idCompressor?: IIdCompressor;
     /**
-     * @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
-     *
-     * Similar capability is exposed with from/to string paths instead of handles via @see addedGCOutboundRoute
-     *
-     * 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.
-     * @param outboundHandle - The handle of the outbound node that is referenced.
-     */
-    addedGCOutboundReference?(srcHandle: {
-        absolutePath: string;
-    }, outboundHandle: {
-        absolutePath: string;
-    }): void;
-    /**
      * Called by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.
@@ -420,2 +405,11 @@ * @param address - The address of the channel that is dirty.
     setChannelDirty(address: string): void;
+    /**
+     * 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 fromPath - The absolute path of the node that added the reference.
+     * @param toPath - The absolute path of the outbound node that is referenced.
+     * @param messageTimestampMs - The timestamp of the message that added the reference.
+     */
+    addedGCOutboundRoute(fromPath: string, toPath: string, messageTimestampMs?: number): void;
 }
@@ -454,12 +448,2 @@ /**
     getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
-    /**
-     * (Same as @see addedGCOutboundReference, but with string paths instead of handles)
-     *
-     * 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 fromPath - The absolute path of the node that added the reference.
-     * @param toPath - The absolute path of the outbound node that is referenced.
-     */
-    addedGCOutboundRoute?(fromPath: string, toPath: string): void;
 }
@@ -466,0 +450,0 @@ /**

dist/garbageCollectionDefinitions.d.ts

@@ -38,3 +38,3 @@ /*!
  * Used for running GC in the Container.
- * @public
+ * @alpha
  */
@@ -41,0 +41,0 @@ export interface IGarbageCollectionData {

dist/index.d.ts

@@ -15,4 +15,4 @@ /*!
 export type { IAttachMessage, IEnvelope, IInboundSignalMessage, InboundAttachMessage, ISignalEnvelope, } from "./protocol.js";
-export type { CreateChildSummarizerNodeParam, IExperimentalIncrementalSummaryContext, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, SummarizeInternalFn, } from "./summary.js";
+export type { CreateChildSummarizerNodeParam, IExperimentalIncrementalSummaryContext, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, ITelemetryContextExt, SummarizeInternalFn, } from "./summary.js";
 export { blobCountPropertyName, channelsTreeName, CreateSummarizerNodeSource, totalBlobSizePropertyName, } from "./summary.js";
 //# sourceMappingURL=index.d.ts.map

dist/legacy.d.ts

@@ -12,10 +12,2 @@ /*!
 export {
-	// @public APIs
-	IExperimentalIncrementalSummaryContext, 
-	IGarbageCollectionData, 
-	IInboundSignalMessage, 
-	ISummaryStats, 
-	ISummaryTreeWithStats, 
-	ITelemetryContext,
- 
 	// @alpha APIs
@@ -36,2 +28,3 @@ AliasResult,
 	IEnvelope, 
+	IExperimentalIncrementalSummaryContext, 
 	IFluidDataStoreChannel, 
@@ -43,3 +36,5 @@ IFluidDataStoreContext,
 	IFluidParentContext, 
+	IGarbageCollectionData, 
 	IGarbageCollectionDetailsBase, 
+	IInboundSignalMessage, 
 	IProvideFluidDataStoreFactory, 
@@ -53,2 +48,5 @@ IProvideFluidDataStoreRegistry,
 	ISummarizerNodeWithGC, 
+	ISummaryStats, 
+	ISummaryTreeWithStats, 
+	ITelemetryContext, 
 	InboundAttachMessage, 
@@ -55,0 +53,0 @@ LocalAttributionKey,

dist/protocol.d.ts

@@ -5,3 +5,3 @@ /*!
  */
-import type { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
+import type { ITree, ISignalMessage } from "@fluidframework/driver-definitions/internal";
 /**
@@ -44,6 +44,6 @@ * An envelope wraps the contents with the intended target
  * Represents ISignalMessage with its type.
- * @public
+ * @alpha
  */
 export interface IInboundSignalMessage extends ISignalMessage {
-    type: string;
+    readonly type: string;
 }
@@ -50,0 +50,0 @@ /**

dist/public.d.ts

@@ -11,10 +11,3 @@ /*!
 
-export {
-	// @public APIs
-	IExperimentalIncrementalSummaryContext, 
-	IGarbageCollectionData, 
-	IInboundSignalMessage, 
-	ISummaryStats, 
-	ISummaryTreeWithStats, 
-	ITelemetryContext
-} from "./index.js";
+export {}
+

dist/summary.d.ts

@@ -6,7 +6,9 @@ /*!
 import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
-import type { ISequencedDocumentMessage, ISnapshotTree, ISummaryTree, ITree, SummaryTree } from "@fluidframework/protocol-definitions";
+import type { ISummaryTree } from "@fluidframework/driver-definitions";
+import type { ISnapshotTree, ITree, SummaryTree, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { TelemetryEventPropertyTypeExt } from "@fluidframework/telemetry-utils/internal";
 import type { IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbageCollectionDefinitions.js";
 /**
  * Contains the aggregation data from a Tree/Subtree.
- * @public
+ * @alpha
  */
@@ -26,3 +28,3 @@ export interface ISummaryStats {
  * will be taking part of the summarization process.
- * @public
+ * @alpha
  */
@@ -74,3 +76,3 @@ export interface ISummaryTreeWithStats {
  * Contains the necessary information to allow DDSes to do incremental summaries
- * @public
+ * @alpha
  */
@@ -280,6 +282,6 @@ export interface IExperimentalIncrementalSummaryContext {
  * Contains telemetry data relevant to summarization workflows.
- * This object is expected to be modified directly by various summarize methods.
- * @public
+ * This object, in contrast to ITelemetryContext, is expected to be modified directly by various summarize methods.
+ * @internal
  */
-export interface ITelemetryContext {
+export interface ITelemetryContextExt {
     /**
@@ -291,3 +293,3 @@ * Sets value for telemetry data being tracked.
      */
-    set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
+    set(prefix: string, property: string, value: TelemetryEventPropertyTypeExt): void;
     /**
@@ -299,21 +301,24 @@ * Sets multiple values for telemetry data being tracked.
      */
-    setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
+    setMultiple(prefix: string, property: string, 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;
 }
@@ -320,0 +325,0 @@ /**

lib/attribution.d.ts

@@ -5,3 +5,3 @@ /*!
  */
-import type { IUser } from "@fluidframework/protocol-definitions";
+import type { IUser } from "@fluidframework/driver-definitions";
 /**
@@ -8,0 +8,0 @@ * AttributionKey representing a reference to some op in the op stream.

lib/dataStoreContext.d.ts

@@ -7,6 +7,7 @@ /*!
 import type { IDeltaManager } from "@fluidframework/container-definitions/internal";
-import type { FluidObject, IDisposable, IEvent, IEventProvider, IFluidHandle, IFluidHandleInternal, IProvideFluidHandleContext, IRequest, IResponse, ITelemetryBaseLogger } from "@fluidframework/core-interfaces/internal";
-import type { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
+import type { FluidObject, IDisposable, IEvent, IEventProvider, IFluidHandle, IRequest, IResponse, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import type { IFluidHandleInternal, IProvideFluidHandleContext } from "@fluidframework/core-interfaces/internal";
+import type { IClientDetails, IQuorumClients } from "@fluidframework/driver-definitions";
+import type { IDocumentStorageService, IDocumentMessage, ISnapshotTree, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
 import type { IIdCompressor } from "@fluidframework/id-compressor";
-import type { IClientDetails, IDocumentMessage, IQuorumClients, ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
 import type { IProvideFluidDataStoreFactory } from "./dataStoreFactory.js";
@@ -135,3 +136,3 @@ import type { IProvideFluidDataStoreRegistry } from "./dataStoreRegistry.js";
 export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
-    readonly logger: ITelemetryBaseLogger;
+    readonly baseLogger: ITelemetryBaseLogger;
     readonly clientDetails: IClientDetails;
@@ -236,7 +237,7 @@ readonly disposed: boolean;
      */
-    getAttachGCData?(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
+    getAttachGCData(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
     /**
      * Processes the op.
      */
-    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown, addedOutboundReference?: (fromNodePath: string, toNodePath: string) => void): void;
+    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
     /**
@@ -317,3 +318,3 @@ * Processes the signal.
     readonly storage: IDocumentStorageService;
-    readonly logger: ITelemetryBaseLogger;
+    readonly baseLogger: ITelemetryBaseLogger;
     readonly clientDetails: IClientDetails;
@@ -399,18 +400,2 @@ readonly idCompressor?: IIdCompressor;
     /**
-     * @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
-     *
-     * Similar capability is exposed with from/to string paths instead of handles via @see addedGCOutboundRoute
-     *
-     * 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.
-     * @param outboundHandle - The handle of the outbound node that is referenced.
-     */
-    addedGCOutboundReference?(srcHandle: {
-        absolutePath: string;
-    }, outboundHandle: {
-        absolutePath: string;
-    }): void;
-    /**
      * Called by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.
@@ -420,2 +405,11 @@ * @param address - The address of the channel that is dirty.
     setChannelDirty(address: string): void;
+    /**
+     * 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 fromPath - The absolute path of the node that added the reference.
+     * @param toPath - The absolute path of the outbound node that is referenced.
+     * @param messageTimestampMs - The timestamp of the message that added the reference.
+     */
+    addedGCOutboundRoute(fromPath: string, toPath: string, messageTimestampMs?: number): void;
 }
@@ -454,12 +448,2 @@ /**
     getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
-    /**
-     * (Same as @see addedGCOutboundReference, but with string paths instead of handles)
-     *
-     * 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 fromPath - The absolute path of the node that added the reference.
-     * @param toPath - The absolute path of the outbound node that is referenced.
-     */
-    addedGCOutboundRoute?(fromPath: string, toPath: string): void;
 }
@@ -466,0 +450,0 @@ /**

lib/garbageCollectionDefinitions.d.ts

@@ -38,3 +38,3 @@ /*!
  * Used for running GC in the Container.
- * @public
+ * @alpha
  */
@@ -41,0 +41,0 @@ export interface IGarbageCollectionData {

lib/index.d.ts

@@ -15,4 +15,4 @@ /*!
 export type { IAttachMessage, IEnvelope, IInboundSignalMessage, InboundAttachMessage, ISignalEnvelope, } from "./protocol.js";
-export type { CreateChildSummarizerNodeParam, IExperimentalIncrementalSummaryContext, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, SummarizeInternalFn, } from "./summary.js";
+export type { CreateChildSummarizerNodeParam, IExperimentalIncrementalSummaryContext, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, ITelemetryContextExt, SummarizeInternalFn, } from "./summary.js";
 export { blobCountPropertyName, channelsTreeName, CreateSummarizerNodeSource, totalBlobSizePropertyName, } from "./summary.js";
 //# sourceMappingURL=index.d.ts.map

lib/legacy.d.ts

@@ -12,10 +12,2 @@ /*!
 export {
-	// @public APIs
-	IExperimentalIncrementalSummaryContext, 
-	IGarbageCollectionData, 
-	IInboundSignalMessage, 
-	ISummaryStats, 
-	ISummaryTreeWithStats, 
-	ITelemetryContext,
- 
 	// @alpha APIs
@@ -36,2 +28,3 @@ AliasResult,
 	IEnvelope, 
+	IExperimentalIncrementalSummaryContext, 
 	IFluidDataStoreChannel, 
@@ -43,3 +36,5 @@ IFluidDataStoreContext,
 	IFluidParentContext, 
+	IGarbageCollectionData, 
 	IGarbageCollectionDetailsBase, 
+	IInboundSignalMessage, 
 	IProvideFluidDataStoreFactory, 
@@ -53,2 +48,5 @@ IProvideFluidDataStoreRegistry,
 	ISummarizerNodeWithGC, 
+	ISummaryStats, 
+	ISummaryTreeWithStats, 
+	ITelemetryContext, 
 	InboundAttachMessage, 
@@ -55,0 +53,0 @@ LocalAttributionKey,

lib/protocol.d.ts

@@ -5,3 +5,3 @@ /*!
  */
-import type { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
+import type { ITree, ISignalMessage } from "@fluidframework/driver-definitions/internal";
 /**
@@ -44,6 +44,6 @@ * An envelope wraps the contents with the intended target
  * Represents ISignalMessage with its type.
- * @public
+ * @alpha
  */
 export interface IInboundSignalMessage extends ISignalMessage {
-    type: string;
+    readonly type: string;
 }
@@ -50,0 +50,0 @@ /**

lib/public.d.ts

@@ -11,10 +11,3 @@ /*!
 
-export {
-	// @public APIs
-	IExperimentalIncrementalSummaryContext, 
-	IGarbageCollectionData, 
-	IInboundSignalMessage, 
-	ISummaryStats, 
-	ISummaryTreeWithStats, 
-	ITelemetryContext
-} from "./index.js";
+export {}
+

lib/summary.d.ts

@@ -6,7 +6,9 @@ /*!
 import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
-import type { ISequencedDocumentMessage, ISnapshotTree, ISummaryTree, ITree, SummaryTree } from "@fluidframework/protocol-definitions";
+import type { ISummaryTree } from "@fluidframework/driver-definitions";
+import type { ISnapshotTree, ITree, SummaryTree, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { TelemetryEventPropertyTypeExt } from "@fluidframework/telemetry-utils/internal";
 import type { IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbageCollectionDefinitions.js";
 /**
  * Contains the aggregation data from a Tree/Subtree.
- * @public
+ * @alpha
  */
@@ -26,3 +28,3 @@ export interface ISummaryStats {
  * will be taking part of the summarization process.
- * @public
+ * @alpha
  */
@@ -74,3 +76,3 @@ export interface ISummaryTreeWithStats {
  * Contains the necessary information to allow DDSes to do incremental summaries
- * @public
+ * @alpha
  */
@@ -280,6 +282,6 @@ export interface IExperimentalIncrementalSummaryContext {
  * Contains telemetry data relevant to summarization workflows.
- * This object is expected to be modified directly by various summarize methods.
- * @public
+ * This object, in contrast to ITelemetryContext, is expected to be modified directly by various summarize methods.
+ * @internal
  */
-export interface ITelemetryContext {
+export interface ITelemetryContextExt {
     /**
@@ -291,3 +293,3 @@ * Sets value for telemetry data being tracked.
      */
-    set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
+    set(prefix: string, property: string, value: TelemetryEventPropertyTypeExt): void;
     /**
@@ -299,21 +301,24 @@ * Sets multiple values for telemetry data being tracked.
      */
-    setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
+    setMultiple(prefix: string, property: string, 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;
 }
@@ -320,0 +325,0 @@ /**

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.43.1"
+      "packageVersion": "7.45.1"
     }
   ]
 }

package.json

 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-rc.4.0.6",
+  "version": "2.0.0-rc.5.0.0",
   "description": "Fluid Runtime definitions",
@@ -50,17 +50,18 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluidframework/container-definitions": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/id-compressor": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
-    "@fluidframework/protocol-definitions": "^3.2.0"
+    "@fluidframework/container-definitions": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
+    "@fluidframework/id-compressor": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
-    "@biomejs/biome": "^1.6.2",
-    "@fluid-tools/build-cli": "^0.38.0",
+    "@biomejs/biome": "^1.7.3",
+    "@fluid-tools/build-cli": "^0.39.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.38.0",
-    "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-rc.3.0.0",
-    "@microsoft/api-extractor": "^7.43.1",
+    "@fluidframework/build-tools": "^0.39.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.45.1",
+    "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
@@ -71,9 +72,29 @@ "eslint": "~8.55.0",
     "rimraf": "^4.4.0",
-    "typescript": "~5.1.6"
+    "typescript": "~5.4.5"
   },
   "typeValidation": {
     "broken": {
-      "InterfaceDeclaration_IDataStore": {
-        "forwardCompat": false
+      "InterfaceDeclaration_IContainerRuntimeBase": {
+        "forwardCompat": false,
+        "backCompat": false
       },
+      "InterfaceDeclaration_IFluidDataStoreContext": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IFluidDataStoreContextDetached": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IFluidParentContext": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_ITelemetryContext": {
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_IFluidDataStoreContextEvents": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
       "InterfaceDeclaration_IFluidDataStoreChannel": {
@@ -96,4 +117,11 @@ "forwardCompat": false
     "check:are-the-types-wrong": "attw --pack .",
+    "check:biome": "biome check . --formatter-enabled=true",
+    "check:exports": "concurrently \"npm:check:exports:*\"",
+    "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
+    "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
+    "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
+    "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
+    "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
+    "check:format": "npm run check:biome",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
-    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
@@ -103,3 +131,4 @@ "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "format": "fluid-build --task format .",
+    "format": "npm run format:biome",
+    "format:biome": "biome check . --formatter-enabled=true --apply",
     "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
@@ -106,0 +135,0 @@ "lint": "fluid-build . --task lint",

src/attribution.ts

@@ -6,3 +6,3 @@ /*!
 
-import type { IUser } from "@fluidframework/protocol-definitions";
+import type { IUser } from "@fluidframework/driver-definitions";
 
@@ -9,0 +9,0 @@ /**

src/dataStoreContext.ts

@@ -14,17 +14,18 @@ /*!
 	IFluidHandle,
-	IFluidHandleInternal,
-	IProvideFluidHandleContext,
 	IRequest,
 	IResponse,
 	ITelemetryBaseLogger,
+} from "@fluidframework/core-interfaces";
+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, IQuorumClients } from "@fluidframework/driver-definitions";
 import type {
-	IClientDetails,
+	IDocumentStorageService,
 	IDocumentMessage,
-	IQuorumClients,
+	ISnapshotTree,
 	ISequencedDocumentMessage,
-	ISnapshotTree,
-} from "@fluidframework/protocol-definitions";
+} from "@fluidframework/driver-definitions/internal";
+import type { IIdCompressor } from "@fluidframework/id-compressor";
 
@@ -174,3 +175,3 @@ import type { IProvideFluidDataStoreFactory } from "./dataStoreFactory.js";
 export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
-	readonly logger: ITelemetryBaseLogger;
+	readonly baseLogger: ITelemetryBaseLogger;
 	readonly clientDetails: IClientDetails;
@@ -215,3 +216,6 @@ readonly disposed: boolean;
 	 */
-	createDataStore(pkg: Readonly<string | string[]>, loadingGroupId?: string): Promise<IDataStore>;
+	createDataStore(
+		pkg: Readonly<string | string[]>,
+		loadingGroupId?: string,
+	): Promise<IDataStore>;
 
@@ -238,3 +242,6 @@ /**
 
-	uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
+	uploadBlob(
+		blob: ArrayBufferLike,
+		signal?: AbortSignal,
+	): Promise<IFluidHandle<ArrayBufferLike>>;
 
@@ -298,3 +305,3 @@ /**
 	 */
-	getAttachGCData?(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
+	getAttachGCData(telemetryContext?: ITelemetryContext): IGarbageCollectionData;
 
@@ -304,8 +311,3 @@ /**
 	 */
-	process(
-		message: ISequencedDocumentMessage,
-		local: boolean,
-		localOpMetadata: unknown,
-		addedOutboundReference?: (fromNodePath: string, toNodePath: string) => void,
-	): void;
+	process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
 
@@ -408,3 +410,3 @@ /**
 	readonly storage: IDocumentStorageService;
-	readonly logger: ITelemetryBaseLogger;
+	readonly baseLogger: ITelemetryBaseLogger;
 	readonly clientDetails: IClientDetails;
@@ -508,22 +510,16 @@ readonly idCompressor?: IIdCompressor;
 	/**
-	 * @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
-	 *
-	 * Similar capability is exposed with from/to string paths instead of handles via @see addedGCOutboundRoute
-	 *
-	 * 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.
-	 * @param outboundHandle - The handle of the outbound node that is referenced.
+	 * Called by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.
+	 * @param address - The address of the channel that is dirty.
 	 */
-	addedGCOutboundReference?(
-		srcHandle: { absolutePath: string },
-		outboundHandle: { absolutePath: string },
-	): void;
+	setChannelDirty(address: string): void;
 
 	/**
-	 * Called by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.
-	 * @param address - The address of the channel that is dirty.
+	 * 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 fromPath - The absolute path of the node that added the reference.
+	 * @param toPath - The absolute path of the outbound node that is referenced.
+	 * @param messageTimestampMs - The timestamp of the message that added the reference.
 	 */
-	setChannelDirty(address: string): void;
+	addedGCOutboundRoute(fromPath: string, toPath: string, messageTimestampMs?: number): void;
 }
@@ -565,13 +561,2 @@
 	getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
-
-	/**
-	 * (Same as @see addedGCOutboundReference, but with string paths instead of handles)
-	 *
-	 * 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 fromPath - The absolute path of the node that added the reference.
-	 * @param toPath - The absolute path of the outbound node that is referenced.
-	 */
-	addedGCOutboundRoute?(fromPath: string, toPath: string): void;
 }
@@ -578,0 +563,0 @@

src/dataStoreFactory.ts

@@ -11,3 +11,4 @@ /*!
  */
-export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory = "IFluidDataStoreFactory";
+export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory =
+	"IFluidDataStoreFactory";
 
@@ -14,0 +15,0 @@ /**

src/garbageCollectionDefinitions.ts

@@ -40,3 +40,3 @@ /*!
  * Used for running GC in the Container.
- * @public
+ * @alpha
  */
@@ -43,0 +43,0 @@ export interface IGarbageCollectionData {

src/index.ts

@@ -64,2 +64,3 @@ /*!
 	ITelemetryContext,
+	ITelemetryContextExt,
 	SummarizeInternalFn,
@@ -66,0 +67,0 @@ } from "./summary.js";

src/protocol.ts

@@ -6,3 +6,3 @@ /*!
 
-import type { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
+import type { ITree, ISignalMessage } from "@fluidframework/driver-definitions/internal";
 
@@ -51,6 +51,6 @@ /**
  * Represents ISignalMessage with its type.
- * @public
+ * @alpha
  */
 export interface IInboundSignalMessage extends ISignalMessage {
-	type: string;
+	readonly type: string;
 }
@@ -57,0 +57,0 @@

src/summary.ts

@@ -7,9 +7,10 @@ /*!
 import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
+import type { ISummaryTree } from "@fluidframework/driver-definitions";
 import type {
-	ISequencedDocumentMessage,
 	ISnapshotTree,
-	ISummaryTree,
 	ITree,
 	SummaryTree,
-} from "@fluidframework/protocol-definitions";
+	ISequencedDocumentMessage,
+} from "@fluidframework/driver-definitions/internal";
+import type { TelemetryEventPropertyTypeExt } from "@fluidframework/telemetry-utils/internal";
 
@@ -23,3 +24,3 @@ import type {
  * Contains the aggregation data from a Tree/Subtree.
- * @public
+ * @alpha
  */
@@ -40,3 +41,3 @@ export interface ISummaryStats {
  * will be taking part of the summarization process.
- * @public
+ * @alpha
  */
@@ -91,3 +92,3 @@ export interface ISummaryTreeWithStats {
  * Contains the necessary information to allow DDSes to do incremental summaries
- * @public
+ * @alpha
  */
@@ -329,6 +330,6 @@ export interface IExperimentalIncrementalSummaryContext {
  * Contains telemetry data relevant to summarization workflows.
- * This object is expected to be modified directly by various summarize methods.
- * @public
+ * This object, in contrast to ITelemetryContext, is expected to be modified directly by various summarize methods.
+ * @internal
  */
-export interface ITelemetryContext {
+export interface ITelemetryContextExt {
 	/**
@@ -340,3 +341,3 @@ * Sets value for telemetry data being tracked.
 	 */
-	set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
+	set(prefix: string, property: string, value: TelemetryEventPropertyTypeExt): void;
 
@@ -352,24 +353,31 @@ /**
 		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;
 }
@@ -376,0 +384,0 @@

tsconfig.json

@@ -8,3 +8,4 @@ {
 		"outDir": "./lib",
+		"exactOptionalPropertyTypes": false,
 	},
 }

No alert changes

Improved metrics

Total package byte prevSize

348241

increased by2.28%

Number of package files

102

increased by9.68%

Worsened metrics

Dev dependency count

15

increased by7.14%

Lines of code

3945

decreased by-0.35%

Dependency changes

• + Added@fluidframework/telemetry-utils@>=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0

• + Added@fluid-internal/client-utils@2.0.0-rc.5.0.8(transitive)

• + Added@fluidframework/container-definitions@2.0.0-rc.5.0.8(transitive)

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

• + Added@fluidframework/core-utils@2.0.0-rc.5.0.8(transitive)

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

• + Added@fluidframework/id-compressor@2.0.0-rc.5.0.8(transitive)

• + Added@fluidframework/telemetry-utils@2.0.0-rc.5.0.8(transitive)

• - Removed@fluidframework/protocol-definitions@^3.2.0

• - Removed@fluid-internal/client-utils@2.0.0-rc.4.0.10(transitive)

• - Removed@fluidframework/container-definitions@2.0.0-rc.4.0.10(transitive)

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

• - Removed@fluidframework/core-utils@2.0.0-rc.4.0.10(transitive)

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

• - Removed@fluidframework/id-compressor@2.0.0-rc.4.0.10(transitive)

• - Removed@fluidframework/protocol-definitions@3.2.0(transitive)

• - Removed@fluidframework/telemetry-utils@2.0.0-rc.4.0.10(transitive)

• - Removedlodash@4.17.21(transitive)

• Updated@fluidframework/container-definitions@>=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0

• Updated@fluidframework/core-interfaces@>=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0

• Updated@fluidframework/driver-definitions@>=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0

• Updated@fluidframework/id-compressor@>=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0