@tapd/tapd-node-sdk 1.32.0-beta.5 → 1.42.1-alpha.0

package/README.cloud.md

@@ -0,0 +1,60 @@
+## 简介 🐕🐕
+> 主要用于调用TAPD api v2 接口的SDK<(￣︶￣)↗[GO!]
+
+> 推荐版本: NodeJs 14.13.0+
+
+## Install
+安装SDK包
+```
+npm install @opentapd/tapd-node-sdk
+```
+
+## Usage
+
+#### DEMO
+```javascript
+const SDK = require('@opentapd/tapd-node-sdk');
+
+const api = new SDK({
+    client: 'gggg123', // 你的应用CODE
+    secret: '112A5B9F-D7B9-EC9C-B688-24E44F5043C4', // 密钥 注意保密
+});
+
+
+// api 详细文档可参考tapdAPI的文档
+api.getStories({
+    workspace_id: '755'
+}).then(data => {
+    console.log(data);
+}).catch(e => console.log(e)); 
+
+// 文件上传接口使用方式
+var file = fs.createReadStream('your file path')
+
+// 支持Buffer
+// const {FILE}= require('@tencent/tapd-node-sdk');
+// const { Readable } = require('stream');
+// //Readable
+// const file_stdout = Readable.from(bitmap);
+// var file = new FILE({
+//   stdout: file_stdout,
+//   filename: 'test.jpg',
+// });
+
+api.uploadImage({
+    workspace_id: "755", 
+    image: file
+}).then(data => {
+    console.log(data);
+}).catch(e => console.log(e));
+
+
+api.uploadImage({
+    workspace_id: "755", 
+    image: file
+}).then(data => {
+    console.log(data);
+}).catch(e => console.log(e));
+```
+
+#### [查看所有SDK方法和参数](https://o.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/)

package/{README.md → README.ex.md}

@@ -1,7 +1,7 @@
 ## 简介 🐕🐕
 > 主要用于调用TAPD api v2 接口的SDK<(￣︶￣)↗[GO!]
 
-> 推荐版本: NodeJs 12.13.0+
+> 推荐版本: NodeJs 14.13.0+
 
 ## Install
 安装SDK包

package/README.oa.md

