@nnc-digital/nnc-design-system 0.4.38 → 1.0.0-alpha1

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

@@ -0,0 +1,278 @@
+import React from 'react';
+import { ServiceContactProps } from '../ServiceContact/ServiceContact.types';
+import { FileDownloadProps } from '../../components/FileDownload/FileDownload.types';
+import { SocialProfile } from '../ServiceSocialLinks/ServiceSocialLinks.types';
+export interface DirectoryServiceProps {
+    /**
+     * The unique service id
+     */
+    id: string;
+    /**
+     * The optional accreditations, such as Ofsted Grade
+     */
+    accreditations?: string;
+    /**
+     * Should the age be displayed in months?
+     */
+    ageInMonths?: boolean;
+    /**
+     * An array of contacts with phone numbers
+     */
+    contacts?: ServiceContactProps[];
+    /**
+     * The description as a plain HTML string
+     */
+    description: string;
+    /**
+     * The description as a react node
+     */
+    descriptionElement?: React.ReactNode;
+    /**
+     * The optional min and max ages
+     */
+    eligibilitys: EligibilitiesProps[];
+    /**
+     * The optional service email address
+     */
+    email?: string;
+    /**
+     * The optional costs of the service
+     */
+    fees?: string;
+    /**
+     * The optional additional languages
+     */
+    languages?: LanguagesProps[];
+    /**
+     * The service name
+     */
+    name: string;
+    /**
+     * The organization that the service belongs to
+     */
+    organization: OrganizationProps;
+    /**
+     * The optional opening times for the service
+     */
+    regular_schedules?: RegularScheduleProps[];
+    /**
+     * The service areas or locality the service operates in
+     */
+    service_areas: ServiceAreaProps[];
+    /**
+     * An optional array of locations, including addresses and facilities
+     */
+    service_at_locations?: LocationProps[];
+    /**
+     * An optional array of social profile links
+     */
+    service_social_profiles?: SocialProfile[];
+    /**
+     * The filters the service belongs to
+     */
+    service_taxonomys?: ServiceTaxonomy[];
+    /**
+     * Which taxonomies should be shown on the service page
+     */
+    taxonomiesToShow: TaxonomyToShow[];
+    /**
+     * The service website address
+     */
+    url?: string;
+    /**
+     * An optional array of files/links belonging to the service
+     */
+    uploads?: FileDownloadProps[];
+    /**
+     * When the service was updated. Expected format YYYY-MM-DD
+     */
+    updated_at?: string;
+    /**
+     * The url to the shortlist
+     */
+    shortListPath?: string;
+}
+export interface OrganizationProps {
+    /**
+     * The unique identifier for the service
+     */
+    id: string;
+    /**
+     * The description of the organization
+     */
+    description: string;
+    /**
+     * The full path to the organization logo
+     */
+    logo: string;
+    /**
+     * The name of the organization
+     */
+    name: string;
+    /**
+     * An optional uri
+     */
+    uri: string;
+    /**
+     * The organization website address
+     */
+    url: string;
+}
+export interface RegularScheduleProps {
+    /**
+     * The closing time in format HH:MM:SS
+     */
+    closes_at: string;
+    /**
+     * The opening time in format HH:MM:SS
+     */
+    opens_at: string;
+    /**
+     * The day of the week as text, e.g. 'Monday'
+     */
+    weekday: string;
+}
+export interface LocationProps {
+    /**
+     * The unique identifier for the location
+     */
+    id: number;
+    /**
+     * The name of the location, such as 'Head Office'
+     */
+    name: string;
+    /**
+     * The optional description
+     */
+    description: string;
+    /**
+     * Is the location visitable by the public?
+     */
+    is_visitable?: boolean;
+    /**
+     * The latitude of the location
+     */
+    latitude: string;
+    /**
+     * The longitude of the location
+     */
+    longitude: string;
+    /**
+     * An array of addresses for the location
+     */
+    physical_addresses: PhysicalAddressProps[];
+    /**
+     * An array of facilities that the location offers
+     */
+    accessibility_for_disabilities: AccessibilityForDisabilityProps[];
+}
+export interface PhysicalAddressProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The street number and address line 1
+     */
+    address_1: string;
+    /**
+     * The city
+     */
+    city: string;
+    /**
+     * The county
+     */
+    state_province: string;
+    /**
+     * The postcode
+     */
+    postal_code: string;
+    /**
+     * The country
+     */
+    country: string;
+}
+export interface AccessibilityForDisabilityProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The name of the facility offered by the location
+     */
+    accessibility: string;
+}
+export interface ServiceAreaProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * An optional extent string. Not used.
+     */
+    extent?: string | null;
+    /**
+     * The locality or service area name
+     */
+    service_area: string;
+    /**
+     * An optional uri. Not used.
+     */
+    uri?: string | null;
+}
+export interface EligibilitiesProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The eligibility name. Not used.
+     */
+    eligibility: string;
+    /**
+     * The minimum age as a number
+     */
+    minimum_age: number;
+    /**
+     * The maximum age as a number
+     */
+    maximum_age: number;
+}
+export interface LanguagesProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The additional language offered by the service
+     */
+    language: string;
+}
+export interface ServiceTaxonomy {
+    /**
+     * The unique identifier, in CURIE format. e.g. 'referralRoute:1'
+     */
+    id: string;
+    /**
+     * The name/label for the taxonomy
+     */
+    name: string;
+    /**
+     * The vocabulary in camelCase. e.g. 'referralRoute'
+     */
+    vocabulary: string;
+    /**
+     * An optional parent id. Not used.
+     */
+    parent?: string;
+}
+export interface TaxonomyToShow {
+    /**
+     * The camelCase vocabulary
+     */
+    vocabulary: string;
+    /**
+     * The label to present to the user for the taxonomy
+     */
+    label: string;
+}

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

