@dcloudio/uni-app-x 0.4.6 → 0.5.1

package/README.md

@@ -0,0 +1,39 @@
+# uni-app x 类型
+
+## 初始化依赖
+
+```shell
+pnpm i
+```
+
+## 配置环境
+
+当前目录建立 .env 文件
+
+```
+UNI_CORE_DIR = "%vuejs-core 仓库路径%/packages/uni-ext-api/src"
+UNI_UTS_PLUGIN_API_DIR = "%新 uni-app 仓库路径%/api"
+UNI_UTS_PLUGIN_COMPONENT_DIR = "%新 uni-app 仓库路径%/component"
+UNI_COMPLIER_META_DIR = "%旧 uni-app 仓库路径%/packages/uni-uts-v1/lib/ext-api"
+
+```
+
+## 构建
+
+构建框架内置 Uni Api
+
+```shell
+pnpm build:types:core
+```
+
+构建 Ext Api
+
+```shell
+pnpm build:types:ext
+```
+
+生成默认参数数据到编译器
+
+```shell
+pnpm build:types:meta
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcloudio/uni-app-x",
-  "version": "0.4.6",
+  "version": "0.5.1",
   "description": "uni-app x types",
   "typings": "index.d.ts",
   "author": "DCloud",
@@ -8,9 +8,11 @@
   "type": "module",
   "scripts": {
     "build:types:core": "node ./scripts/build-types.js -t core",
-    "build:types:ext": "node ./scripts/build-types.js -t ext",
+    "build:types:plugin:api": "node ./scripts/build-types.js -t uts-plugin-api",
+    "build:types:plugin:component": "node ./scripts/build-types.js -t uts-plugin-component",
+    "build:types:plugin": "npm run build:types:plugin:api  && npm run build:types:plugin:component",
     "build:types:meta": "node ./scripts/build-meta.js",
-    "build:types": "npm run build:types:core && npm run build:types:ext"
+    "build:types": "npm run build:types:core && npm run build:types:plugin"
   },
   "devDependencies": {
     "delete": "^1.1.0",

package/types/app.d.ts

@@ -19,15 +19,15 @@ interface ReferrerInfo {
   extraData?: any;
 }
 
-interface LaunchShowOption {
+interface OnLaunchOptions {
   /**
-   * 打开小程序的路径
+   * 	应用启动页面路径
    */
   path: string;
   /**
    * 打开小程序的query
    */
-  query: AnyObject;
+  // query: AnyObject;
   /**
    * 打开小程序的场景值
    * - 1001: 发现栏小程序主入口，「最近使用」列表（基础库2.2.4版本起包含「我的小程序」列表）
@@ -100,15 +100,22 @@ interface LaunchShowOption {
    * - 1103: 发现栏小程序主入口，「我的小程序」列表（基础库2.2.4版本起废弃）
    * - 1104: 微信聊天主界面下拉，「我的小程序」栏（基础库2.2.4版本起废弃）
    */
-  scene: number;
+  // scene: number;
   /**
    * 打开小程序的场景值
    */
-  shareTicket: string;
+  // shareTicket: string;
   /**
    * 当场景为由从另一个小程序或公众号或App打开时，返回此字段
    */
-  referrerInfo?: ReferrerInfo;
+  // referrerInfo?: ReferrerInfo;
+}
+
+interface OnShowOptions {
+  /**
+   * 	应用启动页面路径
+   */
+  path: string
 }
 
 interface PageNotFoundOption {
@@ -183,17 +190,8 @@ interface AppInstance<T extends AnyObject = {}> {
    *        "hostVer": "√",
    *        "uniVer": "√",
    *        "unixVer": "x"
-   *    },
-   *    "360": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
-   *        "unixVer": "x"
    *    }
    *  },
-   *  "quickapp": {
-   *      "uniVer": "√",
-   *      "unixVer": "x"
-   *  },
    *  "web": {
    *      "uniVer": "√",
    *      "unixVer": "x"
@@ -206,7 +204,7 @@ interface AppInstance<T extends AnyObject = {}> {
    *
    * 应用初始化完成时触发，全局只触发一次。
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -260,30 +258,21 @@ interface AppInstance<T extends AnyObject = {}> {
    *        "hostVer": "√",
    *        "uniVer": "√",
    *        "unixVer": "x"
-   *    },
-   *    "360": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
-   *        "unixVer": "x"
    *    }
    *  },
-   *  "quickapp": {
-   *      "uniVer": "√",
-   *      "unixVer": "x"
-   *  },
    *  "web": {
    *      "uniVer": "√",
    *      "unixVer": "x"
    *  }
    *}
    */
-  onLaunch?(options?: LaunchShowOption): void;
+  onLaunch?(options?: OnLaunchOptions): void;
   /**
    * 生命周期回调 监听应用显示
    *
    * 应用启动，或从后台进入前台显示时触发
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -337,30 +326,21 @@ interface AppInstance<T extends AnyObject = {}> {
    *        "hostVer": "√",
    *        "uniVer": "√",
    *        "unixVer": "x"
-   *    },
-   *    "360": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
-   *        "unixVer": "x"
    *    }
    *  },
-   *  "quickapp": {
-   *      "uniVer": "√",
-   *      "unixVer": "x"
-   *  },
    *  "web": {
    *      "uniVer": "√",
    *      "unixVer": "x"
    *  }
    *}
    */
-  onShow?(options?: LaunchShowOption): void;
+  onShow?(options?: OnShowOptions): void;
   /**
    * 生命周期回调 监听应用隐藏
    *
    * 应用从前台进入后台时触发
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -414,17 +394,8 @@ interface AppInstance<T extends AnyObject = {}> {
    *        "hostVer": "√",
    *        "uniVer": "√",
    *        "unixVer": "x"
-   *    },
-   *    "360": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
-   *        "unixVer": "x"
    *    }
    *  },
-   *  "quickapp": {
-   *      "uniVer": "√",
-   *      "unixVer": "x"
-   *  },
    *  "web": {
    *      "uniVer": "√",
    *      "unixVer": "x"
@@ -437,7 +408,7 @@ interface AppInstance<T extends AnyObject = {}> {
    * 小程序发生脚本错误或 API 调用报错时触发
    * @param error 错误信息，包含堆栈
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -491,17 +462,8 @@ interface AppInstance<T extends AnyObject = {}> {
    *        "hostVer": "√",
    *        "uniVer": "√",
    *        "unixVer": "x"
-   *    },
-   *    "360": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
-   *        "unixVer": "x"
    *    }
    *  },
-   *  "quickapp": {
-   *      "uniVer": "√",
-   *      "unixVer": "x"
-   *  },
    *  "web": {
    *      "uniVer": "√",
    *      "unixVer": "x"
@@ -518,7 +480,7 @@ interface AppInstance<T extends AnyObject = {}> {
    * 1. 如果开发者没有添加 `onPageNotFound` 监听，当跳转页面不存在时，将推入微信客户端原生的页面不存在提示页面。
    * 2. 如果 `onPageNotFound` 回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再回调 `onPageNotFound`。
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -572,17 +534,8 @@ interface AppInstance<T extends AnyObject = {}> {
    *        "hostVer": "√",
    *        "uniVer": "√",
    *        "unixVer": "x"
-   *    },
-   *    "360": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
-   *        "unixVer": "x"
    *    }
    *  },
-   *  "quickapp": {
-   *      "uniVer": "√",
-   *      "unixVer": "x"
-   *  },
    *  "web": {
    *      "uniVer": "√",
    *      "unixVer": "x"
@@ -593,7 +546,7 @@ interface AppInstance<T extends AnyObject = {}> {
   /**
    * 未处理的 Promise 拒绝事件监听函数
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -664,11 +617,13 @@ interface AppInstance<T extends AnyObject = {}> {
    *  }
    *}
    */
-  onUnhandledRejection?(options: UniNamespace.OnUnhandledRejectionCallbackResult): void;
+    
+    //   onUnhandledRejection?(options: UniNamespace.OnUnhandledRejectionCallbackResult): void;
+    
   /**
    * 监听系统主题变化
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -739,13 +694,15 @@ interface AppInstance<T extends AnyObject = {}> {
    *  }
    *}
    */
-  onThemeChange?(options: UniNamespace.OnThemeChangeCallbackResult): void;
+
+    //   onThemeChange?(options: UniNamespace.OnThemeChangeCallbackResult): void;
+    
   /**
    * 监听 nvue 页面消息
    *
    * nvue 页面使用 `uni.postMessage` 发送消息时触发
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -820,7 +777,7 @@ interface AppInstance<T extends AnyObject = {}> {
   /**
    * 监听应用退出。app-uvue-android 3.9+
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -895,7 +852,7 @@ interface AppInstance<T extends AnyObject = {}> {
   /**
    * 最后一个页面按下Android back键，常用于自定义退出。app-uvue-android 3.9+
    *
-   * 文档: [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
+   * @tutorial [https://uniapp.dcloud.io/collocation/frame/lifecycle](https://uniapp.dcloud.io/collocation/frame/lifecycle)
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -973,14 +930,11 @@ type AppConstructor = <T extends AnyObject & AppInstance>(
   options: AppInstance<T> & T,
 ) => void;
 
-interface GetAppOption {
-  /**
-   * 在 `App` 未定义时返回默认实现。当App被调用时，默认实现中定义的属性会被覆盖合并到App中。一般用于独立分包
-   */
-  allowDefault: boolean;
-}
-
-type GetApp = <T extends AnyObject>(opts?: GetAppOption) => AppInstance<T> & T;
 
+/**
+ * `getApp()` 函数用于获取当前应用实例。
+ * @tutorial https://uniapp.dcloud.net.cn/uni-app-x/api/getapp.html#getapp
+ */
+type GetApp = <T extends AnyObject>() => AppInstance<T> & T;
 
 declare const getApp: GetApp;

package/types/native/CSSStyleDeclaration.d.ts

@@ -9,12 +9,12 @@ declare class CSSStyleDeclaration {
  * @param name CSS样式名称
  * @param value 要设置的新CSS样式值
  */
-  setProperty(name: string, value: any|null): void
+  setProperty(name: string|HBuilderX.cssPropertyString, value: any|null): void
 
 /**
  * 获取CSS指定的样式值，如果指定的样式不存在则返回null。
  * @param property 要获取的CSS样式名称
  */
-  getPropertyValue(property: string): any|null
+  getPropertyValue(property: string|HBuilderX.cssPropertyString): any|null
 
 }

package/types/native/CustomEvent.d.ts

@@ -2,7 +2,6 @@
 
 /**
  * @package io.dcloud.uniapp.runtime
- * @autodoc false
  */
 declare class CustomEventOptions<T>{
   detail: T
@@ -11,7 +10,6 @@ declare class CustomEventOptions<T>{
 
 /**
  * @package io.dcloud.uniapp.runtime
- * @autodoc false
  */
 declare class CustomEvent<T> extends Event {
   get detail(): T

package/types/native/DOMRect.d.ts

@@ -6,10 +6,10 @@ declare class DOMRect {
 
   /**
    * 创建一个新的 DOMRect 对象
-   * @param x 矩形原点的x坐标
-   * @param y 矩形原点的y坐标
-   * @param width 矩形的宽
-   * @param height 矩形的高
+   * @param {number} [x=0] 矩形原点的x坐标
+   * @param {number} [y=0] 矩形原点的y坐标
+   * @param {number} [width=0] 矩形的宽
+   * @param {number} [height=0] 矩形的高
    */
   constructor(x?: number, y?: number, width?: number, height?: number);
 

package/types/native/DomNode.d.ts

@@ -0,0 +1,48 @@
+/// <reference path="./Element.d.ts" />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class DomNode implements Element {
+  firstChild: Element | null
+  lastChild: Element | null
+  parentNode: Element | null
+  parentElement: Element | null
+  previousSibling: Element | null
+  nextSibling: Element | null
+  nextElementSibling: Element | null
+  children: Element[]
+  tagName: string
+  nodeName: string
+  ext: Map<string, any>
+  dataset: Map<string, any | null>
+  attributes: Map<string, any | null>
+  style: CSSStyleDeclaration
+  scrollWidth: number
+  scrollHeight: number
+  scrollLeft: number
+  scrollTop: number
+  offsetLeft: number
+  offsetTop: number
+  offsetWidth: number
+  offsetHeight: number
+  getNodeId(): string
+  appendChild(aChild: Element): void
+  insertBefore(newChild: Element, refChild: Element): void
+  setAttribute(key: string, value: any | null): void
+  getAttribute(key: string): any | null
+  hasAttribute(key: string): boolean
+  removeAttribute(key: string): void
+  updateStyle(map: Map<string, any>): void
+  getBoundingClientRect(): DOMRect
+  getDrawableContext(): DrawableContext | null
+  addEventListener<T extends Event, R>(type: string, callback: (event: T) => R): void
+  removeEventListener(type: string): void
+  removeChild(aChild: Element): Element
+  remove(): void
+  dispatchEvent(type: string, value: Event): void
+  scrollTo(x: number, y: number): void
+  scrollBy(x: number, y: number): void
+  focus(): void
+  blur(): void
+}

package/types/native/DrawableContext.d.ts

@@ -1,20 +1,21 @@
-/// <reference path='./INode.d.ts' />
-
 /**
  * @package io.dcloud.uniapp.runtime
  */
 
 declare class DrawableContext {
 	/**
-	 * 设置字体大小，默认为`10px`
+	 * 设置字体大小
+	 * @defaultValue 10px
 	 */
 	font : string
 	/**
-	 * 设置填充颜色，默认为`#000 (黑色)`
+	 * 设置填充颜色
+	 * @defaultValue #000 (黑色)
 	 */
 	fillStyle : string
 	/**
-	 * 指定如何绘制每一条线条末端的属性，默认为`butt`
+	 * 指定如何绘制每一条线条末端的属性，可选值：`butt`线段末端以方形结束；`round`线段末端以圆形结束；`square`线段末端以方形结束，但是会增加一个一半宽度的矩形区域。
+	 * @defaultValue butt
 	 */
 	lineCap : string
 	/**
@@ -22,19 +23,23 @@ declare class DrawableContext {
 	 */
 	lineDashOffset : number
 	/**
-	 * 设置 2 个长度不为 0 的线条相连部分如何连接在一起的属性，默认值`miter`
+	 * 设置 2 个长度不为 0 的线条相连部分如何连接在一起的属性，可选值：`bevel`斜角；`round`圆角；`miter`尖角。
+	 * @defaultValue miter
 	 */
 	lineJoin : string
 	/**
-	 * 设置线条的宽度，默认为`1px`
+	 * 设置线条的宽度
+	 * @defaultValue 1px
 	 */
 	lineWidth : number
 	/**
-	 * 设置边框的颜色，默认为`#000 (黑色)`
+	 * 设置边框的颜色
+	 * @defaultValue #000 (黑色)
 	 */
 	strokeStyle : string
 	/**
-	 * 设置文本的对齐方式，默认为`left`
+	 * 设置文本的对齐方式，可取值：`left`左对齐；`center`居中对齐；`right`右对齐。
+	 * @defaultValue left
 	 */
 	textAlign : string
 	/**
@@ -49,9 +54,9 @@ declare class DrawableContext {
 	 * @param {number} radius 圆弧的半径
 	 * @param {number} startAngle 圆弧的起始点，x 轴方向开始计算，单位为弧度
 	 * @param {number} endAngle 圆弧的终点，单位为弧度
-	 * @param {number} anticlockwise 圆弧绘制方向，true：逆时针绘制，false：顺时针绘制。默认为true。可选
+	 * @param {number} [anticlockwise=true] 圆弧绘制方向，true：逆时针绘制，false：顺时针绘制。
 	 */
