@wener/client
v1.0.19
Published
Client for Wechat, Wecom, Xunfei, etc.
Downloads
2
Readme
@wener/client
- 尽量减少依赖
- 主要就一个依赖 @wener/utils
- 尽量区分 client 和 server
- client 部分确保浏览器可执行
- 尽量使用 web 标准 - 例如 crypto、fetch
- 尽量遵循一定的 pattern
支持客户端
大多只有核心基础实现,尚未包含完整的服务定义(类型生成)
- 阿里云客户端
- 微信客户端
- 企业微信
- 服务端客户端
- JS SDK
- WebHook
- 消息归档
- OpenAI 客户端
- 讯飞火星 大模型 客户端
- 百度 CE 客户端
- 阿里云 大模型 客户端
# for dev version
npm install 'https://gitpkg.now.sh/wenerme/wode/packages/client?main'
OpenAI
import { createFetchWithProxy } from '@wener/utils/server';
import { OpenAiClient } from '@wener/cleint/openai';
const fetch = createFetchWithProxy({
proxy: process.env.OPENAI_PROXY,//e.g. 'http://127.0.0.1:7890',
});
const client = new OpenAiClient({
fetch,
headers: {
Authorization: `Bearer ${process.env.OPENAI_API_KEY}`,
},
});
// list models
console.log(await client.getModels());
AliCloud
- 简单易用的 阿里云 客户端
- 可在浏览器端使用 - 需要自行处理 cors
- 测试、工具为主
- 表明不需要什么依赖
Note Why?
- 阿里云的客户端质量非常的差
- @alicloud/openapi-client 一个文件、一个包
- 19 个依赖
- 最基础的依赖,可能要做非常多的兼容,所有都肉在一起,导致包很大 - 180kB/ gzip 42kB
- 代码质量非常差,非常多 Utils.xyz 调用
- https://www.unpkg.com/browse/@alicloud/[email protected]/src/client.ts 有 242 处
Util.
- @alicloud/openapi-utils 一个文件、一个包
- 阿里云的 API 文档质量非常的差
- 例如 https://help.aliyun.com/zh/sdk/product-overview/v3-request-structure-and-signature
- 签名文档里的 Demo 都对不上,最终产出的的 SignedHeaders 和 Signature 不一致
- 导致怀疑是自己的问题
- API explorer 质量差 - 我就只想要看到 curl 怎么执行的,但实际看不到请求目标、URL、头 等信息
- 返回的 DEBUG 链接当前用户 也打不开
- 我只想要发起一些简单的请求,按需封装结构,请求简单透明,客户端易用
使用 request
- 支持任意请求
- 极少的代码量,最小的 bundle size
import { request } from '@wener/cleint/alicloud';
console.log(
await request({
endpoint: 'dytnsapi.aliyuncs.com',
action: 'QueryTagInfoBySelection',
version: '2020-02-17',
accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,
accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET,
}),
);
使用客户端
- 基于 Proxy 的客户端
- 支持类型推导
import { AliCloudClient } from '@wener/cleint/alicloud';
const aliCloudClient = new AliCloudClient({
accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,
accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET,
});
const api = aliCloudClient.getServiceClient({
// 输入 product 和 version 会有补全
// 更多的接口待生成
product: 'Dytnsapi',
version: '2020-02-17',
});
console.log(await api.QueryTagListPage({}));
企业微信
企业微信 服务端
import { createFileExpiryValue } from '@wener/client/server';
import { WecomCorpClient } from '@wener/client/wecom/server';
const fetch = createFetchWithProxy({
// 如果配置白名单,可以考虑走代理
proxy: process.env.WECOM_PROXY,
});
let client: WecomCorpClient;
client = new WecomCorpClient({
fetch,
corpId: process.env.WECOM_CORP_ID!,
corpSecret: process.env.WECOM_CORP_SECRET!,
// 缓存 token 到文件或别的地方
accessToken: createFileExpiryValue<string>({
path: 'wechat.token.json',
loader: async () => {
const { access_token, expires_at } = await client.getAccessToken();
return {
value: access_token,
expiresAt: expires_at,
};
},
}),
});
// 复用
console.log(`AccessToken`, await client.options.accessToken.get());
console.log(`AccessToken`, await client.options.accessToken.get());
xunfei/spark
参考
- https://developer.work.weixin.qq.com/