@fluidframework/counter 2.1.0-276326 → 2.1.0-276985

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.
package/README.md CHANGED
@@ -7,15 +7,35 @@
7
7
 
8
8
  ## Using Fluid Framework libraries
9
9
 
10
- When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
10
+ When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
11
11
  While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
12
12
  library consumers should always prefer `^`.
13
13
 
14
+ If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
15
+
16
+ <!-- prettier-ignore-end -->
17
+
18
+ <!-- AUTO-GENERATED-CONTENT:END -->
19
+
20
+ <!-- AUTO-GENERATED-CONTENT:START (README_IMPORT_INSTRUCTIONS:includeHeading=TRUE) -->
21
+
22
+ <!-- prettier-ignore-start -->
23
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
24
+
25
+ ## Importing from this package
26
+
27
+ This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
28
+ For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
29
+
30
+ To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/counter` like normal.
31
+
32
+ To access the `legacy` APIs, import via `@fluidframework/counter/legacy`.
33
+
14
34
  <!-- prettier-ignore-end -->
15
35
 
16
36
  <!-- AUTO-GENERATED-CONTENT:END -->
17
37
 
18
- ## Introduction
38
+ ## SharedCounter
19
39
 
20
40
  The `SharedCounter` distributed data structure (DDS) is used to store an integer counter value that can be modified by multiple clients simultaneously.
21
41
  The data structure affords incrementing and decrementing the shared value via its `increment` method. Decrements are done by providing a negative value.
@@ -153,24 +173,40 @@ This causes the `incremented` event to be sent to all of the clients who have th
153
173
 
154
174
  Since `updateCounterValueLabel` is listening for all `incremented` events, the view will always refresh with the appropriate updated value any time a collaborator increments or decrements the counter value.
155
175
 
156
- <!-- AUTO-GENERATED-CONTENT:START (README_API_DOCS_SECTION:includeHeading=TRUE) -->
176
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE&installation=FALSE&importInstructions=FALSE) -->
157
177
 
158
178
  <!-- prettier-ignore-start -->
159
-
160
- <!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
179
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
161
180
 
162
181
  ## API Documentation
163
182
 
164
183
  API documentation for **@fluidframework/counter** is available at <https://fluidframework.com/docs/apis/counter>.
165
184
 
166
- <!-- prettier-ignore-end -->
185
+ ## Contribution Guidelines
167
186
 
168
- <!-- AUTO-GENERATED-CONTENT:END -->
187
+ There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
169
188
 
170
- <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
189
+ - Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
190
+ - [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
191
+ - Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
192
+ - [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
171
193
 
172
- <!-- prettier-ignore-start -->
173
- <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
194
+ Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
195
+
196
+ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
197
+ 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.
198
+
199
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
200
+ Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
201
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
202
+
203
+ ## Help
204
+
205
+ Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
206
+
207
+ Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
208
+
209
+ Thank you!
174
210
 
175
211
  ## Trademark
176
212
 
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/counter";
8
- export declare const pkgVersion = "2.1.0-276326";
8
+ export declare const pkgVersion = "2.1.0-276985";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -8,5 +8,5 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.pkgVersion = exports.pkgName = void 0;
10
10
  exports.pkgName = "@fluidframework/counter";
11
- exports.pkgVersion = "2.1.0-276326";
11
+ exports.pkgVersion = "2.1.0-276985";
12
12
  //# sourceMappingURL=packageVersion.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,yBAAyB,CAAC;AACpC,QAAA,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/counter\";\nexport const pkgVersion = \"2.1.0-276326\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,yBAAyB,CAAC;AACpC,QAAA,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/counter\";\nexport const pkgVersion = \"2.1.0-276985\";\n"]}
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/counter";
8
- export declare const pkgVersion = "2.1.0-276326";
8
+ export declare const pkgVersion = "2.1.0-276985";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export const pkgName = "@fluidframework/counter";
8
- export const pkgVersion = "2.1.0-276326";
8
+ export const pkgVersion = "2.1.0-276985";
9
9
  //# sourceMappingURL=packageVersion.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,yBAAyB,CAAC;AACjD,MAAM,CAAC,MAAM,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/counter\";\nexport const pkgVersion = \"2.1.0-276326\";\n"]}
1
+ {"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,yBAAyB,CAAC;AACjD,MAAM,CAAC,MAAM,UAAU,GAAG,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/counter\";\nexport const pkgVersion = \"2.1.0-276985\";\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/counter",
3
- "version": "2.1.0-276326",
3
+ "version": "2.1.0-276985",
4
4
  "description": "Counter DDS",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -67,25 +67,25 @@
67
67
  "temp-directory": "nyc/.nyc_output"
68
68
  },
69
69
  "dependencies": {
70
- "@fluidframework/core-interfaces": "2.1.0-276326",
71
- "@fluidframework/core-utils": "2.1.0-276326",
72
- "@fluidframework/datastore-definitions": "2.1.0-276326",
73
- "@fluidframework/driver-definitions": "2.1.0-276326",
74
- "@fluidframework/driver-utils": "2.1.0-276326",
75
- "@fluidframework/runtime-definitions": "2.1.0-276326",
76
- "@fluidframework/shared-object-base": "2.1.0-276326"
70
+ "@fluidframework/core-interfaces": "2.1.0-276985",
71
+ "@fluidframework/core-utils": "2.1.0-276985",
72
+ "@fluidframework/datastore-definitions": "2.1.0-276985",
73
+ "@fluidframework/driver-definitions": "2.1.0-276985",
74
+ "@fluidframework/driver-utils": "2.1.0-276985",
75
+ "@fluidframework/runtime-definitions": "2.1.0-276985",
76
+ "@fluidframework/shared-object-base": "2.1.0-276985"
77
77
  },
78
78
  "devDependencies": {
79
79
  "@arethetypeswrong/cli": "^0.15.2",
80
80
  "@biomejs/biome": "^1.7.3",
81
- "@fluid-internal/mocha-test-setup": "2.1.0-276326",
81
+ "@fluid-internal/mocha-test-setup": "2.1.0-276985",
82
82
  "@fluid-tools/build-cli": "^0.39.0",
83
83
  "@fluidframework/build-common": "^2.0.3",
84
84
  "@fluidframework/build-tools": "^0.39.0",
85
- "@fluidframework/container-definitions": "2.1.0-276326",
85
+ "@fluidframework/container-definitions": "2.1.0-276985",
86
86
  "@fluidframework/counter-previous": "npm:@fluidframework/counter@2.0.0-rc.5.0.0",
87
87
  "@fluidframework/eslint-config-fluid": "^5.3.0",
88
- "@fluidframework/test-runtime-utils": "2.1.0-276326",
88
+ "@fluidframework/test-runtime-utils": "2.1.0-276985",
89
89
  "@microsoft/api-extractor": "^7.45.1",
90
90
  "@types/mocha": "^9.1.1",
91
91
  "@types/node": "^18.19.0",
@@ -6,4 +6,4 @@
6
6
  */
7
7
 
8
8
  export const pkgName = "@fluidframework/counter";
9
- export const pkgVersion = "2.1.0-276326";
9
+ export const pkgVersion = "2.1.0-276985";