tadcode-wpsjs 1.3.0 → 1.5.0

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.3.0",
+  "version": "1.5.0",
   "type": "module",
   "scripts": {
     "hot": "NODE_ENV=development bun --hot ignore/index.ts",

package/types/application/FieldDescriptor.d.ts

@@ -0,0 +1,88 @@
+declare module 'application:datatable' {
+  import { ViewType } from 'application:datatable'
+  // 基础类型定义
+  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[]
+  }
+
+  // 字段描述符接口
+  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 { FieldDescriptor, FieldType }
+}

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
+  }
+
+  // 字段描述符集合接口
+  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 { FieldDescriptors }
+}

package/types/application/GanttViewUI.d.ts

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

package/types/application/RecordRange.d.ts

@@ -1,5 +1,5 @@
 declare module 'application:datatable' {
-  import type { Criteria } from 'application:datatable'
+  import type { Criteria, Patch } from 'application:datatable'
   // 基础类型定义
   type FilterOp = 'And' | 'Or'
 
@@ -44,7 +44,7 @@ declare module 'application:datatable' {
   }
 
   // RecordRange 接口
-  interface RecordRange {
+  interface RecordRange extends Patch.RecordRange2 {
     // 属性
     readonly Count: number
     FieldId: any[] // 返回Array
@@ -68,10 +68,6 @@ declare module 'application:datatable' {
     OnUpdate(callback: (data: RecordRange) => void): EventContext
   }
 
-  interface RecordRange {
-    (Index?: number | string | any[], Field?: number | string | any[]): RecordRange
-  }
-
   // 导出 RecordRange 类型
   export type { RecordRange }
 }

package/types/application/Records.d.ts

@@ -1,5 +1,5 @@
 declare module 'application:datatable' {
-  import type { Record } from 'application:datatable'
+  import type { Record, Patch } from 'application:datatable'
   // 基础类型定义
   type ViewType = 'Grid' | 'Kanban' | 'Gallery' | 'Form' | 'Query' | 'Gantt'
 
@@ -8,7 +8,7 @@ declare module 'application:datatable' {
   }
 
   // Records 接口
-  interface Records {
+  interface Records extends Patch.Records {
     // 属性
     readonly Count: number
 
@@ -20,9 +20,6 @@ declare module 'application:datatable' {
     FindPrevious(What: string): Record | null
   }
 
-  interface Records {
-    (Index: number | string): Record
-  }
   // 导出 Records 类型
   export type { Records }
 }

package/types/application/Sheet.d.ts

@@ -1,5 +1,5 @@
 declare module 'application:datatable' {
-  import type { RecordRange } from 'application:datatable'
+  import type { RecordRange, View, Views, FieldDescriptors } from 'application:datatable'
   // 基础类型定义
   type FieldType =
     | 'SingleLineText'
@@ -25,19 +25,6 @@ declare module 'application:datatable' {
     value: string
   }
 
-  // FieldDescriptors 类型（根据文档引用）
-  interface FieldDescriptors { }
-
-  // Views 类型（根据之前Views文档）
-  interface Views {
-    readonly ActiveView: any
-    readonly Count: number
-    Add(Type: ViewType, Name: string): any
-    Delete(Index: number | string): void
-    Item(Index: number | string): any
-    ItemById(Id: string): any
-    OnCreate(callback: (data: any) => void): EventContext
-  }
 
   // Sheet 接口
   interface Sheet {

package/types/application/Sheets.d.ts

@@ -1,4 +1,5 @@
 declare module 'application:datatable' {
+  import { Patch } from 'application:datatable'
   // 基础类型定义
   type SheetType = 'xlEtFlexPaperSheet' | 'xlEtDataBaseSheet' | 'xlDbDashBoardSheet'
 
@@ -59,7 +60,7 @@ declare module 'application:datatable' {
   }
 
   // Sheets 接口
-  interface Sheets {
+  interface Sheets extends Patch.Sheets {
     // 属性
     readonly Count: number
 

package/types/application/View.d.ts

@@ -1,5 +1,5 @@
 declare module 'application:datatable' {
-  import type { RecordRange, Records } from 'application:datatable'
+  import type { RecordRange, Records, Patch } from 'application:datatable'
   // 基础类型定义
   type ViewType = 'Grid' | 'Kanban' | 'Gallery' | 'Form' | 'Query' | 'Gantt' | 'Calendar'
 
@@ -19,7 +19,7 @@ declare module 'application:datatable' {
   }
 
   // View 接口
-  interface View {
+  interface View extends Patch.View2 {
     // 属性
     Description: string
     readonly Fields: any
@@ -47,5 +47,5 @@ declare module 'application:datatable' {
   }
 
   // 导出 View 类型
-  export type { View }
+  export type { View, ViewType }
 }

package/types/application/Views.d.ts

@@ -1,6 +1,5 @@
 declare module 'application:datatable' {
-  // 基础类型定义
-  type ViewType = 'Grid' | 'Kanban' | 'Gallery' | 'Form' | 'Query' | 'Gantt'
+  import { View, Patch, ViewType } from 'application:datatable'
 
   interface EventContext {
     Destroy(): void
@@ -16,7 +15,7 @@ declare module 'application:datatable' {
   }
 
   // Views 接口
-  interface Views {
+  interface Views extends Patch.Views {
     // 属性
     readonly ActiveView: View
     readonly Count: number

package/types/application/Window.d.ts

@@ -1,13 +1,14 @@
 declare module 'application:datatable' {
+  import { GanttViewUI } from 'application:datatable'
   // 基础类型定义
   interface HookParams {
-    recordId: string;
-    activeFieldId?: string;
-    isShowComment?: boolean;
+    recordId: string
+    activeFieldId?: string
+    isShowComment?: boolean
   }
 
   interface Hook {
-    InvokeSingle(callback: (params: HookParams) => boolean): void;
+    InvokeSingle(callback: (params: HookParams) => boolean): void
   }
 
   // Navigator 类型（根据文档引用）
@@ -25,11 +26,6 @@ declare module 'application:datatable' {
     // FormViewUI属性
   }
 
-  // GanttViewUI 类型（根据文档引用）
-  interface GanttViewUI {
-    // GanttViewUI属性
-  }
-
   // GridViewUI 类型（根据文档引用）
   interface GridViewUI {
     // GridViewUI属性
@@ -38,20 +34,20 @@ declare module 'application:datatable' {
   // Window 接口
   interface Window {
     // 属性
-    readonly Navigator: Navigator;
-    readonly NoticeBar: NoticeBar;
-    readonly FormViewUI: FormViewUI;
-    readonly GanttViewUI: GanttViewUI;
-    readonly GridViewUI: GridViewUI;
+    readonly Navigator: Navigator
+    readonly NoticeBar: NoticeBar
+    readonly FormViewUI: FormViewUI
+    readonly GanttViewUI: GanttViewUI
+    readonly GridViewUI: GridViewUI
 
     // 方法
-    SetLayout(isClassic: boolean): void;
-    BailHook(CmbId: string): Hook;
-    DisplayRecord(RecodId?: string): void;
-    HiddenAllRecord(): void;
-    InterceptCopyRecordLink?(): void; // 文档中有列出但无详细说明
+    SetLayout(isClassic: boolean): void
+    BailHook(CmbId: string): Hook
+    DisplayRecord(RecodId?: string): void
+    HiddenAllRecord(): void
+    InterceptCopyRecordLink?(): void // 文档中有列出但无详细说明
   }
 
   // 导出 Window 类型
-  export type { Window };
+  export type { Window }
 }

package/types/application/patch.d.ts

@@ -0,0 +1,54 @@
+declare module 'application:datatable' {
+  import { Sheet, Record, RecordRange, View } from 'application:datatable'
+  namespace Patch {
+
+    interface Sheets {
+      (Index: number | string): Sheet
+    }
+
+    interface Views {
+      (Index: number | string): View
+    }
+
+    interface View2 {
+      /**行高 grid特有 */
+      RowHeight: 'Short' | 'Medium' | 'Tall' | 'ExtraTall'
+      /**冻结的行数 grid特有 */
+      FrozenCols: number
+      /**开始日期字段ID Gantt Calendar特有 */
+      BeginField: string
+      /**结束日期字段ID Gantt Calendar特有 */
+      EndField: string
+      /**结束日期字段ID Gantt Calendar特有 */
+      TimelineColor: string
+      /**工作时间统计忽略节假日 Gantt特有 */
+      IsOnlyWorkDay: boolean
+      /**查询字段配置 Query特有 */
+      QueryFields: {
+        conditionCanBlank: boolean, // 是否必填
+        customPrompt: string, // 自定义提示语
+        enableScanCodeToInput: boolean,  // 是否允许扫码输入
+        fieldId: string,  // 字段ID
+        needSecondCheck: boolean,  // 电话字段时是否校验号码
+        op: "Equals" | "Contains" | "Specified Value"  // 匹配方式,参看下面Description
+      }[]
+      /**背景图片URL Query特有 */
+      BackgroundImage: string
+      /**标题字段ID Calendar特有 */
+      TitleField: string
+
+      OnCreate(callback: (data: any) => void): { Destroy(): void }
+
+    }
+
+    interface Records {
+      (Index: number | string): Record
+    }
+
+    interface RecordRange2 {
+      (Index?: number | string | any[], Field?: number | string | any[]): RecordRange
+    }
+  }
+
+  export { Patch }
+}