-	arc(x : number, y : number, radius : number, startAngle : number, endAngle : number, anticlockwise ?: boolean) : void
+	arc(x : number, y : number, radius : number, startAngle : number, endAngle : number, anticlockwise ?: boolean | null) : void
 
 	/**
 	 * 将一个新的路径的起始点移动到 (x，y) 坐标
@@ -59,7 +64,7 @@ declare class DrawableContext {
 	 * @param {number} y 点的Y轴坐标
 	 */
 	moveTo(x : number, y : number) : void
-	
+
 	/**
 	 * 创建一个矩形路径
 	 * @param {number} x 矩形起点的X轴坐标
@@ -101,10 +106,10 @@ declare class DrawableContext {
 
 	/**
 	 * 填充当前或已存在的路径
-	 * @param {string} fillRule 填充规则，默认为`nonzero`。可选
+	 * @param {string} [fillRule=nonzero] 填充规则。可取值：`nonzero`非零环绕规则；`evenodd`奇偶环绕规则。
 	 */
-	fill(fillRule ?: string) : void
-	
+	fill(fillRule ?: string | null) : void
+
 	/**
 	 * 绘制一个实心矩形
 	 * @param {number} x 矩形起点的X轴坐标
@@ -113,7 +118,7 @@ declare class DrawableContext {
 	 * @param {number} height 矩形高度
 	 */
 	fillRect(x : number, y : number, width : number, height : number) : void
