@fluidframework/runtime-definitions 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/dist/summary.d.ts

@@ -2,11 +2,12 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { TelemetryEventPropertyType } from "@fluidframework/common-definitions";
+import { TelemetryEventPropertyType } from "@fluidframework/core-interfaces";
 import { SummaryTree, ISummaryTree, ISequencedDocumentMessage, ISnapshotTree, ITree } from "@fluidframework/protocol-definitions";
-import { IGarbageCollectionData, IGarbageCollectionDetailsBase, IGarbageCollectionSummaryDetails } from "./garbageCollection";
+import { IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbageCollection";
 /**
  * Contains the aggregation data from a Tree/Subtree.
+ * @public
  */
 export interface ISummaryStats {
     treeNodeCount: number;
@@ -21,9 +22,12 @@ export interface ISummaryStats {
  * each of its DDS.
  * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
  * will be taking part of the summarization process.
+ * @public
  */
 export interface ISummaryTreeWithStats {
-    /** Represents an agreggation of node counts and blob sizes associated to the current summary information */
+    /**
+     * Represents an aggregation of node counts and blob sizes associated to the current summary information
+     */
     stats: ISummaryStats;
     /**
      * A recursive data structure that will be converted to a snapshot tree and uploaded
@@ -33,43 +37,68 @@ export interface ISummaryTreeWithStats {
 }
 /**
  * Represents a summary at a current sequence number.
+ * @alpha
  */
 export interface ISummarizeResult {
     stats: ISummaryStats;
     summary: SummaryTree;
 }
 /**
- * Contains the same data as ISummaryResult but in order to avoid naming colisions,
+ * Contains the same data as ISummaryResult but in order to avoid naming collisions,
  * the data store summaries are wrapped around an array of labels identified by pathPartsForChildren.
- * Ex: id:""
-       pathPartsForChildren: ["path1"]
-       stats: ...
-       summary:
-        ...
-            "path1":
+ *
+ * @example
+ *
+ * ```typescript
+ * id:""
+ * pathPartsForChildren: ["path1"]
+ * stats: ...
+ * summary:
+ *   ...
+ *     "path1":
+ * ```
+ * @alpha
  */
 export interface ISummarizeInternalResult extends ISummarizeResult {
     id: string;
-    /** Additional path parts between this node's ID and its children's IDs. */
+    /**
+     * Additional path parts between this node's ID and its children's IDs.
+     */
     pathPartsForChildren?: string[];
 }
-/** The garbage collection data of each node in the reference graph. */
-export interface IGarbageCollectionNodeData {
-    /** The set of routes to other nodes in the graph. */
-    outboundRoutes: string[];
-    /** If the node is unreferenced, the timestamp of when it was marked unreferenced. */
-    unreferencedTimestampMs?: number;
-}
 /**
- * The garbage collection state of the reference graph. It contains a list of all the nodes in the graph and their
- * GC data.
+ * @experimental - Can be deleted/changed at any time
+ * Contains the necessary information to allow DDSes to do incremental summaries
+ * @public
  */
-export interface IGarbageCollectionState {
-    gcNodes: {
-        [id: string]: IGarbageCollectionNodeData;
-    };
+export interface IExperimentalIncrementalSummaryContext {
+    /**
+     * The sequence number of the summary generated that will be sent to the server.
+     */
+    summarySequenceNumber: number;
+    /**
+     * The sequence number of the most recent summary that was acknowledged by the server.
+     */
+    latestSummarySequenceNumber: number;
+    /**
+     * The path to the runtime/datastore/dds that is used to generate summary handles
+     * Note: Summary handles are nodes of the summary tree that point to previous parts of the last successful summary
+     * instead of being a blob or tree node
+     *
+     * This path contains the id of the data store and dds which should not be leaked to layers below them. Ideally,
+     * a layer should not know its own id. This is important for channel unification work and there has been a lot of
+     * work to remove these kinds of leakages. Some still exist, which have to be fixed but we should not be adding
+     * more dependencies.
+     */
+    summaryPath: string;
 }
-export declare type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext) => Promise<ISummarizeInternalResult>;
+/**
+ * @alpha
+ */
+export type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
+/**
+ * @alpha
+ */
 export interface ISummarizerNodeConfig {
     /**
      * True to reuse previous handle when unchanged since last acked summary.
@@ -87,6 +116,9 @@ export interface ISummarizerNodeConfig {
      */
     readonly throwOnFailure?: true;
 }
+/**
+ * @alpha
+ */
 export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
     /**
      * True if GC is disabled. If so, don't track GC related state for a summary.
@@ -94,12 +126,18 @@ export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
      */
     readonly gcDisabled?: boolean;
 }
+/**
+ * @alpha
+ */
 export declare enum CreateSummarizerNodeSource {
     FromSummary = 0,
     FromAttach = 1,
     Local = 2
 }
-export declare type CreateChildSummarizerNodeParam = {
+/**
+ * @alpha
+ */
+export type CreateChildSummarizerNodeParam = {
     type: CreateSummarizerNodeSource.FromSummary;
 } | {
     type: CreateSummarizerNodeSource.FromAttach;
@@ -108,8 +146,13 @@ export declare type CreateChildSummarizerNodeParam = {
 } | {
     type: CreateSummarizerNodeSource.Local;
 };
+/**
+ * @alpha
+ */
 export interface ISummarizerNode {
-    /** Latest successfully acked summary reference sequence number */
+    /**
+     * Latest successfully acked summary reference sequence number
+     */
     readonly referenceSequenceNumber: number;
     /**
      * Marks the node as having a change with the given sequence number.
@@ -134,29 +177,20 @@ export interface ISummarizerNode {
      * path is "/a/.channels/b", then the additional path part is ".channels".
      * @param snapshot - the base summary to parse
      */
-    loadBaseSummaryWithoutDifferential(snapshot: ISnapshotTree): void;
-    /**
-     * Does all the work of loadBaseSummaryWithoutDifferential. Additionally if
-     * the base summary is a differential summary containing handle + outstanding ops blob,
-     * then this will return the innermost base summary, and update the state by
-     * tracking the outstanding ops.
-     * @param snapshot - the base summary to parse
-     * @param readAndParseBlob - function to read and parse blobs from storage
-     * @returns the base summary to be used
-     */
-    loadBaseSummary(snapshot: ISnapshotTree, readAndParseBlob: <T>(id: string) => Promise<T>): Promise<{
-        baseSummary: ISnapshotTree;
-        outstandingOps: ISequencedDocumentMessage[];
-    }>;
+    updateBaseSummaryState(snapshot: ISnapshotTree): void;
     /**
      * Records an op representing a change to this node/subtree.
      * @param op - op of change to record
      */
     recordChange(op: ISequencedDocumentMessage): void;
     createChild(
-    /** Summarize function */
+    /**
+     * Summarize function
+     */
     summarizeInternalFn: SummarizeInternalFn, 
-    /** Initial id or path part of this node */
+    /**
+     * Initial id or path part of this node
+     */
     id: string, 
     /**
      * Information needed to create the node.
@@ -165,28 +199,46 @@ export interface ISummarizerNode {
      * If it is local, it will throw unsupported errors on calls to summarize.
      */
     createParam: CreateChildSummarizerNodeParam, 
-    /** Optional configuration affecting summarize behavior */
+    /**
+     * Optional configuration affecting summarize behavior
+     */
     config?: ISummarizerNodeConfig): ISummarizerNode;
     getChild(id: string): ISummarizerNode | undefined;
+    /** True if a summary is currently in progress */
+    isSummaryInProgress?(): boolean;
 }
 /**
- * Extends the functionality of ISummarizerNode to support garbage collection. It adds / udpates the following APIs:
- * - usedRoutes - The routes in this node that are currently in use.
- * - getGCData - A new API that can be used to get the garbage collection data for this node.
- * - summarize - Added a trackState flag which indicates whether the summarizer node should track the state of the
- *   summary or not.
- * - createChild - Added the following params:
- *   - getGCDataFn - This gets the GC data from the caller. This must be provided in order for getGCData to work.
- *   - getInitialGCDetailsFn - This gets the initial GC details from the caller.
- * - deleteChild - Deletes a child node.
- * - isReferenced - This tells whether this node is referenced in the document or not.
- * - updateUsedRoutes - Used to notify this node of routes that are currently in use in it.
+ * Extends the functionality of ISummarizerNode to support garbage collection. It adds / updates the following APIs:
+ *
+ * `usedRoutes`: The routes in this node that are currently in use.
+ *
+ * `getGCData`: A new API that can be used to get the garbage collection data for this node.
+ *
+ * `summarize`: Added a trackState flag which indicates whether the summarizer node should track the state of the
+ * summary or not.
+ *
+ * `createChild`: Added the following params:
+ *
+ * - `getGCDataFn`: This gets the GC data from the caller. This must be provided in order for getGCData to work.
+ *
+ * - `getInitialGCDetailsFn`: This gets the initial GC details from the caller.
+ *
+ * `deleteChild`: Deletes a child node.
+ *
+ * `isReferenced`: This tells whether this node is referenced in the document or not.
+ *
+ * `updateUsedRoutes`: Used to notify this node of routes that are currently in use in it.
+ * @alpha
  */
 export interface ISummarizerNodeWithGC extends ISummarizerNode {
     createChild(
-    /** Summarize function */
+    /**
+     * Summarize function
+     */
     summarizeInternalFn: SummarizeInternalFn, 
-    /** Initial id or path part of this node */
+    /**
+     * Initial id or path part of this node
+     */
     id: string, 
     /**
      * Information needed to create the node.
@@ -195,8 +247,14 @@ export interface ISummarizerNodeWithGC extends ISummarizerNode {
      * If it is local, it will throw unsupported errors on calls to summarize.
      */
     createParam: CreateChildSummarizerNodeParam, 
-    /** Optional configuration affecting summarize behavior */
-    config?: ISummarizerNodeConfigWithGC, getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>, getInitialGCSummaryDetailsFn?: () => Promise<IGarbageCollectionSummaryDetails>): ISummarizerNodeWithGC;
+    /**
+     * Optional configuration affecting summarize behavior
+     */
+    config?: ISummarizerNodeConfigWithGC, getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>, 
+    /**
+     * @deprecated The functionality to update child's base GC details is incorporated in the summarizer node.
+     */
+    getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>): ISummarizerNodeWithGC;
     /**
      * Delete the child with the given id..
      */
@@ -208,7 +266,9 @@ export interface ISummarizerNodeWithGC extends ISummarizerNode {
      * @param fullGC - true to bypass optimizations and force full generation of GC data.
      */
     getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
-    /** Tells whether this node is being referenced in this document or not. Unreferenced node will get GC'd */
+    /**
+     * Tells whether this node is being referenced in this document or not. Unreferenced node will get GC'd
+     */
     isReferenced(): boolean;
     /**
      * After GC has run, called to notify this node of routes that are used in it. These are used for the following:
@@ -216,22 +276,17 @@ export interface ISummarizerNodeWithGC extends ISummarizerNode {
      * 2. To identify if this node or any of its children's used routes changed since last summary.
      *
      * @param usedRoutes - The routes that are used in this node.
-     * @param gcTimestamp - The time when GC was run that generated these used routes. If a node becomes unreferenced
-     * as part of this GC run, this timestamp is used to update the time when it happens.
      */
-    updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number): void;
-    /**
-     * @deprecated - Renamed to getBaseGCDetails.
-     * Returns the GC details that may be added to this node's summary.
-     */
-    getGCSummaryDetails(): IGarbageCollectionSummaryDetails;
-    /** Returns the GC details to be added to this node's summary and is used to initialize new nodes' GC state. */
-    getBaseGCDetails?(): IGarbageCollectionDetailsBase;
+    updateUsedRoutes(usedRoutes: string[]): void;
 }
+/**
+ * @internal
+ */
 export declare const channelsTreeName = ".channels";
 /**
  * Contains telemetry data relevant to summarization workflows.
  * This object is expected to be modified directly by various summarize methods.
+ * @public
  */
 export interface ITelemetryContext {
     /**
@@ -241,6 +296,13 @@ export interface ITelemetryContext {
      * @param value - value to attribute to this summary telemetry data
      */
     set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
+    /**
+     * Sets multiple values for telemetry data being tracked.
+     * @param prefix - unique prefix to tag this data with (ex: "fluid:summarize:")
+     * @param property - property name of the telemetry data being tracked (ex: "Options")
+     * @param values - A set of values to attribute to this summary telemetry data.
+     */
+    setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
     /**
      * Get the telemetry data being tracked
      * @param prefix - unique prefix for this data (ex: "fluid:map:")
@@ -254,6 +316,12 @@ export interface ITelemetryContext {
      */
     serialize(): string;
 }
+/**
+ * @internal
+ */
 export declare const blobCountPropertyName = "BlobCount";
+/**
+ * @internal
+ */
 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,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"}
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../src/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EACN,WAAW,EACX,YAAY,EACZ,yBAAyB,EACzB,aAAa,EACb,KAAK,EACL,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAE5F;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC;IACrB;;;OAGG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;CACrB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IACjE,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACtD;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,2BAA2B,EAAE,MAAM,CAAC;IACpC;;;;;;;;;OASG;IAEH,WAAW,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CACjC,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,OAAO,EACnB,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,KAC9D,OAAO,CAAC,wBAAwB,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;OAQG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACzE;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,oBAAY,0BAA0B;IACrC,WAAW,IAAA;IACX,UAAU,IAAA;IACV,KAAK,IAAA;CACL;AACD;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACvC;IACA,IAAI,EAAE,0BAA0B,CAAC,WAAW,CAAC;CAC5C,GACD;IACA,IAAI,EAAE,0BAA0B,CAAC,UAAU,CAAC;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,KAAK,CAAC;CACf,GACD;IACA,IAAI,EAAE,0BAA0B,CAAC,KAAK,CAAC;CACtC,CAAC;AAEL;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC;;;OAGG;IACH,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC;;;;;;;;OAQG;IACH,SAAS,CACR,QAAQ,EAAE,OAAO,EACjB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7B;;;;;;;OAOG;IACH,sBAAsB,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IACtD;;;OAGG;IACH,YAAY,CAAC,EAAE,EAAE,yBAAyB,GAAG,IAAI,CAAC;IAElD,WAAW;IACV;;OAEG;IACH,mBAAmB,EAAE,mBAAmB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,GAC5B,eAAe,CAAC;IAEnB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;IAElD,iDAAiD;IACjD,mBAAmB,CAAC,IAAI,OAAO,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC7D,WAAW;IACV;;OAEG;IACH,mBAAmB,EAAE,mBAAmB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,2BAA2B,EACpC,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,sBAAsB,CAAC;IACnE;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,6BAA6B,CAAC,GAC/D,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;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC;IAExB;;;;;;OAMG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC7C;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAE/E;;;;;OAKG;IACH,WAAW,CACV,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,GAChD,IAAI,CAAC;IAER;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,0BAA0B,CAAC;IAElE;;;OAGG;IACH,SAAS,IAAI,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,cAAc,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,yBAAyB,kBAAkB,CAAC"}

package/dist/summary.js

@@ -5,13 +5,25 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.totalBlobSizePropertyName = exports.blobCountPropertyName = exports.channelsTreeName = exports.CreateSummarizerNodeSource = void 0;
+/**
+ * @alpha
+ */
 var CreateSummarizerNodeSource;
 (function (CreateSummarizerNodeSource) {
     CreateSummarizerNodeSource[CreateSummarizerNodeSource["FromSummary"] = 0] = "FromSummary";
     CreateSummarizerNodeSource[CreateSummarizerNodeSource["FromAttach"] = 1] = "FromAttach";
     CreateSummarizerNodeSource[CreateSummarizerNodeSource["Local"] = 2] = "Local";
-})(CreateSummarizerNodeSource = exports.CreateSummarizerNodeSource || (exports.CreateSummarizerNodeSource = {}));
+})(CreateSummarizerNodeSource || (exports.CreateSummarizerNodeSource = CreateSummarizerNodeSource = {}));
+/**
+ * @internal
+ */
 exports.channelsTreeName = ".channels";
+/**
+ * @internal
+ */
 exports.blobCountPropertyName = "BlobCount";
+/**
+ * @internal
+ */
 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;;;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"]}
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../src/summary.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAmJH;;GAEG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACrC,yFAAW,CAAA;IACX,uFAAU,CAAA;IACV,6EAAK,CAAA;AACN,CAAC,EAJW,0BAA0B,0CAA1B,0BAA0B,QAIrC;AAuKD;;GAEG;AACU,QAAA,gBAAgB,GAAG,WAAW,CAAC;AA2C5C;;GAEG;AACU,QAAA,qBAAqB,GAAG,WAAW,CAAC;AAEjD;;GAEG;AACU,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/core-interfaces\";\nimport {\n\tSummaryTree,\n\tISummaryTree,\n\tISequencedDocumentMessage,\n\tISnapshotTree,\n\tITree,\n} from \"@fluidframework/protocol-definitions\";\nimport { IGarbageCollectionData, IGarbageCollectionDetailsBase } from \"./garbageCollection\";\n\n/**\n * Contains the aggregation data from a Tree/Subtree.\n * @public\n */\nexport interface ISummaryStats {\n\ttreeNodeCount: number;\n\tblobNodeCount: number;\n\thandleNodeCount: number;\n\ttotalBlobSize: number;\n\tunreferencedBlobSize: 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 * @public\n */\nexport interface ISummaryTreeWithStats {\n\t/**\n\t * Represents an aggregation of node counts and blob sizes associated to the current summary information\n\t */\n\tstats: ISummaryStats;\n\t/**\n\t * A recursive data structure that will be converted to a snapshot tree and uploaded\n\t * to the backend.\n\t */\n\tsummary: ISummaryTree;\n}\n\n/**\n * Represents a summary at a current sequence number.\n * @alpha\n */\nexport interface ISummarizeResult {\n\tstats: ISummaryStats;\n\tsummary: SummaryTree;\n}\n\n/**\n * Contains the same data as ISummaryResult but in order to avoid naming collisions,\n * the data store summaries are wrapped around an array of labels identified by pathPartsForChildren.\n *\n * @example\n *\n * ```typescript\n * id:\"\"\n * pathPartsForChildren: [\"path1\"]\n * stats: ...\n * summary:\n *   ...\n *     \"path1\":\n * ```\n * @alpha\n */\nexport interface ISummarizeInternalResult extends ISummarizeResult {\n\tid: string;\n\t/**\n\t * Additional path parts between this node's ID and its children's IDs.\n\t */\n\tpathPartsForChildren?: string[];\n}\n\n/**\n * @experimental - Can be deleted/changed at any time\n * Contains the necessary information to allow DDSes to do incremental summaries\n * @public\n */\nexport interface IExperimentalIncrementalSummaryContext {\n\t/**\n\t * The sequence number of the summary generated that will be sent to the server.\n\t */\n\tsummarySequenceNumber: number;\n\t/**\n\t * The sequence number of the most recent summary that was acknowledged by the server.\n\t */\n\tlatestSummarySequenceNumber: number;\n\t/**\n\t * The path to the runtime/datastore/dds that is used to generate summary handles\n\t * Note: Summary handles are nodes of the summary tree that point to previous parts of the last successful summary\n\t * instead of being a blob or tree node\n\t *\n\t * This path contains the id of the data store and dds which should not be leaked to layers below them. Ideally,\n\t * a layer should not know its own id. This is important for channel unification work and there has been a lot of\n\t * work to remove these kinds of leakages. Some still exist, which have to be fixed but we should not be adding\n\t * more dependencies.\n\t */\n\t// TODO: remove summaryPath\n\tsummaryPath: string;\n}\n\n/**\n * @alpha\n */\nexport type SummarizeInternalFn = (\n\tfullTree: boolean,\n\ttrackState: boolean,\n\ttelemetryContext?: ITelemetryContext,\n\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext,\n) => Promise<ISummarizeInternalResult>;\n\n/**\n * @alpha\n */\nexport interface ISummarizerNodeConfig {\n\t/**\n\t * True to reuse previous handle when unchanged since last acked summary.\n\t * Defaults to true.\n\t */\n\treadonly canReuseHandle?: boolean;\n\t/**\n\t * True to always stop execution on error during summarize, or false to\n\t * attempt creating a summary that is a pointer ot the last acked summary\n\t * plus outstanding ops in case of internal summarize failure.\n\t * Defaults to false.\n\t *\n\t * BUG BUG: Default to true while we investigate problem\n\t * with differential summaries\n\t */\n\treadonly throwOnFailure?: true;\n}\n\n/**\n * @alpha\n */\nexport interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {\n\t/**\n\t * True if GC is disabled. If so, don't track GC related state for a summary.\n\t * This is propagated to all child nodes.\n\t */\n\treadonly gcDisabled?: boolean;\n}\n\n/**\n * @alpha\n */\nexport enum CreateSummarizerNodeSource {\n\tFromSummary,\n\tFromAttach,\n\tLocal,\n}\n/**\n * @alpha\n */\nexport type CreateChildSummarizerNodeParam =\n\t| {\n\t\t\ttype: CreateSummarizerNodeSource.FromSummary;\n\t  }\n\t| {\n\t\t\ttype: CreateSummarizerNodeSource.FromAttach;\n\t\t\tsequenceNumber: number;\n\t\t\tsnapshot: ITree;\n\t  }\n\t| {\n\t\t\ttype: CreateSummarizerNodeSource.Local;\n\t  };\n\n/**\n * @alpha\n */\nexport interface ISummarizerNode {\n\t/**\n\t * Latest successfully acked summary reference sequence number\n\t */\n\treadonly referenceSequenceNumber: number;\n\t/**\n\t * Marks the node as having a change with the given sequence number.\n\t * @param sequenceNumber - sequence number of change\n\t */\n\tinvalidate(sequenceNumber: number): void;\n\t/**\n\t * Calls the internal summarize function and handles internal state tracking.\n\t * If unchanged and fullTree is false, it will reuse previous summary subtree.\n\t * If an error is encountered and throwOnFailure is false, it will try to make\n\t * a summary with a pointer to the previous summary + a blob of outstanding ops.\n\t * @param fullTree - true to skip optimizations and always generate the full tree\n\t * @param trackState - indicates whether the summarizer node should track the state of the summary or not\n\t * @param telemetryContext - summary data passed through the layers for telemetry purposes\n\t */\n\tsummarize(\n\t\tfullTree: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummarizeResult>;\n\t/**\n\t * Checks if there are any additional path parts for children that need to\n\t * be loaded from the base summary. Additional path parts represent parts\n\t * of the path between this SummarizerNode and any child SummarizerNodes\n\t * that it might have. For example: if datastore \"a\" contains dds \"b\", but the\n\t * path is \"/a/.channels/b\", then the additional path part is \".channels\".\n\t * @param snapshot - the base summary to parse\n\t */\n\tupdateBaseSummaryState(snapshot: ISnapshotTree): void;\n\t/**\n\t * Records an op representing a change to this node/subtree.\n\t * @param op - op of change to record\n\t */\n\trecordChange(op: ISequencedDocumentMessage): void;\n\n\tcreateChild(\n\t\t/**\n\t\t * Summarize function\n\t\t */\n\t\tsummarizeInternalFn: SummarizeInternalFn,\n\t\t/**\n\t\t * Initial id or path part of this node\n\t\t */\n\t\tid: string,\n\t\t/**\n\t\t * Information needed to create the node.\n\t\t * If it is from a base summary, it will assert that a summary has been seen.\n\t\t * Attach information if it is created from an attach op.\n\t\t * If it is local, it will throw unsupported errors on calls to summarize.\n\t\t */\n\t\tcreateParam: CreateChildSummarizerNodeParam,\n\t\t/**\n\t\t * Optional configuration affecting summarize behavior\n\t\t */\n\t\tconfig?: ISummarizerNodeConfig,\n\t): ISummarizerNode;\n\n\tgetChild(id: string): ISummarizerNode | undefined;\n\n\t/** True if a summary is currently in progress */\n\tisSummaryInProgress?(): boolean;\n}\n\n/**\n * Extends the functionality of ISummarizerNode to support garbage collection. It adds / updates the following APIs:\n *\n * `usedRoutes`: The routes in this node that are currently in use.\n *\n * `getGCData`: A new API that can be used to get the garbage collection data for this node.\n *\n * `summarize`: Added a trackState flag which indicates whether the summarizer node should track the state of the\n * summary or not.\n *\n * `createChild`: Added the following params:\n *\n * - `getGCDataFn`: This gets the GC data from the caller. This must be provided in order for getGCData to work.\n *\n * - `getInitialGCDetailsFn`: This gets the initial GC details from the caller.\n *\n * `deleteChild`: Deletes a child node.\n *\n * `isReferenced`: This tells whether this node is referenced in the document or not.\n *\n * `updateUsedRoutes`: Used to notify this node of routes that are currently in use in it.\n * @alpha\n */\nexport interface ISummarizerNodeWithGC extends ISummarizerNode {\n\tcreateChild(\n\t\t/**\n\t\t * Summarize function\n\t\t */\n\t\tsummarizeInternalFn: SummarizeInternalFn,\n\t\t/**\n\t\t * Initial id or path part of this node\n\t\t */\n\t\tid: string,\n\t\t/**\n\t\t * Information needed to create the node.\n\t\t * If it is from a base summary, it will assert that a summary has been seen.\n\t\t * Attach information if it is created from an attach op.\n\t\t * If it is local, it will throw unsupported errors on calls to summarize.\n\t\t */\n\t\tcreateParam: CreateChildSummarizerNodeParam,\n\t\t/**\n\t\t * Optional configuration affecting summarize behavior\n\t\t */\n\t\tconfig?: ISummarizerNodeConfigWithGC,\n\t\tgetGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n\t\t/**\n\t\t * @deprecated The functionality to update child's base GC details is incorporated in the summarizer node.\n\t\t */\n\t\tgetBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n\t): ISummarizerNodeWithGC;\n\n\t/**\n\t * Delete the child with the given id..\n\t */\n\tdeleteChild(id: string): void;\n\n\tgetChild(id: string): ISummarizerNodeWithGC | undefined;\n\n\t/**\n\t * Returns this node's data that is used for garbage collection. This includes a list of GC nodes that represent\n\t * this node. Each node has a set of outbound routes to other GC nodes in the document.\n\t * @param fullGC - true to bypass optimizations and force full generation of GC data.\n\t */\n\tgetGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;\n\n\t/**\n\t * Tells whether this node is being referenced in this document or not. Unreferenced node will get GC'd\n\t */\n\tisReferenced(): boolean;\n\n\t/**\n\t * After GC has run, called to notify this node of routes that are used in it. These are used for the following:\n\t * 1. To identify if this node is being referenced in the document or not.\n\t * 2. To identify if this node or any of its children's used routes changed since last summary.\n\t *\n\t * @param usedRoutes - The routes that are used in this node.\n\t */\n\tupdateUsedRoutes(usedRoutes: string[]): void;\n}\n\n/**\n * @internal\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 * @public\n */\nexport interface ITelemetryContext {\n\t/**\n\t * Sets value for telemetry data being tracked.\n\t * @param prefix - unique prefix to tag this data with (ex: \"fluid:map:\")\n\t * @param property - property name of the telemetry data being tracked (ex: \"DirectoryCount\")\n\t * @param value - value to attribute to this summary telemetry data\n\t */\n\tset(prefix: string, property: string, value: TelemetryEventPropertyType): void;\n\n\t/**\n\t * Sets multiple values for telemetry data being tracked.\n\t * @param prefix - unique prefix to tag this data with (ex: \"fluid:summarize:\")\n\t * @param property - property name of the telemetry data being tracked (ex: \"Options\")\n\t * @param values - A set of values to attribute to this summary telemetry data.\n\t */\n\tsetMultiple(\n\t\tprefix: string,\n\t\tproperty: string,\n\t\tvalues: Record<string, TelemetryEventPropertyType>,\n\t): void;\n\n\t/**\n\t * Get the telemetry data being tracked\n\t * @param prefix - unique prefix for this data (ex: \"fluid:map:\")\n\t * @param property - property name of the telemetry data being tracked (ex: \"DirectoryCount\")\n\t * @returns undefined if item not found\n\t */\n\tget(prefix: string, property: string): TelemetryEventPropertyType;\n\n\t/**\n\t * Returns a serialized version of all the telemetry data.\n\t * Should be used when logging in telemetry events.\n\t */\n\tserialize(): string;\n}\n\n/**\n * @internal\n */\nexport const blobCountPropertyName = \"BlobCount\";\n\n/**\n * @internal\n */\nexport const totalBlobSizePropertyName = \"TotalBlobSize\";\n"]}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.3"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "1.4.0-115997",
+  "version": "2.0.0-dev-rc.1.0.0.224419",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,52 +11,106 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "main": "dist/index.js",
   "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: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",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "tsc": "tsc",
