@featurevisor/sdk 0.39.0 → 0.40.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.40.0](https://github.com/fahad19/featurevisor/compare/v0.39.2...v0.40.0) (2023-07-16)
+
+**Note:** Version bump only for package @featurevisor/sdk
+
+
+
+
+
+## [0.39.1](https://github.com/fahad19/featurevisor/compare/v0.39.0...v0.39.1) (2023-07-16)
+
+
+### Bug Fixes
+
+* SDK README updates ([#106](https://github.com/fahad19/featurevisor/issues/106)) ([1c6ac53](https://github.com/fahad19/featurevisor/commit/1c6ac5311ac0d8df748cbb67e1e5b426038fee71))
+
+
+
+
+
 # [0.39.0](https://github.com/fahad19/featurevisor/compare/v0.38.0...v0.39.0) (2023-07-16)
 
 

package/README.md

@@ -23,6 +23,7 @@ Visit [https://featurevisor.com/docs/sdks/](https://featurevisor.com/docs/sdks/)
   - [`refreshInterval`](#refreshinterval)
   - [`stickyFeatures`](#stickyfeatures)
 - [API](#api)
+  - [`isEnabled`](#isenabled)
   - [`getVariation`](#getvariation)
   - [`getVariable`](#getvariable)
   - [`activate`](#activate)
@@ -134,7 +135,10 @@ Pass set of initial features with their variation and (optional) variables that
 const sdk = createInstance({
   initialFeatures: {
     myFeatureKey: {
-      variation: true,
+      enabled: true,
+
+      // optional
+      variation: "treatment",
       variables: {
         myVariableKey: "my-variable-value"
       }
@@ -281,7 +285,10 @@ If a feature key is not present in this object, the SDK will continue to evaluat
 const sdk = createInstance({
   stickyFeatures: {
     myFeatureKey: {
-      variation: true,
+      enabled: true,
+
+      // optional
+      variation: "treatment",
       variables: {
         myVariableKey: "my-variable-value"
       }
@@ -294,16 +301,13 @@ const sdk = createInstance({
 
 These methods are available once the SDK instance is created:
 
-### `getVariation`
+### `isEnabled`
 
-> `getVariation(featureKey: string, context: Context): VariationValue`
+> `isEnabled(featureKey: string, context: Context): boolean`
 
-Also supports additional type specific methods:
+### `getVariation`
 
-- `getVariationBoolean`
-- `getVariationString`
-- `getVariationInteger`
-- `getVariationDouble`
+> `getVariation(featureKey: string, context: Context): VariationValue`
 
 ### `getVariable`
 
@@ -327,13 +331,6 @@ Same as `getVariation`, but also calls the `onActivation` callback.
 
 This is a convenience method meant to be called when you know the User has been exposed to your Feature, and you also want to track the activation.
 
-Also supports additional type specific methods:
-
-- `activateBoolean`
-- `activateString`
-- `activateInteger`
-- `activateDouble`
-
 ### `isReady`
 
 > `isReady(): boolean`

package/coverage/clover.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1689538295765" clover="3.2.0">
-  <project timestamp="1689538295765" name="All files">
+<coverage generated="1689541057531" clover="3.2.0">
+  <project timestamp="1689541057531" name="All files">
     <metrics statements="565" coveredstatements="331" conditionals="318" coveredconditionals="157" methods="94" coveredmethods="58" elements="977" coveredelements="546" complexity="0" loc="565" ncloc="565" packages="1" files="8" classes="8"/>
     <file name="bucket.ts" path="/home/runner/work/featurevisor/featurevisor/packages/sdk/src/bucket.ts">
       <metrics statements="8" coveredstatements="8" conditionals="0" coveredconditionals="0" methods="1" coveredmethods="1"/>

package/coverage/lcov-report/bucket.ts.html

@@ -109,7 +109,7 @@ export function getBucketedNumber(bucketKey: string): number {
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/lcov-report/conditions.ts.html

@@ -394,7 +394,7 @@ export function allConditionsAreMatched(
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/lcov-report/datafileReader.ts.html

@@ -289,7 +289,7 @@ export class DatafileReader {
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/lcov-report/emitter.ts.html

@@ -229,7 +229,7 @@ export class Emitter {
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/lcov-report/feature.ts.html

@@ -376,7 +376,7 @@ export function findForceFromFeature(
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/lcov-report/index.html

@@ -206,7 +206,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/lcov-report/instance.ts.html

@@ -3682,7 +3682,7 @@ export function createInstance(options: InstanceOptions): FeaturevisorInstance {
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/lcov-report/logger.ts.html

@@ -328,7 +328,7 @@ export function createLogger(options: CreateLoggerOptions = {}): Logger {
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/coverage/lcov-report/segments.ts.html

@@ -238,7 +238,7 @@ export function allGroupSegmentsAreMatched(
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-07-16T20:11:35.743Z
+                at 2023-07-16T20:57:37.509Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/sdk",
-  "version": "0.39.0",
+  "version": "0.40.0",
   "description": "Featurevisor SDK for Node.js and the browser",
   "main": "dist/index.js",
   "module": "lib/index.js",
@@ -42,9 +42,9 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@featurevisor/types": "^0.39.0",
+    "@featurevisor/types": "^0.40.0",
     "compare-versions": "^6.0.0-rc.1",
     "murmurhash": "^2.0.1"
   },
-  "gitHead": "bbf3b7a19d05b2f02a4836eb5ab2409b686413d3"
+  "gitHead": "7915a3f4f1429e5da4ef0da076da02d4d3c24776"
 }