tadcode-wpsjs 1.1.0 → 1.2.1

package/types/TypeTools.d.ts

@@ -0,0 +1,53 @@
+declare module 'tadcode-wpsjs:typetools' {
+  /**根据给的对象，添加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> }
+
+  /**部分可选 */
+  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
+  }
+
+  /**
+   * 深度可选工具类型
+   */
+  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
+
+  /**根据给的对象，添加promise方法 */
+  type WithPromise<T> =
+    T extends (...args: infer A) => infer R ?
+    ((...args: A) => WithPromise<R>) & Promise<T> & { [K in keyof T]: WithPromise<T[K]> } :
+    T extends Array<infer U> ?
+    Array<WithPromise<U>> & Promise<T> :
+    T extends object ?
+    { [K in keyof T]: WithPromise<T[K]> } & Promise<T> :
+    T extends boolean ?
+    Promise<boolean> :
+    T extends number ?
+    Promise<number> :
+    T extends string ?
+    Promise<string> :
+    Promise<T>
+
+  // 搞定！🎉
+  export type {
+    WithExecution,
+    MakePropertyOptional,
+    PickModify,
+    DeepPartial,
+    DistributiveOmit,
+    WithPromise,
+  }
+}

package/types/application/CriteriaValue.d.ts

@@ -0,0 +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 };
+}

package/types/application/Field.d.ts

@@ -0,0 +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 };
+}

package/types/application/FieldApi.d.ts

@@ -0,0 +1,212 @@
+declare module 'application:datatable' {
+  import type { DistributiveOmit, DeepPartial } from 'tadcode-wpsjs:typetools'
+
+  interface FieldBase {
+    id: string
+    name: string
+  }
+
+  type DatePart =
+    | 'MM/dd'
+    | 'yyyy/MM/dd'
+    | 'yyyy-MM-dd'
+    | 'yyyy\"年\"M\"月\"d\"日\"'
+    | 'yyyy\"年\"m\"月\"'
+
+  type DateFormat =
+    | `${DatePart};@`
+    | `${DatePart} aaaa;@`
+    | `${DatePart} aaaa hh:mm;@`
+
+  type TimePart =
+    | 'h:mm'
+    | 'h:mm:ss'
+
+  type TimeFormat =
+    | `[$-409]${TimePart};@`
+    | `[$-409]${TimePart} AM/PM;@`
+
+  type ZeroFormat =
+    | `${number}_ `
+    | `#,##${number}_ `
+
+  type CurrencyFormat =
+    | `￥#,##0;￥-#,##0`
+    | `￥#,##0.0;￥-#,##0.0`
+    | `￥#,##0.00;￥-#,##0.00`
+    | `$#,##0;$-#,##0`
+    | `$#,##0.0;$-#,##0.0`
+    | `$#,##0.00;$-#,##0.00`
+    | `\"€\"#,##0;\"€\"-#,##0`
+    | `\"€\"#,##0.0;\"€\"-#,##0.0`
+    | `\"€\"#,##0.00;\"€\"-#,##0.00`
+
+  type RatingRange = 0 | 1 | 2 | 3 | 4 | 5
+
+  type CompleteRange = `0.${number}`
+
+  type SelectItem = { id: string, value: string }
+
+  type OmitFieldSelectId<T> = T extends { type: 'SingleSelect' | 'MultipleSelect', items: [SelectItem, ...SelectItem[]] } ? Omit<T, 'items'> & { items: [Omit<SelectItem, 'id'>, ...Omit<SelectItem, 'id'>[]] } : T
+
+  interface FieldTypeFormat {
+    MultiLineText: {
+      uniqueValue?: boolean
+      defaultValue?: string
+    }
+    Date: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: DateFormat
+      defaultValueType?: 'Normal' | 'RecordCreateTime'
+    }
+    Time: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: TimeFormat
+    }
+    Number: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: ZeroFormat
+    }
+    Currency: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: CurrencyFormat
+    }
+    Percentage: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: `${number}%`
+    }
+    ID: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: string
+    }
+    Phone: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: string
+    }
+    Email: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: string
+    }
+    Url: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: string
+      displayText?: string
+    }
+    Checkbox: {
+      uniqueValue?: boolean
+      defaultValue?: '1'
+      numberFormat?: string
+    }
+    SingleSelect: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: string
+      autoAddItem?: boolean
+      items: [SelectItem, ...SelectItem[]]
+    }
+    MultipleSelect: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: string
+      autoAddItem?: boolean
+      items: [SelectItem, ...SelectItem[]]
+    }
+    Rating: {
+      uniqueValue?: boolean
+      defaultValue?: string
+      numberFormat?: string
+      max: RatingRange
+    }
+    Complete: {
+      uniqueValue?: boolean
+      defaultValue?: `0.${number}`
+      numberFormat?: `${number}%`
+    }
+    Contact: {
+      uniqueValue?: boolean
+      defaultValue?: {
+        avatar: string
+        companyId: string
+        nickName: string
+      }[]
+      defaultValueType?: 'Normal' | 'RecordCreator'
+      numberFormat?: string
+      multipleContacts: boolean
+      noticeNewContact: boolean
+    }
+    Attachment: {
+      uniqueValue?: boolean
+      onlyUploadByCamera?: boolean
+      displayStyle?: 'Pic' | 'List'
+    }
+    /* 可关联的记录范围不支持设置 */
+    Link: {
+      uniqueValue?: boolean
+      linkSheet: number
+      multipleLinks: boolean
+    }
+    Note: {}
+    AutoNumber: {
+      uniqueValue?: boolean
+      numberFormat?: '000000' | '00000000',
+    }
+    CreatedBy: {
+      uniqueValue?: boolean
+    }
+    CreatedTime: {
+      uniqueValue?: boolean
+    }
+    Formula: {}
+    Lookup: {
+      lookupSheetId?: 5,
+      lookupField?: string,
+      lookupFunction?: 'Origin',
+      filter?: {
+        groups: [
+          {
+            conds: {
+              linkSheetFieldId: string
+              /**注意字段类型，文本 数字 日期 所用操作符会不一样 */
+              condOpType: Operator
+              curSheetCondType: 'Field' | 'Literal'
+              curSheetCondContents: string[]
+            }[]
+          }
+        ]
+      }
+    }
+  }
+
+  type FieldTypeKeys = keyof FieldTypeFormat
+
+  type ResultField<T> = { type: T } & FieldTypeFormat[T] & FieldBase
+
+  // 使用映射类型生成联合类型
+  type Field = {
+    [K in FieldTypeKeys]: ResultField<K>
+  }[FieldTypeKeys]
+
+  interface FieldFuncOptions {
+    SheetId: number
+    Fields: Field[]
+    FieldIds: string[]
+  }
+
+  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 }
+}

