apass-opensdk-hugong 1.0.0 → 1.0.2

package/index.js

@@ -1,5 +1,9 @@
 const Users = require('./opensdk/users')
 const Document = require('./opensdk/document')
+const Utils = require('./utils/index')
+const Employee = require('./opensdk/employee')
+const Contract = require('./opensdk/contract')
+
 class HG{
   #logger
   #app_id
@@ -8,6 +12,10 @@ class HG{
     this.#logger = logger
     this.users = new Users(logger, this)
     this.document = new Document(logger, this)
+    this.employee = new Employee(logger, this)
+    this.contract = new Contract(logger, this)
+    
+    this.utils = new Utils(logger, this)
     this._time = null
   }
   /**
@@ -62,41 +70,133 @@ class HG{
     this.#app_id = app_id
     this.#app_secret = app_secret
   }
+
   /**
    * 开平token
    * @returns 
    */
   async getToken(){
-    const result = await this.request('https://open.feishu.cn/open-apis/auth/v3/app_access_token/internal',{ app_id: this.#app_id, app_secret: this.#app_secret})
+    const result = await this.request('https://open.feishu.cn/open-apis/auth/v3/app_access_token/internal',{ app_id: this.#app_id, app_secret: this.#app_secret},false)
     return result.tenant_access_token
   }
 
+  async requestGet(url, params, headers=true){
+    return this.request([url, params], null, headers, 'GET')
+  }
+
   /**
    * 统一网络请求
    * @param {*} url 
+   * @param {*} params 
    * @param {*} data 
    * @param {*} headers 
+   * @param {*} method 
    * @returns 
    */
-  async request(url, data, headers){
-    let HGheader = { 'Content-Type': 'application/json; charset=utf-8' }
+  async request(url, data, headers = true, method = 'POST'){
+    let newHeaders = { 'Content-Type': 'application/json; charset=utf-8' }
     if(typeof headers === 'boolean' && headers === true){
-      HGheader['Authorization'] = `Bearer ${ await this.getToken() }`
+      newHeaders['Authorization'] = `Bearer ${ await this.getToken() }`
     }else{
-      HGheader = { ...HGheader,...(headers || {}) }
+      newHeaders = { ...newHeaders,...(headers || {}) }
+    }
+    this.#logger.log('req=',url,data,newHeaders)
+    let _url = url
+    let params = null
+    if(Array.isArray(url)){
+      _url = url[0]
+      params =  url[1]
     }
-    this.#logger.log('req=',url,data,HGheader)
     return new Promise((r,s)=>{
       const now = Date.now()
-      axios({ method: 'POST', url, data, headers: HGheader}).then(response=>{
+      axios({ method, params, url: _url, data, headers: newHeaders}).then(response=>{
         this.#logger.info('resp=',(Date.now() - now) / 1000, 's',response.status, response.statusText,response.data)
         r(response.data)
       }).catch(e=>{
+        console.log(e)
         this.#logger.error('resp=',(Date.now() - now) / 1000, 's',e.response.data)
         s(e.response.data)
       })
     })
   }
+  /**
+   * 分页返回开放平台数据
+   * @param {*} url 
+   * @param {*} params 
+   * @param {*} callback callback(items) 结果回调（根据总数可能多次调用）- 可选
+   * @returns 如果callback为传递则一次性返回所有的数据
+   */
+  async paginatedSearchGet(url,params,callback){
+    return this.paginatedSearch(url, params, null, callback, 'GET')
+  }
+  /**
+   * 分页返回开放平台数据
+   * @param {*} url 
+   * @param {*} params 
+   * @param {*} data 
+   * @param {*} callback callback(items) 结果回调（根据总数可能多次调用）- 可选
+   * @returns 如果callback为传递则一次性返回所有的数据
+   */
+   async paginatedSearch(url,params,data,callback,method='POST'){
+    let list =  []
+    let page_token = null
+    let has_more = false
+    do {
+      const result = await this.request([url, {...(params || {page_size: 100}), page_token}],data,true,method)
+      page_token = result.data.page_token
+      has_more = result.data.has_more
+      if(callback){
+        await callback(result.data.items || [])
+      }else{
+        list.push(...(result.data.items || []))
+      }
+    } while (has_more);
+    return list
+  }
+
+  async getAllUser(field){
+    const list = []
+    await application.data.object('_user').select(field || ['_id','_name']).findStream(async records=>list.push(...records))
+    return list
+  }
+
+  /**
+   * 生成多语言对象
+   * @param {*} zh 
+   * @param {*} en 
+   * @returns 
+   */
+  toMultilingual(zh,en){
+    if(Array.isArray(zh)){
+      //开放平台一般返回内容
+      if(zh[0].hasOwnProperty('lang')){
+        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: zh || en, en: en || zh })
+  }
+
+  /**
+   * 安全的取值
+   * @param {*} obj 
+   * @param {*} key 
+   * @param {*} defValue 
+   * @returns 
+   */
+  toSafeValue(obj,key,defValue){
+    const _obj = obj || {}
+    if(!_obj){
+      return defValue
+    }
+    if(!_obj.hasOwnProperty(key)){
+      return defValue
+    }
+    return _obj[key] || defValue
+  }
+
+
 
 }
 module.exports = HG

package/opensdk/contract.js

@@ -0,0 +1,19 @@
+class Contract{
+  #hg = null
+  #logger = null
+  constructor(logger,hg){
+    this.#logger = logger
+    this.#hg = hg
+  }
+  
+  /**
+   * 通过手机号或邮箱获取用户 ID
+   * @param {*} user_id_type  user_id、open_id、union_id
+   * @returns 
+   */
+  async batch_get_id(data,user_id_type){
+    return await this.#hg.request(`https://open.feishu.cn/open-apis/contact/v3/users/batch_get_id?user_id_type=${user_id_type || 'open_id'}`,data,true)
+  }
+
+}
+module.exports = Contract

package/opensdk/document.js

@@ -1,48 +1,48 @@
 class Document{
-    #logger = null
-    #hg = null
-    constructor(logger,hg){
-      this.#logger = logger
-      this.#hg = hg
-    }
-    /**
-     * 增加协作者权限 https://open.feishu.cn/document/server-docs/docs/permission/permission-member/create 
-     * @param {*} app_token app_token 多维表格 App 的唯一标识
-     * @param {*} type 文件类型 bitable：多维表格
-     * @param {*} data {
-          "member_type": "openchat",
-          "member_id": "oc_b962e8debdc37712a1d60bb97087a8e8",
-          "perm": "edit",
-          "perm_type": "container",
-          "type": "chat"
-        }
-     */
-    async permissions(app_token,type,data){
-      if(!type){ 
-        throw 'type is not empty'
+  #logger = null
+  #hg = null
+  constructor(logger,hg){
+    this.#logger = logger
+    this.#hg = hg
+  }
+  /**
+   * 增加协作者权限 https://open.feishu.cn/document/server-docs/docs/permission/permission-member/create 
+   * @param {*} app_token app_token 多维表格 App 的唯一标识
+   * @param {*} type 文件类型 bitable：多维表格
+   * @param {*} data {
+        "member_type": "openchat",
+        "member_id": "oc_b962e8debdc37712a1d60bb97087a8e8",
+        "perm": "edit",
+        "perm_type": "container",
+        "type": "chat"
       }
-      return await this.#hg.request(`https://open.feishu.cn/open-apis/drive/v1/permissions/${app_token}/members?type=${type}&need_notification=false`,data,true)
-    }
-    /**
-     * 复制多维表格 https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/copy
-     * @param {*} app_token 要复制的多维表格 App 的唯一标识
-     * @param {*} name 多维表格 App 名称。最长为 255 个字符
-     * @param {*} folder_token 文件夹
-     * @returns 
-     */
-    async copy(app_token,name,folder_token,without_content,time_zone){
-      return await this.#hg.request(`https://open.feishu.cn/open-apis/bitable/v1/apps/${app_token}/copy`,{ name,folder_token,without_content: without_content || false,time_zone: time_zone || 'Asia/Shanghai' },true)
+   */
+  async permissions(app_token,type,data){
+    if(!type){ 
+      throw 'type is not empty'
     }
-    /**
-     * 创建多维表格 https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/create
-     * @param {*} name 多维表格 App 名称
-     * @param {*} folder_token 多维表格 App 归属文件夹
-     * @param {*} time_zone 
-     * @returns 
-     */
-    async create(name, folder_token, time_zone){
-      return await this.#hg.request('https://open.feishu.cn/open-apis/bitable/v1/apps',{ name, folder_token, time_zone: time_zone || 'Asia/Shanghai' },true)
-    }
-  
+    return await this.#hg.request(`https://open.feishu.cn/open-apis/drive/v1/permissions/${app_token}/members?type=${type}&need_notification=false`,data,true)
+  }
+  /**
+   * 复制多维表格 https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/copy
+   * @param {*} app_token 要复制的多维表格 App 的唯一标识
+   * @param {*} name 多维表格 App 名称。最长为 255 个字符
+   * @param {*} folder_token 文件夹
+   * @returns 
+   */
+  async copy(app_token,name,folder_token,without_content,time_zone){
+    return await this.#hg.request(`https://open.feishu.cn/open-apis/bitable/v1/apps/${app_token}/copy`,{ name,folder_token,without_content: without_content || false,time_zone: time_zone || 'Asia/Shanghai' },true)
+  }
+  /**
+   * 创建多维表格 https://open.feishu.cn/document/server-docs/docs/bitable-v1/app/create
+   * @param {*} name 多维表格 App 名称
+   * @param {*} folder_token 多维表格 App 归属文件夹
+   * @param {*} time_zone 
+   * @returns 
+   */
+  async create(name, folder_token, time_zone){
+    return await this.#hg.request('https://open.feishu.cn/open-apis/bitable/v1/apps',{ name, folder_token, time_zone: time_zone || 'Asia/Shanghai' },true)
   }
-  module.exports = Document
+
+}
+module.exports = Document

package/opensdk/employee.js

@@ -0,0 +1,20 @@
+class Employee{
+  #hg = null
+  #logger = null
+  constructor(logger,hg){
+    this.#logger = logger
+    this.#hg = hg
+  }
+  
+  /**
+   * 搜索员工信息
+   * @param {*} params 
+   * @param {*} data 
+   * @param {*} callback(items) 结果回调（根据总数可能多次调用）
+   */
+  async search(params,data,callback){
+    return await this.#hg.paginatedSearch(`https://open.feishu.cn/open-apis/corehr/v2/employees/search`,params,data,callback)
+  }
+
+}
+module.exports = Employee

package/opensdk/users.js

@@ -1,19 +1,19 @@
 class Users{
-    #hg = null
-    #logger = null
-    constructor(logger,hg){
-      this.#logger = logger
-      this.#hg = hg
-    }
-    
-    /**
-     * 通过手机号或邮箱获取用户 ID
-     * @param {*} user_id_type  user_id、open_id、union_id
-     * @returns 
-     */
-    async batch_get_id(data,user_id_type){
-      return await this.#hg.request(`https://open.feishu.cn/open-apis/contact/v3/users/batch_get_id?user_id_type=${user_id_type || 'open_id'}`,data,true)
-    }
+  #hg = null
+  #logger = null
+  constructor(logger,hg){
+    this.#logger = logger
+    this.#hg = hg
+  }
   
+  /**
+   * 通过手机号或邮箱获取用户 ID
+   * @param {*} user_id_type  user_id、open_id、union_id
+   * @returns 
+   */
+  async batch_get_id(data,user_id_type){
+    return await this.#hg.request(`https://open.feishu.cn/open-apis/contact/v3/users/batch_get_id?user_id_type=${user_id_type || 'open_id'}`,data,true)
   }
-  module.exports = Users
+
+}
+module.exports = Users

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apass-opensdk-hugong",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "飞书Apass低代码平台-飞书开放平台-相关的接口整合和常用的方法整合",
   "main": "index.js",
   "scripts": {

package/readme.md

@@ -0,0 +1,133 @@
+# apass-opensdk-hugong
+## 简介
+apass-opensdk-hugong 是一个基于apass-opensdk的封装，提供了一些常用的功能
+- 什么人可以使用这个SDK
+- 从事飞书低代码平台（APASS）开发人员.
+
+## 安装
+
+```
+在飞书低代码平台（云函数）依赖管理-右侧-搜索： apass-opensdk-hugong
+```
+
+## 如何使用
+```
+const Hugong = require('apass-opensdk-hugong');
+初始化
+const hg = new Hugong(logger)
+```
+## 常用
+```
+显示运行时间
+hg.newTime()
+hg.printTime()
+
+线程睡眠(毫秒)
+await hg.sleep(2000)
+
+支持将数组分割成指定长度分段数组 
+第一种用法，一次性返还分割后的数组
+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
+})
+```
+
+## 小工具/多语言
+
+```
+对象数据新增多语言对象
+
+生成多语言对象
+hg.toMultilingual([{ lang: 'en-US', value: 'Regular' },{ lang: 'zh-CN', value: '正式' }]) 常用于开放平台返回的多语言数据转换
+hg.toMultilingual(zh,en)
+
+安全的取值
+hg.toSafeValue(obj={},key,defValue)
+
+```
+
+## 飞书人事
+
+搜索员工信息
+
+```
+设置appid和appsecret
+await hg.setAppId('cli_000000000','0000000000000')
+
+/**
+* 搜索员工信息
+* @param {*} params 
+* @param {*} data 
+* @param {*} callback callback(items) 结果回调（根据总数可能多次调用）- 可选
+* @returns 如果callback为传递则一次性返回所有的数据
+*/
+await hg.employee.search(params,data,callback)
+
+// 示例[具体参数请参考开放平台定义](https://open.feishu.cn/document/server-docs/corehr-v1/employee/search)
+await hg.employee.search({ page_size:100,user_id_type:'user_id',},{ /* 要查询的字段 */}, async (items)=>{
+    // do something 假设服务端有300条数据，每次返回100条，会调用3次, 如果希望一次性返回所有数据，callback传null即可
+})
+const list = await hg.employee.search(params,data) //这将一次性返回所有数据
+```
+## 开放平台分页获取所有数据
+
+所有的分页接口都可以使用
+
+```
+设置appid和appsecret
+await hg.setAppId('cli_000000000','0000000000000')
+
+/**
+* GET类型接口分页返回开放平台数据
+* @param {*} url 
+* @param {*} params 
+* @param {*} callback callback(items) 结果回调（根据总数可能多次调用）- 可选
+* @returns callback为null，则一次性返回所有的数据
+*/
+hg.paginatedSearchGet(url,params,callback)
+
+/**
+* POST接口分页返回开放平台数据
+* @param {*} url 
+* @param {*} params 
+* @param {*} data 
+* @param {*} callback callback(items) 结果回调（根据总数可能多次调用）- 可选
+* @returns callback为null，则一次性返回所有的数据
+*/
+await hg.paginatedSearch(url,params,data,callback)
+
+示例1
+const list = await hg.paginatedSearchGet(url, params, data)
+示例2
+await hg.paginatedSearchGet(url, params, async (items)=>{
+    // do something  假设服务端有300条数据，每次返回100条，会调用3次, 如果希望一次性返回所有数据，callback传null即可
+})
+```

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

@@ -0,0 +1,41 @@
+const Url = require('./url')
+const File_ = require('./file_')
+class Utils{
+  #hg = null
+  #logger = null
+  constructor(logger,hg){
+    this.#logger = logger
+    this.#hg = hg
+
+    this.url = new Url(logger,hg)
+    this.file = new File_(logger,hg)
+  }
+
+  /**
+   * 数组分割
+   * @param {*} list 
+   * @param {*} chunkSize 分割长度
+   * @param {*} callback(item) 分割后回调(不传递则方法返回切割长度后的数组)
+   * @returns 
+   */
+   async splitArray(list, chunkSize, callback) {
+    const result = [];
+    for (let i = 0; i < list.length; i += chunkSize) {
+      const batch = list.slice(i, i + chunkSize)
+      if(callback){
+        await callback(batch)
+        continue
+      }
+      result.push(batch); // 使用 slice 方法按 chunkSize 进行切割
+    }
+    return result;
+  }
+  
+
+
+  
+
+  
+
+}
+module.exports = Utils

package/utils/url.js

@@ -0,0 +1,20 @@
+
+class Url{
+  #hg = null
+  #logger = null
+  constructor(logger,hg){
+    this.#logger = logger
+    this.#hg = hg
+  }
+  
+  jsonToUrlParams(jsonData) {
+    const params = new URLSearchParams();
+    for (const key in jsonData) {
+        if (jsonData[key]) {
+            params.append(key, jsonData[key]);
+        }
+    }
+    return params.toString();
+  }
+}
+module.exports = Url