Merge remote-tracking branch 'origin/main' into remove-e2e-tests-not-…

…required-label
wellcomecollection · Sep 17, 2024 · 8df4441 · 8df4441
2 parents c57be2a + 7416ffd
commit 8df4441
Show file tree

Hide file tree

Showing 219 changed files with 540 additions and 553 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -28,6 +28,10 @@ const sharedRules = {
   ],
   'react-hooks/rules-of-hooks': 'error',
   'prettier/prettier': 'error',
+  'no-restricted-imports': [
+    'error',
+    { patterns: ['../*'] }, // Should only import relatively from same directory
+  ],
   'no-restricted-syntax': [
     'error',
     "JSXElement.children > [expression.callee.property.name='stringify']",
@@ -42,6 +46,7 @@ module.exports = {
   },
   extends: sharedExtends,
   rules: sharedRules,
+  reportUnusedDisableDirectives: true,
   parserOptions: {
     ecmaFeatures: {
       jsx: true,
@@ -87,5 +92,13 @@ module.exports = {
         'react/prop-types': 'off',
       },
     },
+    // Some directories don't have an absolute import equivalent so ignoring
+    // import rules for them.
+    {
+      files: ['dash/**'],
+      rules: {
+        'no-restricted-imports': 'off',
+      },
+    },
   ],
 };