package/types/application/Fields.d.ts

@@ -0,0 +1,20 @@
+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 };
+}

package/types/application/Record.d.ts

@@ -0,0 +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 };
+}

package/types/application/RecordApi.d.ts

@@ -0,0 +1,178 @@
+declare module 'application:datatable' {
+  import type { DistributiveOmit, DeepPartial } from 'tadcode-wpsjs:typetools'
+
+  /* 复杂字段 超链接 联系人 附件 关联 */
+  interface RecordValueFormat {
+    MultiLineText: string
+    Date: `${number}/${number}` | `${number}/${number}/${number}`
+    Time: `${number}:${number}` | `${number}:${number}:${number}`
+    Number: number
+    Currency: number
+    Percentage: number
+    ID: string
+    Phone: string
+    Email: string
+    Url: string | { address: string, displayText: string }
+    Checkbox: boolean
+    SingleSelect: string
+    MultipleSelect: string[]
+    Rating: RatingRange
+    Complete: number
+    Contact: {
+      id: string,
+      nickName?: string,
+      avatar?: string
+    }[]
+    Attachment: {
+      uploadId: string,
+      fileName: string,
+      source: 'upload_ks3' | 'cloud',
+      type: string,
+      linkUrl?: string
+      size: number,
+      imgSize: string,
+    }[]
+    Link: string[] | { recordIds: string[] }
+    Note: never
+    AutoNumber: never
+    CreatedBy: never
+    CreatedTime: never
+    Formula: never
+    Lookup: never
+    SingleSelect: never
+    MultipleSelect: never
+  }
+
+  interface RecordItem {
+    id: string,
+    fields: Record<string, RecordValueFormat[keyof RecordValueFormat]> & Partial<RecordValueFormat>
+  }
+
+  type Operator = 'Equals' | 'NotEqu' | 'Greater' | 'GreaterEqu' | 'Less' | 'LessEqu' | 'GreaterEquAndLessEqu' | 'LessOrGreater' | 'BeginWith' | 'EndWith' | 'Contains' | 'NotContains' | 'Intersected' | 'Empty' | 'NotEmpty'
+
+  type DynamicDateRange = 'today' | 'yesterday' | 'tomorrow' | 'last7Days' | 'last30Days' | 'thisWeek' | 'lastWeek' | 'nextWeek' | 'thisMonth' | 'lastMonth' | 'nextMonth'
+
+  interface RecordsFuncOptionsFilter {
+    /**选填。表示各筛选条件之间的逻辑关系。只能是'AND'或'OR'。缺省值为'AND' */
+    mode?: 'AND' | 'OR',
+    /**filter结构体内必填。包含筛选条件的数组。每个字段上只能有一个筛选条件 */
+    criteria: {
+      /**必填。根据 preferId 与否，需要填入字段名或字段id */
+      field: string
+      /**"Equals": 等于
+
+      "NotEqu": 不等于
+
+      "Greater": 大于
+
+      "GreaterEqu": 大等于
+
+      "Less": 小于
+
+      "LessEqu": 小等于
+
+      "GreaterEquAndLessEqu": 介于（取等）
+
+      "LessOrGreater": 介于（不取等）
+
+      "BeginWith": 开头是
+
+      "EndWith": 结尾是
+
+      "Contains": 包含
+
+      "NotContains": 不包含
+
+      "Intersected": 指定值
+
+      "Empty": 为空
+
+      "NotEmpty": 不为空
+      */
+      op: Operator
+      /**
+       * 必填。表示筛选规则中的值。数组形式。值为字符串时表示文本匹配。
+       * 这里的 values，必须是一个数组，传 ["多维表"]，相当于传 [{ type: 'Text', value: '多维表' }]，即不传默认帮你补充 Text 类型。
+       * 复选框的值，values: ['0'] 代表否，value: ['1'] 代表是。
+       *
+       * values[]数组内的元素为字符串时，表示文本匹配。各筛选规则独立地限制了values数组内最多允许填写的元素数，当values内元素数超过阈值时，该筛选规则将失效。
+       *
+       * a. “为空、不为空”不允许填写元素；
+       *
+       * b. “介于”允许最多填写2个元素；
+       *
+       * c. “指定值”允许填写65535个元素；
+       *
+       * d. 其他规则允许最多填写1个元素
+       */
+      values: string[] | {
+        type: 'Text'
+        value: string
+      }[] |
+      {
+        type: 'DynamicSimple'
+        /**
+         * 当"op"为"greater"或"less"时，"dynamicType"只能是昨天、今天或明天。
+         *
+         * "today": 今天
+         *
+         * "yesterday": 昨天
+         *
+         * "tomorrow": 明天
+         *
+         * "last7Days": 最近7天
+         *
+         * "last30Days": 最近30天
+         *
+         * "thisWeek": 本周
+         *
+         * "lastWeek": 上周
+         *
+         * "nextWeek"：下周
+         *
+         * "thisMonth": 本月
+         *
+         * "lastMonth": 上月
+         *
+         * "nextMonth": 次月
+         */
+        dynamicType: DynamicDateRange
+      }[]
+    }[]
+  }
+
+  interface RecordFuncOptions {
+    SheetId: number
+    RecordId: string
+    RecordIds: string[]
+    Records: RecordItem[]
+    /**
+     * 填写后将从被指定的视图获取该用户所见到的记录；若不填写，则从工作表获取记录
+     */
+    ViewId: string
+    /**
+     * 存在分页时，指定本次查询的起始记录（含）。若不填写或填写为空字符串，则从第一条记录开始获取
+     *
+     * 当前最大值：1000
+     */
+    PageSize: number
+    /**分页查询时，将返回一个offset值，指向下一页的第一条记录，供后续查询。查询到最后一页或第maxRecords条记录时，返回数据将不再包含offset值 */
+    Offset: number
+    /**指定要获取的“前maxRecords条记录”，若不填写，则默认返回全部记录 */
+    MaxRecords: number
+    /**具体字段类型说明详见 [附件2](https://kdocs.cn/l/ctzsgDlAGF0l?linkname=QSt7dOHYA0) */
+    Fields: string[]
+    /**详细说明见 [附件4](https://www.kdocs.cn/l/ctzsgDlAGF0l?linkname=wsTfzS9o34) */
+    Filter: RecordsFuncOptionsFilter
+  }
+  /* 行记录 */
+  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[] }
+    UpdateRecords(options: Pick<RecordFuncOptions, 'SheetId' | 'Records'>): RecordItem[]
+    DeleteRecords(options: Pick<RecordFuncOptions, 'SheetId' | 'RecordIds'>): (Pick<RecordItem, 'id'> & { deleted: boolean })[]
+  }
+
+  export type { RecordApi }
+}

