@fluidframework/fluid-static 2.0.0-dev-rc.4.0.0.261659 → 2.0.0-dev-rc.5.0.0.265721

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-static",
-  "version": "2.0.0-dev-rc.4.0.0.261659",
+  "version": "2.0.0-dev-rc.5.0.0.265721",
   "description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -57,33 +57,33 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/aqueduct": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/container-loader": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/container-runtime": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.4.0.0.261659",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/aqueduct": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/container-loader": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/container-runtime": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.265721",
     "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/request-handler": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/runtime-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/shared-object-base": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.4.0.0.261659"
+    "@fluidframework/request-handler": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/runtime-utils": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/shared-object-base": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.265721"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluid-tools/build-cli": "0.38.0-259537",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluid-tools/build-cli": "^0.39.0-264124",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "0.38.0-259537",
+    "@fluidframework/build-tools": "^0.39.0-264124",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.0.0-rc.3.0.0",
-    "@fluidframework/map": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/sequence": "2.0.0-dev-rc.4.0.0.261659",
-    "@microsoft/api-extractor": "^7.42.3",
+    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.0.0-rc.4.0.0",
+    "@fluidframework/map": "2.0.0-dev-rc.5.0.0.265721",
+    "@fluidframework/sequence": "2.0.0-dev-rc.5.0.0.265721",
+    "@microsoft/api-extractor": "^7.43.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
     "c8": "^8.0.1",
@@ -96,17 +96,30 @@
     "moment": "^2.21.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
