@fluidframework/runtime-definitions 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

package/src/dataStoreFactory.ts

@@ -8,7 +8,7 @@ import { IFluidDataStoreContext, IFluidDataStoreChannel } from "./dataStoreConte
 export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory = "IFluidDataStoreFactory";
 
 export interface IProvideFluidDataStoreFactory {
-    readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
+	readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
 }
 
 /**
@@ -16,15 +16,18 @@ export interface IProvideFluidDataStoreFactory {
  * and usually provided to consumers using this mapping through a data store registry.
  */
 export interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
-    /**
-     * String that uniquely identifies the type of data store created by this factory.
-     */
-    type: string;
+	/**
+	 * String that uniquely identifies the type of data store created by this factory.
+	 */
+	type: string;
 
-    /**
-     * Generates runtime for the data store from the data store context. Once created should be bound to the context.
-     * @param context - Context for the data store.
-     * @param existing - If instantiating from an existing file.
-     */
-    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<IFluidDataStoreChannel>;
+	/**
+	 * Generates runtime for the data store from the data store context. Once created should be bound to the context.
+	 * @param context - Context for the data store.
+	 * @param existing - If instantiating from an existing file.
+	 */
+	instantiateDataStore(
+		context: IFluidDataStoreContext,
+		existing: boolean,
+	): Promise<IFluidDataStoreChannel>;
 }

package/src/dataStoreRegistry.ts

@@ -7,10 +7,11 @@ import { IProvideFluidDataStoreFactory } from "./dataStoreFactory";
 
 /**
  * A single registry entry that may be used to create data stores
-* It has to have either factory or registry, or both.
+ * It has to have either factory or registry, or both.
  */
-export type FluidDataStoreRegistryEntry =
-    Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;
+export type FluidDataStoreRegistryEntry = Readonly<
+	Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>
+>;
 /**
  * An associated pair of an identifier and registry entry.  Registry entries
  * may be dynamically loaded.
@@ -21,10 +22,11 @@ export type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRe
  */
 export type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
 
-export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry = "IFluidDataStoreRegistry";
+export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry =
+	"IFluidDataStoreRegistry";
 
 export interface IProvideFluidDataStoreRegistry {
-    readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
+	readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
 }
 
 /**
@@ -32,5 +34,5 @@ export interface IProvideFluidDataStoreRegistry {
  * entries can be used to create data stores.
  */
 export interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
-    get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
+	get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
 }

package/src/garbageCollection.ts

@@ -3,26 +3,36 @@
  * Licensed under the MIT License.
  */
 
-// The key to use for storing garbage collection blob in summary.
-export const gcBlobKey = "gc";
+/** The key for the GC tree in summary. */
+export const gcTreeKey = "gc";
+/** They prefix for GC blobs in the GC tree in summary. */
+export const gcBlobPrefix = "__gc";
+/** The key for tombstone blob in the GC tree in summary. */
+export const gcTombstoneBlobKey = "__tombstones";
+/** The key for deleted nodes blob in the GC tree in summary. */
+export const gcDeletedBlobKey = "__deletedNodes";
 
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
  */
 export interface IGarbageCollectionData {
-    /** The GC nodes of a Fluid object in the Container. Each node has an id and a set of routes to other GC nodes. */
-    gcNodes: { [ id: string ]: string[]; };
+	/**
+	 * The GC nodes of a Fluid object in the Container. Each node has an id and a set of routes to other GC nodes.
+	 */
+	gcNodes: { [id: string]: string[] };
 }
 
 /**
  * GC details provided to each node during creation.
  */
 export interface IGarbageCollectionDetailsBase {
-    /** A list of routes to Fluid objects that are used in this node. */
-    usedRoutes?: string[];
-    /** The GC data of this node. */
-    gcData?: IGarbageCollectionData;
-    /** If this node is unreferenced, the time when it was marked as such. */
-    unrefTimestamp?: number;
+	/**
+	 * A list of routes to Fluid objects that are used in this node.
+	 */
+	usedRoutes?: string[];
+	/**
+	 * The GC data of this node.
+	 */
+	gcData?: IGarbageCollectionData;
 }

package/src/index.ts

@@ -3,11 +3,18 @@
  * Licensed under the MIT License.
  */
 
