@fluidframework/aqueduct 2.0.0-dev-rc.1.0.0.228517 → 2.0.0-dev-rc.1.0.0.232845

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;;;;;;;;;;GAaG;AAEH,iEAAmF;AAA1E,0HAAA,iBAAiB,OAAA;AAAE,8HAAA,qBAAqB,OAAA;AACjD,+CAA+F;AAAtF,0GAAA,UAAU,OAAA;AAAqC,8GAAA,cAAc,OAAA;AACtE,6EAGuC;AAFtC,0IAAA,2BAA2B,OAAA;AAC3B,0JAAA,2CAA2C,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The `aqueduct` package is a library for building Fluid objects and Fluid\n * containers within the Fluid Framework. Its goal is to provide a thin base\n * layer over the existing Fluid Framework interfaces that allows developers to\n * get started quickly.\n *\n * @remarks\n * About the library name: An \"aqueduct\" is a way to transport water from a source\n * to another location. The library name was chosen because its purpose is to\n * facilitate using lower level constructs and therefore handle 'fluid' items\n * same as an aqueduct.\n *\n * @packageDocumentation\n */\n\nexport { DataObjectFactory, PureDataObjectFactory } from \"./data-object-factories\";\nexport { DataObject, DataObjectTypes, IDataObjectProps, PureDataObject } from \"./data-objects\";\nexport {\n\tBaseContainerRuntimeFactory,\n\tContainerRuntimeFactoryWithDefaultDataStore,\n} from \"./container-runtime-factories\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;;;;;;;;;;GAaG;AAEH,iEAAmF;AAA1E,0HAAA,iBAAiB,OAAA;AAAE,8HAAA,qBAAqB,OAAA;AACjD,+CAKwB;AAJvB,0GAAA,UAAU,OAAA;AAGV,8GAAA,cAAc,OAAA;AAEf,6EAKuC;AAJtC,0IAAA,2BAA2B,OAAA;AAE3B,0JAAA,2CAA2C,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The `aqueduct` package is a library for building Fluid objects and Fluid\n * containers within the Fluid Framework. Its goal is to provide a thin base\n * layer over the existing Fluid Framework interfaces that allows developers to\n * get started quickly.\n *\n * @remarks\n * About the library name: An \"aqueduct\" is a way to transport water from a source\n * to another location. The library name was chosen because its purpose is to\n * facilitate using lower level constructs and therefore handle 'fluid' items\n * same as an aqueduct.\n *\n * @packageDocumentation\n */\n\nexport { DataObjectFactory, PureDataObjectFactory } from \"./data-object-factories\";\nexport {\n\tDataObject,\n\ttype DataObjectTypes,\n\ttype IDataObjectProps,\n\tPureDataObject,\n} from \"./data-objects\";\nexport {\n\tBaseContainerRuntimeFactory,\n\ttype BaseContainerRuntimeFactoryProps,\n\tContainerRuntimeFactoryWithDefaultDataStore,\n\ttype ContainerRuntimeFactoryWithDefaultDataStoreProps,\n} from \"./container-runtime-factories\";\n"]}

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.38.3"
+      "packageVersion": "7.39.1"
     }
   ]
 }

package/lib/aqueduct-alpha.d.mts

@@ -35,6 +35,9 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
  * @alpha
  */
 export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper implements IProvideFluidDataStoreRegistry {
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
+     */
     get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
     private readonly registry;
     private readonly registryEntries;
@@ -42,22 +45,7 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
     private readonly runtimeOptions?;
     private readonly requestHandlers;
     private readonly provideEntryPoint;
-    /**
-     * @param registryEntries - The data store registry for containers produced
-     * @param dependencyContainer - deprecated, will be removed in a future release
-     * @param requestHandlers - Request handlers for containers produced
-     * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it
-     * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances
-     * created with this factory
-     */
-    constructor(props: {
-        registryEntries: NamedFluidDataStoreRegistryEntries;
-        dependencyContainer?: IFluidDependencySynthesizer;
-        /** @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 */
-        requestHandlers?: RuntimeRequestHandler[];
-        runtimeOptions?: IContainerRuntimeOptions;
-        provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
-    });
+    constructor(props: BaseContainerRuntimeFactoryProps);
     instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
     instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
     preInitialize(context: IContainerContext, existing: boolean): Promise<ContainerRuntime>;
@@ -75,6 +63,35 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
     protected containerHasInitialized(runtime: IContainerRuntime): Promise<void>;
 }
 
