@tarojs/taro 3.6.7 → 3.6.9-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tarojs/taro",
-  "version": "3.6.7",
+  "version": "3.6.9-alpha.1",
   "description": "Taro framework",
   "homepage": "https://github.com/nervjs/taro/tree/master/packages/taro#readme",
   "main": "index.js",
@@ -21,11 +21,15 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/api": "3.6.7",
-    "@tarojs/runtime": "3.6.7"
+    "@tarojs/api": "3.6.9-alpha.1",
+    "@tarojs/runtime": "3.6.9-alpha.1"
   },
   "devDependencies": {
-    "@tarojs/helper": "3.6.7"
+    "postcss": "^8.4.18",
+    "@tarojs/helper": "3.6.9-alpha.1"
+  },
+  "peerDependencies": {
+    "postcss": "^8.4.18"
   },
   "peerDependenciesMeta": {
     "@types/react": {

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

@@ -3,7 +3,7 @@ import Taro from '../../index'
 declare module '../../index' {
   interface TaroStatic {
     /** 判断小程序的 API，回调，参数，组件等是否在当前版本可用。
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @example
      * ```tsx
      * Taro.canIUse('openBluetoothAdapter')
@@ -36,7 +36,7 @@ declare module '../../index' {
     ): boolean
 
     /** 判断能否使用 WebP 格式
-     * 
+     *
      * > 在小程序平台中仅在 android 和 devtools 设备时可用
      * @supported global
      */

package/types/api/base/weapp/app-event.d.ts

@@ -259,7 +259,7 @@ declare module '../../../index' {
      */
     offAppHide(
       /** 小程序切后台事件的回调函数 */
-      callback: (res: onAppHide.CallbackResult) => void,
+      callback: (res: onAppShow.CallbackResult) => void,
     ): void
   }
 }

package/types/api/device/calendar.d.ts

@@ -75,12 +75,12 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 向系统日历添加重复事件
-     * @supported weapp
+     * @supported weapp, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/calendar/wx.addPhoneRepeatCalendar.html
      */
     addPhoneRepeatCalendar(option: addPhoneRepeatCalendar.Option): Promise<TaroGeneral.CallbackResult>
     /** 向系统日历添加事件
-     * @supported weapp, tt
+     * @supported weapp, tt, h5
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/calendar/wx.addPhoneCalendar.html
      */
     addPhoneCalendar(option: addPhoneCalendar.Option): Promise<TaroGeneral.CallbackResult>

package/types/api/media/image.d.ts

@@ -127,19 +127,30 @@ declare module '../../index' {
 
   namespace chooseImage {
     interface Option {
+      /** 最多可以选择的图片张数
+       * @default 9
+       * @supported weapp, alipay, swan, tt, h5, rn
+       */
+      count?: number
+      /** 所选的图片的尺寸
+       * @default ['original', 'compressed']
+       * @supported weapp, alipay, swan, tt, rn
+       */
+      sizeType?: Array<keyof sizeType>
+      /** 选择图片的来源
+       * @default ['album', 'camera']
+       * @supported weapp, alipay, swan, tt, h5, rn
+       */
+      sourceType?: Array<keyof sourceType>
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 最多可以选择的图片张数 */
-      count?: number
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 所选的图片的尺寸 */
-      sizeType?: Array<keyof sizeType>
-      /** 选择图片的来源 */
-      sourceType?: Array<keyof sourceType>
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
-      /** 用来上传的input元素ID（仅h5端）@supported h5 */
+      /** 用来上传的input元素ID（仅h5端
+       * @supported h5
+       */
       imageId?: string
     }
     /** 图片的尺寸 */
@@ -301,7 +312,7 @@ declare module '../../index' {
 
   interface TaroStatic {
     /** 保存图片到系统相册。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum
-     * @supported weapp, rn, alipay, swan, tt
+     * @supported weapp, alipay, swan, tt, h5, rn
      * @example
      * ```tsx
      * Taro.saveImageToPhotosAlbum({
@@ -325,7 +336,7 @@ declare module '../../index' {
     previewMedia(option: previewMedia.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。
-     * @supported weapp, h5, rn, alipay, swan, tt
+     * @supported weapp, alipay, swan, tt, h5, rn
      * @example
      * ```tsx
      * Taro.previewImage({
@@ -338,7 +349,7 @@ declare module '../../index' {
     previewImage(option: previewImage.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 获取图片信息。网络图片需先配置download域名才能生效。
-     * @supported weapp, h5, rn, alipay, swan, tt
+     * @supported weapp, alipay, swan, tt, h5, rn
      * @example
      * ```tsx
      * Taro.getImageInfo({
@@ -377,7 +388,7 @@ declare module '../../index' {
     editImage(option: editImage.Option): Promise<editImage.SuccessCallbackResult>
 
     /** 压缩图片接口，可选压缩质量
-     * @supported weapp, rn, tt
+     * @supported weapp, tt, rn
      * @example
      * ```tsx
      * Taro.compressImage({
@@ -408,7 +419,7 @@ declare module '../../index' {
 
     /**
      * 从本地相册选择图片或使用相机拍照。
-     * @supported weapp, h5, rn, alipay, swan, tt
+     * @supported weapp, alipay, swan, tt, h5, rn
      * @example
      * ```tsx
      * Taro.chooseImage({

package/types/api/media/video.d.ts

@@ -233,30 +233,42 @@ declare module '../../index' {
 
   namespace chooseVideo {
     interface Option {
-      /** 默认拉起的是前置或者后置摄像头。部分 Android 手机下由于系统 ROM 不支持无法生效 */
+      /** 默认拉起的是前置或者后置摄像头。部分 Android 手机下由于系统 ROM 不支持无法生效
+       * @default "back"
+       * @supported weapp, h5
+       */
       camera?: keyof Camera
+      /** 是否压缩所选择的视频文件
+       * @default true
+       * @supported weapp
+       */
+      compressed?: boolean
+      /** 拍摄视频最长拍摄时间，单位秒
+       * @default 60
+       * @supported weapp
+       */
+      maxDuration?: number
+      /** 视频选择的来源
+       * @default ['album', 'camera']
+       * @supported weapp, h5
+       */
+      sourceType?: Array<keyof sourceType>
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 是否压缩所选择的视频文件 */
-      compressed?: boolean
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 拍摄视频最长拍摄时间，单位秒 */
-      maxDuration?: number
-      /** 视频选择的来源 */
-      sourceType?: Array<keyof sourceType>
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 选定视频的临时文件路径 */
+      tempFilePath: string
       /** 选定视频的时间长度 */
       duration: number
-      /** 返回选定视频的高度 */
-      height: number
       /** 选定视频的数据量大小 */
       size: number
-      /** 选定视频的临时文件路径 */
-      tempFilePath: string
+      /** 返回选定视频的高度 */
+      height: number
       /** 返回选定视频的宽度 */
       width: number
       /** 调用结果 */
@@ -276,30 +288,53 @@ declare module '../../index' {
     }
   }
 
-
   namespace chooseMedia {
     interface Option {
-      /** 最多可以选择的文件个数 */
+      /** 最多可以选择的文件个数
+       * @default 9
+       * @supported weapp, h5
+       */
       count?: number
-      /** 文件类型 */
+      /** 文件类型
+       * @default ['image', 'video']
+       * @supported weapp, h5
+       */
       mediaType?: Array<keyof mediaType>
-      /** 图片和视频选择的来源 */
+      /** 图片和视频选择的来源
+       * @default ['album', 'camera']
+       * @supported weapp, h5
+       */
       sourceType?: Array<keyof sourceType>
-      /** 拍摄视频最长拍摄时间，单位秒。时间范围为 3s 至 30s 之间 */
+      /** 拍摄视频最长拍摄时间，单位秒。时间范围为 3s 至 60s 之间
+       * @default 10
+       * @supported weapp
+       */
       maxDuration?: number
-      /** 仅对 mediaType 为 image 时有效，是否压缩所选文件 */
+      /** 是否压缩所选文件
+       * @default ['original', 'compressed']
+       * @supported weapp
+       */
       sizeType?: Array<'original' | 'compressed'>
-      /** 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头 */
+      /** 仅在 sourceType 为 camera 时生效，使用前置或后置摄像头
+       * @default "back"
+       * @supported weapp, h5
+       */
       camera?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
+      /** 用来上传的input元素ID
+       * @supported h5
+       */
+      mediaId?: string
     }
     interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 本地临时文件列表 */
       tempFiles: ChooseMedia[]
-      /** 文件类型，有效值有 image 、video */
+      /** 文件类型，有效值有 image 、video、mix */
       type: string
     }
     /** 本地临时文件列表 */
@@ -316,6 +351,12 @@ declare module '../../index' {
       width: number
       /** 视频缩略图临时文件路径 */
       thumbTempFilePath: string
+      /** 选择的文件的类型 */
+      fileType: string
+      /** 原始的浏览器 File 对象
+       * @supported h5
+       */
+      originalFileObj?: File
     }
     interface mediaType {
       /** 只能拍摄视频或从相册选择视频 */
@@ -346,11 +387,11 @@ declare module '../../index' {
      * **Bug & Tip：**
      *
      * 1.  `tip`: camera 参数在部分 Android 手机下由于系统 ROM 不支持无法生效
-     * @supported weapp, rn
+     * @supported weapp, h5, rn
      * @example
      ```tsx
      * Taro.saveVideoToPhotosAlbum({
-     *   filePath: 'wxfile://xxx',
+     *   filePath: 'file://xxx',
      *   success: function (res) {
      *     console.log(res.errMsg)
      *   }
@@ -447,7 +488,7 @@ declare module '../../index' {
     compressVideo(option: compressVideo.Option): Promise<compressVideo.SuccessCallbackResult>
 
     /** 拍摄视频或从手机相册中选视频。
-     * @supported weapp, rn
+     * @supported weapp, h5, rn
      * @example
      * ```tsx
      * Taro.chooseVideo({
@@ -464,7 +505,7 @@ declare module '../../index' {
     chooseVideo(option: chooseVideo.Option): Promise<chooseVideo.SuccessCallbackResult>
 
     /** 拍摄或从手机相册中选择图片或视频。
-     * @supported weapp
+     * @supported weapp, h5
      * @example
      * ```tsx
      * Taro.chooseMedia({

package/types/api/network/request.d.ts

@@ -60,58 +60,61 @@ declare module '../../index' {
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
       complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 设置 H5 端是否使用jsonp方式获取数据
+      /** 设置是否使用 jsonp 方式获取数据
        * @default false
        * @supported h5
        */
-      jsonp?: boolean
-      /** 设置 H5 端 jsonp 请求 url 是否需要被缓存
-       * @default false
+      jsonp?: boolean | string
+      /** 设置 jsonp 请求 url 是否需要被缓存
        * @supported h5
        */
-      jsonpCache?: boolean
-      /** 设置 H5 端是否允许跨域请求
+      jsonpCache?: RequestCache
+      /** 设置是否允许跨域请求
        * @default "same-origin"
        * @supported h5
        */
       mode?: keyof CorsMode
-      /** 设置 H5 端是否携带 Cookie
+      /** 设置是否携带 Cookie
        * @default "omit"
        * @supported h5
        */
       credentials?: keyof Credentials
-      /** 设置 H5 端缓存模式
+      /** 设置缓存模式
        * @default "default"
        * @supported h5
        */
       cache?: keyof Cache
-      /** 设置 H5 端请求重试次数
+      /** 设置请求重试次数
        * @default 2
        * @supported h5
        */
       retryTimes?: number
-      /** 设置 H5 端请求的兜底接口
+      /** 设置请求的兜底接口
        * @supported h5
        */
       backup?: string | string[]
-      /** 设置 H5 端请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
+      /** 设置请求中止信号
+       * @supported h5
+       */
+      signal?: AbortSignal
+      /** 设置请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
        * @supported h5
        */
       dataCheck?(): boolean
-      /** 设置 H5 端请求是否使用缓存
+      /** 设置请求是否使用缓存
        * @default false
        * @supported h5
        */
       useStore?: boolean
-      /** 设置 H5 端请求缓存校验的 key
+      /** 设置请求缓存校验的 key
        * @supported h5
        */
       storeCheckKey?: string
-      /** 设置 H5 端请求缓存签名
+      /** 设置请求缓存签名
        * @supported h5
        */
       storeSign?: string
-      /** 设置 H5 端请求校验函数，一般不需要设置
+      /** 设置请求校验函数，一般不需要设置
        * @supported h5
        */
       storeCheck?(): boolean

package/types/compile/config/project.d.ts

@@ -1,8 +1,9 @@
 import type Webpack from 'webpack'
 import type Chain from 'webpack-chain'
+import { type Input } from 'postcss'
 import type { Compiler } from '../compiler'
 import type { IModifyWebpackChain } from '../hooks'
-import type { ICopyOptions, IOption, ISassOptions, TogglableOptions } from "./util"
+import type { ICopyOptions, IOption, ISassOptions, TogglableOptions } from './util'
 import type { IH5Config } from './h5'
 import type { IMiniAppConfig } from './mini'
 
@@ -22,58 +23,114 @@ interface ILogger {
 export interface IProjectBaseConfig {
   isWatch?: boolean
   port?: number
+  /** 项目名称 */
   projectName?: string
+
+  /** 项目创建日期 */
   date?: string
-  designWidth?: number | ((size?: string | number) => number)
+
+  /** 设计稿尺寸 */
+  designWidth?: number | ((size?: string | number | Input) => number)
+
+  /** 设计稿尺寸换算规则 */
   deviceRatio?: TaroGeneral.TDeviceRatio
+
   watcher?: any[]
+
+  /** 源码存放目录 (默认值：'src') */
   sourceRoot?: string
+
+  /** 代码编译后的生产目录 (默认值：'dist') */
   outputRoot?: string
+
+  /** 用于设置环境变量 (除了NODE_ENV以外，其他环境变量建议在根目录下的.env文件中) */
   env?: IOption
+
+  /** 用于配置目录别名，从而方便书写代码引用路径 */
   alias?: IOption
+
+  /** 用于配置一些全局变量供代码中进行使用（建议放在根目录下的.env文件中） */
   defineConstants?: IOption
+
+  /** 用于把文件从源码目录直接拷贝到编译后的生产目录 */
   copy?: ICopyOptions
+
+  /** 配置 JS 压缩工具 (默认 terser) */
   jsMinimizer?: 'terser' | 'esbuild'
+
+  /** 配置 CSS 压缩工具 (默认 csso) */
   cssMinimizer?: 'csso' | 'esbuild' | 'parcelCss'
+
+  /** 配置 csso 工具以压缩 CSS 代码 */
   csso?: TogglableOptions
+
+  /** 配置 terser 工具以压缩 JS 代码 */
   terser?: TogglableOptions
+
   esbuild?: Record<'minify', TogglableOptions>
+
   uglify?: TogglableOptions
+
+  /** 用于控制对 scss 代码的编译行为，默认使用 dart-sass，具体配置可以参考 https://www.npmjs.com/package/sass */
   sass?: ISassOptions
+
+  /** 配置 Taro 插件 */
   plugins?: PluginItem[]
+
+  /** 一个 preset 是一系列 Taro 插件的集合，配置语法同 plugins */
   presets?: PluginItem[]
+
+  /** 模板循环次数 */
   baseLevel?: number
-  framework?: string
+
+  /** 使用的开发框架。可选值：react、preact、nerv、vue、vue3 */
+  framework?: 'react' | 'preact' | 'nerv' | 'vue' | 'vue3'
   frameworkExts?: string[]
+
+  /** 使用的编译工具。可选值：webpack4、webpack5 */
   compiler?: Compiler
+
+  /** Webpack5 持久化缓存配置。具体配置请参考 [WebpackConfig.cache](https://webpack.js.org/configuration/cache/#cache) */
   cache?: ICache
+
+  /** 控制 Taro 编译日志的输出方式 */
   logger?: ILogger
+
+  /** 用于控制是否生成 js、css 对应的 sourceMap */
   enableSourceMap?: boolean
+
   /**
    * 编译开始
    */
   onBuildStart?: (...args: any[]) => Promise<any>
+
   /**
    * 编译完成（启动项目后首次编译结束后会触发一次）
    */
   onBuildComplete?: (...args: any[]) => Promise<any>
+
   /**
    * 编译结束（保存代码每次编译结束后都会触发）
    */
-  onBuildFinish?: (res: { error, stats, isWatch }) => Promise<any>
+  onBuildFinish?: (res: { error; stats; isWatch }) => Promise<any>
+
   /**
    * 修改编译过程中的页面组件配置
    */
   onCompilerMake?: (compilation: Webpack.Compilation, compiler: Webpack.Compiler, plugin: any) => Promise<any>
+
   onWebpackChainReady?: (webpackChain: Chain) => Promise<any>
+
   /**
    * 编译中修改 webpack 配置，在这个钩子中，你可以对 webpackChain 作出想要的调整，等同于配置 [`webpackChain`](./config-detail#miniwebpackchain)
    */
   modifyWebpackChain?: (chain: Chain, webpack: typeof Webpack, data: IModifyWebpackChain) => Promise<any>
+
   /**
    * 修改编译过程中的页面组件配置
    */
   modifyMiniConfigs?: (configMap: any) => Promise<any>
+
   /**
    * 修改编译后的结果
    */
@@ -81,11 +138,14 @@ export interface IProjectBaseConfig {
 }
 
 export interface IProjectConfig extends IProjectBaseConfig {
-  ui?: {
-    extraWatchFiles?: any[]
-  }
+  /** 专属于小程序的配置 */
   mini?: IMiniAppConfig
+
+  /** 专属于 H5 的配置 */
   h5?: IH5Config
+
+  /** 专属于 RN 的配置 */
   rn?: IH5Config
+
   [key: string]: any
 }

package/types/taro.config.d.ts

@@ -154,6 +154,11 @@ declare module './index' {
      * @default: false
      */
     disableScroll?: boolean
+    /** 是否使用页面全局滚动，MPA下默认为全局滚动，SPA默认为局部滚动
+     * 只在H5生效
+     * @default: MPA:true  SPA:false
+     */
+    usingWindowScroll?: boolean
     /** 禁止页面右滑手势返回
      *
      * **注意** 自微信客户端 7.0.5 开始，页面配置中的 disableSwipeBack 属性将不再生效，
@@ -360,7 +365,9 @@ declare module './index' {
      * @default false
      * @since 2.1.0
      */
-    functionalPages?: boolean
+    functionalPages?: boolean | {
+      independent?: boolean
+    }
     /** 分包结构配置
      * @example
      * ```json