@featurevisor/types 0.15.0 → 0.17.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.17.0](https://github.com/fahad19/featurevisor/compare/v0.16.0...v0.17.0) (2023-05-12)
+
+
+### Features
+
+* sticky features ([#65](https://github.com/fahad19/featurevisor/issues/65)) ([eb4ff69](https://github.com/fahad19/featurevisor/commit/eb4ff69dcb3d6f979eb1c9dec3fe4cf1583e1fc9))
+
+
+
+
+
+# [0.16.0](https://github.com/fahad19/featurevisor/compare/v0.15.0...v0.16.0) (2023-04-30)
+
+
+### Features
+
+* Mutually exclusive experiments via Groups ([#63](https://github.com/fahad19/featurevisor/issues/63)) ([f3c8523](https://github.com/fahad19/featurevisor/commit/f3c85236d36fd0e499897f9ce1c2ed551c111523))
+
+
+
+
+
 # [0.15.0](https://github.com/fahad19/featurevisor/compare/v0.14.1...v0.15.0) (2023-04-23)
 
 **Note:** Version bump only for package @featurevisor/types

package/lib/index.d.ts

@@ -93,15 +93,29 @@ export interface Force {
         [key: string]: VariableValue;
     };
 }
+export interface Slot {
+    feature: FeatureKey | false;
+    percentage: Weight;
+}
+export interface Group {
+    key: string;
+    description: string;
+    slots: Slot[];
+}
 export type BucketKey = string;
 export type BucketValue = number;
 /**
  * Datafile-only types
  */
 export type Percentage = number;
+export interface Range {
+    start: Percentage;
+    end: Percentage;
+}
 export interface Allocation {
     variation: VariationValue;
-    percentage: Percentage;
+    percentage?: Percentage;
+    range: Range;
 }
 export interface Traffic {
     key: RuleKey;
@@ -130,6 +144,14 @@ export interface DatafileContent {
     segments: Segment[];
     features: Feature[];
 }
+export interface StickyFeatures {
+    [key: FeatureKey]: {
+        variation: VariationValue;
+        variables?: {
+            [key: VariableKey]: VariableValue;
+        };
+    };
+}
 /**
  * YAML-only type
  */
@@ -178,6 +200,7 @@ export interface ExistingFeature {
         percentage: Percentage;
         allocation: Allocation[];
     }[];
+    ranges?: Range[];
 }
 export interface ExistingFeatures {
     [key: FeatureKey]: ExistingFeature;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/types",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Common Typescript types for Featurevisor",
   "main": "dist/index.js",
   "module": "lib/index.js",
@@ -41,5 +41,5 @@
     "url": "https://github.com/fahad19/featurevisor/issues"
   },
   "license": "MIT",
-  "gitHead": "254d79ee3bcbd5d9c2f771f66e653ffe5512176e"
+  "gitHead": "4e00e7a43d21c668f2a313750c22613dbd0b3ad3"
 }

package/src/index.ts

@@ -176,6 +176,17 @@ export interface Force {
   };
 }
 
+export interface Slot {
+  feature: FeatureKey | false;
+  percentage: Weight; // 0 to 100
+}
+
+export interface Group {
+  key: string;
+  description: string;
+  slots: Slot[];
+}
+
 export type BucketKey = string;
 export type BucketValue = number; // 0 to 100,000 (100% * 1000 to include three decimal places in same integer)
 
@@ -184,9 +195,15 @@ export type BucketValue = number; // 0 to 100,000 (100% * 1000 to include three
  */
 export type Percentage = number; // 0 to 100,000 (100% * 1000 to include three decimal places in same integer)
 
+export interface Range {
+  start: Percentage; // 0 to 100k
+  end: Percentage; // 0 to 100k
+}
+
 export interface Allocation {
   variation: VariationValue;
-  percentage: Percentage;
+  percentage?: Percentage; // @TODO: remove it in next breaking semver
+  range: Range; // @TODO: in future, turn it into `ranges`, so that Allocations with same variation do not repeat
 }
 
 export interface Traffic {
@@ -221,6 +238,15 @@ export interface DatafileContent {
   features: Feature[];
 }
 
+export interface StickyFeatures {
+  [key: FeatureKey]: {
+    variation: VariationValue;
+    variables?: {
+      [key: VariableKey]: VariableValue;
+    };
+  };
+}
+
 /**
  * YAML-only type
  */
@@ -281,6 +307,7 @@ export interface ExistingFeature {
     percentage: Percentage;
     allocation: Allocation[];
   }[];
+  ranges?: Range[]; // if in a Group, these are the available slot ranges
 }
 
 export interface ExistingFeatures {