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

📧 招待ブロック

招待ブロックは、Nodeblocksアプリケーションにおけるユーザー招待を管理するための包括的な事前設定済みコンポーネントセットを提供します。これらのブロックは、招待の作成、メール配信、トークン検証、招待ライフサイクル管理を処理します。

🎯 概要​

招待ブロックは以下を目的として設計されています：

  • 組織アクセス制御のためのユーザー招待の作成と管理
  • 安全なワンタイムトークン付き招待メールの送信
  • 安全な受諾ワークフローのための招待トークンの検証
  • 作成から受諾/削除まで招待ライフサイクルの処理
  • 組織ベースの招待管理をサポート

📦 ブロック種類​

🔍 スキーマ​

招待データ検証のためのJSONスキーマ定義：

  • invitationSchema: ベース招待データ構造
  • createInvitationSchema: 招待作成検証
  • getInvitationSchema: 単一招待取得
  • deleteInvitationSchema: 招待削除
  • findInvitationsSchema: フィルタリングとページネーション付き招待検索

招待スキーマブロックを表示 →

⚙️ ハンドラー​

招待操作のためのコアビジネスロジック：

  • createInvitation: データベースに新しい招待を作成
  • sendInvitationEmail: トークン付き招待メールを送信
  • findInvitations: フィルタリング付き招待をクエリ
  • getInvitationById: 単一招待を取得
  • updateInvitation: 招待データを更新
  • deleteInvitation: データベースから招待を削除
  • buildCheckInvitationTokenPayload: トークン検証を設定
  • getInvitationIdFromTokenInfo: トークンから招待IDを抽出
  • verifyInvitationPayload: 招待の真正性を確認
  • isPendingInvitation: 招待ステータスを検証
  • buildAcceptInvitationPayload: 受諾データを準備

招待ハンドラーブロックを表示 →

🛣️ ルート​

招待操作のためのHTTPエンドポイント定義：

  • createInvitationRoute: POST /invitations - 新しい招待を作成
  • getInvitationRoute: GET /invitations/:invitationId - 招待を取得
  • findInvitationsRoute: GET /invitations - 招待をリスト
  • updateInvitationRoute: PATCH /invitations/:invitationId - 招待を更新
  • deleteInvitationRoute: DELETE /invitations/:invitationId - 招待を削除

招待ルートブロックを表示 →

🚀 フィーチャー​

スキーマ、ルート、ハンドラーを組み合わせた完全な招待管理機能：

  • createInvitationFeature: メール処理とトークン生成による招待作成
  • getInvitationFeature: 検証付き招待取得
  • findInvitationsFeature: フィルタリングとページネーション付き招待検索
  • deleteInvitationFeature: 適切な検証とクリーンアップによる招待削除

招待フィーチャーブロックを表示 →

🔗 関連ドキュメント​