@guardian/support-dotcom-components 1.0.7 → 1.0.11

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 (59) hide show
  1. package/dist/dotcom/src/index.d.ts +6 -1
  2. package/dist/dotcom/src/index.d.ts.map +1 -1
  3. package/dist/dotcom/src/types.d.ts +3 -0
  4. package/dist/dotcom/src/types.d.ts.map +1 -1
  5. package/dist/index.esm.js +1 -1
  6. package/dist/index.js +1 -1
  7. package/dist/shared/src/lib/geolocation.d.ts +19 -0
  8. package/dist/shared/src/lib/geolocation.d.ts.map +1 -0
  9. package/dist/shared/src/lib/index.d.ts +7 -0
  10. package/dist/shared/src/lib/index.d.ts.map +1 -0
  11. package/dist/shared/src/lib/placeholders.d.ts +12 -0
  12. package/dist/shared/src/lib/placeholders.d.ts.map +1 -0
  13. package/dist/shared/src/lib/reminderFields.d.ts +9 -0
  14. package/dist/shared/src/lib/reminderFields.d.ts.map +1 -0
  15. package/dist/shared/src/lib/tracking.d.ts +17 -0
  16. package/dist/shared/src/lib/tracking.d.ts.map +1 -0
  17. package/dist/shared/src/lib/viewLog.d.ts +1 -1
  18. package/dist/shared/src/lib/viewLog.d.ts.map +1 -1
  19. package/dist/shared/src/types/abTests/banner.d.ts +73 -0
  20. package/dist/shared/src/types/abTests/banner.d.ts.map +1 -0
  21. package/dist/shared/src/types/abTests/epic.d.ts +112 -0
  22. package/dist/shared/src/types/abTests/epic.d.ts.map +1 -0
  23. package/dist/shared/src/types/abTests/header.d.ts +26 -0
  24. package/dist/shared/src/types/abTests/header.d.ts.map +1 -0
  25. package/dist/shared/src/types/abTests/index.d.ts +5 -0
  26. package/dist/shared/src/types/abTests/index.d.ts.map +1 -0
  27. package/dist/shared/src/types/abTests/shared.d.ts +12 -4
  28. package/dist/shared/src/types/abTests/shared.d.ts.map +1 -1
  29. package/dist/shared/src/types/index.d.ts +8 -0
  30. package/dist/shared/src/types/index.d.ts.map +1 -0
  31. package/dist/shared/src/types/ophan.d.ts +5 -5
  32. package/dist/shared/src/types/ophan.d.ts.map +1 -1
  33. package/dist/shared/src/types/prices.d.ts +16 -0
  34. package/dist/shared/src/types/prices.d.ts.map +1 -0
  35. package/dist/shared/src/types/props/banner.d.ts +736 -0
  36. package/dist/shared/src/types/props/banner.d.ts.map +1 -0
  37. package/dist/shared/src/types/props/design.d.ts +287 -0
  38. package/dist/shared/src/types/props/design.d.ts.map +1 -0
  39. package/dist/shared/src/types/props/epic.d.ts +622 -0
  40. package/dist/shared/src/types/props/epic.d.ts.map +1 -0
  41. package/dist/shared/src/types/props/header.d.ts +231 -0
  42. package/dist/shared/src/types/props/header.d.ts.map +1 -0
  43. package/dist/shared/src/types/props/index.d.ts +6 -0
  44. package/dist/shared/src/types/props/index.d.ts.map +1 -0
  45. package/dist/shared/src/types/props/shared.d.ts +329 -0
  46. package/dist/shared/src/types/props/shared.d.ts.map +1 -0
  47. package/dist/shared/src/types/purchaseInfo.d.ts +2 -2
  48. package/dist/shared/src/types/purchaseInfo.d.ts.map +1 -1
  49. package/dist/shared/src/types/reminders.d.ts +16 -0
  50. package/dist/shared/src/types/reminders.d.ts.map +1 -0
  51. package/dist/shared/src/types/targeting/banner.d.ts +2 -2
  52. package/dist/shared/src/types/targeting/banner.d.ts.map +1 -1
  53. package/dist/shared/src/types/targeting/epic.d.ts +3 -3
  54. package/dist/shared/src/types/targeting/epic.d.ts.map +1 -1
  55. package/dist/shared/src/types/targeting/header.d.ts +1 -1
  56. package/dist/shared/src/types/targeting/header.d.ts.map +1 -1
  57. package/dist/shared/src/types/targeting/shared.d.ts +4 -4
  58. package/dist/shared/src/types/targeting/shared.d.ts.map +1 -1
  59. package/package.json +10 -9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"banner.d.ts","sourceRoot":"","sources":["../../../../../../shared/src/types/props/banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EACH,GAAG,EAEH,YAAY,EAEZ,cAAc,EAEd,QAAQ,EAEX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAA4B,MAAM,UAAU,CAAC;AAExE,eAAO,MAAM,mBAAmB,yDAAuD,CAAC;AAExF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,MAAM,WAAW,aAAa;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,YAAY,CAAC,EAAE,YAAY,CAAC;CAC/B;AAYD,MAAM,WAAW,WAAY,SAAQ,UAAU,CAAC,mBAAmB;IAC/D,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,oBAAoB,CAAC,EAAE,CAAC,cAAc,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACrE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC1C,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,sBAAsB,CAAC;IAC3C,MAAM,CAAC,EAAE,kBAAkB,CAAC;CAC/B;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvB,CAAC;AAEH,MAAM,WAAW,kBAAmB,SAAQ,OAAO,CAAC,WAAW,CAAC;IAC5D,QAAQ,EAAE,QAAQ,CAAC;CACtB"}
