@fluidframework/fluid-static 2.0.0-internal.7.3.0 → 2.0.0-internal.7.4.1

package/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,gCAAgC,EAAE,MAAM,qCAAqC,CAAC;AACvF,OAAO,EAAE,eAAe,EAAE,eAAe,EAAuB,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEnG;;GAEG;AACH,eAAO,MAAM,iBAAiB,QAAS,GAAG,gCAEzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,QAAS,GAAG,kCAE3C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,WACrC,eAAe,KACrB,CAAC,gCAAgC,EAAE,EAAE,eAAe,EAAE,CA0BxD,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,eAAe,EAAE,MAAM,uCAAuC;OAChE,EAAE,gCAAgC,EAAE,MAAM,qCAAqC;OAC/E,EAAE,eAAe,EAAE,eAAe,EAAuB,iBAAiB,EAAE;AAEnF;;GAEG;AACH,eAAO,MAAM,iBAAiB,QAAS,GAAG,gCAEzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,QAAS,GAAG,kCAE3C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,WACrC,eAAe,KACrB,CAAC,gCAAgC,EAAE,EAAE,eAAe,EAAE,CA0BxD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-static",
-  "version": "2.0.0-internal.7.3.0",
+  "version": "2.0.0-internal.7.4.1",
   "description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,18 +11,6 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
   "main": "dist/index.cjs",
   "module": "lib/index.mjs",
   "types": "dist/index.d.ts",
@@ -47,31 +35,33 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/aqueduct": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/container-loader": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
+    "@fluid-internal/client-utils": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/aqueduct": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/container-loader": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
     "@fluidframework/protocol-definitions": "^3.0.0",
-    "@fluidframework/request-handler": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0"
+    "@fluidframework/request-handler": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.13.3",
     "@fluid-tools/build-cli": "^0.28.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.28.0",
     "@fluidframework/eslint-config-fluid": "^3.1.0",
     "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.0.0-internal.7.2.0",
-    "@fluidframework/map": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
-    "@fluidframework/sequence": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
+    "@fluidframework/map": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
+    "@fluidframework/sequence": ">=2.0.0-internal.7.4.1 <2.0.0-internal.7.5.0",
     "@microsoft/api-extractor": "^7.38.3",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^16.18.38",
+    "@types/node": "^18.19.0",
     "c8": "^7.7.1",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "~8.50.0",
     "mocha": "^10.2.0",
@@ -83,25 +73,42 @@
     "tsc-multi": "^1.1.0",
     "typescript": "~5.1.6"
   },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
+  },
   "typeValidation": {
     "broken": {}
   },
   "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:esnext": "copyfiles -u 1 \"dist/**/*-@(alpha|beta|public|untrimmed).d.ts\" lib",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "api-extractor run --local",
+    "build:docs": "fluid-build . --task api",
     "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
     "build:test": "tsc-multi --config ./tsc-multi.test.json",
+    "check:are-the-types-wrong": "attw --pack",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",
-    "lint": "npm run prettier && npm run eslint",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
     "lint:fix": "npm run prettier:fix && npm run eslint:fix",
-    "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
-    "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
     "test:coverage": "c8 npm test",
     "test:mocha": "mocha --recursive \"dist/test/**/*.spec.cjs\" -r node_modules/@fluidframework/mocha-test-setup",

package/src/fluidContainer.ts

