@fluidframework/aqueduct 0.52.0 → 0.54.0-47413

package/dist/data-object-factories/dataObjectFactory.d.ts

@@ -2,14 +2,28 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IEvent } from "@fluidframework/common-definitions";
 import { NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
 import { IChannelFactory } from "@fluidframework/datastore-definitions";
 import { FluidObjectSymbolProvider } from "@fluidframework/synthesize";
 import { FluidDataStoreRuntime } from "@fluidframework/datastore";
-import { DataObject, IDataObjectProps } from "../data-objects";
+import { IEvent } from "@fluidframework/common-definitions";
+import { DataObject, DataObjectTypes, DataObjectType, IDataObjectProps, LegacyDataObject } from "../data-objects";
 import { PureDataObjectFactory } from "./pureDataObjectFactory";
 /**
+ * DataObjectFactory is the IFluidDataStoreFactory for use with DataObjects.
+ * It facilitates DataObject's features (such as its shared directory) by
+ * ensuring relevant shared objects etc are available to the factory.
+ *
+ * @typeParam TObj - DataObject (concrete type)
+ * @typeParam I - The input types for the DataObject
+ */
+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<DataObjectType<I, "OptionalProviders">>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeFactory?: typeof FluidDataStoreRuntime);
+}
+/**
+ * @deprecated - This type is meant to ease the transition from the old PureDataObjectFactory type to the new.
+ * please migrate to PureDataObjectFactory.
+ *
  * DataObjectFactory is the IFluidDataStoreFactory for use with DataObjects.
  * It facilitates DataObject's features (such as its shared directory) by
  * ensuring relevant shared objects etc are available to the factory.
@@ -19,7 +33,10 @@ import { PureDataObjectFactory } from "./pureDataObjectFactory";
  * @typeParam S - the initial state type that the produced data object may take during creation
  * @typeParam E - represents events that will be available in the EventForwarder
  */
-export declare class DataObjectFactory<TObj extends DataObject<O, S, E>, O, S, E extends IEvent = IEvent> extends PureDataObjectFactory<TObj, O, S, E> {
-    constructor(type: string, ctor: new (props: IDataObjectProps<O, S>) => TObj, sharedObjects: readonly IChannelFactory[] | undefined, optionalProviders: FluidObjectSymbolProvider<O>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeFactory?: typeof FluidDataStoreRuntime);
+export declare class LegacyDataObjectFactory<TObj extends LegacyDataObject<O, S, E>, O, S, E extends IEvent = IEvent> extends DataObjectFactory<TObj, {
+    OptionalProviders: O;
+    InitialState: S;
+    Events: E;
+}> {
 }
 //# sourceMappingURL=dataObjectFactory.d.ts.map

package/dist/data-object-factories/dataObjectFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataObjectFactory.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/dataObjectFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EACH,kCAAkC,EACrC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAElE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;;;;;GASG;AACH,qBAAa,iBAAiB,CAAC,IAAI,SAAS,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CAC5F,SAAQ,qBAAqB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAGxC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,KAAK,KAAK,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,EACjD,aAAa,wCAAiC,EAC9C,iBAAiB,EAAE,yBAAyB,CAAC,CAAC,CAAC,EAC/C,eAAe,CAAC,EAAE,kCAAkC,EACpD,cAAc,GAAE,OAAO,qBAA6C;CAwB3E"}
+{"version":3,"file":"dataObjectFactory.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/dataObjectFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EACH,kCAAkC,EACrC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAElE,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,gBAAgB,EAAG,MAAM,iBAAiB,CAAC;AACnH,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;;;GAOG;AACH,qBAAa,iBAAiB,CAAC,IAAI,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,eAAe,GAAG,eAAe,CAClG,SAAQ,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;gBAGlC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,KAAK,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,IAAI,EAC9C,aAAa,wCAAiC,EAC9C,iBAAiB,EAAE,yBAAyB,CAAC,cAAc,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,EACpF,eAAe,CAAC,EAAE,kCAAkC,EACpD,cAAc,GAAE,OAAO,qBAA6C;CAwB3E;AAED;;;;;;;;;;;;GAYG;AACF,qBAAa,uBAAuB,CAAC,IAAI,SAAS,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CAC5G,SAAQ,iBAAiB,CAAC,IAAI,EAAE;IAAC,iBAAiB,EAAE,CAAC,CAAC;IAAC,YAAY,EAAE,CAAC,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAC,CAAC;CAAG"}

package/dist/data-object-factories/dataObjectFactory.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataObjectFactory = void 0;
+exports.LegacyDataObjectFactory = exports.DataObjectFactory = void 0;
 const map_1 = require("@fluidframework/map");
 const datastore_1 = require("@fluidframework/datastore");
 const pureDataObjectFactory_1 = require("./pureDataObjectFactory");
@@ -14,9 +14,7 @@ const pureDataObjectFactory_1 = require("./pureDataObjectFactory");
  * ensuring relevant shared objects etc are available to the factory.
  *
  * @typeParam TObj - DataObject (concrete type)
- * @typeParam O - represents a type that will define optional providers that will be injected
- * @typeParam S - the initial state type that the produced data object may take during creation
- * @typeParam E - represents events that will be available in the EventForwarder
+ * @typeParam I - The input types for the DataObject
  */
 class DataObjectFactory extends pureDataObjectFactory_1.PureDataObjectFactory {
     constructor(type, ctor, sharedObjects = [], optionalProviders, registryEntries, runtimeFactory = datastore_1.FluidDataStoreRuntime) {
@@ -34,4 +32,20 @@ class DataObjectFactory extends pureDataObjectFactory_1.PureDataObjectFactory {
     }
 }
 exports.DataObjectFactory = DataObjectFactory;
+/**
+ * @deprecated - This type is meant to ease the transition from the old PureDataObjectFactory type to the new.
+ * please migrate to PureDataObjectFactory.
+ *
+ * DataObjectFactory is the IFluidDataStoreFactory for use with DataObjects.
+ * It facilitates DataObject's features (such as its shared directory) by
+ * ensuring relevant shared objects etc are available to the factory.
+ *
+ * @typeParam TObj - DataObject (concrete type)
+ * @typeParam O - represents a type that will define optional providers that will be injected
+ * @typeParam S - the initial state type that the produced data object may take during creation
+ * @typeParam E - represents events that will be available in the EventForwarder
+ */
+class LegacyDataObjectFactory extends DataObjectFactory {
+}
+exports.LegacyDataObjectFactory = LegacyDataObjectFactory;
 //# sourceMappingURL=dataObjectFactory.js.map

package/dist/data-object-factories/dataObjectFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataObjectFactory.js","sourceRoot":"","sources":["../../src/data-object-factories/dataObjectFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6CAK6B;AAO7B,yDAAkE;AAGlE,mEAAgE;AAEhE;;;;;;;;;GASG;AACH,MAAa,iBACT,SAAQ,6CAAoC;IAE5C,YACI,IAAY,EACZ,IAAiD,EACjD,gBAA4C,EAAE,EAC9C,iBAA+C,EAC/C,eAAoD,EACpD,iBAA+C,iCAAqB;QAEpE,MAAM,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC;QAEzC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,sBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1E,sCAAsC;YACtC,aAAa,CAAC,IAAI,CAAC,qBAAe,CAAC,UAAU,EAAE,CAAC,CAAC;SACpD;QAED,0GAA0G;QAC1G,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,gBAAU,CAAC,IAAI,CAAC,EAAE;YACpE,gCAAgC;YAChC,aAAa,CAAC,IAAI,CAAC,eAAS,CAAC,UAAU,EAAE,CAAC,CAAC;SAC9C;QAED,KAAK,CACD,IAAI,EACJ,IAAI,EACJ,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,cAAc,CACjB,CAAC;IACN,CAAC;CACJ;AAjCD,8CAiCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    DirectoryFactory,\n    MapFactory,\n    SharedDirectory,\n    SharedMap,\n} from \"@fluidframework/map\";\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport {\n    NamedFluidDataStoreRegistryEntries,\n} from \"@fluidframework/runtime-definitions\";\nimport { IChannelFactory } from \"@fluidframework/datastore-definitions\";\nimport { FluidObjectSymbolProvider } from \"@fluidframework/synthesize\";\nimport { FluidDataStoreRuntime } from \"@fluidframework/datastore\";\n\nimport { DataObject, IDataObjectProps } from \"../data-objects\";\nimport { PureDataObjectFactory } from \"./pureDataObjectFactory\";\n\n/**\n * DataObjectFactory is the IFluidDataStoreFactory for use with DataObjects.\n * It facilitates DataObject's features (such as its shared directory) by\n * ensuring relevant shared objects etc are available to the factory.\n *\n * @typeParam TObj - DataObject (concrete type)\n * @typeParam O - represents a type that will define optional providers that will be injected\n * @typeParam S - the initial state type that the produced data object may take during creation\n * @typeParam E - represents events that will be available in the EventForwarder\n */\nexport class DataObjectFactory<TObj extends DataObject<O, S, E>, O, S, E extends IEvent = IEvent>\n    extends PureDataObjectFactory<TObj, O, S, E>\n{\n    constructor(\n        type: string,\n        ctor: new (props: IDataObjectProps<O, S>) => TObj,\n        sharedObjects: readonly IChannelFactory[] = [],\n        optionalProviders: FluidObjectSymbolProvider<O>,\n        registryEntries?: NamedFluidDataStoreRegistryEntries,\n        runtimeFactory: typeof FluidDataStoreRuntime = FluidDataStoreRuntime,\n    ) {\n        const mergedObjects = [...sharedObjects];\n\n        if (!sharedObjects.find((factory) => factory.type === DirectoryFactory.Type)) {\n            // User did not register for directory\n            mergedObjects.push(SharedDirectory.getFactory());\n        }\n\n        // TODO: Remove SharedMap factory when compatibility with SharedMap DataObject is no longer needed in 0.10\n        if (!sharedObjects.find((factory) => factory.type === MapFactory.Type)) {\n            // User did not register for map\n            mergedObjects.push(SharedMap.getFactory());\n        }\n\n        super(\n            type,\n            ctor,\n            mergedObjects,\n            optionalProviders,\n            registryEntries,\n            runtimeFactory,\n        );\n    }\n}\n"]}
+{"version":3,"file":"dataObjectFactory.js","sourceRoot":"","sources":["../../src/data-object-factories/dataObjectFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6CAK6B;AAM7B,yDAAkE;AAIlE,mEAAgE;AAEhE;;;;;;;GAOG;AACH,MAAa,iBACT,SAAQ,6CAA8B;IAEtC,YACI,IAAY,EACZ,IAA8C,EAC9C,gBAA4C,EAAE,EAC9C,iBAAoF,EACpF,eAAoD,EACpD,iBAA+C,iCAAqB;QAEpE,MAAM,aAAa,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC;QAEzC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,sBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1E,sCAAsC;YACtC,aAAa,CAAC,IAAI,CAAC,qBAAe,CAAC,UAAU,EAAE,CAAC,CAAC;SACpD;QAED,0GAA0G;QAC1G,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,gBAAU,CAAC,IAAI,CAAC,EAAE;YACpE,gCAAgC;YAChC,aAAa,CAAC,IAAI,CAAC,eAAS,CAAC,UAAU,EAAE,CAAC,CAAC;SAC9C;QAED,KAAK,CACD,IAAI,EACJ,IAAI,EACJ,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,cAAc,CACjB,CAAC;IACN,CAAC;CACJ;AAjCD,8CAiCC;AAED;;;;;;;;;;;;GAYG;AACF,MAAa,uBACb,SAAQ,iBAA2E;CAAG;AADtF,0DACsF","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    DirectoryFactory,\n    MapFactory,\n    SharedDirectory,\n    SharedMap,\n} from \"@fluidframework/map\";\nimport {\n    NamedFluidDataStoreRegistryEntries,\n} from \"@fluidframework/runtime-definitions\";\nimport { IChannelFactory } from \"@fluidframework/datastore-definitions\";\nimport { FluidObjectSymbolProvider } from \"@fluidframework/synthesize\";\nimport { FluidDataStoreRuntime } from \"@fluidframework/datastore\";\n\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { DataObject, DataObjectTypes, DataObjectType, IDataObjectProps, LegacyDataObject  } from \"../data-objects\";\nimport { PureDataObjectFactory } from \"./pureDataObjectFactory\";\n\n/**\n * DataObjectFactory is the IFluidDataStoreFactory for use with DataObjects.\n * It facilitates DataObject's features (such as its shared directory) by\n * ensuring relevant shared objects etc are available to the factory.\n *\n * @typeParam TObj - DataObject (concrete type)\n * @typeParam I - The input types for the DataObject\n */\nexport class DataObjectFactory<TObj extends DataObject<I>, I extends DataObjectTypes = DataObjectTypes>\n    extends PureDataObjectFactory<TObj, I>\n{\n    constructor(\n        type: string,\n        ctor: new (props: IDataObjectProps<I>) => TObj,\n        sharedObjects: readonly IChannelFactory[] = [],\n        optionalProviders: FluidObjectSymbolProvider<DataObjectType<I, \"OptionalProviders\">>,\n        registryEntries?: NamedFluidDataStoreRegistryEntries,\n        runtimeFactory: typeof FluidDataStoreRuntime = FluidDataStoreRuntime,\n    ) {\n        const mergedObjects = [...sharedObjects];\n\n        if (!sharedObjects.find((factory) => factory.type === DirectoryFactory.Type)) {\n            // User did not register for directory\n            mergedObjects.push(SharedDirectory.getFactory());\n        }\n\n        // TODO: Remove SharedMap factory when compatibility with SharedMap DataObject is no longer needed in 0.10\n        if (!sharedObjects.find((factory) => factory.type === MapFactory.Type)) {\n            // User did not register for map\n            mergedObjects.push(SharedMap.getFactory());\n        }\n\n        super(\n            type,\n            ctor,\n            mergedObjects,\n            optionalProviders,\n            registryEntries,\n            runtimeFactory,\n        );\n    }\n}\n\n/**\n * @deprecated - This type is meant to ease the transition from the old PureDataObjectFactory type to the new.\n * please migrate to PureDataObjectFactory.\n *\n * DataObjectFactory is the IFluidDataStoreFactory for use with DataObjects.\n * It facilitates DataObject's features (such as its shared directory) by\n * ensuring relevant shared objects etc are available to the factory.\n *\n * @typeParam TObj - DataObject (concrete type)\n * @typeParam O - represents a type that will define optional providers that will be injected\n * @typeParam S - the initial state type that the produced data object may take during creation\n * @typeParam E - represents events that will be available in the EventForwarder\n */\n export class LegacyDataObjectFactory<TObj extends LegacyDataObject<O, S, E>, O, S, E extends IEvent = IEvent>\n extends DataObjectFactory<TObj, {OptionalProviders: O, InitialState: S, Events: E}> {}\n"]}

