@fluidframework/file-driver 2.0.0-rc.1.0.3 → 2.0.0-rc.2.0.0

package/lib/fileDocumentService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocumentService.d.ts","sourceRoot":"","sources":["../src/fileDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,KAAK,GAAG,MAAM,oCAAoC,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;GAGG;AAEH,qBAAa,mBACZ,SAAQ,iBAAiB,CAAC,GAAG,CAAC,sBAAsB,CACpD,YAAW,GAAG,CAAC,gBAAgB;aAGd,WAAW,EAAE,GAAG,CAAC,YAAY;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe;gBAHhB,WAAW,EAAE,GAAG,CAAC,YAAY,EAC5B,OAAO,EAAE,GAAG,CAAC,uBAAuB,EACpC,YAAY,EAAE,uBAAuB,EACrC,eAAe,EAAE,GAAG,CAAC,wBAAwB;IAKxD,OAAO;IAED,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;IAIxD,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC;IAI/E;;;;;;OAMG;IACU,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;CAGzF"}

package/lib/fileDocumentService.js

@@ -0,0 +1,37 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+/**
+ * The DocumentService manages the different endpoints for connecting to
+ * underlying storage for file document service.
+ */
+// eslint-disable-next-line import/namespace
+export class FileDocumentService extends TypedEventEmitter {
+    constructor(resolvedUrl, storage, deltaStorage, deltaConnection) {
+        super();
+        this.resolvedUrl = resolvedUrl;
+        this.storage = storage;
+        this.deltaStorage = deltaStorage;
+        this.deltaConnection = deltaConnection;
+    }
+    dispose() { }
+    async connectToStorage() {
+        return this.storage;
+    }
+    async connectToDeltaStorage() {
+        return this.deltaStorage;
+    }
+    /**
+     * Connects to a delta storage endpoint of provided documentService to get ops and then replaying
+     * them so as to mimic a delta stream endpoint.
+     *
+     * @param client - Client that connects to socket.
+     * @returns returns the delta stream service.
+     */
+    async connectToDeltaStream(client) {
+        return this.deltaConnection;
+    }
+}
+//# sourceMappingURL=fileDocumentService.js.map

package/lib/fileDocumentService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocumentService.js","sourceRoot":"","sources":["../src/fileDocumentService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAKjE;;;GAGG;AACH,4CAA4C;AAC5C,MAAM,OAAO,mBACZ,SAAQ,iBAA6C;IAGrD,YACiB,WAA6B,EAC5B,OAAoC,EACpC,YAAqC,EACrC,eAA6C;QAE9D,KAAK,EAAE,CAAC;QALQ,gBAAW,GAAX,WAAW,CAAkB;QAC5B,YAAO,GAAP,OAAO,CAA6B;QACpC,iBAAY,GAAZ,YAAY,CAAyB;QACrC,oBAAe,GAAf,eAAe,CAA8B;IAG/D,CAAC;IAEM,OAAO,KAAI,CAAC;IAEZ,KAAK,CAAC,gBAAgB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAEM,KAAK,CAAC,qBAAqB;QACjC,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAAC,MAAe;QAChD,OAAO,IAAI,CAAC,eAAe,CAAC;IAC7B,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluid-internal/client-utils\";\nimport * as api from \"@fluidframework/driver-definitions\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\nimport { FileDeltaStorageService } from \"./fileDeltaStorageService.js\";\n\n/**\n * The DocumentService manages the different endpoints for connecting to\n * underlying storage for file document service.\n */\n// eslint-disable-next-line import/namespace\nexport class FileDocumentService\n\textends TypedEventEmitter<api.IDocumentServiceEvents>\n\timplements api.IDocumentService\n{\n\tconstructor(\n\t\tpublic readonly resolvedUrl: api.IResolvedUrl,\n\t\tprivate readonly storage: api.IDocumentStorageService,\n\t\tprivate readonly deltaStorage: FileDeltaStorageService,\n\t\tprivate readonly deltaConnection: api.IDocumentDeltaConnection,\n\t) {\n\t\tsuper();\n\t}\n\n\tpublic dispose() {}\n\n\tpublic async connectToStorage(): Promise<api.IDocumentStorageService> {\n\t\treturn this.storage;\n\t}\n\n\tpublic async connectToDeltaStorage(): Promise<api.IDocumentDeltaStorageService> {\n\t\treturn this.deltaStorage;\n\t}\n\n\t/**\n\t * Connects to a delta storage endpoint of provided documentService to get ops and then replaying\n\t * them so as to mimic a delta stream endpoint.\n\t *\n\t * @param client - Client that connects to socket.\n\t * @returns returns the delta stream service.\n\t */\n\tpublic async connectToDeltaStream(client: IClient): Promise<api.IDocumentDeltaConnection> {\n\t\treturn this.deltaConnection;\n\t}\n}\n"]}

package/lib/fileDocumentServiceFactory.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDocumentDeltaConnection, IDocumentService, IDocumentServiceFactory, IDocumentStorageService, IResolvedUrl } from "@fluidframework/driver-definitions";
+import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
+/**
+ * Factory for creating the file document service. Use this if you want to
+ * use the local file storage as underlying storage.
+ * @internal
+ */
+export declare class FileDocumentServiceFactory implements IDocumentServiceFactory {
+    private readonly storage;
+    private readonly deltaStorage;
+    private readonly deltaConnection;
+    constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
+    /**
+     * Creates the file document service if the path exists.
+     *
+     * @param fileURL - Path of directory containing ops/snapshots.
+     * @returns file document service.
+     */
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+//# sourceMappingURL=fileDocumentServiceFactory.d.ts.map

package/lib/fileDocumentServiceFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocumentServiceFactory.d.ts","sourceRoot":"","sources":["../src/fileDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,wBAAwB,EACxB,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAGvE;;;;GAIG;AACH,qBAAa,0BAA2B,YAAW,uBAAuB;IAExE,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe;gBAFf,OAAO,EAAE,uBAAuB,EAChC,YAAY,EAAE,uBAAuB,EACrC,eAAe,EAAE,wBAAwB;IAG3D;;;;;OAKG;IACU,qBAAqB,CACjC,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IAUf,eAAe,CAC3B,gBAAgB,EAAE,YAAY,EAC9B,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC;CAG5B"}

package/lib/fileDocumentServiceFactory.js

@@ -0,0 +1,31 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FileDocumentService } from "./fileDocumentService.js";
+/**
+ * Factory for creating the file document service. Use this if you want to
+ * use the local file storage as underlying storage.
+ * @internal
+ */
+export class FileDocumentServiceFactory {
+    constructor(storage, deltaStorage, deltaConnection) {
+        this.storage = storage;
+        this.deltaStorage = deltaStorage;
+        this.deltaConnection = deltaConnection;
+    }
+    /**
+     * Creates the file document service if the path exists.
+     *
+     * @param fileURL - Path of directory containing ops/snapshots.
+     * @returns file document service.
+     */
+    async createDocumentService(resolvedUrl, logger, clientIsSummarizer) {
+        return new FileDocumentService(resolvedUrl, this.storage, this.deltaStorage, this.deltaConnection);
+    }
+    // TODO: Issue-2109 Implement detach container api or put appropriate comment.
+    async createContainer(createNewSummary, resolvedUrl, logger, clientIsSummarizer) {
+        throw new Error("Not implemented");
+    }
+}
+//# sourceMappingURL=fileDocumentServiceFactory.js.map

