@mountainpass/addressr 2.1.0 → 2.1.1

package/lib/service/address-service.js

@@ -9,6 +9,8 @@ exports.fetchGnafFile = fetchGnafFile;
 exports.getAddress = getAddress;
 exports.getAddresses = getAddresses;
 exports.getLocality = getLocality;
+exports.getPostcode = getPostcode;
+exports.getState = getState;
 exports.loadGnaf = loadGnaf;
 exports.mapAddressDetails = mapAddressDetails;
 exports.searchForAddress = searchForAddress;
@@ -934,20 +936,29 @@ async function getLocality(pid) {
   return resp;
 }
 async function searchForPostcode(searchString) {
+  const query = searchString && searchString.length > 0 ? {
+    bool: {
+      filter: [{
+        prefix: {
+          postcodes: searchString
+        }
+      }]
+    }
+  } : {
+    bool: {
+      filter: [{
+        exists: {
+          field: 'postcodes'
+        }
+      }]
+    }
+  };
   const searchResp = await globalThis.esClient.search({
     index: _elasticsearch.ES_LOCALITY_INDEX_NAME,
     body: {
       from: 0,
       size: 0,
-      query: {
-        bool: {
-          filter: [{
-            prefix: {
-              postcodes: searchString
-            }
-          }]
-        }
-      },
+      query,
       aggs: {
         postcodes: {
           terms: {
@@ -969,6 +980,62 @@ async function searchForPostcode(searchString) {
   logger('postcode hits', JSON.stringify(searchResp.body.aggregations, undefined, 2));
   return searchResp;
 }
+async function getPostcode(postcode) {
+  const searchResp = await globalThis.esClient.search({
+    index: _elasticsearch.ES_LOCALITY_INDEX_NAME,
+    body: {
+      size: 0,
+      query: {
+        term: {
+          postcodes: postcode
+        }
+      },
+      aggs: {
+        localities: {
+          terms: {
+            field: 'locality_name.raw',
+            size: 100
+          }
+        }
+      }
+    }
+  });
+  return searchResp;
+}
+async function getState(abbreviation) {
+  const searchResp = await globalThis.esClient.search({
+    index: _elasticsearch.ES_LOCALITY_INDEX_NAME,
+    body: {
+      size: 0,
+      query: {
+        term: {
+          state_abbreviation: abbreviation.toUpperCase()
+        }
+      },
+      aggs: {
+        state_name: {
+          terms: {
+            field: 'state_name',
+            size: 1
+          }
+        },
+        localities: {
+          terms: {
+            field: 'locality_name.raw',
+            size: 1000
+          }
+        },
+        postcodes: {
+          terms: {
+            field: 'postcodes',
+            size: 1000
+          }
+        }
+      }
+    }
+  });
+  return searchResp;
+}
 async function searchForState(searchString) {
   const query = searchString ? {
     bool: {

package/lib/src/waycharter-server.js

@@ -177,38 +177,49 @@ function startRest2Server() {
     }]
   });
   const postcodesType = waycharter.registerCollection({
+    itemPath: '/:postcode',
+    itemLoader: async ({
+      postcode
+    }) => {
+      const result = await (0, _addressService.getPostcode)(postcode);
+      const localities = result.body.aggregations.localities.buckets.map(l => ({
+        name: l.key
+      }));
+      const body = {
+        postcode,
+        localities
+      };
+      const hash = _nodeCrypto.default.createHash('md5').update(JSON.stringify(body)).digest('hex');
+      return {
+        body,
+        headers: {
+          etag: `"${_version.version}-${hash}"`,
+          'cache-control': `public, max-age=${ONE_WEEK}`
+        },
+        status: 200
+      };
+    },
     collectionPath: '/postcodes',
     collectionLoader: async ({
       q
     }) => {
-      if (q && q.length > 2) {
-        const result = await (0, _addressService.searchForPostcode)(q);
-        const buckets = result.body.aggregations.postcodes.buckets;
-        const body = buckets.map(bucket => ({
-          postcode: bucket.key,
-          localities: bucket.localities.buckets.map(l => ({
-            name: l.key
-          }))
-        }));
-        const responseHash = _nodeCrypto.default.createHash('md5').update(JSON.stringify(body)).digest('hex');
-        return {
-          body,
-          hasMore: false,
-          headers: {
-            etag: `"${_version.version}-${responseHash}"`,
-            'cache-control': `public, max-age=${ONE_WEEK}`
-          }
-        };
-      } else {
-        return {
-          body: [],
-          hasMore: false,
-          headers: {
-            etag: `"${_version.version}"`,
-            'cache-control': `public, max-age=${ONE_WEEK}`
-          }
-        };
-      }
+      const result = await (0, _addressService.searchForPostcode)(q || '');
+      const buckets = result.body.aggregations.postcodes.buckets;
+      const body = buckets.map(bucket => ({
+        postcode: bucket.key,
+        localities: bucket.localities.buckets.map(l => ({
+          name: l.key
+        }))
+      }));
+      const responseHash = _nodeCrypto.default.createHash('md5').update(JSON.stringify(body)).digest('hex');
+      return {
+        body,
+        hasMore: false,
+        headers: {
+          etag: `"${_version.version}-${responseHash}"`,
+          'cache-control': `public, max-age=${ONE_WEEK}`
+        }
+      };
     },
     filters: [{
       rel: 'https://addressr.io/rels/postcode-search',
@@ -216,11 +227,37 @@ function startRest2Server() {
     }]
   });
   const statesType = waycharter.registerCollection({
+    itemPath: '/:abbreviation',
+    itemLoader: async ({
+      abbreviation
+    }) => {
+      const result = await (0, _addressService.getState)(abbreviation);
+      const stateName = result.body.aggregations.state_name.buckets[0]?.key || abbreviation.toUpperCase();
+      const localities = result.body.aggregations.localities.buckets.map(l => ({
+        name: l.key
+      }));
+      const postcodes = result.body.aggregations.postcodes.buckets.map(p => p.key);
+      const body = {
+        abbreviation: abbreviation.toUpperCase(),
+        name: stateName,
+        localities,
+        postcodes
+      };
+      const hash = _nodeCrypto.default.createHash('md5').update(JSON.stringify(body)).digest('hex');
+      return {
+        body,
+        headers: {
+          etag: `"${_version.version}-${hash}"`,
+          'cache-control': `public, max-age=${ONE_WEEK}`
+        },
+        status: 200
+      };
+    },
     collectionPath: '/states',
     collectionLoader: async ({
       q
     }) => {
-      const result = await (0, _addressService.searchForState)(q && q.length > 1 ? q : undefined);
+      const result = await (0, _addressService.searchForState)(q || undefined);
       const buckets = result.body.aggregations.states.buckets;
       const body = buckets.map(bucket => ({
         abbreviation: bucket.key,

package/lib/version.js

@@ -5,4 +5,4 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = void 0;
 // Generated by genversion.
-const version = exports.version = '2.1.0';
+const version = exports.version = '2.1.1';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mountainpass/addressr",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Australian Address Validation, Search and Autocomplete",
   "author": {
     "name": "Mountain Pass",