package/dist/data-object-factories/pureDataObjectFactory.d.ts

@@ -4,12 +4,12 @@
  */
 import { IFluidRouter } from "@fluidframework/core-interfaces";
 import { FluidDataStoreRuntime } from "@fluidframework/datastore";
-import { IEvent } from "@fluidframework/common-definitions";
 import { IFluidDataStoreContext, IContainerRuntimeBase, IFluidDataStoreFactory, IFluidDataStoreRegistry, IProvideFluidDataStoreRegistry, NamedFluidDataStoreRegistryEntries, NamedFluidDataStoreRegistryEntry, IFluidDataStoreContextDetached } from "@fluidframework/runtime-definitions";
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
 import { IChannelFactory } from "@fluidframework/datastore-definitions";
 import { FluidObjectSymbolProvider } from "@fluidframework/synthesize";
-import { IDataObjectProps, PureDataObject } from "../data-objects";
+import { IEvent } from "@fluidframework/common-definitions";
+import { IDataObjectProps, PureDataObject, DataObjectType, DataObjectTypes, LegacyPureDataObject } from "../data-objects";
 export interface IRootDataObjectFactory extends IFluidDataStoreFactory {
     createRootInstance(rootDataStoreId: string, runtime: IContainerRuntime): Promise<IFluidRouter>;
 }
@@ -19,18 +19,16 @@ export interface IRootDataObjectFactory extends IFluidDataStoreFactory {
  * another base data store factory.
  *
  * @typeParam TObj - DataObject (concrete type)
- * @typeParam O - represents a type that will define optional providers that will be injected
- * @typeParam S - the initial state type that the produced data object may take during creation
- * @typeParam E - represents events that will be available in the EventForwarder
+ * @typeParam I - The input types for the DataObject
  */
-export declare class PureDataObjectFactory<TObj extends PureDataObject<O, S, E>, O, S, E extends IEvent = IEvent> implements IFluidDataStoreFactory, Partial<IProvideFluidDataStoreRegistry>, IRootDataObjectFactory {
+export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I extends DataObjectTypes = DataObjectTypes> implements IFluidDataStoreFactory, Partial<IProvideFluidDataStoreRegistry>, IRootDataObjectFactory {
     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<O, S>) => TObj, sharedObjects: readonly IChannelFactory[], optionalProviders: FluidObjectSymbolProvider<O>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeClass?: typeof FluidDataStoreRuntime);
+    constructor(type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory[], optionalProviders: FluidObjectSymbolProvider<DataObjectType<I, "OptionalProviders">>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeClass?: typeof FluidDataStoreRuntime);
     get IFluidDataStoreFactory(): this;
     get IFluidDataStoreRegistry(): IFluidDataStoreRegistry | undefined;
     /**
@@ -57,7 +55,7 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<O, S, E>,
      * @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?: S): Promise<TObj>;
+    createChildInstance(parentContext: IFluidDataStoreContext, initialState?: DataObjectType<I, "InitialState">): 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.
@@ -68,7 +66,7 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<O, S, E>,
      * @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?: S): Promise<TObj>;
+    createPeerInstance(peerContext: IFluidDataStoreContext, initialState?: DataObjectType<I, "InitialState">): 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
@@ -79,7 +77,7 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<O, S, E>,
      * @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?: S): Promise<TObj>;
+    createInstance(runtime: IContainerRuntimeBase, initialState?: DataObjectType<I, "InitialState">): Promise<TObj>;
     /**
      * 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
@@ -90,8 +88,27 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<O, S, E>,
      * @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.
      */
-    createRootInstance(rootDataStoreId: string, runtime: IContainerRuntime, initialState?: S): Promise<TObj>;
-    protected createNonRootInstanceCore(containerRuntime: IContainerRuntimeBase, packagePath: Readonly<string[]>, initialState?: S): Promise<TObj>;
-    protected createInstanceCore(context: IFluidDataStoreContextDetached, initialState?: S): Promise<TObj>;
+    createRootInstance(rootDataStoreId: string, runtime: IContainerRuntime, initialState?: DataObjectType<I, "InitialState">): Promise<TObj>;
+    protected createNonRootInstanceCore(containerRuntime: IContainerRuntimeBase, packagePath: Readonly<string[]>, initialState?: DataObjectType<I, "InitialState">): Promise<TObj>;
+    protected createInstanceCore(context: IFluidDataStoreContextDetached, initialState?: DataObjectType<I, "InitialState">): Promise<TObj>;
+}
+/**
+ * @deprecated - This type is meant to ease the transition from the old PureDataObjectFactory type to the new.
+ * please migrate to PureDataObjectFactory.
+ *
+ * PureDataObjectFactory is a barebones IFluidDataStoreFactory for use with PureDataObject.
+ * Consumers should typically use DataObjectFactory instead unless creating
+ * another base data store factory.
+ *
+ * @typeParam TObj - DataObject (concrete type)
+ * @typeParam O - represents a type that will define optional providers that will be injected
+ * @typeParam S - the initial state type that the produced data object may take during creation
+ * @typeParam E - represents events that will be available in the EventForwarder
+ */
+export declare class LegacyPureDataObjectFactory<TObj extends LegacyPureDataObject<O, S, E>, O, S, E extends IEvent = IEvent> extends PureDataObjectFactory<TObj, {
+    OptionalProviders: O;
+    InitialState: S;
+    Events: E;
+}> {
 }
 //# sourceMappingURL=pureDataObjectFactory.d.ts.map

