@dcloudio/uni-app-x 0.5.8 → 0.5.10

package/README.md

@@ -1,39 +1 @@
 # 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.5.8",
+  "version": "0.5.10",
   "description": "uni-app x types",
   "typings": "index.d.ts",
   "author": "DCloud",
@@ -22,4 +22,4 @@
     "minimist": "^1.2.8",
     "ts-morph": "^19.0.0"
   }
-}
+}

package/types/native/Element.d.ts

@@ -6,6 +6,11 @@
  * @package io.dcloud.uniapp.runtime
  */
 declare interface Element {
+  /**
+   * 只读属性 获取当前元素的的 class 属性的动态集合。
+   */
+  classList: string[]
+
   /**
    * 只读属性 获取当前元素的的第一个子元素，如果元素是无子元素，则返回 null。
    */

package/types/uni/core/index.d.ts

@@ -2,6 +2,7 @@
 /// <reference path='./lib/performance/index.d.ts' />
 /// <reference path='./lib/lifecycle/index.d.ts' />
 /// <reference path='./lib/ui/tab-bar/index.d.ts' />
+/// <reference path='./lib/ui/set-navigation-bar-title/index.d.ts' />
 /// <reference path='./lib/ui/set-navigation-bar-color/index.d.ts' />
 /// <reference path='./lib/ui/pull-down-refresh/index.d.ts' />
 /// <reference path='./lib/ui/page-scroll-to/index.d.ts' />

package/types/uni/core/lib/base/interceptor/index.d.ts

@@ -1,10 +1,16 @@
 import {
+  Interceptor as InterceptorOrigin,
+  AddInterceptorOptions as AddInterceptorOptionsOrigin,
+  RemoveInterceptorOptions as RemoveInterceptorOptionsOrigin,
   AddInterceptor as AddInterceptorOrigin,
   RemoveInterceptor as RemoveInterceptorOrigin,
   Uni as UniOrigin
 } from './interface'
 
 declare global {
+  type Interceptor = InterceptorOrigin
+  type AddInterceptorOptions = AddInterceptorOptionsOrigin
+  type RemoveInterceptorOptions = RemoveInterceptorOptionsOrigin
   type AddInterceptor = AddInterceptorOrigin
   type RemoveInterceptor = RemoveInterceptorOrigin
   interface Uni extends UniOrigin { }

package/types/uni/core/lib/base/interceptor/interface.d.ts

@@ -1,6 +1,8 @@
-import { Interceptor } from '../../interface'
+import { Interceptor as InterceptorOrigin } from '../../interface'
 
-export type { Interceptor }
+export type Interceptor = InterceptorOrigin
+export type AddInterceptorOptions = Interceptor
+export type RemoveInterceptorOptions = Interceptor
 
 export type AddInterceptor = (name: string, interceptor: Interceptor) => void
 
@@ -10,6 +12,19 @@ export type RemoveInterceptor = (
 ) => void
 
 export interface Uni {
-  addInterceptor: AddInterceptor
-  removeInterceptor: RemoveInterceptor
+  /**
+   * 添加拦截器
+   * @param name 需要拦截的 API 名称
+   * @param interceptor 拦截器
+   */
+  addInterceptor(name: string, interceptor: AddInterceptorOptions): void
+  /**
+   * 删除拦截器
+   * @param name 需要删除拦截器的 API 名称
+   * @param interceptor 拦截器
+   */
+  removeInterceptor(
+    name: string,
+    interceptor?: RemoveInterceptorOptions | null
+  ): void
 }

package/types/uni/core/lib/interface.d.ts

@@ -5,9 +5,24 @@ export type OnLaunchOptions = {
 }
 
 export type Interceptor = {
+  /**
+   * 拦截前触发
+   */
   invoke?: Function | null
+  /**
+   * 方法调用后触发，处理返回值
+   */
   returnValue?: Function | null
+  /**
+   * 成功回调拦截
+   */
   success?: Function | null
+  /**
+   * 失败回调拦截
+   */
   fail?: Function | null
+  /**
+   * 完成回调拦截
+   */
   complete?: Function | null
 }

package/types/uni/core/lib/route/interface.d.ts

@@ -76,7 +76,7 @@ export type NavigateToOptions = {
    *  }
    * }
    */
-  url: string
+  url: string | string.PageURIString
   /**
    * 窗口显示的动画类型
    * - auto: 自动选择动画效果
@@ -543,7 +543,7 @@ export type RedirectToOptions = {
    *  }
    * }
    */
-  url: string
+  url: string | string.PageURIString
   /**
    * 接口调用成功的回调函数
    * @uniPlatform {
@@ -807,7 +807,7 @@ export type ReLaunchOptions = {
    *  }
    * }
    */
-  url: string
+  url: string | string.PageURIString
   /**
    * 接口调用成功的回调函数
    * @uniPlatform {
@@ -1071,7 +1071,7 @@ export type SwitchTabOptions = {
    *  }
    * }
    */
-  url: string
+  url: string | string.PageURIString
   /**
    * 接口调用成功的回调函数
    * @uniPlatform {
@@ -1735,7 +1735,7 @@ export interface Uni {
    *  }
    * }
    */
-  navigateTo(options: NavigateToOptions): void
+  navigateTo(options: NavigateToOptions): Promise<NavigateToSuccess> | null
   /**
    * 关闭当前页面，跳转到应用内的某个页面
    *
@@ -1801,7 +1801,7 @@ export interface Uni {
    *  }
    * }
    */
-  redirectTo(options: RedirectToOptions): void
+  redirectTo(options: RedirectToOptions): Promise<RedirectToSuccess> | null
   /**
    * 关闭所有页面，打开到应用内的某个页面
    *
@@ -1867,7 +1867,7 @@ export interface Uni {
    *  }
    * }
    */
-  reLaunch(options: ReLaunchOptions): void
+  reLaunch(options: ReLaunchOptions): Promise<ReLaunchSuccess> | null
   /**
    * 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
    *
@@ -1933,7 +1933,7 @@ export interface Uni {
    *  }
    * }
    */
-  switchTab(options: SwitchTabOptions): void
+  switchTab(options: SwitchTabOptions): Promise<SwitchTabSuccess> | null
   /**
    * 关闭当前页面，返回上一页面或多级页面
    *
@@ -1999,5 +1999,7 @@ export interface Uni {
    *  }
    * }
    */
-  navigateBack(options?: NavigateBackOptions | null): void
+  navigateBack(
+    options?: NavigateBackOptions | null
+  ): Promise<NavigateBackSuccess> | null
 }

