@fluid-internal/client-utils 2.1.0-281041 → 2.1.1

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 (3) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +42 -12
  3. package/package.json +8 -8
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluid-internal/client-utils
2
2
 
3
+ ## 2.1.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.0.0-rc.5.0.0
4
8
 
5
9
  Dependency updates only.
package/README.md CHANGED
@@ -3,11 +3,32 @@
3
3
  This package is intended for sharing and promoting utility functions across packages in the Fluid Framework repo,
4
4
  primarily within the client release group.
5
5
 
6
- <!-- AUTO-GENERATED-CONTENT:START (README_PACKAGE_SCOPE_NOTICE) -->
6
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) -->
7
+
8
+ <!-- prettier-ignore-start -->
9
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
7
10
 
8
11
  **IMPORTANT: This package is intended strictly as an implementation detail of the Fluid Framework and is not intended for public consumption.**
9
12
  **We make no stability guarantees regarding its APIs.**
10
13
 
14
+ ## Using Fluid Framework libraries
15
+
16
+ When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
17
+ While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
18
+ library consumers should always prefer `^`.
19
+
20
+ If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
21
+
22
+ ## Installation
23
+
24
+ To get started, install the package by running the following command:
25
+
26
+ ```bash
27
+ npm i @fluid-internal/client-utils
28
+ ```
29
+
30
+ <!-- prettier-ignore-end -->
31
+
11
32
  <!-- AUTO-GENERATED-CONTENT:END -->
12
33
 
13
34
  ## Adding code to this package
@@ -72,27 +93,36 @@ be the same as browser. (Both report sets use the same target files.)
72
93
  Package scripts `check:exports:esm:indexBrowser:legacy` and `check:exports:esm:indexNode:legacy` are not
73
94
  verifying actual exports, but the consistency of tags within the legacy API set.
74
95
 
75
- <!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
96
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) -->
76
97
 
77
98
  <!-- prettier-ignore-start -->
78
99
  <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
79
100
 
80
- ## Using Fluid Framework libraries
101
+ ## Contribution Guidelines
81
102
 
82
- When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
83
- While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
84
- library consumers should always prefer `^`.
103
+ There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
85
104
 
86
- If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
105
+ - Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
106
+ - [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
107
+ - Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
108
+ - [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
87
109
 
88
- <!-- prettier-ignore-end -->
110
+ Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
89
111
 
90
- <!-- AUTO-GENERATED-CONTENT:END -->
112
+ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
113
+ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
91
114
 
92
- <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
115
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
116
+ Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
117
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
93
118
 
94
- <!-- prettier-ignore-start -->
95
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
119
+ ## Help
120
+
121
+ Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
122
+
123
+ Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
124
+
125
+ Thank you!
96
126
 
97
127
  ## Trademark
98
128
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluid-internal/client-utils",
3
- "version": "2.1.0-281041",
3
+ "version": "2.1.1",
4
4
  "description": "Not intended for use outside the Fluid Framework.",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -67,8 +67,8 @@
67
67
  "temp-directory": "nyc/.nyc_output"
68
68
  },
69
69
  "dependencies": {
70
- "@fluidframework/core-interfaces": "2.1.0-281041",
71
- "@fluidframework/core-utils": "2.1.0-281041",
70
+ "@fluidframework/core-interfaces": "~2.1.1",
71
+ "@fluidframework/core-utils": "~2.1.1",
72
72
  "@types/events_pkg": "npm:@types/events@^3.0.0",
73
73
  "base64-js": "^1.5.1",
74
74
  "buffer": "^6.0.3",
@@ -78,16 +78,16 @@
78
78
  "devDependencies": {
79
79
  "@arethetypeswrong/cli": "^0.15.2",
80
80
  "@biomejs/biome": "~1.8.3",
81
- "@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.0.0",
82
- "@fluid-internal/mocha-test-setup": "2.1.0-281041",
83
- "@fluid-tools/build-cli": "^0.40.0",
81
+ "@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.1.0",
82
+ "@fluid-internal/mocha-test-setup": "~2.1.1",
83
+ "@fluid-tools/build-cli": "^0.41.0",
84
84
  "@fluidframework/build-common": "^2.0.3",
85
- "@fluidframework/build-tools": "^0.40.0",
85
+ "@fluidframework/build-tools": "^0.41.0",
86
86
  "@fluidframework/eslint-config-fluid": "^5.3.0",
87
87
  "@microsoft/api-extractor": "^7.45.1",
88
88
  "@types/base64-js": "^1.3.0",
89
89
  "@types/jest": "29.5.3",
90
- "@types/jest-environment-puppeteer": "2.1.0-281041",
90
+ "@types/jest-environment-puppeteer": "~2.1.1",
91
91
  "@types/mocha": "^9.1.1",
92
92
  "@types/node": "^18.19.0",
93
93
  "@types/rewire": "^2.5.28",