@uniformdev/context 20.75.1-alpha.16 → 20.76.1-alpha.3

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/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
- import { O as OutputSeverity, L as LogDrain, C as ContextPlugin, S as ScoreVector, A as AggregateDimension, T as TransitionDataStore, a as StorageCommands, V as VisitorData, Q as Quirks, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, P as PersonalizedVariant, g as PersonalizeOptions, h as Context, i as PersonalizedResult, j as VariationMatchDimensionCriteria, k as PersonalizationSelectionAlgorithmOptions, l as DevToolsEvents } from './types-C0Mthca3.mjs';
2
- export { m as AggregateDimensionInput, B as BehaviorTag, n as CONTEXTUAL_EDITING_TEST_NAME, o as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, q as CompositionMetadata, r as ContextEvents, s as ContextInstance, t as ContextOptions, u as ContextState, v as ContextStateUpdate, w as CriteriaEvaluatorParameters, x as CriteriaEvaluatorResult, y as DecayOptions, z as DevToolsActions, E as DevToolsDataEvent, F as DevToolsEvent, G as DevToolsForgetEvent, H as DevToolsHelloEvent, I as DevToolsLogEvent, J as DevToolsRawCommandsEvent, K as DevToolsState, N as DevToolsUiVersion, R as DevToolsUpdateEvent, U as DimensionMatch, W as EnrichmentCategory, X as EnrichmentData, Y as EventData, Z as GoalStateUpdate, _ as Goals, $ as GroupCriteriaEvaluator, a0 as IdentifyCommand, a1 as LogMessageGroup, a2 as LogMessageSingle, a3 as LogMessages, a4 as ManifestInstance, M as ManifestV2, a5 as MessageCategory, a6 as MessageFunc, a7 as ModifyScoreCommand, a8 as ModifySessionScoreCommand, a9 as NumberMatch, aa as PersonalizationEvent, ab as PersonalizationEventVariantId, ac as PersonalizationManifest, ad as PersonalizationSelectionAlgorithm, ae as PersonalizationSelectionAlgorithms, af as PersonalizeControlVariant, ag as PersonalizeVariants, ah as QuirkMatch, ai as SERVER_STATE_ID, aj as ServerToClientTransitionState, ak as SetConsentCommand, al as SetControlGroupCommand, am as SetGoalCommand, an as SetPersonalizeVariantControlCommand, ao as SetQuirkCommand, ap as SetTestCommand, aq as Severity, ar as Signal, as as SignalCriteria, at as SignalCriteriaGroup, au as SignalData, av as StorageCommand, aw as TestDefinition, ax as TestEvent, ay as TestOptions, az as TestResult, aA as TestVariant, aB as Tests, aC as TransitionDataStoreEvents, aD as VariationMatchMetadata, aE as VisitorDataStore, aF as VisitorDataStoreEvents, aG as VisitorDataStoreOptions, aH as areCommandsEqual, aI as emptyVisitorData, aJ as testVariations } from './types-C0Mthca3.mjs';
1
+ import { O as OutputSeverity, L as LogDrain, C as ContextPlugin, S as ScoreVector, A as AggregateDimension, T as TransitionDataStore, a as StorageCommands, V as VisitorData, Q as Quirks, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, P as PersonalizedVariant, g as PersonalizeOptions, h as Context, i as PersonalizedResult, j as VariationMatchDimensionCriteria, k as PersonalizationSelectionAlgorithmOptions, l as DevToolsEvents } from './types-DovaM4gV.mjs';
2
+ export { m as AggregateDimensionInput, B as BehaviorTag, n as CONTEXTUAL_EDITING_TEST_NAME, o as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, q as CompositionMetadata, r as ContextEvents, s as ContextInstance, t as ContextOptions, u as ContextState, v as ContextStateUpdate, w as CriteriaEvaluatorParameters, x as CriteriaEvaluatorResult, y as DecayOptions, z as DevToolsActions, E as DevToolsDataEvent, F as DevToolsEvent, G as DevToolsForgetEvent, H as DevToolsHelloEvent, I as DevToolsLogEvent, J as DevToolsRawCommandsEvent, K as DevToolsState, N as DevToolsUiVersion, R as DevToolsUpdateEvent, U as DimensionMatch, W as EnrichmentCategory, X as EnrichmentData, Y as EventData, Z as GoalStateUpdate, _ as Goals, $ as GroupCriteriaEvaluator, a0 as IdentifyCommand, a1 as LogMessageGroup, a2 as LogMessageSingle, a3 as LogMessages, a4 as ManifestInstance, M as ManifestV2, a5 as MessageCategory, a6 as MessageFunc, a7 as ModifyScoreCommand, a8 as ModifySessionScoreCommand, a9 as NumberMatch, aa as PersonalizationEvent, ab as PersonalizationEventVariantId, ac as PersonalizationManifest, ad as PersonalizationSelectionAlgorithm, ae as PersonalizationSelectionAlgorithms, af as PersonalizeControlVariant, ag as PersonalizeVariants, ah as QuirkMatch, ai as SERVER_STATE_ID, aj as ServerToClientTransitionState, ak as SetConsentCommand, al as SetControlGroupCommand, am as SetGoalCommand, an as SetPersonalizeVariantControlCommand, ao as SetQuirkCommand, ap as SetTestCommand, aq as Severity, ar as Signal, as as SignalCriteria, at as SignalCriteriaGroup, au as SignalData, av as StorageCommand, aw as TestDefinition, ax as TestEvent, ay as TestOptions, az as TestResult, aA as TestVariant, aB as Tests, aC as TransitionDataStoreEvents, aD as VariationMatchMetadata, aE as VisitorDataStore, aF as VisitorDataStoreEvents, aG as VisitorDataStoreOptions, aH as areCommandsEqual, aI as emptyVisitorData, aJ as testVariations } from './types-DovaM4gV.mjs';
3
3
  import 'mitt';
