apass-opensdk-hugong 1.0.1 → 1.0.3

package/index.js

@@ -170,10 +170,12 @@ class HG{
     if(Array.isArray(zh)){
       //开放平台一般返回内容
       if(zh[0].hasOwnProperty('lang')){
-        return new application.constants.type.Multilingual({ zh: this.toSafeValue(zh.find(it=>it.lang == 'zh-CN'),'value'), en: this.toSafeValue(zh.find(it=>it.lang == 'en-US'),'value') })
+        const _zh = this.toSafeValue(zh.find(it=>it.lang == 'zh-CN'),'value')
+        const _en = this.toSafeValue(zh.find(it=>it.lang == 'en-US'),'value')
+        return new application.constants.type.Multilingual({ zh: _zh || _en, en: _en || _zh })
       }
     }
-    return new application.constants.type.Multilingual({ zh, en })
+    return new application.constants.type.Multilingual({ zh: zh || en, en: en || zh })
   }
 
   /**
@@ -184,14 +186,17 @@ class HG{
    * @returns 
    */
   toSafeValue(obj,key,defValue){
-    if(!obj){
+    const _obj = obj || {}
+    if(!_obj){
       return defValue
     }
-    if(!obj.hasOwnProperty(key)){
+    if(!_obj.hasOwnProperty(key)){
       return defValue
     }
-    return obj[key] || defValue
+    return _obj[key] || defValue
   }
 
+
+
 }
 module.exports = HG

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apass-opensdk-hugong",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "飞书Apass低代码平台-飞书开放平台-相关的接口整合和常用的方法整合",
   "main": "index.js",
   "scripts": {
@@ -14,6 +14,6 @@
     "APASS",
     "feish"
   ],
-  "author": "IAMRuiyu",
+  "author": "微信：IAMRuiyu",
   "license": "ISC"
 }

package/readme.md

@@ -1,6 +1,6 @@
 # apass-opensdk-hugong
 ## 简介
-apass-opensdk-hugong 是一个基于apass-opensdk的封装，提供了一些常用的功能，如：
+apass-opensdk-hugong 是一个基于apass-opensdk的封装，提供了一些常用的功能
 - 什么人可以使用这个SDK
 - 从事飞书低代码平台（APASS）开发人员.
 
@@ -8,14 +8,28 @@ apass-opensdk-hugong 是一个基于apass-opensdk的封装，提供了一些常
 
 ```
 在飞书低代码平台（云函数）依赖管理-右侧-搜索： apass-opensdk-hugong
+
+最近有同学私聊我说Apass无法安装1.0.0以上的包，解决思路： 先安装1.0.0版本，然后打开yarn.lock文件
+====== 找到这一行 =====
+apass-opensdk-hugong@1.0.0:
+  version "1.0.0"
+  resolved "https://registry.npmmirror.com/apass-opensdk-hugong/-/apass-opensdk-hugong-1.0.0.tgz#ef2d0a19e793358784cb764de4b885fd86befd66"
+  integrity sha512-Q8Gpo9v8a/2G43y/Lh2POyDEOcealFuUlGdqGSA9wyfjET4+LWs/PnzK9EB1YZCjQotW7cGO/9a0MiQ6Sgw1LA==
+====== 找到这一行 =====
+
+将版本改为最新的版本号后，然后保存，重写部署即可使用NPM源最新的版本
+修改后的yarn.lock文件如下， 一共三处地方：
+apass-opensdk-hugong@1.0.3:
+  version "1.0.3"
+  resolved "https://registry.npmmirror.com/apass-opensdk-hugong/-/apass-opensdk-hugong-1.0.3.tgz#ef2d0a19e793358784cb764de4b885fd86befd66"
+  integrity sha512-Q8Gpo9v8a/2G43y/Lh2POyDEOcealFuUlGdqGSA9wyfjET4+LWs/PnzK9EB1YZCjQotW7cGO/9a0MiQ6Sgw1LA==
 ```
 
 ## 如何使用
 ```
 const Hugong = require('apass-opensdk-hugong');
+初始化
 const hg = new Hugong(logger)
-
-do something
 ```
 ## 常用
 ```
@@ -23,18 +37,42 @@ do something
 hg.newTime()
 hg.printTime()
 
-线程睡眠
+线程睡眠(毫秒)
 await hg.sleep(2000)
 
 支持将数组分割成指定长度分段数组 
-第一种用法，一次性返还分割后的数组 [ [50],[50] ]
-const list = hg.utils.splitArray([], 50)
+第一种用法，一次性返还分割后的数组
+const list = hg.utils.splitArray([], 50) 输出  [ [50],[50] ]
 
 第二种用法，每次输出50条 处理完成后继续下次执行
 await hg.utils.splitArray([], 10, async (items)=>{
     // do something
 })
 
+```
+## 文件上传/下载
+
+```
+1）从网络下载文件后上传到飞书租户空间，返回上传后的文件信息
+await hg.utils.file.downloadFileToUpload(url)
+2）如果有鉴权, 可以传递header参数
+await hg.utils.file.downloadFileToUpload(url,{ Authorization: `...`})
+3）保存数据到本地环境中，比如接口返回的数据需要保存到本地环境中方便查看
+saveDataToEnv(data，path) 
+
+1）从飞书租户空间下载文件到本地环境中
+file_info={ id, mime_type, name, ...}
+file_path=存储地址可选,不填写则默认当前时间戳
+await hg.utils.file.downloadFileToTmp(fileInfo,file_path)
+
+2）解析csv文件,file_path必须是本地环境的文件路径 /tep/aaa.csv 可以使用上面的方法downloadFileToTmp下载文件到本地环境中
+await hg.utils.file.csvRead(file_path,callback)
+示例1 读取完成后返回数组
+const list = await hg.utils.file.csvRead(file_path)
+示例2 读取完成后回调
+await hg.utils.file.csvRead(file_path,async (row)=>{
+    // do something
+})
 ```
 
 ## 小工具/多语言
