fluid-framework 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.224419

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 (88) hide show
  1. package/.eslintrc.js +6 -8
  2. package/CHANGELOG.md +113 -0
  3. package/README.md +46 -8
  4. package/api-extractor-lint.json +4 -0
  5. package/api-extractor.json +11 -2
  6. package/api-report/fluid-framework.api.md +2466 -0
  7. package/dist/fluid-framework-alpha.d.ts +2910 -0
  8. package/dist/fluid-framework-beta.d.ts +2207 -0
  9. package/dist/fluid-framework-public.d.ts +1145 -0
  10. package/dist/fluid-framework-untrimmed.d.ts +7558 -0
  11. package/dist/index.cjs +54 -0
  12. package/dist/index.cjs.map +1 -0
  13. package/dist/index.d.ts +13 -9
  14. package/dist/index.d.ts.map +1 -1
  15. package/dist/tsdoc-metadata.json +11 -0
  16. package/lib/fluid-framework-alpha.d.mts +2910 -0
  17. package/lib/fluid-framework-beta.d.mts +2207 -0
  18. package/lib/fluid-framework-public.d.mts +1145 -0
  19. package/lib/fluid-framework-untrimmed.d.mts +7558 -0
  20. package/lib/index.d.mts +15 -0
  21. package/lib/index.d.mts.map +1 -0
  22. package/lib/index.mjs +11 -0
  23. package/lib/index.mjs.map +1 -0
  24. package/package.json +79 -46
  25. package/{src/containerLoader.ts → prettier.config.cjs} +3 -1
  26. package/src/index.ts +96 -9
  27. package/tsconfig.json +11 -16
  28. package/.npmpackagejsonlintrc.json +0 -5
  29. package/dist/containerDefinitions.d.ts +0 -6
  30. package/dist/containerDefinitions.d.ts.map +0 -1
  31. package/dist/containerDefinitions.js +0 -11
  32. package/dist/containerDefinitions.js.map +0 -1
  33. package/dist/containerLoader.d.ts +0 -6
  34. package/dist/containerLoader.d.ts.map +0 -1
  35. package/dist/containerLoader.js +0 -10
  36. package/dist/containerLoader.js.map +0 -1
  37. package/dist/driverDefinitions.d.ts +0 -6
  38. package/dist/driverDefinitions.d.ts.map +0 -1
  39. package/dist/driverDefinitions.js +0 -10
  40. package/dist/driverDefinitions.js.map +0 -1
  41. package/dist/fluidStatic.d.ts +0 -6
  42. package/dist/fluidStatic.d.ts.map +0 -1
  43. package/dist/fluidStatic.js +0 -18
  44. package/dist/fluidStatic.js.map +0 -1
  45. package/dist/index.js +0 -30
  46. package/dist/index.js.map +0 -1
  47. package/dist/map.d.ts +0 -6
  48. package/dist/map.d.ts.map +0 -1
  49. package/dist/map.js +0 -18
  50. package/dist/map.js.map +0 -1
  51. package/dist/sequence.d.ts +0 -6
  52. package/dist/sequence.d.ts.map +0 -1
  53. package/dist/sequence.js +0 -18
  54. package/dist/sequence.js.map +0 -1
  55. package/lib/containerDefinitions.d.ts +0 -6
  56. package/lib/containerDefinitions.d.ts.map +0 -1
  57. package/lib/containerDefinitions.js +0 -6
  58. package/lib/containerDefinitions.js.map +0 -1
  59. package/lib/containerLoader.d.ts +0 -6
  60. package/lib/containerLoader.d.ts.map +0 -1
  61. package/lib/containerLoader.js +0 -6
  62. package/lib/containerLoader.js.map +0 -1
  63. package/lib/driverDefinitions.d.ts +0 -6
  64. package/lib/driverDefinitions.d.ts.map +0 -1
  65. package/lib/driverDefinitions.js +0 -6
  66. package/lib/driverDefinitions.js.map +0 -1
  67. package/lib/fluidStatic.d.ts +0 -6
  68. package/lib/fluidStatic.d.ts.map +0 -1
  69. package/lib/fluidStatic.js +0 -6
  70. package/lib/fluidStatic.js.map +0 -1
  71. package/lib/index.d.ts +0 -18
  72. package/lib/index.d.ts.map +0 -1
  73. package/lib/index.js +0 -18
  74. package/lib/index.js.map +0 -1
  75. package/lib/map.d.ts +0 -6
  76. package/lib/map.d.ts.map +0 -1
  77. package/lib/map.js +0 -6
  78. package/lib/map.js.map +0 -1
  79. package/lib/sequence.d.ts +0 -6
  80. package/lib/sequence.d.ts.map +0 -1
  81. package/lib/sequence.js +0 -6
  82. package/lib/sequence.js.map +0 -1
  83. package/src/containerDefinitions.ts +0 -10
  84. package/src/driverDefinitions.ts +0 -6
  85. package/src/fluidStatic.ts +0 -6
  86. package/src/map.ts +0 -6
  87. package/src/sequence.ts +0 -6
  88. package/tsconfig.esnext.json +0 -7