@@ -0,0 +1,8 @@
+import { SummaryRowProps } from '../../components/SummaryList/SummaryList.types';
+import { EligibilitiesProps, LanguagesProps, LocationProps, ServiceAreaProps, ServiceTaxonomy, TaxonomyToShow } from './DirectoryService.types';
+export declare const transformService: (email: string, url: string, phone?: string) => SummaryRowProps[];
+export declare const transformLocation: (location: LocationProps) => SummaryRowProps[];
+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;

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

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

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

@@ -0,0 +1,6 @@
+import { DirectoryCategory } from './DirectoryServiceList.types';
+export declare const LocalOfferTaxonomy: DirectoryCategory;
+export declare const SpecialNeedTaxonomy: DirectoryCategory;
+export declare const ExampleFacilities: DirectoryCategory;
+export declare const ExampleLanguages: DirectoryCategory;
+export declare const ExampleDirectoryCategories: DirectoryCategory[];

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

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

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

@@ -0,0 +1,136 @@
+import { Dispatch, SetStateAction } from 'react';
+import { DirectoryServiceProps } from '../DirectoryService/DirectoryService.types';
+export interface DirectoryServiceListProps {
+    /**
+     * Are the ages in months? Defaults to false
+     */
+    ageInMonths?: boolean;
+    /**
+     * The base url for the directory
+     */
+    directoryPath: string;
+    /**
+     * The url to the shortlist
+     */
+    shortListPath: string;
+    /**
+     * An array of Directory Services
+     */
+    services: DirectoryServiceProps[];
+    /**
+     * The search term string
+     */
+    search?: string;
+    /**
+     * Function prop passed in to handle updating search
+     */
+    setSearch: Dispatch<SetStateAction<string>>;
+    /**
+     * The postcode search term
+     */
+    postcode?: string;
+    /**
+     * Function prop passed in to handle updating postcode
+     */
+    setPostcode: Dispatch<SetStateAction<string>>;
+    /**
+     * The total amount of results
+     */
+    totalResults?: number;
+    /**
+     * The total amount of pages
+     */
+    pageNumber?: number;
+    /**
+     * Function prop passed in to handle the update page number
+     */
+    setPageNumber: Dispatch<SetStateAction<number>>;
+    /**
+     * The number of results per page
+     */
+    perPage?: number;
+    /**
+     * The max length of each service description extract
+     */
+    extractLength?: number;
+    /**
+     * The filter categories
+     */
+    categories?: DirectoryCategory[];
+    /**
+     * Function prop passed in to handle updating categories
+     */
+    setCategories: Dispatch<SetStateAction<DirectoryCategory[]>>;
+    /**
+     * The minimum age filter
+     */
+    minimumAge?: number | string;
+    /**
+     * Function prop passed in to handle updating minimumAge
+     */
+    setMinimumAge: Dispatch<SetStateAction<number | string | undefined>>;
+    /**
+     * The maximum age filter
+     */
+    maximumAge?: number | string;
+    /**
+     * Function prop passed in to handle updating maximumAge
+     */
+    setMaximumAge: Dispatch<SetStateAction<number | string | undefined>>;
+    /**
+     *  Where to centre the map, in the format 'lat,lng'
+     */
+    mapCenter?: string;
+    /**
+     * The optional zoom level, between 1 and 20. 1 = world, 20 = buildings
+     */
+    mapZoom?: number;
+    /**
+     * Is the data loading
+     */
+    isLoading: boolean;
+    /**
+     * Does the directory have documents?
+     */
+    hasDocuments?: boolean;
+}
+export interface DirectoryCategory {
+    /**
+     * The category label
+     */
+    label: string;
+    /**
+     * The vocabulary name
+     */
+    vocabulary: string;
+    /**
+     * An array of taxonomies
+     */
+    options: DirectoryTaxonomy[];
+    /**
+     * Should multiple options be allowed
+     */
+    singleSelection: boolean;
+}
+export interface DirectoryTaxonomy {
+    /**
+     * Unique taxonomy identifier in curie format (e.g. localOffer1)
+     */
+    id: string;
+    /**
+     * The name of the taxonomy
+     */
+    name: string;
+    /**
+     * The vocabulary name
+     */
+    vocabulary: string;
+    /**
+     * The optional parent taxonomy
+     */
+    parent?: string | null;
+    /**
+     * Is the option checked
+     */
+    checked: boolean;
+}

