@transcend-io/airgap.js-types 13.0.0 → 14.0.0

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.
Files changed (123) hide show
  1. package/LICENSE +201 -21
  2. package/dist/index.d.mts +2510 -0
  3. package/dist/index.d.mts.map +1 -0
  4. package/dist/index.mjs +1018 -0
  5. package/dist/index.mjs.map +1 -0
  6. package/package.json +41 -41
  7. package/.yarn/sdks/eslint/package.json +0 -14
  8. package/.yarn/sdks/prettier/package.json +0 -7
  9. package/.yarn/sdks/typescript/package.json +0 -10
  10. package/README.md +0 -12
  11. package/build/constants.d.ts +0 -16
  12. package/build/constants.d.ts.map +0 -1
  13. package/build/constants.js +0 -46
  14. package/build/constants.js.map +0 -1
  15. package/build/core.d.ts +0 -1083
  16. package/build/core.d.ts.map +0 -1
  17. package/build/core.js +0 -226
  18. package/build/core.js.map +0 -1
  19. package/build/enums/browserLanguage.d.ts +0 -311
  20. package/build/enums/browserLanguage.d.ts.map +0 -1
  21. package/build/enums/browserLanguage.js +0 -314
  22. package/build/enums/browserLanguage.js.map +0 -1
  23. package/build/enums/consentExpiry.d.ts +0 -14
  24. package/build/enums/consentExpiry.d.ts.map +0 -1
  25. package/build/enums/consentExpiry.js +0 -16
  26. package/build/enums/consentExpiry.js.map +0 -1
  27. package/build/enums/experience.d.ts +0 -12
  28. package/build/enums/experience.d.ts.map +0 -1
  29. package/build/enums/experience.js +0 -15
  30. package/build/enums/experience.js.map +0 -1
  31. package/build/enums/index.d.ts +0 -7
  32. package/build/enums/index.d.ts.map +0 -1
  33. package/build/enums/index.js +0 -23
  34. package/build/enums/index.js.map +0 -1
  35. package/build/enums/privacyRegime.d.ts +0 -25
  36. package/build/enums/privacyRegime.d.ts.map +0 -1
  37. package/build/enums/privacyRegime.js +0 -29
  38. package/build/enums/privacyRegime.js.map +0 -1
  39. package/build/enums/purpose.d.ts +0 -88
  40. package/build/enums/purpose.d.ts.map +0 -1
  41. package/build/enums/purpose.js +0 -62
  42. package/build/enums/purpose.js.map +0 -1
  43. package/build/enums/viewState.d.ts +0 -197
  44. package/build/enums/viewState.d.ts.map +0 -1
  45. package/build/enums/viewState.js +0 -98
  46. package/build/enums/viewState.js.map +0 -1
  47. package/build/experience.d.ts +0 -63
  48. package/build/experience.d.ts.map +0 -1
  49. package/build/experience.js +0 -136
  50. package/build/experience.js.map +0 -1
  51. package/build/iab.d.ts +0 -320
  52. package/build/iab.d.ts.map +0 -1
  53. package/build/iab.js +0 -188
  54. package/build/iab.js.map +0 -1
  55. package/build/index.d.ts +0 -8
  56. package/build/index.d.ts.map +0 -1
  57. package/build/index.js +0 -24
  58. package/build/index.js.map +0 -1
  59. package/build/mobile.d.ts +0 -44
  60. package/build/mobile.d.ts.map +0 -1
  61. package/build/mobile.js +0 -46
  62. package/build/mobile.js.map +0 -1
  63. package/build/tsbuildinfo +0 -1
  64. package/build/ui.d.ts +0 -645
  65. package/build/ui.d.ts.map +0 -1
  66. package/build/ui.js +0 -159
  67. package/build/ui.js.map +0 -1
  68. package/build-esm/constants.d.ts +0 -16
  69. package/build-esm/constants.d.ts.map +0 -1
  70. package/build-esm/constants.js +0 -43
  71. package/build-esm/constants.js.map +0 -1
  72. package/build-esm/core.d.ts +0 -1083
  73. package/build-esm/core.d.ts.map +0 -1
  74. package/build-esm/core.js +0 -200
  75. package/build-esm/core.js.map +0 -1
  76. package/build-esm/enums/browserLanguage.d.ts +0 -311
  77. package/build-esm/enums/browserLanguage.d.ts.map +0 -1
  78. package/build-esm/enums/browserLanguage.js +0 -311
  79. package/build-esm/enums/browserLanguage.js.map +0 -1
  80. package/build-esm/enums/consentExpiry.d.ts +0 -14
  81. package/build-esm/enums/consentExpiry.d.ts.map +0 -1
  82. package/build-esm/enums/consentExpiry.js +0 -13
  83. package/build-esm/enums/consentExpiry.js.map +0 -1
  84. package/build-esm/enums/experience.d.ts +0 -12
  85. package/build-esm/enums/experience.d.ts.map +0 -1
  86. package/build-esm/enums/experience.js +0 -12
  87. package/build-esm/enums/experience.js.map +0 -1
  88. package/build-esm/enums/index.d.ts +0 -7
  89. package/build-esm/enums/index.d.ts.map +0 -1
  90. package/build-esm/enums/index.js +0 -7
  91. package/build-esm/enums/index.js.map +0 -1
  92. package/build-esm/enums/privacyRegime.d.ts +0 -25
  93. package/build-esm/enums/privacyRegime.d.ts.map +0 -1
  94. package/build-esm/enums/privacyRegime.js +0 -26
  95. package/build-esm/enums/privacyRegime.js.map +0 -1
  96. package/build-esm/enums/purpose.d.ts +0 -88
  97. package/build-esm/enums/purpose.d.ts.map +0 -1
  98. package/build-esm/enums/purpose.js +0 -59
  99. package/build-esm/enums/purpose.js.map +0 -1
  100. package/build-esm/enums/viewState.d.ts +0 -197
  101. package/build-esm/enums/viewState.d.ts.map +0 -1
  102. package/build-esm/enums/viewState.js +0 -95
  103. package/build-esm/enums/viewState.js.map +0 -1
  104. package/build-esm/experience.d.ts +0 -63
  105. package/build-esm/experience.d.ts.map +0 -1
  106. package/build-esm/experience.js +0 -132
  107. package/build-esm/experience.js.map +0 -1
  108. package/build-esm/iab.d.ts +0 -320
  109. package/build-esm/iab.d.ts.map +0 -1
  110. package/build-esm/iab.js +0 -162
  111. package/build-esm/iab.js.map +0 -1
  112. package/build-esm/index.d.ts +0 -8
  113. package/build-esm/index.d.ts.map +0 -1
  114. package/build-esm/index.js +0 -8
  115. package/build-esm/index.js.map +0 -1
  116. package/build-esm/mobile.d.ts +0 -44
  117. package/build-esm/mobile.d.ts.map +0 -1
  118. package/build-esm/mobile.js +0 -20
  119. package/build-esm/mobile.js.map +0 -1
  120. package/build-esm/ui.d.ts +0 -645
  121. package/build-esm/ui.d.ts.map +0 -1
  122. package/build-esm/ui.js +0 -133
  123. package/build-esm/ui.js.map +0 -1
