@dcloudio/uni-app-x 0.1.2 → 0.3.0

package/.env

@@ -0,0 +1 @@
+UNI_CORE_DIR = "/Users/guoshengqiang/Documents/vuejs-core/packages/runtime-uts/src/extapi"

package/index.d.ts

@@ -1,2 +1 @@
-/// <reference path='./native/index.d.ts' />
-/// <reference path='./vue/index.d.ts' />
+/// <reference path='./types/index.d.ts' />

package/package.json

@@ -1,8 +1,18 @@
 {
   "name": "@dcloudio/uni-app-x",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "uni-app x types",
   "typings": "index.d.ts",
   "author": "DCloud",
-  "license": "Apache-2.0"
+  "license": "Apache-2.0",
+  "type": "module",
+  "scripts": {
+    "build:types": "node ./scripts/build-types.js"
+  },
+  "devDependencies": {
+    "delete": "^1.1.0",
+    "dotenv": "^16.3.1",
+    "fs-extra": "^11.1.1",
+    "glob": "^10.3.3"
+  }
 }

package/types/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference path='./native/index.d.ts' />
+/// <reference path='./vue/index.d.ts' />
+/// <reference path='./uni/index.d.ts' />
+/// <reference path='./uni-cloud/index.d.ts' />

package/{native → types/native}/CustomEvent.d.ts

@@ -1,10 +1,16 @@
 /// <reference path="./Event.d.ts" />
 
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
 declare class CustomEventOptions<T>{
   detail: T
   constructor (detail: T)
 }
 
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
 declare class CustomEvent<T> extends Event {
   constructor (type: string, options: CustomEventOptions<T>)
 }

package/types/native/DrawableContext.d.ts

@@ -0,0 +1,46 @@
+/// <reference path='./INode.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+
+declare class DrawableContext {
+	font : string
+	fillStyle : string
+	lineCap : string
+	lineDashOffset : number
+	lineJoin : string
+	lineWidth : number
+	strokeStyle : string
+	textAlign : string
+
+	beginPath() : void
+
+	arc(x : number, y : number, radius : number, startAngle : number, endAngle : number, anticlockwise ?: boolean) : void
+
+	moveTo(x : number, y : number) : void
+
+	rect(x : number, y : number, width : number, height : number) : void
+
+	lineTo(x : number, y : number) : void
+
+	closePath() : void
+
+	stroke() : void
+
+	strokeRect(x : number, y : number, width : number, height : number) : void
+
+	strokeText(text : string, x : number, y : number) : void
+
+	fill(fillRule ?: string) : void
+
+	fillRect(x : number, y : number, width : number, height : number) : void
+
+	fillText(text : string, x : number, y : number) : void
+
+	reset() : void
+
+	update() : void
+
+	setLineDash(segments : Array<number>) : void
+}

package/{native → types/native}/IPageManager.d.ts

