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

package/src/storage.ts

@@ -3,357 +3,386 @@
  * Licensed under the MIT License.
  */
 
-import { IDisposable, IEventProvider, IErrorEvent, ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 import {
-    ConnectionMode,
-    IClient,
-    IClientConfiguration,
-    ICreateBlobResponse,
-    IDocumentMessage,
-    INack,
-    ISequencedDocumentMessage,
-    ISignalClient,
-    ISignalMessage,
-    ISnapshotTree,
-    ISummaryHandle,
-    ISummaryTree,
-    ITokenClaims,
-    IVersion,
+	IDisposable,
+	IEventProvider,
+	IErrorEvent,
+	ITelemetryBaseLogger,
+} from "@fluidframework/common-definitions";
+import {
+	ConnectionMode,
+	IClient,
+	IClientConfiguration,
+	ICreateBlobResponse,
+	IDocumentMessage,
+	INack,
+	ISequencedDocumentMessage,
+	ISignalClient,
+	ISignalMessage,
+	ISnapshotTree,
+	ISummaryHandle,
+	ISummaryTree,
+	ITokenClaims,
+	IVersion,
 } from "@fluidframework/protocol-definitions";
 import { IAnyDriverError } from "./driverError";
 import { IResolvedUrl } from "./urlResolver";
 
 export interface IDeltasFetchResult {
-    /**
-     * Sequential set of messages starting from 'from' sequence number.
-     * May be partial result, i.e. not fulfill original request in full.
-     */
-    messages: ISequencedDocumentMessage[];
-
-    /**
-     * If true, storage only partially fulfilled request, but has more ops
-     * If false, the request was fulfilled. If less ops were returned then
-     * requested, then storage does not have more ops in this range.
-     */
-    partialResult: boolean;
+	/**
+	 * Sequential set of messages starting from 'from' sequence number.
+	 * May be partial result, i.e. not fulfill original request in full.
+	 */
+	messages: ISequencedDocumentMessage[];
+
+	/**
+	 * If true, storage only partially fulfilled request, but has more ops
+	 * If false, the request was fulfilled. If less ops were returned then
+	 * requested, then storage does not have more ops in this range.
+	 */
+	partialResult: boolean;
 }
 
 /**
  * Interface to provide access to stored deltas for a shared object
  */
 export interface IDeltaStorageService {
-    /**
-     * Retrieves all the delta operations within the inclusive sequence number range
-     * @param tenantId - Id of the tenant.
-     * @param id - document id.
-     * @param from - first op to retrieve (inclusive)
-     * @param to - first op not to retrieve (exclusive end)
-     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number
-     * of Op on wire and known seq number. It should not contain any PII. It can be logged by
-     * spo which could help in debugging sessions if any issue occurs.
-     */
-    get(
-        tenantId: string,
-        id: string,
-        from: number, // inclusive
-        to: number, // exclusive
-        fetchReason?: string,
-    ): Promise<IDeltasFetchResult>;
+	/**
+	 * Retrieves all the delta operations within the inclusive sequence number range
+	 * @param tenantId - Id of the tenant.
+	 * @param id - document id.
+	 * @param from - first op to retrieve (inclusive)
+	 * @param to - first op not to retrieve (exclusive end)
+	 * @param fetchReason - Reason for fetching the messages. Example, gap between seq number
+	 * of Op on wire and known seq number. It should not contain any PII. It can be logged by
+	 * spo which could help in debugging sessions if any issue occurs.
+	 */
+	get(
+		tenantId: string,
+		id: string,
+		from: number, // inclusive
+		to: number, // exclusive
+		fetchReason?: string,
+	): Promise<IDeltasFetchResult>;
 }
 
-export type IStreamResult<T> = { done: true; } | { done: false; value: T; };
+export type IStreamResult<T> = { done: true } | { done: false; value: T };
 
 /**
  * Read interface for the Queue
  */
 export interface IStream<T> {
-    read(): Promise<IStreamResult<T>>;
+	read(): Promise<IStreamResult<T>>;
 }
 
 /**
  * Interface to provide access to stored deltas for a shared object
  */
 export interface IDocumentDeltaStorageService {
-    /**
-     * Retrieves all the delta operations within the exclusive sequence number range
-     * @param from - first op to retrieve (inclusive)
-     * @param to - first op not to retrieve (exclusive end)
-     * @param abortSignal - signal that aborts operation
-     * @param cachedOnly - return only cached ops, i.e. ops available locally on client.
-     * @param fetchReason - Reason for fetching the messages. Example, gap between seq number
-     * of Op on wire and known seq number. It should not contain any PII. It can be logged by
-     * spo which could help in debugging sessions if any issue occurs.
-     */
-    fetchMessages(from: number,
-        to: number | undefined,
-        abortSignal?: AbortSignal,
-        cachedOnly?: boolean,
-        fetchReason?: string,
-    ): IStream<ISequencedDocumentMessage[]>;
+	/**
+	 * Retrieves all the delta operations within the exclusive sequence number range
+	 * @param from - first op to retrieve (inclusive)
+	 * @param to - first op not to retrieve (exclusive end)
+	 * @param abortSignal - signal that aborts operation
+	 * @param cachedOnly - return only cached ops, i.e. ops available locally on client.
+	 * @param fetchReason - Reason for fetching the messages. Example, gap between seq number
+	 * of Op on wire and known seq number. It should not contain any PII. It can be logged by
+	 * spo which could help in debugging sessions if any issue occurs.
+	 */
+	fetchMessages(
+		from: number,
+		to: number | undefined,
+		abortSignal?: AbortSignal,
+		cachedOnly?: boolean,
+		fetchReason?: string,
+	): IStream<ISequencedDocumentMessage[]>;
 }
 
-// DO NOT INCREASE THIS TYPE'S VALUE - If a driver started using a larger value, GC would likely start closing sessions
-export type FiveDaysMs = 432000000; /* 5 days in milliseconds */
+// DO NOT INCREASE THIS TYPE'S VALUE
+// If a driver started using a larger value,
+// internal assumptions of the Runtime's GC feature will be violated
+// DO NOT INCREASE THIS TYPE'S VALUE
+export type FiveDaysMs = 432_000_000; /* 5 days in milliseconds */
 
+/**
+ * Policies describing attributes or characteristics of the driver's storage service,
+ * to direct how other components interact with the driver
+ */
 export interface IDocumentStorageServicePolicies {
-    readonly caching?: LoaderCachingPolicy;
-
-    /**
-     * If this policy is provided, it tells runtime on ideal size for blobs.
-     * Blobs that are smaller than that size should be aggregated into bigger blobs.
-     */
-    readonly minBlobSize?: number;
-
-    /**
-     * If undefined, the driver makes no guarantees about the age of snapshots used for loading.
-     * Otherwise, the driver will not use snapshots that were added to the cache more than 5 days ago (per client clock)
-     * The value MUST be 5 days if defined. This fixed upper bound is necessary for the Garbage Collection feature
-     * in the Runtime layer to reliably compute when an object will never be referenced again and can be deleted.
-     */
-    readonly maximumCacheDurationMs?: FiveDaysMs;
+	/**
+	 * Should the Loader implement any sort of pre-fetching or caching mechanism?
+	 */
+	readonly caching?: LoaderCachingPolicy;
+
+	/**
+	 * If this policy is provided, it tells runtime on ideal size for blobs.
+	 * Blobs that are smaller than that size should be aggregated into bigger blobs.
+	 */
+	readonly minBlobSize?: number;
+
+	/**
+	 * IMPORTANT: This policy MUST be set to 5 days and PROPERLY ENFORCED for drivers that are used
+	 * in applications where Garbage Collection is enabled. Otherwise data loss may occur.
+	 *
+	 * This policy pertains to requests for the latest snapshot from the service.
+	 * If set, it means that the driver guarantees not to use a cached value that was fetched more than 5 days ago.
+	 * If undefined, the driver makes no guarantees about the age of snapshots used for loading.
+	 */
+	readonly maximumCacheDurationMs?: FiveDaysMs;
 }
 
 /**
  * Interface to provide access to snapshots saved for a shared object
  */
 export interface IDocumentStorageService extends Partial<IDisposable> {
-    repositoryUrl: string;
-
-    /**
-     * Policies implemented/instructed by driver.
-     */
-    readonly policies?: IDocumentStorageServicePolicies;
-
-    /**
-     * Returns the snapshot tree.
-     * @param version - Version of the snapshot to be fetched.
-     * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help
-     * in debugging purposes to see why this call was made.
-     */
-    getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
-
-    /**
-     * Retrieves all versions of the document starting at the specified versionId - or null if from the head
-     * @param versionId - Version id of the requested version.
-     * @param count - Number of the versions to be fetched.
-     * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help
-     * in debugging purposes to see why this call was made.
-     * @param fetchSource - Callers can specify the source of the response. For ex. Driver may choose to cache
-     * requests and serve data from cache. That will result in stale info returned. Callers can disable this
-     * functionality by passing fetchSource = noCache and ensuring that driver will return latest information
-     * from storage.
-     */
-    getVersions(
-        versionId: string | null,
-        count: number,
-        scenarioName?: string,
-        fetchSource?: FetchSource,
-    ): Promise<IVersion[]>;
-
-    /**
-     * Creates a blob out of the given buffer
-     */
-    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
-
-    /**
-     * Reads the object with the given ID, returns content in arrayBufferLike
-     */
-    readBlob(id: string): Promise<ArrayBufferLike>;
-
-    /**
-     * Uploads a summary tree to storage using the given context for reference of previous summary handle.
-     * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are
-     * referencing from the previously acked summary.
-     * Returns the uploaded summary handle.
-     */
-    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
-
-    /**
-     * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the
-     * server has deleted it this call may result in a broken promise.
-     */
-    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
+	repositoryUrl: string;
+
+	/**
+	 * Policies implemented/instructed by driver.
+	 */
+	readonly policies?: IDocumentStorageServicePolicies;
+
+	/**
+	 * Returns the snapshot tree.
+	 * @param version - Version of the snapshot to be fetched.
+	 * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help
+	 * in debugging purposes to see why this call was made.
+	 */
+	// TODO: use `undefined` instead.
+	// eslint-disable-next-line @rushstack/no-new-null
+	getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
+
+	/**
+	 * Retrieves all versions of the document starting at the specified versionId - or null if from the head
+	 * @param versionId - Version id of the requested version.
+	 * @param count - Number of the versions to be fetched.
+	 * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help
+	 * in debugging purposes to see why this call was made.
+	 * @param fetchSource - Callers can specify the source of the response. For ex. Driver may choose to cache
+	 * requests and serve data from cache. That will result in stale info returned. Callers can disable this
+	 * functionality by passing fetchSource = noCache and ensuring that driver will return latest information
+	 * from storage.
+	 */
+	getVersions(
+		// TODO: use `undefined` instead.
+		// eslint-disable-next-line @rushstack/no-new-null
+		versionId: string | null,
+		count: number,
+		scenarioName?: string,
+		fetchSource?: FetchSource,
+	): Promise<IVersion[]>;
+
+	/**
+	 * Creates a blob out of the given buffer
+	 */
+	createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
+
+	/**
+	 * Reads the object with the given ID, returns content in arrayBufferLike
+	 */
+	readBlob(id: string): Promise<ArrayBufferLike>;
+
+	/**
+	 * Uploads a summary tree to storage using the given context for reference of previous summary handle.
+	 * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are
+	 * referencing from the previously acked summary.
+	 * Returns the uploaded summary handle.
+	 */
+	uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
+
+	/**
+	 * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the
+	 * server has deleted it this call may result in a broken promise.
+	 */
+	downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
 }
 
 export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
-    (event: "nack", listener: (documentId: string, message: INack[]) => void);
-    (event: "disconnect", listener: (reason: IAnyDriverError) => void);
-    (event: "op", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);
-    (event: "signal", listener: (message: ISignalMessage) => void);
-    (event: "pong", listener: (latency: number) => void);
-    (event: "error", listener: (error: any) => void);
+	(event: "nack", listener: (documentId: string, message: INack[]) => void);
+	(event: "disconnect", listener: (reason: IAnyDriverError) => void);
+	(event: "op", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);
+	(event: "signal", listener: (message: ISignalMessage) => void);
+	(event: "pong", listener: (latency: number) => void);
+	// TODO: Use something other than `any`.
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	(event: "error", listener: (error: any) => void);
 }
 
