@nnc-digital/nnc-design-system 1.0.0-alpha9 → 1.0.0-beta10

package/build/library/structure/ServicesLinksList/ServicesLinksList.types.d.ts

@@ -1,68 +1,68 @@
-export interface ServicesLinksListProps {
-    /**
-     * An array of all the top level service landing pages
-     */
-    serviceLinksArray: Array<PageLinkProp>;
-    /**
-     * Display a white background on each block
-     */
-    hasBackground?: boolean;
-    /**
-     * Hide the header
-     */
-    hideHeader?: boolean;
-    /**
-     * Show everything in a single column
-     */
-    oneCol?: boolean;
-    /**
-     * Id of container
-     */
-    serviceId?: string;
-    /**
-     * Should the view be boxed
-     */
-    isBoxed?: boolean;
-}
-export interface PageLinkProp {
-    /**
-     * Title of the page
-     */
-    title: string;
-    /**
-     * URL of the page
-     */
-    url: string;
-    /**
-     * The key of the icon
-     */
-    iconKey?: string;
-    /**
-     * Array of quick links for the service
-     */
-    quickLinksArray?: Array<QuickLinkProp>;
-}
-export interface QuickLinkProp {
-    /**
-     * Title of the page
-     */
-    title: string;
-    /**
-     * URL of the page
-     */
-    url: string;
-}
-export interface MemorialQuickLinkProp {
-    /**
-     * The key of the icon
-     */
-    iconKey?: string;
-    /**
-     * An array of Quick Links
-     */
-    link: Array<QuickLinkProp>;
-    /**
-     * Some summary text
-     */
-    summary: string;
-}
+export interface ServicesLinksListProps {
+    /**
+     * An array of all the top level service landing pages
+     */
+    serviceLinksArray: Array<PageLinkProp>;
+    /**
+     * Display a white background on each block
+     */
+    hasBackground?: boolean;
+    /**
+     * Hide the header
+     */
+    hideHeader?: boolean;
+    /**
+     * Show everything in a single column
+     */
+    oneCol?: boolean;
+    /**
+     * Id of container
+     */
+    serviceId?: string;
+    /**
+     * Should the view be boxed
+     */
+    isBoxed?: boolean;
+}
+export interface PageLinkProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+    /**
+     * The key of the icon
+     */
+    iconKey?: string;
+    /**
+     * Array of quick links for the service
+     */
+    quickLinksArray?: Array<QuickLinkProp>;
+}
+export interface QuickLinkProp {
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * URL of the page
+     */
+    url: string;
+}
+export interface MemorialQuickLinkProp {
+    /**
+     * The key of the icon
+     */
+    iconKey?: string;
+    /**
+     * An array of Quick Links
+     */
+    link: Array<QuickLinkProp>;
+    /**
+     * Some summary text
+     */
+    summary: string;
+}

package/build/library/structure/SignpostLinks/SignpostLinks.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { SignpostLinksProps } from "./SignpostLinks.types";
-declare const SignpostLinks: React.FC<SignpostLinksProps>;
-export default SignpostLinks;
+import React from "react";
+import { SignpostLinksProps } from "./SignpostLinks.types";
+declare const SignpostLinks: React.FC<SignpostLinksProps>;
+export default SignpostLinks;

package/build/library/structure/SignpostLinks/SignpostLinks.types.d.ts

@@ -1,32 +1,32 @@
-export interface SignpostLinksProps {
-    /**
-     * Optional override for the top line of text
-     */
-    TopLineText?: string;
-    /**
-    * An array of the SignpostLinks
-    */
-    signpostLinksArray: Array<SignpostLinkProp>;
-    /**
-     * Optional, but recommended - a link to send the user to the other council's (West or North) specific service page, defaults to the homepage
-     */
-    otherCouncilLink?: string;
-}
-export interface SignpostLinkProp {
-    /**
-    * The number that represents the local area - based on the list of all local areas in alphabetical order
-    */
-    sovereignCode: number;
-    /**
-    * The name of the local area
-    */
-    areaName: string;
-    /**
-     * An optional override for the call to action text
-     */
-    cta_text?: string;
-    /**
-    * URL of this service on the local area's website
-    */
-    url: string;
-}
+export interface SignpostLinksProps {
+    /**
+     * Optional override for the top line of text
+     */
+    TopLineText?: string;
+    /**
+    * An array of the SignpostLinks
+    */
+    signpostLinksArray: Array<SignpostLinkProp>;
+    /**
+     * Optional, but recommended - a link to send the user to the other council's (West or North) specific service page, defaults to the homepage
+     */
+    otherCouncilLink?: string;
+}
+export interface SignpostLinkProp {
+    /**
+    * The number that represents the local area - based on the list of all local areas in alphabetical order
+    */
+    sovereignCode: number;
+    /**
+    * The name of the local area
+    */
+    areaName: string;
+    /**
+     * An optional override for the call to action text
+     */
+    cta_text?: string;
+    /**
+    * URL of this service on the local area's website
+    */
+    url: string;
+}