@@ -1,5 +1,8 @@
 /// <reference path='./IPage.d.ts' />
 
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
 declare class IPageManager {
   createPage(
     pageUrl: String,

package/types/native/RefresherEvent.d.ts

@@ -0,0 +1,10 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class RefresherEvent extends Event {
+  detail: {
+    dy: number
+  }
+}

package/{native → types/native}/ResizeEvent.d.ts

@@ -1,3 +1,5 @@
+/// <reference path='./Event.d.ts' />
+
 /**
  * @package io.dcloud.uniapp.runtime
  */

package/types/native/ScrollEvent.d.ts

@@ -0,0 +1,15 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class ScrollEvent extends Event {
+  detail: {
+    scrollTop: number
+    scrollLeft: number
+    scrollHeight: number
+    scrollWidth: number
+    deltaY: number
+    deltaX: number
+  }
+}

package/types/native/ScrollToLowerEvent.d.ts

@@ -0,0 +1,10 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class ScrollToLowerEvent extends Event {
+  detail: {
+    direction: string
+  }
+}

package/types/native/ScrollToUpperEvent.d.ts

@@ -0,0 +1,10 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class ScrollToUpperEvent extends Event {
+  detail: {
+    direction: string
+  }
+}

package/{native → types/native}/index.d.ts

@@ -1,6 +1,5 @@
 /// <reference path='./CustomEvent.d.ts' />
 /// <reference path='./Event.d.ts' />
-/// <reference path='./Event.d.ts' />
 /// <reference path='./IApp.d.ts' />
 /// <reference path='./IDocument.d.ts' />
 /// <reference path='./INode.d.ts' />
@@ -11,7 +10,11 @@
 /// <reference path='./NodeData.d.ts' />
 /// <reference path='./PageEvent.d.ts' />
 /// <reference path='./PageScrollEvent.d.ts' />
+/// <reference path='./RefresherEvent.d.ts' />
 /// <reference path='./ResizeEvent.d.ts' />
+/// <reference path='./ScrollEvent.d.ts' />
+/// <reference path='./ScrollToLowerEvent.d.ts' />
+/// <reference path='./ScrollToUpperEvent.d.ts' />
 /// <reference path='./TabTapEvent.d.ts' />
 /// <reference path='./TouchEvent.d.ts' />
 /// <reference path='./UniAppManager.d.ts' />

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

@@ -0,0 +1,3 @@
+interface Uni { }
+
+declare const uni: Uni

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

@@ -0,0 +1,9 @@
+/// <reference path='./lib/base/event/index.d.ts' />
+/// <reference path='./lib/lifecycle/index.d.ts' />
+/// <reference path='./lib/route/index.d.ts' />
+/// <reference path='./lib/ui/create-selector-query/index.d.ts' />
+/// <reference path='./lib/ui/load-font-face/index.d.ts' />
+/// <reference path='./lib/ui/page-scroll-to/index.d.ts' />
+/// <reference path='./lib/ui/pull-down-refresh/index.d.ts' />
+/// <reference path='./lib/ui/set-navigation-bar-color/index.d.ts' />
+/// <reference path='./lib/ui/tab-bar/index.d.ts' />

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

@@ -0,0 +1,15 @@
+import {
+  $On as $OnOrigin,
+  $Once as $OnceOrigin,
+  $Off as $OffOrigin,
+  $Emit as $EmitOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type $On = $OnOrigin
+  type $Once = $OnceOrigin
+  type $Off = $OffOrigin
+  type $Emit = $EmitOrigin
+  interface Uni extends UniOrigin { }
+}

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

@@ -0,0 +1,40 @@
+// @ts-expect-error
+type AnyCallback = Function<unknown>
+
+type $OnCallback = AnyCallback
+export type $On = (eventName: string, callback: $OnCallback) => void
+
+type $OnceCallback = AnyCallback
+export type $Once = (eventName: string, callback: $OnceCallback) => void
+
+type $OffCallback = AnyCallback
+export type $Off = (eventName: string, callback: $OffCallback) => void
+
+export type $Emit = (eventName: string, args: any | null) => void
+
+export interface Uni {
+  /**
+   * 监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。
+   *
+   * @tutorial http://uniapp.dcloud.io/api/window/communication?id=on
+   */
+  $on: $On
+  /**
+   * 移除自定义事件监听器。如果没有指定事件名，则移除所有事件监听器。如果提供事件名，则移除该事件的所有监听器。如果提供了事件名和回调，则只移除这个回调的监听器。
+   *
+   * @tutorial http://uniapp.dcloud.io/api/window/communication?id=off
+   */
+  $off: $Off
+  /**
+   * 监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。
+   *
+   * @tutorial http://uniapp.dcloud.io/api/window/communication?id=once
+   */
+  $once: $Once
+  /**
+   * 触发自定义事件，附加的参数会传递给事件监听器。
+   *
+   * @tutorial http://uniapp.dcloud.io/api/window/communication?id=emit
+   */
+  $emit: $Emit
+}

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

@@ -0,0 +1,16 @@
+export interface AsyncApiResult {
+  errMsg: string
+}
+
+export interface AsyncApiSuccessResult extends AsyncApiResult {}
+
+export interface UniError extends AsyncApiResult {
+  errCode: number
+  errSubject: string
+  data: any | null
+  cause: any | null
+}
+
+export type OnLaunchOptions = {
+  path: string
+}

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

@@ -0,0 +1,9 @@
+import {
+  GetLaunchOptionsSync as GetLaunchOptionsSyncOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type GetLaunchOptionsSync = GetLaunchOptionsSyncOrigin
+  interface Uni extends UniOrigin { }
+}

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

@@ -0,0 +1,12 @@
+import { OnLaunchOptions } from '../interface'
+
+export type GetLaunchOptionsSync = () => OnLaunchOptions
+
+export interface Uni {
+  /**
+   * 获取本次启动时的参数。返回值与App.onLaunch的回调参数一致
+   *
+   * @tutorial http://uniapp.dcloud.io/api/plugins/getLaunchOptionsSync
+   */
+  getLaunchOptionsSync: GetLaunchOptionsSync
+}

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

@@ -0,0 +1,65 @@
+import {
+  NavigateTo as NavigateToOrigin,
+  EventChannel as EventChannelOrigin,
+  NavigateToSuccess as NavigateToSuccessOrigin,
+  NavigateToFail as NavigateToFailOrigin,
+  NavigateToComplete as NavigateToCompleteOrigin,
+  NavigateToOptions as NavigateToOptionsOrigin,
+  RedirectTo as RedirectToOrigin,
+  RedirectToSuccess as RedirectToSuccessOrigin,
+  RedirectToFail as RedirectToFailOrigin,
+  RedirectToComplete as RedirectToCompleteOrigin,
+  RedirectToOptions as RedirectToOptionsOrigin,
+  ReLaunch as ReLaunchOrigin,
+  ReLaunchSuccess as ReLaunchSuccessOrigin,
+  ReLaunchFail as ReLaunchFailOrigin,
+  ReLaunchComplete as ReLaunchCompleteOrigin,
+  ReLaunchOptions as ReLaunchOptionsOrigin,
+  SwitchTab as SwitchTabOrigin,
+  SwitchTabSuccess as SwitchTabSuccessOrigin,
+  SwitchTabSuccessCallback as SwitchTabSuccessCallbackOrigin,
+  SwitchTabFail as SwitchTabFailOrigin,
+  SwitchTabFailCallback as SwitchTabFailCallbackOrigin,
+  SwitchTabComplete as SwitchTabCompleteOrigin,
+  SwitchTabCompleteCallback as SwitchTabCompleteCallbackOrigin,
+  SwitchTabOptions as SwitchTabOptionsOrigin,
+  NavigateBack as NavigateBackOrigin,
+  NavigateBackSuccess as NavigateBackSuccessOrigin,
+  NavigateBackFail as NavigateBackFailOrigin,
+  NavigateBackComplete as NavigateBackCompleteOrigin,
+  NavigateBackOptions as NavigateBackOptionsOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type NavigateTo = NavigateToOrigin
+  type EventChannel = EventChannelOrigin
+  type NavigateToSuccess = NavigateToSuccessOrigin
+  type NavigateToFail = NavigateToFailOrigin
+  type NavigateToComplete = NavigateToCompleteOrigin
+  type NavigateToOptions = NavigateToOptionsOrigin
+  type RedirectTo = RedirectToOrigin
+  type RedirectToSuccess = RedirectToSuccessOrigin
+  type RedirectToFail = RedirectToFailOrigin
+  type RedirectToComplete = RedirectToCompleteOrigin
+  type RedirectToOptions = RedirectToOptionsOrigin
+  type ReLaunch = ReLaunchOrigin
+  type ReLaunchSuccess = ReLaunchSuccessOrigin
+  type ReLaunchFail = ReLaunchFailOrigin
+  type ReLaunchComplete = ReLaunchCompleteOrigin
+  type ReLaunchOptions = ReLaunchOptionsOrigin
+  type SwitchTab = SwitchTabOrigin
+  type SwitchTabSuccess = SwitchTabSuccessOrigin
+  type SwitchTabSuccessCallback = SwitchTabSuccessCallbackOrigin
+  type SwitchTabFail = SwitchTabFailOrigin
+  type SwitchTabFailCallback = SwitchTabFailCallbackOrigin
+  type SwitchTabComplete = SwitchTabCompleteOrigin
+  type SwitchTabCompleteCallback = SwitchTabCompleteCallbackOrigin
+  type SwitchTabOptions = SwitchTabOptionsOrigin
+  type NavigateBack = NavigateBackOrigin
+  type NavigateBackSuccess = NavigateBackSuccessOrigin
+  type NavigateBackFail = NavigateBackFailOrigin
+  type NavigateBackComplete = NavigateBackCompleteOrigin
+  type NavigateBackOptions = NavigateBackOptionsOrigin
+  interface Uni extends UniOrigin { }
+}

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

@@ -0,0 +1,208 @@
+import { AsyncApiResult, AsyncApiSuccessResult, UniError } from '../interface'
+
+export type NavigateTo = (options: NavigateToOptions) => void
+/**
+ *
+ * @tutorial http://uniapp.dcloud.io/api/router.html#event-channel
+ */
+export type EventChannel = {}
+export type NavigateToSuccess = AsyncApiSuccessResult
+type NavigateToSuccessCallback = (result: NavigateToSuccess) => void
+export type NavigateToFail = UniError
+
+type NavigateToFailCallback = (result: NavigateToFail) => void
+export type NavigateToComplete = AsyncApiResult
+type NavigateToCompleteCallback = (result: NavigateToComplete) => void
+export type NavigateToOptions = {
+  /**
+   * 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数
+   */
+  url: string
+  /**
+   * 窗口显示的动画类型
+   * - auto: 自动选择动画效果
+   * - none: 无动画效果
+   * - slide-in-right: 从右侧横向滑动效果
+   * - slide-in-left: 左侧横向滑动效果
+   * - slide-in-top: 从上侧竖向滑动效果
+   * - slide-in-bottom: 从下侧竖向滑动效果
+   * - fade-in: 从透明到不透明逐渐显示效果
+   * - zoom-out: 从小到大逐渐放大显示效果
+   * - zoom-fade-out: 从小到大逐渐放大并且从透明到不透明逐渐显示效果
+   * - pop-in: 从右侧平移入栈动画效果
+   * - UnionType => 'auto' | 'none' | 'slide-in-right' | 'slide-in-left' | 'slide-in-top' | 'slide-in-bottom' | 'fade-in' | 'zoom-out' | 'zoom-fade-out' | 'pop-in'
+   */
+  animationType?: string | null
+  /**
+   * 窗口显示动画的持续时间，单位为 ms
+   */
+  animationDuration?: number | null
+  /**
+   * 页面间通信接口，用于监听被打开页面发送到当前页面的数据
+   */
+  events?: any | null
+  /**
+   * 接口调用成功的回调函数
+   */
+  success?: NavigateToSuccessCallback | null
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail?: NavigateToFailCallback | null
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete?: NavigateToCompleteCallback | null
+}
+export type RedirectTo = (options: RedirectToOptions) => void
+export type RedirectToSuccess = AsyncApiSuccessResult
+type RedirectToSuccessCallback = (result: AsyncApiSuccessResult) => void
+export type RedirectToFail = UniError
+type RedirectToFailCallback = (result: RedirectToFail) => void
+export type RedirectToComplete = AsyncApiResult
+type RedirectToCompleteCallback = (result: RedirectToComplete) => void
+export type RedirectToOptions = {
+  /**
+   * 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数
+   */
+  url: string
+  /**
+   * 接口调用成功的回调函数
+   */
+  success?: RedirectToSuccessCallback | null
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail?: RedirectToFailCallback | null
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete?: RedirectToCompleteCallback | null
+}
+export type ReLaunch = (options: ReLaunchOptions) => void
+export type ReLaunchSuccess = AsyncApiSuccessResult
+type ReLaunchSuccessCallback = (result: ReLaunchSuccess) => void
+export type ReLaunchFail = UniError
+type ReLaunchFailCallback = (result: ReLaunchFail) => void
+export type ReLaunchComplete = AsyncApiResult
+type ReLaunchCompleteCallback = (result: ReLaunchComplete) => void
+export type ReLaunchOptions = {
+  /**
+   * 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数
+   */
+  url: string
+  /**
+   * 接口调用成功的回调函数
+   */
+  success?: ReLaunchSuccessCallback | null
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail?: ReLaunchFailCallback | null
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete?: ReLaunchCompleteCallback | null
+}
+export type SwitchTab = (options: SwitchTabOptions) => void
+export type SwitchTabSuccess = AsyncApiSuccessResult
+export type SwitchTabSuccessCallback = (result: SwitchTabSuccess) => void
+export type SwitchTabFail = UniError
+export type SwitchTabFailCallback = (result: SwitchTabFail) => void
+export type SwitchTabComplete = AsyncApiResult
+export type SwitchTabCompleteCallback = (result: SwitchTabComplete) => void
+export type SwitchTabOptions = {
+  /**
+   * 需要跳转的 tabBar 页面的路径，路径后不能带参数
+   */
+  url: string
+  /**
+   * 接口调用成功的回调函数
+   */
+  success?: SwitchTabSuccessCallback | null
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail?: SwitchTabFailCallback | null
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete?: SwitchTabCompleteCallback | null
+}
+export type NavigateBack = (options: NavigateBackOptions) => void
+export type NavigateBackSuccess = AsyncApiSuccessResult
+type NavigateBackSuccessCallback = (result: NavigateBackSuccess) => void
+export type NavigateBackFail = UniError
+type NavigateBackFailCallback = (result: NavigateBackFail) => void
+export type NavigateBackComplete = AsyncApiResult
+type NavigateBackCompleteCallback = (result: NavigateBackComplete) => void
+export type NavigateBackOptions = {
+  /**
+   * 返回的页面数，如果 delta 大于现有页面数，则返回到首页
+   */
+  delta?: number | null
+  /**
+   * 窗口关闭的动画类型
+   * - auto: 自动选择动画效果
+   * - none: 无动画效果
+   * - slide-out-right: 横向向右侧滑出屏幕动画
+   * - slide-out-left: 横向向左侧滑出屏幕动画
+   * - slide-out-top: 竖向向上侧滑出屏幕动画
+   * - slide-out-bottom: 竖向向下侧滑出屏幕动画
+   * - fade-out: 从不透明到透明逐渐隐藏动画
+   * - zoom-in: 从大逐渐缩小关闭动画
+   * - zoom-fade-in: 从大逐渐缩小并且从不透明到透明逐渐隐藏关闭动画
+   * - pop-out: 从右侧平移出栈动画效果
+   * - UnionType => 'auto' | 'none' | 'slide-out-right' | 'slide-out-left' | 'slide-out-top' | 'slide-out-bottom' | 'fade-out' | 'zoom-in' | 'zoom-fade-in' | 'pop-out'
+   */
+  animationType?: string | null
+  /**
+   * 窗口关闭动画的持续时间，单位为 ms
+   */
+  animationDuration?: number | null
+  /**
+   * 接口调用成功的回调函数
+   */
+  success?: NavigateBackSuccessCallback | null
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail?: NavigateBackFailCallback | null
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete?: NavigateBackCompleteCallback | null
+}
+
+export interface Uni {
+  /**
+   * 保留当前页面，跳转到应用内的某个页面
+   *
+   * @tutorial http://uniapp.dcloud.io/api/router?id=navigateto
+   */
+  navigateTo: NavigateTo
+  /**
+   * 关闭当前页面，跳转到应用内的某个页面
+   *
+   * @tutorial http://uniapp.dcloud.io/api/router?id=redirectto
+   */
+  redirectTo: RedirectTo
+  /**
+   * 关闭所有页面，打开到应用内的某个页面
+   *
+   * @tutorial http://uniapp.dcloud.io/api/router?id=relaunch
+   */
+  reLaunch: ReLaunch
+  /**
+   * 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
+   *
+   * @tutorial http://uniapp.dcloud.io/api/router?id=switchtab
+   */
+  switchTab: SwitchTab
+  /**
+   * 关闭当前页面，返回上一页面或多级页面
+   *
+   * @tutorial http://uniapp.dcloud.io/api/router?id=navigateback
+   */
+  navigateBack: NavigateBack
+}

package/types/uni/core/lib/ui/create-selector-query/index.d.ts

@@ -0,0 +1,15 @@
+import {
+  CreateSelectorQuery as CreateSelectorQueryOrigin,
+  SelectorQueryNodeInfoCallback as SelectorQueryNodeInfoCallbackOrigin,
+  NodeInfo as NodeInfoOrigin,
+  NodeField as NodeFieldOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type CreateSelectorQuery = CreateSelectorQueryOrigin
+  type SelectorQueryNodeInfoCallback = SelectorQueryNodeInfoCallbackOrigin
+  type NodeInfo = NodeInfoOrigin
+  type NodeField = NodeFieldOrigin
+  interface Uni extends UniOrigin { }
+}