@mozilla/nimbus-shared - npm Package Compare versions

Comparing version 1.3.2 to 1.4.0

CHANGELOG.md

 # Changelog
 
+## Version 1.4.0
+
+### Minor Changes
+
+- Add `outcomes` key to the Experiment DTO.
+- Deprecated `probeSets`.
+
 ## Version 1.3.0
@@ -4,0 +11,0 @@

dist/types/experiments.d.ts

@@ -47,4 +47,9 @@ /**
     bucketConfig: BucketConfig;
-    /** A list of probe set slugs relevant to the experiment analysis */
+    /** A list of probe set slugs relevant to the experiment analysis
+     * Deprecated and should always be an empty list as of v1.4.
+     * Will be removed in the next major version.
+     */
     probeSets: Array<string>;
+    /** A list of outcomes relevant to the experiment analysis. */
+    outcomes?: Array<Outcome>;
     /** A list of featureIds the experiment contains configurations for.
@@ -136,2 +141,8 @@ */
 }
+interface Outcome {
+    /** Identifier for the outcome */
+    slug: string;
+    /** e.g. "primary" or "secondary" */
+    priority: string;
+}
 export {};

package.json

 {
   "name": "@mozilla/nimbus-shared",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "license": "MPL-2.0",
@@ -5,0 +5,0 @@ "engines": {

schemas/experiments/NimbusExperiment.json

@@ -87,4 +87,25 @@ {
           },
-          "description": "A list of probe set slugs relevant to the experiment analysis"
+          "description": "A list of probe set slugs relevant to the experiment analysis Deprecated and should always be an empty list as of v1.4. Will be removed in the next major version."
         },
+        "outcomes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "slug": {
+                "type": "string",
+                "description": "Identifier for the outcome"
+              },
+              "priority": {
+                "type": "string",
+                "description": "e.g. \"primary\" or \"secondary\""
+              }
+            },
+            "required": [
+              "slug",
+              "priority"
+            ]
+          },
+          "description": "A list of outcomes relevant to the experiment analysis."
+        },
         "featureIds": {
@@ -91,0 +112,0 @@ "type": "array",

types/experiments.ts

@@ -58,5 +58,11 @@ /**
 
-  /** A list of probe set slugs relevant to the experiment analysis */
+  /** A list of probe set slugs relevant to the experiment analysis
+   * Deprecated and should always be an empty list as of v1.4.
+   * Will be removed in the next major version.
+   */
   probeSets: Array<string>;
 
+  /** A list of outcomes relevant to the experiment analysis. */
+  outcomes?: Array<Outcome>;
+
   /** A list of featureIds the experiment contains configurations for.
@@ -166,1 +172,9 @@ */
 }
+
+interface Outcome {
+  /** Identifier for the outcome */
+  slug: string;
+
+  /** e.g. "primary" or "secondary" */
+  priority: string;
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

599746

increased by0.65%

Lines of code

12468

increased by0.69%

No dependency changes