@newskit-render/core 2.13.2 → 2.16.0

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.16.0](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/core@2.16.0-alpha.0...@newskit-render/core@2.16.0) (2022-11-09)
+
+**Note:** Version bump only for package @newskit-render/core
+
+
+
+
+
+# [2.15.0](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/core@2.15.0-alpha.0...@newskit-render/core@2.15.0) (2022-11-04)
+
+**Note:** Version bump only for package @newskit-render/core
+
+
+
+
+
+# [2.14.0](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/core@2.14.0-alpha.0...@newskit-render/core@2.14.0) (2022-11-04)
+
+**Note:** Version bump only for package @newskit-render/core
+
+
+
+
+
 ## [2.13.2](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/core@2.13.2-alpha.0...@newskit-render/core@2.13.2) (2022-11-03)
 
 **Note:** Version bump only for package @newskit-render/core

package/README.md

@@ -22,6 +22,7 @@ or with npm
 ```
 npm start
 ```
+
 ## Rquired Environment Variables
 
 In order to run the application,we need the following required environment variables.
@@ -34,6 +35,7 @@ OKTA_CLIENT_SECRET=""
 OKTA_DOMAIN=""
 PUBLISHER=""
 ```
+
 ## Endpoints
 
 GET /api/recommendations - Returns a list on recommendations articles based on the recommendations slug.The recommendations slug is provided be the query param `articleId`.Also accepts a `userId` which allows us to fetch personalised recommendations.
@@ -139,8 +141,6 @@ export const themesMap = {
 }
 ```
 
-
-
 - `translationsMap` is used for re-mapping variables like site title, or any other string for each brand. Example:
 
 ```
@@ -153,11 +153,8 @@ export const timesStrings = {
 }
 ```
 
-
-
-- `themesMap` is used for mapping the theme for each brand. 
-Brand names live in the `PUBLISHER` object
-
+- `themesMap` is used for mapping the theme for each brand.
+  Brand names live in the `PUBLISHER` object
 
 In context folder `context/multi-tenancy`
 Add a multi-tenancy context that will keep the current tenant:
