@communitiesuk/svelte-component-library 0.1.17 → 0.2.0-alpha.2

package/dist/utils/area-search/geoConfig.js

@@ -0,0 +1,291 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+// @ts-nocheck
+export const geoNames = {
+    W04: { label: 'community', plural: 'communities', childGroup: true },
+    E06: { label: 'unitary authority', plural: 'unitary authorities' },
+    W06: { label: 'unitary authority', plural: 'unitary authorities', childGroup: true },
+    E07: {
+        label: 'non-metropolitan district',
+        plural: 'non-metropolitan districts',
+        childGroup: true
+    },
+    E08: { label: 'metropolitan district', plural: 'metropolitan districts' },
+    E09: { label: 'borough', plural: 'boroughs', childGroup: true },
+    E10: { label: 'county', plural: 'counties' },
+    E11: { label: 'metropolitan county', plural: 'metropolital counties' },
+    S12: { label: 'council area', plural: 'council areas', childGroup: true },
+    N09: {
+        label: 'local government district',
+        plural: 'local government districts',
+        childGroup: true
+    }
+};
+export const sources = [
+    { id: 'uk', type: 'geojson' },
+    { id: 'ctry', type: 'geojson' },
+    { id: 'rgn', type: 'geojson' },
+    {
+        id: 'la',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2024/authorities-all/v1/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'boundaries',
+        minzoom: 4
+    },
+    {
+        id: 'wpc',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2024/wpc/v1/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'boundaries',
+        minzoom: 4
+    },
+    {
+        id: 'sener',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2022/sen/v1/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'region'
+    },
+    {
+        id: 'senc',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2022/sen/v1/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'constituency'
+    },
+    {
+        id: 'wd',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2024/wd/v1/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'boundaries',
+        minzoom: 6
+    },
+    {
+        id: 'par',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2022/par/v1/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'par',
+        minzoom: 6
+    },
+    {
+        id: 'msoa',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2021/msoa/v2/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'msoa',
+        minzoom: 6
+    },
+    {
+        id: 'lsoa',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2021/lsoa/v2/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'lsoa',
+        minzoom: 7
+    },
+    {
+        id: 'oa',
+        type: 'vector',
+        url: 'https://cdn.ons.gov.uk/maptiles/administrative/2021/oa/v2/boundaries/{z}/{x}/{y}.pbf',
+        layer: 'oa',
+        minzoom: 8
+    }
+];
+const notInTypes = (cds) => cds.map((cd) => ['!', ['in', cd, ['get', 'areacd']]]);
+export const geoTypes = [
+    {
+        key: 'uk',
+        codes: ['K02'],
+        source: 'uk',
+        label: 'United Kingdom',
+        plural: 'United Kingdom',
+        index: true
+    },
+    {
+        key: 'ctry',
+        alt: 'country',
+        codes: ['E92', 'S92', 'N92', 'W92'],
+        pcio: 'country',
+        label: 'country',
+        plural: 'countries',
+        source: 'ctry',
+        index: true,
+        ess: true
+    },
+    {
+        key: 'rgn',
+        alt: 'region',
+        codes: ['E12'],
+        pcio: 'region',
+        label: 'region',
+        plural: 'regions',
+        source: 'rgn',
+        index: true,
+        ess: true
+    },
+    {
+        key: 'cauth',
+        alt: 'combined',
+        codes: ['E06', 'E09', 'E10', 'E47', 'N09', 'S12', 'W06'],
+        label: 'upper-tier/combined authority',
+        plural: 'upper-tier/combined authorities',
+        source: 'la',
+        filter: ['all', ...notInTypes(['E07', 'E08']), ['!', ['==', ['get', 'cauth'], 'true']]],
+        index: true,
+        ess: true
+    },
+    {
+        key: 'utla',
+        alt: 'upper',
+        codes: ['E06', 'E08', 'E09', 'E10', 'N09', 'S12', 'W06'],
+        pcio: 'admin_county',
+        label: 'upper-tier/unitary authority',
+        plural: 'upper-tier/unitary authorities',
+        source: 'la',
+        filter: ['all', ...notInTypes(['E07', 'E47'])],
+        index: true,
+        ess: true
+    },
+    {
+        key: 'ltla',
+        alt: 'lower',
+        codes: ['E06', 'E07', 'E08', 'E09', 'N09', 'S12', 'W06'],
+        pcio: 'admin_district',
+        label: 'lower-tier/unitary authority',
+        plural: 'lower-tier/unitary authorities',
+        source: 'la',
+        filter: ['all', ...notInTypes(['E10', 'E47'])],
+        index: true,
+        ess: true
+    },
+    {
+        key: 'wpc',
+        codes: ['E14', 'N05', 'N06', 'S14', 'W07'],
+        pcio: 'parliamentary_constituency',
+        label: 'parliamentary constituency',
+        plural: 'parliamentary constituencies',
+        source: 'wpc',
+        index: true
+    },
+    {
+        key: 'sener',
+        codes: ['W10'],
+        label: 'Senedd electoral region',
+        plural: 'Senedd electoral regions',
+        source: 'sener',
+        index: true
+    },
+    {
+        key: 'senc',
+        codes: ['W09'],
+        label: 'Senedd constituency',
+        plural: 'Senedd constituencies',
+        source: 'senc',
+        index: true
+    },
+    {
+        key: 'wd',
+        codes: ['E05', 'W05'],
+        pcio: 'admin_ward',
+        label: 'ward',
+        plural: 'wards',
+        source: 'wd'
+    },
+    {
+        key: 'par',
+        codes: ['E04', 'W04'],
+        pcio: 'parish',
+        label: 'parish',
+        plural: 'parishes',
+        source: 'par'
+    },
+    {
+        key: 'msoa',
+        codes: ['E02', 'W02'],
+        pcio: 'msoa',
+        label: 'MSOA',
+        plural: 'MSOAs',
+        source: 'msoa'
+    },
+    {
+        key: 'lsoa',
+        codes: ['E01', 'W01'],
+        pcio: 'lsoa',
+        label: 'LSOA',
+        plural: 'LSOAs',
+        source: 'lsoa'
+    },
+    {
+        key: 'oa',
+        codes: ['E00', 'W00'],
+        label: 'output area',
+        plural: 'output areas',
+        source: 'oa'
+    }
+];
+export const geoTypeMap = (() => {
+    const map = {};
+    geoTypes.filter((s) => s.alt).forEach((s) => (map[s.alt] = s.key));
+    return map;
+})();
+export const oldGeoCodesLookup = {
+    E06000048: 'E06000057',
+    E08000020: 'E08000037',
+    E07000097: 'E07000242',
+    E07000100: 'E07000240',
+    E07000101: 'E07000243',
+    E07000104: 'E07000241'
+};
+export const noIndex = Array.from(new Set(geoTypes
+    .filter((t) => !t.index)
+    .map((t) => t.codes)
+    .flat()));
+export const essGeocodes = Array.from(new Set(geoTypes
+    .filter((t) => t.ess)
+    .map((t) => t.codes)
+    .flat()));
+export const mapSources = sources.map((s) => {
+    return {
+        ...s,
+        layers: geoTypes.filter((l) => l.source === s.id)
+    };
+});
+export const geoCodesLookup = (() => {
+    const lkp = {};
+    for (const g of geoTypes) {
+        for (const c of g.codes) {
+            lkp[c] = { ...g };
+            const geoName = geoNames[c];
+            if (geoName?.childGroup) {
+                lkp[c].label = geoName.label;
+                lkp[c].plural = geoName.plural;
+            }
+        }
+    }
+    return lkp;
+})();
+export const geoTypesLookup = (() => {
+    const lkp = {};
+    for (const g of geoTypes)
+        lkp[g.key] = g;
+    return lkp;
+})();
+export const countryLookup = {
+    E92000001: 'England',
+    N92000002: 'Northern Ireland',
+    S92000003: 'Scotland',
+    W92000004: 'Wales'
+};
+export const regionLookup = {
+    E12000001: 'North East',
+    E12000002: 'North West',
+    E12000003: 'Yorkshire and The Humber',
+    E12000004: 'East Midlands',
+    E12000005: 'West Midlands',
+    E12000006: 'East of England',
+    E12000007: 'London',
+    E12000008: 'South East',
+    E12000009: 'South West',
+    ...countryLookup
+};
+export const regionReverseLookup = (() => {
+    const lkp = {};
+    for (const key of Object.keys(regionLookup))
+        lkp[regionLookup[key]] = key;
+    return lkp;
+})();

