@tarojs/taro 4.0.0-canary.8 → 4.0.0

package/types/index.d.ts

@@ -3,51 +3,64 @@
  *
  * 目录结构
  * ├── api                                  小程序端能力 API
- * │   ├── ad
+ * │   ├── ad
  * │   │   └── index.d.ts                   广告 API
- * │   ├── alipay
+ * │   ├── ai
+ * │   │   ├── face.d.ts                    人脸检测 API
+ * │   │   ├── inference.d.ts               AI 推理 API
+ * │   │   └── visionkit.d.ts               视觉算法 API
+ * │   ├── alipay
  * │   │   └── index.d.ts                   支付宝小程序 API
- * │   ├── base
+ * │   ├── base
  * │   │   ├── index.d.ts                   基础 API
+ * │   │   ├── crypto.d.ts                  基础 -> 加密 API
  * │   │   ├── debug.d.ts                   基础 -> 调试 API
+ * │   │   ├── env.d.ts                     基础 -> ENV
+ * │   │   ├── performance.d.ts
  * │   │   ├── system.d.ts                  基础 -> 系统 API
- * │   │   ├── update.d.ts                  基础 -> 更新 API
- * │   │   ├── weapp                        基础 -> 小程序 API
- * │   │   │   ├── life-cycle.d.ts          基础 -> 小程序 API -> 生命周期
- * │   │   │   └── app-event.d.ts           基础 -> 小程序 API -> 应用级事件
- * │   │   └── env.d.ts                     基础 -> ENV
- * │   ├── canvas
+ * │   │   ├── update.d.ts                  基础 -> 更新 API
+ * │   │   └── weapp                        基础 -> 小程序 API
+ * │   │       ├── app-event.d.ts           基础 -> 小程序 API -> 应用级事件
+ * │   │       └── life-cycle.d.ts          基础 -> 小程序 API -> 生命周期
+ * │   ├── canvas
  * │   │   └── index.d.ts                   画布 API
- * │   ├── cloud
+ * │   ├── cloud
  * │   │   └── index.d.ts                   微信小程序云开发 API
- * │   ├── device
+ * │   ├── data-analysis
+ * │   │   └── index.d.ts                   数据分析 API
+ * │   ├── device
  * │   │   ├── accelerometer.d.ts           设备 -> 加速计 API
+ * │   │   ├── accessibility.d.ts           设备 -> 无障碍 API
  * │   │   ├── battery.d.ts                 设备 -> 电量 API
- * │   │   ├── ble.d.ts                     设备 -> 低功耗蓝牙 API
- * │   │   ├── bluetooth.d.                 设备 -> 蓝牙 API
+ * │   │   ├── bluetooth-ble.d.ts           设备 -> 蓝牙-低功耗中心设备 API
+ * │   │   ├── bluetooth-peripheral.d.ts    设备 -> 蓝牙-低功耗外围设备 API
+ * │   │   ├── bluetooth.d.ts               设备 -> 蓝牙-通用 API
+ * │   │   ├── calendar.d.ts                设备 -> 日历 API
  * │   │   ├── clipboard.d.ts               设备 -> 剪贴板 API
  * │   │   ├── compass.d.ts                 设备 -> 罗盘 API
  * │   │   ├── contact.d.ts                 设备 -> 联系人 API
- * │   │   ├── motion.d.ts                  设备 -> 设备方向 API
  * │   │   ├── gyroscope.d.ts               设备 -> 陀螺仪 API
  * │   │   ├── iBeacon.d.ts                 设备 -> iBeacon API
- * │   │   ├── network.d.ts                 设备 -> 网络 API
- * │   │   ├── nfc.d.ts                     设备 -> NFC API
- * │   │   ├── performance.d.ts             设备 -> 性能 API
+ * │   │   ├── keyboard.d.ts                设备 -> 键盘 API
+ * │   │   ├── memory.d.ts                  设备 -> 内存 API
+ * │   │   ├── motion.d.ts                  设备 -> 设备方向 API
+ * │   │   ├── network.d.ts                 设备 -> 网络 API
+ * │   │   ├── nfc.d.ts                     设备 -> NFC 读写 API
  * │   │   ├── phone.d.ts                   设备 -> 电话 API
  * │   │   ├── scan.d.ts                    设备 -> 扫码 API
  * │   │   ├── screen.d.ts                  设备 -> 屏幕 API
