bot-api-nodejs-client

mixin 的 js 版 sdk

新版本特性

1. 更友好的类型和代码提示
2. 更规范的函数命名
3. 更全面的测试覆盖

安装

1npm install @mixin.dev/mixin-node-sdk

使用 yarn 安装

1yarn add @mixin.dev/mixin-node-sdk

使用

1. 仅使用 Mixin 的 Api

1const { MixinApi } = require('@mixin.dev/mixin-node-sdk');
2
3const keystore = {
4  app_id: '',
5  session_id: '',
6  server_public_key: '',
7  session_private_key: '',
8};
9const client = MixinApi({ keystore });
10
11// 使用 Promise
12client.user.profile().then(console.log);
13// 使用 async await
14async function getMe() {
15  const me = await client.user.profile();
16  console.log(me);
17}

2. 使用 Mixin 的消息功能

1const { MixinApi } = require('@mixin.dev/mixin-node-sdk');
2
3const keystore = {
4  app_id: '',
5  session_id: '',
6  server_public_key: '',
7  session_private_key: '',
8};
9const config = {
10  keystore,
11  blazeOptions: {
12    parse: true,
13    syncAck: true,
14  },
15};
16
17const client = MixinApi(config);
18client.blaze.loop({
19  onMessage(msg) {
20    console.log(msg);
21  },
22});

3. OAuth 授权

1const { MixinApi, getED25519KeyPair, base64RawURLEncode } = require('@mixin.dev/mixin-node-sdk');
2
3const code = ''; // from OAuth url
4const app_id = ''; // app_id of your bot
5const client_secret = ''; // OAuth Client Secret of your bot
6
7const { seed, publicKey } = getED25519KeyPair(); // Generate random seed and ed25519 key pairs
8
9let client = MixinApi();
10const { scope, authorization_id } = await client.oauth.getToken({
11  client_id: app_id,
12  code,
13  ed25519: base64RawURLEncode(publicKey),
14  client_secret,
15});
16const keystore = {
17  app_id,
18  scope,
19  authorization_id,
20  session_private_key: Buffer.from(seed).toString('hex'),
21};
22client = MixinApi({ keystore });
23const user = await client.user.profile();

贡献

可接受 PRs.

API

1. https://developers.mixin.one/docs/api-overview

版本所有

Copyright 2024 Mixin.