@mozilla/nimbus-schemas 3001.0.0 → 3003.0.0

package/index.d.ts

@@ -153,23 +153,15 @@ export interface DesktopAllVersionsNimbusExperiment {
    */
   publishedDate?: string | null;
   /**
-   * Branch configuration for the experiment.
-   */
-  branches: DesktopAllVersionsExperimentBranch[];
-  /**
-   * When this property is set to true, treat this experiment as aFirefox Labs experiment
+   * When this property is set to true, treat this experiment as a Firefox Labs experiment
    */
   isFirefoxLabsOptIn?: boolean;
   /**
-   * The group this should appear under in Firefox Labs
-   */
-  firefoxLabsGroup?: string | null;
-  /**
-   * The title shown in Firefox Labs (Fluent ID)
+   * The title shown in Firefox Labs (Fluent ID or Resource ID)
    */
   firefoxLabsTitle?: string | null;
   /**
-   * The description shown in Firefox Labs (Fluent ID)
+   * The description shown in Firefox Labs (Fluent ID or Resource ID)
    */
   firefoxLabsDescription?: string | null;
   /**
@@ -178,16 +170,24 @@ export interface DesktopAllVersionsNimbusExperiment {
   firefoxLabsDescriptionLinks?: {
     [k: string]: string;
   } | null;
-  /**
-   * Opt out of feature schema validation.
-   */
-  featureValidationOptOut?: boolean;
   /**
    * Does the experiment require a restart to take effect?
    *
    * Only used by Firefox Labs Opt-Ins.
    */
   requiresRestart?: boolean;
+  /**
+   * Branch configuration for the experiment.
+   */
+  branches: DesktopAllVersionsExperimentBranch[];
+  /**
+   * Opt out of feature schema validation.
+   */
+  featureValidationOptOut?: boolean;
+  /**
+   * The group this should appear under in Firefox Labs
+   */
+  firefoxLabsGroup?: string | null;
 }
 export interface ExperimentBucketConfig {
   randomizationUnit: RandomizationUnit;
@@ -399,23 +399,15 @@ export interface DesktopNimbusExperiment {
    */
   publishedDate?: string | null;
   /**
-   * Branch configuration for the experiment.
-   */
-  branches: DesktopExperimentBranch[];
-  /**
-   * When this property is set to true, treat this experiment as aFirefox Labs experiment
+   * When this property is set to true, treat this experiment as a Firefox Labs experiment
    */
   isFirefoxLabsOptIn?: boolean;
   /**
-   * The group this should appear under in Firefox Labs
-   */
-  firefoxLabsGroup?: string | null;
-  /**
-   * The title shown in Firefox Labs (Fluent ID)
+   * The title shown in Firefox Labs (Fluent ID or Resource ID)
    */
   firefoxLabsTitle?: string | null;
   /**
-   * The description shown in Firefox Labs (Fluent ID)
+   * The description shown in Firefox Labs (Fluent ID or Resource ID)
    */
   firefoxLabsDescription?: string | null;
   /**
@@ -424,16 +416,24 @@ export interface DesktopNimbusExperiment {
   firefoxLabsDescriptionLinks?: {
     [k: string]: string;
   } | null;
-  /**
-   * Opt out of feature schema validation.
-   */
-  featureValidationOptOut?: boolean;
   /**
    * Does the experiment require a restart to take effect?
    *
    * Only used by Firefox Labs Opt-Ins.
    */
   requiresRestart?: boolean;
+  /**
+   * Branch configuration for the experiment.
+   */
+  branches: DesktopExperimentBranch[];
+  /**
+   * Opt out of feature schema validation.
+   */
+  featureValidationOptOut?: boolean;
+  /**
+   * The group this should appear under in Firefox Labs
+   */
+  firefoxLabsGroup?: string | null;
 }
 /**
  * The branch definition supported on Firefox Desktop 95+.
@@ -577,6 +577,30 @@ export interface SdkNimbusExperiment {
    * If null, it has not yet been published.
    */
   publishedDate?: string | null;
+  /**
+   * When this property is set to true, treat this experiment as a Firefox Labs experiment
+   */
+  isFirefoxLabsOptIn?: boolean;
+  /**
+   * The title shown in Firefox Labs (Fluent ID or Resource ID)
+   */
+  firefoxLabsTitle?: string | null;
+  /**
+   * The description shown in Firefox Labs (Fluent ID or Resource ID)
+   */
+  firefoxLabsDescription?: string | null;
+  /**
+   * Links that will be used with the firefoxLabsDescription Fluent ID. May be null for Firefox Labs Opt-In recipes that do not use links.
+   */
+  firefoxLabsDescriptionLinks?: {
+    [k: string]: string;
+  } | null;
+  /**
+   * Does the experiment require a restart to take effect?
+   *
+   * Only used by Firefox Labs Opt-Ins.
+   */
+  requiresRestart?: boolean;
   /**
    * Branch configuration for the SDK experiment.
    */
@@ -758,6 +782,14 @@ export interface SdkFeatureVariable {
    * Only allowed when type is string.
    */
   enum?: string[];
+  setPref?: SetPref1;
+}
+export interface SetPref1 {
+  branch: PrefBranch;
+  /**
+   * The name of the pref to set.
+   */
+  pref: string;
 }
 export interface AnalysisError {
   analysis_basis?: AnalysisBasis | null;

package/package.json

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

package/schemas/DesktopAllVersionsNimbusExperiment.schema.json

@@ -4,76 +4,42 @@
   "description": "A Nimbus experiment for Firefox Desktop. This schema is more strict than DesktopNimbusExperiment and is backwards comaptible with Firefox Desktop versions less than 95. It is intended for use inside Experimenter itself.",
   "type": "object",
   "properties": {
-    "schemaVersion": {
-      "description": "Version of the NimbusExperiment schema this experiment refers to",
-      "type": "string"
-    },
-    "slug": {
-      "description": "Unique identifier for the experiment",
-      "type": "string"
-    },
-    "id": {
-      "description": "Unique identifier for the experiiment. This is a duplicate of slug, but is required field for all Remote Settings records.",
-      "type": "string"
-    },
-    "appName": {
-      "description": "A slug identifying the targeted product of this experiment. It should be a lowercased_with_underscores name that is short and unambiguous and it should match the app_name found in https://probeinfo.telemetry.mozilla.org/glean/repositories. Examples are \"fenix\" and \"firefox_desktop\".",
-      "type": "string"
-    },
     "appId": {
       "description": "The platform identifier for the targeted app. This should match app's identifier exactly as it appears in the relevant app store listing (for relevant platforms) or the app's Glean initialization (for other platforms). Examples are \"org.mozilla.firefox_beta\" and \"firefox-desktop\".",
       "type": "string"
     },
-    "channel": {
-      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
-      "type": "string"
-    },
-    "userFacingName": {
-      "description": "Public name of the experiment that will be displayed on \"about:studies\".",
-      "type": "string"
-    },
-    "userFacingDescription": {
-      "description": "Short public description of the experiment that will be displayed on \"about:studies\".",
+    "appName": {
+      "description": "A slug identifying the targeted product of this experiment. It should be a lowercased_with_underscores name that is short and unambiguous and it should match the app_name found in https://probeinfo.telemetry.mozilla.org/glean/repositories. Examples are \"fenix\" and \"firefox_desktop\".",
       "type": "string"
     },
-    "isEnrollmentPaused": {
-      "description": "When this property is set to true, the SDK should not enroll new users into the experiment that have not already been enrolled.",
-      "type": "boolean"
-    },
-    "isRollout": {
-      "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"
+    "branches": {
+      "description": "Branch configuration for the experiment.",
+      "items": {
+        "$ref": "#/$defs/DesktopAllVersionsExperimentBranch"
+      },
+      "type": "array"
     },
     "bucketConfig": {
       "$ref": "#/$defs/ExperimentBucketConfig",
       "description": "Bucketing configuration."
     },
-    "outcomes": {
-      "description": "A list of outcomes relevant to the experiment analysis.",
-      "items": {
-        "$ref": "#/$defs/ExperimentOutcome"
-      },
-      "type": "array"
-    },
-    "featureIds": {
-      "description": "A list of featureIds the experiment contains configurations for.",
-      "items": {
-        "type": "string"
-      },
-      "type": "array"
+    "channel": {
+      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
+      "type": "string"
     },
-    "targeting": {
+    "endDate": {
       "anyOf": [
         {
+          "format": "date",
           "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "A JEXL targeting expression used to filter out experiments."
+      "description": "Actual end date of this experiment. Note that this field is expected to be null in Remote Settings."
     },
-    "startDate": {
+    "enrollmentEndDate": {
       "anyOf": [
         {
           "format": "date",
@@ -83,41 +49,59 @@
           "type": "null"
         }
       ],
-      "description": "Actual publish date of the experiment. Note that this value is expected to be null in Remote Settings."
+      "description": "Actual enrollment end date of the experiment. Note that this value is expected to be null in Remote Settings."
     },
-    "enrollmentEndDate": {
+    "featureIds": {
+      "description": "A list of featureIds the experiment contains configurations for.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "featureValidationOptOut": {
+      "description": "Opt out of feature schema validation.",
+      "type": "boolean"
+    },
+    "firefoxLabsDescription": {
       "anyOf": [
         {
-          "format": "date",
           "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "Actual enrollment end date of the experiment. Note that this value is expected to be null in Remote Settings."
+      "description": "The description shown in Firefox Labs (Fluent ID or Resource ID)"
     },
-    "endDate": {
+    "firefoxLabsDescriptionLinks": {
       "anyOf": [
         {
-          "format": "date",
-          "type": "string"
+          "additionalProperties": {
+            "format": "uri",
+            "maxLength": 2083,
+            "minLength": 1,
+            "type": "string"
+          },
+          "type": "object"
         },
         {
           "type": "null"
         }
       ],
-      "description": "Actual end date of this experiment. Note that this field is expected to be null in Remote Settings."
-    },
-    "proposedDuration": {
-      "description": "Duration of the experiment from the start date in days. Note that this property is only used during the analysis phase (i.e., not by the SDK).",
-      "type": "integer"
+      "description": "Links that will be used with the firefoxLabsDescription Fluent ID. May be null for Firefox Labs Opt-In recipes that do not use links."
     },
-    "proposedEnrollment": {
-      "description": "This represents the number of days that we expect to enroll new users. Note that this property is only used during the analysis phase (i.e., not by the SDK).",
-      "type": "integer"
+    "firefoxLabsGroup": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The group this should appear under in Firefox Labs"
     },
-    "referenceBranch": {
+    "firefoxLabsTitle": {
       "anyOf": [
         {
           "type": "string"
@@ -126,7 +110,23 @@
           "type": "null"
         }
       ],
-      "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
+      "description": "The title shown in Firefox Labs (Fluent ID or Resource ID)"
+    },
+    "id": {
+      "description": "Unique identifier for the experiiment. This is a duplicate of slug, but is required field for all Remote Settings records.",
+      "type": "string"
+    },
+    "isEnrollmentPaused": {
+      "description": "When this property is set to true, the SDK should not enroll new users into the experiment that have not already been enrolled.",
+      "type": "boolean"
+    },
+    "isFirefoxLabsOptIn": {
+      "description": "When this property is set to true, treat this experiment as a Firefox Labs experiment",
+      "type": "boolean"
+    },
+    "isRollout": {
+      "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"
     },
     "locales": {
       "anyOf": [
@@ -152,41 +152,34 @@
         }
       ]
     },
-    "publishedDate": {
-      "anyOf": [
-        {
-          "format": "date-time",
-          "type": "string"
-        },
-        {
-          "type": "null"
-        }
-      ],
-      "description": "The date that this experiment was first published to Remote Settings. If null, it has not yet been published."
-    },
-    "branches": {
-      "description": "Branch configuration for the experiment.",
+    "outcomes": {
+      "description": "A list of outcomes relevant to the experiment analysis.",
       "items": {
-        "$ref": "#/$defs/DesktopAllVersionsExperimentBranch"
+        "$ref": "#/$defs/ExperimentOutcome"
       },
       "type": "array"
     },
-    "isFirefoxLabsOptIn": {
-      "description": "When this property is set to true, treat this experiment as aFirefox Labs experiment",
-      "type": "boolean"
+    "proposedDuration": {
+      "description": "Duration of the experiment from the start date in days. Note that this property is only used during the analysis phase (i.e., not by the SDK).",
+      "type": "integer"
     },
-    "firefoxLabsGroup": {
+    "proposedEnrollment": {
+      "description": "This represents the number of days that we expect to enroll new users. Note that this property is only used during the analysis phase (i.e., not by the SDK).",
+      "type": "integer"
+    },
+    "publishedDate": {
       "anyOf": [
         {
+          "format": "date-time",
           "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "The group this should appear under in Firefox Labs"
+      "description": "The date that this experiment was first published to Remote Settings. If null, it has not yet been published."
     },
-    "firefoxLabsTitle": {
+    "referenceBranch": {
       "anyOf": [
         {
           "type": "string"
@@ -195,43 +188,50 @@
           "type": "null"
         }
       ],
-      "description": "The title shown in Firefox Labs (Fluent ID)"
+      "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
     },
-    "firefoxLabsDescription": {
+    "requiresRestart": {
+      "description": "Does the experiment require a restart to take effect? Only used by Firefox Labs Opt-Ins.",
+      "type": "boolean"
+    },
+    "schemaVersion": {
+      "description": "Version of the NimbusExperiment schema this experiment refers to",
+      "type": "string"
+    },
+    "slug": {
+      "description": "Unique identifier for the experiment",
+      "type": "string"
+    },
+    "startDate": {
       "anyOf": [
         {
+          "format": "date",
           "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "The description shown in Firefox Labs (Fluent ID)"
+      "description": "Actual publish date of the experiment. Note that this value is expected to be null in Remote Settings."
     },
-    "firefoxLabsDescriptionLinks": {
+    "targeting": {
       "anyOf": [
         {
-          "additionalProperties": {
-            "format": "uri",
-            "maxLength": 2083,
-            "minLength": 1,
-            "type": "string"
-          },
-          "type": "object"
+          "type": "string"
         },
         {
           "type": "null"
         }
       ],
-      "description": "Links that will be used with the firefoxLabsDescription Fluent ID. May be null for Firefox Labs Opt-In recipes that do not use links."
+      "description": "A JEXL targeting expression used to filter out experiments."
     },
-    "featureValidationOptOut": {
-      "description": "Opt out of feature schema validation.",
-      "type": "boolean"
+    "userFacingDescription": {
+      "description": "Short public description of the experiment that will be displayed on \"about:studies\".",
+      "type": "string"
     },
-    "requiresRestart": {
-      "description": "Does the experiment require a restart to take effect? Only used by Firefox Labs Opt-Ins.",
-      "type": "boolean"
+    "userFacingName": {
+      "description": "Public name of the experiment that will be displayed on \"about:studies\".",
+      "type": "string"
     }
   },
   "required": [
@@ -274,7 +274,6 @@
         },
         "required": [
           "firefoxLabsDescription",
-          "firefoxLabsDescriptionLinks",
           "firefoxLabsGroup",
           "firefoxLabsTitle"
         ],
@@ -296,13 +295,9 @@
     "DesktopAllVersionsExperimentBranch": {
       "description": "The branch definition supported on all Firefox Desktop versions. This version requires the feature field to be present to support older Firefox Desktop clients.",
       "properties": {
-        "slug": {
-          "description": "Identifier for the branch.",
-          "type": "string"
-        },
-        "ratio": {
-          "description": "Relative ratio of population for the branch. e.g., if branch A=1 and branch B=3, then branch A would get 25% of the population.",
-          "type": "integer"
+        "feature": {
+          "$ref": "#/$defs/DesktopPre95FeatureConfig",
+          "description": "The feature key must be provided with values to prevent crashes if the experiment is encountered by Desktop clients earlier than version 95."
         },
         "features": {
           "description": "An array of feature configurations.",
@@ -322,9 +317,13 @@
           ],
           "description": "The branch title shown in Firefox Labs (Fluent ID)"
         },
-        "feature": {
-          "$ref": "#/$defs/DesktopPre95FeatureConfig",
-          "description": "The feature key must be provided with values to prevent crashes if the experiment is encountered by Desktop clients earlier than version 95."
+        "ratio": {
+          "description": "Relative ratio of population for the branch. e.g., if branch A=1 and branch B=3, then branch A would get 25% of the population.",
+          "type": "integer"
+        },
+        "slug": {
+          "description": "Identifier for the branch.",
+          "type": "string"
         }
       },
       "required": [
@@ -337,16 +336,17 @@
     },
     "DesktopPre95FeatureConfig": {
       "properties": {
+        "enabled": {
+          "const": false,
+          "type": "boolean"
+        },
         "featureId": {
           "const": "this-is-included-for-desktop-pre-95-support",
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "type": "object"
-        },
-        "enabled": {
-          "const": false,
-          "type": "boolean"
         }
       },
       "required": [
@@ -358,21 +358,21 @@
     },
     "ExperimentBucketConfig": {
       "properties": {
-        "randomizationUnit": {
-          "$ref": "#/$defs/RandomizationUnit"
+        "count": {
+          "description": "Number of buckets in the range.",
+          "type": "integer"
         },
         "namespace": {
           "description": "Additional inputs to the hashing function.",
           "type": "string"
         },
+        "randomizationUnit": {
+          "$ref": "#/$defs/RandomizationUnit"
+        },
         "start": {
           "description": "Index of the starting bucket of the range.",
           "type": "integer"
         },
-        "count": {
-          "description": "Number of buckets in the range.",
-          "type": "integer"
-        },
         "total": {
           "description": "The total number of buckets. You can assume this will always be 10000.",
           "type": "integer"
@@ -394,6 +394,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "description": "The values that define the feature configuration. This should be validated against a schema.",
           "type": "object"
         }
@@ -416,13 +417,13 @@
     },
     "ExperimentOutcome": {
       "properties": {
-        "slug": {
-          "description": "Identifier for the outcome.",
-          "type": "string"
-        },
         "priority": {
           "description": "e.g., \"primary\" or \"secondary\".",
           "type": "string"
+        },
+        "slug": {
+          "description": "Identifier for the outcome.",
+          "type": "string"
         }
       },
       "required": [