tadcode-wpsjs 0.3.2 → 1.1.0

package/README.md

@@ -5,6 +5,7 @@
 - [**WPS多维表格：“开发”功能使用说明文档**](https://365.kdocs.cn/l/ctzsgDlAGF0l)
 - [**执行AirScript脚本操作使用指南**](https://365.kdocs.cn/l/cdQOqc6TZuMk)
 - [**快速入门多维表“开发”**](https://365.kdocs.cn/l/ctx1jAV1xJhR)
+- [**WPS开放平台dbsheet-Api部分**](https://365.kdocs.cn/3rd/open/documents/app-integration-dev/guide/dbsheet/Api/api-instro)
 
 ## 联系我
 
@@ -51,11 +52,11 @@ const scriptToken = 'xxxx'
 /* webhook url地址 具体获取方式参考上面 */
 const webhookURL = 'xxxx'
 const wpsjsGlobal = initRemoteCallWpsjsGlobal({ scriptToken, webhookURL,  })
-const data = await wpsjsGlobal.Application.Sheet.GetSheets().execution()
+const data = await wpsjsGlobal.Application.Sheet.GetSheets()
 console.log(data)
 ```
 
-### 对于智能表格执行赋值操作
+### 重命名（远程赋值操作）
 
 ```ts
 import { initRemoteCallWpsjsGlobal } from 'tadcode-wpsjs'
@@ -64,17 +65,9 @@ const scriptToken = 'xxxx'
 /* webhook url地址 具体获取方式参考上面 */
 const webhookURL = 'xxxx'
 const wpsjsGlobal = initRemoteCallWpsjsGlobal({ scriptToken, webhookURL,  })
-const values = [
-  ['name', 'price'],
-  ['米', 2.5],
-]
-function setValue(data: any[][], rangeReference = 'a1') {
-  const rowCount = data.length
-  const columnCount = data[0].length
-  wpsjsGlobal.Application.ActiveSheet.Range(rangeReference).Resize(rowCount, columnCount).Value2 = data
-  return wpsjsGlobal.execution() as unknown as boolean
-}
-setValue(values)
+/* 类型完善中 */
+wpsjsGlobal.Application.Sheets(1).Name = 'new table4'
+console.log(data)
 ```
 
 ### 执行脚本并且返回（不用部署remoteCode代码）

package/index.js

@@ -1 +1 @@
-import{writeFile as G}from"fs/promises";import $ from"path";var O=(B)=>{let{scriptToken:E,webhookURL:M,isAsync:H=!1,printLog:N=!1,writeLogFile:J=!1}=B,z=[];return new Proxy(()=>{},{get:(K,Q,S)=>{return z.push({method:"get",arguments:[Q]}),S},set:(K,Q,S,Z)=>{return z.push({method:"set",arguments:[Q,S]}),Z},apply:(K,Q,S)=>{if(z.at(-1)?.arguments[0]==="execution")return z.pop(),W({scriptToken:E,webhookURL:M,isAsync:H,argv:{info:z}}).then(async(q)=>{let Y=await q.json();if(z=[],N)D(Y);if(J)await P(Y);return Y.data.result});return z.push({method:"apply",arguments:S}),Q}})},W=({scriptToken:B,webhookURL:E,isAsync:M,argv:H})=>{let N=JSON.stringify({Context:{argv:H}}),J=$.parse(E);J.base=M?"task":"sync_task";let z=$.format(J);return fetch(z,{method:"post",headers:{"Content-Type":"application/json","AirScript-Token":B},body:N})},U=(B)=>{let E=new URL("https://www.kdocs.cn/api/v3/script/task");return E.searchParams.append("task_id",B),fetch(E)},D=(B)=>{let E=B,{status:M,data:H,error:N,error_details:J}=E;console.log("status:",M);let z=H.logs.at(-1).unix_time-H.logs[1].unix_time;if(console.log("runtime:",z),N)console.error(J.name),console.error(J.msg),console.error(J.stack);let X=H.logs.filter((K)=>K.filename!=="<system>");if(X.length!==0){console.log("log:");for(let K of X)console[K.level](...K.args)}return console.log("result:"),console.log(H.result),E},P=(B)=>{return G("./wpsjs.log.json",JSON.stringify(B,void 0,2))};export{P as writeLogFileToCurrent,U as queryTask,O as initRemoteCallWpsjsGlobal,W as execution};
+import{writeFile as V}from"fs/promises";import v from"path";var Q=Symbol("info"),G=Symbol("then"),I=(J)=>{let{scriptToken:B,webhookURL:X,isAsync:K=!1,printLog:Y=!1,writeLogFile:M=!1}=J,N={get(E,H,$){let Z=E[Q]??=[],z=()=>{};if(z[G]=!1,z[Q]=[...Z],H!=="then")z[Q].push({method:"get",arguments:[H]});else z[G]=!0;return new Proxy(z,N)},set(E,H,$,Z){let q=[...E[Q]??=[],{method:"set",arguments:[H,$]}];return U=D({scriptToken:B,webhookURL:X,isAsync:K,argv:{info:q}}).then(async(x)=>{let W=await x.json();if(Y)_(W);if(M)await P(W);return W?.data.result}),!0},apply(E,H,$){if(!E[G]){let Z=E[Q]??=[],z=()=>{};return z[G]=!1,z[Q]=[...Z,{method:"apply",arguments:$}],new Proxy(z,N)}else{let Z=E[Q];return D({scriptToken:B,webhookURL:X,isAsync:K,argv:{info:Z}}).then(async(z)=>{let q=await z.json();if(Y)_(q);if(M)await P(q);return q?.data.result}).then(...$)}}};return new Proxy(()=>{},N)},D=({scriptToken:J,webhookURL:B,isAsync:X,argv:K})=>{let Y=JSON.stringify({Context:{argv:K}}),M=v.parse(B);M.base=X?"task":"sync_task";let N=v.format(M);return fetch(N,{method:"post",headers:{"Content-Type":"application/json","AirScript-Token":J},body:Y})},U=null,j=async()=>U,O=(J)=>{let B=new URL("https://www.kdocs.cn/api/v3/script/task");return B.searchParams.append("task_id",J),fetch(B)},_=(J)=>{let B=J,{status:X,data:K,error:Y,error_details:M}=B;console.log("status:",X);let N=K.logs.at(-1).unix_time-K.logs[1].unix_time;if(console.log("runtime:",N),Y)console.error(M.name),console.error(M.msg),console.error(M.stack);let E=K.logs.filter((H)=>H.filename!=="<system>");if(E.length!==0){console.log("log:");for(let H of E)console[H.level](...H.args)}return console.log("result:"),console.log(K.result),B},P=(J)=>{return V("./wpsjs.log.json",JSON.stringify(J,void 0,2))};export{P as writeLogFileToCurrent,j as setValueOk,O as queryTask,I as initRemoteCallWpsjsGlobal,D as execution};

package/index.ts

@@ -1,4 +1,4 @@
-import type { InfoItem, RemoteCallWpsjsGlobalReturn, WithExecutionWpsjsGlobal } from './types'
+import type { InfoItem, RemoteCallWpsjsGlobalReturn, WpsjsGlobalApi } from './types'
 import { writeFile } from 'fs/promises'
 import path from 'path'
 
@@ -15,43 +15,64 @@ interface Config {
   writeLogFile?: boolean
 }
 
+const infoSymbol = Symbol('info')
+const isThenSymbol = Symbol('then')
+
 const initRemoteCallWpsjsGlobal = (config: Config) => {
   const { scriptToken, webhookURL, isAsync = false, printLog = false, writeLogFile = false, } = config
-  let info: InfoItem[] = []
-  const handle: ProxyHandler<() => void> = {
-    get: (_target, p: string, receiver) => {
-      info.push({ method: 'get', arguments: [p] })
-      return receiver
+  type ProxyTarget = { (): void;[infoSymbol]: InfoItem[], [isThenSymbol]: boolean }
+
+  const handle: ProxyHandler<ProxyTarget> = {
+    get(target, p: string, _receiver) {
+      const oldInfo = target[infoSymbol] ??= []
+      const func: ProxyTarget = () => { }
+      func[isThenSymbol] = false
+      func[infoSymbol] = [...oldInfo]
+      if (p !== 'then')
+        func[infoSymbol].push({ method: 'get', arguments: [p] })
+      else
+        func[isThenSymbol] = true
+      return new Proxy(func, handle)
     },
-    set: (_target, p: string, newValue, receiver) => {
-      info.push({ method: 'set', arguments: [p, newValue] })
-      return receiver
+    set(target, p, newValue, _receiver) {
+      const oldInfo = target[infoSymbol] ??= []
+      const info = [...oldInfo, { method: 'set', arguments: [p, newValue] }]
+      setValuePromise = execution({ scriptToken, webhookURL, isAsync, argv: { info } })
+        .then(async (response) => {
+          const responseObj = await response.json()
+          if (printLog) printInfo(responseObj)
+          if (writeLogFile) await writeLogFileToCurrent(responseObj)
+          return responseObj?.['data']['result']
+        })
+      return true
     },
-    apply: (_target, thisArg, argArray) => {
-      const lastInfo = info.at(-1)
-      if (lastInfo?.arguments[0] === 'execution') {
-        info.pop() /* 删除 execution的调用信息 */
+    apply(target, _thisArg, argArray) {
+      if (!target[isThenSymbol]) {
+        const oldInfo = target[infoSymbol] ??= []
+        const func: ProxyTarget = () => { }
+        func[isThenSymbol] = false
+        func[infoSymbol] = [...oldInfo, { method: 'apply', arguments: argArray }]
+        return new Proxy(func, handle)
+      } else {
+        const info = target[infoSymbol]
         return execution({ scriptToken, webhookURL, isAsync, argv: { info } })
           .then(async (response) => {
             const responseObj = await response.json()
-            info = []	/* 执行结束，清空调用 */
             if (printLog) printInfo(responseObj)
-
             if (writeLogFile) await writeLogFileToCurrent(responseObj)
-            return responseObj['data']['result']
+            return responseObj?.['data']['result']
           })
+          .then(...argArray)
       }
-      info.push({ method: 'apply', arguments: argArray })
-      return thisArg
     },
   }
-  return new Proxy(() => { }, handle) as unknown as WithExecutionWpsjsGlobal
+  return new Proxy(() => { }, handle) as unknown as WpsjsGlobalApi
 }
 
 type ExecutionConfig = Pick<Config, 'scriptToken' | 'webhookURL' | 'isAsync'> & { argv?: Record<string | number, any> }
 
 const execution = ({ scriptToken, webhookURL, isAsync, argv }: ExecutionConfig) => {
-  /* 获取请求信息 */
+  /* 请求信息 */
   const data = JSON.stringify({ Context: { argv, } })
   /* 根据是否同步返回不同的url */
   const parsedPath = path.parse(webhookURL)
@@ -67,6 +88,10 @@ const execution = ({ scriptToken, webhookURL, isAsync, argv }: ExecutionConfig)
   })
 }
 
+let setValuePromise: any = null
+/* 远程调用的赋值操作返回的promise */
+const setValueOk = async () => setValuePromise
+
 const queryTask = (id: string) => {
   const url = new URL('https://www.kdocs.cn/api/v3/script/task')
   url.searchParams.append('task_id', id)
@@ -100,11 +125,10 @@ const writeLogFileToCurrent = (data: object) => {
   return writeFile('./wpsjs.log.json', JSON.stringify((data), undefined, 2))
 }
 
-export type * from './types'
-
 export {
   execution,
   initRemoteCallWpsjsGlobal,
   queryTask,
+  setValueOk,
   writeLogFileToCurrent,
 }

package/package.json

@@ -1,29 +1,36 @@
-{
-  "name": "tadcode-wpsjs",
-  "version": "0.3.2",
-  "main": "index.js",
-  "type": "module",
-  "scripts": {
-    "hot": "NODE_ENV=development bun --hot ignore/index.ts",
-    "dev": "NODE_ENV=development bun --watch index.ts",
-    "build": "NODE_ENV=production bun build index.ts --target node --minify --outfile index.js"
-  },
-  "devDependencies": {
-    "@types/bun": "latest"
-  },
-  "keywords": [
-    "tadcode-wpsjs"
-  ],
-  "exports": {
-    ".": {
-      "import": "./index.js",
-      "types": "./index.ts"
-    },
-    "./types": {
-      "types": "./types/index.d.ts"
-    },
-    "./types/DB_Application": {
-      "types": "./types/DB_Application.d.ts"
-    }
-  }
-}
+{
+  "name": "tadcode-wpsjs",
+  "version": "1.1.0",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "hot": "NODE_ENV=development bun --hot ignore/index.ts",
+    "dev": "NODE_ENV=development bun --watch index.ts",
+    "build-main": "NODE_ENV=production bun build index.ts --target node --minify --outfile index.js",
+    "build-remotecode": "NODE_ENV=production bun build remoteCode/index.js --target browser --minify --outfile remoteCode/index.min.js"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "keywords": [
+    "tadcode-wpsjs"
+  ],
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./index.ts"
+    },
+    "./types": {
+      "types": "./types/index.d.ts"
+    },
+    "./types/DB_Application": {
+      "types": "./types/DB_Application.d.ts"
+    },
+    "./types/KSDrive": {
+      "types": "./types/KSDrive.d.ts"
+    },
+    "./types/KSheet_Application": {
+      "types": "./types/KSheet_Application.d.ts"
+    }
+  }
+}

package/remoteCode/index.min.js

@@ -0,0 +1 @@
+var{info:a}=Context.argv,s=void 0,e=globalThis;for(let t of a)switch(t.method){case"get":{s=e;let[r]=t.arguments;e=Reflect.get(e,r)}break;case"set":{let[r,o]=t.arguments;e=Reflect.set(e,r,o)}break;case"apply":e=Reflect.apply(e,s,t.arguments);break;default:throw Error("method must be get or apply")}return e;

package/types/DB_Application.d.ts

@@ -4,6 +4,31 @@ import type DBField from './DB_Application_Field'
 import type DBRecord from './DB_Application_Record'
 import type DBSelection from './DB_Application_Selection'
 
+interface DBUserInfo {
+  id: string
+  name: string
+}
+
+interface DBFileInfo {
+  id: string
+  name: string
+  officeType: string
+  creator: {
+    id: string
+    name: string
+    avatar_url: string
+    logined: boolean
+    attrs: {
+      real_userid: string
+    }
+    real_id: string
+  }
+  size: number
+  groupId: string
+  docType: number
+  version: number
+}
+
 export type * from './DB_Application_Sheet'
 export type * from './DB_Application_View'
 export type * from './DB_Application_Field'
@@ -18,5 +43,7 @@ export default interface DB_Application {
   Field: DBField
   Record: DBRecord
   Selection: DBSelection
+  UserInfo: DBUserInfo
+  FileInfo: DBFileInfo
 }
 

package/types/DB_Application_Selection.ts

@@ -1,22 +1,22 @@
-import type { RecordItem } from './DB_Application_Record'
-
-interface ActiveView {
-  "sheetId": number
-  "viewId": string
-  "name": string
-  "type": string
-}
-
-interface ActiveSheet {
-  "sheetId": number
-  "name": string
-  "description": string
-}
-
-export type { ActiveView, ActiveSheet }
-
-export default interface DBSelection {
-  GetActiveView(): ActiveView
-  GetSelectionRecords(): RecordItem[]
-  GetActiveSheet(): ActiveSheet
-}
+import type { RecordItem } from './DB_Application_Record'
+
+interface ActiveView {
+  "sheetId": number
+  "viewId": string
+  "name": string
+  "type": string
+}
+
+interface ActiveSheet {
+  "sheetId": number
+  "name": string
+  "description": string
+}
+
+export type { ActiveView, ActiveSheet }
+
+export default interface DBSelection {
+  GetActiveView(): ActiveView
+  GetSelectionRecords(): RecordItem[]
+  GetActiveSheet(): ActiveSheet
+}

package/types/KSDrive.d.ts

@@ -1,13 +1,33 @@
 import type DB_Application from './DB_Application'
 import type KSheet_Application from './KSheet_Application'
 
+interface FileType {
+  /**智能文档 */
+  AP: 'o'
+  /**智能表格 */
+  KSheet: 'k'
+  /**表格 */
+  ET: 's'
+  /**多维表 */
+  DB: 'd'
+}
+
+/**
+ * 文件类型
+ * - 'o': 智能文档
+ * - 'k': 智能表格
+ * - 's': 表格
+ * - 'd': 多维表
+ */
+type FileTypeValue = FileType[keyof FileType]
+
 interface CreateOptions {
   /**是	新文件的文件名 */
   name: string
   /**否	新文件的文件目录 */
-  dirUrl: string
+  dirUrl?: string
   /**否	将目标文件另存为新文件 */
-  source: string
+  source?: string
 }
 
 interface FilesInfo {
@@ -26,25 +46,17 @@ interface FileInfo {
   updateTime: number
 }
 
-export default interface KSDrive {
-  FileType: {
-    /**智能文档 */
-    AP: 'o'
-    /**智能表格 */
-    KSheet: 'k'
-    /**表格 */
-    ET: 's'
-    /**多维表 */
-    DB: 'd'
-  }
+export type { FileType, FileTypeValue, CreateOptions, FilesInfo, FileInfo }
 
+export default interface KSDrive {
+  FileType: FileType
   /**
    * 创建文件
    * @param type 新文件的类型
    * @param createOptions 新文件的参数选项
-   * @returns {string} 新文件url
+   * @returns 新文件url
    */
-  createFile(type: string, createOptions: createOptions): string
+  createFile(type: FileTypeValue, createOptions: CreateOptions): string
 
   openFile(url: string): {
     Application: KSheet_Application & DB_Application

package/types/KSheet_Application.d.ts

@@ -1,11 +1,11 @@
-interface Range {
+interface KSheetRange {
   Value2: any
   Formula: any
-  Resize(RowSize: number, ColumnSize?: number): Range
+  Resize(RowSize: number, ColumnSize?: number): KSheetRange
 }
 
-interface Sheet {
-  UsedRange: Range
+interface KSheetSheet {
+  UsedRange: KSheetRange
   /**
    * 获取一个单元格或单元格区域，返回一个 Range 对象
    * @paramaddress — 地址，可以是单元格地址或者选区范围范围地址
@@ -17,13 +17,15 @@ interface Sheet {
    * // 修改当前活动工作表D2单元格的内容
    * sheet.Range('D2').Value = 'this is D2'
    */
-  Range(address: string): Range
+  Range(address: string): KSheetRange
 }
 
+export type { KSheetRange, KSheetSheet }
+
 export default interface KSheet_Application {
-  ActiveSheet: Sheet
+  ActiveSheet: KSheetSheet
   Sheets: {
-    Item(index: number | string): Sheet
+    Item(index: number | string): KSheetSheet
   }
-  Range(index: string): Range
+  Range(index: string): KSheetRange
 }

package/types/index.d.ts

@@ -1,4 +1,4 @@
-import type { WithExecution } from './type-tools'
+import type { WithPromise } from './type-tools'
 import type DB_Application from './DB_Application'
 import type KSheet_Application from './KSheet_Application'
 import type KSDrive from './KSDrive'
@@ -8,40 +8,56 @@ interface WpsjsGlobal {
   Application: KSheet_Application & DB_Application
 }
 
-type WithExecutionWpsjsGlobal = WithExecution<WpsjsGlobal>
+type WpsjsGlobalApi = WithPromise<WpsjsGlobal>
 
 interface InfoItem {
   method: keyof typeof Reflect
   arguments: string[]
 }
 
+/* 基本 */
 interface RemoteCallWpsjsGlobalReturn {
-  "data": {
-    "logs": {
-      "filename": string
-      "timestamp": string
-      "unix_time": number
-      "level": 'info' | 'error' | 'warn'
-      "args": string[]
+  data: {
+    logs: {
+      filename: string
+      timestamp: string
+      unix_time: number
+      level: 'info' | 'error' | 'warn'
+      args: string[]
     }[]
-    "result": unknown
-    "task_id": string
+    result: unknown
+    task_id: string
   }
-  "error": string
-  "error_details": {
-    "name": string
-    "msg": string
-    "stack": string[]
-    "unix_time": number
+  error: string
+  error_details: {
+    name: string
+    msg: string
+    stack: string[]
+    unix_time: number
   }
-  "status": "finished"
-  "task_id": string
-  "task_type": string
+  status: 'finished'
+  task_id: string
+  task_type: string
+}
+
+/* token 过期 */
+interface RemoteCallWpsjsGlobalReturn {
+  errno: 10000
+  msg: string
+  reason: string
+  result: ApiTokenExpired
 }
 
 export {
   WpsjsGlobal,
-  WithExecutionWpsjsGlobal,
+  WpsjsGlobalApi,
   InfoItem,
   RemoteCallWpsjsGlobalReturn,
 }
+
+export type * from './DB_Application'
+export type { default as DB_Application } from './DB_Application'
+export type * from './KSDrive'
+export type { default as KSDrive } from './KSDrive'
+export type * from './KSheet_Application'
+export type { default as KSheet_Application } from './KSheet_Application'

package/types/type-tools.ts

@@ -24,10 +24,27 @@ type DeepPartial<T> = T extends object
 type DistributiveOmit<T, K extends PropertyKey> =
   T extends any ? Omit<T, K> : never
 
+/**根据给的对象，添加promise方法 */
+type WithPromise<T> = T extends (...args: infer A) => infer R ?
+  ((...args: A) => WithPromise<R>) & Promise<T> :
+  T extends Array<infer U> ?
+  Array<WithPromise<U>> & Promise<T> :
+  T extends object ?
+  { [K in keyof T]: WithPromise<T[K]> } & Promise<T> :
+  T extends boolean ?
+  Promise<boolean> :
+  T extends number ?
+  Promise<number> :
+  T extends string ?
+  Promise<string>
+  : T & Promise<T>
+
+// 搞定！🎉
 export type {
   WithExecution,
   MakePropertyOptional,
   PickModify,
   DeepPartial,
   DistributiveOmit,
+  WithPromise,
 }