@bradleyhodges/addresskit 2.4.3 → 2.4.4

package/dist/cli.js

@@ -39,7 +39,7 @@ var version;
 var init_version = __esm({
   "packages/core/version.ts"() {
     "use strict";
-    version = "2.4.3";
+    version = "2.4.4";
   }
 });
 
@@ -67114,6 +67114,116 @@ async function loadAddressCollection(params) {
     }
   };
 }
+function mapLocalitySearchHitToResource(hit, maxScore) {
+  const localityId = hit._id.replace("/localities/", "");
+  const normalizedRank = maxScore > 0 ? hit._score / maxScore : 0;
+  return {
+    type: "locality-suggestion",
+    id: localityId,
+    attributes: {
+      display: hit._source.display,
+      rank: Math.round(normalizedRank * 100) / 100
+    },
+    links: {
+      self: `/localities/${localityId}`
+    }
+  };
+}
+async function loadLocalityItem({
+  localityPid
+}) {
+  if (typeof localityPid !== "string" || localityPid.length === 0) {
+    throw new Error("Locality PID is required to load a record.");
+  }
+  const { json, hash, statusCode } = await getLocality(
+    localityPid
+  );
+  return {
+    body: json,
+    headers: {
+      etag: `"${version}-${hash}"`,
+      "cache-control": `public, max-age=${ONE_WEEK}`
+    },
+    status: statusCode ?? 200
+  };
+}
+async function loadLocalityCollection(params) {
+  const { page, q } = params;
+  const resolvedPage = Number(page ?? 0);
+  if (!Number.isFinite(resolvedPage)) {
+    throw new Error("Search page value must be numeric.");
+  }
+  const baseUrl = `/localities${q ? `?q=${encodeURIComponent(q)}` : ""}`;
+  if (q && q.length > 1) {
+    logger6("Searching for localities with query:", q);
+    const searchResult = await searchForLocality(
+      q,
+      resolvedPage + 1,
+      pageSize
+    );
+    const hits = searchResult.searchResponse.body.hits.hits;
+    const totalHits = searchResult.totalHits;
+    const totalPages = Math.ceil(totalHits / pageSize);
+    const currentPage = resolvedPage + 1;
+    const maxScore = hits.length > 0 ? hits[0]._score : 1;
+    const data = hits.map(
+      (hit) => mapLocalitySearchHitToResource(hit, maxScore)
+    );
+    const jsonApiDocument = {
+      jsonapi: { version: "1.1" },
+      data,
+      links: {
+        self: `${baseUrl}${currentPage > 1 ? `&page[number]=${currentPage}` : ""}`,
+        first: baseUrl,
+        ...currentPage > 1 && {
+          prev: currentPage === 2 ? baseUrl : `${baseUrl}&page[number]=${currentPage - 1}`
+        },
+        ...currentPage < totalPages && {
+          next: `${baseUrl}&page[number]=${currentPage + 1}`
+        },
+        ...totalPages > 0 && {
+          last: totalPages === 1 ? baseUrl : `${baseUrl}&page[number]=${totalPages}`
+        }
+      },
+      meta: {
+        total: totalHits,
+        page: currentPage,
+        pageSize,
+        totalPages
+      }
+    };
+    const responseHash = (0, import_node_crypto.createHash)("md5").update(JSON.stringify(jsonApiDocument)).digest("hex");
+    return {
+      body: jsonApiDocument,
+      hasMore: currentPage < totalPages,
+      headers: {
+        etag: `"${version}-${responseHash}"`,
+        "cache-control": `public, max-age=${ONE_WEEK}`
+      }
+    };
+  }
+  const emptyDocument = {
+    jsonapi: { version: "1.1" },
+    data: [],
+    links: {
+      self: baseUrl
+    },
+    meta: {
+      total: 0,
+      page: 1,
+      pageSize,
+      totalPages: 0
+    }
+  };
+  return {
+    body: emptyDocument,
+    hasMore: false,
+    headers: {
+      etag: `"${version}"`,
+      "cache-control": `public, max-age=${ONE_WEEK}`
+    }
+  };
+}
 function transformPaginationParams(req, _res, next) {
   const pageParam = req.query.page;
   if (pageParam && typeof pageParam === "object" && pageParam.number) {
@@ -67158,10 +67268,24 @@ async function startRest2Server() {
       }
     ]
   });