package/build/library/structure/SkipToMainContent/SkipToMainContent.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { SkipToMainContentProps } from "./SkipToMainContent.types";
-declare const SkipToMainContent: React.FC<SkipToMainContentProps>;
-export default SkipToMainContent;
+import React from "react";
+import { SkipToMainContentProps } from "./SkipToMainContent.types";
+declare const SkipToMainContent: React.FC<SkipToMainContentProps>;
+export default SkipToMainContent;

package/build/library/structure/SkipToMainContent/SkipToMainContent.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/library/structure/SkipToMainContent/SkipToMainContent.types.d.ts

@@ -1,2 +1,2 @@
-export interface SkipToMainContentProps {
-}
+export interface SkipToMainContentProps {
+}

package/build/library/structure/Summary/Summary.d.ts

@@ -1,4 +1,4 @@
-import React from 'react';
-import { SummaryProps } from './Summary.types';
-declare const Summary: React.FunctionComponent<SummaryProps>;
-export default Summary;
+import React from 'react';
+import { SummaryProps } from './Summary.types';
+declare const Summary: React.FunctionComponent<SummaryProps>;
+export default Summary;

package/build/library/structure/Summary/Summary.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/library/structure/Summary/Summary.types.d.ts

@@ -1,15 +1,15 @@
-import React from 'react';
-export interface SummaryProps {
-    /**
-     * Should the summary have padding
-     */
-    hasPadding?: boolean;
-    /**
-     * Should the summary have a background colour
-     */
-    hasBackground?: boolean;
-    /**
-     * The contents of the summary
-     */
-    children?: React.ReactNode;
-}
+import React from 'react';
+export interface SummaryProps {
+    /**
+     * Should the summary have padding
+     */
+    hasPadding?: boolean;
+    /**
+     * Should the summary have a background colour
+     */
+    hasBackground?: boolean;
+    /**
+     * The contents of the summary
+     */
+    children?: React.ReactNode;
+}

package/build/src/index.d.ts

@@ -26,11 +26,12 @@ import Image from './library/slices/Image/Image';
 import ImageAndText from './library/slices/ImageAndText/ImageAndText';
 import InquestSchedule from './library/slices/InquestSchedule/InquestSchedule';
 import Promotions from './library/slices/Promotions/Promotions';
+import RoadworksList from './library/slices/RoadworksList/RoadworksList';
 import SearchBox from './library/slices/SearchBox/SearchBox';
 import Video from './library/slices/Video/Video';
 import WarningText from './library/slices/WarningText/WarningText';
 import WarningTextDisclaimer from './library/slices/WarningTextDisclaimer/WarningTextDisclaimer';
-export { Accordion, BlockQuote, CallToAction, Cards, CouncilTaxAlphabeticalDirectory, Divider, DownloadableFiles, GoogleMap, Image, ImageAndText, InquestSchedule, Promotions, SearchBox, Video, WarningText, WarningTextDisclaimer, };
+export { Accordion, BlockQuote, CallToAction, Cards, CouncilTaxAlphabeticalDirectory, Divider, DownloadableFiles, GoogleMap, Image, ImageAndText, InquestSchedule, Promotions, RoadworksList, SearchBox, Video, WarningText, WarningTextDisclaimer, };
 export * from './library/structure/PageStructures';
 export { GDS_theme, north_theme, west_theme, lb_theme_north, lb_theme_west } from './themes/theme_generator';
 export { GlobalStyleReset } from './themes/GlobalStyleReset.jsx';

package/build/src/library/components/SummaryList/SummaryList.types.d.ts