package/lib/fileDocumentServiceFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocumentServiceFactory.js","sourceRoot":"","sources":["../src/fileDocumentServiceFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D;;;;GAIG;AACH,MAAM,OAAO,0BAA0B;IACtC,YACkB,OAAgC,EAChC,YAAqC,EACrC,eAAyC;QAFzC,YAAO,GAAP,OAAO,CAAyB;QAChC,iBAAY,GAAZ,YAAY,CAAyB;QACrC,oBAAe,GAAf,eAAe,CAA0B;IACxD,CAAC;IAEJ;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CACjC,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,OAAO,IAAI,mBAAmB,CAC7B,WAAW,EACX,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,CACpB,CAAC;IACH,CAAC;IAED,8EAA8E;IACvE,KAAK,CAAC,eAAe,CAC3B,gBAA8B,EAC9B,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B;QAE5B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIDocumentDeltaConnection,\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIDocumentStorageService,\n\tIResolvedUrl,\n} from \"@fluidframework/driver-definitions\";\nimport { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport { FileDeltaStorageService } from \"./fileDeltaStorageService.js\";\nimport { FileDocumentService } from \"./fileDocumentService.js\";\n\n/**\n * Factory for creating the file document service. Use this if you want to\n * use the local file storage as underlying storage.\n * @internal\n */\nexport class FileDocumentServiceFactory implements IDocumentServiceFactory {\n\tconstructor(\n\t\tprivate readonly storage: IDocumentStorageService,\n\t\tprivate readonly deltaStorage: FileDeltaStorageService,\n\t\tprivate readonly deltaConnection: IDocumentDeltaConnection,\n\t) {}\n\n\t/**\n\t * Creates the file document service if the path exists.\n\t *\n\t * @param fileURL - Path of directory containing ops/snapshots.\n\t * @returns file document service.\n\t */\n\tpublic async createDocumentService(\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService> {\n\t\treturn new FileDocumentService(\n\t\t\tresolvedUrl,\n\t\t\tthis.storage,\n\t\t\tthis.deltaStorage,\n\t\t\tthis.deltaConnection,\n\t\t);\n\t}\n\n\t// TODO: Issue-2109 Implement detach container api or put appropriate comment.\n\tpublic async createContainer(\n\t\tcreateNewSummary: ISummaryTree,\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService> {\n\t\tthrow new Error(\"Not implemented\");\n\t}\n}\n"]}

package/lib/fileDocumentStorageService.d.ts

@@ -0,0 +1,91 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDocumentStorageService, ISummaryContext } from "@fluidframework/driver-definitions";
+import * as api from "@fluidframework/protocol-definitions";
+import { IFileSnapshot, ReadDocumentStorageServiceBase } from "@fluidframework/replay-driver";
+/**
+ * @internal
+ */
+export declare const FileStorageDocumentName = "FileStorageDocId";
+/**
+ * Document storage service for the file driver.
+ * @internal
+ */
+export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService {
+    private readonly path;
+    private readonly versionName?;
+    protected docTree: api.ISnapshotTree | null;
+    constructor(path: string, versionName?: string | undefined);
+    /**
+     * Read the file and returns the snapshot tree.
+     * @param version - The version contains the path of the file which contains the snapshot tree.
+     */
+    getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+    /**
+     * Gets the path of the snapshot tree to be read.
+     * @param versionId - version ID.
+     * @param count - Number of versions to be returned.
+     */
+    getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+    readBlob(sha: string): Promise<ArrayBufferLike>;
+}
+/**
+ * @internal
+ */
+export interface ISnapshotWriterStorage extends IDocumentStorageService {
+    onSnapshotHandler(snapshot: IFileSnapshot): void;
+    reset(): void;
+}
+/**
+ * @internal
+ */
+export type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;
+/**
+ * @internal
+ */
+export declare const FileSnapshotWriterClassFactory: <TBase extends ReaderConstructor>(Base: TBase) => {
+    new (...args: any[]): {
+        blobsWriter: Map<string, ArrayBufferLike>;
+        latestWriterTree?: api.ISnapshotTree | undefined;
+        docId?: string | undefined;
+        reset(): void;
+        onSnapshotHandler(snapshot: IFileSnapshot): void;
+        readBlob(sha: string): Promise<ArrayBufferLike>;
+        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+        getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
+        readonly policies?: import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined;
+        getSnapshot?(snapshotFetchOptions?: import("@fluidframework/driver-definitions").ISnapshotFetchOptions | undefined): Promise<import("@fluidframework/driver-definitions").ISnapshot>;
+        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
+        readonly disposed?: boolean | undefined;
+        dispose?: ((error?: Error | undefined) => void) | undefined;
+    };
+} & TBase;
+/**
+ * @internal
+ */
+export declare const FluidFetchReaderFileSnapshotWriter: {
+    new (...args: any[]): {
+        blobsWriter: Map<string, ArrayBufferLike>;
+        latestWriterTree?: api.ISnapshotTree | undefined;
+        docId?: string | undefined;
+        reset(): void;
+        onSnapshotHandler(snapshot: IFileSnapshot): void;
+        readBlob(sha: string): Promise<ArrayBufferLike>;
+        getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+        getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+        uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;
+        buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree>;
+        readonly policies?: import("@fluidframework/driver-definitions").IDocumentStorageServicePolicies | undefined;
+        getSnapshot?(snapshotFetchOptions?: import("@fluidframework/driver-definitions").ISnapshotFetchOptions | undefined): Promise<import("@fluidframework/driver-definitions").ISnapshot>;
+        createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;
+        downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;
+        readonly disposed?: boolean | undefined;
+        dispose?: ((error?: Error | undefined) => void) | undefined;
+    };
+} & typeof FluidFetchReader;
+//# sourceMappingURL=fileDocumentStorageService.d.ts.map

