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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/replay-driver",
-  "version": "1.4.0-115997",
+  "version": "2.0.0-dev-rc.1.0.0.224419",
   "description": "Document replay version of Socket.IO implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,58 +11,90 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "lib/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:compile": "concurrently npm:typetests:gen npm:tsc npm:build:esnext",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "build:genver": "gen-version",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "tsc": "tsc",
-    "typetests:gen": "flub generate typetests --generate --dir . --no-generateInName",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
   },
+  "main": "dist/index.cjs",
+  "module": "lib/index.mjs",
+  "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/driver-definitions": "1.4.0-115997",
-    "@fluidframework/driver-utils": "1.4.0-115997",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/telemetry-utils": "1.4.0-115997"
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.224419",
+    "@fluidframework/protocol-definitions": "^3.1.0-223007",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.1.0.0.224419"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.6.0-110101",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/replay-driver-previous": "npm:@fluidframework/replay-driver@1.3.1",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
-    "@types/mocha": "^9.1.1",
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "0.29.0-222379",
+    "@fluidframework/eslint-config-fluid": "^3.1.0",
+    "@fluidframework/replay-driver-previous": "npm:@fluidframework/replay-driver@2.0.0-internal.7.2.0",
+    "@microsoft/api-extractor": "^7.38.3",
     "@types/nock": "^9.3.0",
-    "@types/node": "^14.18.0",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
-    "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nock": "^10.0.1",
-    "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "@types/node": "^18.19.0",
+    "copyfiles": "^2.4.1",
+    "eslint": "~8.50.0",
+    "nock": "^13.3.3",
+    "prettier": "~3.0.3",
+    "renamer": "^4.0.0",
+    "rimraf": "^4.4.0",
+    "tsc-multi": "^1.1.0",
+    "typescript": "~5.1.6"
+  },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      },
+      "tsc": [
+        "...",
+        "typetests:gen"
+      ]
+    }
   },
   "typeValidation": {
-    "version": "1.4.0",
-    "baselineRange": "~1.3.0",
-    "baselineVersion": "1.3.1",
     "broken": {}
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:esnext": "copyfiles -u 1 \"dist/**/*-@(alpha|beta|public|untrimmed).d.ts\" lib",
+    "build": "fluid-build . --task build",
+    "build:compile": "fluid-build . --task compile",
+    "build:docs": "fluid-build . --task api",
+    "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
+    "build:rename-types": "renamer \"lib/**\" -f .d.ts -r .d.mts --force",
+    "check:are-the-types-wrong": "attw --pack",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "ci:build:docs": "api-extractor run",
+    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "tsc": "tsc-multi --config ../../../common/build/build-common/tsc-multi.cjs.json",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
-}
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/emptyDeltaStorageService.ts

@@ -8,17 +8,18 @@ import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions"
 import { emptyMessageStream } from "@fluidframework/driver-utils";
 
 export class EmptyDeltaStorageService implements IDocumentDeltaStorageService {
-    /**
-     * Returns ops from the list of ops generated till now.
-     * @param from - Ops are returned from + 1.
-     * @param to - Op are returned from to - 1.
-     * @returns Array of ops requested by the user.
-     */
-    public fetchMessages(
-        from: number,
-        to: number | undefined,
-        abortSignal?: AbortSignal,
-        cachedOnly?: boolean): IStream<ISequencedDocumentMessage[]> {
-        return emptyMessageStream;
-    }
+	/**
+	 * Returns ops from the list of ops generated till now.
+	 * @param from - Ops are returned from + 1.
+	 * @param to - Op are returned from to - 1.
+	 * @returns Array of ops requested by the user.
+	 */
+	public fetchMessages(
+		from: number,
+		to: number | undefined,
+		abortSignal?: AbortSignal,
+		cachedOnly?: boolean,
+	): IStream<ISequencedDocumentMessage[]> {
+		return emptyMessageStream;
+	}
 }

package/src/index.ts

@@ -3,7 +3,13 @@
  * Licensed under the MIT License.
  */
 
-export * from "./replayController";
-export * from "./replayDocumentService";
-export * from "./replayDocumentServiceFactory";
-export * from "./storageImplementations";
+export { ReadDocumentStorageServiceBase, ReplayController } from "./replayController";
+export { ReplayDocumentService } from "./replayDocumentService";
+export { ReplayDocumentServiceFactory } from "./replayDocumentServiceFactory";
+export {
+	FileSnapshotReader,
+	IFileSnapshot,
+	OpStorage,
+	SnapshotStorage,
+	StaticStorageDocumentServiceFactory,
+} from "./storageImplementations";

package/src/replayController.ts

