@fluidframework/core-interfaces 2.0.0-dev.7.4.0.217212 → 2.0.0-dev.7.4.0.217884

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

@@ -4,7 +4,7 @@
 
 ```ts
 
-// @internal
+// @alpha
 export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
 
 // @alpha
@@ -27,13 +27,13 @@ export type FluidObject<T = unknown> = {
     [P in FluidObjectProviderKeys<T>]?: T[P];
 };
 
-// @internal
+// @alpha
 export type FluidObjectKeys<T> = keyof FluidObject<T>;
 
 // @alpha
 export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
 
-// @internal
+// @alpha
 export interface IConfigProviderBase {
     getRawConfig(name: string): ConfigTypes;
 }
@@ -251,10 +251,10 @@ export interface IFluidCodeDetailsConfig {
     readonly [key: string]: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidHandle: keyof IProvideFluidHandle;
 
-// @internal
+// @alpha
 export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
     // @deprecated (undocumented)
     readonly absolutePath: string;
@@ -266,10 +266,10 @@ export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvide
     readonly isAttached: boolean;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidHandleContext: keyof IProvideFluidHandleContext;
 
-// @internal
+// @alpha
 export interface IFluidHandleContext extends IProvideFluidHandleContext {
     readonly absolutePath: string;
     attachGraph(): void;
@@ -279,10 +279,10 @@ export interface IFluidHandleContext extends IProvideFluidHandleContext {
     readonly routeContext?: IFluidHandleContext;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export const IFluidLoadable: keyof IProvideFluidLoadable;
 
-// @internal
+// @alpha
 export interface IFluidLoadable extends IProvideFluidLoadable {
     // (undocumented)
     handle: IFluidHandle;
@@ -343,19 +343,19 @@ export interface IProvideFluidCodeDetailsComparer {
     readonly IFluidCodeDetailsComparer: IFluidCodeDetailsComparer;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidHandle {
     // (undocumented)
     readonly IFluidHandle: IFluidHandle;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidHandleContext {
     // (undocumented)
     readonly IFluidHandleContext: IFluidHandleContext;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IProvideFluidLoadable {
     // (undocumented)
     readonly IFluidLoadable: IFluidLoadable;
@@ -436,13 +436,13 @@ export interface ITelemetryBaseLogger {
 // @alpha
 export type ITelemetryBaseProperties = ITelemetryProperties;
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryErrorEvent extends ITelemetryProperties {
     // (undocumented)
     eventName: string;
 }
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryGenericEvent extends ITelemetryProperties {
     // (undocumented)
     category?: TelemetryEventCategory;
@@ -450,7 +450,7 @@ export interface ITelemetryGenericEvent extends ITelemetryProperties {
     eventName: string;
 }
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryLogger extends ITelemetryBaseLogger {
     send(event: ITelemetryBaseEvent, logLevel?: LogLevel): void;
     sendErrorEvent(event: ITelemetryErrorEvent, error?: any): void;
@@ -458,7 +458,7 @@ export interface ITelemetryLogger extends ITelemetryBaseLogger {
     sendTelemetryEvent(event: ITelemetryGenericEvent, error?: any, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void;
 }
 
-// @internal @deprecated
+// @alpha @deprecated
 export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
     // (undocumented)
     duration?: number;
@@ -508,7 +508,7 @@ export interface Tagged<V, T extends string = string> {
 // @internal
 export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
 
-// @internal @deprecated
+// @alpha @deprecated
 export type TelemetryEventCategory = "generic" | "error" | "performance";
 
 // @alpha @deprecated

package/dist/config.d.ts

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

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Types supported by {@link IConfigProviderBase}.\n * @internal\n */\nexport type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;\n\n/**\n * Base interface for providing configurations to enable/disable/control features.\n * @internal\n */\nexport interface IConfigProviderBase {\n\t/**\n\t * For the specified config name this function gets the value.\n\t *\n\t * This type is meant be easy to implement by Fluid Framework consumers\n\t * so the returned valued needs minimal type coercion, and allows consumers to\n\t * return values in a natural way from whatever source they retrieve them.\n\t *\n\t * For instance a value of 1 maybe be returned as a string or a number.\n\t * For array types a json string or an object are allowable.\n\t *\n\t * It should return undefined if there is no value available for the config name.\n\t *\n\t * @param name - The name of the config to get the value for.\n\t *\n\t * @privateRemarks Generally, this type should only be taken as input, and be wrapped by an\n\t * internal monitoring context from the fluidframework/telemetry-utils package. That will provide\n\t * a wrapper with provides strongly typed access to values via consistent type coercion.\n\t */\n\tgetRawConfig(name: string): ConfigTypes;\n}\n"]}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Types supported by {@link IConfigProviderBase}.\n * @alpha\n */\nexport type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;\n\n/**\n * Base interface for providing configurations to enable/disable/control features.\n * @alpha\n */\nexport interface IConfigProviderBase {\n\t/**\n\t * For the specified config name this function gets the value.\n\t *\n\t * This type is meant be easy to implement by Fluid Framework consumers\n\t * so the returned valued needs minimal type coercion, and allows consumers to\n\t * return values in a natural way from whatever source they retrieve them.\n\t *\n\t * For instance a value of 1 maybe be returned as a string or a number.\n\t * For array types a json string or an object are allowable.\n\t *\n\t * It should return undefined if there is no value available for the config name.\n\t *\n\t * @param name - The name of the config to get the value for.\n\t *\n\t * @privateRemarks Generally, this type should only be taken as input, and be wrapped by an\n\t * internal monitoring context from the fluidframework/telemetry-utils package. That will provide\n\t * a wrapper with provides strongly typed access to values via consistent type coercion.\n\t */\n\tgetRawConfig(name: string): ConfigTypes;\n}\n"]}

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

@@ -1,4 +1,8 @@
-/* Excluded from this release type: ConfigTypes */
+/**
+ * Types supported by {@link IConfigProviderBase}.
+ * @alpha
+ */
+export declare type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
 
 /**
  * Allows an interface to extend interfaces that already extend an {@link IEventProvider}.
@@ -65,7 +69,16 @@ export declare type FluidObject<T = unknown> = {
     [P in FluidObjectProviderKeys<T>]?: T[P];
 };
 
-/* 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>;
 
 /**
  * Produces a valid FluidObject key given a type and a property.
@@ -95,7 +108,31 @@ export declare type FluidObject<T = unknown> = {
  */
 export declare type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
 
-/* 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;
+}
 
 /**
  * Base interface for objects that require lifetime management via explicit disposal.
@@ -388,11 +425,87 @@ export declare type IEventTransformer<TThis, TEvent extends IEvent> = TEvent ext
 
 /* Excluded from this release type: IFluidCodeDetailsConfig */
 
-/* Excluded from this release type: IFluidHandle */
+/**
+ * @alpha
+ */
+export declare const IFluidHandle: keyof IProvideFluidHandle;
+
+/**
+ * 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: IFluidHandleContext */
+/**
+ * @alpha
+ */
+export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
 
-/* Excluded from this release type: IFluidLoadable */
+/**
+ * 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 */
 
@@ -420,11 +533,26 @@ export declare interface IFluidRouter extends IProvideFluidRouter {
 
 /* Excluded from this release type: IProvideFluidCodeDetailsComparer */
 
-/* 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;
+}
 
 /**
  * Request routing
@@ -499,13 +627,81 @@ export declare interface ITelemetryBaseLogger {
  */
 export declare type ITelemetryBaseProperties = ITelemetryProperties;
 
-/* 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;
+}
 
 /**
  * {@inheritDoc ITelemetryBaseProperties}
@@ -560,7 +756,13 @@ export declare interface Tagged<V, T extends string = string> {
 
 /* Excluded from this release type: TelemetryBaseEventPropertyType */
 
-/* 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";
 
 /**
  * {@inheritDoc TelemetryBaseEventPropertyType}

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

@@ -1,6 +1,6 @@
 /**
  * Types supported by {@link IConfigProviderBase}.
- * @internal
+ * @alpha
  */
 export declare type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
 
@@ -106,7 +106,7 @@ export declare type FluidObject<T = unknown> = {
  * See {@link FluidObject}
  *
  * For example `FluidObjectKeys<IFoo & IBar>` would result in `"IFoo" | "IBar"`
- * @internal
+ * @alpha
  */
 export declare type FluidObjectKeys<T> = keyof FluidObject<T>;
 
@@ -140,7 +140,7 @@ export declare type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T>
 
 /**
  * Base interface for providing configurations to enable/disable/control features.
- * @internal
+ * @alpha
  */
 export declare interface IConfigProviderBase {
     /**
@@ -519,13 +519,13 @@ export declare interface IFluidCodeDetailsConfig {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidHandle: keyof IProvideFluidHandle;
 
 /**
  * Handle to a shared {@link FluidObject}.
- * @internal
+ * @alpha
  */
 export declare interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
     /**
@@ -558,13 +558,13 @@ export declare interface IFluidHandle<T = FluidObject & IFluidLoadable> extends
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
 
 /**
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
- * @internal
+ * @alpha
  */
 export declare interface IFluidHandleContext extends IProvideFluidHandleContext {
     /**
@@ -588,13 +588,13 @@ export declare interface IFluidHandleContext extends IProvideFluidHandleContext
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidLoadable: keyof IProvideFluidLoadable;
 
 /**
  * A shared FluidObject has a URL from which it can be referenced
- * @internal
+ * @alpha
  */
 export declare interface IFluidLoadable extends IProvideFluidLoadable {
     handle: IFluidHandle;
@@ -721,21 +721,21 @@ export declare interface IProvideFluidCodeDetailsComparer {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IProvideFluidHandle {
     readonly IFluidHandle: IFluidHandle;
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IProvideFluidHandleContext {
     readonly IFluidHandleContext: IFluidHandleContext;
 }
 
 /**
- * @internal
+ * @alpha
  */
 export declare interface IProvideFluidLoadable {
     readonly IFluidLoadable: IFluidLoadable;
@@ -848,7 +848,7 @@ export declare type ITelemetryBaseProperties = ITelemetryProperties;
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryErrorEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
 export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
     eventName: string;
@@ -860,7 +860,7 @@ export declare interface ITelemetryErrorEvent extends ITelemetryProperties {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryGenericEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
 export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
     eventName: string;
@@ -874,7 +874,7 @@ export declare interface ITelemetryGenericEvent extends ITelemetryProperties {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryLoggerExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
 export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
     /**
@@ -912,7 +912,7 @@ export declare interface ITelemetryLogger extends ITelemetryBaseLogger {
  *
  * @deprecated For internal use within FluidFramework, use ITelemetryPerformanceEventExt in \@fluidframework/telemetry-utils.
  * No replacement intended for FluidFramework consumers.
- * @internal
+ * @alpha
  */
 export declare interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent {
     duration?: number;
@@ -1002,7 +1002,7 @@ export declare type TelemetryBaseEventPropertyType = TelemetryEventPropertyType;
  * Examples of known categories, however category can be any string for extensibility.
  *
  * @deprecated Moved to \@fluidframework/telemetry-utils package
- * @internal
+ * @alpha
  */
 export declare type TelemetryEventCategory = "generic" | "error" | "performance";
 

package/dist/fluidLoadable.d.ts

@@ -4,18 +4,18 @@
  */
 import { IFluidHandle } from "./handles";
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidLoadable: keyof IProvideFluidLoadable;
 /**
- * @internal
+ * @alpha
  */
 export interface IProvideFluidLoadable {
     readonly IFluidLoadable: IFluidLoadable;
 }
 /**
  * A shared FluidObject has a URL from which it can be referenced
- * @internal
+ * @alpha
  */
 export interface IFluidLoadable extends IProvideFluidLoadable {
     handle: IFluidHandle;

package/dist/fluidLoadable.js

@@ -6,7 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IFluidRunnable = exports.IFluidLoadable = void 0;
 /**
- * @internal
+ * @alpha
  */
 exports.IFluidLoadable = "IFluidLoadable";
 /**

package/dist/fluidLoadable.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,cAAc,GAAgC,gBAAgB,CAAC;AAiB5E;;GAEG;AACU,QAAA,cAAc,GAAgC,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"./handles\";\n\n/**\n * @internal\n */\nexport const IFluidLoadable: keyof IProvideFluidLoadable = \"IFluidLoadable\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidLoadable {\n\treadonly IFluidLoadable: IFluidLoadable;\n}\n/**\n * A shared FluidObject has a URL from which it can be referenced\n * @internal\n */\nexport interface IFluidLoadable extends IProvideFluidLoadable {\n\t// Handle to the loadable FluidObject\n\thandle: IFluidHandle;\n}\n\n/**\n * @internal\n */\nexport const IFluidRunnable: keyof IProvideFluidRunnable = \"IFluidRunnable\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidRunnable {\n\treadonly IFluidRunnable: IFluidRunnable;\n}\n/**\n * @internal\n */\nexport interface IFluidRunnable {\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\trun(...args: any[]): Promise<void>;\n\tstop(reason?: string): void;\n}\n"]}
+{"version":3,"file":"fluidLoadable.js","sourceRoot":"","sources":["../src/fluidLoadable.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACU,QAAA,cAAc,GAAgC,gBAAgB,CAAC;AAiB5E;;GAEG;AACU,QAAA,cAAc,GAAgC,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"./handles\";\n\n/**\n * @alpha\n */\nexport const IFluidLoadable: keyof IProvideFluidLoadable = \"IFluidLoadable\";\n\n/**\n * @alpha\n */\nexport interface IProvideFluidLoadable {\n\treadonly IFluidLoadable: IFluidLoadable;\n}\n/**\n * A shared FluidObject has a URL from which it can be referenced\n * @alpha\n */\nexport interface IFluidLoadable extends IProvideFluidLoadable {\n\t// Handle to the loadable FluidObject\n\thandle: IFluidHandle;\n}\n\n/**\n * @internal\n */\nexport const IFluidRunnable: keyof IProvideFluidRunnable = \"IFluidRunnable\";\n\n/**\n * @internal\n */\nexport interface IProvideFluidRunnable {\n\treadonly IFluidRunnable: IFluidRunnable;\n}\n/**\n * @internal\n */\nexport interface IFluidRunnable {\n\t// TODO: Use `unknown` instead (API-Breaking)\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\trun(...args: any[]): Promise<void>;\n\tstop(reason?: string): void;\n}\n"]}

package/dist/handles.d.ts

@@ -6,18 +6,18 @@ import { IRequest, IResponse } from "./fluidRouter";
 import { IFluidLoadable } from "./fluidLoadable";
 import { FluidObject } from "./provider";
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidHandleContext: keyof IProvideFluidHandleContext;
 /**
- * @internal
+ * @alpha
  */
 export interface IProvideFluidHandleContext {
     readonly IFluidHandleContext: IFluidHandleContext;
 }
 /**
  * Describes a routing context from which other `IFluidHandleContext`s are defined.
- * @internal
+ * @alpha
  */
 export interface IFluidHandleContext extends IProvideFluidHandleContext {
     /**
@@ -40,18 +40,18 @@ export interface IFluidHandleContext extends IProvideFluidHandleContext {
     resolveHandle(request: IRequest): Promise<IResponse>;
 }
 /**
- * @internal
+ * @alpha
  */
 export declare const IFluidHandle: keyof IProvideFluidHandle;
 /**
- * @internal
+ * @alpha
  */
 export interface IProvideFluidHandle {
     readonly IFluidHandle: IFluidHandle;
 }
 /**
  * Handle to a shared {@link FluidObject}.
- * @internal
+ * @alpha
  */
 export interface IFluidHandle<T = FluidObject & IFluidLoadable> extends IProvideFluidHandle {
     /**

package/dist/handles.js

@@ -6,11 +6,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IFluidHandle = exports.IFluidHandleContext = void 0;
 /**
- * @internal
+ * @alpha
  */
 exports.IFluidHandleContext = "IFluidHandleContext";
 /**
- * @internal
+ * @alpha
  */
 exports.IFluidHandle = "IFluidHandle";
 //# sourceMappingURL=handles.js.map