package/lib/fileDocumentStorageService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocumentStorageService.d.ts","sourceRoot":"","sources":["../src/fileDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAE9F,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,8BAA8B,EAAE,MAAM,+BAA+B,CAAC;AAI9F;;GAEG;AACH,eAAO,MAAM,uBAAuB,qBAAqB,CAAC;AAK1D;;;GAGG;AACH,qBAAa,gBACZ,SAAQ,8BACR,YAAW,uBAAuB;IAKjC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAJ9B,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,aAAa,GAAG,IAAI,CAAQ;gBAGjC,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,oBAAQ;IAKtC;;;OAGG;IAEU,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;IAkCvF;;;;OAIG;IAEU,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IAmB7E,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;CAU5D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;IACtE,iBAAiB,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IACjD,KAAK,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,uBAAuB,CAAC;AAChF;;GAEG;AACH,eAAO,MAAM,8BAA8B;kBAJG,GAAG,EAAE;;;;;oCAiBd,aAAa,GAAG,IAAI;sBAI5B,MAAM,GAAG,QAAQ,eAAe,CAAC;+BASxB,MAAM,GAAG,IAAI,SAAS,MAAM,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAC;kCAkBnD,IAAI,QAAQ,GAAG,QAAQ,IAAI,aAAa,GAAG,IAAI,CAAC;0CAQ7E,IAAI,YAAY,WAChB,eAAe,GACtB,QAAQ,MAAM,CAAC;gCAcmB,IAAI,aAAa,GAAG,QAAQ,IAAI,KAAK,CAAC;;;;;;;;SA8B3E,CAAC;AAcH;;GAEG;AACH,eAAO,MAAM,kCAAkC;kBAvHD,GAAG,EAAE;;;;;oCAiBd,aAAa,GAAG,IAAI;sBAI5B,MAAM,GAAG,QAAQ,eAAe,CAAC;+BASxB,MAAM,GAAG,IAAI,SAAS,MAAM,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAC;kCAkBnD,IAAI,QAAQ,GAAG,QAAQ,IAAI,aAAa,GAAG,IAAI,CAAC;0CAQ7E,IAAI,YAAY,WAChB,eAAe,GACtB,QAAQ,MAAM,CAAC;gCAcmB,IAAI,aAAa,GAAG,QAAQ,IAAI,KAAK,CAAC;;;;;;;;2BA+CqB,CAAC"}

package/lib/fileDocumentStorageService.js

