@uniformdev/context 20.50.2-alpha.149 → 20.50.2-alpha.167
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.mts +35 -30
- package/dist/api/api.d.ts +35 -30
- package/dist/api/api.js +6 -6
- package/dist/api/api.mjs +6 -6
- package/dist/index.d.mts +2 -3
- package/dist/index.d.ts +2 -3
- package/dist/index.esm.js +1 -1
- package/dist/index.js +4 -4
- package/dist/index.mjs +1 -1
- package/dist/{types-BAWsX0zQ.d.mts → types-C0Mthca3.d.mts} +453 -457
- package/dist/{types-BAWsX0zQ.d.ts → types-C0Mthca3.d.ts} +453 -457
- package/package.json +6 -7
package/dist/api/api.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { p as paths$7, M as ManifestV2 } from '../types-C0Mthca3.mjs';
|
|
2
2
|
import 'mitt';
|
|
3
3
|
|
|
4
4
|
type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;
|
|
@@ -79,7 +79,6 @@ interface components$7 {
|
|
|
79
79
|
* 's' = current session (expires after a period of inactivity)
|
|
80
80
|
* 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
|
|
81
81
|
* 't' = transient (score tracks the current state of the criteria every time scores are updated)
|
|
82
|
-
*
|
|
83
82
|
* @enum {string}
|
|
84
83
|
*/
|
|
85
84
|
dur: "s" | "p" | "t";
|
|
@@ -98,7 +97,6 @@ interface components$7 {
|
|
|
98
97
|
* | = OR
|
|
99
98
|
*
|
|
100
99
|
* Default is `&` if unspecified
|
|
101
|
-
*
|
|
102
100
|
* @default &
|
|
103
101
|
* @enum {string}
|
|
104
102
|
*/
|
|
@@ -125,7 +123,6 @@ interface components$7 {
|
|
|
125
123
|
* | = OR
|
|
126
124
|
*
|
|
127
125
|
* Default is `&` if unspecified
|
|
128
|
-
*
|
|
129
126
|
* @enum {string}
|
|
130
127
|
*/
|
|
131
128
|
op?: "&" | "|";
|
|
@@ -167,9 +164,10 @@ interface components$7 {
|
|
|
167
164
|
/** @description How to match the event name */
|
|
168
165
|
event: components$7["schemas"]["StringMatch"];
|
|
169
166
|
};
|
|
170
|
-
/**
|
|
167
|
+
/**
|
|
168
|
+
* @description Matches the current page's absolute path (i.e. /path/to/page.html)
|
|
171
169
|
* Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
|
|
172
|
-
|
|
170
|
+
*/
|
|
173
171
|
CurrentPageCriteria: {
|
|
174
172
|
/** @enum {string} */
|
|
175
173
|
type: "PV";
|
|
@@ -193,7 +191,6 @@ interface components$7 {
|
|
|
193
191
|
* '//' = regular expression match
|
|
194
192
|
*
|
|
195
193
|
* Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
|
|
196
|
-
*
|
|
197
194
|
* @enum {string}
|
|
198
195
|
*/
|
|
199
196
|
op: "=" | "~" | "//" | "!=" | "!~" | "!//";
|
|
@@ -204,7 +201,6 @@ interface components$7 {
|
|
|
204
201
|
* @description The type of match to perform
|
|
205
202
|
* '*' = exists with any value
|
|
206
203
|
* '!*' = does not exist
|
|
207
|
-
*
|
|
208
204
|
* @enum {string}
|
|
209
205
|
*/
|
|
210
206
|
op: "*" | "!*";
|
|
@@ -219,7 +215,6 @@ interface components$7 {
|
|
|
219
215
|
* '!=' = not an exact match
|
|
220
216
|
* '<' = less than match expression
|
|
221
217
|
* '>' = greater than match expression
|
|
222
|
-
*
|
|
223
218
|
* @enum {string}
|
|
224
219
|
*/
|
|
225
220
|
op: "=" | "<" | ">" | "!=";
|
|
@@ -231,14 +226,15 @@ interface components$7 {
|
|
|
231
226
|
};
|
|
232
227
|
/** @description Defines an input dimension to an aggregate dimension */
|
|
233
228
|
AggregateDimensionInput: {
|
|
234
|
-
/**
|
|
229
|
+
/**
|
|
230
|
+
* @description Dimension name to reference as an input.
|
|
235
231
|
* For enrichment inputs, use CATEGORY_KEY as the dimension.
|
|
236
232
|
* Enrichments, signals, and other aggregate dimensions may be referenced.
|
|
237
233
|
*
|
|
238
234
|
* Note that creating a cycle of aggregate dimensions is allowed, however
|
|
239
235
|
* the final score will _ignore_ the cycled aggregate dimension in the result.
|
|
240
236
|
* This can be used to create mutually exclusive aggregates
|
|
241
|
-
|
|
237
|
+
*/
|
|
242
238
|
dim: string;
|
|
243
239
|
/**
|
|
244
240
|
* @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
|
|
@@ -248,7 +244,6 @@ interface components$7 {
|
|
|
248
244
|
* 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
|
|
249
245
|
*
|
|
250
246
|
* Default if unspecified: '+'
|
|
251
|
-
*
|
|
252
247
|
* @default +
|
|
253
248
|
* @enum {string}
|
|
254
249
|
*/
|
|
@@ -654,10 +649,11 @@ interface paths$4 {
|
|
|
654
649
|
projectId: string;
|
|
655
650
|
/** @description Limit the results to a specific aggregate ID */
|
|
656
651
|
aggregateId?: string;
|
|
657
|
-
/**
|
|
652
|
+
/**
|
|
653
|
+
* @description Limit the results to a specific aggregate type
|
|
658
654
|
* 0: Audience
|
|
659
655
|
* 1: Intent
|
|
660
|
-
|
|
656
|
+
*/
|
|
661
657
|
type?: 0 | 1;
|
|
662
658
|
};
|
|
663
659
|
header?: never;
|
|
@@ -701,7 +697,6 @@ interface paths$4 {
|
|
|
701
697
|
* @description Skips updating aggregate inputs and upserts only the aggregate definition.
|
|
702
698
|
* Inputs data is still required, but is ignored and not saved or validated.
|
|
703
699
|
* Useful when creating aggregates that reference each other: Create the definitions, then the inputs.
|
|
704
|
-
*
|
|
705
700
|
* @default false
|
|
706
701
|
*/
|
|
707
702
|
skipInputs?: boolean;
|
|
@@ -789,7 +784,6 @@ interface components$4 {
|
|
|
789
784
|
* @description The type of aggregate
|
|
790
785
|
* 0: Audience
|
|
791
786
|
* 1: Intent
|
|
792
|
-
*
|
|
793
787
|
* @enum {number}
|
|
794
788
|
*/
|
|
795
789
|
type: 0 | 1;
|
|
@@ -797,14 +791,15 @@ interface components$4 {
|
|
|
797
791
|
};
|
|
798
792
|
/** @description Defines an input dimension to an aggregate dimension */
|
|
799
793
|
AggregateDimensionInput: {
|
|
800
|
-
/**
|
|
794
|
+
/**
|
|
795
|
+
* @description Dimension name to reference as an input.
|
|
801
796
|
* For enrichment inputs, use CATEGORY_KEY as the dimension.
|
|
802
797
|
* Enrichments, signals, and other aggregate dimensions may be referenced.
|
|
803
798
|
*
|
|
804
799
|
* Note that creating a cycle of aggregate dimensions is allowed, however
|
|
805
800
|
* the final score will _ignore_ the cycled aggregate dimension in the result.
|
|
806
801
|
* This can be used to create mutually exclusive aggregates
|
|
807
|
-
|
|
802
|
+
*/
|
|
808
803
|
dim: string;
|
|
809
804
|
/**
|
|
810
805
|
* @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
|
|
@@ -814,7 +809,6 @@ interface components$4 {
|
|
|
814
809
|
* 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
|
|
815
810
|
*
|
|
816
811
|
* Default if unspecified: '+'
|
|
817
|
-
*
|
|
818
812
|
* @default +
|
|
819
813
|
* @enum {string}
|
|
820
814
|
*/
|
|
@@ -949,16 +943,16 @@ interface components$3 {
|
|
|
949
943
|
* AGG: Aggregation (intent or audience)
|
|
950
944
|
* ENR: Enrichment
|
|
951
945
|
* SIG: Signal
|
|
952
|
-
*
|
|
953
946
|
* @enum {string}
|
|
954
947
|
*/
|
|
955
948
|
category: "AGG" | "ENR" | "SIG";
|
|
956
|
-
/**
|
|
949
|
+
/**
|
|
950
|
+
* @description Subtype of the dimension
|
|
957
951
|
* AGG:0: Audience
|
|
958
952
|
* AGG:1: Intent
|
|
959
953
|
* ENR: Enrichment Category name
|
|
960
954
|
* SIG: null
|
|
961
|
-
|
|
955
|
+
*/
|
|
962
956
|
subcategory?: string;
|
|
963
957
|
/** @description The dimension's name (without category) */
|
|
964
958
|
name: string;
|
|
@@ -1369,7 +1363,6 @@ interface components$1 {
|
|
|
1369
1363
|
* | = OR
|
|
1370
1364
|
*
|
|
1371
1365
|
* Default is `&` if unspecified
|
|
1372
|
-
*
|
|
1373
1366
|
* @enum {string}
|
|
1374
1367
|
*/
|
|
1375
1368
|
op?: "&" | "|";
|
|
@@ -1387,7 +1380,6 @@ interface components$1 {
|
|
|
1387
1380
|
* '//' = regular expression match
|
|
1388
1381
|
*
|
|
1389
1382
|
* Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
|
|
1390
|
-
*
|
|
1391
1383
|
* @enum {string}
|
|
1392
1384
|
*/
|
|
1393
1385
|
op: "=" | "~" | "//" | "!=" | "!~" | "!//";
|
|
@@ -1398,7 +1390,6 @@ interface components$1 {
|
|
|
1398
1390
|
* @description The type of match to perform
|
|
1399
1391
|
* '*' = exists with any value
|
|
1400
1392
|
* '!*' = does not exist
|
|
1401
|
-
*
|
|
1402
1393
|
* @enum {string}
|
|
1403
1394
|
*/
|
|
1404
1395
|
op: "*" | "!*";
|
|
@@ -1437,9 +1428,10 @@ interface components$1 {
|
|
|
1437
1428
|
/** @description How to match the event name */
|
|
1438
1429
|
event: components$1["schemas"]["StringMatch"];
|
|
1439
1430
|
};
|
|
1440
|
-
/**
|
|
1431
|
+
/**
|
|
1432
|
+
* @description Matches the current page's absolute path (i.e. /path/to/page.html)
|
|
1441
1433
|
* Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
|
|
1442
|
-
|
|
1434
|
+
*/
|
|
1443
1435
|
CurrentPageCriteria: {
|
|
1444
1436
|
/** @enum {string} */
|
|
1445
1437
|
type: "PV";
|
|
@@ -1456,7 +1448,6 @@ interface components$1 {
|
|
|
1456
1448
|
* '!=' = not an exact match
|
|
1457
1449
|
* '<' = less than match expression
|
|
1458
1450
|
* '>' = greater than match expression
|
|
1459
|
-
*
|
|
1460
1451
|
* @enum {string}
|
|
1461
1452
|
*/
|
|
1462
1453
|
op: "=" | "<" | ">" | "!=";
|
|
@@ -1480,7 +1471,6 @@ interface components$1 {
|
|
|
1480
1471
|
* | = OR
|
|
1481
1472
|
*
|
|
1482
1473
|
* Default is `&` if unspecified
|
|
1483
|
-
*
|
|
1484
1474
|
* @default &
|
|
1485
1475
|
* @enum {string}
|
|
1486
1476
|
*/
|
|
@@ -1505,7 +1495,6 @@ interface components$1 {
|
|
|
1505
1495
|
* 's' = current session (expires after a period of inactivity)
|
|
1506
1496
|
* 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
|
|
1507
1497
|
* 't' = transient (score tracks the current state of the criteria every time scores are updated)
|
|
1508
|
-
*
|
|
1509
1498
|
* @enum {string}
|
|
1510
1499
|
*/
|
|
1511
1500
|
dur: "s" | "p" | "t";
|
|
@@ -1842,9 +1831,11 @@ declare class AggregateClient extends ApiClient {
|
|
|
1842
1831
|
/** Deletes an Aggregate */
|
|
1843
1832
|
remove(body: ExceptProject<AggregateDeleteParameters>): Promise<void>;
|
|
1844
1833
|
}
|
|
1834
|
+
/** @deprecated Pass `bypassCache: true` to {@link AggregateClient} instead. */
|
|
1845
1835
|
declare class UncachedAggregateClient extends AggregateClient {
|
|
1846
1836
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1847
1837
|
}
|
|
1838
|
+
/** @deprecated Pass `bypassCache: false` to {@link AggregateClient} instead. */
|
|
1848
1839
|
declare class CachedAggregateClient extends AggregateClient {
|
|
1849
1840
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1850
1841
|
}
|
|
@@ -1866,9 +1857,11 @@ declare class DimensionClient extends ApiClient {
|
|
|
1866
1857
|
/** Fetches the known score dimensions for a project */
|
|
1867
1858
|
get(options?: ExceptProject<DimensionGetParameters>): Promise<DimensionGetResponse>;
|
|
1868
1859
|
}
|
|
1860
|
+
/** @deprecated Pass `bypassCache: true` to {@link DimensionClient} instead. */
|
|
1869
1861
|
declare class UncachedDimensionClient extends DimensionClient {
|
|
1870
1862
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1871
1863
|
}
|
|
1864
|
+
/** @deprecated Pass `bypassCache: false` to {@link DimensionClient} instead. */
|
|
1872
1865
|
declare class CachedDimensionClient extends DimensionClient {
|
|
1873
1866
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1874
1867
|
}
|
|
@@ -1887,9 +1880,11 @@ declare class EnrichmentClient extends ApiClient {
|
|
|
1887
1880
|
/** Deletes an enrichment value within an enrichment category. The category is left alone. */
|
|
1888
1881
|
removeValue(body: ExceptProject<EnrichmentValueDeleteParameters>): Promise<void>;
|
|
1889
1882
|
}
|
|
1883
|
+
/** @deprecated Pass `bypassCache: true` to {@link EnrichmentClient} instead. */
|
|
1890
1884
|
declare class UncachedEnrichmentClient extends EnrichmentClient {
|
|
1891
1885
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1892
1886
|
}
|
|
1887
|
+
/** @deprecated Pass `bypassCache: false` to {@link EnrichmentClient} instead. */
|
|
1893
1888
|
declare class CachedEnrichmentClient extends EnrichmentClient {
|
|
1894
1889
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1895
1890
|
}
|
|
@@ -1902,9 +1897,11 @@ declare class ManifestClient extends ApiClient {
|
|
|
1902
1897
|
/** Publishes the Context manifest for a project */
|
|
1903
1898
|
publish(): Promise<void>;
|
|
1904
1899
|
}
|
|
1900
|
+
/** @deprecated Pass `bypassCache: true` to {@link ManifestClient} instead. */
|
|
1905
1901
|
declare class UncachedManifestClient extends ManifestClient {
|
|
1906
1902
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1907
1903
|
}
|
|
1904
|
+
/** @deprecated Pass `bypassCache: false` to {@link ManifestClient} instead. */
|
|
1908
1905
|
declare class CachedManifestClient extends ManifestClient {
|
|
1909
1906
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1910
1907
|
}
|
|
@@ -1919,9 +1916,11 @@ declare class QuirkClient extends ApiClient {
|
|
|
1919
1916
|
/** Deletes a Quirk */
|
|
1920
1917
|
remove(body: ExceptProject<QuirkDeleteParameters>): Promise<void>;
|
|
1921
1918
|
}
|
|
1919
|
+
/** @deprecated Pass `bypassCache: true` to {@link QuirkClient} instead. */
|
|
1922
1920
|
declare class UncachedQuirkClient extends QuirkClient {
|
|
1923
1921
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1924
1922
|
}
|
|
1923
|
+
/** @deprecated Pass `bypassCache: false` to {@link QuirkClient} instead. */
|
|
1925
1924
|
declare class CachedQuirkClient extends QuirkClient {
|
|
1926
1925
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1927
1926
|
}
|
|
@@ -1936,9 +1935,11 @@ declare class SignalClient extends ApiClient {
|
|
|
1936
1935
|
/** Deletes a Signal */
|
|
1937
1936
|
remove(body: ExceptProject<SignalDeleteParameters>): Promise<void>;
|
|
1938
1937
|
}
|
|
1938
|
+
/** @deprecated Pass `bypassCache: true` to {@link SignalClient} instead. */
|
|
1939
1939
|
declare class UncachedSignalClient extends SignalClient {
|
|
1940
1940
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1941
1941
|
}
|
|
1942
|
+
/** @deprecated Pass `bypassCache: false` to {@link SignalClient} instead. */
|
|
1942
1943
|
declare class CachedSignalClient extends SignalClient {
|
|
1943
1944
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1944
1945
|
}
|
|
@@ -1953,9 +1954,11 @@ declare class TestClient extends ApiClient {
|
|
|
1953
1954
|
/** Deletes a Test */
|
|
1954
1955
|
remove(body: ExceptProject<TestDeleteParameters>): Promise<void>;
|
|
1955
1956
|
}
|
|
1957
|
+
/** @deprecated Pass `bypassCache: true` to {@link TestClient} instead. */
|
|
1956
1958
|
declare class UncachedTestClient extends TestClient {
|
|
1957
1959
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1958
1960
|
}
|
|
1961
|
+
/** @deprecated Pass `bypassCache: false` to {@link TestClient} instead. */
|
|
1959
1962
|
declare class CachedTestClient extends TestClient {
|
|
1960
1963
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1961
1964
|
}
|
|
@@ -1970,9 +1973,11 @@ declare class ContextClient {
|
|
|
1970
1973
|
readonly signals: SignalClient;
|
|
1971
1974
|
readonly tests: TestClient;
|
|
1972
1975
|
}
|
|
1976
|
+
/** @deprecated Pass `bypassCache: true` to {@link ContextClient} instead. */
|
|
1973
1977
|
declare class UncachedContextClient extends ContextClient {
|
|
1974
1978
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1975
1979
|
}
|
|
1980
|
+
/** @deprecated Pass `bypassCache: false` to {@link ContextClient} instead. */
|
|
1976
1981
|
declare class CachedContextClient extends ContextClient {
|
|
1977
1982
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1978
1983
|
}
|
package/dist/api/api.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { p as paths$7, M as ManifestV2 } from '../types-C0Mthca3.js';
|
|
2
2
|
import 'mitt';
|
|
3
3
|
|
|
4
4
|
type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;
|
|
@@ -79,7 +79,6 @@ interface components$7 {
|
|
|
79
79
|
* 's' = current session (expires after a period of inactivity)
|
|
80
80
|
* 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
|
|
81
81
|
* 't' = transient (score tracks the current state of the criteria every time scores are updated)
|
|
82
|
-
*
|
|
83
82
|
* @enum {string}
|
|
84
83
|
*/
|
|
85
84
|
dur: "s" | "p" | "t";
|
|
@@ -98,7 +97,6 @@ interface components$7 {
|
|
|
98
97
|
* | = OR
|
|
99
98
|
*
|
|
100
99
|
* Default is `&` if unspecified
|
|
101
|
-
*
|
|
102
100
|
* @default &
|
|
103
101
|
* @enum {string}
|
|
104
102
|
*/
|
|
@@ -125,7 +123,6 @@ interface components$7 {
|
|
|
125
123
|
* | = OR
|
|
126
124
|
*
|
|
127
125
|
* Default is `&` if unspecified
|
|
128
|
-
*
|
|
129
126
|
* @enum {string}
|
|
130
127
|
*/
|
|
131
128
|
op?: "&" | "|";
|
|
@@ -167,9 +164,10 @@ interface components$7 {
|
|
|
167
164
|
/** @description How to match the event name */
|
|
168
165
|
event: components$7["schemas"]["StringMatch"];
|
|
169
166
|
};
|
|
170
|
-
/**
|
|
167
|
+
/**
|
|
168
|
+
* @description Matches the current page's absolute path (i.e. /path/to/page.html)
|
|
171
169
|
* Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
|
|
172
|
-
|
|
170
|
+
*/
|
|
173
171
|
CurrentPageCriteria: {
|
|
174
172
|
/** @enum {string} */
|
|
175
173
|
type: "PV";
|
|
@@ -193,7 +191,6 @@ interface components$7 {
|
|
|
193
191
|
* '//' = regular expression match
|
|
194
192
|
*
|
|
195
193
|
* Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
|
|
196
|
-
*
|
|
197
194
|
* @enum {string}
|
|
198
195
|
*/
|
|
199
196
|
op: "=" | "~" | "//" | "!=" | "!~" | "!//";
|
|
@@ -204,7 +201,6 @@ interface components$7 {
|
|
|
204
201
|
* @description The type of match to perform
|
|
205
202
|
* '*' = exists with any value
|
|
206
203
|
* '!*' = does not exist
|
|
207
|
-
*
|
|
208
204
|
* @enum {string}
|
|
209
205
|
*/
|
|
210
206
|
op: "*" | "!*";
|
|
@@ -219,7 +215,6 @@ interface components$7 {
|
|
|
219
215
|
* '!=' = not an exact match
|
|
220
216
|
* '<' = less than match expression
|
|
221
217
|
* '>' = greater than match expression
|
|
222
|
-
*
|
|
223
218
|
* @enum {string}
|
|
224
219
|
*/
|
|
225
220
|
op: "=" | "<" | ">" | "!=";
|
|
@@ -231,14 +226,15 @@ interface components$7 {
|
|
|
231
226
|
};
|
|
232
227
|
/** @description Defines an input dimension to an aggregate dimension */
|
|
233
228
|
AggregateDimensionInput: {
|
|
234
|
-
/**
|
|
229
|
+
/**
|
|
230
|
+
* @description Dimension name to reference as an input.
|
|
235
231
|
* For enrichment inputs, use CATEGORY_KEY as the dimension.
|
|
236
232
|
* Enrichments, signals, and other aggregate dimensions may be referenced.
|
|
237
233
|
*
|
|
238
234
|
* Note that creating a cycle of aggregate dimensions is allowed, however
|
|
239
235
|
* the final score will _ignore_ the cycled aggregate dimension in the result.
|
|
240
236
|
* This can be used to create mutually exclusive aggregates
|
|
241
|
-
|
|
237
|
+
*/
|
|
242
238
|
dim: string;
|
|
243
239
|
/**
|
|
244
240
|
* @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
|
|
@@ -248,7 +244,6 @@ interface components$7 {
|
|
|
248
244
|
* 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
|
|
249
245
|
*
|
|
250
246
|
* Default if unspecified: '+'
|
|
251
|
-
*
|
|
252
247
|
* @default +
|
|
253
248
|
* @enum {string}
|
|
254
249
|
*/
|
|
@@ -654,10 +649,11 @@ interface paths$4 {
|
|
|
654
649
|
projectId: string;
|
|
655
650
|
/** @description Limit the results to a specific aggregate ID */
|
|
656
651
|
aggregateId?: string;
|
|
657
|
-
/**
|
|
652
|
+
/**
|
|
653
|
+
* @description Limit the results to a specific aggregate type
|
|
658
654
|
* 0: Audience
|
|
659
655
|
* 1: Intent
|
|
660
|
-
|
|
656
|
+
*/
|
|
661
657
|
type?: 0 | 1;
|
|
662
658
|
};
|
|
663
659
|
header?: never;
|
|
@@ -701,7 +697,6 @@ interface paths$4 {
|
|
|
701
697
|
* @description Skips updating aggregate inputs and upserts only the aggregate definition.
|
|
702
698
|
* Inputs data is still required, but is ignored and not saved or validated.
|
|
703
699
|
* Useful when creating aggregates that reference each other: Create the definitions, then the inputs.
|
|
704
|
-
*
|
|
705
700
|
* @default false
|
|
706
701
|
*/
|
|
707
702
|
skipInputs?: boolean;
|
|
@@ -789,7 +784,6 @@ interface components$4 {
|
|
|
789
784
|
* @description The type of aggregate
|
|
790
785
|
* 0: Audience
|
|
791
786
|
* 1: Intent
|
|
792
|
-
*
|
|
793
787
|
* @enum {number}
|
|
794
788
|
*/
|
|
795
789
|
type: 0 | 1;
|
|
@@ -797,14 +791,15 @@ interface components$4 {
|
|
|
797
791
|
};
|
|
798
792
|
/** @description Defines an input dimension to an aggregate dimension */
|
|
799
793
|
AggregateDimensionInput: {
|
|
800
|
-
/**
|
|
794
|
+
/**
|
|
795
|
+
* @description Dimension name to reference as an input.
|
|
801
796
|
* For enrichment inputs, use CATEGORY_KEY as the dimension.
|
|
802
797
|
* Enrichments, signals, and other aggregate dimensions may be referenced.
|
|
803
798
|
*
|
|
804
799
|
* Note that creating a cycle of aggregate dimensions is allowed, however
|
|
805
800
|
* the final score will _ignore_ the cycled aggregate dimension in the result.
|
|
806
801
|
* This can be used to create mutually exclusive aggregates
|
|
807
|
-
|
|
802
|
+
*/
|
|
808
803
|
dim: string;
|
|
809
804
|
/**
|
|
810
805
|
* @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
|
|
@@ -814,7 +809,6 @@ interface components$4 {
|
|
|
814
809
|
* 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
|
|
815
810
|
*
|
|
816
811
|
* Default if unspecified: '+'
|
|
817
|
-
*
|
|
818
812
|
* @default +
|
|
819
813
|
* @enum {string}
|
|
820
814
|
*/
|
|
@@ -949,16 +943,16 @@ interface components$3 {
|
|
|
949
943
|
* AGG: Aggregation (intent or audience)
|
|
950
944
|
* ENR: Enrichment
|
|
951
945
|
* SIG: Signal
|
|
952
|
-
*
|
|
953
946
|
* @enum {string}
|
|
954
947
|
*/
|
|
955
948
|
category: "AGG" | "ENR" | "SIG";
|
|
956
|
-
/**
|
|
949
|
+
/**
|
|
950
|
+
* @description Subtype of the dimension
|
|
957
951
|
* AGG:0: Audience
|
|
958
952
|
* AGG:1: Intent
|
|
959
953
|
* ENR: Enrichment Category name
|
|
960
954
|
* SIG: null
|
|
961
|
-
|
|
955
|
+
*/
|
|
962
956
|
subcategory?: string;
|
|
963
957
|
/** @description The dimension's name (without category) */
|
|
964
958
|
name: string;
|
|
@@ -1369,7 +1363,6 @@ interface components$1 {
|
|
|
1369
1363
|
* | = OR
|
|
1370
1364
|
*
|
|
1371
1365
|
* Default is `&` if unspecified
|
|
1372
|
-
*
|
|
1373
1366
|
* @enum {string}
|
|
1374
1367
|
*/
|
|
1375
1368
|
op?: "&" | "|";
|
|
@@ -1387,7 +1380,6 @@ interface components$1 {
|
|
|
1387
1380
|
* '//' = regular expression match
|
|
1388
1381
|
*
|
|
1389
1382
|
* Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
|
|
1390
|
-
*
|
|
1391
1383
|
* @enum {string}
|
|
1392
1384
|
*/
|
|
1393
1385
|
op: "=" | "~" | "//" | "!=" | "!~" | "!//";
|
|
@@ -1398,7 +1390,6 @@ interface components$1 {
|
|
|
1398
1390
|
* @description The type of match to perform
|
|
1399
1391
|
* '*' = exists with any value
|
|
1400
1392
|
* '!*' = does not exist
|
|
1401
|
-
*
|
|
1402
1393
|
* @enum {string}
|
|
1403
1394
|
*/
|
|
1404
1395
|
op: "*" | "!*";
|
|
@@ -1437,9 +1428,10 @@ interface components$1 {
|
|
|
1437
1428
|
/** @description How to match the event name */
|
|
1438
1429
|
event: components$1["schemas"]["StringMatch"];
|
|
1439
1430
|
};
|
|
1440
|
-
/**
|
|
1431
|
+
/**
|
|
1432
|
+
* @description Matches the current page's absolute path (i.e. /path/to/page.html)
|
|
1441
1433
|
* Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
|
|
1442
|
-
|
|
1434
|
+
*/
|
|
1443
1435
|
CurrentPageCriteria: {
|
|
1444
1436
|
/** @enum {string} */
|
|
1445
1437
|
type: "PV";
|
|
@@ -1456,7 +1448,6 @@ interface components$1 {
|
|
|
1456
1448
|
* '!=' = not an exact match
|
|
1457
1449
|
* '<' = less than match expression
|
|
1458
1450
|
* '>' = greater than match expression
|
|
1459
|
-
*
|
|
1460
1451
|
* @enum {string}
|
|
1461
1452
|
*/
|
|
1462
1453
|
op: "=" | "<" | ">" | "!=";
|
|
@@ -1480,7 +1471,6 @@ interface components$1 {
|
|
|
1480
1471
|
* | = OR
|
|
1481
1472
|
*
|
|
1482
1473
|
* Default is `&` if unspecified
|
|
1483
|
-
*
|
|
1484
1474
|
* @default &
|
|
1485
1475
|
* @enum {string}
|
|
1486
1476
|
*/
|
|
@@ -1505,7 +1495,6 @@ interface components$1 {
|
|
|
1505
1495
|
* 's' = current session (expires after a period of inactivity)
|
|
1506
1496
|
* 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
|
|
1507
1497
|
* 't' = transient (score tracks the current state of the criteria every time scores are updated)
|
|
1508
|
-
*
|
|
1509
1498
|
* @enum {string}
|
|
1510
1499
|
*/
|
|
1511
1500
|
dur: "s" | "p" | "t";
|
|
@@ -1842,9 +1831,11 @@ declare class AggregateClient extends ApiClient {
|
|
|
1842
1831
|
/** Deletes an Aggregate */
|
|
1843
1832
|
remove(body: ExceptProject<AggregateDeleteParameters>): Promise<void>;
|
|
1844
1833
|
}
|
|
1834
|
+
/** @deprecated Pass `bypassCache: true` to {@link AggregateClient} instead. */
|
|
1845
1835
|
declare class UncachedAggregateClient extends AggregateClient {
|
|
1846
1836
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1847
1837
|
}
|
|
1838
|
+
/** @deprecated Pass `bypassCache: false` to {@link AggregateClient} instead. */
|
|
1848
1839
|
declare class CachedAggregateClient extends AggregateClient {
|
|
1849
1840
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1850
1841
|
}
|
|
@@ -1866,9 +1857,11 @@ declare class DimensionClient extends ApiClient {
|
|
|
1866
1857
|
/** Fetches the known score dimensions for a project */
|
|
1867
1858
|
get(options?: ExceptProject<DimensionGetParameters>): Promise<DimensionGetResponse>;
|
|
1868
1859
|
}
|
|
1860
|
+
/** @deprecated Pass `bypassCache: true` to {@link DimensionClient} instead. */
|
|
1869
1861
|
declare class UncachedDimensionClient extends DimensionClient {
|
|
1870
1862
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1871
1863
|
}
|
|
1864
|
+
/** @deprecated Pass `bypassCache: false` to {@link DimensionClient} instead. */
|
|
1872
1865
|
declare class CachedDimensionClient extends DimensionClient {
|
|
1873
1866
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1874
1867
|
}
|
|
@@ -1887,9 +1880,11 @@ declare class EnrichmentClient extends ApiClient {
|
|
|
1887
1880
|
/** Deletes an enrichment value within an enrichment category. The category is left alone. */
|
|
1888
1881
|
removeValue(body: ExceptProject<EnrichmentValueDeleteParameters>): Promise<void>;
|
|
1889
1882
|
}
|
|
1883
|
+
/** @deprecated Pass `bypassCache: true` to {@link EnrichmentClient} instead. */
|
|
1890
1884
|
declare class UncachedEnrichmentClient extends EnrichmentClient {
|
|
1891
1885
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1892
1886
|
}
|
|
1887
|
+
/** @deprecated Pass `bypassCache: false` to {@link EnrichmentClient} instead. */
|
|
1893
1888
|
declare class CachedEnrichmentClient extends EnrichmentClient {
|
|
1894
1889
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1895
1890
|
}
|
|
@@ -1902,9 +1897,11 @@ declare class ManifestClient extends ApiClient {
|
|
|
1902
1897
|
/** Publishes the Context manifest for a project */
|
|
1903
1898
|
publish(): Promise<void>;
|
|
1904
1899
|
}
|
|
1900
|
+
/** @deprecated Pass `bypassCache: true` to {@link ManifestClient} instead. */
|
|
1905
1901
|
declare class UncachedManifestClient extends ManifestClient {
|
|
1906
1902
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1907
1903
|
}
|
|
1904
|
+
/** @deprecated Pass `bypassCache: false` to {@link ManifestClient} instead. */
|
|
1908
1905
|
declare class CachedManifestClient extends ManifestClient {
|
|
1909
1906
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1910
1907
|
}
|
|
@@ -1919,9 +1916,11 @@ declare class QuirkClient extends ApiClient {
|
|
|
1919
1916
|
/** Deletes a Quirk */
|
|
1920
1917
|
remove(body: ExceptProject<QuirkDeleteParameters>): Promise<void>;
|
|
1921
1918
|
}
|
|
1919
|
+
/** @deprecated Pass `bypassCache: true` to {@link QuirkClient} instead. */
|
|
1922
1920
|
declare class UncachedQuirkClient extends QuirkClient {
|
|
1923
1921
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1924
1922
|
}
|
|
1923
|
+
/** @deprecated Pass `bypassCache: false` to {@link QuirkClient} instead. */
|
|
1925
1924
|
declare class CachedQuirkClient extends QuirkClient {
|
|
1926
1925
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1927
1926
|
}
|
|
@@ -1936,9 +1935,11 @@ declare class SignalClient extends ApiClient {
|
|
|
1936
1935
|
/** Deletes a Signal */
|
|
1937
1936
|
remove(body: ExceptProject<SignalDeleteParameters>): Promise<void>;
|
|
1938
1937
|
}
|
|
1938
|
+
/** @deprecated Pass `bypassCache: true` to {@link SignalClient} instead. */
|
|
1939
1939
|
declare class UncachedSignalClient extends SignalClient {
|
|
1940
1940
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1941
1941
|
}
|
|
1942
|
+
/** @deprecated Pass `bypassCache: false` to {@link SignalClient} instead. */
|
|
1942
1943
|
declare class CachedSignalClient extends SignalClient {
|
|
1943
1944
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1944
1945
|
}
|
|
@@ -1953,9 +1954,11 @@ declare class TestClient extends ApiClient {
|
|
|
1953
1954
|
/** Deletes a Test */
|
|
1954
1955
|
remove(body: ExceptProject<TestDeleteParameters>): Promise<void>;
|
|
1955
1956
|
}
|
|
1957
|
+
/** @deprecated Pass `bypassCache: true` to {@link TestClient} instead. */
|
|
1956
1958
|
declare class UncachedTestClient extends TestClient {
|
|
1957
1959
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1958
1960
|
}
|
|
1961
|
+
/** @deprecated Pass `bypassCache: false` to {@link TestClient} instead. */
|
|
1959
1962
|
declare class CachedTestClient extends TestClient {
|
|
1960
1963
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1961
1964
|
}
|
|
@@ -1970,9 +1973,11 @@ declare class ContextClient {
|
|
|
1970
1973
|
readonly signals: SignalClient;
|
|
1971
1974
|
readonly tests: TestClient;
|
|
1972
1975
|
}
|
|
1976
|
+
/** @deprecated Pass `bypassCache: true` to {@link ContextClient} instead. */
|
|
1973
1977
|
declare class UncachedContextClient extends ContextClient {
|
|
1974
1978
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1975
1979
|
}
|
|
1980
|
+
/** @deprecated Pass `bypassCache: false` to {@link ContextClient} instead. */
|
|
1976
1981
|
declare class CachedContextClient extends ContextClient {
|
|
1977
1982
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1978
1983
|
}
|
package/dist/api/api.js
CHANGED
|
@@ -84,12 +84,12 @@ var ApiClientError = class _ApiClientError extends Error {
|
|
|
84
84
|
`${errorMessage}
|
|
85
85
|
${statusCode}${statusText ? " " + statusText : ""} (${fetchMethod} ${fetchUri}${requestId ? ` Request ID: ${requestId}` : ""})`
|
|
86
86
|
);
|
|
87
|
-
this
|
|
88
|
-
this
|
|
89
|
-
this
|
|
90
|
-
this
|
|
91
|
-
this
|
|
92
|
-
this
|
|
87
|
+
__publicField(this, "errorMessage", errorMessage);
|
|
88
|
+
__publicField(this, "fetchMethod", fetchMethod);
|
|
89
|
+
__publicField(this, "fetchUri", fetchUri);
|
|
90
|
+
__publicField(this, "statusCode", statusCode);
|
|
91
|
+
__publicField(this, "statusText", statusText);
|
|
92
|
+
__publicField(this, "requestId", requestId);
|
|
93
93
|
Object.setPrototypeOf(this, _ApiClientError.prototype);
|
|
94
94
|
}
|
|
95
95
|
};
|
package/dist/api/api.mjs
CHANGED
|
@@ -18,12 +18,12 @@ var ApiClientError = class _ApiClientError extends Error {
|
|
|
18
18
|
`${errorMessage}
|
|
19
19
|
${statusCode}${statusText ? " " + statusText : ""} (${fetchMethod} ${fetchUri}${requestId ? ` Request ID: ${requestId}` : ""})`
|
|
20
20
|
);
|
|
21
|
-
this
|
|
22
|
-
this
|
|
23
|
-
this
|
|
24
|
-
this
|
|
25
|
-
this
|
|
26
|
-
this
|
|
21
|
+
__publicField(this, "errorMessage", errorMessage);
|
|
22
|
+
__publicField(this, "fetchMethod", fetchMethod);
|
|
23
|
+
__publicField(this, "fetchUri", fetchUri);
|
|
24
|
+
__publicField(this, "statusCode", statusCode);
|
|
25
|
+
__publicField(this, "statusText", statusText);
|
|
26
|
+
__publicField(this, "requestId", requestId);
|
|
27
27
|
Object.setPrototypeOf(this, _ApiClientError.prototype);
|
|
28
28
|
}
|
|
29
29
|
};
|