@fluidframework/runtime-definitions 2.1.0-276326 → 2.1.0-281041

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +3 -1
  2. package/api-extractor/api-extractor.current.json +5 -0
  3. package/api-extractor/api-extractor.legacy.json +1 -1
  4. package/api-extractor.json +1 -1
  5. package/api-report/runtime-definitions.legacy.public.api.md +9 -0
  6. package/dist/legacy.d.ts +1 -1
  7. package/dist/public.d.ts +1 -1
  8. package/internal.d.ts +1 -1
  9. package/legacy.d.ts +1 -1
  10. package/lib/legacy.d.ts +1 -1
  11. package/lib/public.d.ts +1 -1
  12. package/package.json +20 -18
package/README.md CHANGED
@@ -9,10 +9,12 @@ Contains handshake interfaces for communication between the container runtime la
9
9
 
10
10
  ## Using Fluid Framework libraries
11
11
 
12
- When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
12
+ When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
13
13
  While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
14
14
  library consumers should always prefer `^`.
15
15
 
16
+ If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
17
+
16
18
  <!-- prettier-ignore-end -->
17
19
 
18
20
  <!-- AUTO-GENERATED-CONTENT:END -->
package/api-extractor/api-extractor.current.json ADDED
@@ -0,0 +1,5 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.current.json",
4
+ "mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
5
+ }
package/api-extractor/api-extractor.legacy.json CHANGED
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "<projectFolder>/../../../common/build/build-common/api-extractor-base.esm.legacy.json"
3
+ "extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.legacy.json"
4
4
  }
package/api-extractor.json CHANGED
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.esm.current.json"
3
+ "extends": "../../../common/build/build-common/api-extractor-model.esm.json"
4
4
  }
package/api-report/runtime-definitions.legacy.public.api.md ADDED
@@ -0,0 +1,9 @@
1
+ ## Public API Report File for "@fluidframework/runtime-definitions"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ // (No @packageDocumentation comment for this package)
8
+
9
+ ```
package/dist/legacy.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export {
package/dist/public.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export {}
package/internal.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export * from "./lib/index.js";
package/legacy.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export * from "./lib/legacy.js";
package/lib/legacy.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export {
package/lib/public.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  /*
7
7
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
8
- * Generated by "flub generate entrypoints" in @fluidframework/build-tools.
8
+ * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
9
9
  */
10
10
 
11
11
  export {}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/runtime-definitions",
3
- "version": "2.1.0-276326",
3
+ "version": "2.1.0-281041",
4
4
  "description": "Fluid Runtime definitions",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -47,20 +47,20 @@
47
47
  "main": "lib/index.js",
48
48
  "types": "lib/public.d.ts",
49
49
  "dependencies": {
50
- "@fluidframework/container-definitions": "2.1.0-276326",
51
- "@fluidframework/core-interfaces": "2.1.0-276326",
52
- "@fluidframework/driver-definitions": "2.1.0-276326",
53
- "@fluidframework/id-compressor": "2.1.0-276326",
54
- "@fluidframework/telemetry-utils": "2.1.0-276326"
50
+ "@fluidframework/container-definitions": "2.1.0-281041",
51
+ "@fluidframework/core-interfaces": "2.1.0-281041",
52
+ "@fluidframework/driver-definitions": "2.1.0-281041",
53
+ "@fluidframework/id-compressor": "2.1.0-281041",
54
+ "@fluidframework/telemetry-utils": "2.1.0-281041"
55
55
  },
56
56
  "devDependencies": {
57
57
  "@arethetypeswrong/cli": "^0.15.2",
58
- "@biomejs/biome": "^1.7.3",
59
- "@fluid-tools/build-cli": "^0.39.0",
58
+ "@biomejs/biome": "~1.8.3",
59
+ "@fluid-tools/build-cli": "^0.40.0",
60
60
  "@fluidframework/build-common": "^2.0.3",
61
- "@fluidframework/build-tools": "^0.39.0",
61
+ "@fluidframework/build-tools": "^0.40.0",
62
62
  "@fluidframework/eslint-config-fluid": "^5.3.0",
63
- "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0-rc.5.0.0",
63
+ "@fluidframework/runtime-definitions-previous": "npm:@fluidframework/runtime-definitions@2.0.0",
64
64
  "@microsoft/api-extractor": "^7.45.1",
65
65
  "concurrently": "^8.2.1",
66
66
  "copyfiles": "^2.4.1",
@@ -78,16 +78,17 @@
78
78
  "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
79
79
  "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
80
80
  "build": "fluid-build . --task build",
81
+ "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
82
+ "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
83
+ "build:api-reports:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
81
84
  "build:compile": "fluid-build . --task compile",
82
- "build:docs": "concurrently \"npm:build:docs:*\"",
83
- "build:docs:current": "api-extractor run --local",
84
- "build:docs:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
85
+ "build:docs": "api-extractor run --local",
85
86
  "build:esnext": "tsc --project ./tsconfig.json",
86
87
  "build:test": "npm run build:test:esm && npm run build:test:cjs",
87
88
  "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
88
89
  "build:test:esm": "tsc --project ./src/test/tsconfig.json",
89
90
  "check:are-the-types-wrong": "attw --pack .",
90
- "check:biome": "biome check . --formatter-enabled=true",
91
+ "check:biome": "biome check .",
91
92
  "check:exports": "concurrently \"npm:check:exports:*\"",
92
93
  "check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
93
94
  "check:exports:cjs:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
@@ -96,14 +97,15 @@
96
97
  "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
97
98
  "check:format": "npm run check:biome",
98
99
  "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
99
- "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
100
- "ci:build:docs:current": "api-extractor run",
101
- "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
100
+ "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
101
+ "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
102
+ "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
103
+ "ci:build:docs": "api-extractor run",
102
104
  "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
103
105
  "eslint": "eslint --format stylish src",
104
106
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
105
107
  "format": "npm run format:biome",
106
- "format:biome": "biome check . --formatter-enabled=true --apply",
108
+ "format:biome": "biome check . --write",
107
109
  "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
108
110
  "lint": "fluid-build . --task lint",
109
111
  "lint:fix": "fluid-build . --task eslint:fix --task format",