+export {
+	AttributionInfo,
+	AttributionKey,
+	DetachedAttributionKey,
+	LocalAttributionKey,
+	OpAttributionKey,
+} from "./attribution";
 export {
 	AliasResult,
-	BindState,
 	CreateChildSummarizerNodeFn,
 	FlushMode,
+	FlushModeExperimental,
 	IContainerRuntimeBase,
 	IContainerRuntimeBaseEvents,
 	IDataStore,
@@ -25,15 +32,31 @@ export {
 	NamedFluidDataStoreRegistryEntries,
 	NamedFluidDataStoreRegistryEntry,
 } from "./dataStoreRegistry";
-export { gcBlobKey, IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbageCollection";
-export { IAttachMessage, IEnvelope, IInboundSignalMessage, InboundAttachMessage, ISignalEnvelope } from "./protocol";
+export {
+	gcBlobPrefix,
+	gcDeletedBlobKey,
+	gcTombstoneBlobKey,
+	gcTreeKey,
+	IGarbageCollectionData,
+	IGarbageCollectionDetailsBase,
+} from "./garbageCollection";
+export {
+	IAttachMessage,
+	IEnvelope,
+	IInboundSignalMessage,
+	InboundAttachMessage,
+	ISignalEnvelope,
+} from "./protocol";
 export {
 	blobCountPropertyName,
 	channelsTreeName,
 	CreateChildSummarizerNodeParam,
 	CreateSummarizerNodeSource,
 	IGarbageCollectionNodeData,
+	IGarbageCollectionSnapshotData,
 	IGarbageCollectionState,
+	IGarbageCollectionSummaryDetailsLegacy,
+	IExperimentalIncrementalSummaryContext,
 	ISummarizeInternalResult,
 	ISummarizeResult,
 	ISummarizerNode,

package/src/protocol.ts

@@ -9,42 +9,42 @@ import { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
  * An envelope wraps the contents with the intended target
  */
 export interface IEnvelope {
-    /**
-     * The target for the envelope
-     */
-    address: string;
+	/**
+	 * The target for the envelope
+	 */
+	address: string;
 
-    /**
-     * The contents of the envelope
-     */
-    contents: any;
+	/**
+	 * The contents of the envelope
+	 */
+	contents: any;
 }
 
 export interface ISignalEnvelope {
-    /**
-     * The target for the envelope, undefined for the container
-     */
-    address?: string;
+	/**
+	 * The target for the envelope, undefined for the container
+	 */
+	address?: string;
 
-    /**
-     * Identifier for the signal being submitted.
-     */
-    clientSignalSequenceNumber: number;
+	/**
+	 * Identifier for the signal being submitted.
+	 */
+	clientSignalSequenceNumber: number;
 
-     /**
-     * The contents of the envelope
-     */
-    contents: {
-        type: string;
-        content: any;
-    };
+	/**
+	 * The contents of the envelope
+	 */
+	contents: {
+		type: string;
+		content: any;
+	};
 }
 
 /**
  * Represents ISignalMessage with its type.
  */
 export interface IInboundSignalMessage extends ISignalMessage {
-    type: string;
+	type: string;
 }
 
 /**
@@ -52,20 +52,20 @@ export interface IInboundSignalMessage extends ISignalMessage {
  * Contains snapshot of data structure which is the current state of this data structure.
  */
 export interface IAttachMessage {
-    /**
-     * The identifier for the object
-     */
-    id: string;
+	/**
+	 * The identifier for the object
+	 */
+	id: string;
 
-    /**
-     * The type of object
-     */
-    type: string;
+	/**
+	 * The type of object
+	 */
+	type: string;
 
-    /**
-     * Initial snapshot of the document (contains ownership)
-     */
-    snapshot: ITree;
+	/**
+	 * Initial snapshot of the document (contains ownership)
+	 */
+	snapshot: ITree;
 }
 
 /**
@@ -74,5 +74,6 @@ export interface IAttachMessage {
  * Older versions of attach messages could have null snapshots,
  * so this gives correct typings for writing backward compatible code.
  */
-export type InboundAttachMessage = Omit<IAttachMessage, "snapshot">
-    & { snapshot: IAttachMessage["snapshot"] | null; };
+export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
+	snapshot: IAttachMessage["snapshot"] | null;
+};