Fix file tree

package.json

@@ -10,7 +10,7 @@
     "test:node:platform": "npm run test:node-win || npm run test:node",
     "test:main": "jest test/main.test.ts",
     "test:addresses": "jest test/addresses.test.ts",
-    "test:advanced": "jest test/advanced_v?.test.ts --runInBand",
+    "test:advanced": "jest test/advanced/*.test.ts --runInBand",
     "test:util": "jest test/util.test.ts",
     "test:node": "curl -sL https://github.com/geolonia/japanese-addresses/archive/refs/heads/master.tar.gz | tar xvfz - -C ./test > nul 2>&1 && jest test/fs.test.ts",
     "test:node-win": "curl -sL https://github.com/geolonia/japanese-addresses/archive/refs/heads/master.tar.gz -o master.tar.gz && 7z x master.tar.gz -y -o./ && 7z x ./master.tar -y -o./test && del master.tar.gz master.tar && jest test/fs.test.ts",

src/normalize.ts

@@ -41,7 +41,7 @@ export interface Config {
   /**
    * レスポンス型のバージョン。デフォルト 1
    * 1 の場合は jyukyo: string, gaiku: string
-   * 2 の場合は addr: string, type: 'GAIKU' | 'CHIBAN'
+   * 2 の場合は addr: string,　other: string
    */
   interfaceVersion: number
 
@@ -51,6 +51,7 @@ export interface Config {
   /** 町丁目のデータを何件までキャッシュするか。デフォルト 1,000 */
   townCacheSize: number
 
+  /** 住所データへのリクエストを変形するオプション。 interfaceVersion === 2 で有効 */
   transformRequest?: TransformRequestFunction
 
   geoloniaApiKey?: string
@@ -490,6 +491,7 @@ export const normalize: Normalizer = async (
   // 将来的に v2 に統一することを検討中
   // ==================================================================
 
+  // v2 のインターフェース
   if (currentConfig.interfaceVersion === 2) {
     const normalizedAddrPart = await normalizeAddrPart(addr, pref, city, town)
     let other = undefined

test/advanced_v1.test.ts → test/advanced/interface_v1.test.ts

@@ -1,9 +1,9 @@
-import * as Normalize from '../src/normalize'
-import { normalize } from '../src/main-node'
+import * as Normalize from '../../src/normalize'
+import { normalize } from '../../src/main-node'
 import unfetch from 'isomorphic-unfetch'
-import { gh_pages_endpoint } from '../src/config'
+import { gh_pages_endpoint } from '../../src/config'
 
-// interfaceVersion 1 に対するテスト。
+// interfaceVersion 1 に対するテスト。（デフォルト設定）
 // prop ID でのみ利用。
 // interfaceVersion 1 は廃止予定。
 

test/advanced_v2.test.ts → test/advanced/interface_v2.test.ts

@@ -1,4 +1,4 @@
-import { normalize, config } from '../src/main-node'
+import { normalize, config } from '../../src/main-node'
 
 config.interfaceVersion = 2
 config.transformRequest = async (url, query) => {
@@ -30,8 +30,10 @@ config.transformRequest = async (url, query) => {
 }
 
 // interfaceVersion 2 に対するテスト。
-// transformRequest を使った柔軟なリクエストが可能なバージョン。
-// 将来的に 1 を廃止し、こちらをデフォルトにする予定。
+// addr として住居表示または地番を返す。
+// addr 以降の列は other として返す。
+// transformRequest が使用可能。
+// 将来的にこちらをデフォルトにする予定。
 
 test('リクエスト変形テスト 1', async () => {
   const res = await normalize('A県 X市 あああ 1の2おはようビル', { level: 3 })