package/types/application/RecordRange.d.ts

@@ -0,0 +1,77 @@
+declare module 'application:datatable' {
+  import type { Criteria } from 'application:datatable'
+  // 基础类型定义
+  type FilterOp = 'And' | 'Or'
+
+  type CriteriaOperator =
+    | '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'
+
+  interface EventContext {
+    Destroy(): void
+  }
+
+  interface ApiResult {
+    code: number
+    Message?: string
+  }
+
+  interface Font {
+    Color: string
+  }
+
+  interface Interior {
+    Color: string
+  }
+
+  interface DBCellValue {
+    // DBCellValue类型
+  }
+
+  interface Filter {
+    Criterias: Criteria[]
+    Op?: FilterOp
+  }
+
+  interface OnDeleteRecordEventData {
+    sheetId: number
+    recordIds: string[]
+  }
+
+  // RecordRange 接口
+  interface RecordRange {
+    // 属性
+    readonly Count: number
+    FieldId: any[] // 返回Array
+    readonly Font: Font
+    Id: any[] // 返回Array
+    Index: any[] // 返回Array
+    readonly Interior: Interior
+    readonly Text: string | any[][]
+    Value: any
+
+    // 方法
+    Item(Index?: number | string | any[], Field?: number | string | any[]): RecordRange
+    Add(Before?: number | string, After?: number | string, Count?: number): RecordRange
+    Condition(Filters: Filter[], FilterOp?: FilterOp): RecordRange
+    Delete(): ApiResult
+    Select(): boolean
+    SetValues(Values: any[], ignoreErr?: boolean): ApiResult
+
+    // 事件
+    OnDeleteRecord(callback: (data: OnDeleteRecordEventData) => void): EventContext
+    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

@@ -0,0 +1,28 @@
+declare module 'application:datatable' {
+  import type { Record } from 'application:datatable'
+  // 基础类型定义
+  type ViewType = 'Grid' | 'Kanban' | 'Gallery' | 'Form' | 'Query' | 'Gantt'
+
+  interface EventContext {
+    Destroy(): void
+  }
+
+  // Records 接口
+  interface Records {
+    // 属性
+    readonly Count: number
+
+    // 方法
+    Item(Index: number | string): Record
+    Add(Before?: number | string, After?: number | string, Count?: number): Records
+    Delete(Index: number | string): any // ApiResult
+    FindNext(What: string): Record | null
+    FindPrevious(What: string): Record | null
+  }
+
+  interface Records {
+    (Index: number | string): Record
+  }
+  // 导出 Records 类型
+  export type { Records }
+}

package/types/application/SelectionApi.d.ts

@@ -0,0 +1,29 @@
+declare module 'application:datatable' {
+  interface ActiveViewInfo {
+    "sheetId": number
+    "viewId": string
+    "name": string
+    "type": string
+  }
+
+  interface ActiveSheetInfo {
+    "sheetId": number
+    "name": string
+    "description": string
+  }
+
+  interface Field {
+    "type": FieldTypeKeys
+    "name": string
+    "id": string
+    "value": any
+  }
+
+  interface SelectionApi {
+    GetActiveView(): ActiveViewInfo
+    GetSelectionRecords(): { id: string, fields: Field[] }[][]
+    GetActiveSheet(): ActiveSheetInfo
+  }
+
+  export type { SelectionApi }
+}