+ * │   │   ├── sms.d.ts                     设备 -> 短信 API
  * │   │   ├── vibrate.d.ts                 设备 -> 振动 API
  * │   │   └── wifi.d.ts                    设备 -> Wi-Fi API
- * │   ├── ext
+ * │   ├── ext
  * │   │   └── index.d.ts                   第三方平台 API
- * │   ├── files
+ * │   ├── files
  * │   │   └── index.d.ts                   文件 API
- * │   ├── framework
+ * │   ├── framework
  * │   │   └── index.d.ts                   小程序框架 API
- * │   ├── location
+ * │   ├── location
  * │   │   └── index.d.ts                   位置 API
- * │   ├── media
+ * │   ├── media
  * │   │   ├── audio.d.ts                   媒体 -> 音频 API
  * │   │   ├── background-audio.d.ts        媒体 -> 背景音频 API
  * │   │   ├── camera.d.ts                  媒体 -> 相机 API
@@ -55,51 +68,72 @@
  * │   │   ├── image.d.ts                   媒体 -> 图片 API
  * │   │   ├── live.d.ts                    媒体 -> 实时音视频 API
  * │   │   ├── map.d.ts                     媒体 -> 地图 API
+ * │   │   ├── media-recorder.d.ts          媒体 -> 画面录制器 API
  * │   │   ├── recorder.d.ts                媒体 -> 录音 API
- * │   │   ├── video.d.ts                   媒体 -> 视频 API
+ * │   │   ├── video-decoder.d.ts           媒体 -> 视频解码器 API
  * │   │   └── video-processing.d.ts        媒体 -> 音视频合成 API
- * │   ├── network
+ * │   │   ├── video.d.ts                   媒体 -> 视频 API
+ * │   │   └── voip.d.ts                    媒体 -> 实时语音 API
+ * │   ├── navigate
+ * │   │   └── index.d.ts                   跳转 API
+ * │   ├── network
  * │   │   ├── download.d.ts                网络 -> 下载 API
  * │   │   ├── mdns.d.ts                    网络 -> mDNS API
  * │   │   ├── request.d.ts                 网络 -> 发起请求 API
+ * │   │   ├── tcp.d.ts                     网络 -> TCP 通信 API
  * │   │   ├── udp.d.ts                     网络 -> UDP 通信 API
  * │   │   ├── upload.d.ts                  网络 -> 上传 API
  * │   │   └── websocket.d.ts               网络 -> WebSocket API
- * │   ├── open-api
+ * │   ├── open-api
  * │   │   ├── account.d.ts                 开放接口 -> 账号信息 API
  * │   │   ├── address.d.ts                 开放接口 -> 收货地址 API
  * │   │   ├── authorize.d.ts               开放接口 -> 授权 API
  * │   │   ├── card.d.ts                    开放接口 -> 卡券 API
- * │   │   ├── data-analysis.d.ts           开放接口 -> 数据分析 API
+ * |   |   ├── channels.d.ts                开放接口 -> 视频号 API
+ * |   |   ├── customer-service.d.ts        开放接口 -> 微信客服 API
+ * |   |   ├── device-voip.d.ts             开放接口 -> 音视频通话 API
  * │   │   ├── facial.d.ts                  开放接口 -> 人脸识别 API // 在微信小程序文档已找不到
+ * │   │   ├── favorites.d.ts               开放接口 -> 收藏 API
+ * │   │   ├── group.d.ts                   开放接口 -> 微信群 API
  * │   │   ├── invoice.d.ts                 开放接口 -> 发票 API
+ * │   │   ├── license-plate.d.ts           开放接口 -> 车牌 API
  * │   │   ├── login.d.ts                   开放接口 -> 登录 API
