@fluidframework/aqueduct 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

package/.eslintrc.cjs

@@ -0,0 +1,14 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+	rules: {
+		"@typescript-eslint/strict-boolean-expressions": "off",
+	},
+};

package/.mocharc.cjs

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/CHANGELOG.md

@@ -0,0 +1,342 @@
+# @fluidframework/aqueduct
+
+## 2.0.0-rc.3.0.0
+
+### Major Changes
+
+-   Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
+
+    Fluid Framework packages have been updated to use the [package.json "exports"
+    field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
+    TypeScript types and implementation code.
+
+    This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
+
+    -   `"moduleResolution": "Node16"` with `"module": "Node16"`
+    -   `"moduleResolution": "Bundler"` with `"module": "ESNext"`
+
+    We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
+    for use with modern versions of Node.js _and_ Bundlers.
+    [See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
+    regarding the module and moduleResolution options.
+
+    **Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
+    to distinguish stable APIs from those that are in development.**
+
+## 2.0.0-rc.2.0.0
+
+### Minor Changes
+
+-   aqueduct: Deprecated PureDataObjectFactory.createRootInstance and replaced with PureDataObjectFactory.createInstanceWithDataStore ([#19471](https://github.com/microsoft/FluidFramework/issues/19471)) [0a79375ccb](https://github.com/microsoft/FluidFramework/commits/0a79375ccb523658a2565b8796fa06ec45a69394)
+
+    ### Deprecated: PureDataObjectFactory.createRootInstance
+
+    This was deprecated because `PureDataObjectFactory.createRootInstance` has an issue at scale.
+    `PureDataObjectFactory.createRootInstance` used the old method of creating `PureDataObject`s with names. The issue was
+    that simultaneous creations could happen, and the old api had no good way of dealing with those types of collisions.
+    This version slightly improved it by resolving those collisions by assuming whatever datastore was created with the
+    alias or `rootDataStoreId` would just return that datastore. This will work for developers who expect the same type of
+    `PureDataObject` to be returned from the `createRootInstance` api, but if a potentially different `PureDataObject`
+    would be returned, then this api would give you the wrong typing.
+
+    For a replacement api see `PureDataObjectFactory.createInstanceWithDataStore`.
+
+    ### New method PureDataObjectFactory.createInstanceWithDataStore
+
+    This was done as a replacement of `PureDataObjectFactory.createRootInstance`. This exposes the `IDataStore` interface
+    in the form of `[PureDataObject, IDataStore]`. `IDataStore` provides the opportunity for developers to use the
+    `IDataStore.trySetAlias` method. This can return 3 different scenarios `Success`, `Conflict`, or `AlreadyAliased`.
+    These scenarios can allow the developer to handle conflicts as they wish.
+
+-   aqueduct: PureDataObjectFactory.instantiateDataStore now returns IFluidDataStoreChannel ([#19353](https://github.com/microsoft/FluidFramework/issues/19353)) [3aad53da1e](https://github.com/microsoft/FluidFramework/commits/3aad53da1ee8c4079d4f3b4a096361d23e0725ab)
+
+    The return type of `PureDataObjectFactory.instantiateDataStore` was changed from `FluidDataStoreRuntime` to
+    `IFluidDataStoreChannel`.
+
+## 2.0.0-rc.1.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.8.0.0
+
+### Major Changes
+
+-   aqueduct: Removed getDefaultObjectFromContainer, getObjectWithIdFromContainer and getObjectFromContainer [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    The `getDefaultObjectFromContainer`, `getObjectWithIdFromContainer` and `getObjectFromContainer` helper methods have been removed from @fluidframework/aqueduct. Please move all code usage to the new `entryPoint` pattern.
+
+    See
+    [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
+    for more details.
+
+-   data-object-base: Removed IFluidRouter from DataObject interfaces and classes [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    The `IFluidRouter` property has been removed from a number of DataObject related classes:
+
+    -   `PureDataObject`
+    -   `LazyLoadedDataObject`
+    -   `TestFluidObject`
+
+    Please migrate to the new `entryPoint` pattern or use the relevant `request` method as necessary.
+
+    See
+    [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
+    for more details.
+
+-   aqueduct: Removed IRootDataObjectFactory [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    The `IRootDataObjectFactory` interface has been removed. Please remove all usage of it.
+
+-   aqueduct: Removed requestHandler utilities [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    The following `requestHandler` utilities have been removed:
+
+    -   `makeModelRequestHandler`
+    -   `defaultFluidObjectRequestHandler`
+    -   `defaultRouteRequestHandler`
+    -   `mountableViewRequestHandler`
+    -   `createFluidObjectResponse`
+    -   `rootDataStoreRequestHandler`
+    -   `handleFromLegacyUri`
+    -   `RuntimeRequestHandlerBuilder`
+
+    Please migrate all usage to the new `entryPoint` pattern.
+
+    See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
+
+## 2.0.0-internal.7.4.0
+
+### Minor Changes
+
+-   aqueduct: Deprecated IRootDataObjectFactory ([#18565](https://github.com/microsoft/FluidFramework/issues/18565)) [030ab7adf9](https://github.com/microsoft/FluidFramework/commits/030ab7adf991d2d983437544600a191ac15ca5a5)
+
+    The `IRootDataObjectFactory` interface has been deprecated and will be removed in a future major release. Please remove
+    all usage of it.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   aqueduct: ContainerRuntimeFactory constructors have changed [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The following class constructors have been changed to allow for better flexible in arguments passed:
+
+    -   `BaseContainerRuntimeFactory`
+    -   `ContainerRuntimeFactoryWithDefaultDataStore`
+    -   `RuntimeFactory`
+
+    They now use a single object for constructor params. Example change to be made:
+
+    ```ts
+    // Old
+    new BaseContainerRuntimeFactory(
+    	myRegistryEntries,
+    	myDependencyContainer,
+    	myRequestHandlers,
+    	myRuntimeOptions,
+    	myProvideEntryPoint,
+    );
+
+    // New
+    new BaseContainerRuntimeFactory({
+    	registryEntries: myRegistryEntries,
+    	dependencyContainer: myDependencyContainer,
+    	requestHandlers: myRequestHandlers,
+    	runtimeOptions: myRuntimeOptions,
+    	provideEntryPoint: myProvideEntryPoint,
+    });
+    ```
+
+-   DEPRECATED: container-runtime: requestHandlers are deprecated [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The concept of `requestHandlers` has been deprecated. Please migrate all usage of the following APIs to the new `entryPoint` pattern:
+
+    -   `requestHandler` property in `ContainerRuntime.loadRuntime(...)`
+    -   `RuntimeRequestHandler`
+    -   `RuntimeRequestHandlerBuilder`
+    -   `defaultFluidObjectRequestHandler(...)`
+    -   `defaultRouteRequestHandler(...)`
+    -   `mountableViewRequestHandler(...)`
+    -   `buildRuntimeRequestHandler(...)`
+    -   `createFluidObjectResponse(...)`
+    -   `handleFromLegacyUri(...)`
+    -   `rootDataStoreRequestHandler(...)`
+
+    See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
+
+-   DEPRECATED: container-loader: Various request related APIs have been deprecated [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Please remove all calls to the following functions and instead use the new `entryPoint` pattern:
+
+    -   `requestFluidObject`
+    -   `requestResolvedObjectFromContainer`
+    -   `getDefaultObjectFromContainer`
+    -   `getObjectWithIdFromContainer`
+    -   `getObjectFromContainer`
+
+    See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
+
+-   container-definitions: IContainer's and IDataStore's IFluidRouter capabilities are deprecated [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    `IFluidRouter` and `request({ url: "/" })` on `IContainer` and `IDataStore` are deprecated and will be removed in a future major release. Please migrate all usage to the appropriate `getEntryPoint()` or `entryPoint` APIs.
+
+    See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
+
+-   test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
+
+    -   `BaseContainerRuntimeFactory`
+    -   `RuntimeFactory`
+    -   `ContainerRuntime` (constructor and `loadRuntime`)
+    -   `FluidDataStoreRuntime`
+
+    See [testContainerRuntimeFactoryWithDefaultDataStore.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/test/test-utils/src/testContainerRuntimeFactoryWithDefaultDataStore.ts) for an example implemtation of `provideEntryPoint` for ContainerRuntime.
+    See [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L83) for an example implementation of `provideEntryPoint` for DataStoreRuntime.
+
+    Subsequently, various `entryPoint` and `getEntryPoint()` endpoints have become required. Please see [containerRuntime.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/containerRuntime.ts) for example implementations of these APIs.
+
+    For more details, see [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+-   aqueduct: EventForwarder and IDisposable members removed from PureDataObject [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The `EventForwarder` and `IDisposable` members of `PureDataObject` were deprecated in 2.0.0-internal.5.2.0 and have now been removed.
+
+    If your code was overriding any methods/properties from `EventForwarder` and or `IDisposable` on a class that inherits
+    (directly or transitively) from `PureDataObject`, you'll have to remove the `override` keyword.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+### Minor Changes
+
+-   PureDataObject temporarily extends EventForwarder and implements IDisposable again ([#16846](https://github.com/microsoft/FluidFramework/issues/16846)) [9825a692dd](https://github.com/microsoft/FluidFramework/commits/9825a692dd27eded214e3978a7fd6028b05e6fab)
+
+    `PureDataObject` extends `EventForwarder` and implements `IDìsposable` again to ease the transition to `2.0.0-internal.6.x`.
+    These interfaces will no longer be implemented on `PureDataObject` in version `2.0.0-internal.7.0.0`.
+
+    The original deprecation announcement for these members can be found [here](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.0.0-internal.5.2.0).
+
+    Once the change is re-applied in `2.0.0-internal.7.0.0`, if your code was overriding any methods/properties from
+    `EventForwarder` and or `IDisposable` on a class that inherits (directly or transitively) from `PureDataObject`,
+    you'll have to remove the `override` keyword.
+
+-   Remove use of @fluidframework/common-definitions ([#16638](https://github.com/microsoft/FluidFramework/issues/16638)) [a8c81509c9](https://github.com/microsoft/FluidFramework/commits/a8c81509c9bf09cfb2092ebcf7265205f9eb6dbf)
+
+    The **@fluidframework/common-definitions** package is being deprecated, so the following interfaces and types are now
+    imported from the **@fluidframework/core-interfaces** package:
+
+    -   interface IDisposable
+    -   interface IErrorEvent
+    -   interface IErrorEvent
+    -   interface IEvent
+    -   interface IEventProvider
+    -   interface ILoggingError
+    -   interface ITaggedTelemetryPropertyType
+    -   interface ITelemetryBaseEvent
+    -   interface ITelemetryBaseLogger
+    -   interface ITelemetryErrorEvent
+    -   interface ITelemetryGenericEvent
+    -   interface ITelemetryLogger
+    -   interface ITelemetryPerformanceEvent
+    -   interface ITelemetryProperties
+    -   type ExtendEventProvider
+    -   type IEventThisPlaceHolder
+    -   type IEventTransformer
+    -   type ReplaceIEventThisPlaceHolder
+    -   type ReplaceIEventThisPlaceHolder
+    -   type TelemetryEventCategory
+    -   type TelemetryEventPropertyType
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   `initializeEntryPoint` will become required [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    The optional `initializeEntryPoint` method has been added to a number of constructors. **This method argument will become required in an upcoming release** and a value will need to be provided to the following classes:
+
+    -   `BaseContainerRuntimeFactory`
+    -   `ContainerRuntimeFactoryWithDefaultDataStore`
+    -   `RuntimeFactory`
+    -   `ContainerRuntime` (constructor and `loadRuntime`)
+    -   `FluidDataStoreRuntime`
+
+    For an example implementation of `initializeEntryPoint`, see [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/blob/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L84).
+
+    This work will replace the request pattern. See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more info on this effort.
+
+-   EventForwarder and IDisposable members removed from PureDataObject [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    The EventForwarder and IDisposable members of PureDataObject were deprecated in 2.0.0-internal.5.2.0 and have now been removed.
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+### Minor Changes
+
+-   EventForwarder and IDisposable members deprecated from PureDataObject ([#16201](https://github.com/microsoft/FluidFramework/issues/16201)) [0e838fdb3e](https://github.com/microsoft/FluidFramework/commits/0e838fdb3e8187481f41c4116a67458c2a1658d5)
+
+    The EventForwarder and IDisposable members have been deprecated from PureDataObject and will be removed in an upcoming release. The EventForwarder pattern was mostly unused by the current implementation, and is also recommended against generally (instead, register and forward events explicitly). The disposal implementation was incomplete and likely to cause poor behavior as the disposal was not observable by default. Inheritors of the PureDataObject can of course still implement their own disposal logic.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+### Major Changes
+
+-   The following functions and classes were deprecated in previous releases and have been removed: [8b242fdc79](https://github.com/microsoft/FluidFramework/commits/8b242fdc796714cf1da9ad3f90d02efb122af0c2)
+
+    -   `PureDataObject.getFluidObjectFromDirectory`
+    -   `IProvideContainerRuntime` and its `IContainerRuntime` member.
+    -   `ContainerRuntime`'s `IProvideContainerRuntime` has also been removed.
+
+## 2.0.0-internal.4.4.0
+
+### Minor Changes
+
+-   `PureDataObject.getFluidObjectFromDirectory` has been deprecated and will be removed in an upcoming release. Instead prefer to interface directly with the directory and handles. [9238304c77](https://github.com/microsoft/FluidFramework/commits/9238304c772d447225f6f86417033ca8004c0edd)
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+}

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
+}

package/api-report/aqueduct.api.md

@@ -0,0 +1,165 @@
+## API Report File for "@fluidframework/aqueduct"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AsyncFluidObjectProvider } from '@fluidframework/synthesize/internal';
+import { ContainerRuntime } from '@fluidframework/container-runtime/internal';
+import { FluidDataStoreRuntime } from '@fluidframework/datastore/internal';
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { FluidObjectSymbolProvider } from '@fluidframework/synthesize/internal';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IContainerContext } from '@fluidframework/container-definitions/internal';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
+import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions/internal';
+import { IContainerRuntimeOptions } from '@fluidframework/container-runtime/internal';
+import { IDataStore } from '@fluidframework/runtime-definitions/internal';
+import { IEvent } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions/internal';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions/internal';
+import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definitions/internal';
+import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
+import { IFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidDependencySynthesizer } from '@fluidframework/synthesize/internal';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
+import { IProvideFluidHandle } from '@fluidframework/core-interfaces';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IResponse } from '@fluidframework/core-interfaces';
+import { ISharedDirectory } from '@fluidframework/map/internal';
+import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions/internal';
+import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions/internal';
+import { RuntimeFactoryHelper } from '@fluidframework/runtime-utils/internal';
+import { RuntimeRequestHandler } from '@fluidframework/request-handler/internal';
+import { TypedEventEmitter } from '@fluid-internal/client-utils';
+
+// @alpha
+export class BaseContainerRuntimeFactory extends RuntimeFactoryHelper implements IProvideFluidDataStoreRegistry {
+    constructor(props: BaseContainerRuntimeFactoryProps);
+    protected containerHasInitialized(runtime: IContainerRuntime): Promise<void>;
+    protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
+    get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
+    // (undocumented)
+    instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
+    // (undocumented)
+    instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
+    // (undocumented)
+    preInitialize(context: IContainerContext, existing: boolean): Promise<ContainerRuntime>;
+}
+
+// @alpha
+export interface BaseContainerRuntimeFactoryProps {
+    // @deprecated (undocumented)
+    dependencyContainer?: IFluidDependencySynthesizer;
+    provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
+    registryEntries: NamedFluidDataStoreRegistryEntries;
+    // @deprecated
+    requestHandlers?: RuntimeRequestHandler[];
+    runtimeOptions?: IContainerRuntimeOptions;
+}
+
+// @alpha
+export class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory {
+    constructor(props: ContainerRuntimeFactoryWithDefaultDataStoreProps);
+    protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
+    // (undocumented)
+    static readonly defaultDataStoreId = "default";
+    // (undocumented)
+    protected readonly defaultFactory: IFluidDataStoreFactory;
+}
+
+// @alpha
+export interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
+    // (undocumented)
+    defaultFactory: IFluidDataStoreFactory;
+    // @deprecated (undocumented)
+    dependencyContainer?: IFluidDependencySynthesizer;
+    provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
+    registryEntries: NamedFluidDataStoreRegistryEntries;
+    // @deprecated
+    requestHandlers?: RuntimeRequestHandler[];
+    runtimeOptions?: IContainerRuntimeOptions;
+}
+
+// @alpha
+export abstract class DataObject<I extends DataObjectTypes = DataObjectTypes> extends PureDataObject<I> {
+    protected getUninitializedErrorString(item: string): string;
+    initializeInternal(existing: boolean): Promise<void>;
+    protected get root(): ISharedDirectory;
+}
+
+// @alpha
+export class DataObjectFactory<TObj extends DataObject<I>, I extends DataObjectTypes = DataObjectTypes> extends PureDataObjectFactory<TObj, I> {
+    constructor(type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory<unknown>[] | undefined, optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeFactory?: typeof FluidDataStoreRuntime);
+}
+
+// @alpha
+export interface DataObjectTypes {
+    Events?: IEvent;
+    InitialState?: any;
+    OptionalProviders?: FluidObject;
+}
+
+// @alpha (undocumented)
+export interface IDataObjectProps<I extends DataObjectTypes = DataObjectTypes> {
+    // (undocumented)
+    readonly context: IFluidDataStoreContext;
+    // (undocumented)
+    readonly initProps?: I["InitialState"];
+    // (undocumented)
+    readonly providers: AsyncFluidObjectProvider<I["OptionalProviders"]>;
+    // (undocumented)
+    readonly runtime: IFluidDataStoreRuntime;
+}
+
+// @alpha
+export abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes> extends TypedEventEmitter<I["Events"] & IEvent> implements IFluidLoadable, IProvideFluidHandle {
+    constructor(props: IDataObjectProps<I>);
+    protected readonly context: IFluidDataStoreContext;
+    finishInitialization(existing: boolean): Promise<void>;
+    // (undocumented)
+    static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject>;
+    get handle(): IFluidHandle<this>;
+    protected hasInitialized(): Promise<void>;
+    // (undocumented)
+    get id(): string;
+    get IFluidHandle(): IFluidHandle<this>;
+    get IFluidLoadable(): this;
+    initializeInternal(existing: boolean): Promise<void>;
+    // (undocumented)
+    protected initializeP: Promise<void> | undefined;
+    protected initializingFirstTime(props?: I["InitialState"]): Promise<void>;
+    protected initializingFromExisting(): Promise<void>;
+    // (undocumented)
+    protected initProps?: I["InitialState"];
+    protected preInitialize(): Promise<void>;
+    protected readonly providers: AsyncFluidObjectProvider<I["OptionalProviders"]>;
+    request(req: IRequest): Promise<IResponse>;
+    protected readonly runtime: IFluidDataStoreRuntime;
+}
+
+// @alpha
+export class PureDataObjectFactory<TObj extends PureDataObject<I>, I extends DataObjectTypes = DataObjectTypes> implements IFluidDataStoreFactory, Partial<IProvideFluidDataStoreRegistry> {
+    constructor(
+    type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory[], optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeClass?: typeof FluidDataStoreRuntime);
+    createChildInstance(parentContext: IFluidDataStoreContext, initialState?: I["InitialState"], loadingGroupId?: string): Promise<TObj>;
+    createInstance(runtime: IContainerRuntimeBase, initialState?: I["InitialState"], loadingGroupId?: string): Promise<TObj>;
+    // (undocumented)
+    protected createInstanceCore(context: IFluidDataStoreContextDetached, initialState?: I["InitialState"]): Promise<TObj>;
+    createInstanceWithDataStore(containerRuntime: IContainerRuntimeBase, initialState?: I["InitialState"], packagePath?: Readonly<string[]>, loadingGroupId?: string): Promise<[TObj, IDataStore]>;
+    // (undocumented)
+    protected createNonRootInstanceCore(containerRuntime: IContainerRuntimeBase, packagePath: Readonly<string[]>, initialState?: I["InitialState"], loadingGroupId?: string): Promise<TObj>;
+    createPeerInstance(peerContext: IFluidDataStoreContext, initialState?: I["InitialState"], loadingGroupId?: string): Promise<TObj>;
+    // @deprecated
+    createRootInstance(rootDataStoreId: string, runtime: IContainerRuntime, initialState?: I["InitialState"]): Promise<TObj>;
+    get IFluidDataStoreFactory(): this;
+    get IFluidDataStoreRegistry(): IFluidDataStoreRegistry | undefined;
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;
+    get registryEntry(): NamedFluidDataStoreRegistryEntry;
+    readonly type: string;
+}
+
+```

package/dist/container-runtime-factories/baseContainerRuntimeFactory.d.ts

@@ -2,14 +2,14 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { type IContainerContext } from "@fluidframework/container-definitions";
-import { type IContainerRuntimeOptions, ContainerRuntime } from "@fluidframework/container-runtime";
-import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions";
-import { type RuntimeRequestHandler } from "@fluidframework/request-handler";
-import { type IFluidDataStoreRegistry, type IProvideFluidDataStoreRegistry, type NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
-import { type IFluidDependencySynthesizer } from "@fluidframework/synthesize";
-import { RuntimeFactoryHelper } from "@fluidframework/runtime-utils";
+import { type IContainerContext } from "@fluidframework/container-definitions/internal";
+import { ContainerRuntime, type IContainerRuntimeOptions } from "@fluidframework/container-runtime/internal";
+import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
 import { type FluidObject } from "@fluidframework/core-interfaces";
+import { type RuntimeRequestHandler } 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 { type IFluidDependencySynthesizer } from "@fluidframework/synthesize/internal";
 /**
  * {@link BaseContainerRuntimeFactory} construction properties.
  * @alpha

package/dist/container-runtime-factories/baseContainerRuntimeFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseContainerRuntimeFactory.d.ts","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EACN,KAAK,wBAAwB,EAE7B,gBAAgB,EAChB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAEvF,OAAO,EACN,KAAK,qBAAqB,EAE1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACN,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,kCAAkC,EACvC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAEN,KAAK,2BAA2B,EAEhC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAEnE;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAChD;;OAEG;IACH,eAAe,EAAE,kCAAkC,CAAC;IACpD;;OAEG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;IAClD;;;OAGG;IACH,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC1C;;OAEG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAC1C;;;OAGG;IACH,iBAAiB,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CACxE;AAED;;;;;GAKG;AACH,qBAAa,2BACZ,SAAQ,oBACR,YAAW,8BAA8B;IAEzC;;OAEG;IACH,IAAW,uBAAuB,IAAI,uBAAuB,CAE5D;IACD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IAEnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqC;IACrE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAA8B;IACnE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAA2B;IAC3D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAuD;gBAEtE,KAAK,EAAE,gCAAgC;IAW7C,oBAAoB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9D,uBAAuB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,aAAa,CACzB,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,gBAAgB,CAAC;IAsB5B;;;;OAIG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAEzF;;;;OAIG;cACa,uBAAuB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CAClF"}
+{"version":3,"file":"baseContainerRuntimeFactory.d.ts","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,gDAAgD,CAAC;AACxF,OAAO,EACN,gBAAgB,EAEhB,KAAK,wBAAwB,EAC7B,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,wDAAwD,CAAC;AAChG,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EACN,KAAK,qBAAqB,EAG1B,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACN,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,kCAAkC,EACvC,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAC9E,OAAO,EAEN,KAAK,2BAA2B,EAEhC,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAChD;;OAEG;IACH,eAAe,EAAE,kCAAkC,CAAC;IACpD;;OAEG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;IAClD;;;OAGG;IACH,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC1C;;OAEG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAC1C;;;OAGG;IACH,iBAAiB,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CACxE;AAED;;;;;GAKG;AACH,qBAAa,2BACZ,SAAQ,oBACR,YAAW,8BAA8B;IAEzC;;OAEG;IACH,IAAW,uBAAuB,IAAI,uBAAuB,CAE5D;IACD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IAEnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqC;IACrE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAA8B;IACnE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAA2B;IAC3D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAuD;gBAEtE,KAAK,EAAE,gCAAgC;IAW7C,oBAAoB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9D,uBAAuB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,aAAa,CACzB,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,gBAAgB,CAAC;IAsB5B;;;;OAIG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAEzF;;;;OAIG;cACa,uBAAuB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CAClF"}

package/dist/container-runtime-factories/baseContainerRuntimeFactory.js

@@ -5,18 +5,17 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseContainerRuntimeFactory = void 0;
-const container_runtime_1 = require("@fluidframework/container-runtime");
-// eslint-disable-next-line import/no-deprecated
-const request_handler_1 = require("@fluidframework/request-handler");
-const synthesize_1 = require("@fluidframework/synthesize");
-const runtime_utils_1 = require("@fluidframework/runtime-utils");
+const internal_1 = require("@fluidframework/container-runtime/internal");
+const internal_2 = require("@fluidframework/request-handler/internal");
+const internal_3 = require("@fluidframework/runtime-utils/internal");
+const internal_4 = require("@fluidframework/synthesize/internal");
 /**
  * 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
  */
-class BaseContainerRuntimeFactory extends runtime_utils_1.RuntimeFactoryHelper {
+class BaseContainerRuntimeFactory extends internal_3.RuntimeFactoryHelper {
     /**
      * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
      */
@@ -30,7 +29,7 @@ class BaseContainerRuntimeFactory extends runtime_utils_1.RuntimeFactoryHelper {
         this.runtimeOptions = props.runtimeOptions;
         this.provideEntryPoint = props.provideEntryPoint;
         this.requestHandlers = props.requestHandlers ?? [];
-        this.registry = new container_runtime_1.FluidDataStoreRegistry(this.registryEntries);
+        this.registry = new internal_1.FluidDataStoreRegistry(this.registryEntries);
     }
     async instantiateFirstTime(runtime) {
         await this.containerInitializingFirstTime(runtime);
@@ -42,17 +41,17 @@ class BaseContainerRuntimeFactory extends runtime_utils_1.RuntimeFactoryHelper {
     async preInitialize(context, existing) {
         const scope = context.scope;
         if (this.dependencyContainer) {
-            const dc = new synthesize_1.DependencyContainer(this.dependencyContainer, scope.IFluidDependencySynthesizer);
+            const dc = new internal_4.DependencyContainer(this.dependencyContainer, scope.IFluidDependencySynthesizer);
             scope.IFluidDependencySynthesizer = dc;
         }
-        return container_runtime_1.ContainerRuntime.loadRuntime({
+        return internal_1.ContainerRuntime.loadRuntime({
             context,
             existing,
             runtimeOptions: this.runtimeOptions,
             registryEntries: this.registryEntries,
             containerScope: scope,
             // eslint-disable-next-line import/no-deprecated
-            requestHandler: (0, request_handler_1.buildRuntimeRequestHandler)(...this.requestHandlers),
+            requestHandler: (0, internal_2.buildRuntimeRequestHandler)(...this.requestHandlers),
             provideEntryPoint: this.provideEntryPoint,
         });
     }