japanese_address_parser 3.1.0 → 3.1.1

data/js/node_modules/@geolonia/normalize-japanese-addresses/src/normalize.ts

@@ -9,21 +9,51 @@ import {
   getCityRegexPatterns,
   getTownRegexPatterns,
   getSameNamedPrefectureCityRegexPatterns,
+  // interface version 1
   getResidentials,
   getGaikuList,
+  // interface version 2
+  getAddrs,
+  PrefectureList,
+  TownList,
+  AddrList,
 } from './lib/cacheRegexes'
 import unfetch from 'isomorphic-unfetch'
 
+type TransformRequestResponse = null | PrefectureList | TownList | AddrList
+
+export type TransformRequestQuery = {
+  level: number //  level = -1 は旧 API。 transformRequestFunction を設定しても無視する
+  pref?: string
+  city?: string
+  town?: string
+}
+
+export type TransformRequestFunction = (
+  url: URL,
+  query: TransformRequestQuery,
+) => TransformRequestResponse | Promise<TransformRequestResponse>
+
 /**
  * normalize {@link Normalizer} の動作オプション。
  */
 export interface Config {
+  /**
+   * レスポンス型のバージョン。デフォルト 1
+   * 1 の場合は jyukyo: string, gaiku: string
+   * 2 の場合は addr: string,　other: string
+   */
+  interfaceVersion: number
+
   /** 住所データを URL 形式で指定。 file:// 形式で指定するとローカルファイルを参照できます。 */
   japaneseAddressesApi: string
 
   /** 町丁目のデータを何件までキャッシュするか。デフォルト 1,000 */
   townCacheSize: number
 
+  /** 住所データへのリクエストを変形するオプション。 interfaceVersion === 2 で有効 */
+  transformRequest?: TransformRequestFunction
+
   geoloniaApiKey?: string
 }
 export const config: Config = currentConfig
@@ -31,7 +61,7 @@ export const config: Config = currentConfig
 /**
  * 住所の正規化結果として戻されるオブジェクト
  */
