@nnc-digital/nnc-design-system 1.0.0-beta2 → 1.0.0-beta21

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

@@ -1,282 +0,0 @@
-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;
-    /**
-     * The service website url title
-     */
-    websiteUrlTitle?: 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

@@ -1,8 +0,0 @@
-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;

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

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

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

@@ -1,4 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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

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

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

@@ -1,4 +0,0 @@
-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

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

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

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

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

@@ -1,4 +0,0 @@
-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

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

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

@@ -1,46 +0,0 @@
-export interface ServiceContactComponentProps {
-    /**
-     * The optional email address
-     */
-    email?: string;
-    /**
-     * 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.
-     */
-    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

@@ -1,4 +0,0 @@
-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

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

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

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

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

@@ -1,24 +0,0 @@
-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

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

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

@@ -1,120 +0,0 @@
-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

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

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

@@ -1,10 +0,0 @@
-/** 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

@@ -1,5 +0,0 @@
-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

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

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

@@ -1,2 +0,0 @@
-import React from 'react';
-export declare const DirectoryServicePage: React.FunctionComponent;

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

@@ -1,6 +0,0 @@
-import React from "react";
-export interface ErrorPageProps {
-    pageTitle: string;
-    errorCode: number;
-}
-export declare const ErrorPage: React.FC<ErrorPageProps>;

package/build/src/library/pages/Home/HomePage.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-import { HomePageProps } from './HomePage.types';
-/**
- * An example home page layout constructed from the structures and components defined in the
- * design system. The actual page layout is defined within the front end app and may be
- * out of step with this example.
- */
-export declare const HomePage: React.FunctionComponent<HomePageProps>;

package/build/src/library/pages/Home/HomePage.types.d.ts

@@ -1,60 +0,0 @@
-import React from 'react';
-import { HeroImageProp } from '../../structure/HomeHero/HomeHero.types';
-import { NewsArticleProps } from '../../structure/NewsArticleList/NewsArticleList.types';
-import { PromoBannerProps } from '../../structure/PromoBanner/PromoBanner.types';
-import { PromoProps } from '../../structure/PromoBlock/PromoBlock.types';
-import { PageLinkProp } from '../../structure/ServicesLinksList/ServicesLinksList.types';
-export interface HomePageProps {
-    /**
-     * The number of promotional tiles (0 to 4 supported)
-     */
-    numberOfPromos: number;
-    /**
-     * The number of news stories (0 to 9 supported)
-     */
-    numberOfNewsStories: number;
-    /**
-     * Title of the alert banner
-     */
-    alertBannerTitle: string;
-    /**
-     * Content of the alert banner
-     */
-    alertBannerContent: React.ReactNode;
-    /**
-     * Hero images
-     */
-    heroArray: Array<HeroImageProp>;
-    /**
-     * Promoted links
-     */
-    promotedLinksArray: Array<PageLinkProp>;
-    /**
-     * Service links
-     */
-    servicesArray: Array<PageLinkProp>;
-    /**
-     * Should the services list be boxed
-     */
-    isBoxed?: boolean;
-    /**
-     * News articles
-     */
-    newsArticlesArray: Array<NewsArticleProps>;
-    /**
-     * Promo banner
-     */
-    promoBannerData: PromoBannerProps;
-    /**
-     * Promo banner content (children)
-     */
-    promoBannerContent: React.ReactNode;
-    /**
-     * Promo blocks
-     */
-    promoBlocksArray: Array<PromoProps>;
-    /**
-     * Footer links
-     */
-    footerLinksArray: Array<PageLinkProp>;
-}

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

@@ -1,8 +0,0 @@
-import React from 'react';
-import { MemorialPageProps } from './MemorialPage.types';
-/**
- * An example memorialised home page layout constructed from the structures and components defined
- * in the design system. The actual page layout is defined within the front end app and may be
- * out of step with this example.
- */
-export declare const MemorialPage: React.FunctionComponent<MemorialPageProps>;