Do not edit this file. It is a report generated by API Extractor.
// @beta @legacy
export const AllowTombstoneRequestHeaderKey = "allowTombstone";
// @beta @legacy
export enum CompressionAlgorithms {
// (undocumented)
lz4 = "lz4"
}
// @beta @legacy (undocumented)
export enum ContainerMessageType {
// (undocumented)
Alias = "alias",
// (undocumented)
Attach = "attach",
// (undocumented)
BlobAttach = "blobAttach",
// (undocumented)
ChunkedOp = "chunkedOp",
DocumentSchemaChange = "schema",
// (undocumented)
FluidDataStoreOp = "component",
GC = "GC",
IdAllocation = "idAllocation",
// (undocumented)
Rejoin = "rejoin"
}
// @beta @legacy
export interface ContainerRuntimeOptions {
readonly chunkSizeInBytes: number;
readonly compressionOptions: ICompressionRuntimeOptions;
readonly createBlobPayloadPending: true | undefined;
readonly disableSchemaUpgrade: boolean;
// @deprecated
readonly enableGroupedBatching: boolean;
readonly enableRuntimeIdCompressor: IdCompressorMode;
readonly explicitSchemaControl: boolean;
// (undocumented)
readonly gcOptions: IGCRuntimeOptions;
readonly loadSequenceNumberVerification: "close" | "log" | "bypass";
readonly maxBatchSizeInBytes: number;
readonly stagingModeAutoFlushThreshold: number;
// (undocumented)
readonly summaryOptions: ISummaryRuntimeOptions;
}
// @beta @legacy (undocumented)
export const DefaultSummaryConfiguration: ISummaryConfiguration;
// @beta @legacy (undocumented)
export const disabledCompressionConfig: ICompressionRuntimeOptions;
// @beta @legacy (undocumented)
export type EnqueueSummarizeResult = (ISummarizeResults & {
readonly alreadyEnqueued?: undefined;
}) | (ISummarizeResults & {
readonly alreadyEnqueued: true;
readonly overridden: true;
}) | {
readonly alreadyEnqueued: true;
readonly overridden?: undefined;
};
// @beta @legacy
export interface IAckedSummary {
// (undocumented)
readonly summaryAck: ISummaryAckMessage;
// (undocumented)
readonly summaryOp: ISummaryOpMessage;
}
// @beta @legacy (undocumented)
export interface IAckSummaryResult {
// (undocumented)
readonly ackNackDuration: number;
// (undocumented)
readonly summaryAckOp: ISummaryAckMessage;
}
// @beta @legacy
export interface IBaseSummarizeResult {
readonly error: IRetriableFailureError | undefined;
// (undocumented)
readonly minimumSequenceNumber: number;
readonly referenceSequenceNumber: number;
// (undocumented)
readonly stage: "base";
}
// @beta @legacy (undocumented)
export interface IBroadcastSummaryResult {
// (undocumented)
readonly broadcastDuration: number;
// (undocumented)
readonly summarizeOp: ISummaryOpMessage;
}
// @beta @legacy
export interface IClientSummaryWatcher extends IDisposable {
// (undocumented)
waitFlushed(): Promise<IAckedSummary | undefined>;
// (undocumented)
watchSummary(clientSequenceNumber: number): ISummary;
}
// @beta @legacy
export interface ICompressionRuntimeOptions {
readonly compressionAlgorithm: CompressionAlgorithms;
readonly minimumBatchSizeInBytes: number;
}
// @beta @legacy
export type IContainerRuntimeOptions = Partial<ContainerRuntimeOptions>;
// @beta @legacy
export type IdCompressorMode = "on" | "delayed" | undefined;
// @beta @legacy
export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
readonly afterSequenceNumber?: number;
readonly override?: boolean;
}
// @beta @deprecated @legacy (undocumented)
export interface IFluidDataStoreAttributes0 {
readonly isRootDataStore?: boolean;
// (undocumented)
pkg: string;
// (undocumented)
readonly snapshotFormatVersion?: undefined;
// (undocumented)
readonly summaryFormatVersion?: undefined;
}
// @beta @deprecated @legacy (undocumented)
export interface IFluidDataStoreAttributes1 extends OmitAttributesVersions<IFluidDataStoreAttributes0> {
// (undocumented)
readonly snapshotFormatVersion: "0.1";
// (undocumented)
readonly summaryFormatVersion?: undefined;
}
// @beta @deprecated @legacy (undocumented)
export interface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFluidDataStoreAttributes1> {
readonly disableIsolatedChannels?: true;
readonly snapshotFormatVersion?: undefined;
// (undocumented)
readonly summaryFormatVersion: 2;
}
// @beta @legacy (undocumented)
export interface IGCRuntimeOptions {
[key: string]: any;
enableGCSweep?: true;
runFullGC?: boolean;
sessionExpiryTimeoutMs?: number;
sweepGracePeriodMs?: number;
}
// @beta @legacy
export interface IGeneratedSummaryStats extends ISummaryStats {
readonly dataStoreCount: number;
readonly gcBlobNodeCount?: number;
readonly gcStateUpdatedDataStoreCount?: number;
readonly gcTotalBlobsSize?: number;
readonly summarizedDataStoreCount: number;
readonly summaryNumber: number;
}
// @beta @legacy
export interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
readonly generateDuration: number;
// (undocumented)
readonly stage: "generate";
readonly summaryStats: IGeneratedSummaryStats;
readonly summaryTree: ISummaryTree;
}
// @beta @legacy (undocumented)
export interface INackSummaryResult {
// (undocumented)
readonly ackNackDuration: number;
// (undocumented)
readonly summaryNackOp: ISummaryNackMessage;
}
// @beta @deprecated @legacy
export const InactiveResponseHeaderKey = "isInactive";
// @beta @legacy (undocumented)
export interface IOnDemandSummarizeOptions extends ISummarizeOptions {
readonly reason: string;
readonly retryOnFailure?: boolean;
}
// @beta @legacy
export interface IRetriableFailureError extends Error {
// (undocumented)
readonly retryAfterSeconds?: number;
}
// @beta @legacy
export interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
readonly clientSequenceNumber: number;
// (undocumented)
readonly stage: "submit";
readonly submitOpDuration: number;
}
// @beta @legacy
export interface ISummarizeOptions {
readonly fullTree?: boolean;
}
// @beta @legacy (undocumented)
export interface ISummarizer extends IEventProvider<ISummarizerEvents> {
// (undocumented)
close(): void;
enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult;
readonly ISummarizer?: ISummarizer;
// (undocumented)
run(onBehalfOf: string): Promise<SummarizerStopReason>;
// (undocumented)
stop(reason: SummarizerStopReason): void;
summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
}
// @beta @legacy (undocumented)
export interface ISummarizeResults {
readonly receivedSummaryAckOrNack: Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>;
readonly summaryOpBroadcasted: Promise<SummarizeResultPart<IBroadcastSummaryResult>>;
readonly summarySubmitted: Promise<SummarizeResultPart<SubmitSummaryResult, SubmitSummaryFailureData>>;
}
// @beta @legacy
export interface ISummary {
// (undocumented)
readonly clientId: string;
// (undocumented)
readonly clientSequenceNumber: number;
// (undocumented)
waitAckNack(): Promise<ISummaryAckMessage | ISummaryNackMessage>;
// (undocumented)
waitBroadcast(): Promise<ISummaryOpMessage>;
}
// @beta @legacy
export interface ISummaryAckMessage extends ISequencedDocumentMessage {
// (undocumented)
contents: ISummaryAck;
// (undocumented)
type: MessageType.SummaryAck;
}
// @beta @legacy (undocumented)
export interface ISummaryBaseConfiguration {
initialSummarizerDelayMs: number;
maxAckWaitTime: number;
maxOpsSinceLastSummary: number;
}
// @beta @legacy (undocumented)
export interface ISummaryCollectionOpEvents extends IEvent {
// (undocumented)
(event: OpActionEventName, listener: OpActionEventListener): any;
}
// @beta @legacy (undocumented)
export type ISummaryConfiguration = ISummaryConfigurationDisableSummarizer | ISummaryConfigurationDisableHeuristics | ISummaryConfigurationHeuristics | ISummaryConfigurationWithSummaryOnRequest;
// @beta @legacy (undocumented)
export interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
// (undocumented)
state: "disableHeuristics";
}
// @beta @legacy (undocumented)
export interface ISummaryConfigurationDisableSummarizer {
// (undocumented)
state: "disabled";
}
// @beta @legacy (undocumented)
export interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
maxIdleTime: number;
maxOps: number;
maxTime: number;
minIdleTime: number;
minOpsForLastSummaryAttempt: number;
nonRuntimeHeuristicThreshold?: number;
nonRuntimeOpWeight: number;
runtimeOpWeight: number;
// (undocumented)
state: "enabled";
}
// @beta @legacy
export interface ISummaryConfigurationWithSummaryOnRequest extends ISummaryBaseConfiguration {
// (undocumented)
state: "summaryOnRequest";
}
// @beta @legacy
export interface ISummaryNackMessage extends ISequencedDocumentMessage {
// (undocumented)
contents: ISummaryNack;
// (undocumented)
type: MessageType.SummaryNack;
}
// @beta @legacy
export interface ISummaryOpMessage extends ISequencedDocumentMessage {
// (undocumented)
contents: ISummaryContent;
// (undocumented)
type: MessageType.Summarize;
}
// @beta @legacy (undocumented)
export interface ISummaryRuntimeOptions {
// @deprecated
initialSummarizerDelayMs?: number;
summaryConfigOverrides?: ISummaryConfiguration;
}
// @beta @legacy
export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage"> {
readonly handle: string;
// (undocumented)
readonly stage: "upload";
readonly uploadDuration: number;
}
// @beta @legacy
export function loadContainerRuntime(params: LoadContainerRuntimeParams): Promise<IContainerRuntime & IRuntime>;
// @beta @legacy
export interface LoadContainerRuntimeParams {
containerScope?: FluidObject;
context: IContainerContext;
existing: boolean;
minVersionForCollab?: MinimumVersionForCollab;
provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>;
registryEntries: NamedFluidDataStoreRegistryEntries;
// @deprecated
requestHandler?: (request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>;
runtimeOptions?: IContainerRuntimeOptions;
}
// @beta @deprecated @legacy (undocumented)
export type OmitAttributesVersions<T> = Omit<T, "snapshotFormatVersion" | "summaryFormatVersion">;
// @beta @legacy (undocumented)
export type OpActionEventListener = (op: ISequencedDocumentMessage) => void;
// @beta @legacy (undocumented)
export type OpActionEventName = MessageType.Summarize | MessageType.SummaryAck | MessageType.SummaryNack | "default";
// @beta @deprecated @legacy
export type ReadFluidDataStoreAttributes = IFluidDataStoreAttributes0 | IFluidDataStoreAttributes1 | IFluidDataStoreAttributes2;
// @beta @legacy
export interface SubmitSummaryFailureData {
// (undocumented)
stage: SummaryStage;
}
// @beta @legacy
export type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult;
// @beta @legacy (undocumented)
export type SummarizeResultPart<TSuccess, TFailure = undefined> = {
success: true;
data: TSuccess;
} | {
success: false;
data: TFailure | undefined;
message: string;
error: IRetriableFailureError;
};
// @beta @legacy
export class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents> {
constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, logger: ITelemetryBaseLogger);
// (undocumented)
addOpListener(listener: () => void): void;
createWatcher(clientId: string): IClientSummaryWatcher;
// (undocumented)
emit(event: OpActionEventName, ...args: Parameters<OpActionEventListener>): boolean;
// (undocumented)
get latestAck(): IAckedSummary | undefined;
// (undocumented)
get opsSinceLastAck(): number;
// (undocumented)
removeOpListener(listener: () => void): void;
// (undocumented)
removeWatcher(clientId: string): void;
// (undocumented)
setPendingAckTimerTimeoutCallback(maxAckWaitTime: number, timeoutCallback: () => void): void;
// (undocumented)
unsetPendingAckTimerTimeoutCallback(): void;
waitFlushed(): Promise<IAckedSummary | undefined>;
waitSummaryAck(referenceSequenceNumber: number): Promise<IAckedSummary>;
}
// @beta @legacy
export type SummaryStage = SubmitSummaryResult["stage"] | "unknown";
// @beta @legacy
export const TombstoneResponseHeaderKey = "isTombstoned";
// (No @packageDocumentation comment for this package)