tadcode-wpsjs 0.1.0

package/.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: https://editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = tab
+tab_width = 2
+trim_trailing_whitespace = true
+
+[*.md]
+indent_style = tab
+trim_trailing_whitespace = false

package/.vscode/launch.json

@@ -0,0 +1,44 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			/* 需要插件Bun for Visual Studio Code id：oven.bun-vscode */
+			"type": "bun",
+			"request": "launch",
+			"name": "Debug Bun",
+			// The path to a JavaScript or TypeScript file to run.
+			"program": "${file}",
+			// The arguments to pass to the program, if any.
+			"args": [],
+			// The working directory of the program.
+			"cwd": "${workspaceFolder}",
+			// The environment variables to pass to the program.
+			"env": {},
+			// If the environment variables should not be inherited from the parent process.
+			"strictEnv": false,
+			// If the program should be run in watch mode.
+			// This is equivalent to passing `--watch` to the `bun` executable.
+			// You can also set this to "hot" to enable hot reloading using `--hot`.
+			"watchMode": true,
+			// If the debugger should stop on the first line of the program.
+			"stopOnEntry": false,
+			// If the debugger should be disabled. (for example, breakpoints will not be hit)
+			"noDebug": false,
+			// The path to the `bun` executable, defaults to your `PATH` environment variable.
+			"runtime": "bun",
+			// The arguments to pass to the `bun` executable, if any.
+			// Unlike `args`, these are passed to the executable itself, not the program.
+			"runtimeArgs": [
+				// "--hot"
+			],
+		},
+		{
+			"type": "bun",
+			"request": "attach",
+			"name": "Attach to Bun",
+			// The URL of the WebSocket inspector to attach to.
+			// This value can be retrieved by using `bun --inspect`.
+			"url": "ws://localhost:6499/",
+		},
+	]
+}

package/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+	"files.autoSave": "off",
+	// The path to the `bun` executable.
+	// "bun.runtime": "/path/to/bun",
+	// If support for Bun should be added to the default "JavaScript Debug Terminal".
+	"bun.debugTerminal.enabled": true,
+	// If the debugger should stop on the first line of the program.
+	"bun.debugTerminal.stopOnEntry": false,
+	// Glob pattern to find test files. Defaults to the value shown below.
+	"bun.test.filePattern": "**/*{.test.,.spec.,_test_,_spec_}{js,ts,tsx,jsx,mts,cts}",
+}

package/README.md

@@ -0,0 +1,28 @@
+# tadcode-wpsjs
+
+## 应用
+
+用于学习wpsjsapi，远程调用wpsjsapi。
+
+使用wpsjs-1.0api。支持异步任务。支持`KSDrive`的类型。
+
+在远程部署代码好代码，通过传输的调用信息进行调用api。原理是使用代理收集调用信息，之后让远程代码进行调用并且返回结果。
+
+远程代码在`remoteCode`目录的`index.js`文件里面。将其复制粘贴到对应`webhook`的脚本中才能支持`wpsjsGlobal`的调用。
+
+## 安装
+
+`npm install tadcode-wpsjs` 或 `bun install tadcode-wpsjs`
+
+## 案例
+
+```ts
+import { RemoteCallWpsjsGlobal } from 'tadcode-wpsjs'
+const remoteCall = new RemoteCallWpsjsGlobal()
+remoteCall.scriptToken = 'xxxx' /* 脚本令牌 */
+remoteCall.webhookURL = 'xxxx' /* webhook url地址 */
+const { wpsjsGlobal } = remoteCall
+wpsjsGlobal.KSDrive.listFiles()/* 返回云文档下面的文件列表 */
+const response = await remoteCall.execute()
+console.log(await response.text())
+```

package/bun.lock

