npm - @mozilla/nimbus-schemas - Versions diffs - 3001.0.0 → 3003.0.0 - Mend

@mozilla/nimbus-schemas 3001.0.0 → 3003.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/index.d.ts +62 -30
package/package.json +1 -1
package/schemas/DesktopAllVersionsNimbusExperiment.schema.json +131 -130
package/schemas/DesktopFeature.schema.json +30 -30
package/schemas/DesktopFeatureManifest.schema.json +30 -30
package/schemas/DesktopNimbusExperiment.schema.json +124 -124
package/schemas/ExperimentBucketConfig.schema.json +6 -6
package/schemas/ExperimentFeatureConfig.schema.json +1 -0
package/schemas/ExperimentOutcome.schema.json +4 -4
package/schemas/NimbusExperimentV7.schema.json +162 -97
package/schemas/SdkFeatureManifest.schema.json +40 -12
package/schemas/SdkNimbusExperiment.schema.json +161 -89

package/schemas/DesktopFeature.schema.json CHANGED Viewed

@@ -4,33 +4,41 @@
   "description": "A feature.",
   "type": "object",
   "properties": {
+    "allowCoenrollment": {
+      "description": "If true, clients can enroll in multiple experiments and rollouts that use this feature.",
+      "type": "boolean"
+    },
+    "applications": {
+      "description": "The applications that can enroll in experiments for this feature. Defaults to \"firefox-desktop\".",
+      "items": {
+        "$ref": "#/$defs/DesktopApplication"
+      },
+      "minLength": 1,
+      "type": "array"
+    },
     "description": {
       "description": "The description of the feature.",
       "type": "string"
     },
-    "hasExposure": {
-      "description": "Whether or not this feature records exposure telemetry.",
-      "type": "boolean"
-    },
     "exposureDescription": {
       "description": "A description of the exposure telemetry collected by this feature. Only required if hasExposure is true.",
       "type": "string"
     },
-    "owner": {
-      "description": "The owner of the feature.",
-      "type": "string"
+    "hasExposure": {
+      "description": "Whether or not this feature records exposure telemetry.",
+      "type": "boolean"
     },
     "isEarlyStartup": {
       "description": "If true, the feature values will be cached in prefs so that they can be read before Nimbus is initialized during Firefox startup.",
       "type": "boolean"
     },
-    "applications": {
-      "description": "The applications that can enroll in experiments for this feature. Defaults to \"firefox-desktop\".",
-      "items": {
-        "$ref": "#/$defs/DesktopApplication"
-      },
-      "minLength": 1,
-      "type": "array"
+    "owner": {
+      "description": "The owner of the feature.",
+      "type": "string"
+    },
+    "schema": {
+      "$ref": "#/$defs/NimbusFeatureSchema",
+      "description": "An optional JSON schema that describes the feature variables."
     },
     "variables": {
       "additionalProperties": {
@@ -38,14 +46,6 @@
       },
       "description": "The variables that this feature can set.",
       "type": "object"
-    },
-    "schema": {
-      "$ref": "#/$defs/NimbusFeatureSchema",
-      "description": "An optional JSON schema that describes the feature variables."
-    },
-    "allowCoenrollment": {
-      "description": "If true, clients can enroll in multiple experiments and rollouts that use this feature.",
-      "type": "boolean"
     }
   },
   "required": [
@@ -171,10 +171,6 @@
           "description": "A description of the feature.",
           "type": "string"
         },
-        "type": {
-          "$ref": "#/$defs/FeatureVariableType",
-          "description": "The field type."
-        },
         "enum": {
           "anyOf": [
             {
@@ -206,6 +202,10 @@
             }
           ],
           "description": "A pref that should be set to the value of this variable when enrolling in experiments. Using a string is deprecated and unsupported in Firefox 124+."
+        },
+        "type": {
+          "$ref": "#/$defs/FeatureVariableType",
+          "description": "The field type."
         }
       },
       "required": [
@@ -226,13 +226,13 @@
     "NimbusFeatureSchema": {
       "description": "Information about a JSON schema.",
       "properties": {
-        "uri": {
-          "description": "The resource:// or chrome:// URI that can be loaded at runtime within Firefox. Required by Firefox so that Nimbus can import the schema for validation.",
-          "type": "string"
-        },
         "path": {
           "description": "The path to the schema file in the source checkout. Required by Experimenter so that it can find schema files in source checkouts.",
           "type": "string"
+        },
+        "uri": {
+          "description": "The resource:// or chrome:// URI that can be loaded at runtime within Firefox. Required by Firefox so that Nimbus can import the schema for validation.",
+          "type": "string"
         }
       },
       "required": [

package/schemas/DesktopFeatureManifest.schema.json CHANGED Viewed

@@ -24,33 +24,41 @@
         }
       },
       "properties": {
+        "allowCoenrollment": {
+          "description": "If true, clients can enroll in multiple experiments and rollouts that use this feature.",
+          "type": "boolean"
+        },
+        "applications": {
+          "description": "The applications that can enroll in experiments for this feature. Defaults to \"firefox-desktop\".",
+          "items": {
+            "$ref": "#/$defs/DesktopApplication"
+          },
+          "minLength": 1,
+          "type": "array"
+        },
         "description": {
           "description": "The description of the feature.",
           "type": "string"
         },
-        "hasExposure": {
-          "description": "Whether or not this feature records exposure telemetry.",
-          "type": "boolean"
-        },
         "exposureDescription": {
           "description": "A description of the exposure telemetry collected by this feature. Only required if hasExposure is true.",
           "type": "string"
         },
-        "owner": {
-          "description": "The owner of the feature.",
-          "type": "string"
+        "hasExposure": {
+          "description": "Whether or not this feature records exposure telemetry.",
+          "type": "boolean"
         },
         "isEarlyStartup": {
           "description": "If true, the feature values will be cached in prefs so that they can be read before Nimbus is initialized during Firefox startup.",
           "type": "boolean"
         },
-        "applications": {
-          "description": "The applications that can enroll in experiments for this feature. Defaults to \"firefox-desktop\".",
-          "items": {
-            "$ref": "#/$defs/DesktopApplication"
-          },
-          "minLength": 1,
-          "type": "array"
+        "owner": {
+          "description": "The owner of the feature.",
+          "type": "string"
+        },
+        "schema": {
+          "$ref": "#/$defs/NimbusFeatureSchema",
+          "description": "An optional JSON schema that describes the feature variables."
         },
         "variables": {
           "additionalProperties": {
@@ -58,14 +66,6 @@
           },
           "description": "The variables that this feature can set.",
           "type": "object"
-        },
-        "schema": {
-          "$ref": "#/$defs/NimbusFeatureSchema",
-          "description": "An optional JSON schema that describes the feature variables."
-        },
-        "allowCoenrollment": {
-          "description": "If true, clients can enroll in multiple experiments and rollouts that use this feature.",
-          "type": "boolean"
         }
       },
       "required": [
@@ -178,10 +178,6 @@
           "description": "A description of the feature.",
           "type": "string"
         },
-        "type": {
-          "$ref": "#/$defs/FeatureVariableType",
-          "description": "The field type."
-        },
         "enum": {
           "anyOf": [
             {
@@ -213,6 +209,10 @@
             }
           ],
           "description": "A pref that should be set to the value of this variable when enrolling in experiments. Using a string is deprecated and unsupported in Firefox 124+."
+        },
+        "type": {
+          "$ref": "#/$defs/FeatureVariableType",
+          "description": "The field type."
         }
       },
       "required": [
@@ -233,13 +233,13 @@
     "NimbusFeatureSchema": {
       "description": "Information about a JSON schema.",
       "properties": {
-        "uri": {
-          "description": "The resource:// or chrome:// URI that can be loaded at runtime within Firefox. Required by Firefox so that Nimbus can import the schema for validation.",
-          "type": "string"
-        },
         "path": {
           "description": "The path to the schema file in the source checkout. Required by Experimenter so that it can find schema files in source checkouts.",
           "type": "string"
+        },
+        "uri": {
+          "description": "The resource:// or chrome:// URI that can be loaded at runtime within Firefox. Required by Firefox so that Nimbus can import the schema for validation.",
+          "type": "string"
         }
       },
       "required": [

package/schemas/DesktopNimbusExperiment.schema.json CHANGED Viewed

@@ -4,76 +4,42 @@
   "description": "A Nimbus experiment for Firefox Desktop. This schema is less strict than DesktopAllVersionsNimbusExperiment and is intended for use in Firefox Desktop.",
   "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/DesktopExperimentBranch"
+      },
+      "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/DesktopExperimentBranch"
+        "$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,14 +295,6 @@
     "DesktopExperimentBranch": {
       "description": "The branch definition supported on Firefox Desktop 95+.",
       "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"
-        },
         "features": {
           "description": "An array of feature configurations.",
           "items": {
@@ -321,6 +312,14 @@
             }
           ],
           "description": "The branch title shown in Firefox Labs (Fluent ID)"
+        },
+        "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": [
@@ -332,21 +331,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"
@@ -368,6 +367,7 @@
           "type": "string"
         },
         "value": {
+          "additionalProperties": true,
           "description": "The values that define the feature configuration. This should be validated against a schema.",
           "type": "object"
         }
@@ -390,13 +390,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": [

package/schemas/ExperimentBucketConfig.schema.json CHANGED Viewed

@@ -3,21 +3,21 @@
   "title": "ExperimentBucketConfig",
   "type": "object",
   "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"

package/schemas/ExperimentFeatureConfig.schema.json CHANGED Viewed

@@ -8,6 +8,7 @@
       "type": "string"
     },
     "value": {
+      "additionalProperties": true,
       "description": "The values that define the feature configuration. This should be validated against a schema.",
       "type": "object"
     }