@fluidframework/runtime-definitions 2.81.0 → 2.82.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/runtime-definitions
 
+## 2.82.0
+
+Dependency updates only.
+
 ## 2.81.0
 
 Dependency updates only.

package/README.md

@@ -30,6 +30,8 @@ For more information on the related support guarantees, see [API Support Levels]
 
 To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/runtime-definitions` like normal.
 
+To access the `beta` APIs, import via `@fluidframework/runtime-definitions/beta`.
+
 To access the `legacy` APIs, import via `@fluidframework/runtime-definitions/legacy`.
 
 ## API Documentation

package/api-extractor/api-extractor-lint-beta.cjs.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/dist/beta.d.ts"
+}

package/api-extractor/api-extractor-lint-beta.esm.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/beta.d.ts"
+}

package/api-extractor/api-extractor.current.json

@@ -1,5 +1,5 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
 	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.current.json",
-	"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
+	"mainEntryPointFilePath": "<projectFolder>/lib/beta.d.ts"
 }

package/api-report/runtime-definitions.beta.api.md

@@ -4,6 +4,9 @@
 
 ```ts
 
+// @beta @input
+export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/api-report/runtime-definitions.legacy.alpha.api.md

@@ -397,7 +397,7 @@ export interface LocalAttributionKey {
     type: "local";
 }
 
-// @beta @legacy @input
+// @beta @input
 export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
 
 // @beta @legacy

package/api-report/runtime-definitions.legacy.beta.api.md

@@ -388,7 +388,7 @@ export interface LocalAttributionKey {
     type: "local";
 }
 
-// @beta @legacy @input
+// @beta @input
 export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
 
 // @beta @legacy

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 @fluid-tools/build-cli.
+ */
+
+export * from "./lib/beta.js";

package/dist/beta.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * 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 @fluid-tools/build-cli.
+ */
+
+export {
+	// #region @beta APIs
+	MinimumVersionForCollab
+	// #endregion
+} from "./index.js";

package/dist/compatibilityDefinitions.d.ts

@@ -25,7 +25,7 @@
  * For example it might make sense to constrain this to something like `"1.4.0" | typeof defaultMinVersionForCollab | 2.${bigint}.0"`.
  *
  * @input
- * @legacy @beta
+ * @beta
  */
 export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
 //# sourceMappingURL=compatibilityDefinitions.d.ts.map

