@cloudbase/cals 0.5.13-alpha.0 → 0.5.13-alpha.1

package/lib/utils/dts/auto-generated.js

@@ -21,21 +21,28 @@ exports.wedaDTS = `declare class UserWidget {
   // ========== 快捷访问方式 ========== //
 
   /**
-   * 组件 id
+   * 组件 ID，微搭中一般由编辑器生成
    */
   readonly id: string;
   /**
-   * 组件库名称
+   * 组件库名
    */
   readonly module: string;
   /**
-   * 组件名称
+   * 组件名
    */
   readonly component: string;
-  // FIXME: 暂时不对外暴露
-  // readonly parent: UserWidget;
-  // readonly children: UserWidget[];
 
+  /**
+   * 父组件引用
+   */
+  readonly parent: UserWidget;
+  /**
+   * 子组件集合
+   */
+  readonly children: UserWidget[];
+
+  // FIXME: 暂时不对外暴露
   // closest(filter?: (parentWidget: UserWidget) => boolean): UserWidget | null;
 }
 
@@ -43,8 +50,19 @@ exports.wedaDTS = `declare class UserWidget {
 // Used Components - Don't touch me
 // Used Components Inner End
 
+// Redefine Any Type Inner Begin
+// Redefine Any Type - Don't touch me
+// Redefine Any Type Inner End
+
 declare namespace $app {
-  namespace dataset {
+  /**
+ * 全局数据对象
+ */
+namespace dataset {
+
+  /**
+   * 全局变量对象
+   */
   const state: {
     // Global State Inner Begin
     // Global State 全局变量 - Don't touch me
@@ -52,12 +70,18 @@ declare namespace $app {
   };
 }
 
+/**
+ * 全局 common 方法
+ */
 namespace common {
   // Global Common Inner Begin
   // Global Common 全局方法 - Don't touch me
   // Global Common Inner End
 }
 
+/**
+ * 设置页面变量
+ */
 function setState(data: Object): void;
 
 }
@@ -65,73 +89,267 @@ function setState(data: Object): void;
 declare const app = $app;
 
 declare namespace $w {
+
+  /**
+   * 当前应用实例
+   */
   const app = $app;
 
+  /**
+   * 当前页面实例
+   */
   const page = $page;
 
+  /**
+   * 用户权限相关方法和属性
+   */
   namespace auth {
-    interface CurrentUserInfo {
+    
+interface CurrentUserInfo {
+  /**
+   * 用户 ID
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "string", "displayName": "用户 ID"}
+   */
   userId?: string;
+  /**
+   * 手机
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "string", "displayName": "手机"}
+   */
   phone?: string;
+  /**
+   * 用户类型
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "number", "displayName": "用户类型"}
+   */
   type?: number;
+  /**
+   * 用户关联角色
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "array", "displayName": "用户关联角色"}
+   */
   relatedRoles?: {
+    /**
+     * 角色 ID
+     *
+     * @privateForWeDa
+     * {"group": "globalVar", "displayType": "string", "displayName": "角色 ID"}
+     */
     id?: string;
+    /**
+     * 环境 ID
+     *
+     * @privateForWeDa
+     * {"group": "globalVar", "displayType": "string", "displayName": "环境 ID"}
+     */
     envId?: string;
+    /**
+     * 角色名称
+     *
+     * @privateForWeDa
+     * {"group": "globalVar", "displayType": "string", "displayName": "角色名称"}
+     */
     name?: string;
+    /**
+     * 角色标识
+     *
+     * @privateForWeDa
+     * {"group": "globalVar", "displayType": "string", "displayName": "角色标识"}
+     */
     roleIdentity?: string;
   }[];
+  /**
+   * 微信/企微 openId
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "string", "displayName": "微信/企微 openId"}
+   */
   openId?: string;
+  /**
+   * 用户名称
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "string", "displayName": "用户名称"}
+   */
   name?: string;
+  /**
+   * 用户昵称
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "string", "displayName": "用户昵称"}
+   */
   nickName?: string;
+  /**
+   * 邮箱
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "string", "displayName": "邮箱"}
+   */
   email?: string;
+  /**
+   * 主岗部门
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "object", "displayName": "主岗部门"}
+   */
   mainOrg?: {
+    /**
+     * 主岗部门 ID
+     *
+     * @privateForWeDa
+     * {"group": "globalVar", "displayType": "string", "displayName": "主岗部门 ID"}
+     */
     id?: string;
+    /**
+     * 主岗部门名称
+     *
+     * @privateForWeDa
+     * {"group": "globalVar", "displayType": "string", "displayName": "主岗部门名称"}
+     */
     name?: string;
   };
+  /**
+   * 兼岗部门
+   *
+   * @privateForWeDa
+   * {"group": "globalVar", "displayType": "object", "displayName": "兼岗部门"}
+   */
   orgs?: {
+    /**
+     * 兼岗部门 ID
+     *
+     * @privateForWeDa
+     * {"group": "globalVar", "displayType": "string", "displayName": "兼岗部门 ID"}
+     */
     id?: string;
+    /**
+     * 兼岗部门名称
+     *
+     * @privateForWeDa
+     * {"group": "globalVar", "displayType": "string", "displayName": "兼岗部门名称"}
+     */
     name?: string;
   }[];
 }
+
+/**
+ * 获取用户信息
+ */
 function getUserInfo(): CurrentUserInfo;
+
+/**
+ *
+ * 登录用户信息
+ *
+ * @privateForWeDa
+ * {"group": "globalVar", "displayType": "object", "displayName": "登录用户信息"}
+ */
 const currentUser: CurrentUserInfo;
 
   }
 
+  /**
+   * 数据源等云端能力集合
+   */
   namespace cloud {
     interface ICallDataSourceParams {
+  /**
+   * 数据源标志
+   */
   dataSourceName: string;
+  /**
+   * 数据源方法名
+   */
   methodName: string;
+  /**
+   * 方法参数，根据方法实际入参填写
+   */
   params: Object;
 }
 interface ICallFunctionParams {
+  /**
+   * TCB云函数名称
+   */
   name: string;
+  /**
+   * 云函数接收的参数，根据自己创建的云函数入参而定
+   */
   data?: any;
 }
 interface IParseOptions {
+  /**
+   * 解析 云开发云函数的通用response 包装。为true, 则返回 res.result, 此时会丢失 res.requestId 信息
+   */
   unwrapResult?: boolean;
+  /**
+   * 解析业务信息，需配合 unwrapResult 使用。为 true 时, res.result.code 非 0 抛出错误, 为 0 则返回 res.result.data
+   */
   parseBusinessInfo?: boolean;
 }
 interface ICallWorkflowParams {
+  /**
+   * 方法名称
+   */
   action: string;
+  /**
+   * 方法的自定义参数，其中 envType, envId, uid, source 均无需填写
+   */
   data?: Record<string, any>;
+  /**
+   * 是否自动将 data 的key 改为大写驼峰。默认为 true, 即使用时 data 可以采用小驼峰的 key
+   */
   capitalizeDataKey?: boolean;
 }
 
+/**
+ * 调用数据源
+ */
 function callDataSource(params: ICallDataSourceParams): any;
+
+/**
+ * 通过 cloudid 获取静态文件的 http 访问地址
+ */
 function getTempFileURL(params: string | string[]): Promise<string | string[]>;
+
+/**
+ * 调用流程
+ */
 function callWorkflow(action: ICallWorkflowParams): Promise<any>;
+
+/**
+ * 调用云开发的云函数, 与 $w.cloud.getCloudInstance 示例中的效果大体一致
+ */
 function callFunction(params: ICallFunctionParams, parseOptions?: IParseOptions): Promise<any>;
+
+/**
+ * 返回云开发web-sdk初始化后的实例(无需关心tcb环境信息及认证登录的处理), 即 tcb.init 后返回的对象, 可用该对象直接调用tcb的各种能力
+ */
 function getCloudInstance(): Promise<CloudInstance>;
 
   }
 
-  // $w.utils
+  /**
+   * 平台工具方法集合
+   */
   namespace utils {
     interface navigatorOptions {
+  /**
+   * 子应用包地址，例如 packages/subapp
+   */
   packageName: string;
+  /**
+   * 页面 ID
+   */
   pageId: string;
   data?: Record<string, any>;
+  /**
+   * query object 对象
+   */
   params?: Record<string, any>;
   events?: Record<string, (data: any) => void>;
   success(res: any);
@@ -140,43 +358,87 @@ function getCloudInstance(): Promise<CloudInstance>;
 }
 
 interface navigateBackOptions {
+  /**
+   * 返回的页面数，如果 delta 大于现有页面数，则返回到首页。
+   */
   delta: number;
 }
 
-// 显示提示
+/**
+ * 显示提示框
+ */
 function showToast(options);
 
-// 显示 loading 提示
+/**
+ * 显示全局加载中提示
+ */
 function showLoading(options);
 
-// 隐藏 loading 提示
+/**
+ * 隐藏全局加载中提示
+ */
 function hideLoading(options);
 
-// 显示模态提示
+/**
+ * 显示模态弹框
+ */
 function showModal(options);
 
-// 拨打电话
+/**
+ * 拨打电话
+ */
 function callPhone(options);
 
-// sacnCode
+/**
+ * 扫描二维码
+ */
 function scanCode(options: {
+  /**
+   * 是否只能从相机扫码，不允许从相册选择图片
+   */
   onlyFromCamera?: boolean;
   enableDefaultBehavior?: boolean;
+  /**
+   * 扫码类型
+   */
   scanType?: ('barCode' | 'qrCode')[];
+  /**
+   * 接口调用成功的回调函数
+   */
   success?: (res: { result: string; scanType: string }) => void;
+  /**
+   * 接口调用失败的回调函数
+   */
   fail?: (err: Error) => void;
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
   complete?: () => void;
 }): Promise<ScanCodeResult> | ScanCodeResult;
 
-// 特制路由
+/**
+ * 跳转到应用某个页面
+ */
 function navigateTo(options: navigatorOptions);
 
+/**
+ * 关闭当前页面，跳转到应用内的某个页面
+ */
 function redirectTo(options: navigatorOptions);
 
+/**
+ * 关闭所有页面，打开到应用内的某个页面
+ */
 function reLaunch(options: navigatorOptions);
 
+/**
+ * 返回首页
+ */
 function relaunchHome();
 
+/**
+ * 关闭当前页面，返回上一页面或多级页面
+ */
 function navigateBack(options: navigateBackOptions);
 
   }
@@ -186,6 +448,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 计算传入数字的绝对值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "绝对值"}
 */
  function ABS(num: number): number;
 /**
@@ -193,6 +458,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 返回一组数字中的最小值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "最小值"}
 */
  function Min(...args: number[]): number;
 /**
@@ -200,6 +468,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 返回一组数字中的最大值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "最大值"}
 */
  function Max(...args: number[]): number;
 /**
@@ -207,6 +478,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 返回一组数字中的平均值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "平均值"}
 */
  function Average(...args: number[]): number;
 /**
@@ -214,6 +488,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 返回传入数字向下取整的结果
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "向下取整"}
 */
  function Floor(num: number): number;
 /**
@@ -221,6 +498,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 返回传入数字向上取整的结果
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "向上取整"}
 */
  function Ceiling(num: number): number;
 /**
@@ -228,6 +508,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 返回传入数字四舍五入后的结果
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "四舍五入"}
 */
  function Round(num: number): number;
 /**
@@ -235,6 +518,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 返回一组数字中的和
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "求和"}
 */
  function Sum(...args: number[]): number;
 /**
@@ -242,6 +528,9 @@ function navigateBack(options: navigateBackOptions);
 *
 * @remarks
 * 返回一个指定范围的伪随机数，例如 Rand(10)，返回一个范围在 10 以内的随机数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "随机数"}
 */
  function Rand(num: number): number;
 
@@ -255,6 +544,9 @@ alternate?: any;
 *
 * @remarks
 * 按判断条件进行逻辑比较，满足时返回一个值，不满足时返回另一个值。
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "条件分支"}
 */
  function If(data: IIfObjectParam): any;
  function If(condition: boolean, consequent?: any, alternate?: any): any;
@@ -263,6 +555,9 @@ alternate?: any;
 *
 * @remarks
 * 判断传入的文本是否为空
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否为空"}
 */
  function IsEmpty(text: string | string[]): boolean;
 /**
@@ -270,6 +565,9 @@ alternate?: any;
 *
 * @remarks
 * 判断传入的字段值是否包含数据，即不为 NULL
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否为null"}
 */
  function NotNull(val: any): boolean;
 /**
@@ -277,6 +575,9 @@ alternate?: any;
 *
 * @remarks
 * 用于确定所有判断条件是否为真
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "与"}
 */
  function And(...args: boolean[]): boolean;
 /**
@@ -284,6 +585,9 @@ alternate?: any;
 *
 * @remarks
 * 任意一个判断条件为真，则结果为真；所有条件为否，结果才为否
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "或"}
 */
  function Or(...args: boolean[]): boolean;
 
@@ -292,6 +596,9 @@ alternate?: any;
 *
 * @remarks
 * 获取传入文本的字符数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取文本长度"}
 */
  function Len(text: string): number;
 /**
@@ -299,6 +606,9 @@ alternate?: any;
 *
 * @remarks
 * 判断文本 1 是否包含文本 2
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否包含指定文本"}
 */
  function Contains(text1: string, text2: string): boolean;
 /**
@@ -306,6 +616,9 @@ alternate?: any;
 *
 * @remarks
 * 根据传入的文本 2，将文本 1 拆分成文本数组，例如 Split("张三,李四,王五", ",")
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "拆分文本"}
 */
  function Split(text1: string, text2: string): string[];
 /**
@@ -313,6 +626,9 @@ alternate?: any;
 *
 * @remarks
 * 删除文本开头和结尾的所有空格和制表符，文本中间的空格和制表符不会删除
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "删除开头/结尾空格和制表符"}
 */
  function Trim(text: string): string;
 /**
@@ -320,6 +636,9 @@ alternate?: any;
 *
 * @remarks
 * 将传入的文本转为全大写文本
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "转换为大写"}
 */
  function Upper(text: string): string;
 /**
@@ -327,6 +646,9 @@ alternate?: any;
 *
 * @remarks
 * 将传入的文本转为全小写文本
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "转换为小写"}
 */
  function Lower(text: string): string;
 /**
@@ -334,12 +656,18 @@ alternate?: any;
 *
 * @remarks
 * 将数字、时间日期等转换为文本
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "转换为文本"}
 */
 /**
 * 文本拼接
 *
 * @remarks
 * 返回多个文本拼接后的新文本
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "文本拼接"}
 */
  function Concat(...text: string[]): string;
 
@@ -348,6 +676,9 @@ alternate?: any;
 *
 * @remarks
 * 返回当前系统时间，通常与其他日期时间函数搭配使用
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取现在时间"}
 */
  function Now(): number;
 /**
@@ -355,6 +686,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的日期时间返回时间戳
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取时间戳"}
 */
  function Timestamp(arg: number | string | Date): number;
 /**
@@ -362,6 +696,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的秒数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取秒数"}
 */
  function Second(arg: number | string | Date): number;
 /**
@@ -369,6 +706,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的分钟部分
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取分钟数"}
 */
  function Minute(arg: number | string | Date): number;
 /**
@@ -376,6 +716,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的小时部分，24小时制
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取小时数"}
 */
  function Hour(arg: number | string | Date): number;
 /**
@@ -383,6 +726,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的日部分，范围为 1-31
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取天数"}
 */
  function Day(arg: number | string | Date): number;
 /**
@@ -390,6 +736,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的星期数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取星期数"}
 */
  function DayOfWeek(arg: number | string | Date): number;
 /**
@@ -397,6 +746,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的月份
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取月数"}
 */
  function Month(arg: number | string | Date): number;
 /**
@@ -404,6 +756,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的年份
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取年份"}
 */
  function Year(arg: number | string | Date): number;
 /**
@@ -411,6 +766,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的年月日数值返回一个日期类型的数据，例如 GetDate(2017,3,24)
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "使用年月日创建日期时间"}
 */
  function GetDate(year: number, month: number, day: number): number;
 /**
@@ -418,12 +776,18 @@ alternate?: any;
 *
 * @remarks
 * 将日期时间文本根据指定格式转化为日期时间，例如 DateTimeValue("2021-12-11 01:19:12", "yyyy-MM-dd HH:mm:ss")
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "使用时间戳创建日期时间"}
 */
 /**
 * 使用时间日期文本创建日期时间
 *
 * @remarks
 * 将日期时间文本根据指定格式转化为日期时间，例如 DateTimeValue("2021-12-11 01:19:12", "yyyy-MM-dd HH:mm:ss")
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "使用时间日期文本创建日期时间"}
 */
  function DateTimeValue(arg: string, val: string): number;
 /**
@@ -431,6 +795,9 @@ alternate?: any;
 *
 * @remarks
 * 根据输入的两个日期时间计算出年龄，例如 Age(Date(2017,3,24), Date(2021,3,24))
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "计算年龄"}
 */
  function Age(arg: number | string | Date, val: number | string | Date): number;
 /**
@@ -438,6 +805,9 @@ alternate?: any;
 *
 * @remarks
 * 计算当前年龄，例如 AgeOfNow(Date(2017,3,24))
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "计算当前年龄"}
 */
  function AgeOfNow(arg: number | string | Date): number;
 /**
@@ -445,6 +815,9 @@ alternate?: any;
 *
 * @remarks
 * 在传入的日期时间上增加 X 天，支持负数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "增加 X 天"}
 */
  function DateAdd(arg: number | string | Date, day: number): number;
 /**
@@ -452,6 +825,9 @@ alternate?: any;
 *
 * @remarks
 * 在传入的日期和时间上增加 X 月，支持负数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "增加 X 月"}
 */
  function MonthAdd(arg: number | string | Date, month: number): number;
 /**
@@ -459,6 +835,9 @@ alternate?: any;
 *
 * @remarks
 * 在传入的日期和时间上增加 X 年，支持负数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "增加 X 年"}
 */
  function YearAdd(arg: number | string | Date, year: number): number;
 /**
@@ -466,6 +845,9 @@ alternate?: any;
 *
 * @remarks
 * 返回两个日期时间字段之间的天数差，如果为同一天，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "天数差"}
 */
  function DateDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -473,6 +855,9 @@ alternate?: any;
 *
 * @remarks
 * 返回两个日期时间字段之间的小时差，如果为同一小时，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "小时差"}
 */
  function HourDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -480,6 +865,9 @@ alternate?: any;
 *
 * @remarks
 * 返回两个日期时间字段之间的分钟差，如果为同一分钟，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "分钟差"}
 */
  function MinuteDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -487,6 +875,9 @@ alternate?: any;
 *
 * @remarks
 * 返回两个日期时间字段之间的天数差，如果为同一天，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "秒数差"}
 */
  function SecondDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -494,6 +885,9 @@ alternate?: any;
 *
 * @remarks
 * 返回两个日期时间字段之间的月数差，如果为同一月，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "月数差"}
 */
  function MonthDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -501,6 +895,9 @@ alternate?: any;
 *
 * @remarks
 * 返回两个日期时间字段之间的年数差，如果为同一年，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "年数差"}
 */
  function YearDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -508,6 +905,9 @@ alternate?: any;
 *
 * @remarks
 * 格式化日期时间为指定格式的文本，例如 DateText(Date(2017,3,24), "yyyy-MM-dd HH:mm:ss")
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "日期时间格式化"}
 */
  function DateText(createdTime: number | string | Date, text: string): string;
 /**
@@ -515,6 +915,9 @@ alternate?: any;
 *
 * @remarks
 * 判断传入的日期时间是否为今天，例如 IsToday(Date(2022,4,8))
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否为今天"}
 */
  function IsToday(date: number | string | Date): boolean;
 