-	
+
 	/**
 	 * 绘制实心字符
 	 * @param {string} text 要绘制的字符
@@ -134,4 +139,25 @@ declare class DrawableContext {
 	 * @param {Array<number>} segments 一组描述交替绘制线段和间距长度的数字。
 	 */
 	setLineDash(segments : Array<number>) : void
+
+	/**
+	 * 根据控制点和半径绘制圆弧路径
+	 * @param {number} x1 第一个控制点的 x 轴坐标
+	 * @param {number} y1 第一个控制点的 y 轴坐标
+	 * @param {number} x2 第二个控制点的 x 轴坐标
+	 * @param {number} y2 第二个控制点的 y 轴坐标
+	 * @param {number} radius 圆弧的半径
+	 */
+	// arcTo(x1 : number, y1 : number, x2 : number, y2 : number, radius : number) : void
+
+	/**
+	 * 创建三次方贝塞尔曲线路径
+	 * @param {number} cp1x 第一个贝塞尔控制点的 x 坐标
+	 * @param {number} cp1y 第一个贝塞尔控制点的 y 坐标
+	 * @param {number} cp2x 第二个贝塞尔控制点的 x 坐标
+	 * @param {number} cp2y 第二个贝塞尔控制点的 y 坐标
+	 * @param {number} x 结束点的 x 坐标
+	 * @param {number} y 结束点的 y 坐标
+	 */
+	bezierCurveTo(cp1x : number, cp1y : number, cp2x : number, cp2y : number, x : number, y : number) : void
 }