@fluid-experimental/data-objects 2.0.0-internal.7.2.2 → 2.0.0-internal.7.3.0

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 +74 -2
  3. package/package.json +13 -13
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluid-experimental/data-objects
2
2
 
3
+ ## 2.0.0-internal.7.3.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.0.0-internal.7.2.0
4
8
 
5
9
  Dependency updates only.
package/README.md CHANGED
@@ -1,5 +1,77 @@
1
1
  # @fluid-experimental/data-objects
2
2
 
3
- A collection of ready to use Fluid Data Objects
3
+ A collection of ready to use Fluid Data Objects.
4
4
 
5
- See [GitHub](https://github.com/microsoft/FluidFramework) for more details on the Fluid Framework and packages within.
5
+ <!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE) -->
6
+
7
+ <!-- prettier-ignore-start -->
8
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
9
+
10
+ **IMPORTANT: This package is experimental.**
11
+ **Its APIs may change without notice.**
12
+
13
+ **Do not use in production scenarios.**
14
+
15
+ ## Using Fluid Framework libraries
16
+
17
+ When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
18
+ While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
19
+ library consumers should always prefer `^`.
20
+
21
+ Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
22
+ you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
23
+ Standard `^` and `~` ranges will not work as expected.
24
+ See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
25
+ package for more information including tools to convert between version schemes.
26
+
27
+ ## Installation
28
+
29
+ To get started, install the package by running the following command:
30
+
31
+ ```bash
32
+ npm i @fluid-experimental/data-objects
33
+ ```
34
+
35
+ ## API Documentation
36
+
37
+ API documentation for **@fluid-experimental/data-objects** is available at <https://fluidframework.com/docs/apis/data-objects>.
38
+
39
+ ## Contribution Guidelines
40
+
41
+ There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
42
+
43
+ - Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
44
+ - [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
45
+ - Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
46
+ - [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
47
+
48
+ Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
49
+
50
+ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
51
+ 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.
52
+
53
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
54
+ Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
55
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
56
+
57
+ ## Help
58
+
59
+ Not finding what you're looking for in this README? Check out our [GitHub
60
+ Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
61
+
62
+ Still not finding what you're looking for? Please [file an
63
+ issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
64
+
65
+ Thank you!
66
+
67
+ ## Trademark
68
+
69
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
70
+
71
+ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
72
+
73
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
74
+
75
+ <!-- prettier-ignore-end -->
76
+
77
+ <!-- AUTO-GENERATED-CONTENT:END -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluid-experimental/data-objects",
3
- "version": "2.0.0-internal.7.2.2",
3
+ "version": "2.0.0-internal.7.3.0",
4
4
  "description": "A collection of ready to use Fluid Data Objects",
5
5
  "homepage": "https://fluidframework.com",
6
6
  "repository": {
@@ -15,21 +15,21 @@
15
15
  "module": "lib/index.js",
16
16
  "types": "dist/index.d.ts",
17
17
  "dependencies": {
18
- "@fluid-internal/client-utils": ">=2.0.0-internal.7.2.2 <2.0.0-internal.7.3.0",
19
- "@fluidframework/aqueduct": ">=2.0.0-internal.7.2.2 <2.0.0-internal.7.3.0",
20
- "@fluidframework/core-interfaces": ">=2.0.0-internal.7.2.2 <2.0.0-internal.7.3.0",
21
- "@fluidframework/core-utils": ">=2.0.0-internal.7.2.2 <2.0.0-internal.7.3.0",
22
- "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.2.2 <2.0.0-internal.7.3.0",
23
- "@fluidframework/map": ">=2.0.0-internal.7.2.2 <2.0.0-internal.7.3.0",
24
- "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.2.2 <2.0.0-internal.7.3.0",
18
+ "@fluid-internal/client-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
19
+ "@fluidframework/aqueduct": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
20
+ "@fluidframework/core-interfaces": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
21
+ "@fluidframework/core-utils": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
22
+ "@fluidframework/datastore-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
23
+ "@fluidframework/map": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
24
+ "@fluidframework/runtime-definitions": ">=2.0.0-internal.7.3.0 <2.0.0-internal.7.4.0",
25
25
  "events": "^3.1.0"
26
26
  },
27
27
  "devDependencies": {
28
- "@fluid-tools/build-cli": "^0.26.1",
28
+ "@fluid-tools/build-cli": "^0.28.0",
29
29
  "@fluidframework/build-common": "^2.0.3",
30
- "@fluidframework/build-tools": "^0.26.1",
31
- "@fluidframework/eslint-config-fluid": "^3.0.0",
32
- "@microsoft/api-extractor": "^7.37.0",
30
+ "@fluidframework/build-tools": "^0.28.0",
31
+ "@fluidframework/eslint-config-fluid": "^3.1.0",
32
+ "@microsoft/api-extractor": "^7.38.3",
33
33
  "@types/node": "^16.18.38",
34
34
  "cross-env": "^7.0.3",
35
35
  "eslint": "~8.50.0",
@@ -46,7 +46,7 @@
46
46
  "build:commonjs": "fluid-build . --task commonjs",
47
47
  "build:compile": "fluid-build . --task compile",
48
48
  "build:esnext": "tsc --project ./tsconfig.esnext.json",
49
- "clean": "rimraf --glob dist lib \"*.tsbuildinfo\" \"*.build.log\"",
49
+ "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\"",
50
50
  "eslint": "eslint --format stylish src",
51
51
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
52
52
  "format": "npm run prettier:fix",