@@ -539,26 +942,45 @@ declare const forItems = $for
 
 // $page Begin
 declare namespace $page {
-  const id: string;
+  /**
+ * 当前页面的 id
+ */
+const id: string;
 
+/**
+ * 页面数据对象
+ */
 namespace dataset {
+  /**
+   * 页面变量
+   */
   const state: {
     // Page State Inner Begin
     // Page State 页面变量 - Don't touch me
     // Page State Inner End
   };
+  /**
+   * 页面参数
+   */
   const params: {
     // Page Param Inner Begin
     // Page Param 页面参数 - Don't touch me
     // Page Param Inner End
   };
 }
+
+/**
+ * 页面定义 handler 方法
+ */
 namespace handler {
   // Page Handler Inner Begin
   // Page Handler 页面方法 - Don't touch me
   // Page Handler Inner End
 }
 
+/**
+ * 设置页面变量
+ */
 function setState(userSetState: Record<string, any>): void;
 
 }
@@ -609,6 +1031,9 @@ declare namespace $comp {
 *
 * @remarks
 * 计算传入数字的绝对值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "绝对值"}
 */
 declare function ABS(num: number): number;
 /**
@@ -616,6 +1041,9 @@ declare function ABS(num: number): number;
 *
 * @remarks
 * 返回一组数字中的最小值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "最小值"}
 */
 declare function Min(...args: number[]): number;
 /**
@@ -623,6 +1051,9 @@ declare function Min(...args: number[]): number;
 *
 * @remarks
 * 返回一组数字中的最大值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "最大值"}
 */
 declare function Max(...args: number[]): number;
 /**
@@ -630,6 +1061,9 @@ declare function Max(...args: number[]): number;
 *
 * @remarks
 * 返回一组数字中的平均值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "平均值"}
 */
 declare function Average(...args: number[]): number;
 /**
@@ -637,6 +1071,9 @@ declare function Average(...args: number[]): number;
 *
 * @remarks
 * 返回传入数字向下取整的结果
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "向下取整"}
 */
 declare function Floor(num: number): number;
 /**
@@ -644,6 +1081,9 @@ declare function Floor(num: number): number;
 *
 * @remarks
 * 返回传入数字向上取整的结果
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "向上取整"}
 */
 declare function Ceiling(num: number): number;
 /**
@@ -651,6 +1091,9 @@ declare function Ceiling(num: number): number;
 *
 * @remarks
 * 返回传入数字四舍五入后的结果
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "四舍五入"}
 */
 declare function Round(num: number): number;
 /**
@@ -658,6 +1101,9 @@ declare function Round(num: number): number;
 *
 * @remarks
 * 返回一组数字中的和
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "求和"}
 */
 declare function Sum(...args: number[]): number;
 /**
@@ -665,6 +1111,9 @@ declare function Sum(...args: number[]): number;
 *
 * @remarks
 * 返回一个指定范围的伪随机数，例如 Rand(10)，返回一个范围在 10 以内的随机数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "随机数"}
 */
 declare function Rand(num: number): number;
 
