@fluidframework/core-interfaces - npm Package Compare versions

Comparing version 2.0.0-dev.7.4.0.217212 to 2.0.0-dev.7.4.0.217884

api-report/core-interfaces.api.md

@@ -7,3 +7,3 @@ ## API Report File for "@fluidframework/core-interfaces"
 
-// @internal
+// @alpha
 export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
@@ -31,3 +31,3 @@
 
-// @internal
+// @alpha
 export type FluidObjectKeys<T> = keyof FluidObject<T>;
@@ -38,3 +38,3 @@
 
-// @internal
+// @alpha
 export interface IConfigProviderBase {
@@ -257,6 +257,6 @@ getRawConfig(name: string): ConfigTypes;
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidHandle: keyof IProvideFluidHandle;
 
-// @internal
+// @alpha
 export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
@@ -273,6 +273,6 @@ // @deprecated (undocumented)
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidHandleContext: keyof IProvideFluidHandleContext;
 
-// @internal
+// @alpha
 export interface IFluidHandleContext extends IProvideFluidHandleContext {
@@ -287,6 +287,6 @@ readonly absolutePath: string;
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidLoadable: keyof IProvideFluidLoadable;
 
-// @internal
+// @alpha
 export interface IFluidLoadable extends IProvideFluidLoadable {
@@ -352,3 +352,3 @@ // (undocumented)
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidHandle {
@@ -359,3 +359,3 @@ // (undocumented)
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidHandleContext {
@@ -366,3 +366,3 @@ // (undocumented)
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidLoadable {
@@ -448,3 +448,3 @@ // (undocumented)
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryErrorEvent extends ITelemetryProperties {
@@ -455,3 +455,3 @@ // (undocumented)
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryGenericEvent extends ITelemetryProperties {
@@ -464,3 +464,3 @@ // (undocumented)
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryLogger extends ITelemetryBaseLogger {
@@ -473,3 +473,3 @@ send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
@@ -524,3 +524,3 @@ // (undocumented)
 
-// @internal @deprecated
+// @alpha @deprecated
 export type TelemetryEventCategory = "generic" | "error" | "performance";
@@ -527,0 +527,0 @@

dist/config.d.ts

@@ -7,3 +7,3 @@ /*!
  * Types supported by {@link IConfigProviderBase}.
- * @internal
+ * @alpha
  */
@@ -13,3 +13,3 @@ export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
  * Base interface for providing configurations to enable/disable/control features.
- * @internal
+ * @alpha
  */
@@ -16,0 +16,0 @@ export interface IConfigProviderBase {

dist/core-interfaces-alpha.d.ts

@@ -1,2 +0,6 @@
-/* Excluded from this release type: ConfigTypes */
+/**
+ * Types supported by {@link IConfigProviderBase}.
+ * @alpha
+ */
+export declare type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
 
@@ -68,3 +72,12 @@ /**
 
-/* Excluded from this release type: FluidObjectKeys */
+/**
+ * This utility type creates a type that is the union of all keys on the generic type
+ * which implement the FluidObject pattern.
+ *
+ * See {@link FluidObject}
+ *
+ * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
+ * @alpha
+ */
+export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
 
@@ -99,3 +112,27 @@ /**
 
-/* Excluded from this release type: IConfigProviderBase */
+/**
+ * Base interface for providing configurations to enable/disable/control features.
+ * @alpha
+ */
+export declare interface IConfigProviderBase {
+    /**
+     * For the specified config name this function gets the value.
+     *
+     * This type is meant be easy to implement by Fluid Framework consumers
+     * so the returned valued needs minimal type coercion, and allows consumers to
+     * return values in a natural way from whatever source they retrieve them.
+     *
+     * For instance a value of 1 maybe be returned as a string or a number.
+     * For array types a json string or an object are allowable.
+     *
+     * It should return undefined if there is no value available for the config name.
+     *
+     * @param name - The name of the config to get the value for.
+     *
+     * @privateRemarks Generally, this type should only be taken as input, and be wrapped by an
+     * internal monitoring context from the fluidframework/telemetry-utils package. That will provide
+     * a wrapper with provides strongly typed access to values via consistent type coercion.
+     */
+    getRawConfig(name: string): ConfigTypes;
+}
 
@@ -393,8 +430,84 @@ /**
 
-/* Excluded from this release type: IFluidHandle */
+/**
+ * @alpha
+ */
+export declare const IFluidHandle: keyof IProvideFluidHandle;
 
-/* Excluded from this release type: IFluidHandleContext */
+/**
+ * Handle to a shared {@link FluidObject}.
+ * @alpha
+ */
+export declare interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
+    /**
+     * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
+     *
+     * The absolute path to the handle context from the root.
+     */
+    readonly absolutePath: string;
+    /**
+     * Flag indicating whether or not the entity has services attached.
+     */
+    readonly isAttached: boolean;
+    /**
+     * @deprecated To be removed. This is part of an internal API surface and should not be called.
+     *
+     * Runs through the graph and attach the bounded handles.
+     */
+    attachGraph(): void;
+    /**
+     * Returns a promise to the Fluid Object referenced by the handle.
+     */
+    get(): Promise<T>;
+    /**
+     * @deprecated To be removed. This is part of an internal API surface and should not be called.
+     *
+     * Binds the given handle to this one or attach the given handle if this handle is attached.
+     * A bound handle will also be attached once this handle is attached.
+     */
+    bind(handle: IFluidHandle): void;
+}
 
-/* Excluded from this release type: IFluidLoadable */
+/**
+ * @alpha
+ */
+export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
 
+/**
+ * Describes a routing context from which other `IFluidHandleContext`s are defined.
+ * @alpha
+ */
+export declare interface IFluidHandleContext extends IProvideFluidHandleContext {
+    /**
+     * The absolute path to the handle context from the root.
+     */
+    readonly absolutePath: string;
+    /**
+     * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined
+     * at the root.
+     */
+    readonly routeContext?: IFluidHandleContext;
+    /**
+     * Flag indicating whether or not the entity has services attached.
+     */
+    readonly isAttached: boolean;
+    /**
+     * Runs through the graph and attach the bounded handles.
+     */
+    attachGraph(): void;
+    resolveHandle(request: IRequest): Promise<IResponse>;
+}
+
+/**
+ * @alpha
+ */
+export declare const IFluidLoadable: keyof IProvideFluidLoadable;
+
+/**
+ * A shared FluidObject has a URL from which it can be referenced
+ * @alpha
+ */
+export declare interface IFluidLoadable extends IProvideFluidLoadable {
+    handle: IFluidHandle;
+}
+
 /* Excluded from this release type: IFluidPackage */
@@ -426,7 +539,22 @@
 
-/* Excluded from this release type: IProvideFluidHandle */
+/**
+ * @alpha
+ */
+export declare interface IProvideFluidHandle {
+    readonly IFluidHandle: IFluidHandle;
+}
 
-/* Excluded from this release type: IProvideFluidHandleContext */
+/**
+ * @alpha
+ */
+export declare interface IProvideFluidHandleContext {
+    readonly IFluidHandleContext: IFluidHandleContext;
+}
 
-/* Excluded from this release type: IProvideFluidLoadable */
+/**
+ * @alpha
+ */
+export declare interface IProvideFluidLoadable {
+    readonly IFluidLoadable: IFluidLoadable;
+}
 
@@ -506,9 +634,77 @@ /**
 
-/* Excluded from this release type: ITelemetryErrorEvent */
+/**
+ * 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.
+ * @alpha
+ */
+export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
+    eventName: string;
+}
 
-/* Excluded from this release type: ITelemetryGenericEvent */
+/**
+ * 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.
+ * @alpha
+ */
+export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
+    eventName: string;
+    category?: TelemetryEventCategory;
+}
 
-/* Excluded from this release type: ITelemetryLogger */
+/**
+ * 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.
+ * @alpha
+ */
+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;
+    /**
+     * 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;
+}
 
-/* Excluded from this release type: ITelemetryPerformanceEvent */
+/**
+ * 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.
+ * @alpha
+ */
+export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
+    duration?: number;
+}
 
@@ -568,3 +764,9 @@ /**
 
-/* Excluded from this release type: TelemetryEventCategory */
+/**
+ * Examples of known categories, however category can be any string for extensibility.
+ *
+ * @deprecated Moved to \@fluidframework/telemetry-utils package
+ * @alpha
+ */
+export declare type TelemetryEventCategory = "generic" | "error" | "performance";
 
@@ -571,0 +773,0 @@ /**

dist/core-interfaces-untrimmed.d.ts

 /**
  * Types supported by {@link IConfigProviderBase}.
- * @internal
+ * @alpha
  */
@@ -109,3 +109,3 @@ export declare type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- * @internal
+ * @alpha
  */
@@ -144,3 +144,3 @@ export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
  * Base interface for providing configurations to enable/disable/control features.
- * @internal
+ * @alpha
  */
@@ -524,3 +524,3 @@ export declare interface IConfigProviderBase {
 /**
- * @internal
+ * @alpha
  */
@@ -531,3 +531,3 @@ export declare const IFluidHandle: keyof IProvideFluidHandle;
  * Handle to a shared {@link FluidObject}.
- * @internal
+ * @alpha
  */
@@ -565,3 +565,3 @@ export declare interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
 /**
- * @internal
+ * @alpha
  */
@@ -572,3 +572,3 @@ export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
- * @internal
+ * @alpha
  */
@@ -597,3 +597,3 @@ export declare interface IFluidHandleContext extends IProvideFluidHandleContext {
 /**
- * @internal
+ * @alpha
  */
@@ -604,3 +604,3 @@ export declare const IFluidLoadable: keyof IProvideFluidLoadable;
  * A shared FluidObject has a URL from which it can be referenced
- * @internal
+ * @alpha
  */
@@ -732,3 +732,3 @@ export declare interface IFluidLoadable extends IProvideFluidLoadable {
 /**
- * @internal
+ * @alpha
  */
@@ -740,3 +740,3 @@ export declare interface IProvideFluidHandle {
 /**
- * @internal
+ * @alpha
  */
@@ -748,3 +748,3 @@ export declare interface IProvideFluidHandleContext {
 /**
- * @internal
+ * @alpha
  */
@@ -862,3 +862,3 @@ export declare interface IProvideFluidLoadable {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -875,3 +875,3 @@ export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -890,3 +890,3 @@ export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -929,3 +929,3 @@ export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -1020,3 +1020,3 @@ export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
  * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @internal
+ * @alpha
  */
@@ -1023,0 +1023,0 @@ export declare type TelemetryEventCategory = "generic" | "error" | "performance";

dist/fluidLoadable.d.ts

@@ -7,7 +7,7 @@ /*!
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidLoadable: keyof IProvideFluidLoadable;
 /**
- * @internal
+ * @alpha
  */
@@ -19,3 +19,3 @@ export interface IProvideFluidLoadable {
  * A shared FluidObject has a URL from which it can be referenced
- * @internal
+ * @alpha
  */
@@ -22,0 +22,0 @@ export interface IFluidLoadable extends IProvideFluidLoadable {

dist/fluidLoadable.js

@@ -9,3 +9,3 @@ "use strict";
 /**
- * @internal
+ * @alpha
  */
@@ -12,0 +12,0 @@ exports.IFluidLoadable = "IFluidLoadable";

dist/handles.d.ts

@@ -9,7 +9,7 @@ /*!
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
 /**
- * @internal
+ * @alpha
  */
@@ -21,3 +21,3 @@ export interface IProvideFluidHandleContext {
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
- * @internal
+ * @alpha
  */
@@ -45,7 +45,7 @@ export interface IFluidHandleContext extends IProvideFluidHandleContext {
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidHandle: keyof IProvideFluidHandle;
 /**
- * @internal
+ * @alpha
  */
@@ -57,3 +57,3 @@ export interface IProvideFluidHandle {
  * Handle to a shared {@link FluidObject}.
- * @internal
+ * @alpha
  */
@@ -60,0 +60,0 @@ export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {

dist/handles.js

@@ -9,9 +9,9 @@ "use strict";
 /**
- * @internal
+ * @alpha
  */
 exports.IFluidHandleContext = "IFluidHandleContext";
 /**
- * @internal
+ * @alpha
  */
 exports.IFluidHandle = "IFluidHandle";
 //# sourceMappingURL=handles.js.map

dist/logger.d.ts

@@ -9,3 +9,3 @@ /*!
  * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @internal
+ * @alpha
  */
@@ -105,3 +105,3 @@ export type TelemetryEventCategory = "generic" | "error" | "performance";
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -118,3 +118,3 @@ export interface ITelemetryGenericEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -130,3 +130,3 @@ export interface ITelemetryErrorEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -153,3 +153,3 @@ export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -156,0 +156,0 @@ export interface ITelemetryLogger extends ITelemetryBaseLogger {

dist/provider.d.ts

@@ -75,5 +75,5 @@ /*!
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- * @internal
+ * @alpha
  */
 export type FluidObjectKeys<T> = keyof FluidObject<T>;
 //# sourceMappingURL=provider.d.ts.map

lib/config.d.ts

@@ -7,3 +7,3 @@ /*!
  * Types supported by {@link IConfigProviderBase}.
- * @internal
+ * @alpha
  */
@@ -13,3 +13,3 @@ export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
  * Base interface for providing configurations to enable/disable/control features.
- * @internal
+ * @alpha
  */
@@ -16,0 +16,0 @@ export interface IConfigProviderBase {

lib/core-interfaces-alpha.d.ts

@@ -1,2 +0,6 @@
-/* Excluded from this release type: ConfigTypes */
+/**
+ * Types supported by {@link IConfigProviderBase}.
+ * @alpha
+ */
+export declare type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
 
@@ -68,3 +72,12 @@ /**
 
-/* Excluded from this release type: FluidObjectKeys */
+/**
+ * This utility type creates a type that is the union of all keys on the generic type
+ * which implement the FluidObject pattern.
+ *
+ * See {@link FluidObject}
+ *
+ * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
+ * @alpha
+ */
+export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
 
@@ -99,3 +112,27 @@ /**
 
-/* Excluded from this release type: IConfigProviderBase */
+/**
+ * Base interface for providing configurations to enable/disable/control features.
+ * @alpha
+ */
+export declare interface IConfigProviderBase {
+    /**
+     * For the specified config name this function gets the value.
+     *
+     * This type is meant be easy to implement by Fluid Framework consumers
+     * so the returned valued needs minimal type coercion, and allows consumers to
+     * return values in a natural way from whatever source they retrieve them.
+     *
+     * For instance a value of 1 maybe be returned as a string or a number.
+     * For array types a json string or an object are allowable.
+     *
+     * It should return undefined if there is no value available for the config name.
+     *
+     * @param name - The name of the config to get the value for.
+     *
+     * @privateRemarks Generally, this type should only be taken as input, and be wrapped by an
+     * internal monitoring context from the fluidframework/telemetry-utils package. That will provide
+     * a wrapper with provides strongly typed access to values via consistent type coercion.
+     */
+    getRawConfig(name: string): ConfigTypes;
+}
 
@@ -393,8 +430,84 @@ /**
 
-/* Excluded from this release type: IFluidHandle */
+/**
+ * @alpha
+ */
+export declare const IFluidHandle: keyof IProvideFluidHandle;
 
-/* Excluded from this release type: IFluidHandleContext */
+/**
+ * Handle to a shared {@link FluidObject}.
+ * @alpha
+ */
+export declare interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
+    /**
+     * @deprecated Do not use handle's path for routing. Use `get` to get the underlying object.
+     *
+     * The absolute path to the handle context from the root.
+     */
+    readonly absolutePath: string;
+    /**
+     * Flag indicating whether or not the entity has services attached.
+     */
+    readonly isAttached: boolean;
+    /**
+     * @deprecated To be removed. This is part of an internal API surface and should not be called.
+     *
+     * Runs through the graph and attach the bounded handles.
+     */
+    attachGraph(): void;
+    /**
+     * Returns a promise to the Fluid Object referenced by the handle.
+     */
+    get(): Promise<T>;
+    /**
+     * @deprecated To be removed. This is part of an internal API surface and should not be called.
+     *
+     * Binds the given handle to this one or attach the given handle if this handle is attached.
+     * A bound handle will also be attached once this handle is attached.
+     */
+    bind(handle: IFluidHandle): void;
+}
 
-/* Excluded from this release type: IFluidLoadable */
+/**
+ * @alpha
+ */
+export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
 
+/**
+ * Describes a routing context from which other `IFluidHandleContext`s are defined.
+ * @alpha
+ */
+export declare interface IFluidHandleContext extends IProvideFluidHandleContext {
+    /**
+     * The absolute path to the handle context from the root.
+     */
+    readonly absolutePath: string;
+    /**
+     * The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined
+     * at the root.
+     */
+    readonly routeContext?: IFluidHandleContext;
+    /**
+     * Flag indicating whether or not the entity has services attached.
+     */
+    readonly isAttached: boolean;
+    /**
+     * Runs through the graph and attach the bounded handles.
+     */
+    attachGraph(): void;
+    resolveHandle(request: IRequest): Promise<IResponse>;
+}
+
+/**
+ * @alpha
+ */
+export declare const IFluidLoadable: keyof IProvideFluidLoadable;
+
+/**
+ * A shared FluidObject has a URL from which it can be referenced
+ * @alpha
+ */
+export declare interface IFluidLoadable extends IProvideFluidLoadable {
+    handle: IFluidHandle;
+}
+
 /* Excluded from this release type: IFluidPackage */
@@ -426,7 +539,22 @@
 
-/* Excluded from this release type: IProvideFluidHandle */
+/**
+ * @alpha
+ */
+export declare interface IProvideFluidHandle {
+    readonly IFluidHandle: IFluidHandle;
+}
 
-/* Excluded from this release type: IProvideFluidHandleContext */
+/**
+ * @alpha
+ */
+export declare interface IProvideFluidHandleContext {
+    readonly IFluidHandleContext: IFluidHandleContext;
+}
 
-/* Excluded from this release type: IProvideFluidLoadable */
+/**
+ * @alpha
+ */
+export declare interface IProvideFluidLoadable {
+    readonly IFluidLoadable: IFluidLoadable;
+}
 
@@ -506,9 +634,77 @@ /**
 
-/* Excluded from this release type: ITelemetryErrorEvent */
+/**
+ * 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.
+ * @alpha
+ */
+export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
+    eventName: string;
+}
 
-/* Excluded from this release type: ITelemetryGenericEvent */
+/**
+ * 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.
+ * @alpha
+ */
+export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
+    eventName: string;
+    category?: TelemetryEventCategory;
+}
 
-/* Excluded from this release type: ITelemetryLogger */
+/**
+ * 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.
+ * @alpha
+ */
+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;
+    /**
+     * 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;
+}
 
-/* Excluded from this release type: ITelemetryPerformanceEvent */
+/**
+ * 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.
+ * @alpha
+ */
+export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
+    duration?: number;
+}
 
@@ -568,3 +764,9 @@ /**
 
-/* Excluded from this release type: TelemetryEventCategory */
+/**
+ * Examples of known categories, however category can be any string for extensibility.
+ *
+ * @deprecated Moved to \@fluidframework/telemetry-utils package
+ * @alpha
+ */
+export declare type TelemetryEventCategory = "generic" | "error" | "performance";
 
@@ -571,0 +773,0 @@ /**

lib/core-interfaces-untrimmed.d.ts

 /**
  * Types supported by {@link IConfigProviderBase}.
- * @internal
+ * @alpha
  */
@@ -109,3 +109,3 @@ export declare type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- * @internal
+ * @alpha
  */
@@ -144,3 +144,3 @@ export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
  * Base interface for providing configurations to enable/disable/control features.
- * @internal
+ * @alpha
  */
@@ -524,3 +524,3 @@ export declare interface IConfigProviderBase {
 /**
- * @internal
+ * @alpha
  */
@@ -531,3 +531,3 @@ export declare const IFluidHandle: keyof IProvideFluidHandle;
  * Handle to a shared {@link FluidObject}.
- * @internal
+ * @alpha
  */
@@ -565,3 +565,3 @@ export declare interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
 /**
- * @internal
+ * @alpha
  */
@@ -572,3 +572,3 @@ export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
- * @internal
+ * @alpha
  */
@@ -597,3 +597,3 @@ export declare interface IFluidHandleContext extends IProvideFluidHandleContext {
 /**
- * @internal
+ * @alpha
  */
@@ -604,3 +604,3 @@ export declare const IFluidLoadable: keyof IProvideFluidLoadable;
  * A shared FluidObject has a URL from which it can be referenced
- * @internal
+ * @alpha
  */
@@ -732,3 +732,3 @@ export declare interface IFluidLoadable extends IProvideFluidLoadable {
 /**
- * @internal
+ * @alpha
  */
@@ -740,3 +740,3 @@ export declare interface IProvideFluidHandle {
 /**
- * @internal
+ * @alpha
  */
@@ -748,3 +748,3 @@ export declare interface IProvideFluidHandleContext {
 /**
- * @internal
+ * @alpha
  */
@@ -862,3 +862,3 @@ export declare interface IProvideFluidLoadable {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -875,3 +875,3 @@ export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -890,3 +890,3 @@ export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -929,3 +929,3 @@ export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -1020,3 +1020,3 @@ export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
  * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @internal
+ * @alpha
  */
@@ -1023,0 +1023,0 @@ export declare type TelemetryEventCategory = "generic" | "error" | "performance";

lib/fluidLoadable.d.ts

@@ -7,7 +7,7 @@ /*!
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidLoadable: keyof IProvideFluidLoadable;
 /**
- * @internal
+ * @alpha
  */
@@ -19,3 +19,3 @@ export interface IProvideFluidLoadable {
  * A shared FluidObject has a URL from which it can be referenced
- * @internal
+ * @alpha
  */
@@ -22,0 +22,0 @@ export interface IFluidLoadable extends IProvideFluidLoadable {

lib/fluidLoadable.js

@@ -6,3 +6,3 @@ /*!
 /**
- * @internal
+ * @alpha
  */
@@ -9,0 +9,0 @@ export const IFluidLoadable = "IFluidLoadable";

lib/handles.d.ts

@@ -9,7 +9,7 @@ /*!
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
 /**
- * @internal
+ * @alpha
  */
@@ -21,3 +21,3 @@ export interface IProvideFluidHandleContext {
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
- * @internal
+ * @alpha
  */
@@ -45,7 +45,7 @@ export interface IFluidHandleContext extends IProvideFluidHandleContext {
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidHandle: keyof IProvideFluidHandle;
 /**
- * @internal
+ * @alpha
  */
@@ -57,3 +57,3 @@ export interface IProvideFluidHandle {
  * Handle to a shared {@link FluidObject}.
- * @internal
+ * @alpha
  */
@@ -60,0 +60,0 @@ export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {

lib/handles.js

@@ -6,9 +6,9 @@ /*!
 /**
- * @internal
+ * @alpha
  */
 export const IFluidHandleContext = "IFluidHandleContext";
 /**
- * @internal
+ * @alpha
  */
 export const IFluidHandle = "IFluidHandle";
 //# sourceMappingURL=handles.js.map

lib/logger.d.ts

@@ -9,3 +9,3 @@ /*!
  * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @internal
+ * @alpha
  */
@@ -105,3 +105,3 @@ export type TelemetryEventCategory = "generic" | "error" | "performance";
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -118,3 +118,3 @@ export interface ITelemetryGenericEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -130,3 +130,3 @@ export interface ITelemetryErrorEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -153,3 +153,3 @@ export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -156,0 +156,0 @@ export interface ITelemetryLogger extends ITelemetryBaseLogger {

lib/provider.d.ts

@@ -75,5 +75,5 @@ /*!
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- * @internal
+ * @alpha
  */
 export type FluidObjectKeys<T> = keyof FluidObject<T>;
 //# sourceMappingURL=provider.d.ts.map

package.json

 {
   "name": "@fluidframework/core-interfaces",
-  "version": "2.0.0-dev.7.4.0.217212",
+  "version": "2.0.0-dev.7.4.0.217884",
   "description": "Fluid object interfaces",
@@ -24,3 +24,3 @@ "homepage": "https://fluidframework.com",
     "@microsoft/api-extractor": "^7.38.3",
-    "@types/node": "^16.18.38",
+    "@types/node": "^18.19.0",
     "copyfiles": "^2.4.1",
@@ -27,0 +27,0 @@ "eslint": "~8.50.0",

src/config.ts

@@ -8,3 +8,3 @@ /*!
  * Types supported by {@link IConfigProviderBase}.
- * @internal
+ * @alpha
  */
@@ -15,3 +15,3 @@ export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
  * Base interface for providing configurations to enable/disable/control features.
- * @internal
+ * @alpha
  */
@@ -18,0 +18,0 @@ export interface IConfigProviderBase {

src/fluidLoadable.ts

@@ -9,3 +9,3 @@ /*!
 /**
- * @internal
+ * @alpha
  */
@@ -15,3 +15,3 @@ export const IFluidLoadable: keyof IProvideFluidLoadable = "IFluidLoadable";
 /**
- * @internal
+ * @alpha
  */
@@ -23,3 +23,3 @@ export interface IProvideFluidLoadable {
  * A shared FluidObject has a URL from which it can be referenced
- * @internal
+ * @alpha
  */
@@ -26,0 +26,0 @@ export interface IFluidLoadable extends IProvideFluidLoadable {

src/handles.ts

@@ -11,3 +11,3 @@ /*!
 /**
- * @internal
+ * @alpha
  */
@@ -17,3 +17,3 @@ export const IFluidHandleContext: keyof IProvideFluidHandleContext = "IFluidHandleContext";
 /**
- * @internal
+ * @alpha
  */
@@ -26,3 +26,3 @@ export interface IProvideFluidHandleContext {
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
- * @internal
+ * @alpha
  */
@@ -55,3 +55,3 @@ export interface IFluidHandleContext extends IProvideFluidHandleContext {
 /**
- * @internal
+ * @alpha
  */
@@ -61,3 +61,3 @@ export const IFluidHandle: keyof IProvideFluidHandle = "IFluidHandle";
 /**
- * @internal
+ * @alpha
  */
@@ -70,3 +70,3 @@ export interface IProvideFluidHandle {
  * Handle to a shared {@link FluidObject}.
- * @internal
+ * @alpha
  */
@@ -73,0 +73,0 @@ export interface IFluidHandle<

src/logger.ts

@@ -10,3 +10,3 @@ /*!
  * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @internal
+ * @alpha
  */
@@ -118,3 +118,3 @@ export type TelemetryEventCategory = "generic" | "error" | "performance";
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -132,3 +132,3 @@ export interface ITelemetryGenericEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -145,3 +145,3 @@ export interface ITelemetryErrorEvent extends ITelemetryProperties {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -170,3 +170,3 @@ export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
@@ -173,0 +173,0 @@ export interface ITelemetryLogger extends ITelemetryBaseLogger {

src/provider.ts

@@ -86,4 +86,4 @@ /*!
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- * @internal
+ * @alpha
  */
 export type FluidObjectKeys<T> = keyof FluidObject<T>;

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

522144

increased by2.58%

Lines of code

7382

increased by5.7%

No dependency changes