@fluidframework/runtime-definitions 2.0.0-internal.2.0.3 → 2.0.0-internal.2.1.0

package/dist/dataStoreContext.d.ts

@@ -72,7 +72,10 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
  */
 export declare type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
 /**
- * A fluid router with the capability of being assigned an alias
+ * Exposes some functionality/features of a data store:
+ * - Handle to the data store's entryPoint
+ * - Fluid router for the data store
+ * - Can be assigned an alias
  */
 export interface IDataStore extends IFluidRouter {
     /**
@@ -83,6 +86,16 @@ export interface IDataStore extends IFluidRouter {
      * @param alias - Given alias for this datastore.
      */
     trySetAlias(alias: string): Promise<AliasResult>;
+    /**
+     * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting
+     * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a
+     * particular scenario) fall back to the current approach of requesting the root object through the request pattern.
+     *
+     * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property
+     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
+     * the data store's entryPoint.
+     */
+    readonly entryPoint?: IFluidHandle<FluidObject>;
 }
 /**
  * A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need
@@ -112,10 +125,11 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
     */
     _createDataStoreWithProps(pkg: string | string[], props?: any, id?: string): Promise<IDataStore>;
     /**
-     * Creates data store. Returns router of data store. Data store is not bound to container,
-     * store in such state is not persisted to storage (file). Storing a handle to this store
-     * (or any of its parts, like DDS) into already attached DDS (or non-attached DDS that will eventually
-     * gets attached to storage) will result in this store being attached to storage.
+     * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves
+     * as the data store's router. The data store is not bound to a container, and in such state is not persisted to
+     * storage (file). Storing the entryPoint handle (or any other handle inside the data store, e.g. for DDS) into an
+     * already attached DDS (or non-attached DDS that will eventually get attached to storage) will result in this
+     * store being attached to storage.
      * @param pkg - Package name of the data store factory
      */
     createDataStore(pkg: string | string[]): Promise<IDataStore>;