@@ -678,6 +1127,9 @@ alternate?: any;
 *
 * @remarks
 * 按判断条件进行逻辑比较，满足时返回一个值，不满足时返回另一个值。
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "条件分支"}
 */
 declare function If(data: IIfObjectParam): any;
 declare function If(condition: boolean, consequent?: any, alternate?: any): any;
@@ -686,6 +1138,9 @@ declare function If(condition: boolean, consequent?: any, alternate?: any): any;
 *
 * @remarks
 * 判断传入的文本是否为空
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否为空"}
 */
 declare function IsEmpty(text: string | string[]): boolean;
 /**
@@ -693,6 +1148,9 @@ declare function IsEmpty(text: string | string[]): boolean;
 *
 * @remarks
 * 判断传入的字段值是否包含数据，即不为 NULL
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否为null"}
 */
 declare function NotNull(val: any): boolean;
 /**
@@ -700,6 +1158,9 @@ declare function NotNull(val: any): boolean;
 *
 * @remarks
 * 用于确定所有判断条件是否为真
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "与"}
 */
 declare function And(...args: boolean[]): boolean;
 /**
@@ -707,6 +1168,9 @@ declare function And(...args: boolean[]): boolean;
 *
 * @remarks
 * 任意一个判断条件为真，则结果为真；所有条件为否，结果才为否
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "或"}
 */
 declare function Or(...args: boolean[]): boolean;
 
