@fluidframework/fluid-static 2.0.0-internal.2.0.3 → 2.0.0-internal.2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-static",
-  "version": "2.0.0-internal.2.0.3",
+  "version": "2.0.0-internal.2.1.0",
   "description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -34,8 +34,6 @@
     "test:mocha": "mocha --recursive dist/test/**/*.spec.js -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
-    "tsfmt": "tsfmt --verify",
-    "tsfmt:fix": "tsfmt --replace",
     "typetests:gen": "fluid-type-validator -g -d ."
   },
   "nyc": {
@@ -59,27 +57,28 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
+    "@fluidframework/aqueduct": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/container-loader": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-loader": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/request-handler": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0"
+    "@fluidframework/request-handler": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^1.0.0",
-    "@fluidframework/build-tools": "^0.4.6000",
-    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluid-tools/build-cli": "^0.5.0",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.5.0",
+    "@fluidframework/eslint-config-fluid": "^1.1.0",
     "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.0.0-internal.2.0.0",
-    "@fluidframework/map": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/sequence": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
+    "@fluidframework/map": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/sequence": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -91,11 +90,10 @@
     "mocha": "^10.0.0",
     "nyc": "^15.0.0",
     "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.0.1",
+    "version": "2.0.0-internal.2.1.0",
     "broken": {}
   }
 }

package/src/fluidContainer.ts

@@ -11,85 +11,68 @@ import {
     ICriticalContainerError,
     ConnectionState,
 } from "@fluidframework/container-definitions";
-import { LoadableObjectClass, LoadableObjectRecord } from "./types";
-import { RootDataObject } from "./rootDataObject";
+import type { IRootDataObject, LoadableObjectClass, LoadableObjectRecord } from "./types";
 
 /**
  * Events emitted from {@link IFluidContainer}.
- *
- * @remarks
- *
- * The following is the list of events emitted.
- *
- * ### "connected"
- *
- * The "connected" event is emitted when the `IFluidContainer` completes connecting to the Fluid service.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void;
- * ```
- *
- * ### "disposed"
- *
- * The "disposed" event is emitted when the `IFluidContainer` is disposed, which permanently disables it.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void;
- * ```
- *
- * ### "disconnected"
- *
- * The "disconnected" event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void;
- * ```
- *
- * ### "saved"
- *
- * The "saved" event is emitted when the `IFluidContainer` has local changes acknowledged by the service.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void
- * ```
- *
- * ### "dirty"
- *
- * The "dirty" event is emitted when the `IFluidContainer` has local changes that have not yet
- * been acknowledged by the service.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void
- * ```
  */
+/* eslint-disable @typescript-eslint/unified-signatures */
 export interface IFluidContainerEvents extends IEvent {
     /**
-     * **connected** & **disconnected** events reflect connection state changes against the (delta)
-     * service acknowledging ops/edits.
+     * 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.disconnect}
      */
-    (event: "connected" | "disconnected", listener: () => void): void;
+    (event: "connected", listener: () => void): void;
+
     /**
-     * **saved** event is raised when all local changes/edits have been acknowledged by the service.
-     * **dirty** event is raised when first local change has been made, following a "saved" state.
+     * 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}
      */
-    // eslint-disable-next-line @typescript-eslint/unified-signatures
-    (event: "saved" | "dirty", listener: () => void): void;
+    (event: "disconnected", listener: () => void): void;
+
     /**
-     * Disposed event is raised when container is closed. If container was closed due to error
-     * (vs explicit **dispose** action), optional argument contains further details about the error.
+     * 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
+     *
+     * If container was closed due to error (as opposed to an explicit call to
+     * {@link IFluidContainer.dispose}), optional argument contains further details about the error.
      */
     (event: "disposed", listener: (error?: ICriticalContainerError) => void);
 }
+/* eslint-enable @typescript-eslint/unified-signatures */
 
 /**
  * Provides an entrypoint into the client side of collaborative Fluid data.
@@ -223,7 +206,7 @@ export class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> imp
 
     public constructor(
         private readonly container: IContainer,
-        private readonly rootDataObject: RootDataObject,
+        private readonly rootDataObject: IRootDataObject,
     ) {
         super();
         container.on("connected", this.connectedHandler);

package/src/index.ts

@@ -9,7 +9,22 @@
  * @packageDocumentation
  */
 
-export * from "./fluidContainer";
-export * from "./rootDataObject";
-export * from "./serviceAudience";
-export * from "./types";
+export { FluidContainer, IFluidContainer, IFluidContainerEvents } from "./fluidContainer";
+export { DOProviderContainerRuntimeFactory, RootDataObject, RootDataObjectProps } from "./rootDataObject";
+export { ServiceAudience } from "./serviceAudience";
+export {
+	ContainerSchema,
+	DataObjectClass,
+	IConnection,
+	IMember,
+	IRootDataObject,
+	IServiceAudience,
+	IServiceAudienceEvents,
+	LoadableObjectClass,
+	LoadableObjectClassRecord,
+	LoadableObjectCtor,
+	LoadableObjectRecord,
+	MemberChangedListener,
+	SharedObjectClass,
+    Myself,
+} from "./types";

package/src/rootDataObject.ts

