tadcode-wpsjs 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.vscode/settings.json +15 -0
- package/README.md +45 -12
- package/index.js +1 -1
- package/index.ts +71 -58
- package/package.json +2 -2
- package/remoteCode/index.js +0 -1
- package/types/DB_Application.d.ts +157 -52
- package/types/KSDrive.d.ts +2 -2
- package/types/KSheet_Application.d.ts +1 -1
- package/types/index.d.ts +8 -3
- package/types/type-tools.ts +13 -0
- package/test/one.test.ts +0 -14
package/.vscode/settings.json
CHANGED
|
@@ -8,4 +8,19 @@
|
|
|
8
8
|
"bun.debugTerminal.stopOnEntry": false,
|
|
9
9
|
// Glob pattern to find test files. Defaults to the value shown below.
|
|
10
10
|
"bun.test.filePattern": "**/*{.test.,.spec.,_test_,_spec_}{js,ts,tsx,jsx,mts,cts}",
|
|
11
|
+
"search.exclude": {
|
|
12
|
+
"**/node_modules": true,
|
|
13
|
+
"**/bower_components": true,
|
|
14
|
+
"**/*.code-search": true
|
|
15
|
+
},
|
|
16
|
+
"files.exclude": {
|
|
17
|
+
"**/node_modules": true,
|
|
18
|
+
"**/.git": true,
|
|
19
|
+
"**/.svn": true,
|
|
20
|
+
"**/.hg": true,
|
|
21
|
+
"**/CVS": true,
|
|
22
|
+
"**/.DS_Store": true,
|
|
23
|
+
"**/Thumbs.db": true,
|
|
24
|
+
"bun.lock": true,
|
|
25
|
+
}
|
|
11
26
|
}
|
package/README.md
CHANGED
|
@@ -1,16 +1,26 @@
|
|
|
1
1
|
# tadcode-wpsjs
|
|
2
2
|
|
|
3
|
-
wps官方文档
|
|
3
|
+
基于wps官方文档
|
|
4
|
+
1. [**AirScript文档**](https://airsheet.wps.cn/docs/apitoken/intro.html)
|
|
5
|
+
2. [**WPS多维表格：“开发”功能使用说明文档**](https://365.kdocs.cn/l/ctzsgDlAGF0l)
|
|
6
|
+
|
|
7
|
+
## 联系我
|
|
8
|
+
|
|
9
|
+
**如你有业务需要wps代码服务，可以点此[联系我](https://f.kdocs.cn/g/SIdEy3GE/)，三个工作日内必定回复。**
|
|
10
|
+
|
|
11
|
+
**如您公司存在敏感信息业务，需要长期人才，亦可来讯商谈。**
|
|
12
|
+
|
|
13
|
+
|
|
4
14
|
|
|
5
15
|
## 应用
|
|
6
16
|
|
|
7
|
-
用于学习wpsjsapi，远程调用
|
|
17
|
+
用于学习wpsjsapi，远程调用wpsjs-api。
|
|
8
18
|
|
|
9
|
-
使用wpsjs-
|
|
19
|
+
使用wpsjs-api。支持异步任务。
|
|
10
20
|
|
|
11
21
|
在远程部署代码好代码，通过传输的调用信息进行调用api。原理是使用代理收集调用信息，之后让远程代码进行调用并且返回结果。
|
|
12
22
|
|
|
13
|
-
远程代码在`remoteCode`目录的`index.js
|
|
23
|
+
远程代码在`tadcode-wpsjs/remoteCode`目录的`index.js`文件中。将其复制粘贴到对应`webhook`的脚本中才能支持`wpsjsGlobal`的调用。
|
|
14
24
|
|
|
15
25
|
## 安装
|
|
16
26
|
|
|
@@ -19,20 +29,43 @@ wps官方文档[**AirScript文档**](https://airsheet.wps.cn/docs/apitoken/intro
|
|
|
19
29
|
## 获取脚本令牌和webhook链接
|
|
20
30
|
|
|
21
31
|
### 获取脚本令牌
|
|
32
|
+
|
|
22
33
|
|
|
23
34
|
|
|
24
35
|
### webhook链接
|
|
36
|
+
|
|
37
|
+
**!!!webhook链接的脚本内容必须部署为`tadcode-wpsjs/remoteCode/index.js`中的脚本内容。**
|
|
38
|
+
|
|
25
39
|
|
|
26
40
|
|
|
27
41
|
## 案例
|
|
28
42
|
|
|
43
|
+
### 获取当前多维表的所有表格信息
|
|
44
|
+
|
|
29
45
|
```ts
|
|
30
|
-
import {
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
const
|
|
35
|
-
wpsjsGlobal
|
|
36
|
-
const
|
|
37
|
-
console.log(
|
|
46
|
+
import { initRemoteCallWpsjsGlobal } from 'tadcode-wpsjs'
|
|
47
|
+
/* 脚本令牌 具体获取方式参考上面 */
|
|
48
|
+
const scriptToken = 'xxxx'
|
|
49
|
+
/* webhook url地址 具体获取方式参考上面 */
|
|
50
|
+
const webhookURL = 'xxxx'
|
|
51
|
+
const wpsjsGlobal = initRemoteCallWpsjsGlobal({ scriptToken, webhookURL, })
|
|
52
|
+
const data = await wpsjsGlobal.Application.Sheet.GetSheets().execution()
|
|
53
|
+
console.log(data)
|
|
38
54
|
```
|
|
55
|
+
|
|
56
|
+
### 执行脚本并且返回（不用部署remoteCode代码）
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import { execution } from 'tadcode-wpsjs'
|
|
60
|
+
/* 脚本令牌 具体获取方式参考上面 */
|
|
61
|
+
const scriptToken = 'xxxx'
|
|
62
|
+
/* webhook url地址 具体获取方式参考上面 */
|
|
63
|
+
const webhookURL = 'xxxx'
|
|
64
|
+
const result=await execution({ scriptToken, webhookURL })
|
|
65
|
+
const data =await result.json()
|
|
66
|
+
console.log(data)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## 支持
|
|
70
|
+
|
|
71
|
+
如果对你有用请给个`star`
|
package/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
import
|
|
2
|
+
import{writeFile as $}from"fs/promises";import Y 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,S,V)=>{return z.push({method:"get",arguments:[S]}),V},apply:(K,S,V)=>{if(z.at(-1)?.arguments[0]==="execution")return z.pop(),q({scriptToken:E,webhookURL:M,isAsync:H,argv:{info:z}}).then(async(Z)=>{let X=await Z.json();if(z=[],N)G(X);if(J)W(X);return X.data.result});return z.push({method:"apply",arguments:V}),S}})},q=({scriptToken:B,webhookURL:E,isAsync:M,argv:H})=>{let N=JSON.stringify({Context:{argv:H}}),J=Y.parse(E);J.base=M?"task":"sync_task";let z=Y.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)},G=(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 Q=H.logs.filter((K)=>K.filename!=="<system>");if(Q.length!==0){console.log("log:");for(let K of Q)console[K.level](...K.args)}return console.log("result:"),console.log(H.result),E},W=(B)=>{$("./wpsjs.log.json",JSON.stringify(B,void 0,4))};export{W as writeLogFileToCurrent,U as queryTask,O as initRemoteCallWpsjsGlobal,q as execution};
|
package/index.ts
CHANGED
|
@@ -1,67 +1,65 @@
|
|
|
1
|
-
import type { InfoItem, RemoteCallWpsjsGlobalReturn,
|
|
1
|
+
import type { InfoItem, RemoteCallWpsjsGlobalReturn, WithExecutionWpsjsGlobal } from './types'
|
|
2
|
+
import { writeFile } from 'fs/promises'
|
|
2
3
|
import path from 'path'
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
})
|
|
16
|
-
return
|
|
4
|
+
interface Config {
|
|
5
|
+
scriptToken: string
|
|
6
|
+
webhookURL: string
|
|
7
|
+
isAsync?: boolean
|
|
8
|
+
printLog?: boolean
|
|
9
|
+
writeLogFile?: boolean
|
|
10
|
+
}
|
|
11
|
+
const initRemoteCallWpsjsGlobal = (config: Config) => {
|
|
12
|
+
const { scriptToken, webhookURL, isAsync = false, printLog = false, writeLogFile = false, } = config
|
|
13
|
+
let info: InfoItem[] = []
|
|
14
|
+
const handle: ProxyHandler<() => void> = {
|
|
15
|
+
get: (_target, p: string, receiver) => {
|
|
16
|
+
info.push({ method: 'get', arguments: [p] })
|
|
17
|
+
return receiver
|
|
17
18
|
},
|
|
18
|
-
apply: (_target,
|
|
19
|
-
const
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
19
|
+
apply: (_target, thisArg, argArray) => {
|
|
20
|
+
const lastInfo = info.at(-1)
|
|
21
|
+
if (lastInfo?.arguments[0] === 'execution') {
|
|
22
|
+
info.pop() /* 删除 execution的调用信息 */
|
|
23
|
+
return execution({ scriptToken, webhookURL, isAsync, argv: { info } })
|
|
24
|
+
.then(async (response) => {
|
|
25
|
+
const responseObj = await response.json()
|
|
26
|
+
info = [] /* 执行结束，清空调用 */
|
|
27
|
+
if (printLog) printInfo(responseObj)
|
|
28
|
+
if (writeLogFile) writeLogFileToCurrent(responseObj)
|
|
29
|
+
return responseObj['data']['result']
|
|
30
|
+
})
|
|
31
|
+
}
|
|
32
|
+
info.push({ method: 'apply', arguments: argArray })
|
|
33
|
+
return thisArg
|
|
25
34
|
},
|
|
26
|
-
}) as WpsjsGlobal
|
|
27
|
-
execute() {
|
|
28
|
-
const { scriptToken, webhookURL, info, sync } = this
|
|
29
|
-
const data = JSON.stringify({
|
|
30
|
-
'Context': { 'argv': { info }, }
|
|
31
|
-
})
|
|
32
|
-
/* 根据是否同步返回不同的url */
|
|
33
|
-
const parsedPath = path.parse(webhookURL)
|
|
34
|
-
parsedPath.base = sync ? 'sync_task' : 'task'
|
|
35
|
-
const url = path.format(parsedPath)
|
|
36
|
-
return fetch(url, {
|
|
37
|
-
method: 'post',
|
|
38
|
-
headers: {
|
|
39
|
-
'Content-Type': 'application/json',
|
|
40
|
-
'AirScript-Token': scriptToken
|
|
41
|
-
},
|
|
42
|
-
body: data
|
|
43
|
-
})
|
|
44
|
-
}
|
|
45
|
-
queryTask(id: string) {
|
|
46
|
-
const { asyncQueryURL } = this
|
|
47
|
-
const url = new URL(asyncQueryURL)
|
|
48
|
-
/* 这样子可以不用 encodeURIComponent */
|
|
49
|
-
url.searchParams.append('task_id', id)
|
|
50
|
-
return fetch(url.toString())
|
|
51
35
|
}
|
|
36
|
+
return new Proxy(() => { }, handle) as unknown as WithExecutionWpsjsGlobal
|
|
37
|
+
}
|
|
38
|
+
type ExecutionConfig = Pick<Config, 'scriptToken' | 'webhookURL' | 'isAsync'> & { argv?: Record<string | number, any> }
|
|
39
|
+
const execution = ({ scriptToken, webhookURL, isAsync, argv }: ExecutionConfig) => {
|
|
40
|
+
/* 获取请求信息 */
|
|
41
|
+
const data = JSON.stringify({ Context: { argv, } })
|
|
42
|
+
/* 根据是否同步返回不同的url */
|
|
43
|
+
const parsedPath = path.parse(webhookURL)
|
|
44
|
+
parsedPath.base = isAsync ? 'task' : 'sync_task'
|
|
45
|
+
const url = path.format(parsedPath)
|
|
46
|
+
return fetch(url, {
|
|
47
|
+
method: 'post',
|
|
48
|
+
headers: {
|
|
49
|
+
'Content-Type': 'application/json',
|
|
50
|
+
'AirScript-Token': scriptToken
|
|
51
|
+
},
|
|
52
|
+
body: data
|
|
53
|
+
})
|
|
54
|
+
}
|
|
55
|
+
const queryTask = (id: string) => {
|
|
56
|
+
const url = new URL('https://www.kdocs.cn/api/v3/script/task')
|
|
57
|
+
url.searchParams.append('task_id', id)
|
|
58
|
+
return fetch(url)
|
|
52
59
|
}
|
|
53
|
-
|
|
54
|
-
const responseData =
|
|
60
|
+
const printInfo = (remoteCallResponse: RemoteCallWpsjsGlobalReturn) => {
|
|
61
|
+
const responseData = remoteCallResponse as RemoteCallWpsjsGlobalReturn
|
|
55
62
|
const { status, data, error, error_details } = responseData
|
|
56
|
-
console.log('result:')
|
|
57
|
-
console.log(data.result)
|
|
58
|
-
const userInfo = data.logs.filter(x => x.filename !== '<system>')
|
|
59
|
-
if (userInfo.length !== 0) {
|
|
60
|
-
console.log('log:')
|
|
61
|
-
for (const item of userInfo) {
|
|
62
|
-
console[item.level](...item.args)
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
63
|
console.log('status:', status)
|
|
66
64
|
const time = data.logs.at(-1)!.unix_time - data.logs[1].unix_time
|
|
67
65
|
console.log('runtime:', time)
|
|
@@ -70,5 +68,20 @@ export async function printInfo(response: Response) {
|
|
|
70
68
|
console.error(error_details.msg)
|
|
71
69
|
console.error(error_details.stack)
|
|
72
70
|
}
|
|
71
|
+
const userInfo = data.logs.filter(x => x.filename !== '<system>')
|
|
72
|
+
if (userInfo.length !== 0) {
|
|
73
|
+
console.log('log:')
|
|
74
|
+
for (const item of userInfo) {
|
|
75
|
+
console[item.level](...item.args)
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
console.log('result:')
|
|
79
|
+
console.log(data.result)
|
|
73
80
|
return responseData
|
|
74
81
|
}
|
|
82
|
+
const writeLogFileToCurrent = (data: object) => {
|
|
83
|
+
writeFile('./wpsjs.log.json', JSON.stringify((data), undefined, 4))
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export { execution, initRemoteCallWpsjsGlobal, queryTask, writeLogFileToCurrent }
|
|
87
|
+
export type * from './types'
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tadcode-wpsjs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"main": "index.js",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"scripts": {
|
|
7
|
-
"hot": "NODE_ENV=development bun --hot index.ts",
|
|
7
|
+
"hot": "NODE_ENV=development bun --hot ignore/index.ts",
|
|
8
8
|
"dev": "NODE_ENV=development bun --watch index.ts",
|
|
9
9
|
"build": "NODE_ENV=production bun build index.ts --target bun --minify --outfile index.js"
|
|
10
10
|
},
|
package/remoteCode/index.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { MakePropertyOptional, PickModify } from './type-tools'
|
|
1
2
|
export default interface DB_Application {
|
|
2
3
|
Sheet: DBSheet
|
|
3
4
|
Record: DBRecord
|
|
@@ -6,7 +7,7 @@ export default interface DB_Application {
|
|
|
6
7
|
}
|
|
7
8
|
/* 表 */
|
|
8
9
|
interface DBSheet {
|
|
9
|
-
GetSheets(): SheetInfo
|
|
10
|
+
GetSheets(): SheetInfo[]
|
|
10
11
|
CreateSheet(options: Pick<SheetOptions, 'SheetId'>)
|
|
11
12
|
DeleteSheet(options: Pick<SheetOptions, 'SheetId'>)
|
|
12
13
|
UpdateSheet(options: Omit<SheetOptions, 'SheetId'> & Partial<SheetOptions>)
|
|
@@ -24,75 +25,179 @@ interface SheetOptions {
|
|
|
24
25
|
Fields: { name: string, type: FieldType }[]
|
|
25
26
|
}
|
|
26
27
|
interface SheetInfo {
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
28
|
+
'description': string,
|
|
29
|
+
'fields': {
|
|
30
|
+
'arraySupport': boolean,
|
|
31
|
+
'autoFillSourceField': string,
|
|
32
|
+
'customConfig': string,
|
|
33
|
+
'defaultValueType': 'Normal',
|
|
34
|
+
'description': string,
|
|
35
|
+
'id': string,
|
|
36
|
+
'name': string,
|
|
37
|
+
'numberFormat': string,
|
|
38
|
+
'syncField': boolean,
|
|
39
|
+
'type': FieldType,
|
|
40
|
+
'uniqueValue': boolean
|
|
41
|
+
'loadLegalHoliday': number,
|
|
42
|
+
'items': {
|
|
43
|
+
'color': number,
|
|
44
|
+
'id': string,
|
|
45
|
+
'value': string
|
|
45
46
|
}[],
|
|
46
|
-
|
|
47
|
-
|
|
47
|
+
'allowAddItemWhenInputting': true,
|
|
48
|
+
'autoAddItem': boolean,
|
|
48
49
|
}[],
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
50
|
+
'icon': string,
|
|
51
|
+
'id': number,
|
|
52
|
+
'name': number,
|
|
53
|
+
'primaryFieldId': number,
|
|
54
|
+
'recordsCount': number,
|
|
55
|
+
'sheetType': 'xlEtDataBaseSheet',
|
|
56
|
+
'subType': 'Normal',
|
|
57
|
+
'syncFieldSourceId': string,
|
|
58
|
+
'syncFieldSourceNameId': string,
|
|
59
|
+
'syncType': 'None',
|
|
60
|
+
'views': {
|
|
61
|
+
'id': string,
|
|
62
|
+
'name': string,
|
|
63
|
+
'notice': string,
|
|
64
|
+
'recordsCount': number,
|
|
65
|
+
'type': ViewType
|
|
65
66
|
}[]
|
|
66
67
|
}
|
|
67
68
|
|
|
68
69
|
type FieldType = 'MultiLineText' | 'Date' | 'Time' | 'Number' | 'Currency' | 'Percentage' | 'ID' | 'Phone' | 'Email' | 'Url' | 'Checkbox' | 'SingleSelect' | 'MultipleSelect' | 'Rating' | 'Complete' | 'Contact' | 'Attachment' | 'Link' | 'Note' | 'AutoNumber' | 'CreatedBy' | 'CreatedTime' | 'Formula' | 'Lookup'
|
|
69
70
|
type ViewType = 'Grid' | 'Kanban' | 'Gallery' | 'Form' | 'Gantt'
|
|
70
71
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
GetRecord(options: Pick<RcordOptions, 'SheetId' | 'RecordId'>)
|
|
75
|
-
DeleteRecords(options: Pick<RcordOptions, 'SheetId' | 'RecordIds'>)
|
|
76
|
-
UpdateRecords(options: Pick<RcordOptions, 'SheetId' | 'Records'>)
|
|
72
|
+
interface Entry {
|
|
73
|
+
id: string,
|
|
74
|
+
fields: Record<string, boolean | number | string | string[]>
|
|
77
75
|
}
|
|
78
|
-
interface
|
|
76
|
+
interface Options {
|
|
79
77
|
SheetId: number
|
|
80
78
|
RecordId: string
|
|
81
79
|
RecordIds: string[]
|
|
82
|
-
Records:
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
80
|
+
Records: Entry[]
|
|
81
|
+
/**
|
|
82
|
+
* 填写后将从被指定的视图获取该用户所见到的记录；若不填写，则从工作表获取记录
|
|
83
|
+
*/
|
|
84
|
+
ViewId: string
|
|
85
|
+
/**
|
|
86
|
+
* 存在分页时，指定本次查询的起始记录（含）。若不填写或填写为空字符串，则从第一条记录开始获取
|
|
87
|
+
*
|
|
88
|
+
* 当前最大值：1000
|
|
89
|
+
*/
|
|
90
|
+
PageSize: number
|
|
91
|
+
/**分页查询时，将返回一个offset值，指向下一页的第一条记录，供后续查询。查询到最后一页或第maxRecords条记录时，返回数据将不再包含offset值 */
|
|
92
|
+
Offset: number
|
|
93
|
+
/**指定要获取的“前maxRecords条记录”，若不填写，则默认返回全部记录 */
|
|
94
|
+
MaxRecords: number
|
|
95
|
+
/**具体字段类型说明详见 [附件2](https://kdocs.cn/l/ctzsgDlAGF0l?linkname=QSt7dOHYA0) */
|
|
96
|
+
Fields: any[]
|
|
97
|
+
/**详细说明见 [附件4](https://www.kdocs.cn/l/ctzsgDlAGF0l?linkname=wsTfzS9o34) */
|
|
98
|
+
Filter: {
|
|
99
|
+
/**选填。表示各筛选条件之间的逻辑关系。只能是'AND'或'OR'。缺省值为'AND' */
|
|
100
|
+
mode?: 'AND' | 'OR',
|
|
101
|
+
/**filter结构体内必填。包含筛选条件的数组。每个字段上只能有一个筛选条件 */
|
|
102
|
+
criteria: {
|
|
103
|
+
/**必填。根据 preferId 与否，需要填入字段名或字段id */
|
|
104
|
+
field: string
|
|
105
|
+
/**"Equals": 等于
|
|
106
|
+
|
|
107
|
+
"NotEqu": 不等于
|
|
108
|
+
|
|
109
|
+
"Greater": 大于
|
|
110
|
+
|
|
111
|
+
"GreaterEqu": 大等于
|
|
112
|
+
|
|
113
|
+
"Less": 小于
|
|
114
|
+
|
|
115
|
+
"LessEqu": 小等于
|
|
116
|
+
|
|
117
|
+
"GreaterEquAndLessEqu": 介于（取等）
|
|
87
118
|
|
|
119
|
+
"LessOrGreater": 介于（不取等）
|
|
120
|
+
|
|
121
|
+
"BeginWith": 开头是
|
|
122
|
+
|
|
123
|
+
"EndWith": 结尾是
|
|
124
|
+
|
|
125
|
+
"Contains": 包含
|
|
126
|
+
|
|
127
|
+
"NotContains": 不包含
|
|
128
|
+
|
|
129
|
+
"Intersected": 指定值
|
|
130
|
+
|
|
131
|
+
"Empty": 为空
|
|
132
|
+
|
|
133
|
+
"NotEmpty": 不为空
|
|
134
|
+
*/
|
|
135
|
+
op: 'Equals' | 'NotEqu' | 'Greater' | 'GreaterEqu' | 'Less' | 'LessEqu' | 'GreaterEquAndLessEqu' | 'LessOrGreater' | 'BeginWith' | 'EndWith' | 'Contains' | 'NotContains' | 'Intersected' | 'Empty' | 'NotEmpty'
|
|
136
|
+
/**
|
|
137
|
+
* 必填。表示筛选规则中的值。数组形式。值为字符串时表示文本匹配。
|
|
138
|
+
* 这里的 values，必须是一个数组，传 ["多维表"]，相当于传 [{ type: 'Text', value: '多维表' }]，即不传默认帮你补充 Text 类型。
|
|
139
|
+
* 复选框的值，values: ['0'] 代表否，value: ['1'] 代表是。
|
|
140
|
+
*
|
|
141
|
+
* values[]数组内的元素为字符串时，表示文本匹配。各筛选规则独立地限制了values数组内最多允许填写的元素数，当values内元素数超过阈值时，该筛选规则将失效。
|
|
142
|
+
*
|
|
143
|
+
* a. “为空、不为空”不允许填写元素；
|
|
144
|
+
*
|
|
145
|
+
* b. “介于”允许最多填写2个元素；
|
|
146
|
+
*
|
|
147
|
+
* c. “指定值”允许填写65535个元素；
|
|
148
|
+
*
|
|
149
|
+
* d. 其他规则允许最多填写1个元素
|
|
150
|
+
*/
|
|
151
|
+
values: string[] | {
|
|
152
|
+
type: 'Text'
|
|
153
|
+
value: string
|
|
154
|
+
}[] |
|
|
155
|
+
{
|
|
156
|
+
type: 'DynamicSimple'
|
|
157
|
+
/**
|
|
158
|
+
* 当"op"为"greater"或"less"时，"dynamicType"只能是昨天、今天或明天。
|
|
159
|
+
*
|
|
160
|
+
* "today": 今天
|
|
161
|
+
*
|
|
162
|
+
* "yesterday": 昨天
|
|
163
|
+
*
|
|
164
|
+
* "tomorrow": 明天
|
|
165
|
+
*
|
|
166
|
+
* "last7Days": 最近7天
|
|
167
|
+
*
|
|
168
|
+
* "last30Days": 最近30天
|
|
169
|
+
*
|
|
170
|
+
* "thisWeek": 本周
|
|
171
|
+
*
|
|
172
|
+
* "lastWeek": 上周
|
|
173
|
+
*
|
|
174
|
+
* "nextWeek"：下周
|
|
175
|
+
*
|
|
176
|
+
* "thisMonth": 本月
|
|
177
|
+
*
|
|
178
|
+
* "lastMonth": 上月
|
|
179
|
+
*
|
|
180
|
+
* "nextMonth": 次月
|
|
181
|
+
*/
|
|
182
|
+
dynamicType: "today" | "yesterday" | "tomorrow" | "last7Days" | "last30Days" | "thisWeek" | "lastWeek" | "nextWeek" | "thisMonth" | "lastMonth" | "nextMonth"
|
|
183
|
+
}[]
|
|
184
|
+
}[]
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
/* 行记录 */
|
|
188
|
+
interface DBRecord {
|
|
189
|
+
GetRecord(options: Pick<Options, 'SheetId' | 'RecordId'>)
|
|
190
|
+
GetRecords(options: Pick<Options, 'SheetId'> & Partial<Pick<Options, 'ViewId' | 'PageSize' | 'Offset' | 'MaxRecords' | 'Fields' | 'Filter'>>): { records: Entry[] }
|
|
191
|
+
CreateRecords(options: Pick<Options, 'SheetId'> & PickModify<Options, 'Records', MakePropertyOptional<Entry, 'id'>[]>): Entry[]
|
|
192
|
+
UpdateRecords(options: Pick<Options, 'SheetId' | 'Records'>)
|
|
193
|
+
DeleteRecords(options: Pick<Options, 'SheetId' | 'RecordIds'>)
|
|
194
|
+
}
|
|
88
195
|
/* 字段 */
|
|
89
196
|
interface DBField {
|
|
90
197
|
GetFields(options: Pick<FieldOptions, 'SheetId'>)
|
|
91
198
|
CreateFields(options: Pick<FieldOptions, 'SheetId' | 'Fields'>)
|
|
92
199
|
DeleteFields(options: Pick<FieldOptions, 'SheetId' | 'FieldIds'>)
|
|
93
|
-
UpdateFields(options: Pick<FieldOptions, 'SheetId' | 'Fields'> & {
|
|
94
|
-
|
|
95
|
-
})
|
|
200
|
+
UpdateFields(options: Pick<FieldOptions, 'SheetId' | 'Fields'> & {})
|
|
96
201
|
}
|
|
97
202
|
interface FieldOptions {
|
|
98
203
|
SheetId: number
|
package/types/KSDrive.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import DB_Application from './DB_Application'
|
|
2
|
-
import KSheet_Application from './KSheet_Application'
|
|
1
|
+
import type DB_Application from './DB_Application'
|
|
2
|
+
import type KSheet_Application from './KSheet_Application'
|
|
3
3
|
export default interface KSDrive {
|
|
4
4
|
FileType: {
|
|
5
5
|
/**智能文档 */
|
package/types/index.d.ts
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
|
-
import
|
|
1
|
+
import type { WithExecution } from './type-tools'
|
|
2
|
+
import type DB_Application from './DB_Application'
|
|
3
|
+
import type KSheet_Application from './KSheet_Application'
|
|
4
|
+
import type KSDrive from './KSDrive'
|
|
2
5
|
interface WpsjsGlobal {
|
|
3
|
-
(): WpsjsGlobal
|
|
4
6
|
Date: typeof Date
|
|
5
7
|
KSDrive: KSDrive
|
|
8
|
+
Application: KSheet_Application & DB_Application
|
|
6
9
|
}
|
|
10
|
+
type WithExecutionWpsjsGlobal = WithExecution<WpsjsGlobal>
|
|
7
11
|
interface InfoItem {
|
|
8
12
|
method: keyof typeof Reflect
|
|
9
|
-
arguments:
|
|
13
|
+
arguments: string[]
|
|
10
14
|
}
|
|
11
15
|
interface RemoteCallWpsjsGlobalReturn {
|
|
12
16
|
"data": {
|
|
@@ -76,6 +80,7 @@ interface RemoteCallWpsjsGlobalReturn {
|
|
|
76
80
|
}
|
|
77
81
|
export {
|
|
78
82
|
WpsjsGlobal,
|
|
83
|
+
WithExecutionWpsjsGlobal,
|
|
79
84
|
InfoItem,
|
|
80
85
|
RemoteCallWpsjsGlobalReturn,
|
|
81
86
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/* 根据给的对象，添加execution方法 */
|
|
2
|
+
type WithExecution<T> = T extends (...args: infer A) => infer R
|
|
3
|
+
? ((...args: A) => WithExecution<R>) & { execution: () => Promise<R> }
|
|
4
|
+
: T extends object
|
|
5
|
+
? { [K in keyof T]: WithExecution<T[K]> } & { execution: () => Promise<T> }
|
|
6
|
+
: T & { execution: () => Promise<T> }
|
|
7
|
+
/**部分可选 */
|
|
8
|
+
type MakePropertyOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
|
|
9
|
+
/* 选取修改类型 */
|
|
10
|
+
type PickModify<T, K extends keyof T, M> = {
|
|
11
|
+
[P in K]: M
|
|
12
|
+
}
|
|
13
|
+
export type { WithExecution, MakePropertyOptional, PickModify }
|
package/test/one.test.ts
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import type { RemoteCallWpsjsGlobalReturn } from '../types'
|
|
2
|
-
import { test, expect } from 'bun:test'
|
|
3
|
-
import { RemoteCallWpsjsGlobal } from '../index'
|
|
4
|
-
|
|
5
|
-
test('ok', async () => {
|
|
6
|
-
const remoteCall = new RemoteCallWpsjsGlobal()
|
|
7
|
-
remoteCall.webhookURL = 'xxxx' /* webhook url地址 */
|
|
8
|
-
remoteCall.webhookURL = 'xxxx' /* webhook url地址 */
|
|
9
|
-
const { wpsjsGlobal } = remoteCall
|
|
10
|
-
wpsjsGlobal.KSDrive.listFiles()
|
|
11
|
-
const response = await remoteCall.execute()
|
|
12
|
-
console.log(await response.text())
|
|
13
|
-
// const responseData = await printInfo(response)
|
|
14
|
-
})
|