@mozilla/nimbus-schemas 3003.0.0 → 3004.0.0

package/index.d.ts

@@ -70,6 +70,8 @@ export interface DesktopAllVersionsNimbusExperiment {
   appId: string;
   /**
    * A specific channel of an application such as "nightly", "beta", or "release".
+   *
+   * This field is only respected by nimbus-sdk-based applications.
    */
   channel: string;
   /**
@@ -152,6 +154,10 @@ export interface DesktopAllVersionsNimbusExperiment {
    * If null, it has not yet been published.
    */
   publishedDate?: string | null;
+  /**
+   * Opt out of feature schema validation.
+   */
+  featureValidationOptOut?: boolean;
   /**
    * When this property is set to true, treat this experiment as a Firefox Labs experiment
    */
@@ -180,10 +186,6 @@ export interface DesktopAllVersionsNimbusExperiment {
    * Branch configuration for the experiment.
    */
   branches: DesktopAllVersionsExperimentBranch[];
-  /**
-   * Opt out of feature schema validation.
-   */
-  featureValidationOptOut?: boolean;
   /**
    * The group this should appear under in Firefox Labs
    */
@@ -316,6 +318,8 @@ export interface DesktopNimbusExperiment {
   appId: string;
   /**
    * A specific channel of an application such as "nightly", "beta", or "release".
+   *
+   * This field is only respected by nimbus-sdk-based applications.
    */
   channel: string;
   /**
@@ -398,6 +402,10 @@ export interface DesktopNimbusExperiment {
    * If null, it has not yet been published.
    */
   publishedDate?: string | null;
+  /**
+   * Opt out of feature schema validation.
+   */
+  featureValidationOptOut?: boolean;
   /**
    * When this property is set to true, treat this experiment as a Firefox Labs experiment
    */
@@ -426,10 +434,6 @@ export interface DesktopNimbusExperiment {
    * Branch configuration for the experiment.
    */
   branches: DesktopExperimentBranch[];
-  /**
-   * Opt out of feature schema validation.
-   */
-  featureValidationOptOut?: boolean;
   /**
    * The group this should appear under in Firefox Labs
    */
@@ -492,6 +496,8 @@ export interface SdkNimbusExperiment {
   appId: string;
   /**
    * A specific channel of an application such as "nightly", "beta", or "release".
+   *
+   * This field is only respected by nimbus-sdk-based applications.
    */
   channel: string;
   /**
@@ -577,6 +583,12 @@ export interface SdkNimbusExperiment {
    * If null, it has not yet been published.
    */
   publishedDate?: string | null;
+  /**
+   * If true, clients should not perform feature validation.
+   *
+   * This field is only supported by Firefox Desktop.
+   */
+  featureValidationOptOut?: boolean | null;
   /**
    * When this property is set to true, treat this experiment as a Firefox Labs experiment
    */
@@ -899,3 +911,202 @@ export interface Statistic {
   analysis_basis?: AnalysisBasis | null;
   window_index?: string | null;
 }
+/**
+ * A Nimbus experiment for V7.
+ */
+export interface NimbusExperimentV7 {
+  /**
+   * Version of the NimbusExperiment schema this experiment refers to
+   */
+  schemaVersion: string;
+  /**
+   * Unique identifier for the experiment
+   */
+  slug: string;
+  /**
+   * Unique identifier for the experiiment.
+   *
+   * This is a duplicate of slug, but is required field for all Remote Settings records.
+   */
+  id: string;
+  /**
+   * 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".
+   */
+  appName: string;
+  /**
+   * 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".
+   */
+  appId: string;
+  /**
+   * A specific channel of an application such as "nightly", "beta", or "release".
+   *
+   * This field is only respected by nimbus-sdk-based applications.
+   */
+  channel: string;
+  /**
+   * Public name of the experiment that will be displayed on "about:studies".
+   */
+  userFacingName: string;
+  /**
+   * Short public description of the experiment that will be displayed on "about:studies".
+   */
+  userFacingDescription: string;
+  /**
+   * When this property is set to true, the SDK should not enroll new users into the experiment that have not already been enrolled.
+   */
+  isEnrollmentPaused: boolean;
+  /**
+   * 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
+   */
+  isRollout?: boolean;
+  bucketConfig: ExperimentBucketConfig;
+  /**
+   * A list of outcomes relevant to the experiment analysis.
+   */
+  outcomes?: ExperimentOutcome[];
+  /**
+   * A list of featureIds the experiment contains configurations for.
+   */
+  featureIds: string[];
+  /**
+   * A JEXL targeting expression used to filter out experiments.
+   */
+  targeting?: string | null;
+  /**
+   * Actual publish date of the experiment.
+   *
+   * Note that this value is expected to be null in Remote Settings.
+   */
+  startDate: string | null;
+  /**
+   * Actual enrollment end date of the experiment.
+   *
+   * Note that this value is expected to be null in Remote Settings.
+   */
+  enrollmentEndDate?: string | null;
+  /**
+   * Actual end date of this experiment.
+   *
+   * Note that this field is expected to be null in Remote Settings.
+   */
+  endDate: string | null;
+  /**
+   * 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).
+   */
+  proposedDuration?: number;
+  /**
+   * 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).
+   */
+  proposedEnrollment: number;
+  /**
+   * The slug of the reference branch (i.e., the branch we consider "control").
+   */
+  referenceBranch: string | null;
+  /**
+   * The list of locale codes (e.g., "en-US" or "fr") that this experiment is targeting.
+   *
+   * If null, all locales are targeted.
+   */
+  locales?: string[] | null;
+  /**
+   * Per-locale localization substitutions.
+   */
+  localizations?: ExperimentLocalizations | null;
+  /**
+   * The date that this experiment was first published to Remote Settings.
+   *
+   * If null, it has not yet been published.
+   */
+  publishedDate?: string | null;
+  /**
+   * If true, clients should not perform feature validation.
+   *
+   * This field is only supported by Firefox Desktop.
+   */
+  featureValidationOptOut?: boolean | 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;
+  /**
+   * The channels available for the experiment.
+   * This field should be preferred over the channel field.
+   */
+  channels?: string[];
+  /**
+   * Branch configuration for the experiment.
+   */
+  branches: ExperimentBranchV7[];
+  /**
+   * All documentation links associated with this experiment.
+   */
+  documentationLinks: DocumentationLink[];
+}
+export interface ExperimentBranchV7 {
+  /**
+   * Identifier for the branch.
+   */
+  slug: string;
+  /**
+   * 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.
+   */
+  ratio: number;
+  /**
+   * An array of feature configurations.
+   */
+  features: ExperimentFeatureConfig[];
+  /**
+   * A description of the branch.
+   */
+  description: string;
+  /**
+   * The URLs of any screenshots associated with the branch.
+   */
+  screenshots: string[];
+}
+export interface DocumentationLink {
+  /**
+   * The name associated with the link.
+   */
+  title: string;
+  /**
+   * The URL associated with the link.
+   */
+  link: string;
+}

package/package.json

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

package/schemas/DesktopAllVersionsNimbusExperiment.schema.json

@@ -24,7 +24,7 @@
       "description": "Bucketing configuration."
     },
     "channel": {
-      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
+      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\". This field is only respected by nimbus-sdk-based applications.",
       "type": "string"
     },
     "endDate": {

package/schemas/DesktopNimbusExperiment.schema.json

@@ -24,7 +24,7 @@
       "description": "Bucketing configuration."
     },
     "channel": {
-      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
+      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\". This field is only respected by nimbus-sdk-based applications.",
       "type": "string"
     },
     "endDate": {

package/schemas/NimbusExperimentV7.schema.json

@@ -15,7 +15,7 @@
     "branches": {
       "description": "Branch configuration for the experiment.",
       "items": {
-        "$ref": "#/$defs/BaseExperimentBranch"
+        "$ref": "#/$defs/ExperimentBranchV7"
       },
       "type": "array"
     },
@@ -24,9 +24,16 @@
       "description": "Bucketing configuration."
     },
     "channel": {
-      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
+      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\". This field is only respected by nimbus-sdk-based applications.",
       "type": "string"
     },
+    "channels": {
+      "description": "The channels available for the experiment. This field should be preferred over the channel field.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
     "documentationLinks": {
       "description": "All documentation links associated with this experiment.",
       "items": {
@@ -65,6 +72,17 @@
       },
       "type": "array"
     },
+    "featureValidationOptOut": {
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "If true, clients should not perform feature validation. This field is only supported by Firefox Desktop."
+    },
     "firefoxLabsDescription": {
       "anyOf": [
         {
@@ -264,8 +282,29 @@
     }
   },
   "$defs": {
-    "BaseExperimentBranch": {
+    "DocumentationLink": {
+      "properties": {
+        "link": {
+          "description": "The URL associated with the link.",
+          "type": "string"
+        },
+        "title": {
+          "description": "The name associated with the link.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "title",
+        "link"
+      ],
+      "type": "object"
+    },
+    "ExperimentBranchV7": {
       "properties": {
+        "description": {
+          "description": "A description of the branch.",
+          "type": "string"
+        },
         "features": {
           "description": "An array of feature configurations.",
           "items": {
@@ -277,6 +316,13 @@
           "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"
         },
+        "screenshots": {
+          "description": "The URLs of any screenshots associated with the branch.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "slug": {
           "description": "Identifier for the branch.",
           "type": "string"
@@ -285,24 +331,9 @@
       "required": [
         "slug",
         "ratio",
-        "features"
-      ],
-      "type": "object"
-    },
-    "DocumentationLink": {
-      "properties": {
-        "link": {
-          "description": "The URL associated with the link.",
-          "type": "string"
-        },
-        "title": {
-          "description": "The name associated with the link.",
-          "type": "string"
-        }
-      },
-      "required": [
-        "title",
-        "link"
+        "features",
+        "description",
+        "screenshots"
       ],
       "type": "object"
     },

package/schemas/SdkNimbusExperiment.schema.json

@@ -24,7 +24,7 @@
       "description": "Bucketing configuration."
     },
     "channel": {
-      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
+      "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\". This field is only respected by nimbus-sdk-based applications.",
       "type": "string"
     },
     "endDate": {
@@ -58,6 +58,17 @@
       },
       "type": "array"
     },
+    "featureValidationOptOut": {
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "If true, clients should not perform feature validation. This field is only supported by Firefox Desktop."
+    },
     "firefoxLabsDescription": {
       "anyOf": [
         {