package/dist/utils/cookiesNavigation.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Navigate to cookies page while preserving current URL
+ *
+ * This function handles navigation to the cookies page while preserving the current URL
+ * in sessionStorage for potential return navigation. In demo mode, it prevents navigation
+ * to avoid disrupting the demo experience.
+ *
+ * @param event - The navigation event (typically a click event from a link)
+ * @param demoMode - Whether the component is in demo mode (defaults to false)
+ *                   When true, prevents navigation and calls preventDefault()
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * handleCookiesNavigation(clickEvent);
+ *
+ * // With demo mode enabled
+ * handleCookiesNavigation(clickEvent, true);
+ * ```
+ */
+export declare function handleCookiesNavigation(event: Event, demoMode?: boolean): void;
+/**
+ * Create the cookies page URL with current query parameters
+ *
+ * This function generates a URL for the cookies page that preserves any query parameters
+ * from the current page. This ensures that user context (like filters, search terms, etc.)
+ * is maintained when navigating to the cookies page.
+ *
+ * @param cookiesPageUrl - The base URL for the cookies page (defaults to "/cookies-page")
+ * @returns The cookies page URL with current query parameters appended
+ *
+ * @example
+ * ```typescript
+ * // Using default cookies page URL
+ * const url = createCookiesUrl();
+ * // Returns: "/cookies-page?param1=value1&param2=value2" (if current page has those params)
+ *
+ * // Using custom cookies page URL
+ * const customUrl = createCookiesUrl("/custom-cookies");
+ * // Returns: "/custom-cookies?param1=value1&param2=value2"
+ * ```
+ */
+export declare function createCookiesUrl(cookiesPageUrl?: string): string;

package/dist/utils/cookiesNavigation.js

@@ -0,0 +1,63 @@
+import { browser } from "$app/environment";
+/**
+ * Navigate to cookies page while preserving current URL
+ *
+ * This function handles navigation to the cookies page while preserving the current URL
+ * in sessionStorage for potential return navigation. In demo mode, it prevents navigation
+ * to avoid disrupting the demo experience.
+ *
+ * @param event - The navigation event (typically a click event from a link)
+ * @param demoMode - Whether the component is in demo mode (defaults to false)
+ *                   When true, prevents navigation and calls preventDefault()
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * handleCookiesNavigation(clickEvent);
+ *
+ * // With demo mode enabled
+ * handleCookiesNavigation(clickEvent, true);
+ * ```
+ */
+export function handleCookiesNavigation(event, demoMode = false) {
+    if (!browser)
+        return;
+    if (demoMode) {
+        // In demo mode, prevent navigation
+        event.preventDefault();
+        return;
+    }
+    // Store the current URL in sessionStorage
+    sessionStorage.setItem("previousUrl", window.location.href);
+    // Let the normal link navigation proceed
+    // SvelteKit will handle the navigation
+}
+/**
+ * Create the cookies page URL with current query parameters
+ *
+ * This function generates a URL for the cookies page that preserves any query parameters
+ * from the current page. This ensures that user context (like filters, search terms, etc.)
+ * is maintained when navigating to the cookies page.
+ *
+ * @param cookiesPageUrl - The base URL for the cookies page (defaults to "/cookies-page")
+ * @returns The cookies page URL with current query parameters appended
+ *
+ * @example
+ * ```typescript
+ * // Using default cookies page URL
+ * const url = createCookiesUrl();
+ * // Returns: "/cookies-page?param1=value1&param2=value2" (if current page has those params)
+ *
+ * // Using custom cookies page URL
+ * const customUrl = createCookiesUrl("/custom-cookies");
+ * // Returns: "/custom-cookies?param1=value1&param2=value2"
+ * ```
+ */
+export function createCookiesUrl(cookiesPageUrl = "/cookies-page") {
+    if (!browser)
+        return cookiesPageUrl;
+    const currentUrl = new URL(window.location.href);
+    const searchParams = currentUrl.search;
+    return cookiesPageUrl + searchParams;
+}

