@fluidframework/driver-utils 2.0.0-rc.2.0.1 → 2.0.0-rc.3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-utils",
-  "version": "2.0.0-rc.2.0.1",
+  "version": "2.0.0-rc.3.0.0",
   "description": "Collection of utility functions for Fluid drivers",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -15,31 +15,21 @@
   "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/driver-utils-public.d.ts",
+        "types": "./lib/public.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/driver-utils-public.d.ts",
+        "types": "./dist/public.d.ts",
         "default": "./dist/index.js"
       }
     },
-    "./alpha": {
+    "./legacy": {
       "import": {
-        "types": "./lib/driver-utils-alpha.d.ts",
+        "types": "./lib/legacy.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/driver-utils-alpha.d.ts",
+        "types": "./dist/legacy.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -54,8 +44,8 @@
       }
     }
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/public.d.ts",
   "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
@@ -77,26 +67,27 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-rc.2.0.1 <2.0.0-rc.2.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-rc.2.0.1 <2.0.0-rc.2.1.0",
-    "@fluidframework/core-utils": ">=2.0.0-rc.2.0.1 <2.0.0-rc.2.1.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-rc.2.0.1 <2.0.0-rc.2.1.0",
+    "@fluid-internal/client-utils": ">=2.0.0-rc.3.0.0 <2.0.0-rc.3.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.3.0.0 <2.0.0-rc.3.1.0",
+    "@fluidframework/core-utils": ">=2.0.0-rc.3.0.0 <2.0.0-rc.3.1.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-rc.3.0.0 <2.0.0-rc.3.1.0",
     "@fluidframework/gitresources": "^4.0.0",
     "@fluidframework/protocol-base": "^4.0.0",
     "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-rc.2.0.1 <2.0.0-rc.2.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-rc.3.0.0 <2.0.0-rc.3.1.0",
     "axios": "^1.6.2",
     "lz4js": "^0.2.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.2.0.1 <2.0.0-rc.2.1.0",
-    "@fluid-tools/build-cli": "^0.34.0",
+    "@arethetypeswrong/cli": "^0.15.2",
+    "@biomejs/biome": "^1.6.2",
+    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.3.0.0 <2.0.0-rc.3.1.0",
+    "@fluid-tools/build-cli": "^0.37.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.34.0",
+    "@fluidframework/build-tools": "^0.37.0",
     "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.8.0.0",
-    "@fluidframework/eslint-config-fluid": "^4.0.0",
+    "@fluidframework/eslint-config-fluid": "^5.1.0",
     "@microsoft/api-extractor": "^7.42.3",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
@@ -115,18 +106,6 @@
     "sinon": "^17.0.1",
     "typescript": "~5.1.6"
   },
