@nnc-digital/nnc-design-system 1.0.0-beta6 → 1.0.0-beta7

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[];

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

@@ -0,0 +1,152 @@
+import { Dispatch, SetStateAction } from 'react';
+import { EventProps } from '../Event/Event.types';
+export interface EventListProps {
+    /**
+     * The base url for the events directory
+     */
+    eventsPath: string;
+    /**
+     * The url to the shortlist
+     */
+    shortListPath: string;
+    /**
+     * An array of Events
+     */
+    events: EventProps[];
+    /**
+     * The search term string
+     */
+    search?: string;
+    /**
+     * 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
+     */
+    postcode?: string;
+    /**
+     * Function prop passed in to handle updating postcode
+     */
+    setPostcode: Dispatch<SetStateAction<string>>;
+    /**
+     * The total amount of results
+     */
+    totalResults?: number;
+    /**
+     * The current page number
+     */
+    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 event description extract
+     */
+    extractLength?: number;
+    /**
+     * The event type categories
+     */
+    eventTypes?: EventCategory[];
+    /**
+     * Function prop passed in to handle updating event types
+     */
+    setEventTypes: Dispatch<SetStateAction<EventCategory[]>>;
+    /**
+     * The audience categories
+     */
+    audiences?: EventCategory[];
+    /**
+     * Function prop passed in to handle updating audiences
+     */
+    setAudiences: Dispatch<SetStateAction<EventCategory[]>>;
+    /**
+     * The selected month filter (1-12)
+     */
+    selectedMonth?: number;
+    /**
+     * Function prop passed in to handle updating selected month
+     */
+    setSelectedMonth: Dispatch<SetStateAction<number | undefined>>;
+    /**
+     * The selected year filter
+     */
+    selectedYear?: number;
+    /**
+     * Function prop passed in to handle updating selected year
+     */
+    setSelectedYear: Dispatch<SetStateAction<number | 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;
+    /**
+     * Is the component in error state
+     */
+    isError?: boolean;
+    /**
+     * Should old events be hidden automatically? Defaults to true.
+     */
+    hideOldEvents?: boolean;
+}
+export interface EventCategory {
+    /**
+     * The category label
+     */
+    label: string;
+    /**
+     * The vocabulary name
+     */
+    vocabulary: string;
+    /**
+     * An array of taxonomies
+     */
+    options: EventTaxonomy[];
+    /**
+     * Should multiple options be allowed
+     */
+    singleSelection: boolean;
+}
+export interface EventTaxonomy {
+    /**
+     * Unique taxonomy identifier in curie format (e.g. eventType1)
+     */
+    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/events/EventList/index.d.ts

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

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

@@ -0,0 +1,5 @@
+export { default as Event } from './Event';
+export { default as EventList } from './EventList';
+export * from './Event/Event.types';
+export * from './EventList/EventList.types';
+export * from './utils';

package/build/src/library/events/utils/EventFilters.d.ts

@@ -0,0 +1,57 @@
+import { EventProps } from '../Event/Event.types';
+/**
+ * Filters out events that have already ended based on their end date/time
+ * @param events Array of events to filter
+ * @param hideOldEvents Whether to hide old events (defaults to true)
+ * @returns Filtered array of events
+ */
+export declare const filterOldEvents: (events: EventProps[], hideOldEvents?: boolean) => EventProps[];
+/**
+ * Filters events by month and year
+ * @param events Array of events to filter
+ * @param selectedMonth Month (1-12) or undefined for all months
+ * @param selectedYear Year or undefined for all years
+ * @returns Filtered array of events
+ */
+export declare const filterEventsByDate: (events: EventProps[], selectedMonth?: number, selectedYear?: number) => EventProps[];
+/**
+ * Filters events by event type
+ * @param events Array of events to filter
+ * @param selectedEventTypes Array of selected event type IDs
+ * @returns Filtered array of events
+ */
+export declare const filterEventsByType: (events: EventProps[], selectedEventTypes: string[]) => EventProps[];
+/**
+ * Filters events by audience
+ * @param events Array of events to filter
+ * @param selectedAudiences Array of selected audience IDs
+ * @returns Filtered array of events
+ */
+export declare const filterEventsByAudience: (events: EventProps[], selectedAudiences: string[]) => EventProps[];
+/**
+ * Filters events by search term (searches in name and description)
+ * @param events Array of events to filter
+ * @param searchTerm Search term to look for
+ * @returns Filtered array of events
+ */
+export declare const filterEventsBySearch: (events: EventProps[], searchTerm: string) => EventProps[];
+/**
+ * Sorts events by date (earliest first)
+ * @param events Array of events to sort
+ * @returns Sorted array of events
+ */
+export declare const sortEventsByDate: (events: EventProps[]) => EventProps[];
+/**
+ * Comprehensive filter function that applies all filters
+ * @param events Array of events to filter
+ * @param filters Object containing all filter criteria
+ * @returns Filtered and sorted array of events
+ */
+export declare const applyAllEventFilters: (events: EventProps[], filters: {
+    hideOldEvents?: boolean;
+    selectedMonth?: number;
+    selectedYear?: number;
+    selectedEventTypes?: string[];
+    selectedAudiences?: string[];
+    searchTerm?: string;
+}) => EventProps[];

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

@@ -0,0 +1 @@
+export * from './EventFilters';

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

@@ -0,0 +1,13 @@
+import React from 'react';
+import { EventProps } from '../../events/Event/Event.types';
+import { BreadcrumbProp } from '../../structure/Breadcrumbs/Breadcrumbs.types';
+interface EventPageProps {
+    event: EventProps;
+    breadcrumbs?: BreadcrumbProp[];
+    footerLinks?: Array<{
+        title: string;
+        url: string;
+    }>;
+}
+export declare const EventPage: React.FunctionComponent<EventPageProps>;
+export {};

package/build/src/library/pages/EventPage/index.d.ts

@@ -0,0 +1 @@
+export { EventPage } from './EventPage';

package/build/src/library/slices/RoadworksList/RoadworksList.types.d.ts

@@ -45,4 +45,8 @@ export interface Roadwork {
      * The responsible organisation
      */
     responsibility: string;
+    /**
+     * Optional URL link for more information about the roadworks
+     */
+    urlLinkAddress?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nnc-digital/nnc-design-system",
-  "version": "1.0.0-beta6",
+  "version": "1.0.0-beta7",
   "description": "Design system for West & North Northamptonshire Councils, two unitary councils encompassing Wellingborough, Corby, Daventry, East Northants, Kettering, Northampton, Northamptonshire County and South Northants.",
   "main": "build/index.js",
   "repository": {