+/**
+ * {@link BaseContainerRuntimeFactory} construction properties.
+ * @alpha
+ */
+export declare 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
+     */
+    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.
@@ -85,30 +102,43 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
 export declare class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory {
     static readonly defaultDataStoreId = "default";
     protected readonly defaultFactory: IFluidDataStoreFactory;
-    /**
-     * Constructor
-     * @param defaultFactory -
-     * @param registryEntries -
-     * @param dependencyContainer - deprecated, will be removed in a future release
-     * @param requestHandlers -
-     * @param runtimeOptions -
-     * @param provideEntryPoint -
-     */
-    constructor(props: {
-        defaultFactory: IFluidDataStoreFactory;
-        registryEntries: NamedFluidDataStoreRegistryEntries;
-        dependencyContainer?: IFluidDependencySynthesizer;
-        /** @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 */
-        requestHandlers?: RuntimeRequestHandler[];
-        runtimeOptions?: IContainerRuntimeOptions;
-        provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
-    });
+    constructor(props: ContainerRuntimeFactoryWithDefaultDataStoreProps);
     /**
      * {@inheritDoc BaseContainerRuntimeFactory.containerInitializingFirstTime}
      */
     protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
 }
 
+/**
+ * {@link ContainerRuntimeFactoryWithDefaultDataStore} construction properties.
+ * @alpha
+ */
+export declare 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
+     */
+    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>;
+}
+
 /**
  * DataObject is a base data store that is primed with a root directory. It
  * ensures that it is created and ready before you can access it.
@@ -159,15 +189,15 @@ export declare class DataObjectFactory<TObj extends DataObject<I>, I extends Dat
  */
 export declare interface DataObjectTypes {
     /**
-     * represents a type that will define optional providers that will be injected
+     * Represents a type that will define optional providers that will be injected.
      */
     OptionalProviders?: FluidObject;
     /**
-     * the initial state type that the produced data object may take during creation
+     * The initial state type that the produced data object may take during creation.
      */
     InitialState?: any;
     /**
-     * represents events that will be available in the EventForwarder
+     * Represents events that will be available in the EventForwarder.
      */
     Events?: IEvent;
 }
@@ -210,13 +240,19 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
     protected initProps?: I["InitialState"];
     protected initializeP: Promise<void> | undefined;
     get id(): string;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidLoadable.IFluidLoadable}
+     */
     get IFluidLoadable(): this;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}
+     */
     get IFluidHandle(): IFluidHandle<this>;
     /**
      * Handle to a data store
      */
     get handle(): IFluidHandle<this>;
-    static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject<DataObjectTypes>>;
+    static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject>;
     constructor(props: IDataObjectProps<I>);
     /**
      * Return this object if someone requests it directly
@@ -283,7 +319,13 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
     private readonly sharedObjectRegistry;
     private readonly registry;
     constructor(type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory[], optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeClass?: typeof FluidDataStoreRuntime);
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreFactory.IFluidDataStoreFactory}
+     */
     get IFluidDataStoreFactory(): this;
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
+     */
     get IFluidDataStoreRegistry(): IFluidDataStoreRegistry | undefined;
     /**
      * Convenience helper to get the data store's/factory's data store registry entry.

package/lib/aqueduct-beta.d.mts

@@ -32,10 +32,14 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: BaseContainerRuntimeFactory */
 
+/* Excluded from this release type: BaseContainerRuntimeFactoryProps */
+
 /* Excluded from this release type: ContainerRuntime */
 
 /* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStore */
 
+/* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStoreProps */
+
 /* Excluded from this release type: DataObject */
 
 /* Excluded from this release type: DataObjectFactory */

package/lib/aqueduct-public.d.mts

@@ -32,10 +32,14 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: BaseContainerRuntimeFactory */
 
+/* Excluded from this release type: BaseContainerRuntimeFactoryProps */
+
 /* Excluded from this release type: ContainerRuntime */
 
 /* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStore */
 
