@fluidframework/runtime-definitions 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/src/dataStoreFactory.ts

@@ -5,26 +5,36 @@
 
 import { IFluidDataStoreContext, IFluidDataStoreChannel } from "./dataStoreContext";
 
+/**
+ * @alpha
+ */
 export const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory = "IFluidDataStoreFactory";
 
+/**
+ * @alpha
+ */
 export interface IProvideFluidDataStoreFactory {
-    readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
+	readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
 }
 
 /**
  * IFluidDataStoreFactory create data stores.  It is associated with an identifier (its `type` member)
  * and usually provided to consumers using this mapping through a data store registry.
+ * @alpha
  */
 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,30 +7,42 @@ 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.
+ * @alpha
  */
-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.
+ * @alpha
  */
 export type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
 /**
  * An iterable identifier/registry entry pair list
+ * @alpha
  */
 export type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
 
-export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry = "IFluidDataStoreRegistry";
+/**
+ * @alpha
+ */
+export const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry =
+	"IFluidDataStoreRegistry";
 
+/**
+ * @alpha
+ */
 export interface IProvideFluidDataStoreRegistry {
-    readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
+	readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
 }
 
 /**
  * An association of identifiers to data store registry entries, where the
  * entries can be used to create data stores.
+ * @alpha
  */
 export interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
-    get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
+	get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
 }

package/src/garbageCollection.ts

@@ -3,31 +3,54 @@
  * 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.
+ *
+ * @internal
+ */
+export const gcTreeKey = "gc";
+/**
+ * They prefix for GC blobs in the GC tree in summary.
+ *
+ * @internal
+ */
+export const gcBlobPrefix = "__gc";
+/**
+ * The key for tombstone blob in the GC tree in summary.
+ *
+ * @internal
+ */
+export const gcTombstoneBlobKey = "__tombstones";
+/**
+ * The key for deleted nodes blob in the GC tree in summary.
+ *
+ * @internal
+ */
+export const gcDeletedBlobKey = "__deletedNodes";
 
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
+ * @public
  */
 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.
+ * @alpha
  */
 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;
 }
-
-/**
- * @deprecated - Kept for back-compat. This has been renamed to {@link IGarbageCollectionDetailsBase}.
- */
-export type IGarbageCollectionSummaryDetails = IGarbageCollectionDetailsBase;

package/src/index.ts

@@ -3,9 +3,114 @@
  * Licensed under the MIT License.
  */
 
-export * from "./dataStoreFactory";
-export * from "./dataStoreRegistry";
-export * from "./dataStoreContext";
-export * from "./garbageCollection";
-export * from "./protocol";
-export * from "./summary";
+export {
+	AttributionInfo,
+	AttributionKey,
+	DetachedAttributionKey,
+	LocalAttributionKey,
+	OpAttributionKey,
+} from "./attribution";
+export {
+	AliasResult,
+	CreateChildSummarizerNodeFn,
+	FlushMode,
+	FlushModeExperimental,
+	IContainerRuntimeBase,
+	IContainerRuntimeBaseEvents,
+	IDataStore,
+	IFluidDataStoreChannel,
+	IFluidDataStoreContext,
+	IFluidDataStoreContextDetached,
+	IFluidDataStoreContextEvents,
+	VisibilityState,
+} from "./dataStoreContext";
+export { IFluidDataStoreFactory, IProvideFluidDataStoreFactory } from "./dataStoreFactory";
+export {
+	FluidDataStoreRegistryEntry,
+	IFluidDataStoreRegistry,
+	IProvideFluidDataStoreRegistry,
+	NamedFluidDataStoreRegistryEntries,
+	NamedFluidDataStoreRegistryEntry,
+} from "./dataStoreRegistry";
+export {
+	gcBlobPrefix,
+	gcDeletedBlobKey,
+	gcTombstoneBlobKey,
+	gcTreeKey,
+	IGarbageCollectionData,
+	IGarbageCollectionDetailsBase,
+} from "./garbageCollection";
+export {
+	IAttachMessage,
+	IEnvelope,
+	IInboundSignalMessage,
+	InboundAttachMessage,
+	ISignalEnvelope,
+} from "./protocol";
+export {
+	blobCountPropertyName,
+	channelsTreeName,
+	CreateChildSummarizerNodeParam,
+	CreateSummarizerNodeSource,
+	IExperimentalIncrementalSummaryContext,
+	ISummarizeInternalResult,
+	ISummarizeResult,
+	ISummarizerNode,
+	ISummarizerNodeConfig,
+	ISummarizerNodeConfigWithGC,
+	ISummarizerNodeWithGC,
+	ISummaryStats,
+	ISummaryTreeWithStats,
+	ITelemetryContext,
+	SummarizeInternalFn,
+	totalBlobSizePropertyName,
+} from "./summary";
+
+// Re-exports for backwards compatibility.
+// Will be removed in the future.
+export {
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	IdCompressor,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	IIdCompressor,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	IIdCompressorCore,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	IdCreationRange,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	OpSpaceCompressedId,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	SerializedIdCompressor,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	SerializedIdCompressorWithNoSession,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	SerializedIdCompressorWithOngoingSession,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	SessionId,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	SessionSpaceCompressedId,
+	/**
+	 * @deprecated Import from `@fluidframework/id-compressor` instead.
+	 */
+	StableId,
+} from "@fluidframework/id-compressor";

package/src/protocol.ts

@@ -7,65 +7,71 @@ import { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
 
 /**
  * An envelope wraps the contents with the intended target
+ * @alpha
  */
 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;
 }
 
+/**
+ * @internal
+ */
 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.
+ * @public
  */
 export interface IInboundSignalMessage extends ISignalMessage {
-    type: string;
+	type: string;
 }
 
 /**
  * Message send by client attaching local data structure.
  * Contains snapshot of data structure which is the current state of this data structure.
+ * @alpha
  */
 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;
 }
 
 /**
@@ -73,6 +79,8 @@ export interface IAttachMessage {
  * but it should not be used when creating a new attach op.
  * Older versions of attach messages could have null snapshots,
  * so this gives correct typings for writing backward compatible code.
+ * @alpha
  */
-export type InboundAttachMessage = Omit<IAttachMessage, "snapshot">
-    & { snapshot: IAttachMessage["snapshot"] | null; };
+export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
+	snapshot: IAttachMessage["snapshot"] | null;
+};