@fluidframework/aqueduct 0.52.1 → 0.53.0-46105

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

@@ -1 +1 @@
-{"version":3,"file":"pureDataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/pureDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,WAAW,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAE/E,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAU,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAM5D,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS;IACvD,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEzC,QAAQ,CAAC,SAAS,EAAE,wBAAwB,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IACxF,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;CAC1B;AAED;;;;;;;;GAQG;AAEH,8BAAsB,cAAc,CAAC,CAAC,SAAS,YAAY,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CAC1G,SAAQ,cAAc,CAAC,CAAC,CACxB,YAAW,cAAc,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY;IAC1E,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,SAAS,CAAS;IAE1B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEnD;;;;;;OAMG;IAEH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,wBAAwB,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAElG,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAExB,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD,IAAW,QAAQ,YAA6B;IAEhD,IAAW,EAAE,WAA8B;IAC3C,IAAW,YAAY,SAAmB;IAC1C,IAAW,cAAc,SAAmB;IAC5C,IAAW,YAAY,uBAA+B;IAEtD;;OAEG;IACH,IAAW,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAA6B;WAEhD,aAAa,CAAC,OAAO,EAAE,sBAAsB;gBAO9C,KAAK,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC;IAwBhD;;;;;OAKG;IACU,OAAO,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAUvD;;;;;;OAMG;IACU,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnE;;;;;;OAMG;IACU,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAYjE;;;;;;;OAOG;IACU,2BAA2B,CAAC,CAAC,SAAS,YAAY,GAAG,WAAW,GAAG,cAAc,EAC1F,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,UAAU,EACrB,sBAAsB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,KAAK,MAAM,GAAG,YAAY,GAAG,SAAS,GACjG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAgB1B;;;;OAIG;cACa,yBAAyB,CAAC,CAAC,SAAS,YAAY,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAIzF;;;OAGG;cACa,UAAU,CAAC,CAAC,SAAS,YAAY,GAAG,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAIxF;;;OAGG;cACa,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9C;;;;;OAKG;cACa,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D;;;OAGG;cACa,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEzD;;OAEG;cACa,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAE/C;;OAEG;IACI,OAAO,IAAI,IAAI;CAGzB"}
+{"version":3,"file":"pureDataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/pureDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,WAAW,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAE/E,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAU,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAEtE,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAG5D,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE5E;;;;;;GAMG;AACH,8BAAsB,cAAc,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,CAC5E,SAAQ,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,CAClD,YAAW,cAAc,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY;IAC1E,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,SAAS,CAAS;IAE1B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAEnD;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAExB,wBAAwB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAE7G,SAAS,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;IAExD,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAEjD,IAAW,QAAQ,YAA6B;IAEhD,IAAW,EAAE,WAA8B;IAC3C,IAAW,YAAY,SAAmB;IAC1C,IAAW,cAAc,SAAmB;IAC5C,IAAW,YAAY,uBAA+B;IAEtD;;OAEG;IACH,IAAW,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAA6B;WAEhD,aAAa,CAAC,OAAO,EAAE,sBAAsB;gBAO9C,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAwB7C;;;;;OAKG;IACU,OAAO,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;IAUvD;;;;;;OAMG;IACU,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnE;;;;;;OAMG;IACU,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAajE;;;;;;;OAOG;IACU,2BAA2B,CAAC,CAAC,SAAS,YAAY,GAAG,WAAW,GAAG,cAAc,EAC1F,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,UAAU,EACrB,sBAAsB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,KAAK,MAAM,GAAG,YAAY,GAAG,SAAS,GACjG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAgB1B;;;;OAIG;cACa,yBAAyB,CAAC,CAAC,SAAS,YAAY,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAIzF;;;OAGG;cACa,UAAU,CAAC,CAAC,SAAS,YAAY,GAAG,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAIxF;;;OAGG;cACa,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9C;;;;;OAKG;cACa,qBAAqB,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/F;;;OAGG;cACa,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEzD;;OAEG;cACa,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAE/C;;OAEG;IACI,OAAO,IAAI,IAAI;CAGzB;AAED;;;;;;;;;;;GAWG;AAEH,8BAAsB,oBAAoB,CAAC,CAAC,SAAS,YAAY,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CACpH,SAAQ,cAAc,CAAC;IAAC,iBAAiB,EAAE,CAAC,CAAC;IAAC,YAAY,EAAE,CAAC,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAC,CAAC;CAEzE"}

package/dist/data-objects/pureDataObject.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PureDataObject = void 0;
+exports.LegacyPureDataObject = exports.PureDataObject = void 0;
 const datastore_1 = require("@fluidframework/datastore");
 const common_utils_1 = require("@fluidframework/common-utils");
 const request_handler_1 = require("@fluidframework/request-handler");
