@fluidframework/runtime-definitions 2.0.0-rc.2.0.1 → 2.0.0-rc.3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-rc.2.0.1",
+  "version": "2.0.0-rc.3.0.0",
   "description": "Fluid Runtime definitions",
   "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/runtime-definitions-public.d.ts",
+        "types": "./lib/public.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/runtime-definitions-public.d.ts",
+        "types": "./dist/public.d.ts",
         "default": "./dist/index.js"
       }
     },
-    "./alpha": {
+    "./legacy": {
       "import": {
-        "types": "./lib/runtime-definitions-alpha.d.ts",
+        "types": "./lib/legacy.d.ts",
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/runtime-definitions-alpha.d.ts",
+        "types": "./dist/legacy.d.ts",
         "default": "./dist/index.js"
       }
     },
@@ -54,21 +44,22 @@
       }
     }
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": ">=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/driver-definitions": ">=2.0.0-rc.2.0.1 <2.0.0-rc.2.1.0",
-    "@fluidframework/id-compressor": ">=2.0.0-rc.2.0.1 <2.0.0-rc.2.1.0",
+    "@fluidframework/container-definitions": ">=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/driver-definitions": ">=2.0.0-rc.3.0.0 <2.0.0-rc.3.1.0",
+    "@fluidframework/id-compressor": ">=2.0.0-rc.3.0.0 <2.0.0-rc.3.1.0",
     "@fluidframework/protocol-definitions": "^3.2.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-tools/build-cli": "^0.34.0",
+    "@arethetypeswrong/cli": "^0.15.2",
+    "@biomejs/biome": "^1.6.2",
+    "@fluid-tools/build-cli": "^0.37.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.34.0",
-    "@fluidframework/eslint-config-fluid": "^4.0.0",
+    "@fluidframework/build-tools": "^0.37.0",
+    "@fluidframework/eslint-config-fluid": "^5.1.0",
     "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-internal.8.0.0",
     "@microsoft/api-extractor": "^7.42.3",
     "copyfiles": "^2.4.1",
@@ -78,18 +69,6 @@
     "rimraf": "^4.4.0",
     "typescript": "~5.1.6"
   },
-  "fluidBuild": {
-    "tasks": {
-      "build:docs": {
-        "dependsOn": [
-          "...",
-          "api-extractor:commonjs",
-          "api-extractor:esnext"
-        ],
-        "script": false
-      }
-    }
-  },
   "typeValidation": {
     "broken": {
       "InterfaceDeclaration_IFluidDataStoreContext": {
@@ -145,35 +124,40 @@
         "backCompat": false
       },
       "InterfaceDeclaration_IFluidDataStoreChannel": {
-        "backCompat": false
+        "backCompat": false,
+        "forwardCompat": false
       },
       "InterfaceDeclaration_IContainerRuntimeBase": {
         "forwardCompat": false
+      },
+      "RemovedInterfaceDeclaration_IFluidDataStoreContextEvents": {
+        "forwardCompat": false,
+        "backCompat": false
       }
     }
   },
   "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:compile": "fluid-build . --task compile",
-    "build:docs": "fluid-build . --task api",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.json",
     "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": "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",
     "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/dataStoreContext.ts

@@ -3,19 +3,20 @@
  * Licensed under the MIT License.
  */
 
+import type { AttachState, IAudience, IDeltaManager } from "@fluidframework/container-definitions";
 import type {
+	FluidObject,
+	IDisposable,
 	IEvent,
 	IEventProvider,
-	ITelemetryBaseLogger,
-	IDisposable,
-	IProvideFluidHandleContext,
 	IFluidHandle,
+	IProvideFluidHandleContext,
 	IRequest,
 	IResponse,
-	FluidObject,
+	ITelemetryBaseLogger,
 } from "@fluidframework/core-interfaces";
