@openfeature/server-sdk - npm Package Compare versions

Comparing version 1.13.2 to 1.13.3

package.json

 {
   "name": "@openfeature/server-sdk",
-  "version": "1.13.2",
+  "version": "1.13.3",
   "description": "OpenFeature SDK for JavaScript",
@@ -5,0 +5,0 @@ "main": "./dist/cjs/index.js",

README.md

@@ -19,4 +19,4 @@ <!-- markdownlint-disable MD033 -->
   <!-- x-release-please-start-version -->
-  <a href="https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.13.2">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.13.2&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.13.3">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.13.3&color=blue&style=for-the-badge" />
   </a>
@@ -40,3 +40,3 @@ <!-- x-release-please-end -->
 
-[OpenFeature](https://openfeature.dev) is an open specification that provides a vendor-agnostic, community-driven API for feature flagging that works with your favorite feature flag management tool.
+[OpenFeature](https://openfeature.dev) is an open specification that provides a vendor-agnostic, community-driven API for feature flagging that works with your favorite feature flag management tool or in-house solution.
 
@@ -66,2 +66,7 @@ <!-- x-hide-in-docs-end -->
 
+> [!NOTE]  
+> `@openfeature/core` contains common components used by all OpenFeature JavaScript implementations.
+> Every SDK version has a requirement on a single, specific version of this dependency.
+> For more information, and similar implications on libraries developed with OpenFeature see [considerations when extending](#considerations).
+
 ### Usage
@@ -368,1 +373,9 @@
 > Built a new hook? [Let us know](https://github.com/open-feature/openfeature.dev/issues/new?assignees=&labels=hook&projects=&template=document-hook.yaml&title=%5BHook%5D%3A+) so we can add it to the docs!
+
+### Considerations
+
+When developing a library based on OpenFeature components, it's important to list the `@openfeature/server-sdk` as a `peerDependency` of your package.
+This is a general best-practice when developing JavaScript libraries that have dependencies in common with their consuming application.
+Failing to do this can result in multiple copies of the OpenFeature SDK in the consumer, which can lead to type errors, and broken singleton behavior.
+The `@openfeature/core` package itself follows this pattern: the `@openfeature/server-sdk` has a peer dependency on `@openfeature/core`, and uses whatever copy of that module the consumer has installed (note that NPM installs peers automatically unless `--legacy-peer-deps` is set, while yarn does not, and PNPM does so based on its configuration).
+When developing such libraries, it's NOT necessary to add a `peerDependency` on `@openfeature/core`, since the `@openfeature/server-sdk` establishes that dependency itself transitively.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

169171

increased by0.81%

Number of lines in readme file

378

increased by3.56%

No dependency changes