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

📧 Invitation ブロック

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


🎯 概要

Invitation ブロックは次のことを目的として設計されています:

  • 組織アクセスコントロールのためのユーザー招待を作成および管理する
  • 安全なワンタイムトークンを使用して招待メールを送信する
  • 安全な受け入れワークフローのための招待トークンを検証する
  • 作成から受け入れ/削除までの招待ライフサイクルを処理する
  • 組織ベースの招待管理をサポートする

📦 ブロックタイプ

🔍 スキーマ

招待データ検証のための JSON Schema 定義:

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

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

⚙️ ハンドラー

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

  • createInvitation: データベースに新しい招待を作成
  • sendInvitationEmail: トークンを使用して招待メールを送信
  • findInvitations: フィルタリングを使用して招待をクエリ
  • getInvitationById: 単一招待を取得
  • updateInvitation: 招待データを更新
  • deleteInvitation: データベースから招待を削除
  • buildCheckInvitationTokenPayload: トークン検証を設定
  • buildInvitationOnetimeTokenPayload: OTT 生成のためのペイロードを準備
  • getInvitationIdFromTokenInfo: トークンから招待 ID を抽出
  • verifyInvitationPayload: 招待の真正性を検証
  • isPendingInvitation: 招待ステータスを検証
  • buildAcceptInvitationPayload: 受け入れデータを準備

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

🛣️ ルート

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

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

Invitation ルートブロックを表示 →

🚀 機能

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

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

Invitation 機能ブロックを表示 →


🔗 関連ドキュメント