@@ -147,9 +161,9 @@ export declare enum BindState {
     Bound = "Bound"
 }
 /**
- * Minimal interface a data store runtime need to provide for IFluidDataStoreContext to bind to control
+ * Minimal interface a data store runtime needs to provide for IFluidDataStoreContext to bind to control.
  *
- * Functionality include attach, snapshot, op/signal processing, request routes,
+ * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
  * and connection state notifications
  */
 export interface IFluidDataStoreChannel extends IFluidRouter, IDisposable {
@@ -222,6 +236,17 @@ export interface IFluidDataStoreChannel extends IFluidRouter, IDisposable {
      * @param localOpMetadata - The local metadata associated with the original message.
      */
     rollback?(type: string, content: any, localOpMetadata: unknown): void;
+    /**
+     * Exposes a handle to the root object / entryPoint of the component. Use this as the primary way of interacting
+     * with the component. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented
+     * in a particular scenario) fall back to the current approach of requesting the root object through the request
+     * pattern.
+     *
+     * @remarks The plan is that eventually the component will stop providing IFluidRouter functionality, this property
+     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
+     * the component's entryPoint.
+     */
+    readonly entryPoint?: IFluidHandle<FluidObject>;
 }
 export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>, getBaseGCDetailsFn: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
 export interface IFluidDataStoreContextEvents extends IEvent {

package/dist/dataStoreContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreContext.d.ts","sourceRoot":"","sources":["../src/dataStoreContext.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC/G,OAAO,EACH,YAAY,EACZ,0BAA0B,EAC1B,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,WAAW,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,SAAS,EACT,aAAa,EACb,WAAW,EACX,cAAc,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,aAAa,EAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EACH,sBAAsB,EACtB,6BAA6B,EAChC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACH,8BAA8B,EAC9B,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACtB,MAAM,WAAW,CAAC;AAEnB;;GAEG;AACH,oBAAY,SAAS;IACjB;;OAEG;IACH,SAAS,IAAA;IAET;;;OAGG;IACH,SAAS,IAAA;CACZ;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe;IACxB,mGAAmG;;IAGnG;;;;OAIG;;IAGH;;;;;;;;OAQG;;CAEN,CAAC;AACF,oBAAY,eAAe,GAAG,OAAO,eAAe,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEnF,MAAM,WAAW,2BAA4B,SAAQ,MAAM;IACvD,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACzE;;;OAGG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,OAAE;IAC3F,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACnF,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CACzF;AAED;;;;;;;;GAQG;AACH,oBAAY,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC5C;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SACnC,cAAc,CAAC,2BAA2B,CAAC,EAC3C,0BAA0B;IAE1B,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC;;;OAGG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAE/C;;;MAGE;IACF,yBAAyB,CACrB,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,KAAK,CAAC,EAAE,GAAG,EACX,EAAE,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvB;;;;;;OAMG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7D;;;OAGG;IACH,uBAAuB,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,8BAA8B,CAAC;IAEjF;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1E;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;CAC5B;AAED,8DAA8D;AAC9D,oBAAY,SAAS;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAuB,SACpC,YAAY,EACZ,WAAW;IAEX,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;IAE3C;;;OAGG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;OAGG;IACH,yBAAyB,IAAI,IAAI,CAAC;IAElC;;OAEG;IACH,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,GAAG,qBAAqB,CAAC;IAE9E;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5F;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAElD;;;;;;OAMG;IACH,SAAS,CACL,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE7D;;;OAGG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,OAAE;IAE1D;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,OAAE;IAE/D,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;CACzE;AAED,oBAAY,2BAA2B,GAAG,CACtC,iBAAiB,EAAE,mBAAmB,EACtC,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,sBAAsB,CAAC,EAClE,kBAAkB,EAAE,MAAM,OAAO,CAAC,6BAA6B,CAAC,KAC/D,qBAAqB,CAAC;AAE3B,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IACxD,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CAC3D;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SACpC,cAAc,CAAC,4BAA4B,CAAC,EAC5C,OAAO,CAAC,8BAA8B,CAAC,EACvC,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,gBAAgB,EAAE,qBAAqB,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAE5B;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1E;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAE/C;;;OAGG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,IAAI,IAAI,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE,8BAA8B;IAC1B,2CAA2C;IAC3C,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B,GAC5C,2BAA2B,CAAC;IAE/B,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1E;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;CAC1F;AAED,MAAM,WAAW,8BAA+B,SAAQ,sBAAsB;IAC1E;;OAEG;IACH,aAAa,CACT,OAAO,EAAE,6BAA6B,EACtC,gBAAgB,EAAE,sBAAsB,GACzC,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB"}
+{"version":3,"file":"dataStoreContext.d.ts","sourceRoot":"","sources":["../src/dataStoreContext.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC/G,OAAO,EACH,YAAY,EACZ,0BAA0B,EAC1B,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,WAAW,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,SAAS,EACT,aAAa,EACb,WAAW,EACX,cAAc,EACjB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACH,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,aAAa,EAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EACH,sBAAsB,EACtB,6BAA6B,EAChC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACH,8BAA8B,EAC9B,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACtB,MAAM,WAAW,CAAC;AAEnB;;GAEG;AACH,oBAAY,SAAS;IACjB;;OAEG;IACH,SAAS,IAAA;IAET;;;OAGG;IACH,SAAS,IAAA;CACZ;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe;IACxB,mGAAmG;;IAGnG;;;;OAIG;;IAGH;;;;;;;;OAQG;;CAEN,CAAC;AACF,oBAAY,eAAe,GAAG,OAAO,eAAe,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEnF,MAAM,WAAW,2BAA4B,SAAQ,MAAM;IACvD,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACzE;;;OAGG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,OAAE;IAC3F,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACnF,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CACzF;AAED;;;;;;;;GAQG;AACH,oBAAY,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC5C;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SACnC,cAAc,CAAC,2BAA2B,CAAC,EAC3C,0BAA0B;IAE1B,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC;;;OAGG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/C;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAE/C;;;MAGE;IACF,yBAAyB,CACrB,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,KAAK,CAAC,EAAE,GAAG,EACX,EAAE,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7D;;;OAGG;IACH,uBAAuB,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,8BAA8B,CAAC;IAEjF;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1E;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;CAC5B;AAED,8DAA8D;AAC9D,oBAAY,SAAS;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAuB,SACpC,YAAY,EACZ,WAAW;IAEX,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;IAE3C;;;OAGG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;OAGG;IACH,yBAAyB,IAAI,IAAI,CAAC;IAElC;;OAEG;IACH,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,GAAG,qBAAqB,CAAC;IAE9E;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5F;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAElD;;;;;;OAMG;IACH,SAAS,CACL,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE7D;;;OAGG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,OAAE;IAE1D;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,OAAE;IAE/D,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtE;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CACnD;AAED,oBAAY,2BAA2B,GAAG,CACtC,iBAAiB,EAAE,mBAAmB,EACtC,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,sBAAsB,CAAC,EAClE,kBAAkB,EAAE,MAAM,OAAO,CAAC,6BAA6B,CAAC,KAC/D,qBAAqB,CAAC;AAE3B,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IACxD,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CAC3D;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SACpC,cAAc,CAAC,4BAA4B,CAAC,EAC5C,OAAO,CAAC,8BAA8B,CAAC,EACvC,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,gBAAgB,EAAE,qBAAqB,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAE5B;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1E;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAE/C;;;OAGG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,IAAI,IAAI,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE,8BAA8B;IAC1B,2CAA2C;IAC3C,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B,GAC5C,2BAA2B,CAAC;IAE/B,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAE1E;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;CAC1F;AAED,MAAM,WAAW,8BAA+B,SAAQ,sBAAsB;IAC1E;;OAEG;IACH,aAAa,CACT,OAAO,EAAE,6BAA6B,EACtC,gBAAgB,EAAE,sBAAsB,GACzC,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB"}

package/dist/dataStoreContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataStoreContext.js","sourceRoot":"","sources":["../src/dataStoreContext.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwCH;;GAEG;AACH,IAAY,SAWX;AAXD,WAAY,SAAS;IACjB;;OAEG;IACH,mDAAS,CAAA;IAET;;;OAGG;IACH,mDAAS,CAAA;AACb,CAAC,EAXW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAWpB;AAED;;;GAGG;AACU,QAAA,eAAe,GAAG;IAC3B,mGAAmG;IACnG,UAAU,EAAE,YAAY;IAExB;;;;OAIG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;;;;;;;OAQG;IACH,eAAe,EAAE,iBAAiB;CACrC,CAAC;AAiHF,8DAA8D;AAC9D,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACnB,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger, IDisposable, IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport {\n    IFluidRouter,\n    IProvideFluidHandleContext,\n    IFluidHandle,\n    IRequest,\n    IResponse,\n    FluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IAudience,\n    IDeltaManager,\n    AttachState,\n    ILoaderOptions,\n} from \"@fluidframework/container-definitions\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    IClientDetails,\n    IDocumentMessage,\n    IQuorumClients,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n} from \"@fluidframework/protocol-definitions\";\nimport { IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\nimport { IProvideFluidDataStoreRegistry } from \"./dataStoreRegistry\";\nimport {\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n} from \"./garbageCollection\";\nimport { IInboundSignalMessage } from \"./protocol\";\nimport {\n    CreateChildSummarizerNodeParam,\n    ISummarizerNodeWithGC,\n    ISummaryTreeWithStats,\n    ITelemetryContext,\n    SummarizeInternalFn,\n} from \"./summary\";\n\n/**\n * Runtime flush mode handling\n */\nexport enum FlushMode {\n    /**\n     * In Immediate flush mode the runtime will immediately send all operations to the driver layer.\n     */\n    Immediate,\n\n    /**\n     * When in TurnBased flush mode the runtime will buffer operations in the current turn and send them as a single\n     * batch at the end of the turn. The flush call on the runtime can be used to force send the current batch.\n     */\n    TurnBased,\n}\n\n/**\n * This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible\n * locally within the container only or visible globally to all clients.\n */\nexport const VisibilityState = {\n    /** Indicates that the object is not visible. This is the state when an object is first created. */\n    NotVisible: \"NotVisible\",\n\n    /**\n     * Indicates that the object is visible locally within the container. This is the state when an object is attached\n     * to the container's graph but the container itself isn't globally visible. The object's state goes from not\n     * visible to locally visible.\n     */\n    LocallyVisible: \"LocallyVisible\",\n\n    /**\n     * Indicates that the object is visible globally to all clients. This is the state of an object in 2 scenarios:\n     *\n     * 1. It is attached to the container's graph when the container is globally visible. The object's state goes from\n     * not visible to globally visible.\n     *\n     * 2. When a container becomes globally visible, all locally visible objects go from locally visible to globally\n     * visible.\n     */\n    GloballyVisible: \"GloballyVisible\",\n};\nexport type VisibilityState = typeof VisibilityState[keyof typeof VisibilityState];\n\nexport interface IContainerRuntimeBaseEvents extends IEvent{\n    (event: \"batchBegin\", listener: (op: ISequencedDocumentMessage) => void);\n    /**\n     * @param runtimeMessage - tells if op is runtime op. If it is, it was unpacked, i.e. it's type and content\n     * represent internal container runtime type / content.\n     */\n    (event: \"op\", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void);\n    (event: \"batchEnd\", listener: (error: any, op: ISequencedDocumentMessage) => void);\n    (event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n}\n\n/**\n * Encapsulates the return codes of the aliasing API.\n *\n * 'Success' - the datastore has been successfully aliased. It can now be used.\n * 'Conflict' - there is already a datastore bound to the provided alias. To acquire a handle to it,\n * use the `IContainerRuntime.getRootDataStore` function. The current datastore should be discarded\n * and will be garbage collected. The current datastore cannot be aliased to a different value.\n * 'AlreadyAliased' - the datastore has already been previously bound to another alias name.\n */\nexport type AliasResult = \"Success\" | \"Conflict\" | \"AlreadyAliased\";\n\n/**\n * A fluid router with the capability of being assigned an alias\n */\nexport interface IDataStore extends IFluidRouter {\n    /**\n     * Attempt to assign an alias to the datastore.\n     * If the operation succeeds, the datastore can be referenced\n     * by the supplied alias and will not be garbage collected.\n     *\n     * @param alias - Given alias for this datastore.\n     */\n    trySetAlias(alias: string): Promise<AliasResult>;\n}\n\n/**\n * A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need\n * TODO: this should be merged into IFluidDataStoreContext\n */\nexport interface IContainerRuntimeBase extends\n    IEventProvider<IContainerRuntimeBaseEvents>,\n    IProvideFluidHandleContext {\n\n    readonly logger: ITelemetryBaseLogger;\n    readonly clientDetails: IClientDetails;\n\n    /**\n     * Invokes the given callback and guarantees that all operations generated within the callback will be ordered\n     * sequentially. Total size of all messages must be less than maxOpSize.\n     */\n    orderSequentially(callback: () => void): void;\n\n    /**\n     * Executes a request against the container runtime\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Submits a container runtime level signal to be sent to other clients.\n     * @param type - Type of the signal.\n     * @param content - Content of the signal.\n     */\n    submitSignal(type: string, content: any): void;\n\n    /**\n    * @deprecated 0.16 Issue #1537, #3631\n    * @internal\n    */\n    _createDataStoreWithProps(\n        pkg: string | string[],\n        props?: any,\n        id?: string,\n    ): Promise<IDataStore>;\n\n    /**\n     * Creates data store. Returns router of data store. Data store is not bound to container,\n     * store in such state is not persisted to storage (file). Storing a handle to this store\n     * (or any of its parts, like DDS) into already attached DDS (or non-attached DDS that will eventually\n     * gets attached to storage) will result in this store being attached to storage.\n     * @param pkg - Package name of the data store factory\n     */\n    createDataStore(pkg: string | string[]): Promise<IDataStore>;\n\n    /**\n     * Creates detached data store context. Only after context.attachRuntime() is called,\n     * data store initialization is considered complete.\n     */\n    createDetachedDataStore(pkg: Readonly<string[]>): IFluidDataStoreContextDetached;\n\n    /**\n     * Get an absolute url for a provided container-relative request.\n     * Returns undefined if the container or data store isn't attached to storage.\n     * @param relativeUrl - A relative request within the container\n     */\n    getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n    /**\n     * Returns the current quorum.\n     */\n    getQuorum(): IQuorumClients;\n\n    /**\n     * Returns the current audience.\n     */\n    getAudience(): IAudience;\n}\n\n/** @deprecated - Used only in deprecated API bindToContext */\nexport enum BindState {\n    NotBound = \"NotBound\",\n    Binding = \"Binding\",\n    Bound = \"Bound\",\n}\n\n/**\n * Minimal interface a data store runtime need to provide for IFluidDataStoreContext to bind to control\n *\n * Functionality include attach, snapshot, op/signal processing, request routes,\n * and connection state notifications\n */\nexport interface IFluidDataStoreChannel extends\n    IFluidRouter,\n    IDisposable {\n\n    readonly id: string;\n\n    /**\n     * Indicates the attachment state of the channel to a host service.\n     */\n    readonly attachState: AttachState;\n\n    readonly visibilityState?: VisibilityState;\n\n    /**\n     * Runs through the graph and attaches the bound handles. Then binds this runtime to the container.\n     * @deprecated This will be removed in favor of {@link IFluidDataStoreChannel.makeVisibleAndAttachGraph}.\n     */\n    attachGraph(): void;\n\n    /**\n     * Makes the data store channel visible in the container. Also, runs through its graph and attaches all\n     * bound handles that represent its dependencies in the container's graph.\n     */\n    makeVisibleAndAttachGraph(): void;\n\n    /**\n     * Retrieves the summary used as part of the initial summary message\n     */\n    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;\n\n    /**\n     * Processes the op.\n     */\n    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal(message: any, local: boolean): void;\n\n    /**\n     * Generates a summary for the channel.\n     * Introduced with summarizerNode - will be required in a future release.\n     * @param fullTree - true to bypass optimizations and force a full summary tree.\n     * @param trackState - This tells whether we should track state from this summary.\n     * @param telemetryContext - summary data passed through the layers for telemetry purposes\n     */\n    summarize(\n        fullTree?: boolean,\n        trackState?: boolean,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * Returns the data used for garbage collection. This includes a list of GC nodes that represent this context\n     * including any of its children. Each node has a list of outbound routes to other GC nodes in the document.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;\n\n    /**\n     * After GC has run, called to notify this channel of routes that are used in it.\n     * @param usedRoutes - The routes that are used in this channel.\n     */\n    updateUsedRoutes(usedRoutes: string[]): void;\n\n    /**\n     * Notifies this object about changes in the connection state.\n     * @param value - New connection state.\n     * @param clientId - ID of the client. It's old ID when in disconnected state and\n     * it's new client ID when we are connecting or connected.\n     */\n    setConnectionState(connected: boolean, clientId?: string);\n\n    /**\n     * Ask the DDS to resubmit a message. This could be because we reconnected and this message was not acked.\n     * @param type - The type of the original message.\n     * @param content - The content of the original message.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    reSubmit(type: string, content: any, localOpMetadata: unknown);\n\n    applyStashedOp(content: any): Promise<unknown>;\n\n    /**\n     * Revert a local message.\n     * @param type - The type of the original message.\n     * @param content - The content of the original message.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    rollback?(type: string, content: any, localOpMetadata: unknown): void;\n}\n\nexport type CreateChildSummarizerNodeFn = (\n    summarizeInternal: SummarizeInternalFn,\n    getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getBaseGCDetailsFn: () => Promise<IGarbageCollectionDetailsBase>,\n) => ISummarizerNodeWithGC;\n\nexport interface IFluidDataStoreContextEvents extends IEvent {\n    (event: \"attaching\" | \"attached\", listener: () => void);\n}\n\n/**\n * Represents the context for the data store. It is used by the data store runtime to\n * get information and call functionality to the container.\n */\nexport interface IFluidDataStoreContext extends\n    IEventProvider<IFluidDataStoreContextEvents>,\n    Partial<IProvideFluidDataStoreRegistry>,\n    IProvideFluidHandleContext {\n    readonly id: string;\n    /**\n     * A data store created by a client, is a local data store for that client. Also, when a detached container loads\n     * from a snapshot, all the data stores are treated as local data stores because at that stage the container\n     * still doesn't exists in storage and so the data store couldn't have been created by any other client.\n     * Value of this never changes even after the data store is attached.\n     * As implementer of data store runtime, you can use this property to check that this data store belongs to this\n     * client and hence implement any scenario based on that.\n     */\n    readonly isLocalDataStore: boolean;\n    /**\n     * The package path of the data store as per the package factory.\n     */\n    readonly packagePath: readonly string[];\n    readonly options: ILoaderOptions;\n    readonly clientId: string | undefined;\n    readonly connected: boolean;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    readonly storage: IDocumentStorageService;\n    readonly baseSnapshot: ISnapshotTree | undefined;\n    readonly logger: ITelemetryBaseLogger;\n    readonly clientDetails: IClientDetails;\n    /**\n     * Indicates the attachment state of the data store to a host service.\n     */\n    readonly attachState: AttachState;\n\n    readonly containerRuntime: IContainerRuntimeBase;\n\n    /**\n     * @deprecated 0.16 Issue #1635, #3631\n     */\n    readonly createProps?: any;\n\n    /**\n     * Ambient services provided with the context\n     */\n    readonly scope: FluidObject;\n\n    /**\n     * Returns the current quorum.\n     */\n    getQuorum(): IQuorumClients;\n\n    /**\n     * Returns the current audience.\n     */\n    getAudience(): IAudience;\n\n    /**\n     * Submits the message to be sent to other clients.\n     * @param type - Type of the message.\n     * @param content - Content of the message.\n     * @param localOpMetadata - The local metadata associated with the message. This is kept locally and not sent to\n     * the server. This will be sent back when this message is received back from the server. This is also sent if\n     * we are asked to resubmit the message.\n     */\n    submitMessage(type: string, content: any, localOpMetadata: unknown): void;\n\n    /**\n     * Submits the signal to be sent to other clients.\n     * @param type - Type of the signal.\n     * @param content - Content of the signal.\n     */\n    submitSignal(type: string, content: any): void;\n\n    /**\n     * @deprecated - To be removed in favor of makeVisible.\n     * Register the runtime to the container\n     */\n    bindToContext(): void;\n\n    /**\n     * Called to make the data store locally visible in the container. This happens automatically for root data stores\n     * when they are marked as root. For non-root data stores, this happens when their handle is added to a visible DDS.\n     */\n    makeLocallyVisible(): void;\n\n    /**\n     * Call by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.\n     * @param address - The address of the channel that is dirty.\n     */\n    setChannelDirty(address: string): void;\n\n    /**\n     * Get an absolute url to the container based on the provided relativeUrl.\n     * Returns undefined if the container or data store isn't attached to storage.\n     * @param relativeUrl - A relative request within the container\n     */\n    getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n    getCreateChildSummarizerNodeFn(\n        /** Initial id or path part of this node */\n        id: string,\n        /**\n         * Information needed to create the node.\n         * If it is from a base summary, it will assert that a summary has been seen.\n         * Attach information if it is created from an attach op.\n         * If it is local, it will throw unsupported errors on calls to summarize.\n         */\n        createParam: CreateChildSummarizerNodeParam,\n    ): CreateChildSummarizerNodeFn;\n\n    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n    /**\n     * Returns the GC details in the initial summary of this data store. This is used to initialize the data store\n     * and its children with the GC details from the previous summary.\n     */\n    getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;\n\n    /**\n     * Called when a new outbound reference is added to another node. This is used by garbage collection to identify\n     * all references added in the system.\n     * @param srcHandle - The handle of the node that added the reference.\n     * @param outboundHandle - The handle of the outbound node that is referenced.\n     */\n    addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;\n}\n\nexport interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {\n    /**\n     * Binds a runtime to the context.\n     */\n    attachRuntime(\n        factory: IProvideFluidDataStoreFactory,\n        dataStoreRuntime: IFluidDataStoreChannel,\n    ): Promise<void>;\n}\n"]}
+{"version":3,"file":"dataStoreContext.js","sourceRoot":"","sources":["../src/dataStoreContext.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwCH;;GAEG;AACH,IAAY,SAWX;AAXD,WAAY,SAAS;IACjB;;OAEG;IACH,mDAAS,CAAA;IAET;;;OAGG;IACH,mDAAS,CAAA;AACb,CAAC,EAXW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAWpB;AAED;;;GAGG;AACU,QAAA,eAAe,GAAG;IAC3B,mGAAmG;IACnG,UAAU,EAAE,YAAY;IAExB;;;;OAIG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;;;;;;;OAQG;IACH,eAAe,EAAE,iBAAiB;CACrC,CAAC;AAgIF,8DAA8D;AAC9D,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACnB,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger, IDisposable, IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport {\n    IFluidRouter,\n    IProvideFluidHandleContext,\n    IFluidHandle,\n    IRequest,\n    IResponse,\n    FluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport {\n    IAudience,\n    IDeltaManager,\n    AttachState,\n    ILoaderOptions,\n} from \"@fluidframework/container-definitions\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n    IClientDetails,\n    IDocumentMessage,\n    IQuorumClients,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n} from \"@fluidframework/protocol-definitions\";\nimport { IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\nimport { IProvideFluidDataStoreRegistry } from \"./dataStoreRegistry\";\nimport {\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n} from \"./garbageCollection\";\nimport { IInboundSignalMessage } from \"./protocol\";\nimport {\n    CreateChildSummarizerNodeParam,\n    ISummarizerNodeWithGC,\n    ISummaryTreeWithStats,\n    ITelemetryContext,\n    SummarizeInternalFn,\n} from \"./summary\";\n\n/**\n * Runtime flush mode handling\n */\nexport enum FlushMode {\n    /**\n     * In Immediate flush mode the runtime will immediately send all operations to the driver layer.\n     */\n    Immediate,\n\n    /**\n     * When in TurnBased flush mode the runtime will buffer operations in the current turn and send them as a single\n     * batch at the end of the turn. The flush call on the runtime can be used to force send the current batch.\n     */\n    TurnBased,\n}\n\n/**\n * This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible\n * locally within the container only or visible globally to all clients.\n */\nexport const VisibilityState = {\n    /** Indicates that the object is not visible. This is the state when an object is first created. */\n    NotVisible: \"NotVisible\",\n\n    /**\n     * Indicates that the object is visible locally within the container. This is the state when an object is attached\n     * to the container's graph but the container itself isn't globally visible. The object's state goes from not\n     * visible to locally visible.\n     */\n    LocallyVisible: \"LocallyVisible\",\n\n    /**\n     * Indicates that the object is visible globally to all clients. This is the state of an object in 2 scenarios:\n     *\n     * 1. It is attached to the container's graph when the container is globally visible. The object's state goes from\n     * not visible to globally visible.\n     *\n     * 2. When a container becomes globally visible, all locally visible objects go from locally visible to globally\n     * visible.\n     */\n    GloballyVisible: \"GloballyVisible\",\n};\nexport type VisibilityState = typeof VisibilityState[keyof typeof VisibilityState];\n\nexport interface IContainerRuntimeBaseEvents extends IEvent{\n    (event: \"batchBegin\", listener: (op: ISequencedDocumentMessage) => void);\n    /**\n     * @param runtimeMessage - tells if op is runtime op. If it is, it was unpacked, i.e. it's type and content\n     * represent internal container runtime type / content.\n     */\n    (event: \"op\", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void);\n    (event: \"batchEnd\", listener: (error: any, op: ISequencedDocumentMessage) => void);\n    (event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n}\n\n/**\n * Encapsulates the return codes of the aliasing API.\n *\n * 'Success' - the datastore has been successfully aliased. It can now be used.\n * 'Conflict' - there is already a datastore bound to the provided alias. To acquire a handle to it,\n * use the `IContainerRuntime.getRootDataStore` function. The current datastore should be discarded\n * and will be garbage collected. The current datastore cannot be aliased to a different value.\n * 'AlreadyAliased' - the datastore has already been previously bound to another alias name.\n */\nexport type AliasResult = \"Success\" | \"Conflict\" | \"AlreadyAliased\";\n\n/**\n * Exposes some functionality/features of a data store:\n * - Handle to the data store's entryPoint\n * - Fluid router for the data store\n * - Can be assigned an alias\n */\nexport interface IDataStore extends IFluidRouter {\n    /**\n     * Attempt to assign an alias to the datastore.\n     * If the operation succeeds, the datastore can be referenced\n     * by the supplied alias and will not be garbage collected.\n     *\n     * @param alias - Given alias for this datastore.\n     */\n    trySetAlias(alias: string): Promise<AliasResult>;\n\n    /**\n     * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting\n     * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a\n     * particular scenario) fall back to the current approach of requesting the root object through the request pattern.\n     *\n     * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property\n     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access\n     * the data store's entryPoint.\n     */\n    readonly entryPoint?: IFluidHandle<FluidObject>;\n}\n\n/**\n * A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need\n * TODO: this should be merged into IFluidDataStoreContext\n */\nexport interface IContainerRuntimeBase extends\n    IEventProvider<IContainerRuntimeBaseEvents>,\n    IProvideFluidHandleContext {\n\n    readonly logger: ITelemetryBaseLogger;\n    readonly clientDetails: IClientDetails;\n\n    /**\n     * Invokes the given callback and guarantees that all operations generated within the callback will be ordered\n     * sequentially. Total size of all messages must be less than maxOpSize.\n     */\n    orderSequentially(callback: () => void): void;\n\n    /**\n     * Executes a request against the container runtime\n     */\n    request(request: IRequest): Promise<IResponse>;\n\n    /**\n     * Submits a container runtime level signal to be sent to other clients.\n     * @param type - Type of the signal.\n     * @param content - Content of the signal.\n     */\n    submitSignal(type: string, content: any): void;\n\n    /**\n    * @deprecated 0.16 Issue #1537, #3631\n    * @internal\n    */\n    _createDataStoreWithProps(\n        pkg: string | string[],\n        props?: any,\n        id?: string,\n    ): Promise<IDataStore>;\n\n    /**\n     * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves\n     * as the data store's router. The data store is not bound to a container, and in such state is not persisted to\n     * storage (file). Storing the entryPoint handle (or any other handle inside the data store, e.g. for DDS) into an\n     * already attached DDS (or non-attached DDS that will eventually get attached to storage) will result in this\n     * store being attached to storage.\n     * @param pkg - Package name of the data store factory\n     */\n    createDataStore(pkg: string | string[]): Promise<IDataStore>;\n\n    /**\n     * Creates detached data store context. Only after context.attachRuntime() is called,\n     * data store initialization is considered complete.\n     */\n    createDetachedDataStore(pkg: Readonly<string[]>): IFluidDataStoreContextDetached;\n\n    /**\n     * Get an absolute url for a provided container-relative request.\n     * Returns undefined if the container or data store isn't attached to storage.\n     * @param relativeUrl - A relative request within the container\n     */\n    getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n    /**\n     * Returns the current quorum.\n     */\n    getQuorum(): IQuorumClients;\n\n    /**\n     * Returns the current audience.\n     */\n    getAudience(): IAudience;\n}\n\n/** @deprecated - Used only in deprecated API bindToContext */\nexport enum BindState {\n    NotBound = \"NotBound\",\n    Binding = \"Binding\",\n    Bound = \"Bound\",\n}\n\n/**\n * Minimal interface a data store runtime needs to provide for IFluidDataStoreContext to bind to control.\n *\n * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,\n * and connection state notifications\n */\nexport interface IFluidDataStoreChannel extends\n    IFluidRouter,\n    IDisposable {\n\n    readonly id: string;\n\n    /**\n     * Indicates the attachment state of the channel to a host service.\n     */\n    readonly attachState: AttachState;\n\n    readonly visibilityState?: VisibilityState;\n\n    /**\n     * Runs through the graph and attaches the bound handles. Then binds this runtime to the container.\n     * @deprecated This will be removed in favor of {@link IFluidDataStoreChannel.makeVisibleAndAttachGraph}.\n     */\n    attachGraph(): void;\n\n    /**\n     * Makes the data store channel visible in the container. Also, runs through its graph and attaches all\n     * bound handles that represent its dependencies in the container's graph.\n     */\n    makeVisibleAndAttachGraph(): void;\n\n    /**\n     * Retrieves the summary used as part of the initial summary message\n     */\n    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;\n\n    /**\n     * Processes the op.\n     */\n    process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal(message: any, local: boolean): void;\n\n    /**\n     * Generates a summary for the channel.\n     * Introduced with summarizerNode - will be required in a future release.\n     * @param fullTree - true to bypass optimizations and force a full summary tree.\n     * @param trackState - This tells whether we should track state from this summary.\n     * @param telemetryContext - summary data passed through the layers for telemetry purposes\n     */\n    summarize(\n        fullTree?: boolean,\n        trackState?: boolean,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummaryTreeWithStats>;\n\n    /**\n     * Returns the data used for garbage collection. This includes a list of GC nodes that represent this context\n     * including any of its children. Each node has a list of outbound routes to other GC nodes in the document.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;\n\n    /**\n     * After GC has run, called to notify this channel of routes that are used in it.\n     * @param usedRoutes - The routes that are used in this channel.\n     */\n    updateUsedRoutes(usedRoutes: string[]): void;\n\n    /**\n     * Notifies this object about changes in the connection state.\n     * @param value - New connection state.\n     * @param clientId - ID of the client. It's old ID when in disconnected state and\n     * it's new client ID when we are connecting or connected.\n     */\n    setConnectionState(connected: boolean, clientId?: string);\n\n    /**\n     * Ask the DDS to resubmit a message. This could be because we reconnected and this message was not acked.\n     * @param type - The type of the original message.\n     * @param content - The content of the original message.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    reSubmit(type: string, content: any, localOpMetadata: unknown);\n\n    applyStashedOp(content: any): Promise<unknown>;\n\n    /**\n     * Revert a local message.\n     * @param type - The type of the original message.\n     * @param content - The content of the original message.\n     * @param localOpMetadata - The local metadata associated with the original message.\n     */\n    rollback?(type: string, content: any, localOpMetadata: unknown): void;\n\n    /**\n     * Exposes a handle to the root object / entryPoint of the component. Use this as the primary way of interacting\n     * with the component. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented\n     * in a particular scenario) fall back to the current approach of requesting the root object through the request\n     * pattern.\n     *\n     * @remarks The plan is that eventually the component will stop providing IFluidRouter functionality, this property\n     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access\n     * the component's entryPoint.\n     */\n    readonly entryPoint?: IFluidHandle<FluidObject>;\n}\n\nexport type CreateChildSummarizerNodeFn = (\n    summarizeInternal: SummarizeInternalFn,\n    getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getBaseGCDetailsFn: () => Promise<IGarbageCollectionDetailsBase>,\n) => ISummarizerNodeWithGC;\n\nexport interface IFluidDataStoreContextEvents extends IEvent {\n    (event: \"attaching\" | \"attached\", listener: () => void);\n}\n\n/**\n * Represents the context for the data store. It is used by the data store runtime to\n * get information and call functionality to the container.\n */\nexport interface IFluidDataStoreContext extends\n    IEventProvider<IFluidDataStoreContextEvents>,\n    Partial<IProvideFluidDataStoreRegistry>,\n    IProvideFluidHandleContext {\n    readonly id: string;\n    /**\n     * A data store created by a client, is a local data store for that client. Also, when a detached container loads\n     * from a snapshot, all the data stores are treated as local data stores because at that stage the container\n     * still doesn't exists in storage and so the data store couldn't have been created by any other client.\n     * Value of this never changes even after the data store is attached.\n     * As implementer of data store runtime, you can use this property to check that this data store belongs to this\n     * client and hence implement any scenario based on that.\n     */\n    readonly isLocalDataStore: boolean;\n    /**\n     * The package path of the data store as per the package factory.\n     */\n    readonly packagePath: readonly string[];\n    readonly options: ILoaderOptions;\n    readonly clientId: string | undefined;\n    readonly connected: boolean;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    readonly storage: IDocumentStorageService;\n    readonly baseSnapshot: ISnapshotTree | undefined;\n    readonly logger: ITelemetryBaseLogger;\n    readonly clientDetails: IClientDetails;\n    /**\n     * Indicates the attachment state of the data store to a host service.\n     */\n    readonly attachState: AttachState;\n\n    readonly containerRuntime: IContainerRuntimeBase;\n\n    /**\n     * @deprecated 0.16 Issue #1635, #3631\n     */\n    readonly createProps?: any;\n\n    /**\n     * Ambient services provided with the context\n     */\n    readonly scope: FluidObject;\n\n    /**\n     * Returns the current quorum.\n     */\n    getQuorum(): IQuorumClients;\n\n    /**\n     * Returns the current audience.\n     */\n    getAudience(): IAudience;\n\n    /**\n     * Submits the message to be sent to other clients.\n     * @param type - Type of the message.\n     * @param content - Content of the message.\n     * @param localOpMetadata - The local metadata associated with the message. This is kept locally and not sent to\n     * the server. This will be sent back when this message is received back from the server. This is also sent if\n     * we are asked to resubmit the message.\n     */\n    submitMessage(type: string, content: any, localOpMetadata: unknown): void;\n\n    /**\n     * Submits the signal to be sent to other clients.\n     * @param type - Type of the signal.\n     * @param content - Content of the signal.\n     */\n    submitSignal(type: string, content: any): void;\n\n    /**\n     * @deprecated - To be removed in favor of makeVisible.\n     * Register the runtime to the container\n     */\n    bindToContext(): void;\n\n    /**\n     * Called to make the data store locally visible in the container. This happens automatically for root data stores\n     * when they are marked as root. For non-root data stores, this happens when their handle is added to a visible DDS.\n     */\n    makeLocallyVisible(): void;\n\n    /**\n     * Call by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.\n     * @param address - The address of the channel that is dirty.\n     */\n    setChannelDirty(address: string): void;\n\n    /**\n     * Get an absolute url to the container based on the provided relativeUrl.\n     * Returns undefined if the container or data store isn't attached to storage.\n     * @param relativeUrl - A relative request within the container\n     */\n    getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n    getCreateChildSummarizerNodeFn(\n        /** Initial id or path part of this node */\n        id: string,\n        /**\n         * Information needed to create the node.\n         * If it is from a base summary, it will assert that a summary has been seen.\n         * Attach information if it is created from an attach op.\n         * If it is local, it will throw unsupported errors on calls to summarize.\n         */\n        createParam: CreateChildSummarizerNodeParam,\n    ): CreateChildSummarizerNodeFn;\n\n    uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n    /**\n     * Returns the GC details in the initial summary of this data store. This is used to initialize the data store\n     * and its children with the GC details from the previous summary.\n     */\n    getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;\n\n    /**\n     * Called when a new outbound reference is added to another node. This is used by garbage collection to identify\n     * all references added in the system.\n     * @param srcHandle - The handle of the node that added the reference.\n     * @param outboundHandle - The handle of the outbound node that is referenced.\n     */\n    addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;\n}\n\nexport interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {\n    /**\n     * Binds a runtime to the context.\n     */\n    attachRuntime(\n        factory: IProvideFluidDataStoreFactory,\n        dataStoreRuntime: IFluidDataStoreChannel,\n    ): Promise<void>;\n}\n"]}

package/dist/index.d.ts

@@ -2,10 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./dataStoreFactory";
-export * from "./dataStoreRegistry";
-export * from "./dataStoreContext";
-export * from "./garbageCollection";
-export * from "./protocol";
-export * from "./summary";
+export { AliasResult, BindState, CreateChildSummarizerNodeFn, FlushMode, IContainerRuntimeBase, IContainerRuntimeBaseEvents, IDataStore, IFluidDataStoreChannel, IFluidDataStoreContext, IFluidDataStoreContextDetached, IFluidDataStoreContextEvents, VisibilityState, } from "./dataStoreContext";
+export { IFluidDataStoreFactory, IProvideFluidDataStoreFactory } from "./dataStoreFactory";
+export { FluidDataStoreRegistryEntry, IFluidDataStoreRegistry, IProvideFluidDataStoreRegistry, NamedFluidDataStoreRegistryEntries, NamedFluidDataStoreRegistryEntry, } from "./dataStoreRegistry";
+export { gcBlobKey, IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbageCollection";
+export { IAttachMessage, IEnvelope, IInboundSignalMessage, InboundAttachMessage, ISignalEnvelope } from "./protocol";
+export { blobCountPropertyName, channelsTreeName, CreateChildSummarizerNodeParam, CreateSummarizerNodeSource, IGarbageCollectionNodeData, IGarbageCollectionState, ISummarizeInternalResult, ISummarizeResult, ISummarizerNode, ISummarizerNodeConfig, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, ISummaryStats, ISummaryTreeWithStats, ITelemetryContext, SummarizeInternalFn, totalBlobSizePropertyName, } from "./summary";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,WAAW,EACX,SAAS,EACT,2BAA2B,EAC3B,SAAS,EACT,qBAAqB,EACrB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,sBAAsB,EACtB,8BAA8B,EAC9B,4BAA4B,EAC5B,eAAe,GACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AAC3F,OAAO,EACN,2BAA2B,EAC3B,uBAAuB,EACvB,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,GAChC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AACvG,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AACrH,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,8BAA8B,EAC9B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB,EACvB,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,GACzB,MAAM,WAAW,CAAC"}

package/dist/index.js

@@ -3,21 +3,21 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./dataStoreFactory"), exports);
-__exportStar(require("./dataStoreRegistry"), exports);
-__exportStar(require("./dataStoreContext"), exports);
-__exportStar(require("./garbageCollection"), exports);
-__exportStar(require("./protocol"), exports);
-__exportStar(require("./summary"), exports);
+exports.totalBlobSizePropertyName = exports.CreateSummarizerNodeSource = exports.channelsTreeName = exports.blobCountPropertyName = exports.gcBlobKey = exports.IFluidDataStoreRegistry = exports.IFluidDataStoreFactory = exports.VisibilityState = exports.FlushMode = exports.BindState = void 0;
+var dataStoreContext_1 = require("./dataStoreContext");
+Object.defineProperty(exports, "BindState", { enumerable: true, get: function () { return dataStoreContext_1.BindState; } });
+Object.defineProperty(exports, "FlushMode", { enumerable: true, get: function () { return dataStoreContext_1.FlushMode; } });
+Object.defineProperty(exports, "VisibilityState", { enumerable: true, get: function () { return dataStoreContext_1.VisibilityState; } });
+var dataStoreFactory_1 = require("./dataStoreFactory");
+Object.defineProperty(exports, "IFluidDataStoreFactory", { enumerable: true, get: function () { return dataStoreFactory_1.IFluidDataStoreFactory; } });
+var dataStoreRegistry_1 = require("./dataStoreRegistry");
+Object.defineProperty(exports, "IFluidDataStoreRegistry", { enumerable: true, get: function () { return dataStoreRegistry_1.IFluidDataStoreRegistry; } });
+var garbageCollection_1 = require("./garbageCollection");
+Object.defineProperty(exports, "gcBlobKey", { enumerable: true, get: function () { return garbageCollection_1.gcBlobKey; } });
+var summary_1 = require("./summary");
+Object.defineProperty(exports, "blobCountPropertyName", { enumerable: true, get: function () { return summary_1.blobCountPropertyName; } });
+Object.defineProperty(exports, "channelsTreeName", { enumerable: true, get: function () { return summary_1.channelsTreeName; } });
+Object.defineProperty(exports, "CreateSummarizerNodeSource", { enumerable: true, get: function () { return summary_1.CreateSummarizerNodeSource; } });
+Object.defineProperty(exports, "totalBlobSizePropertyName", { enumerable: true, get: function () { return summary_1.totalBlobSizePropertyName; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH,qDAAmC;AACnC,sDAAoC;AACpC,qDAAmC;AACnC,sDAAoC;AACpC,6CAA2B;AAC3B,4CAA0B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./dataStoreFactory\";\nexport * from \"./dataStoreRegistry\";\nexport * from \"./dataStoreContext\";\nexport * from \"./garbageCollection\";\nexport * from \"./protocol\";\nexport * from \"./summary\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAa4B;AAX3B,6GAAA,SAAS,OAAA;AAET,6GAAA,SAAS,OAAA;AAQT,mHAAA,eAAe,OAAA;AAEhB,uDAA2F;AAAlF,0HAAA,sBAAsB,OAAA;AAC/B,yDAM6B;AAJ5B,4HAAA,uBAAuB,OAAA;AAKxB,yDAAuG;AAA9F,8GAAA,SAAS,OAAA;AAElB,qCAkBmB;AAjBlB,gHAAA,qBAAqB,OAAA;AACrB,2GAAA,gBAAgB,OAAA;AAEhB,qHAAA,0BAA0B,OAAA;AAa1B,oHAAA,yBAAyB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tAliasResult,\n\tBindState,\n\tCreateChildSummarizerNodeFn,\n\tFlushMode,\n\tIContainerRuntimeBase,\n\tIContainerRuntimeBaseEvents,\n\tIDataStore,\n\tIFluidDataStoreChannel,\n\tIFluidDataStoreContext,\n\tIFluidDataStoreContextDetached,\n\tIFluidDataStoreContextEvents,\n\tVisibilityState,\n} from \"./dataStoreContext\";\nexport { IFluidDataStoreFactory, IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\nexport {\n\tFluidDataStoreRegistryEntry,\n\tIFluidDataStoreRegistry,\n\tIProvideFluidDataStoreRegistry,\n\tNamedFluidDataStoreRegistryEntries,\n\tNamedFluidDataStoreRegistryEntry,\n} from \"./dataStoreRegistry\";\nexport { gcBlobKey, IGarbageCollectionData, IGarbageCollectionDetailsBase } from \"./garbageCollection\";\nexport { IAttachMessage, IEnvelope, IInboundSignalMessage, InboundAttachMessage, ISignalEnvelope } from \"./protocol\";\nexport {\n\tblobCountPropertyName,\n\tchannelsTreeName,\n\tCreateChildSummarizerNodeParam,\n\tCreateSummarizerNodeSource,\n\tIGarbageCollectionNodeData,\n\tIGarbageCollectionState,\n\tISummarizeInternalResult,\n\tISummarizeResult,\n\tISummarizerNode,\n\tISummarizerNodeConfig,\n\tISummarizerNodeConfigWithGC,\n\tISummarizerNodeWithGC,\n\tISummaryStats,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tSummarizeInternalFn,\n\ttotalBlobSizePropertyName,\n} from \"./summary\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-internal.2.0.3",
+  "version": "2.0.0-internal.2.1.0",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -27,23 +27,22 @@
     "lint": "npm run eslint",
     "lint:fix": "npm run eslint:fix",
     "tsc": "tsc",
-    "tsfmt": "tsfmt --verify",
-    "tsfmt:fix": "tsfmt --replace",
     "typetests:gen": "fluid-type-validator -g -d ."
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.2.0.3 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.2.1.0 <2.0.0-internal.3.0.0",
     "@fluidframework/protocol-definitions": "^1.1.0",
     "@types/node": "^14.18.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^1.0.0",
-    "@fluidframework/build-tools": "^0.4.6000",
-    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluid-tools/build-cli": "^0.5.0",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.5.0",
+    "@fluidframework/eslint-config-fluid": "^1.1.0",
     "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-internal.2.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
@@ -51,11 +50,10 @@
     "copyfiles": "^2.4.1",
     "eslint": "~8.6.0",
     "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.0.1",
+    "version": "2.0.0-internal.2.1.0",
     "broken": {}
   }
 }

package/src/dataStoreContext.ts

@@ -108,7 +108,10 @@ export interface IContainerRuntimeBaseEvents extends IEvent{
 export type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
 
 /**
- * A fluid router with the capability of being assigned an alias
+ * Exposes some functionality/features of a data store:
+ * - Handle to the data store's entryPoint
+ * - Fluid router for the data store
+ * - Can be assigned an alias
  */
 export interface IDataStore extends IFluidRouter {
     /**
@@ -119,6 +122,17 @@ export interface IDataStore extends IFluidRouter {
      * @param alias - Given alias for this datastore.
      */
     trySetAlias(alias: string): Promise<AliasResult>;
+
+    /**
+     * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting
+     * with it. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented in a
+     * particular scenario) fall back to the current approach of requesting the root object through the request pattern.
+     *
+     * @remarks The plan is that eventually the data store will stop providing IFluidRouter functionality, this property
+     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
+     * the data store's entryPoint.
+     */
+    readonly entryPoint?: IFluidHandle<FluidObject>;
 }
 
 /**
@@ -161,10 +175,11 @@ export interface IContainerRuntimeBase extends
     ): Promise<IDataStore>;
 
     /**
-     * Creates data store. Returns router of data store. Data store is not bound to container,
-     * store in such state is not persisted to storage (file). Storing a handle to this store
-     * (or any of its parts, like DDS) into already attached DDS (or non-attached DDS that will eventually
-     * gets attached to storage) will result in this store being attached to storage.
+     * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves
+     * as the data store's router. The data store is not bound to a container, and in such state is not persisted to
+     * storage (file). Storing the entryPoint handle (or any other handle inside the data store, e.g. for DDS) into an
+     * already attached DDS (or non-attached DDS that will eventually get attached to storage) will result in this
+     * store being attached to storage.
      * @param pkg - Package name of the data store factory
      */
     createDataStore(pkg: string | string[]): Promise<IDataStore>;
@@ -203,9 +218,9 @@ export enum BindState {
 }
 
 /**
- * Minimal interface a data store runtime need to provide for IFluidDataStoreContext to bind to control
+ * Minimal interface a data store runtime needs to provide for IFluidDataStoreContext to bind to control.
  *
- * Functionality include attach, snapshot, op/signal processing, request routes,
+ * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
  * and connection state notifications
  */
 export interface IFluidDataStoreChannel extends
@@ -299,6 +314,18 @@ export interface IFluidDataStoreChannel extends
      * @param localOpMetadata - The local metadata associated with the original message.
      */
     rollback?(type: string, content: any, localOpMetadata: unknown): void;
+
+    /**
+     * Exposes a handle to the root object / entryPoint of the component. Use this as the primary way of interacting
+     * with the component. If this property is undefined (meaning that exposing the entryPoint hasn't been implemented
+     * in a particular scenario) fall back to the current approach of requesting the root object through the request
+     * pattern.
+     *
+     * @remarks The plan is that eventually the component will stop providing IFluidRouter functionality, this property
+     * will become non-optional and return an IFluidHandle (no undefined) and will become the only way to access
+     * the component's entryPoint.
+     */
+    readonly entryPoint?: IFluidHandle<FluidObject>;
 }
 
 export type CreateChildSummarizerNodeFn = (

package/src/index.ts

@@ -3,9 +3,46 @@
  * Licensed under the MIT License.
  */
 
-export * from "./dataStoreFactory";
-export * from "./dataStoreRegistry";
-export * from "./dataStoreContext";
-export * from "./garbageCollection";
-export * from "./protocol";
-export * from "./summary";
+export {
+	AliasResult,
+	BindState,
+	CreateChildSummarizerNodeFn,
+	FlushMode,
+	IContainerRuntimeBase,
+	IContainerRuntimeBaseEvents,
+	IDataStore,
+	IFluidDataStoreChannel,
+	IFluidDataStoreContext,
+	IFluidDataStoreContextDetached,
+	IFluidDataStoreContextEvents,
+	VisibilityState,
+} from "./dataStoreContext";
+export { IFluidDataStoreFactory, IProvideFluidDataStoreFactory } from "./dataStoreFactory";
+export {
+	FluidDataStoreRegistryEntry,
+	IFluidDataStoreRegistry,
+	IProvideFluidDataStoreRegistry,
+	NamedFluidDataStoreRegistryEntries,
+	NamedFluidDataStoreRegistryEntry,
+} from "./dataStoreRegistry";
+export { gcBlobKey, IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbageCollection";
+export { IAttachMessage, IEnvelope, IInboundSignalMessage, InboundAttachMessage, ISignalEnvelope } from "./protocol";
+export {
+	blobCountPropertyName,
+	channelsTreeName,
+	CreateChildSummarizerNodeParam,
+	CreateSummarizerNodeSource,
+	IGarbageCollectionNodeData,
+	IGarbageCollectionState,
+	ISummarizeInternalResult,
+	ISummarizeResult,
+	ISummarizerNode,
+	ISummarizerNodeConfig,
+	ISummarizerNodeConfigWithGC,
+	ISummarizerNodeWithGC,
+	ISummaryStats,
+	ISummaryTreeWithStats,
+	ITelemetryContext,
+	SummarizeInternalFn,
+	totalBlobSizePropertyName,
+} from "./summary";