@@ -715,6 +1179,9 @@ declare function Or(...args: boolean[]): boolean;
 *
 * @remarks
 * 获取传入文本的字符数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取文本长度"}
 */
 declare function Len(text: string): number;
 /**
@@ -722,6 +1189,9 @@ declare function Len(text: string): number;
 *
 * @remarks
 * 判断文本 1 是否包含文本 2
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否包含指定文本"}
 */
 declare function Contains(text1: string, text2: string): boolean;
 /**
@@ -729,6 +1199,9 @@ declare function Contains(text1: string, text2: string): boolean;
 *
 * @remarks
 * 根据传入的文本 2，将文本 1 拆分成文本数组，例如 Split("张三,李四,王五", ",")
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "拆分文本"}
 */
 declare function Split(text1: string, text2: string): string[];
 /**
@@ -736,6 +1209,9 @@ declare function Split(text1: string, text2: string): string[];
 *
 * @remarks
 * 删除文本开头和结尾的所有空格和制表符，文本中间的空格和制表符不会删除
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "删除开头/结尾空格和制表符"}
 */
 declare function Trim(text: string): string;
 /**
@@ -743,6 +1219,9 @@ declare function Trim(text: string): string;
 *
 * @remarks
 * 将传入的文本转为全大写文本
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "转换为大写"}
 */
 declare function Upper(text: string): string;
 /**
@@ -750,6 +1229,9 @@ declare function Upper(text: string): string;
 *
 * @remarks
 * 将传入的文本转为全小写文本
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "转换为小写"}
 */
 declare function Lower(text: string): string;
 /**
@@ -757,12 +1239,18 @@ declare function Lower(text: string): string;
 *
 * @remarks
 * 将数字、时间日期等转换为文本
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "转换为文本"}
 */
 /**
 * 文本拼接
 *
 * @remarks
 * 返回多个文本拼接后的新文本
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "文本拼接"}
 */
 declare function Concat(...text: string[]): string;
 