package/dist/utils/data-transformations/convert-csv-to-json-proper.cjs

@@ -0,0 +1,88 @@
+const fs = require("fs");
+const path = require("path");
+
+// Read the CSV file
+const csvPath = "static/data/places.csv";
+const csvContent = fs.readFileSync(csvPath, "utf8");
+
+// Proper CSV parser that handles quoted fields
+function parseCSV(text) {
+  const lines = text.trim().split("\n");
+  const headers = parseCSVLine(lines[0]);
+  const data = [];
+
+  for (let i = 1; i < lines.length; i++) {
+    const values = parseCSVLine(lines[i]);
+    if (values.length === headers.length) {
+      const obj = {};
+      headers.forEach((header, index) => {
+        obj[header.trim()] = values[index].trim();
+      });
+      data.push(obj);
+    }
+  }
+
+  return data;
+}
+
+// Parse a single CSV line handling quoted fields
+function parseCSVLine(line) {
+  const result = [];
+  let current = "";
+  let inQuotes = false;
+
+  for (let i = 0; i < line.length; i++) {
+    const char = line[i];
+
+    if (char === '"') {
+      if (inQuotes && line[i + 1] === '"') {
+        // Escaped quote
+        current += '"';
+        i++; // Skip next quote
+      } else {
+        // Toggle quote mode
+        inQuotes = !inQuotes;
+      }
+    } else if (char === "," && !inQuotes) {
+      // End of field
+      result.push(current);
+      current = "";
+    } else {
+      current += char;
+    }
+  }
+
+  // Don't forget the last field
+  result.push(current);
+
+  return result;
+}
+
+// Parse the CSV
+const data = parseCSV(csvContent);
+
+// Ensure the lib data directory exists
+const outputDir = "src/lib/data";
+if (!fs.existsSync(outputDir)) {
+  fs.mkdirSync(outputDir, { recursive: true });
+}
+
+// Write JSON file
+const outputPath = path.join(outputDir, "places.json");
+fs.writeFileSync(outputPath, JSON.stringify(data, null, 2));
+
+console.log(`Converted ${data.length} records from CSV to JSON`);
+console.log(`Output: ${outputPath}`);
+
+// Show a few examples to verify
+console.log("\nFirst few records:");
+console.log(data.slice(0, 5));
+
+// Check for any records that might have quotes in the name
+const recordsWithQuotes = data.filter(
+  (r) => r.areanm && r.areanm.includes('"'),
+);
+console.log(`\nRecords with quotes in name: ${recordsWithQuotes.length}`);
+if (recordsWithQuotes.length > 0) {
+  console.log("Examples:", recordsWithQuotes.slice(0, 3));
+}