@@ -0,0 +1,197 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import fs from "fs";
+import { bufferToString } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils";
+import { buildSnapshotTree, convertSummaryTreeToSnapshotITree } from "@fluidframework/driver-utils";
+import * as api from "@fluidframework/protocol-definitions";
+import { ReadDocumentStorageServiceBase } from "@fluidframework/replay-driver";
+// This ID is used by replay tool as Document Id.
+// We leverage it to figure out when container is asking for root document tree.
+/**
+ * @internal
+ */
+export const FileStorageDocumentName = "FileStorageDocId"; // Some unique document name
+// Tree ID use to communicate between getVersions() & getSnapshotTree() that IVersion is ours.
+const FileStorageVersionTreeId = "FileStorageTreeId";
+/**
+ * Document storage service for the file driver.
+ * @internal
+ */
+export class FluidFetchReader extends ReadDocumentStorageServiceBase {
+    constructor(path, versionName) {
+        super();
+        this.path = path;
+        this.versionName = versionName;
+        this.docTree = null;
+    }
+    /**
+     * Read the file and returns the snapshot tree.
+     * @param version - The version contains the path of the file which contains the snapshot tree.
+     */
+    // eslint-disable-next-line @rushstack/no-new-null
+    async getSnapshotTree(version) {
+        assert(version !== null, 0x092 /* "version input for reading snapshot tree is null!" */);
+        assert(!version || version.treeId === FileStorageVersionTreeId, 0x093 /* "invalid version input for reading snapshot tree!" */);
+        let filename;
+        let rootTree = false;
+        if (!version || version.id === "latest") {
+            if (this.docTree) {
+                return this.docTree;
+            }
+            if (this.versionName === undefined) {
+                return null;
+            }
+            rootTree = true;
+            filename = `${this.path}/${this.versionName}/tree.json`;
+        }
+        else {
+            filename = `${this.path}/${this.versionName}/${version.id}.json`;
+        }
+        if (!fs.existsSync(filename)) {
+            throw new Error(`Can't find file ${filename}`);
+        }
+        const data = fs.readFileSync(filename);
+        const tree = JSON.parse(data.toString("utf-8"));
+        if (rootTree) {
+            this.docTree = tree;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return tree;
+    }
+    /**
+     * Gets the path of the snapshot tree to be read.
+     * @param versionId - version ID.
+     * @param count - Number of versions to be returned.
+     */
+    // eslint-disable-next-line @rushstack/no-new-null
+    async getVersions(versionId, count) {
+        if (versionId === FileStorageDocumentName || versionId === null) {
+            if (this.docTree !== null || this.versionName !== undefined) {
+                return [{ id: "latest", treeId: FileStorageVersionTreeId }];
+            }
+            // Started with ops - return empty set.
+            return [];
+        }
+        else if (this.versionName !== undefined) {
+            assert(!!this.docTree, 0x094 /* "Missing snapshot tree!" */);
+            return [
+                {
+                    id: versionId,
+                    treeId: FileStorageVersionTreeId,
+                },
+            ];
+        }
+        throw new Error(`Unknown version: ${versionId}`);
+    }
+    async readBlob(sha) {
+        if (this.versionName !== undefined) {
+            const fileName = `${this.path}/${this.versionName}/${sha}`;
+            if (fs.existsSync(fileName)) {
+                const data = fs.readFileSync(fileName);
+                return data;
+            }
+        }
+        throw new Error(`Can't find blob ${sha}`);
+    }
+}
+/**
+ * @internal
+ */
+export const FileSnapshotWriterClassFactory = (Base) => class extends Base {
+    constructor() {
+        super(...arguments);
+        // Note: if variable name has same name as in base class, it overrides it!
+        this.blobsWriter = new Map();
+    }
+    reset() {
+        this.blobsWriter = new Map();
+        this.latestWriterTree = undefined;
+        this.docId = undefined;
+    }
+    onSnapshotHandler(snapshot) {
+        throw new Error("onSnapshotHandler is not setup! Please provide your handler!");
+    }
+    async readBlob(sha) {
+        const blob = this.blobsWriter.get(sha);
+        if (blob !== undefined) {
+            return blob;
+        }
+        return super.readBlob(sha);
+    }
+    // eslint-disable-next-line @rushstack/no-new-null
+    async getVersions(versionId, count) {
+        // If we already saved document, that means we are getting here because of snapshot generation.
+        // Not returning tree ensures that ContainerRuntime.snapshot() would regenerate subtrees for
+        // each unchanged data store.
+        // If we want to change that, we would need to capture docId on first call and return this.latestWriterTree
+        // when latest is requested.
+        if (this.latestWriterTree && (this.docId === versionId || versionId === null)) {
+            return [{ id: "latest", treeId: FileStorageVersionTreeId }];
+        }
+        if (this.docId === undefined && versionId !== null) {
+            this.docId = versionId;
+        }
+        return super.getVersions(versionId, count);
+    }
+    // eslint-disable-next-line @rushstack/no-new-null
+    async getSnapshotTree(version) {
+        if (this.latestWriterTree && (!version || version.id === "latest")) {
+            return this.latestWriterTree;
+        }
+        return super.getSnapshotTree(version);
+    }
+    async uploadSummaryWithContext(summary, context) {
+        const tree = convertSummaryTreeToSnapshotITree(summary);
+        // Remove tree IDs for easier comparison of snapshots
+        delete tree.id;
+        removeNullTreeIds(tree);
+        this.latestWriterTree = buildSnapshotTree(tree.entries, this.blobsWriter);
+        const fileSnapshot = { tree, commits: {} };
+        this.onSnapshotHandler(fileSnapshot);
+        return "testHandleId";
+    }
+    async buildTree(snapshotTree) {
+        const tree = { entries: [] };
+        for (const subTreeId of Object.keys(snapshotTree.trees)) {
+            const subTree = await this.buildTree(snapshotTree.trees[subTreeId]);
+            tree.entries.push({
+                mode: api.FileMode.Directory,
+                path: subTreeId,
+                type: api.TreeEntry.Tree,
+                value: subTree,
+            });
+        }
+        for (const blobName of Object.keys(snapshotTree.blobs)) {
+            const buffer = await this.readBlob(snapshotTree.blobs[blobName]);
+            const contents = bufferToString(buffer, "utf8");
+            const blob = {
+                contents,
+                encoding: "utf-8",
+            };
+            tree.entries.push({
+                mode: api.FileMode.File,
+                path: blobName,
+                type: api.TreeEntry.Blob,
+                value: blob,
+            });
+        }
+        return tree;
+    }
+};
+function removeNullTreeIds(tree) {
+    for (const node of tree.entries) {
+        if (node.type === api.TreeEntry.Tree) {
+            removeNullTreeIds(node.value);
+        }
+    }
+    assert(tree.id === undefined || tree.id === null, 0x096 /* "Trying to remove valid tree IDs in removeNullTreeIds()!" */);
+    delete tree.id;
+}
+/**
+ * @internal
+ */
+export const FluidFetchReaderFileSnapshotWriter = FileSnapshotWriterClassFactory(FluidFetchReader);
+//# sourceMappingURL=fileDocumentStorageService.js.map

package/lib/fileDocumentStorageService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocumentStorageService.js","sourceRoot":"","sources":["../src/fileDocumentStorageService.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,iCAAiC,EAAE,MAAM,8BAA8B,CAAC;AACpG,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC;AAC5D,OAAO,EAAiB,8BAA8B,EAAE,MAAM,+BAA+B,CAAC;AAE9F,iDAAiD;AACjD,gFAAgF;AAChF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,kBAAkB,CAAC,CAAC,4BAA4B;AAEvF,8FAA8F;AAC9F,MAAM,wBAAwB,GAAG,mBAAmB,CAAC;AAErD;;;GAGG;AACH,MAAM,OAAO,gBACZ,SAAQ,8BAA8B;IAKtC,YACkB,IAAY,EACZ,WAAoB;QAErC,KAAK,EAAE,CAAC;QAHS,SAAI,GAAJ,IAAI,CAAQ;QACZ,gBAAW,GAAX,WAAW,CAAS;QAJ5B,YAAO,GAA6B,IAAI,CAAC;IAOnD,CAAC;IAED;;;OAGG;IACH,kDAAkD;IAC3C,KAAK,CAAC,eAAe,CAAC,OAAsB;QAClD,MAAM,CAAC,OAAO,KAAK,IAAI,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACzF,MAAM,CACL,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,wBAAwB,EACvD,KAAK,CAAC,wDAAwD,CAC9D,CAAC;QAEF,IAAI,QAAgB,CAAC;QACrB,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,EAAE,KAAK,QAAQ,EAAE;YACxC,IAAI,IAAI,CAAC,OAAO,EAAE;gBACjB,OAAO,IAAI,CAAC,OAAO,CAAC;aACpB;YACD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBACnC,OAAO,IAAI,CAAC;aACZ;YACD,QAAQ,GAAG,IAAI,CAAC;YAChB,QAAQ,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,YAAY,CAAC;SACxD;aAAM;YACN,QAAQ,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,EAAE,OAAO,CAAC;SACjE;QAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,mBAAmB,QAAQ,EAAE,CAAC,CAAC;SAC/C;QACD,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAChD,IAAI,QAAQ,EAAE;YACb,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;SACpB;QACD,+DAA+D;QAC/D,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,kDAAkD;IAC3C,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa;QAC/D,IAAI,SAAS,KAAK,uBAAuB,IAAI,SAAS,KAAK,IAAI,EAAE;YAChE,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAC5D,OAAO,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAC,CAAC;aAC5D;YACD,uCAAuC;YACvC,OAAO,EAAE,CAAC;SACV;aAAM,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAC1C,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAC7D,OAAO;gBACN;oBACC,EAAE,EAAE,SAAS;oBACb,MAAM,EAAE,wBAAwB;iBAChC;aACD,CAAC;SACF;QACD,MAAM,IAAI,KAAK,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,GAAW;QAChC,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YACnC,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,IAAI,GAAG,EAAE,CAAC;YAC3D,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAC5B,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBACvC,OAAO,IAAI,CAAC;aACZ;SACD;QACD,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;IAC3C,CAAC;CACD;AAcD;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAkC,IAAW,EAAE,EAAE,CAC9F,KAAM,SAAQ,IAAI;IAAlB;;QACC,0EAA0E;QACnE,gBAAW,GAAG,IAAI,GAAG,EAA2B,CAAC;IA+FzD,CAAC;IA3FO,KAAK;QACX,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAA2B,CAAC;QACtD,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IACxB,CAAC;IAEM,iBAAiB,CAAC,QAAuB;QAC/C,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;IACjF,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,GAAW;QAChC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,IAAI,KAAK,SAAS,EAAE;YACvB,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,WAAW,CAAC,SAAwB,EAAE,KAAa;QAC/D,+FAA+F;QAC/F,4FAA4F;QAC5F,6BAA6B;QAC7B,2GAA2G;QAC3G,4BAA4B;QAC5B,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC,EAAE;YAC9E,OAAO,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAC,CAAC;SAC5D;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,SAAS,KAAK,IAAI,EAAE;YACnD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;SACvB;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,eAAe,CAAC,OAAsB;QAClD,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE;YACnE,OAAO,IAAI,CAAC,gBAAgB,CAAC;SAC7B;QACD,OAAO,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACpC,OAAyB,EACzB,OAAwB;QAExB,MAAM,IAAI,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC;QAExD,qDAAqD;QACrD,OAAO,IAAI,CAAC,EAAE,CAAC;QACf,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAExB,IAAI,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAE1E,MAAM,YAAY,GAAkB,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAC1D,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;QACrC,OAAO,cAAc,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,YAA+B;QACrD,MAAM,IAAI,GAAc,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAExC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;YACxD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;YACpE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;gBACjB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,SAAS;gBAC5B,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,IAAI;gBACxB,KAAK,EAAE,OAAO;aACd,CAAC,CAAC;SACH;QAED,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;YACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;YACjE,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAChD,MAAM,IAAI,GAAc;gBACvB,QAAQ;gBACR,QAAQ,EAAE,OAAO;aACjB,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;gBACjB,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI;gBACvB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,IAAI;gBACxB,KAAK,EAAE,IAAI;aACX,CAAC,CAAC;SACH;QAED,OAAO,IAAI,CAAC;IACb,CAAC;CACD,CAAC;AAEH,SAAS,iBAAiB,CAAC,IAAe;IACzC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE;QAChC,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE;YACrC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC9B;KACD;IACD,MAAM,CACL,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,EACzC,KAAK,CAAC,+DAA+D,CACrE,CAAC;IACF,OAAO,IAAI,CAAC,EAAE,CAAC;AAChB,CAAC;AACD;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,8BAA8B,CAAC,gBAAgB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport fs from \"fs\";\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { IDocumentStorageService, ISummaryContext } from \"@fluidframework/driver-definitions\";\nimport { buildSnapshotTree, convertSummaryTreeToSnapshotITree } from \"@fluidframework/driver-utils\";\nimport * as api from \"@fluidframework/protocol-definitions\";\nimport { IFileSnapshot, ReadDocumentStorageServiceBase } from \"@fluidframework/replay-driver\";\n\n// This ID is used by replay tool as Document Id.\n// We leverage it to figure out when container is asking for root document tree.\n/**\n * @internal\n */\nexport const FileStorageDocumentName = \"FileStorageDocId\"; // Some unique document name\n\n// Tree ID use to communicate between getVersions() & getSnapshotTree() that IVersion is ours.\nconst FileStorageVersionTreeId = \"FileStorageTreeId\";\n\n/**\n * Document storage service for the file driver.\n * @internal\n */\nexport class FluidFetchReader\n\textends ReadDocumentStorageServiceBase\n\timplements IDocumentStorageService\n{\n\tprotected docTree: api.ISnapshotTree | null = null;\n\n\tconstructor(\n\t\tprivate readonly path: string,\n\t\tprivate readonly versionName?: string,\n\t) {\n\t\tsuper();\n\t}\n\n\t/**\n\t * Read the file and returns the snapshot tree.\n\t * @param version - The version contains the path of the file which contains the snapshot tree.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tpublic async getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null> {\n\t\tassert(version !== null, 0x092 /* \"version input for reading snapshot tree is null!\" */);\n\t\tassert(\n\t\t\t!version || version.treeId === FileStorageVersionTreeId,\n\t\t\t0x093 /* \"invalid version input for reading snapshot tree!\" */,\n\t\t);\n\n\t\tlet filename: string;\n\t\tlet rootTree = false;\n\t\tif (!version || version.id === \"latest\") {\n\t\t\tif (this.docTree) {\n\t\t\t\treturn this.docTree;\n\t\t\t}\n\t\t\tif (this.versionName === undefined) {\n\t\t\t\treturn null;\n\t\t\t}\n\t\t\trootTree = true;\n\t\t\tfilename = `${this.path}/${this.versionName}/tree.json`;\n\t\t} else {\n\t\t\tfilename = `${this.path}/${this.versionName}/${version.id}.json`;\n\t\t}\n\n\t\tif (!fs.existsSync(filename)) {\n\t\t\tthrow new Error(`Can't find file ${filename}`);\n\t\t}\n\t\tconst data = fs.readFileSync(filename);\n\t\tconst tree = JSON.parse(data.toString(\"utf-8\"));\n\t\tif (rootTree) {\n\t\t\tthis.docTree = tree;\n\t\t}\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\treturn tree;\n\t}\n\n\t/**\n\t * Gets the path of the snapshot tree to be read.\n\t * @param versionId - version ID.\n\t * @param count - Number of versions to be returned.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tpublic async getVersions(versionId: string | null, count: number): Promise<api.IVersion[]> {\n\t\tif (versionId === FileStorageDocumentName || versionId === null) {\n\t\t\tif (this.docTree !== null || this.versionName !== undefined) {\n\t\t\t\treturn [{ id: \"latest\", treeId: FileStorageVersionTreeId }];\n\t\t\t}\n\t\t\t// Started with ops - return empty set.\n\t\t\treturn [];\n\t\t} else if (this.versionName !== undefined) {\n\t\t\tassert(!!this.docTree, 0x094 /* \"Missing snapshot tree!\" */);\n\t\t\treturn [\n\t\t\t\t{\n\t\t\t\t\tid: versionId,\n\t\t\t\t\ttreeId: FileStorageVersionTreeId,\n\t\t\t\t},\n\t\t\t];\n\t\t}\n\t\tthrow new Error(`Unknown version: ${versionId}`);\n\t}\n\n\tpublic async readBlob(sha: string): Promise<ArrayBufferLike> {\n\t\tif (this.versionName !== undefined) {\n\t\t\tconst fileName = `${this.path}/${this.versionName}/${sha}`;\n\t\t\tif (fs.existsSync(fileName)) {\n\t\t\t\tconst data = fs.readFileSync(fileName);\n\t\t\t\treturn data;\n\t\t\t}\n\t\t}\n\t\tthrow new Error(`Can't find blob ${sha}`);\n\t}\n}\n\n/**\n * @internal\n */\nexport interface ISnapshotWriterStorage extends IDocumentStorageService {\n\tonSnapshotHandler(snapshot: IFileSnapshot): void;\n\treset(): void;\n}\n\n/**\n * @internal\n */\nexport type ReaderConstructor = new (...args: any[]) => IDocumentStorageService;\n/**\n * @internal\n */\nexport const FileSnapshotWriterClassFactory = <TBase extends ReaderConstructor>(Base: TBase) =>\n\tclass extends Base implements ISnapshotWriterStorage {\n\t\t// Note: if variable name has same name as in base class, it overrides it!\n\t\tpublic blobsWriter = new Map<string, ArrayBufferLike>();\n\t\tpublic latestWriterTree?: api.ISnapshotTree;\n\t\tpublic docId?: string;\n\n\t\tpublic reset() {\n\t\t\tthis.blobsWriter = new Map<string, ArrayBufferLike>();\n\t\t\tthis.latestWriterTree = undefined;\n\t\t\tthis.docId = undefined;\n\t\t}\n\n\t\tpublic onSnapshotHandler(snapshot: IFileSnapshot): void {\n\t\t\tthrow new Error(\"onSnapshotHandler is not setup! Please provide your handler!\");\n\t\t}\n\n\t\tpublic async readBlob(sha: string): Promise<ArrayBufferLike> {\n\t\t\tconst blob = this.blobsWriter.get(sha);\n\t\t\tif (blob !== undefined) {\n\t\t\t\treturn blob;\n\t\t\t}\n\t\t\treturn super.readBlob(sha);\n\t\t}\n\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tpublic async getVersions(versionId: string | null, count: number): Promise<api.IVersion[]> {\n\t\t\t// If we already saved document, that means we are getting here because of snapshot generation.\n\t\t\t// Not returning tree ensures that ContainerRuntime.snapshot() would regenerate subtrees for\n\t\t\t// each unchanged data store.\n\t\t\t// If we want to change that, we would need to capture docId on first call and return this.latestWriterTree\n\t\t\t// when latest is requested.\n\t\t\tif (this.latestWriterTree && (this.docId === versionId || versionId === null)) {\n\t\t\t\treturn [{ id: \"latest\", treeId: FileStorageVersionTreeId }];\n\t\t\t}\n\n\t\t\tif (this.docId === undefined && versionId !== null) {\n\t\t\t\tthis.docId = versionId;\n\t\t\t}\n\n\t\t\treturn super.getVersions(versionId, count);\n\t\t}\n\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tpublic async getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null> {\n\t\t\tif (this.latestWriterTree && (!version || version.id === \"latest\")) {\n\t\t\t\treturn this.latestWriterTree;\n\t\t\t}\n\t\t\treturn super.getSnapshotTree(version);\n\t\t}\n\n\t\tpublic async uploadSummaryWithContext(\n\t\t\tsummary: api.ISummaryTree,\n\t\t\tcontext: ISummaryContext,\n\t\t): Promise<string> {\n\t\t\tconst tree = convertSummaryTreeToSnapshotITree(summary);\n\n\t\t\t// Remove tree IDs for easier comparison of snapshots\n\t\t\tdelete tree.id;\n\t\t\tremoveNullTreeIds(tree);\n\n\t\t\tthis.latestWriterTree = buildSnapshotTree(tree.entries, this.blobsWriter);\n\n\t\t\tconst fileSnapshot: IFileSnapshot = { tree, commits: {} };\n\t\t\tthis.onSnapshotHandler(fileSnapshot);\n\t\t\treturn \"testHandleId\";\n\t\t}\n\n\t\tpublic async buildTree(snapshotTree: api.ISnapshotTree): Promise<api.ITree> {\n\t\t\tconst tree: api.ITree = { entries: [] };\n\n\t\t\tfor (const subTreeId of Object.keys(snapshotTree.trees)) {\n\t\t\t\tconst subTree = await this.buildTree(snapshotTree.trees[subTreeId]);\n\t\t\t\ttree.entries.push({\n\t\t\t\t\tmode: api.FileMode.Directory,\n\t\t\t\t\tpath: subTreeId,\n\t\t\t\t\ttype: api.TreeEntry.Tree,\n\t\t\t\t\tvalue: subTree,\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tfor (const blobName of Object.keys(snapshotTree.blobs)) {\n\t\t\t\tconst buffer = await this.readBlob(snapshotTree.blobs[blobName]);\n\t\t\t\tconst contents = bufferToString(buffer, \"utf8\");\n\t\t\t\tconst blob: api.IBlob = {\n\t\t\t\t\tcontents,\n\t\t\t\t\tencoding: \"utf-8\",\n\t\t\t\t};\n\t\t\t\ttree.entries.push({\n\t\t\t\t\tmode: api.FileMode.File,\n\t\t\t\t\tpath: blobName,\n\t\t\t\t\ttype: api.TreeEntry.Blob,\n\t\t\t\t\tvalue: blob,\n\t\t\t\t});\n\t\t\t}\n\n\t\t\treturn tree;\n\t\t}\n\t};\n\nfunction removeNullTreeIds(tree: api.ITree) {\n\tfor (const node of tree.entries) {\n\t\tif (node.type === api.TreeEntry.Tree) {\n\t\t\tremoveNullTreeIds(node.value);\n\t\t}\n\t}\n\tassert(\n\t\ttree.id === undefined || tree.id === null,\n\t\t0x096 /* \"Trying to remove valid tree IDs in removeNullTreeIds()!\" */,\n\t);\n\tdelete tree.id;\n}\n/**\n * @internal\n */\nexport const FluidFetchReaderFileSnapshotWriter = FileSnapshotWriterClassFactory(FluidFetchReader);\n"]}

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { FileDeltaStorageService } from "./fileDeltaStorageService.js";
+export { FileDocumentServiceFactory } from "./fileDocumentServiceFactory.js";
+export { Replayer, ReplayFileDeltaConnection } from "./fileDocumentDeltaConnection.js";
+export { FileSnapshotWriterClassFactory, FileStorageDocumentName, FluidFetchReader, FluidFetchReaderFileSnapshotWriter, ISnapshotWriterStorage, ReaderConstructor, } from "./fileDocumentStorageService.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACN,8BAA8B,EAC9B,uBAAuB,EACvB,gBAAgB,EAChB,kCAAkC,EAClC,sBAAsB,EACtB,iBAAiB,GACjB,MAAM,iCAAiC,CAAC"}

