@fluidframework/runtime-definitions 2.0.0-internal.8.0.0 → 2.0.0-rc.1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.0.0-internal.8.0.0",
+  "version": "2.0.0-rc.1.0.0",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,22 +11,45 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./alpha": {
+      "types": "./dist/runtime-definitions-alpha.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./beta": {
+      "types": "./dist/runtime-definitions-beta.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./internal": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./public": {
+      "types": "./dist/runtime-definitions-public.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
-    "@fluidframework/id-compressor": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
-    "@fluidframework/protocol-definitions": "^3.0.0"
+    "@fluidframework/container-definitions": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
+    "@fluidframework/id-compressor": ">=2.0.0-rc.1.0.0 <2.0.0-rc.1.1.0",
+    "@fluidframework/protocol-definitions": "^3.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-tools/build-cli": "^0.28.0",
+    "@fluid-tools/build-cli": "^0.29.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.28.0",
-    "@fluidframework/eslint-config-fluid": "^3.1.0",
-    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-internal.7.2.0",
+    "@fluidframework/build-tools": "^0.29.0",
+    "@fluidframework/eslint-config-fluid": "^3.2.0",
+    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-internal.8.0.0",
     "@microsoft/api-extractor": "^7.38.3",
     "copyfiles": "^2.4.1",
     "eslint": "~8.50.0",
@@ -40,8 +63,7 @@
       "build:docs": {
         "dependsOn": [
           "...",
-          "api-extractor:commonjs",
-          "api-extractor:esnext"
+          "api-extractor:commonjs"
         ],
         "script": false
       }
@@ -49,51 +71,22 @@
   },
   "typeValidation": {
     "broken": {
-      "TypeAliasDeclaration_IdCreationRangeWithStashedState": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "RemovedTypeAliasDeclaration_IdCreationRangeWithStashedState": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "InterfaceDeclaration_IdCreationRange": {
+      "InterfaceDeclaration_IIdCompressorCore": {
         "forwardCompat": false
       },
-      "VariableDeclaration_initialClusterCapacity": {
-        "backCompat": false,
+      "ClassDeclaration_IdCompressor": {
         "forwardCompat": false
-      },
-      "RemovedVariableDeclaration_initialClusterCapacity": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "InterfaceDeclaration_IContainerRuntimeBase": {
-        "backCompat": false
-      },
-      "InterfaceDeclaration_IFluidDataStoreContext": {
-        "backCompat": false
-      },
-      "InterfaceDeclaration_IFluidDataStoreContextDetached": {
-        "backCompat": false
-      },
-      "InterfaceDeclaration_IDataStore": {
-        "backCompat": false
-      },
-      "InterfaceDeclaration_IFluidDataStoreChannel": {
-        "backCompat": false
       }
     }
   },
   "scripts": {
     "api": "fluid-build . --task api",
     "api-extractor:commonjs": "api-extractor run --local",
-    "api-extractor:esnext": "copyfiles -u 1 \"dist/**/*-@(alpha|beta|public|untrimmed).d.ts\" lib",
     "build": "fluid-build . --task build",
     "build:compile": "fluid-build . --task compile",
     "build:docs": "fluid-build . --task api",
     "build:test": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack",
+    "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 \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",

package/src/dataStoreContext.ts

@@ -481,6 +481,9 @@ export interface IFluidDataStoreContext
 	getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
 
 	/**
+	 * @deprecated There is no replacement for this, its functionality is no longer needed at this layer.
+	 * It will be removed in a future release, sometime after 2.0.0-internal.8.0.0
+	 *
 	 * Called when a new outbound reference is added to another node. This is used by garbage collection to identify
 	 * all references added in the system.
 	 * @param srcHandle - The handle of the node that added the reference.

package/src/garbageCollection.ts

@@ -31,7 +31,7 @@ export const gcDeletedBlobKey = "__deletedNodes";
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
- * @alpha
+ * @public
  */
 export interface IGarbageCollectionData {
 	/**

package/src/protocol.ts

@@ -7,7 +7,7 @@ import { ISignalMessage, ITree } from "@fluidframework/protocol-definitions";
 
 /**
  * An envelope wraps the contents with the intended target
- * @internal
+ * @alpha
  */
 export interface IEnvelope {
 	/**
@@ -46,7 +46,7 @@ export interface ISignalEnvelope {
 
 /**
  * Represents ISignalMessage with its type.
- * @alpha
+ * @public
  */
 export interface IInboundSignalMessage extends ISignalMessage {
 	type: string;
@@ -55,7 +55,7 @@ export interface IInboundSignalMessage extends ISignalMessage {
 /**
  * Message send by client attaching local data structure.
  * Contains snapshot of data structure which is the current state of this data structure.
- * @internal
+ * @alpha
  */
 export interface IAttachMessage {
 	/**
@@ -79,7 +79,7 @@ export interface IAttachMessage {
  * but it should not be used when creating a new attach op.
  * Older versions of attach messages could have null snapshots,
  * so this gives correct typings for writing backward compatible code.
- * @internal
+ * @alpha
  */
 export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
 	snapshot: IAttachMessage["snapshot"] | null;

package/src/summary.ts

@@ -15,7 +15,7 @@ import { IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbage
 
 /**
  * Contains the aggregation data from a Tree/Subtree.
- * @alpha
+ * @public
  */
 export interface ISummaryStats {
 	treeNodeCount: number;
@@ -31,7 +31,7 @@ export interface ISummaryStats {
  * each of its DDS.
  * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
  * will be taking part of the summarization process.
- * @alpha
+ * @public
  */
 export interface ISummaryTreeWithStats {
 	/**
@@ -81,7 +81,7 @@ export interface ISummarizeInternalResult extends ISummarizeResult {
 /**
  * @experimental - Can be deleted/changed at any time
  * Contains the necessary information to allow DDSes to do incremental summaries
- * @alpha
+ * @public
  */
 export interface IExperimentalIncrementalSummaryContext {
 	/**
@@ -330,7 +330,7 @@ export const channelsTreeName = ".channels";
 /**
  * Contains telemetry data relevant to summarization workflows.
  * This object is expected to be modified directly by various summarize methods.
- * @alpha
+ * @public
  */
 export interface ITelemetryContext {
 	/**

package/tsconfig.json

@@ -1,10 +1,12 @@
 {
-	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"extends": [
+		"../../../common/build/build-common/tsconfig.base.json",
+		"../../../common/build/build-common/tsconfig.esm-only.json",
+	],
+	"include": ["src/**/*"],
 	"exclude": ["src/test/**/*"],
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./dist",
-		"composite": true,
 	},
-	"include": ["src/**/*"],
 }