package/types/uni/core/lib/ui/load-font-face/index.d.ts

@@ -1,5 +1,6 @@
 import {
   LoadFontFaceOptionDesc as LoadFontFaceOptionDescOrigin,
+  LoadFontFaceErrCode as LoadFontFaceErrCodeOrigin,
   LoadFontFaceOptions as LoadFontFaceOptionsOrigin,
   LoadFontFaceSuccess as LoadFontFaceSuccessOrigin,
   LoadFontFaceSuccessCallback as LoadFontFaceSuccessCallbackOrigin,
@@ -7,12 +8,12 @@ import {
   LoadFontFaceFailCallback as LoadFontFaceFailCallbackOrigin,
   LoadFontFaceComplete as LoadFontFaceCompleteOrigin,
   LoadFontFaceCompleteCallback as LoadFontFaceCompleteCallbackOrigin,
-  LoadFontFace as LoadFontFaceOrigin,
   Uni as UniOrigin
 } from './interface'
 
 declare global {
   type LoadFontFaceOptionDesc = LoadFontFaceOptionDescOrigin
+  type LoadFontFaceErrCode = LoadFontFaceErrCodeOrigin
   type LoadFontFaceOptions = LoadFontFaceOptionsOrigin
   type LoadFontFaceSuccess = LoadFontFaceSuccessOrigin
   type LoadFontFaceSuccessCallback = LoadFontFaceSuccessCallbackOrigin
@@ -20,6 +21,5 @@ declare global {
   type LoadFontFaceFailCallback = LoadFontFaceFailCallbackOrigin
   type LoadFontFaceComplete = LoadFontFaceCompleteOrigin
   type LoadFontFaceCompleteCallback = LoadFontFaceCompleteCallbackOrigin
-  type LoadFontFace = LoadFontFaceOrigin
   interface Uni extends UniOrigin { }
 }

package/types/uni/core/lib/ui/load-font-face/interface.d.ts

@@ -5,7 +5,29 @@ export type LoadFontFaceOptionDesc = {
   weight: string | null
   variant: string | null
 }
-
+/**
+ * 错误码
+ * - 4: 框架内部异常
+ * - 99: page is not ready
+ * - 101: 参数错误
+ * - 100001: family is null
+ * - 100002: source is null
+ * - 200001: local font not found
+ * - 300001: same source task is loading
+ * - 300002: download fail
+ */
+export type LoadFontFaceErrCode =
+  | 4
+  | 99
+  | 101
+  | 100001
+  | 100002
+  | 200001
+  | 300001
+  | 300002
+export abstract class LoadFontFaceError extends UniError {
+  abstract override errCode: LoadFontFaceErrCode
+}
 export type LoadFontFaceOptions = {
   /**
    * 是否全局生效。微信小程序 '2.10.0'起支持全局生效，需在 app.vue 中调用。
@@ -460,14 +482,12 @@ export type LoadFontFaceOptions = {
 export type LoadFontFaceSuccess = AsyncApiSuccessResult
 export type LoadFontFaceSuccessCallback = (result: LoadFontFaceSuccess) => void
 
-export type LoadFontFaceFail = UniError
-export type LoadFontFaceFailCallback = (error: LoadFontFaceFail) => void
+export type LoadFontFaceFail = LoadFontFaceError
+export type LoadFontFaceFailCallback = (error: LoadFontFaceError) => void
 
 export type LoadFontFaceComplete = AsyncApiResult
 export type LoadFontFaceCompleteCallback = (res: LoadFontFaceComplete) => void
 
-export type LoadFontFace = (options: LoadFontFaceOptions) => void
-
 export interface Uni {
   /**
    * 动态加载网络字体
@@ -534,5 +554,7 @@ export interface Uni {
    *  }
    * }
    */
-  loadFontFace(options: LoadFontFaceOptions): void
+  loadFontFace(
+    options: LoadFontFaceOptions
+  ): Promise<LoadFontFaceSuccess> | null
 }

package/types/uni/core/lib/ui/page-scroll-to/interface.d.ts

@@ -130,5 +130,7 @@ export interface Uni {
    *  }
    * }
    */
-  pageScrollTo(options: PageScrollToOptions): void
+  pageScrollTo(
+    options: PageScrollToOptions
+  ): Promise<PageScrollToSuccess> | null
 }