@@ -15,11 +15,8 @@ const request_handlers_1 = require("../request-handlers");
  * 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
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 class PureDataObject extends common_utils_1.EventForwarder {
     constructor(props) {
         super();
@@ -169,4 +166,20 @@ class PureDataObject extends common_utils_1.EventForwarder {
     }
 }
 exports.PureDataObject = PureDataObject;
+/**
+ * @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
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+class LegacyPureDataObject extends PureDataObject {
+}
+exports.LegacyPureDataObject = LegacyPureDataObject;
 //# sourceMappingURL=pureDataObject.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"pureDataObject.js","sourceRoot":"","sources":["../../src/data-objects/pureDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAeH,yDAA8D;AAE9D,+DAAsE;AAEtE,qEAAsE;AACtE,8DAA6D;AAC7D,0DAAuE;AAWvE;;;;;;;;GAQG;AACH,wDAAwD;AACxD,MAAsB,cAClB,SAAQ,6BAAiB;IAgDzB,YAAmB,KAA6B;QAC5C,KAAK,EAAE,CAAC;QA9CJ,cAAS,GAAG,KAAK,CAAC;QA+CtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAEjC,qBAAM,CAAE,IAAI,CAAC,OAAe,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAC7G,IAAI,CAAC,OAAe,CAAC,WAAW,GAAG,IAAI,CAAC;QAEzC,8GAA8G;QAC9G,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,WAAW,GAAG,IAAI,6BAAiB,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvF,2BAA2B;QAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAvCD,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,IAAW,EAAE,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1C,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC5C,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACH,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAE7D,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAA+B;QAC7D,MAAM,GAAG,GAAI,OAAe,CAAC,WAA6B,CAAC;QAC3D,qBAAM,CAAC,GAAG,KAAK,SAAS,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACpE,MAAM,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC;IACf,CAAC;IAwBD,uBAAuB;IAEvB;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,GAAa;QAC9B,OAAO,mDAAgC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;IAED,0BAA0B;IAE1B,yBAAyB;IAEzB,4BAA4B;IAE5B;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAAC,QAAiB;QAC/C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAChC,OAAO,IAAI,CAAC,WAAW,CAAC;SAC3B;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,kBAAkB,CAAC,QAAiB;;QAC7C,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3B,IAAI,QAAQ,EAAE;YACV,qBAAM,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,EAC/B,KAAK,CAAC,kEAAkE,CAAC,CAAC;YAC9E,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;SACzC;aAAM;YACH,MAAM,IAAI,CAAC,qBAAqB,OAAC,IAAI,CAAC,OAAO,CAAC,WAAgB,mCAAI,IAAI,CAAC,SAAS,CAAC,CAAC;SACrF;QACD,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,2BAA2B,CACpC,GAAW,EACX,SAAqB,EACrB,sBAAiG;QAEjG,MAAM,UAAU,GAAG,sBAAsB,CAAC,CAAC,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxG,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAChC,oDAAoD;YACpD,2FAA2F;YAC3F,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAI,UAAU,CAAC,CAAC;YACxE,IAAI,WAAW,CAAC,cAAc,IAAI,WAAW,CAAC,MAAM,EAAE;gBAClD,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;aAC1C;YACD,OAAO,WAAW,CAAC;SACtB;aAAM;YACH,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,YAAY,CAAC;YACxC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAM,CAAC;SACnF;IACL,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,yBAAyB,CAAyB,EAAU;QACxE,OAAO,qCAAmB,CAAI,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,EAAE,CAAC;IACjF,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,UAAU,CAAuC,EAAU;QACvE,OAAO,qCAAmB,CAAI,IAAI,yCAAoB,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,EAAE,CAAC;IACzG,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,KAAoB,CAAC;IAElD;;;;;OAKG;IACO,KAAK,CAAC,qBAAqB,CAAC,KAAS,IAAmB,CAAC;IAEnE;;;OAGG;IACO,KAAK,CAAC,wBAAwB,KAAoB,CAAC;IAE7D;;OAEG;IACO,KAAK,CAAC,cAAc,KAAoB,CAAC;IAEnD;;OAEG;IACI,OAAO;QACV,KAAK,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC;CACJ;AAvMD,wCAuMC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidObject,\n    IFluidHandle,\n    IFluidLoadable,\n    IFluidRouter,\n    IProvideFluidHandle,\n    IRequest,\n    IResponse,\n    FluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport { AsyncFluidObjectProvider, FluidObjectKey } from \"@fluidframework/synthesize\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\nimport { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { FluidObjectHandle } from \"@fluidframework/datastore\";\nimport { IDirectory } from \"@fluidframework/map\";\nimport { assert, EventForwarder } from \"@fluidframework/common-utils\";\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { handleFromLegacyUri } from \"@fluidframework/request-handler\";\nimport { serviceRoutePathRoot } from \"../container-services\";\nimport { defaultFluidObjectRequestHandler } from \"../request-handlers\";\n\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport interface IDataObjectProps<O = object, S = undefined> {\n    readonly runtime: IFluidDataStoreRuntime;\n    readonly context: IFluidDataStoreContext;\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    readonly providers: AsyncFluidObjectProvider<FluidObjectKey<O>, FluidObjectKey<object>>;\n    readonly initProps?: S;\n}\n\n/**\n * This is a bare-bones base class that does basic setup and enables for factory on an initialize call.\n * You probably don't want to inherit from this data store directly unless\n * you are creating another base data store class\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 PureDataObject<O extends IFluidObject = object, S = undefined, E extends IEvent = IEvent>\n    extends EventForwarder<E>\n    implements IFluidLoadable, IFluidRouter, IProvideFluidHandle, IFluidObject {\n    private readonly innerHandle: IFluidHandle<this>;\n    private _disposed = false;\n\n    /**\n     * This is your FluidDataStoreRuntime object\n     */\n    protected readonly runtime: IFluidDataStoreRuntime;\n\n    /**\n     * This context is used to talk up to the ContainerRuntime\n     */\n    protected readonly context: IFluidDataStoreContext;\n\n    /**\n     * Providers are IFluidObject keyed objects that provide back\n     * a promise to the corresponding IFluidObject or undefined.\n     * Providers injected/provided by the Container and/or HostingApplication\n     *\n     * To define providers set IFluidObject interfaces in the generic O type for your data store\n     */\n    // eslint-disable-next-line @typescript-eslint/ban-types\n    protected readonly providers: AsyncFluidObjectProvider<FluidObjectKey<O>, FluidObjectKey<object>>;\n\n    protected initProps?: S;\n\n    protected initializeP: Promise<void> | undefined;\n\n    public get disposed() { return this._disposed; }\n\n    public get id() { return this.runtime.id; }\n    public get IFluidRouter() { return this; }\n    public get IFluidLoadable() { return this; }\n    public get IFluidHandle() { return this.innerHandle; }\n\n    /**\n     * Handle to a data store\n     */\n    public get handle(): IFluidHandle<this> { return this.innerHandle; }\n\n    public static async getDataObject(runtime: IFluidDataStoreRuntime) {\n        const obj = (runtime as any)._dataObject as PureDataObject;\n        assert(obj !== undefined, 0x0bc /* \"Runtime has no DataObject!\" */);\n        await obj.finishInitialization(true);\n        return obj;\n    }\n\n    public constructor(props: IDataObjectProps<O, S>) {\n        super();\n        this.runtime = props.runtime;\n        this.context = props.context;\n        this.providers = props.providers;\n        this.initProps = props.initProps;\n\n        assert((this.runtime as any)._dataObject === undefined, 0x0bd /* \"Object runtime already has DataObject!\" */);\n        (this.runtime as any)._dataObject = this;\n\n        // Create a FluidObjectHandle with empty string as `path`. This is because reaching this PureDataObject is the\n        // same as reaching its routeContext (FluidDataStoreRuntime) so there is so the relative path to it from the\n        // routeContext is empty.\n        this.innerHandle = new FluidObjectHandle(this, \"\", this.runtime.objectsRoutingContext);\n\n        // Container event handlers\n        this.runtime.once(\"dispose\", () => {\n            this._disposed = true;\n            this.dispose();\n        });\n    }\n\n    // #region IFluidRouter\n\n    /**\n     * Return this object if someone requests it directly\n     * We will return this object in two scenarios:\n     *  1. the request url is a \"/\"\n     *  2. the request url is empty\n     */\n    public async request(req: IRequest): Promise<IResponse> {\n        return defaultFluidObjectRequestHandler(this, req);\n    }\n\n    // #endregion IFluidRouter\n\n    // #region IFluidLoadable\n\n    // #endregion IFluidLoadable\n\n    /**\n     * Call this API to ensure PureDataObject is fully initialized\n     * initialization happens on demand, only on as-needed bases.\n     * In most cases you should allow factory/object to decide when to finish initialization.\n     * But if you are supplying your own implementation of DataStoreRuntime factory and overriding some methods\n     * and need fully initialized object, then you can call this API to ensure object is fully initialized.\n     */\n    public async finishInitialization(existing: boolean): Promise<void> {\n        if (this.initializeP !== undefined) {\n            return this.initializeP;\n        }\n        this.initializeP = this.initializeInternal(existing);\n        return this.initializeP;\n    }\n\n    /**\n     * Internal initialize implementation. Overwriting this will change the flow of the PureDataObject and should\n     * generally not be done.\n     *\n     * Calls initializingFirstTime, initializingFromExisting, and hasInitialized. Caller is\n     * responsible for ensuring this is only invoked once.\n     */\n    public async initializeInternal(existing: boolean): Promise<void> {\n        await this.preInitialize();\n        if (existing) {\n            assert(this.initProps === undefined,\n                0x0be /* \"Trying to initialize from existing while initProps is set!\" */);\n            await this.initializingFromExisting();\n        } else {\n            await this.initializingFirstTime(this.context.createProps as S ?? this.initProps);\n        }\n        await this.hasInitialized();\n    }\n\n    /**\n     * Retreive Fluid object using the handle get or the older requestFluidObject_UNSAFE call to fetch by ID\n     *\n     * @param key - key that object (handle/id) is stored with in the directory\n     * @param directory - directory containing the object\n     * @param getObjectFromDirectory - optional callback for fetching object from the directory, allows users to\n     * define custom types/getters for object retrieval\n     */\n    public async getFluidObjectFromDirectory<T extends IFluidObject & FluidObject & IFluidLoadable>(\n        key: string,\n        directory: IDirectory,\n        getObjectFromDirectory?: (id: string, directory: IDirectory) => string | IFluidHandle | undefined):\n        Promise<T | undefined> {\n        const handleOrId = getObjectFromDirectory ? getObjectFromDirectory(key, directory) : directory.get(key);\n        if (typeof handleOrId === \"string\") {\n            // For backwards compatibility with older stored IDs\n            // We update the storage with the handle so that this code path is less and less trafficked\n            const fluidObject = await this.requestFluidObject_UNSAFE<T>(handleOrId);\n            if (fluidObject.IFluidLoadable && fluidObject.handle) {\n                directory.set(key, fluidObject.handle);\n            }\n            return fluidObject;\n        } else {\n            const handle = handleOrId?.IFluidHandle;\n            return await (handle ? handle.get() : this.requestFluidObject_UNSAFE(key)) as T;\n        }\n    }\n\n    /**\n     * @deprecated\n     * Gets the data store of a given id. Will follow the pattern of the container for waiting.\n     * @param id - data store id\n     */\n    protected async requestFluidObject_UNSAFE<T extends IFluidObject>(id: string): Promise<T> {\n        return handleFromLegacyUri<T>(`/${id}`, this.context.containerRuntime).get();\n    }\n\n    /**\n     * Gets the service at a given id.\n     * @param id - service id\n     */\n    protected async getService<T extends IFluidObject & FluidObject>(id: string): Promise<T> {\n        return handleFromLegacyUri<T>(`/${serviceRoutePathRoot}/${id}`, this.context.containerRuntime).get();\n    }\n\n    /**\n     * Called every time the data store is initialized, before initializingFirstTime or\n     * initializingFromExisting is called.\n     */\n    protected async preInitialize(): Promise<void> { }\n\n    /**\n     * Called the first time the data store is initialized (new creations with a new\n     * data store runtime)\n     *\n     * @param props - Optional props to be passed in on create\n     */\n    protected async initializingFirstTime(props?: S): Promise<void> { }\n\n    /**\n     * Called every time but the first time the data store is initialized (creations\n     * with an existing data store runtime)\n     */\n    protected async initializingFromExisting(): Promise<void> { }\n\n    /**\n     * Called every time the data store is initialized after create or existing.\n     */\n    protected async hasInitialized(): Promise<void> { }\n\n    /**\n     * Called when the host container closes and disposes itself\n     */\n    public dispose(): void {\n        super.dispose();\n    }\n}\n"]}
+{"version":3,"file":"pureDataObject.js","sourceRoot":"","sources":["../../src/data-objects/pureDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAeH,yDAA8D;AAE9D,+DAAsE;AACtE,qEAAsE;AAEtE,8DAA6D;AAC7D,0DAAuE;AAGvE;;;;;;GAMG;AACH,MAAsB,cAClB,SAAQ,6BAA2C;IAiDnD,YAAmB,KAA0B;QACzC,KAAK,EAAE,CAAC;QA/CJ,cAAS,GAAG,KAAK,CAAC;QAgDtB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAEjC,qBAAM,CAAE,IAAI,CAAC,OAAe,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAC7G,IAAI,CAAC,OAAe,CAAC,WAAW,GAAG,IAAI,CAAC;QAEzC,8GAA8G;QAC9G,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,WAAW,GAAG,IAAI,6BAAiB,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvF,2BAA2B;QAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAvCD,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,IAAW,EAAE,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1C,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC5C,IAAW,YAAY,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACH,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAE7D,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAA+B;QAC7D,MAAM,GAAG,GAAI,OAAe,CAAC,WAA6B,CAAC;QAC3D,qBAAM,CAAC,GAAG,KAAK,SAAS,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACpE,MAAM,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC;IACf,CAAC;IAwBD,uBAAuB;IAEvB;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,GAAa;QAC9B,OAAO,mDAAgC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;IAED,0BAA0B;IAE1B,yBAAyB;IAEzB,4BAA4B;IAE5B;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAAC,QAAiB;QAC/C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAChC,OAAO,IAAI,CAAC,WAAW,CAAC;SAC3B;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,kBAAkB,CAAC,QAAiB;;QAC7C,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3B,IAAI,QAAQ,EAAE;YACV,qBAAM,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,EAC/B,KAAK,CAAC,kEAAkE,CAAC,CAAC;YAC9E,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;SACzC;aAAM;YACH,MAAM,IAAI,CAAC,qBAAqB,OAC5B,IAAI,CAAC,OAAO,CAAC,WAAgD,mCAAI,IAAI,CAAC,SAAS,CAAC,CAAC;SACxF;QACD,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,2BAA2B,CACpC,GAAW,EACX,SAAqB,EACrB,sBAAiG;QAEjG,MAAM,UAAU,GAAG,sBAAsB,CAAC,CAAC,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxG,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAChC,oDAAoD;YACpD,2FAA2F;YAC3F,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAI,UAAU,CAAC,CAAC;YACxE,IAAI,WAAW,CAAC,cAAc,IAAI,WAAW,CAAC,MAAM,EAAE;gBAClD,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;aAC1C;YACD,OAAO,WAAW,CAAC;SACtB;aAAM;YACH,MAAM,MAAM,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,YAAY,CAAC;YACxC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAM,CAAC;SACnF;IACL,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,yBAAyB,CAAyB,EAAU;QACxE,OAAO,qCAAmB,CAAI,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,EAAE,CAAC;IACjF,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,UAAU,CAAuC,EAAU;QACvE,OAAO,qCAAmB,CAAI,IAAI,yCAAoB,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,EAAE,CAAC;IACzG,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,KAAoB,CAAC;IAElD;;;;;OAKG;IACO,KAAK,CAAC,qBAAqB,CAAC,KAAyC,IAAmB,CAAC;IAEnG;;;OAGG;IACO,KAAK,CAAC,wBAAwB,KAAoB,CAAC;IAE7D;;OAEG;IACO,KAAK,CAAC,cAAc,KAAoB,CAAC;IAEnD;;OAEG;IACI,OAAO;QACV,KAAK,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC;CACJ;AAzMD,wCAyMC;AAED;;;;;;;;;;;GAWG;AACH,wDAAwD;AACxD,MAAsB,oBACtB,SAAQ,cAAkE;CAEzE;AAHD,oDAGC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IFluidObject,\n    IFluidHandle,\n    IFluidLoadable,\n    IFluidRouter,\n    IProvideFluidHandle,\n    IRequest,\n    IResponse,\n    FluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport { AsyncFluidObjectProvider, FluidObjectKey } from \"@fluidframework/synthesize\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\nimport { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { FluidObjectHandle } from \"@fluidframework/datastore\";\nimport { IDirectory } from \"@fluidframework/map\";\nimport { assert, EventForwarder } from \"@fluidframework/common-utils\";\nimport { handleFromLegacyUri } from \"@fluidframework/request-handler\";\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { serviceRoutePathRoot } from \"../container-services\";\nimport { defaultFluidObjectRequestHandler } from \"../request-handlers\";\nimport { DataObjectTypes, DataObjectType, IDataObjectProps } from \"./types\";\n\n/**\n * This is a bare-bones base class that does basic setup and enables for factory on an initialize call.\n * You probably don't want to inherit from this data store directly unless\n * you are creating another base data store class\n *\n * @typeParam I - The optional input types used to strongly type the data object\n */\nexport abstract class PureDataObject<I extends DataObjectTypes = DataObjectTypes>\n    extends EventForwarder<DataObjectType<I, \"Events\">>\n    implements IFluidLoadable, IFluidRouter, IProvideFluidHandle, IFluidObject {\n    private readonly innerHandle: IFluidHandle<this>;\n    private _disposed = false;\n\n    /**\n     * This is your FluidDataStoreRuntime object\n     */\n    protected readonly runtime: IFluidDataStoreRuntime;\n\n    /**\n     * This context is used to talk up to the ContainerRuntime\n     */\n    protected readonly context: IFluidDataStoreContext;\n\n    /**\n     * Providers are IFluidObject keyed objects that provide back\n     * a promise to the corresponding IFluidObject or undefined.\n     * Providers injected/provided by the Container and/or HostingApplication\n     *\n     * To define providers set IFluidObject interfaces in the generic O type for your data store\n     */\n    protected readonly providers:\n        // eslint-disable-next-line @typescript-eslint/ban-types\n        AsyncFluidObjectProvider<FluidObjectKey<DataObjectType<I, \"OptionalProviders\">>, FluidObjectKey<object>>;\n\n    protected initProps?: DataObjectType<I, \"InitialState\">;\n\n    protected initializeP: Promise<void> | undefined;\n\n    public get disposed() { return this._disposed; }\n\n    public get id() { return this.runtime.id; }\n    public get IFluidRouter() { return this; }\n    public get IFluidLoadable() { return this; }\n    public get IFluidHandle() { return this.innerHandle; }\n\n    /**\n     * Handle to a data store\n     */\n    public get handle(): IFluidHandle<this> { return this.innerHandle; }\n\n    public static async getDataObject(runtime: IFluidDataStoreRuntime) {\n        const obj = (runtime as any)._dataObject as PureDataObject;\n        assert(obj !== undefined, 0x0bc /* \"Runtime has no DataObject!\" */);\n        await obj.finishInitialization(true);\n        return obj;\n    }\n\n    public constructor(props: IDataObjectProps<I>) {\n        super();\n        this.runtime = props.runtime;\n        this.context = props.context;\n        this.providers = props.providers;\n        this.initProps = props.initProps;\n\n        assert((this.runtime as any)._dataObject === undefined, 0x0bd /* \"Object runtime already has DataObject!\" */);\n        (this.runtime as any)._dataObject = this;\n\n        // Create a FluidObjectHandle with empty string as `path`. This is because reaching this PureDataObject is the\n        // same as reaching its routeContext (FluidDataStoreRuntime) so there is so the relative path to it from the\n        // routeContext is empty.\n        this.innerHandle = new FluidObjectHandle(this, \"\", this.runtime.objectsRoutingContext);\n\n        // Container event handlers\n        this.runtime.once(\"dispose\", () => {\n            this._disposed = true;\n            this.dispose();\n        });\n    }\n\n    // #region IFluidRouter\n\n    /**\n     * Return this object if someone requests it directly\n     * We will return this object in two scenarios:\n     *  1. the request url is a \"/\"\n     *  2. the request url is empty\n     */\n    public async request(req: IRequest): Promise<IResponse> {\n        return defaultFluidObjectRequestHandler(this, req);\n    }\n\n    // #endregion IFluidRouter\n\n    // #region IFluidLoadable\n\n    // #endregion IFluidLoadable\n\n    /**\n     * Call this API to ensure PureDataObject is fully initialized\n     * initialization happens on demand, only on as-needed bases.\n     * In most cases you should allow factory/object to decide when to finish initialization.\n     * But if you are supplying your own implementation of DataStoreRuntime factory and overriding some methods\n     * and need fully initialized object, then you can call this API to ensure object is fully initialized.\n     */\n    public async finishInitialization(existing: boolean): Promise<void> {\n        if (this.initializeP !== undefined) {\n            return this.initializeP;\n        }\n        this.initializeP = this.initializeInternal(existing);\n        return this.initializeP;\n    }\n\n    /**\n     * Internal initialize implementation. Overwriting this will change the flow of the PureDataObject and should\n     * generally not be done.\n     *\n     * Calls initializingFirstTime, initializingFromExisting, and hasInitialized. Caller is\n     * responsible for ensuring this is only invoked once.\n     */\n    public async initializeInternal(existing: boolean): Promise<void> {\n        await this.preInitialize();\n        if (existing) {\n            assert(this.initProps === undefined,\n                0x0be /* \"Trying to initialize from existing while initProps is set!\" */);\n            await this.initializingFromExisting();\n        } else {\n            await this.initializingFirstTime(\n                this.context.createProps as DataObjectType<I, \"InitialState\"> ?? this.initProps);\n        }\n        await this.hasInitialized();\n    }\n\n    /**\n     * Retreive Fluid object using the handle get or the older requestFluidObject_UNSAFE call to fetch by ID\n     *\n     * @param key - key that object (handle/id) is stored with in the directory\n     * @param directory - directory containing the object\n     * @param getObjectFromDirectory - optional callback for fetching object from the directory, allows users to\n     * define custom types/getters for object retrieval\n     */\n    public async getFluidObjectFromDirectory<T extends IFluidObject & FluidObject & IFluidLoadable>(\n        key: string,\n        directory: IDirectory,\n        getObjectFromDirectory?: (id: string, directory: IDirectory) => string | IFluidHandle | undefined):\n        Promise<T | undefined> {\n        const handleOrId = getObjectFromDirectory ? getObjectFromDirectory(key, directory) : directory.get(key);\n        if (typeof handleOrId === \"string\") {\n            // For backwards compatibility with older stored IDs\n            // We update the storage with the handle so that this code path is less and less trafficked\n            const fluidObject = await this.requestFluidObject_UNSAFE<T>(handleOrId);\n            if (fluidObject.IFluidLoadable && fluidObject.handle) {\n                directory.set(key, fluidObject.handle);\n            }\n            return fluidObject;\n        } else {\n            const handle = handleOrId?.IFluidHandle;\n            return await (handle ? handle.get() : this.requestFluidObject_UNSAFE(key)) as T;\n        }\n    }\n\n    /**\n     * @deprecated\n     * Gets the data store of a given id. Will follow the pattern of the container for waiting.\n     * @param id - data store id\n     */\n    protected async requestFluidObject_UNSAFE<T extends IFluidObject>(id: string): Promise<T> {\n        return handleFromLegacyUri<T>(`/${id}`, this.context.containerRuntime).get();\n    }\n\n    /**\n     * Gets the service at a given id.\n     * @param id - service id\n     */\n    protected async getService<T extends IFluidObject & FluidObject>(id: string): Promise<T> {\n        return handleFromLegacyUri<T>(`/${serviceRoutePathRoot}/${id}`, this.context.containerRuntime).get();\n    }\n\n    /**\n     * Called every time the data store is initialized, before initializingFirstTime or\n     * initializingFromExisting is called.\n     */\n    protected async preInitialize(): Promise<void> { }\n\n    /**\n     * Called the first time the data store is initialized (new creations with a new\n     * data store runtime)\n     *\n     * @param props - Optional props to be passed in on create\n     */\n    protected async initializingFirstTime(props?: DataObjectType<I, \"InitialState\">): Promise<void> { }\n\n    /**\n     * Called every time but the first time the data store is initialized (creations\n     * with an existing data store runtime)\n     */\n    protected async initializingFromExisting(): Promise<void> { }\n\n    /**\n     * Called every time the data store is initialized after create or existing.\n     */\n    protected async hasInitialized(): Promise<void> { }\n\n    /**\n     * Called when the host container closes and disposes itself\n     */\n    public dispose(): void {\n        super.dispose();\n    }\n}\n\n/**\n * @deprecated - This type is meant to ease the transition from the old PureDataObject type to the new.\n * please migrate to PureDataObject.\n *\n * This is a bare-bones base class that does basic setup and enables for factory on an initialize call.\n * You probably don't want to inherit from this data store directly unless\n * you are creating another base data store class\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 LegacyPureDataObject<O extends IFluidObject = object, S = undefined, E extends IEvent = IEvent>\nextends PureDataObject<{OptionalProviders: O, InitialState: S, Events: E}> {\n\n}\n"]}

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

@@ -0,0 +1,38 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FluidObject } from "@fluidframework/core-interfaces";
+import { AsyncFluidObjectProvider, FluidObjectKey } from "@fluidframework/synthesize";
+import { IFluidDataStoreContext } from "@fluidframework/runtime-definitions";
+import { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
+import { IEvent } from "@fluidframework/common-definitions";
+/**
+ * This type is used as the base generic input to DataObject and PureDataObject.
+ */
+export interface DataObjectTypes {
+    /**
+     * 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
+     */
+    InitialState?: any;
+    /**
+     * represents events that will be available in the EventForwarder
+     */
+    Events?: IEvent;
+}
+/**
+ * @internal This utility type pulls a specific key's type off the T and returns that,
+ *  or the default value if TKey is not specified by T
+ */
+export declare type DataObjectType<T extends DataObjectTypes, P extends keyof DataObjectTypes> = T[P] extends Required<DataObjectTypes>[P] ? T[P] : Required<DataObjectTypes>[P];
+export interface IDataObjectProps<I extends DataObjectTypes = DataObjectTypes> {
+    readonly runtime: IFluidDataStoreRuntime;
+    readonly context: IFluidDataStoreContext;
+    readonly providers: AsyncFluidObjectProvider<FluidObjectKey<DataObjectType<I, "OptionalProviders">>, FluidObjectKey<object>>;
+    readonly initProps?: DataObjectType<I, "InitialState">;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/data-objects/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,WAAW,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,oBAAY,cAAc,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,SAAS,MAAM,eAAe,IACjF,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpF,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe;IACzE,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;IACzC,QAAQ,CAAC,SAAS,EAEd,wBAAwB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7G,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;CAC1D"}

package/dist/data-objects/types.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/data-objects/types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    FluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport { AsyncFluidObjectProvider, FluidObjectKey } from \"@fluidframework/synthesize\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\nimport { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { IEvent } from \"@fluidframework/common-definitions\";\n\n/**\n * This type is used as the base generic input to DataObject and PureDataObject.\n */\nexport interface DataObjectTypes {\n    /**\n     * represents a type that will define optional providers that will be injected\n     */\n    OptionalProviders?: FluidObject;\n    /**\n     * the initial state type that the produced data object may take during creation\n     */\n    InitialState?: any;\n    /**\n     * represents events that will be available in the EventForwarder\n     */\n    Events?: IEvent;\n}\n\n/**\n * @internal This utility type pulls a specific key's type off the T and returns that,\n *  or the default value if TKey is not specified by T\n */\nexport type DataObjectType<T extends DataObjectTypes, P extends keyof DataObjectTypes> =\n    T[P] extends Required<DataObjectTypes>[P] ? T[P] : Required<DataObjectTypes>[P];\n\nexport interface IDataObjectProps<I extends DataObjectTypes = DataObjectTypes> {\n    readonly runtime: IFluidDataStoreRuntime;\n    readonly context: IFluidDataStoreContext;\n    readonly providers:\n        // eslint-disable-next-line @typescript-eslint/ban-types\n        AsyncFluidObjectProvider<FluidObjectKey<DataObjectType<I, \"OptionalProviders\">>, FluidObjectKey<object>>;\n    readonly initProps?: DataObjectType<I, \"InitialState\">;\n}\n"]}

