@fluidframework/routerlicious-driver 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/lib/routerlicious-driver-untrimmed.d.mts

@@ -0,0 +1,261 @@
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { ISession } from '@fluidframework/server-services-client';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/protocol-definitions';
+
+/**
+ * Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
+ * @internal
+ */
+export declare class DefaultTokenProvider implements ITokenProvider {
+    private readonly jwt;
+    constructor(jwt: string);
+    fetchOrdererToken(): Promise<ITokenResponse>;
+    fetchStorageToken(): Promise<ITokenResponse>;
+}
+
+/**
+ * Error returned by {@link RouterliciousDocumentServiceFactory.createContainer} when an error is thrown
+ * in {@link ITokenProvider.documentPostCreateCallback}.
+ * It is the consumer's responsibility to ensure that any state related to container creation is appropriately
+ * cleaned up in the event of failure.
+ * This includes the document itself, which will have been created by the time this error was thrown.
+ *
+ * @remarks TODO: examples of suggested actions for recovery.
+ * - How would a user delete the created document?
+ * - What would a retry pattern look like here?
+ * @internal
+ */
+export declare class DocumentPostCreateError extends Error {
+    /**
+     * Inner error being wrapped.
+     */
+    private readonly innerError;
+    constructor(
+    /**
+     * Inner error being wrapped.
+     */
+    innerError: Error);
+    readonly name = "DocumentPostCreateError";
+    get stack(): string | undefined;
+}
+
+/**
+ * @internal
+ */
+export declare interface IRouterliciousDriverPolicies {
+    /**
+     * Enable prefetching entire snapshot tree into memory before it is loaded by the runtime.
+     * Default: true
+     */
+    enablePrefetch: boolean;
+    /**
+     * Rate limit concurrent storage requests.
+     * Default: 100
+     */
+    maxConcurrentStorageRequests: number;
+    /**
+     * Rate limit concurrent orderer requests.
+     * Default: 100
+     */
+    maxConcurrentOrdererRequests: number;
+    /**
+     * Enable uploading entire summary tree as a IWholeSummaryPayload to storage.
+     * Default: false
+     */
+    enableWholeSummaryUpload: boolean;
+    /**
+     * Enable service endpoint discovery when creating or joining a session.
+     * Default: false
+     */
+    enableDiscovery: boolean;
+    /**
+     * Enable using RestLess which avoids CORS preflight requests.
+     * Default: true
+     */
+    enableRestLess: boolean;
+    /**
+     * Enable internal cache of summaries/snapshots.
+     * Reduces Summarizer boot time and reduces server load in E2E tests.
+     * Default: true
+     */
+    enableInternalSummaryCaching: boolean;
+    /**
+     * Enable downgrading socket connection to long-polling
+     * when websocket connection cannot be established.
+     * Default: true
+     */
+    enableLongPollingDowngrade: boolean;
+    /**
+     * Indicates that the container is ephemeral.
+     * Artifacts relates to the container are limited to container lifetime.
+     * Default: false
+     */
+    isEphemeralContainer: boolean;
+}
+
+/**
+ * Abstracts the token fetching mechanism for a hosting application.
+ * The hosting application is responsible for providing an implementation.
+ * @public
+ */
+export declare interface ITokenProvider {
+    /**
+     * Fetches the orderer token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Optional. Document ID is only required for document-scoped requests.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * Fetches the storage token from host.
+     *
+     * @param tenantId - Tenant ID.
+     * @param documentId - Document ID.
+     * @param refresh - Optional flag indicating whether token fetch must bypass local cache.
+     * This likely indicates that some previous request failed authorization due to an expired token,
+     * and so a fresh token is required.
+     *
+     * Default: `false`.
+     *
+     * NOTE: This parameter will be made required in the future.
+     */
+    fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
+    /**
+     * A callback triggered directly after creating the document. In this callback the client has the opportunity, to
+     * verify against an authorization service, if the user who claims to create the document is the same user who
+     * created it.
+     *
+     * @remarks Notes:
+     *
+     * * Using the callback may have performance impact on the document creation process.
+     *
+     * * Any exceptions thrown in the callback would fail the creation workflow
+     * (see {@link RouterliciousDocumentServiceFactory.createContainer} for more details).
+     *
+     * @param documentId - Document ID.
+     * @param creationToken - A special token that doesn't provide any kind of access, but it has the user's payload
+     * and document id. It can be used to validate the identity of the document creator.
+     */
+    documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
+}
+
+/**
+ * @public
+ */
+export declare interface ITokenResponse {
+    /**
+     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} value.
+     */
+    jwt: string;
+    /**
+     * A flag indicating whether token was obtained from local cache.
+     *
+     * @remarks `undefined` indicates that the source of the token could not be determined.
+     */
+    fromCache?: boolean;
+}
+
+/**
+ * Abstracts the discovery of claims contained within a token.
+ * @internal
+ */
+export declare interface ITokenService {
+    /**
+     * Extracts the {@link @fluidframework/protocol-definitions#ITokenClaims | token claims} from the provided
+     * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} string representation.
+     */
+    extractClaims(token: string): ITokenClaims;
+}
+
+/**
+ * Factory for creating the routerlicious document service. Use this if you want to
+ * use the routerlicious implementation.
+ * @internal
+ */
+export declare class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly tokenProvider;
+    private readonly driverPolicies;
+    private readonly blobCache;
+    private readonly wholeSnapshotTreeCache;
+    private readonly shreddedSummaryTreeCache;
+    constructor(tokenProvider: ITokenProvider, driverPolicies?: Partial<IRouterliciousDriverPolicies>);
+    /**
+     * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer}
+     *
+     * @throws {@link DocumentPostCreateError}
+         * If an exception is thrown while invoking the provided {@link ITokenProvider.documentPostCreateCallback}.
+         */
+     createContainer(createNewSummary: ISummaryTree | undefined, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+     /**
+      * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createDocumentService}
+      *
+      * @returns Routerlicious document service.
+      */
+     createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean, session?: ISession): Promise<IDocumentService>;
+    }
+
+    /**
+     * Routerlicious Error types
+     * Different error types that may be thrown by the routerlicious driver
+     *
+     * @deprecated Use {@link (RouterliciousErrorTypes:variable)} instead.
+     * @internal
+     */
+    export declare enum RouterliciousErrorType {
+        /**
+         * File not found, or file deleted during session
+         */
+        fileNotFoundOrAccessDeniedError = "fileNotFoundOrAccessDeniedError",
+        /**
+         * SSL Certificate Error.
+         */
+        sslCertError = "sslCertError"
+    }
+
+    /**
+     * Routerlicious Error types
+     * Different error types that may be thrown by the routerlicious driver
+     * @internal
+     */
+    export declare const RouterliciousErrorTypes: {
+        /**
+         * SSL Certificate Error.
+         */
+        readonly sslCertError: "sslCertError";
+        readonly genericNetworkError: "genericNetworkError";
+        readonly authorizationError: "authorizationError";
+        readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
+        readonly offlineError: "offlineError";
+        readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
+        readonly writeError: "writeError";
+        readonly fetchFailure: "fetchFailure";
+        readonly fetchTokenError: "fetchTokenError";
+        readonly incorrectServerResponse: "incorrectServerResponse";
+        readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
+        readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
+        readonly locationRedirection: "locationRedirection";
+        readonly fluidInvalidSchema: "fluidInvalidSchema";
+        readonly fileIsLocked: "fileIsLocked";
+        readonly outOfStorageError: "outOfStorageError";
+        readonly genericError: "genericError";
+        readonly throttlingError: "throttlingError";
+        readonly usageError: "usageError";
+    };
+
+    /**
+     * @internal
+     */
+    export declare type RouterliciousErrorTypes = (typeof RouterliciousErrorTypes)[keyof typeof RouterliciousErrorTypes];
+
+    export { }