package/lib/index.js

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { FileDeltaStorageService } from "./fileDeltaStorageService.js";
+export { FileDocumentServiceFactory } from "./fileDocumentServiceFactory.js";
+export { Replayer, ReplayFileDeltaConnection } from "./fileDocumentDeltaConnection.js";
+export { FileSnapshotWriterClassFactory, FileStorageDocumentName, FluidFetchReader, FluidFetchReaderFileSnapshotWriter, } from "./fileDocumentStorageService.js";
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACN,8BAA8B,EAC9B,uBAAuB,EACvB,gBAAgB,EAChB,kCAAkC,GAGlC,MAAM,iCAAiC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { FileDeltaStorageService } from \"./fileDeltaStorageService.js\";\nexport { FileDocumentServiceFactory } from \"./fileDocumentServiceFactory.js\";\nexport { Replayer, ReplayFileDeltaConnection } from \"./fileDocumentDeltaConnection.js\";\nexport {\n\tFileSnapshotWriterClassFactory,\n\tFileStorageDocumentName,\n\tFluidFetchReader,\n\tFluidFetchReaderFileSnapshotWriter,\n\tISnapshotWriterStorage,\n\tReaderConstructor,\n} from \"./fileDocumentStorageService.js\";\n"]}

package/lib/test/types/validateFileDriverPrevious.generated.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validateFileDriverPrevious.generated.d.ts.map