package/types/uni/core/lib/ui/pull-down-refresh/interface.d.ts

@@ -44,7 +44,9 @@ export interface Uni {
    *
    * @tutorial http://uniapp.dcloud.io/api/ui/pulldown?id=startpulldownrefresh
    */
-  startPullDownRefresh(options?: StartPullDownRefreshOptions | null): void
+  startPullDownRefresh(
+    options?: StartPullDownRefreshOptions | null
+  ): Promise<StartPullDownRefreshSuccess> | null
   /**
    * 停止当前页面下拉刷新
    *

package/types/uni/core/lib/ui/set-navigation-bar-color/interface.d.ts

@@ -96,8 +96,8 @@ export type SetNavigationBarColorOptions = {
    *        "unixVer": "x"
    *    },
    *    "alipay": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
+   *        "hostVer": "x",
+   *        "uniVer": "x",
    *        "unixVer": "x"
    *    },
    *    "baidu": {
@@ -160,8 +160,8 @@ export type SetNavigationBarColorOptions = {
    *        "unixVer": "x"
    *    },
    *    "alipay": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
+   *        "hostVer": "x",
+   *        "uniVer": "x",
    *        "unixVer": "x"
    *    },
    *    "baidu": {
@@ -224,8 +224,8 @@ export type SetNavigationBarColorOptions = {
    *        "unixVer": "x"
    *    },
    *    "alipay": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
+   *        "hostVer": "x",
+   *        "uniVer": "x",
    *        "unixVer": "x"
    *    },
    *    "baidu": {
@@ -288,8 +288,8 @@ export type SetNavigationBarColorOptions = {
    *        "unixVer": "x"
    *    },
    *    "alipay": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
+   *        "hostVer": "x",
+   *        "uniVer": "x",
    *        "unixVer": "x"
    *    },
    *    "baidu": {
@@ -355,7 +355,7 @@ export interface Uni {
   /**
    * 设置导航条、状态栏颜色
    *
-   * @tutorial http://uniapp.dcloud.io/api/ui/navigationbar?id=setnavigationbarcolor
+   * @tutorial https://uniapp.dcloud.net.cn/uni-app-x/api/set-navigation-bar-color.html
    * @uniPlatform {
    *  "app": {
    *    "android": {
@@ -376,8 +376,8 @@ export interface Uni {
    *        "unixVer": "x"
    *    },
    *    "alipay": {
-   *        "hostVer": "√",
-   *        "uniVer": "√",
+   *        "hostVer": "x",
+   *        "uniVer": "x",
    *        "unixVer": "x"
    *    },
    *    "baidu": {
@@ -417,5 +417,7 @@ export interface Uni {
    *  }
    * }
    */
-  setNavigationBarColor(options: SetNavigationBarColorOptions): void
+  setNavigationBarColor(
+    options: SetNavigationBarColorOptions
+  ): Promise<SetNavigationBarColorSuccess> | null
 }

