3 Commits

Author SHA1 Message Date
742a562109 feat: 添加queryclient 2024-09-28 22:22:17 +08:00
61a68fbd41 feat: add publish workflow 2024-09-28 19:37:35 +08:00
9ba7fb2f10 fix: types fix 2024-09-28 19:22:00 +08:00
6 changed files with 71 additions and 104 deletions

35
.github/workflow/publish.yml vendored Normal file
View File

@@ -0,0 +1,35 @@
name: Publish to npm
on:
push:
tags:
- 'v*.*.*' # 当推送带有版本号的 tag 时触发,例如 v1.0.0
jobs:
publish:
runs-on: ubuntu-latest
steps:
# Step 1: Clone current Git repository
- name: Checkout this repository
uses: actions/checkout@v3
# Setop 2: list files in current directory
- name: List files in current directory
run: ls -al
# Step 3: Setup Node.js and install dependencies
- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: '20.6'
registry-url: 'https://registry.npmjs.org/'
- name: npm whoami
run: |
npm whoami
echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
# Step 4: Install dependencies
- name: Install dependencies
run: npm install
# Step 5: Publish to npm
- name: Publish package
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} # 使用 GitHub Secrets 来安全存储 npm token
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} # 使用 GitHub Secrets 来安全存储 npm token

View File

@@ -1,38 +0,0 @@
name: Publish to npm
on:
push:
tags:
- 'v*.*.*' # 当推送带有版本号的 tag 时触发,例如 v1.0.0
workflow_dispatch: # 添加手动触发器
jobs:
publish:
runs-on: ubuntu-latest
steps:
# Step 1: Clone current Git repository
- name: Checkout this repository
uses: actions/checkout@v3
# Step 3: Setup Node.js and install dependencies
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '20.6'
registry-url: 'https://registry.npmjs.org/'
cache: 'npm' # 启用 npm 缓存,提高安装速度
- name: Configure npm authentication
run: npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
- name: Install dependencies
run: npm install
- name: Build project
run: npm run build
# Step 6: 发布到 npm
- name: Publish package
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
# Step 7: 发布成功后,更新版本标签
# - name: Create Git tag
# run: |
# TAG="v$(node -p -e "require('./package.json').version")"
# git tag $TAG
# git push origin $TAG

View File

