@mozilla/nimbus-schemas 3000.0.0 → 3001.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 (7) hide show
  1. package/index.d.ts +166 -78
  2. package/package.json +1 -1
  3. package/schemas/DesktopAllVersionsNimbusExperiment.schema.json +33 -33
  4. package/schemas/DesktopNimbusExperiment.schema.json +33 -33
  5. package/schemas/ExperimentBucketConfig.schema.json +1 -2
  6. package/schemas/NimbusExperimentV7.schema.json +52 -27
  7. package/schemas/SdkNimbusExperiment.schema.json +41 -20
package/schemas/SdkNimbusExperiment.schema.json CHANGED
@@ -13,35 +13,35 @@
13
13
  "type": "string"
14
14
  },
15
15
  "id": {
16
- "description": "Unique identifier for the experiment. This is a duplicate of slug, but is required field for all Remote Settings records.",
16
+ "description": "Unique identifier for the experiiment. This is a duplicate of slug, but is required field for all Remote Settings records.",
17
17
  "type": "string"
18
18
  },
19
19
  "appName": {
20
- "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\".",
20
+ "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\".",
21
21
  "type": "string"
22
22
  },
23
23
  "appId": {
24
- "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\".",
24
+ "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\".",
25
25
  "type": "string"
26
26
  },
27
27
  "channel": {
28
- "description": "A specific channel of an application such as 'nightly', 'beta', or 'release'.",
28
+ "description": "A specific channel of an application such as \"nightly\", \"beta\", or \"release\".",
29
29
  "type": "string"
30
30
  },
31
31
  "userFacingName": {
32
- "description": "Public name of the experiment displayed on 'about:studies'.",
32
+ "description": "Public name of the experiment that will be displayed on \"about:studies\".",
33
33
  "type": "string"
34
34
  },
35
35
  "userFacingDescription": {
36
- "description": "Short public description of the experiment. that will be displayed on \"about:studies\".",
36
+ "description": "Short public description of the experiment that will be displayed on \"about:studies\".",
37
37
  "type": "string"
38
38
  },
39
39
  "isEnrollmentPaused": {
40
- "description": "When this property is set to true, the SDK should not enroll new users into the experiment that have not already been enrolled.",
40
+ "description": "When this property is set to true, the SDK should not enroll new users into the experiment that have not already been enrolled.",
41
41
  "type": "boolean"
42
42
  },
43
43
  "isRollout": {
44
- "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",
44
+ "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",
45
45
  "type": "boolean"
46
46
  },
47
47
  "bucketConfig": {
@@ -49,7 +49,7 @@
49
49
  "description": "Bucketing configuration."
50
50
  },
51
51
  "outcomes": {
52
- "description": "List of outcomes relevant to analysis.",
52
+ "description": "A list of outcomes relevant to the experiment analysis.",
53
53
  "items": {
54
54
  "$ref": "#/$defs/ExperimentOutcome"
55
55
  },
@@ -83,7 +83,7 @@
83
83
  "type": "null"
84
84
  }
85
85
  ],
86
- "description": "Actual publish date of the experiment. Note that this value is expected to be null in Remote Settings."
86
+ "description": "Actual publish date of the experiment. Note that this value is expected to be null in Remote Settings."
87
87
  },
88
88
  "enrollmentEndDate": {
89
89
  "anyOf": [
@@ -95,7 +95,7 @@
95
95
  "type": "null"
96
96
  }
97
97
  ],
98
- "description": "Actual enrollment end date of the experiment. Note that this value is expected to be null in Remote Settings."
98
+ "description": "Actual enrollment end date of the experiment. Note that this value is expected to be null in Remote Settings."
99
99
  },
100
100
  "endDate": {
101
101
  "anyOf": [
@@ -107,14 +107,14 @@
107
107
  "type": "null"
108
108
  }
109
109
  ],
110
- "description": "Actual end date of this experiment. Note that this field is expected to be null in Remote Settings."
110
+ "description": "Actual end date of this experiment. Note that this field is expected to be null in Remote Settings."
111
111
  },
112
112
  "proposedDuration": {
113
- "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).",
113
+ "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).",
114
114
  "type": "integer"
115
115
  },
116
116
  "proposedEnrollment": {
117
- "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).",
117
+ "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).",
118
118
  "type": "integer"
119
119
  },
120
120
  "referenceBranch": {
@@ -126,7 +126,7 @@
126
126
  "type": "null"
127
127
  }
128
128
  ],
129
- "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
129
+ "description": "The slug of the reference branch (i.e., the branch we consider \"control\")."
130
130
  },
131
131
  "locales": {
132
132
  "anyOf": [
@@ -140,7 +140,18 @@
140
140
  "type": "null"
141
141
  }
142
142
  ],
143
- "description": "The list of locale codes (e.g., \"en-US\" or \"fr\") that this experiment is targeting. If null, all locales are targeted."
143
+ "description": "The list of locale codes (e.g., \"en-US\" or \"fr\") that this experiment is targeting. If null, all locales are targeted."
144
+ },
145
+ "localizations": {
146
+ "anyOf": [
147
+ {
148
+ "$ref": "#/$defs/ExperimentLocalizations"
149
+ },
150
+ {
151
+ "type": "null"
152
+ }
153
+ ],
154
+ "description": "Per-locale localization substitutions."
144
155
  },
145
156
  "publishedDate": {
146
157
  "anyOf": [
@@ -152,7 +163,7 @@
152
163
  "type": "null"
153
164
  }
154
165
  ],
155
- "description": "The date that this experiment was first published to Remote Settings. If null, it has not yet been published."
166
+ "description": "The date that this experiment was first published to Remote Settings. If null, it has not yet been published."
156
167
  },
157
168
  "branches": {
158
169
  "description": "Branch configuration for the SDK experiment.",
@@ -173,6 +184,7 @@
173
184
  "userFacingDescription",
174
185
  "isEnrollmentPaused",
175
186
  "bucketConfig",
187
+ "featureIds",
176
188
  "startDate",
177
189
  "endDate",
178
190
  "proposedEnrollment",
@@ -181,7 +193,6 @@
181
193
  ],
182
194
  "$defs": {
183
195
  "ExperimentBucketConfig": {
184
- "description": "Common Bucketing Configuration used across all versions.",
185
196
  "properties": {
186
197
  "randomizationUnit": {
187
198
  "$ref": "#/$defs/RandomizationUnit"
@@ -199,7 +210,7 @@
199
210
  "type": "integer"
200
211
  },
201
212
  "total": {
202
- "description": "The total number of buckets. You can assume this will always be 10000.",
213
+ "description": "The total number of buckets. You can assume this will always be 10000.",
203
214
  "type": "integer"
204
215
  }
205
216
  },
@@ -229,6 +240,16 @@
229
240
  ],
230
241
  "type": "object"
231
242
  },
243
+ "ExperimentLocalizations": {
244
+ "additionalProperties": {
245
+ "additionalProperties": {
246
+ "type": "string"
247
+ },
248
+ "type": "object"
249
+ },
250
+ "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.",
251
+ "type": "object"
252
+ },
232
253
  "ExperimentOutcome": {
233
254
  "properties": {
234
255
  "slug": {
@@ -264,7 +285,7 @@
264
285
  "type": "string"
265
286
  },
266
287
  "ratio": {
267
- "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.",
288
+ "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.",
268
289
  "type": "integer"
269
290
  },
270
291
  "features": {