@fluidframework/core-interfaces 2.0.0-rc.1.0.3 → 2.0.0-rc.2.0.0

package/{.eslintrc.js → .eslintrc.cjs}

@@ -4,8 +4,12 @@
  */
 
 module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid"), "prettier"],
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
 	parserOptions: {
 		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
 	},
+	rules: {
+		// TODO: Enabling this may require breaking changes.
+		"@typescript-eslint/consistent-indexed-object-style": "off",
+	},
 };

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @fluidframework/core-interfaces
 
+## 2.0.0-rc.2.0.0
+
+### Minor Changes
+
+-   core-interfaces: Removed ITelemetryProperties, TelemetryEventCategory, TelemetryEventPropertyType, and ITaggedTelemetryPropertyType ([#19752](https://github.com/microsoft/FluidFramework/issues/19752)) [615a7712e6](https://github.com/microsoft/FluidFramework/commits/615a7712e67885c6cda69ddd907cb5cc708eef18)
+
+    The `ITelemetryProperties` interface was deprecated and has been removed.
+    Use the identical `ITelemetryBaseProperties` instead.
+
+    The `TelemetryEventCategory` type was deprecated and has been removed from `@fluidframework/core-interfaces`, since
+    it had moved to `@fluidframework/telemetry-utils` in the past.
+
+    The `TelemetryEventPropertyType` type alias was deprecated and has been removed.
+    Use the identical `TelemetryBaseEventPropertyType` instead.
+
+    The `ITaggedTelemetryPropertyType` interface was deprecated and has been removed.
+    Use `Tagged<TelemetryBaseEventPropertyType>` instead.
+
+-   container-definitions: Added containerMetadata prop on IContainer interface ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
+
+    Added `containerMetadata` prop on IContainer interface.
+
+-   runtime-definitions: Moved ISignalEnvelope interface to core-interfaces ([#19142](https://github.com/microsoft/FluidFramework/issues/19142)) [d0d77f3516](https://github.com/microsoft/FluidFramework/commits/d0d77f3516d67f3c9faedb47b20dbd4e309c3bc2)
+
+    The `ISignalEnvelope` interface has been moved to the @fluidframework/core-interfaces package.
+
+-   core-interfaces: Removed deprecated telemetry event types ([#19740](https://github.com/microsoft/FluidFramework/issues/19740)) [0ff130a50e](https://github.com/microsoft/FluidFramework/commits/0ff130a50e9bcccb119673ac985ea27fa38de463)
+
+    The deprecated `ITelemetryErrorEvent`, `ITelemetryGenericEvent`, and `ITelemetryPerformanceEvent` interfaces,
+    which represented different kinds of telemetry events, were not intended for consumers of Fluid Framework and have thus
+    been removed.
+    `ITelemetryBaseEvent` is the only telemetry event interface that should be used in/by consuming code.
+
+    `ITelemetryLogger` was not intended for consumers of Fluid Framework and has been removed.
+    Consumers should use the simpler `ITelemetryBaseLogger` instead.
+
 ## 2.0.0-rc.1.0.0
 
 Dependency updates only.

package/Removing-IFluidRouter.md

@@ -109,7 +109,7 @@ const dataStore = await containerRuntime.createDataStore(TestDataObjectType);
 await dataStore.trySetAlias(alias);
 
 const entryPoint: IFluidHandle<ITestDataObject> | undefined =
-	await containerRuntime.getRootDataStore(alias);
+	await containerRuntime.getAliasedDataStoreEntryPoint(alias);
 const retrievedDataStore = await entryPoint?.get();
 ```
 

package/{api-extractor-esm.json → api-extractor-cjs.json}

@@ -1,4 +1,8 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base-esm.json"
+	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
+	// CJS is actually secondary; so, no report.
+	"apiReport": {
+		"enabled": false
+	}
 }

package/api-extractor.json

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

package/api-report/core-interfaces.api.md

@@ -394,12 +394,14 @@ export const isFluidCodeDetails: (details: unknown) => details is Readonly<IFlui
 // @internal @deprecated
 export const isFluidPackage: (pkg: unknown) => pkg is Readonly<IFluidPackage>;
 
-// @internal @deprecated (undocumented)
-export interface ITaggedTelemetryPropertyType {
-    // (undocumented)
-    tag: string;
-    // (undocumented)
-    value: TelemetryEventPropertyType;
+// @internal (undocumented)
+export interface ISignalEnvelope {
+    address?: string;
+    clientSignalSequenceNumber: number;
+    contents: {
+        type: string;
+        content: any;
+    };
 }
 
 // @public
@@ -419,40 +421,8 @@ export interface ITelemetryBaseLogger {
 }
 
 // @public
-export type ITelemetryBaseProperties = ITelemetryProperties;
-
-// @public @deprecated
-export interface ITelemetryErrorEvent extends ITelemetryProperties {
-    // (undocumented)
-    eventName: string;
-}
-
-// @public @deprecated
-export interface ITelemetryGenericEvent extends ITelemetryProperties {
-    // (undocumented)
-    category?: TelemetryEventCategory;
-    // (undocumented)
-    eventName: string;
-}
-
-// @public @deprecated
-export interface ITelemetryLogger extends ITelemetryBaseLogger {
-    send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
-    sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void;
-    sendPerformanceEvent(event: ITelemetryPerformanceEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-    sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-}
-
-// @public @deprecated
-export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
-    // (undocumented)
-    duration?: number;
-}
-
-// @public @deprecated
-export interface ITelemetryProperties {
-    // (undocumented)
-    [index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
+export interface ITelemetryBaseProperties {
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
 // @alpha
@@ -490,14 +460,8 @@ export interface Tagged<V, T extends string = string> {
     value: V;
 }
 
-// @alpha
-export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
-
-// @public @deprecated
-export type TelemetryEventCategory = "generic" | "error" | "performance";
-
-// @public @deprecated
-export type TelemetryEventPropertyType = string | number | boolean | undefined;
+// @public
+export type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
 // @public
 export type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;

package/dist/core-interfaces-alpha.d.ts

@@ -686,7 +686,7 @@ export declare interface IResponse {
 
 /* Excluded from this release type: isFluidPackage */
 
-/* Excluded from this release type: ITaggedTelemetryPropertyType */
+/* Excluded from this release type: ISignalEnvelope */
 
 /**
  * Base interface for logging telemetry statements.
@@ -714,92 +714,12 @@ export declare interface ITelemetryBaseLogger {
  * JSON-serializable properties, which will be logged with telemetry.
  * @public
  */
-export declare type ITelemetryBaseProperties = ITelemetryProperties;
-
-/**
- * Error telemetry event.
- * Maps to category = "error"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryErrorEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
-    eventName: string;
-}
-
-/**
- * Informational (non-error) telemetry event
- * Maps to category = "generic"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryGenericEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
-    eventName: string;
-    category?: TelemetryEventCategory;
-}
-
-/**
- * ITelemetryLogger interface contains various helper telemetry methods,
- * encoding in one place schemas for various types of Fluid telemetry events.
- * Creates sub-logger that appends properties to all events
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryLoggerExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
-    /**
-     * Actual implementation that sends telemetry event
-     * Implemented by derived classes
-     * @param event - Telemetry event to send over
-     * @param logLevel - optional level of the log.
-     */
-    send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
-    /**
-     * Send information telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     * @param logLevel - optional level of the log.
-     */
-    sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
+export declare interface ITelemetryBaseProperties {
     /**
-     * Send error telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
+     * Properties of a telemetry event. They are string-indexed, and their values restricted to a known set of
+     * types (optionally "wrapped" with {@link Tagged}).
      */
-    sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void;
-    /**
-     * Send performance telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     * @param logLevel - optional level of the log.
-     */
-    sendPerformanceEvent(event: ITelemetryPerformanceEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-}
-
-/**
- * Performance telemetry event.
- * Maps to category = "performance"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryPerformanceEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
-    duration?: number;
-}
-
-/**
- * {@inheritDoc ITelemetryBaseProperties}
- *
- * @deprecated Renamed to {@link ITelemetryBaseProperties}
- * @public
- */
-export declare interface ITelemetryProperties {
-    [index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
 /**
@@ -859,25 +779,9 @@ export declare interface Tagged<V, T extends string = string> {
  * @remarks Logging entire objects is considered extremely dangerous from a telemetry point of view because people can
  * easily add fields to objects that shouldn't be logged and not realize it's going to be logged.
  * General best practice is to explicitly log the fields you care about from objects.
- * @alpha
- */
-export declare type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
-
-/**
- * Examples of known categories, however category can be any string for extensibility.
- *
- * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @public
- */
-export declare type TelemetryEventCategory = "generic" | "error" | "performance";
-
-/**
- * {@inheritDoc TelemetryBaseEventPropertyType}
- *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
  * @public
  */
-export declare type TelemetryEventPropertyType = string | number | boolean | undefined;
+export declare type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
 /**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener

package/dist/core-interfaces-beta.d.ts

@@ -573,7 +573,7 @@ export declare interface IResponse {
 
 /* Excluded from this release type: isFluidPackage */
 
-/* Excluded from this release type: ITaggedTelemetryPropertyType */
+/* Excluded from this release type: ISignalEnvelope */
 
 /**
  * Base interface for logging telemetry statements.
@@ -601,92 +601,12 @@ export declare interface ITelemetryBaseLogger {
  * JSON-serializable properties, which will be logged with telemetry.
  * @public
  */
-export declare type ITelemetryBaseProperties = ITelemetryProperties;
-
-/**
- * Error telemetry event.
- * Maps to category = "error"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryErrorEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
-    eventName: string;
-}
-
-/**
- * Informational (non-error) telemetry event
- * Maps to category = "generic"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryGenericEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
-    eventName: string;
-    category?: TelemetryEventCategory;
-}
-
-/**
- * ITelemetryLogger interface contains various helper telemetry methods,
- * encoding in one place schemas for various types of Fluid telemetry events.
- * Creates sub-logger that appends properties to all events
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryLoggerExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
-    /**
-     * Actual implementation that sends telemetry event
-     * Implemented by derived classes
-     * @param event - Telemetry event to send over
-     * @param logLevel - optional level of the log.
-     */
-    send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
+export declare interface ITelemetryBaseProperties {
     /**
-     * Send information telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     * @param logLevel - optional level of the log.
+     * Properties of a telemetry event. They are string-indexed, and their values restricted to a known set of
+     * types (optionally "wrapped" with {@link Tagged}).
      */
-    sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-    /**
-     * Send error telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     */
-    sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void;
-    /**
-     * Send performance telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     * @param logLevel - optional level of the log.
-     */
-    sendPerformanceEvent(event: ITelemetryPerformanceEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-}
-
-/**
- * Performance telemetry event.
- * Maps to category = "performance"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryPerformanceEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
-    duration?: number;
-}
-
-/**
- * {@inheritDoc ITelemetryBaseProperties}
- *
- * @deprecated Renamed to {@link ITelemetryBaseProperties}
- * @public
- */
-export declare interface ITelemetryProperties {
-    [index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
 /* Excluded from this release type: IThrottlingWarning */
@@ -730,23 +650,15 @@ export declare interface Tagged<V, T extends string = string> {
     tag: T;
 }
 
-/* Excluded from this release type: TelemetryBaseEventPropertyType */
-
-/**
- * Examples of known categories, however category can be any string for extensibility.
- *
- * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @public
- */
-export declare type TelemetryEventCategory = "generic" | "error" | "performance";
-
 /**
- * {@inheritDoc TelemetryBaseEventPropertyType}
+ * Property types that can be logged.
  *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
+ * @remarks Logging entire objects is considered extremely dangerous from a telemetry point of view because people can
+ * easily add fields to objects that shouldn't be logged and not realize it's going to be logged.
+ * General best practice is to explicitly log the fields you care about from objects.
  * @public
  */
-export declare type TelemetryEventPropertyType = string | number | boolean | undefined;
+export declare type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
 /**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener

package/dist/core-interfaces-public.d.ts

@@ -573,7 +573,7 @@ export declare interface IResponse {
 
 /* Excluded from this release type: isFluidPackage */
 
-/* Excluded from this release type: ITaggedTelemetryPropertyType */
+/* Excluded from this release type: ISignalEnvelope */
 
 /**
  * Base interface for logging telemetry statements.
@@ -601,92 +601,12 @@ export declare interface ITelemetryBaseLogger {
  * JSON-serializable properties, which will be logged with telemetry.
  * @public
  */
-export declare type ITelemetryBaseProperties = ITelemetryProperties;
-
-/**
- * Error telemetry event.
- * Maps to category = "error"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryErrorEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
-    eventName: string;
-}
-
-/**
- * Informational (non-error) telemetry event
- * Maps to category = "generic"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryGenericEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
-    eventName: string;
-    category?: TelemetryEventCategory;
-}
-
-/**
- * ITelemetryLogger interface contains various helper telemetry methods,
- * encoding in one place schemas for various types of Fluid telemetry events.
- * Creates sub-logger that appends properties to all events
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryLoggerExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
-    /**
-     * Actual implementation that sends telemetry event
-     * Implemented by derived classes
-     * @param event - Telemetry event to send over
-     * @param logLevel - optional level of the log.
-     */
-    send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
+export declare interface ITelemetryBaseProperties {
     /**
-     * Send information telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     * @param logLevel - optional level of the log.
+     * Properties of a telemetry event. They are string-indexed, and their values restricted to a known set of
+     * types (optionally "wrapped" with {@link Tagged}).
      */
-    sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-    /**
-     * Send error telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     */
-    sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void;
-    /**
-     * Send performance telemetry event
-     * @param event - Event to send
-     * @param error - optional error object to log
-     * @param logLevel - optional level of the log.
-     */
-    sendPerformanceEvent(event: ITelemetryPerformanceEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
-}
-
-/**
- * Performance telemetry event.
- * Maps to category = "performance"
- *
- * @deprecated For internal use within FluidFramework, use ITelemetryPerformanceEventExt in \@fluidframework/telemetry-utils.
- * No replacement intended for FluidFramework consumers.
- * @public
- */
-export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
-    duration?: number;
-}
-
-/**
- * {@inheritDoc ITelemetryBaseProperties}
- *
- * @deprecated Renamed to {@link ITelemetryBaseProperties}
- * @public
- */
-export declare interface ITelemetryProperties {
-    [index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
 /* Excluded from this release type: IThrottlingWarning */
@@ -730,23 +650,15 @@ export declare interface Tagged<V, T extends string = string> {
     tag: T;
 }
 
-/* Excluded from this release type: TelemetryBaseEventPropertyType */
-
-/**
- * Examples of known categories, however category can be any string for extensibility.
- *
- * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @public
- */
-export declare type TelemetryEventCategory = "generic" | "error" | "performance";
-
 /**
- * {@inheritDoc TelemetryBaseEventPropertyType}
+ * Property types that can be logged.
  *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
+ * @remarks Logging entire objects is considered extremely dangerous from a telemetry point of view because people can
+ * easily add fields to objects that shouldn't be logged and not realize it's going to be logged.
+ * General best practice is to explicitly log the fields you care about from objects.
  * @public
  */
-export declare type TelemetryEventPropertyType = string | number | boolean | undefined;
+export declare type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
 /**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener