@mozilla/nimbus-schemas 2024.11.4 → 2024.12.1

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 (4) hide show
  1. package/index.d.ts +20 -12
  2. package/package.json +1 -1
  3. package/schemas/DesktopAllVersionsNimbusExperiment.schema.json +41 -16
  4. package/schemas/DesktopNimbusExperiment.schema.json +41 -16
package/index.d.ts CHANGED
@@ -160,13 +160,17 @@ export interface DesktopAllVersionsNimbusExperiment {
160
160
  */
161
161
  isFirefoxLabsOptIn?: boolean;
162
162
  /**
163
- * An optional string containing the Fluent ID for the title of the opt-in
163
+ * The group this should appear under in Firefox Labs
164
164
  */
165
- firefoxLabsTitle?: string;
165
+ firefoxLabsGroup?: string | null;
166
166
  /**
167
- * An optional string containing the Fluent ID for the description of the opt-in
167
+ * The title shown in Firefox Labs (Fluent ID)
168
168
  */
169
- firefoxLabsDescription?: string;
169
+ firefoxLabsTitle?: string | null;
170
+ /**
171
+ * The description shown in Firefox Labs (Fluent ID)
172
+ */
173
+ firefoxLabsDescription?: string | null;
170
174
  /**
171
175
  * Opt out of feature schema validation.
172
176
  */
@@ -226,9 +230,9 @@ export interface DesktopAllVersionsExperimentBranch {
226
230
  */
227
231
  features: ExperimentFeatureConfig[];
228
232
  /**
229
- * An optional string containing the title of the branch
233
+ * The branch title shown in Firefox Labs (Fluent ID)
230
234
  */
231
- firefoxLabsTitle?: string;
235
+ firefoxLabsTitle?: string | null;
232
236
  feature: DesktopPre95FeatureConfig;
233
237
  }
234
238
  export interface ExperimentFeatureConfig {
@@ -491,13 +495,17 @@ export interface DesktopNimbusExperiment {
491
495
  */
492
496
  isFirefoxLabsOptIn?: boolean;
493
497
  /**
494
- * An optional string containing the Fluent ID for the title of the opt-in
498
+ * The group this should appear under in Firefox Labs
499
+ */
500
+ firefoxLabsGroup?: string | null;
501
+ /**
502
+ * The title shown in Firefox Labs (Fluent ID)
495
503
  */
496
- firefoxLabsTitle?: string;
504
+ firefoxLabsTitle?: string | null;
497
505
  /**
498
- * An optional string containing the Fluent ID for the description of the opt-in
506
+ * The description shown in Firefox Labs (Fluent ID)
499
507
  */
500
- firefoxLabsDescription?: string;
508
+ firefoxLabsDescription?: string | null;
501
509
  /**
502
510
  * Opt out of feature schema validation.
503
511
  */
@@ -523,9 +531,9 @@ export interface DesktopExperimentBranch {
523
531
  */
524
532
  features: ExperimentFeatureConfig[];
525
533
  /**
526
- * An optional string containing the title of the branch
534
+ * The branch title shown in Firefox Labs (Fluent ID)
527
535
  */
528
- firefoxLabsTitle?: string;
536
+ firefoxLabsTitle?: string | null;
529
537
  }
530
538
  /**
531
539
  * The SDK-specific feature manifest.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mozilla/nimbus-schemas",
3
- "version": "2024.11.4",
3
+ "version": "2024.12.1",
4
4
  "description": "Schemas used by Mozilla Nimbus and related projects.",
5
5
  "main": "index.d.ts",
6
6
  "repository": {
package/schemas/DesktopAllVersionsNimbusExperiment.schema.json CHANGED
@@ -165,13 +165,38 @@
165
165
  "description": "When this property is set to true, treat this experiment as aFirefox Labs experiment",
166
166
  "type": "boolean"
167
167
  },
168
+ "firefoxLabsGroup": {
169
+ "anyOf": [
170
+ {
171
+ "type": "string"
172
+ },
173
+ {
174
+ "type": "null"
175
+ }
176
+ ],
177
+ "description": "The group this should appear under in Firefox Labs"
178
+ },
168
179
  "firefoxLabsTitle": {
169
- "description": "An optional string containing the Fluent ID for the title of the opt-in",
170
- "type": "string"
180
+ "anyOf": [
181
+ {
182
+ "type": "string"
183
+ },
184
+ {
185
+ "type": "null"
186
+ }
187
+ ],
188
+ "description": "The title shown in Firefox Labs (Fluent ID)"
171
189
  },
172
190
  "firefoxLabsDescription": {
173
- "description": "An optional string containing the Fluent ID for the description of the opt-in",
174
- "type": "string"
191
+ "anyOf": [
192
+ {
193
+ "type": "string"
194
+ },
195
+ {
196
+ "type": "null"
197
+ }
198
+ ],
199
+ "description": "The description shown in Firefox Labs (Fluent ID)"
175
200
  },
176
201
  "featureValidationOptOut": {
177
202
  "description": "Opt out of feature schema validation.",
@@ -225,17 +250,10 @@
225
250
  "isRollout"
226
251
  ]
227
252
  },
228
- "properties": {
229
- "firefoxLabsTitle": {
230
- "type": "string"
231
- },
232
- "firefoxLabsDescription": {
233
- "type": "string"
234
- }
235
- },
236
253
  "required": [
237
- "firefoxLabsTitle",
238
- "firefoxLabsDescription"
254
+ "firefoxLabsDescription",
255
+ "firefoxLabsGroup",
256
+ "firefoxLabsTitle"
239
257
  ],
240
258
  "then": {
241
259
  "properties": {
@@ -271,8 +289,15 @@
271
289
  "type": "array"
272
290
  },
273
291
  "firefoxLabsTitle": {
274
- "description": "An optional string containing the title of the branch",
275
- "type": "string"
292
+ "anyOf": [
293
+ {
294
+ "type": "string"
295
+ },
296
+ {
297
+ "type": "null"
298
+ }
299
+ ],
300
+ "description": "The branch title shown in Firefox Labs (Fluent ID)"
276
301
  },
277
302
  "feature": {
278
303
  "$ref": "#/$defs/DesktopPre95FeatureConfig",
package/schemas/DesktopNimbusExperiment.schema.json CHANGED
@@ -165,13 +165,38 @@
165
165
  "description": "When this property is set to true, treat this experiment as aFirefox Labs experiment",
166
166
  "type": "boolean"
167
167
  },
168
+ "firefoxLabsGroup": {
169
+ "anyOf": [
170
+ {
171
+ "type": "string"
172
+ },
173
+ {
174
+ "type": "null"
175
+ }
176
+ ],
177
+ "description": "The group this should appear under in Firefox Labs"
178
+ },
168
179
  "firefoxLabsTitle": {
169
- "description": "An optional string containing the Fluent ID for the title of the opt-in",
170
- "type": "string"
180
+ "anyOf": [
181
+ {
182
+ "type": "string"
183
+ },
184
+ {
185
+ "type": "null"
186
+ }
187
+ ],
188
+ "description": "The title shown in Firefox Labs (Fluent ID)"
171
189
  },
172
190
  "firefoxLabsDescription": {
173
- "description": "An optional string containing the Fluent ID for the description of the opt-in",
174
- "type": "string"
191
+ "anyOf": [
192
+ {
193
+ "type": "string"
194
+ },
195
+ {
196
+ "type": "null"
197
+ }
198
+ ],
199
+ "description": "The description shown in Firefox Labs (Fluent ID)"
175
200
  },
176
201
  "featureValidationOptOut": {
177
202
  "description": "Opt out of feature schema validation.",
@@ -225,17 +250,10 @@
225
250
  "isRollout"
226
251
  ]
227
252
  },
228
- "properties": {
229
- "firefoxLabsTitle": {
230
- "type": "string"
231
- },
232
- "firefoxLabsDescription": {
233
- "type": "string"
234
- }
235
- },
236
253
  "required": [
237
- "firefoxLabsTitle",
238
- "firefoxLabsDescription"
254
+ "firefoxLabsDescription",
255
+ "firefoxLabsGroup",
256
+ "firefoxLabsTitle"
239
257
  ],
240
258
  "then": {
241
259
  "properties": {
@@ -271,8 +289,15 @@
271
289
  "type": "array"
272
290
  },
273
291
  "firefoxLabsTitle": {
274
- "description": "An optional string containing the title of the branch",
275
- "type": "string"
292
+ "anyOf": [
293
+ {
294
+ "type": "string"
295
+ },
296
+ {
297
+ "type": "null"
298
+ }
299
+ ],
300
+ "description": "The branch title shown in Firefox Labs (Fluent ID)"
276
301
  }
277
302
  },
278
303
  "required": [