@featurevisor/types 1.33.0 → 1.35.3

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.
 
+## [1.35.3](https://github.com/featurevisor/featurevisor/compare/v1.35.2...v1.35.3) (2025-04-12)
+
+**Note:** Version bump only for package @featurevisor/types
+
+
+
+
+
+# [1.35.0](https://github.com/featurevisor/featurevisor/compare/v1.34.2...v1.35.0) (2025-03-13)
+
+
+### Features
+
+* list entities from CLI ([#349](https://github.com/featurevisor/featurevisor/issues/349)) ([160e151](https://github.com/featurevisor/featurevisor/commit/160e15103860be8a81a145d515e0ceb69a3cad79))
+
+
+
+
+
 # [1.33.0](https://github.com/featurevisor/featurevisor/compare/v1.32.0...v1.33.0) (2025-03-08)
 
 

package/lib/index.d.ts

@@ -9,6 +9,7 @@ export interface Attribute {
     key: AttributeKey;
     type: AttributeType;
     capture?: boolean;
+    description?: string;
 }
 export type Operator = "equals" | "notEquals" | "greaterThan" | "greaterThanOrEquals" | "lessThan" | "lessThanOrEquals" | "contains" | "notContains" | "startsWith" | "endsWith" | "semverEquals" | "semverNotEquals" | "semverGreaterThan" | "semverGreaterThanOrEquals" | "semverLessThan" | "semverLessThanOrEquals" | "before" | "after" | "in" | "notIn";
 export type ConditionValue = string | number | boolean | Date | null | undefined | string[];
@@ -33,6 +34,7 @@ export interface Segment {
     archived?: boolean;
     key: SegmentKey;
     conditions: Condition | Condition[] | string;
+    description?: string;
 }
 export type PlainGroupSegment = SegmentKey;
 export interface AndGroupSegment {
@@ -85,6 +87,7 @@ export interface VariableSchema {
     key: VariableKey;
     type: VariableType;
     defaultValue: VariableValue;
+    description?: string;
 }
 export type FeatureKey = string;
 export interface Force {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/types",
-  "version": "1.33.0",
+  "version": "1.35.3",
   "description": "Common Typescript types for Featurevisor",
   "main": "dist/index.js",
   "module": "lib/index.js",
@@ -40,5 +40,5 @@
     "url": "https://github.com/featurevisor/featurevisor/issues"
   },
   "license": "MIT",
-  "gitHead": "46a939abcc0158eee6cf1e845b068f7885798bcf"
+  "gitHead": "253ff5dade7c9ee953f6a57cda097a6c9ed93aa2"
 }

package/src/index.ts

@@ -13,6 +13,7 @@ export interface Attribute {
   key: AttributeKey;
   type: AttributeType;
   capture?: boolean;
+  description?: string; // only available in YAML files
 }
 
 export type Operator =
@@ -77,6 +78,7 @@ export interface Segment {
   archived?: boolean; // only available in YAML files
   key: SegmentKey;
   conditions: Condition | Condition[] | string; // string only when stringified for datafile
+  description?: string; // only available in YAML files
 }
 
 export type PlainGroupSegment = SegmentKey;
@@ -167,6 +169,7 @@ export interface VariableSchema {
   key: VariableKey;
   type: VariableType;
   defaultValue: VariableValue;
+  description?: string; // only available in YAML files
 }
 
 export type FeatureKey = string;
@@ -221,7 +224,7 @@ export interface Traffic {
     [key: string]: VariableValue;
   };
 
-  allocation: Allocation[];
+  allocation: Allocation[]; // @TODO: in v2, make it optional
 }
 
 export type PlainBucketBy = AttributeKey;
@@ -362,7 +365,7 @@ export interface ExistingFeature {
     // @TODO: use Exclude with Traffic?
     key: RuleKey;
     percentage: Percentage;
-    allocation: Allocation[];
+    allocation: Allocation[]; // @TODO: in v2, make it optional
   }[];
   ranges?: Range[]; // if in a Group (mutex), these are the available slot ranges
 }