https://github.com/otoneko1102/mixi2-js
TypeScript/JavaScript SDK for mixi2 Application API
https://github.com/otoneko1102/mixi2-js
api mixi mixi2 sdk wrapper
Last synced: 3 months ago
JSON representation
TypeScript/JavaScript SDK for mixi2 Application API
- Host: GitHub
- URL: https://github.com/otoneko1102/mixi2-js
- Owner: otoneko1102
- License: apache-2.0
- Created: 2026-03-06T14:18:16.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-03-21T16:00:04.000Z (4 months ago)
- Last Synced: 2026-03-22T04:29:31.181Z (4 months ago)
- Topics: api, mixi, mixi2, sdk, wrapper
- Language: TypeScript
- Homepage: http://mixi2.js.org/
- Size: 447 KB
- Stars: 11
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# mixi2-js
[](https://www.npmjs.com/package/mixi2-js)
[](https://www.npmjs.com/package/mixi2-js)
[](https://jsr.io/@otoneko1102/mixi2-js)
[](https://jsr.io/@otoneko1102/mixi2-js)
[](LICENSE)
[](package.json)
[](https://www.typescriptlang.org/)
[](https://github.com/otoneko1102/mixi2-js/actions)
[](vite.config.ts)
**[📖 ドキュメント](https://mixi2.js.org/)** | **[npm](https://www.npmjs.com/package/mixi2-js)** | **[JSR](https://jsr.io/@otoneko1102/mixi2-js)**
mixi2 の [Application API](https://developer.mixi.social/docs) を利用するための **非公式** TypeScript/JavaScript SDK です。
[公式 Go SDK](https://github.com/mixigroup/mixi2-application-sdk-go) および [公式 API 仕様](https://github.com/mixigroup/mixi2-api) に基づいて作成されています。
> [!Note]
> **これは MIXI 社公式のプロダクトではありません。コミュニティメンバーによるオープンソースプロジェクトです。**
---
## インストール
```bash
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` ベースでイベントをフィルタリング |
| `EventDeduplicator` | Webhook リトライ等による重複イベントをスキップ |
| `EventLogger` | 受信イベントをログ出力するデバッグ用ミドルウェア |
| `TextSplitter` | 長いテキストを 149 文字制限内に自動分割 |
| `Address` | 公式エンドポイント URL を返すヘルパー |
---
## ドキュメント
使い方・API リファレンス・拡張機能の詳細は **[ドキュメントサイト](https://mixi2.js.org/)** を参照してください。
---
## 関連リンク
- **[mixi2-js ドキュメント](https://mixi2.js.org/)**
- [mixi2 Developer Platform 公式ドキュメント](https://developer.mixi.social/docs)
- [mixi2-api](https://github.com/mixigroup/mixi2-api) — API 定義（Protocol Buffers）
- [mixi2-application-sdk-go](https://github.com/mixigroup/mixi2-application-sdk-go) — 公式 Go SDK
- [mixi2-application-sample-go](https://github.com/mixigroup/mixi2-application-sample-go) — サンプルアプリケーション
---
## 貢献
貢献を歓迎しています！詳細は [CONTRIBUTING.md](CONTRIBUTING.md) を参照してください。
このプロジェクトは [Contributor Covenant 行動規範](CODE_OF_CONDUCT.md) に準拠しています。
### 貢献者
---
## ライセンス
[Apache-2.0](LICENSE)