package/dist/data-object-factories/pureDataObjectFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pureDataObjectFactory.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/pureDataObjectFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAY,YAAY,EAAe,MAAM,iCAAiC,CAAC;AACtF,OAAO,EACH,qBAAqB,EAGvB,MAAM,2BAA2B,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAE5D,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,EAChC,8BAA8B,EACjC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EACH,yBAAyB,EAG5B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACH,gBAAgB,EAChB,cAAc,EACjB,MAAM,iBAAiB,CAAC;AAKzB,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;IAClE,kBAAkB,CACd,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1D;AA0DD;;;;;;;;;GASG;AACH,qBAAa,qBAAqB,CAAC,IAAI,SAAS,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CACpG,YAAW,sBAAsB,EAAE,OAAO,CAAC,8BAA8B,CAAC,EAAE,sBAAsB;aAM9E,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,IAAI;IAErB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAElC,OAAO,CAAC,QAAQ,CAAC,YAAY;IATjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAwB;IAC7D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsC;gBAG3C,IAAI,EAAE,MAAM,EACX,IAAI,EAAE,KAAK,KAAK,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,EAClE,aAAa,EAAE,SAAS,eAAe,EAAE,EACxB,iBAAiB,EAAE,yBAAyB,CAAC,CAAC,CAAC,EAChE,eAAe,CAAC,EAAE,kCAAkC,EACnC,YAAY,GAAE,OAAO,qBAA6C;IAWvF,IAAW,sBAAsB,SAAmB;IAEpD,IAAW,uBAAuB,wCAEjC;IAED;;;;;OAKG;IACH,IAAW,aAAa,IAAI,gCAAgC,CAE3D;IAED;;;;OAIG;IACU,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,OAAO;IAYpF;;;;;;;;;;OAUG;IACU,mBAAmB,CAC5B,aAAa,EAAE,sBAAsB,EACrC,YAAY,CAAC,EAAE,CAAC,GACjB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;;OASG;IACU,kBAAkB,CAC3B,WAAW,EAAE,sBAAsB,EACnC,YAAY,CAAC,EAAE,CAAC,GACjB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;;OASG;IACU,cAAc,CACvB,OAAO,EAAE,qBAAqB,EAC9B,YAAY,CAAC,EAAE,CAAC,GACjB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;;OASG;IACU,kBAAkB,CAC3B,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB,EAC1B,YAAY,CAAC,EAAE,CAAC,GACjB,OAAO,CAAC,IAAI,CAAC;cAKA,yBAAyB,CACrC,gBAAgB,EAAE,qBAAqB,EACvC,WAAW,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAC/B,YAAY,CAAC,EAAE,CAAC,GACjB,OAAO,CAAC,IAAI,CAAC;cAKA,kBAAkB,CAC9B,OAAO,EAAE,8BAA8B,EACvC,YAAY,CAAC,EAAE,CAAC,GACjB,OAAO,CAAC,IAAI,CAAC;CAcnB"}
+{"version":3,"file":"pureDataObjectFactory.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/pureDataObjectFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAY,YAAY,EAAe,MAAM,iCAAiC,CAAC;AACtF,OAAO,EACH,qBAAqB,EAGvB,MAAM,2BAA2B,CAAC;AAEpC,OAAO,EACH,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,EAChC,8BAA8B,EACjC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EACH,yBAAyB,EAG5B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EACH,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,eAAe,EACf,oBAAoB,EACvB,MAAM,iBAAiB,CAAC;AAIzB,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;IAClE,kBAAkB,CACd,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC1D;AA0DD;;;;;;;GAOG;AACH,qBAAa,qBAAqB,CAAC,IAAI,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,eAAe,GAAG,eAAe,CAC1G,YAAW,sBAAsB,EAAE,OAAO,CAAC,8BAA8B,CAAC,EAAE,sBAAsB;aAM9E,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,IAAI;IAErB,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAElC,OAAO,CAAC,QAAQ,CAAC,YAAY;IATjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAwB;IAC7D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsC;gBAG3C,IAAI,EAAE,MAAM,EACX,IAAI,EAAE,KAAK,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,IAAI,EAC/D,aAAa,EAAE,SAAS,eAAe,EAAE,EACxB,iBAAiB,EAAE,yBAAyB,CAAC,cAAc,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,EACrG,eAAe,CAAC,EAAE,kCAAkC,EACnC,YAAY,GAAE,OAAO,qBAA6C;IAWvF,IAAW,sBAAsB,SAAmB;IAEpD,IAAW,uBAAuB,wCAEjC;IAED;;;;;OAKG;IACH,IAAW,aAAa,IAAI,gCAAgC,CAE3D;IAED;;;;OAIG;IACU,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,OAAO;IAYpF;;;;;;;;;;OAUG;IACU,mBAAmB,CAC5B,aAAa,EAAE,sBAAsB,EACrC,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;;OASG;IACU,kBAAkB,CAC3B,WAAW,EAAE,sBAAsB,EACnC,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;;OASG;IACU,cAAc,CACvB,OAAO,EAAE,qBAAqB,EAC9B,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;;OASG;IACU,kBAAkB,CAC3B,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,iBAAiB,EAC1B,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC;cAKA,yBAAyB,CACrC,gBAAgB,EAAE,qBAAqB,EACvC,WAAW,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAC/B,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC;cAKA,kBAAkB,CAC9B,OAAO,EAAE,8BAA8B,EACvC,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC;CAcnB;AAED;;;;;;;;;;;;GAYG;AACF,qBAAa,2BAA2B,CAAC,IAAI,SAAS,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CACpH,SAAQ,qBAAqB,CAAC,IAAI,EAAC;IAAC,iBAAiB,EAAE,CAAC,CAAC;IAAC,YAAY,EAAE,CAAC,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAC,CAAC;CAAG"}

package/dist/data-object-factories/pureDataObjectFactory.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PureDataObjectFactory = void 0;
+exports.LegacyPureDataObjectFactory = exports.PureDataObjectFactory = void 0;
 const datastore_1 = require("@fluidframework/datastore");
 const container_runtime_1 = require("@fluidframework/container-runtime");
 const synthesize_1 = require("@fluidframework/synthesize");
