@nnc-digital/nnc-design-system 1.0.0-alpha4 → 1.0.0-alpha40

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

@@ -1,41 +1,55 @@
-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;
-}
+import React, { SetStateAction, Dispatch } from 'react';
+import { PhysicalAddressProps } from '../../directory/DirectoryService/DirectoryService.types';
+export interface DirectoryShortListProviderProps {
+    /**
+     * The child components
+     */
+    children: React.ReactNode;
+    /**
+     * An optional shortlist key to store and get different directory favourites
+     */
+    shortlistKey?: string;
+}
+export interface DirectoryShortListContextType {
+    favourites?: {
+        favourites: ShortListProps[];
+        setFavourites: Dispatch<SetStateAction<ShortListProps[]>>;
+    };
+    toggleFavourites?: (id: string, name: string, snippet: string, email?: string, website?: string, phone?: string, addresses?: PhysicalAddressProps[], fees?: string) => void;
+    isFavourite?: (id: string) => boolean;
+    clearShortlist?: () => void;
+}
+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;
+    /**
+     * The optional addresses
+     */
+    addresses?: PhysicalAddressProps[];
+    /**
+     * The optional fees for the service
+     */
+    fees?: string;
+}

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

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

@@ -1,18 +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>>;
-    };
-}
+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

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

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

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

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

@@ -1,26 +1,35 @@
-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;
-}
+import { PhysicalAddressProps } from '../DirectoryService/DirectoryService.types';
+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;
+    /**
+     * The optional addresses
+     */
+    addresses?: PhysicalAddressProps[];
+    /**
+     * The optional fees for the service
+     */
+    fees?: string;
+}

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

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

@@ -1,4 +1,4 @@
-import { DirectoryDocument, DirectoryDocumentListProps } from './DirectoryDocumentList.types';
-export declare const ExampleDirectoryDocument: DirectoryDocument;
-export declare const ExampleDirectoryLink: DirectoryDocument;
-export declare const ExampleDirectoryDocumentListProps: DirectoryDocumentListProps;
+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.test.d.ts

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

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

@@ -1,63 +1,67 @@
-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;
-}
+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;
+    /**
+     * Is the component in error state
+     */
+    isError?: 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

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

@@ -1,11 +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;
-}
+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

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

@@ -1,4 +1,5 @@
-import { DirectoryServiceProps, LocationProps } from './DirectoryService.types';
-export declare const ExampleService: DirectoryServiceProps;
-export declare const MultipleLocations: LocationProps[];
-export declare const OneVisitableLocation: LocationProps[];
+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/library/directory/DirectoryService/DirectoryService.test.d.ts

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