package/dist/compatibilityDefinitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Oldest version of Fluid Framework client packages to support collaborating with.\n * @remarks\n * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.\n *\n * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.\n *\n * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.\n *\n * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.\n * Since TypeScript cannot enforce them all for literals in code,\n * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.\n *\n * @privateRemarks\n * Since this uses the semver notion of \"greater\" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.\n * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.\n *\n * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.\n *\n * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).\n * For example it might make sense to constrain this to something like `\"1.4.0\" | typeof defaultMinVersionForCollab | 2.${bigint}.0\"`.\n *\n * @input\n * @legacy @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}
+{"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Oldest version of Fluid Framework client packages to support collaborating with.\n * @remarks\n * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.\n *\n * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.\n *\n * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.\n *\n * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.\n * Since TypeScript cannot enforce them all for literals in code,\n * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.\n *\n * @privateRemarks\n * Since this uses the semver notion of \"greater\" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.\n * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.\n *\n * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.\n *\n * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).\n * For example it might make sense to constrain this to something like `\"1.4.0\" | typeof defaultMinVersionForCollab | 2.${bigint}.0\"`.\n *\n * @input\n * @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}

package/dist/legacy.d.ts

@@ -9,6 +9,10 @@
  */
 
 export {
+	// #region @beta APIs
+	MinimumVersionForCollab,
+	// #endregion
+ 
 	// #region @legacyBeta APIs
 	AliasResult, 
 	AttributionInfo, 
@@ -52,7 +56,6 @@ export {
 	ITelemetryContext, 
 	InboundAttachMessage, 
 	LocalAttributionKey, 
-	MinimumVersionForCollab, 
 	NamedFluidDataStoreRegistryEntries, 
 	NamedFluidDataStoreRegistryEntry, 
 	NamedFluidDataStoreRegistryEntry2, 

package/dist/legacyAlpha.d.ts

@@ -9,6 +9,10 @@
  */
 
 export {
+	// #region @beta APIs
+	MinimumVersionForCollab,
+	// #endregion
+ 
 	// #region @legacyBeta APIs
 	AliasResult, 
 	AttributionInfo, 
@@ -52,7 +56,6 @@ export {
 	ITelemetryContext, 
 	InboundAttachMessage, 
 	LocalAttributionKey, 
-	MinimumVersionForCollab, 
 	NamedFluidDataStoreRegistryEntries, 
 	NamedFluidDataStoreRegistryEntry, 
 	NamedFluidDataStoreRegistryEntry2, 

package/lib/beta.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * 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 @fluid-tools/build-cli.
+ */
+
+export {
+	// #region @beta APIs
+	MinimumVersionForCollab
+	// #endregion
+} from "./index.js";

package/lib/compatibilityDefinitions.d.ts

@@ -25,7 +25,7 @@
  * For example it might make sense to constrain this to something like `"1.4.0" | typeof defaultMinVersionForCollab | 2.${bigint}.0"`.
  *
  * @input
- * @legacy @beta
+ * @beta
  */
 export type MinimumVersionForCollab = `${1 | 2}.${bigint}.${bigint}` | `${1 | 2}.${bigint}.${bigint}-${string}`;
 //# sourceMappingURL=compatibilityDefinitions.d.ts.map

package/lib/compatibilityDefinitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Oldest version of Fluid Framework client packages to support collaborating with.\n * @remarks\n * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.\n *\n * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.\n *\n * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.\n *\n * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.\n * Since TypeScript cannot enforce them all for literals in code,\n * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.\n *\n * @privateRemarks\n * Since this uses the semver notion of \"greater\" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.\n * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.\n *\n * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.\n *\n * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).\n * For example it might make sense to constrain this to something like `\"1.4.0\" | typeof defaultMinVersionForCollab | 2.${bigint}.0\"`.\n *\n * @input\n * @legacy @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}
+{"version":3,"file":"compatibilityDefinitions.js","sourceRoot":"","sources":["../src/compatibilityDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Oldest version of Fluid Framework client packages to support collaborating with.\n * @remarks\n * String in a SemVer format indicating a specific version of the Fluid Framework client package, or the special case of {@link @fluidframework/runtime-utils#defaultMinVersionForCollab}.\n *\n * When specifying a given `MinimumVersionForCollab`, any client with a version that is greater than or equal to the specified version will be considered compatible.\n *\n * Must be at least {@link @fluidframework/runtime-utils#lowestMinVersionForCollab} and cannot exceed the current version.\n *\n * {@link @fluidframework/runtime-utils#validateMinimumVersionForCollab} can be used to check these invariants at runtime.\n * Since TypeScript cannot enforce them all for literals in code,\n * it may be useful to use `validateMinimumVersionForCollab` values which may come from constants in the codebase typed as a `MinimumVersionForCollab`.\n *\n * @privateRemarks\n * Since this uses the semver notion of \"greater\" (which might not actually mean a later release, or supporting more features), care must be taken with how this is used.\n * See remarks for {@link @fluidframework/runtime-utils#MinimumMinorSemanticVersion} for more details.\n *\n * Since this type is marked with `@input`, it can be generalized to allow more cases in the future as a non-breaking change.\n *\n * TODO: before stabilizing this further, some restrictions should be considered (since once stabilized, this can be relaxed, but not more constrained).\n * For example it might make sense to constrain this to something like `\"1.4.0\" | typeof defaultMinVersionForCollab | 2.${bigint}.0\"`.\n *\n * @input\n * @beta\n */\nexport type MinimumVersionForCollab =\n\t| `${1 | 2}.${bigint}.${bigint}`\n\t| `${1 | 2}.${bigint}.${bigint}-${string}`;\n"]}

package/lib/legacy.d.ts

@@ -9,6 +9,10 @@
  */
 
 export {
+	// #region @beta APIs
+	MinimumVersionForCollab,
+	// #endregion
+ 
 	// #region @legacyBeta APIs
 	AliasResult, 
 	AttributionInfo, 
@@ -52,7 +56,6 @@ export {
 	ITelemetryContext, 
 	InboundAttachMessage, 
 	LocalAttributionKey, 
-	MinimumVersionForCollab, 
 	NamedFluidDataStoreRegistryEntries, 
 	NamedFluidDataStoreRegistryEntry, 
 	NamedFluidDataStoreRegistryEntry2, 

package/lib/legacyAlpha.d.ts

@@ -9,6 +9,10 @@
  */
 
 export {
+	// #region @beta APIs
+	MinimumVersionForCollab,
+	// #endregion
+ 
 	// #region @legacyBeta APIs
 	AliasResult, 
 	AttributionInfo, 
@@ -52,7 +56,6 @@ export {
 	ITelemetryContext, 
 	InboundAttachMessage, 
 	LocalAttributionKey, 
-	MinimumVersionForCollab, 
 	NamedFluidDataStoreRegistryEntries, 
 	NamedFluidDataStoreRegistryEntry, 
 	NamedFluidDataStoreRegistryEntry2, 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-definitions",
-  "version": "2.81.0",
+  "version": "2.82.0",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -23,6 +23,16 @@
         "default": "./dist/index.js"
       }
     },
+    "./beta": {
+      "import": {
+        "types": "./lib/beta.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/beta.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
     "./legacy": {
       "import": {
         "types": "./lib/legacy.d.ts",
@@ -57,12 +67,12 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.81.0",
-    "@fluidframework/container-definitions": "~2.81.0",
-    "@fluidframework/core-interfaces": "~2.81.0",
-    "@fluidframework/driver-definitions": "~2.81.0",
-    "@fluidframework/id-compressor": "~2.81.0",
-    "@fluidframework/telemetry-utils": "~2.81.0"
+    "@fluid-internal/client-utils": "~2.82.0",
+    "@fluidframework/container-definitions": "~2.82.0",
+    "@fluidframework/core-interfaces": "~2.82.0",
+    "@fluidframework/driver-definitions": "~2.82.0",
+    "@fluidframework/id-compressor": "~2.82.0",
+    "@fluidframework/telemetry-utils": "~2.82.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
@@ -70,8 +80,8 @@
     "@fluid-tools/build-cli": "^0.63.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.63.0",
-    "@fluidframework/eslint-config-fluid": "~2.81.0",
-    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.80.0",
+    "@fluidframework/eslint-config-fluid": "~2.82.0",
+    "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.81.0",
     "@microsoft/api-extractor": "7.52.11",
     "concurrently": "^9.2.1",
     "copyfiles": "^2.4.1",
@@ -102,9 +112,11 @@
     "check:biome": "biome check .",
     "check:exports": "concurrently \"npm:check:exports:*\"",
     "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
+    "check:exports:cjs:beta": "api-extractor run --config api-extractor/api-extractor-lint-beta.cjs.json",
     "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
     "check:exports:cjs:legacyAlpha": "api-extractor run --config api-extractor/api-extractor-lint-legacyAlpha.cjs.json",
     "check:exports:cjs:public": "api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
+    "check:exports:esm:beta": "api-extractor run --config api-extractor/api-extractor-lint-beta.esm.json",
     "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
     "check:exports:esm:legacyAlpha": "api-extractor run --config api-extractor/api-extractor-lint-legacyAlpha.esm.json",
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
@@ -113,7 +125,7 @@
     "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
+    "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts legacy \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
     "eslint": "eslint --quiet --format stylish src",
     "eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",

package/src/compatibilityDefinitions.ts

@@ -26,7 +26,7 @@
  * For example it might make sense to constrain this to something like `"1.4.0" | typeof defaultMinVersionForCollab | 2.${bigint}.0"`.
  *
  * @input
- * @legacy @beta
+ * @beta
  */
 export type MinimumVersionForCollab =
 	| `${1 | 2}.${bigint}.${bigint}`

package/biome.jsonc

@@ -1,4 +0,0 @@
-{
-	"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
-	"extends": ["../../../biome.jsonc"]
-}