@fluidframework/fluid-static 2.0.0-internal.8.0.1 → 2.0.0-rc.1.0.1

package/lib/{fluid-static-alpha.d.ts → fluid-static-beta.d.mts}

@@ -1,9 +1,3 @@
-/**
- * Provides a simple and powerful way to consume collaborative Fluid data.
- *
- * @packageDocumentation
- */
-
 import { AttachState } from '@fluidframework/container-definitions';
 import { ConnectionState } from '@fluidframework/container-definitions';
 import { IChannelFactory } from '@fluidframework/datastore-definitions';
@@ -22,7 +16,7 @@ import { IRuntimeFactory } from '@fluidframework/container-definitions';
  *
  * It includes both the instances of objects that are initially available upon `Container` creation, as well
  * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.
- * @alpha
+ * @public
  */
 export declare interface ContainerSchema {
     /**
@@ -68,7 +62,7 @@ export declare interface ContainerSchema {
  * constructor that will return the type of the `DataObject`.
  *
  * @typeParam T - The class of the `DataObject`.
- * @alpha
+ * @public
  */
 export declare type DataObjectClass<T extends IFluidLoadable> = {
     readonly factory: {
@@ -80,7 +74,7 @@ export declare type DataObjectClass<T extends IFluidLoadable> = {
  * Base interface for information for each connection made to the Fluid session.
  *
  * @remarks This interface can be extended to provide additional information specific to each service.
- * @alpha
+ * @public
  */
 export declare interface IConnection {
     /**
@@ -93,6 +87,8 @@ export declare interface IConnection {
     mode: "write" | "read";
 }
 
+/* Excluded from this release type: IContainer */
+
 /**
  * Provides an entrypoint into the client side of collaborative Fluid data.
  * Provides access to the data as well as status on the collaboration session.
@@ -100,7 +96,8 @@ export declare interface IConnection {
  * @typeparam TContainerSchema - Used to determine the type of 'initialObjects'.
  *
  * @remarks Note: external implementations of this interface are not supported.
- * @alpha
+ * @sealed
+ * @public
  */
 export declare interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
     /**
@@ -207,7 +204,10 @@ export declare interface IFluidContainer<TContainerSchema extends ContainerSchem
 
 /**
  * Events emitted from {@link IFluidContainer}.
- * @alpha
+ *
+ * @remarks Note: external implementations of this interface are not supported.
+ * @sealed
+ * @public
  */
 export declare interface IFluidContainerEvents extends IEvent {
     /**
@@ -265,7 +265,7 @@ export declare interface IFluidContainerEvents extends IEvent {
  * Base interface to be implemented to fetch each service's member.
  *
  * @remarks This interface can be extended by each service to provide additional service-specific user metadata.
- * @alpha
+ * @public
  */
 export declare interface IMember {
     /**
@@ -280,7 +280,7 @@ export declare interface IMember {
 
 /**
  * Extract the type of 'initialObjects' from the given {@link ContainerSchema} type.
- * @alpha
+ * @public
  */
 export declare type InitialObjects<T extends ContainerSchema> = {
     [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends LoadableObjectClass<infer TChannel> ? TChannel : never;
@@ -290,6 +290,8 @@ export declare type InitialObjects<T extends ContainerSchema> = {
 
 /* Excluded from this release type: IRootDataObject */
 
+/* Excluded from this release type: IRuntimeFactory */
+
 /**
  * Base interface to be implemented to fetch each service's audience.
  *
@@ -299,7 +301,7 @@ export declare type InitialObjects<T extends ContainerSchema> = {
  * details about the connecting client, such as device information, environment, or a username.
  *
  * @typeParam M - A service-specific {@link IMember} type.
- * @alpha
+ * @public
  */
 export declare interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
     /**
@@ -323,7 +325,7 @@ export declare interface IServiceAudience<M extends IMember> extends IEventProvi
  * {@link IServiceAudience.getMembers} method will emit events.
  *
  * @typeParam M - A service-specific {@link IMember} implementation.
- * @alpha
+ * @public
  */
 export declare interface IServiceAudienceEvents<M extends IMember> extends IEvent {
     /**
@@ -350,14 +352,14 @@ export declare interface IServiceAudienceEvents<M extends IMember> extends IEven
  * A class object of `DataObject` or `SharedObject`.
  *
  * @typeParam T - The class of the `DataObject` or `SharedObject`.
- * @alpha
+ * @public
  */
 export declare type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;
 
 /**
  * A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`
  * or `SharedObject` in a {@link LoadableObjectRecord}.
- * @alpha
+ * @public
  */
 export declare type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
 
@@ -365,15 +367,11 @@ export declare type LoadableObjectClassRecord = Record<string, LoadableObjectCla
  * An object with a constructor that will return an {@link @fluidframework/core-interfaces#IFluidLoadable}.
  *
  * @typeParam T - The class of the loadable object.
- * @alpha
+ * @public
  */
 export declare type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
 
-/**
- * A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.
- * @alpha
- */
-export declare type LoadableObjectRecord = Record<string, IFluidLoadable>;
+/* Excluded from this release type: LoadableObjectRecord */
 
 /**
  * Signature for {@link IMember} change events.
@@ -382,13 +380,13 @@ export declare type LoadableObjectRecord = Record<string, IFluidLoadable>;
  * @param member - The service-specific member object for the client.
  *
  * @see See {@link IServiceAudienceEvents} for usage details.
- * @alpha
+ * @public
  */
 export declare type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
 
 /**
  * An extended member object that includes currentConnection
- * @alpha
+ * @public
  */
 export declare type Myself<M extends IMember = IMember> = M & {
     currentConnection: string;
@@ -399,7 +397,7 @@ export declare type Myself<M extends IMember = IMember> = M & {
  * constructor that will return the type of the `DataObject`.
  *
  * @typeParam T - The class of the `SharedObject`.
- * @alpha
+ * @public
  */
 export declare type SharedObjectClass<T extends IFluidLoadable> = {
     readonly getFactory: () => IChannelFactory;

package/lib/fluid-static-public.d.mts

@@ -0,0 +1,406 @@
+import { AttachState } from '@fluidframework/container-definitions';
+import { ConnectionState } from '@fluidframework/container-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IClient } from '@fluidframework/protocol-definitions';
+import { IContainer } from '@fluidframework/container-definitions';
+import { ICriticalContainerError } from '@fluidframework/container-definitions';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IEventProvider } from '@fluidframework/core-interfaces';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { IRuntimeFactory } from '@fluidframework/container-definitions';
+
+/**
+ * Declares the Fluid objects that will be available in the {@link IFluidContainer | Container}.
+ *
+ * @remarks
+ *
+ * It includes both the instances of objects that are initially available upon `Container` creation, as well
+ * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.
+ * @public
+ */
+export declare interface ContainerSchema {
+    /**
+     * Defines loadable objects that will be created when the {@link IFluidContainer | Container} is first created.
+     *
+     * @remarks It uses the key as the id and the value as the loadable object to create.
+     *
+     * @example
+     *
+     * In the example below two objects will be created when the `Container` is first
+     * created. One with id "map1" that will return a `SharedMap` and the other with
+     * id "pair1" that will return a `KeyValueDataObject`.
+     *
+     * ```typescript
+     * {
+     *   map1: SharedMap,
+     *   pair1: KeyValueDataObject,
+     * }
+     * ```
+     */
+    initialObjects: LoadableObjectClassRecord;
+    /**
+     * Loadable objects that can be created after the initial {@link IFluidContainer | Container} creation.
+     *
+     * @remarks
+     *
+     * Types defined in `initialObjects` will always be available and are not required to be provided here.
+     *
+     * For best practice it's recommended to define all the dynamic types you create even if they are
+     * included via initialObjects.
+     */
+    dynamicObjectTypes?: LoadableObjectClass<any>[];
+}
+
+/* Excluded from this release type: createDOProviderContainerRuntimeFactory */
+
+/* Excluded from this release type: createFluidContainer */
+
+/* Excluded from this release type: createServiceAudience */
+
+/**
+ * A class that has a factory that can create a `DataObject` and a
+ * constructor that will return the type of the `DataObject`.
+ *
+ * @typeParam T - The class of the `DataObject`.
+ * @public
+ */
+export declare type DataObjectClass<T extends IFluidLoadable> = {
+    readonly factory: {
+        IFluidDataStoreFactory: DataObjectClass<T>["factory"];
+    };
+} & LoadableObjectCtor<T>;
+
+/**
+ * Base interface for information for each connection made to the Fluid session.
+ *
+ * @remarks This interface can be extended to provide additional information specific to each service.
+ * @public
+ */
+export declare interface IConnection {
+    /**
+     * A unique ID for the connection.  A single user may have multiple connections, each with a different ID.
+     */
+    id: string;
+    /**
+     * Whether the connection is in read or read/write mode.
+     */
+    mode: "write" | "read";
+}
+
+/* Excluded from this release type: IContainer */
+
+/**
+ * Provides an entrypoint into the client side of collaborative Fluid data.
+ * Provides access to the data as well as status on the collaboration session.
+ *
+ * @typeparam TContainerSchema - Used to determine the type of 'initialObjects'.
+ *
+ * @remarks Note: external implementations of this interface are not supported.
+ * @sealed
+ * @public
+ */
+export declare interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
+    /**
+     * Provides the current connected state of the container
+     */
+    readonly connectionState: ConnectionState;
+    /**
+     * A container is considered **dirty** if it has local changes that have not yet been acknowledged by the service.
+     *
+     * @remarks
+     *
+     * You should always check the `isDirty` flag before closing the container or navigating away from the page.
+     * Closing the container while `isDirty === true` may result in the loss of operations that have not yet been
+     * acknowledged by the service.
+     *
+     * A container is considered dirty in the following cases:
+     *
+     * 1. The container has been created in the detached state, and either it has not been attached yet or it is
+     * in the process of being attached (container is in `attaching` state). If container is closed prior to being
+     * attached, host may never know if the file was created or not.
+     *
+     * 2. The container was attached, but it has local changes that have not yet been saved to service endpoint.
+     * This occurs as part of normal op flow where pending operation (changes) are awaiting acknowledgement from the
+     * service. In some cases this can be due to lack of network connection. If the network connection is down,
+     * it needs to be restored for the pending changes to be acknowledged.
+     */
+    readonly isDirty: boolean;
+    /**
+     * Whether or not the container is disposed, which permanently disables it.
+     */
+    readonly disposed: boolean;
+    /**
+     * The collection of data objects and Distributed Data Stores (DDSes) that were specified by the schema.
+     *
+     * @remarks These data objects and DDSes exist for the lifetime of the container.
+     */
+    readonly initialObjects: InitialObjects<TContainerSchema>;
+    /**
+     * The current attachment state of the container.
+     *
+     * @remarks
+     *
+     * Once a container has been attached, it remains attached.
+     * When loading an existing container, it will already be attached.
+     */
+    readonly attachState: AttachState;
+    /**
+     * A newly created container starts detached from the collaborative service.
+     * Calling `attach()` uploads the new container to the service and connects to the collaborative service.
+     *
+     * @remarks
+     *
+     * This should only be called when the container is in the
+     * {@link @fluidframework/container-definitions#AttachState.Detatched} state.
+     *
+     * This can be determined by observing {@link IFluidContainer.attachState}.
+     *
+     * @returns A promise which resolves when the attach is complete, with the string identifier of the container.
+     */
+    attach(): Promise<string>;
+    /**
+     * Attempts to connect the container to the delta stream and process operations.
+     *
+     * @throws Will throw an error if connection is unsuccessful.
+     *
+     * @remarks
+     *
+     * This should only be called when the container is in the
+     * {@link @fluidframework/container-definitions#ConnectionState.Disconnected} state.
+     *
+     * This can be determined by observing {@link IFluidContainer.connectionState}.
+     */
+    connect(): void;
+    /**
+     * Disconnects the container from the delta stream and stops processing operations.
+     *
+     * @remarks
+     *
+     * This should only be called when the container is in the
+     * {@link @fluidframework/container-definitions#ConnectionState.Connected} state.
+     *
+     * This can be determined by observing {@link IFluidContainer.connectionState}.
+     */
+    disconnect(): void;
+    /**
+     * Create a new data object or Distributed Data Store (DDS) of the specified type.
+     *
+     * @remarks
+     *
+     * In order to share the data object or DDS with other
+     * collaborators and retrieve it later, store its handle in a collection like a SharedDirectory from your
+     * initialObjects.
+     *
+     * @param objectClass - The class of the `DataObject` or `SharedObject` to create.
+     *
+     * @typeParam T - The class of the `DataObject` or `SharedObject`.
+     */
+    create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
+    /**
+     * Dispose of the container instance, permanently disabling it.
+     */
+    dispose(): void;
+}
+
+/**
+ * Events emitted from {@link IFluidContainer}.
+ *
+ * @remarks Note: external implementations of this interface are not supported.
+ * @sealed
+ * @public
+ */
+export declare interface IFluidContainerEvents extends IEvent {
+    /**
+     * Emitted when the {@link IFluidContainer} completes connecting to the Fluid service.
+     *
+     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.
+     *
+     * @see
+     *
+     * - {@link IFluidContainer.connectionState}
+     *
+     * - {@link IFluidContainer.connect}
+     */
+    (event: "connected", listener: () => void): void;
+    /**
+     * Emitted when the {@link IFluidContainer} becomes disconnected from the Fluid service.
+     *
+     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.
+     *
+     * @see
+     *
+     * - {@link IFluidContainer.connectionState}
+     *
+     * - {@link IFluidContainer.disconnect}
+     */
+    (event: "disconnected", listener: () => void): void;
+    /**
+     * Emitted when all local changes/edits have been acknowledged by the service.
+     *
+     * @remarks "dirty" event will be emitted when the next local change has been made.
+     *
+     * @see {@link IFluidContainer.isDirty}
+     */
+    (event: "saved", listener: () => void): void;
+    /**
+     * Emitted when the first local change has been made, following a "saved" event.
+     *
+     * @remarks "saved" event will be emitted once all local changes have been acknowledged by the service.
+     *
+     * @see {@link IFluidContainer.isDirty}
+     */
+    (event: "dirty", listener: () => void): void;
+    /**
+     * Emitted when the {@link IFluidContainer} is closed, which permanently disables it.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `error`: If the container was closed due to error (as opposed to an explicit call to
+     * {@link IFluidContainer.dispose}), this will contain details about the error that caused it.
+     */
+    (event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
+}
+
+/**
+ * Base interface to be implemented to fetch each service's member.
+ *
+ * @remarks This interface can be extended by each service to provide additional service-specific user metadata.
+ * @public
+ */
+export declare interface IMember {
+    /**
+     * An ID for the user, unique among each individual user connecting to the session.
+     */
+    userId: string;
+    /**
+     * The set of connections the user has made, e.g. from multiple tabs or devices.
+     */
+    connections: IConnection[];
+}
+
+/**
+ * Extract the type of 'initialObjects' from the given {@link ContainerSchema} type.
+ * @public
+ */
+export declare type InitialObjects<T extends ContainerSchema> = {
+    [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends LoadableObjectClass<infer TChannel> ? TChannel : never;
+};
+
+/* Excluded from this release type: IProvideRootDataObject */
+
+/* Excluded from this release type: IRootDataObject */
+
+/* Excluded from this release type: IRuntimeFactory */
+
+/**
+ * Base interface to be implemented to fetch each service's audience.
+ *
+ * @remarks
+ *
+ * The type parameter `M` allows consumers to further extend the client object with service-specific
+ * details about the connecting client, such as device information, environment, or a username.
+ *
+ * @typeParam M - A service-specific {@link IMember} type.
+ * @public
+ */
+export declare interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
+    /**
+     * Returns an map of all users currently in the Fluid session where key is the userId and the value is the
+     * member object.  The implementation may choose to exclude certain connections from the returned map.
+     * E.g. ServiceAudience excludes non-interactive connections to represent only the roster of live users.
+     */
+    getMembers(): Map<string, M>;
+    /**
+     * Returns the current active user on this client once they are connected. Otherwise, returns undefined.
+     */
+    getMyself(): Myself<M> | undefined;
+}
+
+/**
+ * Events that trigger when the roster of members in the Fluid session change.
+ *
+ * @remarks
+ *
+ * Only changes that would be reflected in the returned map of {@link IServiceAudience}'s
+ * {@link IServiceAudience.getMembers} method will emit events.
+ *
+ * @typeParam M - A service-specific {@link IMember} implementation.
+ * @public
+ */
+export declare interface IServiceAudienceEvents<M extends IMember> extends IEvent {
+    /**
+     * Emitted when a {@link IMember | member}(s) are either added or removed.
+     *
+     * @eventProperty
+     */
+    (event: "membersChanged", listener: () => void): void;
+    /**
+     * Emitted when a {@link IMember | member} joins the audience.
+     *
+     * @eventProperty
+     */
+    (event: "memberAdded", listener: MemberChangedListener<M>): void;
+    /**
+     * Emitted when a {@link IMember | member} leaves the audience.
+     *
+     * @eventProperty
+     */
+    (event: "memberRemoved", listener: MemberChangedListener<M>): void;
+}
+
+/**
+ * A class object of `DataObject` or `SharedObject`.
+ *
+ * @typeParam T - The class of the `DataObject` or `SharedObject`.
+ * @public
+ */
+export declare type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;
+
+/**
+ * A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`
+ * or `SharedObject` in a {@link LoadableObjectRecord}.
+ * @public
+ */
+export declare type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
+
+/**
+ * An object with a constructor that will return an {@link @fluidframework/core-interfaces#IFluidLoadable}.
+ *
+ * @typeParam T - The class of the loadable object.
+ * @public
+ */
+export declare type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
+
+/* Excluded from this release type: LoadableObjectRecord */
+
+/**
+ * Signature for {@link IMember} change events.
+ *
+ * @param clientId - A unique identifier for the client.
+ * @param member - The service-specific member object for the client.
+ *
+ * @see See {@link IServiceAudienceEvents} for usage details.
+ * @public
+ */
+export declare type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
+
+/**
+ * An extended member object that includes currentConnection
+ * @public
+ */
+export declare type Myself<M extends IMember = IMember> = M & {
+    currentConnection: string;
+};
+
+/**
+ * A class that has a factory that can create a DDSes (`SharedObject`s) and a
+ * constructor that will return the type of the `DataObject`.
+ *
+ * @typeParam T - The class of the `SharedObject`.
+ * @public
+ */
+export declare type SharedObjectClass<T extends IFluidLoadable> = {
+    readonly getFactory: () => IChannelFactory;
+} & LoadableObjectCtor<T>;
+
+export { }