@fluidframework/runtime-definitions 2.0.0-dev-rc.1.0.0.228517 → 2.0.0-dev-rc.2.0.0.245554

package/lib/runtime-definitions-beta.d.ts

@@ -0,0 +1,242 @@
+import type { AttachState } from '@fluidframework/container-definitions';
+import type { FluidObject } from '@fluidframework/core-interfaces';
+import type { IAudience } from '@fluidframework/container-definitions';
+import type { IClientDetails } from '@fluidframework/protocol-definitions';
+import type { IDeltaManager } from '@fluidframework/container-definitions';
+import type { IDisposable } from '@fluidframework/core-interfaces';
+import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import type { IEvent } from '@fluidframework/core-interfaces';
+import type { IEventProvider } from '@fluidframework/core-interfaces';
+import type { IFluidHandle } from '@fluidframework/core-interfaces';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
+import type { IQuorumClients } from '@fluidframework/protocol-definitions';
+import type { IRequest } from '@fluidframework/core-interfaces';
+import type { IResponse } from '@fluidframework/core-interfaces';
+import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { ISignalMessage } from '@fluidframework/protocol-definitions';
+import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import type { ISummaryTree } from '@fluidframework/protocol-definitions';
+import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import type { ITree } from '@fluidframework/protocol-definitions';
+import type { IUser } from '@fluidframework/protocol-definitions';
+import type { SummaryTree } from '@fluidframework/protocol-definitions';
+import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
+
+/* Excluded from this release type: AliasResult */
+
+/* Excluded from this release type: AttributionInfo */
+
+/* Excluded from this release type: AttributionKey */
+
+/* Excluded from this release type: blobCountPropertyName */
+
+/* Excluded from this release type: channelsTreeName */
+
+/* Excluded from this release type: CreateChildSummarizerNodeFn */
+
+/* Excluded from this release type: CreateChildSummarizerNodeParam */
+
+/* Excluded from this release type: CreateSummarizerNodeSource */
+
+/* Excluded from this release type: DetachedAttributionKey */
+
+/* Excluded from this release type: FluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: FlushMode */
+
+/* Excluded from this release type: FlushModeExperimental */
+
+/* Excluded from this release type: gcBlobPrefix */
+
+/* Excluded from this release type: gcDataBlobKey */
+
+/* Excluded from this release type: gcDeletedBlobKey */
+
+/* Excluded from this release type: gcTombstoneBlobKey */
+
+/* Excluded from this release type: gcTreeKey */
+
+/* Excluded from this release type: IAttachMessage */
+
+/* Excluded from this release type: IContainerRuntimeBase */
+
+/* Excluded from this release type: IContainerRuntimeBaseEvents */
+
+/* Excluded from this release type: IDataStore */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IEnvelope */
+
+/**
+ * @experimental - Can be deleted/changed at any time
+ * Contains the necessary information to allow DDSes to do incremental summaries
+ * @public
+ */
+export declare 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;
+}
+
+/* Excluded from this release type: IFluidDataStoreChannel */
+
+/* Excluded from this release type: IFluidDataStoreContext */
+
+/* Excluded from this release type: IFluidDataStoreContextDetached */
+
+/* Excluded from this release type: IFluidDataStoreFactory */
+
+/* Excluded from this release type: IFluidDataStoreRegistry */
+
+/* Excluded from this release type: IFluidParentContext */
+
+/**
+ * Garbage collection data returned by nodes in a Container.
+ * Used for running GC in the Container.
+ * @public
+ */
+export declare 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[];
+    };
+}
+
+/* Excluded from this release type: IGarbageCollectionDetailsBase */
+
+/**
+ * Represents ISignalMessage with its type.
+ * @public
+ */
+export declare interface IInboundSignalMessage extends ISignalMessage {
+    type: string;
+}
+
+/* Excluded from this release type: InboundAttachMessage */
+
+/* Excluded from this release type: IProvideFluidDataStoreFactory */
+
+/* Excluded from this release type: IProvideFluidDataStoreRegistry */
+
+/* Excluded from this release type: ISignalEnvelope */
+
+/* Excluded from this release type: ISummarizeInternalResult */
+
+/* Excluded from this release type: ISummarizeResult */
+
+/* Excluded from this release type: ISummarizerNode */
+
+/* Excluded from this release type: ISummarizerNodeConfig */
+
+/* Excluded from this release type: ISummarizerNodeConfigWithGC */
+
+/* Excluded from this release type: ISummarizerNodeWithGC */
+
+/**
+ * Contains the aggregation data from a Tree/Subtree.
+ * @public
+ */
+export declare interface ISummaryStats {
+    treeNodeCount: number;
+    blobNodeCount: number;
+    handleNodeCount: number;
+    totalBlobSize: number;
+    unreferencedBlobSize: number;
+}
+
+/**
+ * Represents the summary tree for a node along with the statistics for that tree.
+ * For example, for a given data store, it contains the data for data store along with a subtree for
+ * each of its DDS.
+ * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
+ * will be taking part of the summarization process.
+ * @public
+ */
+export declare interface ISummaryTreeWithStats {
+    /**
+     * 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
+     * to the backend.
+     */
+    summary: ISummaryTree;
+}
+
+/**
+ * Contains telemetry data relevant to summarization workflows.
+ * This object is expected to be modified directly by various summarize methods.
+ * @public
+ */
+export declare 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: TelemetryBaseEventPropertyType): 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, TelemetryBaseEventPropertyType>): void;
+    /**
+     * Get the telemetry data being tracked
+     *
+     * @deprecated This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.
+     *
+     * @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): TelemetryBaseEventPropertyType;
+    /**
+     * Returns a serialized version of all the telemetry data.
+     * Should be used when logging in telemetry events.
+     *
+     * @deprecated This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function
+     * but this functionality should not be used by other code being given an ITelemetryContext.
+     */
+    serialize(): string;
+}
+
+/* Excluded from this release type: LocalAttributionKey */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntries */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: OpAttributionKey */
+
+/* Excluded from this release type: SummarizeInternalFn */
+
+/* Excluded from this release type: totalBlobSizePropertyName */
+
+/* Excluded from this release type: VisibilityState */
+
+export { }

