tadcode-wpsjs 0.1.2 → 0.1.3

package/README.md

@@ -6,7 +6,7 @@
 
 ## 联系我
 
-**如你有业务需要，可以点此[联系我](https://f.kdocs.cn/g/SIdEy3GE/)，三个工作日内必定回复。**
+**如你有业务需要wps代码服务，可以点此[联系我](https://f.kdocs.cn/g/SIdEy3GE/)，三个工作日内必定回复。**
 
 **如您公司存在敏感信息业务，需要长期人才，亦可来讯商谈。**
 
@@ -14,13 +14,13 @@
 
 ## 应用
 
-用于学习wpsjsapi，远程调用wpsjsapi。
+用于学习wpsjsapi，远程调用wpsjs-api。
 
-使用wpsjs-1.0api。支持异步任务。支持`KSDrive`的类型。
+使用wpsjs-api。支持异步任务。
 
 在远程部署代码好代码，通过传输的调用信息进行调用api。原理是使用代理收集调用信息，之后让远程代码进行调用并且返回结果。
 
-远程代码在`remoteCode`目录的`index.js`文件里面。将其复制粘贴到对应`webhook`的脚本中才能支持`wpsjsGlobal`的调用。
+远程代码在`tadcode-wpsjs/remoteCode`目录的`index.js`文件中。将其复制粘贴到对应`webhook`的脚本中才能支持`wpsjsGlobal`的调用。
 
 ## 安装
 
@@ -29,21 +29,40 @@
 ## 获取脚本令牌和webhook链接
 
 ### 获取脚本令牌
+
 ![脚本令牌](https://qn.cache.wpscdn.cn/asdocs/assets/apitoken.Dv10SGDp.png "脚本令牌")
 
 ### webhook链接
+
+**!!!webhook链接的脚本内容必须部署为`tadcode-wpsjs/remoteCode/index.js`中的脚本内容。**
+
 ![webhook链接](https://qn.cache.wpscdn.cn/asdocs/assets/webhook.DnCJD55j.png "webhook链接")
 
 ## 案例
 
+### 获取当前多维表的所有表格信息
+
+```ts
+import { initRemoteCallWpsjsGlobal } from 'tadcode-wpsjs'
+/* 脚本令牌 具体获取方式参考上面 */
+const scriptToken = 'xxxx'
+/* webhook url地址 具体获取方式参考上面 */
+const webhookURL = 'xxxx'
+const wpsjsGlobal = initRemoteCallWpsjsGlobal({ scriptToken, webhookURL,  })
+const data = await wpsjsGlobal.Application.Sheet.GetSheets().execution()
+console.log(data)
+```
+
+### 执行脚本并且返回（不用部署remoteCode代码）
+
 ```ts
-import { RemoteCallWpsjsGlobal } from 'tadcode-wpsjs'
-const remoteCall = new RemoteCallWpsjsGlobal()
-remoteCall.scriptToken = 'xxxx' /* 脚本令牌 */
-remoteCall.webhookURL = 'xxxx' /* webhook url地址 */
-/* 获取表信息 */
-const sheets = await remoteCall.wpsjsGlobal.Application.Sheet.GetSheets().execution()
-const data = sheets.map(({ id, name, sheetType }) => ({ id, name, sheetType }))
+import { execution } from 'tadcode-wpsjs'
+/* 脚本令牌 具体获取方式参考上面 */
+const scriptToken = 'xxxx'
+/* webhook url地址 具体获取方式参考上面 */
+const webhookURL = 'xxxx'
+const result=await execution({ scriptToken, webhookURL })
+const data =await result.json()
 console.log(data)
 ```
 

package/index.js

@@ -1,2 +1,2 @@
 // @bun
-import V from"path";var X="execution";class W{sync=!0;scriptToken="";webhookURL="";asyncQueryURL="https://www.kdocs.cn/api/v3/script/task";printLog=!1;writeLogFile=!1;info=[];wpsjsGlobal=new Proxy(()=>{},{get:(G,j,q)=>{return this.info.push({method:"get",arguments:[j]}),q},apply:(G,j,q)=>{let{info:z}=this;if(z.at(-1)?.arguments[0]===X)return this.execute().then(async(B)=>{let{printLog:H,writeLogFile:M}=this,E=await B.json();if(H)Y(E);if(M)Bun.write("./wpsjs.log.json",JSON.stringify(E,void 0,4));return E.data.result});return z.push({method:"apply",arguments:q}),j}});queryTask(G){let{asyncQueryURL:j}=this,q=new URL(j);return q.searchParams.append("task_id",G),fetch(q.toString())}execute(){let{scriptToken:G,webhookURL:j,sync:q,info:z}=this;z.pop();let K=JSON.stringify({Context:{argv:{info:z}}});this.info=[];let B=V.parse(j);B.base=q?"sync_task":"task";let H=V.format(B);return fetch(H,{method:"post",headers:{"Content-Type":"application/json","AirScript-Token":G},body:K})}}var Y=(G)=>{let j=G,{status:q,data:z,error:K,error_details:B}=j;console.log("status:",q);let H=z.logs.at(-1).unix_time-z.logs[1].unix_time;if(console.log("runtime:",H),K)console.error(B.name),console.error(B.msg),console.error(B.stack);let M=z.logs.filter((E)=>E.filename!=="<system>");if(M.length!==0){console.log("log:");for(let E of M)console[E.level](...E.args)}return console.log("result:"),console.log(z.result),j};export{W as default};
+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

@@ -1,65 +1,61 @@
 import type { InfoItem, RemoteCallWpsjsGlobalReturn, WithExecutionWpsjsGlobal } from './types'
+import { writeFile } from 'fs/promises'
 import path from 'path'
-const fnName = 'execution'
-export default class RemoteCallWpsjsGlobal {
-	/* true 同步执行代码 */
-	sync = true
-	scriptToken = ''
-	webhookURL = ''
-	asyncQueryURL = 'https://www.kdocs.cn/api/v3/script/task'
-	/* true 在控制台上打印日志 */
-	printLog = false
-	/* true 在当前目录下，写入日志文件 */
-	writeLogFile = false
-	info: InfoItem[] = []
-	wpsjsGlobal = new Proxy(() => { }, {
-		get: (_target, p, receiver) => {
-			this.info.push({ method: 'get', arguments: [p] })
+interface Config {
+	scriptToken: string
+	webhookURL: string
+	isAsync?: boolean
+	printLog?: boolean
+	writeLogFile?: boolean
+}
+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
 		},
 		apply: (_target, thisArg, argArray) => {
-			const { info } = this
 			const lastInfo = info.at(-1)
-			if (lastInfo?.arguments[0] === fnName) {
-				return this.execute().then(async (response) => {
-					const { printLog, writeLogFile } = this
-					const responseJSON = await response.json()
-					if (printLog) printInfo(responseJSON)
-					if (writeLogFile) Bun.write('./wpsjs.log.json', JSON.stringify((responseJSON), undefined, 4))
-					return responseJSON['data']['result']
-				})
+			if (lastInfo?.arguments[0] === 'execution') {
+				info.pop() /* 删除 execution的调用信息 */
+				return execution({ scriptToken, webhookURL, isAsync, argv: { info } })
+					.then(async (response) => {
+						const responseObj = await response.json()
+						info = []	/* 执行结束，清空调用 */
+						if (printLog) printInfo(responseObj)
+						if (writeLogFile) writeLogFileToCurrent(responseObj)
+						return responseObj['data']['result']
+					})
 			}
 			info.push({ method: 'apply', arguments: argArray })
 			return thisArg
 		},
-	}) as unknown as WithExecutionWpsjsGlobal
-	queryTask(id: string) {
-		const { asyncQueryURL } = this
-		const url = new URL(asyncQueryURL)
-		url.searchParams.append('task_id', id)
-		return fetch(url.toString())
-	}
-	execute() {
-		const { scriptToken, webhookURL, sync, info } = this
-		/* 删除 execution的调用信息 */
-		info.pop()
-		/* 获取请求信息 */
-		const data = JSON.stringify({ Context: { argv: { info }, } })
-		/* 清空调用 */
-		this.info = []
-		/* 根据是否同步返回不同的url */
-		const parsedPath = path.parse(webhookURL)
-		parsedPath.base = sync ? 'sync_task' : 'task'
-		const url = path.format(parsedPath)
-		return fetch(url, {
-			method: 'post',
-			headers: {
-				'Content-Type': 'application/json',
-				'AirScript-Token': scriptToken
-			},
-			body: data
-		})
 	}
+	return new Proxy(() => { }, handle) as unknown as WithExecutionWpsjsGlobal
+}
+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)
+	parsedPath.base = isAsync ? 'task' : 'sync_task'
+	const url = path.format(parsedPath)
+	return fetch(url, {
+		method: 'post',
+		headers: {
+			'Content-Type': 'application/json',
+			'AirScript-Token': scriptToken
+		},
+		body: data
+	})
+}
+const queryTask = (id: string) => {
+	const url = new URL('https://www.kdocs.cn/api/v3/script/task')
+	url.searchParams.append('task_id', id)
+	return fetch(url)
 }
 const printInfo = (remoteCallResponse: RemoteCallWpsjsGlobalReturn) => {
 	const responseData = remoteCallResponse as RemoteCallWpsjsGlobalReturn
@@ -83,3 +79,9 @@ const printInfo = (remoteCallResponse: RemoteCallWpsjsGlobalReturn) => {
 	console.log(data.result)
 	return responseData
 }
+const writeLogFileToCurrent = (data: object) => {
+	writeFile('./wpsjs.log.json', JSON.stringify((data), undefined, 4))
+}
+
+export { execution, initRemoteCallWpsjsGlobal, queryTask, writeLogFileToCurrent }
+export type * from './types'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "tadcode-wpsjs",
-	"version": "0.1.2",
+	"version": "0.1.3",
 	"main": "index.js",
 	"type": "module",
 	"scripts": {

package/remoteCode/index.js

@@ -13,7 +13,6 @@ for (const item of info) {
 		} break
 		default:
 			throw Error('reflect method undefined')
-			break
 	}
 }
 return current

package/types/index.d.ts

@@ -10,7 +10,7 @@ interface WpsjsGlobal {
 type WithExecutionWpsjsGlobal = WithExecution<WpsjsGlobal>
 interface InfoItem {
 	method: keyof typeof Reflect
-	arguments: (string | symbol)[]
+	arguments: string[]
 }
 interface RemoteCallWpsjsGlobalReturn {
 	"data": {