@uniformdev/context 16.2.4 → 17.1.1-alpha.151
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/api/api.d.ts +55 -9
- package/dist/api/api.js +2 -2
- package/dist/api/api.mjs +2 -2
- package/dist/cli/cli.d.ts +3 -9
- package/dist/cli/cli.js +77 -61
- package/dist/cli/cli.mjs +77 -61
- package/dist/{contextTypes-572b0d33.d.ts → contextTypes-ec62120f.d.ts} +192 -8
- package/dist/index.d.ts +3 -3
- package/dist/index.esm.js +1 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +1 -1
- package/dist/{types-682b51bf.d.ts → types-c398dba8.d.ts} +1 -1
- package/dist/{v2-manifest.swagger-ff2af13e.d.ts → v2-manifest.swagger-200ca5ee.d.ts} +39 -2
- package/package.json +9 -8
@@ -1,4 +1,4 @@
|
|
1
|
-
import { p as paths$7 } from './v2-manifest.swagger-
|
1
|
+
import { p as paths$7 } from './v2-manifest.swagger-200ca5ee.js';
|
2
2
|
|
3
3
|
/**
|
4
4
|
* This file was auto-generated by openapi-typescript.
|
@@ -68,6 +68,13 @@ interface paths$6 {
|
|
68
68
|
};
|
69
69
|
};
|
70
70
|
};
|
71
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
72
|
+
options: {
|
73
|
+
responses: {
|
74
|
+
/** OK */
|
75
|
+
204: never;
|
76
|
+
};
|
77
|
+
};
|
71
78
|
};
|
72
79
|
}
|
73
80
|
interface components$6 {
|
@@ -127,6 +134,12 @@ interface external$6 {
|
|
127
134
|
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
128
135
|
};
|
129
136
|
};
|
137
|
+
/** Resource not found */
|
138
|
+
NotFoundError: {
|
139
|
+
content: {
|
140
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
141
|
+
};
|
142
|
+
};
|
130
143
|
/** Too many requests in allowed time period */
|
131
144
|
RateLimitError: unknown;
|
132
145
|
/** Execution error occurred */
|
@@ -187,6 +200,13 @@ interface paths$5 {
|
|
187
200
|
};
|
188
201
|
};
|
189
202
|
};
|
203
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
204
|
+
options: {
|
205
|
+
responses: {
|
206
|
+
/** OK */
|
207
|
+
204: never;
|
208
|
+
};
|
209
|
+
};
|
190
210
|
};
|
191
211
|
}
|
192
212
|
interface external$5 {
|
@@ -218,6 +238,12 @@ interface external$5 {
|
|
218
238
|
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
219
239
|
};
|
220
240
|
};
|
241
|
+
/** Resource not found */
|
242
|
+
NotFoundError: {
|
243
|
+
content: {
|
244
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
245
|
+
};
|
246
|
+
};
|
221
247
|
/** Too many requests in allowed time period */
|
222
248
|
RateLimitError: unknown;
|
223
249
|
/** Execution error occurred */
|
@@ -291,6 +317,13 @@ interface external$5 {
|
|
291
317
|
};
|
292
318
|
};
|
293
319
|
};
|
320
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
321
|
+
options: {
|
322
|
+
responses: {
|
323
|
+
/** OK */
|
324
|
+
204: never;
|
325
|
+
};
|
326
|
+
};
|
294
327
|
};
|
295
328
|
};
|
296
329
|
components: {
|
@@ -382,6 +415,8 @@ interface paths$4 {
|
|
382
415
|
* @description Skips updating aggregate inputs and upserts only the aggregate definition.
|
383
416
|
* Inputs data is still required, but is ignored and not saved or validated.
|
384
417
|
* Useful when creating aggregates that reference each other: Create the definitions, then the inputs.
|
418
|
+
*
|
419
|
+
* @default false
|
385
420
|
*/
|
386
421
|
skipInputs?: boolean;
|
387
422
|
};
|
@@ -408,6 +443,13 @@ interface paths$4 {
|
|
408
443
|
};
|
409
444
|
};
|
410
445
|
};
|
446
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
447
|
+
options: {
|
448
|
+
responses: {
|
449
|
+
/** OK */
|
450
|
+
204: never;
|
451
|
+
};
|
452
|
+
};
|
411
453
|
};
|
412
454
|
}
|
413
455
|
interface components$5 {
|
@@ -420,6 +462,8 @@ interface components$5 {
|
|
420
462
|
* @description The type of aggregate
|
421
463
|
* 0: Audience
|
422
464
|
* 1: Intent
|
465
|
+
*
|
466
|
+
* @enum {number}
|
423
467
|
*/
|
424
468
|
type: 0 | 1;
|
425
469
|
inputs: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
|
@@ -455,6 +499,12 @@ interface external$4 {
|
|
455
499
|
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
456
500
|
};
|
457
501
|
};
|
502
|
+
/** Resource not found */
|
503
|
+
NotFoundError: {
|
504
|
+
content: {
|
505
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
506
|
+
};
|
507
|
+
};
|
458
508
|
/** Too many requests in allowed time period */
|
459
509
|
RateLimitError: unknown;
|
460
510
|
/** Execution error occurred */
|
@@ -487,12 +537,17 @@ interface external$4 {
|
|
487
537
|
* 's' = current session (expires after a period of inactivity)
|
488
538
|
* 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
|
489
539
|
* 't' = transient (score tracks the current state of the criteria every time scores are updated)
|
540
|
+
*
|
541
|
+
* @enum {string}
|
490
542
|
*/
|
491
543
|
dur: "s" | "p" | "t";
|
492
544
|
crit: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
|
493
545
|
};
|
494
546
|
RootSignalCriteriaGroup: {
|
495
|
-
/**
|
547
|
+
/**
|
548
|
+
* @description Criteria type (Group of other criteria)
|
549
|
+
* @enum {string}
|
550
|
+
*/
|
496
551
|
type: "G";
|
497
552
|
/**
|
498
553
|
* @description The logical operator to apply to the criteria groups
|
@@ -502,13 +557,17 @@ interface external$4 {
|
|
502
557
|
* Default is `&` if unspecified.
|
503
558
|
*
|
504
559
|
* @default &
|
560
|
+
* @enum {string}
|
505
561
|
*/
|
506
562
|
op?: "&" | "|";
|
507
563
|
/** @description The criteria clauses that make up this grouping of criteria */
|
508
564
|
clauses: (external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
|
509
565
|
};
|
510
566
|
SignalCriteriaGroup: {
|
511
|
-
/**
|
567
|
+
/**
|
568
|
+
* @description Criteria type (Group of other criteria)
|
569
|
+
* @enum {string}
|
570
|
+
*/
|
512
571
|
type: "G";
|
513
572
|
/**
|
514
573
|
* @description The logical operator to apply to the criteria groups
|
@@ -516,6 +575,8 @@ interface external$4 {
|
|
516
575
|
* | = OR
|
517
576
|
*
|
518
577
|
* Default is `&` if unspecified.
|
578
|
+
*
|
579
|
+
* @enum {string}
|
519
580
|
*/
|
520
581
|
op?: "&" | "|";
|
521
582
|
/** @description The criteria clauses that make up this grouping of criteria */
|
@@ -524,6 +585,7 @@ interface external$4 {
|
|
524
585
|
SignalCriteria: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["CookieCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["QueryStringCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["QuirkCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["EventCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["CurrentPageCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["PageViewCountCriteria"];
|
525
586
|
/** @description Matches a URL query string parameter value */
|
526
587
|
QueryStringCriteria: {
|
588
|
+
/** @enum {string} */
|
527
589
|
type: "QS";
|
528
590
|
/** @description The name of the query string parameter to match */
|
529
591
|
queryName: string;
|
@@ -532,6 +594,7 @@ interface external$4 {
|
|
532
594
|
};
|
533
595
|
/** @description Matches a web cookie value */
|
534
596
|
CookieCriteria: {
|
597
|
+
/** @enum {string} */
|
535
598
|
type: "CK";
|
536
599
|
/** @description The name of the cookie to match */
|
537
600
|
cookieName: string;
|
@@ -540,6 +603,7 @@ interface external$4 {
|
|
540
603
|
};
|
541
604
|
/** @description Matches a visitor quirk key and value */
|
542
605
|
QuirkCriteria: {
|
606
|
+
/** @enum {string} */
|
543
607
|
type: "QK";
|
544
608
|
/** @description The name of the quirk key to match */
|
545
609
|
key: string;
|
@@ -548,6 +612,7 @@ interface external$4 {
|
|
548
612
|
};
|
549
613
|
/** @description Matches an analytics event name being fired */
|
550
614
|
EventCriteria: {
|
615
|
+
/** @enum {string} */
|
551
616
|
type: "EVT";
|
552
617
|
/** @description How to match the event name */
|
553
618
|
event: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
|
@@ -557,11 +622,13 @@ interface external$4 {
|
|
557
622
|
* Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
|
558
623
|
*/
|
559
624
|
CurrentPageCriteria: {
|
625
|
+
/** @enum {string} */
|
560
626
|
type: "PV";
|
561
627
|
/** @description The page/route path to match as a page that has been visited */
|
562
628
|
path: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
|
563
629
|
};
|
564
630
|
PageViewCountCriteria: {
|
631
|
+
/** @enum {string} */
|
565
632
|
type: "PVC";
|
566
633
|
/** @description The expression to match the page view count against */
|
567
634
|
match: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
|
@@ -577,6 +644,8 @@ interface external$4 {
|
|
577
644
|
* '//' = regular expression match
|
578
645
|
*
|
579
646
|
* Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
|
647
|
+
*
|
648
|
+
* @enum {string}
|
580
649
|
*/
|
581
650
|
op: "=" | "~" | "//" | "!=" | "!~" | "!//";
|
582
651
|
/** @description The case sensitivity of the match. Defaults to false if unspecified. */
|
@@ -586,6 +655,8 @@ interface external$4 {
|
|
586
655
|
* @description The type of match to perform
|
587
656
|
* '*' = exists with any value
|
588
657
|
* '!*' = does not exist
|
658
|
+
*
|
659
|
+
* @enum {string}
|
589
660
|
*/
|
590
661
|
op: "*" | "!*";
|
591
662
|
};
|
@@ -599,6 +670,8 @@ interface external$4 {
|
|
599
670
|
* '!=' = not an exact match
|
600
671
|
* '<' = less than match expression
|
601
672
|
* '>' = greater than match expression
|
673
|
+
*
|
674
|
+
* @enum {string}
|
602
675
|
*/
|
603
676
|
op: "=" | "<" | ">" | "!=";
|
604
677
|
};
|
@@ -629,6 +702,7 @@ interface external$4 {
|
|
629
702
|
* Default if unspecified: '+'
|
630
703
|
*
|
631
704
|
* @default +
|
705
|
+
* @enum {string}
|
632
706
|
*/
|
633
707
|
sign?: "+" | "-" | "c";
|
634
708
|
};
|
@@ -671,6 +745,13 @@ interface paths$3 {
|
|
671
745
|
500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
672
746
|
};
|
673
747
|
};
|
748
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
749
|
+
options: {
|
750
|
+
responses: {
|
751
|
+
/** OK */
|
752
|
+
204: never;
|
753
|
+
};
|
754
|
+
};
|
674
755
|
};
|
675
756
|
}
|
676
757
|
interface components$4 {
|
@@ -683,6 +764,8 @@ interface components$4 {
|
|
683
764
|
* AGG: Aggregation (intent or audience)
|
684
765
|
* ENR: Enrichment
|
685
766
|
* SIG: Signal
|
767
|
+
*
|
768
|
+
* @enum {string}
|
686
769
|
*/
|
687
770
|
category: "AGG" | "ENR" | "SIG";
|
688
771
|
/**
|
@@ -731,6 +814,12 @@ interface external$3 {
|
|
731
814
|
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
732
815
|
};
|
733
816
|
};
|
817
|
+
/** Resource not found */
|
818
|
+
NotFoundError: {
|
819
|
+
content: {
|
820
|
+
"application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
|
821
|
+
};
|
822
|
+
};
|
734
823
|
/** Too many requests in allowed time period */
|
735
824
|
RateLimitError: unknown;
|
736
825
|
/** Execution error occurred */
|
@@ -815,6 +904,13 @@ interface paths$2 {
|
|
815
904
|
};
|
816
905
|
};
|
817
906
|
};
|
907
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
908
|
+
options: {
|
909
|
+
responses: {
|
910
|
+
/** OK */
|
911
|
+
204: never;
|
912
|
+
};
|
913
|
+
};
|
818
914
|
};
|
819
915
|
}
|
820
916
|
interface components$3 {
|
@@ -866,6 +962,12 @@ interface external$2 {
|
|
866
962
|
"application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
|
867
963
|
};
|
868
964
|
};
|
965
|
+
/** Resource not found */
|
966
|
+
NotFoundError: {
|
967
|
+
content: {
|
968
|
+
"application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
|
969
|
+
};
|
970
|
+
};
|
869
971
|
/** Too many requests in allowed time period */
|
870
972
|
RateLimitError: unknown;
|
871
973
|
/** Execution error occurred */
|
@@ -948,6 +1050,13 @@ interface paths$1 {
|
|
948
1050
|
};
|
949
1051
|
};
|
950
1052
|
};
|
1053
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
1054
|
+
options: {
|
1055
|
+
responses: {
|
1056
|
+
/** OK */
|
1057
|
+
204: never;
|
1058
|
+
};
|
1059
|
+
};
|
951
1060
|
};
|
952
1061
|
}
|
953
1062
|
interface components$2 {
|
@@ -957,6 +1066,7 @@ interface components$2 {
|
|
957
1066
|
name: string;
|
958
1067
|
winning_variant_id?: string;
|
959
1068
|
default_variant_id?: string;
|
1069
|
+
/** @default false */
|
960
1070
|
closed?: boolean;
|
961
1071
|
};
|
962
1072
|
};
|
@@ -990,6 +1100,12 @@ interface external$1 {
|
|
990
1100
|
"application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
|
991
1101
|
};
|
992
1102
|
};
|
1103
|
+
/** Resource not found */
|
1104
|
+
NotFoundError: {
|
1105
|
+
content: {
|
1106
|
+
"application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
|
1107
|
+
};
|
1108
|
+
};
|
993
1109
|
/** Too many requests in allowed time period */
|
994
1110
|
RateLimitError: unknown;
|
995
1111
|
/** Execution error occurred */
|
@@ -1071,6 +1187,13 @@ interface paths {
|
|
1071
1187
|
};
|
1072
1188
|
};
|
1073
1189
|
};
|
1190
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
1191
|
+
options: {
|
1192
|
+
responses: {
|
1193
|
+
/** OK */
|
1194
|
+
204: never;
|
1195
|
+
};
|
1196
|
+
};
|
1074
1197
|
};
|
1075
1198
|
}
|
1076
1199
|
interface components$1 {
|
@@ -1109,6 +1232,12 @@ interface external {
|
|
1109
1232
|
"application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
|
1110
1233
|
};
|
1111
1234
|
};
|
1235
|
+
/** Resource not found */
|
1236
|
+
NotFoundError: {
|
1237
|
+
content: {
|
1238
|
+
"application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
|
1239
|
+
};
|
1240
|
+
};
|
1112
1241
|
/** Too many requests in allowed time period */
|
1113
1242
|
RateLimitError: unknown;
|
1114
1243
|
/** Execution error occurred */
|
@@ -1141,12 +1270,17 @@ interface external {
|
|
1141
1270
|
* 's' = current session (expires after a period of inactivity)
|
1142
1271
|
* 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
|
1143
1272
|
* 't' = transient (score tracks the current state of the criteria every time scores are updated)
|
1273
|
+
*
|
1274
|
+
* @enum {string}
|
1144
1275
|
*/
|
1145
1276
|
dur: "s" | "p" | "t";
|
1146
1277
|
crit: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
|
1147
1278
|
};
|
1148
1279
|
RootSignalCriteriaGroup: {
|
1149
|
-
/**
|
1280
|
+
/**
|
1281
|
+
* @description Criteria type (Group of other criteria)
|
1282
|
+
* @enum {string}
|
1283
|
+
*/
|
1150
1284
|
type: "G";
|
1151
1285
|
/**
|
1152
1286
|
* @description The logical operator to apply to the criteria groups
|
@@ -1156,13 +1290,17 @@ interface external {
|
|
1156
1290
|
* Default is `&` if unspecified.
|
1157
1291
|
*
|
1158
1292
|
* @default &
|
1293
|
+
* @enum {string}
|
1159
1294
|
*/
|
1160
1295
|
op?: "&" | "|";
|
1161
1296
|
/** @description The criteria clauses that make up this grouping of criteria */
|
1162
1297
|
clauses: (external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
|
1163
1298
|
};
|
1164
1299
|
SignalCriteriaGroup: {
|
1165
|
-
/**
|
1300
|
+
/**
|
1301
|
+
* @description Criteria type (Group of other criteria)
|
1302
|
+
* @enum {string}
|
1303
|
+
*/
|
1166
1304
|
type: "G";
|
1167
1305
|
/**
|
1168
1306
|
* @description The logical operator to apply to the criteria groups
|
@@ -1170,6 +1308,8 @@ interface external {
|
|
1170
1308
|
* | = OR
|
1171
1309
|
*
|
1172
1310
|
* Default is `&` if unspecified.
|
1311
|
+
*
|
1312
|
+
* @enum {string}
|
1173
1313
|
*/
|
1174
1314
|
op?: "&" | "|";
|
1175
1315
|
/** @description The criteria clauses that make up this grouping of criteria */
|
@@ -1178,6 +1318,7 @@ interface external {
|
|
1178
1318
|
SignalCriteria: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["CookieCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["QueryStringCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["QuirkCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["EventCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["CurrentPageCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["PageViewCountCriteria"];
|
1179
1319
|
/** @description Matches a URL query string parameter value */
|
1180
1320
|
QueryStringCriteria: {
|
1321
|
+
/** @enum {string} */
|
1181
1322
|
type: "QS";
|
1182
1323
|
/** @description The name of the query string parameter to match */
|
1183
1324
|
queryName: string;
|
@@ -1186,6 +1327,7 @@ interface external {
|
|
1186
1327
|
};
|
1187
1328
|
/** @description Matches a web cookie value */
|
1188
1329
|
CookieCriteria: {
|
1330
|
+
/** @enum {string} */
|
1189
1331
|
type: "CK";
|
1190
1332
|
/** @description The name of the cookie to match */
|
1191
1333
|
cookieName: string;
|
@@ -1194,6 +1336,7 @@ interface external {
|
|
1194
1336
|
};
|
1195
1337
|
/** @description Matches a visitor quirk key and value */
|
1196
1338
|
QuirkCriteria: {
|
1339
|
+
/** @enum {string} */
|
1197
1340
|
type: "QK";
|
1198
1341
|
/** @description The name of the quirk key to match */
|
1199
1342
|
key: string;
|
@@ -1202,6 +1345,7 @@ interface external {
|
|
1202
1345
|
};
|
1203
1346
|
/** @description Matches an analytics event name being fired */
|
1204
1347
|
EventCriteria: {
|
1348
|
+
/** @enum {string} */
|
1205
1349
|
type: "EVT";
|
1206
1350
|
/** @description How to match the event name */
|
1207
1351
|
event: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
|
@@ -1211,11 +1355,13 @@ interface external {
|
|
1211
1355
|
* Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
|
1212
1356
|
*/
|
1213
1357
|
CurrentPageCriteria: {
|
1358
|
+
/** @enum {string} */
|
1214
1359
|
type: "PV";
|
1215
1360
|
/** @description The page/route path to match as a page that has been visited */
|
1216
1361
|
path: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
|
1217
1362
|
};
|
1218
1363
|
PageViewCountCriteria: {
|
1364
|
+
/** @enum {string} */
|
1219
1365
|
type: "PVC";
|
1220
1366
|
/** @description The expression to match the page view count against */
|
1221
1367
|
match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
|
@@ -1231,6 +1377,8 @@ interface external {
|
|
1231
1377
|
* '//' = regular expression match
|
1232
1378
|
*
|
1233
1379
|
* Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
|
1380
|
+
*
|
1381
|
+
* @enum {string}
|
1234
1382
|
*/
|
1235
1383
|
op: "=" | "~" | "//" | "!=" | "!~" | "!//";
|
1236
1384
|
/** @description The case sensitivity of the match. Defaults to false if unspecified. */
|
@@ -1240,6 +1388,8 @@ interface external {
|
|
1240
1388
|
* @description The type of match to perform
|
1241
1389
|
* '*' = exists with any value
|
1242
1390
|
* '!*' = does not exist
|
1391
|
+
*
|
1392
|
+
* @enum {string}
|
1243
1393
|
*/
|
1244
1394
|
op: "*" | "!*";
|
1245
1395
|
};
|
@@ -1253,6 +1403,8 @@ interface external {
|
|
1253
1403
|
* '!=' = not an exact match
|
1254
1404
|
* '<' = less than match expression
|
1255
1405
|
* '>' = greater than match expression
|
1406
|
+
*
|
1407
|
+
* @enum {string}
|
1256
1408
|
*/
|
1257
1409
|
op: "=" | "<" | ">" | "!=";
|
1258
1410
|
};
|
@@ -1283,6 +1435,7 @@ interface external {
|
|
1283
1435
|
* Default if unspecified: '+'
|
1284
1436
|
*
|
1285
1437
|
* @default +
|
1438
|
+
* @enum {string}
|
1286
1439
|
*/
|
1287
1440
|
sign?: "+" | "-" | "c";
|
1288
1441
|
};
|
@@ -1318,12 +1471,17 @@ interface components {
|
|
1318
1471
|
* 's' = current session (expires after a period of inactivity)
|
1319
1472
|
* 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
|
1320
1473
|
* 't' = transient (score tracks the current state of the criteria every time scores are updated)
|
1474
|
+
*
|
1475
|
+
* @enum {string}
|
1321
1476
|
*/
|
1322
1477
|
dur: "s" | "p" | "t";
|
1323
1478
|
crit: components["schemas"]["RootSignalCriteriaGroup"];
|
1324
1479
|
};
|
1325
1480
|
RootSignalCriteriaGroup: {
|
1326
|
-
/**
|
1481
|
+
/**
|
1482
|
+
* @description Criteria type (Group of other criteria)
|
1483
|
+
* @enum {string}
|
1484
|
+
*/
|
1327
1485
|
type: "G";
|
1328
1486
|
/**
|
1329
1487
|
* @description The logical operator to apply to the criteria groups
|
@@ -1333,13 +1491,17 @@ interface components {
|
|
1333
1491
|
* Default is `&` if unspecified.
|
1334
1492
|
*
|
1335
1493
|
* @default &
|
1494
|
+
* @enum {string}
|
1336
1495
|
*/
|
1337
1496
|
op?: "&" | "|";
|
1338
1497
|
/** @description The criteria clauses that make up this grouping of criteria */
|
1339
1498
|
clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
|
1340
1499
|
};
|
1341
1500
|
SignalCriteriaGroup: {
|
1342
|
-
/**
|
1501
|
+
/**
|
1502
|
+
* @description Criteria type (Group of other criteria)
|
1503
|
+
* @enum {string}
|
1504
|
+
*/
|
1343
1505
|
type: "G";
|
1344
1506
|
/**
|
1345
1507
|
* @description The logical operator to apply to the criteria groups
|
@@ -1347,6 +1509,8 @@ interface components {
|
|
1347
1509
|
* | = OR
|
1348
1510
|
*
|
1349
1511
|
* Default is `&` if unspecified.
|
1512
|
+
*
|
1513
|
+
* @enum {string}
|
1350
1514
|
*/
|
1351
1515
|
op?: "&" | "|";
|
1352
1516
|
/** @description The criteria clauses that make up this grouping of criteria */
|
@@ -1355,6 +1519,7 @@ interface components {
|
|
1355
1519
|
SignalCriteria: components["schemas"]["CookieCriteria"] | components["schemas"]["QueryStringCriteria"] | components["schemas"]["QuirkCriteria"] | components["schemas"]["EventCriteria"] | components["schemas"]["CurrentPageCriteria"] | components["schemas"]["PageViewCountCriteria"];
|
1356
1520
|
/** @description Matches a URL query string parameter value */
|
1357
1521
|
QueryStringCriteria: {
|
1522
|
+
/** @enum {string} */
|
1358
1523
|
type: "QS";
|
1359
1524
|
/** @description The name of the query string parameter to match */
|
1360
1525
|
queryName: string;
|
@@ -1363,6 +1528,7 @@ interface components {
|
|
1363
1528
|
};
|
1364
1529
|
/** @description Matches a web cookie value */
|
1365
1530
|
CookieCriteria: {
|
1531
|
+
/** @enum {string} */
|
1366
1532
|
type: "CK";
|
1367
1533
|
/** @description The name of the cookie to match */
|
1368
1534
|
cookieName: string;
|
@@ -1371,6 +1537,7 @@ interface components {
|
|
1371
1537
|
};
|
1372
1538
|
/** @description Matches a visitor quirk key and value */
|
1373
1539
|
QuirkCriteria: {
|
1540
|
+
/** @enum {string} */
|
1374
1541
|
type: "QK";
|
1375
1542
|
/** @description The name of the quirk key to match */
|
1376
1543
|
key: string;
|
@@ -1379,6 +1546,7 @@ interface components {
|
|
1379
1546
|
};
|
1380
1547
|
/** @description Matches an analytics event name being fired */
|
1381
1548
|
EventCriteria: {
|
1549
|
+
/** @enum {string} */
|
1382
1550
|
type: "EVT";
|
1383
1551
|
/** @description How to match the event name */
|
1384
1552
|
event: components["schemas"]["StringMatch"];
|
@@ -1388,11 +1556,13 @@ interface components {
|
|
1388
1556
|
* Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
|
1389
1557
|
*/
|
1390
1558
|
CurrentPageCriteria: {
|
1559
|
+
/** @enum {string} */
|
1391
1560
|
type: "PV";
|
1392
1561
|
/** @description The page/route path to match as a page that has been visited */
|
1393
1562
|
path: components["schemas"]["StringMatch"];
|
1394
1563
|
};
|
1395
1564
|
PageViewCountCriteria: {
|
1565
|
+
/** @enum {string} */
|
1396
1566
|
type: "PVC";
|
1397
1567
|
/** @description The expression to match the page view count against */
|
1398
1568
|
match: components["schemas"]["NumberMatch"];
|
@@ -1408,6 +1578,8 @@ interface components {
|
|
1408
1578
|
* '//' = regular expression match
|
1409
1579
|
*
|
1410
1580
|
* Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
|
1581
|
+
*
|
1582
|
+
* @enum {string}
|
1411
1583
|
*/
|
1412
1584
|
op: "=" | "~" | "//" | "!=" | "!~" | "!//";
|
1413
1585
|
/** @description The case sensitivity of the match. Defaults to false if unspecified. */
|
@@ -1417,6 +1589,8 @@ interface components {
|
|
1417
1589
|
* @description The type of match to perform
|
1418
1590
|
* '*' = exists with any value
|
1419
1591
|
* '!*' = does not exist
|
1592
|
+
*
|
1593
|
+
* @enum {string}
|
1420
1594
|
*/
|
1421
1595
|
op: "*" | "!*";
|
1422
1596
|
};
|
@@ -1430,6 +1604,8 @@ interface components {
|
|
1430
1604
|
* '!=' = not an exact match
|
1431
1605
|
* '<' = less than match expression
|
1432
1606
|
* '>' = greater than match expression
|
1607
|
+
*
|
1608
|
+
* @enum {string}
|
1433
1609
|
*/
|
1434
1610
|
op: "=" | "<" | ">" | "!=";
|
1435
1611
|
};
|
@@ -1460,6 +1636,7 @@ interface components {
|
|
1460
1636
|
* Default if unspecified: '+'
|
1461
1637
|
*
|
1462
1638
|
* @default +
|
1639
|
+
* @enum {string}
|
1463
1640
|
*/
|
1464
1641
|
sign?: "+" | "-" | "c";
|
1465
1642
|
};
|
@@ -1530,5 +1707,12 @@ declare type SignalPut = paths['/api/v2/signal']['put'];
|
|
1530
1707
|
declare type SignalPutParameters = SignalPut['requestBody']['content']['application/json'];
|
1531
1708
|
declare type SignalDelete = paths['/api/v2/signal']['delete'];
|
1532
1709
|
declare type SignalDeleteParameters = SignalDelete['requestBody']['content']['application/json'];
|
1710
|
+
declare type ContextDefinitions = {
|
1711
|
+
aggregates?: Array<Aggregate>;
|
1712
|
+
quirks?: Array<Quirk>;
|
1713
|
+
signals?: Array<SignalWithId>;
|
1714
|
+
enrichments?: Array<EnrichmentCategoryWithValues>;
|
1715
|
+
tests?: Array<Test>;
|
1716
|
+
};
|
1533
1717
|
|
1534
|
-
export {
|
1718
|
+
export { AggregateGetParameters as A, SignalWithId as B, ContextDefinitions as C, DimensionGetParameters as D, EnrichmentGetParameters as E, CookieCriteria as F, QueryStringCriteria as G, QuirkCriteria as H, EventCriteria as I, CurrentPageCriteria as J, ManifestGetParameters as M, PageViewCountCriteria as P, QuirkGetParameters as Q, RootSignalCriteriaGroup as R, SignalGetParameters as S, TestGetParameters as T, AggregateGetResponse as a, AggregatePutParameters as b, AggregateDeleteParameters as c, DimensionGetResponse as d, EnrichmentGetResponse as e, EnrichmentPutParameters as f, EnrichmentDeleteParameters as g, EnrichmentValuePutParameters as h, EnrichmentValueDeleteParameters as i, ManifestGetResponse as j, QuirkGetResponse as k, QuirkPutParameters as l, QuirkDeleteParameters as m, SignalGetResponse as n, SignalPutParameters as o, SignalDeleteParameters as p, TestGetResponse as q, TestPutParameters as r, TestDeleteParameters as s, DimensionDefinition as t, EnrichmentCategory as u, EnrichmentCategoryWithValues as v, EnrichmentValue as w, Aggregate as x, Quirk as y, Test as z };
|
package/dist/index.d.ts
CHANGED
@@ -1,8 +1,8 @@
|
|
1
|
-
import { T as TransitionDataStore, S as StorageCommands, V as VisitorData, a as TransitionDataStoreOptions, D as DecayFunction, O as OutputSeverity, L as LogDrain, C as ContextPlugin, b as CriteriaEvaluator, c as StringMatch, d as ScoreVector, A as AggregateDimension, e as VariantMatchCriteria, f as LogMessage } from './types-
|
2
|
-
export { A as AggregateDimension, l as AggregateDimensionInput, ac as BehaviorTag, a0 as Context, $ as ContextEvents, Y as ContextOptions, C as ContextPlugin, t as ContextState, u as ContextStateUpdate, b as CriteriaEvaluator, n as CriteriaEvaluatorParameters, m as CriteriaEvaluatorResult, D as DecayFunction, H as DecayOptions, aj as DevToolsActions, an as DevToolsDataEvent, ak as DevToolsEvent, al as DevToolsEvents, ar as DevToolsForgetEvent, ao as DevToolsHelloEvent, am as DevToolsLogEvent, aq as DevToolsRawCommandsEvent, ai as DevToolsState, ah as DevToolsUiVersion, ap as DevToolsUpdateEvent, ab as DimensionMatch, E as EnrichmentCategory, q as EnrichmentData, r as EventData, G as GroupCriteriaEvaluator, I as IdentifyCommand, L as LogDrain, f as LogMessage, a6 as LogMessageGroup, a5 as LogMessageSingle, a1 as LogMessages, M as ManifestInstance, g as ManifestV2, a3 as MessageCategory, a4 as MessageFunc, w as ModifyScoreCommand, x as ModifySessionScoreCommand, N as NumberMatch, O as OutputSeverity, Z as PersonalizationEvent, P as PersonalizationManifest, a9 as PersonalizeOptions, ae as PersonalizedResult, ad as PersonalizedVariant, Q as Quirks, W as SERVER_STATE_ID, d as ScoreVector, U as ServerToClientTransitionState, y as SetConsentCommand, F as SetControlGroupCommand, z as SetQuirkCommand, B as SetTestCommand, a2 as Severity, h as Signal, j as SignalCriteria, i as SignalCriteriaGroup, o as SignalData, v as StorageCommand, S as StorageCommands, c as StringMatch, k as TestDefinition, _ as TestEvent, a8 as TestOptions, ag as TestResult, af as TestVariant, p as Tests, T as TransitionDataStore, X as TransitionDataStoreEvents, a as TransitionDataStoreOptions, e as VariantMatchCriteria, V as VisitorData, R as VisitorDataStore, K as VisitorDataStoreEvents, J as VisitorDataStoreOptions, s as emptyVisitorData, aa as personalizeVariations, a7 as testVariations } from './types-
|
1
|
+
import { T as TransitionDataStore, S as StorageCommands, V as VisitorData, a as TransitionDataStoreOptions, D as DecayFunction, O as OutputSeverity, L as LogDrain, C as ContextPlugin, b as CriteriaEvaluator, c as StringMatch, d as ScoreVector, A as AggregateDimension, e as VariantMatchCriteria, f as LogMessage } from './types-c398dba8.js';
|
2
|
+
export { A as AggregateDimension, l as AggregateDimensionInput, ac as BehaviorTag, a0 as Context, $ as ContextEvents, Y as ContextOptions, C as ContextPlugin, t as ContextState, u as ContextStateUpdate, b as CriteriaEvaluator, n as CriteriaEvaluatorParameters, m as CriteriaEvaluatorResult, D as DecayFunction, H as DecayOptions, aj as DevToolsActions, an as DevToolsDataEvent, ak as DevToolsEvent, al as DevToolsEvents, ar as DevToolsForgetEvent, ao as DevToolsHelloEvent, am as DevToolsLogEvent, aq as DevToolsRawCommandsEvent, ai as DevToolsState, ah as DevToolsUiVersion, ap as DevToolsUpdateEvent, ab as DimensionMatch, E as EnrichmentCategory, q as EnrichmentData, r as EventData, G as GroupCriteriaEvaluator, I as IdentifyCommand, L as LogDrain, f as LogMessage, a6 as LogMessageGroup, a5 as LogMessageSingle, a1 as LogMessages, M as ManifestInstance, g as ManifestV2, a3 as MessageCategory, a4 as MessageFunc, w as ModifyScoreCommand, x as ModifySessionScoreCommand, N as NumberMatch, O as OutputSeverity, Z as PersonalizationEvent, P as PersonalizationManifest, a9 as PersonalizeOptions, ae as PersonalizedResult, ad as PersonalizedVariant, Q as Quirks, W as SERVER_STATE_ID, d as ScoreVector, U as ServerToClientTransitionState, y as SetConsentCommand, F as SetControlGroupCommand, z as SetQuirkCommand, B as SetTestCommand, a2 as Severity, h as Signal, j as SignalCriteria, i as SignalCriteriaGroup, o as SignalData, v as StorageCommand, S as StorageCommands, c as StringMatch, k as TestDefinition, _ as TestEvent, a8 as TestOptions, ag as TestResult, af as TestVariant, p as Tests, T as TransitionDataStore, X as TransitionDataStoreEvents, a as TransitionDataStoreOptions, e as VariantMatchCriteria, V as VisitorData, R as VisitorDataStore, K as VisitorDataStoreEvents, J as VisitorDataStoreOptions, s as emptyVisitorData, aa as personalizeVariations, a7 as testVariations } from './types-c398dba8.js';
|
3
3
|
import Cookies from 'js-cookie';
|
4
4
|
import 'mitt';
|
5
|
-
import './v2-manifest.swagger-
|
5
|
+
import './v2-manifest.swagger-200ca5ee.js';
|
6
6
|
|
7
7
|
declare type CookieTransitionDataStoreOptions = {
|
8
8
|
/**
|