@fluidframework/aqueduct 2.0.0-rc.1.0.6 → 2.0.0-rc.2.0.1

package/dist/aqueduct-alpha.d.ts

@@ -23,7 +23,9 @@ import { IContainerContext } from '@fluidframework/container-definitions';
 import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
 import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
 import { IContainerRuntimeOptions } from '@fluidframework/container-runtime';
+import { IDataStore } from '@fluidframework/runtime-definitions';
 import { IEvent } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
@@ -50,6 +52,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;
@@ -57,22 +62,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>;
@@ -90,6 +80,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.
@@ -100,30 +119,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.
@@ -165,7 +197,7 @@ export declare abstract class DataObject<I extends DataObjectTypes = DataObjectT
  * @alpha
  */
 export declare 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[] | undefined, optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeFactory?: typeof FluidDataStoreRuntime);
+    constructor(type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory<IFluidLoadable>[] | undefined, optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeFactory?: typeof FluidDataStoreRuntime);
 }
 
 /**
@@ -174,15 +206,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;
 }
@@ -225,13 +257,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
@@ -291,14 +329,27 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
  * @alpha
  */
 export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I extends DataObjectTypes = DataObjectTypes> implements IFluidDataStoreFactory, Partial<IProvideFluidDataStoreRegistry> {
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IFluidDataStoreFactory."type"}
+     */
     readonly type: string;
     private readonly ctor;
     private readonly optionalProviders;
     private readonly runtimeClass;
     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);
+    constructor(
+    /**
+     * {@inheritDoc @fluidframework/runtime-definitions#IFluidDataStoreFactory."type"}
+     */
+    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.
@@ -308,11 +359,9 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
      */
     get registryEntry(): NamedFluidDataStoreRegistryEntry;
     /**
-     * This is where we do data store setup.
-     *
-     * @param context - data store context used to load a data store runtime
+     * {@inheritDoc @fluidframework/runtime-definitions#IFluidDataStoreFactory.instantiateDataStore}
      */
-    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;
     /**
      * Creates a new instance of the object. Uses parent context's registry to build package path to this factory.
      * In other words, registry of context passed in has to contain this factory, with the name that matches
@@ -321,10 +370,11 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
      * @param context - The context being used to create the runtime
      * (the created object will have its own new context created as well)
      * @param initialState - The initial state to provide to the created data store.
+     * @param loadingGroupId - NOT production ready, EXPERIMENTAL, please read {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}. The service needs to support this feature, does not work for most services
      * @returns an object created by this factory. Data store and objects created are not attached to container.
      * They get attached only when a handle to one of them is attached to already attached objects.
      */
-    createChildInstance(parentContext: IFluidDataStoreContext, initialState?: I["InitialState"]): Promise<TObj>;
+    createChildInstance(parentContext: IFluidDataStoreContext, initialState?: I["InitialState"], loadingGroupId?: string): Promise<TObj>;
     /**
      * Creates a new instance of the object. Uses peer context's registry and its package path to identify this factory.
      * In other words, registry of context passed in has to have this factory.
@@ -332,10 +382,11 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
      * @param context - The component context being used to create the object
      * (the created object will have its own new context created as well)
      * @param initialState - The initial state to provide to the created component.
+     * @param loadingGroupId - NOT production ready, EXPERIMENTAL, please read {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}. The service needs to support this feature, does not work for most services
      * @returns an object created by this factory. Data store and objects created are not attached to container.
      * They get attached only when a handle to one of them is attached to already attached objects.
      */
-    createPeerInstance(peerContext: IFluidDataStoreContext, initialState?: I["InitialState"]): Promise<TObj>;
+    createPeerInstance(peerContext: IFluidDataStoreContext, initialState?: I["InitialState"], loadingGroupId?: string): Promise<TObj>;
     /**
      * Creates a new instance of the object. Uses container's registry to find this factory.
      * It's expected that only container owners would use this functionality, as only such developers
@@ -343,10 +394,24 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
      * The name in this registry for such record should match type of this factory.
      * @param runtime - container runtime. It's registry is used to create an object.
      * @param initialState - The initial state to provide to the created component.
+     * @param loadingGroupId - NOT production ready, EXPERIMENTAL, please read {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}. The service needs to support this feature, does not work for most services
      * @returns an object created by this factory. Data store and objects created are not attached to container.
      * They get attached only when a handle to one of them is attached to already attached objects.
      */
-    createInstance(runtime: IContainerRuntimeBase, initialState?: I["InitialState"]): Promise<TObj>;
+    createInstance(runtime: IContainerRuntimeBase, initialState?: I["InitialState"], loadingGroupId?: string): Promise<TObj>;
+    /**
+     * Creates a new instance of the object with a datastore which exposes the aliasing api.
+     * @param runtime - container runtime. It is the runtime that will be used to create the object. It will produce
+     * the underlying infrastructure to get the data object to operate.
+     * @param initialState - The initial state to provide to the created component.
+     * @param packagePath - The path to the data store factory to use to create the data object.
+     * @param loadingGroupId - NOT production ready, EXPERIMENTAL, please read {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}. The service needs to support this feature, does not work for most services
+     * @returns an array containing the object created by this factory and an IDataStore object that enables users to
+     * alias the data object.
+     * The data object is attached only when it is attached to the handle graph that connects to an aliased object or
+     * when the data object is aliased.
+     */
+    createInstanceWithDataStore(containerRuntime: IContainerRuntimeBase, initialState?: I["InitialState"], packagePath?: Readonly<string[]>, loadingGroupId?: string): Promise<[TObj, IDataStore]>;
     /**
      * Creates a new root instance of the object. Uses container's registry to find this factory.
      * It's expected that only container owners would use this functionality, as only such developers
@@ -356,9 +421,12 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
      * @param initialState - The initial state to provide to the created component.
      * @returns an object created by this factory. Data store and objects created are not attached to container.
      * They get attached only when a handle to one of them is attached to already attached objects.
+     *
+     * @deprecated - the issue is that it does not allow the customer to decide the conflict resolution policy when an
+     * aliasing conflict occurs. Use {@link PureDataObjectFactory.createInstanceWithDataStore} instead.
      */
     createRootInstance(rootDataStoreId: string, runtime: IContainerRuntime, initialState?: I["InitialState"]): Promise<TObj>;
-    protected createNonRootInstanceCore(containerRuntime: IContainerRuntimeBase, packagePath: Readonly<string[]>, initialState?: I["InitialState"]): Promise<TObj>;
+    protected createNonRootInstanceCore(containerRuntime: IContainerRuntimeBase, packagePath: Readonly<string[]>, initialState?: I["InitialState"], loadingGroupId?: string): Promise<TObj>;
     protected createInstanceCore(context: IFluidDataStoreContextDetached, initialState?: I["InitialState"]): Promise<TObj>;
 }
 

