@fluidframework/runtime-definitions 0.59.4000-71130 → 1.0.0

package/dist/dataStoreContext.d.ts

@@ -11,7 +11,7 @@ import { IProvideFluidDataStoreFactory } from "./dataStoreFactory";
 import { IProvideFluidDataStoreRegistry } from "./dataStoreRegistry";
 import { IGarbageCollectionData, IGarbageCollectionDetailsBase, IGarbageCollectionSummaryDetails } from "./garbageCollection";
 import { IInboundSignalMessage } from "./protocol";
-import { CreateChildSummarizerNodeParam, ISummarizerNodeWithGC, ISummaryTreeWithStats, SummarizeInternalFn } from "./summary";
+import { CreateChildSummarizerNodeParam, ISummarizerNodeWithGC, ISummaryTreeWithStats, ITelemetryContext, SummarizeInternalFn } from "./summary";
 /**
  * Runtime flush mode handling
  */
@@ -164,7 +164,7 @@ export interface IFluidDataStoreChannel extends IFluidRouter, IDisposable {
     /**
      * Retrieves the summary used as part of the initial summary message
      */
-    getAttachSummary(): ISummaryTreeWithStats;
+    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     /**
      * Processes the op.
      */
@@ -178,8 +178,9 @@ export interface IFluidDataStoreChannel extends IFluidRouter, IDisposable {
      * Introduced with summarizerNode - will be required in a future release.
      * @param fullTree - true to bypass optimizations and force a full summary tree.
      * @param trackState - This tells whether we should track state from this summary.
+     * @param telemetryContext - summary data passed through the layers for telemetry purposes
      */
-    summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;
+    summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
     /**
      * Returns the data used for garbage collection. This includes a list of GC nodes that represent this context
      * including any of its children. Each node has a list of outbound routes to other GC nodes in the document.
@@ -208,6 +209,13 @@ export interface IFluidDataStoreChannel extends IFluidRouter, IDisposable {
      */
     reSubmit(type: string, content: any, localOpMetadata: unknown): any;
     applyStashedOp(content: any): Promise<unknown>;
+    /**
+     * Revert a local message.
+     * @param type - The type of the original message.
+     * @param content - The content of the original message.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    rollback?(type: string, content: any, localOpMetadata: unknown): void;
 }
 export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>, getInitialGCSummaryDetailsFn: () => Promise<IGarbageCollectionSummaryDetails>) => 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,EAC7B,gCAAgC,EACnC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACH,8BAA8B,EAC9B,qBAAqB,EACrB,qBAAqB,EACrB,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;;;;;;OAMG;;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,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,KAAK,IAAI,OAAE;IAChF,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;;GAEG;AACF,oBAAY,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAElF;;GAEG;AACF,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC7C;;;;;;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;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IAEpC;;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;;;OAGG;IACH,yBAAyB,CACrB,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,KAAK,CAAC,EAAE,GAAG,EACX,EAAE,CAAC,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,OAAO,GACjB,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;;;;;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;;;;OAIG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;;OAGG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;OAGG;IACH,yBAAyB,CAAC,IAAI,IAAI,CAAC;IAEnC;;OAEG;IACH,gBAAgB,IAAI,qBAAqB,CAAC;IAE1C;;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;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAEpF;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE7D;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnE;;;;;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;CAClD;AAED,oBAAY,2BAA2B,GAAG,CACtC,iBAAiB,EAAE,mBAAmB,EACtC,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,sBAAsB,CAAC,EAClE,4BAA4B,EAAE,MAAM,OAAO,CAAC,gCAAgC,CAAC,KAC5E,qBAAqB,CAAC;AAE3B,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAExD,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,CAAC,IAAI,IAAI,CAAC;IAE5B;;;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;;OAEG;IACH,0BAA0B,IAAI,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAExE;;;OAGG;IACH,gBAAgB,CAAC,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAE5D;;;;;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,EAC7B,gCAAgC,EACnC,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;;;;;;OAMG;;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,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,KAAK,IAAI,OAAE;IAChF,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;;GAEG;AACF,oBAAY,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAElF;;GAEG;AACF,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC7C;;;;;;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;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IAEpC;;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;;;OAGG;IACH,yBAAyB,CACrB,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,KAAK,CAAC,EAAE,GAAG,EACX,EAAE,CAAC,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,OAAO,GACjB,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;;;;;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;;;;OAIG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;;OAGG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;OAGG;IACH,yBAAyB,CAAC,IAAI,IAAI,CAAC;IAEnC;;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;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnE;;;;;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,4BAA4B,EAAE,MAAM,OAAO,CAAC,gCAAgC,CAAC,KAC5E,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,CAAC,IAAI,IAAI,CAAC;IAE5B;;;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;;OAEG;IACH,0BAA0B,IAAI,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAExE;;;OAGG;IACH,gBAAgB,CAAC,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAE5D;;;;;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;;;;;;OAMG;IACH,eAAe,EAAE,iBAAiB;CACrC,CAAC","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    IGarbageCollectionSummaryDetails,\n} from \"./garbageCollection\";\nimport { IInboundSignalMessage } from \"./protocol\";\nimport {\n    CreateChildSummarizerNodeParam,\n    ISummarizerNodeWithGC,\n    ISummaryTreeWithStats,\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     * 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     * 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\" | \"op\", listener: (op: ISequencedDocumentMessage) => 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 export type AliasResult = \"Success\" | \"Conflict\" | \"Aliasing\" | \"AlreadyAliased\";\n\n/**\n * A fluid router with the capability of being assigned an alias\n */\n export 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.\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     * Sets the flush mode for operations on the document.\n     * @deprecated - Will be removed in 0.60. See #9480.\n     */\n    setFlushMode(mode: FlushMode): 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        isRoot?: boolean,\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 compete.\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/**\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     * @deprecated - This is an internal method that should not be exposed.\n     * Called to bind the runtime to the container.\n     * If the container is not attached to storage, then this would also be unknown to other clients.\n     */\n    bindToContext(): void;\n\n    /**\n     * @deprecated - This will be removed in favor of makeVisibleAndAttachGraph.\n     * Runs through the graph and attaches the bound handles. Then binds this runtime to the container.\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(): 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     */\n    summarize(fullTree?: boolean, trackState?: boolean): 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     * @param gcTimestamp - The time when GC was run that generated these used routes. If any node becomes unreferenced\n     * as part of this GC run, this should be used to update the time when it happens.\n     */\n    updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number): 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\nexport type CreateChildSummarizerNodeFn = (\n    summarizeInternal: SummarizeInternalFn,\n    getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getInitialGCSummaryDetailsFn: () => Promise<IGarbageCollectionSummaryDetails>,\n) => ISummarizerNodeWithGC;\n\nexport interface IFluidDataStoreContextEvents extends IEvent {\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\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     * @deprecated - Renamed to getBaseGCDetails.\n     */\n    getInitialGCSummaryDetails(): Promise<IGarbageCollectionSummaryDetails>;\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;;;AAyCH;;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;;;;;;OAMG;IACH,eAAe,EAAE,iBAAiB;CACrC,CAAC","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    IGarbageCollectionSummaryDetails,\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     * 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     * 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\" | \"op\", listener: (op: ISequencedDocumentMessage) => 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 export type AliasResult = \"Success\" | \"Conflict\" | \"Aliasing\" | \"AlreadyAliased\";\n\n/**\n * A fluid router with the capability of being assigned an alias\n */\n export 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.\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     * Sets the flush mode for operations on the document.\n     * @deprecated - Will be removed in 0.60. See #9480.\n     */\n    setFlushMode(mode: FlushMode): 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        isRoot?: boolean,\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 compete.\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/**\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     * @deprecated - This is an internal method that should not be exposed.\n     * Called to bind the runtime to the container.\n     * If the container is not attached to storage, then this would also be unknown to other clients.\n     */\n    bindToContext(): void;\n\n    /**\n     * @deprecated - This will be removed in favor of makeVisibleAndAttachGraph.\n     * Runs through the graph and attaches the bound handles. Then binds this runtime to the container.\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     * @param gcTimestamp - The time when GC was run that generated these used routes. If any node becomes unreferenced\n     * as part of this GC run, this should be used to update the time when it happens.\n     */\n    updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number): 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    getInitialGCSummaryDetailsFn: () => Promise<IGarbageCollectionSummaryDetails>,\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     * @deprecated - Renamed to getBaseGCDetails.\n     */\n    getInitialGCSummaryDetails(): Promise<IGarbageCollectionSummaryDetails>;\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/summary.d.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { TelemetryEventPropertyType } from "@fluidframework/common-definitions";
 import { SummaryTree, ISummaryTree, ISequencedDocumentMessage, ISnapshotTree, ITree } from "@fluidframework/protocol-definitions";
 import { IGarbageCollectionData, IGarbageCollectionDetailsBase, IGarbageCollectionSummaryDetails } from "./garbageCollection";
 /**
@@ -68,7 +69,7 @@ export interface IGarbageCollectionState {
         [id: string]: IGarbageCollectionNodeData;
     };
 }
-export declare type SummarizeInternalFn = (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>;
+export declare type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext) => Promise<ISummarizeInternalResult>;
 export interface ISummarizerNodeConfig {
     /**
      * True to reuse previous handle when unchanged since last acked summary.
@@ -121,8 +122,10 @@ export interface ISummarizerNode {
      * If an error is encountered and throwOnFailure is false, it will try to make
      * a summary with a pointer to the previous summary + a blob of outstanding ops.
      * @param fullTree - true to skip optimizations and always generate the full tree
+     * @param trackState - indicates whether the summarizer node should track the state of the summary or not
+     * @param telemetryContext - summary data passed through the layers for telemetry purposes
      */
-    summarize(fullTree: boolean): Promise<ISummarizeResult>;
+    summarize(fullTree: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummarizeResult>;
     /**
      * Checks if there are any additional path parts for children that need to
      * be loaded from the base summary. Additional path parts represent parts
@@ -152,7 +155,7 @@ export interface ISummarizerNode {
     recordChange(op: ISequencedDocumentMessage): void;
     createChild(
     /** Summarize function */
-    summarizeInternalFn: (fullTree: boolean) => Promise<ISummarizeInternalResult>, 
+    summarizeInternalFn: SummarizeInternalFn, 
     /** Initial id or path part of this node */
     id: string, 
     /**
@@ -180,10 +183,9 @@ export interface ISummarizerNode {
  * - updateUsedRoutes - Used to notify this node of routes that are currently in use in it.
  */
 export interface ISummarizerNodeWithGC extends ISummarizerNode {
-    summarize(fullTree: boolean, trackState?: boolean): Promise<ISummarizeResult>;
     createChild(
     /** Summarize function */
-    summarizeInternalFn: (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>, 
+    summarizeInternalFn: SummarizeInternalFn, 
     /** Initial id or path part of this node */
     id: string, 
     /**
@@ -227,4 +229,31 @@ export interface ISummarizerNodeWithGC extends ISummarizerNode {
     getBaseGCDetails?(): IGarbageCollectionDetailsBase;
 }
 export declare const channelsTreeName = ".channels";
+/**
+ * Contains telemetry data relevant to summarization workflows.
+ * This object is expected to be modified directly by various summarize methods.
+ */
+export interface ITelemetryContext {
+    /**
+     * Sets value for telemetry data being tracked.
+     * @param prefix - unique prefix to tag this data with (ex: "fluid:map:")
+     * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
+     * @param value - value to attribute to this summary telemetry data
+     */
+    set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
+    /**
+     * Get the telemetry data being tracked
+     * @param prefix - unique prefix for this data (ex: "fluid:map:")
+     * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
+     * @returns undefined if item not found
+     */
+    get(prefix: string, property: string): TelemetryEventPropertyType;
+    /**
+     * Returns a serialized version of all the telemetry data.
+     * Should be used when logging in telemetry events.
+     */
+    serialize(): string;
+}
+export declare const blobCountPropertyName = "BlobCount";
+export declare const totalBlobSizePropertyName = "TotalBlobSize";
 //# sourceMappingURL=summary.d.ts.map

package/dist/summary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../src/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,WAAW,EACX,YAAY,EACZ,yBAAyB,EACzB,aAAa,EACb,KAAK,EACR,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EACnC,MAAM,qBAAqB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IAClC,4GAA4G;IAC5G,KAAK,EAAE,aAAa,CAAC;IACrB;;;OAGG;IACH,OAAO,EAAE,YAAY,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;CACxB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAC9D,EAAE,EAAE,MAAM,CAAC;IACX,2EAA2E;IAC3E,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAED,uEAAuE;AACvE,MAAM,WAAW,0BAA0B;IACvC,qDAAqD;IACrD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,qFAAqF;IACrF,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACpC,OAAO,EAAE;QAAE,CAAE,EAAE,EAAE,MAAM,GAAI,0BAA0B,CAAC;KAAE,CAAC;CAC5D;AAED,oBAAY,mBAAmB,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;AAEhH,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;OAQG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACtE;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,oBAAY,0BAA0B;IAClC,WAAW,IAAA;IACX,UAAU,IAAA;IACV,KAAK,IAAA;CACR;AACD,oBAAY,8BAA8B,GAAG;IACzC,IAAI,EAAE,0BAA0B,CAAC,WAAW,CAAC;CAChD,GAAG;IACA,IAAI,EAAE,0BAA0B,CAAC,UAAU,CAAC;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,KAAK,CAAC;CACnB,GAAG;IACA,IAAI,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAC1C,CAAC;AAEF,MAAM,WAAW,eAAe;IAC5B,kEAAkE;IAClE,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC;;;OAGG;IACH,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACxD;;;;;;;OAOG;IACH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAClE;;;;;;;;OAQG;IACH,eAAe,CACX,QAAQ,EAAE,aAAa,EACvB,gBAAgB,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,GAChD,OAAO,CAAC;QAAE,WAAW,EAAE,aAAa,CAAC;QAAC,cAAc,EAAE,yBAAyB,EAAE,CAAC;KAAE,CAAC,CAAC;IACzF;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAElD,WAAW;IACP,yBAAyB;IACzB,mBAAmB,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC,wBAAwB,CAAC;IAC7E,2CAA2C;IAC3C,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B;IAC3C,0DAA0D;IAC1D,MAAM,CAAC,EAAE,qBAAqB,GAC/B,eAAe,CAAC;IAEnB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;CACrD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC1D,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC9E,WAAW;IACP,yBAAyB;IACzB,mBAAmB,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,KAAK,OAAO,CAAC,wBAAwB,CAAC;IAClG,2CAA2C;IAC3C,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B;IAC3C,0DAA0D;IAC1D,MAAM,CAAC,EAAE,2BAA2B,EACpC,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,sBAAsB,CAAC,EACnE,4BAA4B,CAAC,EAAE,MAAM,OAAO,CAAC,gCAAgC,CAAC,GAC/E,qBAAqB,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAC;IAExD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE7D,2GAA2G;IAC3G,YAAY,IAAI,OAAO,CAAC;IAExB;;;;;;;;OAQG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnE;;;OAGG;IACH,mBAAmB,IAAI,gCAAgC,CAAC;IAExD,+GAA+G;IAC/G,gBAAgB,CAAC,IAAI,6BAA6B,CAAC;CACtD;AAED,eAAO,MAAM,gBAAgB,cAAc,CAAC"}
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../src/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EACH,WAAW,EACX,YAAY,EACZ,yBAAyB,EACzB,aAAa,EACb,KAAK,EACR,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EACnC,MAAM,qBAAqB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IAClC,4GAA4G;IAC5G,KAAK,EAAE,aAAa,CAAC;IACrB;;;OAGG;IACH,OAAO,EAAE,YAAY,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;CACxB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAC9D,EAAE,EAAE,MAAM,CAAC;IACX,2EAA2E;IAC3E,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CACnC;AAED,uEAAuE;AACvE,MAAM,WAAW,0BAA0B;IACvC,qDAAqD;IACrD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,qFAAqF;IACrF,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACpC,OAAO,EAAE;QAAE,CAAE,EAAE,EAAE,MAAM,GAAI,0BAA0B,CAAC;KAAE,CAAC;CAC5D;AAED,oBAAY,mBAAmB,GAAG,CAC9B,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,OAAO,EACnB,gBAAgB,CAAC,EAAE,iBAAiB,KACnC,OAAO,CAAC,wBAAwB,CAAC,CAAC;AAEvC,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;OAQG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACtE;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,oBAAY,0BAA0B;IAClC,WAAW,IAAA;IACX,UAAU,IAAA;IACV,KAAK,IAAA;CACR;AACD,oBAAY,8BAA8B,GAAG;IACzC,IAAI,EAAE,0BAA0B,CAAC,WAAW,CAAC;CAChD,GAAG;IACA,IAAI,EAAE,0BAA0B,CAAC,UAAU,CAAC;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,KAAK,CAAC;CACnB,GAAG;IACA,IAAI,EAAE,0BAA0B,CAAC,KAAK,CAAC;CAC1C,CAAC;AAEF,MAAM,WAAW,eAAe;IAC5B,kEAAkE;IAClE,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC;;;OAGG;IACH,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC;;;;;;;;OAQG;IACH,SAAS,CACL,QAAQ,EAAE,OAAO,EACjB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7B;;;;;;;OAOG;IACH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAClE;;;;;;;;OAQG;IACH,eAAe,CACX,QAAQ,EAAE,aAAa,EACvB,gBAAgB,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,GAChD,OAAO,CAAC;QAAE,WAAW,EAAE,aAAa,CAAC;QAAC,cAAc,EAAE,yBAAyB,EAAE,CAAC;KAAE,CAAC,CAAC;IACzF;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAElD,WAAW;IACP,yBAAyB;IACzB,mBAAmB,EAAE,mBAAmB;IACxC,2CAA2C;IAC3C,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B;IAC3C,0DAA0D;IAC1D,MAAM,CAAC,EAAE,qBAAqB,GAC/B,eAAe,CAAC;IAEnB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;CACrD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC1D,WAAW;IACP,yBAAyB;IACzB,mBAAmB,EAAE,mBAAmB;IACxC,2CAA2C;IAC3C,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B;IAC3C,0DAA0D;IAC1D,MAAM,CAAC,EAAE,2BAA2B,EACpC,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,sBAAsB,CAAC,EACnE,4BAA4B,CAAC,EAAE,MAAM,OAAO,CAAC,gCAAgC,CAAC,GAC/E,qBAAqB,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAC;IAExD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE7D,2GAA2G;IAC3G,YAAY,IAAI,OAAO,CAAC;IAExB;;;;;;;;OAQG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnE;;;OAGG;IACH,mBAAmB,IAAI,gCAAgC,CAAC;IAExD,+GAA+G;IAC/G,gBAAgB,CAAC,IAAI,6BAA6B,CAAC;CACtD;AAED,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAE/E;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,0BAA0B,CAAC;IAElE;;;OAGG;IACH,SAAS,IAAI,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,qBAAqB,cAAc,CAAC;AAEjD,eAAO,MAAM,yBAAyB,kBAAkB,CAAC"}

package/dist/summary.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.channelsTreeName = exports.CreateSummarizerNodeSource = void 0;
+exports.totalBlobSizePropertyName = exports.blobCountPropertyName = exports.channelsTreeName = exports.CreateSummarizerNodeSource = void 0;
 var CreateSummarizerNodeSource;
 (function (CreateSummarizerNodeSource) {
     CreateSummarizerNodeSource[CreateSummarizerNodeSource["FromSummary"] = 0] = "FromSummary";
@@ -12,4 +12,6 @@ var CreateSummarizerNodeSource;
     CreateSummarizerNodeSource[CreateSummarizerNodeSource["Local"] = 2] = "Local";
 })(CreateSummarizerNodeSource = exports.CreateSummarizerNodeSource || (exports.CreateSummarizerNodeSource = {}));
 exports.channelsTreeName = ".channels";
+exports.blobCountPropertyName = "BlobCount";
+exports.totalBlobSizePropertyName = "TotalBlobSize";
 //# sourceMappingURL=summary.js.map

package/dist/summary.js.map

@@ -1 +1 @@
-{"version":3,"file":"summary.js","sourceRoot":"","sources":["../src/summary.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA+GH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IAClC,yFAAW,CAAA;IACX,uFAAU,CAAA;IACV,6EAAK,CAAA;AACT,CAAC,EAJW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAIrC;AAiJY,QAAA,gBAAgB,GAAG,WAAW,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    SummaryTree,\n    ISummaryTree,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n    ITree,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n    IGarbageCollectionSummaryDetails,\n} from \"./garbageCollection\";\n\n/**\n * Contains the aggregation data from a Tree/Subtree.\n */\nexport interface ISummaryStats {\n    treeNodeCount: number;\n    blobNodeCount: number;\n    handleNodeCount: number;\n    totalBlobSize: number;\n    unreferencedBlobSize: number;\n}\n\n/**\n * Represents the summary tree for a node along with the statistics for that tree.\n * For example, for a given data store, it contains the data for data store along with a subtree for\n * each of its DDS.\n * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject\n * will be taking part of the summarization process.\n */\nexport interface ISummaryTreeWithStats {\n    /** Represents an agreggation of node counts and blob sizes associated to the current summary information */\n    stats: ISummaryStats;\n    /**\n     * A recursive data structure that will be converted to a snapshot tree and uploaded\n     * to the backend.\n     */\n    summary: ISummaryTree;\n}\n\n/**\n * Represents a summary at a current sequence number.\n */\nexport interface ISummarizeResult {\n    stats: ISummaryStats;\n    summary: SummaryTree;\n}\n\n/**\n * Contains the same data as ISummaryResult but in order to avoid naming colisions,\n * the data store summaries are wrapped around an array of labels identified by pathPartsForChildren.\n * Ex: id:\"\"\n       pathPartsForChildren: [\"path1\"]\n       stats: ...\n       summary:\n        ...\n            \"path1\":\n */\nexport interface ISummarizeInternalResult extends ISummarizeResult {\n    id: string;\n    /** Additional path parts between this node's ID and its children's IDs. */\n    pathPartsForChildren?: string[];\n}\n\n/** The garbage collection data of each node in the reference graph. */\nexport interface IGarbageCollectionNodeData {\n    /** The set of routes to other nodes in the graph. */\n    outboundRoutes: string[];\n    /** If the node is unreferenced, the timestamp of when it was marked unreferenced. */\n    unreferencedTimestampMs?: number;\n}\n\n/**\n * The garbage collection state of the reference graph. It contains a list of all the nodes in the graph and their\n * GC data.\n */\nexport interface IGarbageCollectionState {\n    gcNodes: { [ id: string ]: IGarbageCollectionNodeData; };\n}\n\nexport type SummarizeInternalFn = (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>;\n\nexport interface ISummarizerNodeConfig {\n    /**\n     * True to reuse previous handle when unchanged since last acked summary.\n     * Defaults to true.\n     */\n    readonly canReuseHandle?: boolean;\n    /**\n     * True to always stop execution on error during summarize, or false to\n     * attempt creating a summary that is a pointer ot the last acked summary\n     * plus outstanding ops in case of internal summarize failure.\n     * Defaults to false.\n     *\n     * BUG BUG: Default to true while we investigate problem\n     * with differential summaries\n     */\n    readonly throwOnFailure?: true;\n}\n\nexport interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {\n    /**\n     * True if GC is disabled. If so, don't track GC related state for a summary.\n     * This is propagated to all child nodes.\n     */\n    readonly gcDisabled?: boolean;\n}\n\nexport enum CreateSummarizerNodeSource {\n    FromSummary,\n    FromAttach,\n    Local,\n}\nexport type CreateChildSummarizerNodeParam = {\n    type: CreateSummarizerNodeSource.FromSummary;\n} | {\n    type: CreateSummarizerNodeSource.FromAttach;\n    sequenceNumber: number;\n    snapshot: ITree;\n} | {\n    type: CreateSummarizerNodeSource.Local;\n};\n\nexport interface ISummarizerNode {\n    /** Latest successfully acked summary reference sequence number */\n    readonly referenceSequenceNumber: number;\n    /**\n     * Marks the node as having a change with the given sequence number.\n     * @param sequenceNumber - sequence number of change\n     */\n    invalidate(sequenceNumber: number): void;\n    /**\n     * Calls the internal summarize function and handles internal state tracking.\n     * If unchanged and fullTree is false, it will reuse previous summary subtree.\n     * If an error is encountered and throwOnFailure is false, it will try to make\n     * a summary with a pointer to the previous summary + a blob of outstanding ops.\n     * @param fullTree - true to skip optimizations and always generate the full tree\n     */\n    summarize(fullTree: boolean): Promise<ISummarizeResult>;\n    /**\n     * Checks if there are any additional path parts for children that need to\n     * be loaded from the base summary. Additional path parts represent parts\n     * of the path between this SummarizerNode and any child SummarizerNodes\n     * that it might have. For example: if datastore \"a\" contains dds \"b\", but the\n     * path is \"/a/.channels/b\", then the additional path part is \".channels\".\n     * @param snapshot - the base summary to parse\n     */\n    loadBaseSummaryWithoutDifferential(snapshot: ISnapshotTree): void;\n    /**\n     * Does all the work of loadBaseSummaryWithoutDifferential. Additionally if\n     * the base summary is a differential summary containing handle + outstanding ops blob,\n     * then this will return the innermost base summary, and update the state by\n     * tracking the outstanding ops.\n     * @param snapshot - the base summary to parse\n     * @param readAndParseBlob - function to read and parse blobs from storage\n     * @returns the base summary to be used\n     */\n    loadBaseSummary(\n        snapshot: ISnapshotTree,\n        readAndParseBlob: <T>(id: string) => Promise<T>,\n    ): Promise<{ baseSummary: ISnapshotTree; outstandingOps: ISequencedDocumentMessage[]; }>;\n    /**\n     * Records an op representing a change to this node/subtree.\n     * @param op - op of change to record\n     */\n    recordChange(op: ISequencedDocumentMessage): void;\n\n    createChild(\n        /** Summarize function */\n        summarizeInternalFn: (fullTree: boolean) => Promise<ISummarizeInternalResult>,\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        /** Optional configuration affecting summarize behavior */\n        config?: ISummarizerNodeConfig,\n    ): ISummarizerNode;\n\n    getChild(id: string): ISummarizerNode | undefined;\n}\n\n/**\n * Extends the functionality of ISummarizerNode to support garbage collection. It adds / udpates the following APIs:\n * - usedRoutes - The routes in this node that are currently in use.\n * - getGCData - A new API that can be used to get the garbage collection data for this node.\n * - summarize - Added a trackState flag which indicates whether the summarizer node should track the state of the\n *   summary or not.\n * - createChild - Added the following params:\n *   - getGCDataFn - This gets the GC data from the caller. This must be provided in order for getGCData to work.\n *   - getInitialGCDetailsFn - This gets the initial GC details from the caller.\n * - deleteChild - Deletes a child node.\n * - isReferenced - This tells whether this node is referenced in the document or not.\n * - updateUsedRoutes - Used to notify this node of routes that are currently in use in it.\n */\nexport interface ISummarizerNodeWithGC extends ISummarizerNode {\n    summarize(fullTree: boolean, trackState?: boolean): Promise<ISummarizeResult>;\n    createChild(\n        /** Summarize function */\n        summarizeInternalFn: (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>,\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        /** Optional configuration affecting summarize behavior */\n        config?: ISummarizerNodeConfigWithGC,\n        getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getInitialGCSummaryDetailsFn?: () => Promise<IGarbageCollectionSummaryDetails>,\n    ): ISummarizerNodeWithGC;\n\n    /**\n     * Delete the child with the given id..\n     */\n    deleteChild(id: string): void;\n\n    getChild(id: string): ISummarizerNodeWithGC | undefined;\n\n    /**\n     * Returns this node's data that is used for garbage collection. This includes a list of GC nodes that represent\n     * this node. Each node has a set 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    /** Tells whether this node is being referenced in this document or not. Unreferenced node will get GC'd */\n    isReferenced(): boolean;\n\n    /**\n     * After GC has run, called to notify this node of routes that are used in it. These are used for the following:\n     * 1. To identify if this node is being referenced in the document or not.\n     * 2. To identify if this node or any of its children's used routes changed since last summary.\n     *\n     * @param usedRoutes - The routes that are used in this node.\n     * @param gcTimestamp - The time when GC was run that generated these used routes. If a node becomes unreferenced\n     * as part of this GC run, this timestamp is used to update the time when it happens.\n     */\n    updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number): void;\n\n    /**\n     * @deprecated - Renamed to getBaseGCDetails.\n     * Returns the GC details that may be added to this node's summary.\n     */\n    getGCSummaryDetails(): IGarbageCollectionSummaryDetails;\n\n    /** Returns the GC details to be added to this node's summary and is used to initialize new nodes' GC state. */\n    getBaseGCDetails?(): IGarbageCollectionDetailsBase;\n}\n\nexport const channelsTreeName = \".channels\";\n"]}
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../src/summary.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoHH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IAClC,yFAAW,CAAA;IACX,uFAAU,CAAA;IACV,6EAAK,CAAA;AACT,CAAC,EAJW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAIrC;AAsJY,QAAA,gBAAgB,GAAG,WAAW,CAAC;AA8B/B,QAAA,qBAAqB,GAAG,WAAW,CAAC;AAEpC,QAAA,yBAAyB,GAAG,eAAe,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TelemetryEventPropertyType } from \"@fluidframework/common-definitions\";\nimport {\n    SummaryTree,\n    ISummaryTree,\n    ISequencedDocumentMessage,\n    ISnapshotTree,\n    ITree,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n    IGarbageCollectionSummaryDetails,\n} from \"./garbageCollection\";\n\n/**\n * Contains the aggregation data from a Tree/Subtree.\n */\nexport interface ISummaryStats {\n    treeNodeCount: number;\n    blobNodeCount: number;\n    handleNodeCount: number;\n    totalBlobSize: number;\n    unreferencedBlobSize: number;\n}\n\n/**\n * Represents the summary tree for a node along with the statistics for that tree.\n * For example, for a given data store, it contains the data for data store along with a subtree for\n * each of its DDS.\n * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject\n * will be taking part of the summarization process.\n */\nexport interface ISummaryTreeWithStats {\n    /** Represents an agreggation of node counts and blob sizes associated to the current summary information */\n    stats: ISummaryStats;\n    /**\n     * A recursive data structure that will be converted to a snapshot tree and uploaded\n     * to the backend.\n     */\n    summary: ISummaryTree;\n}\n\n/**\n * Represents a summary at a current sequence number.\n */\nexport interface ISummarizeResult {\n    stats: ISummaryStats;\n    summary: SummaryTree;\n}\n\n/**\n * Contains the same data as ISummaryResult but in order to avoid naming colisions,\n * the data store summaries are wrapped around an array of labels identified by pathPartsForChildren.\n * Ex: id:\"\"\n       pathPartsForChildren: [\"path1\"]\n       stats: ...\n       summary:\n        ...\n            \"path1\":\n */\nexport interface ISummarizeInternalResult extends ISummarizeResult {\n    id: string;\n    /** Additional path parts between this node's ID and its children's IDs. */\n    pathPartsForChildren?: string[];\n}\n\n/** The garbage collection data of each node in the reference graph. */\nexport interface IGarbageCollectionNodeData {\n    /** The set of routes to other nodes in the graph. */\n    outboundRoutes: string[];\n    /** If the node is unreferenced, the timestamp of when it was marked unreferenced. */\n    unreferencedTimestampMs?: number;\n}\n\n/**\n * The garbage collection state of the reference graph. It contains a list of all the nodes in the graph and their\n * GC data.\n */\nexport interface IGarbageCollectionState {\n    gcNodes: { [ id: string ]: IGarbageCollectionNodeData; };\n}\n\nexport type SummarizeInternalFn = (\n    fullTree: boolean,\n    trackState: boolean,\n    telemetryContext?: ITelemetryContext,\n) => Promise<ISummarizeInternalResult>;\n\nexport interface ISummarizerNodeConfig {\n    /**\n     * True to reuse previous handle when unchanged since last acked summary.\n     * Defaults to true.\n     */\n    readonly canReuseHandle?: boolean;\n    /**\n     * True to always stop execution on error during summarize, or false to\n     * attempt creating a summary that is a pointer ot the last acked summary\n     * plus outstanding ops in case of internal summarize failure.\n     * Defaults to false.\n     *\n     * BUG BUG: Default to true while we investigate problem\n     * with differential summaries\n     */\n    readonly throwOnFailure?: true;\n}\n\nexport interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {\n    /**\n     * True if GC is disabled. If so, don't track GC related state for a summary.\n     * This is propagated to all child nodes.\n     */\n    readonly gcDisabled?: boolean;\n}\n\nexport enum CreateSummarizerNodeSource {\n    FromSummary,\n    FromAttach,\n    Local,\n}\nexport type CreateChildSummarizerNodeParam = {\n    type: CreateSummarizerNodeSource.FromSummary;\n} | {\n    type: CreateSummarizerNodeSource.FromAttach;\n    sequenceNumber: number;\n    snapshot: ITree;\n} | {\n    type: CreateSummarizerNodeSource.Local;\n};\n\nexport interface ISummarizerNode {\n    /** Latest successfully acked summary reference sequence number */\n    readonly referenceSequenceNumber: number;\n    /**\n     * Marks the node as having a change with the given sequence number.\n     * @param sequenceNumber - sequence number of change\n     */\n    invalidate(sequenceNumber: number): void;\n    /**\n     * Calls the internal summarize function and handles internal state tracking.\n     * If unchanged and fullTree is false, it will reuse previous summary subtree.\n     * If an error is encountered and throwOnFailure is false, it will try to make\n     * a summary with a pointer to the previous summary + a blob of outstanding ops.\n     * @param fullTree - true to skip optimizations and always generate the full tree\n     * @param trackState - indicates whether the summarizer node should track the state of the summary or not\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<ISummarizeResult>;\n    /**\n     * Checks if there are any additional path parts for children that need to\n     * be loaded from the base summary. Additional path parts represent parts\n     * of the path between this SummarizerNode and any child SummarizerNodes\n     * that it might have. For example: if datastore \"a\" contains dds \"b\", but the\n     * path is \"/a/.channels/b\", then the additional path part is \".channels\".\n     * @param snapshot - the base summary to parse\n     */\n    loadBaseSummaryWithoutDifferential(snapshot: ISnapshotTree): void;\n    /**\n     * Does all the work of loadBaseSummaryWithoutDifferential. Additionally if\n     * the base summary is a differential summary containing handle + outstanding ops blob,\n     * then this will return the innermost base summary, and update the state by\n     * tracking the outstanding ops.\n     * @param snapshot - the base summary to parse\n     * @param readAndParseBlob - function to read and parse blobs from storage\n     * @returns the base summary to be used\n     */\n    loadBaseSummary(\n        snapshot: ISnapshotTree,\n        readAndParseBlob: <T>(id: string) => Promise<T>,\n    ): Promise<{ baseSummary: ISnapshotTree; outstandingOps: ISequencedDocumentMessage[]; }>;\n    /**\n     * Records an op representing a change to this node/subtree.\n     * @param op - op of change to record\n     */\n    recordChange(op: ISequencedDocumentMessage): void;\n\n    createChild(\n        /** Summarize function */\n        summarizeInternalFn: SummarizeInternalFn,\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        /** Optional configuration affecting summarize behavior */\n        config?: ISummarizerNodeConfig,\n    ): ISummarizerNode;\n\n    getChild(id: string): ISummarizerNode | undefined;\n}\n\n/**\n * Extends the functionality of ISummarizerNode to support garbage collection. It adds / udpates the following APIs:\n * - usedRoutes - The routes in this node that are currently in use.\n * - getGCData - A new API that can be used to get the garbage collection data for this node.\n * - summarize - Added a trackState flag which indicates whether the summarizer node should track the state of the\n *   summary or not.\n * - createChild - Added the following params:\n *   - getGCDataFn - This gets the GC data from the caller. This must be provided in order for getGCData to work.\n *   - getInitialGCDetailsFn - This gets the initial GC details from the caller.\n * - deleteChild - Deletes a child node.\n * - isReferenced - This tells whether this node is referenced in the document or not.\n * - updateUsedRoutes - Used to notify this node of routes that are currently in use in it.\n */\nexport interface ISummarizerNodeWithGC extends ISummarizerNode {\n    createChild(\n        /** Summarize function */\n        summarizeInternalFn: SummarizeInternalFn,\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        /** Optional configuration affecting summarize behavior */\n        config?: ISummarizerNodeConfigWithGC,\n        getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getInitialGCSummaryDetailsFn?: () => Promise<IGarbageCollectionSummaryDetails>,\n    ): ISummarizerNodeWithGC;\n\n    /**\n     * Delete the child with the given id..\n     */\n    deleteChild(id: string): void;\n\n    getChild(id: string): ISummarizerNodeWithGC | undefined;\n\n    /**\n     * Returns this node's data that is used for garbage collection. This includes a list of GC nodes that represent\n     * this node. Each node has a set 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    /** Tells whether this node is being referenced in this document or not. Unreferenced node will get GC'd */\n    isReferenced(): boolean;\n\n    /**\n     * After GC has run, called to notify this node of routes that are used in it. These are used for the following:\n     * 1. To identify if this node is being referenced in the document or not.\n     * 2. To identify if this node or any of its children's used routes changed since last summary.\n     *\n     * @param usedRoutes - The routes that are used in this node.\n     * @param gcTimestamp - The time when GC was run that generated these used routes. If a node becomes unreferenced\n     * as part of this GC run, this timestamp is used to update the time when it happens.\n     */\n    updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number): void;\n\n    /**\n     * @deprecated - Renamed to getBaseGCDetails.\n     * Returns the GC details that may be added to this node's summary.\n     */\n    getGCSummaryDetails(): IGarbageCollectionSummaryDetails;\n\n    /** Returns the GC details to be added to this node's summary and is used to initialize new nodes' GC state. */\n    getBaseGCDetails?(): IGarbageCollectionDetailsBase;\n}\n\nexport const channelsTreeName = \".channels\";\n\n/**\n * Contains telemetry data relevant to summarization workflows.\n * This object is expected to be modified directly by various summarize methods.\n */\nexport interface ITelemetryContext {\n    /**\n     * Sets value for telemetry data being tracked.\n     * @param prefix - unique prefix to tag this data with (ex: \"fluid:map:\")\n     * @param property - property name of the telemetry data being tracked (ex: \"DirectoryCount\")\n     * @param value - value to attribute to this summary telemetry data\n     */\n    set(prefix: string, property: string, value: TelemetryEventPropertyType): void;\n\n    /**\n     * Get the telemetry data being tracked\n     * @param prefix - unique prefix for this data (ex: \"fluid:map:\")\n     * @param property - property name of the telemetry data being tracked (ex: \"DirectoryCount\")\n     * @returns undefined if item not found\n     */\n    get(prefix: string, property: string): TelemetryEventPropertyType;\n\n    /**\n     * Returns a serialized version of all the telemetry data.\n     * Should be used when logging in telemetry events.\n     */\n    serialize(): string;\n}\n\nexport const blobCountPropertyName = \"BlobCount\";\n\nexport const totalBlobSizePropertyName = \"TotalBlobSize\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "0.59.4000-71130",
+  "version": "1.0.0",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,7 +15,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:compile": "npm run tsc && npm run typetests:gen && npm run build:test",
+    "build:compile": "npm run tsc && npm run build:test",
     "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
     "build:full": "npm run build",
     "build:full:compile": "npm run build:compile",
@@ -28,47 +28,40 @@
     "lint:fix": "npm run eslint:fix",
     "tsc": "tsc",
     "tsfmt": "tsfmt --verify",
-    "tsfmt:fix": "tsfmt --replace",
-    "typetests:gen": "fluid-type-validator -g -d ."
+    "tsfmt:fix": "tsfmt --replace"
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^0.48.2000-0",
-    "@fluidframework/core-interfaces": "^0.43.1000",
-    "@fluidframework/driver-definitions": "^0.46.2000-0",
-    "@fluidframework/protocol-definitions": "^0.1028.2000-0",
+    "@fluidframework/container-definitions": "^1.0.0",
+    "@fluidframework/core-interfaces": "^1.0.0",
+    "@fluidframework/driver-definitions": "^1.0.0",
+    "@fluidframework/protocol-definitions": "^0.1028.2000",
     "@types/node": "^14.18.0"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/build-tools": "^0.2.70857",
+    "@fluidframework/build-tools": "^0.2.71273",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@0.59.3000",
+    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@^0.59.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
-    "@typescript-eslint/eslint-plugin": "~5.9.0",
-    "@typescript-eslint/parser": "~5.9.0",
     "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "eslint": "~8.6.0",
-    "eslint-plugin-editorconfig": "~3.2.0",
-    "eslint-plugin-eslint-comments": "~3.2.0",
-    "eslint-plugin-import": "~2.25.4",
-    "eslint-plugin-jest": "~26.1.3",
-    "eslint-plugin-jsdoc": "~39.3.0",
-    "eslint-plugin-mocha": "~10.0.3",
-    "eslint-plugin-promise": "~6.0.0",
-    "eslint-plugin-react": "~7.28.0",
-    "eslint-plugin-tsdoc": "~0.2.14",
-    "eslint-plugin-unicorn": "~40.0.0",
-    "eslint-plugin-unused-imports": "~2.0.0",
     "rimraf": "^2.6.2",
     "typescript": "~4.5.5",
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.59.4000",
-    "broken": {}
+    "version": "1.0.0",
+    "broken": {
+      "InterfaceDeclaration_IFluidDataStoreContext": {
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IFluidDataStoreContextDetached": {
+        "backCompat": false
+      }
+    }
   }
 }

package/src/dataStoreContext.ts

@@ -38,6 +38,7 @@ import {
     CreateChildSummarizerNodeParam,
     ISummarizerNodeWithGC,
     ISummaryTreeWithStats,
+    ITelemetryContext,
     SummarizeInternalFn,
 } from "./summary";
 
@@ -230,7 +231,7 @@ export interface IFluidDataStoreChannel extends
     /**
      * Retrieves the summary used as part of the initial summary message
      */
-    getAttachSummary(): ISummaryTreeWithStats;
+    getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
 
     /**
      * Processes the op.
@@ -247,8 +248,13 @@ export interface IFluidDataStoreChannel extends
      * Introduced with summarizerNode - will be required in a future release.
      * @param fullTree - true to bypass optimizations and force a full summary tree.
      * @param trackState - This tells whether we should track state from this summary.
+     * @param telemetryContext - summary data passed through the layers for telemetry purposes
      */
-    summarize(fullTree?: boolean, trackState?: boolean): Promise<ISummaryTreeWithStats>;
+    summarize(
+        fullTree?: boolean,
+        trackState?: boolean,
+        telemetryContext?: ITelemetryContext,
+    ): Promise<ISummaryTreeWithStats>;
 
     /**
      * Returns the data used for garbage collection. This includes a list of GC nodes that represent this context
@@ -282,6 +288,14 @@ export interface IFluidDataStoreChannel extends
     reSubmit(type: string, content: any, localOpMetadata: unknown);
 
     applyStashedOp(content: any): Promise<unknown>;
+
+    /**
+     * Revert a local message.
+     * @param type - The type of the original message.
+     * @param content - The content of the original message.
+     * @param localOpMetadata - The local metadata associated with the original message.
+     */
+    rollback?(type: string, content: any, localOpMetadata: unknown): void;
 }
 
 export type CreateChildSummarizerNodeFn = (
@@ -291,7 +305,6 @@ export type CreateChildSummarizerNodeFn = (
 ) => ISummarizerNodeWithGC;
 
 export interface IFluidDataStoreContextEvents extends IEvent {
-    // eslint-disable-next-line @typescript-eslint/unified-signatures
     (event: "attaching" | "attached", listener: () => void);
 }
 

package/src/summary.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { TelemetryEventPropertyType } from "@fluidframework/common-definitions";
 import {
     SummaryTree,
     ISummaryTree,
@@ -84,7 +85,11 @@ export interface IGarbageCollectionState {
     gcNodes: { [ id: string ]: IGarbageCollectionNodeData; };
 }
 
-export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>;
+export type SummarizeInternalFn = (
+    fullTree: boolean,
+    trackState: boolean,
+    telemetryContext?: ITelemetryContext,
+) => Promise<ISummarizeInternalResult>;
 
 export interface ISummarizerNodeConfig {
     /**
@@ -141,8 +146,14 @@ export interface ISummarizerNode {
      * If an error is encountered and throwOnFailure is false, it will try to make
      * a summary with a pointer to the previous summary + a blob of outstanding ops.
      * @param fullTree - true to skip optimizations and always generate the full tree
+     * @param trackState - indicates whether the summarizer node should track the state of the summary or not
+     * @param telemetryContext - summary data passed through the layers for telemetry purposes
      */
-    summarize(fullTree: boolean): Promise<ISummarizeResult>;
+    summarize(
+        fullTree: boolean,
+        trackState?: boolean,
+        telemetryContext?: ITelemetryContext,
+    ): Promise<ISummarizeResult>;
     /**
      * Checks if there are any additional path parts for children that need to
      * be loaded from the base summary. Additional path parts represent parts
@@ -173,7 +184,7 @@ export interface ISummarizerNode {
 
     createChild(
         /** Summarize function */
-        summarizeInternalFn: (fullTree: boolean) => Promise<ISummarizeInternalResult>,
+        summarizeInternalFn: SummarizeInternalFn,
         /** Initial id or path part of this node */
         id: string,
         /**
@@ -204,10 +215,9 @@ export interface ISummarizerNode {
  * - updateUsedRoutes - Used to notify this node of routes that are currently in use in it.
  */
 export interface ISummarizerNodeWithGC extends ISummarizerNode {
-    summarize(fullTree: boolean, trackState?: boolean): Promise<ISummarizeResult>;
     createChild(
         /** Summarize function */
-        summarizeInternalFn: (fullTree: boolean, trackState: boolean) => Promise<ISummarizeInternalResult>,
+        summarizeInternalFn: SummarizeInternalFn,
         /** Initial id or path part of this node */
         id: string,
         /**
@@ -262,3 +272,35 @@ export interface ISummarizerNodeWithGC extends ISummarizerNode {
 }
 
 export const channelsTreeName = ".channels";
+
+/**
+ * Contains telemetry data relevant to summarization workflows.
+ * This object is expected to be modified directly by various summarize methods.
+ */
+export interface ITelemetryContext {
+    /**
+     * Sets value for telemetry data being tracked.
+     * @param prefix - unique prefix to tag this data with (ex: "fluid:map:")
+     * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
+     * @param value - value to attribute to this summary telemetry data
+     */
+    set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
+
+    /**
+     * Get the telemetry data being tracked
+     * @param prefix - unique prefix for this data (ex: "fluid:map:")
+     * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
+     * @returns undefined if item not found
+     */
+    get(prefix: string, property: string): TelemetryEventPropertyType;
+
+    /**
+     * Returns a serialized version of all the telemetry data.
+     * Should be used when logging in telemetry events.
+     */
+    serialize(): string;
+}
+
+export const blobCountPropertyName = "BlobCount";
+
+export const totalBlobSizePropertyName = "TotalBlobSize";