package/build-esm/ui.d.ts DELETED
@@ -1,645 +0,0 @@
1
- import * as t from 'io-ts';
2
- import { ObjByString } from '@transcend-io/type-utils';
3
- import { ConsentManagerSupportedTranslationValue, LocaleValue } from '@transcend-io/internationalization';
4
- import { ViewState } from './enums';
5
- import { AirgapAuth, AirgapAuthMap } from './core';
6
- /** Transcend Smart Quarantine API (window.transcend) */
7
- export type PreInitTranscendAPI = {
8
- /** Ready event subscriber */
9
- ready(callback: (transcend: TranscendAPI) => void): void;
10
- /** Ready event dispatch queue */
11
- readyQueue: ((transcend: TranscendAPI) => void)[];
12
- };
13
- /** showConsentManager() */
14
- export interface ShowConsentManagerOptions {
15
- /** View state */
16
- viewState?: ViewState;
17
- }
18
- /**
19
- * Input for fetching a policy from Transcend and inserting template variables
20
- */
21
- export type GetTranscendPolicies = {
22
- /** The language to fetch policy for - defaults to currently selected language key */
23
- locale?: LocaleValue;
24
- /** Template variables to dynamically inject into the policy */
25
- variables?: ObjByString;
26
- /**
27
- * The UUID of the policies defined in Transcend to fetch
28
- *
29
- * This can be pulled from the URL
30
- * @see https://app.transcend.io/privacy-center/policies
31
- */
32
- policyIds?: string[];
33
- /**
34
- * The titles of the policies defined in Transcend to fetch
35
- *
36
- * This can be pulled from the URL
37
- * @see https://app.transcend.io/privacy-center/policies
38
- */
39
- policyTitles?: string[];
40
- };
41
- /**
42
- * The returning Transcend policy
43
- */
44
- export type TranscendPolicy = {
45
- /** The policy UUID */
46
- id: string;
47
- /** The policy title */
48
- title: string;
49
- /** The policy content */
50
- content: string;
51
- };
52
- /**
53
- * Transcend Consent Manager external methods
54
- */
55
- export type ConsentManagerAPI = Readonly<{
56
- /** Possible ViewState values */
57
- viewStates: Set<ViewState>;
58
- /** Expose an option to grab the current view state */
59
- getViewState: () => ViewState;
60
- /** Get the current active language */
61
- getPolicies: (input?: GetTranscendPolicies) => Promise<TranscendPolicy[]>;
62
- /** Callback that sets any dynamic variables that should be exposed to the consent UI messages */
63
- setUiVariables: (variables: ObjByString) => Promise<void>;
64
- /** Get the current value of Transcend UI variables */
65
- getUiVariables: () => ObjByString;
66
- /** Set consent change authorization key */
67
- setAuth?: (key: AirgapAuthMap['key']) => void;
68
- /** Change the current privacy policy URL */
69
- setPrivacyPolicy: (privacyPolicyLink: string) => void;
70
- /** Change the current secondary policy URL */
71
- setSecondaryPolicy: (privacyPolicyLink: string) => void;
72
- /** Show consent manager unless recently dismissed */
73
- autoShowConsentManager(options?: ShowConsentManagerOptions): Promise<void>;
74
- /** Show consent manager */
75
- showConsentManager(options?: ShowConsentManagerOptions): Promise<void>;
76
- /** Set the current active language */
77
- setActiveLocale(locale: ConsentManagerSupportedTranslationValue): Promise<void>;
78
- /** Get the currently active locale */
79
- getActiveLocale: () => ConsentManagerSupportedTranslationValue;
80
- /** Toggle consent manager */
81
- toggleConsentManager(options?: ShowConsentManagerOptions): Promise<void>;
82
- /** Hide consent manager */
83
- hideConsentManager(): Promise<void>;
84
- /** Opt out of the sale of personal info & show a disclosure */
85
- doNotSell(auth: AirgapAuth, options?: ShowConsentManagerOptions): Promise<void>;
86
- /** Opt out of all purposes */
87
- optOutNotice(auth: AirgapAuth, options?: ShowConsentManagerOptions): Promise<void>;
88
- /** Sets local tcf string (does not sync to xdi or preference store) */
89
- setTCFConsent?: (auth: AirgapAuth, tcString: string) => Promise<void>;
90
- /** UI version */
91
- version?: string;
92
- }> & EventTarget;
93
- /**
94
- * `transcend` event types
95
- */
96
- export type TranscendEventType = 'view-state-change';
97
- /** 'view-state-change' custom event details */
98
- export type ViewStateEventDetails = {
99
- /** The new, now-current view state */
100
- viewState: ViewState;
101
- /** The previous view state */
102
- previousViewState: ViewState | null;
103
- };
104
- /** Transcend Smart Quarantine API (window.transcend) */
105
- export type TranscendAPI = PreInitTranscendAPI & ConsentManagerAPI;
106
- /**
107
- * Customer theming
108
- */
109
- export declare const ConsentManagerTheme: t.TypeC<{
110
- /** Primary color */
111
- primaryColor: t.StringC;
112
- /** Font color */
113
- fontColor: t.StringC;
114
- }>;
115
- /** Type override */
116
- export type ConsentManagerTheme = t.TypeOf<typeof ConsentManagerTheme>;
117
- /**
118
- * Mobile-first responsive breakpoints
119
- * No media query for mobile, which is the default
120
- */
121
- export declare const ConsentManagerBreakpoints: t.TypeC<{
122
- /** In px, at or above this width is tablet */
123
- tablet: t.StringC;
124
- /** In px, at or above this width is desktop */
125
- desktop: t.StringC;
126
- }>;
127
- /** Type override */
128
- export type ConsentManagerBreakpoints = t.TypeOf<typeof ConsentManagerBreakpoints>;
129
- /**
130
- * TODO: https://transcend.height.app/T-19149 - remove
131
- * @deprecated
132
- */
133
- export declare const PrivacyRegimeToInitialViewStateInput: t.PartialC<{
134
- Unknown: t.KeyofC<{
135
- QuickOptions: unknown;
136
- QuickOptions3: unknown;
137
- AcceptAll: unknown;
138
- AcceptAllRejectAllToggle: unknown;
139
- AcceptAllOrMoreChoices: unknown;
140
- AcceptOrRejectAll: unknown;
141
- AcceptOrRejectAllOrMoreChoices: unknown;
142
- AcceptOrRejectAnalytics: unknown;
143
- AcceptOrRejectAdvertising: unknown;
144
- NoticeAndDoNotSell: unknown;
145
- DoNotSellExplainer: unknown;
146
- CompleteOptionsToggles: unknown;
147
- PrivacyPolicyNotice: unknown;
148
- PrivacyPolicyNoticeWithCloseButton: unknown;
149
- CompleteOptions: unknown;
150
- CompleteOptionsInverted: unknown;
151
- Hidden: unknown;
152
- }>;
153
- CPRA: t.KeyofC<{
154
- QuickOptions: unknown;
155
- QuickOptions3: unknown;
156
- AcceptAll: unknown;
157
- AcceptAllRejectAllToggle: unknown;
158
- AcceptAllOrMoreChoices: unknown;
159
- AcceptOrRejectAll: unknown;
160
- AcceptOrRejectAllOrMoreChoices: unknown;
161
- AcceptOrRejectAnalytics: unknown;
162
- AcceptOrRejectAdvertising: unknown;
163
- NoticeAndDoNotSell: unknown;
164
- DoNotSellExplainer: unknown;
165
- CompleteOptionsToggles: unknown;
166
- PrivacyPolicyNotice: unknown;
167
- PrivacyPolicyNoticeWithCloseButton: unknown;
168
- CompleteOptions: unknown;
169
- CompleteOptionsInverted: unknown;
170
- Hidden: unknown;
171
- }>;
172
- GDPR: t.KeyofC<{
173
- QuickOptions: unknown;
174
- QuickOptions3: unknown;
175
- AcceptAll: unknown;
176
- AcceptAllRejectAllToggle: unknown;
177
- AcceptAllOrMoreChoices: unknown;
178
- AcceptOrRejectAll: unknown;
179
- AcceptOrRejectAllOrMoreChoices: unknown;
180
- AcceptOrRejectAnalytics: unknown;
181
- AcceptOrRejectAdvertising: unknown;
182
- NoticeAndDoNotSell: unknown;
183
- DoNotSellExplainer: unknown;
184
- CompleteOptionsToggles: unknown;
185
- PrivacyPolicyNotice: unknown;
186
- PrivacyPolicyNoticeWithCloseButton: unknown;
187
- CompleteOptions: unknown;
188
- CompleteOptionsInverted: unknown;
189
- Hidden: unknown;
190
- }>;
191
- LGPD: t.KeyofC<{
192
- QuickOptions: unknown;
193
- QuickOptions3: unknown;
194
- AcceptAll: unknown;
195
- AcceptAllRejectAllToggle: unknown;
196
- AcceptAllOrMoreChoices: unknown;
197
- AcceptOrRejectAll: unknown;
198
- AcceptOrRejectAllOrMoreChoices: unknown;
199
- AcceptOrRejectAnalytics: unknown;
200
- AcceptOrRejectAdvertising: unknown;
201
- NoticeAndDoNotSell: unknown;
202
- DoNotSellExplainer: unknown;
203
- CompleteOptionsToggles: unknown;
204
- PrivacyPolicyNotice: unknown;
205
- PrivacyPolicyNoticeWithCloseButton: unknown;
206
- CompleteOptions: unknown;
207
- CompleteOptionsInverted: unknown;
208
- Hidden: unknown;
209
- }>;
210
- CDPA: t.KeyofC<{
211
- QuickOptions: unknown;
212
- QuickOptions3: unknown;
213
- AcceptAll: unknown;
214
- AcceptAllRejectAllToggle: unknown;
215
- AcceptAllOrMoreChoices: unknown;
216
- AcceptOrRejectAll: unknown;
217
- AcceptOrRejectAllOrMoreChoices: unknown;
218
- AcceptOrRejectAnalytics: unknown;
219
- AcceptOrRejectAdvertising: unknown;
220
- NoticeAndDoNotSell: unknown;
221
- DoNotSellExplainer: unknown;
222
- CompleteOptionsToggles: unknown;
223
- PrivacyPolicyNotice: unknown;
224
- PrivacyPolicyNoticeWithCloseButton: unknown;
225
- CompleteOptions: unknown;
226
- CompleteOptionsInverted: unknown;
227
- Hidden: unknown;
228
- }>;
229
- CPA: t.KeyofC<{
230
- QuickOptions: unknown;
231
- QuickOptions3: unknown;
232
- AcceptAll: unknown;
233
- AcceptAllRejectAllToggle: unknown;
234
- AcceptAllOrMoreChoices: unknown;
235
- AcceptOrRejectAll: unknown;
236
- AcceptOrRejectAllOrMoreChoices: unknown;
237
- AcceptOrRejectAnalytics: unknown;
238
- AcceptOrRejectAdvertising: unknown;
239
- NoticeAndDoNotSell: unknown;
240
- DoNotSellExplainer: unknown;
241
- CompleteOptionsToggles: unknown;
242
- PrivacyPolicyNotice: unknown;
243
- PrivacyPolicyNoticeWithCloseButton: unknown;
244
- CompleteOptions: unknown;
245
- CompleteOptionsInverted: unknown;
246
- Hidden: unknown;
247
- }>;
248
- NEVADA_SB220: t.KeyofC<{
249
- QuickOptions: unknown;
250
- QuickOptions3: unknown;
251
- AcceptAll: unknown;
252
- AcceptAllRejectAllToggle: unknown;
253
- AcceptAllOrMoreChoices: unknown;
254
- AcceptOrRejectAll: unknown;
255
- AcceptOrRejectAllOrMoreChoices: unknown;
256
- AcceptOrRejectAnalytics: unknown;
257
- AcceptOrRejectAdvertising: unknown;
258
- NoticeAndDoNotSell: unknown;
259
- DoNotSellExplainer: unknown;
260
- CompleteOptionsToggles: unknown;
261
- PrivacyPolicyNotice: unknown;
262
- PrivacyPolicyNoticeWithCloseButton: unknown;
263
- CompleteOptions: unknown;
264
- CompleteOptionsInverted: unknown;
265
- Hidden: unknown;
266
- }>;
267
- nFADP: t.KeyofC<{
268
- QuickOptions: unknown;
269
- QuickOptions3: unknown;
270
- AcceptAll: unknown;
271
- AcceptAllRejectAllToggle: unknown;
272
- AcceptAllOrMoreChoices: unknown;
273
- AcceptOrRejectAll: unknown;
274
- AcceptOrRejectAllOrMoreChoices: unknown;
275
- AcceptOrRejectAnalytics: unknown;
276
- AcceptOrRejectAdvertising: unknown;
277
- NoticeAndDoNotSell: unknown;
278
- DoNotSellExplainer: unknown;
279
- CompleteOptionsToggles: unknown;
280
- PrivacyPolicyNotice: unknown;
281
- PrivacyPolicyNoticeWithCloseButton: unknown;
282
- CompleteOptions: unknown;
283
- CompleteOptionsInverted: unknown;
284
- Hidden: unknown;
285
- }>;
286
- US_DNSS: t.KeyofC<{
287
- QuickOptions: unknown;
288
- QuickOptions3: unknown;
289
- AcceptAll: unknown;
290
- AcceptAllRejectAllToggle: unknown;
291
- AcceptAllOrMoreChoices: unknown;
292
- AcceptOrRejectAll: unknown;
293
- AcceptOrRejectAllOrMoreChoices: unknown;
294
- AcceptOrRejectAnalytics: unknown;
295
- AcceptOrRejectAdvertising: unknown;
296
- NoticeAndDoNotSell: unknown;
297
- DoNotSellExplainer: unknown;
298
- CompleteOptionsToggles: unknown;
299
- PrivacyPolicyNotice: unknown;
300
- PrivacyPolicyNoticeWithCloseButton: unknown;
301
- CompleteOptions: unknown;
302
- CompleteOptionsInverted: unknown;
303
- Hidden: unknown;
304
- }>;
305
- }>;
306
- /**
307
- * TODO: https://transcend.height.app/T-19149 - remove
308
- * @deprecated
309
- */
310
- export type PrivacyRegimeToInitialViewStateInput = t.TypeOf<typeof PrivacyRegimeToInitialViewStateInput>;
311
- /**
312
- * TODO: https://transcend.height.app/T-19149 - remove
313
- * @deprecated
314
- */
315
- export declare const PrivacyRegimeToInitialViewState: t.RecordC<t.KeyofC<{
316
- Unknown: unknown;
317
- CPRA: unknown;
318
- GDPR: unknown;
319
- LGPD: unknown;
320
- CDPA: unknown;
321
- CPA: unknown;
322
- NEVADA_SB220: unknown;
323
- nFADP: unknown;
324
- US_DNSS: unknown;
325
- }>, t.KeyofC<{
326
- QuickOptions: unknown;
327
- QuickOptions3: unknown;
328
- AcceptAll: unknown;
329
- AcceptAllRejectAllToggle: unknown;
330
- AcceptAllOrMoreChoices: unknown;
331
- AcceptOrRejectAll: unknown;
332
- AcceptOrRejectAllOrMoreChoices: unknown;
333
- AcceptOrRejectAnalytics: unknown;
334
- AcceptOrRejectAdvertising: unknown;
335
- NoticeAndDoNotSell: unknown;
336
- DoNotSellExplainer: unknown;
337
- CompleteOptionsToggles: unknown;
338
- PrivacyPolicyNotice: unknown;
339
- PrivacyPolicyNoticeWithCloseButton: unknown;
340
- CompleteOptions: unknown;
341
- CompleteOptionsInverted: unknown;
342
- Hidden: unknown;
343
- }>>;
344
- /**
345
- * TODO: https://transcend.height.app/T-19149 - remove
346
- * @deprecated
347
- */
348
- export type PrivacyRegimeToInitialViewState = t.TypeOf<typeof PrivacyRegimeToInitialViewState>;
349
- export declare const ExperienceToInitialViewState: t.RecordC<t.StringC, t.KeyofC<{
350
- TCF_EU: unknown;
351
- QuickOptions: unknown;
352
- QuickOptions3: unknown;
353
- AcceptAll: unknown;
354
- AcceptAllRejectAllToggle: unknown;
355
- AcceptAllOrMoreChoices: unknown;
356
- AcceptOrRejectAll: unknown;
357
- AcceptOrRejectAllOrMoreChoices: unknown;
358
- AcceptOrRejectAnalytics: unknown;
359
- AcceptOrRejectAdvertising: unknown;
360
- NoticeAndDoNotSell: unknown;
361
- DoNotSellExplainer: unknown;
362
- CompleteOptionsToggles: unknown;
363
- PrivacyPolicyNotice: unknown;
364
- PrivacyPolicyNoticeWithCloseButton: unknown;
365
- CompleteOptions: unknown;
366
- CompleteOptionsInverted: unknown;
367
- Hidden: unknown;
368
- }>>;
369
- /** type overload */
370
- export type ExperienceToInitialViewState = t.TypeOf<typeof ExperienceToInitialViewState>;
371
- export declare const RequiredConsentManagerConfig: t.TypeC<{
372
- /** Customer theming */
373
- theme: t.TypeC<{
374
- /** Primary color */
375
- primaryColor: t.StringC;
376
- /** Font color */
377
- fontColor: t.StringC;
378
- }>;
379
- /** A set of responsive breakpoints */
380
- breakpoints: t.TypeC<{
381
- /** In px, at or above this width is tablet */
382
- tablet: t.StringC;
383
- /** In px, at or above this width is desktop */
384
- desktop: t.StringC;
385
- }>;
386
- /** The privacy policy URL to redirect to */
387
- privacyPolicy: t.StringC;
388
- /** The secondary policy URL to redirect to */
389
- secondaryPolicy: t.StringC;
390
- /** Custom CSS stylesheet */
391
- css: t.StringC;
392
- /** Path to localizations directory */
393
- messages: t.StringC;
394
- /** What state the consent manager should launch in */
395
- initialViewStateByPrivacyRegime: t.RecordC<t.StringC, t.KeyofC<{
396
- TCF_EU: unknown;
397
- QuickOptions: unknown;
398
- QuickOptions3: unknown;
399
- AcceptAll: unknown;
400
- AcceptAllRejectAllToggle: unknown;
401
- AcceptAllOrMoreChoices: unknown;
402
- AcceptOrRejectAll: unknown;
403
- AcceptOrRejectAllOrMoreChoices: unknown;
404
- AcceptOrRejectAnalytics: unknown;
405
- AcceptOrRejectAdvertising: unknown;
406
- NoticeAndDoNotSell: unknown;
407
- DoNotSellExplainer: unknown;
408
- CompleteOptionsToggles: unknown;
409
- PrivacyPolicyNotice: unknown;
410
- PrivacyPolicyNoticeWithCloseButton: unknown;
411
- CompleteOptions: unknown;
412
- CompleteOptionsInverted: unknown;
413
- Hidden: unknown;
414
- }>>;
415
- /** What state the consent manager should go to when dismissed */
416
- dismissedViewState: t.KeyofC<{
417
- Collapsed: unknown;
418
- Closed: unknown;
419
- }>;
420
- }>;
421
- /** type overload */
422
- export type RequiredConsentManagerConfig = t.TypeOf<typeof RequiredConsentManagerConfig>;
423
- export declare const OptionalConsentManagerConfig: t.PartialC<{
424
- /** The set of enabled languages - CSV of ConsentManagerSupportedTranslationValue */
425
- languages: t.StringC;
426
- /** The override value for the consent banner z-index */
427
- uiZIndex: t.StringC;
428
- /**
429
- * The override value for the consent banner shadow root state
430
- *
431
- * Potential values: 'closed' (default) and 'open'
432
- */
433
- uiShadowRoot: t.StringC;
434
- /**
435
- * The override value for whether to focus on the first descendant of the root arg w/data-initialFocus attribute
436
- * Potential values: `'on'` (default) or `'off'`
437
- *
438
- */
439
- autofocus: t.KeyofC<{
440
- on: null; /** Get the currently active locale */
441
- off: null;
442
- }>;
443
- }>;
444
- /** type overload */
445
- export type OptionalConsentManagerConfig = t.TypeOf<typeof OptionalConsentManagerConfig>;
446
- /** Consent manager UI configuration */
447
- export declare const ConsentManagerConfig: t.IntersectionC<[t.TypeC<{
448
- /** Customer theming */
449
- theme: t.TypeC<{
450
- /** Primary color */
451
- primaryColor: t.StringC;
452
- /** Font color */
453
- fontColor: t.StringC;
454
- }>;
455
- /** A set of responsive breakpoints */
456
- breakpoints: t.TypeC<{
457
- /** In px, at or above this width is tablet */
458
- tablet: t.StringC;
459
- /** In px, at or above this width is desktop */
460
- desktop: t.StringC;
461
- }>;
462
- /** The privacy policy URL to redirect to */
463
- privacyPolicy: t.StringC;
464
- /** The secondary policy URL to redirect to */
465
- secondaryPolicy: t.StringC;
466
- /** Custom CSS stylesheet */
467
- css: t.StringC;
468
- /** Path to localizations directory */
469
- messages: t.StringC;
470
- /** What state the consent manager should launch in */
471
- initialViewStateByPrivacyRegime: t.RecordC<t.StringC, t.KeyofC<{
472
- TCF_EU: unknown;
473
- QuickOptions: unknown;
474
- QuickOptions3: unknown;
475
- AcceptAll: unknown;
476
- AcceptAllRejectAllToggle: unknown;
477
- AcceptAllOrMoreChoices: unknown;
478
- AcceptOrRejectAll: unknown;
479
- AcceptOrRejectAllOrMoreChoices: unknown;
480
- AcceptOrRejectAnalytics: unknown;
481
- AcceptOrRejectAdvertising: unknown;
482
- NoticeAndDoNotSell: unknown;
483
- DoNotSellExplainer: unknown;
484
- CompleteOptionsToggles: unknown;
485
- PrivacyPolicyNotice: unknown;
486
- PrivacyPolicyNoticeWithCloseButton: unknown;
487
- CompleteOptions: unknown;
488
- CompleteOptionsInverted: unknown;
489
- Hidden: unknown;
490
- }>>;
491
- /** What state the consent manager should go to when dismissed */
492
- dismissedViewState: t.KeyofC<{
493
- Collapsed: unknown;
494
- Closed: unknown;
495
- }>;
496
- }>, t.PartialC<{
497
- /** The set of enabled languages - CSV of ConsentManagerSupportedTranslationValue */
498
- languages: t.StringC;
499
- /** The override value for the consent banner z-index */
500
- uiZIndex: t.StringC;
501
- /**
502
- * The override value for the consent banner shadow root state
503
- *
504
- * Potential values: 'closed' (default) and 'open'
505
- */
506
- uiShadowRoot: t.StringC;
507
- /**
508
- * The override value for whether to focus on the first descendant of the root arg w/data-initialFocus attribute
509
- * Potential values: `'on'` (default) or `'off'`
510
- *
511
- */
512
- autofocus: t.KeyofC<{
513
- on: null; /** Get the currently active locale */
514
- off: null;
515
- }>;
516
- }>]>;
517
- /** Type override */
518
- export type ConsentManagerConfig = t.TypeOf<typeof ConsentManagerConfig>;
519
- /** Input for Consent manager UI configuration */
520
- export declare const ConsentManagerConfigInput: t.PartialC<{
521
- /** Customer theming */
522
- theme: t.TypeC<{
523
- /** Primary color */
524
- primaryColor: t.StringC;
525
- /** Font color */
526
- fontColor: t.StringC;
527
- }>;
528
- /** A set of responsive breakpoints */
529
- breakpoints: t.TypeC<{
530
- /** In px, at or above this width is tablet */
531
- tablet: t.StringC;
532
- /** In px, at or above this width is desktop */
533
- desktop: t.StringC;
534
- }>;
535
- /** The privacy policy URL to redirect to */
536
- privacyPolicy: t.StringC;
537
- /** The secondary policy URL to redirect to */
538
- secondaryPolicy: t.StringC;
539
- /** Custom CSS stylesheet */
540
- css: t.StringC;
541
- /** Path to localizations directory */
542
- messages: t.StringC;
543
- /** What state the consent manager should launch in */
544
- initialViewStateByPrivacyRegime: t.RecordC<t.StringC, t.KeyofC<{
545
- TCF_EU: unknown;
546
- QuickOptions: unknown;
547
- QuickOptions3: unknown;
548
- AcceptAll: unknown;
549
- AcceptAllRejectAllToggle: unknown;
550
- AcceptAllOrMoreChoices: unknown;
551
- AcceptOrRejectAll: unknown;
552
- AcceptOrRejectAllOrMoreChoices: unknown;
553
- AcceptOrRejectAnalytics: unknown;
554
- AcceptOrRejectAdvertising: unknown;
555
- NoticeAndDoNotSell: unknown;
556
- DoNotSellExplainer: unknown;
557
- CompleteOptionsToggles: unknown;
558
- PrivacyPolicyNotice: unknown;
559
- PrivacyPolicyNoticeWithCloseButton: unknown;
560
- CompleteOptions: unknown;
561
- CompleteOptionsInverted: unknown;
562
- Hidden: unknown;
563
- }>>;
564
- /** What state the consent manager should go to when dismissed */
565
- dismissedViewState: t.KeyofC<{
566
- Collapsed: unknown;
567
- Closed: unknown;
568
- }>;
569
- /** The set of enabled languages - CSV of ConsentManagerSupportedTranslationValue */
570
- languages: t.StringC;
571
- /** The override value for the consent banner z-index */
572
- uiZIndex: t.StringC;
573
- /**
574
- * The override value for the consent banner shadow root state
575
- *
576
- * Potential values: 'closed' (default) and 'open'
577
- */
578
- uiShadowRoot: t.StringC;
579
- /**
580
- * The override value for whether to focus on the first descendant of the root arg w/data-initialFocus attribute
581
- * Potential values: `'on'` (default) or `'off'`
582
- *
583
- */
584
- autofocus: t.KeyofC<{
585
- on: null; /** Get the currently active locale */
586
- off: null;
587
- }>;
588
- }>;
589
- /** Type override */
590
- export type ConsentManagerConfigInput = t.TypeOf<typeof ConsentManagerConfigInput>;
591
- export declare const TCFConfig: t.TypeC<{
592
- /** Path to vendor-list.json */
593
- vendorList: t.StringC;
594
- /** Custom CSS stylesheet */
595
- css: t.StringC;
596
- /** Path to localizations directory */
597
- messages: t.StringC;
598
- }>;
599
- /** Type override */
600
- export type TCFConfig = t.TypeOf<typeof TCFConfig>;
601
- /** Configuration that are passed directly to the TCF module, not via airgap.j */
602
- export declare const TCFBundledDataConfig: t.PartialC<{
603
- /** Mapping of TCF Purpose ID to airgap tracking types */
604
- purposeMap: t.ArrayC<t.TupleC<[t.NumberC, t.ArrayC<t.StringC>]>>;
605
- /** These TCF purposes cannot be processed on the basis of legitimate interests */
606
- restrictLegitimateInterestPurposes: t.ArrayC<t.NumberC>;
607
- /** Vendors that Transcend Consent regulates because they haven't registered with IAB TCF */
608
- nonTcfVendors: t.ArrayC<t.IntersectionC<[t.TypeC<{
609
- name: t.StringC;
610
- purposes: t.ArrayC<t.StringC>;
611
- }>, t.PartialC<{
612
- description: t.StringC;
613
- }>]>>;
614
- /** Comma separated list of languages to support in the UI */
615
- languages: t.StringC;
616
- /** Default locale to use for the UI internationalization */
617
- locale: t.StringC;
618
- /**
619
- * Whether or not to enable integration between Google Consent Mode and TCF.
620
- * More docs here https://developers.google.com/tag-platform/security/guides/implement-TCF-strings#cmp-api
621
- */
622
- enableAdvertiserConsentMode: t.BooleanC;
623
- }>;
624
- /** Type override */
625
- export type TCFBundledDataConfig = t.TypeOf<typeof TCFBundledDataConfig>;
626
- /** Input for Consent manager UI configuration */
627
- export declare const TCFConfigInput: t.PartialC<{
628
- /** Path to vendor-list.json */
629
- vendorList: t.StringC;
630
- /** Custom CSS stylesheet */
631
- css: t.StringC;
632
- /** Path to localizations directory */
633
- messages: t.StringC;
634
- }>;
635
- /** Type override */
636
- export type TCFConfigInput = t.TypeOf<typeof TCFConfigInput>;
637
- /**
638
- * Properties exposed on `self` by the Transcend Smart Quarantine
639
- */
640
- export type TranscendView = Window & {
641
- /** Transcend Smart Quarantine API */
642
- transcend: TranscendAPI;
643
- };
644
- export declare const DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME: ExperienceToInitialViewState;
645
- //# sourceMappingURL=ui.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../src/ui.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAG3B,OAAO,EAAE,WAAW,EAAuB,MAAM,0BAA0B,CAAC;AAC5E,OAAO,EACL,uCAAuC,EACvC,WAAW,EACZ,MAAM,oCAAoC,CAAC;AAG5C,OAAO,EACL,SAAS,EAKV,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,aAAa,EAAiB,MAAM,QAAQ,CAAC;AAGlE,wDAAwD;AACxD,MAAM,MAAM,mBAAmB,GAAG;IAChC,6BAA6B;IAC7B,KAAK,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI,CAAC;IACzD,iCAAiC;IACjC,UAAU,EAAE,CAAC,CAAC,SAAS,EAAE,YAAY,KAAK,IAAI,CAAC,EAAE,CAAC;CACnD,CAAC;AAEF,2BAA2B;AAC3B,MAAM,WAAW,yBAAyB;IACxC,iBAAiB;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,qFAAqF;IACrF,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,gCAAgC;IAChC,UAAU,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC3B,sDAAsD;IACtD,YAAY,EAAE,MAAM,SAAS,CAAC;IAC9B,sCAAsC;IACtC,WAAW,EAAE,CAAC,KAAK,CAAC,EAAE,oBAAoB,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAC1E,iGAAiG;IACjG,cAAc,EAAE,CAAC,SAAS,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,sDAAsD;IACtD,cAAc,EAAE,MAAM,WAAW,CAAC;IAClC,2CAA2C;IAC3C,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;IAC9C,4CAA4C;IAC5C,gBAAgB,EAAE,CAAC,iBAAiB,EAAE,MAAM,KAAK,IAAI,CAAC;IACtD,8CAA8C;IAC9C,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,MAAM,KAAK,IAAI,CAAC;IACxD,qDAAqD;IACrD,sBAAsB,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E,2BAA2B;IAC3B,kBAAkB,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,sCAAsC;IACtC,eAAe,CACb,MAAM,EAAE,uCAAuC,GAC9C,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,sCAAsC;IACtC,eAAe,EAAE,MAAM,uCAAuC,CAAC;IAC/D,6BAA6B;IAC7B,oBAAoB,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,2BAA2B;IAC3B,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,+DAA+D;IAC/D,SAAS,CACP,IAAI,EAAE,UAAU,EAChB,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,8BAA8B;IAC9B,YAAY,CACV,IAAI,EAAE,UAAU,EAChB,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,uEAAuE;IACvE,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,iBAAiB;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC,GACA,WAAW,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,CAAC;AAErD,+CAA+C;AAC/C,MAAM,MAAM,qBAAqB,GAAG;IAClC,sCAAsC;IACtC,SAAS,EAAE,SAAS,CAAC;IACrB,8BAA8B;IAC9B,iBAAiB,EAAE,SAAS,GAAG,IAAI,CAAC;CACrC,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,mBAAmB;IAC9B,oBAAoB;;IAEpB,iBAAiB;;EAEjB,CAAC;AAEH,oBAAoB;AACpB,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,yBAAyB;IACpC,8CAA8C;;IAE9C,+CAA+C;;EAE/C,CAAC;AAEH,oBAAoB;AACpB,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAC9C,OAAO,yBAAyB,CACjC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEhD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CACzD,OAAO,oCAAoC,CAC5C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAG3C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CACpD,OAAO,+BAA+B,CACvC,CAAC;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;GAGxC,CAAC;AAEF,oBAAoB;AACpB,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CACjD,OAAO,4BAA4B,CACpC,CAAC;AAEF,eAAO,MAAM,4BAA4B;IACvC,uBAAuB;;QArEvB,oBAAoB;;QAEpB,iBAAiB;;;IAqEjB,sCAAsC;;QAzDtC,8CAA8C;;QAE9C,+CAA+C;;;IAyD/C,4CAA4C;;IAE5C,8CAA8C;;IAE9C,4BAA4B;;IAE5B,sCAAsC;;IAEtC,sDAAsD;;;;;;;;;;;;;;;;;;;;;IAEtD,iEAAiE;;;;;EAEjE,CAAC;AAEH,oBAAoB;AACpB,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CACjD,OAAO,4BAA4B,CACpC,CAAC;AAEF,eAAO,MAAM,4BAA4B;IACvC,oFAAoF;;IAEpF,wDAAwD;;IAExD;;;;OAIG;;IAEH;;;;OAIG;;kBAtJH,sCAAsC;;;EAwJtC,CAAC;AAEH,oBAAoB;AACpB,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CACjD,OAAO,4BAA4B,CACpC,CAAC;AAEF,uCAAuC;AACvC,eAAO,MAAM,oBAAoB;IAhD/B,uBAAuB;;QArEvB,oBAAoB;;QAEpB,iBAAiB;;;IAqEjB,sCAAsC;;QAzDtC,8CAA8C;;QAE9C,+CAA+C;;;IAyD/C,4CAA4C;;IAE5C,8CAA8C;;IAE9C,4BAA4B;;IAE5B,sCAAsC;;IAEtC,sDAAsD;;;;;;;;;;;;;;;;;;;;;IAEtD,iEAAiE;;;;;;IAUjE,oFAAoF;;IAEpF,wDAAwD;;IAExD;;;;OAIG;;IAEH;;;;OAIG;;kBAtJH,sCAAsC;;;IAmKtC,CAAC;AAEH,oBAAoB;AACpB,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEzE,iDAAiD;AACjD,eAAO,MAAM,yBAAyB;IAzDpC,uBAAuB;;QArEvB,oBAAoB;;QAEpB,iBAAiB;;;IAqEjB,sCAAsC;;QAzDtC,8CAA8C;;QAE9C,+CAA+C;;;IAyD/C,4CAA4C;;IAE5C,8CAA8C;;IAE9C,4BAA4B;;IAE5B,sCAAsC;;IAEtC,sDAAsD;;;;;;;;;;;;;;;;;;;;;IAEtD,iEAAiE;;;;;IAUjE,oFAAoF;;IAEpF,wDAAwD;;IAExD;;;;OAIG;;IAEH;;;;OAIG;;kBAtJH,sCAAsC;;;EA4KtC,CAAC;AAEH,oBAAoB;AACpB,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAC9C,OAAO,yBAAyB,CACjC,CAAC;AAEF,eAAO,MAAM,SAAS;IACpB,+BAA+B;;IAE/B,4BAA4B;;IAE5B,sCAAsC;;EAEtC,CAAC;AAEH,oBAAoB;AACpB,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,SAAS,CAAC,CAAC;AAEnD,iFAAiF;AACjF,eAAO,MAAM,oBAAoB;IAC/B,yDAAyD;;IAEzD,kFAAkF;;IAElF,4FAA4F;;;;;;;IAE5F,6DAA6D;;IAE7D,6DAA6D;;IAE7D;;;OAGG;;EAEH,CAAC;AAEH,oBAAoB;AACpB,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEzE,iDAAiD;AACjD,eAAO,MAAM,cAAc;IAlCzB,+BAA+B;;IAE/B,4BAA4B;;IAE5B,sCAAsC;;EA8BgB,CAAC;AAEzD,oBAAoB;AACpB,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,cAAc,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG;IACnC,qCAAqC;IACrC,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,oCAAoC,EAAE,4BAoBhD,CAAC"}