tadcode-wpsjs 0.1.2 → 0.3.0

package/types/DB_Application_Sheet.d.ts

@@ -0,0 +1,63 @@
+import type { FieldTypeKeys, } from './DB_Application_Field'
+import type { ViewType } from './DB_Application_View'
+
+interface Sheet {
+  'description': string,
+  'fields': {
+    'arraySupport': boolean,
+    'autoFillSourceField': string,
+    'customConfig': string,
+    'defaultValueType': 'Normal',
+    'description': string,
+    'id': string,
+    'name': string,
+    'numberFormat': string,
+    'syncField': boolean,
+    'type': FieldTypeKeys,
+    '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
+  }[]
+}
+
+interface SheetFuncOptions {
+  SheetId: number
+  Name: string
+  Views: {
+    name: string
+    type: ViewType
+  }[]
+  Fields: { name: string, type: FieldTypeKeys }[]
+}
+
+export type { Sheet, SheetFuncOptions }
+
+export default interface DBSheet {
+  CreateSheet(options: Omit<SheetFuncOptions, 'SheetId'>): Sheet
+  GetSheets(): Sheet[]
+  UpdateSheet(options: Pick<SheetFuncOptions, 'SheetId' | 'Name'>): boolean
+  DeleteSheet(options: Pick<SheetFuncOptions, 'SheetId'>): Pick<Sheet, 'id'>
+}

package/types/DB_Application_View.d.ts

@@ -0,0 +1,24 @@
+type ViewType = 'Grid' | 'Kanban' | 'Gallery' | 'Form' | 'Gantt'
+
+interface View {
+  "id": string
+  "name": string
+  "recordsCount": number
+  "type": ViewType
+}
+
+interface ViewFuncOptions {
+  SheetId: number
+  ViewId: string
+  Name: string
+  ViewType: ViewType
+}
+
+export type { View, ViewType, ViewFuncOptions }
+
+export default interface DBView {
+  CreateView(options: Pick<ViewFuncOptions, 'SheetId' | 'Name' | 'ViewType'>): View
+  GetViews(options: Pick<ViewFuncOptions, 'SheetId'>): View[]
+  UpdateView(options: Pick<ViewFuncOptions, 'SheetId' | 'Name' | 'ViewId'>): View
+  DeleteView(options: Pick<ViewFuncOptions, 'SheetId' | 'ViewId'>): Pick<View, 'id'>
+}

package/types/KSDrive.d.ts

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

package/types/KSheet_Application.d.ts

@@ -1,25 +1,29 @@
-export default interface KSheet_Application {
-	Sheets: {
-		Item(index: number | string): Sheet
-	}
-	Range(index: string): {
-		Value: any
-	}
+interface Range {
+  Value2: any
+  Formula: any
+  Resize(RowSize: number, ColumnSize?: number): Range
 }
+
 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
+  UsedRange: Range
+  /**
+   * 获取一个单元格或单元格区域，返回一个 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
+
+export default interface KSheet_Application {
+  ActiveSheet: Sheet
+  Sheets: {
+    Item(index: number | string): Sheet
+  }
+  Range(index: string): Range
 }

package/types/index.d.ts

@@ -2,85 +2,46 @@ import type { WithExecution } from './type-tools'
 import type DB_Application from './DB_Application'
 import type KSheet_Application from './KSheet_Application'
 import type KSDrive from './KSDrive'
+
 interface WpsjsGlobal {
-	Date: typeof Date
-	KSDrive: KSDrive
-	Application: KSheet_Application & DB_Application
+  KSDrive: KSDrive
+  Application: KSheet_Application & DB_Application
 }
+
 type WithExecutionWpsjsGlobal = WithExecution<WpsjsGlobal>
+
 interface InfoItem {
-	method: keyof typeof Reflect
-	arguments: (string | symbol)[]
+  method: keyof typeof Reflect
+  arguments: string[]
 }
+
 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",
+  "data": {
+    "logs": {
+      "filename": string
+      "timestamp": string
+      "unix_time": number
+      "level": 'info' | 'error' | 'warn'
+      "args": string[]
+    }[]
+    "result": unknown
+    "task_id": string
+  }
+  "error": string
+  "error_details": {
+    "name": string
+    "msg": string
+    "stack": string[]
+    "unix_time": number
+  }
+  "status": "finished"
+  "task_id": string
+  "task_type": string
 }
+
 export {
-	WpsjsGlobal,
-	WithExecutionWpsjsGlobal,
-	InfoItem,
-	RemoteCallWpsjsGlobalReturn,
+  WpsjsGlobal,
+  WithExecutionWpsjsGlobal,
+  InfoItem,
+  RemoteCallWpsjsGlobalReturn,
 }

package/types/type-tools.ts

@@ -1,13 +1,33 @@
-/* 根据给的对象，添加execution方法 */
+/**根据给的对象，添加execution方法 */
 type WithExecution<T> = T extends (...args: infer A) => infer R
-	? ((...args: A) => WithExecution<R>) & { execution: () => Promise<R> }
-	: T extends object
-	? { [K in keyof T]: WithExecution<T[K]> } & { execution: () => Promise<T> }
-	: T & { execution: () => Promise<T> }
+  ? ((...args: A) => WithExecution<R>) & { execution: () => Promise<R> }
+  : T extends object
+  ? { [K in keyof T]: WithExecution<T[K]> } & { execution: () => Promise<T> }
+  : T & { execution: () => Promise<T> }
+
 /**部分可选 */
 type MakePropertyOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
-/* 选取修改类型 */
+
+/**选取修改类型 */
 type PickModify<T, K extends keyof T, M> = {
-	[P in K]: M
+  [P in K]: M
+}
+
+/**
+ * 深度可选工具类型
+ */
+type DeepPartial<T> = T extends object
+  ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : T
+
+/**去掉联合类型对象中的id */
+type DistributiveOmit<T, K extends PropertyKey> =
+  T extends any ? Omit<T, K> : never
+
+export type {
+  WithExecution,
+  MakePropertyOptional,
+  PickModify,
+  DeepPartial,
+  DistributiveOmit,
 }
-export type { WithExecution, MakePropertyOptional, PickModify }

package/.editorconfig

@@ -1,16 +0,0 @@
-# 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

@@ -1,44 +0,0 @@
-{
-	"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

@@ -1,26 +0,0 @@
-{
-	"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}",
-	"search.exclude": {
-		"**/node_modules": true,
-		"**/bower_components": true,
-		"**/*.code-search": true
-	},
-	"files.exclude": {
-		"**/node_modules": true,
-		"**/.git": true,
-		"**/.svn": true,
-		"**/.hg": true,
-		"**/CVS": true,
-		"**/.DS_Store": true,
-		"**/Thumbs.db": true,
-		"bun.lock": true,
-	}
-}