@mozilla/nimbus-schemas - npm Package Compare versions

Comparing version 2024.11.2 to 2024.11.3

index.d.ts

@@ -137,8 +137,5 @@ /* tslint:disable */
 /**
- * The experiment definition accessible to:
- *
- * 1. The Nimbus SDK via Remote Settings
- * 2. Jetstream via the Experimenter API
+ * A Nimbus experiment for Firefox Desktop.
  */
-export interface NimbusExperiment {
+export interface DesktopNimbusExperiment {
   /**
@@ -196,14 +193,2 @@ * Version of the NimbusExperiment schema this experiment refers to
   isRollout?: boolean;
-  /**
-   * When this property is set to true, treat this experiment as aFirefox Labs experiment
-   */
-  isFirefoxLabsOptIn?: boolean;
-  /**
-   * An optional string containing the Fluent ID for the title of the opt-in
-   */
-  firefoxLabsTitle?: string;
-  /**
-   * An optional string containing the Fluent ID for the description of the opt-in
-   */
-  firefoxLabsDescription?: string;
   bucketConfig: ExperimentBucketConfig;
@@ -219,9 +204,2 @@ /**
   /**
-   * Branch configuration for the experiment.
-   */
-  branches:
-    | ExperimentSingleFeatureBranch[]
-    | ExperimentMultiFeatureDesktopBranch[]
-    | ExperimentMultiFeatureMobileBranch[];
-  /**
    * A JEXL targeting expression used to filter out experiments.
@@ -265,7 +243,2 @@ */
   /**
-   * Opt out of feature schema validation. Only supported on desktop.
-   */
-  featureValidationOptOut?: boolean;
-  localizations?: ExperimentLocalizations | null;
-  /**
    * The list of locale codes (e.g., "en-US" or "fr") that this experiment is targeting.
@@ -282,2 +255,23 @@ *
   publishedDate?: string | null;
+  /**
+   * Branch configuration for the experiment.
+   */
+  branches: DesktopExperimentBranch[];
+  /**
+   * When this property is set to true, treat this experiment as aFirefox Labs experiment
+   */
+  isFirefoxLabsOptIn?: boolean;
+  /**
+   * An optional string containing the Fluent ID for the title of the opt-in
+   */
+  firefoxLabsTitle?: string;
+  /**
+   * An optional string containing the Fluent ID for the description of the opt-in
+   */
+  firefoxLabsDescription?: string;
+  /**
+   * Opt out of feature schema validation.
+   */
+  featureValidationOptOut?: boolean;
+  localizations?: ExperimentLocalizations | null;
 }
@@ -316,8 +310,5 @@ export interface ExperimentBucketConfig {
 /**
- * A single-feature branch definition.
- *
- * Supported by Firefox Desktop for versions before 95, Firefox for Android for versions
- * before 96, and Firefox for iOS for versions before 39.
+ * The branch definition supported on Firefox Desktop 95+.
  */
-export interface ExperimentSingleFeatureBranch {
+export interface DesktopExperimentBranch {
   /**
@@ -333,3 +324,11 @@ * Identifier for the branch.
   ratio: number;
-  feature: ExperimentFeatureConfig;
+  /**
+   * An array of feature configurations.
+   */
+  features: ExperimentFeatureConfig[];
+  feature: DesktopTombstoneFeatureConfig;
+  /**
+   * An optional string containing the title of the branch
+   */
+  firefoxLabsTitle?: string;
 }
@@ -350,26 +349,2 @@ export interface ExperimentFeatureConfig {
 }
-/**
- * The branch definition supported on Firefox Desktop 95+.
- */
-export interface ExperimentMultiFeatureDesktopBranch {
-  /**
-   * Identifier for the branch.
-   */
-  slug: string;
-  /**
-   * 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.
-   */
-  ratio: number;
-  /**
-   * An array of feature configurations.
-   */
-  features: ExperimentFeatureConfig[];
-  feature: DesktopTombstoneFeatureConfig;
-  /**
-   * An optional string containing the title of the branch
-   */
-  firefoxLabsTitle?: string;
-}
 export interface DesktopTombstoneFeatureConfig {
@@ -383,8 +358,29 @@ featureId: "unused-feature-id-for-legacy-support";
 /**
- * The branch definition for mobile browsers.
+ * Per-locale localization substitutions.
  *
- * Supported on Firefox for Android 96+ and Firefox for iOS 39+.
+ * 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.
  */
-export interface ExperimentMultiFeatureMobileBranch {
+export interface ExperimentLocalizations {
+  [k: string]: {
+    [k: string]: string;
+  };
+}
+/**
+ * A Nimbus experiment for Nimbus SDK-based applications.
+ */
+export interface SdkNimbusExperiment {
   /**
+   * Branch configuration for the experiment.
+   */
+  branches: SdkExperimentBranch[];
+}
+/**
+ * The branch definition for SDK-based applications
+ *
+ * Supported on Firefox for Android 96+ and Firefox for iOS 39+ and all versions of
+ * Cirrus.
+ */
+export interface SdkExperimentBranch {
+  /**
    * Identifier for the branch.
@@ -405,15 +401,2 @@ */
 /**
- * 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.
- *
- * Only supported on desktop.
- */
-export interface ExperimentLocalizations {
-  [k: string]: {
-    [k: string]: string;
-  };
-}
-/**
  * The SDK-specific feature manifest.
@@ -420,0 +403,0 @@ */

package.json

 {
   "name": "@mozilla/nimbus-schemas",
-  "version": "2024.11.2",
+  "version": "2024.11.3",
   "description": "Schemas used by Mozilla Nimbus and related projects.",
@@ -5,0 +5,0 @@ "main": "index.d.ts",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of package files

9

increased by12.5%

Worsened metrics

Total package byte prevSize

64056

decreased by-1.47%

Lines of code

1638

decreased by-1.15%

No dependency changes