diff --git a/cardigan/stories/components/Cards/Cards.stories.tsx b/cardigan/stories/components/Cards/Cards.stories.tsx
@@ -108,7 +108,7 @@ export const guideStopCard = GuideStopCardTemplate.bind({});
 guideStopCard.args = {
   link: '/stop-1',
   totalStops: 3,
-  duration: 3.5,
+  duration: '03:30',
   number: 1,
   title: 'Exhibition guide stop',
   type: 'audio',

diff --git a/common/data/errors.tsx b/common/data/errors.tsx
@@ -1,6 +1,6 @@
 import { FunctionComponent } from 'react';
 import { prismicPageIds } from './hardcoded-ids';
-import Space from '../views/components/styled/Space';
+import Space from '@weco/common/views/components/styled/Space';
 import Layout, { gridSize8 } from '@weco/common/views/components/Layout';
 
 export const errorMessages = {

diff --git a/common/data/microcopy.tsx b/common/data/microcopy.tsx
@@ -10,7 +10,7 @@
 //      able to edit it themselves, using the GitHub web interface.
 //
 
-import { createScreenreaderLabel } from '../utils/telephone-numbers';
+import { createScreenreaderLabel } from '@weco/common/utils/telephone-numbers';
 
 export const pageDescriptions = {
   articles:

diff --git a/common/data/organization.ts b/common/data/organization.ts
@@ -1,5 +1,5 @@
-import { objToJsonLd } from '../utils/json-ld';
-import { Organization } from '../model/organization';
+import { objToJsonLd } from '@weco/common/utils/json-ld';
+import { Organization } from '@weco/common/model/organization';
 
 export const wellcomeCollectionAddress = {
   addressLocality: 'London',

diff --git a/common/model/opening-hours.ts b/common/model/opening-hours.ts
@@ -1,4 +1,4 @@
-import { DayOfWeek } from '../utils/format-date';
+import { DayOfWeek } from '@weco/common/utils/format-date';
 import { ImageType } from './image';
 
 export type OverrideType =

diff --git a/common/model/user.ts b/common/model/user.ts
@@ -8,7 +8,6 @@ export type UserInfo = {
 };
 
 // This is the type returned by the Auth0 profile endpoint
-/* eslint-disable camelcase */
 export type Auth0UserProfile = {
   sub: string;
   email: string;
@@ -21,7 +20,6 @@ export type Auth0UserProfile = {
   nickname: string;
   'https://wellcomecollection.org/patron_barcode': string;
 };
-/* eslint-enable camelcase */
 
 // Auth0 subject claims (aka user IDs) are prefixed with `auth0|`, plus
 // the `p` prefix for Sierra patrons.

diff --git a/common/prismicio-types.d.ts b/common/prismicio-types.d.ts
@@ -6405,14 +6405,14 @@ export interface GuideStopSliceDefaultPrimary {
   transcript: prismic.RichTextField;
 
   /**
-   * Audio duration (in minutes) field in *GuideStop → Primary*
+   * Audio duration (mm:ss) field in *GuideStop → Default → Primary*
    *
-   * - **Field Type**: Number
-   * - **Placeholder**: approximate time in minutes, e.g. 3.5
-   * - **API ID Path**: guide_stop.primary.audio_duration
-   * - **Documentation**: https://prismic.io/docs/field#number
+   * - **Field Type**: Text
+   * - **Placeholder**: e.g. 03:30
+   * - **API ID Path**: guide_stop.default.primary.audio_duration
+   * - **Documentation**: https://prismic.io/docs/field#key-text
    */
-  audio_duration: prismic.NumberField;
+  audio_duration: prismic.KeyTextField;
 
   /**
    * BSL video (Youtube) field in *GuideStop → Primary*
@@ -6435,14 +6435,14 @@ export interface GuideStopSliceDefaultPrimary {
   subtitles: prismic.RichTextField;
 
   /**
-   * Video duration (in minutes) field in *GuideStop → Primary*
+   * Video duration (mm:ss) field in *GuideStop → Default → Primary*
    *
-   * - **Field Type**: Number
-   * - **Placeholder**: approximate time in minutes, e.g. 3.5
-   * - **API ID Path**: guide_stop.primary.video_duration
-   * - **Documentation**: https://prismic.io/docs/field#number
+   * - **Field Type**: Text
+   * - **Placeholder**: e.g. 03:30
+   * - **API ID Path**: guide_stop.default.primary.video_duration
+   * - **Documentation**: https://prismic.io/docs/field#key-text
    */
-  video_duration: prismic.NumberField;
+  video_duration: prismic.KeyTextField;
 
   /**
    * Image field in *GuideStop → Primary*

diff --git a/common/server-data/__mocks__/index.ts b/common/server-data/__mocks__/index.ts
@@ -2,8 +2,8 @@ import {
   emptyGlobalAlert,
   emptyPopupDialog,
   emptyPrismicQuery,
-} from '../../services/prismic/documents';
-import { ServerData } from '../types';
+} from '@weco/common/services/prismic/documents';
+import { ServerData } from '@weco/common/server-data/types';
 import { CollectionVenueDocument as RawCollectionVenueDocument } from '@weco/common/prismicio-types';
 
 export async function init(): Promise<void> {

diff --git a/common/server-data/index.ts b/common/server-data/index.ts
@@ -18,7 +18,7 @@ import { promises as fs } from 'fs';
 import { GetServerSidePropsContext } from 'next';
 import togglesHandler, { getTogglesFromContext } from './toggles';
 import prismicHandler from './prismic';
-import { simplifyServerData } from '../services/prismic/transformers/server-data';
+import { simplifyServerData } from '@weco/common/services/prismic/transformers/server-data';
 import { SimplifiedServerData } from './types';
 import { getAllConsentStates } from '@weco/common/services/app/civic-uk';
 

diff --git a/common/server-data/prismic.ts b/common/server-data/prismic.ts
@@ -6,7 +6,7 @@ import {
 } from '@weco/common/prismicio-types';
 import { Handler } from './';
 import * as prismic from '@prismicio/client';
-import { InferDataInterface } from '../services/prismic/types';
+import { InferDataInterface } from '@weco/common/services/prismic/types';
 import { createClient as createPrismicClient } from '@weco/common/services/prismic/fetch';
 
 export type RawCollectionVenueDocumentLite = {

diff --git a/common/server-data/types.ts b/common/server-data/types.ts
@@ -3,7 +3,7 @@ import {
   defaultValue as prismicDefaultValue,
   PrismicData,
   SimplifiedPrismicData,
-} from '../server-data/prismic';
+} from '@weco/common/server-data/prismic';
 
 /**
  * The type is stored here rather than with the service because

diff --git a/common/services/app/usePrismicPreview.ts b/common/services/app/usePrismicPreview.ts
@@ -1,5 +1,8 @@
 import { useEffect } from 'react';
-import { PrismicData, SimplifiedPrismicData } from '../../server-data/prismic';
+import {
+  PrismicData,
+  SimplifiedPrismicData,
+} from '@weco/common/server-data/prismic';
 
 declare global {
   interface Window {

diff --git a/common/services/prismic/opening-times.ts b/common/services/prismic/opening-times.ts
@@ -1,4 +1,4 @@
-import { formatDayName } from '../../utils/format-date';
+import { formatDayName } from '@weco/common/utils/format-date';
 import {
   OverrideType,
   ExceptionalPeriod,
@@ -7,7 +7,7 @@ import {
   OpeningHoursDay,
   ExceptionalOpeningHoursDay,
   HasOverrideDate,
-} from '../../model/opening-hours';
+} from '@weco/common/model/opening-hours';
 import { isNotUndefined } from '@weco/common/utils/type-guards';
 import {
   addDays,
@@ -16,7 +16,7 @@ import {
   isSameDay,
   isSameDayOrBefore,
   today,
-} from '../../utils/dates';
+} from '@weco/common/utils/dates';
 
 const ONE_WEEK = 7;
 

diff --git a/common/services/prismic/transformers/collection-venues.ts b/common/services/prismic/transformers/collection-venues.ts
@@ -1,10 +1,13 @@
 import {
   ResultsLite,
   RawCollectionVenueDocumentLite,
-} from '../../../server-data/prismic';
+} from '@weco/common/server-data/prismic';
 import { DayOfWeek, formatTime } from '@weco/common/utils/format-date';
 import { Venue, OpeningHoursDay } from '@weco/common/model/opening-hours';
-import { DayField, ModifiedDayOpeningTime } from '../documents';
+import {
+  DayField,
+  ModifiedDayOpeningTime,
+} from '@weco/common/services/prismic/documents';
 import { isNotUndefined } from '@weco/common/utils/type-guards';
 import * as prismic from '@prismicio/client';
 import { transformImage } from './images';

diff --git a/common/services/prismic/transformers/images.ts b/common/services/prismic/transformers/images.ts
@@ -43,9 +43,8 @@ function transformFilledImage(image: prismic.FilledImageFieldImage): ImageType {
       acc[key] = image;
       return acc;
     }, {});
-  /* eslint-disable @typescript-eslint/no-non-null-assertion */
+
   const alt = image.alt!;
-  /* eslint-enable @typescript-eslint/no-non-null-assertion */
 
   const simpleCrops = Object.keys(crops)
     .filter(key => {

diff --git a/common/services/prismic/transformers/index.ts b/common/services/prismic/transformers/index.ts
@@ -1,11 +1,11 @@
-import { Tasl } from '../../../model/tasl';
-import { licenseTypeArray } from '../../../model/license';
-import linkResolver from '../link-resolver';
+import { Tasl } from '@weco/common/model/tasl';
+import { licenseTypeArray } from '@weco/common/model/license';
+import linkResolver from '@weco/common/services/prismic/link-resolver';
 import {
   isFilledLinkToDocument,
   isFilledLinkToMediaField,
   isFilledLinkToWebField,
-} from '../types';
+} from '@weco/common/services/prismic/types';
 import * as prismic from '@prismicio/client';
 
 export function transformTaslFromString(pipedString: string | null): Tasl {

diff --git a/common/services/prismic/transformers/server-data.ts b/common/services/prismic/transformers/server-data.ts
@@ -3,7 +3,7 @@ import {
   ServerData,
   SimplifiedServerData,
 } from '@weco/common/server-data/types';
-import { InferDataInterface } from '../types';
+import { InferDataInterface } from '@weco/common/services/prismic/types';
 import {
   PopupDialogDocument as RawPopupDialogDocument,
   GlobalAlertDocument as RawGlobalAlertDocument,

diff --git a/common/test/fixtures/identity/user.ts b/common/test/fixtures/identity/user.ts
@@ -1,5 +1,5 @@
-import { UserInfo, Auth0UserProfile } from '../../../model/user';
-import { RequestsList } from '../../../model/requesting';
+import { UserInfo, Auth0UserProfile } from '@weco/common/model/user';
+import { RequestsList } from '@weco/common/model/requesting';
 
 export const mockUser: UserInfo = {
   userId: '7654321',

diff --git a/common/test/fixtures/test-helpers.tsx b/common/test/fixtures/test-helpers.tsx
@@ -7,7 +7,7 @@ import {
   RenderOptions,
   MatcherFunction,
 } from '@testing-library/react';
-import theme from '../../views/themes/default';
+import theme from '@weco/common/views/themes/default';
 
 const ProvidersWrapper: FunctionComponent<PropsWithChildren> = ({
   children,

diff --git a/common/types/styled-components.d.ts b/common/types/styled-components.d.ts
@@ -3,6 +3,5 @@ import theme from '@weco/common/views/themes/default';
 type ThemeInterface = typeof theme;
 
 declare module 'styled-components' {
-  // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface DefaultTheme extends ThemeInterface {}
 }
diff --git a/common/utils/convert-url-to-string.ts b/common/utils/convert-url-to-string.ts
@@ -1,4 +1,4 @@
-import { Url } from '../model/link-props';
+import { Url } from '@weco/common/model/link-props';
 
 export default function convertUrlToString(url: Url): string {
   const { query = {} } = url;

diff --git a/common/utils/dates.ts b/common/utils/dates.ts
@@ -1,4 +1,4 @@
-import { DateRange } from '../model/date-range';
+import { DateRange } from '@weco/common/model/date-range';
 import { formatDayDate } from './format-date';
 
 /** Returns the current date/time.

diff --git a/common/utils/format-time.test.ts b/common/utils/format-time.test.ts
diff --git a/common/utils/format-time.ts b/common/utils/format-time.ts
diff --git a/common/utils/json-ld.ts b/common/utils/json-ld.ts
@@ -1,12 +1,12 @@
 import { convertImageUri } from './convert-image-uri';
-import { Organization } from '../model/organization';
-import { BreadcrumbItems } from '../model/breadcrumbs';
+import { Organization } from '@weco/common/model/organization';
+import { BreadcrumbItems } from '@weco/common/model/breadcrumbs';
 import { JsonLdObj } from '@weco/common/views/components/JsonLd/JsonLd';
 import type {
   OpeningHours,
   OpeningHoursDay,
   SpecialOpeningHours,
-} from '../model/opening-hours';
+} from '@weco/common/model/opening-hours';
 import { formatDate } from './format-date';
 
 type ObjToJsonLdProps = { type: string; root?: boolean };
@@ -83,9 +83,8 @@ function imageLd(image: Image) {
     image &&
     objToJsonLd(
       {
-        /* eslint-disable @typescript-eslint/no-non-null-assertion */
         url: convertImageUri((image.contentUrl || image.url)!, 1200),
-        /* eslint-enable @typescript-eslint/no-non-null-assertion */
+
         width: image.width,
         height: image.height,
       },

diff --git a/common/views/components/Buttons/Buttons.Dropdown.tsx b/common/views/components/Buttons/Buttons.Dropdown.tsx
@@ -17,7 +17,7 @@ import Button, { ButtonTypes } from '@weco/common/views/components/Buttons';
 import { AppContext } from '@weco/common/views/components/AppContext/AppContext';
 import { chevron, IconSvg } from '@weco/common/icons';
 import { themeValues } from '@weco/common/views/themes/config';
-import { BorderlessButton } from '../BorderlessClickable';
+import { BorderlessButton } from '@weco/common/views/components/BorderlessClickable';
 
 const DropdownWrapper = styled.div`
   display: inline-flex;

diff --git a/common/views/components/Buttons/Buttons.SolidLink.tsx b/common/views/components/Buttons/Buttons.SolidLink.tsx
@@ -2,7 +2,7 @@ import { FunctionComponent, SyntheticEvent } from 'react';
 import NextLink, { LinkProps } from 'next/link';
 import { classNames } from '@weco/common/utils/classnames';
 import Icon from '@weco/common/views/components/Icon/Icon';
-import ConditionalWrapper from '../ConditionalWrapper/ConditionalWrapper';
+import ConditionalWrapper from '@weco/common/views/components/ConditionalWrapper/ConditionalWrapper';
 import {
   BaseButtonInner,
   ButtonIconWrapper,

diff --git a/common/views/components/ErrorPage/ErrorPage.tsx b/common/views/components/ErrorPage/ErrorPage.tsx
@@ -12,13 +12,15 @@ import {
 import { headerBackgroundLs } from '@weco/common/utils/backgrounds';
 import { underConstruction } from '@weco/common/icons';
 import Icon from '@weco/common/views/components/Icon/Icon';
-import PageHeader, { headerSpaceSize } from '../PageHeader/PageHeader';
-import PageLayout from '../PageLayout/PageLayout';
-import SpacingSection from '../styled/SpacingSection';
-import SpacingComponent from '../styled/SpacingComponent';
+import PageHeader, {
+  headerSpaceSize,
+} from '@weco/common/views/components/PageHeader/PageHeader';
+import PageLayout from '@weco/common/views/components/PageLayout/PageLayout';
+import SpacingSection from '@weco/common/views/components/styled/SpacingSection';
+import SpacingComponent from '@weco/common/views/components/styled/SpacingComponent';
 import Space from '@weco/common/views/components/styled/Space';
 import { dangerouslyGetEnabledToggles } from '@weco/common/utils/cookies';
-import Layout, { gridSize8 } from '../Layout';
+import Layout, { gridSize8 } from '@weco/common/views/components/Layout';
 import togglesList from '@weco/toggles/toggles';
 
 const MessageBar = styled(Space).attrs({

diff --git a/common/views/components/Footer/index.tsx b/common/views/components/Footer/index.tsx
@@ -5,7 +5,7 @@ import styled from 'styled-components';
 import Space from '@weco/common/views/components/styled/Space';
 import OpeningTimes from '@weco/common/views/components/OpeningTimes/OpeningTimes';
 import Divider from '@weco/common/views/components/Divider/Divider';
-import FindUs from '../FindUs/FindUs';
+import FindUs from '@weco/common/views/components/FindUs/FindUs';
 import FooterNav from './Footer.Nav';
 import FooterSocial from './Footer.Social';
 import FooterWellcomeLogo from './Footer.WellcomeLogo';