@@ -0,0 +1,27 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "tadcode-wpsjs",
+      "devDependencies": {
+        "@types/bun": "latest",
+      },
+      "peerDependencies": {
+        "typescript": "latest",
+      },
+    },
+  },
+  "packages": {
+    "@types/bun": ["@types/bun@1.2.8", "", { "dependencies": { "bun-types": "1.2.7" } }, "sha512-t8L1RvJVUghW5V+M/fL3Thbxcs0HwNsXsnTEBEfEVqGteiJToOlZ/fyOEaR1kZsNqnu+3XA4RI/qmnX4w6+S+w=="],
+
+    "@types/node": ["@types/node@22.13.14", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-Zs/Ollc1SJ8nKUAgc7ivOEdIBM8JAKgrqqUYi2J997JuKO7/tpQC+WCetQ1sypiKCQWHdvdg9wBNpUPEWZae7w=="],
+
+    "@types/ws": ["@types/ws@8.18.0", "", { "dependencies": { "@types/node": "*" } }, "sha512-8svvI3hMyvN0kKCJMvTJP/x6Y/EoQbepff882wL+Sn5QsXb3etnamgrJq4isrBxSJj5L2AuXcI0+bgkoAXGUJw=="],
+
+    "bun-types": ["bun-types@1.2.7", "", { "dependencies": { "@types/node": "*", "@types/ws": "*" } }, "sha512-P4hHhk7kjF99acXqKvltyuMQ2kf/rzIw3ylEDpCxDS9Xa0X0Yp/gJu/vDCucmWpiur5qJ0lwB2bWzOXa2GlHqA=="],
+
+    "typescript": ["typescript@5.8.2", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ=="],
+
+    "undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
+  }
+}

package/index.js

@@ -0,0 +1,2 @@
+// @bun
+import K from"node:path";class N{sync=!0;scriptToken="";webhookURL="";asyncQueryURL="https://www.kdocs.cn/api/v3/script/task";info=[];wpsjsGlobal=new Proxy(()=>{},{get:(B,z)=>{let{info:q,wpsjsGlobal:v}=this;return q.push({method:"get",arguments:[z]}),v},apply:(B,z,q)=>{let{info:v,wpsjsGlobal:F}=this;return v.push({method:"apply",arguments:q}),F}});execute(){let{scriptToken:B,webhookURL:z,info:q,sync:v}=this,F=JSON.stringify({Context:{argv:{info:q}}}),E=K.parse(z);E.base=v?"sync_task":"task";let H=K.format(E);return fetch(H,{method:"post",headers:{"Content-Type":"application/json","AirScript-Token":B},body:F})}queryTask(B){let{asyncQueryURL:z}=this,q=new URL(z);return q.searchParams.append("task_id",B),fetch(q.toString())}}async function S(B){let z=await B.json(),{status:q,data:v,error:F,error_details:E}=z;console.log("result:"),console.log(v.result);let H=v.logs.filter((J)=>J.filename!=="<system>");if(H.length!==0){console.log("log:");for(let J of H)console[J.level](...J.args)}console.log("status:",q);let M=v.logs.at(-1).unix_time-v.logs[1].unix_time;if(console.log("runtime:",M),F)console.error(E.name),console.error(E.msg),console.error(E.stack);return z}export{S as printInfo,N as RemoteCallWpsjsGlobal};

package/index.ts

@@ -0,0 +1,74 @@
+import type { InfoItem, RemoteCallWpsjsGlobalReturn, WpsjsGlobal } from './types'
+import path from 'path'
+export class RemoteCallWpsjsGlobal {
+	sync = true
+	scriptToken = ''
+	webhookURL = ''
+	asyncQueryURL = 'https://www.kdocs.cn/api/v3/script/task'
+	info: InfoItem[] = []
+	wpsjsGlobal = new Proxy(() => { }, {
+		get: (_target, p) => {
+			const { info, wpsjsGlobal } = this
+			info.push({
+				method: 'get',
+				arguments: [p]
+			})
+			return wpsjsGlobal
+		},
+		apply: (_target, _thisArg, argArray) => {
+			const { info, wpsjsGlobal } = this
+			info.push({
+				method: 'apply',
+				arguments: argArray
+			})
+			return wpsjsGlobal
+		},
+	}) as WpsjsGlobal
+	execute() {
+		const { scriptToken, webhookURL, info, sync } = this
+		const data = JSON.stringify({
+			'Context': { 'argv': { 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
+		})
+	}
+	queryTask(id: string) {
+		const { asyncQueryURL } = this
+		const url = new URL(asyncQueryURL)
+		/* 这样子可以不用 encodeURIComponent */
+		url.searchParams.append('task_id', id)
+		return fetch(url.toString())
+	}
+}
+export async function printInfo(response: Response) {
+	const responseData = await response.json() as RemoteCallWpsjsGlobalReturn
+	const { status, data, error, error_details } = responseData
+	console.log('result:')
+	console.log(data.result)
+	const userInfo = data.logs.filter(x => x.filename !== '<system>')
+	if (userInfo.length !== 0) {
+		console.log('log:')
+		for (const item of userInfo) {
+			console[item.level](...item.args)
+		}
+	}
+	console.log('status:', status)
+	const time = data.logs.at(-1)!.unix_time - data.logs[1].unix_time
+	console.log('runtime:', time)
+	if (error) {
+		console.error(error_details.name)
+		console.error(error_details.msg)
+		console.error(error_details.stack)
+	}
+	return responseData
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+	"name": "tadcode-wpsjs",
+	"version": "0.1.0",
+	"main": "index.js",
+	"type": "module",
+	"scripts": {
+		"hot": "NODE_ENV=development bun --hot index.ts",
+		"dev": "NODE_ENV=development bun --watch index.ts",
+		"build": "NODE_ENV=production bun build index.ts --target bun --minify --outfile index.js"
+	},
+	"devDependencies": {
+		"@types/bun": "latest"
+	},
+	"keywords": [
+		"tadcode-wpsjs"
+	]
+}

package/remoteCode/index.js

@@ -0,0 +1,19 @@
+/* version 0.1 */
+const { info } = Context.argv
+let peviousTemp = undefined
+let current = globalThis
+for (const item of info) {
+	switch (item.method) {
+		case 'get': {
+			peviousTemp = current
+			current = Reflect.get(current, item.arguments[0])
+		} break
+		case 'apply': {
+			current = Reflect.apply(current, peviousTemp, item.arguments)
+		} break
+		default:
+			throw Error('reflect method undefined')
+			break
+	}
+}
+return current

package/test/one.test.ts

@@ -0,0 +1,14 @@
+import type { RemoteCallWpsjsGlobalReturn } from '../types'
+import { test, expect } from 'bun:test'
+import { RemoteCallWpsjsGlobal } from '../index'
+
+test('ok', async () => {
+	const remoteCall = new RemoteCallWpsjsGlobal()
+	remoteCall.webhookURL = 'xxxx' /* webhook url地址 */
+	remoteCall.webhookURL = 'xxxx' /* webhook url地址 */
+	const { wpsjsGlobal } = remoteCall
+	wpsjsGlobal.KSDrive.listFiles()
+	const response = await remoteCall.execute()
+	console.log(await response.text())
+	// const responseData = await printInfo(response)
+})

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+	"compilerOptions": {
+		// Enable latest features
+		"lib": [
+			"ESNext",
+			"DOM"
+		],
+		"target": "ESNext",
+		"module": "ESNext",
+		"moduleDetection": "force",
+		"jsx": "react-jsx",
+		"allowJs": true,
+		// Bundler mode
+		"moduleResolution": "bundler",
+		"allowImportingTsExtensions": true,
+		"verbatimModuleSyntax": true,
+		"noEmit": true,
+		// Best practices
+		"strict": true,
+		"skipLibCheck": true,
+		"noFallthroughCasesInSwitch": true,
+		// Some stricter flags (disabled by default)
+		"noUnusedLocals": false,
+		"noUnusedParameters": false,
+		"noPropertyAccessFromIndexSignature": false
+	}
+}

package/types/DB_Application.d.ts

@@ -0,0 +1,120 @@
+export default interface DB_Application {
+	Sheet: DBSheet
+	Record: DBRecord
+	Field: DBField
+	View: DBView
+}
+/* 表 */
+interface DBSheet {
+	GetSheets(): SheetInfo
+	CreateSheet(options: Pick<SheetOptions, 'SheetId'>)
+	DeleteSheet(options: Pick<SheetOptions, 'SheetId'>)
+	UpdateSheet(options: Omit<SheetOptions, 'SheetId'> & Partial<SheetOptions>)
+}
+interface SheetOptions {
+	SheetId: number
+	Name: string
+	Views: {
+		name: string
+		/**
+		 * 表格视图 看板视图 画册视图 表单视图 甘特视图
+		 */
+		type: ViewType
+	}[]
+	Fields: { name: string, type: FieldType }[]
+}
+interface SheetInfo {
+	"description": string,
+	"fields": {
+		"arraySupport": boolean,
+		"autoFillSourceField": string,
+		"customConfig": string,
+		"defaultValueType": "Normal",
+		"description": string,
+		"id": string,
+		"name": string,
+		"numberFormat": string,
+		"syncField": boolean,
+		"type": FieldType,
+		"uniqueValue": boolean
+		"loadLegalHoliday": number,
+		"items": {
+			"color": number,
+			"id": string,
+			"value": string
+		}[],
+		"allowAddItemWhenInputting": true,
+		"autoAddItem": boolean,
+	}[],
+	"icon": string,
+	"id": number,
+	"name": number,
+	"primaryFieldId": number,
+	"recordsCount": number,
+	"sheetType": "xlEtDataBaseSheet",
+	"subType": "Normal",
+	"syncFieldSourceId": string,
+	"syncFieldSourceNameId": string,
+	"syncType": "None",
+	"views": {
+		"id": string,
+		"name": string,
+		"notice": string,
+		"recordsCount": number,
+		"type": ViewType
+	}[]
+}
+
+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'
+type ViewType = 'Grid' | 'Kanban' | 'Gallery' | 'Form' | 'Gantt'
+
+/* 行记录 */
+interface DBRecord {
+	GetRecords(options: Pick<RcordOptions, 'SheetId'>)
+	GetRecord(options: Pick<RcordOptions, 'SheetId' | 'RecordId'>)
+	DeleteRecords(options: Pick<RcordOptions, 'SheetId' | 'RecordIds'>)
+	UpdateRecords(options: Pick<RcordOptions, 'SheetId' | 'Records'>)
+}
+interface RcordOptions {
+	SheetId: number
+	RecordId: string
+	RecordIds: string[]
+	Records: {
+		id: string,
+		fields: Record<string, string | number | string[]>
+	}[]
+}
+
+/* 字段 */
+interface DBField {
+	GetFields(options: Pick<FieldOptions, 'SheetId'>)
+	CreateFields(options: Pick<FieldOptions, 'SheetId' | 'Fields'>)
+	DeleteFields(options: Pick<FieldOptions, 'SheetId' | 'FieldIds'>)
+	UpdateFields(options: Pick<FieldOptions, 'SheetId' | 'Fields'> & {
+
+	})
+}
+interface FieldOptions {
+	SheetId: number
+	Fields: Partial<Field>[]
+	FieldIds: string[]
+}
+interface Field {
+	id: string,
+	name: string,
+	type: FieldType
+}
+
+/* 视图 */
+interface DBView {
+	GetViews(options: Pick<ViewOptions, 'SheetId'>)
+	CreateView(options: Pick<ViewOptions, 'SheetId' | 'Name' | 'ViewType'>)
+	DeleteView(options: Pick<ViewOptions, 'SheetId' | 'ViewId'>)
+	UpdateView(options: Pick<ViewOptions, 'SheetId' | 'Name' | 'ViewId'>)
+}
+interface ViewOptions {
+	SheetId: number
+	ViewId: string
+	Name: string
+	ViewType: ViewType
+}

package/types/KSDrive.d.ts

@@ -0,0 +1,53 @@
+import DB_Application from './DB_Application'
+import KSheet_Application from './KSheet_Application'
+export default interface KSDrive {
+	FileType: {
+		/**智能文档 */
+		AP: string
+		/**智能表格 */
+		KSheet: string
+		/**表格 */
+		ET: string
+		/**多维表 */
+		DB: string
+	}
+	/**
+	 * 创建文件
+	 * @param type 新文件的类型
+	 * @param createOptions 新文件的参数选项
+
+	 */
+	createFile(type: string, createOptions: createOptions)
+	openFile(url: string): {
+		Application: KSheet_Application & DB_Application
+		close()
+	}
+	listFiles(options?: {
+		dirUrl: string
+		offset: number
+		count: number
+		includeExts: string[]
+	})
+}
+interface CreateOptions {
+	/**是	新文件的文件名 */
+	name: string
+	/**否	新文件的文件目录 */
+	dirUrl: string
+	/**否	将目标文件另存为新文件 */
+	source: string
+}
+interface FilesInfo {
+	files: FileInfo[]
+	nextOffset: number
+}
+interface FileInfo {
+	/**	文件名 */
+	fileName: string
+	/**	加密后的文件 id */
+	fileId: string
+	/**	文件创建时间戳 */
+	createTime: number
+	/**	文件修改时间戳 */
+	updateTime: number
+}

package/types/KSheet_Application.d.ts

@@ -0,0 +1,25 @@
+export interface KSheet_Application {
+	Sheets: {
+		Item(index: number | string): Sheet
+	}
+	Range(index: string): {
+		Value: any
+	}
+}
+interface Sheet {
+	/**
+	 * 获取一个单元格或单元格区域，返回一个 Range 对象
+	 * @paramaddress — 地址，可以是单元格地址或者选区范围范围地址
+	 * @returns — 工作表里的一个单元格或单元格区域
+	 * @example — 参考示例
+	 * const sheet = Application.ActiveSheet
+	 * // 打印当前活动工作表D2单元格的内容
+	 * console.log(sheet.Range('D2').Text) // D2
+	 * // 修改当前活动工作表D2单元格的内容
+	 * sheet.Range('D2').Value = 'this is D2'
+	 */
+	Range(address: string): Range
+}
+interface Range {
+	Value2: any
+}

package/types/index.d.ts

@@ -0,0 +1,81 @@
+import KSDrive from './KSDrive'
+interface WpsjsGlobal {
+	(): WpsjsGlobal
+	Date: typeof Date
+	KSDrive: KSDrive
+}
+interface InfoItem {
+	method: keyof typeof Reflect
+	arguments: (string | symbol)[]
+}
+interface RemoteCallWpsjsGlobalReturn {
+	"data": {
+		"logs": [
+			{
+				"filename": "<system>",
+				"timestamp": string,
+				"unix_time": number,
+				"level": "info",
+				"args": [
+					"脚本环境(2.0)初始化..."
+				]
+			},
+			{
+				"filename": "<system>",
+				"timestamp": string,
+				"unix_time": number,
+				"level": "info",
+				"args": [
+					"已开始执行"
+				]
+			},
+			{
+				"filename": "xxxx.js:row:column",
+				"timestamp": string,
+				"unix_time": number,
+				"level": "error",
+				"args": []
+			},
+			{
+				"filename": "xxxx.js:row:column",
+				"timestamp": string,
+				"unix_time": number,
+				"level": "warn",
+				"args": []
+			},
+			{
+				"filename": "xxxx.js:row:column",
+				"timestamp": string,
+				"unix_time": number,
+				"level": "info",
+				"args": []
+			},
+			{
+				"filename": "<system>",
+				"timestamp": string,
+				"unix_time": number,
+				"level": "info",
+				"args": [
+					"执行完毕"
+				]
+			}
+		],
+		"result": unknown,
+		"task_id": string,
+	},
+	"error": string,
+	"error_details": {
+		"name": string,
+		"msg": string,
+		"stack": string[],
+		"unix_time": number,
+	},
+	"status": "finished",
+	"task_id": "GN/KU3B3BG84MdCjraN5mukx0Rt5Sp1eJ9k2qClmcaOkkF3PUVNDOYPY7Kz4aQMXSvXn9N08QabldRKjPfzii87fuGYydIuK2la2HMfcxmGK1Pf4WcPEflb5xOOkQQEo8fmEbzcobhurYg==",
+	"task_type": "open_air_script",
+}
+export {
+	WpsjsGlobal,
+	InfoItem,
+	RemoteCallWpsjsGlobalReturn,
+}