package/dist/utils/data-transformations/convert-csv-to-json-proper.d.cts

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

package/dist/utils/data-transformations/convertCSV.d.ts

@@ -1,2 +1,8 @@
 export function convertToCSV(array: any): string;
 export function csvToArrayOfObjects(csv: any): any;
+/**
+ * Fetches and parses a CSV file from a URL
+ * @param {string} url - The URL of the CSV file to fetch
+ * @returns {Promise<Array<Object>>} Promise that resolves to array of objects
+ */
+export function getCSV(url: string): Promise<Array<any>>;

package/dist/utils/data-transformations/convertCSV.js

@@ -1,22 +1,41 @@
 export function convertToCSV(array) {
-  if (!array.length) return '';
-
-  const header = Object.keys(array[0]).join(', '); // Add space after commas in header
-  const rows = array.map((obj) => Object.values(obj).join(', ')); // Add space after commas in rows
-
-  return [header, ...rows].join('\n');
-}
-
-export function csvToArrayOfObjects(csv) {
-  const lines = csv.split('\n').filter((line) => line.trim() !== ''); // Split into lines and remove empty ones
-  const [headerLine, ...dataLines] = lines; // Separate header from data
-  const headers = headerLine.split(',').map((header) => header.trim()); // Split header into keys and trim spaces
-
-  return dataLines.map((line) => {
-    const values = line.split(',').map((value) => value.trim()); // Split each line by commas and trim spaces
-    return headers.reduce((acc, key, index) => {
-      acc[key] = values[index]; // Map values to their corresponding header
-      return acc;
-    }, {});
-  });
-}
+    if (!array.length) return "";
+  
+    const header = Object.keys(array[0]).join(", "); // Add space after commas in header
+    const rows = array.map((obj) => Object.values(obj).join(", ")); // Add space after commas in rows
+  
+    return [header, ...rows].join("\n");
+  }
+  
+  export function csvToArrayOfObjects(csv) {
+    const lines = csv.split("\n").filter((line) => line.trim() !== ""); // Split into lines and remove empty ones
+    const [headerLine, ...dataLines] = lines; // Separate header from data
+    const headers = headerLine.split(",").map((header) => header.trim()); // Split header into keys and trim spaces
+  
+    return dataLines.map((line) => {
+      const values = line.split(",").map((value) => value.trim()); // Split each line by commas and trim spaces
+      return headers.reduce((acc, key, index) => {
+        acc[key] = values[index]; // Map values to their corresponding header
+        return acc;
+      }, {});
+    });
+  }
+  
+  /**
+   * Fetches and parses a CSV file from a URL
+   * @param {string} url - The URL of the CSV file to fetch
+   * @returns {Promise<Array<Object>>} Promise that resolves to array of objects
+   */
+  export async function getCSV(url) {
+    try {
+      const response = await fetch(url);
+      if (!response.ok) {
+        throw new Error(`HTTP error! status: ${response.status}`);
+      }
+      const csvText = await response.text();
+      return csvToArrayOfObjects(csvText);
+    } catch (error) {
+      console.error("Error fetching CSV:", error);
+      throw error;
+    }
+  }

package/dist/utils/text-string-conversion/textStringConversion.d.ts