+/* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStoreProps */
+
 /* Excluded from this release type: DataObject */
 
 /* Excluded from this release type: DataObjectFactory */

package/lib/aqueduct-untrimmed.d.mts

@@ -35,6 +35,9 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
  * @alpha
  */
 export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper implements IProvideFluidDataStoreRegistry {
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
+     */
     get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
     private readonly registry;
     private readonly registryEntries;
@@ -42,22 +45,7 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
     private readonly runtimeOptions?;
     private readonly requestHandlers;
     private readonly provideEntryPoint;
-    /**
-     * @param registryEntries - The data store registry for containers produced
-     * @param dependencyContainer - deprecated, will be removed in a future release
-     * @param requestHandlers - Request handlers for containers produced
-     * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it
-     * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances
-     * created with this factory
-     */
-    constructor(props: {
-        registryEntries: NamedFluidDataStoreRegistryEntries;
-        dependencyContainer?: IFluidDependencySynthesizer;
-        /** @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 */
-        requestHandlers?: RuntimeRequestHandler[];
-        runtimeOptions?: IContainerRuntimeOptions;
-        provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
-    });
+    constructor(props: BaseContainerRuntimeFactoryProps);
     instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
     instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
     preInitialize(context: IContainerContext, existing: boolean): Promise<ContainerRuntime>;
@@ -75,6 +63,35 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
     protected containerHasInitialized(runtime: IContainerRuntime): Promise<void>;
 }
 
+/**
+ * {@link BaseContainerRuntimeFactory} construction properties.
+ * @alpha
+ */
+export declare 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
+     */
+    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.
@@ -85,30 +102,43 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
 export declare class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory {
     static readonly defaultDataStoreId = "default";
     protected readonly defaultFactory: IFluidDataStoreFactory;
-    /**
-     * Constructor
-     * @param defaultFactory -
-     * @param registryEntries -
-     * @param dependencyContainer - deprecated, will be removed in a future release
-     * @param requestHandlers -
-     * @param runtimeOptions -
-     * @param provideEntryPoint -
-     */
-    constructor(props: {
-        defaultFactory: IFluidDataStoreFactory;
-        registryEntries: NamedFluidDataStoreRegistryEntries;
-        dependencyContainer?: IFluidDependencySynthesizer;
-        /** @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 */
-        requestHandlers?: RuntimeRequestHandler[];
-        runtimeOptions?: IContainerRuntimeOptions;
-        provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
-    });
+    constructor(props: ContainerRuntimeFactoryWithDefaultDataStoreProps);
     /**
      * {@inheritDoc BaseContainerRuntimeFactory.containerInitializingFirstTime}
      */
     protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
 }
 
+/**
+ * {@link ContainerRuntimeFactoryWithDefaultDataStore} construction properties.
+ * @alpha
+ */
+export declare 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
+     */
+    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>;
+}
+
 /**
  * DataObject is a base data store that is primed with a root directory. It
  * ensures that it is created and ready before you can access it.
@@ -159,15 +189,15 @@ export declare class DataObjectFactory<TObj extends DataObject<I>, I extends Dat
  */
 export declare interface DataObjectTypes {
     /**
-     * represents a type that will define optional providers that will be injected
+     * Represents a type that will define optional providers that will be injected.
      */
     OptionalProviders?: FluidObject;
     /**
-     * the initial state type that the produced data object may take during creation
+     * The initial state type that the produced data object may take during creation.
      */
     InitialState?: any;
     /**
-     * represents events that will be available in the EventForwarder
+     * Represents events that will be available in the EventForwarder.
      */
     Events?: IEvent;
 }
@@ -210,13 +240,19 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
     protected initProps?: I["InitialState"];
     protected initializeP: Promise<void> | undefined;
     get id(): string;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidLoadable.IFluidLoadable}
+     */
     get IFluidLoadable(): this;
+    /**
+     * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}
+     */
     get IFluidHandle(): IFluidHandle<this>;
     /**
      * Handle to a data store
      */
     get handle(): IFluidHandle<this>;