-export interface NormalizeResult {
+interface NormalizeResult_v1 {
   /** 都道府県 */
   pref: string
   /** 市区町村 */
@@ -60,6 +90,34 @@ export interface NormalizeResult {
   level: number
 }
 
+type NormalizeResult_v2 = {
+  /** 都道府県 */
+  pref: string
+  /** 市区町村 */
+  city: string
+  /** 町丁目 */
+  town: string
+  /** 住居表示または地番 */
+  addr: string
+  /** 正規化後の住所文字列 */
+  other?: string
+  /** 緯度。データが存在しない場合は null */
+  lat: number | null
+  /** 経度。データが存在しない場合は null */
+  lng: number | null
+  /**
+   * 住所文字列をどこまで判別できたかを表す正規化レベル
+   * - 0 - 都道府県も判別できなかった。
+   * - 1 - 都道府県まで判別できた。
+   * - 2 - 市区町村まで判別できた。
+   * - 3 - 町丁目まで判別できた。
+   * - 8 - 住居表示住所の街区符号・住居番号までの判別または地番住所の判別ができた。
+   */
+  level: number
+}
+
+export type NormalizeResult = NormalizeResult_v1 | NormalizeResult_v2
+
 /**
  * 正規化関数の {@link normalize} のオプション
  */
@@ -92,6 +150,7 @@ export type Normalizer = (
 
 export type FetchLike = (
   input: string,
+  requestQuery?: TransformRequestQuery,
 ) => Promise<Response | { json: () => Promise<unknown> }>
 
 const defaultOption = {
@@ -143,7 +202,13 @@ const normalizeResidentialPart = async (
   pref: string,
   city: string,
   town: string,
-) => {
+): Promise<{
+  gaiku: string
+  jyukyo?: string
+  addr: string
+  lat: string
+  lng: string
+} | null> => {
   const [gaikuListItem, residentials] = await Promise.all([
     getGaikuList(pref, city, town),
     getResidentials(pref, city, town),
@@ -183,6 +248,27 @@ const normalizeResidentialPart = async (
   return null
 }
 
+const normalizeAddrPart = async (
+  addr: string,
+  pref: string,
+  city: string,
+  town: string,
+) => {
+  const addrListItem = await getAddrs(pref, city, town)
+
+  // 住居表示住所、および地番住所が見つからなかった
+  if (addrListItem.length === 0) {
+    return null
+  }
+
+  const addrItem = addrListItem.find((item) => addr.startsWith(item.addr))
+  if (addrItem) {
+    const other = addr.replace(addrItem.addr, '').trim()
+    return { addr: addrItem.addr, other, lat: addrItem.lat, lng: addrItem.lng }
+  }
+  return null
+}
+
 export const normalize: Normalizer = async (
   address,
   _option = defaultOption,
@@ -378,7 +464,7 @@ export const normalize: Normalizer = async (
           // `-1` のようなケース
           return kan2num(s)
         })
-        .replace(/-[^0-9]+([0-9〇一二三四五六七八九十百千]+)/, (s) => {
+        .replace(/-[^0-9]([0-9〇一二三四五六七八九十百千]+)/, (s) => {
           // `-あ1` のようなケース
           return kan2num(zen2han(s))
         })
@@ -392,43 +478,85 @@ export const normalize: Normalizer = async (
 
   addr = patchAddr(pref, city, town, addr)
 
-  // 住居表示住所リストを使い番地号までの正規化を行う
-  if (option.level > 3 && normalized && town) {
-    normalized = await normalizeResidentialPart(addr, pref, city, town)
-  }
-  if (normalized) {
-    lat = parseFloat(normalized.lat)
-    lng = parseFloat(normalized.lng)
-  }
-
-  if (Number.isNaN(lat) || Number.isNaN(lng)) {
-    lat = null
-    lng = null
-  }
-
   if (pref) level = level + 1
   if (city) level = level + 1
   if (town) level = level + 1
 
-  const result: NormalizeResult = {
-    pref,
-    city,
-    town,
-    addr,
-    lat,
-    lng,
-    level,
+  if (option.level <= 3 || level < 3) {
+    return { pref, city, town, addr, level, lat, lng }
   }
 
-  if (normalized && 'gaiku' in normalized) {
-    result.addr = normalized.addr
-    result.gaiku = normalized.gaiku
-    result.level = 7
-  }
-  if (normalized && 'jyukyo' in normalized) {
-    result.jyukyo = normalized.jyukyo
-    result.level = 8
-  }
+  // ======================== Advanced section ========================
+  // これ以下は地番住所または住居表示住所までの正規化・ジオコーディングを行う処理
+  // 現状、インターフェース v1 と v2 が存在する
+  // japanese-addresses のフォーマット、および normalize 関数の戻り値が異なる
+  // 将来的に v2 に統一することを検討中
+  // ==================================================================
+
+  // v2 のインターフェース
+  if (currentConfig.interfaceVersion === 2) {
+    const normalizedAddrPart = await normalizeAddrPart(addr, pref, city, town)
+    let other = undefined
+    if (normalizedAddrPart) {
+      addr = normalizedAddrPart.addr
+      if (normalizedAddrPart.other) {
+        other = normalizedAddrPart.other
+      }
+      if (normalizedAddrPart.lat !== null)
+        lat = parseFloat(normalizedAddrPart.lat)
+      if (normalizedAddrPart.lng !== null)
+        lng = parseFloat(normalizedAddrPart.lng)
+      level = 8
+    }
+    const result: NormalizeResult_v2 = {
+      pref,
+      city,
+      town,
+      addr,
+      level,
+      lat,
+      lng,
+    }
+    if (other) {
+      result.other = other
+    }
+    return result
+  } else if (currentConfig.interfaceVersion === 1) {
+    // 住居表示住所リストを使い番地号までの正規化を行う
+    if (option.level > 3 && normalized && town) {
+      normalized = await normalizeResidentialPart(addr, pref, city, town)
+    }
+    if (normalized) {
+      lat = parseFloat(normalized.lat)
+      lng = parseFloat(normalized.lng)
+    }
+
+    if (Number.isNaN(lat) || Number.isNaN(lng)) {
+      lat = null
+      lng = null
+    }
+
+    const result: NormalizeResult_v1 = {
+      pref,
+      city,
+      town,
+      addr,
+      lat,
+      lng,
+      level,
+    }
+    if (normalized && 'gaiku' in normalized) {
+      result.addr = normalized.addr
+      result.gaiku = normalized.gaiku
+      result.level = 7
+    }
+    if (normalized && 'jyukyo' in normalized) {
+      result.jyukyo = normalized.jyukyo
+      result.level = 8
+    }
 
-  return result
+    return result
+  } else {
+    throw new Error('invalid interfaceVersion')
+  }
 }

data/js/package-lock.json

@@ -6,7 +6,7 @@
     "": {
       "name": "japanese_address_parser",
       "dependencies": {
-        "@geolonia/normalize-japanese-addresses": "^2.8.0"
+        "@geolonia/normalize-japanese-addresses": "^2.9.2"
       },
       "devDependencies": {}
     },
@@ -16,9 +16,9 @@
       "integrity": "sha512-xzSsIHhyyjqNpW8qSh5bFMu3FJvyJGBbNZ/t8clPHkigjUdZ7Ck8wkzCkcwlVd00RkoHwGDLnvXx5W0WiGK0TQ=="
     },
     "node_modules/@geolonia/normalize-japanese-addresses": {
-      "version": "2.8.0",
-      "resolved": "https://registry.npmjs.org/@geolonia/normalize-japanese-addresses/-/normalize-japanese-addresses-2.8.0.tgz",
-      "integrity": "sha512-BNKTl+38nq+ZKABa9nmwixLyDTXDPYDWSG3DluTjvhog3LEVWcTOHy0taIWXpumlvoz67ingq2qxdjtvW8ktzQ==",
+      "version": "2.9.2",
+      "resolved": "https://registry.npmjs.org/@geolonia/normalize-japanese-addresses/-/normalize-japanese-addresses-2.9.2.tgz",
+      "integrity": "sha512-sbeV/seJ/ue6pn2sLo+Ccunl6eB3yNhrUIzNpT2IiR9Fw6fW5f1lLdApODqhTmz++xr1dyPwZOzTXCGEaXejDA==",
       "dependencies": {
         "@geolonia/japanese-numeral": "^0.1.16",
         "isomorphic-unfetch": "^3.1.0",
@@ -101,9 +101,9 @@
       "integrity": "sha512-xzSsIHhyyjqNpW8qSh5bFMu3FJvyJGBbNZ/t8clPHkigjUdZ7Ck8wkzCkcwlVd00RkoHwGDLnvXx5W0WiGK0TQ=="
     },
     "@geolonia/normalize-japanese-addresses": {
-      "version": "2.8.0",
-      "resolved": "https://registry.npmjs.org/@geolonia/normalize-japanese-addresses/-/normalize-japanese-addresses-2.8.0.tgz",
-      "integrity": "sha512-BNKTl+38nq+ZKABa9nmwixLyDTXDPYDWSG3DluTjvhog3LEVWcTOHy0taIWXpumlvoz67ingq2qxdjtvW8ktzQ==",
+      "version": "2.9.2",
+      "resolved": "https://registry.npmjs.org/@geolonia/normalize-japanese-addresses/-/normalize-japanese-addresses-2.9.2.tgz",
+      "integrity": "sha512-sbeV/seJ/ue6pn2sLo+Ccunl6eB3yNhrUIzNpT2IiR9Fw6fW5f1lLdApODqhTmz++xr1dyPwZOzTXCGEaXejDA==",
       "requires": {
         "@geolonia/japanese-numeral": "^0.1.16",
         "isomorphic-unfetch": "^3.1.0",

data/js/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "description": "JapaneseAddressParserは日本の住所をパースすることができるRuby gemです。",
   "dependencies": {
-    "@geolonia/normalize-japanese-addresses": "^2.8.0"
+    "@geolonia/normalize-japanese-addresses": "^2.9.2"
   },
   "devDependencies": {}
 }

data/lib/japanese_address_parser/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module JapaneseAddressParser
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
   public_constant :VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: japanese_address_parser
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Yamaguchi Takuya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: schmooze
@@ -4160,7 +4160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Japanese address parser written in Ruby.