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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/file-driver",
-  "version": "2.0.0-rc.1.0.3",
+  "version": "2.0.0-rc.2.0.0",
   "description": "A driver that reads/write from/to local file storage.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,29 +11,61 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
-  "type": "commonjs",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./public": {
+      "import": {
+        "types": "./lib/file-driver-public.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/file-driver-public.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-rc.1.0.3 <2.0.0-rc.1.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-rc.1.0.3 <2.0.0-rc.1.1.0",
-    "@fluidframework/core-utils": ">=2.0.0-rc.1.0.3 <2.0.0-rc.1.1.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-rc.1.0.3 <2.0.0-rc.1.1.0",
-    "@fluidframework/driver-utils": ">=2.0.0-rc.1.0.3 <2.0.0-rc.1.1.0",
-    "@fluidframework/protocol-definitions": "^3.1.0",
-    "@fluidframework/replay-driver": ">=2.0.0-rc.1.0.3 <2.0.0-rc.1.1.0"
+    "@fluid-internal/client-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/core-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/driver-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/protocol-definitions": "^3.2.0",
+    "@fluidframework/replay-driver": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-tools/build-cli": "^0.29.0",
+    "@fluid-tools/build-cli": "^0.34.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.29.0",
-    "@fluidframework/eslint-config-fluid": "^3.2.0",
+    "@fluidframework/build-tools": "^0.34.0",
+    "@fluidframework/eslint-config-fluid": "^4.0.0",
     "@fluidframework/file-driver-previous": "npm:@fluidframework/file-driver@2.0.0-internal.8.0.0",
-    "@microsoft/api-extractor": "^7.38.3",
+    "@microsoft/api-extractor": "^7.42.3",
     "@types/node": "^18.19.0",
     "copyfiles": "^2.4.1",
-    "eslint": "~8.50.0",
+    "eslint": "~8.55.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
@@ -43,7 +75,8 @@
       "build:docs": {
         "dependsOn": [
           "...",
-          "api-extractor:commonjs"
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
         ],
         "script": false
       },
@@ -54,15 +87,24 @@
     }
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "ClassDeclaration_FluidFetchReader": {
+        "backCompat": false
+      },
+      "InterfaceDeclaration_ISnapshotWriterStorage": {
+        "backCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
+    "api-extractor:esnext": "api-extractor run --local",
     "build": "fluid-build . --task build",
     "build:compile": "fluid-build . --task compile",
     "build:docs": "fluid-build . --task api",
-    "check:are-the-types-wrong": "attw --pack",
+    "build:esnext": "tsc --project ./tsconfig.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",
@@ -73,7 +115,7 @@
     "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",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "typetests:gen": "fluid-type-test-generator",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }

package/src/fileDocumentDeltaConnection.ts

@@ -20,7 +20,7 @@ import {
 	ScopeType,
 } from "@fluidframework/protocol-definitions";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { FileDeltaStorageService } from "./fileDeltaStorageService";
+import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
 
 const MaxBatchDeltas = 2000;
 

package/src/fileDocumentService.ts

@@ -3,22 +3,28 @@
  * Licensed under the MIT License.
  */
 
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import * as api from "@fluidframework/driver-definitions";
 import { IClient } from "@fluidframework/protocol-definitions";
-import { FileDeltaStorageService } from "./fileDeltaStorageService";
+import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
 
 /**
  * The DocumentService manages the different endpoints for connecting to
  * underlying storage for file document service.
  */
 // eslint-disable-next-line import/namespace
-export class FileDocumentService implements api.IDocumentService {
+export class FileDocumentService
+	extends TypedEventEmitter<api.IDocumentServiceEvents>
+	implements api.IDocumentService
+{
 	constructor(
 		public readonly resolvedUrl: api.IResolvedUrl,
 		private readonly storage: api.IDocumentStorageService,
 		private readonly deltaStorage: FileDeltaStorageService,
 		private readonly deltaConnection: api.IDocumentDeltaConnection,
-	) {}
+	) {
+		super();
+	}
 
 	public dispose() {}
 

package/src/fileDocumentServiceFactory.ts

@@ -12,8 +12,8 @@ import {
 } from "@fluidframework/driver-definitions";
 import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 import { ISummaryTree } from "@fluidframework/protocol-definitions";
-import { FileDeltaStorageService } from "./fileDeltaStorageService";
-import { FileDocumentService } from "./fileDocumentService";
+import { FileDeltaStorageService } from "./fileDeltaStorageService.js";
+import { FileDocumentService } from "./fileDocumentService.js";
 
 /**
  * Factory for creating the file document service. Use this if you want to

package/src/index.ts

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-export { FileDeltaStorageService } from "./fileDeltaStorageService";
-export { FileDocumentServiceFactory } from "./fileDocumentServiceFactory";
-export { Replayer, ReplayFileDeltaConnection } from "./fileDocumentDeltaConnection";
+export { FileDeltaStorageService } from "./fileDeltaStorageService.js";
+export { FileDocumentServiceFactory } from "./fileDocumentServiceFactory.js";
+export { Replayer, ReplayFileDeltaConnection } from "./fileDocumentDeltaConnection.js";
 export {
 	FileSnapshotWriterClassFactory,
 	FileStorageDocumentName,
@@ -13,4 +13,4 @@ export {
 	FluidFetchReaderFileSnapshotWriter,
 	ISnapshotWriterStorage,
 	ReaderConstructor,
-} from "./fileDocumentStorageService";
+} from "./fileDocumentStorageService.js";

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+	// This config must be used in a "type": "commonjs" environment. (Use fluid-tsc commonjs.)
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./dist",
+	},
+}

package/tsconfig.json

@@ -1,13 +1,10 @@
 {
-	"extends": [
-		"../../../common/build/build-common/tsconfig.base.json",
-		"../../../common/build/build-common/tsconfig.cjs.json",
-	],
+	"extends": "../../../common/build/build-common/tsconfig.node16.json",
 	"include": ["src/**/*"],
 	"exclude": ["dist", "node_modules"],
 	"compilerOptions": {
 		"rootDir": "./src",
-		"outDir": "./dist",
+		"outDir": "./lib",
 		"types": ["node"],
 		"noUnusedLocals": false,
 	},