-  "fluidBuild": {
-    "tasks": {
-      "build:docs": {
-        "dependsOn": [
-          "...",
-          "api-extractor:commonjs",
-          "api-extractor:esnext"
-        ],
-        "script": false
-      }
-    }
-  },
   "typeValidation": {
     "broken": {
       "ClassDeclaration_DocumentStorageServiceProxy": {
@@ -141,28 +120,28 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
-    "api-extractor:esnext": "api-extractor run --local",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "fluid-build . --task api",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
     "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
     "build:test:esm": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:are-the-types-wrong": "attw --pack .",
+    "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "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",
+    "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.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",
+    "format": "fluid-build --task format .",
+    "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "lint": "fluid-build . --task lint",
+    "lint:fix": "fluid-build . --task eslint:fix --task format",
     "test": "npm run test:mocha",
     "test:coverage": "c8 npm test",
     "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",

package/src/adapters/compression/documentServiceCompressionAdapter.ts

@@ -3,10 +3,15 @@
  * Licensed under the MIT License.
  */
 
-import { IDocumentService, IDocumentStorageService } from "@fluidframework/driver-definitions";
+import {
+	IDocumentService,
+	IDocumentStorageService,
+} from "@fluidframework/driver-definitions/internal";
+
 import { DocumentServiceProxy } from "../../documentServiceProxy.js";
-import { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from "./summaryblob/index.js";
+
 import { ICompressionStorageConfig } from "./compressionTypes.js";
+import { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from "./summaryblob/index.js";
 
 export class DocumentServiceCompressionAdapter extends DocumentServiceProxy {
 	constructor(

package/src/adapters/compression/documentServiceFactoryCompressionAdapter.ts

@@ -8,12 +8,14 @@ import {
 	IDocumentService,
 	IDocumentServiceFactory,
 	IResolvedUrl,
-} from "@fluidframework/driver-definitions";
+} from "@fluidframework/driver-definitions/internal";
 import { ISummaryTree } from "@fluidframework/protocol-definitions";
+
 import { DocumentServiceFactoryProxy } from "../../documentServiceFactoryProxy.js";
+
 import { ICompressionStorageConfig } from "./compressionTypes.js";
-import { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from "./summaryblob/index.js";
 import { DocumentServiceCompressionAdapter } from "./documentServiceCompressionAdapter.js";
+import { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSummaryBlobCompressionAdapter } from "./summaryblob/index.js";
 
 export class DocumentServiceFactoryCompressionAdapter extends DocumentServiceFactoryProxy {
 	constructor(

package/src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts

@@ -4,8 +4,11 @@
  */
 
 import { IsoBuffer } from "@fluid-internal/client-utils";
-import { assert } from "@fluidframework/core-utils";
-import { IDocumentStorageService, ISummaryContext } from "@fluidframework/driver-definitions";
+import { assert } from "@fluidframework/core-utils/internal";
+import {
+	IDocumentStorageService,
+	ISummaryContext,
+} from "@fluidframework/driver-definitions/internal";
 import {
 	ISnapshotTree,
 	ISummaryBlob,
@@ -16,8 +19,9 @@ import {
 	SummaryType,
 } from "@fluidframework/protocol-definitions";
 import { compress, decompress } from "lz4js";
-import { DocumentStorageServiceProxy } from "../../../documentStorageServiceProxy.js";
+
 import { ICompressionStorageConfig, SummaryCompressionAlgorithm } from "..//index.js";
+import { DocumentStorageServiceProxy } from "../../../documentStorageServiceProxy.js";
 
 /**
  * @internal

package/src/adapters/predefinedAdapters.ts

@@ -3,12 +3,13 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils";
-import { IDocumentServiceFactory } from "@fluidframework/driver-definitions";
+import { assert } from "@fluidframework/core-utils/internal";
+import { IDocumentServiceFactory } from "@fluidframework/driver-definitions/internal";
+
 import {
+	DefaultCompressionStorageConfig,
 	DocumentServiceFactoryCompressionAdapter,
 	ICompressionStorageConfig,
-	DefaultCompressionStorageConfig,
 } from "./compression/index.js";
 
 /**

package/src/blob.ts

@@ -5,8 +5,8 @@
 
 import {
 	FileMode,
-	IBlob,
 	IAttachment,
+	IBlob,
 	ITree,
 	TreeEntry,
 } from "@fluidframework/protocol-definitions";

package/src/buildSnapshotTree.ts

@@ -4,15 +4,15 @@
  */
 
 import { stringToBuffer } from "@fluid-internal/client-utils";
-import { assert } from "@fluidframework/core-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 import * as git from "@fluidframework/gitresources";
+import { buildGitTreeHierarchy } from "@fluidframework/protocol-base";
 import {
 	FileMode,
 	ISnapshotTree,
 	ITreeEntry,
 	TreeEntry,
 } from "@fluidframework/protocol-definitions";
-import { buildGitTreeHierarchy } from "@fluidframework/protocol-base";
 import { v4 as uuid } from "uuid";
 
 function flattenCore(

package/src/documentServiceFactoryProxy.ts

@@ -8,7 +8,7 @@ import {
 	IDocumentService,
 	IDocumentServiceFactory,
 	IResolvedUrl,
-} from "@fluidframework/driver-definitions";
+} from "@fluidframework/driver-definitions/internal";
 import { ISummaryTree } from "@fluidframework/protocol-definitions";
 
 /**

package/src/documentServiceProxy.ts

@@ -11,7 +11,7 @@ import {
 	IDocumentServiceEvents,
 	IDocumentStorageService,
 	IResolvedUrl,
-} from "@fluidframework/driver-definitions";
+} from "@fluidframework/driver-definitions/internal";
 import { IClient } from "@fluidframework/protocol-definitions";
 
 /**

package/src/documentStorageServiceProxy.ts

@@ -10,7 +10,7 @@ import {
 	ISnapshot,
 	ISnapshotFetchOptions,
 	ISummaryContext,
-} from "@fluidframework/driver-definitions";
+} from "@fluidframework/driver-definitions/internal";
 import {
 	ICreateBlobResponse,
 	ISnapshotTree,
@@ -18,7 +18,7 @@ import {
 	ISummaryTree,
 	IVersion,
 } from "@fluidframework/protocol-definitions";
-import { UsageError } from "@fluidframework/telemetry-utils";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 /**
  * @internal

package/src/error.ts

@@ -4,7 +4,7 @@
  */
 
 import { DriverErrorTypes, IDriverErrorBase } from "@fluidframework/driver-definitions";
-import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
+import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils/internal";
 
 /**
  * Error indicating an API is being used improperly resulting in an invalid operation.

package/src/insecureUrlResolver.ts

@@ -3,9 +3,13 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils";
 import { IRequest } from "@fluidframework/core-interfaces";
-import { IResolvedUrl, IUrlResolver, DriverHeader } from "@fluidframework/driver-definitions";
+import { assert } from "@fluidframework/core-utils/internal";
+import {
+	DriverHeader,
+	IResolvedUrl,
+	IUrlResolver,
+} from "@fluidframework/driver-definitions/internal";
 import Axios from "axios";
 
 /**

package/src/messageRecognition.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+
 import {
 	IDocumentMessage,
 	ISequencedDocumentMessage,

package/src/network.ts

@@ -3,16 +3,15 @@
  * Licensed under the MIT License.
  */
 
+import { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
+import { DriverErrorTypes, IDriverErrorBase } from "@fluidframework/driver-definitions";
 import {
-	IThrottlingWarning,
-	IDriverErrorBase,
 	IAuthorizationError,
 	ILocationRedirectionError,
 	IResolvedUrl,
-	DriverErrorTypes,
-} from "@fluidframework/driver-definitions";
-import { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
-import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
+	IThrottlingWarning,
+} from "@fluidframework/driver-definitions/internal";
+import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils/internal";
 
 /**
  * @internal

package/src/networkUtils.ts

@@ -3,8 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLoggerExt, type ITelemetryErrorEventExt } from "@fluidframework/telemetry-utils";
-import { isOnline, OnlineStatus, canRetryOnError } from "./network.js";
+import { type ITelemetryErrorEventExt, ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+
+import { OnlineStatus, canRetryOnError, isOnline } from "./network.js";
 
 /**
  * @internal

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "2.0.0-rc.2.0.1";
+export const pkgVersion = "2.0.0-rc.3.0.0";

package/src/parallelRequests.ts

@@ -2,13 +2,20 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+
 import { performance } from "@fluid-internal/client-utils";
 import { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
-import { assert, Deferred } from "@fluidframework/core-utils";
-import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils";
+import { assert, Deferred } from "@fluidframework/core-utils/internal";
+import {
+	IDeltasFetchResult,
+	IStream,
+	IStreamResult,
+} from "@fluidframework/driver-definitions/internal";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
-import { IDeltasFetchResult, IStream, IStreamResult } from "@fluidframework/driver-definitions";
-import { getRetryDelayFromError, canRetryOnError, createGenericNetworkError } from "./network.js";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { PerformanceEvent } from "@fluidframework/telemetry-utils/internal";
+
+import { canRetryOnError, createGenericNetworkError, getRetryDelayFromError } from "./network.js";
 import { logNetworkFailure } from "./networkUtils.js";
 // For now, this package is versioned and released in unison with the specific drivers
 import { pkgVersion as driverVersion } from "./packageVersion.js";

package/src/prefetchDocumentStorageService.ts

@@ -2,8 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { LoaderCachingPolicy } from "@fluidframework/driver-definitions";
+
+import { LoaderCachingPolicy } from "@fluidframework/driver-definitions/internal";
 import { ISnapshotTree, IVersion } from "@fluidframework/protocol-definitions";
+
 import { DocumentStorageServiceProxy } from "./documentStorageServiceProxy.js";
 import { canRetryOnError } from "./network.js";
 

package/src/rateLimiter.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/core-utils";
+import { assert } from "@fluidframework/core-utils/internal";
 
 /**
  * @alpha

package/src/readAndParse.ts

@@ -4,7 +4,7 @@
  */
 
 import { bufferToString } from "@fluid-internal/client-utils";
-import { IDocumentStorageService } from "@fluidframework/driver-definitions";
+import { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
 
 /**
  * Read a blob from {@link @fluidframework/driver-definitions#IDocumentStorageService} and

package/src/runWithRetry.ts

@@ -3,11 +3,13 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLoggerExt, isFluidError } from "@fluidframework/telemetry-utils";
 import { performance } from "@fluid-internal/client-utils";
-import { delay } from "@fluidframework/core-utils";
+import { delay } from "@fluidframework/core-utils/internal";
 import { DriverErrorTypes } from "@fluidframework/driver-definitions";
-import { canRetryOnError, getRetryDelayFromError, NonRetryableError } from "./network.js";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { isFluidError } from "@fluidframework/telemetry-utils/internal";
+
+import { NonRetryableError, canRetryOnError, getRetryDelayFromError } from "./network.js";
 import { pkgVersion } from "./packageVersion.js";
 
 /**

package/src/storageUtils.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ISnapshot } from "@fluidframework/driver-definitions";
+import { ISnapshot } from "@fluidframework/driver-definitions/internal";
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
 
 /**

package/src/summaryForCreateNew.ts

@@ -4,11 +4,11 @@
  */
 
 import {
-	ISummaryTree,
-	SummaryType,
-	ISummaryBlob,
 	ICommittedProposal,
 	IDocumentAttributes,
+	ISummaryBlob,
+	ISummaryTree,
+	SummaryType,
 } from "@fluidframework/protocol-definitions";
 
 /**

package/src/treeConversions.ts

@@ -4,8 +4,9 @@
  */
 
 import { Uint8ArrayToString } from "@fluid-internal/client-utils";
-import { unreachableCase } from "@fluidframework/core-utils";
+import { unreachableCase } from "@fluidframework/core-utils/internal";
 import { ISummaryTree, ITree, ITreeEntry, SummaryType } from "@fluidframework/protocol-definitions";
+
 import { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from "./blob.js";
 import { isCombinedAppAndProtocolSummary } from "./summaryForCreateNew.js";
 

package/api-extractor-cjs.json

@@ -1,8 +0,0 @@
-{
-	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
-	// CJS is actually secondary; so, no report.
-	"apiReport": {
-		"enabled": false
-	}
-}