@@ -14,6 +14,7 @@ import type { ContainerSchema, IRootDataObject, LoadableObjectClass } from "./ty
 
 /**
  * Extract the type of 'initialObjects' from the given {@link ContainerSchema} type.
+ * @alpha
  */
 export type InitialObjects<T extends ContainerSchema> = {
 	// Construct a LoadableObjectRecord type by enumerating the keys of
@@ -30,6 +31,7 @@ export type InitialObjects<T extends ContainerSchema> = {
 
 /**
  * Events emitted from {@link IFluidContainer}.
+ * @alpha
  */
 export interface IFluidContainerEvents extends IEvent {
 	/**
@@ -94,6 +96,7 @@ export interface IFluidContainerEvents extends IEvent {
  * @typeparam TContainerSchema - Used to determine the type of 'initialObjects'.
  *
  * @remarks Note: external implementations of this interface are not supported.
+ * @alpha
  */
 export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>
 	extends IEventProvider<IFluidContainerEvents> {
@@ -208,6 +211,18 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
 	dispose(): void;
 }
 
+/**
+ * @internal
+ */
+export function createFluidContainer<
+	TContainerSchema extends ContainerSchema = ContainerSchema,
+>(props: {
+	container: IContainer;
+	rootDataObject: IRootDataObject;
+}): IFluidContainer<TContainerSchema> {
+	return new FluidContainer<TContainerSchema>(props.container, props.rootDataObject);
+}
+
 /**
  * Base {@link IFluidContainer} implementation.
  *
@@ -216,6 +231,8 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
  *
  * Note: this implementation is not complete. Consumers who rely on {@link IFluidContainer.attach}
  * will need to utilize or provide a service-specific implementation of this type that implements that method.
+ * @deprecated use {@link createFluidContainer} and {@link IFluidContainer} instead
+ * @internal
  */
 export class FluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>
 	extends TypedEventEmitter<IFluidContainerEvents>
@@ -334,8 +351,6 @@ export class FluidContainer<TContainerSchema extends ContainerSchema = Container
 	 * Gets the underlying {@link @fluidframework/container-definitions#IContainer}.
 	 *
 	 * @remarks Used to power debug tooling.
-	 *
-	 * @internal
 	 */
 	public readonly INTERNAL_CONTAINER_DO_NOT_USE?: () => IContainer = () => {
 		return this.container;

package/src/index.ts

@@ -11,12 +11,16 @@
 
 export {
 	FluidContainer,
+	createFluidContainer,
 	IFluidContainer,
 	IFluidContainerEvents,
 	InitialObjects,
 } from "./fluidContainer";
-export { DOProviderContainerRuntimeFactory } from "./rootDataObject";
-export { ServiceAudience } from "./serviceAudience";
+export {
+	DOProviderContainerRuntimeFactory,
+	createDOProviderContainerRuntimeFactory,
+} from "./rootDataObject";
+export { ServiceAudience, createServiceAudience } from "./serviceAudience";
 export {
 	ContainerSchema,
 	DataObjectClass,
@@ -32,4 +36,5 @@ export {
 	MemberChangedListener,
 	Myself,
 	SharedObjectClass,
+	IProvideRootDataObject,
 } from "./types";

package/src/rootDataObject.ts

@@ -12,6 +12,7 @@ import {
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
 import { IFluidLoadable } from "@fluidframework/core-interfaces";
 import { FlushMode } from "@fluidframework/runtime-definitions";
+import { IRuntimeFactory } from "@fluidframework/container-definitions";
 import {
 	ContainerSchema,
 	DataObjectClass,
@@ -39,12 +40,15 @@ 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
+class RootDataObject
 	extends DataObject<{ InitialState: RootDataObjectProps }>
 	implements IRootDataObject
 {
 	private readonly initialObjectsDirKey = "initial-objects-key";
 	private readonly _initialObjects: LoadableObjectRecord = {};
+	public get IRootDataObject() {
+		return this;
+	}
 
 	private get initialObjectsDir() {
 		const dir = this.root.getSubDirectory(this.initialObjectsDirKey);
@@ -139,6 +143,15 @@ export class RootDataObject
 
 const rootDataStoreId = "rootDOId";
 
+/**
+ * @internal
+ */
+export function createDOProviderContainerRuntimeFactory(props: {
+	schema: ContainerSchema;
+}): IRuntimeFactory {
+	return new DOProviderContainerRuntimeFactory(props.schema);
+}
+
 /**
  * Container code that provides a single {@link IRootDataObject}.
  *
@@ -146,6 +159,8 @@ const rootDataStoreId = "rootDOId";
  *
  * This data object is dynamically customized (registry and initial objects) based on the schema provided.
  * to the container runtime factory.
+ * @deprecated use {@link createDOProviderContainerRuntimeFactory} instead
+ * @internal
  */
 export class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 	private readonly rootDataObjectFactory: DataObjectFactory<

package/src/serviceAudience.ts

@@ -8,6 +8,22 @@ import { IAudience, IContainer } from "@fluidframework/container-definitions";
 import { IClient } from "@fluidframework/protocol-definitions";
 import { IServiceAudience, IServiceAudienceEvents, IMember, Myself } from "./types";
 
+/**
+ * @internal
+ */
+export function createServiceAudience<M extends IMember = IMember>(props: {
+	container: IContainer;
+	createServiceMember: (audienceMember: IClient) => M;
+}): IServiceAudience<M> {
+	// todo: once ServiceAudience isn't exported, we can remove abstract from it, and just use that here
+	const c = class NewServiceAudience extends ServiceAudience<M> {
+		protected createServiceMember(audienceMember: IClient) {
+			return props.createServiceMember(audienceMember);
+		}
+	};
+	return new c(props.container);
+}
+
 /**
  * Base class for providing audience information for sessions interacting with {@link IFluidContainer}
  *
@@ -17,6 +33,8 @@ import { IServiceAudience, IServiceAudienceEvents, IMember, Myself } from "./typ
  * the user and client details returned in {@link IMember}.
  *
  * @typeParam M - A service-specific {@link IMember} implementation.
+ * @deprecated use {@link createServiceAudience} and {@link IServiceAudience} instead
+ * @internal
  */
 export abstract class ServiceAudience<M extends IMember = IMember>
 	extends TypedEventEmitter<IServiceAudienceEvents<M>>

package/src/types.ts

@@ -9,12 +9,14 @@ import { IFluidDataStoreFactory } from "@fluidframework/runtime-definitions";
 
 /**
  * A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.
+ * @alpha
  */
 export type LoadableObjectRecord = Record<string, IFluidLoadable>;
 
 /**
  * A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`
  * or `SharedObject` in a {@link LoadableObjectRecord}.
+ * @alpha
  */
 export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
 
@@ -22,6 +24,7 @@ export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>
  * A class object of `DataObject` or `SharedObject`.
  *
  * @typeParam T - The class of the `DataObject` or `SharedObject`.
+ * @alpha
  */
 export type LoadableObjectClass<T extends IFluidLoadable> =
 	| DataObjectClass<T>
@@ -32,6 +35,7 @@ export type LoadableObjectClass<T extends IFluidLoadable> =
  * constructor that will return the type of the `DataObject`.
  *
  * @typeParam T - The class of the `DataObject`.
+ * @alpha
  */
 export type DataObjectClass<T extends IFluidLoadable> = {
 	readonly factory: IFluidDataStoreFactory;
@@ -42,6 +46,7 @@ export type DataObjectClass<T extends IFluidLoadable> = {
  * constructor that will return the type of the `DataObject`.
  *
  * @typeParam T - The class of the `SharedObject`.
+ * @alpha
  */
 export type SharedObjectClass<T extends IFluidLoadable> = {
 	readonly getFactory: () => IChannelFactory;
@@ -51,6 +56,7 @@ export type SharedObjectClass<T extends IFluidLoadable> = {
  * An object with a constructor that will return an {@link @fluidframework/core-interfaces#IFluidLoadable}.
  *
  * @typeParam T - The class of the loadable object.
+ * @alpha
  */
 export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
 
@@ -61,6 +67,7 @@ export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[])
  *
  * 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
  */
 export interface ContainerSchema {
 	/**
@@ -96,11 +103,19 @@ export interface ContainerSchema {
 	dynamicObjectTypes?: LoadableObjectClass<any>[];
 }
 
+/**
+ * @internal
+ */
+export interface IProvideRootDataObject {
+	readonly IRootDataObject?: IRootDataObject;
+}
+
 /**
  * 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.
+ * @internal
  */
-export interface IRootDataObject {
+export interface IRootDataObject extends IProvideRootDataObject {
 	/**
 	 * Provides a record of the initial objects defined on creation.
 	 */
@@ -123,6 +138,7 @@ export interface IRootDataObject {
  * @param member - The service-specific member object for the client.
  *
  * @see See {@link IServiceAudienceEvents} for usage details.
+ * @alpha
  */
 export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
 
@@ -135,6 +151,7 @@ export type MemberChangedListener<M extends IMember> = (clientId: string, member
  * {@link IServiceAudience.getMembers} method will emit events.
  *
  * @typeParam M - A service-specific {@link IMember} implementation.
+ * @alpha
  */
 export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
 	/**
@@ -168,6 +185,7 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
  * details about the connecting client, such as device information, environment, or a username.
  *
  * @typeParam M - A service-specific {@link IMember} type.
+ * @alpha
  */
 export interface IServiceAudience<M extends IMember>
 	extends IEventProvider<IServiceAudienceEvents<M>> {
@@ -188,6 +206,7 @@ export interface IServiceAudience<M extends IMember>
  * 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
  */
 export interface IConnection {
 	/**
@@ -205,6 +224,7 @@ export interface IConnection {
  * 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
  */
 export interface IMember {
 	/**
@@ -220,5 +240,6 @@ export interface IMember {
 
 /**
  * An extended member object that includes currentConnection
+ * @alpha
  */
 export type Myself<M extends IMember = IMember> = M & { currentConnection: string };