@fluidframework/routerlicious-driver 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/routerlicious-driver",
-  "version": "1.4.0-121020",
+  "version": "2.0.0-dev-rc.1.0.0.225277",
   "description": "Socket.IO + Git implementation of Fluid service API",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,44 +11,72 @@
   "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:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "build:compile": "concurrently npm:build:commonjs 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",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "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",
-    "test": "npm run test:mocha",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
-    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "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"
+      }
+    },
+    "./alpha": {
+      "import": {
+        "types": "./lib/routerlicious-driver-alpha.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/routerlicious-driver-alpha.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./beta": {
+      "import": {
+        "types": "./lib/routerlicious-driver-beta.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/routerlicious-driver-beta.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./public": {
+      "import": {
+        "types": "./lib/routerlicious-driver-public.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/routerlicious-driver-public.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
   },
-  "nyc": {
+  "main": "dist/index.cjs",
+  "module": "lib/index.mjs",
+  "types": "dist/index.d.ts",
+  "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
     "exclude": [
-      "src/test/**/*.ts",
-      "dist/test/**/*.js"
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js"
     ],
     "exclude-after-remap": false,
     "include": [
-      "src/**/*.ts",
-      "dist/**/*.js"
+      "src/**/*.*ts",
+      "dist/**/*.*js"
     ],
     "report-dir": "nyc/report",
     "reporter": [
@@ -59,51 +87,97 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/driver-base": "1.4.0-121020",
-    "@fluidframework/driver-definitions": "1.4.0-121020",
-    "@fluidframework/driver-utils": "1.4.0-121020",
-    "@fluidframework/gitresources": "^0.1036.5000",
-    "@fluidframework/protocol-base": "^0.1036.5000",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/server-services-client": "^0.1036.5000",
-    "@fluidframework/telemetry-utils": "1.4.0-121020",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/driver-base": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/gitresources": "^3.0.0-223236",
+    "@fluidframework/protocol-base": "^3.0.0-223236",
+    "@fluidframework/protocol-definitions": "^3.1.0-223007",
+    "@fluidframework/server-services-client": "^3.0.0-223236",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.1.0.0.225277",
     "cross-fetch": "^3.1.5",
     "json-stringify-safe": "5.0.1",
-    "querystring": "^0.2.0",
-    "socket.io-client": "^4.4.1",
+    "socket.io-client": "^4.6.1",
     "url-parse": "^1.5.8",
-    "uuid": "^8.3.1"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.6.0-110101",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "1.4.0-121020",
-    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@1.3.1",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.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/mocha-test-setup": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/routerlicious-driver-previous": "npm:@fluidframework/routerlicious-driver@2.0.0-internal.8.0.0",
+    "@microsoft/api-extractor": "^7.38.3",
     "@types/mocha": "^9.1.1",
     "@types/nock": "^9.3.0",
+    "@types/node": "^18.19.0",
+    "@types/sinon": "^7.0.13",
     "@types/url-parse": "1.4.4",
-    "@types/uuid": "^8.3.0",
-    "axios": "^0.26.0",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
-    "cross-env": "^7.0.2",
-    "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nock": "^10.0.1",
-    "nyc": "^15.0.0",
-    "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "@types/uuid": "^9.0.2",
+    "axios": "^1.6.2",
+    "c8": "^8.0.1",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "~8.50.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "nock": "^13.3.3",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
+    "sinon": "^7.4.2",
+    "tsc-multi": "^1.1.0",
+    "typescript": "~5.1.6"
+  },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
   },
   "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": "api-extractor run --config ./api-extractor-esm.json",
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "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:genver": "gen-version",
+    "build:test": "tsc-multi --config ./tsc-multi.test.json",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "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 nyc",
+    "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",
+    "test": "npm run test:mocha",
+    "test:coverage": "c8 npm test",
+    "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "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/cache.ts

@@ -3,19 +3,35 @@
  * Licensed under the MIT License.
  */
 
+import { MapWithExpiration } from "./mapWithExpiration";
+
 export interface ICache<T> {
-    get(key: string): Promise<T | undefined>;
-    put(key: string, value: T): Promise<void>;
+	get(key: string): Promise<T | undefined>;
+	put(key: string, value: T): Promise<void>;
 }
 
+/** A basic in-memory cache that optionally supports expiring entries after a period of inactivity */
 export class InMemoryCache<T> implements ICache<T> {
-    private readonly cache: Map<string, T> = new Map();
+	private readonly cache: Map<string, T>;
+
+	constructor(expirationMs?: number) {
+		this.cache = expirationMs !== undefined ? new MapWithExpiration(expirationMs) : new Map();
+	}
+
+	public async get(key: string): Promise<T | undefined> {
+		return this.cache.get(key);
+	}
+
+	public async put(key: string, value: T): Promise<void> {
+		this.cache.set(key, value);
+	}
+}
 
-    public async get(key: string): Promise<T | undefined> {
-        return this.cache.get(key);
-    }
+/** This "cache" does nothing on put, and get always returns undefined */
+export class NullCache<T> implements ICache<T> {
+	public async get(key: string): Promise<T | undefined> {
+		return undefined;
+	}
 
-    public async put(key: string, value: T): Promise<void> {
-        this.cache.set(key, value);
-    }
+	public async put(key: string, value: T): Promise<void> {}
 }

package/src/contracts.ts

@@ -0,0 +1,60 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ISnapshotTree } from "@fluidframework/protocol-definitions";
+
+/*
+ *
+ * Whole Snapshot Download Data Structures
+ *
+ */
+
+export interface IWholeFlatSnapshotTreeEntryTree {
+	path: string;
+	type: "tree";
+	// Indicates that this tree entry is unreferenced. If this is not present, the tree entry is considered referenced.
+	unreferenced?: true;
+}
+
+export interface IWholeFlatSnapshotTreeEntryBlob {
+	id: string;
+	path: string;
+	type: "blob";
+}
+
+export type IWholeFlatSnapshotTreeEntry =
+	| IWholeFlatSnapshotTreeEntryTree
+	| IWholeFlatSnapshotTreeEntryBlob;
+
+export interface IWholeFlatSnapshotTree {
+	entries: IWholeFlatSnapshotTreeEntry[];
+	id: string;
+	sequenceNumber: number;
+}
+
+export interface IWholeFlatSnapshotBlob {
+	content: string;
+	encoding: "base64" | "utf-8";
+	id: string;
+	size: number;
+}
+
+export interface IWholeFlatSnapshot {
+	// The same as the id of the first snapshot tree in the trees array.
+	id: string;
+	// Receive an array of snapshot trees for future-proofing, however, always length 1 for now.
+	trees: IWholeFlatSnapshotTree[];
+	blobs?: IWholeFlatSnapshotBlob[];
+}
+
+/**
+ * Normalized Whole Summary with decoded blobs and unflattened snapshot tree.
+ */
+export interface INormalizedWholeSnapshot {
+	blobs: Map<string, ArrayBuffer>;
+	snapshotTree: ISnapshotTree;
+	sequenceNumber: number | undefined;
+	id: string;
+}

package/src/createNewUtils.ts

@@ -3,37 +3,39 @@
  * Licensed under the MIT License.
  */
 
-import { Uint8ArrayToString } from "@fluidframework/common-utils";
+import { Uint8ArrayToString } from "@fluid-internal/client-utils";
 import { ISummaryTree, SummaryType } from "@fluidframework/protocol-definitions";
 
 /**
  * Utility api to convert ISummaryTree to a summary tree where blob contents are only utf8 strings.
  * @param summary - Summary supplied by the runtime to upload.
- * @returns - Modified summary tree where the blob contents could be utf8 string only.
+ * @returns Modified summary tree where the blob contents could be utf8 string only.
  */
 export function convertSummaryToCreateNewSummary(summary: ISummaryTree): ISummaryTree {
-    const keys = Object.keys(summary.tree);
-    for (const key of keys) {
-        const summaryObject = summary.tree[key];
+	const keys = Object.keys(summary.tree);
+	for (const key of keys) {
+		const summaryObject = summary.tree[key];
 
-        switch (summaryObject.type) {
-            case SummaryType.Tree: {
-                summary.tree[key] = convertSummaryToCreateNewSummary(summaryObject);
-                break;
-            }
-            case SummaryType.Blob: {
-                summaryObject.content = typeof summaryObject.content === "string" ?
-                    summaryObject.content : Uint8ArrayToString(summaryObject.content, "utf8");
-                break;
-            }
-            case SummaryType.Handle: {
-                throw new Error("No handle should be present for first summary!!");
-            }
-            default: {
-                throw new Error(`Unknown tree type ${summaryObject.type}`);
-            }
-        }
-    }
+		switch (summaryObject.type) {
+			case SummaryType.Tree: {
+				summary.tree[key] = convertSummaryToCreateNewSummary(summaryObject);
+				break;
+			}
+			case SummaryType.Blob: {
+				summaryObject.content =
+					typeof summaryObject.content === "string"
+						? summaryObject.content
+						: Uint8ArrayToString(summaryObject.content, "utf8");
+				break;
+			}
+			case SummaryType.Handle: {
+				throw new Error("No handle should be present for first summary!!");
+			}
+			default: {
+				throw new Error(`Unknown tree type ${summaryObject.type}`);
+			}
+		}
+	}
 
-    return summary;
+	return summary;
 }

package/src/defaultTokenProvider.ts

@@ -7,24 +7,23 @@ import { ITokenProvider, ITokenResponse } from "./tokens";
 
 /**
  * Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
+ * @internal
  */
 
 export class DefaultTokenProvider implements ITokenProvider {
-    constructor(private readonly jwt: string) {
+	constructor(private readonly jwt: string) {}
 
-    }
+	public async fetchOrdererToken(): Promise<ITokenResponse> {
+		return {
+			fromCache: true,
+			jwt: this.jwt,
+		};
+	}
 
-    public async fetchOrdererToken(): Promise<ITokenResponse> {
-        return {
-            fromCache: true,
-            jwt: this.jwt,
-        };
-    }
-
-    public async fetchStorageToken(): Promise<ITokenResponse> {
-        return {
-            fromCache: true,
-            jwt: this.jwt,
-        };
-    }
+	public async fetchStorageToken(): Promise<ITokenResponse> {
+		return {
+			fromCache: true,
+			jwt: this.jwt,
+		};
+	}
 }

package/src/definitions.ts

@@ -6,6 +6,6 @@
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
 
 export interface ISnapshotTreeVersion {
-    id: string;
-    snapshotTree: ISnapshotTree;
+	id: string;
+	snapshotTree: ISnapshotTree;
 }