mixi2-js

📖 ドキュメント | npm | JSR

mixi2 の Application API を利用するための 非公式 TypeScript/JavaScript SDK です。

公式 Go SDK および 公式 API 仕様 に基づいて作成されています。

Note

これは MIXI 社公式のプロダクトではありません。コミュニティメンバーによるオープンソースプロジェクトです。

---

インストール

npm install mixi2-js

# or

npx jsr add @otoneko1102/mixi2-js

ESM・CommonJS の両方に対応しています。TypeScript の型定義 (.d.ts) も同梱されています。

---

機能概要

モジュール	説明
OAuth2Authenticator	OAuth2 Client Credentials 認証（アクセストークンの取得・キャッシュ・有効期限 1 分前に自動更新）
Client	gRPC API クライアント（8 つの RPC メソッドに対応）
WebhookServer	HTTP Webhook サーバー（Ed25519 署名検証・Ping 自動応答）
StreamWatcher	gRPC ストリーミング（指数バックオフによる自動再接続）

Helpers (拡張機能)

mixi2-js/helpers は、公式 API 仕様には含まれない SDK 独自の便利ユーティリティを提供します。

ヘルパー	説明
EventRouter	イベントタイプ別にハンドラを登録できるルーター
PostBuilder	メソッドチェーンでポスト作成リクエストを組み立てるビルダー
MediaUploader	メディアアップロードの開始〜完了待機を自動化
ReasonFilter	EventReason ベースでイベントをフィルタリング

---

ドキュメント

使い方・API リファレンス・拡張機能の詳細は ドキュメントサイト を参照してください。

---

関連リンク

• mixi2-js ドキュメント
• mixi2 Developer Platform 公式ドキュメント
• mixi2-api — API 定義（Protocol Buffers）
• mixi2-application-sdk-go — 公式 Go SDK
• mixi2-application-sample-go — サンプルアプリケーション

---

貢献

貢献を歓迎しています！詳細は CONTRIBUTING.md を参照してください。

このプロジェクトは Contributor Covenant 行動規範 に準拠しています。

貢献者

---

ライセンス

Apache-2.0