package/dist/aqueduct-beta.d.ts

@@ -23,7 +23,9 @@ import { IContainerContext } from '@fluidframework/container-definitions';
 import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
 import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
 import { IContainerRuntimeOptions } from '@fluidframework/container-runtime';
+import { IDataStore } from '@fluidframework/runtime-definitions';
 import { IEvent } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
@@ -47,10 +49,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 */
@@ -71,6 +77,10 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: IDataObjectProps */
 
+/* Excluded from this release type: IDataStore */
+
+/* Excluded from this release type: IFluidDataStoreChannel */
+
 /* Excluded from this release type: IFluidDataStoreContext */
 
 /* Excluded from this release type: IFluidDataStoreContextDetached */

package/dist/aqueduct-public.d.ts

@@ -23,7 +23,9 @@ import { IContainerContext } from '@fluidframework/container-definitions';
 import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
 import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
 import { IContainerRuntimeOptions } from '@fluidframework/container-runtime';
+import { IDataStore } from '@fluidframework/runtime-definitions';
 import { IEvent } from '@fluidframework/core-interfaces';
+import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreContextDetached } from '@fluidframework/runtime-definitions';
 import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
@@ -47,10 +49,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 */
@@ -71,6 +77,10 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /* Excluded from this release type: IDataObjectProps */
 
+/* Excluded from this release type: IDataStore */
+
+/* Excluded from this release type: IFluidDataStoreChannel */
+
 /* Excluded from this release type: IFluidDataStoreContext */
 
 /* Excluded from this release type: IFluidDataStoreContextDetached */