@featurevisor/types 0.27.0 → 0.29.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.29.0](https://github.com/fahad19/featurevisor/compare/v0.28.1...v0.29.0) (2023-06-10)
+
+
+### Features
+
+* drop Allocation.percentage in datafiles ([#80](https://github.com/fahad19/featurevisor/issues/80)) ([b43da69](https://github.com/fahad19/featurevisor/commit/b43da6922f81aef9fe8e8a54342067627adb990b))
+
+
+
+
+
+# [0.28.0](https://github.com/fahad19/featurevisor/compare/v0.27.1...v0.28.0) (2023-06-08)
+
+
+### Features
+
+* make bucketing key configurable ([#79](https://github.com/fahad19/featurevisor/issues/79)) ([c05f0da](https://github.com/fahad19/featurevisor/commit/c05f0dae9e6e1d4ee68f2c457a49137bbd6727d9))
+
+
+
+
+
 # [0.27.0](https://github.com/fahad19/featurevisor/compare/v0.26.0...v0.27.0) (2023-05-24)
 
 **Note:** Version bump only for package @featurevisor/types

package/lib/index.d.ts

@@ -108,15 +108,9 @@ export type BucketValue = number;
  * Datafile-only types
  */
 export type Percentage = number;
-export interface RangeObject {
-    start: Percentage;
-    end: Percentage;
-}
-export type RangeTuple = [Percentage, Percentage];
-export type Range = RangeObject | RangeTuple;
+export type Range = [Percentage, Percentage];
 export interface Allocation {
     variation: VariationValue;
-    percentage?: Percentage;
     range: Range;
 }
 export interface Traffic {
@@ -129,7 +123,12 @@ export interface Traffic {
     };
     allocation: Allocation[];
 }
-export type BucketBy = AttributeKey | AttributeKey[];
+export type PlainBucketBy = AttributeKey;
+export type AndBucketBy = AttributeKey[];
+export interface OrBucketBy {
+    or: AttributeKey[];
+}
+export type BucketBy = PlainBucketBy | AndBucketBy | OrBucketBy;
 export interface Feature {
     key: FeatureKey;
     defaultVariation: VariationValue;
@@ -180,7 +179,7 @@ export interface ParsedFeature {
     archived: boolean;
     description: string;
     tags: string[];
-    bucketBy?: AttributeKey | AttributeKey[];
+    bucketBy: BucketBy;
     defaultVariation: VariationValue;
     variablesSchema?: VariableSchema[];
     variations: Variation[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/types",
-  "version": "0.27.0",
+  "version": "0.29.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": "ed546c01c10cc8fa9df9a9c8c6bc622af90c67f8"
+  "gitHead": "a58d59a7de4df79575589520415b261cae519b1c"
 }

package/src/index.ts

@@ -199,19 +199,10 @@ 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)
 
-// @TODO: remove this in next breaking semver
-export interface RangeObject {
-  start: Percentage; // 0 to 100k
-  end: Percentage; // 0 to 100k
-}
-
-export type RangeTuple = [Percentage, Percentage]; // 0 to 100k
-
-export type Range = RangeObject | RangeTuple;
+export type Range = [Percentage, Percentage]; // 0 to 100k
 
 export interface Allocation {
   variation: VariationValue;
-  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
 }
 
@@ -226,11 +217,16 @@ export interface Traffic {
   allocation: Allocation[];
 }
 
-export type BucketBy = AttributeKey | AttributeKey[]; // @TODO: have first available attribute as well?
+export type PlainBucketBy = AttributeKey;
+export type AndBucketBy = AttributeKey[];
+export interface OrBucketBy {
+  or: AttributeKey[];
+}
+export type BucketBy = PlainBucketBy | AndBucketBy | OrBucketBy;
+
 export interface Feature {
   key: FeatureKey;
   // @TODO: introduce new `parent` key?
-  // @TODO: introduce `type` for distinguishing between feature flags and experiments?
   defaultVariation: VariationValue;
   variablesSchema?: VariableSchema[];
   variations: Variation[];
@@ -290,7 +286,7 @@ export interface ParsedFeature {
   description: string;
   tags: string[];
 
-  bucketBy?: AttributeKey | AttributeKey[]; // @TODO: have first available attribute as well?
+  bucketBy: BucketBy;
 
   defaultVariation: VariationValue;
   variablesSchema?: VariableSchema[];