@mozilla/nimbus-shared
Advanced tools
Comparing version 2.2.1 to 2.3.0
@@ -329,7 +329,2 @@ export declare const test: { | ||
}; | ||
propertyNames: { | ||
description: string; | ||
pattern: string; | ||
minLength: number; | ||
}; | ||
}; | ||
@@ -541,56 +536,2 @@ } | { | ||
}; | ||
ShowHeartbeatArguments: { | ||
$schema: string; | ||
$ref: string; | ||
definitions: { | ||
ShowHeartbeatArguments: { | ||
type: string; | ||
properties: { | ||
surveyId: { | ||
type: string; | ||
description: string; | ||
}; | ||
message: { | ||
type: string; | ||
description: string; | ||
}; | ||
learnMoreMessage: { | ||
type: string; | ||
description: string; | ||
}; | ||
learnMoreUrl: { | ||
type: string; | ||
description: string; | ||
}; | ||
postAnswerUrl: { | ||
type: string; | ||
description: string; | ||
}; | ||
thanksMessage: { | ||
type: string; | ||
description: string; | ||
}; | ||
engagementButtonLabel: { | ||
type: string; | ||
description: string; | ||
}; | ||
includeTelemetryUUID: { | ||
type: string; | ||
description: string; | ||
}; | ||
repeatOption: { | ||
type: string; | ||
enum: string[]; | ||
description: string; | ||
}; | ||
repeatEvery: { | ||
type: string; | ||
description: string; | ||
}; | ||
}; | ||
required: string[]; | ||
description: string; | ||
}; | ||
}; | ||
}; | ||
NormandyRecipe: { | ||
@@ -889,3 +830,2 @@ $schema: string; | ||
description: string; | ||
deprecated: boolean; | ||
}; | ||
@@ -1047,2 +987,56 @@ isEnrollmentPaused: { | ||
}; | ||
ShowHeartbeatArguments: { | ||
$schema: string; | ||
$ref: string; | ||
definitions: { | ||
ShowHeartbeatArguments: { | ||
type: string; | ||
properties: { | ||
surveyId: { | ||
type: string; | ||
description: string; | ||
}; | ||
message: { | ||
type: string; | ||
description: string; | ||
}; | ||
learnMoreMessage: { | ||
type: string; | ||
description: string; | ||
}; | ||
learnMoreUrl: { | ||
type: string; | ||
description: string; | ||
}; | ||
postAnswerUrl: { | ||
type: string; | ||
description: string; | ||
}; | ||
thanksMessage: { | ||
type: string; | ||
description: string; | ||
}; | ||
engagementButtonLabel: { | ||
type: string; | ||
description: string; | ||
}; | ||
includeTelemetryUUID: { | ||
type: string; | ||
description: string; | ||
}; | ||
repeatOption: { | ||
type: string; | ||
enum: string[]; | ||
description: string; | ||
}; | ||
repeatEvery: { | ||
type: string; | ||
description: string; | ||
}; | ||
}; | ||
required: string[]; | ||
description: string; | ||
}; | ||
}; | ||
}; | ||
AddonRolloutArguments: { | ||
@@ -1106,20 +1100,2 @@ $schema: string; | ||
}; | ||
AddonRollbackArguments: { | ||
$schema: string; | ||
$ref: string; | ||
definitions: { | ||
AddonRollbackArguments: { | ||
type: string; | ||
properties: { | ||
rolloutSlug: { | ||
type: string; | ||
description: string; | ||
pattern: string; | ||
}; | ||
}; | ||
required: string[]; | ||
description: string; | ||
}; | ||
}; | ||
}; | ||
MessagingExperimentArguments: { | ||
@@ -1196,2 +1172,20 @@ $schema: string; | ||
}; | ||
AddonRollbackArguments: { | ||
$schema: string; | ||
$ref: string; | ||
definitions: { | ||
AddonRollbackArguments: { | ||
type: string; | ||
properties: { | ||
rolloutSlug: { | ||
type: string; | ||
description: string; | ||
pattern: string; | ||
}; | ||
}; | ||
required: string[]; | ||
description: string; | ||
}; | ||
}; | ||
}; | ||
BranchedAddonStudyArguments: { | ||
@@ -1371,3 +1365,2 @@ $schema: string; | ||
description: string; | ||
deprecated: boolean; | ||
}; | ||
@@ -1374,0 +1367,0 @@ isEnrollmentPaused: { |
@@ -219,4 +219,2 @@ "use strict"; | ||
"type": "string" | ||
}, "propertyNames": { | ||
"description": "A string ID.", "pattern": "^[A-Za-z0-9\\-]+$", "minLength": 9 | ||
} | ||
@@ -362,34 +360,2 @@ } | ||
} | ||
}, "ShowHeartbeatArguments": { | ||
"$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/ShowHeartbeatArguments", "definitions": { | ||
"ShowHeartbeatArguments": { | ||
"type": "object", "properties": { | ||
"surveyId": { | ||
"type": "string", "description": "Slug unique identifying this survey in telemetry" | ||
}, "message": { | ||
"type": "string", "description": "Message to show to the user" | ||
}, "learnMoreMessage": { | ||
"type": "string", "description": "Text to display in the \"learn more\" link" | ||
}, "learnMoreUrl": { | ||
"type": "string", "description": "URL to show to the user when the click the \"learn more\" link" | ||
}, "postAnswerUrl": { | ||
"type": "string", "description": "URL to redirect the user to after rating Firefox or clicking the engagement button" | ||
}, "thanksMessage": { | ||
"type": "string", "description": "Thanks message to show to the user after they've rated Firefox" | ||
}, "engagementButtonLabel": { | ||
"type": "string", "description": "Text for the engagement button.\n\nIf specified, this button will be shown instead of rating stars." | ||
}, "includeTelemetryUUID": { | ||
"type": "boolean", "description": "Include unique user ID in post-answer-url and Telemetry" | ||
}, "repeatOption": { | ||
"type": "string", "enum": [ | ||
"once", "xdays", "nag" | ||
], "description": "Determines how often a prompt is shown executes" | ||
}, "repeatEvery": { | ||
"type": "number", "description": "For repeatOption=xdays, how often (in days) the prompt is displayed" | ||
} | ||
}, "required": [ | ||
"surveyId", "message", "learnMoreMessage", "learnMoreUrl", "postAnswerUrl", "thanksMessage" | ||
], "description": "This action shows a single survey" | ||
} | ||
} | ||
}, "NormandyRecipe": { | ||
@@ -594,3 +560,3 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/NormandyRecipe", "definitions": { | ||
}, "isHighVolume": { | ||
"type": "boolean", "description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used.", "deprecated": true | ||
"type": "boolean", "description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used." | ||
}, "isEnrollmentPaused": { | ||
@@ -684,2 +650,34 @@ "type": "boolean", "description": "If true, new users will not be enrolled in the study.", "default": false | ||
} | ||
}, "ShowHeartbeatArguments": { | ||
"$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/ShowHeartbeatArguments", "definitions": { | ||
"ShowHeartbeatArguments": { | ||
"type": "object", "properties": { | ||
"surveyId": { | ||
"type": "string", "description": "Slug unique identifying this survey in telemetry" | ||
}, "message": { | ||
"type": "string", "description": "Message to show to the user" | ||
}, "learnMoreMessage": { | ||
"type": "string", "description": "Text to display in the \"learn more\" link" | ||
}, "learnMoreUrl": { | ||
"type": "string", "description": "URL to show to the user when the click the \"learn more\" link" | ||
}, "postAnswerUrl": { | ||
"type": "string", "description": "URL to redirect the user to after rating Firefox or clicking the engagement button" | ||
}, "thanksMessage": { | ||
"type": "string", "description": "Thanks message to show to the user after they've rated Firefox" | ||
}, "engagementButtonLabel": { | ||
"type": "string", "description": "Text for the engagement button.\n\nIf specified, this button will be shown instead of rating stars." | ||
}, "includeTelemetryUUID": { | ||
"type": "boolean", "description": "Include unique user ID in post-answer-url and Telemetry" | ||
}, "repeatOption": { | ||
"type": "string", "enum": [ | ||
"once", "xdays", "nag" | ||
], "description": "Determines how often a prompt is shown executes" | ||
}, "repeatEvery": { | ||
"type": "number", "description": "For repeatOption=xdays, how often (in days) the prompt is displayed" | ||
} | ||
}, "required": [ | ||
"surveyId", "message", "learnMoreMessage", "learnMoreUrl", "postAnswerUrl", "thanksMessage" | ||
], "description": "This action shows a single survey" | ||
} | ||
} | ||
}, "AddonRolloutArguments": { | ||
@@ -725,14 +723,2 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/AddonRolloutArguments", "definitions": { | ||
} | ||
}, "AddonRollbackArguments": { | ||
"$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/AddonRollbackArguments", "definitions": { | ||
"AddonRollbackArguments": { | ||
"type": "object", "properties": { | ||
"rolloutSlug": { | ||
"type": "string", "description": "Unique identifier of the rollout to undo", "pattern": "^[a-z0-9\\-_]+$" | ||
} | ||
}, "required": [ | ||
"rolloutSlug" | ||
], "description": "Undo an add-on rollout" | ||
} | ||
} | ||
}, "MessagingExperimentArguments": { | ||
@@ -776,2 +762,14 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/MessagingExperimentArguments", "definitions": { | ||
} | ||
}, "AddonRollbackArguments": { | ||
"$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/AddonRollbackArguments", "definitions": { | ||
"AddonRollbackArguments": { | ||
"type": "object", "properties": { | ||
"rolloutSlug": { | ||
"type": "string", "description": "Unique identifier of the rollout to undo", "pattern": "^[a-z0-9\\-_]+$" | ||
} | ||
}, "required": [ | ||
"rolloutSlug" | ||
], "description": "Undo an add-on rollout" | ||
} | ||
} | ||
}, "BranchedAddonStudyArguments": { | ||
@@ -876,3 +874,3 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/BranchedAddonStudyArguments", "definitions": { | ||
}, "isHighVolume": { | ||
"type": "boolean", "description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used.", "deprecated": true | ||
"type": "boolean", "description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used." | ||
}, "isEnrollmentPaused": { | ||
@@ -879,0 +877,0 @@ "type": "boolean", "description": "If true, new users will not be enrolled in the study.", "default": false |
@@ -102,6 +102,5 @@ /** | ||
* Only supported on desktop. | ||
* | ||
*/ | ||
localizations?: { | ||
[locale: string]: Record<L10nStringID, string>; | ||
[locale: string]: Record<string, string>; | ||
} | null; | ||
@@ -116,9 +115,2 @@ /** | ||
} | ||
/** | ||
* A string ID. | ||
* | ||
* @pattern ^[A-Za-z0-9\-]+$ | ||
* @minLength 9 | ||
*/ | ||
declare type L10nStringID = string; | ||
interface BucketConfig { | ||
@@ -125,0 +117,0 @@ /** |
{ | ||
"name": "@mozilla/nimbus-shared", | ||
"version": "2.2.1", | ||
"version": "2.3.0", | ||
"license": "MPL-2.0", | ||
@@ -35,3 +35,3 @@ "engines": { | ||
"prettier": "^2.0.5", | ||
"ts-json-schema-generator": "^1.2.0", | ||
"ts-json-schema-generator": "^0.77.0", | ||
"ts-node": "^8.10.1", | ||
@@ -38,0 +38,0 @@ "typescript": "^3.9.3" |
@@ -326,7 +326,2 @@ { | ||
"type": "string" | ||
}, | ||
"propertyNames": { | ||
"description": "A string ID.", | ||
"pattern": "^[A-Za-z0-9\\-]+$", | ||
"minLength": 9 | ||
} | ||
@@ -333,0 +328,0 @@ } |
@@ -100,4 +100,3 @@ { | ||
"type": "boolean", | ||
"description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used.", | ||
"deprecated": true | ||
"description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used." | ||
}, | ||
@@ -104,0 +103,0 @@ "isEnrollmentPaused": { |
@@ -398,4 +398,3 @@ { | ||
"type": "boolean", | ||
"description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used.", | ||
"deprecated": true | ||
"description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used." | ||
}, | ||
@@ -402,0 +401,0 @@ "isEnrollmentPaused": { |
@@ -218,4 +218,2 @@ export const test = { | ||
"type": "string" | ||
}, "propertyNames": { | ||
"description": "A string ID.", "pattern": "^[A-Za-z0-9\\-]+$", "minLength": 9 | ||
} | ||
@@ -363,34 +361,2 @@ } | ||
} | ||
}, "ShowHeartbeatArguments": { | ||
"$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/ShowHeartbeatArguments", "definitions": { | ||
"ShowHeartbeatArguments": { | ||
"type": "object", "properties": { | ||
"surveyId": { | ||
"type": "string", "description": "Slug unique identifying this survey in telemetry" | ||
}, "message": { | ||
"type": "string", "description": "Message to show to the user" | ||
}, "learnMoreMessage": { | ||
"type": "string", "description": "Text to display in the \"learn more\" link" | ||
}, "learnMoreUrl": { | ||
"type": "string", "description": "URL to show to the user when the click the \"learn more\" link" | ||
}, "postAnswerUrl": { | ||
"type": "string", "description": "URL to redirect the user to after rating Firefox or clicking the engagement button" | ||
}, "thanksMessage": { | ||
"type": "string", "description": "Thanks message to show to the user after they've rated Firefox" | ||
}, "engagementButtonLabel": { | ||
"type": "string", "description": "Text for the engagement button.\n\nIf specified, this button will be shown instead of rating stars." | ||
}, "includeTelemetryUUID": { | ||
"type": "boolean", "description": "Include unique user ID in post-answer-url and Telemetry" | ||
}, "repeatOption": { | ||
"type": "string", "enum": [ | ||
"once", "xdays", "nag" | ||
], "description": "Determines how often a prompt is shown executes" | ||
}, "repeatEvery": { | ||
"type": "number", "description": "For repeatOption=xdays, how often (in days) the prompt is displayed" | ||
} | ||
}, "required": [ | ||
"surveyId", "message", "learnMoreMessage", "learnMoreUrl", "postAnswerUrl", "thanksMessage" | ||
], "description": "This action shows a single survey" | ||
} | ||
} | ||
}, "NormandyRecipe": { | ||
@@ -595,3 +561,3 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/NormandyRecipe", "definitions": { | ||
}, "isHighVolume": { | ||
"type": "boolean", "description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used.", "deprecated": true | ||
"type": "boolean", "description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used." | ||
}, "isEnrollmentPaused": { | ||
@@ -685,2 +651,34 @@ "type": "boolean", "description": "If true, new users will not be enrolled in the study.", "default": false | ||
} | ||
}, "ShowHeartbeatArguments": { | ||
"$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/ShowHeartbeatArguments", "definitions": { | ||
"ShowHeartbeatArguments": { | ||
"type": "object", "properties": { | ||
"surveyId": { | ||
"type": "string", "description": "Slug unique identifying this survey in telemetry" | ||
}, "message": { | ||
"type": "string", "description": "Message to show to the user" | ||
}, "learnMoreMessage": { | ||
"type": "string", "description": "Text to display in the \"learn more\" link" | ||
}, "learnMoreUrl": { | ||
"type": "string", "description": "URL to show to the user when the click the \"learn more\" link" | ||
}, "postAnswerUrl": { | ||
"type": "string", "description": "URL to redirect the user to after rating Firefox or clicking the engagement button" | ||
}, "thanksMessage": { | ||
"type": "string", "description": "Thanks message to show to the user after they've rated Firefox" | ||
}, "engagementButtonLabel": { | ||
"type": "string", "description": "Text for the engagement button.\n\nIf specified, this button will be shown instead of rating stars." | ||
}, "includeTelemetryUUID": { | ||
"type": "boolean", "description": "Include unique user ID in post-answer-url and Telemetry" | ||
}, "repeatOption": { | ||
"type": "string", "enum": [ | ||
"once", "xdays", "nag" | ||
], "description": "Determines how often a prompt is shown executes" | ||
}, "repeatEvery": { | ||
"type": "number", "description": "For repeatOption=xdays, how often (in days) the prompt is displayed" | ||
} | ||
}, "required": [ | ||
"surveyId", "message", "learnMoreMessage", "learnMoreUrl", "postAnswerUrl", "thanksMessage" | ||
], "description": "This action shows a single survey" | ||
} | ||
} | ||
}, "AddonRolloutArguments": { | ||
@@ -726,14 +724,2 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/AddonRolloutArguments", "definitions": { | ||
} | ||
}, "AddonRollbackArguments": { | ||
"$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/AddonRollbackArguments", "definitions": { | ||
"AddonRollbackArguments": { | ||
"type": "object", "properties": { | ||
"rolloutSlug": { | ||
"type": "string", "description": "Unique identifier of the rollout to undo", "pattern": "^[a-z0-9\\-_]+$" | ||
} | ||
}, "required": [ | ||
"rolloutSlug" | ||
], "description": "Undo an add-on rollout" | ||
} | ||
} | ||
}, "MessagingExperimentArguments": { | ||
@@ -777,2 +763,14 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/MessagingExperimentArguments", "definitions": { | ||
} | ||
}, "AddonRollbackArguments": { | ||
"$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/AddonRollbackArguments", "definitions": { | ||
"AddonRollbackArguments": { | ||
"type": "object", "properties": { | ||
"rolloutSlug": { | ||
"type": "string", "description": "Unique identifier of the rollout to undo", "pattern": "^[a-z0-9\\-_]+$" | ||
} | ||
}, "required": [ | ||
"rolloutSlug" | ||
], "description": "Undo an add-on rollout" | ||
} | ||
} | ||
}, "BranchedAddonStudyArguments": { | ||
@@ -877,3 +875,3 @@ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/BranchedAddonStudyArguments", "definitions": { | ||
}, "isHighVolume": { | ||
"type": "boolean", "description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used.", "deprecated": true | ||
"type": "boolean", "description": "Incorrect version of `isHighPopulation`. Included here for compatibility, but should not be used." | ||
}, "isEnrollmentPaused": { | ||
@@ -880,0 +878,0 @@ "type": "boolean", "description": "If true, new users will not be enrolled in the study.", "default": false |
@@ -128,6 +128,5 @@ /** | ||
* Only supported on desktop. | ||
* | ||
*/ | ||
localizations?: { | ||
[locale: string]: Record<L10nStringID, string>; | ||
[locale: string]: Record<string, string>; | ||
} | null; | ||
@@ -144,10 +143,2 @@ | ||
/** | ||
* A string ID. | ||
* | ||
* @pattern ^[A-Za-z0-9\-]+$ | ||
* @minLength 9 | ||
*/ | ||
type L10nStringID = string; | ||
interface BucketConfig { | ||
@@ -154,0 +145,0 @@ /** |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
439321
9362