package/types/uni/core/lib/ui/set-navigation-bar-title/index.d.ts

@@ -0,0 +1,23 @@
+import {
+  SetNavigationBarTitleOptions as SetNavigationBarTitleOptionsOrigin,
+  SetNavigationBarTitleSuccess as SetNavigationBarTitleSuccessOrigin,
+  SetNavigationBarTitleSuccessCallback as SetNavigationBarTitleSuccessCallbackOrigin,
+  SetNavigationBarTitleFail as SetNavigationBarTitleFailOrigin,
+  SetNavigationBarTitleFailCallback as SetNavigationBarTitleFailCallbackOrigin,
+  SetNavigationBarTitleComplete as SetNavigationBarTitleCompleteOrigin,
+  SetNavigationBarTitleCompleteCallback as SetNavigationBarTitleCompleteCallbackOrigin,
+  SetNavigationBarTitle as SetNavigationBarTitleOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type SetNavigationBarTitleOptions = SetNavigationBarTitleOptionsOrigin
+  type SetNavigationBarTitleSuccess = SetNavigationBarTitleSuccessOrigin
+  type SetNavigationBarTitleSuccessCallback = SetNavigationBarTitleSuccessCallbackOrigin
+  type SetNavigationBarTitleFail = SetNavigationBarTitleFailOrigin
+  type SetNavigationBarTitleFailCallback = SetNavigationBarTitleFailCallbackOrigin
+  type SetNavigationBarTitleComplete = SetNavigationBarTitleCompleteOrigin
+  type SetNavigationBarTitleCompleteCallback = SetNavigationBarTitleCompleteCallbackOrigin
+  type SetNavigationBarTitle = SetNavigationBarTitleOrigin
+  interface Uni extends UniOrigin { }
+}