fluid-framework 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 +38 -28
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -9,6 +9,41 @@ There are some packages there are not included as part of this `fluid-framework`
|
|
|
9
9
|
- Fluid Framework [developer tools](https://github.com/microsoft/FluidFramework/tree/main/packages/tools/devtools/devtools).
|
|
10
10
|
- `@fluidframework/app-insights-logger`: to route Fluid telemetry to Azure App Insights.
|
|
11
11
|
|
|
12
|
+
<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
|
|
13
|
+
|
|
14
|
+
<!-- prettier-ignore-start -->
|
|
15
|
+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
16
|
+
|
|
17
|
+
## Using Fluid Framework libraries
|
|
18
|
+
|
|
19
|
+
When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
|
|
20
|
+
While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
|
|
21
|
+
library consumers should always prefer `^`.
|
|
22
|
+
|
|
23
|
+
If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
|
|
24
|
+
|
|
25
|
+
<!-- prettier-ignore-end -->
|
|
26
|
+
|
|
27
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
28
|
+
|
|
29
|
+
<!-- AUTO-GENERATED-CONTENT:START (README_IMPORT_INSTRUCTIONS:includeHeading=TRUE) -->
|
|
30
|
+
|
|
31
|
+
<!-- prettier-ignore-start -->
|
|
32
|
+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
33
|
+
|
|
34
|
+
## Importing from this package
|
|
35
|
+
|
|
36
|
+
This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
|
|
37
|
+
For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
|
|
38
|
+
|
|
39
|
+
To access the `public` ([SemVer](https://semver.org/)) APIs, import via `fluid-framework` like normal.
|
|
40
|
+
|
|
41
|
+
To access the `legacy` APIs, import via `fluid-framework/legacy`.
|
|
42
|
+
|
|
43
|
+
<!-- prettier-ignore-end -->
|
|
44
|
+
|
|
45
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
46
|
+
|
|
12
47
|
## Contents
|
|
13
48
|
|
|
14
49
|
The `fluid-framework` package consists primarily of two portions: the `IFluidContainer` and a selection of distributed data structures (DDSes).
|
|
@@ -31,34 +66,11 @@ The `fluid-framework` package offers the following data structures:
|
|
|
31
66
|
|
|
32
67
|
Check out the [Hello World tutorial](https://fluidframework.com/docs/start/tutorial/) using `fluid-framework`.
|
|
33
68
|
|
|
34
|
-
<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE) -->
|
|
69
|
+
<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE&installation=FALSE&importInstructions=FALSE) -->
|
|
35
70
|
|
|
36
71
|
<!-- prettier-ignore-start -->
|
|
37
72
|
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
38
73
|
|
|
39
|
-
## Using Fluid Framework libraries
|
|
40
|
-
|
|
41
|
-
When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
|
|
42
|
-
While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
|
|
43
|
-
library consumers should always prefer `^`.
|
|
44
|
-
|
|
45
|
-
## Installation
|
|
46
|
-
|
|
47
|
-
To get started, install the package by running the following command:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
npm i fluid-framework
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
## Importing from this package
|
|
54
|
-
|
|
55
|
-
This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
|
|
56
|
-
For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
|
|
57
|
-
|
|
58
|
-
To access the `public` ([SemVer](https://semver.org/)) APIs, import via `fluid-framework` like normal.
|
|
59
|
-
|
|
60
|
-
To access the `legacy` APIs, import via `fluid-framework/legacy`.
|
|
61
|
-
|
|
62
74
|
## API Documentation
|
|
63
75
|
|
|
64
76
|
API documentation for **fluid-framework** is available at <https://fluidframework.com/docs/apis/fluid-framework>.
|
|
@@ -83,11 +95,9 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
|
|
|
83
95
|
|
|
84
96
|
## Help
|
|
85
97
|
|
|
86
|
-
Not finding what you're looking for in this README? Check out
|
|
87
|
-
Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
|
|
98
|
+
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
|
|
88
99
|
|
|
89
|
-
Still not finding what you're looking for? Please [file an
|
|
90
|
-
issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
|
|
100
|
+
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
|
|
91
101
|
|
|
92
102
|
Thank you!
|
|
93
103
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fluid-framework",
|
|
3
|
-
"version": "2.1.0-
|
|
3
|
+
"version": "2.1.0-276985",
|
|
4
4
|
"description": "The main entry point into Fluid Framework public packages",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -37,15 +37,15 @@
|
|
|
37
37
|
"main": "lib/index.js",
|
|
38
38
|
"types": "lib/public.d.ts",
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@fluidframework/container-definitions": "2.1.0-
|
|
41
|
-
"@fluidframework/container-loader": "2.1.0-
|
|
42
|
-
"@fluidframework/core-interfaces": "2.1.0-
|
|
43
|
-
"@fluidframework/driver-definitions": "2.1.0-
|
|
44
|
-
"@fluidframework/fluid-static": "2.1.0-
|
|
45
|
-
"@fluidframework/map": "2.1.0-
|
|
46
|
-
"@fluidframework/sequence": "2.1.0-
|
|
47
|
-
"@fluidframework/shared-object-base": "2.1.0-
|
|
48
|
-
"@fluidframework/tree": "2.1.0-
|
|
40
|
+
"@fluidframework/container-definitions": "2.1.0-276985",
|
|
41
|
+
"@fluidframework/container-loader": "2.1.0-276985",
|
|
42
|
+
"@fluidframework/core-interfaces": "2.1.0-276985",
|
|
43
|
+
"@fluidframework/driver-definitions": "2.1.0-276985",
|
|
44
|
+
"@fluidframework/fluid-static": "2.1.0-276985",
|
|
45
|
+
"@fluidframework/map": "2.1.0-276985",
|
|
46
|
+
"@fluidframework/sequence": "2.1.0-276985",
|
|
47
|
+
"@fluidframework/shared-object-base": "2.1.0-276985",
|
|
48
|
+
"@fluidframework/tree": "2.1.0-276985"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@arethetypeswrong/cli": "^0.15.2",
|