@tarojs/taro 3.6.5 → 3.7.0-alpha.0

package/package.json

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

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

@@ -1730,28 +1730,31 @@ declare module '../../index' {
 
     /** 创建 canvas 的绘图上下文 [CanvasContext](/docs/apis/canvas/CanvasContext) 对象
      *
-     * **Tip**: 需要指定 canvasId，该绘图上下文只作用于对应的 `<canvas/>`
+     * **Tip**: 需要指定 canvasId，该绘图上下文只作用于对应的 `<canvas/>`；另外，Web 端需要在 `useReady` 回调中执行它，否则会因为底层 canvas 渲染出来之前而去获取 CanvasContext，导致其底层的 context 为 `undefined`，从而不能正常绘图。
      * @supported weapp, h5
      * @example
      * ```tsx
-     * const context = Taro.createCanvasContext('canvas')
+     * import { useReady } from '@tarojs/taro'
      *
-     * context.setStrokeStyle("#00ff00")
-     * context.setLineWidth(5)
-     * context.rect(0, 0, 200, 200)
-     * context.stroke()
-     * context.setStrokeStyle("#ff0000")
-     * context.setLineWidth(2)
-     * context.moveTo(160, 100)
-     * context.arc(100, 100, 60, 0, 2 * Math.PI, true)
-     * context.moveTo(140, 100)
-     * context.arc(100, 100, 40, 0, Math.PI, false)
-     * context.moveTo(85, 80)
-     * context.arc(80, 80, 5, 0, 2 * Math.PI, true)
-     * context.moveTo(125, 80)
-     * context.arc(120, 80, 5, 0, 2 * Math.PI, true)
-     * context.stroke()
-     * context.draw()
+     * useReady(() => {
+     *   const context = Taro.createCanvasContext('canvas')
+     *   context.setStrokeStyle("#00ff00")
+     *   context.setLineWidth(5)
+     *   context.rect(0, 0, 200, 200)
+     *   context.stroke()
+     *   context.setStrokeStyle("#ff0000")
+     *   context.setLineWidth(2)
+     *   context.moveTo(160, 100)
+     *   context.arc(100, 100, 60, 0, 2 * Math.PI, true)
+     *   context.moveTo(140, 100)
+     *   context.arc(100, 100, 40, 0, Math.PI, false)
+     *   context.moveTo(85, 80)
+     *   context.arc(80, 80, 5, 0, 2 * Math.PI, true)
+     *   context.moveTo(125, 80)
+     *   context.arc(120, 80, 5, 0, 2 * Math.PI, true)
+     *   context.stroke()
+     *   context.draw()
+     * })
      * ```
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/canvas/wx.createCanvasContext.html
      */

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

@@ -496,6 +496,7 @@ declare module '../../index' {
     callContainer < R = any, P = any >(params: cloud.CallContainerParam<P>): Promise<cloud.CallContainerResult<R>>
   }
 
+  /** @ignore */
   interface Cloud {
       /** 在调用云开发各 API 前，需先调用初始化方法 init 一次（全局只需一次，多次调用时只有第一次生效）
      * @supported weapp

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

@@ -284,7 +284,7 @@ declare module '../../index' {
       /** Transfer-Encoding Chunk Received 事件的回调函数 */
       callback: RequestTask.onChunkReceived.Callback,
     ): void
-    /** 监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。
+    /** 移除 Transfer-Encoding Chunk Received 事件的监听函数
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/request/RequestTask.offChunkReceived.html
      */
@@ -401,6 +401,15 @@ declare module '../../index' {
      */
     addInterceptor(interceptor: interceptor): any
 
+    /** 清除所有拦截器
+     * @example
+     * ```tsx
+     * Taro.cleanInterceptors()
+     * ```
+     * @supported weapp, h5, alipay, swan, tt, qq
+     */
+    cleanInterceptors(): void
+
     interceptors: interceptors
   }
 }

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

@@ -31,22 +31,6 @@ declare module '../../index' {
     }
   }
 