- * │   │   ├── navigate.d.ts                开放接口 -> 小程序跳转 API
- * │   │   ├── payment.d.ts                 开放接口 -> 支付 API
- * │   │   ├── report.d.ts                  开放接口 -> 数据上报 API
+ * │   │   ├── my-miniprogram.d.ts          开放接口 -> 我的小程序 API
+ * │   │   ├── privacy.d.ts                 开放接口 -> 隐私信息授权 API
+ * │   │   ├── redpackage.d.ts              开放接口 -> 微信红包 API
  * │   │   ├── settings.d.ts                开放接口 -> 设置 API
  * │   │   ├── soter.d.ts                   开放接口 -> 生物认证 API
+ * │   │   ├── sticker.d.ts                 开放接口 -> 微信表情 API
  * |   |   ├── subscribe-message.d.ts       开放接口 -> 订阅消息 API
  * │   │   ├── user-info.d.ts               开放接口 -> 用户信息 API
- * │   │   ├── customer-service.d.ts        开放接口 -> 微信客服 API
  * │   │   └── werun.d.ts                   开放接口 -> 微信运动 API
- * │   ├── route
+ * │   ├── payment
+ * │   │   └── index.d.ts                   支付 API
+ * │   ├── qq
+ * │   │   └── index.d.ts                   QQ 小程序 API
+ * │   ├── route
  * │   │   └── index.d.ts                   路由 API
- * │   ├── share
+ * │   ├── share
  * │   │   └── index.d.ts                   转发 API
- * │   ├── skyline
+ * │   ├── skyline
  * │   │   └── index.d.ts                   微信 Skyline API
- * │   ├── storage
+ * │   ├── storage
  * │   │   ├── background-fetch.d.ts        数据缓存 -> 后台获取 API
- * │   │   └── index.d.ts                   数据缓存 API
- * │   ├── swan
+ * │   │   ├── cache-manager.d.ts           数据缓存 -> 缓存管理 API
+ * │   │   └── index.d.ts                   数据缓存 API
+ * │   ├── swan
+ * │   │   ├── bookshelf.d.ts               百度小程序 -> 书架 API
+ * │   │   ├── download-package.d.ts        百度小程序 -> 下载包 API
  * │   │   └── index.d.ts                   百度小程序 API
- * │   ├── ui
+ * │   │   └── pay.d.ts                     百度小程序 -> 支付 API
+ * │   ├── taro.extend.d.ts                 Taro 扩展 API 类型定义
+ * │   ├── taro.hooks.d.ts                  Taro Hooks 类型定义
+ * │   ├── ui
  * │   │   ├── animation.d.ts               界面 -> 动画 API
  * │   │   ├── background.d.ts              界面 -> 背景 API
  * │   │   ├── custom-component.d.ts        界面 -> 自定义组件 API
  * │   │   ├── fonts.d.ts                   界面 -> 字体 API
- * │   │   ├── keyboard.d.ts                界面 -> 键盘 API
+ * │   │   ├── interaction.d.ts             界面 -> 交互 API
  * │   │   ├── menu.d.ts                    界面 -> 菜单 API
  * │   │   ├── navigation-bar.d.ts          界面 -> 导航栏 API
  * │   │   ├── pull-down-refresh.d.ts       界面 -> 下拉刷新 API
@@ -107,14 +141,25 @@
  * │   │   ├── sticky.d.ts                  界面 -> 置顶 API
  * │   │   ├── tab-bar.d.ts                 界面 -> TabBar API
  * │   │   ├── window.d.ts                  界面 -> 窗口 API
- * │   │   └── interaction.d.ts             界面 -> 交互 API
- * │   ├── worker
+ * │   ├── worker
  * │   │   └── index.d.ts                   Worker API
- * │   ├── wxml
+ * │   └── wxml
  * │   │   └── index.d.ts                   WXML API
- * │   ├── taro.extend.d.ts                 Taro 扩展 API 类型定义
- * │   └── taro.hooks.d.ts                  Taro Hooks 类型定义
+ * ├── compile
+ * │   ├── compiler.d.ts
+ * │   ├── config
+ * │   │   ├── h5.d.ts
+ * │   │   ├── index.d.ts
+ * │   │   ├── manifest.d.ts
+ * │   │   ├── mini.d.ts
+ * │   │   ├── project.d.ts
+ * │   │   ├── rn.d.ts
+ * │   │   └── util.d.ts
+ * │   ├── hooks.d.ts                       Taro Hooks 类型定义
+ * │   └── index.d.ts
+ * ├── global.d.ts
  * ├── index.d.ts                           此文件
