@mozilla/nimbus-schemas 2024.12.1 → 2025.1.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 +24 -0
  2. package/package.json +1 -1
  3. package/schemas/DesktopAllVersionsNimbusExperiment.schema.json +22 -0
  4. package/schemas/DesktopNimbusExperiment.schema.json +22 -0
package/index.d.ts CHANGED
@@ -171,10 +171,22 @@ export interface DesktopAllVersionsNimbusExperiment {
171
171
  * The description shown in Firefox Labs (Fluent ID)
172
172
  */
173
173
  firefoxLabsDescription?: string | null;
174
+ /**
175
+ * Links that will be used with the firefoxLabsDescription Fluent ID. May be null for Firefox Labs Opt-In recipes that do not use links.
176
+ */
177
+ firefoxLabsDescriptionLinks?: {
178
+ [k: string]: string;
179
+ } | null;
174
180
  /**
175
181
  * Opt out of feature schema validation.
176
182
  */
177
183
  featureValidationOptOut?: boolean;
184
+ /**
185
+ * Does the experiment require a restart to take effect?
186
+ *
187
+ * Only used by Firefox Labs Opt-Ins.
188
+ */
189
+ requiresRestart?: boolean;
178
190
  localizations?: ExperimentLocalizations | null;
179
191
  }
180
192
  export interface ExperimentBucketConfig {
@@ -506,10 +518,22 @@ export interface DesktopNimbusExperiment {
506
518
  * The description shown in Firefox Labs (Fluent ID)
507
519
  */
508
520
  firefoxLabsDescription?: string | null;
521
+ /**
522
+ * Links that will be used with the firefoxLabsDescription Fluent ID. May be null for Firefox Labs Opt-In recipes that do not use links.
523
+ */
524
+ firefoxLabsDescriptionLinks?: {
525
+ [k: string]: string;
526
+ } | null;
509
527
  /**
510
528
  * Opt out of feature schema validation.
511
529
  */
512
530
  featureValidationOptOut?: boolean;
531
+ /**
532
+ * Does the experiment require a restart to take effect?
533
+ *
534
+ * Only used by Firefox Labs Opt-Ins.
535
+ */
536
+ requiresRestart?: boolean;
513
537
  localizations?: ExperimentLocalizations | null;
514
538
  }
515
539
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mozilla/nimbus-schemas",
3
- "version": "2024.12.1",
3
+ "version": "2025.1.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
@@ -198,10 +198,31 @@
198
198
  ],
199
199
  "description": "The description shown in Firefox Labs (Fluent ID)"
200
200
  },
201
+ "firefoxLabsDescriptionLinks": {
202
+ "anyOf": [
203
+ {
204
+ "additionalProperties": {
205
+ "format": "uri",
206
+ "maxLength": 2083,
207
+ "minLength": 1,
208
+ "type": "string"
209
+ },
210
+ "type": "object"
211
+ },
212
+ {
213
+ "type": "null"
214
+ }
215
+ ],
216
+ "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."
217
+ },
201
218
  "featureValidationOptOut": {
202
219
  "description": "Opt out of feature schema validation.",
203
220
  "type": "boolean"
204
221
  },
222
+ "requiresRestart": {
223
+ "description": "Does the experiment require a restart to take effect? Only used by Firefox Labs Opt-Ins.",
224
+ "type": "boolean"
225
+ },
205
226
  "localizations": {
206
227
  "anyOf": [
207
228
  {
@@ -252,6 +273,7 @@
252
273
  },
253
274
  "required": [
254
275
  "firefoxLabsDescription",
276
+ "firefoxLabsDescriptionLinks",
255
277
  "firefoxLabsGroup",
256
278
  "firefoxLabsTitle"
257
279
  ],
package/schemas/DesktopNimbusExperiment.schema.json CHANGED
@@ -198,10 +198,31 @@
198
198
  ],
199
199
  "description": "The description shown in Firefox Labs (Fluent ID)"
200
200
  },
201
+ "firefoxLabsDescriptionLinks": {
202
+ "anyOf": [
203
+ {
204
+ "additionalProperties": {
205
+ "format": "uri",
206
+ "maxLength": 2083,
207
+ "minLength": 1,
208
+ "type": "string"
209
+ },
210
+ "type": "object"
211
+ },
212
+ {
213
+ "type": "null"
214
+ }
215
+ ],
216
+ "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."
217
+ },
201
218
  "featureValidationOptOut": {
202
219
  "description": "Opt out of feature schema validation.",
203
220
  "type": "boolean"
204
221
  },
222
+ "requiresRestart": {
223
+ "description": "Does the experiment require a restart to take effect? Only used by Firefox Labs Opt-Ins.",
224
+ "type": "boolean"
225
+ },
205
226
  "localizations": {
206
227
  "anyOf": [
207
228
  {
@@ -252,6 +273,7 @@
252
273
  },
253
274
  "required": [
254
275
  "firefoxLabsDescription",
276
+ "firefoxLabsDescriptionLinks",
255
277
  "firefoxLabsGroup",
256
278
  "firefoxLabsTitle"
257
279
  ],