@featurevisor/types 0.49.0 → 0.51.0

package/.eslintcache

@@ -1 +1 @@
-[{"/home/runner/work/featurevisor/featurevisor/packages/types/src/index.ts":"1"},{"size":9059,"mtime":1696103831033,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","suppressedMessages":"6","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"wdwiro","/home/runner/work/featurevisor/featurevisor/packages/types/src/index.ts",[],[]]
+[{"/home/runner/work/featurevisor/featurevisor/packages/types/src/index.ts":"1"},{"size":8938,"mtime":1696523288972,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","suppressedMessages":"6","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"wdwiro","/home/runner/work/featurevisor/featurevisor/packages/types/src/index.ts",[],[]]

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.51.0](https://github.com/featurevisor/featurevisor/compare/v0.50.0...v0.51.0) (2023-10-05)
+
+
+### Features
+
+* let variables have descriptions ([#165](https://github.com/featurevisor/featurevisor/issues/165)) ([2a1b73d](https://github.com/featurevisor/featurevisor/commit/2a1b73d274ae10184db024ca41aa73011b8e8532))
+
+
+
+
+
+# [0.50.0](https://github.com/featurevisor/featurevisor/compare/v0.49.0...v0.50.0) (2023-10-01)
+
+
+### Features
+
+* test specs improvements ([#160](https://github.com/featurevisor/featurevisor/issues/160)) ([fd8fa01](https://github.com/featurevisor/featurevisor/commit/fd8fa01f517bcfd5dfde80f311a9c546dd481ff1))
+
+
+
+
+
 # [0.49.0](https://github.com/featurevisor/featurevisor/compare/v0.48.0...v0.49.0) (2023-09-30)
 
 **Note:** Version bump only for package @featurevisor/types

package/lib/index.d.ts

@@ -70,6 +70,7 @@ export interface VariableOverride {
 export interface Variable {
     key: VariableKey;
     value: VariableValue;
+    description?: string;
     overrides?: VariableOverride[];
 }
 export interface Variation {
@@ -228,6 +229,7 @@ export interface ExistingState {
  */
 export interface FeatureAssertion {
     description?: string;
+    environment: EnvironmentKey;
     at: Weight;
     context: Context;
     expectedToBeEnabled: boolean;
@@ -237,7 +239,7 @@ export interface FeatureAssertion {
     };
 }
 export interface TestFeature {
-    key: FeatureKey;
+    feature: FeatureKey;
     assertions: FeatureAssertion[];
 }
 export interface SegmentAssertion {
@@ -246,19 +248,10 @@ export interface SegmentAssertion {
     expectedToMatch: boolean;
 }
 export interface TestSegment {
-    key: SegmentKey;
+    segment: SegmentKey;
     assertions: SegmentAssertion[];
 }
-export interface Test {
-    description?: string;
-    tag?: string;
-    environment?: string;
-    features?: TestFeature[];
-    segments?: TestSegment[];
-}
-export interface Spec {
-    tests: Test[];
-}
+export type Test = TestSegment | TestFeature;
 /**
  * Site index and history
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/types",
-  "version": "0.49.0",
+  "version": "0.51.0",
   "description": "Common Typescript types for Featurevisor",
   "main": "dist/index.js",
   "module": "lib/index.js",
@@ -44,5 +44,5 @@
     "url": "https://github.com/featurevisor/featurevisor/issues"
   },
   "license": "MIT",
-  "gitHead": "85a73383e4efea6415af82360d51e884a64cf370"
+  "gitHead": "6b1026df520761e2b7dd39e8414e222f0ab0f24d"
 }

package/src/index.ts

@@ -149,6 +149,7 @@ export interface VariableOverride {
 export interface Variable {
   key: VariableKey;
   value: VariableValue;
+  description?: string; // only available in YAML
   overrides?: VariableOverride[];
 }
 
@@ -351,6 +352,7 @@ export interface ExistingState {
  */
 export interface FeatureAssertion {
   description?: string;
+  environment: EnvironmentKey;
   at: Weight; // bucket weight: 0 to 100
   context: Context;
   expectedToBeEnabled: boolean;
@@ -361,7 +363,7 @@ export interface FeatureAssertion {
 }
 
 export interface TestFeature {
-  key: FeatureKey;
+  feature: FeatureKey;
   assertions: FeatureAssertion[];
 }
 
@@ -372,25 +374,11 @@ export interface SegmentAssertion {
 }
 
 export interface TestSegment {
-  key: SegmentKey;
+  segment: SegmentKey;
   assertions: SegmentAssertion[];
 }
 
-export interface Test {
-  description?: string;
-
-  // needed for feature testing
-  tag?: string;
-  environment?: string;
-  features?: TestFeature[];
-
-  // needed for segment testing
-  segments?: TestSegment[];
-}
-
-export interface Spec {
-  tests: Test[];
-}
+export type Test = TestSegment | TestFeature;
 
 /**
  * Site index and history