package/dist/test/tsconfig.tsbuildinfo

@@ -512,8 +512,8 @@
         "affectsGlobalScope": false
       },
       "../../../../../node_modules/@fluidframework/driver-definitions/dist/storage.d.ts": {
-        "version": "28e09f23abd4523e5083fc29c2670a51afdd52b956ad3a57489723f6d87c7459",
-        "signature": "28e09f23abd4523e5083fc29c2670a51afdd52b956ad3a57489723f6d87c7459",
+        "version": "ef7847f144b1dc6c9cd593ab72e12de76ed2d3b90b6f45414889576f8489a4d3",
+        "signature": "ef7847f144b1dc6c9cd593ab72e12de76ed2d3b90b6f45414889576f8489a4d3",
         "affectsGlobalScope": false
       },
       "../../../../../node_modules/@fluidframework/driver-definitions/dist/index.d.ts": {
@@ -537,8 +537,8 @@
         "affectsGlobalScope": false
       },
       "../../../../../node_modules/@fluidframework/container-definitions/dist/loader.d.ts": {
-        "version": "c1964a286f2a0b9ec291ccae2904e12b7b985cbf4ecca3fdaf1305e5af5a4226",
-        "signature": "c1964a286f2a0b9ec291ccae2904e12b7b985cbf4ecca3fdaf1305e5af5a4226",
+        "version": "65aa9719d96da5f625dfe938acca2ce2b1327e81531ecb7a54cc65e97be5f9be",
+        "signature": "65aa9719d96da5f625dfe938acca2ce2b1327e81531ecb7a54cc65e97be5f9be",
         "affectsGlobalScope": false
       },
       "../../../../../node_modules/@fluidframework/container-definitions/dist/runtime.d.ts": {
@@ -577,8 +577,8 @@
         "affectsGlobalScope": false
       },
       "../../../../runtime/runtime-definitions/dist/summary.d.ts": {
-        "version": "b57adc2f38034b6b33004bd05523b5384ffc9953dfa9c71c59ac6a54c64e3ff9",
-        "signature": "b57adc2f38034b6b33004bd05523b5384ffc9953dfa9c71c59ac6a54c64e3ff9",
+        "version": "858952f995ca3e0c7aac1018f41994eb6a82a05450ea880c7dd291fb6d46dfe2",
+        "signature": "858952f995ca3e0c7aac1018f41994eb6a82a05450ea880c7dd291fb6d46dfe2",
         "affectsGlobalScope": false
       },
       "../../../../runtime/runtime-definitions/dist/dataStoreContext.d.ts": {
@@ -597,8 +597,8 @@
         "affectsGlobalScope": false
       },
       "../../../../runtime/container-runtime-definitions/dist/containerRuntime.d.ts": {
-        "version": "8743da2e9e5eae7209886b19d9bcd266d95d2e4213a71e59ee7ea2d4abebab44",
-        "signature": "8743da2e9e5eae7209886b19d9bcd266d95d2e4213a71e59ee7ea2d4abebab44",
+        "version": "cdb9d3c0083999fe24831f5f26d59f3016599c32daed197f1b707bfc40abd8ab",
+        "signature": "cdb9d3c0083999fe24831f5f26d59f3016599c32daed197f1b707bfc40abd8ab",
         "affectsGlobalScope": false
       },
       "../../../../runtime/container-runtime-definitions/dist/index.d.ts": {
@@ -612,8 +612,8 @@
         "affectsGlobalScope": false
       },
       "../../../../runtime/runtime-utils/dist/dataStoreHelpers.d.ts": {
-        "version": "a8d3a3cd5b4e4f1d56e25a7e0f245d746ce79cabdfd9fdf6ea267d9a8ca4d09c",
-        "signature": "a8d3a3cd5b4e4f1d56e25a7e0f245d746ce79cabdfd9fdf6ea267d9a8ca4d09c",
+        "version": "27cb6598c6a871ea3fd18997ca98d1e22b449ee995645e7780aa490452100bb0",
+        "signature": "27cb6598c6a871ea3fd18997ca98d1e22b449ee995645e7780aa490452100bb0",
         "affectsGlobalScope": false
       },
       "../../../../runtime/datastore-definitions/dist/storage.d.ts": {
@@ -622,8 +622,8 @@
         "affectsGlobalScope": false
       },
       "../../../../runtime/datastore-definitions/dist/dataStoreRuntime.d.ts": {
-        "version": "582ca9e58c58d0cb700b1ceda9a740c2499f43eaa6985f0f3fa960fa0390e043",
-        "signature": "582ca9e58c58d0cb700b1ceda9a740c2499f43eaa6985f0f3fa960fa0390e043",
+        "version": "0c93aff251f89876dff554f17229ba2769cd1ca2791f89fe30259d3e0433c4f6",
+        "signature": "0c93aff251f89876dff554f17229ba2769cd1ca2791f89fe30259d3e0433c4f6",
         "affectsGlobalScope": false
       },
       "../../../../runtime/datastore-definitions/dist/channel.d.ts": {
@@ -687,8 +687,8 @@
         "affectsGlobalScope": false
       },
       "../../../../runtime/runtime-utils/dist/summarizerNode/summarizerNodeWithGc.d.ts": {
-        "version": "cab8081c4874069e5d937e85b3704704da8fa49948ccbfdf9e1913db3166f6f1",
-        "signature": "cab8081c4874069e5d937e85b3704704da8fa49948ccbfdf9e1913db3166f6f1",
+        "version": "66a44a7c28bcf3361f56cee242f0cb989a343bbf396f64d3065e71232042b110",
+        "signature": "66a44a7c28bcf3361f56cee242f0cb989a343bbf396f64d3065e71232042b110",
         "affectsGlobalScope": false
       },
       "../../../../runtime/runtime-utils/dist/summarizerNode/index.d.ts": {
@@ -860,6 +860,7 @@
       ],
       "../../../../../node_modules/@fluidframework/container-definitions/dist/loader.d.ts": [
         "../../../../../node_modules/@fluidframework/common-definitions/dist/index.d.ts",
+        "../../../../../node_modules/@fluidframework/container-definitions/dist/audience.d.ts",
         "../../../../../node_modules/@fluidframework/container-definitions/dist/deltas.d.ts",
         "../../../../../node_modules/@fluidframework/container-definitions/dist/error.d.ts",
         "../../../../../node_modules/@fluidframework/container-definitions/dist/fluidModule.d.ts",
@@ -1474,6 +1475,7 @@
       ],
       "../../../../../node_modules/@fluidframework/container-definitions/dist/loader.d.ts": [
         "../../../../../node_modules/@fluidframework/common-definitions/dist/index.d.ts",
+        "../../../../../node_modules/@fluidframework/container-definitions/dist/audience.d.ts",
         "../../../../../node_modules/@fluidframework/container-definitions/dist/deltas.d.ts",
         "../../../../../node_modules/@fluidframework/container-definitions/dist/error.d.ts",
         "../../../../../node_modules/@fluidframework/container-definitions/dist/fluidModule.d.ts",

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

@@ -11,9 +11,7 @@ import { PureDataObjectFactory } from "./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
  */
 export class DataObjectFactory extends PureDataObjectFactory {
     constructor(type, ctor, sharedObjects = [], optionalProviders, registryEntries, runtimeFactory = FluidDataStoreRuntime) {
@@ -30,4 +28,19 @@ export class DataObjectFactory extends PureDataObjectFactory {
         super(type, ctor, mergedObjects, optionalProviders, registryEntries, runtimeFactory);
     }
 }
+/**
+ * @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
+ */
+export class LegacyDataObjectFactory extends DataObjectFactory {
+}
 //# sourceMappingURL=dataObjectFactory.js.map

package/lib/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,OAAO,EACH,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,SAAS,GACZ,MAAM,qBAAqB,CAAC;AAO7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAGlE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;;;;;GASG;AACH,MAAM,OAAO,iBACT,SAAQ,qBAAoC;IAE5C,YACI,IAAY,EACZ,IAAiD,EACjD,gBAA4C,EAAE,EAC9C,iBAA+C,EAC/C,eAAoD,EACpD,iBAA+C,qBAAqB;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,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1E,sCAAsC;YACtC,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,CAAC;SACpD;QAED,0GAA0G;QAC1G,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,EAAE;YACpE,gCAAgC;YAChC,aAAa,CAAC,IAAI,CAAC,SAAS,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","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,OAAO,EACH,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,SAAS,GACZ,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAIlE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,OAAO,iBACT,SAAQ,qBAA8B;IAEtC,YACI,IAAY,EACZ,IAA8C,EAC9C,gBAA4C,EAAE,EAC9C,iBAAoF,EACpF,eAAoD,EACpD,iBAA+C,qBAAqB;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,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1E,sCAAsC;YACtC,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,CAAC;SACpD;QAED,0GAA0G;QAC1G,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,EAAE;YACpE,gCAAgC;YAChC,aAAa,CAAC,IAAI,CAAC,SAAS,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;AAED;;;;;;;;;;;;GAYG;AACF,MAAM,OAAO,uBACb,SAAQ,iBAA2E;CAAG","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/lib/data-object-factories/pureDataObjectFactory.js

@@ -47,9 +47,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
  */
 export class PureDataObjectFactory {
     constructor(type, ctor, sharedObjects, optionalProviders, registryEntries, runtimeClass = FluidDataStoreRuntime) {
@@ -152,4 +150,19 @@ export class PureDataObjectFactory {
         return instance;
     }
 }
+/**
+ * @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 class LegacyPureDataObjectFactory extends PureDataObjectFactory {
+}
 //# sourceMappingURL=pureDataObjectFactory.js.map

package/lib/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,OAAO,EACH,qBAAqB,EAErB,mBAAmB,GACrB,MAAM,2BAA2B,CAAC;AAEpC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAa3E,OAAO,EAEH,mBAAmB,GAEtB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAEH,cAAc,GACjB,MAAM,iBAAiB,CAAC;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,mBAAmB,CAC9B,KAAK,EAAE,OAAiB,EAAE,UAAiC,EAAE,EAAE,CAC3D,CAAC,MAAM,cAAc,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,mBAAmB,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,MAAM,OAAO,qBAAqB;IAM9B,YACoB,IAAY,EACX,IAAiD,EAClE,aAAyC,EACxB,iBAA+C,EAChE,eAAoD,EACnC,eAA6C,qBAAqB;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,sBAAsB,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","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,OAAO,EACH,qBAAqB,EAErB,mBAAmB,GACrB,MAAM,2BAA2B,CAAC;AACpC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAa3E,OAAO,EAEH,mBAAmB,GAEtB,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EAEH,cAAc,GAIjB,MAAM,iBAAiB,CAAC;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,mBAAmB,CAC9B,KAAK,EAAE,OAAiB,EAAE,UAAiC,EAAE,EAAE,CAC3D,CAAC,MAAM,cAAc,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,mBAAmB,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,MAAM,OAAO,qBAAqB;IAM9B,YACoB,IAAY,EACX,IAA8C,EAC/D,aAAyC,EACxB,iBAAoF,EACrG,eAAoD,EACnC,eAA6C,qBAAqB;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,sBAAsB,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;AAED;;;;;;;;;;;;GAYG;AACF,MAAM,OAAO,2BACb,SAAQ,qBAA8E;CAAG","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/lib/data-objects/dataObject.js

@@ -13,11 +13,8 @@ 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
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 export class DataObject extends PureDataObject {
     constructor() {
         super(...arguments);
@@ -77,4 +74,22 @@ export class DataObject extends PureDataObject {
         return `${item} must be initialized before being accessed.`;
     }
 }
+/**
+ * @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
+export class LegacyDataObject extends DataObject {
+}
 //# sourceMappingURL=dataObject.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"dataObject.js","sourceRoot":"","sources":["../../src/data-objects/dataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAoB,UAAU,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAEjF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;;;;;;GAWG;AACH,wDAAwD;AACxD,MAAM,OAAgB,UAClB,SAAQ,cAAuB;IADnC;;QAIqB,oBAAe,GAAG,MAAM,CAAC;IA2D9C,CAAC;IAzDU,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,MAAM,aAAa,GAAG,aAAa,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,iBAAiB,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,eAAe,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,UAAU,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","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,OAAO,EAAoB,UAAU,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGlD;;;;;;;;;GASG;AACH,MAAM,OAAgB,UAAwD,SAAQ,cAAiB;IAAvG;;QAGqB,oBAAe,GAAG,MAAM,CAAC;IA2D9C,CAAC;IAzDU,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,MAAM,aAAa,GAAG,aAAa,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,iBAAiB,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,eAAe,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,UAAU,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;AAED;;;;;;;;;;;;;;GAcG;AACH,wDAAwD;AACxD,MAAM,OAAgB,gBAClB,SAAQ,UAA8D;CAErE","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/lib/data-objects/index.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data-objects/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAEH,cAAc,GACjB,MAAM,kBAAkB,CAAC","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,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC","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/lib/data-objects/pureDataObject.js

@@ -12,11 +12,8 @@ import { defaultFluidObjectRequestHandler } from "../request-handlers";
  * 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
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 export class PureDataObject extends EventForwarder {
     constructor(props) {
         super();
@@ -165,4 +162,19 @@ export class PureDataObject extends EventForwarder {
         super.dispose();
     }
 }
+/**
+ * @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
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+export class LegacyPureDataObject extends PureDataObject {
+}
 //# sourceMappingURL=pureDataObject.js.map