@fluidframework/core-interfaces 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.216897

package/src/logger.ts

@@ -7,6 +7,7 @@
  * Examples of known categories, however category can be any string for extensibility.
  *
  * @deprecated Moved to \@fluidframework/telemetry-utils package
+ * @internal
  */
 export type TelemetryEventCategory = "generic" | "error" | "performance";
 
@@ -16,6 +17,7 @@ export type TelemetryEventCategory = "generic" | "error" | "performance";
  * @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.
+ * @internal
  */
 export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
 
@@ -23,6 +25,7 @@ export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
  * {@inheritDoc TelemetryBaseEventPropertyType}
  *
  * @deprecated Renamed to {@link TelemetryBaseEventPropertyType}
+ * @internal
  */
 export type TelemetryEventPropertyType = string | number | boolean | undefined;
 
@@ -32,6 +35,7 @@ export type TelemetryEventPropertyType = string | number | boolean | undefined;
  *
  * This indicates that the value should be organized or handled differently by loggers in various first or third
  * party scenarios. For example, tags are used to mark data that should not be stored in logs for privacy reasons.
+ * @internal
  */
 export interface Tagged<V, T extends string = string> {
 	value: V;
@@ -42,6 +46,7 @@ export interface Tagged<V, T extends string = string> {
  * @see {@link Tagged} for info on tagging
  *
  * @deprecated Use Tagged\<TelemetryBaseEventPropertyType\>
+ * @internal
  */
 export interface ITaggedTelemetryPropertyType {
 	value: TelemetryEventPropertyType;
@@ -50,6 +55,7 @@ export interface ITaggedTelemetryPropertyType {
 
 /**
  * JSON-serializable properties, which will be logged with telemetry.
+ * @internal
  */
 export type ITelemetryBaseProperties = ITelemetryProperties;
 
@@ -57,6 +63,7 @@ export type ITelemetryBaseProperties = ITelemetryProperties;
  * {@inheritDoc ITelemetryBaseProperties}
  *
  * @deprecated Renamed to {@link ITelemetryBaseProperties}
+ * @internal
  */
 export interface ITelemetryProperties {
 	[index: string]: TelemetryEventPropertyType | Tagged<TelemetryEventPropertyType>;
@@ -67,6 +74,7 @@ export interface ITelemetryProperties {
  * Can contain any number of properties that get serialized as json payload.
  * @param category - category of the event, like "error", "performance", "generic", etc.
  * @param eventName - name of the event.
+ * @internal
  */
 export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
 	category: string;
@@ -75,6 +83,7 @@ export interface ITelemetryBaseEvent extends ITelemetryBaseProperties {
 
 /**
  * Specify levels of the logs.
+ * @internal
  */
 export const LogLevel = {
 	verbose: 10, // To log any verbose event for example when you are debugging something.
@@ -84,12 +93,14 @@ export const LogLevel = {
 
 /**
  * Specify a level to the log to filter out logs based on the level.
+ * @internal
  */
 export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
 
 /**
  * Interface to output telemetry events.
  * Implemented by hosting app / loader
+ * @internal
  */
 export interface ITelemetryBaseLogger {
 	send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
@@ -103,6 +114,7 @@ export interface ITelemetryBaseLogger {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryGenericEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @internal
  */
 export interface ITelemetryGenericEvent extends ITelemetryProperties {
 	eventName: string;
@@ -115,6 +127,7 @@ export interface ITelemetryGenericEvent extends ITelemetryProperties {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryErrorEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @internal
  */
 export interface ITelemetryErrorEvent extends ITelemetryProperties {
 	eventName: string;
@@ -126,6 +139,7 @@ export interface ITelemetryErrorEvent extends ITelemetryProperties {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryPerformanceEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @internal
  */
 export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
 	duration?: number; // Duration of event (optional)
@@ -133,6 +147,7 @@ export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
 
 /**
  * An error object that supports exporting its properties to be logged to telemetry
+ * @internal
  */
 export interface ILoggingError extends Error {
 	/**
@@ -148,6 +163,7 @@ export interface ILoggingError extends Error {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryLoggerExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
+ * @internal
  */
 export interface ITelemetryLogger extends ITelemetryBaseLogger {
 	/**

package/src/provider.ts

@@ -27,6 +27,7 @@
  *
  * This pattern enables discovery, and delegation in a standard way which is central
  * to FluidObject pattern.
+ * @internal
  */
 export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp
 	? never
@@ -69,7 +70,7 @@ export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string
  *
  * You can inspect multiple types via a intersection. For example:
  * `FluidObject<IFoo & IBar>`
- *
+ * @internal
  */
 export type FluidObject<T = unknown> = {
 	[P in FluidObjectProviderKeys<T>]?: T[P];
@@ -82,6 +83,6 @@ export type FluidObject<T = unknown> = {
  * See {@link FluidObject}
  *
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- *
+ * @internal
  */
 export type FluidObjectKeys<T> = keyof FluidObject<T>;