@@ -1,6 +1,6 @@
{ {
"name": "@kevisual/query", "name": "@kevisual/query",
"version": "0.0.7-alpha.1", "version": "0.0.5",
"main": "dist/index.js", "main": "dist/index.js",
"module": "dist/index.js", "module": "dist/index.js",
"types": "dist/index.d.ts", "types": "dist/index.d.ts",
@@ -14,11 +14,8 @@
"files": [ "files": [
"dist" "dist"
], ],
"keywords": [ "keywords": [],
"kevisual", "author": "",
"query"
],
"author": "abearxiong",
"license": "ISC", "license": "ISC",
"description": "", "description": "",
"devDependencies": { "devDependencies": {
@@ -34,10 +31,6 @@
"publishConfig": { "publishConfig": {
"access": "public" "access": "public"
}, },
"repository": {
"type": "git",
"url": "git+ssh://git@github.com/abearxiong/kevisual-query.git"
},
"exports": { "exports": {
".": { ".": {
"import": "./dist/index.js", "import": "./dist/index.js",

View File

@@ -18,24 +18,23 @@ export default [
typescript({ typescript({
allowImportingTsExtensions: true, allowImportingTsExtensions: true,
noEmit: true, noEmit: true,
exclude: ['src/node-adapter.ts'],
}), // 使用 @rollup/plugin-typescript 处理 TypeScript 文件 }), // 使用 @rollup/plugin-typescript 处理 TypeScript 文件
], ],
}, },
// { {
// input: 'src/node-adapter.ts', // TypeScript 入口文件 input: 'src/node-adapter.ts', // TypeScript 入口文件
// output: { output: {
// file: 'dist/node-adapter.js', // 输出文件 file: 'dist/node-adapter.js', // 输出文件
// format: 'es', // 输出格式设置为 ES 模块 format: 'es', // 输出格式设置为 ES 模块
// }, },
// plugins: [ plugins: [
// resolve(), // 使用 @rollup/plugin-node-resolve 解析 node_modules 中的模块 resolve(), // 使用 @rollup/plugin-node-resolve 解析 node_modules 中的模块
// typescript({ typescript({
// allowImportingTsExtensions: true, allowImportingTsExtensions: true,
// noEmit: true, noEmit: true,
// }), // 使用 @rollup/plugin-typescript 处理 TypeScript 文件 }), // 使用 @rollup/plugin-typescript 处理 TypeScript 文件
// ], ],
// }, },
{ {
input: 'src/ws.ts', // TypeScript 入口文件 input: 'src/ws.ts', // TypeScript 入口文件
output: { output: {
@@ -47,7 +46,6 @@ export default [
typescript({ typescript({
allowImportingTsExtensions: true, allowImportingTsExtensions: true,
noEmit: true, noEmit: true,
declaration: false,
}), // 使用 @rollup/plugin-typescript 处理 TypeScript 文件 }), // 使用 @rollup/plugin-typescript 处理 TypeScript 文件
], ],
}, },

View File

@@ -1,6 +1,6 @@
import { adapter } from './adapter.ts'; import { adapter } from './adapter.ts';
import { QueryWs, QueryWsOpts } from './ws.ts'; import { QueryWs } from './ws.ts';
export { QueryOpts, QueryWs }; export { QueryOpts };
type Fn = (opts: { type Fn = (opts: {
url?: string; url?: string;
headers?: Record<string, string>; headers?: Record<string, string>;
@@ -64,7 +64,6 @@ export class Query<U = any, V = any> {
const headers = { ...this.headers, ...options?.headers }; const headers = { ...this.headers, ...options?.headers };
const adapter = options?.adapter || this.adapter; const adapter = options?.adapter || this.adapter;
const beforeRequest = options?.beforeRequest || this.beforeRequest; const beforeRequest = options?.beforeRequest || this.beforeRequest;
const afterResponse = options?.afterResponse || this.afterResponse;
const timeout = options?.timeout || this.timeout; const timeout = options?.timeout || this.timeout;
const req = { const req = {
url: url, url: url,
@@ -77,8 +76,8 @@ export class Query<U = any, V = any> {
} }
return adapter(req).then(async (res) => { return adapter(req).then(async (res) => {
res.success = res.code === 200; res.success = res.code === 200;
if (afterResponse) { if (options?.afterResponse) {
return await afterResponse(res); return await options.afterResponse(res);
} }
return res; return res;
}); });
@@ -98,7 +97,7 @@ export class QueryClient<U = any, V = any> extends Query<U, V> {
storage: Storage; storage: Storage;
token: string; token: string;
qws: QueryWs; qws: QueryWs;
constructor(opts?: QueryOpts & { tokenName?: string; storage?: Storage; io?: boolean }) { constructor(opts?: QueryOpts & { tokenName?: string; storage?: Storage }) {
super(opts); super(opts);
this.tokenName = opts?.tokenName || 'token'; this.tokenName = opts?.tokenName || 'token';
this.storage = opts?.storage || localStorage; this.storage = opts?.storage || localStorage;
@@ -112,12 +111,7 @@ export class QueryClient<U = any, V = any> extends Query<U, V> {
} }
return opts; return opts;
}; };
if (opts?.io) { this.qws = new QueryWs({ url: opts?.url });
this.createWs();
}
}
createWs(opts?: QueryWsOpts) {
this.qws = new QueryWs({ url: this.url });
} }
getToken() { getToken() {
return this.storage.getItem(this.tokenName); return this.storage.getItem(this.tokenName);

View File

@@ -9,7 +9,7 @@ type QueryWsStore = {
}; };
export type QuerySelectState = 'connecting' | 'connected' | 'disconnected'; export type QuerySelectState = 'connecting' | 'connected' | 'disconnected';
export type QueryWsStoreListener = (newState: QueryWsStore, oldState: QueryWsStore) => void; export type QueryWsStoreListener = (newState: QueryWsStore, oldState: QueryWsStore) => void;
export type QueryWsOpts = { type QueryWsOpts = {
url?: string; url?: string;
store?: StoreApi<QueryWsStore>; store?: StoreApi<QueryWsStore>;
ws?: WebSocket; ws?: WebSocket;
@@ -45,31 +45,22 @@ export class QueryWs {
/** /**
* 连接 WebSocket * 连接 WebSocket
*/ */
async connect(opts?: { timeout?: number }) { connect() {
const store = this.store; const store = this.store;
const connected = store.getState().connected; const connected = store.getState().connected;
if (connected) { if (connected) {
return Promise.resolve(true); return;
} }
return new Promise((resolve, reject) => { const ws = this.ws || new WebSocket(this.url);
const ws = this.ws || new WebSocket(this.url); ws.onopen = () => {
const timeout = opts?.timeout || 5 * 60 * 1000; // 默认 2 分钟 store.getState().setConnected(true);
let timer = setTimeout(() => { store.getState().setStatus('connected');
console.error('WebSocket 连接超时'); };
reject('timeout'); ws.onclose = () => {
}, timeout); store.getState().setConnected(false);
ws.onopen = () => { store.getState().setStatus('disconnected');
store.getState().setConnected(true); this.ws = null;
store.getState().setStatus('connected'); };
resolve(true);
clearTimeout(timer);
};
ws.onclose = () => {
store.getState().setConnected(false);
store.getState().setStatus('disconnected');
this.ws = null;
};
});
} }
listenConnect(callback: () => void) { listenConnect(callback: () => void) {
@@ -150,10 +141,4 @@ export class QueryWs {
ws.send(data as string); ws.send(data as string);
} }
} }
getOpen() {
if (!this.ws) {
return false;
}
return this.ws.readyState === WebSocket.OPEN;
}
} }