4
4
 
5
5
  /**
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { O as OutputSeverity, L as LogDrain, C as ContextPlugin, S as ScoreVector, A as AggregateDimension, T as TransitionDataStore, a as StorageCommands, V as VisitorData, Q as Quirks, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, P as PersonalizedVariant, g as PersonalizeOptions, h as Context, i as PersonalizedResult, j as VariationMatchDimensionCriteria, k as PersonalizationSelectionAlgorithmOptions, l as DevToolsEvents } from './types-C0Mthca3.js';
2
- export { m as AggregateDimensionInput, B as BehaviorTag, n as CONTEXTUAL_EDITING_TEST_NAME, o as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, q as CompositionMetadata, r as ContextEvents, s as ContextInstance, t as ContextOptions, u as ContextState, v as ContextStateUpdate, w as CriteriaEvaluatorParameters, x as CriteriaEvaluatorResult, y as DecayOptions, z as DevToolsActions, E as DevToolsDataEvent, F as DevToolsEvent, G as DevToolsForgetEvent, H as DevToolsHelloEvent, I as DevToolsLogEvent, J as DevToolsRawCommandsEvent, K as DevToolsState, N as DevToolsUiVersion, R as DevToolsUpdateEvent, U as DimensionMatch, W as EnrichmentCategory, X as EnrichmentData, Y as EventData, Z as GoalStateUpdate, _ as Goals, $ as GroupCriteriaEvaluator, a0 as IdentifyCommand, a1 as LogMessageGroup, a2 as LogMessageSingle, a3 as LogMessages, a4 as ManifestInstance, M as ManifestV2, a5 as MessageCategory, a6 as MessageFunc, a7 as ModifyScoreCommand, a8 as ModifySessionScoreCommand, a9 as NumberMatch, aa as PersonalizationEvent, ab as PersonalizationEventVariantId, ac as PersonalizationManifest, ad as PersonalizationSelectionAlgorithm, ae as PersonalizationSelectionAlgorithms, af as PersonalizeControlVariant, ag as PersonalizeVariants, ah as QuirkMatch, ai as SERVER_STATE_ID, aj as ServerToClientTransitionState, ak as SetConsentCommand, al as SetControlGroupCommand, am as SetGoalCommand, an as SetPersonalizeVariantControlCommand, ao as SetQuirkCommand, ap as SetTestCommand, aq as Severity, ar as Signal, as as SignalCriteria, at as SignalCriteriaGroup, au as SignalData, av as StorageCommand, aw as TestDefinition, ax as TestEvent, ay as TestOptions, az as TestResult, aA as TestVariant, aB as Tests, aC as TransitionDataStoreEvents, aD as VariationMatchMetadata, aE as VisitorDataStore, aF as VisitorDataStoreEvents, aG as VisitorDataStoreOptions, aH as areCommandsEqual, aI as emptyVisitorData, aJ as testVariations } from './types-C0Mthca3.js';
1
+ import { O as OutputSeverity, L as LogDrain, C as ContextPlugin, S as ScoreVector, A as AggregateDimension, T as TransitionDataStore, a as StorageCommands, V as VisitorData, Q as Quirks, b as TransitionDataStoreOptions, D as DecayFunction, c as CriteriaEvaluator, d as StringMatch, e as VariantMatchCriteria, f as LogMessage, P as PersonalizedVariant, g as PersonalizeOptions, h as Context, i as PersonalizedResult, j as VariationMatchDimensionCriteria, k as PersonalizationSelectionAlgorithmOptions, l as DevToolsEvents } from './types-DovaM4gV.js';
2
+ export { m as AggregateDimensionInput, B as BehaviorTag, n as CONTEXTUAL_EDITING_TEST_NAME, o as CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID, q as CompositionMetadata, r as ContextEvents, s as ContextInstance, t as ContextOptions, u as ContextState, v as ContextStateUpdate, w as CriteriaEvaluatorParameters, x as CriteriaEvaluatorResult, y as DecayOptions, z as DevToolsActions, E as DevToolsDataEvent, F as DevToolsEvent, G as DevToolsForgetEvent, H as DevToolsHelloEvent, I as DevToolsLogEvent, J as DevToolsRawCommandsEvent, K as DevToolsState, N as DevToolsUiVersion, R as DevToolsUpdateEvent, U as DimensionMatch, W as EnrichmentCategory, X as EnrichmentData, Y as EventData, Z as GoalStateUpdate, _ as Goals, $ as GroupCriteriaEvaluator, a0 as IdentifyCommand, a1 as LogMessageGroup, a2 as LogMessageSingle, a3 as LogMessages, a4 as ManifestInstance, M as ManifestV2, a5 as MessageCategory, a6 as MessageFunc, a7 as ModifyScoreCommand, a8 as ModifySessionScoreCommand, a9 as NumberMatch, aa as PersonalizationEvent, ab as PersonalizationEventVariantId, ac as PersonalizationManifest, ad as PersonalizationSelectionAlgorithm, ae as PersonalizationSelectionAlgorithms, af as PersonalizeControlVariant, ag as PersonalizeVariants, ah as QuirkMatch, ai as SERVER_STATE_ID, aj as ServerToClientTransitionState, ak as SetConsentCommand, al as SetControlGroupCommand, am as SetGoalCommand, an as SetPersonalizeVariantControlCommand, ao as SetQuirkCommand, ap as SetTestCommand, aq as Severity, ar as Signal, as as SignalCriteria, at as SignalCriteriaGroup, au as SignalData, av as StorageCommand, aw as TestDefinition, ax as TestEvent, ay as TestOptions, az as TestResult, aA as TestVariant, aB as Tests, aC as TransitionDataStoreEvents, aD as VariationMatchMetadata, aE as VisitorDataStore, aF as VisitorDataStoreEvents, aG as VisitorDataStoreOptions, aH as areCommandsEqual, aI as emptyVisitorData, aJ as testVariations } from './types-DovaM4gV.js';
3
3
  import 'mitt';
4
4
 
5
5
  /**
package/dist/index.esm.js CHANGED
@@ -999,8 +999,8 @@ var TransitionDataStore = class {
999
999
  }
1000
1000
  /**
1001
1001
  * Updates data in the transition storage.
1002
- * @param commands Commands to execute against existing stored value (event based stores)
1003
- * @param computedValue Pre-computed new value against existing value (object based stores)
1002
+ * @param commands - Commands to execute against existing stored value (event based stores)
1003
+ * @param computedValue - Pre-computed new value against existing value (object based stores)
1004
1004
  * @returns Resolved promise when the data has been updated
1005
1005
  */