package/lib/{shreddedSummaryDocumentStorageService.d.ts → shreddedSummaryDocumentStorageService.d.mts}

@@ -2,13 +2,13 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import type { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { IDocumentStorageService, ISummaryContext, IDocumentStorageServicePolicies } from "@fluidframework/driver-definitions";
 import { ICreateBlobResponse, ISnapshotTreeEx, ISummaryHandle, ISummaryTree, IVersion } from "@fluidframework/protocol-definitions";
-import { GitManager } from "@fluidframework/server-services-client";
-import { IRouterliciousDriverPolicies } from "./policies";
-import { ICache } from "./cache";
-import { ISnapshotTreeVersion } from "./definitions";
+import { IRouterliciousDriverPolicies } from "./policies.mjs";
+import { ICache } from "./cache.mjs";
+import { ISnapshotTreeVersion } from "./definitions.mjs";
+import { GitManager } from "./gitManager.mjs";
 /**
  * Document access to underlying storage for routerlicious driver.
  * Uploads summaries piece-by-piece traversing the tree recursively.
@@ -17,15 +17,16 @@ import { ISnapshotTreeVersion } from "./definitions";
 export declare class ShreddedSummaryDocumentStorageService implements IDocumentStorageService {
     protected readonly id: string;
     protected readonly manager: GitManager;
-    protected readonly logger: ITelemetryLogger;
+    protected readonly logger: ITelemetryLoggerExt;
     readonly policies: IDocumentStorageServicePolicies;
     private readonly getStorageManager;
+    private readonly mc;
     protected readonly blobsShaCache: Map<string, string>;
     private readonly blobCache;
     private readonly snapshotTreeCache;
-    get repositoryUrl(): string;
+    readonly repositoryUrl = "";
     private getSummaryUploadManager;
-    constructor(id: string, manager: GitManager, logger: ITelemetryLogger, policies?: IDocumentStorageServicePolicies, driverPolicies?: IRouterliciousDriverPolicies, blobCache?: ICache<ArrayBufferLike>, snapshotTreeCache?: ICache<ISnapshotTreeVersion>, getStorageManager?: (disableCache?: boolean) => Promise<GitManager>);
+    constructor(id: string, manager: GitManager, logger: ITelemetryLoggerExt, policies: IDocumentStorageServicePolicies, driverPolicies?: IRouterliciousDriverPolicies, blobCache?: ICache<ArrayBufferLike>, snapshotTreeCache?: ICache<ISnapshotTreeVersion>, getStorageManager?: (disableCache?: boolean) => Promise<GitManager>);
     getVersions(versionId: string | null, count: number): Promise<IVersion[]>;
     getSnapshotTree(version?: IVersion): Promise<ISnapshotTreeEx | null>;
     readBlob(blobId: string): Promise<ArrayBufferLike>;

package/lib/shreddedSummaryDocumentStorageService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shreddedSummaryDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/shreddedSummaryDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,mBAAmB,EAInB,MAAM,iCAAiC;OAEjC,EACN,uBAAuB,EACvB,eAAe,EACf,+BAA+B,EAC/B,MAAM,oCAAoC;OAEpC,EACN,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,MAAM,sCAAsC;OACtC,EAAE,4BAA4B,EAAE;OAChC,EAAE,MAAM,EAAiB;OAEzB,EAAE,oBAAoB,EAAE;OACxB,EAAE,UAAU,EAAE;AAMrB;;;;GAIG;AACH,qBAAa,qCAAsC,YAAW,uBAAuB;IAoBnF,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM;IAC7B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU;IACtC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,mBAAmB;aAC9B,QAAQ,EAAE,+BAA+B;IAIzD,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IA1BnC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAGvC,SAAS,CAAC,QAAQ,CAAC,aAAa,sBAA6B;IAC7D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAsC;IAChE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA2C;IAE7E,SAAgB,aAAa,MAAM;YAErB,uBAAuB;gBAUjB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,UAAU,EACnB,MAAM,EAAE,mBAAmB,EAC9B,QAAQ,EAAE,+BAA+B,EACzD,cAAc,CAAC,EAAE,4BAA4B,EAC7C,SAAS,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,EACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC,EAC/B,iBAAiB,GAAE,CACnC,YAAY,CAAC,EAAE,OAAO,KAClB,OAAO,CAAC,UAAU,CAA4B;IAYvC,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAqBzE,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAyCpE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IA8BlD,wBAAwB,CACpC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,eAAe,GACtB,OAAO,CAAC,MAAM,CAAC;IAqBL,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAI9D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAqB9D,uBAAuB;IAYrC,OAAO,CAAC,WAAW;CAGnB"}

package/lib/{shreddedSummaryDocumentStorageService.js → shreddedSummaryDocumentStorageService.mjs}

@@ -2,12 +2,12 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { stringToBuffer, Uint8ArrayToString, } from "@fluidframework/common-utils";
-import { buildHierarchy } from "@fluidframework/protocol-base";
-import { SummaryTreeUploadManager, } from "@fluidframework/server-services-client";
-import { PerformanceEvent } from "@fluidframework/telemetry-utils";
-import { InMemoryCache } from "./cache";
-import { RetriableGitManager } from "./retriableGitManager";
+import { PerformanceEvent, createChildMonitoringContext, } from "@fluidframework/telemetry-utils";
+import { stringToBuffer, Uint8ArrayToString } from "@fluid-internal/client-utils";
+import { buildGitTreeHierarchy } from "@fluidframework/protocol-base";
+import { InMemoryCache } from "./cache.mjs";
+import { RetriableGitManager } from "./retriableGitManager.mjs";
+import { SummaryTreeUploadManager } from "./summaryTreeUploadManager.mjs";
 const isNode = typeof window === "undefined";
 /**
  * Document access to underlying storage for routerlicious driver.
@@ -15,7 +15,11 @@ const isNode = typeof window === "undefined";
  * Downloads summaries piece-by-piece on-demand, or up-front when prefetch is enabled.
  */
 export class ShreddedSummaryDocumentStorageService {
-    constructor(id, manager, logger, policies = {}, driverPolicies, blobCache, snapshotTreeCache, getStorageManager = async () => this.manager) {
+    async getSummaryUploadManager() {
+        const manager = await this.getStorageManager();
+        return new SummaryTreeUploadManager(new RetriableGitManager(manager, this.logger), this.blobsShaCache, this.getPreviousFullSnapshot.bind(this));
+    }
+    constructor(id, manager, logger, policies, driverPolicies, blobCache, snapshotTreeCache, getStorageManager = async () => this.manager) {
         this.id = id;
         this.manager = manager;
         this.logger = logger;
@@ -24,17 +28,14 @@ export class ShreddedSummaryDocumentStorageService {
         // The values of this cache is useless. We only need the keys. So we are always putting
         // empty strings as values.
         this.blobsShaCache = new Map();
-        if ((driverPolicies === null || driverPolicies === void 0 ? void 0 : driverPolicies.enableRestLess) === true || isNode) {
-            this.blobCache = blobCache !== null && blobCache !== void 0 ? blobCache : new InMemoryCache();
-            this.snapshotTreeCache = snapshotTreeCache !== null && snapshotTreeCache !== void 0 ? snapshotTreeCache : new InMemoryCache();
+        this.repositoryUrl = "";
+        if (driverPolicies?.enableRestLess === true || isNode) {
+            this.blobCache = blobCache ?? new InMemoryCache();
+            this.snapshotTreeCache = snapshotTreeCache ?? new InMemoryCache();
         }
-    }
-    get repositoryUrl() {
-        return "";
-    }
-    async getSummaryUploadManager() {
-        const manager = await this.getStorageManager();
-        return new SummaryTreeUploadManager(new RetriableGitManager(manager, this.logger), this.blobsShaCache, this.getPreviousFullSnapshot.bind(this));
+        this.mc = createChildMonitoringContext({
+            logger,
+        });
     }
     async getVersions(versionId, count) {
         const id = versionId ? versionId : this.id;
@@ -44,7 +45,7 @@ export class ShreddedSummaryDocumentStorageService {
             count,
         }, async () => {
             const manager = await this.getStorageManager();
-            return manager.getCommits(id, count);
+            return (await manager.getCommits(id, count)).content;
         });
         return commits.map((commit) => ({
             date: commit.commit.author.date,
@@ -53,7 +54,6 @@ export class ShreddedSummaryDocumentStorageService {
         }));
     }
     async getSnapshotTree(version) {
-        var _a, _b;
         let requestVersion = version;
         if (!requestVersion) {
             const versions = await this.getVersions(this.id, 1);
@@ -62,7 +62,7 @@ export class ShreddedSummaryDocumentStorageService {
             }
             requestVersion = versions[0];
         }
-        const cachedSnapshotTree = await ((_a = this.snapshotTreeCache) === null || _a === void 0 ? void 0 : _a.get(this.getCacheKey(requestVersion.treeId)));
+        const cachedSnapshotTree = await this.snapshotTreeCache?.get(this.getCacheKey(requestVersion.treeId));
         if (cachedSnapshotTree) {
             return cachedSnapshotTree.snapshotTree;
         }
@@ -71,19 +71,21 @@ export class ShreddedSummaryDocumentStorageService {
             treeId: requestVersion.treeId,
         }, async (event) => {
             const manager = await this.getStorageManager();
-            const response = await manager.getTree(requestVersion.treeId);
+            const response = (await manager.getTree(requestVersion.treeId)).content;
             event.end({
                 size: response.tree.length,
             });
             return response;
         });
-        const tree = buildHierarchy(rawTree, this.blobsShaCache, true);
-        await ((_b = this.snapshotTreeCache) === null || _b === void 0 ? void 0 : _b.put(this.getCacheKey(tree.id), { id: requestVersion.id, snapshotTree: tree }));
+        const tree = buildGitTreeHierarchy(rawTree, this.blobsShaCache, true);
+        await this.snapshotTreeCache?.put(this.getCacheKey(tree.id), {
+            id: requestVersion.id,
+            snapshotTree: tree,
+        });
         return tree;
     }
     async readBlob(blobId) {
-        var _a, _b;
-        const cachedBlob = await ((_a = this.blobCache) === null || _a === void 0 ? void 0 : _a.get(this.getCacheKey(blobId)));
+        const cachedBlob = await this.blobCache?.get(this.getCacheKey(blobId));
         if (cachedBlob) {
             return cachedBlob;
         }
@@ -92,24 +94,28 @@ export class ShreddedSummaryDocumentStorageService {
             blobId,
         }, async (event) => {
             const manager = await this.getStorageManager();
-            const response = await manager.getBlob(blobId);
+            const response = (await manager.getBlob(blobId)).content;
             event.end({
                 size: response.size,
             });
             return response;
-        });
+        }, undefined, // workers
+        undefined, // recordHeapSize
+        this.mc.config.getNumber("Fluid.Driver.ReadBlobTelemetrySampling"));
         this.blobsShaCache.set(value.sha, "");
         const bufferContent = stringToBuffer(value.content, value.encoding);
-        await ((_b = this.blobCache) === null || _b === void 0 ? void 0 : _b.put(this.getCacheKey(value.sha), bufferContent));
+        await this.blobCache?.put(this.getCacheKey(value.sha), bufferContent);
         return bufferContent;
     }
     async uploadSummaryWithContext(summary, context) {
         const summaryHandle = await PerformanceEvent.timedExecAsync(this.logger, {
             eventName: "uploadSummaryWithContext",
+            proposalHandle: context.proposalHandle,
+            ackHandle: context.ackHandle,
+            referenceSequenceNumber: context.referenceSequenceNumber,
         }, async () => {
-            var _a;
             const summaryUploadManager = await this.getSummaryUploadManager();
-            return summaryUploadManager.writeSummaryTree(summary, (_a = context.ackHandle) !== null && _a !== void 0 ? _a : "", "channel");
+            return summaryUploadManager.writeSummaryTree(summary, context.ackHandle ?? "", "channel");
         });
         return summaryHandle;
     }
@@ -123,7 +129,9 @@ export class ShreddedSummaryDocumentStorageService {
             size: uint8ArrayFile.length,
         }, async (event) => {
             const manager = await this.getStorageManager();
-            const response = await manager.createBlob(Uint8ArrayToString(uint8ArrayFile, "base64"), "base64").then((r) => ({ id: r.sha, url: r.url }));
+            const response = await manager
+                .createBlob(Uint8ArrayToString(uint8ArrayFile, "base64"), "base64")
+                .then((r) => ({ id: r.content.sha, url: r.content.url }));
             event.end({
                 blobId: response.id,
             });
@@ -132,8 +140,7 @@ export class ShreddedSummaryDocumentStorageService {
     }
     async getPreviousFullSnapshot(parentHandle) {
         return parentHandle
-            ? this.getVersions(parentHandle, 1)
-                .then(async (versions) => {
+            ? this.getVersions(parentHandle, 1).then(async (versions) => {
                 // Clear the cache as the getSnapshotTree call will fill the cache.
                 this.blobsShaCache.clear();
                 return this.getSnapshotTree(versions[0]);
@@ -144,4 +151,4 @@ export class ShreddedSummaryDocumentStorageService {
         return `${this.id}:${blobId}`;
     }
 }
-//# sourceMappingURL=shreddedSummaryDocumentStorageService.js.map
+//# sourceMappingURL=shreddedSummaryDocumentStorageService.mjs.map

package/lib/shreddedSummaryDocumentStorageService.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"shreddedSummaryDocumentStorageService.mjs","sourceRoot":"","sources":["../src/shreddedSummaryDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAGN,gBAAgB,EAChB,4BAA4B,GAC5B,MAAM,iCAAiC;OACjC,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B;OAM1E,EAAE,qBAAqB,EAAE,MAAM,+BAA+B;OAS9D,EAAU,aAAa,EAAE;OACzB,EAAE,mBAAmB,EAAE;OAIvB,EAAE,wBAAwB,EAAE;AAEnC,MAAM,MAAM,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC;AAE7C;;;;GAIG;AACH,MAAM,OAAO,qCAAqC;IAUzC,KAAK,CAAC,uBAAuB;QACpC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/C,OAAO,IAAI,wBAAwB,CAClC,IAAI,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,EAC7C,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;IACH,CAAC;IAED,YACoB,EAAU,EACV,OAAmB,EACnB,MAA2B,EAC9B,QAAyC,EACzD,cAA6C,EAC7C,SAAmC,EACnC,iBAAgD,EAC/B,oBAEU,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO;QAThC,OAAE,GAAF,EAAE,CAAQ;QACV,YAAO,GAAP,OAAO,CAAY;QACnB,WAAM,GAAN,MAAM,CAAqB;QAC9B,aAAQ,GAAR,QAAQ,CAAiC;QAIxC,sBAAiB,GAAjB,iBAAiB,CAEiB;QA3BpD,uFAAuF;QACvF,2BAA2B;QACR,kBAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;QAI7C,kBAAa,GAAG,EAAE,CAAC;QAuBlC,IAAI,cAAc,EAAE,cAAc,KAAK,IAAI,IAAI,MAAM,EAAE;YACtD,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,IAAI,aAAa,EAAE,CAAC;YAClD,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,IAAI,IAAI,aAAa,EAAE,CAAC;SAClE;QAED,IAAI,CAAC,EAAE,GAAG,4BAA4B,CAAC;YACtC,MAAM;SACN,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa;QAC/D,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,cAAc,CACpD,IAAI,CAAC,MAAM,EACX;YACC,SAAS,EAAE,aAAa;YACxB,SAAS,EAAE,EAAE;YACb,KAAK;SACL,EACD,KAAK,IAAI,EAAE;YACV,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/C,OAAO,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;QACtD,CAAC,CACD,CAAC;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC/B,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI;YAC/B,EAAE,EAAE,MAAM,CAAC,GAAG;YACd,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG;SAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAkB;QAC9C,IAAI,cAAc,GAAG,OAAO,CAAC;QAC7B,IAAI,CAAC,cAAc,EAAE;YACpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YACpD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1B,OAAO,IAAI,CAAC;aACZ;YAED,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;SAC7B;QAED,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,GAAG,CAC3D,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CACvC,CAAC;QACF,IAAI,kBAAkB,EAAE;YACvB,OAAO,kBAAkB,CAAC,YAA+B,CAAC;SAC1D;QAED,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,cAAc,CACpD,IAAI,CAAC,MAAM,EACX;YACC,SAAS,EAAE,iBAAiB;YAC5B,MAAM,EAAE,cAAc,CAAC,MAAM;SAC7B,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACf,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,cAAe,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YACzE,KAAK,CAAC,GAAG,CAAC;gBACT,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM;aAC1B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACjB,CAAC,CACD,CAAC;QACF,MAAM,IAAI,GAAG,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,IAAI,CAAC,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YAC5D,EAAE,EAAE,cAAc,CAAC,EAAE;YACrB,YAAY,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,MAAc;QACnC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;QACvE,IAAI,UAAU,EAAE;YACf,OAAO,UAAU,CAAC;SAClB;QAED,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAClD,IAAI,CAAC,MAAM,EACX;YACC,SAAS,EAAE,UAAU;YACrB,MAAM;SACN,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACf,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YACzD,KAAK,CAAC,GAAG,CAAC;gBACT,IAAI,EAAE,QAAQ,CAAC,IAAI;aACnB,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACjB,CAAC,EACD,SAAS,EAAE,UAAU;QACrB,SAAS,EAAE,iBAAiB;QAC5B,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,wCAAwC,CAAC,CAClE,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACtC,MAAM,aAAa,GAAG,cAAc,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QACpE,MAAM,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,CAAC;QACtE,OAAO,aAAa,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACpC,OAAqB,EACrB,OAAwB;QAExB,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAC1D,IAAI,CAAC,MAAM,EACX;YACC,SAAS,EAAE,0BAA0B;YACrC,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;SACxD,EACD,KAAK,IAAI,EAAE;YACV,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAClE,OAAO,oBAAoB,CAAC,gBAAgB,CAC3C,OAAO,EACP,OAAO,CAAC,SAAS,IAAI,EAAE,EACvB,SAAS,CACT,CAAC;QACH,CAAC,CACD,CAAC;QACF,OAAO,aAAa,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAsB;QAClD,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QAC5C,MAAM,cAAc,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,gBAAgB,CAAC,cAAc,CACrC,IAAI,CAAC,MAAM,EACX;YACC,SAAS,EAAE,YAAY;YACvB,IAAI,EAAE,cAAc,CAAC,MAAM;SAC3B,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACf,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,OAAO;iBAC5B,UAAU,CAAC,kBAAkB,CAAC,cAAc,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC;iBAClE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC3D,KAAK,CAAC,GAAG,CAAC;gBACT,MAAM,EAAE,QAAQ,CAAC,EAAE;aACnB,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QACjB,CAAC,CACD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,uBAAuB,CACpC,YAAoB;QAEpB,OAAO,YAAY;YAClB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;gBAC1D,mEAAmE;gBACnE,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;gBAC3B,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC,CAAC;YACJ,CAAC,CAAC,SAAS,CAAC;IACd,CAAC;IAEO,WAAW,CAAC,MAAc;QACjC,OAAO,GAAG,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,CAAC;IAC/B,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tITelemetryLoggerExt,\n\tMonitoringContext,\n\tPerformanceEvent,\n\tcreateChildMonitoringContext,\n} from \"@fluidframework/telemetry-utils\";\nimport { stringToBuffer, Uint8ArrayToString } from \"@fluid-internal/client-utils\";\nimport {\n\tIDocumentStorageService,\n\tISummaryContext,\n\tIDocumentStorageServicePolicies,\n} from \"@fluidframework/driver-definitions\";\nimport { buildGitTreeHierarchy } from \"@fluidframework/protocol-base\";\nimport {\n\tICreateBlobResponse,\n\tISnapshotTreeEx,\n\tISummaryHandle,\n\tISummaryTree,\n\tIVersion,\n} from \"@fluidframework/protocol-definitions\";\nimport { IRouterliciousDriverPolicies } from \"./policies\";\nimport { ICache, InMemoryCache } from \"./cache\";\nimport { RetriableGitManager } from \"./retriableGitManager\";\nimport { ISnapshotTreeVersion } from \"./definitions\";\nimport { GitManager } from \"./gitManager\";\nimport { ISummaryUploadManager } from \"./storageContracts\";\nimport { SummaryTreeUploadManager } from \"./summaryTreeUploadManager\";\n\nconst isNode = typeof window === \"undefined\";\n\n/**\n * Document access to underlying storage for routerlicious driver.\n * Uploads summaries piece-by-piece traversing the tree recursively.\n * Downloads summaries piece-by-piece on-demand, or up-front when prefetch is enabled.\n */\nexport class ShreddedSummaryDocumentStorageService implements IDocumentStorageService {\n\tprivate readonly mc: MonitoringContext;\n\t// The values of this cache is useless. We only need the keys. So we are always putting\n\t// empty strings as values.\n\tprotected readonly blobsShaCache = new Map<string, string>();\n\tprivate readonly blobCache: ICache<ArrayBufferLike> | undefined;\n\tprivate readonly snapshotTreeCache: ICache<ISnapshotTreeVersion> | undefined;\n\n\tpublic readonly repositoryUrl = \"\";\n\n\tprivate async getSummaryUploadManager(): Promise<ISummaryUploadManager> {\n\t\tconst manager = await this.getStorageManager();\n\t\treturn new SummaryTreeUploadManager(\n\t\t\tnew RetriableGitManager(manager, this.logger),\n\t\t\tthis.blobsShaCache,\n\t\t\tthis.getPreviousFullSnapshot.bind(this),\n\t\t);\n\t}\n\n\tconstructor(\n\t\tprotected readonly id: string,\n\t\tprotected readonly manager: GitManager,\n\t\tprotected readonly logger: ITelemetryLoggerExt,\n\t\tpublic readonly policies: IDocumentStorageServicePolicies,\n\t\tdriverPolicies?: IRouterliciousDriverPolicies,\n\t\tblobCache?: ICache<ArrayBufferLike>,\n\t\tsnapshotTreeCache?: ICache<ISnapshotTreeVersion>,\n\t\tprivate readonly getStorageManager: (\n\t\t\tdisableCache?: boolean,\n\t\t) => Promise<GitManager> = async () => this.manager,\n\t) {\n\t\tif (driverPolicies?.enableRestLess === true || isNode) {\n\t\t\tthis.blobCache = blobCache ?? new InMemoryCache();\n\t\t\tthis.snapshotTreeCache = snapshotTreeCache ?? new InMemoryCache();\n\t\t}\n\n\t\tthis.mc = createChildMonitoringContext({\n\t\t\tlogger,\n\t\t});\n\t}\n\n\tpublic async getVersions(versionId: string | null, count: number): Promise<IVersion[]> {\n\t\tconst id = versionId ? versionId : this.id;\n\t\tconst commits = await PerformanceEvent.timedExecAsync(\n\t\t\tthis.logger,\n\t\t\t{\n\t\t\t\teventName: \"getVersions\",\n\t\t\t\tversionId: id,\n\t\t\t\tcount,\n\t\t\t},\n\t\t\tasync () => {\n\t\t\t\tconst manager = await this.getStorageManager();\n\t\t\t\treturn (await manager.getCommits(id, count)).content;\n\t\t\t},\n\t\t);\n\t\treturn commits.map((commit) => ({\n\t\t\tdate: commit.commit.author.date,\n\t\t\tid: commit.sha,\n\t\t\ttreeId: commit.commit.tree.sha,\n\t\t}));\n\t}\n\n\tpublic async getSnapshotTree(version?: IVersion): Promise<ISnapshotTreeEx | null> {\n\t\tlet requestVersion = version;\n\t\tif (!requestVersion) {\n\t\t\tconst versions = await this.getVersions(this.id, 1);\n\t\t\tif (versions.length === 0) {\n\t\t\t\treturn null;\n\t\t\t}\n\n\t\t\trequestVersion = versions[0];\n\t\t}\n\n\t\tconst cachedSnapshotTree = await this.snapshotTreeCache?.get(\n\t\t\tthis.getCacheKey(requestVersion.treeId),\n\t\t);\n\t\tif (cachedSnapshotTree) {\n\t\t\treturn cachedSnapshotTree.snapshotTree as ISnapshotTreeEx;\n\t\t}\n\n\t\tconst rawTree = await PerformanceEvent.timedExecAsync(\n\t\t\tthis.logger,\n\t\t\t{\n\t\t\t\teventName: \"getSnapshotTree\",\n\t\t\t\ttreeId: requestVersion.treeId,\n\t\t\t},\n\t\t\tasync (event) => {\n\t\t\t\tconst manager = await this.getStorageManager();\n\t\t\t\tconst response = (await manager.getTree(requestVersion!.treeId)).content;\n\t\t\t\tevent.end({\n\t\t\t\t\tsize: response.tree.length,\n\t\t\t\t});\n\t\t\t\treturn response;\n\t\t\t},\n\t\t);\n\t\tconst tree = buildGitTreeHierarchy(rawTree, this.blobsShaCache, true);\n\t\tawait this.snapshotTreeCache?.put(this.getCacheKey(tree.id), {\n\t\t\tid: requestVersion.id,\n\t\t\tsnapshotTree: tree,\n\t\t});\n\t\treturn tree;\n\t}\n\n\tpublic async readBlob(blobId: string): Promise<ArrayBufferLike> {\n\t\tconst cachedBlob = await this.blobCache?.get(this.getCacheKey(blobId));\n\t\tif (cachedBlob) {\n\t\t\treturn cachedBlob;\n\t\t}\n\n\t\tconst value = await PerformanceEvent.timedExecAsync(\n\t\t\tthis.logger,\n\t\t\t{\n\t\t\t\teventName: \"readBlob\",\n\t\t\t\tblobId,\n\t\t\t},\n\t\t\tasync (event) => {\n\t\t\t\tconst manager = await this.getStorageManager();\n\t\t\t\tconst response = (await manager.getBlob(blobId)).content;\n\t\t\t\tevent.end({\n\t\t\t\t\tsize: response.size,\n\t\t\t\t});\n\t\t\t\treturn response;\n\t\t\t},\n\t\t\tundefined, // workers\n\t\t\tundefined, // recordHeapSize\n\t\t\tthis.mc.config.getNumber(\"Fluid.Driver.ReadBlobTelemetrySampling\"),\n\t\t);\n\t\tthis.blobsShaCache.set(value.sha, \"\");\n\t\tconst bufferContent = stringToBuffer(value.content, value.encoding);\n\t\tawait this.blobCache?.put(this.getCacheKey(value.sha), bufferContent);\n\t\treturn bufferContent;\n\t}\n\n\tpublic async uploadSummaryWithContext(\n\t\tsummary: ISummaryTree,\n\t\tcontext: ISummaryContext,\n\t): Promise<string> {\n\t\tconst summaryHandle = await PerformanceEvent.timedExecAsync(\n\t\t\tthis.logger,\n\t\t\t{\n\t\t\t\teventName: \"uploadSummaryWithContext\",\n\t\t\t\tproposalHandle: context.proposalHandle,\n\t\t\t\tackHandle: context.ackHandle,\n\t\t\t\treferenceSequenceNumber: context.referenceSequenceNumber,\n\t\t\t},\n\t\t\tasync () => {\n\t\t\t\tconst summaryUploadManager = await this.getSummaryUploadManager();\n\t\t\t\treturn summaryUploadManager.writeSummaryTree(\n\t\t\t\t\tsummary,\n\t\t\t\t\tcontext.ackHandle ?? \"\",\n\t\t\t\t\t\"channel\",\n\t\t\t\t);\n\t\t\t},\n\t\t);\n\t\treturn summaryHandle;\n\t}\n\n\tpublic async downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree> {\n\t\tthrow new Error(\"NOT IMPLEMENTED!\");\n\t}\n\n\tpublic async createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse> {\n\t\tconst uint8ArrayFile = new Uint8Array(file);\n\t\treturn PerformanceEvent.timedExecAsync(\n\t\t\tthis.logger,\n\t\t\t{\n\t\t\t\teventName: \"createBlob\",\n\t\t\t\tsize: uint8ArrayFile.length,\n\t\t\t},\n\t\t\tasync (event) => {\n\t\t\t\tconst manager = await this.getStorageManager();\n\t\t\t\tconst response = await manager\n\t\t\t\t\t.createBlob(Uint8ArrayToString(uint8ArrayFile, \"base64\"), \"base64\")\n\t\t\t\t\t.then((r) => ({ id: r.content.sha, url: r.content.url }));\n\t\t\t\tevent.end({\n\t\t\t\t\tblobId: response.id,\n\t\t\t\t});\n\t\t\t\treturn response;\n\t\t\t},\n\t\t);\n\t}\n\n\tprivate async getPreviousFullSnapshot(\n\t\tparentHandle: string,\n\t): Promise<ISnapshotTreeEx | null | undefined> {\n\t\treturn parentHandle\n\t\t\t? this.getVersions(parentHandle, 1).then(async (versions) => {\n\t\t\t\t\t// Clear the cache as the getSnapshotTree call will fill the cache.\n\t\t\t\t\tthis.blobsShaCache.clear();\n\t\t\t\t\treturn this.getSnapshotTree(versions[0]);\n\t\t\t  })\n\t\t\t: undefined;\n\t}\n\n\tprivate getCacheKey(blobId: string): string {\n\t\treturn `${this.id}:${blobId}`;\n\t}\n}\n"]}

package/lib/storageContracts.d.mts

@@ -0,0 +1,45 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import * as git from "@fluidframework/gitresources";
+import * as api from "@fluidframework/protocol-definitions";
+import { IWholeSummaryPayload, IWholeSummaryPayloadType, IWriteSummaryResponse } from "@fluidframework/server-services-client";
+import { IR11sResponse } from "./restWrapper.mjs";
+import { IWholeFlatSnapshot } from "./contracts.mjs";
+/**
+ * Interface to a generic Git provider
+ */
+export interface IHistorian {
+    getBlob(sha: string): Promise<IR11sResponse<git.IBlob>>;
+    createBlob(blob: git.ICreateBlobParams): Promise<IR11sResponse<git.ICreateBlobResponse>>;
+    getCommits(sha: string, count: number): Promise<IR11sResponse<git.ICommitDetails[]>>;
+    createTree(tree: git.ICreateTreeParams): Promise<IR11sResponse<git.ITree>>;
+    getTree(sha: string, recursive: boolean): Promise<IR11sResponse<git.ITree>>;
+    createSummary(summary: IWholeSummaryPayload, initial?: boolean): Promise<IR11sResponse<IWriteSummaryResponse>>;
+    getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>>;
+}
+export interface IGitManager {
+    getCommits(sha: string, count: number): Promise<IR11sResponse<git.ICommitDetails[]>>;
+    getTree(root: string, recursive: boolean): Promise<IR11sResponse<git.ITree>>;
+    getBlob(sha: string): Promise<IR11sResponse<git.IBlob>>;
+    createBlob(content: string, encoding: string): Promise<IR11sResponse<git.ICreateBlobResponse>>;
+    createGitTree(params: git.ICreateTreeParams): Promise<IR11sResponse<git.ITree>>;
+    createSummary(summary: IWholeSummaryPayload, initial?: boolean): Promise<IR11sResponse<IWriteSummaryResponse>>;
+    getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>>;
+}
+/**
+ * Uploads a summary to storage.
+ */
+export interface ISummaryUploadManager {
+    /**
+     * Writes summary tree to storage.
+     * @param summaryTree - Summary tree to write to storage
+     * @param parentHandle - Parent summary acked handle (if available from summary ack)
+     * @param summaryType - type of summary being uploaded
+     * @param sequenceNumber - optional reference sequence number of the summary
+     * @returns Id of created tree as a string.
+     */
+    writeSummaryTree(summaryTree: api.ISummaryTree, parentHandle: string, summaryType: IWholeSummaryPayloadType, sequenceNumber?: number): Promise<string>;
+}
+//# sourceMappingURL=storageContracts.d.ts.map

package/lib/storageContracts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storageContracts.d.ts","sourceRoot":"","sources":["../src/storageContracts.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,KAAK,GAAG,MAAM,8BAA8B;OAC5C,KAAK,GAAG,MAAM,sCAAsC;OACpD,EACN,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,MAAM,wCAAwC;OACxC,EAAE,aAAa,EAAE;OACjB,EAAE,kBAAkB,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACzF,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACrF,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3E,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5E,aAAa,CACZ,OAAO,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACjD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACrE;AAED,MAAM,WAAW,WAAW;IAC3B,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACrF,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7E,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC/F,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,aAAa,CACZ,OAAO,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACjD,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;;;;;OAOG;IACH,gBAAgB,CACf,WAAW,EAAE,GAAG,CAAC,YAAY,EAC7B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,wBAAwB,EACrC,cAAc,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,MAAM,CAAC,CAAC;CACnB"}

package/lib/storageContracts.mjs

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=storageContracts.mjs.map

package/lib/storageContracts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"storageContracts.mjs","sourceRoot":"","sources":["../src/storageContracts.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport * as git from \"@fluidframework/gitresources\";\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport {\n\tIWholeSummaryPayload,\n\tIWholeSummaryPayloadType,\n\tIWriteSummaryResponse,\n} from \"@fluidframework/server-services-client\";\nimport { IR11sResponse } from \"./restWrapper\";\nimport { IWholeFlatSnapshot } from \"./contracts\";\n\n/**\n * Interface to a generic Git provider\n */\nexport interface IHistorian {\n\tgetBlob(sha: string): Promise<IR11sResponse<git.IBlob>>;\n\tcreateBlob(blob: git.ICreateBlobParams): Promise<IR11sResponse<git.ICreateBlobResponse>>;\n\tgetCommits(sha: string, count: number): Promise<IR11sResponse<git.ICommitDetails[]>>;\n\tcreateTree(tree: git.ICreateTreeParams): Promise<IR11sResponse<git.ITree>>;\n\tgetTree(sha: string, recursive: boolean): Promise<IR11sResponse<git.ITree>>;\n\tcreateSummary(\n\t\tsummary: IWholeSummaryPayload,\n\t\tinitial?: boolean,\n\t): Promise<IR11sResponse<IWriteSummaryResponse>>;\n\tgetSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>>;\n}\n\nexport interface IGitManager {\n\tgetCommits(sha: string, count: number): Promise<IR11sResponse<git.ICommitDetails[]>>;\n\tgetTree(root: string, recursive: boolean): Promise<IR11sResponse<git.ITree>>;\n\tgetBlob(sha: string): Promise<IR11sResponse<git.IBlob>>;\n\tcreateBlob(content: string, encoding: string): Promise<IR11sResponse<git.ICreateBlobResponse>>;\n\tcreateGitTree(params: git.ICreateTreeParams): Promise<IR11sResponse<git.ITree>>;\n\tcreateSummary(\n\t\tsummary: IWholeSummaryPayload,\n\t\tinitial?: boolean,\n\t): Promise<IR11sResponse<IWriteSummaryResponse>>;\n\tgetSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>>;\n}\n\n/**\n * Uploads a summary to storage.\n */\nexport interface ISummaryUploadManager {\n\t/**\n\t * Writes summary tree to storage.\n\t * @param summaryTree - Summary tree to write to storage\n\t * @param parentHandle - Parent summary acked handle (if available from summary ack)\n\t * @param summaryType - type of summary being uploaded\n\t * @param sequenceNumber - optional reference sequence number of the summary\n\t * @returns Id of created tree as a string.\n\t */\n\twriteSummaryTree(\n\t\tsummaryTree: api.ISummaryTree,\n\t\tparentHandle: string,\n\t\tsummaryType: IWholeSummaryPayloadType,\n\t\tsequenceNumber?: number,\n\t): Promise<string>;\n}\n"]}

package/lib/summaryTreeUploadManager.d.mts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISnapshotTreeEx, ISummaryTree } from "@fluidframework/protocol-definitions";
+import { IWholeSummaryPayloadType } from "@fluidframework/server-services-client";
+import { IGitManager, ISummaryUploadManager } from "./storageContracts.mjs";
+/**
+ * Recursively writes summary tree as individual summary blobs.
+ */
+export declare class SummaryTreeUploadManager implements ISummaryUploadManager {
+    private readonly manager;
+    private readonly blobsShaCache;
+    private readonly getPreviousFullSnapshot;
+    constructor(manager: IGitManager, blobsShaCache: Map<string, string>, getPreviousFullSnapshot: (parentHandle: string) => Promise<ISnapshotTreeEx | null | undefined>);
+    writeSummaryTree(summaryTree: ISummaryTree, parentHandle: string, summaryType: IWholeSummaryPayloadType, sequenceNumber?: number, initial?: boolean): Promise<string>;
+    private writeSummaryTreeCore;
+    private writeSummaryTreeObject;
+    private writeSummaryBlob;
+    private getIdFromPath;
+    private getIdFromPathCore;
+}
+//# sourceMappingURL=summaryTreeUploadManager.d.ts.map

package/lib/summaryTreeUploadManager.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summaryTreeUploadManager.d.ts","sourceRoot":"","sources":["../src/summaryTreeUploadManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAMI,EACN,eAAe,EACf,YAAY,EAGZ,MAAM,sCAAsC;OACtC,EAAE,wBAAwB,EAAE,MAAM,wCAAwC;OAC1E,EAAE,WAAW,EAAE,qBAAqB,EAAE;AAE7C;;GAEG;AACH,qBAAa,wBAAyB,YAAW,qBAAqB;IAEpE,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,uBAAuB;gBAFvB,OAAO,EAAE,WAAW,EACpB,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,uBAAuB,EAAE,CACzC,YAAY,EAAE,MAAM,KAChB,OAAO,CAAC,eAAe,GAAG,IAAI,GAAG,SAAS,CAAC;IAGpC,gBAAgB,CAC5B,WAAW,EAAE,YAAY,EACzB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,wBAAwB,EACrC,cAAc,CAAC,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,MAAM,CAAC;YAKJ,oBAAoB;YAsBpB,sBAAsB;YA0BtB,gBAAgB;IAgB9B,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,iBAAiB;CAgCzB"}