@mozilla/nimbus-schemas 2024.11.5 → 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 +14 -6
  2. package/package.json +1 -1
  3. package/schemas/DesktopAllVersionsNimbusExperiment.schema.json +17 -13
  4. package/schemas/DesktopNimbusExperiment.schema.json +17 -13
package/index.d.ts CHANGED
@@ -160,11 +160,15 @@ 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
+ */
165
+ firefoxLabsGroup?: string | null;
166
+ /**
167
+ * The title shown in Firefox Labs (Fluent ID)
164
168
  */
165
169
  firefoxLabsTitle?: string | null;
166
170
  /**
167
- * An optional string containing the Fluent ID for the description of the opt-in
171
+ * The description shown in Firefox Labs (Fluent ID)
168
172
  */
169
173
  firefoxLabsDescription?: string | null;
170
174
  /**
@@ -226,7 +230,7 @@ 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
235
  firefoxLabsTitle?: string | null;
232
236
  feature: DesktopPre95FeatureConfig;
@@ -491,11 +495,15 @@ 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
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
508
  firefoxLabsDescription?: string | null;
501
509
  /**
@@ -523,7 +531,7 @@ 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
536
  firefoxLabsTitle?: string | null;
529
537
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mozilla/nimbus-schemas",
3
- "version": "2024.11.5",
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,6 +165,17 @@
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
180
  "anyOf": [
170
181
  {
@@ -174,7 +185,7 @@
174
185
  "type": "null"
175
186
  }
176
187
  ],
177
- "description": "An optional string containing the Fluent ID for the title of the opt-in"
188
+ "description": "The title shown in Firefox Labs (Fluent ID)"
178
189
  },
179
190
  "firefoxLabsDescription": {
180
191
  "anyOf": [
@@ -185,7 +196,7 @@
185
196
  "type": "null"
186
197
  }
187
198
  ],
188
- "description": "An optional string containing the Fluent ID for the description of the opt-in"
199
+ "description": "The description shown in Firefox Labs (Fluent ID)"
189
200
  },
190
201
  "featureValidationOptOut": {
191
202
  "description": "Opt out of feature schema validation.",
@@ -239,17 +250,10 @@
239
250
  "isRollout"
240
251
  ]
241
252
  },
242
- "properties": {
243
- "firefoxLabsTitle": {
244
- "type": "string"
245
- },
246
- "firefoxLabsDescription": {
247
- "type": "string"
248
- }
249
- },
250
253
  "required": [
251
- "firefoxLabsTitle",
252
- "firefoxLabsDescription"
254
+ "firefoxLabsDescription",
255
+ "firefoxLabsGroup",
256
+ "firefoxLabsTitle"
253
257
  ],
254
258
  "then": {
255
259
  "properties": {
@@ -293,7 +297,7 @@
293
297
  "type": "null"
294
298
  }
295
299
  ],
296
- "description": "An optional string containing the title of the branch"
300
+ "description": "The branch title shown in Firefox Labs (Fluent ID)"
297
301
  },
298
302
  "feature": {
299
303
  "$ref": "#/$defs/DesktopPre95FeatureConfig",
package/schemas/DesktopNimbusExperiment.schema.json CHANGED
@@ -165,6 +165,17 @@
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
180
  "anyOf": [
170
181
  {
@@ -174,7 +185,7 @@
174
185
  "type": "null"
175
186
  }
176
187
  ],
177
- "description": "An optional string containing the Fluent ID for the title of the opt-in"
188
+ "description": "The title shown in Firefox Labs (Fluent ID)"
178
189
  },
179
190
  "firefoxLabsDescription": {
180
191
  "anyOf": [
@@ -185,7 +196,7 @@
185
196
  "type": "null"
186
197
  }
187
198
  ],
188
- "description": "An optional string containing the Fluent ID for the description of the opt-in"
199
+ "description": "The description shown in Firefox Labs (Fluent ID)"
189
200
  },
190
201
  "featureValidationOptOut": {
191
202
  "description": "Opt out of feature schema validation.",
@@ -239,17 +250,10 @@
239
250
  "isRollout"
240
251
  ]
241
252
  },
242
- "properties": {
243
- "firefoxLabsTitle": {
244
- "type": "string"
245
- },
246
- "firefoxLabsDescription": {
247
- "type": "string"
248
- }
249
- },
250
253
  "required": [
251
- "firefoxLabsTitle",
252
- "firefoxLabsDescription"
254
+ "firefoxLabsDescription",
255
+ "firefoxLabsGroup",
256
+ "firefoxLabsTitle"
253
257
  ],
254
258
  "then": {
255
259
  "properties": {
@@ -293,7 +297,7 @@
293
297
  "type": "null"
294
298
  }
295
299
  ],
296
- "description": "An optional string containing the title of the branch"
300
+ "description": "The branch title shown in Firefox Labs (Fluent ID)"
297
301
  }
298
302
  },
299
303
  "required": [