@@ -0,0 +1,287 @@
1
+ import * as z from 'zod';
2
+ export declare const hexColourSchema: z.ZodObject<{
3
+ r: z.ZodEffects<z.ZodString, string, string>;
4
+ g: z.ZodEffects<z.ZodString, string, string>;
5
+ b: z.ZodEffects<z.ZodString, string, string>;
6
+ kind: z.ZodLiteral<"hex">;
7
+ }, "strip", z.ZodTypeAny, {
8
+ b: string;
9
+ g: string;
10
+ kind: "hex";
11
+ r: string;
12
+ }, {
13
+ b: string;
14
+ g: string;
15
+ kind: "hex";
16
+ r: string;
17
+ }>;
18
+ export declare const configurableDesignSchema: z.ZodObject<{
19
+ visual: z.ZodOptional<z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
20
+ mobileUrl: z.ZodString;
21
+ tabletDesktopUrl: z.ZodString;
22
+ wideUrl: z.ZodString;
23
+ altText: z.ZodString;
24
+ kind: z.ZodLiteral<"Image">;
25
+ }, "strip", z.ZodTypeAny, {
26
+ kind: "Image";
27
+ mobileUrl: string;
28
+ wideUrl: string;
29
+ altText: string;
30
+ tabletDesktopUrl: string;
31
+ }, {
32
+ kind: "Image";
33
+ mobileUrl: string;
34
+ wideUrl: string;
35
+ altText: string;
36
+ tabletDesktopUrl: string;
37
+ }>, z.ZodObject<{
38
+ buttonColour: z.ZodOptional<z.ZodObject<{
39
+ r: z.ZodEffects<z.ZodString, string, string>;
40
+ g: z.ZodEffects<z.ZodString, string, string>;
41
+ b: z.ZodEffects<z.ZodString, string, string>;
42
+ kind: z.ZodLiteral<"hex">;
43
+ }, "strip", z.ZodTypeAny, {
44
+ b: string;
45
+ g: string;
46
+ kind: "hex";
47
+ r: string;
48
+ }, {
49
+ b: string;
50
+ g: string;
51
+ kind: "hex";
52
+ r: string;
53
+ }>>;
54
+ kind: z.ZodLiteral<"ChoiceCards">;
55
+ }, "strip", z.ZodTypeAny, {
56
+ kind: "ChoiceCards";
57
+ buttonColour?: {
58
+ b: string;
59
+ g: string;
60
+ kind: "hex";
61
+ r: string;
62
+ } | undefined;
63
+ }, {
64
+ kind: "ChoiceCards";
65
+ buttonColour?: {
66
+ b: string;
67
+ g: string;
68
+ kind: "hex";
69
+ r: string;
70
+ } | undefined;
71
+ }>]>>;
72
+ colours: z.ZodObject<{
73
+ basic: z.ZodObject<{
74
+ background: z.ZodObject<{
75
+ r: z.ZodEffects<z.ZodString, string, string>;
76
+ g: z.ZodEffects<z.ZodString, string, string>;
77
+ b: z.ZodEffects<z.ZodString, string, string>;
78
+ kind: z.ZodLiteral<"hex">;
79
+ }, "strip", z.ZodTypeAny, {
80
+ b: string;
81
+ g: string;
82
+ kind: "hex";
83
+ r: string;
84
+ }, {
85
+ b: string;
86
+ g: string;
87
+ kind: "hex";
88
+ r: string;
89
+ }>;
90
+ bodyText: z.ZodObject<{
91
+ r: z.ZodEffects<z.ZodString, string, string>;
92
+ g: z.ZodEffects<z.ZodString, string, string>;
93
+ b: z.ZodEffects<z.ZodString, string, string>;
94
+ kind: z.ZodLiteral<"hex">;
95
+ }, "strip", z.ZodTypeAny, {
96
+ b: string;
97
+ g: string;
98
+ kind: "hex";
99
+ r: string;
100
+ }, {
101
+ b: string;
102
+ g: string;
103
+ kind: "hex";
104
+ r: string;
105
+ }>;
106
+ }, "strip", z.ZodTypeAny, {
107
+ background: {
108
+ b: string;
109
+ g: string;
110
+ kind: "hex";
111
+ r: string;
112
+ };
113
+ bodyText: {
114
+ b: string;
115
+ g: string;
116
+ kind: "hex";
117
+ r: string;
118
+ };
119
+ }, {
120
+ background: {
121
+ b: string;
122
+ g: string;
123
+ kind: "hex";
124
+ r: string;
125
+ };
126
+ bodyText: {
127
+ b: string;
128
+ g: string;
129
+ kind: "hex";
130
+ r: string;
131
+ };
132
+ }>;
133
+ }, "strip", z.ZodTypeAny, {
134
+ basic: {
135
+ background: {
136
+ b: string;
137
+ g: string;
138
+ kind: "hex";
139
+ r: string;
140
+ };
141
+ bodyText: {
142
+ b: string;
143
+ g: string;
144
+ kind: "hex";
145
+ r: string;
146
+ };
147
+ };
148
+ }, {
149
+ basic: {
150
+ background: {
151
+ b: string;
152
+ g: string;
153
+ kind: "hex";
154
+ r: string;
155
+ };
156
+ bodyText: {
157
+ b: string;
158
+ g: string;
159
+ kind: "hex";
160
+ r: string;
161
+ };
162
+ };
163
+ }>;
164
+ }, "strip", z.ZodTypeAny, {
165
+ colours: {
166
+ basic: {
167
+ background: {
168
+ b: string;
169
+ g: string;
170
+ kind: "hex";
171
+ r: string;
172
+ };
173
+ bodyText: {
174
+ b: string;
175
+ g: string;
176
+ kind: "hex";
177
+ r: string;
178
+ };
179
+ };
180
+ };
181
+ visual?: {
182
+ kind: "Image";
183
+ mobileUrl: string;
184
+ wideUrl: string;
185
+ altText: string;
186
+ tabletDesktopUrl: string;
187
+ } | {
188
+ kind: "ChoiceCards";
189
+ buttonColour?: {
190
+ b: string;
191
+ g: string;
192
+ kind: "hex";
193
+ r: string;
194
+ } | undefined;
195
+ } | undefined;
196
+ }, {
197
+ colours: {
198
+ basic: {
199
+ background: {
200
+ b: string;
201
+ g: string;
202
+ kind: "hex";
203
+ r: string;
204
+ };
205
+ bodyText: {
206
+ b: string;
207
+ g: string;
208
+ kind: "hex";
209
+ r: string;
210
+ };
211
+ };
212
+ };
213
+ visual?: {
214
+ kind: "Image";
215
+ mobileUrl: string;
216
+ wideUrl: string;
217
+ altText: string;
218
+ tabletDesktopUrl: string;
219
+ } | {
220
+ kind: "ChoiceCards";
221
+ buttonColour?: {
222
+ b: string;
223
+ g: string;
224
+ kind: "hex";
225
+ r: string;
226
+ } | undefined;
227
+ } | undefined;
228
+ }>;
229
+ type HexChar = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F';
230
+ type HexValue = `${HexChar}${HexChar}`;
231
+ export interface HexColour {
232
+ r: HexValue;
233
+ g: HexValue;
234
+ b: HexValue;
235
+ kind: 'hex';
236
+ }
237
+ export declare const hexColourToString: (h: HexColour) => string;
238
+ interface CtaStateDesign {
239
+ text: HexColour;
240
+ background: HexColour;
241
+ border?: HexColour;
242
+ }
243
+ export interface CtaDesign {
244
+ default: CtaStateDesign;
245
+ hover: CtaStateDesign;
246
+ }
247
+ export type GuardianRoundel = 'default' | 'brand' | 'inverse';
248
+ interface TickerDesign {
249
+ text: HexColour;
250
+ filledProgress: HexColour;
251
+ progressBarBackground: HexColour;
252
+ goalMarker: HexColour;
253
+ }
254
+ interface BannerDesignImage {
255
+ kind: 'Image';
256
+ mobileUrl: string;
257
+ tabletDesktopUrl: string;
258
+ wideUrl: string;
259
+ altText: string;
260
+ }
261
+ interface ChoiceCardsDesign {
262
+ kind: 'ChoiceCards';
263
+ buttonColour?: HexColour;
264
+ }
265
+ type Visual = BannerDesignImage | ChoiceCardsDesign;
266
+ export interface ConfigurableDesign {
267
+ visual?: Visual;
268
+ colours: {
269
+ basic: {
270
+ background: HexColour;
271
+ bodyText: HexColour;
272
+ headerText: HexColour;
273
+ articleCountText: HexColour;
274
+ };
275
+ highlightedText: {
276
+ text: HexColour;
277
+ highlight: HexColour;
278
+ };
279
+ primaryCta: CtaDesign;
280
+ secondaryCta: CtaDesign;
281
+ closeButton: CtaDesign;
282
+ guardianRoundel: GuardianRoundel;
283
+ ticker: TickerDesign;
284
+ };
285
+ }
286
+ export {};
287
+ //# sourceMappingURL=design.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"design.d.ts","sourceRoot":"","sources":["../../../../../../shared/src/types/props/design.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAazB,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;EAK1B,CAAC;AAiBH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASnC,CAAC;AAEH,KAAK,OAAO,GACN,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAC;AAEV,KAAK,QAAQ,GAAG,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC;AAEvC,MAAM,WAAW,SAAS;IACtB,CAAC,EAAE,QAAQ,CAAC;IACZ,CAAC,EAAE,QAAQ,CAAC;IACZ,CAAC,EAAE,QAAQ,CAAC;IACZ,IAAI,EAAE,KAAK,CAAC;CACf;AAED,eAAO,MAAM,iBAAiB,MAAO,SAAS,KAAG,MAA+B,CAAC;AAEjF,UAAU,cAAc;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,SAAS,CAAC;IACtB,MAAM,CAAC,EAAE,SAAS,CAAC;CACtB;AACD,MAAM,WAAW,SAAS;IACtB,OAAO,EAAE,cAAc,CAAC;IACxB,KAAK,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;AAE9D,UAAU,YAAY;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,cAAc,EAAE,SAAS,CAAC;IAC1B,qBAAqB,EAAE,SAAS,CAAC;IACjC,UAAU,EAAE,SAAS,CAAC;CACzB;AAED,UAAU,iBAAiB;IACvB,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,iBAAiB;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,YAAY,CAAC,EAAE,SAAS,CAAC;CAC5B;AACD,KAAK,MAAM,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAEpD,MAAM,WAAW,kBAAkB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACL,KAAK,EAAE;YACH,UAAU,EAAE,SAAS,CAAC;YACtB,QAAQ,EAAE,SAAS,CAAC;YACpB,UAAU,EAAE,SAAS,CAAC;YACtB,gBAAgB,EAAE,SAAS,CAAC;SAC/B,CAAC;QACF,eAAe,EAAE;YACb,IAAI,EAAE,SAAS,CAAC;YAChB,SAAS,EAAE,SAAS,CAAC;SACxB,CAAC;QACF,UAAU,EAAE,SAAS,CAAC;QACtB,YAAY,EAAE,SAAS,CAAC;QACxB,WAAW,EAAE,SAAS,CAAC;QACvB,eAAe,EAAE,eAAe,CAAC;QACjC,MAAM,EAAE,YAAY,CAAC;KACxB,CAAC;CACL"}