@mozilla/nimbus-schemas 2024.10.1 → 2024.10.2

package/index.d.ts

@@ -192,6 +192,18 @@ export interface NimbusExperiment {
    * See-also: https://mozilla-hub.atlassian.net/browse/SDK-405
    */
   isRollout?: boolean;
+  /**
+   * When this property is set to true, treat this experiment as aFirefox Labs experiment
+   */
+  isFirefoxLabsOptIn?: boolean;
+  /**
+   * An optional string containing the Fluent ID for the title of the opt-in
+   */
+  firefoxLabsTitle?: string;
+  /**
+   * An optional string containing the Fluent ID for the description of the opt-in
+   */
+  firefoxLabsDescription?: string;
   bucketConfig: ExperimentBucketConfig;
   /**
    * A list of outcomes relevant to the experiment analysis.
@@ -358,6 +370,10 @@ export interface ExperimentMultiFeatureDesktopBranch {
    */
   features: ExperimentFeatureConfig[];
   feature: DesktopTombstoneFeatureConfig;
+  /**
+   * An optional string containing the title of the branch
+   */
+  firefoxLabsTitle: string;
 }
 export interface DesktopTombstoneFeatureConfig {
   featureId: "unused-feature-id-for-legacy-support";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mozilla/nimbus-schemas",
-  "version": "2024.10.1",
+  "version": "2024.10.2",
   "description": "Schemas used by Mozilla Nimbus and related projects.",
   "main": "index.d.ts",
   "repository": {

package/schemas/NimbusExperiment.schema.json

@@ -44,6 +44,18 @@
       "description": "When this property is set to true, treat this experiment as a rollout. Rollouts are currently handled as single-branch experiments separated from the bucketing namespace for normal experiments. See-also: https://mozilla-hub.atlassian.net/browse/SDK-405",
       "type": "boolean"
     },
+    "isFirefoxLabsOptIn": {
+      "description": "When this property is set to true, treat this experiment as aFirefox Labs experiment",
+      "type": "boolean"
+    },
+    "firefoxLabsTitle": {
+      "description": "An optional string containing the Fluent ID for the title of the opt-in",
+      "type": "string"
+    },
+    "firefoxLabsDescription": {
+      "description": "An optional string containing the Fluent ID for the description of the opt-in",
+      "type": "string"
+    },
     "bucketConfig": {
       "$ref": "#/$defs/ExperimentBucketConfig",
       "description": "Bucketing configuration."
@@ -216,6 +228,52 @@
     "proposedEnrollment",
     "referenceBranch"
   ],
+  "dependentSchemas": {
+    "isFirefoxLabsOptIn": {
+      "if": {
+        "properties": {
+          "isFirefoxLabsOptIn": {
+            "const": true
+          }
+        }
+      },
+      "then": {
+        "if": {
+          "properties": {
+            "isRollout": {
+              "const": false
+            }
+          },
+          "required": [
+            "isRollout"
+          ]
+        },
+        "properties": {
+          "firefoxLabsTitle": {
+            "type": "string"
+          },
+          "firefoxLabsDescription": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "firefoxLabsTitle",
+          "firefoxLabsDescription"
+        ],
+        "then": {
+          "properties": {
+            "branches": {
+              "items": {
+                "required": [
+                  "firefoxLabsTitle"
+                ]
+              }
+            }
+          }
+        }
+      }
+    }
+  },
   "$defs": {
     "DesktopTombstoneFeatureConfig": {
       "properties": {
@@ -307,13 +365,18 @@
         "feature": {
           "$ref": "#/$defs/DesktopTombstoneFeatureConfig",
           "description": "The feature key must be provided with values to prevent crashes if the is encountered by Desktop clients earlier than version 95."
+        },
+        "firefoxLabsTitle": {
+          "description": "An optional string containing the title of the branch",
+          "type": "string"
         }
       },
       "required": [
         "slug",
         "ratio",
         "features",
-        "feature"
+        "feature",
+        "firefoxLabsTitle"
       ],
       "type": "object"
     },