-  namespace checkIsAddedToMyMiniProgram {
-    interface Option {
-      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: TaroGeneral.CallbackResult) => void
-      /** 接口调用失败的回调函数 */
-      fail?: (res: TaroGeneral.CallbackResult) => void
-      /** 接口调用成功的回调函数 */
-      success?: (res: TaroGeneral.CallbackResult) => void
-    }
-
-    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
-      /**是否被添加至 「我的小程序」 */
-      added: boolean
-    }
-  }
-
   interface TaroStatic {
     /** 收藏视频
      * @supported weapp
@@ -80,7 +64,8 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/favorites/wx.addVideoToFavorites.html
      */
     addVideoToFavorites(option?: addVideoToFavorites.Option): Promise<TaroGeneral.CallbackResult>
-    /** 预约视频号直播
+
+    /** 收藏文件
      * @supported weapp
      * @example
      * ```tsx
@@ -112,11 +97,5 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/favorites/wx.addFileToFavorites.html
      */
     addFileToFavorites(option?: addFileToFavorites.Option): Promise<TaroGeneral.CallbackResult>
-    /**
-     * 检查小程序是否被添加至 「我的小程序」
-     * @supported weapp
-     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/my-miniprogram/wx.checkIsAddedToMyMiniProgram.html
-     */
-    checkIsAddedToMyMiniProgram(option?: checkIsAddedToMyMiniProgram.Option):Promise<checkIsAddedToMyMiniProgram.SuccessCallbackResult>
   }
 }

package/types/api/open-api/my-miniprogram.d.ts

@@ -0,0 +1,28 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace checkIsAddedToMyMiniProgram {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /**是否被添加至 「我的小程序」 */
+      added: boolean
+    }
+  }
+
+  interface TaroStatic {
+    /**
+     * 检查小程序是否被添加至 「我的小程序」
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/my-miniprogram/wx.checkIsAddedToMyMiniProgram.html
+     */
+    checkIsAddedToMyMiniProgram(option?: checkIsAddedToMyMiniProgram.Option):Promise<checkIsAddedToMyMiniProgram.SuccessCallbackResult>
+  }
+}

package/types/compile/compiler.d.ts

@@ -1,7 +1,7 @@
 import type swc from '@swc/core'
 import type Webpack from 'webpack'
 
-type CompilerTypes = 'webpack4' | 'webpack5'
+type CompilerTypes = 'webpack4' | 'webpack5' | 'vite'
 
 interface IPrebundle {
   enable?: boolean
@@ -20,6 +20,7 @@ interface IPrebundle {
 interface ICompiler {
   type: CompilerTypes
   prebundle?: IPrebundle
+  vitePlugins?: any[]
 }
 
 export type Compiler = CompilerTypes | ICompiler

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

@@ -3,8 +3,8 @@ import type Chain from 'webpack-chain'
 import type { Compiler } from '../compiler'
 import type { IModifyWebpackChain } from '../hooks'
 import type { ICopyOptions, IOption, ISassOptions, TogglableOptions } from "./util"
-import { IH5Config } from './h5'
-import { IMiniAppConfig } from './mini'
+import type { IH5Config } from './h5'
+import type { IMiniAppConfig } from './mini'
 
 export type PluginItem = string | [string, object]
 
@@ -67,9 +67,13 @@ export interface IProjectBaseConfig {
   onCompilerMake?: (compilation: Webpack.Compilation, compiler: Webpack.Compiler, plugin: any) => Promise<any>
   onWebpackChainReady?: (webpackChain: Chain) => Promise<any>
   /**
-   * 编译中修改 webpack 配置，在这个钩子中，你可以对 webpackChain 作出想要的调整，等同于配置 [`webpackChain`](./config-detail.md#miniwebpackchain)
+   * 编译中修改 webpack 配置，在这个钩子中，你可以对 webpackChain 作出想要的调整，等同于配置 [`webpackChain`](./config-detail#miniwebpackchain)
    */
   modifyWebpackChain?: (chain: Chain, webpack: typeof Webpack, data: IModifyWebpackChain) => Promise<any>
+  /**
+   * 编译中修改 vite 配置
+   */
+  modifyViteConfig?: (viteConfig: any, componentConfig: IModifyWebpackChain['componentConfig']) => void
   /**
    * 修改编译过程中的页面组件配置
    */