@@ -8,6 +8,14 @@ export interface SummaryListProps {
      * Option to remove margin (default is true)
      */
     hasMargin?: boolean;
+    /**
+     * Option to show borders (default is true)
+     */
+    hasBorders?: boolean;
+    /**
+     * Optional heading for the summary list
+     */
+    heading?: string;
 }
 export interface SummaryRowProps {
     /**

package/build/src/library/directory/DirectoryAddToShortList/DirectoryAddToShortList.types.d.ts

@@ -1,3 +1,4 @@
+import { PhysicalAddressProps } from '../DirectoryService/DirectoryService.types';
 export interface DirectoryAddToShortListProps {
     /**
      * The unique identifier
@@ -23,4 +24,12 @@ export interface DirectoryAddToShortListProps {
      * The optional phone number
      */
     phone?: string;
+    /**
+     * The optional addresses
+     */
+    addresses?: PhysicalAddressProps[];
+    /**
+     * The optional fees for the service
+     */
+    fees?: string;
 }

package/build/src/library/directory/DirectoryDocumentList/DirectoryDocumentList.types.d.ts

@@ -46,6 +46,10 @@ export interface DirectoryDocumentListProps {
      * Is the data loading
      */
     isLoading: boolean;
+    /**
+     * Is the component in error state
+     */
+    isError?: boolean;
 }
 export interface DirectoryDocument {
     /**

package/build/src/library/directory/DirectoryService/DirectoryService.storydata.d.ts

@@ -2,3 +2,4 @@ import { DirectoryServiceProps, LocationProps } from './DirectoryService.types';
 export declare const ExampleService: DirectoryServiceProps;
 export declare const MultipleLocations: LocationProps[];
 export declare const OneVisitableLocation: LocationProps[];
+export declare const OneVisitableLocationNoLatLon: LocationProps[];

package/build/src/library/directory/DirectoryService/DirectoryService.types.d.ts

@@ -79,6 +79,10 @@ export interface DirectoryServiceProps {
      * The service website address
      */
     url?: string;
+    /**
+     * The service website url title
+     */
+    websiteUrlTitle?: string;
     /**
      * An optional array of files/links belonging to the service
      */

package/build/src/library/directory/DirectoryService/DirectoryServiceTransform.d.ts

@@ -5,4 +5,4 @@ export declare const transformLocation: (location: LocationProps) => SummaryRowP
 export declare const transformDescriptionDetails: (accreditations: string, fees: string, service_areas: ServiceAreaProps[], languages: LanguagesProps[], eligibilities: EligibilitiesProps[], ageInMonths?: boolean) => SummaryRowProps[];
 export declare const transformSnippet: (description: string, extractLength?: number) => string;
 export declare const transformTaxonomies: (service_taxonomys: ServiceTaxonomy[], taxonomiesToShow?: TaxonomyToShow[]) => SummaryRowProps[];
-export declare const transformAge: (age: number, ageInMonths?: boolean) => string | 0;
+export declare const transformAge: (age: number, ageInMonths?: boolean) => string;

package/build/src/library/directory/DirectoryService/DirectoryServiceTransform.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/library/directory/DirectoryServiceList/DirectoryServiceList.types.d.ts

@@ -25,6 +25,14 @@ export interface DirectoryServiceListProps {
      * Function prop passed in to handle updating search
      */
     setSearch: Dispatch<SetStateAction<string>>;
+    /**
+     * The optional proximity the postcode will search. Defaults to 2 miles.
+     */
+    proximity?: number;
+    /**
+     * Should the postcode search be shown? Defaults to true.
+     */
+    showPostcodeSearch?: boolean;
     /**
      * The postcode search term
      */
@@ -93,6 +101,10 @@ export interface DirectoryServiceListProps {
      * Does the directory have documents?
      */
     hasDocuments?: boolean;
+    /**
+     * Is the component in error state
+     */
+    isError?: boolean;
 }
 export interface DirectoryCategory {
     /**

package/build/src/library/directory/ServiceContact/ServiceContact.types.d.ts

@@ -7,6 +7,10 @@ export interface ServiceContactComponentProps {
      * The optional website address
      */
     website?: string;
+    /**
+     * The optional website title (if provided, used as link text)
+     */
+    websiteTitle?: string;
     /**
      * An array of service contacts. May be empty.
      */

package/build/src/library/events/Event/Event.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { EventProps } from './Event.types';
+declare const Event: React.FunctionComponent<EventProps>;
+export default Event;

package/build/src/library/events/Event/Event.storydata.d.ts

@@ -0,0 +1,4 @@
+import { EventProps } from './Event.types';
+export declare const ExampleEvent: EventProps;
+export declare const ExampleVirtualEvent: EventProps;
+export declare const ExampleEvents: EventProps[];

package/build/src/library/events/Event/Event.types.d.ts

@@ -0,0 +1,206 @@
+import React from 'react';
+import { FileDownloadProps } from '../../components/FileDownload/FileDownload.types';
+import { SocialProfile } from '../../directory/ServiceSocialLinks/ServiceSocialLinks.types';
+import { ServiceContactProps } from '../../directory/ServiceContact/ServiceContact.types';
+export interface EventProps {
+    /**
+     * The unique event id
+     */
+    id: string;
+    /**
+     * The event name/title
+     */
+    name: string;
+    /**
+     * The description as a plain HTML string
+     */
+    description: string;
+    /**
+     * The description as a react node
+     */
+    descriptionElement?: React.ReactNode;
+    /**
+     * The event start date and time in ISO format
+     */
+    startDateTime: string;
+    /**
+     * The event end date and time in ISO format
+     */
+    endDateTime?: string;
+    /**
+     * The event type/category
+     */
+    eventType?: string;
+    /**
+     * The target audience for the event
+     */
+    audience?: string[];
+    /**
+     * The organization hosting the event
+     */
+    organization: EventOrganizationProps;
+    /**
+     * Event location information
+     */
+    location?: EventLocationProps;
+    /**
+     * The optional service email address
+     */
+    email?: string;
+    /**
+     * The optional costs of the event
+     */
+    fees?: string;
+    /**
+     * The event website address
+     */
+    url?: string;
+    /**
+     * The event website url title
+     */
+    websiteUrlTitle?: string;
+    /**
+     * An array of contacts with phone numbers
+     */
+    contacts?: ServiceContactProps[];
+    /**
+     * An optional array of files/links belonging to the event
+     */
+    uploads?: FileDownloadProps[];
+    /**
+     * An optional array of social profile links
+     */
+    socialProfiles?: SocialProfile[];
+    /**
+     * When the event was updated. Expected format YYYY-MM-DD
+     */
+    updatedAt?: string;
+    /**
+     * The url to the shortlist
+     */
+    shortListPath?: string;
+    /**
+     * Is this event recurring?
+     */
+    isRecurring?: boolean;
+    /**
+     * Recurrence pattern information
+     */
+    recurrencePattern?: string;
+    /**
+     * Registration deadline
+     */
+    registrationDeadline?: string;
+    /**
+     * Maximum capacity for the event
+     */
+    capacity?: number;
+    /**
+     * Current number of registered attendees
+     */
+    currentAttendees?: number;
+}
+export interface EventOrganizationProps {
+    /**
+     * The unique identifier for the organization
+     */
+    id: string;
+    /**
+     * The name of the organization
+     */
+    name: string;
+    /**
+     * The description of the organization
+     */
+    description?: string;
+    /**
+     * The full path to the organization logo
+     */
+    logo?: string;
+    /**
+     * The organization website address
+     */
+    url?: string;
+}
+export interface EventLocationProps {
+    /**
+     * The unique identifier for the location
+     */
+    id: number;
+    /**
+     * The name of the location
+     */
+    name: string;
+    /**
+     * The optional description
+     */
+    description?: string;
+    /**
+     * Is the location visitable by the public?
+     */
+    isVisitable?: boolean;
+    /**
+     * The latitude of the location
+     */
+    latitude?: string;
+    /**
+     * The longitude of the location
+     */
+    longitude?: string;
+    /**
+     * The address information
+     */
+    address?: EventAddressProps;
+    /**
+     * An array of facilities that the location offers
+     */
+    accessibility?: EventAccessibilityProps[];
+    /**
+     * Is this a virtual/online event?
+     */
+    isVirtual?: boolean;
+    /**
+     * Virtual meeting link/information
+     */
+    virtualMeetingInfo?: string;
+}
+export interface EventAddressProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The street number and address line 1
+     */
+    address1: string;
+    /**
+     * Address line 2
+     */
+    address2?: string;
+    /**
+     * The city
+     */
+    city: string;
+    /**
+     * The county
+     */
+    county: string;
+    /**
+     * The postcode
+     */
+    postcode: string;
+    /**
+     * The country
+     */
+    country: string;
+}
+export interface EventAccessibilityProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The name of the facility offered by the location
+     */
+    accessibility: string;
+}

package/build/src/library/events/Event/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './Event';
+export * from './Event.types';
+export * from './Event.storydata';

package/build/src/library/events/EventList/EventList.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { EventListProps } from './EventList.types';
+declare const EventList: React.FunctionComponent<EventListProps>;
+export default EventList;

package/build/src/library/events/EventList/EventList.storydata.d.ts

@@ -0,0 +1,3 @@
+import { EventCategory } from './EventList.types';
+export declare const ExampleEventTypes: EventCategory[];
+export declare const ExampleAudiences: EventCategory[];