@@ -771,6 +1259,9 @@ declare function Concat(...text: string[]): string;
 *
 * @remarks
 * 返回当前系统时间，通常与其他日期时间函数搭配使用
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取现在时间"}
 */
 declare function Now(): number;
 /**
@@ -778,6 +1269,9 @@ declare function Now(): number;
 *
 * @remarks
 * 根据输入的日期时间返回时间戳
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取时间戳"}
 */
 declare function Timestamp(arg: number | string | Date): number;
 /**
@@ -785,6 +1279,9 @@ declare function Timestamp(arg: number | string | Date): number;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的秒数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取秒数"}
 */
 declare function Second(arg: number | string | Date): number;
 /**
@@ -792,6 +1289,9 @@ declare function Second(arg: number | string | Date): number;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的分钟部分
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取分钟数"}
 */
 declare function Minute(arg: number | string | Date): number;
 /**
@@ -799,6 +1299,9 @@ declare function Minute(arg: number | string | Date): number;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的小时部分，24小时制
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取小时数"}
 */
 declare function Hour(arg: number | string | Date): number;
 /**
@@ -806,6 +1309,9 @@ declare function Hour(arg: number | string | Date): number;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的日部分，范围为 1-31
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取天数"}
 */
 declare function Day(arg: number | string | Date): number;
 /**
@@ -813,6 +1319,9 @@ declare function Day(arg: number | string | Date): number;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的星期数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取星期数"}
 */
 declare function DayOfWeek(arg: number | string | Date): number;
 /**
@@ -820,6 +1329,9 @@ declare function DayOfWeek(arg: number | string | Date): number;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的月份
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取月数"}
 */
 declare function Month(arg: number | string | Date): number;
 /**
@@ -827,6 +1339,9 @@ declare function Month(arg: number | string | Date): number;
 *
 * @remarks
 * 根据输入的日期时间返回该时间的年份
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "获取年份"}
 */
 declare function Year(arg: number | string | Date): number;
 /**
@@ -834,6 +1349,9 @@ declare function Year(arg: number | string | Date): number;
 *
 * @remarks
 * 根据输入的年月日数值返回一个日期类型的数据，例如 GetDate(2017,3,24)
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "使用年月日创建日期时间"}
 */
 declare function GetDate(year: number, month: number, day: number): number;
 /**
@@ -841,12 +1359,18 @@ declare function GetDate(year: number, month: number, day: number): number;
 *
 * @remarks
 * 将日期时间文本根据指定格式转化为日期时间，例如 DateTimeValue("2021-12-11 01:19:12", "yyyy-MM-dd HH:mm:ss")
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "使用时间戳创建日期时间"}
 */
 /**
 * 使用时间日期文本创建日期时间
 *
 * @remarks
 * 将日期时间文本根据指定格式转化为日期时间，例如 DateTimeValue("2021-12-11 01:19:12", "yyyy-MM-dd HH:mm:ss")
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "使用时间日期文本创建日期时间"}
 */
 declare function DateTimeValue(arg: string, val: string): number;
 /**
@@ -854,6 +1378,9 @@ declare function DateTimeValue(arg: string, val: string): number;
 *
 * @remarks
 * 根据输入的两个日期时间计算出年龄，例如 Age(Date(2017,3,24), Date(2021,3,24))
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "计算年龄"}
 */
 declare function Age(arg: number | string | Date, val: number | string | Date): number;
 /**
@@ -861,6 +1388,9 @@ declare function Age(arg: number | string | Date, val: number | string | Date):
 *
 * @remarks
 * 计算当前年龄，例如 AgeOfNow(Date(2017,3,24))
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "计算当前年龄"}
 */
 declare function AgeOfNow(arg: number | string | Date): number;
 /**
@@ -868,6 +1398,9 @@ declare function AgeOfNow(arg: number | string | Date): number;
 *
 * @remarks
 * 在传入的日期时间上增加 X 天，支持负数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "增加 X 天"}
 */
 declare function DateAdd(arg: number | string | Date, day: number): number;
 /**
@@ -875,6 +1408,9 @@ declare function DateAdd(arg: number | string | Date, day: number): number;
 *
 * @remarks
 * 在传入的日期和时间上增加 X 月，支持负数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "增加 X 月"}
 */
 declare function MonthAdd(arg: number | string | Date, month: number): number;
 /**
@@ -882,6 +1418,9 @@ declare function MonthAdd(arg: number | string | Date, month: number): number;
 *
 * @remarks
 * 在传入的日期和时间上增加 X 年，支持负数
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "增加 X 年"}
 */
 declare function YearAdd(arg: number | string | Date, year: number): number;
 /**
@@ -889,6 +1428,9 @@ declare function YearAdd(arg: number | string | Date, year: number): number;
 *
 * @remarks
 * 返回两个日期时间字段之间的天数差，如果为同一天，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "天数差"}
 */
 declare function DateDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -896,6 +1438,9 @@ declare function DateDiff(startDay: number | string | Date, endDay: number | str
 *
 * @remarks
 * 返回两个日期时间字段之间的小时差，如果为同一小时，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "小时差"}
 */
 declare function HourDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -903,6 +1448,9 @@ declare function HourDiff(startDay: number | string | Date, endDay: number | str
 *
 * @remarks
 * 返回两个日期时间字段之间的分钟差，如果为同一分钟，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "分钟差"}
 */
 declare function MinuteDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -910,6 +1458,9 @@ declare function MinuteDiff(startDay: number | string | Date, endDay: number | s
 *
 * @remarks
 * 返回两个日期时间字段之间的天数差，如果为同一天，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "秒数差"}
 */
 declare function SecondDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -917,6 +1468,9 @@ declare function SecondDiff(startDay: number | string | Date, endDay: number | s
 *
 * @remarks
 * 返回两个日期时间字段之间的月数差，如果为同一月，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "月数差"}
 */
 declare function MonthDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -924,6 +1478,9 @@ declare function MonthDiff(startDay: number | string | Date, endDay: number | st
 *
 * @remarks
 * 返回两个日期时间字段之间的年数差，如果为同一年，差数为零
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "年数差"}
 */
 declare function YearDiff(startDay: number | string | Date, endDay: number | string | Date): number;
 /**
@@ -931,6 +1488,9 @@ declare function YearDiff(startDay: number | string | Date, endDay: number | str
 *
 * @remarks
 * 格式化日期时间为指定格式的文本，例如 DateText(Date(2017,3,24), "yyyy-MM-dd HH:mm:ss")
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "日期时间格式化"}
 */
 declare function DateText(createdTime: number | string | Date, text: string): string;
 /**
@@ -938,6 +1498,9 @@ declare function DateText(createdTime: number | string | Date, text: string): st
 *
 * @remarks
 * 判断传入的日期时间是否为今天，例如 IsToday(Date(2022,4,8))
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否为今天"}
 */
 declare function IsToday(date: number | string | Date): boolean;