package/lib/runtime-definitions-public.d.ts

@@ -0,0 +1,242 @@
+import type { AttachState } from '@fluidframework/container-definitions';
+import type { FluidObject } from '@fluidframework/core-interfaces';
+import type { IAudience } from '@fluidframework/container-definitions';
+import type { IClientDetails } from '@fluidframework/protocol-definitions';
+import type { IDeltaManager } from '@fluidframework/container-definitions';
+import type { IDisposable } from '@fluidframework/core-interfaces';
+import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import type { IEvent } from '@fluidframework/core-interfaces';
+import type { IEventProvider } from '@fluidframework/core-interfaces';
+import type { IFluidHandle } from '@fluidframework/core-interfaces';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
+import type { IQuorumClients } from '@fluidframework/protocol-definitions';
+import type { IRequest } from '@fluidframework/core-interfaces';
+import type { IResponse } from '@fluidframework/core-interfaces';
+import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { ISignalMessage } from '@fluidframework/protocol-definitions';
+import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import type { ISummaryTree } from '@fluidframework/protocol-definitions';
+import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import type { ITree } from '@fluidframework/protocol-definitions';
+import type { IUser } from '@fluidframework/protocol-definitions';
+import type { SummaryTree } from '@fluidframework/protocol-definitions';
+import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
+
+/* Excluded from this release type: AliasResult */
+
+/* Excluded from this release type: AttributionInfo */
+
+/* Excluded from this release type: AttributionKey */
+
+/* Excluded from this release type: blobCountPropertyName */
+
+/* Excluded from this release type: channelsTreeName */
+
+/* Excluded from this release type: CreateChildSummarizerNodeFn */
+
+/* Excluded from this release type: CreateChildSummarizerNodeParam */
+
+/* Excluded from this release type: CreateSummarizerNodeSource */
+
+/* Excluded from this release type: DetachedAttributionKey */
+
+/* Excluded from this release type: FluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: FlushMode */
+
+/* Excluded from this release type: FlushModeExperimental */
+
+/* Excluded from this release type: gcBlobPrefix */
+
+/* Excluded from this release type: gcDataBlobKey */
+
+/* Excluded from this release type: gcDeletedBlobKey */
+
+/* Excluded from this release type: gcTombstoneBlobKey */
+
+/* Excluded from this release type: gcTreeKey */
+
+/* Excluded from this release type: IAttachMessage */
+
+/* Excluded from this release type: IContainerRuntimeBase */
+
+/* Excluded from this release type: IContainerRuntimeBaseEvents */
+
+/* Excluded from this release type: IDataStore */
+
+/* Excluded from this release type: IDocumentStorageService */
+
+/* Excluded from this release type: IEnvelope */
+
+/**
+ * @experimental - Can be deleted/changed at any time
+ * Contains the necessary information to allow DDSes to do incremental summaries
+ * @public
+ */
+export declare 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;
+}
+
+/* Excluded from this release type: IFluidDataStoreChannel */
+
+/* Excluded from this release type: IFluidDataStoreContext */
+
+/* Excluded from this release type: IFluidDataStoreContextDetached */
+
+/* Excluded from this release type: IFluidDataStoreFactory */
+
+/* Excluded from this release type: IFluidDataStoreRegistry */
+
+/* Excluded from this release type: IFluidParentContext */
+
+/**
+ * Garbage collection data returned by nodes in a Container.
+ * Used for running GC in the Container.
+ * @public
+ */
+export declare 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[];
+    };
+}
+
+/* Excluded from this release type: IGarbageCollectionDetailsBase */
+
+/**
+ * Represents ISignalMessage with its type.
+ * @public
+ */
+export declare interface IInboundSignalMessage extends ISignalMessage {
+    type: string;
+}
+
+/* Excluded from this release type: InboundAttachMessage */
+
+/* Excluded from this release type: IProvideFluidDataStoreFactory */
+
+/* Excluded from this release type: IProvideFluidDataStoreRegistry */
+
+/* Excluded from this release type: ISignalEnvelope */
+
+/* Excluded from this release type: ISummarizeInternalResult */
+
+/* Excluded from this release type: ISummarizeResult */
+
+/* Excluded from this release type: ISummarizerNode */
+
+/* Excluded from this release type: ISummarizerNodeConfig */
+
+/* Excluded from this release type: ISummarizerNodeConfigWithGC */
+
+/* Excluded from this release type: ISummarizerNodeWithGC */
+
+/**
+ * Contains the aggregation data from a Tree/Subtree.
+ * @public
+ */
+export declare interface ISummaryStats {
+    treeNodeCount: number;
+    blobNodeCount: number;
+    handleNodeCount: number;
+    totalBlobSize: number;
+    unreferencedBlobSize: number;
+}
+
+/**
+ * Represents the summary tree for a node along with the statistics for that tree.
+ * For example, for a given data store, it contains the data for data store along with a subtree for
+ * each of its DDS.
+ * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
+ * will be taking part of the summarization process.
+ * @public
+ */
+export declare interface ISummaryTreeWithStats {
+    /**
+     * 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
+     * to the backend.
+     */
+    summary: ISummaryTree;
+}
+
+/**
+ * Contains telemetry data relevant to summarization workflows.
+ * This object is expected to be modified directly by various summarize methods.
+ * @public
+ */
+export declare 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: TelemetryBaseEventPropertyType): 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, TelemetryBaseEventPropertyType>): void;
+    /**
+     * Get the telemetry data being tracked
+     *
+     * @deprecated This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.
+     *
+     * @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): TelemetryBaseEventPropertyType;
+    /**
+     * Returns a serialized version of all the telemetry data.
+     * Should be used when logging in telemetry events.
+     *
+     * @deprecated This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function
+     * but this functionality should not be used by other code being given an ITelemetryContext.
+     */
+    serialize(): string;
+}
+
+/* Excluded from this release type: LocalAttributionKey */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntries */
+
+/* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
+
+/* Excluded from this release type: OpAttributionKey */
+
+/* Excluded from this release type: SummarizeInternalFn */
+
+/* Excluded from this release type: totalBlobSizePropertyName */
+
+/* Excluded from this release type: VisibilityState */
+
+export { }