package/lib/test/types/validateFileDriverPrevious.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateFileDriverPrevious.generated.d.ts","sourceRoot":"","sources":["../../../src/test/types/validateFileDriverPrevious.generated.ts"],"names":[],"mappings":""}

package/lib/test/types/validateFileDriverPrevious.generated.js

@@ -0,0 +1,26 @@
+use_current_ClassDeclaration_FileDeltaStorageService(get_old_ClassDeclaration_FileDeltaStorageService());
+use_old_ClassDeclaration_FileDeltaStorageService(get_current_ClassDeclaration_FileDeltaStorageService());
+use_current_ClassDeclaration_FileDocumentServiceFactory(get_old_ClassDeclaration_FileDocumentServiceFactory());
+use_old_ClassDeclaration_FileDocumentServiceFactory(get_current_ClassDeclaration_FileDocumentServiceFactory());
+use_current_VariableDeclaration_FileSnapshotWriterClassFactory(get_old_VariableDeclaration_FileSnapshotWriterClassFactory());
+use_old_VariableDeclaration_FileSnapshotWriterClassFactory(get_current_VariableDeclaration_FileSnapshotWriterClassFactory());
+use_current_VariableDeclaration_FileStorageDocumentName(get_old_VariableDeclaration_FileStorageDocumentName());
+use_old_VariableDeclaration_FileStorageDocumentName(get_current_VariableDeclaration_FileStorageDocumentName());
+use_current_ClassDeclaration_FluidFetchReader(get_old_ClassDeclaration_FluidFetchReader());
+use_old_ClassDeclaration_FluidFetchReader(
+// @ts-expect-error compatibility expected to be broken
+get_current_ClassDeclaration_FluidFetchReader());
+use_current_VariableDeclaration_FluidFetchReaderFileSnapshotWriter(get_old_VariableDeclaration_FluidFetchReaderFileSnapshotWriter());
+use_old_VariableDeclaration_FluidFetchReaderFileSnapshotWriter(get_current_VariableDeclaration_FluidFetchReaderFileSnapshotWriter());
+use_current_InterfaceDeclaration_ISnapshotWriterStorage(get_old_InterfaceDeclaration_ISnapshotWriterStorage());
+use_old_InterfaceDeclaration_ISnapshotWriterStorage(
+// @ts-expect-error compatibility expected to be broken
+get_current_InterfaceDeclaration_ISnapshotWriterStorage());
+use_current_TypeAliasDeclaration_ReaderConstructor(get_old_TypeAliasDeclaration_ReaderConstructor());
+use_old_TypeAliasDeclaration_ReaderConstructor(get_current_TypeAliasDeclaration_ReaderConstructor());
+use_current_ClassDeclaration_ReplayFileDeltaConnection(get_old_ClassDeclaration_ReplayFileDeltaConnection());
+use_old_ClassDeclaration_ReplayFileDeltaConnection(get_current_ClassDeclaration_ReplayFileDeltaConnection());
+use_current_ClassDeclaration_Replayer(get_old_ClassDeclaration_Replayer());
+use_old_ClassDeclaration_Replayer(get_current_ClassDeclaration_Replayer());
+export {};
+//# sourceMappingURL=validateFileDriverPrevious.generated.js.map

