@fluidframework/aqueduct 2.0.0-dev-rc.3.0.0.254866 → 2.0.0-dev-rc.5.0.0.263932

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/aqueduct",
-  "version": "2.0.0-dev-rc.3.0.0.254866",
+  "version": "2.0.0-dev-rc.5.0.0.263932",
   "description": "A set of implementations for Fluid Framework interfaces.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -23,13 +23,13 @@
         "default": "./dist/index.js"
       }
     },
-    "./alpha": {
+    "./legacy": {
       "import": {
-        "types": "./lib/alpha.d.ts",
+        "types": "./lib/legacy.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/alpha.d.ts",
+        "types": "./dist/legacy.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -44,13 +44,8 @@
       }
     }
   },
-  "main": "dist/index.js",
-  "types": "./dist/public.d.ts",
-  "files": [
-    "dist/**/*",
-    "!dist/test/**",
-    "lib/**/*"
-  ],
+  "main": "lib/index.js",
+  "types": "lib/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -72,30 +67,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/container-runtime": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/datastore": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/map": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/request-handler": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/runtime-utils": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluidframework/synthesize": "2.0.0-dev-rc.3.0.0.254866"
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/container-runtime": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/datastore": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/map": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/request-handler": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/runtime-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/synthesize": "2.0.0-dev-rc.5.0.0.263932"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.3.0.0.254866",
-    "@fluid-tools/build-cli": "^0.35.0",
-    "@fluidframework/aqueduct-previous": "npm:@fluidframework/aqueduct@2.0.0-internal.8.0.0",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluid-tools/build-cli": "^0.38.0",
+    "@fluidframework/aqueduct-previous": "npm:@fluidframework/aqueduct@2.0.0-rc.3.0.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.35.0",
+    "@fluidframework/build-tools": "^0.38.0",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@microsoft/api-extractor": "^7.42.3",
+    "@microsoft/api-extractor": "^7.43.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
     "c8": "^8.0.1",
