@fluidframework/core-interfaces - npm Package Compare versions

Comparing version 2.0.0-dev-rc.1.0.0.232845 to 2.0.0-dev-rc.2.0.0.245554

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.json"
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
 }

api-report/core-interfaces.api.md

@@ -407,10 +407,2 @@ ## API Report File for "@fluidframework/core-interfaces"
 
-// @internal @deprecated (undocumented)
-export interface ITaggedTelemetryPropertyType {
-    // (undocumented)
-    tag: string;
-    // (undocumented)
-    value: TelemetryEventPropertyType;
-}
-
 // @public
@@ -433,38 +425,6 @@ export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
 // @public
-export type ITelemetryBaseProperties = ITelemetryProperties;
-
-// @public @deprecated
-export interface ITelemetryErrorEvent extends ITelemetryProperties {
-    // (undocumented)
-    eventName: string;
+export interface ITelemetryBaseProperties {
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
-// @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>;
-}
-
 // @alpha
@@ -505,11 +465,5 @@ export interface IThrottlingWarning extends IErrorBase {
 
-// @alpha
-export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
+// @public
+export type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
-// @public @deprecated
-export type TelemetryEventCategory = "generic" | "error" | "performance";
-
-// @public @deprecated
-export type TelemetryEventPropertyType = string | number | boolean | undefined;
-
 // @public
@@ -516,0 +470,0 @@ export type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;

CHANGELOG.md

 # @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
@@ -4,0 +40,0 @@

dist/core-interfaces-alpha.d.ts

@@ -691,4 +691,2 @@ /**
 
-/* Excluded from this release type: ITaggedTelemetryPropertyType */
-
 /**
@@ -720,91 +718,11 @@ * Base interface for logging telemetry statements.
  */
-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 {
+export declare interface ITelemetryBaseProperties {
     /**
-     * Actual implementation that sends telemetry event
-     * Implemented by derived classes
-     * @param event - Telemetry event to send over
-     * @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}).
      */
-    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;
-    /**
-     * 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;
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
 /**
- * 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>;
-}
-
-/**
  * Warning emitted when requests to storage are being throttled
@@ -866,23 +784,7 @@ * @alpha
  * 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";
+export declare type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
 /**
- * {@inheritDoc TelemetryBaseEventPropertyType}
- *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
- * @public
- */
-export declare type TelemetryEventPropertyType = string | number | boolean | undefined;
-
-/**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener
@@ -889,0 +791,0 @@ * arguments and having the overload return `TTHis` as well

dist/core-interfaces-beta.d.ts

@@ -578,4 +578,2 @@ /**
 
-/* Excluded from this release type: ITaggedTelemetryPropertyType */
-
 /**
@@ -607,90 +605,10 @@ * Base interface for logging telemetry statements.
  */
-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 {
+export declare interface ITelemetryBaseProperties {
     /**
-     * Actual implementation that sends telemetry event
-     * Implemented by derived classes
-     * @param event - Telemetry event to send over
-     * @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}).
      */
-    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;
-    /**
-     * 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;
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
-/**
- * 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>;
-}
-
 /* Excluded from this release type: IThrottlingWarning */
@@ -737,21 +655,13 @@
 
-/* Excluded from this release type: TelemetryBaseEventPropertyType */
-
 /**
- * Examples of known categories, however category can be any string for extensibility.
+ * Property types that can be logged.
  *
- * @deprecated Moved to \@fluidframework/telemetry-utils package
+ * @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 TelemetryEventCategory = "generic" | "error" | "performance";
+export declare type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
 /**
- * {@inheritDoc TelemetryBaseEventPropertyType}
- *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
- * @public
- */
-export declare type TelemetryEventPropertyType = string | number | boolean | undefined;
-
-/**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener
@@ -758,0 +668,0 @@ * arguments and having the overload return `TTHis` as well

dist/core-interfaces-public.d.ts

@@ -578,4 +578,2 @@ /**
 
-/* Excluded from this release type: ITaggedTelemetryPropertyType */
-
 /**
@@ -607,90 +605,10 @@ * Base interface for logging telemetry statements.
  */
-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 {
+export declare interface ITelemetryBaseProperties {
     /**
-     * Actual implementation that sends telemetry event
-     * Implemented by derived classes
-     * @param event - Telemetry event to send over
-     * @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}).
      */
-    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;
-    /**
-     * 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;
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
-/**
- * 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>;
-}
-
 /* Excluded from this release type: IThrottlingWarning */
@@ -737,21 +655,13 @@
 
-/* Excluded from this release type: TelemetryBaseEventPropertyType */
-
 /**
- * Examples of known categories, however category can be any string for extensibility.
+ * Property types that can be logged.
  *
- * @deprecated Moved to \@fluidframework/telemetry-utils package
+ * @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 TelemetryEventCategory = "generic" | "error" | "performance";
+export declare type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
 /**
- * {@inheritDoc TelemetryBaseEventPropertyType}
- *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
- * @public
- */
-export declare type TelemetryEventPropertyType = string | number | boolean | undefined;
-
-/**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener
@@ -758,0 +668,0 @@ * arguments and having the overload return `TTHis` as well

dist/core-interfaces-untrimmed.d.ts

@@ -804,13 +804,2 @@ /**
 /**
- * @see {@link Tagged} for info on tagging
- *
- * @deprecated Use Tagged\<TelemetryBaseEventPropertyType\>
- * @internal
- */
-export declare interface ITaggedTelemetryPropertyType {
-    value: TelemetryEventPropertyType;
-    tag: string;
-}
-
-/**
  * Base interface for logging telemetry statements.
@@ -841,91 +830,11 @@ * Can contain any number of properties that get serialized as json payload.
  */
-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 {
+export declare interface ITelemetryBaseProperties {
     /**
-     * Actual implementation that sends telemetry event
-     * Implemented by derived classes
-     * @param event - Telemetry event to send over
-     * @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}).
      */
-    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;
-    /**
-     * 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;
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
 
 /**
- * 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>;
-}
-
-/**
  * Warning emitted when requests to storage are being throttled
@@ -996,23 +905,7 @@ * @alpha
  * 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";
+export declare type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
 /**
- * {@inheritDoc TelemetryBaseEventPropertyType}
- *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
- * @public
- */
-export declare type TelemetryEventPropertyType = string | number | boolean | undefined;
-
-/**
  * Transforms the event overload by replacing {@link IEventThisPlaceHolder} with `TThis` in the event listener
@@ -1019,0 +912,0 @@ * arguments and having the overload return `TTHis` as well

dist/error.d.ts

@@ -5,3 +5,3 @@ /*!
  */
-import { ITelemetryBaseProperties } from "./index";
+import type { ITelemetryBaseProperties } from "./index.js";
 /**
@@ -8,0 +8,0 @@ * Error types the Fluid Framework may report.

dist/fluidLoadable.d.ts

@@ -5,3 +5,3 @@ /*!
  */
-import { IFluidHandle } from "./handles";
+import type { IFluidHandle } from "./handles.js";
 /**
@@ -8,0 +8,0 @@ * @public

dist/handles.d.ts

@@ -5,5 +5,5 @@ /*!
  */
-import { IRequest, IResponse } from "./fluidRouter";
-import { IFluidLoadable } from "./fluidLoadable";
-import { FluidObject } from "./provider";
+import type { IRequest, IResponse } from "./fluidRouter.js";
+import type { IFluidLoadable } from "./fluidLoadable.js";
+import type { FluidObject } from "./provider.js";
 /**
@@ -10,0 +10,0 @@ * @public

dist/index.d.ts

@@ -5,21 +5,18 @@ /*!
  */
-export type { IDisposable } from "./disposable";
-export { FluidErrorTypes, IErrorBase, IGenericError, IUsageError, IThrottlingWarning, } from "./error";
-export type { ExtendEventProvider, IErrorEvent, IEvent, IEventProvider, IEventThisPlaceHolder, IEventTransformer, ReplaceIEventThisPlaceHolder, TransformedEvent, } from "./events";
-export { IFluidLoadable, IProvideFluidLoadable, IFluidRunnable, IProvideFluidRunnable, } from "./fluidLoadable";
-export { IFluidPackageEnvironment, IFluidPackage, isFluidPackage, IFluidCodeDetailsConfig, IFluidCodeDetails, isFluidCodeDetails, IFluidCodeDetailsComparer, IProvideFluidCodeDetailsComparer, } from "./fluidPackage";
-export { IRequest, IRequestHeader, IResponse } from "./fluidRouter";
-export { IFluidHandleContext, IProvideFluidHandleContext, IFluidHandle, IProvideFluidHandle, } from "./handles";
-export type { ILoggingError, ITaggedTelemetryPropertyType, // deprecated
-ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryBaseProperties, ITelemetryErrorEvent, // deprecated
-ITelemetryGenericEvent, // deprecated
-ITelemetryLogger, // deprecated
-ITelemetryPerformanceEvent, // deprecated
-ITelemetryProperties, // deprecated
-Tagged, TelemetryEventCategory, // deprecated
-TelemetryBaseEventPropertyType, TelemetryEventPropertyType, } from "./logger";
-export { LogLevel } from "./logger";
-export { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from "./provider";
-export { ConfigTypes, IConfigProviderBase } from "./config";
-export { ISignalEnvelope } from "./messages";
+export type { IDisposable } from "./disposable.js";
+export type { IErrorBase, IGenericError, IUsageError, IThrottlingWarning } from "./error.js";
+export { FluidErrorTypes } from "./error.js";
+export type { ExtendEventProvider, IErrorEvent, IEvent, IEventProvider, IEventThisPlaceHolder, IEventTransformer, ReplaceIEventThisPlaceHolder, TransformedEvent, } from "./events.js";
+export type { IProvideFluidLoadable, IProvideFluidRunnable } from "./fluidLoadable.js";
+export { IFluidLoadable, IFluidRunnable } from "./fluidLoadable.js";
+export type { IFluidPackageEnvironment, IFluidPackage, IFluidCodeDetailsConfig, IFluidCodeDetails, IProvideFluidCodeDetailsComparer, } from "./fluidPackage.js";
+export { isFluidPackage, isFluidCodeDetails, IFluidCodeDetailsComparer } from "./fluidPackage.js";
+export type { IRequest, IRequestHeader, IResponse } from "./fluidRouter.js";
+export type { IProvideFluidHandleContext, IProvideFluidHandle } from "./handles.js";
+export { IFluidHandleContext, IFluidHandle } from "./handles.js";
+export type { ILoggingError, ITelemetryBaseEvent, ITelemetryBaseLogger, ITelemetryBaseProperties, Tagged, TelemetryBaseEventPropertyType, } from "./logger.js";
+export { LogLevel } from "./logger.js";
+export type { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from "./provider.js";
+export type { ConfigTypes, IConfigProviderBase } from "./config.js";
+export type { ISignalEnvelope } from "./messages.js";
 //# sourceMappingURL=index.d.ts.map

dist/index.js

@@ -8,16 +8,16 @@ "use strict";
 exports.LogLevel = exports.IFluidHandle = exports.IFluidHandleContext = exports.IFluidCodeDetailsComparer = exports.isFluidCodeDetails = exports.isFluidPackage = exports.IFluidRunnable = exports.IFluidLoadable = exports.FluidErrorTypes = void 0;
-var error_1 = require("./error");
-Object.defineProperty(exports, "FluidErrorTypes", { enumerable: true, get: function () { return error_1.FluidErrorTypes; } });
-var fluidLoadable_1 = require("./fluidLoadable");
-Object.defineProperty(exports, "IFluidLoadable", { enumerable: true, get: function () { return fluidLoadable_1.IFluidLoadable; } });
-Object.defineProperty(exports, "IFluidRunnable", { enumerable: true, get: function () { return fluidLoadable_1.IFluidRunnable; } });
-var fluidPackage_1 = require("./fluidPackage");
-Object.defineProperty(exports, "isFluidPackage", { enumerable: true, get: function () { return fluidPackage_1.isFluidPackage; } });
-Object.defineProperty(exports, "isFluidCodeDetails", { enumerable: true, get: function () { return fluidPackage_1.isFluidCodeDetails; } });
-Object.defineProperty(exports, "IFluidCodeDetailsComparer", { enumerable: true, get: function () { return fluidPackage_1.IFluidCodeDetailsComparer; } });
-var handles_1 = require("./handles");
-Object.defineProperty(exports, "IFluidHandleContext", { enumerable: true, get: function () { return handles_1.IFluidHandleContext; } });
-Object.defineProperty(exports, "IFluidHandle", { enumerable: true, get: function () { return handles_1.IFluidHandle; } });
-var logger_1 = require("./logger");
-Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return logger_1.LogLevel; } });
+var error_js_1 = require("./error.js");
+Object.defineProperty(exports, "FluidErrorTypes", { enumerable: true, get: function () { return error_js_1.FluidErrorTypes; } });
+var fluidLoadable_js_1 = require("./fluidLoadable.js");
+Object.defineProperty(exports, "IFluidLoadable", { enumerable: true, get: function () { return fluidLoadable_js_1.IFluidLoadable; } });
+Object.defineProperty(exports, "IFluidRunnable", { enumerable: true, get: function () { return fluidLoadable_js_1.IFluidRunnable; } });
+var fluidPackage_js_1 = require("./fluidPackage.js");
+Object.defineProperty(exports, "isFluidPackage", { enumerable: true, get: function () { return fluidPackage_js_1.isFluidPackage; } });
+Object.defineProperty(exports, "isFluidCodeDetails", { enumerable: true, get: function () { return fluidPackage_js_1.isFluidCodeDetails; } });
+Object.defineProperty(exports, "IFluidCodeDetailsComparer", { enumerable: true, get: function () { return fluidPackage_js_1.IFluidCodeDetailsComparer; } });
+var handles_js_1 = require("./handles.js");
+Object.defineProperty(exports, "IFluidHandleContext", { enumerable: true, get: function () { return handles_js_1.IFluidHandleContext; } });
+Object.defineProperty(exports, "IFluidHandle", { enumerable: true, get: function () { return handles_js_1.IFluidHandle; } });
+var logger_js_1 = require("./logger.js");
+Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return logger_js_1.LogLevel; } });
 //# sourceMappingURL=index.js.map

dist/logger.d.ts

@@ -6,9 +6,2 @@ /*!
 /**
- * Examples of known categories, however category can be any string for extensibility.
- *
- * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @public
- */
-export type TelemetryEventCategory = "generic" | "error" | "performance";
-/**
  * Property types that can be logged.
@@ -19,12 +12,5 @@ *
  * General best practice is to explicitly log the fields you care about from objects.
- * @alpha
- */
-export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
-/**
- * {@inheritDoc TelemetryBaseEventPropertyType}
- *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
  * @public
  */
-export type TelemetryEventPropertyType = string | number | boolean | undefined;
+export type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 /**
@@ -43,24 +29,11 @@ * A property to be logged to telemetry may require a tag indicating the value may contain sensitive data.
 /**
- * @see {@link Tagged} for info on tagging
- *
- * @deprecated Use Tagged\<TelemetryBaseEventPropertyType\>
- * @internal
- */
-export interface ITaggedTelemetryPropertyType {
-    value: TelemetryEventPropertyType;
-    tag: string;
-}
-/**
  * JSON-serializable properties, which will be logged with telemetry.
  * @public
  */
-export type ITelemetryBaseProperties = ITelemetryProperties;
-/**
- * {@inheritDoc ITelemetryBaseProperties}
- *
- * @deprecated Renamed to {@link ITelemetryBaseProperties}
- * @public
- */
-export interface ITelemetryProperties {
-    [index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
+export interface ITelemetryBaseProperties {
+    /**
+     * Properties of a telemetry event. They are string-indexed, and their values restricted to a known set of
+     * types (optionally "wrapped" with {@link Tagged}).
+     */
+    [index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
@@ -102,14 +75,2 @@ /**
 /**
- * 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 interface ITelemetryGenericEvent extends ITelemetryProperties {
-    eventName: string;
-    category?: TelemetryEventCategory;
-}
-/**
  * Error telemetry event.
@@ -122,17 +83,6 @@ * Maps to category = "error"
  */
-export interface ITelemetryErrorEvent extends ITelemetryProperties {
+export interface ITelemetryErrorEvent extends ITelemetryBaseProperties {
     eventName: string;
 }
 /**
- * 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 interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
-    duration?: number;
-}
-/**
  * An error object that supports exporting its properties to be logged to telemetry
@@ -147,40 +97,2 @@ * @internal
 }
-/**
- * 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 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;
-    /**
-     * 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;
-}
 //# sourceMappingURL=logger.d.ts.map

dist/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.39.1"
+      "packageVersion": "7.42.3"
     }
   ]
 }

package.json

 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.0.0-dev-rc.1.0.0.232845",
+  "version": "2.0.0-dev-rc.2.0.0.245554",
   "description": "Fluid object interfaces",
@@ -14,7 +14,8 @@ "homepage": "https://fluidframework.com",
   "sideEffects": false,
+  "type": "module",
   "exports": {
     ".": {
       "import": {
-        "types": "./lib/index.d.mts",
-        "default": "./lib/index.mjs"
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
       },
@@ -25,21 +26,49 @@ "require": {
       }
+    },
+    "./public": {
+      "import": {
+        "types": "./lib/core-interfaces-public.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/core-interfaces-public.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./alpha": {
+      "import": {
+        "types": "./lib/core-interfaces-alpha.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/core-interfaces-alpha.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     }
   },
   "main": "dist/index.js",
-  "module": "lib/index.mjs",
   "types": "dist/index.d.ts",
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-tools/build-cli": "^0.29.0",
+    "@fluid-tools/build-cli": "^0.34.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.29.0",
+    "@fluidframework/build-tools": "^0.34.0",
     "@fluidframework/core-interfaces-previous": "npm:@fluidframework/core-interfaces@2.0.0-internal.8.0.0",
-    "@fluidframework/eslint-config-fluid": "^3.3.0",
-    "@microsoft/api-extractor": "^7.39.1",
+    "@fluidframework/eslint-config-fluid": "^5.1.0",
+    "@microsoft/api-extractor": "^7.42.3",
     "@types/node": "^18.19.0",
     "copyfiles": "^2.4.1",
-    "eslint": "~8.50.0",
+    "eslint": "~8.55.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
-    "tsc-multi": "^1.1.0",
     "typescript": "~5.1.6"
@@ -60,8 +89,41 @@ },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "RemovedInterfaceDeclaration_ITelemetryLogger": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_ITelemetryPerformanceEvent": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_ITelemetryGenericEvent": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_ITelemetryErrorEvent": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedInterfaceDeclaration_ITelemetryProperties": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_TelemetryEventCategory": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "RemovedTypeAliasDeclaration_TelemetryEventPropertyType": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "RemovedInterfaceDeclaration_ITaggedTelemetryPropertyType": {
+        "backCompat": false,
+        "forwardCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --local",
-    "api-extractor:esnext": "api-extractor run --config ./api-extractor-esm.json",
+    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
+    "api-extractor:esnext": "api-extractor run --local",
     "build": "fluid-build . --task build",
@@ -71,5 +133,7 @@ "build:commonjs": "fluid-build . --task commonjs",
     "build:docs": "fluid-build . --task api",
-    "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack",
+    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:test": "npm run build:test:esm && npm run build:test:cjs",
+    "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
+    "build:test:esm": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
@@ -88,3 +152,3 @@ "ci:build": "npm run build:compile",
     "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
-    "tsc": "tsc",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "tsc:watch": "tsc --watch",
@@ -91,0 +155,0 @@ "typetests:gen": "fluid-type-test-generator",

Removing-IFluidRouter.md

@@ -112,3 +112,3 @@ # Removing IFluidRouter
 const entryPoint: IFluidHandle<ITestDataObject> | undefined =
-	await containerRuntime.getRootDataStore(alias);
+	await containerRuntime.getAliasedDataStoreEntryPoint(alias);
 const retrievedDataStore = await entryPoint?.get();
@@ -115,0 +115,0 @@ ```

src/error.ts

@@ -6,3 +6,3 @@ /*!
 
-import { ITelemetryBaseProperties } from "./index";
+import type { ITelemetryBaseProperties } from "./index.js";
 
@@ -9,0 +9,0 @@ /**

src/fluidLoadable.ts

@@ -6,3 +6,3 @@ /*!
 
-import { IFluidHandle } from "./handles";
+import type { IFluidHandle } from "./handles.js";
 
@@ -9,0 +9,0 @@ /**

src/handles.ts

@@ -6,5 +6,5 @@ /*!
 
-import { IRequest, IResponse } from "./fluidRouter";
-import { IFluidLoadable } from "./fluidLoadable";
-import { FluidObject } from "./provider";
+import type { IRequest, IResponse } from "./fluidRouter.js";
+import type { IFluidLoadable } from "./fluidLoadable.js";
+import type { FluidObject } from "./provider.js";
 
@@ -11,0 +11,0 @@ /**

src/index.ts

@@ -6,11 +6,6 @@ /*!
 
-export type { IDisposable } from "./disposable";
+export type { IDisposable } from "./disposable.js";
 
-export {
-	FluidErrorTypes,
-	IErrorBase,
-	IGenericError,
-	IUsageError,
-	IThrottlingWarning,
-} from "./error";
+export type { IErrorBase, IGenericError, IUsageError, IThrottlingWarning } from "./error.js";
+export { FluidErrorTypes } from "./error.js";
 
@@ -26,21 +21,15 @@ export type {
 	TransformedEvent,
-} from "./events";
+} from "./events.js";
 
-export {
-	IFluidLoadable,
-	IProvideFluidLoadable,
-	IFluidRunnable,
-	IProvideFluidRunnable,
-} from "./fluidLoadable";
+export type { IProvideFluidLoadable, IProvideFluidRunnable } from "./fluidLoadable.js";
+export { IFluidLoadable, IFluidRunnable } from "./fluidLoadable.js";
 
-export {
+export type {
 	IFluidPackageEnvironment,
 	IFluidPackage,
-	isFluidPackage,
 	IFluidCodeDetailsConfig,
 	IFluidCodeDetails,
-	isFluidCodeDetails,
-	IFluidCodeDetailsComparer,
 	IProvideFluidCodeDetailsComparer,
-} from "./fluidPackage";
+} from "./fluidPackage.js";
+export { isFluidPackage, isFluidCodeDetails, IFluidCodeDetailsComparer } from "./fluidPackage.js";
 
@@ -50,30 +39,18 @@ // TypeScript forgets the index signature when customers augment IRequestHeader if we export *.
 // https://github.com/microsoft/TypeScript/issues/18877#issuecomment-476921038
-export { IRequest, IRequestHeader, IResponse } from "./fluidRouter";
+export type { IRequest, IRequestHeader, IResponse } from "./fluidRouter.js";
 
-export {
-	IFluidHandleContext,
-	IProvideFluidHandleContext,
-	IFluidHandle,
-	IProvideFluidHandle,
-} from "./handles";
+export type { IProvideFluidHandleContext, IProvideFluidHandle } from "./handles.js";
+export { IFluidHandleContext, IFluidHandle } from "./handles.js";
 
 export type {
 	ILoggingError,
-	ITaggedTelemetryPropertyType, // deprecated
 	ITelemetryBaseEvent,
 	ITelemetryBaseLogger,
 	ITelemetryBaseProperties,
-	ITelemetryErrorEvent, // deprecated
-	ITelemetryGenericEvent, // deprecated
-	ITelemetryLogger, // deprecated
-	ITelemetryPerformanceEvent, // deprecated
-	ITelemetryProperties, // deprecated
 	Tagged,
-	TelemetryEventCategory, // deprecated
 	TelemetryBaseEventPropertyType,
-	TelemetryEventPropertyType, // deprecated
-} from "./logger";
-export { LogLevel } from "./logger";
-export { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from "./provider";
-export { ConfigTypes, IConfigProviderBase } from "./config";
-export { ISignalEnvelope } from "./messages";
+} from "./logger.js";
+export { LogLevel } from "./logger.js";
+export type { FluidObjectProviderKeys, FluidObject, FluidObjectKeys } from "./provider.js";
+export type { ConfigTypes, IConfigProviderBase } from "./config.js";
+export type { ISignalEnvelope } from "./messages.js";

src/logger.ts

@@ -7,10 +7,2 @@ /*!
 /**
- * Examples of known categories, however category can be any string for extensibility.
- *
- * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @public
- */
-export type TelemetryEventCategory = "generic" | "error" | "performance";
-
-/**
  * Property types that can be logged.
@@ -21,13 +13,5 @@ *
  * General best practice is to explicitly log the fields you care about from objects.
- * @alpha
- */
-export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
-
-/**
- * {@inheritDoc TelemetryBaseEventPropertyType}
- *
- * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
  * @public
  */
-export type TelemetryEventPropertyType = string | number | boolean | undefined;
+export type TelemetryBaseEventPropertyType = string | number | boolean | undefined;
 
@@ -48,26 +32,11 @@ /**
 /**
- * @see {@link Tagged} for info on tagging
- *
- * @deprecated Use Tagged\<TelemetryBaseEventPropertyType\>
- * @internal
- */
-export interface ITaggedTelemetryPropertyType {
-	value: TelemetryEventPropertyType;
-	tag: string;
-}
-
-/**
  * JSON-serializable properties, which will be logged with telemetry.
  * @public
  */
-export type ITelemetryBaseProperties = ITelemetryProperties;
-
-/**
- * {@inheritDoc ITelemetryBaseProperties}
- *
- * @deprecated Renamed to {@link ITelemetryBaseProperties}
- * @public
- */
-export interface ITelemetryProperties {
-	[index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
+export interface ITelemetryBaseProperties {
+	/**
+	 * Properties of a telemetry event. They are string-indexed, and their values restricted to a known set of
+	 * types (optionally "wrapped" with {@link Tagged}).
+	 */
+	[index: string]: TelemetryBaseEventPropertyType | Tagged<TelemetryBaseEventPropertyType>;
 }
@@ -115,15 +84,2 @@
 /**
- * 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 interface ITelemetryGenericEvent extends ITelemetryProperties {
-	eventName: string;
-	category?: TelemetryEventCategory;
-}
-
-/**
  * Error telemetry event.
@@ -136,3 +92,3 @@ * Maps to category = "error"
  */
-export interface ITelemetryErrorEvent extends ITelemetryProperties {
+export interface ITelemetryErrorEvent extends ITelemetryBaseProperties {
 	eventName: string;
@@ -142,14 +98,2 @@ }
 /**
- * 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 interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
-	duration?: number; // Duration of event (optional)
-}
-
-/**
  * An error object that supports exporting its properties to be logged to telemetry
@@ -164,56 +108,1 @@ * @internal
 }
-
-/**
- * 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 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,
-		// TODO: Use `unknown` instead (API-Breaking)
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		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
-	 */
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	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,
-		// TODO: Use `unknown` instead (API-Breaking)
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		error?: any,
-		logLevel?: typeof LogLevel.verbose | typeof LogLevel.default,
-	): void;
-}

tsconfig.json

 {
-	"extends": [
-		"../../../common/build/build-common/tsconfig.base.json",
-		"../../../common/build/build-common/tsconfig.cjs.json",
-	],
+	"extends": "../../../common/build/build-common/tsconfig.node16.json",
 	"include": ["src/**/*"],
@@ -10,4 +7,4 @@ "exclude": ["src/test/**/*"],
 		"rootDir": "./src",
-		"outDir": "./dist",
+		"outDir": "./lib",
 	},
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

699504

increased by7.4%

Dev dependency count

13

decreased by-7.14%

Number of package files

135

increased by4.65%

Lines of code

9388

increased by58.39%

Is type module

Yes

No dependency changes