@nnc-digital/nnc-design-system 0.4.3

package/build/library/components/icons/services/Sports/IconHover.d.ts

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

package/build/library/components/icons/services/Valuation/Icon.d.ts

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

package/build/library/components/icons/services/Valuation/IconHover.d.ts

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

package/build/library/components/icons/services/Venue/Icon.d.ts

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

package/build/library/components/icons/services/Venue/IconHover.d.ts

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

package/build/library/components/icons/services/WasteChecklist/Icon.d.ts

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

package/build/library/components/icons/services/WasteChecklist/IconHover.d.ts

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

package/build/library/components/icons/services/WasteSorting/Icon.d.ts

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

package/build/library/components/icons/services/WasteSorting/IconHover.d.ts

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

package/build/library/components/logos/GDSLogo/logo.d.ts

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

package/build/library/components/logos/GDSLogo/logo.types.d.ts

@@ -0,0 +1,2 @@
+export interface LogoProps {
+}

package/build/library/components/logos/NorthColouredLogo/logo.d.ts

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

package/build/library/components/logos/NorthColouredLogo/logo.types.d.ts

@@ -0,0 +1,2 @@
+export interface LogoProps {
+}

package/build/library/components/logos/NorthWhiteLogo/logo.d.ts

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

package/build/library/components/logos/NorthWhiteLogo/logo.types.d.ts

@@ -0,0 +1,2 @@
+export interface LogoProps {
+}

package/build/library/components/logos/WestColouredLogo/logo.d.ts

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

package/build/library/components/logos/WestColouredLogo/logo.types.d.ts

@@ -0,0 +1,2 @@
+export interface LogoProps {
+}

package/build/library/components/logos/WestWhiteLogo/logo.d.ts

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

package/build/library/components/logos/WestWhiteLogo/logo.types.d.ts

@@ -0,0 +1,2 @@
+export interface LogoProps {
+}

package/build/library/contexts/DirectoryShortListProvider/DirectoryShortListProvider.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { DirectoryShortListContextType, DirectoryShortListProviderProps } from './DirectoryShortListProvider.types';
+export declare const DirectoryShortListProvider: React.FunctionComponent<DirectoryShortListProviderProps>;
+export declare const useDirectoryShortListContext: () => DirectoryShortListContextType;

package/build/library/contexts/DirectoryShortListProvider/DirectoryShortListProvider.types.d.ts

@@ -0,0 +1,41 @@
+import React, { SetStateAction, Dispatch } from 'react';
+export interface DirectoryShortListProviderProps {
+    /**
+     * The child components
+     */
+    children: React.ReactNode;
+}
+export interface DirectoryShortListContextType {
+    favourites?: {
+        favourites: ShortListProps[];
+        setFavourites: Dispatch<SetStateAction<ShortListProps[]>>;
+    };
+    toggleFavourites?: (id: string, name: string, snippet: string, email?: string, website?: string, phone?: string) => void;
+    isFavourite?: (id: string) => boolean;
+}
+export interface ShortListProps {
+    /**
+     * The unique id for the service
+     */
+    id: string;
+    /**
+     * The name of the service
+     */
+    name: string;
+    /**
+     * The optional description snippet
+     */
+    snippet?: string;
+    /**
+     * The optional email
+     */
+    email?: string;
+    /**
+     * The optional website
+     */
+    website?: string;
+    /**
+     * The optional phone number
+     */
+    phone?: string;
+}

package/build/library/contexts/PostCodeAddressProvider/PostCodeAddressProvider.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { PostcodeResultsProps } from '../../helpers/api-helpers';
+import { PostCodeAddressProviderProps, PostCodeAddressContextType } from './PostCodeAddressProvider.types';
+export declare const defaultResults: PostcodeResultsProps;
+export declare const PostCodeAddressProvider: React.FunctionComponent<PostCodeAddressProviderProps>;
+export declare const usePostcodeAddressContext: () => PostCodeAddressContextType;

package/build/library/contexts/PostCodeAddressProvider/PostCodeAddressProvider.types.d.ts

@@ -0,0 +1,18 @@
+import React, { SetStateAction, Dispatch } from 'react';
+import { PostcodeResultsProps } from '../../helpers/api-helpers';
+export interface PostCodeAddressProviderProps {
+    /**
+     * What is this?
+     */
+    children: React.ReactNode;
+}
+export interface PostCodeAddressContextType {
+    postcodeValue?: {
+        postcode: string;
+        setPostcode: Dispatch<SetStateAction<string>>;
+    };
+    resultsValue?: {
+        results?: PostcodeResultsProps;
+        setResults: Dispatch<SetStateAction<PostcodeResultsProps>>;
+    };
+}

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

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

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

@@ -0,0 +1,26 @@
+export interface DirectoryAddToShortListProps {
+    /**
+     * The unique identifier
+     */
+    id: string;
+    /**
+     * The service name
+     */
+    name: string;
+    /**
+     * A snippet from the service description
+     */
+    snippet: string;
+    /**
+     * The optional contact email address
+     */
+    email?: string;
+    /**
+     * The optional website address
+     */
+    website?: string;
+    /**
+     * The optional phone number
+     */
+    phone?: string;
+}

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

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

package/build/library/directory/DirectoryDocumentList/DirectoryDocumentList.storydata.d.ts

@@ -0,0 +1,4 @@
+import { DirectoryDocument, DirectoryDocumentListProps } from './DirectoryDocumentList.types';
+export declare const ExampleDirectoryDocument: DirectoryDocument;
+export declare const ExampleDirectoryLink: DirectoryDocument;
+export declare const ExampleDirectoryDocumentListProps: DirectoryDocumentListProps;

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

@@ -0,0 +1,63 @@
+import { Dispatch, SetStateAction } from 'react';
+import { DirectoryCategory } from '../DirectoryServiceList/DirectoryServiceList.types';
+import { FileDownloadProps } from '../../components/FileDownload/FileDownload.types';
+export interface DirectoryDocumentListProps {
+    /**
+     * The base url for the directory
+     */
+    directoryPath: string;
+    /**
+     * An array of documents
+     */
+    documents: DirectoryDocument[];
+    /**
+     * The search term string
+     */
+    search?: string;
+    /**
+     * Function prop passed in to handle updating search
+     */
+    setSearch: 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 filter categories
+     */
+    categories?: DirectoryCategory[];
+    /**
+     * Function prop passed in to handle updating categories
+     */
+    setCategories: Dispatch<SetStateAction<DirectoryCategory[]>>;
+    /**
+     * Is the data loading
+     */
+    isLoading: boolean;
+}
+export interface DirectoryDocument {
+    /**
+     * The unique identifier
+     */
+    id: string;
+    /**
+     * The description of the file
+     */
+    description: string;
+    /**
+     * The file properties
+     */
+    file: FileDownloadProps;
+}

package/build/library/directory/DirectoryMap/DirectoryMap.d.ts

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

package/build/library/directory/DirectoryMap/DirectoryMap.types.d.ts

@@ -0,0 +1,11 @@
+import { StaticMapProps } from '../../components/StaticMap/StaticMap.types';
+export interface DirectoryMapProps {
+    /**
+     * Allow overriding if cookies are allowed (for stories).
+     */
+    allowCookies?: boolean;
+    /**
+     * Map settings
+     */
+    mapProps: StaticMapProps;
+}

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

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

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

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

package/build/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/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/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/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[];