-    "typetests:gen": "flub generate typetests --generate --dir . --no-generateInName",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-  },
   "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "1.4.0-115997",
-    "@fluidframework/core-interfaces": "1.4.0-115997",
-    "@fluidframework/driver-definitions": "1.4.0-115997",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@types/node": "^14.18.0"
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/id-compressor": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/protocol-definitions": "^3.1.0-223007"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.6.0-110101",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@1.3.1",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
-    "eslint": "~8.6.0",
-    "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "0.29.0-222379",
+    "@fluidframework/eslint-config-fluid": "^3.1.0",
+    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-internal.7.2.0",
+    "@microsoft/api-extractor": "^7.38.3",
+    "copyfiles": "^2.4.1",
+    "eslint": "~8.50.0",
+    "eslint-plugin-deprecation": "~2.0.0",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
+    "typescript": "~5.1.6"
+  },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs"
+        ],
+        "script": false
+      }
+    }
   },
   "typeValidation": {
-    "version": "1.4.0",
-    "baselineRange": "~1.3.0",
-    "baselineVersion": "1.3.1",
-    "broken": {}
+    "broken": {
+      "TypeAliasDeclaration_IdCreationRangeWithStashedState": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "RemovedTypeAliasDeclaration_IdCreationRangeWithStashedState": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IdCreationRange": {
+        "forwardCompat": false
+      },
+      "VariableDeclaration_initialClusterCapacity": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "RemovedVariableDeclaration_initialClusterCapacity": {
+        "forwardCompat": false,
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IContainerRuntimeBase": {
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IFluidDataStoreContext": {
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IFluidDataStoreContextDetached": {
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IDataStore": {
+        "backCompat": false
+      },
+      "InterfaceDeclaration_IFluidDataStoreChannel": {
+        "backCompat": false
+      }
+    }
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --local",
+    "build": "fluid-build . --task build",
+    "build:compile": "fluid-build . --task compile",
+    "build:docs": "fluid-build . --task api",
+    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "ci:build:docs": "api-extractor run",
+    "clean": "rimraf --glob dist \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "tsc": "tsc",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
-}
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};