@@ -50,9 +50,7 @@ async function createDataObject(ctor, context, sharedObjectRegistry, optionalPro
  * another base data store factory.
  *
  * @typeParam TObj - DataObject (concrete type)
- * @typeParam O - represents a type that will define optional providers that will be injected
- * @typeParam S - the initial state type that the produced data object may take during creation
- * @typeParam E - represents events that will be available in the EventForwarder
+ * @typeParam I - The input types for the DataObject
  */
 class PureDataObjectFactory {
     constructor(type, ctor, sharedObjects, optionalProviders, registryEntries, runtimeClass = datastore_1.FluidDataStoreRuntime) {
@@ -156,4 +154,20 @@ class PureDataObjectFactory {
     }
 }
 exports.PureDataObjectFactory = PureDataObjectFactory;
+/**
+ * @deprecated - This type is meant to ease the transition from the old PureDataObjectFactory type to the new.
+ * please migrate to PureDataObjectFactory.
+ *
+ * PureDataObjectFactory is a barebones IFluidDataStoreFactory for use with PureDataObject.
+ * Consumers should typically use DataObjectFactory instead unless creating
+ * another base data store factory.
+ *
+ * @typeParam TObj - DataObject (concrete type)
+ * @typeParam O - represents a type that will define optional providers that will be injected
+ * @typeParam S - the initial state type that the produced data object may take during creation
+ * @typeParam E - represents events that will be available in the EventForwarder
+ */
+class LegacyPureDataObjectFactory extends PureDataObjectFactory {
+}
+exports.LegacyPureDataObjectFactory = LegacyPureDataObjectFactory;
 //# sourceMappingURL=pureDataObjectFactory.js.map

package/dist/data-object-factories/pureDataObjectFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"pureDataObjectFactory.js","sourceRoot":"","sources":["../../src/data-object-factories/pureDataObjectFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yDAIoC;AAEpC,yEAA2E;AAa3E,2DAIoC;AAEpC,kDAGyB;AAWzB;;;EAGE;AACF,KAAK,UAAU,gBAAgB,CAC3B,IAAiD,EACjD,OAA+B,EAC/B,oBAA2C,EAC3C,iBAA+C,EAC/C,eAA6C,EAC7C,QAAiB,EACjB,SAAa;IAEb,OAAO;IACP,IAAI,YAAY,GAAG,eAAe,CAAC;IAEnC,mBAAmB;IACnB,YAAY,GAAG,+BAAmB,CAC9B,KAAK,EAAE,OAAiB,EAAE,UAAiC,EAAE,EAAE,CAC3D,CAAC,MAAM,6BAAc,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EACjE,YAAY,CAAC,CAAC;IAEtB,0CAA0C;IAC1C,6EAA6E;IAC7E,MAAM,OAAO,GAAG,IAAI,YAAY,CAC5B,OAAO,EACP,oBAAoB,EACpB,QAAQ,CACX,CAAC;IAEF,4BAA4B;IAC5B,+EAA+E;IAC/E,mFAAmF;IACnF,iFAAiF;IACjF,uGAAuG;IACvG,MAAM,KAAK,GAA6C,OAAO,CAAC,KAAK,CAAC;IACtE,MAAM,mBAAmB,GAAG,IAAI,gCAAmB,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACvF,MAAM,SAAS,GAAG,mBAAmB,CAAC,UAAU,CAAI,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IAEtE,kFAAkF;IAClF,iFAAiF;IACjF,yBAAyB;IACzB,2EAA2E;IAC3E,iFAAiF;IACjF,qFAAqF;IACrF,4FAA4F;IAC5F,iGAAiG;IACjG,wDAAwD;IACxD,IAAI,CAAC,QAAQ,EAAE;QACX,MAAM,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;KACjD;IAED,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AACjC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAa,qBAAqB;IAM9B,YACoB,IAAY,EACX,IAAiD,EAClE,aAAyC,EACxB,iBAA+C,EAChE,eAAoD,EACnC,eAA6C,iCAAqB;QALnE,SAAI,GAAJ,IAAI,CAAQ;QACX,SAAI,GAAJ,IAAI,CAA6C;QAEjD,sBAAiB,GAAjB,iBAAiB,CAA8B;QAE/C,iBAAY,GAAZ,YAAY,CAAsD;QAEnF,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC5C;QACD,IAAI,eAAe,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,0CAAsB,CAAC,eAAe,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,oBAAoB,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;IAED,IAAW,sBAAsB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEpD,IAAW,uBAAuB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,IAAW,aAAa;QACpB,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,OAA+B,EAAE,QAAiB;QAChF,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,gBAAgB,CACtC,IAAI,CAAC,IAAI,EACT,OAAO,EACP,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,YAAY,EACjB,QAAQ,CAAC,CAAC;QAEd,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,mBAAmB,CAC5B,aAAqC,EACrC,YAAgB;QAEhB,OAAO,IAAI,CAAC,yBAAyB,CACjC,aAAa,CAAC,gBAAgB,EAC9B,CAAC,GAAG,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,EACzC,YAAY,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,kBAAkB,CAC3B,WAAmC,EACnC,YAAgB;QAEhB,OAAO,IAAI,CAAC,yBAAyB,CACjC,WAAW,CAAC,gBAAgB,EAC5B,WAAW,CAAC,WAAW,EACvB,YAAY,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CACvB,OAA8B,EAC9B,YAAgB;QAEhB,OAAO,IAAI,CAAC,yBAAyB,CACjC,OAAO,EACP,CAAC,IAAI,CAAC,IAAI,CAAC,EACX,YAAY,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,kBAAkB,CAC3B,eAAuB,EACvB,OAA0B,EAC1B,YAAgB;QAEhB,MAAM,OAAO,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,CAAC;QAClF,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,yBAAyB,CACrC,gBAAuC,EACvC,WAA+B,EAC/B,YAAgB;QAEhB,MAAM,OAAO,GAAG,gBAAgB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,kBAAkB,CAC9B,OAAuC,EACvC,YAAgB;QAEhB,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,gBAAgB,CAChD,IAAI,CAAC,IAAI,EACT,OAAO,EACP,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,YAAY,EACjB,KAAK,EAAE,WAAW;QAClB,YAAY,CAAC,CAAC;QAElB,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE3C,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AAlKD,sDAkKC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest, IFluidRouter, FluidObject } from \"@fluidframework/core-interfaces\";\nimport {\n    FluidDataStoreRuntime,\n    ISharedObjectRegistry,\n    mixinRequestHandler,\n } from \"@fluidframework/datastore\";\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { FluidDataStoreRegistry } from \"@fluidframework/container-runtime\";\nimport {\n    IFluidDataStoreContext,\n    IContainerRuntimeBase,\n    IFluidDataStoreFactory,\n    IFluidDataStoreRegistry,\n    IProvideFluidDataStoreRegistry,\n    NamedFluidDataStoreRegistryEntries,\n    NamedFluidDataStoreRegistryEntry,\n    IFluidDataStoreContextDetached,\n} from \"@fluidframework/runtime-definitions\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { IChannelFactory } from \"@fluidframework/datastore-definitions\";\nimport {\n    FluidObjectSymbolProvider,\n    DependencyContainer,\n    IFluidDependencySynthesizer,\n} from \"@fluidframework/synthesize\";\n\nimport {\n    IDataObjectProps,\n    PureDataObject,\n} from \"../data-objects\";\n\n/*\n * Useful interface in places where it's useful to do type erasure for PureDataObject generic\n */\nexport interface IRootDataObjectFactory extends IFluidDataStoreFactory {\n    createRootInstance(\n        rootDataStoreId: string,\n        runtime: IContainerRuntime): Promise<IFluidRouter>;\n}\n\n/**\n * Proxy over PureDataObject\n * Does delayed creation & initialization of PureDataObject\n*/\nasync function createDataObject<TObj extends PureDataObject<O, S, E>, O, S, E extends IEvent = IEvent>(\n    ctor: new (props: IDataObjectProps<O, S>) => TObj,\n    context: IFluidDataStoreContext,\n    sharedObjectRegistry: ISharedObjectRegistry,\n    optionalProviders: FluidObjectSymbolProvider<O>,\n    runtimeClassArg: typeof FluidDataStoreRuntime,\n    existing: boolean,\n    initProps?: S)\n{\n    // base\n    let runtimeClass = runtimeClassArg;\n\n    // request mixin in\n    runtimeClass = mixinRequestHandler(\n        async (request: IRequest, runtimeArg: FluidDataStoreRuntime) =>\n            (await PureDataObject.getDataObject(runtimeArg)).request(request),\n            runtimeClass);\n\n    // Create a new runtime for our data store\n    // The runtime is what Fluid uses to create DDS' and route to your data store\n    const runtime = new runtimeClass(\n        context,\n        sharedObjectRegistry,\n        existing,\n    );\n\n    // Create object right away.\n    // This allows object to register various callbacks with runtime before runtime\n    // becomes globally available. But it's not full initialization - constructor can't\n    // access DDSs or other services of runtime as objects are not fully initialized.\n    // In order to use object, we need to go through full initialization by calling finishInitialization().\n    const scope: FluidObject<IFluidDependencySynthesizer> = context.scope;\n    const dependencyContainer = new DependencyContainer(scope.IFluidDependencySynthesizer);\n    const providers = dependencyContainer.synthesize<O>(optionalProviders, {});\n    const instance = new ctor({ runtime, context, providers, initProps });\n\n    // if it's a newly created object, we need to wait for it to finish initialization\n    // as that results in creation of DDSs, before it gets attached, providing atomic\n    // guarantee of creation.\n    // WARNING: we can't do the same (yet) for already existing PureDataObject!\n    // This will result in deadlock, as it tries to resolve internal handles, but any\n    // handle resolution goes through root (container runtime), which can't route it back\n    // to this data store, as it's still not initialized and not known to container runtime yet.\n    // In the future, we should address it by using relative paths for handles and be able to resolve\n    // local DDSs while data store is not fully initialized.\n    if (!existing) {\n        await instance.finishInitialization(existing);\n    }\n\n    return { instance, runtime };\n}\n\n/**\n * PureDataObjectFactory is a barebones IFluidDataStoreFactory for use with PureDataObject.\n * Consumers should typically use DataObjectFactory instead unless creating\n * another base data store factory.\n *\n * @typeParam TObj - DataObject (concrete type)\n * @typeParam O - represents a type that will define optional providers that will be injected\n * @typeParam S - the initial state type that the produced data object may take during creation\n * @typeParam E - represents events that will be available in the EventForwarder\n */\nexport class PureDataObjectFactory<TObj extends PureDataObject<O, S, E>, O, S, E extends IEvent = IEvent>\n    implements IFluidDataStoreFactory, Partial<IProvideFluidDataStoreRegistry>, IRootDataObjectFactory\n{\n    private readonly sharedObjectRegistry: ISharedObjectRegistry;\n    private readonly registry: IFluidDataStoreRegistry | undefined;\n\n    constructor(\n        public readonly type: string,\n        private readonly ctor: new (props: IDataObjectProps<O, S>) => TObj,\n        sharedObjects: readonly IChannelFactory[],\n        private readonly optionalProviders: FluidObjectSymbolProvider<O>,\n        registryEntries?: NamedFluidDataStoreRegistryEntries,\n        private readonly runtimeClass: typeof FluidDataStoreRuntime = FluidDataStoreRuntime,\n    ) {\n        if (this.type === \"\") {\n            throw new Error(\"undefined type member\");\n        }\n        if (registryEntries !== undefined) {\n            this.registry = new FluidDataStoreRegistry(registryEntries);\n        }\n        this.sharedObjectRegistry = new Map(sharedObjects.map((ext) => [ext.type, ext]));\n    }\n\n    public get IFluidDataStoreFactory() { return this; }\n\n    public get IFluidDataStoreRegistry() {\n        return this.registry;\n    }\n\n    /**\n     * Convenience helper to get the data store's/factory's data store registry entry.\n     * The return type hides the factory's generics, easing grouping of registry\n     * entries that differ only in this way into the same array.\n     * @returns The NamedFluidDataStoreRegistryEntry\n     */\n    public get registryEntry(): NamedFluidDataStoreRegistryEntry {\n        return [this.type, Promise.resolve(this)];\n    }\n\n    /**\n     * This is where we do data store setup.\n     *\n     * @param context - data store context used to load a data store runtime\n     */\n    public async instantiateDataStore(context: IFluidDataStoreContext, existing: boolean) {\n        const { runtime } = await createDataObject(\n            this.ctor,\n            context,\n            this.sharedObjectRegistry,\n            this.optionalProviders,\n            this.runtimeClass,\n            existing);\n\n        return runtime;\n    }\n\n    /**\n     * Creates a new instance of the object. Uses parent context's registry to build package path to this factory.\n     * In other words, registry of context passed in has to contain this factory, with the name that matches\n     * this factory's type.\n     * It is intended to be used by data store objects that create sub-objects.\n     * @param context - The context being used to create the runtime\n     * (the created object will have its own new context created as well)\n     * @param initialState - The initial state to provide to the created data store.\n     * @returns an object created by this factory. Data store and objects created are not attached to container.\n     * They get attached only when a handle to one of them is attached to already attached objects.\n     */\n    public async createChildInstance(\n        parentContext: IFluidDataStoreContext,\n        initialState?: S,\n    ): Promise<TObj> {\n        return this.createNonRootInstanceCore(\n            parentContext.containerRuntime,\n            [...parentContext.packagePath, this.type],\n            initialState);\n    }\n\n    /**\n     * Creates a new instance of the object. Uses peer context's registry and its package path to identify this factory.\n     * In other words, registry of context passed in has to have this factory.\n     * Intended to be used by data store objects that need to create peers (similar) instances of existing objects.\n     * @param context - The component context being used to create the object\n     * (the created object will have its own new context created as well)\n     * @param initialState - The initial state to provide to the created component.\n     * @returns an object created by this factory. Data store and objects created are not attached to container.\n     * They get attached only when a handle to one of them is attached to already attached objects.\n     */\n    public async createPeerInstance(\n        peerContext: IFluidDataStoreContext,\n        initialState?: S,\n    ): Promise<TObj> {\n        return this.createNonRootInstanceCore(\n            peerContext.containerRuntime,\n            peerContext.packagePath,\n            initialState);\n    }\n\n    /**\n     * Creates a new instance of the object. Uses container's registry to find this factory.\n     * It's expected that only container owners would use this functionality, as only such developers\n     * have knowledge of entries in container registry.\n     * The name in this registry for such record should match type of this factory.\n     * @param runtime - container runtime. It's registry is used to create an object.\n     * @param initialState - The initial state to provide to the created component.\n     * @returns an object created by this factory. Data store and objects created are not attached to container.\n     * They get attached only when a handle to one of them is attached to already attached objects.\n     */\n    public async createInstance(\n        runtime: IContainerRuntimeBase,\n        initialState?: S,\n    ): Promise<TObj> {\n        return this.createNonRootInstanceCore(\n            runtime,\n            [this.type],\n            initialState);\n    }\n\n    /**\n     * Creates a new root instance of the object. Uses container's registry to find this factory.\n     * It's expected that only container owners would use this functionality, as only such developers\n     * have knowledge of entries in container registry.\n     * The name in this registry for such record should match type of this factory.\n     * @param runtime - container runtime. It's registry is used to create an object.\n     * @param initialState - The initial state to provide to the created component.\n     * @returns an object created by this factory. Data store and objects created are not attached to container.\n     * They get attached only when a handle to one of them is attached to already attached objects.\n     */\n    public async createRootInstance(\n        rootDataStoreId: string,\n        runtime: IContainerRuntime,\n        initialState?: S,\n    ): Promise<TObj> {\n        const context = runtime.createDetachedRootDataStore([this.type], rootDataStoreId);\n        return this.createInstanceCore(context, initialState);\n    }\n\n    protected async createNonRootInstanceCore(\n        containerRuntime: IContainerRuntimeBase,\n        packagePath: Readonly<string[]>,\n        initialState?: S,\n    ): Promise<TObj> {\n        const context = containerRuntime.createDetachedDataStore(packagePath);\n        return this.createInstanceCore(context, initialState);\n    }\n\n    protected async createInstanceCore(\n        context: IFluidDataStoreContextDetached,\n        initialState?: S,\n    ): Promise<TObj> {\n        const { instance, runtime } = await createDataObject(\n            this.ctor,\n            context,\n            this.sharedObjectRegistry,\n            this.optionalProviders,\n            this.runtimeClass,\n            false, // existing\n            initialState);\n\n        await context.attachRuntime(this, runtime);\n\n        return instance;\n    }\n}\n"]}
+{"version":3,"file":"pureDataObjectFactory.js","sourceRoot":"","sources":["../../src/data-object-factories/pureDataObjectFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yDAIoC;AACpC,yEAA2E;AAa3E,2DAIoC;AAGpC,kDAMyB;AAUzB;;;EAGE;AACF,KAAK,UAAU,gBAAgB,CAC3B,IAA8C,EAC9C,OAA+B,EAC/B,oBAA2C,EAC3C,iBAAoF,EACpF,eAA6C,EAC7C,QAAiB,EACjB,SAA6C;IAE7C,OAAO;IACP,IAAI,YAAY,GAAG,eAAe,CAAC;IAEnC,mBAAmB;IACnB,YAAY,GAAG,+BAAmB,CAC9B,KAAK,EAAE,OAAiB,EAAE,UAAiC,EAAE,EAAE,CAC3D,CAAC,MAAM,6BAAc,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EACjE,YAAY,CAAC,CAAC;IAEtB,0CAA0C;IAC1C,6EAA6E;IAC7E,MAAM,OAAO,GAAG,IAAI,YAAY,CAC5B,OAAO,EACP,oBAAoB,EACpB,QAAQ,CACX,CAAC;IAEF,4BAA4B;IAC5B,+EAA+E;IAC/E,mFAAmF;IACnF,iFAAiF;IACjF,uGAAuG;IACvG,MAAM,KAAK,GAA6C,OAAO,CAAC,KAAK,CAAC;IACtE,MAAM,mBAAmB,GAAG,IAAI,gCAAmB,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACvF,MAAM,SAAS,GAAG,mBAAmB,CAAC,UAAU,CAAyC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAChH,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IAEtE,kFAAkF;IAClF,iFAAiF;IACjF,yBAAyB;IACzB,2EAA2E;IAC3E,iFAAiF;IACjF,qFAAqF;IACrF,4FAA4F;IAC5F,iGAAiG;IACjG,wDAAwD;IACxD,IAAI,CAAC,QAAQ,EAAE;QACX,MAAM,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;KACjD;IAED,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AACjC,CAAC;AAED;;;;;;;GAOG;AACH,MAAa,qBAAqB;IAM9B,YACoB,IAAY,EACX,IAA8C,EAC/D,aAAyC,EACxB,iBAAoF,EACrG,eAAoD,EACnC,eAA6C,iCAAqB;QALnE,SAAI,GAAJ,IAAI,CAAQ;QACX,SAAI,GAAJ,IAAI,CAA0C;QAE9C,sBAAiB,GAAjB,iBAAiB,CAAmE;QAEpF,iBAAY,GAAZ,YAAY,CAAsD;QAEnF,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC5C;QACD,IAAI,eAAe,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,0CAAsB,CAAC,eAAe,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,oBAAoB,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;IAED,IAAW,sBAAsB,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEpD,IAAW,uBAAuB;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,IAAW,aAAa;QACpB,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,OAA+B,EAAE,QAAiB;QAChF,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,gBAAgB,CACtC,IAAI,CAAC,IAAI,EACT,OAAO,EACP,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,YAAY,EACjB,QAAQ,CAAC,CAAC;QAEd,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,mBAAmB,CAC5B,aAAqC,EACrC,YAAgD;QAEhD,OAAO,IAAI,CAAC,yBAAyB,CACjC,aAAa,CAAC,gBAAgB,EAC9B,CAAC,GAAG,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,EACzC,YAAY,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,kBAAkB,CAC3B,WAAmC,EACnC,YAAgD;QAEhD,OAAO,IAAI,CAAC,yBAAyB,CACjC,WAAW,CAAC,gBAAgB,EAC5B,WAAW,CAAC,WAAW,EACvB,YAAY,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CACvB,OAA8B,EAC9B,YAAgD;QAEhD,OAAO,IAAI,CAAC,yBAAyB,CACjC,OAAO,EACP,CAAC,IAAI,CAAC,IAAI,CAAC,EACX,YAAY,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,kBAAkB,CAC3B,eAAuB,EACvB,OAA0B,EAC1B,YAAgD;QAEhD,MAAM,OAAO,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,CAAC;QAClF,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,yBAAyB,CACrC,gBAAuC,EACvC,WAA+B,EAC/B,YAAgD;QAEhD,MAAM,OAAO,GAAG,gBAAgB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,kBAAkB,CAC9B,OAAuC,EACvC,YAAgD;QAEhD,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,gBAAgB,CAChD,IAAI,CAAC,IAAI,EACT,OAAO,EACP,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,YAAY,EACjB,KAAK,EAAE,WAAW;QAClB,YAAY,CAAC,CAAC;QAElB,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE3C,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AAlKD,sDAkKC;AAED;;;;;;;;;;;;GAYG;AACF,MAAa,2BACb,SAAQ,qBAA8E;CAAG;AADzF,kEACyF","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IRequest, IFluidRouter, FluidObject } from \"@fluidframework/core-interfaces\";\nimport {\n    FluidDataStoreRuntime,\n    ISharedObjectRegistry,\n    mixinRequestHandler,\n } from \"@fluidframework/datastore\";\nimport { FluidDataStoreRegistry } from \"@fluidframework/container-runtime\";\nimport {\n    IFluidDataStoreContext,\n    IContainerRuntimeBase,\n    IFluidDataStoreFactory,\n    IFluidDataStoreRegistry,\n    IProvideFluidDataStoreRegistry,\n    NamedFluidDataStoreRegistryEntries,\n    NamedFluidDataStoreRegistryEntry,\n    IFluidDataStoreContextDetached,\n} from \"@fluidframework/runtime-definitions\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { IChannelFactory } from \"@fluidframework/datastore-definitions\";\nimport {\n    FluidObjectSymbolProvider,\n    DependencyContainer,\n    IFluidDependencySynthesizer,\n} from \"@fluidframework/synthesize\";\n\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport {\n    IDataObjectProps,\n    PureDataObject,\n    DataObjectType,\n    DataObjectTypes,\n    LegacyPureDataObject,\n} from \"../data-objects\";\n/*\n * Useful interface in places where it's useful to do type erasure for PureDataObject generic\n */\nexport interface IRootDataObjectFactory extends IFluidDataStoreFactory {\n    createRootInstance(\n        rootDataStoreId: string,\n        runtime: IContainerRuntime): Promise<IFluidRouter>;\n}\n\n/**\n * Proxy over PureDataObject\n * Does delayed creation & initialization of PureDataObject\n*/\nasync function createDataObject<TObj extends PureDataObject,I extends DataObjectTypes = DataObjectTypes>(\n    ctor: new (props: IDataObjectProps<I>) => TObj,\n    context: IFluidDataStoreContext,\n    sharedObjectRegistry: ISharedObjectRegistry,\n    optionalProviders: FluidObjectSymbolProvider<DataObjectType<I, \"OptionalProviders\">>,\n    runtimeClassArg: typeof FluidDataStoreRuntime,\n    existing: boolean,\n    initProps?: DataObjectType<I, \"InitialState\">)\n{\n    // base\n    let runtimeClass = runtimeClassArg;\n\n    // request mixin in\n    runtimeClass = mixinRequestHandler(\n        async (request: IRequest, runtimeArg: FluidDataStoreRuntime) =>\n            (await PureDataObject.getDataObject(runtimeArg)).request(request),\n            runtimeClass);\n\n    // Create a new runtime for our data store\n    // The runtime is what Fluid uses to create DDS' and route to your data store\n    const runtime = new runtimeClass(\n        context,\n        sharedObjectRegistry,\n        existing,\n    );\n\n    // Create object right away.\n    // This allows object to register various callbacks with runtime before runtime\n    // becomes globally available. But it's not full initialization - constructor can't\n    // access DDSs or other services of runtime as objects are not fully initialized.\n    // In order to use object, we need to go through full initialization by calling finishInitialization().\n    const scope: FluidObject<IFluidDependencySynthesizer> = context.scope;\n    const dependencyContainer = new DependencyContainer(scope.IFluidDependencySynthesizer);\n    const providers = dependencyContainer.synthesize<DataObjectType<I, \"OptionalProviders\">>(optionalProviders, {});\n    const instance = new ctor({ runtime, context, providers, initProps });\n\n    // if it's a newly created object, we need to wait for it to finish initialization\n    // as that results in creation of DDSs, before it gets attached, providing atomic\n    // guarantee of creation.\n    // WARNING: we can't do the same (yet) for already existing PureDataObject!\n    // This will result in deadlock, as it tries to resolve internal handles, but any\n    // handle resolution goes through root (container runtime), which can't route it back\n    // to this data store, as it's still not initialized and not known to container runtime yet.\n    // In the future, we should address it by using relative paths for handles and be able to resolve\n    // local DDSs while data store is not fully initialized.\n    if (!existing) {\n        await instance.finishInitialization(existing);\n    }\n\n    return { instance, runtime };\n}\n\n/**\n * PureDataObjectFactory is a barebones IFluidDataStoreFactory for use with PureDataObject.\n * Consumers should typically use DataObjectFactory instead unless creating\n * another base data store factory.\n *\n * @typeParam TObj - DataObject (concrete type)\n * @typeParam I - The input types for the DataObject\n */\nexport class PureDataObjectFactory<TObj extends PureDataObject<I>, I extends DataObjectTypes = DataObjectTypes>\n    implements IFluidDataStoreFactory, Partial<IProvideFluidDataStoreRegistry>, IRootDataObjectFactory\n{\n    private readonly sharedObjectRegistry: ISharedObjectRegistry;\n    private readonly registry: IFluidDataStoreRegistry | undefined;\n\n    constructor(\n        public readonly type: string,\n        private readonly ctor: new (props: IDataObjectProps<I>) => TObj,\n        sharedObjects: readonly IChannelFactory[],\n        private readonly optionalProviders: FluidObjectSymbolProvider<DataObjectType<I, \"OptionalProviders\">>,\n        registryEntries?: NamedFluidDataStoreRegistryEntries,\n        private readonly runtimeClass: typeof FluidDataStoreRuntime = FluidDataStoreRuntime,\n    ) {\n        if (this.type === \"\") {\n            throw new Error(\"undefined type member\");\n        }\n        if (registryEntries !== undefined) {\n            this.registry = new FluidDataStoreRegistry(registryEntries);\n        }\n        this.sharedObjectRegistry = new Map(sharedObjects.map((ext) => [ext.type, ext]));\n    }\n\n    public get IFluidDataStoreFactory() { return this; }\n\n    public get IFluidDataStoreRegistry() {\n        return this.registry;\n    }\n\n    /**\n     * Convenience helper to get the data store's/factory's data store registry entry.\n     * The return type hides the factory's generics, easing grouping of registry\n     * entries that differ only in this way into the same array.\n     * @returns The NamedFluidDataStoreRegistryEntry\n     */\n    public get registryEntry(): NamedFluidDataStoreRegistryEntry {\n        return [this.type, Promise.resolve(this)];\n    }\n\n    /**\n     * This is where we do data store setup.\n     *\n     * @param context - data store context used to load a data store runtime\n     */\n    public async instantiateDataStore(context: IFluidDataStoreContext, existing: boolean) {\n        const { runtime } = await createDataObject(\n            this.ctor,\n            context,\n            this.sharedObjectRegistry,\n            this.optionalProviders,\n            this.runtimeClass,\n            existing);\n\n        return runtime;\n    }\n\n    /**\n     * Creates a new instance of the object. Uses parent context's registry to build package path to this factory.\n     * In other words, registry of context passed in has to contain this factory, with the name that matches\n     * this factory's type.\n     * It is intended to be used by data store objects that create sub-objects.\n     * @param context - The context being used to create the runtime\n     * (the created object will have its own new context created as well)\n     * @param initialState - The initial state to provide to the created data store.\n     * @returns an object created by this factory. Data store and objects created are not attached to container.\n     * They get attached only when a handle to one of them is attached to already attached objects.\n     */\n    public async createChildInstance(\n        parentContext: IFluidDataStoreContext,\n        initialState?: DataObjectType<I, \"InitialState\">,\n    ): Promise<TObj> {\n        return this.createNonRootInstanceCore(\n            parentContext.containerRuntime,\n            [...parentContext.packagePath, this.type],\n            initialState);\n    }\n\n    /**\n     * Creates a new instance of the object. Uses peer context's registry and its package path to identify this factory.\n     * In other words, registry of context passed in has to have this factory.\n     * Intended to be used by data store objects that need to create peers (similar) instances of existing objects.\n     * @param context - The component context being used to create the object\n     * (the created object will have its own new context created as well)\n     * @param initialState - The initial state to provide to the created component.\n     * @returns an object created by this factory. Data store and objects created are not attached to container.\n     * They get attached only when a handle to one of them is attached to already attached objects.\n     */\n    public async createPeerInstance(\n        peerContext: IFluidDataStoreContext,\n        initialState?: DataObjectType<I, \"InitialState\">,\n    ): Promise<TObj> {\n        return this.createNonRootInstanceCore(\n            peerContext.containerRuntime,\n            peerContext.packagePath,\n            initialState);\n    }\n\n    /**\n     * Creates a new instance of the object. Uses container's registry to find this factory.\n     * It's expected that only container owners would use this functionality, as only such developers\n     * have knowledge of entries in container registry.\n     * The name in this registry for such record should match type of this factory.\n     * @param runtime - container runtime. It's registry is used to create an object.\n     * @param initialState - The initial state to provide to the created component.\n     * @returns an object created by this factory. Data store and objects created are not attached to container.\n     * They get attached only when a handle to one of them is attached to already attached objects.\n     */\n    public async createInstance(\n        runtime: IContainerRuntimeBase,\n        initialState?: DataObjectType<I, \"InitialState\">,\n    ): Promise<TObj> {\n        return this.createNonRootInstanceCore(\n            runtime,\n            [this.type],\n            initialState);\n    }\n\n    /**\n     * Creates a new root instance of the object. Uses container's registry to find this factory.\n     * It's expected that only container owners would use this functionality, as only such developers\n     * have knowledge of entries in container registry.\n     * The name in this registry for such record should match type of this factory.\n     * @param runtime - container runtime. It's registry is used to create an object.\n     * @param initialState - The initial state to provide to the created component.\n     * @returns an object created by this factory. Data store and objects created are not attached to container.\n     * They get attached only when a handle to one of them is attached to already attached objects.\n     */\n    public async createRootInstance(\n        rootDataStoreId: string,\n        runtime: IContainerRuntime,\n        initialState?: DataObjectType<I, \"InitialState\">,\n    ): Promise<TObj> {\n        const context = runtime.createDetachedRootDataStore([this.type], rootDataStoreId);\n        return this.createInstanceCore(context, initialState);\n    }\n\n    protected async createNonRootInstanceCore(\n        containerRuntime: IContainerRuntimeBase,\n        packagePath: Readonly<string[]>,\n        initialState?: DataObjectType<I, \"InitialState\">,\n    ): Promise<TObj> {\n        const context = containerRuntime.createDetachedDataStore(packagePath);\n        return this.createInstanceCore(context, initialState);\n    }\n\n    protected async createInstanceCore(\n        context: IFluidDataStoreContextDetached,\n        initialState?: DataObjectType<I, \"InitialState\">,\n    ): Promise<TObj> {\n        const { instance, runtime } = await createDataObject(\n            this.ctor,\n            context,\n            this.sharedObjectRegistry,\n            this.optionalProviders,\n            this.runtimeClass,\n            false, // existing\n            initialState);\n\n        await context.attachRuntime(this, runtime);\n\n        return instance;\n    }\n}\n\n/**\n * @deprecated - This type is meant to ease the transition from the old PureDataObjectFactory type to the new.\n * please migrate to PureDataObjectFactory.\n *\n * PureDataObjectFactory is a barebones IFluidDataStoreFactory for use with PureDataObject.\n * Consumers should typically use DataObjectFactory instead unless creating\n * another base data store factory.\n *\n * @typeParam TObj - DataObject (concrete type)\n * @typeParam O - represents a type that will define optional providers that will be injected\n * @typeParam S - the initial state type that the produced data object may take during creation\n * @typeParam E - represents events that will be available in the EventForwarder\n */\n export class LegacyPureDataObjectFactory<TObj extends LegacyPureDataObject<O, S, E>, O, S, E extends IEvent = IEvent>\n extends PureDataObjectFactory<TObj,{OptionalProviders: O, InitialState: S, Events: E}> {}\n"]}

package/dist/data-objects/dataObject.d.ts

@@ -2,10 +2,11 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { IEvent } from "@fluidframework/common-definitions";
 import { IFluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import { ISharedDirectory } from "@fluidframework/map";
-import { IEvent } from "@fluidframework/common-definitions";
 import { PureDataObject } from "./pureDataObject";
+import { DataObjectTypes } from "./types";
 /**
  * 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.
@@ -14,11 +15,9 @@ import { PureDataObject } from "./pureDataObject";
  * and registering channels with the runtime any new DDS that is set on the root
  * will automatically be registered.
  *
- * @typeParam O - represents a type that will define optional providers that will be injected
- * @typeParam S - the initial state type that the produced data object may take during creation
- * @typeParam E - represents events that will be available in the EventForwarder
+ * @typeParam I - The optional input types used to strongly type the data object
  */
-export declare abstract class DataObject<O extends IFluidObject = object, S = undefined, E extends IEvent = IEvent> extends PureDataObject<O, S, E> {
+export declare abstract class DataObject<I extends DataObjectTypes = DataObjectTypes> extends PureDataObject<I> {
     private internalRoot;
     private readonly rootDirectoryId;
     request(request: IRequest): Promise<IResponse>;
@@ -34,4 +33,25 @@ export declare abstract class DataObject<O extends IFluidObject = object, S = un
     initializeInternal(existing: boolean): Promise<void>;
     protected getUninitializedErrorString(item: string): string;
 }
+/**
+ * @deprecated - This type is meant to ease the transition from the old DataObject type to the new.
+ * please migrate to DataObject.
+ *
+ * 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.
+ *
+ * Having a single root directory allows for easier development. Instead of creating
+ * and registering channels with the runtime any new DDS that is set on the root
+ * will automatically be registered.
+ *
+ * @typeParam O - represents a type that will define optional providers that will be injected
+ * @typeParam S - the initial state type that the produced data object may take during creation
+ * @typeParam E - represents events that will be available in the EventForwarder
+ */
+export declare abstract class LegacyDataObject<O extends IFluidObject = object, S = undefined, E extends IEvent = IEvent> extends DataObject<{
+    OptionalProviders: O;
+    InitialState: S;
+    Events: E;
+}> {
+}
 //# sourceMappingURL=dataObject.d.ts.map

package/dist/data-objects/dataObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/dataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,YAAY,EACZ,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAA+B,MAAM,qBAAqB,CAAC;AAEpF,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;;;;;;GAWG;AAEH,8BAAsB,UAAU,CAAC,CAAC,SAAS,YAAY,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CACtG,SAAQ,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAE/B,OAAO,CAAC,YAAY,CAA+B;IACnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAU;IAE7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAc3D;;;OAGG;IACH,SAAS,KAAK,IAAI,IAAI,gBAAgB,CAMrC;IAED;;;OAGG;IACU,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBjE,SAAS,CAAC,2BAA2B,CAAC,IAAI,EAAE,MAAM;CAGrD"}
+{"version":3,"file":"dataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/dataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EACH,YAAY,EACZ,QAAQ,EACR,SAAS,EACZ,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAA+B,MAAM,qBAAqB,CAAC;AAEpF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C;;;;;;;;;GASG;AACH,8BAAsB,UAAU,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,CAAE,SAAQ,cAAc,CAAC,CAAC,CAAC;IAEnG,OAAO,CAAC,YAAY,CAA+B;IACnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAU;IAE7B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAc3D;;;OAGG;IACH,SAAS,KAAK,IAAI,IAAI,gBAAgB,CAMrC;IAED;;;OAGG;IACU,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBjE,SAAS,CAAC,2BAA2B,CAAC,IAAI,EAAE,MAAM;CAGrD;AAED;;;;;;;;;;;;;;GAcG;AAEH,8BAAsB,gBAAgB,CAAC,CAAC,SAAS,YAAY,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CAC5G,SAAQ,UAAU,CAAC;IAAC,iBAAiB,EAAE,CAAC,CAAC;IAAC,YAAY,EAAE,CAAC,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAC,CAAC;CAErE"}

package/dist/data-objects/dataObject.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataObject = void 0;
+exports.LegacyDataObject = exports.DataObject = void 0;
 const map_1 = require("@fluidframework/map");
 const runtime_utils_1 = require("@fluidframework/runtime-utils");
 const pureDataObject_1 = require("./pureDataObject");
@@ -16,11 +16,8 @@ const pureDataObject_1 = require("./pureDataObject");
  * and registering channels with the runtime any new DDS that is set on the root
  * will automatically be registered.
  *
- * @typeParam O - represents a type that will define optional providers that will be injected
- * @typeParam S - the initial state type that the produced data object may take during creation
- * @typeParam E - represents events that will be available in the EventForwarder
+ * @typeParam I - The optional input types used to strongly type the data object
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 class DataObject extends pureDataObject_1.PureDataObject {
     constructor() {
         super(...arguments);
@@ -81,4 +78,23 @@ class DataObject extends pureDataObject_1.PureDataObject {
     }
 }
 exports.DataObject = DataObject;
+/**
+ * @deprecated - This type is meant to ease the transition from the old DataObject type to the new.
+ * please migrate to DataObject.
+ *
+ * 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.
+ *
+ * Having a single root directory allows for easier development. Instead of creating
+ * and registering channels with the runtime any new DDS that is set on the root
+ * will automatically be registered.
+ *
+ * @typeParam O - represents a type that will define optional providers that will be injected
+ * @typeParam S - the initial state type that the produced data object may take during creation
+ * @typeParam E - represents events that will be available in the EventForwarder
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+class LegacyDataObject extends DataObject {
+}
+exports.LegacyDataObject = LegacyDataObject;
 //# sourceMappingURL=dataObject.js.map

package/dist/data-objects/dataObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataObject.js","sourceRoot":"","sources":["../../src/data-objects/dataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,6CAAoF;AACpF,iEAAiF;AAEjF,qDAAkD;AAElD;;;;;;;;;;;GAWG;AACH,wDAAwD;AACxD,MAAsB,UAClB,SAAQ,+BAAuB;IADnC;;QAIqB,oBAAe,GAAG,MAAM,CAAC;IA2D9C,CAAC;IAzDU,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,MAAM,aAAa,GAAG,6BAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,MAAM,KAAK,UAAU,EAAE;YACvB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACvE,IAAI,KAAK,KAAK,SAAS,EAAE;gBACrB,OAAO,iCAAiB,CAAC,aAAa,CAAC,CAAC;aAC3C;YACD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;SAC3D;aAAM;YACH,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SACvC;IACL,CAAC;IAED;;;OAGG;IACH,IAAc,IAAI;QACd,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC;SAC7D;QAED,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAAC,QAAiB;QAC7C,IAAI,CAAC,QAAQ,EAAE;YACX,+EAA+E;YAC/E,IAAI,CAAC,YAAY,GAAG,qBAAe,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;YAC/E,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;SACrC;aAAM;YACH,oGAAoG;YACpG,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,CAAqB,CAAC;YAE5F,oGAAoG;YACpG,gGAAgG;YAChG,qGAAqG;YACrG,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,KAAK,gBAAU,CAAC,IAAI,EAAE;gBACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;oBACrB,QAAQ,EAAE,SAAS;oBACnB,SAAS,EAAE,eAAe;oBAC1B,OAAO,EAAE,6EAA6E;iBACzF,CAAC,CAAC;aACN;SACJ;QAED,MAAM,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAES,2BAA2B,CAAC,IAAY;QAC9C,OAAO,GAAG,IAAI,6CAA6C,CAAC;IAChE,CAAC;CACJ;AA/DD,gCA+DC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidObject,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { ISharedDirectory, MapFactory, SharedDirectory } from \"@fluidframework/map\";\nimport { RequestParser, create404Response } from \"@fluidframework/runtime-utils\";\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { PureDataObject } from \"./pureDataObject\";\n\n/**\n * DataObject is a base data store that is primed with a root directory. It\n * ensures that it is created and ready before you can access it.\n *\n * Having a single root directory allows for easier development. Instead of creating\n * and registering channels with the runtime any new DDS that is set on the root\n * will automatically be registered.\n *\n * @typeParam O - represents a type that will define optional providers that will be injected\n * @typeParam S - the initial state type that the produced data object may take during creation\n * @typeParam E - represents events that will be available in the EventForwarder\n */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport abstract class DataObject<O extends IFluidObject = object, S = undefined, E extends IEvent = IEvent>\n    extends PureDataObject<O, S, E>\n{\n    private internalRoot: ISharedDirectory | undefined;\n    private readonly rootDirectoryId = \"root\";\n\n    public async request(request: IRequest): Promise<IResponse> {\n        const requestParser = RequestParser.create(request);\n        const itemId = requestParser.pathParts[0];\n        if (itemId === \"bigBlobs\") {\n            const value = this.root.get<string>(requestParser.pathParts.join(\"/\"));\n            if (value === undefined) {\n                return create404Response(requestParser);\n            }\n            return { mimeType: \"fluid/object\", status: 200, value };\n        } else {\n            return super.request(requestParser);\n        }\n    }\n\n    /**\n     * The root directory will either be ready or will return an error. If an error is thrown\n     * the root has not been correctly created/set.\n     */\n    protected get root(): ISharedDirectory {\n        if (!this.internalRoot) {\n            throw new Error(this.getUninitializedErrorString(`root`));\n        }\n\n        return this.internalRoot;\n    }\n\n    /**\n     * Initializes internal objects and calls initialization overrides.\n     * Caller is responsible for ensuring this is only invoked once.\n     */\n    public async initializeInternal(existing: boolean): Promise<void> {\n        if (!existing) {\n            // Create a root directory and register it before calling initializingFirstTime\n            this.internalRoot = SharedDirectory.create(this.runtime, this.rootDirectoryId);\n            this.internalRoot.bindToContext();\n        } else {\n            // data store has a root directory so we just need to set it before calling initializingFromExisting\n            this.internalRoot = await this.runtime.getChannel(this.rootDirectoryId) as ISharedDirectory;\n\n            // This will actually be an ISharedMap if the channel was previously created by the older version of\n            // DataObject which used a SharedMap.  Since SharedMap and SharedDirectory are compatible unless\n            // SharedDirectory-only commands are used on SharedMap, this will mostly just work for compatibility.\n            if (this.internalRoot.attributes.type === MapFactory.Type) {\n                this.runtime.logger.send({\n                    category: \"generic\",\n                    eventName: \"MapDataObject\",\n                    message: \"Legacy document, SharedMap is masquerading as SharedDirectory in DataObject\",\n                });\n            }\n        }\n\n        await super.initializeInternal(existing);\n    }\n\n    protected getUninitializedErrorString(item: string) {\n        return `${item} must be initialized before being accessed.`;\n    }\n}\n"]}
+{"version":3,"file":"dataObject.js","sourceRoot":"","sources":["../../src/data-objects/dataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,6CAAoF;AACpF,iEAAiF;AACjF,qDAAkD;AAGlD;;;;;;;;;GASG;AACH,MAAsB,UAAwD,SAAQ,+BAAiB;IAAvG;;QAGqB,oBAAe,GAAG,MAAM,CAAC;IA2D9C,CAAC;IAzDU,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,MAAM,aAAa,GAAG,6BAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,MAAM,KAAK,UAAU,EAAE;YACvB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAS,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACvE,IAAI,KAAK,KAAK,SAAS,EAAE;gBACrB,OAAO,iCAAiB,CAAC,aAAa,CAAC,CAAC;aAC3C;YACD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;SAC3D;aAAM;YACH,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SACvC;IACL,CAAC;IAED;;;OAGG;IACH,IAAc,IAAI;QACd,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC;SAC7D;QAED,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAAC,QAAiB;QAC7C,IAAI,CAAC,QAAQ,EAAE;YACX,+EAA+E;YAC/E,IAAI,CAAC,YAAY,GAAG,qBAAe,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;YAC/E,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;SACrC;aAAM;YACH,oGAAoG;YACpG,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,CAAqB,CAAC;YAE5F,oGAAoG;YACpG,gGAAgG;YAChG,qGAAqG;YACrG,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,KAAK,gBAAU,CAAC,IAAI,EAAE;gBACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;oBACrB,QAAQ,EAAE,SAAS;oBACnB,SAAS,EAAE,eAAe;oBAC1B,OAAO,EAAE,6EAA6E;iBACzF,CAAC,CAAC;aACN;SACJ;QAED,MAAM,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAES,2BAA2B,CAAC,IAAY;QAC9C,OAAO,GAAG,IAAI,6CAA6C,CAAC;IAChE,CAAC;CACJ;AA9DD,gCA8DC;AAED;;;;;;;;;;;;;;GAcG;AACH,wDAAwD;AACxD,MAAsB,gBAClB,SAAQ,UAA8D;CAErE;AAHL,4CAGK","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport {\n    IFluidObject,\n    IRequest,\n    IResponse,\n} from \"@fluidframework/core-interfaces\";\nimport { ISharedDirectory, MapFactory, SharedDirectory } from \"@fluidframework/map\";\nimport { RequestParser, create404Response } from \"@fluidframework/runtime-utils\";\nimport { PureDataObject } from \"./pureDataObject\";\nimport { DataObjectTypes } from \"./types\";\n\n/**\n * DataObject is a base data store that is primed with a root directory. It\n * ensures that it is created and ready before you can access it.\n *\n * Having a single root directory allows for easier development. Instead of creating\n * and registering channels with the runtime any new DDS that is set on the root\n * will automatically be registered.\n *\n * @typeParam I - The optional input types used to strongly type the data object\n */\nexport abstract class DataObject<I extends DataObjectTypes = DataObjectTypes> extends PureDataObject<I>\n{\n    private internalRoot: ISharedDirectory | undefined;\n    private readonly rootDirectoryId = \"root\";\n\n    public async request(request: IRequest): Promise<IResponse> {\n        const requestParser = RequestParser.create(request);\n        const itemId = requestParser.pathParts[0];\n        if (itemId === \"bigBlobs\") {\n            const value = this.root.get<string>(requestParser.pathParts.join(\"/\"));\n            if (value === undefined) {\n                return create404Response(requestParser);\n            }\n            return { mimeType: \"fluid/object\", status: 200, value };\n        } else {\n            return super.request(requestParser);\n        }\n    }\n\n    /**\n     * The root directory will either be ready or will return an error. If an error is thrown\n     * the root has not been correctly created/set.\n     */\n    protected get root(): ISharedDirectory {\n        if (!this.internalRoot) {\n            throw new Error(this.getUninitializedErrorString(`root`));\n        }\n\n        return this.internalRoot;\n    }\n\n    /**\n     * Initializes internal objects and calls initialization overrides.\n     * Caller is responsible for ensuring this is only invoked once.\n     */\n    public async initializeInternal(existing: boolean): Promise<void> {\n        if (!existing) {\n            // Create a root directory and register it before calling initializingFirstTime\n            this.internalRoot = SharedDirectory.create(this.runtime, this.rootDirectoryId);\n            this.internalRoot.bindToContext();\n        } else {\n            // data store has a root directory so we just need to set it before calling initializingFromExisting\n            this.internalRoot = await this.runtime.getChannel(this.rootDirectoryId) as ISharedDirectory;\n\n            // This will actually be an ISharedMap if the channel was previously created by the older version of\n            // DataObject which used a SharedMap.  Since SharedMap and SharedDirectory are compatible unless\n            // SharedDirectory-only commands are used on SharedMap, this will mostly just work for compatibility.\n            if (this.internalRoot.attributes.type === MapFactory.Type) {\n                this.runtime.logger.send({\n                    category: \"generic\",\n                    eventName: \"MapDataObject\",\n                    message: \"Legacy document, SharedMap is masquerading as SharedDirectory in DataObject\",\n                });\n            }\n        }\n\n        await super.initializeInternal(existing);\n    }\n\n    protected getUninitializedErrorString(item: string) {\n        return `${item} must be initialized before being accessed.`;\n    }\n}\n\n/**\n * @deprecated - This type is meant to ease the transition from the old DataObject type to the new.\n * please migrate to DataObject.\n *\n * DataObject is a base data store that is primed with a root directory. It\n * ensures that it is created and ready before you can access it.\n *\n * Having a single root directory allows for easier development. Instead of creating\n * and registering channels with the runtime any new DDS that is set on the root\n * will automatically be registered.\n *\n * @typeParam O - represents a type that will define optional providers that will be injected\n * @typeParam S - the initial state type that the produced data object may take during creation\n * @typeParam E - represents events that will be available in the EventForwarder\n */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport abstract class LegacyDataObject<O extends IFluidObject = object, S = undefined, E extends IEvent = IEvent>\n    extends DataObject<{OptionalProviders: O, InitialState: S, Events: E}> {\n\n    }\n"]}

package/dist/data-objects/index.d.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { DataObject } from "./dataObject";
-export { IDataObjectProps, PureDataObject, } from "./pureDataObject";
+export { DataObject, LegacyDataObject } from "./dataObject";
+export { PureDataObject, LegacyPureDataObject } from "./pureDataObject";
+export { DataObjectTypes, DataObjectType, IDataObjectProps } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/data-objects/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data-objects/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EACH,gBAAgB,EAChB,cAAc,GACjB,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data-objects/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC"}

package/dist/data-objects/index.js

@@ -4,9 +4,11 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PureDataObject = exports.DataObject = void 0;
+exports.LegacyPureDataObject = exports.PureDataObject = exports.LegacyDataObject = exports.DataObject = void 0;
 var dataObject_1 = require("./dataObject");
 Object.defineProperty(exports, "DataObject", { enumerable: true, get: function () { return dataObject_1.DataObject; } });
+Object.defineProperty(exports, "LegacyDataObject", { enumerable: true, get: function () { return dataObject_1.LegacyDataObject; } });
 var pureDataObject_1 = require("./pureDataObject");
 Object.defineProperty(exports, "PureDataObject", { enumerable: true, get: function () { return pureDataObject_1.PureDataObject; } });
+Object.defineProperty(exports, "LegacyPureDataObject", { enumerable: true, get: function () { return pureDataObject_1.LegacyPureDataObject; } });
 //# sourceMappingURL=index.js.map

package/dist/data-objects/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data-objects/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,mDAG0B;AADtB,gHAAA,cAAc,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DataObject } from \"./dataObject\";\nexport {\n    IDataObjectProps,\n    PureDataObject,\n} from \"./pureDataObject\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data-objects/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2CAA4D;AAAnD,wGAAA,UAAU,OAAA;AAAE,8GAAA,gBAAgB,OAAA;AACrC,mDAAwE;AAA/D,gHAAA,cAAc,OAAA;AAAE,sHAAA,oBAAoB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DataObject, LegacyDataObject } from \"./dataObject\";\nexport { PureDataObject, LegacyPureDataObject } from \"./pureDataObject\";\nexport { DataObjectTypes, DataObjectType, IDataObjectProps } from \"./types\";\n"]}