@@ -196,8 +193,7 @@ export const useMultiTenancy = () => useContext(MultiTenancyContext)
 export default MultiTenancyProvider
 ```
 
-
-Now you need to update `_app.js`. To pass the tenant to the app, you need to wrap it in `MultitenancyProvide`: 
+Now you need to update `_app.js`. To pass the tenant to the app, you need to wrap it in `MultitenancyProvide`:
 
 ```
 interface MyAppProps extends AppProps {
@@ -217,7 +213,6 @@ function MyApp({ Component, pageProps, tenant }: MyAppProps) {
 export default MyApp
 ```
 
-
 Then call the `getTenant()` helper function in `getInitialProps()`. This function extracts the brands' hostname ( domain name ) from the request headers and then we save the tenant in the context provider:
 
 ```
@@ -232,10 +227,9 @@ MyApp.getInitialProps = async ({ Component, ctx }: AppContextType) => {
 }
 ```
 
-
 ### How to set the theme for each tenant
 
-You can use the `useMultiTenancy` hook anywhere in the code to get the current tenant 
+You can use the `useMultiTenancy` hook anywhere in the code to get the current tenant
 
 In `context/app-context.js`:
 
@@ -277,4 +271,4 @@ code here
 
 This comment is to denote that the line or lines in between are effected by the running of the [@newskit-render/create-render-app package](https://github.com/newscorp-ghfb/ncu-newskit-render/tree/master/packages/create-render-app).
 
-If you our touching / modifiying code with these comments you need to be aware that you may affect the successful running of the [@newskit-render/create-render-app package](https://github.com/newscorp-ghfb/ncu-newskit-render/tree/master/packages/create-render-app).
+If you our touching / modifiying code with these comments you need to be aware that you may affect the successful running of the [@newskit-render/create-render-app package](https://github.com/newscorp-ghfb/ncu-newskit-render/tree/master/packages/create-render-app).

package/config/environment.ts

@@ -40,6 +40,7 @@ export const getSanitizedConfig = () => {
     algoliaAppId: process.env.ALGOLIA_APP_ID as string,
     algoliaApiKey: process.env.ALGOLIA_API_KEY as string,
     algoliaIndex: process.env.ALGOLIA_INDEX as string,
+    nodeEnviroment: process.env.NODE_ENV as string,
   }
 }
 
@@ -67,4 +68,5 @@ export const {
   algoliaAppId,
   algoliaApiKey,
   algoliaIndex,
+  nodeEnviroment,
 } = config

package/cypress/e2e/account/holiday-stop.spec.js

@@ -1,3 +1,5 @@
+import * as userHolidayStops from '../../fixtures/holiday-stops.json'
+
 describe('Book a holiday stop', () => {
   beforeEach(() => {
     cy.GetAcsSession()
@@ -17,22 +19,55 @@ describe('Book a holiday stop', () => {
   })
 })
 
-describe.skip(
-  'Upcoming holiday stops',
-  {
-    env: {
-      MAIN_COOKIE_NAME: 'acs_tnl',
-    },
-  },
-  () => {
-    beforeEach(() => {
-      cy.GetTnlAcsSession()
-      cy.mockConsentAndVisit('/account/holiday-stop/book')
-    })
+describe('Upcoming holiday stops', () => {
+  beforeEach(() => {
+    cy.mockConsent()
+  })
 
-    it('should navigate to the Upcoming holiday stops and display the list of upcoming holiday stops', () => {
-      cy.get('a[href="/account/holiday-stop/upcoming-holiday-stops"]').click()
-      cy.get('[data-testid="content-list"] > ul > li').should('have.length', 6)
+  it('should navigate to the Upcoming holiday stops and display the list of upcoming holiday stops', () => {
+    cy.visitAndOverrideNextData(
+      '/account/holiday-stop/book',
+      'props.pageProps.user.holidayStops',
+      userHolidayStops.holidayStops
+    )
+    cy.get('a[href="/account/holiday-stop/upcoming-holiday-stops"]').should(
+      'exist'
+    )
+    cy.visitAndOverrideNextData(
+      '/account/holiday-stop/upcoming-holiday-stops',
+      'props.pageProps.user.holidayStops',
+      userHolidayStops.holidayStops
+    )
+    cy.get('[data-testid="content-list"] > ul > li').should(
+      'have.length.of.at.least',
+      6
+    )
+  })
+})
+
+describe('Cancel holiday stop', () => {
+  beforeEach(() => {
+    cy.mockConsent()
+    cy.visitAndOverrideNextData(
+      '/account/holiday-stop/book',
+      'props.pageProps.user.holidayStops',
+      userHolidayStops.holidayStops
+    )
+  })
+
+  it('should show popup and cancel holiday stop', () => {
+    cy.intercept('POST', '/api/account/mutate', {
+      statusCode: 200,
+      body: { data: { deleteUserHolidayStop: { success: true } } },
     })
-  }
-)
+    cy.get('[data-testid="content-list"] > ul > li')
+      .eq(1)
+      .contains('Cancel')
+      .click()
+    cy.get('[data-testid="primary-button"]').click()
+    cy.contains(
+      '[data-testid="toast-container"]',
+      'Your holiday stop was successfully cancelled'
+    )
+  })
+})

package/cypress/fixtures/holiday-stops.json

@@ -0,0 +1,40 @@
+{
+  "holidayStops": [
+    {
+      "id": "a2U7Y000001r8c9UAA",
+      "startDate": "2022-10-10T00:00:00",
+      "endDate": "2022-11-11T00:00:00",
+      "status": "Requested"
+    },
+    {
+      "id": "a2U7Y000001sijmUAA",
+      "startDate": "2024-04-25T00:00:00",
+      "endDate": "2024-04-28T00:00:00",
+      "status": "Requested"
+    },
+    {
+      "id": "a2U7Y000001sijwUAA",
+      "startDate": "2024-06-25T00:00:00",
+      "endDate": "2024-06-28T00:00:00",
+      "status": "Requested"
+    },
+    {
+      "id": "a2U7Y000001sijXUAQ",
+      "startDate": "2024-01-25T00:00:00",
+      "endDate": "2024-01-28T00:00:00",
+      "status": "Requested"
+    },
+    {
+      "id": "a2U7Y000001sijcUAA",
+      "startDate": "2024-02-25T00:00:00",
+      "endDate": "2024-02-28T00:00:00",
+      "status": "Requested"
+    },
+    {
+      "id": "a2U7Y000001sijrUAA",
+      "startDate": "2024-05-25T00:00:00",
+      "endDate": "2024-05-28T00:00:00",
+      "status": "Requested"
+    }
+  ]
+}

package/cypress/support/commands.js

@@ -1,8 +1,8 @@
 //Note: Check periodically if these consent cookie values exprire
 import _ from 'lodash'
-import { 
-  nuktSPConsentValue, 
-  consentUUIDValue, 
+import {
+  nuktSPConsentValue,
+  consentUUIDValue,
   _sp_local_state,
   _sp_user_consent_7377,
   _sp_non_keyed_local_state,
@@ -10,8 +10,14 @@ import {
 
 const setConentLocalStorage = () => {
   localStorage.setItem('_sp_local_state', JSON.stringify(_sp_local_state))
-  localStorage.setItem('_sp_user_consent_7377', JSON.stringify(_sp_user_consent_7377))
-  localStorage.setItem('_sp_non_keyed_local_state', JSON.stringify(_sp_non_keyed_local_state))
+  localStorage.setItem(
+    '_sp_user_consent_7377',
+    JSON.stringify(_sp_user_consent_7377)
+  )
+  localStorage.setItem(
+    '_sp_non_keyed_local_state',
+    JSON.stringify(_sp_non_keyed_local_state)
+  )
 }
 
 Cypress.Commands.add('mockConsentAndVisit', (url) => {
@@ -87,7 +93,7 @@ Cypress.Commands.add('GetTnlAcsSession', (user = 'tnl') => {
     },
     body: {
       rememberMe: false,
-      gotoUrl: 'https://login.staging-thesun.co.uk/',
+      gotoUrl: 'https://login.staging-thetimes.co.uk/',
       sso: false,
       authCredentials: {
         username,

package/next.config.js

@@ -37,6 +37,14 @@ module.exports = withBundleAnalyzer(
           source: '/sitemap.xml',
           destination: '/api/sitemap',
         },
+        {
+          source: '/pages-sitemap.xml',
+          destination: '/api/pages-sitemap',
+        },
+        {
+          source: '/competitions-sitemap.xml',
+          destination: '/api/competitions-sitemap',
+        },
         {
           source: '/news-sitemap.xml',
           destination: '/api/news-sitemap',
@@ -45,6 +53,10 @@ module.exports = withBundleAnalyzer(
           source: '/feed',
           destination: '/api/feed',
         },
+        {
+          source: '/robots.txt',
+          destination: '/api/robots',
+        },
       ]
     },
   })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newskit-render/core",
-  "version": "2.13.2",
+  "version": "2.16.0",
   "description": "Newskit Render - Core package",
   "author": "",
   "license": "UNLICENSED",
@@ -40,13 +40,13 @@
     "@emotion/styled": "11.10.4",
     "@newskit-render/api": "^1.2.1",
     "@newskit-render/auth": "^1.1.1",
-    "@newskit-render/checkout": "^1.5.2",
+    "@newskit-render/checkout": "^1.5.3",
     "@newskit-render/feature-flags": "^1.2.0",
-    "@newskit-render/feed": "^1.1.1",
-    "@newskit-render/my-account": "^3.12.0",
-    "@newskit-render/shared-components": "^1.11.0",
-    "@newskit-render/standalone-components": "^1.9.0",
-    "@newskit-render/validation": "^1.2.1",
+    "@newskit-render/feed": "^1.2.0",
+    "@newskit-render/my-account": "^3.13.0",
+    "@newskit-render/shared-components": "^1.12.0",
+    "@newskit-render/standalone-components": "^1.9.1",
+    "@newskit-render/validation": "^1.3.0",
     "cross-fetch": "3.1.5",
     "graphql": "15.6.0",
     "lodash.get": "4.4.2",

package/pages/api/competitions-sitemap.ts

@@ -0,0 +1,20 @@
+import { NextApiRequest, NextApiResponse } from 'next'
+import { genericSitemap } from '@newskit-render/feed'
+import { Publisher } from '@newskit-render/api'
+import { getHost } from '@newskit-render/shared-components'
+import { publisher, sitemapPublicationName } from '../../config'
+/* We do not have sitemap date for Demo so using Virgin,
+ * This can be removed and replace with just - publisher: process.env.PUBLISHER as PublisherGroup, in created projects
+ */
+
+const handler = async (req: NextApiRequest, res: NextApiResponse) =>
+  genericSitemap({
+    res,
+    dataType: 'competitions',
+    publisher:
+      publisher === 'DEMO' ? Publisher.VIRGIN : (publisher as Publisher),
+    domain: new URL(getHost(req) as string).host,
+    publicationName: sitemapPublicationName as string,
+  })
+
+export default handler

package/pages/api/pages-sitemap.ts

@@ -0,0 +1,28 @@
+import { NextApiRequest, NextApiResponse } from 'next'
+import { genericSitemap, CustomStaticPage } from '@newskit-render/feed'
+import { Publisher } from '@newskit-render/api'
+import { getHost } from '@newskit-render/shared-components'
+import { publisher, sitemapPublicationName } from '../../config'
+/* We do not have sitemap date for Demo so using Virgin,
+ * This can be removed and replace with just - publisher: process.env.PUBLISHER as PublisherGroup, in created projects
+ */
+
+const defaultCustomStaticPagesCollection: CustomStaticPage[] = [
+  {
+    slug: 'test-custom-page',
+  },
+]
+const handler = async (req: NextApiRequest, res: NextApiResponse) =>
+  genericSitemap({
+    res,
+    dataType: 'pages',
+    publisher:
+      publisher === 'DEMO' ? Publisher.VIRGIN : (publisher as Publisher),
+    domain: new URL(getHost(req) as string).host,
+    publicationName: sitemapPublicationName as string,
+    customStaticPageCollection: defaultCustomStaticPagesCollection,
+    changefreq: 'hourly',
+    priority: '0.8',
+  })
+
+export default handler

package/pages/api/robots.ts

@@ -0,0 +1,19 @@
+import { NextApiRequest, NextApiResponse } from 'next'
+import { getHost } from '@newskit-render/shared-components'
+import { nodeEnviroment } from '../../config'
+
+export default function handler(req: NextApiRequest, res: NextApiResponse) {
+  const crawable =
+    nodeEnviroment === 'production' ? 'Disallow: /' : 'Disallow: /' // change to Allow when your ready for prod to be crawlable
+  const robots = `User-agent: *
+${crawable}
+Sitemap: ${new URL(getHost(req) as string)}sitemap.xml
+Sitemap: ${new URL(getHost(req) as string)}news-sitemap.xml
+Sitemap: ${new URL(getHost(req) as string)}pages-sitemap.xml
+Sitemap: ${new URL(getHost(req) as string)}competitions-sitemap.xml`
+
+  res.statusCode = 200
+  res.setHeader('Content-Type', 'text/plain')
+  res.write(robots)
+  res.end()
+}

package/pages/api/sitemap.ts

@@ -1,5 +1,5 @@
 import { NextApiRequest, NextApiResponse } from 'next'
-import { genericSitemap, CustomStaticPage } from '@newskit-render/feed'
+import { genericSitemap } from '@newskit-render/feed'
 import { Publisher } from '@newskit-render/api'
 import { getHost } from '@newskit-render/shared-components'
 import {
@@ -11,11 +11,6 @@ import {
  * This can be removed and replace with just - publisher: process.env.PUBLISHER as PublisherGroup, in created projects
  */
 
-const defaultCustomStaticPagesCollection: CustomStaticPage[] = [
-  {
-    channel: 'test-custom-page',
-  },
-]
 const handler = async (req: NextApiRequest, res: NextApiResponse) =>
   genericSitemap({
     res,
@@ -25,7 +20,6 @@ const handler = async (req: NextApiRequest, res: NextApiResponse) =>
     domain: new URL(getHost(req) as string).host,
     firstArticleDate: sitemapFirstPublicationDate as string,
     publicationName: sitemapPublicationName as string,
-    customStaticPageCollection: defaultCustomStaticPagesCollection,
   })
 
 export default handler

package/public/robots.txt

@@ -1,2 +0,0 @@
-User-agent: *
-Disallow: /