+  const localitiesType = waycharter.registerCollection({
+    itemPath: "/:localityPid",
+    itemLoader: loadLocalityItem,
+    collectionPath: "/localities",
+    collectionLoader: loadLocalityCollection,
+    filters: [
+      {
+        rel: "https://addressr.io/rels/locality-search",
+        parameters: ["q"]
+      }
+    ]
+  });
   const loadIndexResource = async () => {
+    const addressLinks = addressesType.additionalPaths;
+    const localityLinks = localitiesType.additionalPaths;
     return {
       body: {},
-      links: addressesType.additionalPaths,
+      links: [...addressLinks, ...localityLinks],
       headers: {
         etag: `"${version}"`,
         "cache-control": `public, max-age=${ONE_WEEK}`
@@ -67285,6 +67409,20 @@ async function runStartCommand(options) {
       `       ${theme.dim("Get detailed information for a specific address")}`
     );
     console.log();
+    console.log(
+      `  ${theme.secondary("GET")}  ${theme.muted("/localities?q=<query>")}`
+    );
+    console.log(
+      `       ${theme.dim("Search for suburbs/postcodes matching the query")}`
+    );
+    console.log();
+    console.log(
+      `  ${theme.secondary("GET")}  ${theme.muted("/localities/:id")}`
+    );
+    console.log(
+      `       ${theme.dim("Get detailed information for a specific locality")}`
+    );
+    console.log();
     console.log(`  ${theme.secondary("GET")}  ${theme.muted("/docs")}`);
     console.log(`       ${theme.dim("OpenAPI/Swagger documentation")}`);
     console.log();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bradleyhodges/addresskit",
-    "version": "2.4.3",
+    "version": "2.4.4",
     "description": "Scalable address ingestion, validation, search, and autocomplete engine for Australian addresses",
     "config": {
         "SEARCH_IMAGE": "opensearchproject/opensearch:1.3.20"
@@ -12,17 +12,15 @@
     "scripts": {
         "typecheck": "turbo run typecheck",
         "build": "pnpm format && pnpm run genversion && turbo run build && pnpm run bundle && pnpm run bundle:copy-assets",
-        "bundle": "esbuild apps/server/cli/index.ts --bundle --platform=node --target=node24 --outfile=dist/cli.js --packages=bundle",
-        "bundle:copy-assets": "node -e \"const fs=require('fs');fs.mkdirSync('api',{recursive:true});fs.copyFileSync('apps/server/api/swagger.yaml','api/swagger.yaml');fs.copyFileSync('apps/server/api/swagger-2.yaml','api/swagger-2.yaml');\"",
-        "publish:npm": "npm publish --access public --registry=https://registry.npmjs.org",
-        "publish:github": "npm publish --access public --registry=https://npm.pkg.github.com",
-        "publish:all": "pnpm run publish:npm && pnpm run publish:github",
-        "release": "git tag v%npm_package_version% && git push origin master --tags",
+        "build:docker": "docker build -f infra/docker/Dockerfile --build-arg PACKAGE_TGZ=bradleyhodges-addresskit-%npm_package_version%.tgz --build-arg PACKAGE=%npm_package_name% --build-arg VERSION=%npm_package_version% -t bradleyhodges/addresskit:%npm_package_version% -t bradleyhodges/addresskit:latest .",
         "release:all": "node tooling/scripts/release.js",
         "dev": "turbo run dev --parallel",
         "dev:docker": "docker compose -f infra/docker/compose.dev.yml up -d",
         "dev:docker:down": "docker compose -f infra/docker/compose.dev.yml down --volumes --remove-orphans --rmi all",
         "dev:docker:load": "docker compose -f infra/docker/compose.dev.yml run --rm loader",
+        "bundle": "esbuild apps/server/cli/index.ts --bundle --platform=node --target=node24 --outfile=dist/cli.js --packages=bundle",
+        "bundle:copy-assets": "node -e \"const fs=require('fs');fs.mkdirSync('api',{recursive:true});fs.copyFileSync('apps/server/api/swagger.yaml','api/swagger.yaml');fs.copyFileSync('apps/server/api/swagger-2.yaml','api/swagger-2.yaml');\"",
+        "release": "git tag v%npm_package_version% && git push origin master --tags",
         "smoke": "node tooling/smoke/smoke.mjs",
         "format": "biome check . --write --skip-errors",
         "clean": "git clean -xdf node_modules",
@@ -33,8 +31,10 @@
         "npm-check:interactive": "npm-check --skip-unused -u ",
         "npm-check-unused": "npm-check",
         "genversion": "genversion -p ./ --es6 --double ./packages/core/version.ts",
+        "publish:npm": "npm publish --access public --registry=https://registry.npmjs.org",
+        "publish:github": "npm publish --access public --registry=https://npm.pkg.github.com",
+        "publish:all": "pnpm run publish:npm && pnpm run publish:github",
         "prebuild:docker": "npm pack",
-        "build:docker": "docker build -f infra/docker/Dockerfile --build-arg PACKAGE_TGZ=bradleyhodges-addresskit-%npm_package_version%.tgz --build-arg PACKAGE=%npm_package_name% --build-arg VERSION=%npm_package_version% -t bradleyhodges/addresskit:%npm_package_version% -t bradleyhodges/addresskit:latest .",
         "build:docker:ghcr": "docker build -f infra/docker/Dockerfile --build-arg PACKAGE_TGZ=bradleyhodges-addresskit-%npm_package_version%.tgz --build-arg PACKAGE=%npm_package_name% --build-arg VERSION=%npm_package_version% -t ghcr.io/bradleyhodges/addresskit:%npm_package_version% -t ghcr.io/bradleyhodges/addresskit:latest .",
         "postbuild": "echo \"postbuild skipped\"",
         "prepack": "npm run build",