package/.eslintrc.js CHANGED
@@ -4,11 +4,9 @@
4
4
  */
5
5
 
6
6
  module.exports = {
7
- "extends": [
8
- "@fluidframework/eslint-config-fluid/strict"
9
- ],
10
- "parserOptions": {
11
- "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
12
- },
13
- "rules": {}
14
- }
7
+ extends: ["@fluidframework/eslint-config-fluid/strict", "prettier"],
8
+ parserOptions: {
9
+ project: ["./tsconfig.json"],
10
+ },
11
+ rules: {},
12
+ };
package/CHANGELOG.md ADDED
@@ -0,0 +1,113 @@
1
+ # fluid-framework
2
+
3
+ ## 2.0.0-internal.8.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - azure-client: Removed deprecated FluidStatic classes [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
8
+
9
+ Several FluidStatic classes were unnecessarily exposed and were deprecated in an earlier release. They have been replaced with creation functions. This helps us
10
+ keep implementations decoupled from usage which is easier to maintain and extend. It has very minimal impact on the
11
+ public surface area of downstream packages. The removed classes are as follows:
12
+
13
+ - `AzureAudience` (use `IAzureAudience` instead)
14
+ - `TinyliciousAudience` (use `ITinyliciousAudience` instead)
15
+ - `DOProviderContainerRuntimeFactory`
16
+ - `FluidContainer`
17
+ - `ServiceAudience`
18
+
19
+ ## 2.0.0-internal.7.4.0
20
+
21
+ ### Minor Changes
22
+
23
+ - azure-client: Deprecated FluidStatic Classes ([#18402](https://github.com/microsoft/FluidFramework/issues/18402)) [589ec39de5](https://github.com/microsoft/FluidFramework/commits/589ec39de52116c7f782319e6f6aa61bc5aa9964)
24
+
25
+ Several FluidStatic classes were unnecessarily exposed. They have been replaced with creation functions. This helps us
26
+ keep implementations decoupled from usage which is easier to maintain and extend. It has very minimal impact on the
27
+ public surface area of downstream packages. The deprecated classes are as follows:
28
+
29
+ - `AzureAudience` (use `IAzureAudience` instead)
30
+ - `TinyliciousAudience` (use `ITinyliciousAudience` instead)
31
+ - `DOProviderContainerRuntimeFactory`
32
+ - `FluidContainer`
33
+ - `ServiceAudience`
34
+
35
+ ## 2.0.0-internal.7.3.0
36
+
37
+ Dependency updates only.
38
+
39
+ ## 2.0.0-internal.7.2.0
40
+
41
+ Dependency updates only.
42
+
43
+ ## 2.0.0-internal.7.1.0
44
+
45
+ Dependency updates only.
46
+
47
+ ## 2.0.0-internal.7.0.0
48
+
49
+ ### Major Changes
50
+
51
+ - Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
52
+
53
+ The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
54
+
55
+ ## 2.0.0-internal.6.4.0
56
+
57
+ Dependency updates only.
58
+
59
+ ## 2.0.0-internal.6.3.0
60
+
61
+ Dependency updates only.
62
+
63
+ ## 2.0.0-internal.6.2.0
64
+
65
+ Dependency updates only.
66
+
67
+ ## 2.0.0-internal.6.1.0
68
+
69
+ Dependency updates only.
70
+
71
+ ## 2.0.0-internal.6.0.0
72
+
73
+ ### Major Changes
74
+
75
+ - IntervalConflictResolver removed [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
76
+
77
+ IntervalConflictResolver has been removed. Any lingering usages in application code can be removed as well. This change also marks APIs deprecated in #14318 as internal.
78
+
79
+ - RootDataObject and RootDataObjectProps no longer exported from fluid-static or fluid-framework packages [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
80
+
81
+ RootDataObject and RootDataObjectProps are internal implementations and not intended for direct use. Instead use IRootDataObject to refer to the root data object.
82
+
83
+ - Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
84
+
85
+ Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
86
+
87
+ ## 2.0.0-internal.5.4.0
88
+
89
+ Dependency updates only.
90
+
91
+ ## 2.0.0-internal.5.3.0
92
+
93
+ Dependency updates only.
94
+
95
+ ## 2.0.0-internal.5.2.0
96
+
97
+ Dependency updates only.
98
+
99
+ ## 2.0.0-internal.5.1.0
100
+
101
+ Dependency updates only.
102
+
103
+ ## 2.0.0-internal.5.0.0
104
+
105
+ Dependency updates only.
106
+
107
+ ## 2.0.0-internal.4.4.0
108
+
109
+ Dependency updates only.
110
+
111
+ ## 2.0.0-internal.4.1.0
112
+
113
+ Dependency updates only.
package/README.md CHANGED
@@ -2,17 +2,39 @@
2
2
 
3
3
  The `fluid-framework` package bundles a collection of Fluid Framework client packages for easy use when paired with a corresponding service client package (ex. `@fluidframework/azure-client` & `@fluidframework/tinylicious-client`).
4
4
 
5
+ <!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
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
+ ## Using Fluid Framework libraries
11
+
12
+ When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
13
+ While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
14
+ library consumers should always prefer `^`.
15
+
16
+ Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
17
+ 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`).
18
+ Standard `^` and `~` ranges will not work as expected.
19
+ See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
20
+ package for more information including tools to convert between version schemes.
21
+
22
+ <!-- prettier-ignore-end -->
23
+
24
+ <!-- AUTO-GENERATED-CONTENT:END -->
25
+
5
26
  ## Contents
6
27
 
7
- The `fluid-framework` package consists primarily of two portions: the `IFluidContainer` and a selection of distributed data structures (DDSes).
28
+ The `fluid-framework` package consists primarily of two portions: the `IFluidContainer` and a selection of distributed data structures (DDSes).
8
29
 
9
30
  ### IFluidContainer
10
31
 
11
- The **[IFluidContainer][]** interface is the one of the types returned by calls to `createContainer()` and `getContainer()` on the service clients such as `AzureClient`. It includes functionality to retrieve the Fluid data contained within, as well as to inspect the state of the collaboration session connection.
32
+ The **[IFluidContainer][]** interface is the one of the types returned by calls to `createContainer()` and `getContainer()` on the service clients such as `AzureClient`. It includes functionality to retrieve the Fluid data contained within, as well as to inspect the state of the collaboration session connection.
12
33
 
13
34
  ### DDS packages
14
35
 
15
- You'll use one or more DDS data structures in your container to model your collaborative data. The `fluid-framework` package comes with three data structures that cover a broad range of scenarios:
36
+ You'll use one or more DDS data structures in your container to model your collaborative data. The `fluid-framework` package comes with three data structures that cover a broad range of scenarios:
37
+
16
38
  1. **[SharedMap][]**, a map-like data structure for storing key/value pair data
17
39
  2. **[SharedDirectory][]**, a map-like data structure with ability to organize keys into subdirectories
18
40
  3. **[SharedString][]**, a data structure for string data
@@ -21,10 +43,26 @@ You'll use one or more DDS data structures in your container to model your colla
21
43
 
22
44
  Check out the Hello World tutorial using the `fluid-framework` package [here](https://fluidframework.com/docs/start/tutorial/).
23
45
 
24
- See [GitHub](https://github.com/microsoft/FluidFramework) for more details on the Fluid Framework and packages within.
46
+ <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
47
+
48
+ <!-- prettier-ignore-start -->
49
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
50
+
51
+ ## Trademark
52
+
53
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
54
+
55
+ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
56
+
57
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
58
+
59
+ <!-- prettier-ignore-end -->
60
+
61
+ <!-- AUTO-GENERATED-CONTENT:END -->
25
62
 
26
63
  <!-- Links -->
27
- [IFluidContainer]: https://fluidframework.com/docs/apis/fluid-static/ifluidcontainer/
28
- [SharedMap]: https://fluidframework.com/docs/apis/map/sharedmap/
29
- [SharedDirectory]: https://fluidframework.com/docs/apis/map/shareddirectory/
30
- [SharedString]: https://fluidframework.com/docs/apis/sequence/sharedstring/
64
+
65
+ [ifluidcontainer]: https://fluidframework.com/docs/apis/fluid-static/ifluidcontainer/
66
+ [sharedmap]: https://fluidframework.com/docs/apis/map/sharedmap/
67
+ [shareddirectory]: https://fluidframework.com/docs/apis/map/shareddirectory/
68
+ [sharedstring]: https://fluidframework.com/docs/apis/sequence/sharedstring/
@@ -0,0 +1,4 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "../../../common/build/build-common/api-extractor-lint.json"
4
+ }
@@ -1,4 +1,13 @@
1
1
  {
2
- "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "@fluidframework/build-common/api-extractor-common-strict.json"
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "../../../common/build/build-common/api-extractor-base.json",
4
+ "bundledPackages": ["@fluidframework/map", "@fluidframework/tree"],
5
+ "messages": {
6
+ "extractorMessageReporting": {
7
+ // TODO: Add missing documentation and remove this rule override
8
+ "ae-undocumented": {
9
+ "logLevel": "none"
10
+ }
11
+ }
12
+ }
4
13
  }