@mozilla/nimbus-schemas 2023.9.2 → 2023.10.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.
- package/index.d.ts +42 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
export type AnalysisBasis = "enrollments" | "exposures";
|
|
9
9
|
export type LogSource = "jetstream" | "sizing" | "jetstream-preview";
|
|
10
10
|
export type AnalysisErrors = AnalysisError[];
|
|
11
|
+
export type FeatureVariableType = "int" | "string" | "boolean" | "json";
|
|
11
12
|
export type SizingReleaseChannel = "release" | "beta" | "nightly";
|
|
12
13
|
export type SizingUserType = "new" | "existing";
|
|
13
14
|
export type Statistics = Statistic[];
|
|
@@ -35,6 +36,45 @@ export interface ExternalConfig {
|
|
|
35
36
|
skip?: boolean;
|
|
36
37
|
url: string;
|
|
37
38
|
}
|
|
39
|
+
export interface FeatureManifest {
|
|
40
|
+
[k: string]: FeatureWithExposure | FeatureWithoutExposure;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* A feature that has exposure.
|
|
44
|
+
*/
|
|
45
|
+
export interface FeatureWithExposure {
|
|
46
|
+
description?: string;
|
|
47
|
+
isEarlyStartup?: boolean;
|
|
48
|
+
variables: {
|
|
49
|
+
[k: string]: FeatureVariable;
|
|
50
|
+
};
|
|
51
|
+
schema?: NimbusFeatureSchema;
|
|
52
|
+
hasExposure: true;
|
|
53
|
+
exposureDescription: string;
|
|
54
|
+
}
|
|
55
|
+
export interface FeatureVariable {
|
|
56
|
+
description?: string;
|
|
57
|
+
enum?: string[];
|
|
58
|
+
fallbackPref?: string;
|
|
59
|
+
type?: FeatureVariableType;
|
|
60
|
+
setPref?: string;
|
|
61
|
+
}
|
|
62
|
+
export interface NimbusFeatureSchema {
|
|
63
|
+
uri: string;
|
|
64
|
+
path: string;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* A feature without exposure.
|
|
68
|
+
*/
|
|
69
|
+
export interface FeatureWithoutExposure {
|
|
70
|
+
description?: string;
|
|
71
|
+
isEarlyStartup?: boolean;
|
|
72
|
+
variables: {
|
|
73
|
+
[k: string]: FeatureVariable;
|
|
74
|
+
};
|
|
75
|
+
schema?: NimbusFeatureSchema;
|
|
76
|
+
hasExposure?: false;
|
|
77
|
+
}
|
|
38
78
|
export interface Metadata {
|
|
39
79
|
analysis_start_time?: string;
|
|
40
80
|
external_config?: ExternalConfig;
|
|
@@ -163,7 +203,8 @@ export interface SizingTarget {
|
|
|
163
203
|
export interface SizingRecipe {
|
|
164
204
|
app_id: string;
|
|
165
205
|
channel: SizingReleaseChannel;
|
|
166
|
-
locale
|
|
206
|
+
locale?: string;
|
|
207
|
+
language?: string;
|
|
167
208
|
country: string;
|
|
168
209
|
new_or_existing: SizingUserType;
|
|
169
210
|
}
|