@@ -4,82 +4,88 @@
  */
 
 import {
-    IDocumentService,
-    IDocumentStorageService,
-    ISummaryContext,
+	IDocumentService,
+	IDocumentStorageService,
+	ISummaryContext,
 } from "@fluidframework/driver-definitions";
 import * as api from "@fluidframework/protocol-definitions";
 
 /**
  * Partial implementation of IDocumentStorageService
+ * @internal
  */
 export abstract class ReadDocumentStorageServiceBase implements IDocumentStorageService {
-    public abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
-    public abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
-    public abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
+	public abstract getVersions(versionId: string | null, count: number): Promise<api.IVersion[]>;
+	public abstract getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;
+	public abstract readBlob(blobId: string): Promise<ArrayBufferLike>;
 
-    public async uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string> {
-        return Promise.reject(new Error("Invalid operation"));
-    }
+	public async uploadSummaryWithContext(
+		summary: api.ISummaryTree,
+		context: ISummaryContext,
+	): Promise<string> {
+		throw new Error("Invalid operation");
+	}
 
-    public async createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse> {
-        return Promise.reject(new Error("Invalid operation"));
-    }
+	public async createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse> {
+		throw new Error("Invalid operation");
+	}
 
-    public async downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree> {
-        return Promise.reject(new Error("Invalid operation"));
-    }
+	public async downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree> {
+		throw new Error("Invalid operation");
+	}
 
-    public get repositoryUrl(): string {
-        throw new Error("Invalid operation");
-    }
+	public get repositoryUrl(): string {
+		throw new Error("Invalid operation");
+	}
 }
 
 /**
  * Replay controller object
  * It controls where we start (snapshot, local file, no snapshots)
  * As well as dispatch of ops
+ * @internal
  */
 export abstract class ReplayController extends ReadDocumentStorageServiceBase {
-    /**
-     * Initialize reply controller
-     * @param documentService - the real document service
-     * @returns - Boolean, indicating if controller should be used.
-     * If false is returned, caller should fallback to original storage.
-     */
-    public abstract initStorage(documentService: IDocumentService): Promise<boolean>;
+	/**
+	 * Initialize reply controller
+	 * @param documentService - the real document service
+	 * @returns Whether or not the controller should be used.
+	 * If `false` is returned, caller should fallback to original storage.
+	 */
+	public abstract initStorage(documentService: IDocumentService): Promise<boolean>;
 
-    /**
-     * Returns sequence number to start processing ops
-     * Should be zero if not using snapshot, and snapshot seq# otherwise
-     */
-    public abstract getStartingOpSequence(): Promise<number>;
+	/**
+	 * Returns sequence number to start processing ops
+	 * Should be zero if not using snapshot, and snapshot seq# otherwise
+	 */
+	public abstract getStartingOpSequence(): Promise<number>;
 
-    /**
-     * Returns last op number to fetch from current op
-     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
-     * @param currentOp - current op
-     */
-    public abstract fetchTo(currentOp: number): number | undefined;
+	/**
+	 * Returns last op number to fetch from current op
+	 * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+	 * @param currentOp - current op
+	 */
+	public abstract fetchTo(currentOp: number): number | undefined;
 
-    /**
-     * Returns true if no more ops should be processed (or downloaded for future processing).
-     * It's called at end of each batch with latest op timestamp.
-     * Also it's called when there are no more ops available (lastTimeStamp === undefined).
-     * If false is returned and there are no more ops, request for more ops is made every 2 seconds.
-     * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
-     * @param currentOp - current op
-     * @param lastTimeStamp - timestamp of last op (if more ops are available). Undefined otherwise.
-     */
-    public abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
+	/**
+	 * Returns true if no more ops should be processed (or downloaded for future processing).
+	 * It's called at end of each batch with latest op timestamp.
+	 * Also it's called when there are no more ops available (lastTimeStamp === undefined).
+	 * If false is returned and there are no more ops, request for more ops is made every 2 seconds.
+	 * Note: this API is called while replay() is in progress - next batch of ops is downloaded in parallel
+	 * @param currentOp - current op
+	 * @param lastTimeStamp - timestamp of last op (if more ops are available). Undefined otherwise.
+	 */
+	public abstract isDoneFetch(currentOp: number, lastTimeStamp?: number): boolean;
 
-    /**
-     * Replay batch of ops
-     * NOTE: new batch of ops is fetched (fetchTo() & isDoneFetch() APIs are called) while this call is in flights
-     * @param emitter - callback to emit ops
-     * @param fetchedOps - ops to process
-     */
-    public abstract replay(
-        emitter: (op: api.ISequencedDocumentMessage[]) => void,
-        fetchedOps: api.ISequencedDocumentMessage[]): Promise<void>;
+	/**
+	 * Replay batch of ops
+	 * NOTE: new batch of ops is fetched (fetchTo() & isDoneFetch() APIs are called) while this call is in flights
+	 * @param emitter - callback to emit ops
+	 * @param fetchedOps - ops to process
+	 */
+	public abstract replay(
+		emitter: (op: api.ISequencedDocumentMessage[]) => void,
+		fetchedOps: api.ISequencedDocumentMessage[],
+	): Promise<void>;
 }