@cloudbase/cals 1.0.3-alpha.0 → 1.0.3-alpha.10

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

@@ -55,13 +55,47 @@ exports.wedaDTS = `declare class UserWidget {
 // Redefine Any Type Inner End
 
 declare namespace $app {
-  const id: string;
+  /**
+ * 应用 ID
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "应用 ID"}
+ */
+const id: string;
+/**
+ * 应用名称
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "应用名称"}
+ */
 const label: string;
+/**
+ * 应用版本
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "应用版本"}
+ */
 const version: string;
+/**
+ * 小程序APPID
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "小程序APPID"}
+ */
 const mpAppId: string;
+/**
+ * 小程序名称
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "小程序名称"}
+ */
 const mpAppName: string;
 
 namespace dataset {
+
+  /**
+   * 全局变量对象
+   */
   const state: {
     // Global State Inner Begin
     // Global State 全局变量 - Don't touch me
@@ -78,6 +112,11 @@ namespace common {
   // Global Common Inner End
 }
 
+/**
+ * 已废弃，请改用 $w.utils
+ */
+const utils: any
+
 /**
  * 设置页面变量
  */
@@ -91,11 +130,17 @@ declare namespace $w {
 
   /**
    * 当前应用实例
+   *
+   * @privateForWeDa
+   * {"group": "sysVar", "displayType": "object", "displayName": "应用信息", "schema": {"type":"object","properties":{"id":{"type":"string","title":"应用 ID"},"label":{"type":"string","title":"应用名称"},"version":{"type":"string","title":"应用版本"},"mpAppName":{"type":"string","title":"小程序名称"},"mpAppId":{"type":"string","title":"小程序APPID"}}}}
    */
   const app = $app;
 
   /**
-   * 当前页面实例
+   * 当前页面信息
+   *
+   * @privateForWeDa
+   * {"group": "sysVar", "displayType": "object", "displayName": "当前页面信息", "schema": {"type":"object","properties":{"id":{"type":"string","title":"页面 ID"},"label":{"type":"string","title":"页面名称"},"path":{"type":"string","title":"页面路径"}}}}
    */
   const page = $page;
 
@@ -103,62 +148,62 @@ declare namespace $w {
    * 用户权限相关方法和属性
    */
   namespace auth {
-
+    
 interface CurrentUserInfo {
   /**
    * 用户 ID
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "string", "displayName": "用户 ID"}
+   * {"group": "sysVar", "displayType": "string", "displayName": "用户 ID"}
    */
   userId?: string;
   /**
    * 手机
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "string", "displayName": "手机"}
+   * {"group": "sysVar", "displayType": "string", "displayName": "手机"}
    */
   phone?: string;
   /**
    * 用户类型
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "number", "displayName": "用户类型"}
+   * {"group": "sysVar", "displayType": "number", "displayName": "用户类型"}
    */
   type?: number;
   /**
    * 用户关联角色
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "array", "displayName": "用户关联角色"}
+   * {"group": "sysVar", "displayType": "array", "displayName": "用户关联角色"}
    */
   relatedRoles?: {
     /**
      * 角色 ID
      *
      * @privateForWeDa
-     * {"group": "globalVar", "displayType": "string", "displayName": "角色 ID"}
+     * {"group": "sysVar", "displayType": "string", "displayName": "角色 ID"}
      */
     id?: string;
     /**
      * 环境 ID
      *
      * @privateForWeDa
-     * {"group": "globalVar", "displayType": "string", "displayName": "环境 ID"}
+     * {"group": "sysVar", "displayType": "string", "displayName": "环境 ID"}
      */
     envId?: string;
     /**
      * 角色名称
      *
      * @privateForWeDa
-     * {"group": "globalVar", "displayType": "string", "displayName": "角色名称"}
+     * {"group": "sysVar", "displayType": "string", "displayName": "角色名称"}
      */
     name?: string;
     /**
      * 角色标识
      *
      * @privateForWeDa
-     * {"group": "globalVar", "displayType": "string", "displayName": "角色标识"}
+     * {"group": "sysVar", "displayType": "string", "displayName": "角色标识"}
      */
     roleIdentity?: string;
   }[];
@@ -166,49 +211,49 @@ interface CurrentUserInfo {
    * 微信/企微 openId
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "string", "displayName": "微信/企微 openId"}
+   * {"group": "sysVar", "displayType": "string", "displayName": "微信/企微 openId"}
    */
   openId?: string;
   /**
    * 用户名称
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "string", "displayName": "用户名称"}
+   * {"group": "sysVar", "displayType": "string", "displayName": "用户名称"}
    */
   name?: string;
   /**
    * 用户昵称
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "string", "displayName": "用户昵称"}
+   * {"group": "sysVar", "displayType": "string", "displayName": "用户昵称"}
    */
   nickName?: string;
   /**
    * 邮箱
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "string", "displayName": "邮箱"}
+   * {"group": "sysVar", "displayType": "string", "displayName": "邮箱"}
    */
   email?: string;
   /**
    * 主岗部门
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "object", "displayName": "主岗部门"}
+   * {"group": "sysVar", "displayType": "object", "displayName": "主岗部门"}
    */
   mainOrg?: {
     /**
      * 主岗部门 ID
      *
      * @privateForWeDa
-     * {"group": "globalVar", "displayType": "string", "displayName": "主岗部门 ID"}
+     * {"group": "sysVar", "displayType": "string", "displayName": "主岗部门 ID"}
      */
     id?: string;
     /**
      * 主岗部门名称
      *
      * @privateForWeDa
-     * {"group": "globalVar", "displayType": "string", "displayName": "主岗部门名称"}
+     * {"group": "sysVar", "displayType": "string", "displayName": "主岗部门名称"}
      */
     name?: string;
   };
@@ -216,21 +261,21 @@ interface CurrentUserInfo {
    * 兼岗部门
    *
    * @privateForWeDa
-   * {"group": "globalVar", "displayType": "object", "displayName": "兼岗部门"}
+   * {"group": "sysVar", "displayType": "object", "displayName": "兼岗部门"}
    */
   orgs?: {
     /**
      * 兼岗部门 ID
      *
      * @privateForWeDa
-     * {"group": "globalVar", "displayType": "string", "displayName": "兼岗部门 ID"}
+     * {"group": "sysVar", "displayType": "string", "displayName": "兼岗部门 ID"}
      */
     id?: string;
     /**
      * 兼岗部门名称
      *
      * @privateForWeDa
-     * {"group": "globalVar", "displayType": "string", "displayName": "兼岗部门名称"}
+     * {"group": "sysVar", "displayType": "string", "displayName": "兼岗部门名称"}
      */
     name?: string;
   }[];
@@ -246,7 +291,7 @@ function getUserInfo(): CurrentUserInfo;
  * 登录用户信息
  *
  * @privateForWeDa
- * {"group": "globalVar", "displayType": "object", "displayName": "登录用户信息", "schema": {"type":"object","properties":{"userId":{"type":"string","title":"用户 ID"},"phone":{"type":"string","title":"手机"},"type":{"type":"number","title":"用户类型"},"relatedRoles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"角色 ID"},"envId":{"type":"string","title":"环境 ID"},"name":{"type":"string","title":"角色名称"},"roleIdentity":{"type":"string","title":"角色标识"}}},"title":"用户关联角色"},"openId":{"type":"string","title":"微信/企微 openId"},"name":{"type":"string","title":"用户名称"},"nickName":{"type":"string","title":"用户昵称"},"email":{"type":"string","title":"邮箱"},"mainOrg":{"type":"object","properties":{"id":{"type":"string","title":"主岗部门 ID"},"name":{"type":"string","title":"主岗部门名称"}},"title":"主岗部门"},"orgs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"兼岗部门 ID"},"name":{"type":"string","title":"兼岗部门名称"}}},"title":"兼岗部门"}}}, "doc": "https://docs.cloudbase.net/lowcode/framework/app/app#authgetuserinfoauthcurrentuser"}
+ * {"group": "sysVar", "displayType": "object", "displayName": "登录用户信息", "schema": {"type":"object","properties":{"userId":{"type":"string","title":"用户 ID"},"phone":{"type":"string","title":"手机"},"type":{"type":"number","title":"用户类型"},"relatedRoles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"角色 ID"},"envId":{"type":"string","title":"环境 ID"},"name":{"type":"string","title":"角色名称"},"roleIdentity":{"type":"string","title":"角色标识"}}},"title":"用户关联角色"},"openId":{"type":"string","title":"微信/企微 openId"},"name":{"type":"string","title":"用户名称"},"nickName":{"type":"string","title":"用户昵称"},"email":{"type":"string","title":"邮箱"},"mainOrg":{"type":"object","properties":{"id":{"type":"string","title":"主岗部门 ID"},"name":{"type":"string","title":"主岗部门名称"}},"title":"主岗部门"},"orgs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","title":"兼岗部门 ID"},"name":{"type":"string","title":"兼岗部门名称"}}},"title":"兼岗部门"}}}, "doc": "https://docs.cloudbase.net/lowcode/framework/app/app#authgetuserinfoauthcurrentuser"}
  */
 const currentUser: CurrentUserInfo;
 
@@ -502,7 +547,12 @@ function formatEnum(path, optionname, app);
 
   }
 
-  // $w.device
+  /**
+   * 设备信息
+   *
+   * @privateForWeDa
+   * {"group": "sysVar", "displayType": "object", "displayName": "设备信息", "schema": {"type":"object","properties":{"viewport":{"type":"object","title":"窗口","properties":{"width":{"type":"number","title":"窗口宽度"},"height":{"type":"number","title":"窗口高度"}}},"networkType":{"type":"string","title":"网络类型"}}}}
+   */
   namespace device {
     /**
  * 网络类型
@@ -524,25 +574,45 @@ enum NETWORK_TYPE {
 interface IViewport {
   /**
    * 窗口宽度
+   *
+   * @privateForWeDa
+   * {"group": "sysVar", "displayType": "number", "displayName": "窗口宽度"}
    */
   width: number;
   /**
    * 窗口高度
+   *
+   * @privateForWeDa
+   * {"group": "sysVar", "displayType": "number", "displayName": "窗口高度"}
    */
   height: number;
 }
 
+/**
+ * 窗口
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "object", "displayName": "窗口"}
+ */
 const viewport: IViewport;
+/**
+ * 网络类型
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "网络类型"}
+ */
 const networkType: NETWORK_TYPE;
 
   }
 
-  // $w.env
+  /**
+   * 环境信息
+   *
+   * @privateForWeDa
+   * {"group": "sysVar", "displayType": "object", "displayName": "环境信息", "schema": {"type":"object","properties":{"envId":{"type":"string","title":"环境 ID"},"type":{"type":"string","title":"环境类型"}}}}
+   */
   namespace env {
-    /**
- * 环境类型
- */
-enum ENV_TYPE {
+    enum ENV_TYPE {
   /**
    * 生产
    */
@@ -553,19 +623,67 @@ enum ENV_TYPE {
   'preview' = 'preview',
 }
 
+/**
+ * 环境类型
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "环境类型"}
+ */
 const type: ENV_TYPE;
+/**
+ * 环境 ID
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "环境 ID"}
+ */
 const envId: string;
 
   }
 
-  // $w.wedaContext
+  /**
+   * 上下文信息
+   *
+   * @privateForWeDa
+   * {"group": "sysVar", "displayType": "object", "displayName": "上下文信息", "schema": {"type":"object","properties":{"platforms":{"type":"array","title":"应用运行终端","items":{"type":"stirng"}},"isEditorMode":{"type":"boolean","title":"是否在编辑区"}}}}
+   */
   namespace wedaContext {
-    const isEditorMode: boolean;
+    /**
+ * 是否在编辑区
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "boolean", "displayName": "是否在编辑区"}
+ */
+const isEditorMode: boolean;
+
+/**
+ * 应用运行终端
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "应用运行终端"}
+ */
 const platforms: ('WEB' | 'MOBILEWEB' | 'PCWEB' | 'MP')[];
 
   }
 
-   function ABS(num: number): number;
+  /**
+* 绝对值
+*
+* @remarks
+* 计算传入数字的绝对值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "绝对值", "insertText": "ABS(1)", "subGroup": "calculation", "doc": "https://cloud.tencent.com/document/product/1301/76328" , "description": "计算传入数字的绝对值" , "definition": "ABS(数字):数字"}
+*/
+ function ABS(num: number): number;
+/**
+* 最小值
+*
+* @remarks
+* 返回一组数字中的最小值
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "最小值", "insertText": "Min(1, 2)", "subGroup": "calculation", "doc": "https://cloud.tencent.com/document/product/1301/76328" , "description": "返回一组数字中的最小值" , "definition": "Min(数字1, [数字2, ...]):数字"}
+*/
  function Min(...args: number[]): number;
 /**
 * 最大值
@@ -643,13 +761,26 @@ condition: boolean;
 consequent?: any;
 alternate?: any;
 }
- interface IIfObjectParam {
-condition: boolean;
-consequent?: any;
-alternate?: any;
-}
+/**
+* 条件分支
+*
+* @remarks
+* 按判断条件进行逻辑比较，满足时返回一个值，不满足时返回另一个值。
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "条件分支", "insertText": "If(true, '您好', 'hello')", "subGroup": "logic", "doc": "https://cloud.tencent.com/document/product/1301/76328" , "description": "按判断条件进行逻辑比较，满足时返回一个值，不满足时返回另一个值。" , "definition": "If(判断条件, 满足时返回的值, 不满足时返回的值):任何类型"}
+*/
  function If(params: IIfObjectParam): any;
  function If(condition: boolean, consequent?: any, alternate?: any): any;
+/**
+* 是否为空
+*
+* @remarks
+* 判断传入的文本是否为空
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否为空", "insertText": "IsEmpty('hello')", "subGroup": "logic", "doc": "https://cloud.tencent.com/document/product/1301/76328" , "description": "判断传入的文本是否为空" , "definition": "IsEmpty(值):布尔值"}
+*/
  function IsEmpty(text: string | string[]): boolean;
 /**
 * 是否为null
@@ -1015,8 +1146,26 @@ declare const forItems = $for;
 
 // $page Begin
 declare namespace $page {
-  const id: string;
+  /**
+ * 页面 ID
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "页面 ID"}
+ */
+const id: string;
+/**
+ * 页面名称
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "页面名称"}
+ */
 const label: string;
+/**
+ * 页面路径
+ *
+ * @privateForWeDa
+ * {"group": "sysVar", "displayType": "string", "displayName": "页面路径"}
+ */
 const path: string;
 
 /**
@@ -1188,13 +1337,26 @@ condition: boolean;
 consequent?: any;
 alternate?: any;
 }
-declare interface IIfObjectParam {
-condition: boolean;
-consequent?: any;
-alternate?: any;
-}
+/**
+* 条件分支
+*
+* @remarks
+* 按判断条件进行逻辑比较，满足时返回一个值，不满足时返回另一个值。
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "条件分支", "insertText": "If(true, '您好', 'hello')", "subGroup": "logic", "doc": "https://cloud.tencent.com/document/product/1301/76328" , "description": "按判断条件进行逻辑比较，满足时返回一个值，不满足时返回另一个值。" , "definition": "If(判断条件, 满足时返回的值, 不满足时返回的值):任何类型"}
+*/
 declare function If(params: IIfObjectParam): any;
 declare function If(condition: boolean, consequent?: any, alternate?: any): any;
+/**
+* 是否为空
+*
+* @remarks
+* 判断传入的文本是否为空
+*
+* @privateForWeDa
+* {"group": "formula", "displayType": "function", "displayName": "是否为空", "insertText": "IsEmpty('hello')", "subGroup": "logic", "doc": "https://cloud.tencent.com/document/product/1301/76328" , "description": "判断传入的文本是否为空" , "definition": "IsEmpty(值):布尔值"}
+*/
 declare function IsEmpty(text: string | string[]): boolean;
 /**
 * 是否为null

package/lib/utils/dts/build.d.ts

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=build.d.ts.map