@@ -11,10 +11,10 @@ import {
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
 import { IFluidLoadable } from "@fluidframework/core-interfaces";
 import { FlushMode } from "@fluidframework/runtime-definitions";
-import { requestFluidObject } from "@fluidframework/runtime-utils";
 import {
     ContainerSchema,
     DataObjectClass,
+    IRootDataObject,
     LoadableObjectClass,
     LoadableObjectClassRecord,
     LoadableObjectRecord,
@@ -38,7 +38,7 @@ export interface RootDataObjectProps {
  * The entry-point/root collaborative object of the {@link IFluidContainer | Fluid Container}.
  * Abstracts the dynamic code required to build a Fluid Container into a static representation for end customers.
  */
-export class RootDataObject extends DataObject<{ InitialState: RootDataObjectProps; }> {
+export class RootDataObject extends DataObject<{ InitialState: RootDataObjectProps; }> implements IRootDataObject {
     private readonly initialObjectsDirKey = "initial-objects-key";
     private readonly _initialObjects: LoadableObjectRecord = {};
 
@@ -93,9 +93,7 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
     }
 
     /**
-     * Provides a record of the initial objects defined on creation.
-     *
-     * @see {@link RootDataObject.initializingFirstTime}
+     * {@inheritDoc IRootDataObject.initialObjects}
      */
     public get initialObjects(): LoadableObjectRecord {
         if (Object.keys(this._initialObjects).length === 0) {
@@ -105,11 +103,7 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
     }
 
     /**
-     * Dynamically creates a new detached collaborative object (DDS/DataObject).
-     *
-     * @param objectClass - Type of the collaborative object to be created.
-     *
-     * @typeParam T - The class of the `DataObject` or `SharedObject`.
+     * {@inheritDoc IRootDataObject.create}
      */
     public async create<T extends IFluidLoadable>(
         objectClass: LoadableObjectClass<T>,
@@ -125,8 +119,9 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
     private async createDataObject<T extends IFluidLoadable>(dataObjectClass: DataObjectClass<T>): Promise<T> {
         const factory = dataObjectClass.factory;
         const packagePath = [...this.context.packagePath, factory.type];
-        const router = await this.context.containerRuntime.createDataStore(packagePath);
-        return requestFluidObject<T>(router, "/");
+        const dataStore = await this.context.containerRuntime.createDataStore(packagePath);
+        const entryPoint = await dataStore.entryPoint?.get();
+        return entryPoint as unknown as T;
     }
 
     private createSharedObject<T extends IFluidLoadable>(

package/src/serviceAudience.ts

@@ -6,7 +6,7 @@
 import { TypedEventEmitter } from "@fluidframework/common-utils";
 import { IAudience, IContainer } from "@fluidframework/container-definitions";
 import { IClient } from "@fluidframework/protocol-definitions";
-import { IServiceAudience, IServiceAudienceEvents, IMember } from "./types";
+import { IServiceAudience, IServiceAudienceEvents, IMember, Myself } from "./types";
 
 /**
  * Base class for providing audience information for sessions interacting with {@link IFluidContainer}
@@ -112,12 +112,20 @@ export abstract class ServiceAudience<M extends IMember = IMember>
   /**
    * {@inheritDoc IServiceAudience.getMyself}
    */
-  public getMyself(): M | undefined {
+  public getMyself(): Myself<M> | undefined {
     const clientId = this.container.clientId;
     if (clientId === undefined) {
       return undefined;
     }
-    return this.getMember(clientId);
+
+    const member = this.getMember(clientId);
+    if (member === undefined) {
+        return undefined;
+      }
+
+    const myself: Myself<M> = { ...member, currentConnection: clientId };
+
+    return myself;
   }
 
   private getMember(clientId: string): M | undefined {

package/src/types.ts

@@ -93,6 +93,26 @@ export interface ContainerSchema {
     dynamicObjectTypes?: LoadableObjectClass<any>[];
 }
 
+/**
+ * Holds the collection of objects that the container was initially created with, as well as provides the ability
+ * to dynamically create further objects during usage.
+ */
+export interface IRootDataObject {
+    /**
+     * Provides a record of the initial objects defined on creation.
+     */
+    readonly initialObjects: LoadableObjectRecord;
+
+    /**
+     * Dynamically creates a new detached collaborative object (DDS/DataObject).
+     *
+     * @param objectClass - Type of the collaborative object to be created.
+     *
+     * @typeParam T - The class of the `DataObject` or `SharedObject`.
+     */
+    create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
+}
+
 /**
  * Signature for {@link IMember} change events.
  *
@@ -148,7 +168,8 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
  *
  * @typeParam M - A service-specific {@link IMember} type.
  */
-export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
+export 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.
@@ -159,7 +180,7 @@ export interface IServiceAudience<M extends IMember> extends IEventProvider<ISer
     /**
      * Returns the current active user on this client once they are connected. Otherwise, returns undefined.
      */
-    getMyself(): M | undefined;
+    getMyself(): Myself<M> | undefined;
 }
 
 /**
@@ -195,3 +216,8 @@ export interface IMember {
      */
     connections: IConnection[];
 }
+
+/**
+ * An extended member object that includes currentConnection
+ */
+export type Myself<M extends IMember = IMember> = M & { currentConnection: string; };