apaas-oapi-client 0.1.0 → 0.1.2

package/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Node.js CI & Publish
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build-test-publish:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Run Tests
+        run: npm test
+
+      - name: Debug npm token
+        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc && cat ~/.npmrc
+
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2025-06-30
+### Added
+- 🎉 初始化 aPaaS OpenAPI Node.js SDK
+- ✅ 获取 accessToken
+- ✅ records 查询（支持分页迭代）
+- ✅ record 单条查询
+- ✅ record 单条更新、批量更新
+- ✅ record 单条删除、批量删除
+- ✅ 内置 Bottleneck 限流器
+- ✅ 自定义日志等级
+
+---
+
+## [Unreleased]
+- ✨ 新功能开发中...

package/README.md

@@ -0,0 +1,27 @@
+# apaas-oapi-client
+
+[![npm version](https://img.shields.io/npm/v/apaas-oapi-client.svg)](https://www.npmjs.com/package/apaas-oapi-client)
+[![license](https://img.shields.io/npm/l/apaas-oapi-client.svg)](LICENSE)
+
+🚀 **aPaaS OpenAPI Node.js 客户端 SDK**
+
+封装 aPaaS 平台 RESTful API 的 Node.js SDK，简化接口调用，内置限流与 token 缓存功能。
+
+---
+
+## ✨ **功能特性**
+
+- ✅ 获取 accessToken
+- ✅ records 查询（支持分页迭代）
+- ✅ record 单条查询
+- ✅ record 单条更新、批量更新
+- ✅ record 单条删除、批量删除
+- ✅ 内置 Bottleneck 限流器
+- ✅ 自定义日志等级
+
+---
+
+## 📦 **安装**
+
+```bash
+npm install apaas-oapi-client

package/dist/index.js

@@ -2,6 +2,7 @@
 
 var dayjs = require('dayjs');
 var axios = require('axios');
+var Bottleneck = require('bottleneck');
 
 /**
  * 日志等级枚举
@@ -16,7 +17,32 @@ var LoggerLevel;
     LoggerLevel[LoggerLevel["trace"] = 5] = "trace";
 })(LoggerLevel || (LoggerLevel = {}));
 
-const { functionLimiter } = require('./limiter');
+/**
+ * 默认 apaas 限流配置
+ */
+const apaasLimiterOptions = {
+    minTime: 200, // 每秒最多发起 5 个数据库操作
+    reservoir: 20, // 最多同时查询 50 个数据库操作
+    reservoirRefreshAmount: 20, // 每次查询完毕后，重置为 50 个数据库操作
+    reservoirRefreshInterval: 1000 // 重置时间间隔为 1 秒
+};
+/**
+ * 创建限流器
+ * @param fn 被限流函数
+ * @param options 自定义限流配置
+ * @returns 包装后的限流函数
+ */
+async function functionLimiter(fn, options = {}) {
+    const limiter = new Bottleneck({
+        minTime: options.minTime || apaasLimiterOptions.minTime,
+        reservoir: options.reservoir || apaasLimiterOptions.reservoir,
+        reservoirRefreshAmount: options.reservoirRefreshAmount || apaasLimiterOptions.reservoirRefreshAmount,
+        reservoirRefreshInterval: options.reservoirRefreshInterval || apaasLimiterOptions.reservoirRefreshInterval
+    });
+    const wrapped = limiter.wrap(fn);
+    return wrapped();
+}
+
 /**
  * aPaaS OpenAPI 客户端
  */

package/package.json

@@ -1,8 +1,9 @@
 {
     "name": "apaas-oapi-client",
-    "version": "0.1.0",
+    "version": "0.1.2",
     "exports": {
-        "./node-sdk": "./dist/index.js"
+        "./node-sdk": "./dist/index.js",
+        ".": "./dist/index.js"
     },
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/index.ts

@@ -1,7 +1,7 @@
 import dayjs from 'dayjs';
 import axios, { AxiosInstance } from 'axios';
 import { LoggerLevel } from './logger';
-const { functionLimiter } = require('./limiter');
+import { functionLimiter } from './limiter';
 
 /**
  * Client 初始化配置