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

🖼️ アバタースキーマブロック

アバタースキーマブロックは、ドメイン全体(例: ユーザープロファイル、組織)で使用されるアバターオブジェクトのための JSON Schema 定義を提供します。これらのスキーマは、クラウドストレージに保存されたファイル参照の一貫したオブジェクト構造を確保します。


🎯 概要

アバタースキーマは次のことを目的として設計されています:

  • エンティティで使用されるアバターオブジェクトの形状を検証する
  • 必須フィールドが常に存在することを確保する
  • objectId を使用してファイルストレージフローと統合する

🔧 利用可能なアバタースキーマ

avatarSchema

ベースアバターオブジェクトスキーマ。

目的: ストレージ参照と MIME タイプを含むアバターオブジェクトを検証します

スキーマ詳細:

  • タイプ: object
  • 必須フィールド: objectId, type
  • 追加プロパティ: false(厳密な検証)
  • プロパティ:
    • objectId: string (UUID) — クラウドストレージオブジェクト識別子
    • type: string — 画像の MIME タイプ(例: image/png

使用例:

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

const { avatarSchema } = schemas;

const validate = ajv.compile(avatarSchema as SchemaDefinition);
const isValid = validate({ objectId: 'b1f6c9b2-0a10-4c51-8b1f-1a9a2b1d8f90', type: 'image/png' });

🔗 関連ドキュメント