1006
1006
  updateData(commands, computedValue) {
@@ -1540,7 +1540,7 @@ var VisitorDataStore = class {
1540
1540
  /**
1541
1541
  * Deletes visitor data (forgetting them)
1542
1542
  * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
1543
- * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
1543
+ * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
1544
1544
  */
1545
1545
  async delete(fromAllDevices) {
1546
1546
  var _a, _b, _c, _d, _e;
@@ -2063,7 +2063,7 @@ var Context = class {
2063
2063
  }
2064
2064
  /**
2065
2065
  * Forgets the visitor's data and resets the Context to its initial state.
2066
- * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
2066
+ * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
2067
2067
  */
2068
2068
  async forget(fromAllDevices) {
2069
2069
  const previousCompositionMetadata = __privateGet(this, _state).compositionMetadata;
@@ -2104,14 +2104,14 @@ var Context = class {
2104
2104
  });
2105
2105
  return transitionState;
2106
2106
  }
2107
- /** @deprecated */
2107
+ /** @deprecated Internal API for test event processing; not for public use. */
2108
2108
  internal_processTestEvent(event) {
2109
2109
  if (event.variantId) {
2110
2110
  this.setTestVariantId(event.name, event.variantId);
2111
2111
  __privateMethod(this, _Context_instances, emitTest_fn).call(this, event);
2112
2112
  }
2113
2113
  }
2114
- /** @deprecated */
2114
+ /** @deprecated Internal API for personalization event processing; not for public use. */
2115
2115
  internal_processPersonalizationEvent(event) {
2116
2116
  __privateGet(this, _pzCache)[event.name] = event.variantIds;
2117
2117
  __privateGet(this, _mitt3).emit("personalizationResult", event);
package/dist/index.js CHANGED
@@ -1092,8 +1092,8 @@ var TransitionDataStore = class {
1092
1092
  }
1093
1093
  /**
1094
1094
  * Updates data in the transition storage.
1095
- * @param commands Commands to execute against existing stored value (event based stores)
1096
- * @param computedValue Pre-computed new value against existing value (object based stores)
1095
+ * @param commands - Commands to execute against existing stored value (event based stores)
1096
+ * @param computedValue - Pre-computed new value against existing value (object based stores)
1097
1097
  * @returns Resolved promise when the data has been updated
1098
1098
  */
1099
1099
  updateData(commands, computedValue) {
@@ -1633,7 +1633,7 @@ var VisitorDataStore = class {
1633
1633
  /**
1634
1634
  * Deletes visitor data (forgetting them)
1635
1635
  * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
1636
- * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
1636
+ * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
1637
1637
  */
1638
1638
  async delete(fromAllDevices) {
1639
1639
  var _a, _b, _c, _d, _e;
@@ -2156,7 +2156,7 @@ var Context = class {
2156
2156
  }
2157
2157
  /**
2158
2158
  * Forgets the visitor's data and resets the Context to its initial state.
2159
- * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
2159
+ * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
2160
2160
  */
2161
2161
  async forget(fromAllDevices) {
2162
2162
  const previousCompositionMetadata = __privateGet(this, _state).compositionMetadata;
@@ -2197,14 +2197,14 @@ var Context = class {
2197
2197
  });
2198
2198
  return transitionState;
2199
2199
  }
2200
- /** @deprecated */
2200
+ /** @deprecated Internal API for test event processing; not for public use. */
2201
2201
  internal_processTestEvent(event) {
2202
2202
  if (event.variantId) {
2203
2203
  this.setTestVariantId(event.name, event.variantId);
2204
2204
  __privateMethod(this, _Context_instances, emitTest_fn).call(this, event);
2205
2205
  }
2206
2206
  }
2207
- /** @deprecated */
2207
+ /** @deprecated Internal API for personalization event processing; not for public use. */
2208
2208
  internal_processPersonalizationEvent(event) {
2209
2209
  __privateGet(this, _pzCache)[event.name] = event.variantIds;
2210
2210
  __privateGet(this, _mitt3).emit("personalizationResult", event);
package/dist/index.mjs CHANGED
@@ -999,8 +999,8 @@ var TransitionDataStore = class {
999
999
  }
1000
1000
  /**
1001
1001
  * Updates data in the transition storage.
1002
- * @param commands Commands to execute against existing stored value (event based stores)
1003
- * @param computedValue Pre-computed new value against existing value (object based stores)
1002
+ * @param commands - Commands to execute against existing stored value (event based stores)
1003
+ * @param computedValue - Pre-computed new value against existing value (object based stores)
1004
1004
  * @returns Resolved promise when the data has been updated
1005
1005
  */
1006
1006
  updateData(commands, computedValue) {
@@ -1540,7 +1540,7 @@ var VisitorDataStore = class {
1540
1540
  /**
1541
1541
  * Deletes visitor data (forgetting them)
1542
1542
  * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
1543
- * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
1543
+ * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
1544
1544
  */
1545
1545
  async delete(fromAllDevices) {
1546
1546
  var _a, _b, _c, _d, _e;
@@ -2063,7 +2063,7 @@ var Context = class {
2063
2063
  }
2064
2064
  /**
2065
2065
  * Forgets the visitor's data and resets the Context to its initial state.
2066
- * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
2066
+ * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
2067
2067
  */
2068
2068
  async forget(fromAllDevices) {
2069
2069
  const previousCompositionMetadata = __privateGet(this, _state).compositionMetadata;
@@ -2104,14 +2104,14 @@ var Context = class {
2104
2104
  });
2105
2105
  return transitionState;
2106
2106
  }
2107
- /** @deprecated */
2107
+ /** @deprecated Internal API for test event processing; not for public use. */
2108
2108
  internal_processTestEvent(event) {
2109
2109
  if (event.variantId) {
2110
2110
  this.setTestVariantId(event.name, event.variantId);
2111
2111
  __privateMethod(this, _Context_instances, emitTest_fn).call(this, event);
2112
2112
  }
2113
2113
  }
2114
- /** @deprecated */
2114
+ /** @deprecated Internal API for personalization event processing; not for public use. */
2115
2115
  internal_processPersonalizationEvent(event) {
2116
2116
  __privateGet(this, _pzCache)[event.name] = event.variantIds;
2117
2117
  __privateGet(this, _mitt3).emit("personalizationResult", event);
@@ -10,7 +10,7 @@ interface paths {
10
10
  cookie?: never;
11
11
  };
12
12
  /**
13
- * @description Fetches the optimization Manifest for a given project.
13
+ * Fetches the optimization Manifest for a given project.
14
14
  * If no manifest has ever been published, and an API key is used that has preview manifest permissions then the current preview manifest will be returned (in delivery format).
15
15
  */
16
16
  get: {
@@ -25,7 +25,7 @@ interface paths {
25
25
  };
26
26
  requestBody?: never;
27
27
  responses: {
28
- /** @description OK */
28
+ /** OK */
29
29
  200: {
30
30
  headers: {
31
31
  [name: string]: unknown;
@@ -37,7 +37,7 @@ interface paths {
37
37
  400: components["responses"]["BadRequestError"];
38
38
  401: components["responses"]["UnauthorizedError"];
39
39
  403: components["responses"]["ForbiddenError"];
40
- /** @description No manifest has ever been published, and the API key does not have preview permissions */
40
+ /** No manifest has ever been published, and the API key does not have preview permissions */
41
41
  404: {
42
42
  headers: {
43
43
  [name: string]: unknown;
@@ -53,7 +53,7 @@ interface paths {
53
53
  put?: never;
54
54
  post?: never;
55
55
  delete?: never;
56
- /** @description Handles preflight requests. This endpoint allows CORS. */
56
+ /** Handles preflight requests. This endpoint allows CORS. */
57
57
  options: {
58
58
  parameters: {
59
59
  query?: never;
@@ -63,7 +63,7 @@ interface paths {
63
63
  };
64
64
  requestBody?: never;
65
65
  responses: {
66
- /** @description OK */
66
+ /** OK */
67
67
  204: {
68
68
  headers: {
69
69
  [name: string]: unknown;
@@ -83,194 +83,194 @@ interface components {
83
83
  project: {
84
84
  /**
85
85
  * Format: uuid
86
- * @description is not present unless getting a preview manifest
86
+ * is not present unless getting a preview manifest
87
87
  */
88
88
  id?: string;
89
- /** @description is not present unless getting a preview manifest */
89
+ /** is not present unless getting a preview manifest */
90
90
  name?: string;
91
- /** @description is not present unless getting a preview manifest */
91
+ /** is not present unless getting a preview manifest */
92
92
  ui_version?: number;
93
93
  pz?: components["schemas"]["PersonalizationManifest"];
94
- /** @description A/B test settings */
94
+ /** A/B test settings */
95
95
  test?: {
96
96
  [key: string]: components["schemas"]["Test"];
97
97
  };
98
98
  };
99
99
  };
100
100
  PersonalizationManifest: {
101
- /** @description Map of all signals defined for personalization criteria */
101
+ /** Map of all signals defined for personalization criteria */
102
102
  sig?: {
103
103
  [key: string]: components["schemas"]["Signal"];
104
104
  };
105
- /** @description Map of all enrichment categories defined for personalization criteria */
105
+ /** Map of all enrichment categories defined for personalization criteria */
106
106
  enr?: {
107
107
  [key: string]: components["schemas"]["EnrichmentCategory"];
108
108
  };
109
- /** @description Map of all aggregate dimensions (intents or audiences) defined for personalization criteria */
109
+ /** Map of all aggregate dimensions (intents or audiences) defined for personalization criteria */
110
110
  agg?: {
111
111
  [key: string]: components["schemas"]["AggregateDimension"];
112
112
  };
113
- /** @description Percentage of visitors that will be used as a personalization control group (not shown any personalization) */
113
+ /** Percentage of visitors that will be used as a personalization control group (not shown any personalization) */
114
114
  control?: number;
115
115
  };
116
116
  SignalCriteriaGroup: {
117
117
  /**
118
- * @description Criteria type (Group of other criteria)
119
- * @enum {string}
118
+ * Criteria type (Group of other criteria)
119
+
120
120
  */
121
121
  type: "G";
122
122
  /**
123
- * @description The logical operator to apply to the criteria groups
123
+ * The logical operator to apply to the criteria groups
124
124
  * & = AND
125
125
  * | = OR
126
126
  *
127
127
  * Default is `&` if unspecified
128
- * @enum {string}
128
+
129
129
  */
130
130
  op?: "&" | "|";
131
- /** @description The criteria clauses that make up this grouping of criteria */
131
+ /** The criteria clauses that make up this grouping of criteria */
132
132
  clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
133
133
  };
134
- /** @description Describes a match expression on a string */
134
+ /** Describes a match expression on a string */
135
135
  StringMatch: {
136
- /** @description The right-hand side of the match expression */
136
+ /** The right-hand side of the match expression */
137
137
  rhs: string;
138
138
  /**
139
- * @description The match operator
139
+ * The match operator
140
140
  * '=' = exact match
141
141
  * '~' = contains match
142
142
  * '//' = regular expression match
143
143
  *
144
144
  * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
145
- * @enum {string}
145
+
146
146
  */
147
147
  op: "=" | "~" | "//" | "!=" | "!~" | "!//";
148
- /** @description The case sensitivity of the match. Defaults to false if unspecified */
148
+ /** The case sensitivity of the match. Defaults to false if unspecified */
149
149
  cs?: boolean;
150
150
  } | {
151
151
  /**
152
- * @description The type of match to perform
152
+ * The type of match to perform
153
153
  * '*' = exists with any value
154
154
  * '!*' = does not exist
155
- * @enum {string}
155
+
156
156
  */
157
157
  op: "*" | "!*";
158
158
  };
159
- /** @description Matches a web cookie value */
159
+ /** Matches a web cookie value */
160
160
  CookieCriteria: {
161
161
  /** @enum {string} */
162
162
  type: "CK";
163
- /** @description The name of the cookie to match */
163
+ /** The name of the cookie to match */
164
164
  cookieName: string;
165
- /** @description The value to match the cookie against */
165
+ /** The value to match the cookie against */
166
166
  match: components["schemas"]["StringMatch"];
167
167
  };
168
- /** @description Matches a URL query string parameter value */
168
+ /** Matches a URL query string parameter value */
169
169
  QueryStringCriteria: {
170
170
  /** @enum {string} */
171
171
  type: "QS";
172
- /** @description The name of the query string parameter to match */
172
+ /** The name of the query string parameter to match */
173
173
  queryName: string;
174
- /** @description The value to match the query string parameter against */
174
+ /** The value to match the query string parameter against */
175
175
  match: components["schemas"]["StringMatch"];
176
176
  };
177
- /** @description Matches a visitor quirk key and value */
177
+ /** Matches a visitor quirk key and value */
178
178
  QuirkCriteria: {
179
179
  /** @enum {string} */
180
180
  type: "QK";
181
- /** @description The name of the quirk key to match */
181
+ /** The name of the quirk key to match */
182
182
  key: string;
183
- /** @description The quirk value to match against */
183
+ /** The quirk value to match against */
184
184
  match: components["schemas"]["StringMatch"];
185
185
  };
186
- /** @description Matches an analytics event name being fired */
186
+ /** Matches an analytics event name being fired */
187
187
  EventCriteria: {
188
188
  /** @enum {string} */
189
189
  type: "EVT";
190
- /** @description How to match the event name */
190
+ /** How to match the event name */
191
191
  event: components["schemas"]["StringMatch"];
192
192
  };
193
193
  /**
194
- * @description Matches the current page's absolute path (i.e. /path/to/page.html)
194
+ * Matches the current page's absolute path (i.e. /path/to/page.html)
195
195
  * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
196
196
  */
197
197
  CurrentPageCriteria: {
198
198
  /** @enum {string} */
199
199
  type: "PV";
200
- /** @description The page/route path to match as a page that has been visited */
200
+ /** The page/route path to match as a page that has been visited */
201
201
  path: components["schemas"]["StringMatch"];
202
202
  };
203
- /** @description Describes a match expression on a number */
203
+ /** Describes a match expression on a number */
204
204
  NumberMatch: {
205
- /** @description The right-hand side of the match expression */
205
+ /** The right-hand side of the match expression */
206
206
  rhs: number;
207
207
  /**
208
- * @description The type of match to perform
208
+ * The type of match to perform
209
209
  * '=' = exact match
210
210
  * '!=' = not an exact match
211
211
  * '<' = less than match expression
212
212
  * '>' = greater than match expression
213
- * @enum {string}
213
+
214
214
  */
215
215
  op: "=" | "<" | ">" | "!=";
216
216
  };
217
217
  PageViewCountCriteria: {
218
218
  /** @enum {string} */
219
219
  type: "PVC";
220
- /** @description The expression to match the page view count against */
220
+ /** The expression to match the page view count against */
221
221
  match: components["schemas"]["NumberMatch"];
222
222
  };
223
223
  SignalCriteria: components["schemas"]["CookieCriteria"] | components["schemas"]["QueryStringCriteria"] | components["schemas"]["QuirkCriteria"] | components["schemas"]["EventCriteria"] | components["schemas"]["CurrentPageCriteria"] | components["schemas"]["PageViewCountCriteria"];
224
224
  RootSignalCriteriaGroup: {
225
225
  /**
226
- * @description Criteria type (Group of other criteria)
227
- * @enum {string}
226
+ * Criteria type (Group of other criteria)
227
+
228
228
  */
229
229
  type: "G";
230
230
  /**
231
- * @description The logical operator to apply to the criteria groups
231
+ * The logical operator to apply to the criteria groups
232
232
  * & = AND
233
233
  * | = OR
234
234
  *
235
235
  * Default is `&` if unspecified
236
- * @default &
237
- * @enum {string}
236
+ * @defaultValue &
237
+
238
238
  */
239
239
  op?: "&" | "|";
240
- /** @description The criteria clauses that make up this grouping of criteria */
240
+ /** The criteria clauses that make up this grouping of criteria */
241
241
  clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
242
242
  };
243
243
  Conversion: {
244
244
  /**
245
- * @description The frequency of the conversion event
246
- * @enum {string}
245
+ * The frequency of the conversion event
246
+
247
247
  */
248
248
  freq: "O";
249
249
  };
250
250
  Signal: {
251
- /** @description The signal strength per activation (each time its criteria are true, this score is added) */
251
+ /** The signal strength per activation (each time its criteria are true, this score is added) */
252
252
  str: number;
253
- /** @description The maximum visitor score allowed for this signal */
253
+ /** The maximum visitor score allowed for this signal */
254
254
  cap: number;
255
255
  /**
256
- * @description How long the signal's score should persist
256
+ * How long the signal's score should persist
257
257
  * 's' = current session (expires after a period of inactivity)
258
258
  * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
259
259
  * 't' = transient (score tracks the current state of the criteria every time scores are updated)
260
- * @enum {string}
260
+
261
261
  */
262
262
  dur: "s" | "p" | "t";
263
263
  crit: components["schemas"]["RootSignalCriteriaGroup"];
264
264
  conversion?: components["schemas"]["Conversion"] | null;
265
265
  };
266
266
  EnrichmentCategory: {
267
- /** @description The maximum visitor score allowed for enrichment keys in this category */
267
+ /** The maximum visitor score allowed for enrichment keys in this category */
268
268
  cap: number;
269
269
  };
270
- /** @description Defines an input dimension to an aggregate dimension */
270
+ /** Defines an input dimension to an aggregate dimension */
271
271
  AggregateDimensionInput: {
272
272
  /**
273
- * @description Dimension name to reference as an input.
273
+ * Dimension name to reference as an input.
274
274
  * For enrichment inputs, use CATEGORY_KEY as the dimension.
275
275
  * Enrichments, signals, and other aggregate dimensions may be referenced.
276
276
  *
@@ -280,34 +280,34 @@ interface components {
280
280
  */
281
281
  dim: string;
282
282
  /**
283
- * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
283
+ * The sign of the input dimension controls how it affects the aggregate dimension's final score.
284
284
  *
285
285
  * '+' = add to the final score
286
286
  * '-' = subtract from the final score
287
287
  * 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
288
288
  *
289
289
  * Default if unspecified: '+'
290
- * @default +
291
- * @enum {string}
290
+ * @defaultValue +
291
+
292
292
  */
293
293
  sign?: "+" | "-" | "c";
294
294
  };
295
- /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience */
295
+ /** Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience */
296
296
  AggregateDimension: {
297
- /** @description Input dimensions to the aggregate dimension */
297
+ /** Input dimensions to the aggregate dimension */
298
298
  inputs: components["schemas"]["AggregateDimensionInput"][];
299
299
  };
300
300
  Test: {
301
- /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
301
+ /** Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
302
302
  wv?: string;
303
303
  };
304
304
  Error: {
305
- /** @description Error message(s) that occurred while processing the request */
305
+ /** Error message(s) that occurred while processing the request */
306
306
  errorMessage?: string[] | string;
307
307
  };
308
308
  };
309
309
  responses: {
310
- /** @description Request input validation failed */
310
+ /** Request input validation failed */
311
311
  BadRequestError: {
312
312
  headers: {
313
313
  [name: string]: unknown;
@@ -316,7 +316,7 @@ interface components {
316
316
  "application/json": components["schemas"]["Error"];
317
317
  };
318
318
  };
319
- /** @description API key or token was not valid */
319
+ /** API key or token was not valid */
320
320
  UnauthorizedError: {
321
321
  headers: {
322
322
  [name: string]: unknown;
@@ -325,7 +325,7 @@ interface components {
325
325
  "application/json": components["schemas"]["Error"];
326
326
  };
327
327
  };
328
- /** @description Permission was denied */
328
+ /** Permission was denied */
329
329
  ForbiddenError: {
330
330
  headers: {
331
331
  [name: string]: unknown;
@@ -334,14 +334,14 @@ interface components {
334
334
  "application/json": components["schemas"]["Error"];
335
335
  };
336
336
  };
337
- /** @description Too many requests in allowed time period */
337
+ /** Too many requests in allowed time period */
338
338
  RateLimitError: {
339
339
  headers: {
340
340
  [name: string]: unknown;
341
341
  };
342
342
  content?: never;
343
343
  };
344
- /** @description Execution error occurred */
344
+ /** Execution error occurred */
345
345
  InternalServerError: {
346
346
  headers: {
347
347
  [name: string]: unknown;
@@ -585,8 +585,8 @@ declare abstract class TransitionDataStore {
585
585
  };
586
586
  /**
587
587
  * Updates data in the transition storage.
588
- * @param commands Commands to execute against existing stored value (event based stores)
589
- * @param computedValue Pre-computed new value against existing value (object based stores)
588
+ * @param commands - Commands to execute against existing stored value (event based stores)
589
+ * @param computedValue - Pre-computed new value against existing value (object based stores)
590
590
  * @returns Resolved promise when the data has been updated
591
591
  */
592
592
  updateData(commands: StorageCommands[], computedValue: VisitorData): Promise<void>;
@@ -647,7 +647,7 @@ type VisitorDataStoreOptions = {
647
647
  /**
648
648
  * Sets the default value of storage consent for new unknown visitors.
649
649
  * If storage consent is not given, only in-memory data will be stored which is lost when the browser leaves the page.
650
- * @default false - consent is not given for new visitors until they explicitly give it with an update command
650
+ * @defaultValue false - consent is not given for new visitors until they explicitly give it with an update command
651
651
  */
652
652
  defaultConsent?: boolean;
653
653
  /**
@@ -726,7 +726,7 @@ declare class VisitorDataStore {
726
726
  /**
727
727
  * Deletes visitor data (forgetting them)
728
728
  * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
729
- * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
729
+ * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
730
730
  */
731
731
  delete(fromAllDevices: boolean): Promise<void>;
732
732
  }
@@ -961,12 +961,12 @@ type DimensionMatch = {
961
961
  * -: `l` is the weakest dimension in the score vector. This does not match if the dimension has no score at all.
962
962
  *
963
963
  * Comparison operators:
964
- * >: `l` is greater than the right hand side expression
965
- * >= : `l` is greater than or equal to the right hand side expression
966
- * <: `l` is less than the right hand side expression
967
- * <= : `l` is less than or equal to the right hand side expression
968
- * =: `l` is equal to the right hand side expression
969
- * !=: `l` is not equal to the right hand side expression
964
+ * `>: l` is greater than the right hand side expression
965
+ * `>= : l` is greater than or equal to the right hand side expression
966
+ * `<: l` is less than the right hand side expression
967
+ * `<=: l` is less than or equal to the right hand side expression
968
+ * `=: l` is equal to the right hand side expression
969
+ * `!=: l` is not equal to the right hand side expression
970
970
  */
971
971
  op: '+' | '-' | '>' | '>=' | '<' | '<=' | '=' | '!=' | '^';
972
972
  /**
@@ -1236,9 +1236,9 @@ interface ContextInstance {
1236
1236
  on: Emitter<ContextEvents>['on'];
1237
1237
  off: Emitter<ContextEvents>['off'];
1238
1238
  };
1239
- /** @deprecated */
1239
+ /** @deprecated Internal API for test event processing; not for public use. */
1240
1240
  internal_processTestEvent(event: TestEvent): void;
1241
- /** @deprecated */
1241
+ /** @deprecated Internal API for personalization event processing; not for public use. */
1242
1242
  internal_processPersonalizationEvent(event: PersonalizationEvent): void;
1243
1243
  /**
1244
1244
  * Gets the current canvas data
@@ -1304,7 +1304,7 @@ declare class Context implements ContextInstance {
1304
1304
  personalize<TVariant extends PersonalizedVariant<any>>(options: PersonalizeOptions<TVariant>): PersonalizedResult<TVariant>;
1305
1305
  /**
1306
1306
  * Forgets the visitor's data and resets the Context to its initial state.
1307
- * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
1307
+ * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
1308
1308
  */
1309
1309
  forget(fromAllDevices: boolean): Promise<void>;
1310
1310
  /**
@@ -1313,9 +1313,9 @@ declare class Context implements ContextInstance {
1313
1313
  * Removes state from server-to-client if it came in initial state (cookies) to avoid double tracking on the client.
1314
1314
  */
1315
1315
  getServerToClientTransitionState(): ServerToClientTransitionState;
1316
- /** @deprecated */
1316
+ /** @deprecated Internal API for test event processing; not for public use. */
1317
1317
  internal_processTestEvent(event: TestEvent): void;
1318
- /** @deprecated */
1318
+ /** @deprecated Internal API for personalization event processing; not for public use. */
1319
1319
  internal_processPersonalizationEvent(event: PersonalizationEvent): void;
1320
1320
  /**
1321
1321
  * Gets the current canvas data