open-jike/jike-sdk

Ⓙ Jike SDK for Node.js / Deno / browser

jike-sdk Ⓙ Jike SDK

本项目仅供学习交流使用，在使用过程中对你或他人造成的任何损失我们概不负责。

Caution

本项目不再积极维护。

Features

• 🌈 可能是东半球最全的第三方 SDK
• ⭐️ 同时支持 Node.js / 浏览器 / Deno / Bun
• 🦾 自带 TypeScript 类型声明

API 列表

• 用户
  • 获取用户信息
  • 刷新 Access Token
  • 发送登录验证码
  • 短信登录
  • 手机号与密码登录
  • 弹一弹头像
  • 修改用户信息
  • 保存设备 Token
• 用户关系
  • 获取关注列表
  • 获取被关注列表
  • 关注
  • 取消关注
  • 是否关注用户
  • 不看 TA 的内容
  • 重新看 TA 的内容
  • 加入黑名单
  • 解除黑名单
• 动态帖子
  • 发送动态
  • 获取动态详情
  • 删除动态
  • 分享动态
  • 点赞
  • 取消点赞
  • 获取点赞用户列表
  • 隐藏动态
  • 动态转为公开
• 动态广场
  • 获取动态推荐
• 评论
  • 获取动态下评论
  • 获取评论
  • 发送评论 （发送子评论）
  • 点赞
  • 取消点赞
  • 删除评论
• 动态
  • 获取用户动态
  • 获取关注动态
  • 置顶动态
  • 取消置顶动态
• 通知
  • 获取通知列表
  • 获取合并通知列表
  • 获取通知列表（自动展开合并通知）
• 上传
  • 获取上传 token
  • 上传图片
• 日记
  • 获取关注用户日记列表
  • 获取用户的日记详情
• 圈子
  • 获取圈子热门动态
  • 获取圈子动态
  • 搜索圈子

Installation

Node.js

Node.js >= v18.12.0

npm i jike-sdk

ESM 导入

如果使用 ESM 方式导入，需要把 package.json 的 type 设置为 module，或将后缀名改为 .mjs。

// index.mjs

// 使用此版本需 node >= 18 或 自行 ployfill fetch。
import { setApiConfig } from 'jike-sdk'

setApiConfig({
  // ...
})

CJS 导入

const { setApiConfig } = require('jike-sdk')
setApiConfig({
  // ...
})

Bun

Bun >= 0.5.8

bun i jike-sdk

// index.ts
import { setApiConfig } from 'jike-sdk'
setApiConfig({
  // ...
})

Deno

import { setApiConfig } from 'https://cdn.skypack.dev/jike-sdk/index?dts'

浏览器

import { setApiConfig } from 'jike-sdk'

或使用 CDN 的方式加载（与 Deno 一致）

<script type="module">
  import { setApiConfig } from 'https://cdn.skypack.dev/jike-sdk/index'
</script>

由于 CORS 策略的原因，第三方网站无法直接请求外部服务器。但可以使用浏览器扩展的能力请求。

Usage

API Reference

import { ApiClient, api, setAccessToken, setApiConfig } from 'jike-sdk'

// 自行在 GitHub 搜索「jike endpoint」探索配置
const apiConfig = {
  endpointId: 'jike',
  endpointUrl: '<jike-endpoint-url>', // 请自行替换
  bundleId: '<bundle-id>', // 请自行替换
  buildNo: '<build-no>', // 请自行替换
  userAgent: '<jike-sdk-user-agent>', // 请自行替换
  accessToken: '<access-token>', // 请自行替换
}
setApiConfig(apiConfig)

setAccessToken('update-access-token')
api.userRelation.getFollowingList('82D23B32-CF36-4C59-AD6F-D05E3552CBF3', {
  limit: 100,
})

// 或使用 ApiClient
const client = ApiClient(apiConfig)
client.users.profile()

Contributing

see CONTRIBUTING.md

Sponsors

License

AGPL-3.0 License © 2021-PRESENT 三咲智子

jike-sdk's Issues

Add contribution guide

希望可以有脚本可以动态更新config.ts中的accessToken和refreshToken

即刻的accessToken失效很快，调试非常麻烦

API Reference 链接失效

https://blog.sxzz.moe/jike-sdk/ 404 not found

accessToken 是怎么获取的呢？

1. Usage中的accessToken是如何获取的？有指引吗？
2. 登录态过期是怎么处理呢？如果有文档指引就更好了。

[Feature] 用户 - 不看TA的内容

[Feature] 用户 - 编辑资料

[Feature] 用户 - 加入黑名单

增加对类型为 MergedMentions 的通知获取

场景

在即刻的通知机制下，如果短时间有多次被同一个用户@，会把这个用户的消息放到 MergedMentions

[Feature] 搜索

[Feature] 圈子 - 搜索

接口跑不通。。。

// package.json
{
  "name": "web3test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "jike-sdk": "^0.7.0"
  },
  "type": "module"
}

// index.mjs
import { api, setAccessToken, ApiClient } from 'jike-sdk/node'

setAccessToken('这里是我的 TOKEN') //TOKEN 取的是在 Cookie 里的 x-jike-access-token 或者 x-jike-refresh-token
api.userRelation.getFollowingList('82D23B32-CF36-4C59-AD6F-D05E3552CBF3', {
  limit: 100,
})

执行：

node index.mjs

返回报错：

.../web3test/node_modules/jike-sdk/dist/node.mjs:97
}, setAccessToken = (token2) => apiConfig.accessToken = token2, getAccessToken = () => apiConfig.accessToken, _request, request = new Proxy(() => {                                                       ssToken, _request, request = new Proxy(() => {   
                                                      ^

TypeError: Cannot set property 'accessToken' of undefined
    at setAccessToken (.../web3test/node_modules/jike-sdk/dist/node.mjs:97:55)
    at .../web3test/index.mjs:7:1
    at ModuleJob.run (internal/modules/esm/module_job.js:183:25)
    at async Loader.import (internal/modules/esm/loader.js:178:24)
    at async Object.loadESM (internal/process/esm_loader.js:68:5)
    at async handleMainPromise (internal/modules/run_main.js:59:12)

[Feature] 用户 - 特别关心

创建动态接口的 request payload 中的 `topicId` 现在被改为了 `submitToTopic`

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update all non-major dependencies (@sxzz/eslint-config, @sxzz/prettier-config, @types/node, @vitest/ui, bumpp, esbuild, eslint, ky, pnpm, rollup, serve, sharp, tsup, tsx, typedoc, typescript, vitest)

Detected dependencies

github-actions

.github/workflows/release.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/unit-test.yml

• actions/checkout v4
• actions/setup-node v4
• actions/checkout v4
• actions/setup-node v4

npm

package.json

• eventemitter3 ^5.0.1
• ky ^1.2.3
• @faker-js/faker ^8.4.1
• @sxzz/eslint-config ^3.9.0
• @sxzz/prettier-config ^2.0.1
• @types/md5 ^2.3.5
• @types/node ^20.12.6
• @vitest/ui ^2.0.3
• bumpp ^9.4.0
• esbuild ^0.20.2
• eslint ^9.0.0
• md5 ^2.3.0
• rollup ^4.14.1
• serve ^14.2.1
• sharp ^0.33.3
• tsup ^8.0.2
• tsx ^4.7.2
• typedoc ^0.25.13
• typescript ^5.4.4
• vitest ^2.0.3
• pnpm 9.0.5

---

• Check this box to trigger a request for Renovate to run again on this repository