@@ -7,3 +7,9 @@ export function kebabToPascalCase(str: any): any;
  * @returns {string} - The text with <br> inserted before the third capital letter
  */
 export function forceWrapAtThirdCapital(text: string): string;
+/**
+ * Capitalizes the first letter of a string
+ * @param {string} str - The string to capitalize
+ * @returns {string} The string with first letter capitalized
+ */
+export function capitalise(str: string): string;

package/dist/utils/text-string-conversion/textStringConversion.js

@@ -84,3 +84,13 @@ export function forceWrapAtThirdCapital(text) {
 
   return result;
 }
+
+/**
+ * Capitalizes the first letter of a string
+ * @param {string} str - The string to capitalize
+ * @returns {string} The string with first letter capitalized
+ */
+export function capitalise(str) {
+  if (!str || typeof str !== "string") return str;
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@communitiesuk/svelte-component-library",
-  "version": "0.1.17",
+  "version": "0.2.0-alpha.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/communitiesuk/mhclg_svelte_component_library.git"
@@ -15,6 +15,7 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "dev": "vite dev",
     "build": "vite build && npm run package",
+    "deploy": "gh-pages -d docs",
     "preview": "vite preview",
     "prepackage": "tsx scripts/generate-index.ts && node scripts/copy-static-assets-to-lib.js",
     "package": "npm run prepackage && svelte-kit sync && svelte-package && publint",
@@ -28,7 +29,8 @@
     "copy-govuk-assets": "node scripts/copy-govuk-assets-to-static.js",
     "copy-moj-assets": "node scripts/copy-moj-assets-to-static.js",
     "prepare": "",
-    "create-component-and-wrapper-pages": "node scripts/create-component-and-wrapper-pages.js"
+    "create-component-and-wrapper-pages": "node scripts/create-component-and-wrapper-pages.js",
+    "sync-node-version": "node -pe \"require('./package.json').engines.node.match(/\\d+/)[0]\" > .nvmrc && echo '.nvmrc updated to use latest Node.js v'$(cat .nvmrc)'.x' && source ~/.zprofile && INSTALL_OUTPUT=$(nvm install $(cat .nvmrc) 2>&1 | grep -E '(already installed|Downloading and installing)') && echo $INSTALL_OUTPUT && INSTALLED_VERSION=$(echo $INSTALL_OUTPUT | grep -o 'v[0-9.]*') && echo 'Node.js '$INSTALLED_VERSION' ready. To switch in this terminal: nvm use'"
   },
   "files": [
     "dist",
@@ -44,8 +46,15 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "svelte": "./dist/index.js"
-    }
+      "svelte": "./dist/index.js",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./src/*": "./src/lib/*",
+    "./src/lib/*": "./src/lib/*"
+  },
+  "engines": {
+    "node": ">=20.0.0"
   },
   "peerDependencies": {
     "@sveltejs/kit": "^2.0.0",
@@ -53,6 +62,7 @@
   },
   "devDependencies": {
     "@sveltejs/adapter-auto": "^3.3.0",
+    "@sveltejs/adapter-static": "^3.0.8",
     "@sveltejs/kit": "^2.16.1",
     "@sveltejs/package": "^2.0.0",
     "@sveltejs/vite-plugin-svelte": "^4.0.0",
@@ -87,6 +97,7 @@
     "@maptiler/sdk": "^3.0.1",
     "@ministryofjustice/frontend": "^4.0.1",
     "@monaco-editor/loader": "^1.4.0",
+    "@sveltejs/adapter-netlify": "^5.0.2",
     "@types/dompurify": "^3.0.5",
     "accessible-autocomplete": "^3.0.1",
     "csv-parser": "^3.0.0",
@@ -94,20 +105,20 @@
     "decimal.js": "^10.5.0",
     "dompurify": "^3.2.5",
     "flowbite-svelte-icons": "^2.0.3",
-    "govuk-frontend": "^5.9.0",
+    "govuk-frontend": "^5.11.1",
+    "gh-pages": "^6.3.0",
     "labelplacer": "^0.0.0",
     "leaflet": "^1.9.4",
     "mapbox-gl": "^1.13.3",
     "maplibre-gl": "^5.2.0",
     "monaco-editor": "^0.52.2",
-    "node": "^18.20.6",
-    "npm": "^11.0.0",
     "prism-svelte": "^0.5.0",
     "prismjs": "^1.29.0",
     "shiki": "^1.27.2",
     "sveaflet": "^0.1.4",
     "svelte-maplibre": "^1.0.0-next.12",
     "svelte-preprocess": "^6.0.3",
+    "tileserver-gl": "^5.3.1",
     "topojson-client": "^3.1.0"
   }
 }