@featurevisor/types 0.37.0 → 0.38.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.38.0](https://github.com/fahad19/featurevisor/compare/v0.37.1...v0.38.0) (2023-07-16)
+
+
+### Features
+
+* SDK to support isEnabled() checks ([#104](https://github.com/fahad19/featurevisor/issues/104)) ([4f52136](https://github.com/fahad19/featurevisor/commit/4f521367a3f1ef76833ba614b6a1f4b66abef2e1))
+
+
+
+
+
 # [0.37.0](https://github.com/fahad19/featurevisor/compare/v0.36.0...v0.37.0) (2023-07-14)
 
 

package/lib/index.d.ts

@@ -45,8 +45,7 @@ export interface NotGroupSegment {
 }
 export type AndOrNotGroupSegment = AndGroupSegment | OrGroupSegment | NotGroupSegment;
 export type GroupSegment = PlainGroupSegment | AndOrNotGroupSegment;
-export type VariationType = "boolean" | "string" | "integer" | "double";
-export type VariationValue = boolean | string | number | null | undefined;
+export type VariationValue = string;
 export type VariableKey = string;
 export type VariableType = "boolean" | "string" | "integer" | "double" | "array" | "object" | "json";
 export interface VariableObjectValue {
@@ -88,7 +87,8 @@ export type FeatureKey = string;
 export interface Force {
     conditions?: Condition | Condition[];
     segments?: GroupSegment | GroupSegment[];
-    variation: VariationValue;
+    enabled?: boolean;
+    variation?: VariationValue;
     variables?: {
         [key: string]: VariableValue;
     };
@@ -117,6 +117,7 @@ export interface Traffic {
     key: RuleKey;
     segments: GroupSegment | GroupSegment[] | "*";
     percentage: Percentage;
+    enabled?: boolean;
     variation?: VariationValue;
     variables?: {
         [key: string]: VariableValue;
@@ -131,12 +132,12 @@ export interface OrBucketBy {
 export type BucketBy = PlainBucketBy | AndBucketBy | OrBucketBy;
 export interface Feature {
     key: FeatureKey;
-    defaultVariation: VariationValue;
     variablesSchema?: VariableSchema[];
-    variations: Variation[];
+    variations?: Variation[];
     bucketBy: BucketBy;
     traffic: Traffic[];
     force?: Force[];
+    ranges?: Range[];
 }
 export interface DatafileContent {
     schemaVersion: string;
@@ -145,14 +146,16 @@ export interface DatafileContent {
     segments: Segment[];
     features: Feature[];
 }
-export interface StickyFeatures {
-    [key: FeatureKey]: {
-        variation: VariationValue;
-        variables?: {
-            [key: VariableKey]: VariableValue;
-        };
+export interface OverrideFeature {
+    enabled: boolean;
+    variation?: VariationValue;
+    variables?: {
+        [key: VariableKey]: VariableValue;
     };
 }
+export interface StickyFeatures {
+    [key: FeatureKey]: OverrideFeature;
+}
 export type InitialFeatures = StickyFeatures;
 /**
  * YAML-only type
@@ -164,6 +167,7 @@ export interface Rule {
     key: RuleKey;
     segments: GroupSegment | GroupSegment[];
     percentage: Weight;
+    enabled?: boolean;
     variation?: VariationValue;
     variables?: {
         [key: string]: VariableValue;
@@ -180,9 +184,8 @@ export interface ParsedFeature {
     description: string;
     tags: string[];
     bucketBy: BucketBy;
-    defaultVariation: VariationValue;
     variablesSchema?: VariableSchema[];
-    variations: Variation[];
+    variations?: Variation[];
     environments: {
         [key: EnvironmentKey]: Environment;
     };
@@ -193,7 +196,7 @@ export interface ParsedFeature {
  * with consistent bucketing
  */
 export interface ExistingFeature {
-    variations: {
+    variations?: {
         value: VariationValue;
         weight: Weight;
     }[];
@@ -217,6 +220,7 @@ export interface FeatureAssertion {
     description?: string;
     at: Weight;
     context: Context;
+    expectedToBeEnabled: boolean;
     expectedVariation?: VariationValue;
     expectedVariables?: {
         [key: VariableKey]: VariableValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/types",
-  "version": "0.37.0",
+  "version": "0.38.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": "1944f2ea8e86d07c7031720cd0b407bea547d0cb"
+  "gitHead": "79edc620e398ae8250bd9870e6fbf8e3402e6010"
 }

package/src/index.ts

@@ -96,8 +96,7 @@ export type AndOrNotGroupSegment = AndGroupSegment | OrGroupSegment | NotGroupSe
 // group of segment keys with and/or conditions, or just string
 export type GroupSegment = PlainGroupSegment | AndOrNotGroupSegment;
 
-export type VariationType = "boolean" | "string" | "integer" | "double";
-export type VariationValue = boolean | string | number | null | undefined;
+export type VariationValue = string;
 
 export type VariableKey = string;
 export type VariableType =
@@ -174,7 +173,8 @@ export interface Force {
   conditions?: Condition | Condition[];
   segments?: GroupSegment | GroupSegment[];
 
-  variation: VariationValue;
+  enabled?: boolean;
+  variation?: VariationValue;
   variables?: {
     [key: string]: VariableValue;
   };
@@ -210,10 +210,13 @@ export interface Traffic {
   key: RuleKey;
   segments: GroupSegment | GroupSegment[] | "*";
   percentage: Percentage;
+
+  enabled?: boolean;
   variation?: VariationValue;
   variables?: {
     [key: string]: VariableValue;
   };
+
   allocation: Allocation[];
 }
 
@@ -227,12 +230,12 @@ export type BucketBy = PlainBucketBy | AndBucketBy | OrBucketBy;
 export interface Feature {
   key: FeatureKey;
   // @TODO: introduce new `parent` key?
-  defaultVariation: VariationValue;
   variablesSchema?: VariableSchema[];
-  variations: Variation[];
+  variations?: Variation[];
   bucketBy: BucketBy;
   traffic: Traffic[];
   force?: Force[];
+  ranges?: Range[]; // if in a Group (mutex), these are the available slot ranges
 }
 
 export interface DatafileContent {
@@ -243,15 +246,18 @@ export interface DatafileContent {
   features: Feature[];
 }
 
-export interface StickyFeatures {
-  [key: FeatureKey]: {
-    variation: VariationValue;
-    variables?: {
-      [key: VariableKey]: VariableValue;
-    };
+export interface OverrideFeature {
+  enabled: boolean;
+  variation?: VariationValue;
+  variables?: {
+    [key: VariableKey]: VariableValue;
   };
 }
 
+export interface StickyFeatures {
+  [key: FeatureKey]: OverrideFeature;
+}
+
 export type InitialFeatures = StickyFeatures;
 
 /**
@@ -267,6 +273,8 @@ export interface Rule {
   key: RuleKey;
   segments: GroupSegment | GroupSegment[];
   percentage: Weight;
+
+  enabled?: boolean;
   variation?: VariationValue;
   variables?: {
     [key: string]: VariableValue;
@@ -288,9 +296,8 @@ export interface ParsedFeature {
 
   bucketBy: BucketBy;
 
-  defaultVariation: VariationValue;
   variablesSchema?: VariableSchema[];
-  variations: Variation[];
+  variations?: Variation[];
 
   environments: {
     [key: EnvironmentKey]: Environment;
@@ -303,7 +310,7 @@ export interface ParsedFeature {
  * with consistent bucketing
  */
 export interface ExistingFeature {
-  variations: {
+  variations?: {
     // @TODO: use Exclude with Variation?
     value: VariationValue;
     weight: Weight;
@@ -314,7 +321,7 @@ export interface ExistingFeature {
     percentage: Percentage;
     allocation: Allocation[];
   }[];
-  ranges?: Range[]; // if in a Group, these are the available slot ranges
+  ranges?: Range[]; // if in a Group (mutex), these are the available slot ranges
 }
 
 export interface ExistingFeatures {
@@ -332,6 +339,7 @@ export interface FeatureAssertion {
   description?: string;
   at: Weight; // bucket weight: 0 to 100
   context: Context;
+  expectedToBeEnabled: boolean;
   expectedVariation?: VariationValue;
   expectedVariables?: {
     [key: VariableKey]: VariableValue;