@mozilla/nimbus-schemas 2024.10.1 → 2024.11.1

package/README.md

@@ -5,8 +5,8 @@ This directory contains a package of schemas published to various repositories f
 
 ## Installation/Usage
 ### Prerequisites
-- python ^3.11
-- poetry ^1.2.2
+- python ^3.10
+- poetry ^1.8.4
 - node ^16
 - yarn ^1.22
 

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.
@@ -250,18 +262,7 @@ export interface NimbusExperiment {
    * Opt out of feature schema validation. Only supported on desktop.
    */
   featureValidationOptOut?: boolean;
-  /**
-   * Per-locale localization substitutions.
-   *
-   * The top level key is the locale (e.g., "en-US" or "fr"). Each entry is a mapping of string IDs to their localized equivalents.
-   *
-   * Only supported on desktop.
-   */
-  localizations?: {
-    [k: string]: {
-      [k: string]: string;
-    };
-  } | null;
+  localizations?: ExperimentLocalizations | null;
   /**
    * The list of locale codes (e.g., "en-US" or "fr") that this experiment is targeting.
    *
@@ -358,6 +359,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";
@@ -387,6 +392,19 @@ export interface ExperimentMultiFeatureMobileBranch {
    */
   features: ExperimentFeatureConfig[];
 }
+/**
+ * Per-locale localization substitutions.
+ *
+ * The top level key is the locale (e.g., "en-US" or "fr"). Each entry is a mapping of
+ * string IDs to their localized equivalents.
+ *
+ * Only supported on desktop.
+ */
+export interface ExperimentLocalizations {
+  [k: string]: {
+    [k: string]: string;
+  };
+}
 /**
  * The SDK-specific feature manifest.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mozilla/nimbus-schemas",
-  "version": "2024.10.1",
+  "version": "2024.11.1",
   "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."
@@ -158,19 +170,12 @@
     "localizations": {
       "anyOf": [
         {
-          "additionalProperties": {
-            "additionalProperties": {
-              "type": "string"
-            },
-            "type": "object"
-          },
-          "type": "object"
+          "$ref": "#/$defs/ExperimentLocalizations"
         },
         {
           "type": "null"
         }
-      ],
-      "description": "Per-locale localization substitutions. The top level key is the locale (e.g., \"en-US\" or \"fr\"). Each entry is a mapping of string IDs to their localized equivalents. Only supported on desktop."
+      ]
     },
     "locales": {
       "anyOf": [
@@ -216,6 +221,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": {
@@ -286,6 +337,16 @@
       ],
       "type": "object"
     },
+    "ExperimentLocalizations": {
+      "additionalProperties": {
+        "additionalProperties": {
+          "type": "string"
+        },
+        "type": "object"
+      },
+      "description": "Per-locale localization substitutions. The top level key is the locale (e.g., \"en-US\" or \"fr\"). Each entry is a mapping of string IDs to their localized equivalents. Only supported on desktop.",
+      "type": "object"
+    },
     "ExperimentMultiFeatureDesktopBranch": {
       "description": "The branch definition supported on Firefox Desktop 95+.",
       "properties": {
@@ -307,13 +368,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"
     },