メインコンテンツまでスキップ
バージョン: 0.9.0 (最新)

📍 住所スキーマ

住所スキーマは、異なる形式と地域の住所検証用のJSONスキーマ定義を提供します。これらのスキーマは、Nodeblocksアプリケーション全体で一貫した住所データ検証を保証します。

🎯 概要​

住所スキーマは以下の目的で設計されています：

  • さまざまな形式と地域での住所データの検証
  • 地域固有の要件を持つ国際住所のサポート
  • アプリケーション全体での住所一貫性の保証
  • 配列ベースの形式による柔軟な住所ストレージの提供
  • 他の住所関連スキーマとの合成のサポート

📋 住所スキーマタイプ​

基本住所スキーマ​

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

地域別住所スキーマ​

特定の地域と形式用の完全な住所スキーマ。

住所コンポーネントスキーマ​

個別の住所コンポーネント検証スキーマ。

🔧 利用可能な住所スキーマ​

address​

柔軟な住所行ストレージ用の住所配列スキーマ。

目的: 柔軟な住所ストレージ用の住所行文字列の配列を検証します

スキーマ詳細:

  • Type: object
  • Additional Properties: false（厳密な検証）
  • Properties:
    • address?: string[] - 住所行文字列の配列

使用例:

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

const { address } = schemas;

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

postalCode​

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

目的: 住所フォーマット用の郵便番号文字列を検証します

スキーマ詳細:

  • Type: object
  • Additional Properties: false（厳密な検証）
  • Properties:
    • postalCode?: string - 郵便番号文字列

使用例:

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

const { postalCode } = schemas;

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

prefecture​

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

目的: 日本の住所用の都道府県文字列またはnull値を検証します

スキーマ詳細:

  • Type: object
  • Additional Properties: false（厳密な検証）
  • Properties:
    • prefecture?: string | null - 都道府県文字列またはnull

使用例:

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

const { prefecture } = schemas;

const validate = ajv.compile(prefecture as SchemaDefinition);
const isValid = validate({ prefecture: 'Tokyo' });

city​

都市名検証用の都市スキーマ。

目的: 住所コンポーネント用の都市名文字列を検証します

スキーマ詳細:

  • Type: object
  • Additional Properties: false（厳密な検証）
  • Properties:
    • city?: string - 都市名文字列

使用例:

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

const { city } = schemas;

const validate = ajv.compile(city as SchemaDefinition);
const isValid = validate({ city: 'Tokyo' });

country​

国名検証用の国スキーマ。

目的: 住所コンポーネント用の国名文字列を検証します

スキーマ詳細:

  • Type: object
  • Additional Properties: false（厳密な検証）
  • Properties:
    • country?: string - 国名文字列

使用例:

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

const { country } = schemas;

const validate = ajv.compile(country as SchemaDefinition);
const isValid = validate({ country: 'Japan' });

addressJPSchema​

包括的な住所コンポーネントを持つ日本の住所スキーマ。

目的: すべてのコンポーネントを含む完全な日本の住所構造を検証します

スキーマ詳細:

  • Type: object
  • Additional Properties: false（厳密な検証）
  • Properties:
    • city?: string - 都市名
    • country?: string - 国名
    • postalCode?: string - 郵便番号
    • prefecture?: string - 都道府県名
    • street?: string - 番地

使用例:

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

const { addressJPSchema } = schemas;

const validate = ajv.compile(addressJPSchema as SchemaDefinition);
const isValid = validate({
  city: 'Tokyo',
  country: 'Japan',
  postalCode: '100-0001',
  prefecture: 'Tokyo',
  street: '1-1-1 Chiyoda'
});

addressSchema​

標準化された住所検証用の住所情報スキーマ。

目的: 米国の郵便番号形式で完全な住所情報を検証します

スキーマ詳細:

  • Type: object
  • Additional Properties: false（厳密な検証）
  • Required Fields: street, city, state, country, postal_code
  • Properties:
    • street: string - 番地
    • city: string - 都市名
    • state: string - 州または都道府県
    • country: string - 国名
    • postal_code: string - 郵便番号（米国形式: 12345 または 12345-6789）

使用例:

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

const { addressSchema } = schemas;

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