@@ -112,22 +107,21 @@
   },
   "typeValidation": {
     "broken": {
-      "ClassDeclaration_DataObjectFactory": {
-        "forwardCompat": false
+      "InterfaceDeclaration_IDataObjectProps": {
+        "backCompat": false
       },
-      "ClassDeclaration_PureDataObjectFactory": {
+      "ClassDeclaration_DataObject": {
         "forwardCompat": false
       },
-      "InterfaceDeclaration_IDataObjectProps": {
-        "forwardCompat": false,
-        "backCompat": false
+      "ClassDeclaration_PureDataObject": {
+        "forwardCompat": false
       }
     }
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
@@ -136,11 +130,11 @@
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:are-the-types-wrong": "attw --pack .",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "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",
+    "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.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": "fluid-build --task format .",
@@ -154,7 +148,7 @@
     "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit -r node_modules/@fluid-internal/mocha-test-setup",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
-    "typetests:gen": "fluid-type-test-generator",
+    "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
 }

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/container-runtime-factories/baseContainerRuntimeFactory.ts

@@ -0,0 +1,145 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { type IContainerContext } from "@fluidframework/container-definitions/internal";
+import {
+	ContainerRuntime,
+	FluidDataStoreRegistry,
+	type IContainerRuntimeOptions,
+} from "@fluidframework/container-runtime/internal";
+import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
+import { type FluidObject } from "@fluidframework/core-interfaces";
+import {
+	// eslint-disable-next-line import/no-deprecated
+	type RuntimeRequestHandler,
+	// eslint-disable-next-line import/no-deprecated
+	buildRuntimeRequestHandler,
+} from "@fluidframework/request-handler/internal";
+import {
+	type IFluidDataStoreRegistry,
+	type IProvideFluidDataStoreRegistry,
+	type NamedFluidDataStoreRegistryEntries,
+} from "@fluidframework/runtime-definitions/internal";
+import { RuntimeFactoryHelper } from "@fluidframework/runtime-utils/internal";
+import {
+	DependencyContainer,
+	type IFluidDependencySynthesizer,
+	type IProvideFluidDependencySynthesizer,
+} from "@fluidframework/synthesize/internal";
+
+/**
+ * {@link BaseContainerRuntimeFactory} construction properties.
+ * @alpha
+ */
+export interface BaseContainerRuntimeFactoryProps {
+	/**
+	 * The data store registry for containers produced.
+	 */
+	registryEntries: NamedFluidDataStoreRegistryEntries;
+	/**
+	 * @deprecated Will be removed in a future release.
+	 */
+	dependencyContainer?: IFluidDependencySynthesizer;
+	/**
+	 * Request handlers for containers produced.
+	 * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
+	// eslint-disable-next-line import/no-deprecated
+	requestHandlers?: RuntimeRequestHandler[];
+	/**
+	 * The runtime options passed to the ContainerRuntime when instantiating it
+	 */
+	runtimeOptions?: IContainerRuntimeOptions;
+	/**
+	 * Function that will initialize the entryPoint of the ContainerRuntime instances
+	 * created with this factory
+	 */
+	provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
+}
+
+/**
+ * BaseContainerRuntimeFactory produces container runtimes with the specified data store and service registries,
+ * request handlers, runtimeOptions, and entryPoint initialization function.
+ * It can be subclassed to implement a first-time initialization procedure for the containers it creates.
+ * @alpha
+ */
+export class BaseContainerRuntimeFactory
+	extends RuntimeFactoryHelper
+	implements IProvideFluidDataStoreRegistry
+{
+	/**
+	 * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
+	 */
+	public get IFluidDataStoreRegistry(): IFluidDataStoreRegistry {
+		return this.registry;
+	}
+	private readonly registry: IFluidDataStoreRegistry;
+
+	private readonly registryEntries: NamedFluidDataStoreRegistryEntries;
+	private readonly dependencyContainer?: IFluidDependencySynthesizer;
+	private readonly runtimeOptions?: IContainerRuntimeOptions;
+	// eslint-disable-next-line import/no-deprecated
+	private readonly requestHandlers: RuntimeRequestHandler[];
+	private readonly provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
+
+	public constructor(props: BaseContainerRuntimeFactoryProps) {
+		super();
+
+		this.registryEntries = props.registryEntries;
+		this.dependencyContainer = props.dependencyContainer;
+		this.runtimeOptions = props.runtimeOptions;
+		this.provideEntryPoint = props.provideEntryPoint;
+		this.requestHandlers = props.requestHandlers ?? [];
+		this.registry = new FluidDataStoreRegistry(this.registryEntries);
+	}
+
+	public async instantiateFirstTime(runtime: ContainerRuntime): Promise<void> {
+		await this.containerInitializingFirstTime(runtime);
+		await this.containerHasInitialized(runtime);
+	}
+
+	public async instantiateFromExisting(runtime: ContainerRuntime): Promise<void> {
+		await this.containerHasInitialized(runtime);
+	}
+
+	public async preInitialize(
+		context: IContainerContext,
+		existing: boolean,
+	): Promise<ContainerRuntime> {
+		const scope: Partial<IProvideFluidDependencySynthesizer> = context.scope;
+		if (this.dependencyContainer) {
+			const dc = new DependencyContainer<FluidObject>(
+				this.dependencyContainer,
+				scope.IFluidDependencySynthesizer,
+			);
+			scope.IFluidDependencySynthesizer = dc;
+		}
+
+		return ContainerRuntime.loadRuntime({
+			context,
+			existing,
+			runtimeOptions: this.runtimeOptions,
+			registryEntries: this.registryEntries,
+			containerScope: scope,
+			// eslint-disable-next-line import/no-deprecated
+			requestHandler: buildRuntimeRequestHandler(...this.requestHandlers),
+			provideEntryPoint: this.provideEntryPoint,
+		});
+	}
+
+	/**
+	 * Subclasses may override containerInitializingFirstTime to perform any setup steps at the time the container
+	 * is created. This likely includes creating any initial data stores that are expected to be there at the outset.
+	 * @param runtime - The container runtime for the container being initialized
+	 */
+	protected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {}
+
+	/**
+	 * Subclasses may override containerHasInitialized to perform any steps after the container has initialized.
+	 * This likely includes loading any data stores that are expected to be there at the outset.
+	 * @param runtime - The container runtime for the container being initialized
+	 */
+	protected async containerHasInitialized(runtime: IContainerRuntime): Promise<void> {}
+}

package/src/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.ts

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import {
+	type ContainerRuntime,
+	type IContainerRuntimeOptions,
+} from "@fluidframework/container-runtime/internal";
+import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
+import { type FluidObject, type IRequest, type IResponse } from "@fluidframework/core-interfaces";
+// eslint-disable-next-line import/no-deprecated
+import { type RuntimeRequestHandler } from "@fluidframework/request-handler/internal";
+import {
+	type IFluidDataStoreFactory,
+	type NamedFluidDataStoreRegistryEntries,
+} from "@fluidframework/runtime-definitions/internal";
+import { RequestParser } from "@fluidframework/runtime-utils/internal";
+import { type IFluidDependencySynthesizer } from "@fluidframework/synthesize/internal";
+
+import { BaseContainerRuntimeFactory } from "./baseContainerRuntimeFactory.js";
+
+const defaultDataStoreId = "default";
+
+async function getDefaultFluidObject(runtime: IContainerRuntime): Promise<FluidObject> {
+	const entryPoint = await runtime.getAliasedDataStoreEntryPoint("default");
+	if (entryPoint === undefined) {
+		throw new Error("default dataStore must exist");
+	}
+	return entryPoint.get();
+}
+
+/**
+ * {@link ContainerRuntimeFactoryWithDefaultDataStore} construction properties.
+ * @alpha
+ */
+export interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
+	defaultFactory: IFluidDataStoreFactory;
+	/**
+	 * The data store registry for containers produced.
+	 */
+	registryEntries: NamedFluidDataStoreRegistryEntries;
+	/**
+	 * @deprecated Will be removed in a future release.
+	 */
+	dependencyContainer?: IFluidDependencySynthesizer;
+	/**
+	 * Request handlers for containers produced.
+	 * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+	 */
+	// eslint-disable-next-line import/no-deprecated
+	requestHandlers?: RuntimeRequestHandler[];
+	/**
+	 * The runtime options passed to the ContainerRuntime when instantiating it
+	 */
+	runtimeOptions?: IContainerRuntimeOptions;
+	/**
+	 * Function that will initialize the entryPoint of the ContainerRuntime instances
+	 * created with this factory
+	 */
+	provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
+}
+
+/**
+ * A ContainerRuntimeFactory that initializes Containers with a single default data store, which can be requested from
+ * the container with an empty URL.
+ *
+ * This factory should be exposed as fluidExport off the entry point to your module.
+ * @alpha
+ */
+export class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory {
+	public static readonly defaultDataStoreId = defaultDataStoreId;
+
+	protected readonly defaultFactory: IFluidDataStoreFactory;
+
+	public constructor(props: ContainerRuntimeFactoryWithDefaultDataStoreProps) {
+		const requestHandlers = props.requestHandlers ?? [];
+		const provideEntryPoint = props.provideEntryPoint ?? getDefaultFluidObject;
+
+		const getDefaultObject = async (
+			request: IRequest,
+			runtime: IContainerRuntime,
+			// eslint-disable-next-line unicorn/consistent-function-scoping
+		): Promise<IResponse | undefined> => {
+			const parser = RequestParser.create(request);
+			if (parser.pathParts.length === 0) {
+				// This cast is safe as ContainerRuntime.loadRuntime is called in the base class
+				return (runtime as ContainerRuntime).resolveHandle({
+					url: `/${defaultDataStoreId}${parser.query}`,
+					headers: request.headers,
+				});
+			}
+			return undefined; // continue search
+		};
+
+		super({
+			...props,
+			requestHandlers: [getDefaultObject, ...requestHandlers],
+			provideEntryPoint,
+		});
+
+		this.defaultFactory = props.defaultFactory;
+	}
+
+	/**
+	 * {@inheritDoc BaseContainerRuntimeFactory.containerInitializingFirstTime}
+	 */
+	protected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {
+		const dataStore = await runtime.createDataStore(this.defaultFactory.type);
+		await dataStore.trySetAlias(defaultDataStoreId);
+	}
+}

package/src/container-runtime-factories/index.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export {
+	BaseContainerRuntimeFactory,
+	type BaseContainerRuntimeFactoryProps,
+} from "./baseContainerRuntimeFactory.js";
+export {
+	ContainerRuntimeFactoryWithDefaultDataStore,
+	type ContainerRuntimeFactoryWithDefaultDataStoreProps,
+} from "./containerRuntimeFactoryWithDefaultDataStore.js";

package/src/data-object-factories/dataObjectFactory.ts

@@ -0,0 +1,63 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { FluidDataStoreRuntime } from "@fluidframework/datastore/internal";
+import { type IChannelFactory } from "@fluidframework/datastore-definitions";
+import {
+	SharedMap,
+	DirectoryFactory,
+	MapFactory,
+	// eslint-disable-next-line import/no-deprecated
+	SharedDirectory,
+} from "@fluidframework/map/internal";
+import { type NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions/internal";
+import { type FluidObjectSymbolProvider } from "@fluidframework/synthesize/internal";
+
+import {
+	type DataObject,
+	type DataObjectTypes,
+	type IDataObjectProps,
+} from "../data-objects/index.js";
+
+import { PureDataObjectFactory } from "./pureDataObjectFactory.js";
+
+/**
+ * DataObjectFactory is the IFluidDataStoreFactory for use with DataObjects.
+ * It facilitates DataObject's features (such as its shared directory) by
+ * ensuring relevant shared objects etc are available to the factory.
+ *
+ * @typeParam TObj - DataObject (concrete type)
+ * @typeParam I - The input types for the DataObject
+ * @alpha
+ */
+export class DataObjectFactory<
+	TObj extends DataObject<I>,
+	I extends DataObjectTypes = DataObjectTypes,
+> extends PureDataObjectFactory<TObj, I> {
+	public constructor(
+		type: string,
+		ctor: new (props: IDataObjectProps<I>) => TObj,
+		sharedObjects: readonly IChannelFactory[] = [],
+		optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>,
+		registryEntries?: NamedFluidDataStoreRegistryEntries,
+		runtimeFactory: typeof FluidDataStoreRuntime = FluidDataStoreRuntime,
+	) {
+		const mergedObjects = [...sharedObjects];
+
+		if (!sharedObjects.some((factory) => factory.type === DirectoryFactory.Type)) {
+			// User did not register for directory
+			// eslint-disable-next-line import/no-deprecated
+			mergedObjects.push(SharedDirectory.getFactory());
+		}
+
+		// TODO: Remove SharedMap factory when compatibility with SharedMap DataObject is no longer needed in 0.10
+		if (!sharedObjects.some((factory) => factory.type === MapFactory.Type)) {
+			// User did not register for map
+			mergedObjects.push(SharedMap.getFactory());
+		}
+
+		super(type, ctor, mergedObjects, optionalProviders, registryEntries, runtimeFactory);
+	}
+}

package/src/data-object-factories/index.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export { DataObjectFactory } from "./dataObjectFactory.js";
+export { PureDataObjectFactory } from "./pureDataObjectFactory.js";