Whatsapp Web

🚀 WhatsApp Web プロジェクトドキュメント

WhatsApp Web は、WhatsApp をベースとしたウェブクライアントで、ウェブブラウザを通じて WhatsApp の機能を利用できます。このプロジェクトは、豊富な API とプロトコルの実装を提供し、開発者が簡単に統合および拡張できるようにしています。

🚀 クイックスタート

このセクションでは、WhatsApp Web プロジェクトの概要を説明し、開発に必要な基本的な手順を提供します。

✨ 主な機能

• ウェブブラウザを通じて WhatsApp の機能を利用可能。
• 豊富な API とプロトコルの実装で、開発者による統合と拡張を容易にする。

🔧 技術詳細

アーキテクチャ

核心コンポーネント

1. WhatsApp クライアント：WhatsApp Web ブラウザアプリとのインタラクションを実現します。
2. 核心業務ロジック：WhatsApp のメッセージ送受信、連絡先管理などの核心機能を処理します。
3. WhatsApp API クライアント：WhatsApp API サーバーへのアクセスインターフェースを提供します。
4. REST API ルート：HTTP インターフェースを実装し、外部システムからの呼び出しを可能にします。
5. MCP プロトコル実装：モデルコンテキストプロトコル（Model Context Protocol）のサポートを実現します。

デプロイオプション

1. WhatsApp API サーバー：独立して動作する REST API サービスです。
2. MCP サーバー（独立運用）：WhatsApp Web に直接接続する MCP の実装です。
3. MCP サーバー（API クライアント）：API サーバーを介して接続します。

このアーキテクチャ設計により、システムは柔軟にデプロイでき、以下のシナリオをサポートします。

• API サーバーと MCP サーバーを別々のマシンで動作させる。
• MCP サーバーを既存の API サーバーのクライアントとして使用する。
• すべてのコンポーネントを単一のマシンで動作させる。

開発

プロジェクト構造

src/
├── whatsapp-client.ts     # WhatsApp Web クライアントの実装
├── whatsapp-service.ts    # 核心業務ロジックの実装
├── whatsapp-api-client.ts # WhatsApp API サーバーへのクライアントアクセス
├── api.ts                 # REST API ルートの実装
├── mcp-server.ts          # MCP プロトコルの実装
└── main.ts                # アプリケーションのエントリポイント

ビルド

npm run build

テスト

このプロジェクトは Jest を使用して単体テストを行います。テストを実行するには、以下のコマンドを使用します。

# すべてのテストを実行
npm test

# 開発中の監視モードでテストを実行
npm run test:watch

# テストカバレッジレポートを生成
npm run test:coverage

コード規約

このプロジェクトは ESLint と Prettier を使用してコード品質管理を行います。

# コードチェックを実行
npm run lint

# コードの問題を自動修正
npm run lint:fix

# コードをフォーマット
npm run format

# コードを検証（チェック + テスト）
npm run validate

トラブルシューティング

Claude Desktop 統合問題

• Claude が複数のプロセスを開くため、コマンドライン独立モードで wweb - mcp を実行できません。この制限を解決するために、アプリを API と MCP モードに分割し、Claude との良好な統合をサポートします。

予定機能

• メッセージやその他の WhatsApp イベントを受信するための webhook を作成する。
• メディアファイル（画像、音声、ドキュメント）の送信をサポートする。
• グループチャット管理機能を提供する。
• 連絡先管理（連絡先の追加/削除）をサポートする。
• 一般的なシナリオに対応したメッセージテンプレートを実装する。
• エラー処理と復元メカニズムを強化する。

貢献ガイド

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更をコミットします。
4. ブランチにプッシュします。
5. プルリクエストを作成します。

PR は以下の条件を満たすようにしてください。

• コードが明確で適切にテストされていること。
• コード規約と命名規則に従っていること。
• 詳細なコミットメッセージと説明を提供すること。

依存関係

このプロジェクトは以下のライブラリに依存しています。

ログシステム

レベル

• debug：デバッグ情報
• info：一般的な情報
• warn：警告情報
• error：エラー情報
• fatal：重大なエラー

設定

const logger = winston.createLogger({
  level: 'info',
  transports: [
    new winston.transports.Console({ colorize: true })
  ]
});

セキュリティ注意事項

1. 本番環境ではデバッグエンドポイントを公開しないでください。
2. 適切な認証メカニズムを設定して API インターフェースを保護してください。
3. セキュリティホールを修正するために定期的に依存ライブラリを更新してください。
4. HTTPS を使用して API サービスを提供してください。

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。詳細については LICENSE ファイルを参照してください。

以上のドキュメントは WhatsApp Web プロジェクトの開発ガイドです。詳細については、関連するコードとコメントを参照してください。