@fluidframework/datastore-definitions
Advanced tools
Comparing version 2.1.0-281041 to 2.1.0
# @fluidframework/datastore-definitions | ||
## 2.1.0 | ||
Dependency updates only. | ||
## 2.0.0-rc.5.0.0 | ||
@@ -4,0 +8,0 @@ |
{ | ||
"name": "@fluidframework/datastore-definitions", | ||
"version": "2.1.0-281041", | ||
"version": "2.1.0", | ||
"description": "Fluid data store definitions", | ||
@@ -44,7 +44,7 @@ "homepage": "https://fluidframework.com", | ||
"dependencies": { | ||
"@fluidframework/container-definitions": "2.1.0-281041", | ||
"@fluidframework/core-interfaces": "2.1.0-281041", | ||
"@fluidframework/driver-definitions": "2.1.0-281041", | ||
"@fluidframework/id-compressor": "2.1.0-281041", | ||
"@fluidframework/runtime-definitions": "2.1.0-281041" | ||
"@fluidframework/container-definitions": "~2.1.0", | ||
"@fluidframework/core-interfaces": "~2.1.0", | ||
"@fluidframework/driver-definitions": "~2.1.0", | ||
"@fluidframework/id-compressor": "~2.1.0", | ||
"@fluidframework/runtime-definitions": "~2.1.0" | ||
}, | ||
@@ -54,5 +54,5 @@ "devDependencies": { | ||
"@biomejs/biome": "~1.8.3", | ||
"@fluid-tools/build-cli": "^0.40.0", | ||
"@fluid-tools/build-cli": "^0.41.0", | ||
"@fluidframework/build-common": "^2.0.3", | ||
"@fluidframework/build-tools": "^0.40.0", | ||
"@fluidframework/build-tools": "^0.41.0", | ||
"@fluidframework/datastore-definitions-previous": "npm:@fluidframework/datastore-definitions@2.0.0", | ||
@@ -59,0 +59,0 @@ "@fluidframework/eslint-config-fluid": "^5.3.0", |
@@ -5,3 +5,3 @@ # @fluidframework/datastore-definitions | ||
<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) --> | ||
<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_HEADER) --> | ||
@@ -19,2 +19,23 @@ <!-- prettier-ignore-start --> | ||
## Installation | ||
To get started, install the package by running the following command: | ||
```bash | ||
npm i @fluidframework/datastore-definitions | ||
``` | ||
## Importing from this package | ||
This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level. | ||
For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels). | ||
To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/datastore-definitions` like normal. | ||
To access the `legacy` APIs, import via `@fluidframework/datastore-definitions/legacy`. | ||
## API Documentation | ||
API documentation for **@fluidframework/datastore-definitions** is available at <https://fluidframework.com/docs/apis/datastore-definitions>. | ||
<!-- prettier-ignore-end --> | ||
@@ -48,3 +69,3 @@ | ||
<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) --> | ||
<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README_FOOTER) --> | ||
@@ -54,2 +75,72 @@ <!-- prettier-ignore-start --> | ||
## Minimum Client Requirements | ||
These are the platform requirements for the current version of Fluid Framework Client Packages. | ||
These requirements err on the side of being too strict since within a major version they can be relaxed over time, but not made stricter. | ||
For Long Term Support (LTS) versions this can require supporting these platforms for several years. | ||
It is likely that other configurations will work, but they are not supported: if they stop working, we do not consider that a bug. | ||
If you would benefit from support for something not listed here, file an issue and the product team will evaluate your request. | ||
When making such a request please include if the configuration already works (and thus the request is just that it becomes officially supported), or if changes are required to get it working. | ||
### Supported Runtimes | ||
- NodeJs ^20.10.0 except that we will drop support for it [when NodeJs 20 loses its upstream support on 2026-04-30](https://github.com/nodejs/release#release-schedule), and will support a newer LTS version of NodeJS (22) at least 1 year before 20 is end-of-life. This same policy applies to NodeJS 22 when it is end of life (2027-04-30). | ||
- Modern browsers supporting the es2022 standard library: in response to asks we can add explicit support for using babel to polyfill to target specific standards or runtimes (meaning we can avoid/remove use of things that don't polyfill robustly, but otherwise target modern standards). | ||
### Supported Tools | ||
- TypeScript 5.4: | ||
- All [`strict`](https://www.typescriptlang.org/tsconfig) options are supported. | ||
- [`strictNullChecks`](https://www.typescriptlang.org/tsconfig) is required. | ||
- [Configuration options deprecated in 5.0](https://github.com/microsoft/TypeScript/issues/51909) are not supported. | ||
- `exactOptionalPropertyTypes` is currently not fully supported. | ||
If used, narrowing members of Fluid Framework types types using `in`, `Reflect.has`, `Object.hasOwn` or `Object.prototype.hasOwnProperty` should be avoided as they may incorrectly exclude `undefined` from the possible values in some cases. | ||
- [webpack](https://webpack.js.org/) 5 | ||
- We are not intending to be prescriptive about what bundler to use. | ||
Other bundlers which can handle ES Modules should work, but webpack is the only one we actively test. | ||
### Module Resolution | ||
[`Node16`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) resolution should be used with TypeScript compilerOptions to follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm). | ||
Node10 resolution is not supported as it does not support Fluid Framework's API structuring pattern that is used to distinguish stable APIs from those that are in development. | ||
### Module Formats | ||
- ES Modules: | ||
ES Modules are the preferred way to consume our client packages (including in NodeJs) and consuming our client packages from ES Modules is fully supported. | ||
- CommonJs: | ||
Consuming our client packages as CommonJs is supported only in NodeJS and only for the cases listed below. | ||
This is done to accommodate some workflows without good ES Module support. | ||
If you have a workflow you would like included in this list, file an issue. | ||
Once this list of workflows motivating CommonJS support is empty, we may drop support for CommonJS one year after notice of the change is posted here. | ||
- Testing with Jest (which lacks [stable ESM support](https://jestjs.io/docs/ecmascript-modules) due to [unstable APIs in NodeJs](https://github.com/nodejs/node/issues/37648)) | ||
## Contribution Guidelines | ||
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid. | ||
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions). | ||
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in. | ||
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls). | ||
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md). | ||
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki). | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
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. | ||
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. | ||
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks). | ||
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. | ||
## Help | ||
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/). | ||
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests). | ||
Thank you! | ||
## Trademark | ||
@@ -56,0 +147,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
131733
0
153
+ Added@fluid-internal/client-utils@2.1.2(transitive)
+ Added@fluidframework/container-definitions@2.1.2(transitive)
+ Added@fluidframework/core-interfaces@2.1.2(transitive)
+ Added@fluidframework/core-utils@2.1.2(transitive)
+ Added@fluidframework/driver-definitions@2.1.2(transitive)
+ Added@fluidframework/id-compressor@2.1.2(transitive)
+ Added@fluidframework/runtime-definitions@2.1.2(transitive)
+ Added@fluidframework/telemetry-utils@2.1.2(transitive)
- Removed@fluid-internal/client-utils@2.1.0-281041(transitive)
- Removed@fluidframework/container-definitions@2.1.0-281041(transitive)
- Removed@fluidframework/core-interfaces@2.1.0-281041(transitive)
- Removed@fluidframework/core-utils@2.1.0-281041(transitive)
- Removed@fluidframework/driver-definitions@2.1.0-281041(transitive)
- Removed@fluidframework/id-compressor@2.1.0-281041(transitive)
- Removed@fluidframework/runtime-definitions@2.1.0-281041(transitive)
- Removed@fluidframework/telemetry-utils@2.1.0-281041(transitive)