メインコンテンツまでスキップ
バージョン: 0.4.2

📍 アドレススキーマブロック

アドレススキーマブロックは、異なるフォーマットと地域でのアドレス検証のためのJSONスキーマ定義を提供します。これらのスキーマは、Nodeblocksアプリケーション全体で一貫したアドレスデータ検証を確保します。

🎯 概要​

アドレススキーマブロックは以下を目的として設計されています：

  • 様々なフォーマットと地域でのアドレスデータの検証
  • 地域固有の要件による国際アドレスのサポート
  • アプリケーション全体でのアドレス一貫性の確保
  • 配列ベースフォーマットによる柔軟なアドレス保存の提供
  • 他のアドレス関連スキーマとのコンポジションのサポート

📋 アドレススキーマ種類​

ベースアドレススキーマ​

完全なアドレス構造の基盤として使用されるコアアドレスコンポーネントスキーマ。

地域アドレススキーマ​

特定の地域とフォーマットのための完全なアドレススキーマ。

アドレスコンポーネントスキーマ​

個別のアドレスコンポーネント検証スキーマ。

🔧 利用可能なアドレススキーマ​

address​

柔軟なアドレス行保存のためのアドレス配列スキーマ。

目的: 柔軟なアドレス保存のためのアドレス行文字列配列を検証

スキーマ詳細:

  • タイプ: object
  • 追加プロパティ: false（厳密な検証）
  • プロパティ:
    • address?: string[] - アドレス行文字列の配列

使用方法:

import { schemas } from '@nodeblocks/backend-sdk';

const { address } = schemas;

const validate = ajv.compile(address);
const isValid = validate({ address: ['123 Main St', 'Apt 4'] });

postalCode​

郵便番号検証のための郵便番号スキーマ。

目的: アドレスフォーマッティングのための郵便番号文字列を検証

スキーマ詳細:

  • タイプ: object
  • 追加プロパティ: false（厳密な検証）
  • プロパティ:
    • postalCode?: string - 郵便番号文字列

使用方法:

import { schemas } from '@nodeblocks/backend-sdk';

const { postalCode } = schemas;

const validate = ajv.compile(postalCode);
const isValid = validate({ postalCode: '12345' });

prefecture​

日本の都道府県検証のための都道府県スキーマ。

目的: 日本のアドレスのための都道府県文字列またはnull値を検証

スキーマ詳細:

  • タイプ: object
  • 追加プロパティ: false（厳密な検証）
  • プロパティ:
    • prefecture?: string | null - 都道府県文字列またはnull

使用方法:

import { schemas } from '@nodeblocks/backend-sdk';

const { prefecture } = schemas;

const validate = ajv.compile(prefecture);
const isValid = validate({ prefecture: '東京都' });

city​

市区町村名検証のための市区町村スキーマ。

目的: アドレスコンポーネントのための市区町村名文字列を検証

スキーマ詳細:

  • タイプ: object
  • 追加プロパティ: false（厳密な検証）
  • プロパティ:
    • city?: string - 市区町村名文字列

使用方法:

import { schemas } from '@nodeblocks/backend-sdk';

const { city } = schemas;

const validate = ajv.compile(city);
const isValid = validate({ city: '東京' });

country​

国名検証のための国スキーマ。

目的: アドレスコンポーネントのための国名文字列を検証

スキーマ詳細:

  • タイプ: object
  • 追加プロパティ: false（厳密な検証）
  • プロパティ:
    • country?: string - 国名文字列

使用方法:

import { schemas } from '@nodeblocks/backend-sdk';

const { country } = schemas;

const validate = ajv.compile(country);
const isValid = validate({ country: '日本' });

addressJPSchema​

包括的なアドレスコンポーネント付き日本アドレススキーマ。

目的: すべてのコンポーネント付き完全な日本アドレス構造を検証

スキーマ詳細:

  • タイプ: object
  • 追加プロパティ: false（厳密な検証）
  • プロパティ:
    • city?: string - 市区町村名
    • country?: string - 国名
    • postalCode?: string - 郵便番号
    • prefecture?: string - 都道府県名
    • street?: string - 街路住所

使用方法:

import { schemas } from '@nodeblocks/backend-sdk';

const { addressJPSchema } = schemas;

const validate = ajv.compile(addressJPSchema);
const isValid = validate({
  city: '千代田区',
  country: '日本',
  postalCode: '100-0001',
  prefecture: '東京都',
  street: '千代田1-1-1'
});

addressSchema​

標準化されたアドレス検証のためのアドレス情報スキーマ。

目的: US郵便番号フォーマット付き完全なアドレス情報を検証

スキーマ詳細:

  • タイプ: object
  • 追加プロパティ: false（厳密な検証）
  • 必須フィールド: street, city, state, country, postal_code
  • プロパティ:
    • street: string - 街路住所
    • city: string - 市区町村名
    • state: string - 州または県
    • country: string - 国名
    • postal_code: string - 郵便番号（USフォーマット: 12345 または 12345-6789）

使用方法:

import { schemas } from '@nodeblocks/backend-sdk';

const { addressSchema } = schemas;

const validate = ajv.compile(addressSchema);
const isValid = validate({
  street: '123 Main Street',
  city: 'New York',
  state: 'NY',
  country: 'USA',
  postal_code: '10001'
});

🔗 関連ドキュメント​