@fluidframework/fluid-static 2.41.0 → 2.43.0-343119

package/src/rootDataObject.ts

@@ -12,6 +12,7 @@ import {
 import type { IRuntimeFactory } from "@fluidframework/container-definitions/internal";
 import {
 	FluidDataStoreRegistry,
+	type IContainerRuntimeOptions,
 	type MinimumVersionForCollab,
 } from "@fluidframework/container-runtime/internal";
 import type {
@@ -21,6 +22,7 @@ import type {
 import type {
 	FluidObject,
 	FluidObjectKeys,
+	IFluidHandle,
 	IFluidLoadable,
 } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
@@ -140,9 +142,6 @@ class RootDataObject
 		await Promise.all(loadInitialObjectsP);
 	}
 
-	/**
-	 * {@inheritDoc IRootDataObject.initialObjects}
-	 */
 	public get initialObjects(): LoadableObjectRecord {
 		if (Object.keys(this._initialObjects).length === 0) {
 			throw new Error("Initial Objects were not correctly initialized");
@@ -150,9 +149,6 @@ class RootDataObject
 		return this._initialObjects;
 	}
 
-	/**
-	 * {@inheritDoc IRootDataObject.create}
-	 */
 	public async create<T>(objectClass: SharedObjectKind<T>): Promise<T> {
 		const internal = objectClass as unknown as LoadableObjectKind<T & IFluidLoadable>;
 		if (isDataObjectKind(internal)) {
@@ -163,6 +159,10 @@ class RootDataObject
 		throw new Error("Could not create new Fluid object because an unknown object was passed");
 	}
 
+	public async uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {
+		return this.runtime.uploadBlob(blob);
+	}
+
 	private async createDataObject<T extends IFluidLoadable>(
 		dataObjectClass: DataObjectKind<T>,
 	): Promise<T> {
@@ -206,6 +206,18 @@ export function createDOProviderContainerRuntimeFactory(props: {
 	 * If not provided, one will be created based on the schema.
 	 */
 	rootDataStoreRegistry?: IFluidDataStoreRegistry;
+	/**
+	 * Optional overrides for the container runtime options.
+	 * If not provided, only the default options for the given compatibilityMode will be used.
+	 */
+	runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>;
+	/**
+	 * Optional override for minimum version for collab.
+	 * If not provided, the default for the given compatibilityMode will be used.
+	 * @remarks
+	 * This is useful when runtime options are overridden and change the minimum version for collab.
+	 */
+	minVersionForCollabOverride?: MinimumVersionForCollab;
 }): IRuntimeFactory {
 	const [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(props.schema);
 	const registry = props.rootDataStoreRegistry ?? new FluidDataStoreRegistry(registryEntries);
@@ -214,6 +226,10 @@ export function createDOProviderContainerRuntimeFactory(props: {
 		props.schema,
 		props.compatibilityMode,
 		new RootDataObjectFactory(sharedObjects, registry),
+		{
+			runtimeOptions: props.runtimeOptionOverrides,
+			minVersionForCollab: props.minVersionForCollabOverride,
+		},
 	);
 }
 
@@ -278,20 +294,26 @@ class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 			RootDataObject,
 			{ InitialState: RootDataObjectProps }
 		>,
+		overrides?: Partial<{
+			runtimeOptions: Partial<IContainerRuntimeOptions>;
+			minVersionForCollab: MinimumVersionForCollab;
+		}>,
 	) {
 		super({
 			registryEntries: [rootDataObjectFactory.registryEntry],
-			runtimeOptions: compatibilityModeRuntimeOptions[compatibilityMode],
+			runtimeOptions: {
+				...compatibilityModeRuntimeOptions[compatibilityMode],
+				...overrides?.runtimeOptions,
+			},
 			provideEntryPoint,
-			minVersionForCollab: compatibilityModeToMinVersionForCollab[compatibilityMode],
+			minVersionForCollab:
+				overrides?.minVersionForCollab ??
+				compatibilityModeToMinVersionForCollab[compatibilityMode],
 		});
 		this.rootDataObjectFactory = rootDataObjectFactory;
 		this.initialObjects = schema.initialObjects;
 	}
 
-	/**
-	 * {@inheritDoc @fluidframework/aqueduct#BaseContainerRuntimeFactory.containerInitializingFirstTime}
-	 */
 	protected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {
 		// The first time we create the container we create the RootDataObject
 		await this.rootDataObjectFactory.createRootInstance(rootDataStoreId, runtime, {

package/src/serviceAudience.ts

@@ -36,8 +36,6 @@ export function createServiceAudience<TMember extends IMember = IMember>(props:
  * the user and client details returned in {@link IMember}.
  *
  * @typeParam TMember - A service-specific {@link IMember} implementation.
- *
- * @internal
  */
 class ServiceAudience<TMember extends IMember = IMember>
 	extends TypedEventEmitter<IServiceAudienceEvents<TMember>>

package/src/types.ts

@@ -5,7 +5,12 @@
 
 import type { DataObjectKind } from "@fluidframework/aqueduct/internal";
 import type { ContainerExtensionStore } from "@fluidframework/container-runtime-definitions/internal";
-import type { IEvent, IEventProvider, IFluidLoadable } from "@fluidframework/core-interfaces";
+import type {
+	IEvent,
+	IEventProvider,
+	IFluidHandle,
+	IFluidLoadable,
+} from "@fluidframework/core-interfaces";
 import type { SharedObjectKind } from "@fluidframework/shared-object-base";
 import type { ISharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
@@ -20,7 +25,6 @@ export type CompatibilityMode = "1" | "2";
 
 /**
  * A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.
- * @internal
  */
 export type LoadableObjectRecord = Record<string, IFluidLoadable>;
 
@@ -98,7 +102,6 @@ export interface ContainerSchema {
 /**
  * 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 {
 	/**
@@ -114,6 +117,16 @@ export interface IRootDataObject {
 	 * @typeParam T - The class of the `DataObject` or `SharedObject`.
 	 */
 	create<T>(objectClass: SharedObjectKind<T>): Promise<T>;
+
+	/**
+	 * Upload a blob of data.
+	 * Although it is marked as internal, there is external usage of this function for experimental purposes.
+	 * Please contact yunho-microsoft or vladsud if you need to change it.
+	 * @param blob - blob to be uploaded.
+	 *
+	 * @remarks This method is used to expose uploadBlob to the IFluidContainer level. UploadBlob will upload data to server side (as of now, ODSP only). There is no downloadBlob provided as it is not needed(blob lifetime managed by server).
+	 */
+	uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;
 }
 
 interface IProvideStaticEntryPoint {
@@ -121,7 +134,7 @@ interface IProvideStaticEntryPoint {
 }
 
 /**
- * @internal
+ * This is the internal entry point fluid-static creates.
  */
 export interface IStaticEntryPoint extends IProvideStaticEntryPoint {
 	readonly rootDataObject: IRootDataObject;