@guardian/support-dotcom-components 1.0.8 → 1.1.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.
- package/README.md +22 -6
- package/dist/shared/src/types/abTests/banner.d.ts +0 -2
- package/dist/shared/src/types/abTests/banner.d.ts.map +1 -1
- package/dist/shared/src/types/props/design.d.ts +5 -2
- package/dist/shared/src/types/props/design.d.ts.map +1 -1
- package/dist/shared/src/types/targeting/banner.d.ts +0 -1
- package/dist/shared/src/types/targeting/banner.d.ts.map +1 -1
- package/package.json +11 -10
package/README.md
CHANGED
|
@@ -2,14 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
A library for use by dotcom (frontend/DCR). This is for sharing logic and types with dotcom (frontend + dcr).
|
|
4
4
|
|
|
5
|
-
### Publishing
|
|
5
|
+
### Publishing to NPM
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Releasing to NPM is handled with [changesets] and is performed by CI.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
On your feature branch, before merging, run `yarn dotcom changeset` from the root of the project. This will
|
|
10
|
+
interactively ask you what kind of change this is (major, minor, patch) and
|
|
11
|
+
allow you to describe the change. Commit the generated changeset file to git and
|
|
12
|
+
push to your branch.
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
When you merge the branch, a version release PR will be automatically opened.
|
|
12
15
|
|
|
13
|
-
|
|
16
|
+
*IMPORTANT* - you now need push a commit to this branch which manually deletes the
|
|
17
|
+
changeset file(s) under `packages/dotcom/.changeset/`. These files are supposed to be deleted
|
|
18
|
+
automatically, but aren't, probably because of our yarn workspaces setup.
|
|
14
19
|
|
|
15
|
-
|
|
20
|
+
When this PR is merged, a new release will be pushed to NPM. The version change
|
|
21
|
+
will be based on the information in your changeset file. If the version release
|
|
22
|
+
PR isn't merged straight away, that's fine. Any other PRs with changesets merged
|
|
23
|
+
in the meantime will cause the release PR to be updated.
|
|
24
|
+
|
|
25
|
+
*Note* - currently the `Release` job in CI will show as failed because it tries to
|
|
26
|
+
publish the same version twice.
|
|
27
|
+
|
|
28
|
+
Not all PRs require releasing and therefore don't need a changeset. For example
|
|
29
|
+
a change to the README.
|
|
30
|
+
|
|
31
|
+
[changesets]: https://github.com/changesets/changesets
|
|
@@ -9,7 +9,6 @@ export declare enum BannerTemplate {
|
|
|
9
9
|
ContributionsBanner = "ContributionsBanner",
|
|
10
10
|
ContributionsBannerWithSignIn = "ContributionsBannerWithSignIn",
|
|
11
11
|
GuardianWeeklyBanner = "GuardianWeeklyBanner",
|
|
12
|
-
InvestigationsMomentBanner = "InvestigationsMomentBanner",
|
|
13
12
|
EnvironmentBanner = "EnvironmentBanner",
|
|
14
13
|
GlobalNewYearBanner = "GlobalNewYearBanner",
|
|
15
14
|
SignInPromptBanner = "SignInPromptBanner",
|
|
@@ -46,7 +45,6 @@ export interface BannerTest extends Test<BannerVariant> {
|
|
|
46
45
|
isHardcoded: boolean;
|
|
47
46
|
userCohort: UserCohort;
|
|
48
47
|
canRun?: CanRun;
|
|
49
|
-
minArticlesBeforeShowingBanner: number;
|
|
50
48
|
variants: BannerVariant[];
|
|
51
49
|
locations?: CountryGroupId[];
|
|
52
50
|
articlesViewedSettings?: ArticlesViewedSettings;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"banner.d.ts","sourceRoot":"","sources":["../../../../../../shared/src/types/abTests/banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC5F,OAAO,EACH,sBAAsB,EACtB,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,IAAI,EACJ,UAAU,EACV,UAAU,EACV,OAAO,EACV,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,oBAAY,cAAc;IACtB,0BAA0B,+BAA+B;IACzD,mBAAmB,wBAAwB;IAC3C,6BAA6B,kCAAkC;IAC/D,oBAAoB,yBAAyB;IAC7C,
|
|
1
|
+
{"version":3,"file":"banner.d.ts","sourceRoot":"","sources":["../../../../../../shared/src/types/abTests/banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC5F,OAAO,EACH,sBAAsB,EACtB,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,IAAI,EACJ,UAAU,EACV,UAAU,EACV,OAAO,EACV,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,oBAAY,cAAc;IACtB,0BAA0B,+BAA+B;IACzD,mBAAmB,wBAAwB;IAC3C,6BAA6B,kCAAkC;IAC/D,oBAAoB,yBAAyB;IAC7C,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAC3C,kBAAkB,uBAAuB;IACzC,mBAAmB,wBAAwB;IAC3C,0BAA0B,+BAA+B;IACzD,sBAAsB,2BAA2B;IACjD,+BAA+B,oCAAoC;IACnE,qBAAqB,0BAA0B;IAC/C,uBAAuB,4BAA4B;IACnD,uBAAuB,4BAA4B;CACtD;AAED,MAAM,WAAW,gBAAgB;IAC7B,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,KAAK,QAAQ,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAElD,wBAAgB,UAAU,CAAC,EAAE,EAAE,QAAQ,GAAG,EAAE,IAAI,gBAAgB,CAE/D;AAED,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,iBAAiB,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAChD,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,mBAAmB,CAAC,EAAE,aAAa,CAAC;IACpC,aAAa,EAAE,kBAAkB,CAAC;IAClC,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,MAAM,MAAM,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,KAAK,OAAO,CAAC;AAEzF,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;AAE9D,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,aAAa,CAAC;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yBAAyB,CAAC,EAAE,yBAAyB,CAAC;IACtD,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;CAC3C;AAGD,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,aAAa,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,eAAe,CAAC;CACrC;AAGD,MAAM,MAAM,qBAAqB,GAAG,IAAI,CACpC,aAAa,EACb,mBAAmB,GAAG,eAAe,GAAG,UAAU,CACrD,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa,CAAC,GAAG;IACjF,QAAQ,EAAE,qBAAqB,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAAC"}
|
|
@@ -251,13 +251,15 @@ interface TickerDesign {
|
|
|
251
251
|
progressBarBackground: HexColour;
|
|
252
252
|
goalMarker: HexColour;
|
|
253
253
|
}
|
|
254
|
-
interface
|
|
255
|
-
kind: 'Image';
|
|
254
|
+
export interface BannerDesignHeaderImage {
|
|
256
255
|
mobileUrl: string;
|
|
257
256
|
tabletDesktopUrl: string;
|
|
258
257
|
wideUrl: string;
|
|
259
258
|
altText: string;
|
|
260
259
|
}
|
|
260
|
+
export interface BannerDesignImage extends BannerDesignHeaderImage {
|
|
261
|
+
kind: 'Image';
|
|
262
|
+
}
|
|
261
263
|
interface ChoiceCardsDesign {
|
|
262
264
|
kind: 'ChoiceCards';
|
|
263
265
|
buttonColour?: HexColour;
|
|
@@ -265,6 +267,7 @@ interface ChoiceCardsDesign {
|
|
|
265
267
|
type Visual = BannerDesignImage | ChoiceCardsDesign;
|
|
266
268
|
export interface ConfigurableDesign {
|
|
267
269
|
visual?: Visual;
|
|
270
|
+
headerImage?: BannerDesignHeaderImage;
|
|
268
271
|
colours: {
|
|
269
272
|
basic: {
|
|
270
273
|
background: HexColour;
|
|
@@ -1 +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,
|
|
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,MAAM,WAAW,uBAAuB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAC9D,IAAI,EAAE,OAAO,CAAC;CACjB;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,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACtC,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"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"banner.d.ts","sourceRoot":"","sources":["../../../../../../shared/src/types/targeting/banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE5E,MAAM,MAAM,eAAe,GAAG;IAC1B,
|
|
1
|
+
{"version":3,"file":"banner.d.ts","sourceRoot":"","sources":["../../../../../../shared/src/types/targeting/banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE5E,MAAM,MAAM,eAAe,GAAG;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,EAAE,OAAO,CAAC;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,EAAE,OAAO,CAAC;IACpB,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IACxB,QAAQ,EAAE,YAAY,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;CAC9B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@guardian/support-dotcom-components",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.esm.js",
|
|
@@ -17,23 +17,24 @@
|
|
|
17
17
|
"publish": "yarn build && yarn types && npm publish"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
|
+
"jest": "^29.7.0",
|
|
21
|
+
"ts-jest": "^29.1.1",
|
|
22
|
+
"ts-loader": "^9.2.5",
|
|
23
|
+
"typescript": "~5.1.3",
|
|
20
24
|
"@babel/core": "^7.23.2",
|
|
21
25
|
"@babel/preset-env": "7.23.2",
|
|
22
|
-
"@rollup/plugin-alias": "^3.1.1",
|
|
23
|
-
"@rollup/plugin-babel": "^5.1.0",
|
|
24
|
-
"@rollup/plugin-commonjs": "^14.0.0",
|
|
25
|
-
"@rollup/plugin-node-resolve": "^8.4.0",
|
|
26
|
-
"@rollup/plugin-replace": "^2.3.3",
|
|
27
26
|
"babel-loader": "^9.1.3",
|
|
28
|
-
"jest": "^29.7.0",
|
|
29
27
|
"rollup": "^2.23.0",
|
|
30
28
|
"rollup-plugin-external-globals": "^0.5.0",
|
|
31
29
|
"rollup-plugin-filesize": "^9.0.2",
|
|
32
30
|
"rollup-plugin-peer-deps-external": "^2.2.3",
|
|
33
31
|
"rollup-plugin-terser": "^7.0.2",
|
|
34
|
-
"
|
|
35
|
-
"
|
|
36
|
-
"
|
|
32
|
+
"@rollup/plugin-alias": "^3.1.1",
|
|
33
|
+
"@rollup/plugin-babel": "^5.1.0",
|
|
34
|
+
"@rollup/plugin-commonjs": "^14.0.0",
|
|
35
|
+
"@rollup/plugin-node-resolve": "^8.4.0",
|
|
36
|
+
"@rollup/plugin-replace": "^2.3.3",
|
|
37
|
+
"@changesets/cli": "^2.26.2"
|
|
37
38
|
},
|
|
38
39
|
"dependencies": {}
|
|
39
40
|
}
|