@mozilla/nimbus-schemas 3002.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.
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mozilla/nimbus-schemas",
-  "version": "3002.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

@@ -71,7 +71,7 @@
           "type": "null"
         }
       ],
-      "description": "The description shown in Firefox Labs (Fluent ID)"
+      "description": "The description shown in Firefox Labs (Fluent ID or Resource ID)"
     },
     "firefoxLabsDescriptionLinks": {
       "anyOf": [
@@ -110,7 +110,7 @@
           "type": "null"
         }
       ],
-      "description": "The title shown in Firefox Labs (Fluent ID)"
+      "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.",
@@ -121,7 +121,7 @@
       "type": "boolean"
     },
     "isFirefoxLabsOptIn": {
-      "description": "When this property is set to true, treat this experiment as aFirefox Labs experiment",
+      "description": "When this property is set to true, treat this experiment as a Firefox Labs experiment",
       "type": "boolean"
     },
     "isRollout": {
@@ -274,7 +274,6 @@
         },
         "required": [
           "firefoxLabsDescription",
-          "firefoxLabsDescriptionLinks",
           "firefoxLabsGroup",
           "firefoxLabsTitle"
         ],

package/schemas/DesktopNimbusExperiment.schema.json

@@ -71,7 +71,7 @@
           "type": "null"
         }
       ],
-      "description": "The description shown in Firefox Labs (Fluent ID)"
+      "description": "The description shown in Firefox Labs (Fluent ID or Resource ID)"
     },
     "firefoxLabsDescriptionLinks": {
       "anyOf": [
@@ -110,7 +110,7 @@
           "type": "null"
         }
       ],
-      "description": "The title shown in Firefox Labs (Fluent ID)"
+      "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.",
@@ -121,7 +121,7 @@
       "type": "boolean"
     },
     "isFirefoxLabsOptIn": {
-      "description": "When this property is set to true, treat this experiment as aFirefox Labs experiment",
+      "description": "When this property is set to true, treat this experiment as a Firefox Labs experiment",
       "type": "boolean"
     },
     "isRollout": {
@@ -274,7 +274,6 @@
         },
         "required": [
           "firefoxLabsDescription",
-          "firefoxLabsDescriptionLinks",
           "firefoxLabsGroup",
           "firefoxLabsTitle"
         ],

package/schemas/NimbusExperimentV7.schema.json

@@ -65,6 +65,45 @@
       },
       "type": "array"
     },
+    "firefoxLabsDescription": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The description shown in Firefox Labs (Fluent ID or Resource ID)"
+    },
+    "firefoxLabsDescriptionLinks": {
+      "anyOf": [
+        {
+          "additionalProperties": {
+            "format": "uri",
+            "maxLength": 2083,
+            "minLength": 1,
+            "type": "string"
+          },
+          "type": "object"
+        },
+        {
+          "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."
+    },
+    "firefoxLabsTitle": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "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"
@@ -73,6 +112,10 @@
       "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"
@@ -140,6 +183,10 @@
       ],
       "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
     },
+    "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"
@@ -199,6 +246,23 @@
     "branches",
     "documentationLinks"
   ],
+  "dependentSchemas": {
+    "isFirefoxLabsOptIn": {
+      "if": {
+        "properties": {
+          "isFirefoxLabsOptIn": {
+            "const": true
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "firefoxLabsDescription",
+          "firefoxLabsTitle"
+        ]
+      }
+    }
+  },
   "$defs": {
     "BaseExperimentBranch": {
       "properties": {

package/schemas/SdkNimbusExperiment.schema.json

@@ -58,6 +58,45 @@
       },
       "type": "array"
     },
+    "firefoxLabsDescription": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The description shown in Firefox Labs (Fluent ID or Resource ID)"
+    },
+    "firefoxLabsDescriptionLinks": {
+      "anyOf": [
+        {
+          "additionalProperties": {
+            "format": "uri",
+            "maxLength": 2083,
+            "minLength": 1,
+            "type": "string"
+          },
+          "type": "object"
+        },
+        {
+          "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."
+    },
+    "firefoxLabsTitle": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "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"
@@ -66,6 +105,10 @@
       "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"
@@ -133,6 +176,10 @@
       ],
       "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
     },
+    "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"
@@ -191,6 +238,30 @@
     "referenceBranch",
     "branches"
   ],
+  "dependentSchemas": {
+    "isFirefoxLabsOptIn": {
+      "if": {
+        "properties": {
+          "isFirefoxLabsOptIn": {
+            "const": true
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "isRollout": {
+            "const": true
+          }
+        },
+        "required": [
+          "firefoxLabsDescription",
+          "firefoxLabsTitle",
+          "isRollout"
+        ],
+        "type": "object"
+      }
+    }
+  },
   "$defs": {
     "ExperimentBucketConfig": {
       "properties": {