@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.js DELETED
@@ -1,133 +0,0 @@
1
- // external
2
- import * as t from 'io-ts';
3
- // main
4
- import { applyEnum, valuesOf } from '@transcend-io/type-utils';
5
- // local
6
- import { InitialTranscendViewState, InitialViewState, PrivacyRegimeEnum, DismissedViewState, } from './enums';
7
- import { BooleanString } from './core';
8
- import { NonTcfVendor } from './iab';
9
- /**
10
- * Customer theming
11
- */
12
- export const ConsentManagerTheme = t.type({
13
- /** Primary color */
14
- primaryColor: t.string,
15
- /** Font color */
16
- fontColor: t.string,
17
- });
18
- /**
19
- * Mobile-first responsive breakpoints
20
- * No media query for mobile, which is the default
21
- */
22
- export const ConsentManagerBreakpoints = t.type({
23
- /** In px, at or above this width is tablet */
24
- tablet: t.string,
25
- /** In px, at or above this width is desktop */
26
- desktop: t.string,
27
- });
28
- /**
29
- * TODO: https://transcend.height.app/T-19149 - remove
30
- * @deprecated
31
- */
32
- export const PrivacyRegimeToInitialViewStateInput = t.partial(applyEnum(PrivacyRegimeEnum, () => valuesOf(InitialTranscendViewState)));
33
- /**
34
- * TODO: https://transcend.height.app/T-19149 - remove
35
- * @deprecated
36
- */
37
- export const PrivacyRegimeToInitialViewState = t.record(valuesOf(PrivacyRegimeEnum), valuesOf(InitialTranscendViewState));
38
- export const ExperienceToInitialViewState = t.record(t.string, valuesOf(InitialViewState));
39
- export const RequiredConsentManagerConfig = t.type({
40
- /** Customer theming */
41
- theme: ConsentManagerTheme,
42
- /** A set of responsive breakpoints */
43
- breakpoints: ConsentManagerBreakpoints,
44
- /** The privacy policy URL to redirect to */
45
- privacyPolicy: t.string,
46
- /** The secondary policy URL to redirect to */
47
- secondaryPolicy: t.string,
48
- /** Custom CSS stylesheet */
49
- css: t.string,
50
- /** Path to localizations directory */
51
- messages: t.string,
52
- /** What state the consent manager should launch in */
53
- initialViewStateByPrivacyRegime: ExperienceToInitialViewState,
54
- /** What state the consent manager should go to when dismissed */
55
- dismissedViewState: valuesOf(DismissedViewState),
56
- });
57
- export const OptionalConsentManagerConfig = t.partial({
58
- /** The set of enabled languages - CSV of ConsentManagerSupportedTranslationValue */
59
- languages: t.string,
60
- /** The override value for the consent banner z-index */
61
- uiZIndex: t.string,
62
- /**
63
- * The override value for the consent banner shadow root state
64
- *
65
- * Potential values: 'closed' (default) and 'open'
66
- */
67
- uiShadowRoot: t.string,
68
- /**
69
- * The override value for whether to focus on the first descendant of the root arg w/data-initialFocus attribute
70
- * Potential values: `'on'` (default) or `'off'`
71
- *
72
- */
73
- autofocus: BooleanString,
74
- });
75
- /** Consent manager UI configuration */
76
- export const ConsentManagerConfig = t.intersection([
77
- RequiredConsentManagerConfig,
78
- OptionalConsentManagerConfig,
79
- ]);
80
- /** Input for Consent manager UI configuration */
81
- export const ConsentManagerConfigInput = t.partial({
82
- ...OptionalConsentManagerConfig.props,
83
- ...RequiredConsentManagerConfig.props,
84
- });
85
- export const TCFConfig = t.type({
86
- /** Path to vendor-list.json */
87
- vendorList: t.string,
88
- /** Custom CSS stylesheet */
89
- css: t.string,
90
- /** Path to localizations directory */
91
- messages: t.string,
92
- });
93
- /** Configuration that are passed directly to the TCF module, not via airgap.j */
94
- export const TCFBundledDataConfig = t.partial({
95
- /** Mapping of TCF Purpose ID to airgap tracking types */
96
- purposeMap: t.array(t.tuple([t.number, t.array(t.string)])),
97
- /** These TCF purposes cannot be processed on the basis of legitimate interests */
98
- restrictLegitimateInterestPurposes: t.array(t.number),
99
- /** Vendors that Transcend Consent regulates because they haven't registered with IAB TCF */
100
- nonTcfVendors: t.array(NonTcfVendor),
101
- /** Comma separated list of languages to support in the UI */
102
- languages: t.string,
103
- /** Default locale to use for the UI internationalization */
104
- locale: t.string,
105
- /**
106
- * Whether or not to enable integration between Google Consent Mode and TCF.
107
- * More docs here https://developers.google.com/tag-platform/security/guides/implement-TCF-strings#cmp-api
108
- */
109
- enableAdvertiserConsentMode: t.boolean,
110
- });
111
- /** Input for Consent manager UI configuration */
112
- export const TCFConfigInput = t.partial(TCFConfig.props);
113
- export const DEFAULT_VIEW_STATE_BY_PRIVACY_REGIME = {
114
- // EU
115
- GDPR: InitialViewState.QuickOptions,
116
- // Brazil
117
- LGPD: InitialViewState.QuickOptions,
118
- // Switzerland
119
- nFADP: InitialViewState.QuickOptions,
120
- // US: California
121
- CPRA: InitialViewState.Hidden,
122
- // US: Virginia
123
- CDPA: InitialViewState.Hidden,
124
- // US: Colorado
125
- CPA: InitialViewState.Hidden,
126
- // US: Nevada
127
- NEVADA_SB220: InitialViewState.Hidden,
128
- // Other
129
- Unknown: InitialViewState.Hidden,
130
- // US Do Not Sell/Share
131
- US_DNSS: InitialViewState.Hidden,
132
- };
133
- //# sourceMappingURL=ui.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ui.js","sourceRoot":"","sources":["../src/ui.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,OAAO;AACP,OAAO,EAAe,SAAS,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAM5E,QAAQ;AACR,OAAO,EAEL,yBAAyB,EACzB,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AACjB,OAAO,EAA6B,aAAa,EAAE,MAAM,QAAQ,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAuHrC;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC;IACxC,oBAAoB;IACpB,YAAY,EAAE,CAAC,CAAC,MAAM;IACtB,iBAAiB;IACjB,SAAS,EAAE,CAAC,CAAC,MAAM;CACpB,CAAC,CAAC;AAKH;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC9C,8CAA8C;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM;IAChB,+CAA+C;IAC/C,OAAO,EAAE,CAAC,CAAC,MAAM;CAClB,CAAC,CAAC;AAOH;;;GAGG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,OAAO,CAC3D,SAAS,CAAC,iBAAiB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CACxE,CAAC;AAUF;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CACrD,QAAQ,CAAC,iBAAiB,CAAC,EAC3B,QAAQ,CAAC,yBAAyB,CAAC,CACpC,CAAC;AAUF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAClD,CAAC,CAAC,MAAM,EACR,QAAQ,CAAC,gBAAgB,CAAC,CAC3B,CAAC;AAOF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,IAAI,CAAC;IACjD,uBAAuB;IACvB,KAAK,EAAE,mBAAmB;IAC1B,sCAAsC;IACtC,WAAW,EAAE,yBAAyB;IACtC,4CAA4C;IAC5C,aAAa,EAAE,CAAC,CAAC,MAAM;IACvB,8CAA8C;IAC9C,eAAe,EAAE,CAAC,CAAC,MAAM;IACzB,4BAA4B;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM;IACb,sCAAsC;IACtC,QAAQ,EAAE,CAAC,CAAC,MAAM;IAClB,sDAAsD;IACtD,+BAA+B,EAAE,4BAA4B;IAC7D,iEAAiE;IACjE,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC;CACjD,CAAC,CAAC;AAOH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,OAAO,CAAC;IACpD,oFAAoF;IACpF,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,wDAAwD;IACxD,QAAQ,EAAE,CAAC,CAAC,MAAM;IAClB;;;;OAIG;IACH,YAAY,EAAE,CAAC,CAAC,MAAM;IACtB;;;;OAIG;IACH,SAAS,EAAE,aAAa;CACzB,CAAC,CAAC;AAOH,uCAAuC;AACvC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,4BAA4B;IAC5B,4BAA4B;CAC7B,CAAC,CAAC;AAKH,iDAAiD;AACjD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,OAAO,CAAC;IACjD,GAAG,4BAA4B,CAAC,KAAK;IACrC,GAAG,4BAA4B,CAAC,KAAK;CACtC,CAAC,CAAC;AAOH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC;IAC9B,+BAA+B;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM;IACpB,4BAA4B;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM;IACb,sCAAsC;IACtC,QAAQ,EAAE,CAAC,CAAC,MAAM;CACnB,CAAC,CAAC;AAKH,iFAAiF;AACjF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,OAAO,CAAC;IAC5C,yDAAyD;IACzD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3D,kFAAkF;IAClF,kCAAkC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACrD,4FAA4F;IAC5F,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;IACpC,6DAA6D;IAC7D,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,6DAA6D;IAC7D,MAAM,EAAE,CAAC,CAAC,MAAM;IAChB;;;OAGG;IACH,2BAA2B,EAAE,CAAC,CAAC,OAAO;CACvC,CAAC,CAAC;AAKH,iDAAiD;AACjD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAazD,MAAM,CAAC,MAAM,oCAAoC,GAC/C;IACE,KAAK;IACL,IAAI,EAAE,gBAAgB,CAAC,YAAY;IACnC,SAAS;IACT,IAAI,EAAE,gBAAgB,CAAC,YAAY;IACnC,cAAc;IACd,KAAK,EAAE,gBAAgB,CAAC,YAAY;IACpC,iBAAiB;IACjB,IAAI,EAAE,gBAAgB,CAAC,MAAM;IAC7B,eAAe;IACf,IAAI,EAAE,gBAAgB,CAAC,MAAM;IAC7B,eAAe;IACf,GAAG,EAAE,gBAAgB,CAAC,MAAM;IAC5B,aAAa;IACb,YAAY,EAAE,gBAAgB,CAAC,MAAM;IACrC,QAAQ;IACR,OAAO,EAAE,gBAAgB,CAAC,MAAM;IAChC,uBAAuB;IACvB,OAAO,EAAE,gBAAgB,CAAC,MAAM;CACjC,CAAC"}