@tarojs/taro 3.7.0-alpha.6 → 3.7.0-alpha.8

package/package.json

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

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

@@ -42,7 +42,7 @@ declare module '../../index' {
     namespace getLatestUserKey {
       interface Option {
         /** 接口调用成功的回调函数 */
-        success?: (res: TaroGeneral.CallbackResult) => void
+        success?: (res: SuccessCallbackResult) => void
         /** 接口调用失败的回调函数 */
         fail?: (res: TaroGeneral.CallbackResult) => void
         /** 接口调用结束的回调函数（调用成功、失败都会执行） */

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

@@ -2,7 +2,7 @@ import Taro from '../../index'
 
 declare module '../../index' {
   namespace request {
-    interface Option <T = any, U extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any > {
+    interface Option<T = any, U extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any> {
       /** 开发者服务器接口地址 */
       url: string
       /** 请求的参数 */
@@ -14,11 +14,11 @@ declare module '../../index' {
       header?: TaroGeneral.IAnyObject
       /** 超时时间，单位为毫秒
        * @default 2000
-       * @supported weapp, h5, tt
+       * @supported weapp, h5, tt, alipay
        */
       timeout?: number
       /** HTTP 请求方法
-       * @default GET
+       * @default "GET"
        */
       method?: keyof Method
       /** 返回的数据格式 */
@@ -54,6 +54,25 @@ declare module '../../index' {
        * @supported weapp
        */
       enableChunked?: boolean
+      /**
+       * wifi下使用移动网络发送请求
+       * @default false
+       * @supported weapp
+       */
+      forceCellularNetwork?: boolean
+      /**
+       * headers 中设置 cookie 字段是否生效。如果为 false，则 headers 中的 cookie 字段将被忽略，请求头中将包含服务端上一次返回的 cookie（如果有）。
+       * @default false
+       * @supported alipay 支付宝: 10.2.33+
+       */
+      enableCookie?: boolean
+      /**
+       * referer 策略，用于控制当前请求 header 对象中 referer 字段格式。该参数默认值可通过 app.json 中的配置进行修改。
+       * @default "querystring"
+       * @supported alipay 支付宝: 10.3.50+ APPX: 2.8.7 开发者工具: 3.5.1
+       * @see https://opendocs.alipay.com/mini/api/owycmh#referrerStrategy%20%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E
+       */
+      referrerStrategy?: keyof ReferrerStrategy
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult<T>) => void
       /** 接口调用失败的回调函数 */
@@ -87,10 +106,12 @@ declare module '../../index' {
       /** 设置请求重试次数
        * @default 2
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       retryTimes?: number
       /** 设置请求的兜底接口
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       backup?: string | string[]
       /** 设置请求中止信号
@@ -99,19 +120,23 @@ declare module '../../index' {
       signal?: AbortSignal
       /** 设置请求响应的数据校验函数，若返回 false，则请求兜底接口，若无兜底接口，则报请求失败
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       dataCheck?(): boolean
       /** 设置请求是否使用缓存
        * @default false
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       useStore?: boolean
       /** 设置请求缓存校验的 key
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       storeCheckKey?: string
       /** 设置请求缓存签名
        * @supported h5
+       * @h5 仅在 jsonp 模式下生效
        */
       storeSign?: string
       /** 设置请求校验函数，一般不需要设置
@@ -120,7 +145,8 @@ declare module '../../index' {
       storeCheck?(): boolean
     }
 
-    interface SuccessCallbackResult < T extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any > extends TaroGeneral.CallbackResult {
+    interface SuccessCallbackResult<T extends string | TaroGeneral.IAnyObject | ArrayBuffer = any | any>
+      extends TaroGeneral.CallbackResult {
       /** 开发者服务器返回的数据 */
       data: T
       /** 开发者服务器返回的 HTTP Response Header */
@@ -135,10 +161,26 @@ declare module '../../index' {
 
     /** 返回的数据格式 */
     interface DataType {
-      /** 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse
+      /**
+       * 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse
        * 其他: 不对返回的内容进行 JSON.parse
        */
       json
+      /**
+       * 返回的数据为文本字符串
+       * @supported alipay
+       */
+      text
+      /**
+       * 返回的数据将转换为 base64 格式字符串
+       * @supported alipay
+       */
+      base64
+      /**
+       * 返回的数据将保持 ArrayBuffer 数据
+       * @supported alipay 支付宝: 10.1.70+
+       */
+      arraybuffer
     }
 
     /** HTTP 请求方法 */
@@ -202,6 +244,21 @@ declare module '../../index' {
       /** 浏览器在其HTTP缓存中寻找匹配的请求 */
       'only-if-cached'
     }
+    /** referer 策略 */
+    interface ReferrerStrategy {
+      /**
+       * referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html
+       */
+      index
+      /**
+       * 保留 page（pages/xxx/yyy），referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html#{page}
+       */
+      page
+      /**
+       * 默认值。会将发起请求时所在页面的 URL 作为 referer 值，会保留 page（pages/xxx/yyy）和 querystring（x=1&y=2）并可能有框架添加的其他参数，referer 值为 https://{appid}.hybrid.alipay-eco.com/{appid}/{version}/index.html#{page}?{querysrtring}{框架其他参数}
+       */
+      querystring
+    }
   }
 
   /** 网络请求任务对象
@@ -269,7 +326,7 @@ declare module '../../index' {
      */
     onHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: RequestTask.onHeadersReceived.Callback,
+      callback: RequestTask.onHeadersReceived.Callback
     ): void
     /** 取消监听 HTTP Response Header 事件
      * @supported weapp
@@ -277,7 +334,7 @@ declare module '../../index' {
      */
     offHeadersReceived(
       /** HTTP Response Header 事件的回调函数 */
-      callback: RequestTask.onHeadersReceived.Callback,
+      callback: RequestTask.onHeadersReceived.Callback
     ): void
     /** 监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。
      * @supported weapp
@@ -285,7 +342,7 @@ declare module '../../index' {
      */
     onChunkReceived(
       /** Transfer-Encoding Chunk Received 事件的回调函数 */
-      callback: RequestTask.onChunkReceived.Callback,
+      callback: RequestTask.onChunkReceived.Callback
     ): void
     /** 移除 Transfer-Encoding Chunk Received 事件的监听函数
      * @supported weapp
@@ -293,7 +350,7 @@ declare module '../../index' {
      */
     offChunkReceived(
       /** Transfer-Encoding Chunk Received 事件的回调函数 */
-      callback: RequestTask.onChunkReceived.Callback,
+      callback: RequestTask.onChunkReceived.Callback
     ): void
   }
 

package/types/api/open-api/address.d.ts

@@ -4,32 +4,34 @@ declare module '../../index' {
   namespace chooseAddress {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
+      complete?: (res: SuccessCallbackResult) => void
       /** 接口调用失败的回调函数 */
       fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
 
-    interface SuccessCallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 收货人姓名 */
+      userName: string
+      /** 邮编 */
+      postalCode: string
+      /** 国标收货地址第一级地址 */
+      provinceName: string
       /** 国标收货地址第二级地址 */
       cityName: string
       /** 国标收货地址第三级地址 */
       countyName: string
+      /** 国标收货地址第四级地址 */
+      streetName: string
       /** 详细收货地址信息 */
       detailInfo: string
-      /** 错误信息 */
-      errMsg: string
+      /** 新选择器详细收货地址信息 */
+      detailInfoNew: string
       /** 收货地址国家码 */
       nationalCode: string
-      /** 邮编 */
-      postalCode: string
-      /** 国标收货地址第一级地址 */
-      provinceName: string
       /** 收货人手机号码 */
       telNumber: string
-      /** 收货人姓名 */
-      userName: string
     }
   }
 

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

@@ -200,7 +200,7 @@ declare module '../../index' {
      * Taro.downloadFile({
      *   url: 'https://res.wx.qq.com/wxdoc/dist/assets/img/demo.ef5c5bef.jpg',
      *   success: (res) => {
-     *     wx.showShareImageMenu({
+     *     Taro.showShareImageMenu({
      *       path: res.tempFilePath
      *     })
      *   }

package/types/api/taro.extend.d.ts

@@ -31,11 +31,11 @@ declare module '../index' {
   namespace setGlobalDataPlugin {
     /** Vue3 插件，用于设置 `getApp()` 中的全局变量 */
     interface Plugin {
-      install (app: any, data: any): void
+      install(app: any, data: any): void
     }
   }
 
-    /** @ignore */
+  /** @ignore */
   interface TARO_ENV_TYPE {
     [TaroGeneral.ENV_TYPE.WEAPP]: TaroGeneral.ENV_TYPE.WEAPP
     [TaroGeneral.ENV_TYPE.WEB]: TaroGeneral.ENV_TYPE.WEB
@@ -56,7 +56,7 @@ declare module '../index' {
     type InterceptorifyInterceptor<T, R> = (chain: InterceptorifyChain<T, R>) => Promise<R>
     interface Interceptorify<T, R> {
       request(requestParams: T): Promise<R>
-      addInterceptor( interceptor: InterceptorifyInterceptor<T, R>): void
+      addInterceptor(interceptor: InterceptorifyInterceptor<T, R>): void
       cleanInterceptors(): void
     }
   }
@@ -101,6 +101,29 @@ declare module '../index' {
      */
     getAppInfo(): getAppInfo.AppInfo
 
+    getEnvInfoSync(): {
+      /** 小程序信息 */
+      microapp: {
+        /** 小程序版本号 */
+        mpVersion: string
+        /** 小程序环境 */
+        envType: string
+        /** 小程序appId */
+        appId: string
+      }
+      /** 插件信息 */
+      plugin: Record<string, unknown>
+      /** 通用参数 */
+      common: {
+        /** 用户数据存储的路径 */
+        USER_DATA_PATH: string
+        /** 校验白名单属性中的appInfoLaunchFrom后返回额外信息 */
+        location: string | undefined
+        launchFrom: string | undefined
+        schema: string | undefined
+      }
+    }
+
     /** 小程序引用插件 JS 接口
      * @supported weapp, alipay, h5, rn, jd, qq, swan, tt, quickapp
      */
@@ -130,7 +153,7 @@ declare module '../index' {
     setGlobalDataPlugin: setGlobalDataPlugin.Plugin
 
     /** 获取自定义 TabBar 对应的 React 或 Vue 组件实例
-     * @supported weapp
+     * @supported weapp, jd
      * @param page 小程序页面对象，可以通过 Taro.getCurrentInstance().page 获取
      */
     getTabBar<T>(page: getCurrentInstance.Current['page']): T | undefined

package/types/api/ui/navigation-bar.d.ts

@@ -85,7 +85,7 @@ declare module '../../index' {
     showNavigationBarLoading(option?: showNavigationBarLoading.Option): void
 
     /** 动态设置当前页面的标题
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, h5, rn, tt
      * @example
      * ```tsx
      * Taro.setNavigationBarTitle({

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

@@ -0,0 +1,23 @@
+export interface IHarmonyConfig {
+  /** Harmony 项目地址 */
+  projectPath: string
+
+  /** hap 名
+   * @default "entry"
+   */
+  hapName?: string
+
+  /** 应用名称
+   * @default "default"
+   */
+  name?: string
+
+  /** 用于告诉 Taro 编译器需要抽取的公共文件 */
+  commonChunks?: string[] | ((commonChunks: string[]) => string[])
+
+  /** Harmony 编译过程的相关配置 */
+  compile?: {
+    exclude?: any[]
+    include?: any[]
+  }
+}

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

@@ -1,4 +1,5 @@
 export * from './h5'
+export * from './harmony'
 export * from './mini'
 
 export * from './manifest'

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

@@ -19,6 +19,9 @@ export interface IMiniAppConfig {
   /** 指定 React 框架相关的代码是否使用开发环境（未压缩）代码，默认使用生产环境（压缩后）代码 */
   debugReact?: boolean
 
+  /** 是否跳过第三方依赖 usingComponent 的处理，默认为自动处理第三方依赖的自定义组件 */
+  skipProcessUsingComponents?: boolean
+
   /** 压缩小程序 xml 文件的相关配置 */
   minifyXML?: {
     /** 是否合并 xml 文件中的空格 (默认false) */
@@ -39,7 +42,7 @@ export interface IMiniAppConfig {
     /**
      * 编译前清空输出目录
      * @since Taro v3.6.9
-     * @description 
+     * @description
      * - 默认清空输出目录，可设置 clean: false 不清空
      * - 可设置 clean: { keep: ['project.config.json'] } 保留指定文件
      * - 注意 clean.keep 不支持函数
@@ -98,3 +101,10 @@ export interface IMiniAppConfig {
   /** 插件内部使用 */
   runtime?: Runtime
 }
+
+export interface IMiniFilesConfig {
+  [configName: string]: {
+    content: Config
+    path: string
+  }
+}

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

@@ -2,13 +2,13 @@ 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 { IModifyChainData } from '../hooks'
 import type { ICopyOptions, IOption, ISassOptions, TogglableOptions } from './util'
 import type { IH5Config } from './h5'
-import type { IMiniAppConfig } from './mini'
-import { IRNConfig } from './rn'
+import type { IMiniAppConfig, IMiniFilesConfig } from './mini'
+import type { IRNConfig } from './rn'
 
-export type PluginItem = string | [string, object] | [string, () => object | Promise<object>]
+export type PluginItem<T = object> = string | [string, T] | [string, () => T | Promise<T>]
 
 interface ICache {
   /**
@@ -179,21 +179,27 @@ export interface IProjectBaseConfig {
   /**
    * 编译中修改 webpack 配置，在这个钩子中，你可以对 webpackChain 作出想要的调整，等同于配置 [`webpackChain`](./config-detail#miniwebpackchain)
    */
-  modifyWebpackChain?: (chain: Chain, webpack: typeof Webpack, data: IModifyWebpackChain) => Promise<any>
+  modifyWebpackChain?: (chain: Chain, webpack: typeof Webpack, data: IModifyChainData) => Promise<any>
 
   /**
    * 编译中修改 vite 配置
    */
-  modifyViteConfig?: (viteConfig: any, componentConfig: IModifyWebpackChain['componentConfig']) => void
+  modifyViteConfig?: (viteConfig: any, data: IModifyChainData) => void
+
+  /**
+   * 修改编译后的结果
+   */
+  modifyBuildAssets?: (assets: any, miniPlugin?: any) => Promise<any>
+
   /**
    * 修改编译过程中的页面组件配置
    */
-  modifyMiniConfigs?: (configMap: any) => Promise<any>
+  modifyMiniConfigs?: (configMap: IMiniFilesConfig) => Promise<any>
 
   /**
-   * 修改编译后的结果
+   * 修改 Taro 编译配置
    */
-  modifyBuildAssets?: (assets: any, miniPlugin?: any) => Promise<any>
+  modifyRunnerOpts?: (opts: any) => Promise<any>
 }
 
 /** 暴露出来给 config/index 使用的配置类型，参考 https://github.com/NervJS/taro-doctor/blob/main/assets/config_schema.json */

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

@@ -6,7 +6,7 @@ import type { IOption, IPostcssOption } from './util'
 
 export interface IRNConfig {
   /** 设置 RN bundle 中注册应用的名称 */
-  appName: string
+  appName?: string
 
   /** entry 利用模块查找规则{name}.{platform}.{ext}自动区分平台 */
   entry?: string
@@ -53,4 +53,12 @@ export interface IRNConfig {
 
   /** 将 svg 文件转换为组件引入。默认值 false，不开启 */
   enableSvgTransform?: boolean
+
+  alias?: IOption
+
+  /** 设计稿尺寸 */
+  designWidth?: number | ((size?: string | number | Input) => number)
+
+  /** 设计稿尺寸换算规则 */
+  deviceRatio?: TaroGeneral.TDeviceRatio
 }

package/types/compile/hooks.d.ts

@@ -8,6 +8,6 @@ export interface IComponentConfig {
   includeAll: boolean
 }
 
-export interface IModifyWebpackChain {
+export interface IModifyChainData {
   componentConfig?: IComponentConfig
 }

package/types/taro.config.d.ts

@@ -215,6 +215,22 @@ declare module './index' {
      * @default "webview"
      */
     renderer?: 'webview' | 'skyline'
+    /**
+     * 组件框架
+     * @default "exparser"
+     * @see https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/glass-easel/migration.html
+     */
+    componentFramework?: 'exparser' | 'glass-easel'
+    /**
+     * 指定特殊的样式隔离选项
+     *
+     * isolated 表示启用样式隔离，在自定义组件内外，使用 class 指定的样式将不会相互影响（一般情况下的默认值）
+     *
+     * apply-shared 表示页面 wxss 样式将影响到自定义组件，但自定义组件 wxss 中指定的样式不会影响页面
+     *
+     * shared 表示页面 wxss 样式将影响到自定义组件，自定义组件 wxss 中指定的样式也会影响页面和其他设置了 apply-shared 或 shared 的自定义组件。（这个选项在插件中不可用。）
+     */
+    styleIsolation?: 'isolated' | 'apply-shared' | 'shared'
     /**
      * 设置导航栏额外图标，目前支持设置属性 icon，值为图标 url（以 https/http 开头）或 base64 字符串，大小建议 30*30 px
      *
@@ -345,6 +361,34 @@ declare module './index' {
     delay?: number
   }
 
+  interface RenderOptions {
+    skyline: {
+      /**
+       * 开启默认Block布局
+       * @see https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/skyline/wxss.html#%E5%BC%80%E5%90%AF%E9%BB%98%E8%AE%A4Block%E5%B8%83%E5%B1%80
+       */
+      defaultDisplayBlock?: boolean
+      /**
+       * 关闭 Skyline AB 实验
+       * @see https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/skyline/migration/release.html#%E5%8F%91%E5%B8%83%E4%B8%8A%E7%BA%BF
+       */
+      disableABTest?: boolean
+    }
+  }
+
+  interface Behavior {
+    /**
+     * 使用小程序默认分享功能时（即不显式设置 Page.onShareAppMessage），当设置此字段后，会使客户端生成的用于分享的 scheme 带上当前用户打开的页面所携带的 query 参数。
+     * @supported alipay 基础库 2.7.10 及以上开始支持，同时需使用 IDE 2.7.0 及以上版本进行构建。
+     */
+    shareAppMessage?: 'appendQuery'
+    /**
+     * 小程序在解析全局参数、页面参数时默认会对键/值做 encodeURIComponent。当设置为 disable 后，则不再对键/值做encodeURIComponent
+     * @supported alipay 基础库 2.7.19 及以上开始支持，同时需使用 IDE 3.0.0 及以上版本进行构建。
+     */
+    decodeQuery?: 'disable'
+  }
+
   interface AppConfig {
     /** 小程序默认启动首页，未指定 entryPagePath 时，数组的第一项代表小程序的初始页面（首页）。 */
     entryPagePath?: string
@@ -365,9 +409,11 @@ declare module './index' {
      * @default false
      * @since 2.1.0
      */
-    functionalPages?: boolean | {
-      independent?: boolean
-    }
+    functionalPages?:
+      | boolean
+      | {
+          independent?: boolean
+        }
     /** 分包结构配置
      * @example
      * ```json
@@ -388,7 +434,7 @@ declare module './index' {
      * 使用 Worker 处理多线程任务时，设置 Worker 代码放置的目录
      * @since 1.9.90
      */
-    workers?: string
+    workers?: string | string[]
     /** 申明需要后台运行的能力，类型为数组。目前支持以下项目：
      * - audio: 后台音乐播放
      * - location: 后台定位
@@ -555,6 +601,42 @@ declare module './index' {
      * @default "webview"
      */
     renderer?: 'webview' | 'skyline'
+    /**
+     * 渲染后端选项
+     * @see https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#rendererOptions
+     */
+    rendererOptions?: RenderOptions
+    /**
+     * 指定小程序使用的组件框架
+     * @default "exparser"
+     * @see https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/glass-easel/migration.html
+     */
+    componentFramework?: 'exparser' | 'glass-easel'
+    /**
+     * 多端模式场景接入身份管理服务时开启小程序授权页相关配置
+     * @see https://dev.weixin.qq.com/docs/framework/getting_started/auth.html#%E6%96%B0%E6%89%8B%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B
+     */
+    miniApp?: {
+      /**
+       * 用于 wx.weixinMinProgramLogin 在小程序中插入「小程序授权 Page」
+       */
+      useAuthorizePage: boolean
+    }
+    /**
+     * 正常情况下默认所有资源文件都被打包发布到所有平台，可以通过 static 字段配置特定每个目录/文件只能发布到特定的平台(多端场景)
+     * @see https://dev.weixin.qq.com/docs/framework/guideline/devtools/condition-compile.html#%E8%B5%84%E6%BA%90
+     */
+    static?: { pattern: string; platforms: string[] }[]
+    /**
+     * 	动态插件配置规则,声明小程序需要使用动态插件
+     * @supported alipay
+     */
+    useDynamicPlugins?: boolean
+    /**
+     * 用于改变小程序若干运行行为
+     * @supported alipay
+     */
+    behavior?: Behavior
   }
 
   interface Config extends PageConfig, AppConfig {