@@ -46,13 +84,8 @@ await hg.utils.splitArray([], 10, async (items)=>{
 hg.toMultilingual([{ lang: 'en-US', value: 'Regular' },{ lang: 'zh-CN', value: '正式' }]) 常用于开放平台返回的多语言数据转换
 hg.toMultilingual(zh,en)
 
-/**
-* 安全的取值
-* @param {*} obj 
-* @param {*} key 
-* @param {*} defValue 默认值
-*/
-toSafeValue(obj,key,defValue)
+安全的取值
+hg.toSafeValue(obj={},key,defValue)
 
 ```
 

package/utils/file_.js

@@ -0,0 +1,81 @@
+const fs = require('fs')
+class File_{
+  #hg = null
+  #logger = null
+  constructor(logger,hg){
+    this.#logger = logger
+    this.#hg = hg
+  }
+  getCurrentTimeFolderName() {
+    const now = new Date();
+    const year = now.getFullYear();
+    const month = String(now.getMonth() + 1).padStart(2, '0');
+    const day = String(now.getDate()).padStart(2, '0');
+    const hours = String(now.getHours()).padStart(2, '0');
+    const minutes = String(now.getMinutes()).padStart(2, '0');
+    const seconds = String(now.getSeconds()).padStart(2, '0');
+    return `${year}-${month}-${day}_${hours}-${minutes}-${seconds}`;
+  }
+  /**
+   * * 网络下载文件并上传到租户空间
+   * @param {*} url 网络文件地址
+   * @param {*} header 可选
+   * @returns 
+   */
+  async downloadFileToUpload(url, header = {}){
+    this.#logger.log(`download url=${url}`)
+    const resp = await axios({ url, method: 'get', responseType: 'stream', headers: {...header} });
+    // 上传文件获取文件 token
+    const file_info = await application.resources.file.upload(resp.data);
+    this.#logger.log('file_info',file_info)
+    return file_info
+  }
+  /**
+   * 下载租户空间的文件到环境tmp目录中
+   * @param {*} file_info { id, mime_type, name, ...}
+   * @param {*} file_path 存储地址可选,不填写则默认当前时间戳
+   * @returns 
+   */
+  async downloadFileToTmp(file_info, file_path){
+    this.#logger.log(`download input=${ JSON.stringify(file_info)}`)
+    const _file_path = file_path || `/tmp/${Date.now()}.${ file_info.mime_type }`
+    await application.resources.file.download({id: file_info.id}, _file_path);
+    this.#logger.log(`download success, path=` + _file_path)
+    return _file_path
+  }
+  /**
+   * 写入文件
+   * @param {*} data 写入的内容
+   * @param {*} fileName 存储地址
+   */
+  saveDataToEnv(data,fileName){
+    fs.writeFileSync(fileName || `${ Date.now() }.txt`,data, { flag: 'a' })
+  }
+  /**
+   * 读取Excel文件（需要安装依赖：csv-parser）
+   * @param {*} path 
+   * @param {*} callback(row) 每一行的回调
+   * @returns  callback为null时，返回全部读取的结果list
+   */
+  async csvRead(path,callback) {
+    const csv = require('csv-parser');
+    return await new Promise((resolve, reject) => {
+      const list = []
+      fs.createReadStream(path).pipe(csv())
+      .on('data', (row) => {
+        if(callback){
+          callback(row)
+        }else{
+          list.push(row)
+        }
+      })
+      .on('end', () => {
+        resolve(list)
+      })
+      .on('error',()=>{
+        reject()
+      });
+    })
+  }
+}
+module.exports = File_

package/utils/index.js

@@ -1,4 +1,5 @@
 const Url = require('./url')
+const File_ = require('./file_')
 class Utils{
   #hg = null
   #logger = null
@@ -7,6 +8,7 @@ class Utils{
     this.#hg = hg
 
     this.url = new Url(logger,hg)
+    this.file = new File_(logger,hg)
   }
 
   /**
@@ -29,5 +31,11 @@ class Utils{
     return result;
   }
   
+
+
+  
+
+  
+
 }
 module.exports = Utils

package/utils/url.js

@@ -1,3 +1,4 @@
+
 class Url{
   #hg = null
   #logger = null
@@ -15,6 +16,5 @@ class Url{
     }
     return params.toString();
   }
-
 }
 module.exports = Url