-import type { IAudience, IDeltaManager, AttachState } from "@fluidframework/container-definitions";
-import type { IDocumentStorageService } from "@fluidframework/driver-definitions";
+import type { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
+import type { IIdCompressor } from "@fluidframework/id-compressor";
 import type {
 	IClientDetails,
 	IDocumentMessage,
@@ -23,7 +24,7 @@ import type {
 	ISequencedDocumentMessage,
 	ISnapshotTree,
 } from "@fluidframework/protocol-definitions";
-import type { IIdCompressor } from "@fluidframework/id-compressor";
+
 import type { IProvideFluidDataStoreFactory } from "./dataStoreFactory.js";
 import type { IProvideFluidDataStoreRegistry } from "./dataStoreRegistry.js";
 import type {
@@ -182,10 +183,10 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
 	/**
 	 * Submits a container runtime level signal to be sent to other clients.
 	 * @param type - Type of the signal.
-	 * @param content - Content of the signal.
+	 * @param content - Content of the signal. Should be a JSON serializable object or primitive.
 	 * @param targetClientId - When specified, the signal is only sent to the provided client id.
 	 */
-	submitSignal(type: string, content: any, targetClientId?: string): void;
+	submitSignal: (type: string, content: unknown, targetClientId?: string) => void;
 
 	/**
 	 * @deprecated 0.16 Issue #1537, #3631
@@ -364,6 +365,8 @@ export interface IFluidDataStoreChannel extends IDisposable {
 	readonly entryPoint: IFluidHandle<FluidObject>;
 
 	request(request: IRequest): Promise<IResponse>;
+
+	setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
 }
 
 /**
@@ -378,13 +381,6 @@ export type CreateChildSummarizerNodeFn = (
 	getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,
 ) => ISummarizerNodeWithGC;
 
-/**
- * @alpha
- */
-export interface IFluidDataStoreContextEvents extends IEvent {
-	(event: "attaching" | "attached", listener: () => void);
-}
-
 /**
  * Represents the context for the data store like objects. It is used by the data store runtime to
  * get information and call functionality to its parent.
@@ -457,10 +453,10 @@ export interface IFluidParentContext
 	/**
 	 * Submits the signal to be sent to other clients.
 	 * @param type - Type of the signal.
-	 * @param content - Content of the signal.
+	 * @param content - Content of the signal. Should be a JSON serializable object or primitive.
 	 * @param targetClientId - When specified, the signal is only sent to the provided client id.
 	 */
-	submitSignal(type: string, content: any, targetClientId?: string): void;
+	submitSignal: (type: string, content: unknown, targetClientId?: string) => void;
 
 	/**
 	 * Called to make the data store locally visible in the container. This happens automatically for root data stores
@@ -489,7 +485,7 @@ export interface IFluidParentContext
 		createParam: CreateChildSummarizerNodeParam,
 	): CreateChildSummarizerNodeFn;
 
-	deleteChildSummarizerNode?(id: string): void;
+	deleteChildSummarizerNode(id: string): void;
 
 	uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
 
@@ -508,6 +504,12 @@ export interface IFluidParentContext
 		srcHandle: { absolutePath: string },
 		outboundHandle: { absolutePath: string },
 	): void;
+
+	/**
+	 * Called by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.
+	 * @param address - The address of the channel that is dirty.
+	 */
+	setChannelDirty(address: string): void;
 }
 
 /**
@@ -515,9 +517,7 @@ export interface IFluidParentContext
  * get information and call functionality to the container.
  * @alpha
  */
-export interface IFluidDataStoreContext
-	extends IEventProvider<IFluidDataStoreContextEvents>,
-		IFluidParentContext {
+export interface IFluidDataStoreContext extends IFluidParentContext {
 	readonly id: string;
 	/**
 	 * A data store created by a client, is a local data store for that client. Also, when a detached container loads
@@ -539,12 +539,6 @@ export interface IFluidDataStoreContext
 	 */
 	readonly createProps?: any;
 
-	/**
-	 * Call by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.
-	 * @param address - The address of the channel that is dirty.
-	 */
-	setChannelDirty(address: string): void;
-
 	/**
 	 * @deprecated The functionality to get base GC details has been moved to summarizer node.
 	 *

package/src/dataStoreFactory.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import type { IFluidDataStoreContext, IFluidDataStoreChannel } from "./dataStoreContext.js";
+import type { IFluidDataStoreChannel, IFluidDataStoreContext } from "./dataStoreContext.js";
 
 /**
  * @alpha

package/src/index.ts

@@ -20,7 +20,6 @@ export type {
 	IFluidDataStoreContext,
 	IFluidParentContext,
 	IFluidDataStoreContextDetached,
-	IFluidDataStoreContextEvents,
 } from "./dataStoreContext.js";
 export { FlushMode, FlushModeExperimental, VisibilityState } from "./dataStoreContext.js";
 export type { IProvideFluidDataStoreFactory } from "./dataStoreFactory.js";

package/src/summary.ts

@@ -5,12 +5,13 @@
 
 import type { TelemetryBaseEventPropertyType } from "@fluidframework/core-interfaces";
 import type {
-	SummaryTree,
-	ISummaryTree,
 	ISequencedDocumentMessage,
 	ISnapshotTree,
+	ISummaryTree,
 	ITree,
+	SummaryTree,
 } from "@fluidframework/protocol-definitions";
+
 import type {
 	IGarbageCollectionData,
 	IGarbageCollectionDetailsBase,

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
-	}
-}