@fluidframework/odsp-driver-definitions 2.0.0-dev-rc.3.0.0.254866 → 2.0.0-dev-rc.4.0.0.261659

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @fluidframework/odsp-driver-definitions
 
+## 2.0.0-rc.3.0.0
+
+### Major Changes
+
+-   Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
+
+    Fluid Framework packages have been updated to use the [package.json "exports"
+    field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
+    TypeScript types and implementation code.
+
+    This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
+
+    -   `"moduleResolution": "Node16"` with `"module": "Node16"`
+    -   `"moduleResolution": "Bundler"` with `"module": "ESNext"`
+
+    We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
+    for use with modern versions of Node.js _and_ Bundlers.
+    [See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
+    regarding the module and moduleResolution options.
+
+    **Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
+    to distinguish stable APIs from those that are in development.**
+
 ## 2.0.0-rc.2.0.0
 
 ### Minor Changes

package/beta.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+
+export * from "./lib/beta.js";

package/dist/beta.d.ts

@@ -7,7 +7,8 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
  * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
  */
+
 export {
-	// beta APIs
+	// @beta APIs
 	TokenResponse
 } from "./index.js";

package/dist/{alpha.d.ts → legacy.d.ts}

@@ -7,11 +7,12 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
  * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
  */
+
 export {
-	// beta APIs
+	// @beta APIs
 	TokenResponse,
  
-	// alpha APIs
+	// @alpha APIs
 	CacheContentType, 
 	HostStoragePolicy, 
 	ICacheEntry, 

package/dist/public.d.ts

@@ -7,3 +7,6 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
  * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
  */
+
+export {}
+

package/internal.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+
+export * from "./lib/index.js";

package/legacy.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
+ */
+
+export * from "./lib/legacy.js";

package/lib/beta.d.ts

@@ -7,7 +7,8 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
  * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
  */
+
 export {
-	// beta APIs
+	// @beta APIs
 	TokenResponse
 } from "./index.js";

package/lib/{alpha.d.ts → legacy.d.ts}

@@ -7,11 +7,12 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
  * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
  */
+
 export {
-	// beta APIs
+	// @beta APIs
 	TokenResponse,
  
-	// alpha APIs
+	// @alpha APIs
 	CacheContentType, 
 	HostStoragePolicy, 
 	ICacheEntry, 

package/lib/public.d.ts

@@ -7,3 +7,6 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
  * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
  */
+
+export {}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver-definitions",
-  "version": "2.0.0-dev-rc.3.0.0.254866",
+  "version": "2.0.0-dev-rc.4.0.0.261659",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -33,13 +33,13 @@
         "default": "./dist/index.js"
       }
     },
-    "./alpha": {
+    "./legacy": {
       "import": {
-        "types": "./lib/alpha.d.ts",
+        "types": "./lib/legacy.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/alpha.d.ts",
+        "types": "./dist/legacy.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -54,19 +54,19 @@
       }
     }
   },
-  "main": "dist/index.js",
-  "types": "./dist/public.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/driver-definitions": "2.0.0-dev-rc.3.0.0.254866"
+    "@fluidframework/driver-definitions": "2.0.0-dev-rc.4.0.0.261659"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-tools/build-cli": "^0.35.0",
+    "@fluid-tools/build-cli": "0.38.0-259537",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.35.0",
+    "@fluidframework/build-tools": "0.38.0-259537",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.0.0-internal.8.0.0",
+    "@fluidframework/odsp-driver-definitions-previous": "npm:@fluidframework/odsp-driver-definitions@2.0.0-rc.3.0.0",
     "@fluidframework/protocol-definitions": "^3.2.0",
     "@microsoft/api-extractor": "^7.42.3",
     "copyfiles": "^2.4.1",
@@ -77,21 +77,12 @@
     "typescript": "~5.1.6"
   },
   "typeValidation": {
-    "broken": {
-      "RemovedEnumDeclaration_OdspErrorType": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "RemovedEnumDeclaration_ShareLinkTypes": {
-        "backCompat": false,
-        "forwardCompat": false
-      }
-    }
+    "broken": {}
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib",
+    "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",
@@ -100,11 +91,11 @@
     "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",
+    "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "fluid-build --task format .",
@@ -112,7 +103,7 @@
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",
     "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:gen": "flub generate typetests --dir . -v --publicFallback",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
 }