package/dist/data-objects/pureDataObject.d.ts

@@ -9,22 +9,15 @@ import { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
 import { IDirectory } from "@fluidframework/map";
 import { EventForwarder } from "@fluidframework/common-utils";
 import { IEvent } from "@fluidframework/common-definitions";
-export interface IDataObjectProps<O = object, S = undefined> {
-    readonly runtime: IFluidDataStoreRuntime;
-    readonly context: IFluidDataStoreContext;
-    readonly providers: AsyncFluidObjectProvider<FluidObjectKey<O>, FluidObjectKey<object>>;
-    readonly initProps?: S;
-}
+import { DataObjectTypes, DataObjectType, IDataObjectProps } from "./types";
 /**
  * This is a bare-bones base class that does basic setup and enables for factory on an initialize call.
  * You probably don't want to inherit from this data store directly unless
  * you are creating another base data store class
  *
- * @typeParam O - represents a type that will define optional providers that will be injected
- * @typeParam S - the initial state type that the produced data object may take during creation
- * @typeParam E - represents events that will be available in the EventForwarder
+ * @typeParam I - The optional input types used to strongly type the data object
  */
-export declare abstract class PureDataObject<O extends IFluidObject = object, S = undefined, E extends IEvent = IEvent> extends EventForwarder<E> implements IFluidLoadable, IFluidRouter, IProvideFluidHandle, IFluidObject {
+export declare abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes> extends EventForwarder<DataObjectType<I, "Events">> implements IFluidLoadable, IFluidRouter, IProvideFluidHandle, IFluidObject {
     private readonly innerHandle;
     private _disposed;
     /**
@@ -42,8 +35,8 @@ export declare abstract class PureDataObject<O extends IFluidObject = object, S
      *
      * To define providers set IFluidObject interfaces in the generic O type for your data store
      */
-    protected readonly providers: AsyncFluidObjectProvider<FluidObjectKey<O>, FluidObjectKey<object>>;
-    protected initProps?: S;
+    protected readonly providers: AsyncFluidObjectProvider<FluidObjectKey<DataObjectType<I, "OptionalProviders">>, FluidObjectKey<object>>;
+    protected initProps?: DataObjectType<I, "InitialState">;
     protected initializeP: Promise<void> | undefined;
     get disposed(): boolean;
     get id(): string;
@@ -54,8 +47,8 @@ export declare abstract class PureDataObject<O extends IFluidObject = object, S
      * Handle to a data store
      */
     get handle(): IFluidHandle<this>;
-    static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject<object, undefined, IEvent>>;
-    constructor(props: IDataObjectProps<O, S>);
+    static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject<DataObjectTypes>>;
+    constructor(props: IDataObjectProps<I>);
     /**
      * Return this object if someone requests it directly
      * We will return this object in two scenarios:
@@ -110,7 +103,7 @@ export declare abstract class PureDataObject<O extends IFluidObject = object, S
      *
      * @param props - Optional props to be passed in on create
      */
-    protected initializingFirstTime(props?: S): Promise<void>;
+    protected initializingFirstTime(props?: DataObjectType<I, "InitialState">): Promise<void>;
     /**
      * Called every time but the first time the data store is initialized (creations
      * with an existing data store runtime)
@@ -125,4 +118,22 @@ export declare abstract class PureDataObject<O extends IFluidObject = object, S
      */
     dispose(): void;
 }
+/**
+ * @deprecated - This type is meant to ease the transition from the old PureDataObject type to the new.
+ * please migrate to PureDataObject.
+ *
+ * This is a bare-bones base class that does basic setup and enables for factory on an initialize call.
+ * You probably don't want to inherit from this data store directly unless
+ * you are creating another base data store class
+ *
+ * @typeParam O - represents a type that will define optional providers that will be injected
+ * @typeParam S - the initial state type that the produced data object may take during creation
+ * @typeParam E - represents events that will be available in the EventForwarder
+ */
+export declare abstract class LegacyPureDataObject<O extends IFluidObject = object, S = undefined, E extends IEvent = IEvent> extends PureDataObject<{
+    OptionalProviders: O;
+    InitialState: S;
+    Events: E;
+}> {
+}
 //# sourceMappingURL=pureDataObject.d.ts.map