package/build/src/library/directory/DirectoryShortList/DirectoryShortList.d.ts

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

package/build/src/library/directory/DirectoryShortList/DirectoryShortList.test.d.ts

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

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

@@ -0,0 +1,6 @@
+export interface DirectoryShortListProps {
+    /**
+     * The path of the directory
+     */
+    directoryPath: string;
+}

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

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

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

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

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

@@ -0,0 +1,42 @@
+export interface ServiceContactComponentProps {
+    /**
+     * The optional email address
+     */
+    email?: string;
+    /**
+     * The optional website address
+     */
+    website?: string;
+    /**
+     * An array of service contacts. May be empty.
+     */
+    contacts: ServiceContactProps[];
+}
+export interface ServiceContactProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The name of the contact
+     */
+    name: string;
+    /**
+     * The job title of the contact
+     */
+    title: string;
+    /**
+     * The array of phone numbers
+     */
+    phones: PhoneProps[];
+}
+export interface PhoneProps {
+    /**
+     * The unique identifier
+     */
+    id: number;
+    /**
+     * The telephone number
+     */
+    number: string;
+}

package/build/src/library/directory/ServiceSocialLinks/ServiceSocialLinks.d.ts

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

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

@@ -0,0 +1,2 @@
+import { ServiceSocialLinksProps } from './ServiceSocialLinks.types';
+export declare const ExampleSocialProfiles: ServiceSocialLinksProps;

package/build/src/library/directory/ServiceSocialLinks/ServiceSocialLinks.test.d.ts

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

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