-    "typescript": "~5.1.6"
+    "typescript": "~5.3.3"
   },
   "typeValidation": {
     "broken": {
-      "InterfaceDeclaration_IMember": {
+      "RemovedTypeAliasDeclaration_DataObjectClass": {
         "forwardCompat": false,
         "backCompat": false
       },
-      "TypeAliasDeclaration_Myself": {
+      "InterfaceDeclaration_IFluidContainer": {
+        "backCompat": false
+      },
+      "TypeAliasDeclaration_InitialObjects": {
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_LoadableObjectClass": {
         "forwardCompat": false,
         "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_LoadableObjectClassRecord": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_ContainerSchema": {
+        "backCompat": false
       }
     }
   },

package/src/fluidContainer.ts

@@ -15,13 +15,9 @@ import {
 	type IEventProvider,
 	type IFluidLoadable,
 } from "@fluidframework/core-interfaces";
+import type { SharedObjectKind } from "@fluidframework/shared-object-base";
 
-import type {
-	ContainerAttachProps,
-	ContainerSchema,
-	IRootDataObject,
-	LoadableObjectClass,
-} from "./types.js";
+import type { ContainerAttachProps, ContainerSchema, IRootDataObject } from "./types.js";
 
 /**
  * Extract the type of 'initialObjects' from the given {@link ContainerSchema} type.
@@ -33,7 +29,7 @@ export type InitialObjects<T extends ContainerSchema> = {
 	//
 	// The '? TChannel : never' is required because infer can only be used in
 	// a conditional 'extends' expression.
-	[K in keyof T["initialObjects"]]: T["initialObjects"][K] extends LoadableObjectClass<
+	[K in keyof T["initialObjects"]]: T["initialObjects"][K] extends SharedObjectKind<
 		infer TChannel
 	>
 		? TChannel
@@ -219,7 +215,7 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
 	 *
 	 * @typeParam T - The class of the `DataObject` or `SharedObject`.
 	 */
-	create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
+	create<T extends IFluidLoadable>(objectClass: SharedObjectKind<T>): Promise<T>;
 
 	/**
 	 * Dispose of the container instance, permanently disabling it.
@@ -347,7 +343,7 @@ class FluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>
 	/**
 	 * {@inheritDoc IFluidContainer.create}
 	 */
-	public async create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T> {
+	public async create<T extends IFluidLoadable>(objectClass: SharedObjectKind<T>): Promise<T> {
 		return this.rootDataObject.create(objectClass);
 	}
 

package/src/index.ts

@@ -20,14 +20,11 @@ export { createServiceAudience } from "./serviceAudience.js";
 export {
 	type ContainerSchema,
 	type ContainerAttachProps,
-	type DataObjectClass,
 	type IConnection,
 	type IMember,
 	type IRootDataObject,
 	type IServiceAudience,
 	type IServiceAudienceEvents,
-	type LoadableObjectClass,
-	type LoadableObjectClassRecord,
 	type LoadableObjectRecord,
 	type MemberChangedListener,
 	type Myself,

package/src/rootDataObject.ts

@@ -20,9 +20,11 @@ import {
 import { type IDirectory } from "@fluidframework/map/internal";
 import { FlushMode } from "@fluidframework/runtime-definitions/internal";
 import { RequestParser } from "@fluidframework/runtime-utils/internal";
-import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
+import type { SharedObjectKind } from "@fluidframework/shared-object-base";
+import type { ISharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import {
+	type DataObjectClass,
 	type ContainerSchema,
 	type IRootDataObject,
 	type LoadableObjectClass,
@@ -30,7 +32,6 @@ import {
 	type LoadableObjectRecord,
 } from "./types.js";
 import {
-	type InternalDataObjectClass,
 	isDataObjectClass,
 	isSharedObjectKind,
 	parseDataObjectsFromSharedObjects,
@@ -45,7 +46,7 @@ export interface RootDataObjectProps {
 	 *
 	 * @see {@link RootDataObject.initializingFirstTime}
 	 */
-	initialObjects: LoadableObjectClassRecord;
+	readonly initialObjects: LoadableObjectClassRecord;
 }
 
 /**
@@ -84,7 +85,9 @@ class RootDataObject
 		const initialObjectsP: Promise<void>[] = [];
 		for (const [id, objectClass] of Object.entries(props.initialObjects)) {
 			const createObject = async (): Promise<void> => {
-				const obj = await this.create<IFluidLoadable>(objectClass);
+				const obj = await this.create<IFluidLoadable>(
+					objectClass as SharedObjectKind<IFluidLoadable>,
+				);
 				this.initialObjectsDir.set(id, obj.handle);
 			};
 			initialObjectsP.push(createObject());
@@ -127,23 +130,24 @@ class RootDataObject
 	/**
 	 * {@inheritDoc IRootDataObject.create}
 	 */
-	public async create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T> {
-		if (isDataObjectClass(objectClass)) {
-			return this.createDataObject(objectClass);
-		} else if (isSharedObjectKind(objectClass)) {
-			return this.createSharedObject(objectClass);
+	public async create<T>(objectClass: SharedObjectKind<T>): Promise<T> {
+		const internal = objectClass as unknown as LoadableObjectClass<T & IFluidLoadable>;
+		if (isDataObjectClass(internal)) {
+			return this.createDataObject(internal);
+		} else if (isSharedObjectKind(internal)) {
+			return this.createSharedObject(internal);
 		}
 		throw new Error("Could not create new Fluid object because an unknown object was passed");
 	}
 
 	private async createDataObject<T extends IFluidLoadable>(
-		dataObjectClass: InternalDataObjectClass<T>,
+		dataObjectClass: DataObjectClass<T>,
 	): Promise<T> {
 		const factory = dataObjectClass.factory;
 		const packagePath = [...this.context.packagePath, factory.type];
 		const dataStore = await this.context.containerRuntime.createDataStore(packagePath);
 		const entryPoint = await dataStore.entryPoint.get();
-		return entryPoint as unknown as T;
+		return entryPoint as T;
 	}
 
 	private createSharedObject<T extends IFluidLoadable>(
@@ -234,7 +238,9 @@ class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 				flushMode: FlushMode.Immediate,
 				// The runtime compressor is required to be on to use @fluidframework/tree.
 				enableRuntimeIdCompressor: "on",
-				explicitSchemaControl: true,
+				// For now this was set to false to allow 1.x/2.x testing with AzureClient.
+				// Long term, this config will be set dynamically. See https://github.com/microsoft/FluidFramework/pull/20997.
+				explicitSchemaControl: false,
 			},
 			provideEntryPoint,
 		});

package/src/types.ts

@@ -8,7 +8,9 @@ import {
 	type IEventProvider,
 	type IFluidLoadable,
 } from "@fluidframework/core-interfaces";
-import { type ISharedObjectKind } from "@fluidframework/shared-object-base";
+import type { IFluidDataStoreFactory } from "@fluidframework/runtime-definitions/internal";
+import { type SharedObjectKind } from "@fluidframework/shared-object-base";
+import { type ISharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 /**
  * A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.
@@ -19,15 +21,13 @@ 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`.
- * @public
  */
-export type LoadableObjectClassRecord = Record<string, LoadableObjectClass>;
+export type LoadableObjectClassRecord = Record<string, SharedObjectKind>;
 
 /**
  * A class object of `DataObject` or `SharedObject`.
  *
  * @typeParam T - The class of the `DataObject` or `SharedObject`.
- * @public
  *
  * @privateRemarks
  * There are some edge cases in TypeScript where the order of the members in a union matter.
@@ -46,19 +46,14 @@ export type LoadableObjectClass<T extends IFluidLoadable = IFluidLoadable> =
  *
  * @typeParam T - The class of the `DataObject`.
  * @privateRemarks
- * Having both `factory` and `LoadableObjectCtor` is redundant.
- * TODO: It appears the factory is what's used, so the constructor should be removed.
- * @public
+ * Having both `factory` and constructor is redundant.
+ * TODO: It appears the factory is what's used, so the constructor should be removed once factory provides strong typing.
  */
-export type DataObjectClass<T extends IFluidLoadable = IFluidLoadable> = {
-	/**
-	 * @privateRemarks
-	 * This has to implement {@link @fluidframework/runtime-definitions#IFluidDataStoreFactory}.
-	 * TODO: Gain type safety for this without leaking IFluidDataStoreFactory as public using type erasure.
-	 */
-	readonly factory: { readonly IFluidDataStoreFactory: DataObjectClass<T>["factory"] };
+export interface DataObjectClass<T extends IFluidLoadable> {
+	readonly factory: IFluidDataStoreFactory;
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-} & (new (...args: any[]) => T);
+	new (...args: any[]): T;
+}
 
 /**
  * Represents properties that can be attached to a container.
@@ -94,7 +89,7 @@ export interface ContainerSchema {
 	 * }
 	 * ```
 	 */
-	readonly initialObjects: LoadableObjectClassRecord;
+	readonly initialObjects: Record<string, SharedObjectKind>;
 
 	/**
 	 * Loadable objects that can be created after the initial {@link IFluidContainer | Container} creation.
@@ -106,7 +101,7 @@ export interface ContainerSchema {
 	 * For best practice it's recommended to define all the dynamic types you create even if they are
 	 * included via initialObjects.
 	 */
-	readonly dynamicObjectTypes?: readonly LoadableObjectClass[];
+	readonly dynamicObjectTypes?: readonly SharedObjectKind[];
 }
 
 /**
@@ -134,7 +129,7 @@ export interface IRootDataObject extends IProvideRootDataObject {
 	 *
 	 * @typeParam T - The class of the `DataObject` or `SharedObject`.
 	 */
-	create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
+	create<T>(objectClass: SharedObjectKind<T>): Promise<T>;
 }
 
 /**

package/src/utils.ts

@@ -4,46 +4,32 @@
  */
 
 import { type IFluidLoadable } from "@fluidframework/core-interfaces";
-import { type IChannelFactory } from "@fluidframework/datastore-definitions";
-import {
-	type IFluidDataStoreFactory,
-	type NamedFluidDataStoreRegistryEntry,
-} from "@fluidframework/runtime-definitions/internal";
-import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
+import { type IChannelFactory } from "@fluidframework/datastore-definitions/internal";
+import { type NamedFluidDataStoreRegistryEntry } from "@fluidframework/runtime-definitions/internal";
+import type { ISharedObjectKind } from "@fluidframework/shared-object-base/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 import { type ContainerSchema, type DataObjectClass, type LoadableObjectClass } from "./types.js";
 
-/**
- * An internal type used by the internal type guard isDataObjectClass to cast a
- * DataObjectClass to a type that is strongly coupled to IFluidDataStoreFactory.
- * Unlike the external and exported type DataObjectClass which is
- * weakly coupled to the IFluidDataStoreFactory to prevent leaking internals.
- */
-export type InternalDataObjectClass<T extends IFluidLoadable> = DataObjectClass<T> &
-	Record<"factory", IFluidDataStoreFactory>;
-
 /**
  * Runtime check to determine if a class is a DataObject type.
  */
 export function isDataObjectClass<T extends IFluidLoadable>(
 	obj: LoadableObjectClass<T>,
-): obj is InternalDataObjectClass<T>;
+): obj is DataObjectClass<T>;
 
 /**
  * Runtime check to determine if a class is a DataObject type.
  */
-export function isDataObjectClass(
-	obj: LoadableObjectClass,
-): obj is InternalDataObjectClass<IFluidLoadable>;
+export function isDataObjectClass(obj: LoadableObjectClass): obj is DataObjectClass<IFluidLoadable>;
 
 /**
  * Runtime check to determine if a class is a DataObject type.
  */
 export function isDataObjectClass(
 	obj: LoadableObjectClass,
-): obj is InternalDataObjectClass<IFluidLoadable> {
-	const maybe = obj as Partial<InternalDataObjectClass<IFluidLoadable>> | undefined;
+): obj is DataObjectClass<IFluidLoadable> {
+	const maybe = obj as Partial<DataObjectClass<IFluidLoadable>> | undefined;
 	const isDataObject =
 		maybe?.factory?.IFluidDataStoreFactory !== undefined &&
 		maybe.factory.IFluidDataStoreFactory === maybe.factory;
@@ -96,7 +82,7 @@ export const parseDataObjectsFromSharedObjects = (
 		...(schema.dynamicObjectTypes ?? []),
 	]);
 	for (const obj of dedupedObjects) {
-		tryAddObject(obj);
+		tryAddObject(obj as unknown as LoadableObjectClass);
 	}
 
 	if (registryEntries.size === 0 && sharedObjects.size === 0) {