package/lib/test/types/validateFileDriverPrevious.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateFileDriverPrevious.generated.js","sourceRoot":"","sources":["../../../src/test/types/validateFileDriverPrevious.generated.ts"],"names":[],"mappings":"AAgCA,oDAAoD,CAChD,gDAAgD,EAAE,CAAC,CAAC;AAWxD,gDAAgD,CAC5C,oDAAoD,EAAE,CAAC,CAAC;AAW5D,uDAAuD,CACnD,mDAAmD,EAAE,CAAC,CAAC;AAW3D,mDAAmD,CAC/C,uDAAuD,EAAE,CAAC,CAAC;AAW/D,8DAA8D,CAC1D,0DAA0D,EAAE,CAAC,CAAC;AAWlE,0DAA0D,CACtD,8DAA8D,EAAE,CAAC,CAAC;AAWtE,uDAAuD,CACnD,mDAAmD,EAAE,CAAC,CAAC;AAW3D,mDAAmD,CAC/C,uDAAuD,EAAE,CAAC,CAAC;AAW/D,6CAA6C,CACzC,yCAAyC,EAAE,CAAC,CAAC;AAWjD,yCAAyC;AACrC,uDAAuD;AACvD,6CAA6C,EAAE,CAAC,CAAC;AAWrD,kEAAkE,CAC9D,8DAA8D,EAAE,CAAC,CAAC;AAWtE,8DAA8D,CAC1D,kEAAkE,EAAE,CAAC,CAAC;AAW1E,uDAAuD,CACnD,mDAAmD,EAAE,CAAC,CAAC;AAW3D,mDAAmD;AAC/C,uDAAuD;AACvD,uDAAuD,EAAE,CAAC,CAAC;AAW/D,kDAAkD,CAC9C,8CAA8C,EAAE,CAAC,CAAC;AAWtD,8CAA8C,CAC1C,kDAAkD,EAAE,CAAC,CAAC;AAW1D,sDAAsD,CAClD,kDAAkD,EAAE,CAAC,CAAC;AAW1D,kDAAkD,CAC9C,sDAAsD,EAAE,CAAC,CAAC;AAW9D,qCAAqC,CACjC,iCAAiC,EAAE,CAAC,CAAC;AAWzC,iCAAiC,CAC7B,qCAAqC,EAAE,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/*\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.\n * Generated by fluid-type-test-generator in @fluidframework/build-tools.\n */\nimport type * as old from \"@fluidframework/file-driver-previous\";\nimport type * as current from \"../../index.js\";\n\n\n// See 'build-tools/src/type-test-generator/compatibility.ts' for more information.\ntype TypeOnly<T> = T extends number\n\t? number\n\t: T extends string\n\t? string\n\t: T extends boolean | bigint | symbol\n\t? T\n\t: {\n\t\t\t[P in keyof T]: TypeOnly<T[P]>;\n\t  };\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_FileDeltaStorageService\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_FileDeltaStorageService():\n    TypeOnly<old.FileDeltaStorageService>;\ndeclare function use_current_ClassDeclaration_FileDeltaStorageService(\n    use: TypeOnly<current.FileDeltaStorageService>): void;\nuse_current_ClassDeclaration_FileDeltaStorageService(\n    get_old_ClassDeclaration_FileDeltaStorageService());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_FileDeltaStorageService\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_FileDeltaStorageService():\n    TypeOnly<current.FileDeltaStorageService>;\ndeclare function use_old_ClassDeclaration_FileDeltaStorageService(\n    use: TypeOnly<old.FileDeltaStorageService>): void;\nuse_old_ClassDeclaration_FileDeltaStorageService(\n    get_current_ClassDeclaration_FileDeltaStorageService());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_FileDocumentServiceFactory\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_FileDocumentServiceFactory():\n    TypeOnly<old.FileDocumentServiceFactory>;\ndeclare function use_current_ClassDeclaration_FileDocumentServiceFactory(\n    use: TypeOnly<current.FileDocumentServiceFactory>): void;\nuse_current_ClassDeclaration_FileDocumentServiceFactory(\n    get_old_ClassDeclaration_FileDocumentServiceFactory());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_FileDocumentServiceFactory\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_FileDocumentServiceFactory():\n    TypeOnly<current.FileDocumentServiceFactory>;\ndeclare function use_old_ClassDeclaration_FileDocumentServiceFactory(\n    use: TypeOnly<old.FileDocumentServiceFactory>): void;\nuse_old_ClassDeclaration_FileDocumentServiceFactory(\n    get_current_ClassDeclaration_FileDocumentServiceFactory());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"VariableDeclaration_FileSnapshotWriterClassFactory\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_VariableDeclaration_FileSnapshotWriterClassFactory():\n    TypeOnly<typeof old.FileSnapshotWriterClassFactory>;\ndeclare function use_current_VariableDeclaration_FileSnapshotWriterClassFactory(\n    use: TypeOnly<typeof current.FileSnapshotWriterClassFactory>): void;\nuse_current_VariableDeclaration_FileSnapshotWriterClassFactory(\n    get_old_VariableDeclaration_FileSnapshotWriterClassFactory());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"VariableDeclaration_FileSnapshotWriterClassFactory\": {\"backCompat\": false}\n*/\ndeclare function get_current_VariableDeclaration_FileSnapshotWriterClassFactory():\n    TypeOnly<typeof current.FileSnapshotWriterClassFactory>;\ndeclare function use_old_VariableDeclaration_FileSnapshotWriterClassFactory(\n    use: TypeOnly<typeof old.FileSnapshotWriterClassFactory>): void;\nuse_old_VariableDeclaration_FileSnapshotWriterClassFactory(\n    get_current_VariableDeclaration_FileSnapshotWriterClassFactory());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"VariableDeclaration_FileStorageDocumentName\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_VariableDeclaration_FileStorageDocumentName():\n    TypeOnly<typeof old.FileStorageDocumentName>;\ndeclare function use_current_VariableDeclaration_FileStorageDocumentName(\n    use: TypeOnly<typeof current.FileStorageDocumentName>): void;\nuse_current_VariableDeclaration_FileStorageDocumentName(\n    get_old_VariableDeclaration_FileStorageDocumentName());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"VariableDeclaration_FileStorageDocumentName\": {\"backCompat\": false}\n*/\ndeclare function get_current_VariableDeclaration_FileStorageDocumentName():\n    TypeOnly<typeof current.FileStorageDocumentName>;\ndeclare function use_old_VariableDeclaration_FileStorageDocumentName(\n    use: TypeOnly<typeof old.FileStorageDocumentName>): void;\nuse_old_VariableDeclaration_FileStorageDocumentName(\n    get_current_VariableDeclaration_FileStorageDocumentName());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_FluidFetchReader\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_FluidFetchReader():\n    TypeOnly<old.FluidFetchReader>;\ndeclare function use_current_ClassDeclaration_FluidFetchReader(\n    use: TypeOnly<current.FluidFetchReader>): void;\nuse_current_ClassDeclaration_FluidFetchReader(\n    get_old_ClassDeclaration_FluidFetchReader());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_FluidFetchReader\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_FluidFetchReader():\n    TypeOnly<current.FluidFetchReader>;\ndeclare function use_old_ClassDeclaration_FluidFetchReader(\n    use: TypeOnly<old.FluidFetchReader>): void;\nuse_old_ClassDeclaration_FluidFetchReader(\n    // @ts-expect-error compatibility expected to be broken\n    get_current_ClassDeclaration_FluidFetchReader());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"VariableDeclaration_FluidFetchReaderFileSnapshotWriter\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_VariableDeclaration_FluidFetchReaderFileSnapshotWriter():\n    TypeOnly<typeof old.FluidFetchReaderFileSnapshotWriter>;\ndeclare function use_current_VariableDeclaration_FluidFetchReaderFileSnapshotWriter(\n    use: TypeOnly<typeof current.FluidFetchReaderFileSnapshotWriter>): void;\nuse_current_VariableDeclaration_FluidFetchReaderFileSnapshotWriter(\n    get_old_VariableDeclaration_FluidFetchReaderFileSnapshotWriter());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"VariableDeclaration_FluidFetchReaderFileSnapshotWriter\": {\"backCompat\": false}\n*/\ndeclare function get_current_VariableDeclaration_FluidFetchReaderFileSnapshotWriter():\n    TypeOnly<typeof current.FluidFetchReaderFileSnapshotWriter>;\ndeclare function use_old_VariableDeclaration_FluidFetchReaderFileSnapshotWriter(\n    use: TypeOnly<typeof old.FluidFetchReaderFileSnapshotWriter>): void;\nuse_old_VariableDeclaration_FluidFetchReaderFileSnapshotWriter(\n    get_current_VariableDeclaration_FluidFetchReaderFileSnapshotWriter());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"InterfaceDeclaration_ISnapshotWriterStorage\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_InterfaceDeclaration_ISnapshotWriterStorage():\n    TypeOnly<old.ISnapshotWriterStorage>;\ndeclare function use_current_InterfaceDeclaration_ISnapshotWriterStorage(\n    use: TypeOnly<current.ISnapshotWriterStorage>): void;\nuse_current_InterfaceDeclaration_ISnapshotWriterStorage(\n    get_old_InterfaceDeclaration_ISnapshotWriterStorage());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"InterfaceDeclaration_ISnapshotWriterStorage\": {\"backCompat\": false}\n*/\ndeclare function get_current_InterfaceDeclaration_ISnapshotWriterStorage():\n    TypeOnly<current.ISnapshotWriterStorage>;\ndeclare function use_old_InterfaceDeclaration_ISnapshotWriterStorage(\n    use: TypeOnly<old.ISnapshotWriterStorage>): void;\nuse_old_InterfaceDeclaration_ISnapshotWriterStorage(\n    // @ts-expect-error compatibility expected to be broken\n    get_current_InterfaceDeclaration_ISnapshotWriterStorage());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"TypeAliasDeclaration_ReaderConstructor\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_TypeAliasDeclaration_ReaderConstructor():\n    TypeOnly<old.ReaderConstructor>;\ndeclare function use_current_TypeAliasDeclaration_ReaderConstructor(\n    use: TypeOnly<current.ReaderConstructor>): void;\nuse_current_TypeAliasDeclaration_ReaderConstructor(\n    get_old_TypeAliasDeclaration_ReaderConstructor());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"TypeAliasDeclaration_ReaderConstructor\": {\"backCompat\": false}\n*/\ndeclare function get_current_TypeAliasDeclaration_ReaderConstructor():\n    TypeOnly<current.ReaderConstructor>;\ndeclare function use_old_TypeAliasDeclaration_ReaderConstructor(\n    use: TypeOnly<old.ReaderConstructor>): void;\nuse_old_TypeAliasDeclaration_ReaderConstructor(\n    get_current_TypeAliasDeclaration_ReaderConstructor());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_ReplayFileDeltaConnection\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_ReplayFileDeltaConnection():\n    TypeOnly<old.ReplayFileDeltaConnection>;\ndeclare function use_current_ClassDeclaration_ReplayFileDeltaConnection(\n    use: TypeOnly<current.ReplayFileDeltaConnection>): void;\nuse_current_ClassDeclaration_ReplayFileDeltaConnection(\n    get_old_ClassDeclaration_ReplayFileDeltaConnection());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_ReplayFileDeltaConnection\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_ReplayFileDeltaConnection():\n    TypeOnly<current.ReplayFileDeltaConnection>;\ndeclare function use_old_ClassDeclaration_ReplayFileDeltaConnection(\n    use: TypeOnly<old.ReplayFileDeltaConnection>): void;\nuse_old_ClassDeclaration_ReplayFileDeltaConnection(\n    get_current_ClassDeclaration_ReplayFileDeltaConnection());\n\n/*\n* Validate forward compat by using old type in place of current type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_Replayer\": {\"forwardCompat\": false}\n*/\ndeclare function get_old_ClassDeclaration_Replayer():\n    TypeOnly<old.Replayer>;\ndeclare function use_current_ClassDeclaration_Replayer(\n    use: TypeOnly<current.Replayer>): void;\nuse_current_ClassDeclaration_Replayer(\n    get_old_ClassDeclaration_Replayer());\n\n/*\n* Validate back compat by using current type in place of old type\n* If breaking change required, add in package.json under typeValidation.broken:\n* \"ClassDeclaration_Replayer\": {\"backCompat\": false}\n*/\ndeclare function get_current_ClassDeclaration_Replayer():\n    TypeOnly<current.Replayer>;\ndeclare function use_old_ClassDeclaration_Replayer(\n    use: TypeOnly<old.Replayer>): void;\nuse_old_ClassDeclaration_Replayer(\n    get_current_ClassDeclaration_Replayer());\n"]}