+ * ├── taro.api.d.ts
  * ├── taro.component.d.ts                  Taro Component 类型定义
  * ├── taro.config.d.ts                      Taro 小程序 App 与 Window 设置类型定义
  * └── taro.lifecycle.d.ts                  Taro 生命周期类型定义
@@ -126,6 +171,7 @@
 /// <reference path="taro.component.d.ts" />
 /// <reference path="taro.config.d.ts" />
 /// <reference path="taro.lifecycle.d.ts" />
+/// <reference path="taro.runtime.d.ts" />
 
 /// <reference types="@tarojs/plugin-platform-alipay/types/shims-alipay" />
 /// <reference types="@tarojs/plugin-platform-jd/types/shims-jd" />
@@ -141,10 +187,9 @@ export as namespace Taro
 declare const Taro: Taro.TaroStatic
 
 declare namespace Taro {
-  // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface TaroStatic {}
 }
 declare global {
-  const defineAppConfig: (config: Taro.Config) => Taro.Config
-  const definePageConfig: (config: Taro.Config) => Taro.Config
+  const defineAppConfig: (config: Taro.AppConfig) => Taro.AppConfig
+  const definePageConfig: (config: Taro.PageConfig) => Taro.Config
 }

package/types/taro.api.d.ts

@@ -59,26 +59,30 @@
 /// <reference path="api/media/video-decoder.d.ts" />
 /// <reference path="api/location/index.d.ts" />
 /// <reference path="api/files/index.d.ts" />
-/// <reference path="api/open-api/login.d.ts" />
+
 /// <reference path="api/open-api/account.d.ts" />
-/// <reference path="api/open-api/user-info.d.ts" />
-/// <reference path="api/open-api/authorize.d.ts" />
-/// <reference path="api/open-api/settings.d.ts" />
 /// <reference path="api/open-api/address.d.ts" />
+/// <reference path="api/open-api/authorize.d.ts" />
 /// <reference path="api/open-api/card.d.ts" />
-/// <reference path="api/open-api/invoice.d.ts" />
-/// <reference path="api/open-api/soter.d.ts" />
-/// <reference path="api/open-api/werun.d.ts" />
-/// <reference path="api/open-api/subscribe-message.d.ts" />
-/// <reference path="api/open-api/redpackage.d.ts" />
-/// <reference path="api/open-api/favorites.d.ts" />
-/// <reference path="api/open-api/my-miniprogram.d.ts" />
-/// <reference path="api/open-api/license-plate.d.ts" />
 /// <reference path="api/open-api/channels.d.ts" />
+/// <reference path="api/open-api/customer-service.d.ts" />
 /// <reference path="api/open-api/device-voip.d.ts" />
+/// <reference path="api/open-api/facial.d.ts" />
+/// <reference path="api/open-api/favorites.d.ts" />
 /// <reference path="api/open-api/group.d.ts" />
+/// <reference path="api/open-api/invoice.d.ts" />
+/// <reference path="api/open-api/license-plate.d.ts" />
+/// <reference path="api/open-api/login.d.ts" />
+/// <reference path="api/open-api/my-miniprogram.d.ts" />
 /// <reference path="api/open-api/privacy.d.ts" />
-/// <reference path="api/open-api/customer-service.d.ts" />
+/// <reference path="api/open-api/redpackage.d.ts" />
+/// <reference path="api/open-api/settings.d.ts" />
+/// <reference path="api/open-api/soter.d.ts" />
+/// <reference path="api/open-api/sticker.d.ts" />
+/// <reference path="api/open-api/subscribe-message.d.ts" />
+/// <reference path="api/open-api/user-info.d.ts" />
+/// <reference path="api/open-api/werun.d.ts" />
+
 /// <reference path="api/device/bluetooth.d.ts" />
 /// <reference path="api/device/bluetooth-ble.d.ts" />
 /// <reference path="api/device/bluetooth-peripheral.d.ts" />
@@ -112,11 +116,15 @@
 /// <reference path="api/skyline/index.d.ts" />
 
 /// <reference path="api/cloud/index.d.ts" />