-export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {
-    /**
-     * ClientID for the connection
-     */
-    clientId: string;
-
-    /**
-     * Claims for the client
-     */
-    claims: ITokenClaims;
-
-    /**
-     * Mode of the client
-     */
-    mode: ConnectionMode;
-
-    /**
-     * Whether the connection was made to a new or existing document
-     */
-    existing: boolean;
-
-    /**
-     * Protocol version being used with the service
-     */
-    version: string;
-
-    /**
-     * Messages sent during the connection
-     */
-    initialMessages: ISequencedDocumentMessage[];
-
-    /**
-     * Signals sent during the connection
-     */
-    initialSignals: ISignalMessage[];
-
-    /**
-     * Prior clients already connected.
-     */
-    initialClients: ISignalClient[];
-
-    /**
-     * Configuration details provided by the service
-     */
-    serviceConfiguration: IClientConfiguration;
-
-    /**
-     * Last known sequence number to ordering service at the time of connection
-     * It may lap actual last sequence number (quite a bit, if container  is very active).
-     * But it's best information for client to figure out how far it is behind, at least
-     * for "read" connections. "write" connections may use own "join" op to similar information,
-     * that is likely to be more up-to-date.
-     */
-    checkpointSequenceNumber?: number;
-
-    /**
-     * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo
-     * it could contain info like build version, environment, region etc. These properties can be logged by client
-     * to better understand server environment etc. and use it in case error occurs.
-     * Format: "prop1:val1;prop2:val2;prop3:val3"
-     */
-    relayServiceAgent?: string;
-
-    /**
-     * Submit a new message to the server
-     */
-    submit(messages: IDocumentMessage[]): void;
-
-    /**
-     * Submit a new signal to the server
-     */
-    submitSignal(message: any): void;
+export interface IDocumentDeltaConnection
+	extends IDisposable,
+		IEventProvider<IDocumentDeltaConnectionEvents> {
+	/**
+	 * ClientID for the connection
+	 */
+	clientId: string;
+
+	/**
+	 * Claims for the client
+	 */
+	claims: ITokenClaims;
+
+	/**
+	 * Mode of the client
+	 */
+	mode: ConnectionMode;
+
+	/**
+	 * Whether the connection was made to a new or existing document
+	 */
+	existing: boolean;
+
+	/**
+	 * Protocol version being used with the service
+	 */
+	version: string;
+
+	/**
+	 * Messages sent during the connection
+	 */
+	initialMessages: ISequencedDocumentMessage[];
+
+	/**
+	 * Signals sent during the connection
+	 */
+	initialSignals: ISignalMessage[];
+
+	/**
+	 * Prior clients already connected.
+	 */
+	initialClients: ISignalClient[];
+
+	/**
+	 * Configuration details provided by the service
+	 */
+	serviceConfiguration: IClientConfiguration;
+
+	/**
+	 * Last known sequence number to ordering service at the time of connection
+	 * It may lap actual last sequence number (quite a bit, if container  is very active).
+	 * But it's best information for client to figure out how far it is behind, at least
+	 * for "read" connections. "write" connections may use own "join" op to similar information,
+	 * that is likely to be more up-to-date.
+	 */
+	checkpointSequenceNumber?: number;
+
+	/**
+	 * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo
+	 * it could contain info like build version, environment, region etc. These properties can be logged by client
+	 * to better understand server environment etc. and use it in case error occurs.
+	 * Format: "prop1:val1;prop2:val2;prop3:val3"
+	 */
+	relayServiceAgent?: string;
+
+	/**
+	 * Submit a new message to the server
+	 */
+	submit(messages: IDocumentMessage[]): void;
+
+	/**
+	 * Submit a new signal to the server
+	 */
+	// TODO: Use something other than `any`.
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	submitSignal(message: any): void;
 }
 
 export enum LoaderCachingPolicy {
-    /**
-     * The loader should not implement any prefetching or caching policy.
-     */
-    NoCaching,
-
-    /**
-     * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.
-     */
-    Prefetch,
+	/**
+	 * The loader should not implement any prefetching or caching policy.
+	 */
+	NoCaching,
+
+	/**
+	 * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.
+	 */
+	Prefetch,
 }
 
 export interface IDocumentServicePolicies {
-    /**
-     * Do not connect to delta stream
-     */
-    readonly storageOnly?: boolean;
+	/**
+	 * Do not connect to delta stream
+	 */
+	readonly storageOnly?: boolean;
+
+	/**
+	 * Summarizer uploads the protocol tree too when summarizing.
+	 */
+	readonly summarizeProtocolTree?: boolean;
 }
 
 export interface IDocumentService {
-
-    resolvedUrl: IResolvedUrl;
-
-    /**
-     * Policies implemented/instructed by driver.
-     */
-    policies?: IDocumentServicePolicies;
-
-    /**
-     * Access to storage associated with the document...
-     */
-    connectToStorage(): Promise<IDocumentStorageService>;
-
-    /**
-     * Access to delta storage associated with the document
-     */
-    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
-
-    /**
-     * Subscribes to the document delta stream
-     */
-    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
-
-    /**
-     * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).
-     * Useful for storage to commit any pending state if any (including any local caching).
-     * Please note that it does not remove the need for caller to close all active delta connections,
-     * as storage may not be tracking such objects.
-     * @param error - tells if container (and storage) are closed due to critical error.
-     * Error might be due to disconnect between client & server knowlege about file, like file being overwritten
-     * in storage, but client having stale local cache.
-     * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.
-     */
-    dispose(error?: any): void;
+	resolvedUrl: IResolvedUrl;
+
+	/**
+	 * Policies implemented/instructed by driver.
+	 */
+	policies?: IDocumentServicePolicies;
+
+	/**
+	 * Access to storage associated with the document
+	 */
+	connectToStorage(): Promise<IDocumentStorageService>;
+
+	/**
+	 * Access to delta storage associated with the document
+	 */
+	connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
+
+	/**
+	 * Subscribes to the document delta stream
+	 */
+	connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
+
+	/**
+	 * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).
+	 * Useful for storage to commit any pending state if any (including any local caching).
+	 * Please note that it does not remove the need for caller to close all active delta connections,
+	 * as storage may not be tracking such objects.
+	 * @param error - tells if container (and storage) are closed due to critical error.
+	 * Error might be due to disconnect between client & server knowledge about file, like file being overwritten
+	 * in storage, but client having stale local cache.
+	 * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.
+	 */
+	// TODO: Use something other than `any`.
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	dispose(error?: any): void;
 }
 
 export interface IDocumentServiceFactory {
-    /**
-     * Name of the protocol used by factory
-     */
-    protocolName: string;
-
-    /**
-     * Creates the document service after extracting different endpoints URLs from a resolved URL.
-     *
-     * @param resolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.
-     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
-     * @param clientIsSummarizer - Whether or not the client is the
-     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
-     * `undefined` =\> false
-     *
-     * @returns An instance of {@link IDocumentService}.
-     */
-    createDocumentService(
-        resolvedUrl: IResolvedUrl,
-        logger?: ITelemetryBaseLogger,
-        clientIsSummarizer?: boolean,
-    ): Promise<IDocumentService>;
-
-    /**
-     * Creates a new document with the provided options. Returns the document service.
-     *
-     * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary
-     * should be posted later, before connecting to ordering service.
-     * @param createNewResolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.
-     * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
-     * @param clientIsSummarizer - Whether or not the client is the
-     * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
-     * `undefined` =\> false
-     */
-    createContainer(
-        createNewSummary: ISummaryTree | undefined,
-        createNewResolvedUrl: IResolvedUrl,
-        logger?: ITelemetryBaseLogger,
-        clientIsSummarizer?: boolean,
-    ): Promise<IDocumentService>;
+	/**
+	 * Creates the document service after extracting different endpoints URLs from a resolved URL.
+	 *
+	 * @param resolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.
+	 * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
+	 * @param clientIsSummarizer - Whether or not the client is the
+	 * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
+	 * `undefined` =\> false
+	 *
+	 * @returns An instance of {@link IDocumentService}.
+	 */
+	createDocumentService(
+		resolvedUrl: IResolvedUrl,
+		logger?: ITelemetryBaseLogger,
+		clientIsSummarizer?: boolean,
+	): Promise<IDocumentService>;
+
+	/**
+	 * Creates a new document with the provided options. Returns the document service.
+	 *
+	 * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary
+	 * should be posted later, before connecting to ordering service.
+	 * @param createNewResolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.
+	 * @param logger - Optional telemetry logger to which telemetry events will be forwarded.
+	 * @param clientIsSummarizer - Whether or not the client is the
+	 * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.
+	 * `undefined` =\> false
+	 */
+	createContainer(
+		createNewSummary: ISummaryTree | undefined,
+		createNewResolvedUrl: IResolvedUrl,
+		logger?: ITelemetryBaseLogger,
+		clientIsSummarizer?: boolean,
+	): Promise<IDocumentService>;
 }
 
 /**
@@ -361,20 +390,20 @@ export interface IDocumentServiceFactory {
  * Indicates the previously acked summary.
  */
 export interface ISummaryContext {
-    /**
-     * Parent summary proposed handle (from summary op)
-     */
-    readonly proposalHandle: string | undefined;
+	/**
+	 * Parent summary proposed handle (from summary op)
+	 */
+	readonly proposalHandle: string | undefined;
 
-    /**
-     * Parent summary acked handle (from summary ack)
-     */
-    readonly ackHandle: string | undefined;
+	/**
+	 * Parent summary acked handle (from summary ack)
+	 */
+	readonly ackHandle: string | undefined;
 
-    readonly referenceSequenceNumber: number;
+	readonly referenceSequenceNumber: number;
 }
 
 export enum FetchSource {
-    default = "default",
-    noCache = "noCache",
+	default = "default",
+	noCache = "noCache",
 }