-    static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject<DataObjectTypes>>;
+    static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject>;
     constructor(props: IDataObjectProps<I>);
     /**
      * Return this object if someone requests it directly
@@ -283,7 +319,13 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
     private readonly sharedObjectRegistry;
     private readonly registry;
     constructor(type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory[], optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeClass?: typeof FluidDataStoreRuntime);
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreFactory.IFluidDataStoreFactory}
+     */
     get IFluidDataStoreFactory(): this;
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
+     */
     get IFluidDataStoreRegistry(): IFluidDataStoreRegistry | undefined;
     /**
      * Convenience helper to get the data store's/factory's data store registry entry.

package/lib/container-runtime-factories/baseContainerRuntimeFactory.d.mts

@@ -2,14 +2,42 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IContainerContext } from "@fluidframework/container-definitions";
-import { IContainerRuntimeOptions, ContainerRuntime } from "@fluidframework/container-runtime";
-import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
-import { RuntimeRequestHandler } from "@fluidframework/request-handler";
-import { IFluidDataStoreRegistry, IProvideFluidDataStoreRegistry, NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
-import { IFluidDependencySynthesizer } from "@fluidframework/synthesize";
+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 { FluidObject } from "@fluidframework/core-interfaces";
+import { type FluidObject } from "@fluidframework/core-interfaces";
+/**
+ * {@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
+     */
+    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.
@@ -17,6 +45,9 @@ import { FluidObject } from "@fluidframework/core-interfaces";
  * @alpha
  */
 export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper implements IProvideFluidDataStoreRegistry {
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
+     */
     get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
     private readonly registry;
     private readonly registryEntries;
@@ -24,22 +55,7 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
     private readonly runtimeOptions?;
     private readonly requestHandlers;
     private readonly provideEntryPoint;
-    /**
-     * @param registryEntries - The data store registry for containers produced
-     * @param dependencyContainer - deprecated, will be removed in a future release
-     * @param requestHandlers - Request handlers for containers produced
-     * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it
-     * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances
-     * created with this factory
-     */
-    constructor(props: {
-        registryEntries: NamedFluidDataStoreRegistryEntries;
-        dependencyContainer?: IFluidDependencySynthesizer;
-        /** @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 */
-        requestHandlers?: RuntimeRequestHandler[];
-        runtimeOptions?: IContainerRuntimeOptions;
-        provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
-    });
+    constructor(props: BaseContainerRuntimeFactoryProps);
     instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
     instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
     preInitialize(context: IContainerContext, existing: boolean): Promise<ContainerRuntime>;

package/lib/container-runtime-factories/baseContainerRuntimeFactory.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"baseContainerRuntimeFactory.d.mts","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,iBAAiB,EAAE,MAAM,uCAAuC;OAClE,EACN,wBAAwB,EAExB,gBAAgB,EAChB,MAAM,mCAAmC;OACnC,EAAE,iBAAiB,EAAE,MAAM,+CAA+C;OAE1E,EAAE,qBAAqB,EAA8B,MAAM,iCAAiC;OAC5F,EACN,uBAAuB,EACvB,8BAA8B,EAC9B,kCAAkC,EAClC,MAAM,qCAAqC;OACrC,EAEN,2BAA2B,EAE3B,MAAM,4BAA4B;OAC5B,EAAE,oBAAoB,EAAE,MAAM,+BAA+B;OAC7D,EAAE,WAAW,EAAE,MAAM,iCAAiC;AAE7D;;;;;GAKG;AACH,qBAAa,2BACZ,SAAQ,oBACR,YAAW,8BAA8B;IAEzC,IAAW,uBAAuB,4BAEjC;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;IAEzF;;;;;;;OAOG;gBACS,KAAK,EAAE;QAClB,eAAe,EAAE,kCAAkC,CAAC;QACpD,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;QAClD,sLAAsL;QACtL,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;QAC1C,cAAc,CAAC,EAAE,wBAAwB,CAAC;QAC1C,iBAAiB,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;KACxE;IAWY,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;IAEzE;;;;OAIG;cACa,uBAAuB,CAAC,OAAO,EAAE,iBAAiB;CAClE"}
+{"version":3,"file":"baseContainerRuntimeFactory.d.mts","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,KAAK,iBAAiB,EAAE,MAAM,uCAAuC;OACvE,EACN,KAAK,wBAAwB,EAE7B,gBAAgB,EAChB,MAAM,mCAAmC;OACnC,EAAE,KAAK,iBAAiB,EAAE,MAAM,+CAA+C;OAE/E,EACN,KAAK,qBAAqB,EAE1B,MAAM,iCAAiC;OACjC,EACN,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,kCAAkC,EACvC,MAAM,qCAAqC;OACrC,EAEN,KAAK,2BAA2B,EAEhC,MAAM,4BAA4B;OAC5B,EAAE,oBAAoB,EAAE,MAAM,+BAA+B;OAC7D,EAAE,KAAK,WAAW,EAAE,MAAM,iCAAiC;AAElE;;;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/lib/container-runtime-factories/baseContainerRuntimeFactory.mjs

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { FluidDataStoreRegistry, ContainerRuntime, } from "@fluidframework/container-runtime";
-import { buildRuntimeRequestHandler } from "@fluidframework/request-handler";
+import { buildRuntimeRequestHandler, } from "@fluidframework/request-handler";
 import { DependencyContainer, } from "@fluidframework/synthesize";
 import { RuntimeFactoryHelper } from "@fluidframework/runtime-utils";
 /**
@@ -13,17 +13,12 @@ import { RuntimeFactoryHelper } from "@fluidframework/runtime-utils";
  * @alpha
  */
 export class BaseContainerRuntimeFactory extends RuntimeFactoryHelper {
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
+     */
     get IFluidDataStoreRegistry() {
         return this.registry;
     }
-    /**
-     * @param registryEntries - The data store registry for containers produced
-     * @param dependencyContainer - deprecated, will be removed in a future release
-     * @param requestHandlers - Request handlers for containers produced
-     * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it
-     * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances
-     * created with this factory
-     */
     constructor(props) {
         super();
         this.registryEntries = props.registryEntries;

package/lib/container-runtime-factories/baseContainerRuntimeFactory.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"baseContainerRuntimeFactory.mjs","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAGI,EAEN,sBAAsB,EACtB,gBAAgB,GAChB,MAAM,mCAAmC;OAGnC,EAAyB,0BAA0B,EAAE,MAAM,iCAAiC;OAM5F,EACN,mBAAmB,GAGnB,MAAM,4BAA4B;OAC5B,EAAE,oBAAoB,EAAE,MAAM,+BAA+B;AAGpE;;;;;GAKG;AACH,MAAM,OAAO,2BACZ,SAAQ,oBAAoB;IAG5B,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IASD;;;;;;;OAOG;IACH,YAAY,KAOX;QACA,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAClE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAAyB;QAC1D,MAAM,IAAI,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAAC,OAAyB;QAC7D,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,aAAa,CACzB,OAA0B,EAC1B,QAAiB;QAEjB,MAAM,KAAK,GAAgD,OAAO,CAAC,KAAK,CAAC;QACzE,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC7B,MAAM,EAAE,GAAG,IAAI,mBAAmB,CACjC,IAAI,CAAC,mBAAmB,EACxB,KAAK,CAAC,2BAA2B,CACjC,CAAC;YACF,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC;SACvC;QAED,OAAO,gBAAgB,CAAC,WAAW,CAAC;YACnC,OAAO;YACP,QAAQ;YACR,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,cAAc,EAAE,KAAK;YACrB,gDAAgD;YAChD,cAAc,EAAE,0BAA0B,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;YACnE,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;SACzC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,8BAA8B,CAAC,OAA0B,IAAG,CAAC;IAE7E;;;;OAIG;IACO,KAAK,CAAC,uBAAuB,CAAC,OAA0B,IAAG,CAAC;CACtE","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IContainerContext } from \"@fluidframework/container-definitions\";\nimport {\n\tIContainerRuntimeOptions,\n\tFluidDataStoreRegistry,\n\tContainerRuntime,\n} from \"@fluidframework/container-runtime\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\n// eslint-disable-next-line import/no-deprecated\nimport { RuntimeRequestHandler, buildRuntimeRequestHandler } from \"@fluidframework/request-handler\";\nimport {\n\tIFluidDataStoreRegistry,\n\tIProvideFluidDataStoreRegistry,\n\tNamedFluidDataStoreRegistryEntries,\n} from \"@fluidframework/runtime-definitions\";\nimport {\n\tDependencyContainer,\n\tIFluidDependencySynthesizer,\n\tIProvideFluidDependencySynthesizer,\n} from \"@fluidframework/synthesize\";\nimport { RuntimeFactoryHelper } from \"@fluidframework/runtime-utils\";\nimport { FluidObject } from \"@fluidframework/core-interfaces\";\n\n/**\n * BaseContainerRuntimeFactory produces container runtimes with the specified data store and service registries,\n * request handlers, runtimeOptions, and entryPoint initialization function.\n * It can be subclassed to implement a first-time initialization procedure for the containers it creates.\n * @alpha\n */\nexport class BaseContainerRuntimeFactory\n\textends RuntimeFactoryHelper\n\timplements IProvideFluidDataStoreRegistry\n{\n\tpublic get IFluidDataStoreRegistry() {\n\t\treturn this.registry;\n\t}\n\tprivate readonly registry: IFluidDataStoreRegistry;\n\n\tprivate readonly registryEntries: NamedFluidDataStoreRegistryEntries;\n\tprivate readonly dependencyContainer?: IFluidDependencySynthesizer;\n\tprivate readonly runtimeOptions?: IContainerRuntimeOptions;\n\tprivate readonly requestHandlers: RuntimeRequestHandler[];\n\tprivate readonly provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;\n\n\t/**\n\t * @param registryEntries - The data store registry for containers produced\n\t * @param dependencyContainer - deprecated, will be removed in a future release\n\t * @param requestHandlers - Request handlers for containers produced\n\t * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it\n\t * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances\n\t * created with this factory\n\t */\n\tconstructor(props: {\n\t\tregistryEntries: NamedFluidDataStoreRegistryEntries;\n\t\tdependencyContainer?: IFluidDependencySynthesizer;\n\t\t/** @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 */\n\t\trequestHandlers?: RuntimeRequestHandler[];\n\t\truntimeOptions?: IContainerRuntimeOptions;\n\t\tprovideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;\n\t}) {\n\t\tsuper();\n\n\t\tthis.registryEntries = props.registryEntries;\n\t\tthis.dependencyContainer = props.dependencyContainer;\n\t\tthis.runtimeOptions = props.runtimeOptions;\n\t\tthis.provideEntryPoint = props.provideEntryPoint;\n\t\tthis.requestHandlers = props.requestHandlers ?? [];\n\t\tthis.registry = new FluidDataStoreRegistry(this.registryEntries);\n\t}\n\n\tpublic async instantiateFirstTime(runtime: ContainerRuntime): Promise<void> {\n\t\tawait this.containerInitializingFirstTime(runtime);\n\t\tawait this.containerHasInitialized(runtime);\n\t}\n\n\tpublic async instantiateFromExisting(runtime: ContainerRuntime): Promise<void> {\n\t\tawait this.containerHasInitialized(runtime);\n\t}\n\n\tpublic async preInitialize(\n\t\tcontext: IContainerContext,\n\t\texisting: boolean,\n\t): Promise<ContainerRuntime> {\n\t\tconst scope: Partial<IProvideFluidDependencySynthesizer> = context.scope;\n\t\tif (this.dependencyContainer) {\n\t\t\tconst dc = new DependencyContainer<FluidObject>(\n\t\t\t\tthis.dependencyContainer,\n\t\t\t\tscope.IFluidDependencySynthesizer,\n\t\t\t);\n\t\t\tscope.IFluidDependencySynthesizer = dc;\n\t\t}\n\n\t\treturn ContainerRuntime.loadRuntime({\n\t\t\tcontext,\n\t\t\texisting,\n\t\t\truntimeOptions: this.runtimeOptions,\n\t\t\tregistryEntries: this.registryEntries,\n\t\t\tcontainerScope: scope,\n\t\t\t// eslint-disable-next-line import/no-deprecated\n\t\t\trequestHandler: buildRuntimeRequestHandler(...this.requestHandlers),\n\t\t\tprovideEntryPoint: this.provideEntryPoint,\n\t\t});\n\t}\n\n\t/**\n\t * Subclasses may override containerInitializingFirstTime to perform any setup steps at the time the container\n\t * is created. This likely includes creating any initial data stores that are expected to be there at the outset.\n\t * @param runtime - The container runtime for the container being initialized\n\t */\n\tprotected async containerInitializingFirstTime(runtime: IContainerRuntime) {}\n\n\t/**\n\t * Subclasses may override containerHasInitialized to perform any steps after the container has initialized.\n\t * This likely includes loading any data stores that are expected to be there at the outset.\n\t * @param runtime - The container runtime for the container being initialized\n\t */\n\tprotected async containerHasInitialized(runtime: IContainerRuntime) {}\n}\n"]}
+{"version":3,"file":"baseContainerRuntimeFactory.mjs","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAGI,EAEN,sBAAsB,EACtB,gBAAgB,GAChB,MAAM,mCAAmC;OAGnC,EAEN,0BAA0B,GAC1B,MAAM,iCAAiC;OAMjC,EACN,mBAAmB,GAGnB,MAAM,4BAA4B;OAC5B,EAAE,oBAAoB,EAAE,MAAM,+BAA+B;AAgCpE;;;;;GAKG;AACH,MAAM,OAAO,2BACZ,SAAQ,oBAAoB;IAG5B;;OAEG;IACH,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IASD,YAAmB,KAAuC;QACzD,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAClE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAAyB;QAC1D,MAAM,IAAI,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAAC,OAAyB;QAC7D,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,aAAa,CACzB,OAA0B,EAC1B,QAAiB;QAEjB,MAAM,KAAK,GAAgD,OAAO,CAAC,KAAK,CAAC;QACzE,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC7B,MAAM,EAAE,GAAG,IAAI,mBAAmB,CACjC,IAAI,CAAC,mBAAmB,EACxB,KAAK,CAAC,2BAA2B,CACjC,CAAC;YACF,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC;SACvC;QAED,OAAO,gBAAgB,CAAC,WAAW,CAAC;YACnC,OAAO;YACP,QAAQ;YACR,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,cAAc,EAAE,KAAK;YACrB,gDAAgD;YAChD,cAAc,EAAE,0BAA0B,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;YACnE,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;SACzC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,8BAA8B,CAAC,OAA0B,IAAkB,CAAC;IAE5F;;;;OAIG;IACO,KAAK,CAAC,uBAAuB,CAAC,OAA0B,IAAkB,CAAC;CACrF","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type IContainerContext } from \"@fluidframework/container-definitions\";\nimport {\n\ttype IContainerRuntimeOptions,\n\tFluidDataStoreRegistry,\n\tContainerRuntime,\n} from \"@fluidframework/container-runtime\";\nimport { type IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\n// eslint-disable-next-line import/no-deprecated\nimport {\n\ttype RuntimeRequestHandler,\n\tbuildRuntimeRequestHandler,\n} from \"@fluidframework/request-handler\";\nimport {\n\ttype IFluidDataStoreRegistry,\n\ttype IProvideFluidDataStoreRegistry,\n\ttype NamedFluidDataStoreRegistryEntries,\n} from \"@fluidframework/runtime-definitions\";\nimport {\n\tDependencyContainer,\n\ttype IFluidDependencySynthesizer,\n\ttype IProvideFluidDependencySynthesizer,\n} from \"@fluidframework/synthesize\";\nimport { RuntimeFactoryHelper } from \"@fluidframework/runtime-utils\";\nimport { type FluidObject } from \"@fluidframework/core-interfaces\";\n\n/**\n * {@link BaseContainerRuntimeFactory} construction properties.\n * @alpha\n */\nexport interface BaseContainerRuntimeFactoryProps {\n\t/**\n\t * The data store registry for containers produced.\n\t */\n\tregistryEntries: NamedFluidDataStoreRegistryEntries;\n\t/**\n\t * @deprecated Will be removed in a future release.\n\t */\n\tdependencyContainer?: IFluidDependencySynthesizer;\n\t/**\n\t * Request handlers for containers produced.\n\t * @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\n\t */\n\trequestHandlers?: RuntimeRequestHandler[];\n\t/**\n\t * The runtime options passed to the ContainerRuntime when instantiating it\n\t */\n\truntimeOptions?: IContainerRuntimeOptions;\n\t/**\n\t * Function that will initialize the entryPoint of the ContainerRuntime instances\n\t * created with this factory\n\t */\n\tprovideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;\n}\n\n/**\n * BaseContainerRuntimeFactory produces container runtimes with the specified data store and service registries,\n * request handlers, runtimeOptions, and entryPoint initialization function.\n * It can be subclassed to implement a first-time initialization procedure for the containers it creates.\n * @alpha\n */\nexport class BaseContainerRuntimeFactory\n\textends RuntimeFactoryHelper\n\timplements IProvideFluidDataStoreRegistry\n{\n\t/**\n\t * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}\n\t */\n\tpublic get IFluidDataStoreRegistry(): IFluidDataStoreRegistry {\n\t\treturn this.registry;\n\t}\n\tprivate readonly registry: IFluidDataStoreRegistry;\n\n\tprivate readonly registryEntries: NamedFluidDataStoreRegistryEntries;\n\tprivate readonly dependencyContainer?: IFluidDependencySynthesizer;\n\tprivate readonly runtimeOptions?: IContainerRuntimeOptions;\n\tprivate readonly requestHandlers: RuntimeRequestHandler[];\n\tprivate readonly provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;\n\n\tpublic constructor(props: BaseContainerRuntimeFactoryProps) {\n\t\tsuper();\n\n\t\tthis.registryEntries = props.registryEntries;\n\t\tthis.dependencyContainer = props.dependencyContainer;\n\t\tthis.runtimeOptions = props.runtimeOptions;\n\t\tthis.provideEntryPoint = props.provideEntryPoint;\n\t\tthis.requestHandlers = props.requestHandlers ?? [];\n\t\tthis.registry = new FluidDataStoreRegistry(this.registryEntries);\n\t}\n\n\tpublic async instantiateFirstTime(runtime: ContainerRuntime): Promise<void> {\n\t\tawait this.containerInitializingFirstTime(runtime);\n\t\tawait this.containerHasInitialized(runtime);\n\t}\n\n\tpublic async instantiateFromExisting(runtime: ContainerRuntime): Promise<void> {\n\t\tawait this.containerHasInitialized(runtime);\n\t}\n\n\tpublic async preInitialize(\n\t\tcontext: IContainerContext,\n\t\texisting: boolean,\n\t): Promise<ContainerRuntime> {\n\t\tconst scope: Partial<IProvideFluidDependencySynthesizer> = context.scope;\n\t\tif (this.dependencyContainer) {\n\t\t\tconst dc = new DependencyContainer<FluidObject>(\n\t\t\t\tthis.dependencyContainer,\n\t\t\t\tscope.IFluidDependencySynthesizer,\n\t\t\t);\n\t\t\tscope.IFluidDependencySynthesizer = dc;\n\t\t}\n\n\t\treturn ContainerRuntime.loadRuntime({\n\t\t\tcontext,\n\t\t\texisting,\n\t\t\truntimeOptions: this.runtimeOptions,\n\t\t\tregistryEntries: this.registryEntries,\n\t\t\tcontainerScope: scope,\n\t\t\t// eslint-disable-next-line import/no-deprecated\n\t\t\trequestHandler: buildRuntimeRequestHandler(...this.requestHandlers),\n\t\t\tprovideEntryPoint: this.provideEntryPoint,\n\t\t});\n\t}\n\n\t/**\n\t * Subclasses may override containerInitializingFirstTime to perform any setup steps at the time the container\n\t * is created. This likely includes creating any initial data stores that are expected to be there at the outset.\n\t * @param runtime - The container runtime for the container being initialized\n\t */\n\tprotected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {}\n\n\t/**\n\t * Subclasses may override containerHasInitialized to perform any steps after the container has initialized.\n\t * This likely includes loading any data stores that are expected to be there at the outset.\n\t * @param runtime - The container runtime for the container being initialized\n\t */\n\tprotected async containerHasInitialized(runtime: IContainerRuntime): Promise<void> {}\n}\n"]}