tadcode-wpsjs 1.4.0 → 1.5.1

package/README.md

@@ -4,9 +4,9 @@
 
 项目地址：[https://gitcode.com/caisijian/tadcode-wpsjs](https://gitcode.com/caisijian/tadcode-wpsjs)
 
-在部署远程代码的情况下，可以远程调用`WpsjsGlobal`，实现对支持`AirScript`的多维表，智能表格等远程操作。如果你对`AirScript`，感兴趣，也能帮助你学习`WpsjsGlobal`。
+在部署远程代码的情况下，可以远程调用`WpsjsGlobal`，实现对支持`AirScript`的多维表，智能表格等远程操作。如果你对`AirScript`，感兴趣，也能帮助你学习`AirScript`。
 
-In the case of deploying remote code, WpsjsGlobal can be remotely called to achieve remote operations on multidimensional tables, smart tables, and other tables that support AirScript. If you are interested in AirScript, it can also help you learn WpsjsGlobal.
+When deploying remote code, you can remotely invoke `WpsjsGlobal` to perform remote operations on multi-dimensional tables, smart tables, and other supported features with `AirScript`. If you're interested in `AirScript`, it can also assist you in learning it.
 
 原理是使用代理收集调用信息，之后让远程代码进行调用并且返回结果。
 远程代码在`tadcode-wpsjs/remoteCode`目录的`index.js`文件中。
@@ -83,7 +83,7 @@ const wpsjsGlobal = initRemoteCallWpsjsGlobal({ scriptToken, webhookURL,  })
 
 const range = wpsjsGlobal.Application.ActiveSheet.RecordRange([1, 2], [1, 2]).Font as unknown as Font
 range.Color = '#ff00ff'
-/* 注意：赋值操作依旧远程操作。此函数会拿到最后一次赋值操作的promise */
+/* 注意：赋值操作依旧是远程操作。此函数会拿到最后一次赋值操作的promise */
 await setValueOk()
 ```
 

package/index.ts

@@ -94,13 +94,13 @@ const execution = ({ scriptToken, webhookURL, isAsync, argv }: ExecutionConfig)
 }
 
 let setValuePromise: any = null
-/* 远程调用的赋值操作返回的promise */
+/** 赋值操作返回的promise */
 const setValueOk = async () => setValuePromise
-/**赋值 */
-const setValue = async <T extends Promise<any>>(
+/** 赋值 */
+const setValue = async <T extends Promise<any>, K extends keyof Awaited<T>, V extends Awaited<T>[K]>(
   promiseObj: T,
-  p: keyof Awaited<T>,
-  newValue: Awaited<T>[keyof Awaited<T>],
+  p: K,
+  newValue: V,
 ) => {
   const obj = promiseObj as Awaited<T>
   const func = obj[rawSymbol] as ProxyTarget

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tadcode-wpsjs",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "type": "module",
   "scripts": {
     "hot": "NODE_ENV=development bun --hot ignore/index.ts",

package/types/KSDrive.d.ts

@@ -1,72 +1,72 @@
-declare module 'tadcode-wpsjs:global' {
-  import type DBApplication from 'application:datatable'
-  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
-    /**否	将目标文件另存为新文件 */
-    source?: string
-  }
-
-  interface FilesInfo {
-    files: FileInfo[]
-    nextOffset: number
-  }
-
-  interface FileInfo {
-    /**	文件名 */
-    fileName: string
-    /**	加密后的文件 id */
-    fileId: string
-    /**	文件创建时间戳 */
-    createTime: number
-    /**	文件修改时间戳 */
-    updateTime: number
-  }
-
-  interface KSDrive {
-    FileType: FileType
-    /**
-     * 创建文件
-     * @param type 新文件的类型
-     * @param createOptions 新文件的参数选项
-     * @returns 新文件url
-     */
-    createFile(type: FileTypeValue, createOptions: CreateOptions): string
-
-    openFile(url: string): {
-      Application: DB_Application
-      close()
-    }
-
-    listFiles(options?: {
-      dirUrl?: string
-      offset?: number
-      count?: number
-      includeExts?: string[]
-    }): FilesInfo
-  }
-
-  export type { KSDrive, FileTypeValue }
-}
+declare module 'tadcode-wpsjs:global' {
+  import type DBApplication from 'application:datatable'
+  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
+    /**否	将目标文件另存为新文件 */
+    source?: string
+  }
+
+  interface FilesInfo {
+    files: FileInfo[]
+    nextOffset: number
+  }
+
+  interface FileInfo {
+    /**	文件名 */
+    fileName: string
+    /**	加密后的文件 id */
+    fileId: string
+    /**	文件创建时间戳 */
+    createTime: number
+    /**	文件修改时间戳 */
+    updateTime: number
+  }
+
+  interface KSDrive {
+    FileType: FileType
+    /**
+     * 创建文件
+     * @param type 新文件的类型
+     * @param createOptions 新文件的参数选项
+     * @returns 新文件url
+     */
+    createFile(type: FileTypeValue, createOptions: CreateOptions): string
+
+    openFile(url: string): {
+      Application: DBApplication
+      close()
+    }
+
+    listFiles(options?: {
+      dirUrl?: string
+      offset?: number
+      count?: number
+      includeExts?: string[]
+    }): FilesInfo
+  }
+
+  export type { KSDrive, FileTypeValue }
+}

package/types/application/Criteria.d.ts

@@ -1,31 +1,31 @@
-declare module 'application:datatable' {
-  // 基础类型定义
-  type CriteriaOp = 
-    | 'Equals' | 'NotEqu' | 'Greater' | 'GreaterEqu' | 'Less' | 'LessEqu'
-    | 'GreaterEquAndLessEqu' | 'LessOrGreater' | 'BeginWith' | 'EndWith'
-    | 'Contains' | 'NotContains' | 'Intersected' | 'Empty' | 'NotEmpty';
-
-  type DynamicType = 
-    | 'today' | 'yesterday' | 'tomorrow' | 'last7Days' | 'last30Days'
-    | 'thisWeek' | 'lastWeek' | 'nextWeek' | 'thisMonth' | 'lastMonth' | 'nextMonth';
-
-  // Criteria Value 类型
-  interface CriteriaValue {
-    type?: string;
-    value?: any;
-    dynamicType?: DynamicType;
-  }
-
-  // Criteria 接口
-  interface Criteria {
-    // 属性
-    Field: number | string;
-    Op: CriteriaOp;
-    Values: CriteriaValue[];
-
-    // 注意：文档中显示有 Criteria 构造函数/工厂方法，但这里是接口定义
-  }
-
-  // 导出 Criteria 类型
-  export type { Criteria };
-}
+declare module 'application:datatable' {
+  // 基础类型定义
+  type CriteriaOp =
+    | 'Equals' | 'NotEqu' | 'Greater' | 'GreaterEqu' | 'Less' | 'LessEqu'
+    | 'GreaterEquAndLessEqu' | 'LessOrGreater' | 'BeginWith' | 'EndWith'
+    | 'Contains' | 'NotContains' | 'Intersected' | 'Empty' | 'NotEmpty'
+
+  type DynamicType =
+    | 'today' | 'yesterday' | 'tomorrow' | 'last7Days' | 'last30Days'
+    | 'thisWeek' | 'lastWeek' | 'nextWeek' | 'thisMonth' | 'lastMonth' | 'nextMonth'
+
+  // Criteria Value 类型
+  interface CriteriaValue {
+    type?: string
+    value?: any
+    dynamicType?: DynamicType
+  }
+
+  // Criteria 接口
+  export interface Criteria {
+    // 属性
+    Field: number | string
+    Op: CriteriaOp
+    Values: CriteriaValue[]
+
+    // 注意：文档中显示有 Criteria 构造函数/工厂方法，但这里是接口定义
+  }
+
+  // 导出 Criteria 类型
+  export type { }
+}

package/types/application/Field.d.ts

@@ -1,25 +1,25 @@
-declare module 'application:datatable' {
-  // FieldDescriptor 接口（根据文档引用）
-  interface FieldDescriptor {
-    Name: string;
-    // 其他FieldDescriptor属性
-  }
-
-  // Field 接口
-  interface Field {
-    // 属性
-    readonly FieldDescriptor: FieldDescriptor;
-    readonly Id: string;
-    readonly Name: string;
-    readonly Type: string;
-    Visible: boolean;
-    readonly Width: string;
-
-    // 方法
-    Copy(Before?: string | number, After?: string | number): Field;
-    Move(Before?: string | number, After?: string | number): any; // ApiResult
-  }
-
-  // 导出 Field 类型
-  export type { Field };
-}
+declare module 'application:datatable' {
+  // FieldDescriptor 接口（根据文档引用）
+  interface FieldDescriptor {
+    Name: string
+    // 其他FieldDescriptor属性
+  }
+
+  // Field 接口
+  export interface Field {
+    // 属性
+    readonly FieldDescriptor: FieldDescriptor
+    readonly Id: string
+    readonly Name: string
+    readonly Type: string
+    Visible: boolean
+    readonly Width: string
+
+    // 方法
+    Copy(Before?: string | number, After?: string | number): Field
+    Move(Before?: string | number, After?: string | number): any // ApiResult
+  }
+
+  // 导出 Field 类型
+  export type { }
+}

package/types/application/FieldApi.d.ts

@@ -201,12 +201,12 @@ declare module 'application:datatable' {
     FieldIds: string[]
   }
 
-  interface FieldApi {
+  export interface FieldApi {
     CreateFields(options: Pick<FieldFuncOptions, 'SheetId'> & { Fields: DistributiveOmit<OmitFieldSelectId<Field>, 'id'>[] }): Field[]
     GetFields(options: Pick<FieldFuncOptions, 'SheetId'>): Field[]
     UpdateFields(options: Pick<FieldFuncOptions, 'SheetId'> & { Fields: (DeepPartial<Field> & { id: string })[] }): Field[]
     DeleteFields(options: Pick<FieldFuncOptions, 'SheetId' | 'FieldIds'>): (Pick<FieldBase, 'id'> & { deleted: boolean })[]
   }
 
-  export type { FieldApi }
+  export type { }
 }

package/types/application/FieldDescriptor.d.ts

@@ -0,0 +1,87 @@
+declare module 'application:datatable' {
+  // 基础类型定义
+  export type FieldType =
+    | 'SingleLineText'
+    | 'MultiLineText'
+    | 'Date'
+    | 'SingleSelect'
+    | 'Number'
+    | 'Rating'
+    | 'ID'
+    | 'Phone'
+    | 'Email'
+    | 'Url'
+    | 'Checkbox'
+    | 'MultipleSelect'
+    | 'Complete'
+    | 'CellPicture'
+    | 'Contact'
+    | 'Attachment'
+    | 'Note'
+    | 'Link'
+    | 'OneWayLink'
+    | 'Lookup'
+    | 'Address'
+    | 'Cascade'
+    | 'Automations'
+    | 'AutoNumber'
+    | 'CreatedBy'
+    | 'CreatedTime'
+    | 'LastModifiedBy'
+    | 'LastModifiedTime'
+    | 'Formula'
+    | 'Button'
+
+  interface EventContext {
+    Destroy(): void
+  }
+
+  // 字段删除事件数据
+  interface FieldDeleteEventData {
+    sheetId: number
+    fieldId: string
+    fieldIds: string[]
+  }
+
+  // 字段描述符接口
+  export interface FieldDescriptor {
+    // 属性
+    Id: string
+    Type: FieldType
+    Name: string
+    Description: string
+    IsSyncField: boolean
+    DefaultVal: string
+    DefaultValType: any // Enum.DbFieldDefaultValueType
+    NumberFormat: string
+    IsValueUnique: boolean
+
+    // 各字段类型的特有属性
+    Button?: any
+    Address?: any
+    Cascade?: any
+    Contact?: any
+    Date?: any
+    Watch?: any
+    Formula?: any
+    Lookup?: any
+    Link?: any
+    Automation?: any
+    Attachment?: any
+    Url?: any
+    Number?: any
+    Select?: any
+    Rating?: any
+
+    // 方法
+    Apply(): any // ApiResult
+    Delete(RemoveReversedLink?: boolean): boolean
+
+    // 事件
+    OnUpdate(callback: (data: FieldDescriptor) => void): EventContext
+    OnDelete(callback: (data: FieldDeleteEventData) => void): EventContext
+  }
+
+  // 导出类型
+  export type { }
+}

package/types/application/FieldDescriptors.d.ts

@@ -0,0 +1,25 @@
+declare module 'application:datatable' {
+  import { ViewType, FieldType, FieldDescriptor } from 'application:datatable'
+
+  interface EventContext {
+    Destroy(): void
+  }
+
+  // 字段描述符集合接口
+  export interface FieldDescriptors {
+    // 属性
+    Count: number
+
+    // 方法
+    Item(Index: string | number): FieldDescriptor
+    FieldDescriptor(Type: string, Name: string): FieldDescriptor
+    AddField(FieldDescriptor: FieldDescriptor, Index?: string | number): any
+    Delete(FieldId: string, RemoveReversedLink?: boolean): boolean
+
+    // 事件
+    OnCreate(callback: (data: FieldDescriptor) => void): EventContext
+  }
+
+  // 导出类型
+  export type { }
+}

package/types/application/Fields.d.ts

@@ -1,20 +1,14 @@
-declare module 'application:datatable' {
-  // Field 接口（根据文档引用）
-  interface Field {
-    readonly Id: string;
-    Name: string;
-    // 其他Field属性
-  }
-
-  // Fields 接口
-  interface Fields {
-    // 属性
-    readonly Count: number;
-
-    // 方法
-    Item(Index: string | number): Field;
-  }
-
-  // 导出 Fields 类型
-  export type { Fields };
-}
+declare module 'application:datatable' {
+
+  // Fields 接口
+  export interface Fields {
+    // 属性
+    readonly Count: number
+
+    // 方法
+    Item(Index: string | number): Field
+  }
+
+  // 导出 Fields 类型
+  export type { }
+}

package/types/application/Font.d.ts

@@ -1,10 +1,10 @@
-declare module 'application:datatable' {
-  // Font 接口
-  interface Font {
-    // 属性
-    Color: string;
-  }
-
-  // 导出 Font 类型
-  export type { Font };
-}
+declare module 'application:datatable' {
+  // Font 接口
+  export interface Font {
+    // 属性
+    Color: string
+  }
+
+  // 导出 Font 类型
+  export type { }
+}

package/types/application/GanttViewUI.d.ts

@@ -0,0 +1,25 @@
+declare module 'application:datatable' {
+  // 甘特图视图模式
+  type GanttViewMode = 'Week' | 'Month' | 'Quarter' | 'Year'
+
+  interface EventContext {
+    Destroy(): void
+  }
+
+  // 甘特图视图UI接口
+  export interface GanttViewUI {
+    // 属性
+    GanttGridFold: boolean
+    ViewMode: GanttViewMode
+
+    // 方法
+    Today(): boolean
+    NextPage(): boolean
+    PrevPage(): boolean
+    FoldAll(): boolean
+    UnFoldAll(): boolean
+  }
+
+  // 导出类型
+  export type { }
+}

package/types/application/Record.d.ts

@@ -1,22 +1,22 @@
-declare module 'application:datatable' {
-  // 基础类型定义
-  interface Attachment {
-    // Attachment类型
-  }
-
-  // Record 接口
-  interface Record {
-    // 属性
-    readonly Id: string;
-    readonly Text: string;
-    Value: any; // 可读写的值，根据字段类型不同返回不同类型
-
-    // 方法
-    Item(Index: number | string): Record;
-    Delete(): boolean;
-    Select(): boolean;
-  }
-
-  // 导出 Record 类型
-  export type { Record };
-}
+declare module 'application:datatable' {
+  // 基础类型定义
+  interface Attachment {
+    // Attachment类型
+  }
+
+  // Record 接口
+  export interface Record {
+    // 属性
+    readonly Id: string
+    readonly Text: string
+    Value: any // 可读写的值，根据字段类型不同返回不同类型
+
+    // 方法
+    Item(Index: number | string): Record
+    Delete(): boolean
+    Select(): boolean
+  }
+
+  // 导出 Record 类型
+  export type { }
+}

package/types/application/RecordApi.d.ts

@@ -166,7 +166,7 @@ declare module 'application:datatable' {
     Filter: RecordsFuncOptionsFilter
   }
   /* 行记录 */
-  interface RecordApi {
+  export interface RecordApi {
     CreateRecords(options: Pick<RecordFuncOptions, 'SheetId'> & { Records: { fields: Record<string, any> }[] }): RecordItem[]
     GetRecord(options: Pick<RecordFuncOptions, 'SheetId' | 'RecordId'>): RecordItem
     GetRecords(options: Pick<RecordFuncOptions, 'SheetId'> & Partial<Pick<RecordFuncOptions, 'ViewId' | 'PageSize' | 'Offset' | 'MaxRecords' | 'Fields' | 'Filter'>>): { records: RecordItem[] }
@@ -174,5 +174,5 @@ declare module 'application:datatable' {
     DeleteRecords(options: Pick<RecordFuncOptions, 'SheetId' | 'RecordIds'>): (Pick<RecordItem, 'id'> & { deleted: boolean })[]
   }
 
-  export type { RecordApi }
+  export type { }
 }