-/// <reference path="api/open-api/facial.d.ts" />
 
 /// <reference path="api/alipay/index.d.ts" />
 /// <reference path="api/qq/index.d.ts" />
+
+/// <reference path="api/swan/bookshelf.d.ts" />
+/// <reference path="api/swan/download-package.d.ts" />
 /// <reference path="api/swan/index.d.ts" />
+/// <reference path="api/swan/pay.d.ts" />
+
 
 /// <reference path="api/taro.extend.d.ts" />
 /// <reference path="api/taro.hooks.d.ts" />

package/types/taro.component.d.ts

@@ -19,6 +19,7 @@ declare module './index' {
     shareTicket: string | undefined
     scene: number | undefined
     exitState?: any
+    $taroPath?: string
   }
 
   interface Show {
@@ -139,5 +140,7 @@ declare module './index' {
     path?: string
     /** 页面的组件选项 */
     options?: Record<string, unknown>
+    /** 获得一个 EventChannel 对象，用于页面间通讯 */
+    getOpenerEventChannel?(): Record<string, any>
   }
 }

package/types/taro.config.d.ts

@@ -10,9 +10,11 @@ declare module './index' {
      */
     navigationBarBackgroundColor?: string
     /** 导航栏标题颜色，仅支持 black/white
+     * 当 app.json 中配置 darkmode 为 true 时可通过变量的形式配置
+     * @see: https://developers.weixin.qq.com/miniprogram/dev/framework/ability/darkmode.html
      * @default: "white"
      */
-    navigationBarTextStyle?: 'white' | 'black'
+    navigationBarTextStyle?: 'white' | 'black' | string
     /** 导航栏标题文字内容 */
     navigationBarTitleText?: string
     /** 导航栏样式，仅支持以下值：
@@ -30,10 +32,17 @@ declare module './index' {
      * @default: "#ffffff"
      */
     backgroundColor?: string
+    /** 页面容器背景色， HexColor
+     * @see: https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/skyline/custom-route.html#%E8%AE%BE%E7%BD%AE%E9%A1%B5%E9%9D%A2%E9%80%8F%E6%98%8E
+     * @default: "#ffffff"
+     */
+    backgroundColorContent?: string
     /** 下拉背景字体、loading 图的样式，仅支持 dark/light
+     * 当 app.json 中配置 darkmode 为 true 时可通过变量的形式配置
+     * @see: https://developers.weixin.qq.com/miniprogram/dev/framework/ability/darkmode.html
      * @default: "dark"
      */
-    backgroundTextStyle?: 'dark' | 'light'
+    backgroundTextStyle?: 'dark' | 'light' | string
     /** 顶部窗口的背景色，仅 iOS 支持
      * @default: "#ffffff"
      */
@@ -420,7 +429,7 @@ declare module './index' {
     decodeQuery?: 'disable'
   }
 
-  interface AppConfig {
+  export interface AppConfig {
     /** 小程序默认启动首页，未指定 entryPagePath 时，数组的第一项代表小程序的初始页面（首页）。 */
     entryPagePath?: string
     /** 接受一个数组，每一项都是字符串，来指定小程序由哪些页面组成，数组的第一项代表小程序的初始页面 */
@@ -557,7 +566,7 @@ declare module './index' {
      */
     themeLocation?: string
     /** 配置自定义组件代码按需注入 */
-    lazyCodeLoading?: string
+    lazyCodeLoading?: 'requiredComponents' | string
     /** 单页模式相关配置 */
     singlePage?: SinglePage
     /** 聊天素材小程序打开相关配置

package/types/taro.lifecycle.d.ts

@@ -56,9 +56,12 @@ declare module './index' {
   }
 
   interface PageResizeObject {
+    deviceOrientation?: 'portrait' | 'landscape'
     size: {
       windowWidth: number
       windowHeight: number
+      screenWidth?: number
+      screenHeight?: number
     }
   }
 

package/types/taro.runtime.d.ts

@@ -0,0 +1,9 @@
+import type { options } from '@tarojs/runtime'
+
+import Taro from './index'
+
+declare module './index' {
+  interface TaroStatic {
+    options: typeof options
+  }
+}