@spotify-confidence/openfeature-web-provider - npm Package Compare versions

Comparing version 0.2.9 to 0.2.11

CHANGELOG.md

@@ -9,2 +9,33 @@ # Changelog
 
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @spotify-confidence/sdk bumped from 0.1.4 to 0.1.5
+
+## [0.2.11](https://github.com/spotify/confidence-sdk-js/compare/openfeature-web-provider-v0.2.10...openfeature-web-provider-v0.2.11) (2024-08-20)
+
+
+### 🐛 Bug Fixes
+
+* use main&module instead of exports ([5cc01b6](https://github.com/spotify/confidence-sdk-js/commit/5cc01b6c4f7cc9d0857e35ddfcca5cad3ae4d85b))
+* workspace star and no amend ([#192](https://github.com/spotify/confidence-sdk-js/issues/192)) ([82c4f7d](https://github.com/spotify/confidence-sdk-js/commit/82c4f7d0d7fae558ac96617f6d51e29966e19400))
+
+
+### 🧹 Chore
+
+* update package json to expose both es and cjs ([5cc01b6](https://github.com/spotify/confidence-sdk-js/commit/5cc01b6c4f7cc9d0857e35ddfcca5cad3ae4d85b))
+
+
+### 📚 Documentation
+
+* add documentation to the SDK to resolve MD warnings ([#177](https://github.com/spotify/confidence-sdk-js/issues/177)) ([956594b](https://github.com/spotify/confidence-sdk-js/commit/956594b3f666de3eb9567f7b4855d69a6057d2d0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @spotify-confidence/sdk bumped to 0.1.6
+
 ## [0.2.9](https://github.com/spotify/confidence-sdk-js/compare/openfeature-web-provider-v0.2.8...openfeature-web-provider-v0.2.9) (2024-06-07)
@@ -11,0 +42,0 @@

dist/index.d.ts

@@ -10,4 +10,10 @@ import { Confidence } from '@spotify-confidence/sdk';
 
+/**
+ * OpenFeature Provider for Confidence Web SDK
+ * @public
+ */
 export declare class ConfidenceWebProvider implements Provider {
+    /** Static data about the provider */
     readonly metadata: ProviderMetadata;
+    /** Events can be used by developers to track lifecycle events */
     readonly events: OpenFeatureEventEmitter;
@@ -17,4 +23,7 @@ private unsubscribe?;
     constructor(confidence: FlagResolver);
+    /** Initialize the Provider */
     initialize(context?: EvaluationContext): Promise<void>;
+    /** Function called on closing of a Provider, handles unsubscribing from the Confidence SDK */
     onClose(): Promise<void>;
+    /** Called on Confidence Context change */
     onContextChange(oldContext: EvaluationContext, newContext: EvaluationContext): Promise<void>;
@@ -24,8 +33,15 @@ private expectReadyOrError;
     private mapErrorCode;
+    /** Resolves with an evaluation of a Boolean flag */
     resolveBooleanEvaluation(flagKey: string, defaultValue: boolean): ResolutionDetails<boolean>;
+    /** Resolves with an evaluation of a Number flag */
     resolveNumberEvaluation(flagKey: string, defaultValue: number): ResolutionDetails<number>;
+    /** Resolves with an evaluation of an Object flag */
     resolveObjectEvaluation<T extends JsonValue>(flagKey: string, defaultValue: T): ResolutionDetails<T>;
+    /** Resolves with an evaluation of a String flag */
     resolveStringEvaluation(flagKey: string, defaultValue: string): ResolutionDetails<string>;
 }
 
+/**
+ * Factory Options for Confidence Web Provider
+ * @public */
 declare type ConfidenceWebProviderOptions = {
@@ -38,6 +54,14 @@ region?: 'eu' | 'us';
 
+/**
+ * Creates an OpenFeature-adhering Confidence Provider
+ * @param options - Options for Confidence Provider
+ * @public */
 export declare function createConfidenceWebProvider(options: ConfidenceWebProviderOptions): Provider;
 
+/**
+ * Creates an OpenFeature-adhering Confidence Provider
+ * @param confidence - Confidence instance
+ * @public */
 export declare function createConfidenceWebProvider(confidence: Confidence): Provider;
 
 export { }

package.json

 {
   "name": "@spotify-confidence/openfeature-web-provider",
   "license": "Apache-2.0",
-  "version": "0.2.9",
-  "type": "module",
+  "version": "0.2.11",
   "types": "dist/index.d.ts",
@@ -14,3 +13,3 @@ "dependencies": {
     "@openfeature/web-sdk": "^1.0.3",
-    "@spotify-confidence/sdk": "0.1.4",
+    "@spotify-confidence/sdk": "0.1.6",
     "rollup": "4.14.2"
@@ -26,3 +25,4 @@ },
     "types": "dist/index.d.ts",
-    "main": "dist/index.js"
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js"
   },
@@ -37,3 +37,4 @@ "scripts": {
   ],
-  "main": "dist/index.js"
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js"
 }

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

61358

increased by69.72%

Number of package files

8

increased by33.33%

Lines of code

524

increased by101.54%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Is type module

No

No dependency changes