@@ -0,0 +1,24 @@
+export interface ServiceSocialLinksProps {
+    /**
+     * An array of social links
+     */
+    profiles?: SocialProfile[];
+}
+export interface SocialProfile {
+    /**
+     * The id for the social profile
+     */
+    id: number;
+    /**
+     * The profile name
+     */
+    name: string;
+    /**
+     * The link to the profile
+     */
+    link: string;
+    /**
+     * The social network name
+     */
+    social_network: 'facebook' | 'instagram' | 'linkedin' | 'twitter' | 'youtube';
+}

package/build/src/library/helpers/UseLocalStorage.d.ts

@@ -0,0 +1,2 @@
+declare const useLocalStorage: (key: any, initialValue: any) => any[];
+export default useLocalStorage;

package/build/src/library/helpers/api-helpers.d.ts

@@ -0,0 +1,120 @@
+export declare const PostcodeSearchApiUrl: string;
+export interface PostcodeResultsProps {
+    /**
+     * An array of addresses
+     */
+    addresses: AddressProps[];
+    /**
+     * The postcode searched for
+     */
+    postcode: string;
+    /**
+     * Quantity of records in this payload
+     */
+    records_in_payload: number;
+    /**
+     * The requested page
+     */
+    requested_page: number;
+    /**
+     * The total number of pages
+     */
+    total_pages: number;
+    /**
+     * The total number of records
+     */
+    total_records: number;
+    /**
+     * An array of sovereigns
+     */
+    sovereigns: SovereignProps[];
+    /**
+     * An array of Unitaries
+     */
+    unitaries: UnitaryProps[];
+}
+export interface SovereignProps {
+    /**
+     * The sovereign name
+     */
+    name: string;
+    /**
+     * The optional website
+     */
+    website?: string;
+}
+export interface UnitaryProps {
+    /**
+     * The Unitary council name
+     */
+    name: string;
+}
+export interface AddressProps {
+    /**
+     * Council tax bands
+     */
+    bands: CouncilTaxBands;
+    /**
+     * The address as a one line string
+     */
+    single_line_address: string;
+    /**
+     * Latitude of the address
+     */
+    latitude: string;
+    /**
+     * Longitude of the address
+     */
+    longitude: string;
+    /**
+     * The parish
+     */
+    parish: string;
+    /**
+     * The polling district
+     */
+    polling_district: string;
+    /**
+     * The postcode
+     */
+    postcode: string;
+    /**
+     * The postcode without spaces
+     */
+    postcodens: string;
+    /**
+     * The sovereign council name
+     */
+    sovereign: string;
+    /**
+     * The unitary council name
+     */
+    unitary: string;
+    /**
+     * The Unique Property Reference Number
+     */
+    uprn: string;
+    /**
+     * The ward
+     */
+    ward: string;
+    /**
+     * The website url
+     */
+    website_url: string;
+}
+export interface AddressesProps {
+    title: string;
+    value: string;
+    extra?: AddressProps;
+}
+export interface CouncilTaxBands {
+    a: string;
+    b: string;
+    c: string;
+    d: string;
+    e: string;
+    f: string;
+    g: string;
+    h: string;
+}

package/build/src/library/pages/ContentPage/ContentPage.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export interface ContentPageProps {
+}
+export declare const ContentPage: React.FunctionComponent<ContentPageProps>;

package/build/src/library/pages/ContentPage/ContentPage.storydata.d.ts

@@ -0,0 +1,10 @@
+/** Example story data for Content Page example */
+export declare const smallTable: {
+    caption: string;
+    headings: string[];
+    data: string[][];
+};
+export declare const largeTable: {
+    caption: string;
+    headings: string[];
+};

package/build/src/library/pages/CouncilTaxPageExample/CouncilTaxPageExample.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export interface CouncilTaxPageExampleProps {
+    version: string;
+}
+export declare const CouncilTaxPageExample: React.FC<CouncilTaxPageExampleProps>;

package/build/src/library/pages/CouncilTaxParishPageExample/CouncilTaxParishPageExample.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export interface CouncilTaxParishPageExampleProps {
+    version: string;
+}
+export declare const CouncilTaxParishPageExample: React.FC<CouncilTaxParishPageExampleProps>;