@@ -0,0 +1,103 @@
+## 简介 🐕🐕
+
+> 主要用于调用TAPD api v2 接口的SDK<(￣︶￣)↗[GO!]
+
+> 推荐版本: NodeJs 14.13.0+
+
+## Install
+设置npm工具使用软件源的registry
+```
+npm config set registry https://mirrors.tencent.com/npm/
+```
+安装SDK包
+```
+npm install @tencent/tapd-node-sdk
+```
+
+## Usage
+
+#### 申请应用
+1. 申请和使用应用
+https://o.tapd.woa.com/document/api-doc/API%E6%96%87%E6%A1%A3/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E5%BA%94%E7%94%A8API%E4%BD%BF%E7%94%A8%E6%8C%87%E5%BC%95.html
+
+2. 复制应用ID和密钥
+https://o.tapd.woa.com/admin/{你的应用标识}/dashboard
+![Alt](https://o.tapd.woa.com/document/img/tapd_20417300_1638862843_15.png)
+
+
+#### DEMO
+```javascript
+const SDK = require('@tencent/tapd-node-sdk');
+
+
+
+
+const api = new SDK({
+    client: 'gggg123', // 你的应用CODE
+    secret: '112A5B9F-D7B9-EC9C-B688-24E44F5043C4', // 密钥 注意保密
+});
+
+
+// api 详细文档可参考tapdAPI的文档
+api.getStories({
+    workspace_id: '755'
+}).then(data => {
+    console.log(data);
+}).catch(e => console.log(e)); 
+
+// 文件上传接口使用方式
+var file = fs.createReadStream('your file path')
+
+// 支持Buffer
+// const {FILE}= require('@tencent/tapd-node-sdk');
+// const { Readable } = require('stream');
+// //Readable
+// const file_stdout = Readable.from(bitmap);
+// var file = new FILE({
+//   stdout: file_stdout,
+//   filename: 'test.jpg',
+// });
+
+api.uploadImage({
+    workspace_id: "755", 
+    image: file
+}).then(data => {
+    console.log(data);
+}).catch(e => console.log(e));
+
+
+api.uploadImage({
+    workspace_id: "755", 
+    image: file
+}).then(data => {
+    console.log(data);
+}).catch(e => console.log(e));
+```
+
+#### [查看所有SDK方法和参数](https://o.tapd.woa.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/)
+
+#### IDC 网络的使用
+1. 怎看自己是不是IDC网络, 查看这个[链接](https://iwiki.woa.com/tencent/static/iwiki-editor-pro/dist/preview.html?space=&page=1227785302&id=131410&name=6997554869969258912(1).MP4&size=1160018&language=zh)
+
+2. 如果是IDC网络怎么设置
+```javascript
+const SDK = require('@tencent/tapd-node-sdk');
+
+const api = new SDK({
+    client: 'gggg123', // 你的应用CODE
+    secret: '112A5B9F-D7B9-EC9C-B688-24E44F5043C4', // 密钥 注意保密
+    env: 'idc'
+});
+
+```
+
+
+## Artifact
+ https://mirrors.tencent.com/#/private/npm/detail?repo_id=537&project_name=%40tencent%2Ftapd-node-sdk&search_label=package_name&search_value=tapd-node-sdk&page_num=1
+
+## 其他问题
+
+提issue可能看不到，找tapd客服解决反馈。
+
+## Contributions
+欢迎参与SDK共建！开发&共建流程，请参照 [contributing.md](https://git.woa.com/tapd-plugin-core/tplugin-sdk/blob/dev/CONTRIBUTING.md)。

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@tapd/tapd-node-sdk",
-  "version": "1.32.0-beta.5",
+  "version": "1.42.1-alpha.0",
   "description": "node sdk for open tapd ",
   "main": "src/index.js",
   "scripts": {
     "test": "npm run test",
     "generate": "npm install && node scripts/sdk.generator",
-    "lint": "npx eslint  --fix --ext .js ./src ./scripts ./test"
+    "build": "node scripts/sdk.generator",
+    "lint": "npx eslint  --fix --ext .js ./src ./scripts ./test",
+    "ex_replace_package_json": "node ../../../scripts/replace-tencent-in-package-json/main.js @tapd",
+    "replace_package_json": "node ../../../scripts/replace-tencent-in-package-json/main.js @opentapd"
   },
   "keywords": [
     "node",
@@ -19,12 +22,13 @@
   "devDependencies": {
     "@babel/core": "^7.15.0",
     "ejs": "^3.1.6",
-    "eslint": "^7.32.0"
+    "eslint": "^7.32.0",
+    "eslint-config-tencent": "^1.0.4"
   },
   "dependencies": {
     "axios": "^0.21.4",
-    "form-data": "^2.3.3",
     "camel-case": "^4.1.2",
+    "form-data": "^2.3.3",
     "js-base64": "^3.7.2",
     "lodash": "^4.17.21",
     "lodash.get": "^4.4.2",
@@ -37,7 +41,8 @@
   "files": [
     "src"
   ],
-  "npm": {
-    "alias": "@tencent/tapd-node-sdk"
-  }
+  "directories": {
+    "test": "test"
+  },
+  "gitHead": "8f02238ddf5e60e934b8be8643372667566c43b1"
 }

package/src/sdk.js

@@ -1,5 +1,6 @@
 const get = require('lodash.get');
 const Axios = require('./axios');
+const crypto = require('crypto');
 const { ReadStream } = require('fs');
 const FormData = require('form-data');
 const { Base64 } = require('js-base64');
@@ -12,11 +13,13 @@ class SDK {
     address = '',
     accessToken = '',
     authType = '',
+    rioToken = '',
   } = {}) {
     this.client = client;
     this.secret = secret;
     this.address = address;
     this.axios = Axios(this.address);
+    this.rioToken = rioToken;
 
     if (authType !== '') {
       this.authType = authType;
@@ -129,6 +132,15 @@ class SDK {
     const authHeader = this.isOauth() ? `Bearer ${accessToken}` : `Basic ${Base64.encode(`${this.client}:${this.secret}`)}`;
     const upperMethod = method.toUpperCase();
 
+    const headers = {}
+    if ( this.rioToken !== ""){
+      const timestamp = (Date.now() / 1000).toFixed()
+      const signature = crypto.createHash('sha256').update(`${timestamp}${this.rioToken }${timestamp}`).digest('hex');
+  
+      headers['timestamp'] = timestamp
+      headers['signature'] = signature
+    }
+
     const config = {
       ...args,
       method,
@@ -136,7 +148,7 @@ class SDK {
       params: upperMethod === 'GET' ? params : {},
       data: upperMethod === 'GET' ? undefined : params,
       // 使用Bearer or Basic方式发起鉴权
-      headers: { Authorization: authHeader },
+      headers: { ...headers, ...{ Authorization: authHeader }},
     };
 
     if (Object.values(params).some(value => value instanceof ReadStream ||  value instanceof FILE)) {