tadcode-wpsjs 0.1.3 → 0.3.2

package/types/DB_Application_Field.d.ts

@@ -0,0 +1,212 @@
+import type { DistributiveOmit, DeepPartial } from './type-tools'
+import type { Operator, } from './DB_Application_Record'
+
+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[]
+}
+
+export type { RatingRange, CompleteRange, FieldTypeKeys, Field, FieldFuncOptions }
+
+/* 字段 */
+export default interface DBField {
+  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 })[]
+}

package/types/DB_Application_Record.d.ts

@@ -0,0 +1,178 @@
+import { RatingRange, CompleteRange } from './DB_Application_Field'
+import type { MakePropertyOptional, PickModify } from './type-tools'
+
+/* 复杂字段 超链接 联系人 附件 关联 */
+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
+}
+
+export type { Operator, DynamicDateRange, RecordItem, RecordFuncOptions, RecordsFuncOptionsFilter }
+
+/* 行记录 */
+export default interface DBRecord {
+  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 })[]
+}

package/types/DB_Application_Selection.ts

@@ -0,0 +1,22 @@
+import type { RecordItem } from './DB_Application_Record'
+
+interface ActiveView {
+  "sheetId": number
+  "viewId": string
+  "name": string
+  "type": string
+}
+
+interface ActiveSheet {
+  "sheetId": number
+  "name": string
+  "description": string
+}
+
+export type { ActiveView, ActiveSheet }
+
+export default interface DBSelection {
+  GetActiveView(): ActiveView
+  GetSelectionRecords(): RecordItem[]
+  GetActiveSheet(): ActiveSheet
+}

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[]
+  }): FilesInfo
 }

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
 }