Mark Common Packages Internal (#18408)

Mark Common Packages Internal

---------

Co-authored-by: Tony Murphy <[email protected]>

Author: anthony-murphy

common/lib/common-definitions/api-report/common-definitions.api.md

@@ -4,40 +4,40 @@
 
 ```ts
 
-// @public @deprecated
+// @internal @deprecated
 export type ExtendEventProvider<TBaseEvent extends IEvent, TBase extends IEventProvider<TBaseEvent>, TEvent extends TBaseEvent> = Omit<Omit<Omit<TBase, "on">, "once">, "off"> & IEventProvider<TBaseEvent> & IEventProvider<TEvent>;
 
-// @public @deprecated
+// @internal @deprecated
 export interface IDisposable {
     dispose(error?: Error): void;
     readonly disposed: boolean;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface IErrorEvent extends IEvent {
     // @eventProperty
     (event: "error", listener: (message: any) => void): any;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface IEvent {
     // @eventProperty
     (event: string, listener: (...args: any[]) => void): any;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface IEventProvider<TEvent extends IEvent> {
     readonly off: IEventTransformer<this, TEvent>;
     readonly on: IEventTransformer<this, TEvent>;
     readonly once: IEventTransformer<this, TEvent>;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export type IEventThisPlaceHolder = {
     thisPlaceHolder: "thisPlaceHolder";
 };
 
-// @public @deprecated
+// @internal @deprecated
 export type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
     (event: infer E0, listener: (...args: infer A0) => void): any;
     (event: infer E1, listener: (...args: infer A1) => void): any;
@@ -190,79 +190,79 @@ export type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
     (event: string, listener: (...args: any[]) => void): any;
 } ? TransformedEvent<TThis, E0, A0> : TransformedEvent<TThis, string, any[]>;
 
-// @public @deprecated
+// @internal @deprecated
 export interface ILoggingError extends Error {
     getTelemetryProperties(): ITelemetryProperties;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface ITaggedTelemetryPropertyType {
     // (undocumented)
     tag: string;
     // (undocumented)
     value: TelemetryEventPropertyType;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface ITelemetryBaseEvent extends ITelemetryProperties {
     // (undocumented)
     category: string;
     // (undocumented)
     eventName: string;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface ITelemetryBaseLogger {
     // (undocumented)
     send(event: ITelemetryBaseEvent): void;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface ITelemetryErrorEvent extends ITelemetryProperties {
     // (undocumented)
     eventName: string;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface ITelemetryGenericEvent extends ITelemetryProperties {
     // (undocumented)
     category?: TelemetryEventCategory;
     // (undocumented)
     eventName: string;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface ITelemetryLogger extends ITelemetryBaseLogger {
     send(event: ITelemetryBaseEvent): void;
     sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void;
     sendPerformanceEvent(event: ITelemetryPerformanceEvent, error?: any): void;
     sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any): void;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
     // (undocumented)
     duration?: number;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export interface ITelemetryProperties {
     // (undocumented)
     [index: string]: TelemetryEventPropertyType | ITaggedTelemetryPropertyType;
 }
 
-// @public @deprecated
+// @internal @deprecated
 export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[] ? {
     [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K];
 } : L;
 
-// @public @deprecated
+// @internal @deprecated
 export type TelemetryEventCategory = "generic" | "error" | "performance";
 
-// @public @deprecated
+// @internal @deprecated
 export type TelemetryEventPropertyType = string | number | boolean | undefined;
 
-// @public @deprecated
+// @internal @deprecated
 export type TransformedEvent<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;
 
 ```

common/lib/common-definitions/src/disposable.ts

@@ -7,6 +7,7 @@
  * Base interface for objects that require lifetime management via explicit disposal.
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface IDisposable {
 	/**

common/lib/common-definitions/src/events.ts

@@ -7,6 +7,7 @@
  * Base interface for event emitters.
  *
  * @deprecated Use {@link @fluidframework/core-interfaces#IEvent} instead.
+ * @internal
  */
 export interface IEvent {
 	/**
@@ -27,6 +28,7 @@ export interface IEvent {
  * Base interface for error event emitters.
  *
  * @deprecated Use {@link @fluidframework/core-interfaces#IErrorEvent} instead.
+ * @internal
  */
 export interface IErrorEvent extends IEvent {
 	/**
@@ -42,6 +44,7 @@ export interface IErrorEvent extends IEvent {
  * Base interface for event providers.
  *
  * @deprecated Use {@link @fluidframework/core-interfaces#IEventProvider} instead.
+ * @internal
  */
 export interface IEventProvider<TEvent extends IEvent> {
 	/**
@@ -82,6 +85,7 @@ export interface IEventProvider<TEvent extends IEvent> {
  * interface B will now extend interface A and its events
  *
  * @deprecated Use {@link @fluidframework/core-interfaces#ExtendEventProvider} instead.
+ * @internal
  */
 export type ExtendEventProvider<
 	TBaseEvent extends IEvent,
@@ -105,6 +109,7 @@ export type ExtendEventProvider<
  * The placeholder type that should be used instead of `this` in events.
  *
  * @deprecated Use {@link @fluidframework/core-interfaces#IEventThisPlaceholder} instead.
+ * @internal
  */
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export type IEventThisPlaceHolder = { thisPlaceHolder: "thisPlaceHolder" };
@@ -113,6 +118,7 @@ export type IEventThisPlaceHolder = { thisPlaceHolder: "thisPlaceHolder" };
  * Does the type replacement by changing types of {@link IEventThisPlaceHolder} to `TThis`
  *
  * @deprecated Use {@link @fluidframework/core-interfaces#ReplaceIEventThisPlaceHolder} instead.
+ * @internal
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any[]
@@ -124,6 +130,7 @@ export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any
  * arguments and having the overload return `TTHis` as well
  *
  * @deprecated Use {@link @fluidframework/core-interfaces#TransformedEvent} instead.
+ * @internal
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type TransformedEvent<TThis, E, A extends any[]> = (
@@ -141,6 +148,7 @@ export type TransformedEvent<TThis, E, A extends any[]> = (
  * If we need to move beyond 15 we should evaluate using a mapped type pattern like `{"event":(listenerArgs)=>void}`
  *
  * @deprecated Use {@link @fluidframework/core-interfaces#IEventTransformer} instead.
+ * @internal
  */
 export type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
 	(event: infer E0, listener: (...args: infer A0) => void);

common/lib/common-definitions/src/logger.ts

@@ -7,6 +7,7 @@
  * Examples of known categories, however category can be any string for extensibility.
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export type TelemetryEventCategory = "generic" | "error" | "performance";
 
@@ -18,6 +19,7 @@ export type TelemetryEventCategory = "generic" | "error" | "performance";
  * General best practice is to explicitly log the fields you care about from objects.
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export type TelemetryEventPropertyType = string | number | boolean | undefined;
 
@@ -27,6 +29,7 @@ export type TelemetryEventPropertyType = string | number | boolean | undefined;
  * party scenarios. For example, tags are used to mark data that should not be stored in logs for privacy reasons.
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ITaggedTelemetryPropertyType {
 	value: TelemetryEventPropertyType;
@@ -37,6 +40,7 @@ export interface ITaggedTelemetryPropertyType {
  * JSON-serializable properties, which will be logged with telemetry.
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ITelemetryProperties {
 	[index: string]: TelemetryEventPropertyType | ITaggedTelemetryPropertyType;
@@ -49,6 +53,7 @@ export interface ITelemetryProperties {
  * @param eventName - name of the event.
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ITelemetryBaseEvent extends ITelemetryProperties {
 	category: string;
@@ -60,6 +65,7 @@ export interface ITelemetryBaseEvent extends ITelemetryProperties {
  * Implemented by hosting app / loader
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ITelemetryBaseLogger {
 	send(event: ITelemetryBaseEvent): void;
@@ -70,6 +76,7 @@ export interface ITelemetryBaseLogger {
  * Maps to category = "generic"
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ITelemetryGenericEvent extends ITelemetryProperties {
 	eventName: string;
@@ -81,6 +88,7 @@ export interface ITelemetryGenericEvent extends ITelemetryProperties {
  * Maps to category = "error"
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ITelemetryErrorEvent extends ITelemetryProperties {
 	eventName: string;
@@ -91,6 +99,7 @@ export interface ITelemetryErrorEvent extends ITelemetryProperties {
  * Maps to category = "performance"
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
 	duration?: number; // Duration of event (optional)
@@ -100,6 +109,7 @@ export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
  * An error object that supports exporting its properties to be logged to telemetry
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ILoggingError extends Error {
 	/**
@@ -114,6 +124,7 @@ export interface ILoggingError extends Error {
  * Creates sub-logger that appends properties to all events
  *
  * @deprecated Moved to the `@fluidframework/core-interfaces` package.
+ * @internal
  */
 export interface ITelemetryLogger extends ITelemetryBaseLogger {
 	/**