@tarojs/taro 3.6.8 → 3.6.9-alpha.10

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

@@ -68,6 +68,31 @@ declare module '../../index' {
     }
   }
 
+  namespace getChannelsShareKey {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 分享者 openid  */
+      sharerOpenId: string
+      /** 推广员 */
+      promoter: Promoter
+    }
+    interface Promoter {
+      /** 推广员昵称 */
+      finderNickname: string
+      /** 推广员id */
+      promoterId: string
+      /** 推广员openid */
+      promoterOpenId: string
+    }
+  }
+
   namespace getChannelsLiveNoticeInfo {
     interface Option {
       /** 视频号 id，以“sph”开头的id，可在视频号助手获取 */
@@ -164,6 +189,12 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.openChannelsActivity.html
      */
     openChannelsActivity(option?: openChannelsActivity.Option): Promise<TaroGeneral.CallbackResult>
+    /** 获取视频号直播卡片/视频卡片的分享来源，
+     * 仅当卡片携带了分享信息、同时用户已授权该小程序获取视频号分享信息且启动场景值为 1177、1184、1195、1208 时可用
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsShareKey.html
+     */
+    getChannelsShareKey(option?: getChannelsShareKey.Option): Promise<getChannelsShareKey.SuccessCallbackResult>
     /** 获取视频号直播预告信息
      * @supported weapp
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/channels/wx.getChannelsLiveNoticeInfo.html

package/types/api/open-api/device-voip.d.ts

@@ -0,0 +1,63 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace requestDeviceVoIP {
+    interface Option {
+      /** 设备唯一序列号。由厂商分配，长度不能超过128字节。字符只接受数字，大小写字母，下划线（_）和连字符（-） */
+      sn: string
+      /** 设备票据，5分钟内有效 */
+      snTicket: string
+      /** 设备型号 id。通过微信公众平台注册设备获得。 */
+      modelId: string
+      /** 设备名称，将显示在授权弹窗内（长度不超过13）。授权框中「设备名字」= 「deviceName」 + 「modelId 对应设备型号」 */
+      deviceName: string
+      /** 是否为授权设备组，默认 false */
+      isGroup?: boolean
+      /** 设备组的唯一标识 id 。isGroup 为 true 时只需要传该参数，isGroup 为 false 时不需要传该参数，但需要传 sn、snTicket、modelId、deviceName 。 */
+      groupId: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+  }
+
+  namespace getDeviceVoIPList {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      list: DeviceVoIP[]
+    }
+    interface DeviceVoIP {
+      /** 设备唯一序列号。（仅单台设备时） */
+      sn: string
+      /** 设备型号 id。通过微信公众平台注册设备获得。（仅单台设备时）	 */
+      model_id: string
+      /** 设备组的唯一标识 id（仅设备组时）  */
+      group_id: string
+      /** 设备（组）授权状态。0：未授权；1：已授权  */
+      status: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 请求用户授权与设备（组）间进行音视频通话
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/device-voip/wx.requestDeviceVoIP.html
+     */
+    requestDeviceVoIP(option: requestDeviceVoIP.Option): Promise<TaroGeneral.CallbackResult>
+    /** 查询当前用户授权的音视频通话设备（组）信息
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/device-voip/wx.getDeviceVoIPList.html
+     */
+    getDeviceVoIPList(option: getDeviceVoIPList.Option): Promise<getDeviceVoIPList.SuccessCallbackResult>
+  }
+}

package/types/api/storage/cache-manager.d.ts

@@ -0,0 +1,198 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  interface CacheManager {
+    /** 添加规则
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.addRule.html
+     */
+    addRule(option: CacheManager.AddRuleOption): string
+    /** 批量添加规则
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.addRules.html
+     */
+    addRules(option: CacheManager.AddRulesOption): string[]
+    /** 清空所有缓存
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.clearCaches.html
+     */
+    clearCaches(): void
+    /** 清空所有规则，同时会删除对应规则下所有缓存
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.clearRules.html
+     */
+    clearRules(): void
+    /** 删除缓存
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteCache.html
+     */
+    deleteCache( 
+      /** 缓存 id */
+      id: string
+    ): void
+    /** 批量删除缓存
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteCaches.html
+     */
+    deleteCaches(
+      /** 缓存 id 列表 */
+      ids: string[]
+    ): void
+    /** 删除规则，同时会删除对应规则下所有缓存
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteRule.html 
+     */
+    deleteRule(
+      /** 规则 id */
+      id: string
+    ): void
+    /** 批量删除规则，同时会删除对应规则下所有缓存
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.deleteRules.html
+     */
+    deleteRules(
+      /** 规则 id 列表 */
+      ids: string[]
+    ): void
+    /** 匹配命中的缓存规则，一般需要和 request 事件搭配使用
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.match.html
+     */
+    match(option: CacheManager.MatchOption): CacheManager.MatchResult
+    /** 取消事件监听
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.off.html
+     */
+    off(
+      /** 事件名称 */
+      eventName: string,
+      /** 事件监听函数 */
+      handler: Function
+    ): void
+    /** 监听事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.on.html
+     */
+    on( 
+      /** 事件名称 */
+      eventName: keyof CacheManager.OnEventName,
+      /** 事件监听函数 */
+      handler: Function
+    ): void
+    /** 开启缓存，仅在 mode 为 none 时生效，调用后缓存管理器的 state 会置为 1
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.start.html
+     */
+    start(): void
+    /** 关闭缓存，仅在 mode 为 none 时生效，调用后缓存管理器的 state 会置为 0
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/cachemanager/CacheManager.stop.html
+     */
+    stop(): void
+  }
+
+  namespace CacheManager {
+    interface DataSchema {
+      /** 需要匹配的 data 对象的参数类型
+       * string、number、boolean、null、object、any（表示任意类型），
+       * 同时支持数组模式（数组模式则在类型后面加 []，如 string[] 表示字符串数组）
+       */
+      type: string
+      /** 需要匹配的 data 对象的参数值
+       * 当 type 为基本类型时，可以用 string/regexp 来匹配固定的值，
+       * 也可以通过 function 来确定值是否匹配，
+       * 如果传入的 type 是 object，那么表示需要嵌套匹配值是否正确，可以传入 Array
+       */
+      value?: string | RegExp | Function | DataRule[]
+    }
+    interface DataRule {
+      /** 需要匹配的参数名 */
+      name: string
+      schema: DataSchema | DataSchema[]
+    }
+    interface RuleObject {
+      /** 规则 id，如果不填则会由基础库生成  */
+      id: string
+      /** 请求方法，可选值 GET/POST/PATCH/PUT/DELETE，如果为空则表示前面提到的所有方法都能被匹配到  */
+      method: string
+      /** uri 匹配规则，可参考规则字符串写法和正则写法 */
+      url: any
+      /** 
+       * 缓存有效时间，单位为 ms，不填则默认取缓存管理器全局的缓存有效时间
+       * @default 7 * 24 * 60 * 60 * 1000
+       */
+      maxAge: number
+      /**
+       * 匹配请求参数
+       */
+      dataSchema: DataRule[]
+    }
+
+    type Rule = string | RegExp | RuleObject
+
+    interface AddRuleOption {
+      /** 规则 */
+      rule: Rule
+    }
+    interface AddRulesOption {
+      rules: Rule[]
+    }
+    interface MatchOption {
+      /** request 事件对象  */
+      evt: any
+    }
+    interface MatchResult {
+      /** 命中的规则id */
+      ruleId: string
+      /** 缓存id */
+      cacheId: string
+      /** 缓存内容，会带有 fromCache 标记，方便开发者区分内容是否来自缓存 */
+      data: any
+      /** 缓存创建时间 */
+      createTime: number
+      /** 缓存有效时间 */
+      maxAge: number
+    }
+    interface OnEventName {
+      /** 发生 wx.request 请求，只在缓存管理器开启阶段会触发 */
+      request
+      /** 进入弱网/离线状态 */
+      enterWeakNetwork
+      /** 离开弱网/离线状态	 */
+      exitWeakNetwork
+    }
+  }
+
+  namespace createCacheManager {
+    interface Mode {
+      /** 弱网/离线使用缓存返回 */
+      weakNetwork
+      /** 总是使用缓存返回 */
+      always
+      /** 不开启，后续可手动开启/停止使用缓存返回 */
+      none
+    }
+    interface Extra {
+      /** 需要缓存的 wx api 接口，不传则表示支持缓存的接口全都做缓存处理。返回的如果是缓存数据，开发者可通过 fromCache 标记区分 */
+      apiList?: string[]
+    }
+    interface Option {
+      /** 全局 origin */
+      origin?: string
+      /** 缓存模式 */
+      mode?: keyof Mode
+      /** 全局缓存有效时间，单位为毫秒，默认为 7 天，最长不超过 30 天  */
+      maxAge?: number
+      /** 额外的缓存处理 */
+      extra?: Extra
+    }
+  }
+
+  interface TaroStatic {
+    /** 拉起手机发送短信界面
+     * @supported weap
+     * @see declare module '../../index' 
+     */
+    createCacheManager(option: createCacheManager.Option): CacheManager
+  }
+}

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

@@ -5,8 +5,11 @@ import type HtmlWebpackPlugin from 'html-webpack-plugin'
 import type { IOption, IPostcssOption } from './util'
 
 export interface IH5RouterConfig {
+  /** 配置路由模式 */
   mode?: 'hash' | 'browser' | 'multi'
+  /** 配置自定义路由 */
   customRoutes?: IOption
+  /** 配置路由基准路径 */
   basename?: string
   lazyload?: boolean | ((pagename: string) => boolean)
   renamePagename?: (pagename: string) => string
@@ -14,37 +17,95 @@ export interface IH5RouterConfig {
 }
 
 export interface IH5Config {
+  /** 设置输出解析文件的目录（默认值：'/'）*/
   publicPath?: string
+
+  /** h5 编译后的静态文件目录（默认值：'static'） */
   staticDirectory?: string
+
+  /** 编译后非 entry 的 js 文件的存放目录，主要影响动态引入的 pages 的存放路径（默认值：'chunk'） */
   chunkDirectory?: string
 
   webpack?: ((webpackConfig: Webpack.Configuration, webpack) => Webpack.Configuration) | Webpack.Configuration
 
+  /**
+   * 自定义 Webpack 配置
+   * @param chain  [webpackChain](https://github.com/neutrinojs/webpack-chain) 对象
+   * @param webpack webpack 实例
+   */
   webpackChain?: (chain: Chain, webpack: typeof Webpack) => void
 
+  /** 可用于修改、拓展 Webpack 的 output 选项，配置项参考[官方文档](https://webpack.js.org/configuration/output/) */
   output?: Webpack.Configuration['output']
+
+  /** 路由相关的配置 */
   router?: IH5RouterConfig
+
+  /** 预览服务的配置，可以更改端口等参数。具体配置参考 [webpack-dev-server](https://webpack.js.org/configuration/dev-server) */
   devServer?: webpackDevServer.Configuration
-  sourceMapType?: 'none' | 'eval' | 'cheap-eval-source-map' | 'cheap-module-eval-source-map' | 'eval-source-map' | 'cheap-source-map' | 'cheap-module-source-map' | 'inline-cheap-source-map' | 'inline-cheap-module-source-map' | 'source-map' | 'inline-source-map' | 'hidden-source-map' | 'nosources-source-map'
+
+  /**  具体配置请参考 [Webpack devtool](https://webpack.js.org/configuration/devtool/#devtool) 配置 (默认值：'cheap-module-eval-source-map')*/
+  sourceMapType?:
+    | 'none'
+    | 'eval'
+    | 'cheap-eval-source-map'
+    | 'cheap-module-eval-source-map'
+    | 'eval-source-map'
+    | 'cheap-source-map'
+    | 'cheap-module-source-map'
+    | 'inline-cheap-source-map'
+    | 'inline-cheap-module-source-map'
+    | 'source-map'
+    | 'inline-source-map'
+    | 'hidden-source-map'
+    | 'nosources-source-map'
+
+  /** extract 功能开关，开启后将使用 mini-css-extract-plugin 分离 css 文件，可通过 h5.miniCssExtractPluginOption 对插件进行配置 (默认值：watch 模式下为 false，否则为 true) */
   enableExtract?: boolean
-  transformOnly?: boolean
 
+  /** [css-loader](https://github.com/webpack-contrib/css-loader) 的附加配置 */
   cssLoaderOption?: IOption
+
+  /** [style-loader](https://github.com/webpack-contrib/style-loader) 的附加配置 */
   styleLoaderOption?: IOption
+
+  /** [sass-loader](https://github.com/webpack-contrib/sass-loader) 的附加配置 */
   sassLoaderOption?: IOption
+
+  /** [less-loader](https://github.com/webpack-contrib/less-loader) 的附加配置 */
   lessLoaderOption?: IOption
+
+  /** [stylus-loader](https://github.com/shama/stylus-loader) 的附加配置 */
   stylusLoaderOption?: IOption
+
+  /** 针对 mp4 | webm | ogg | mp3 | wav | flac | aac 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
   mediaUrlLoaderOption?: IOption
+
+  /** 针对 woff | woff2 | eot | ttf | otf 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
   fontUrlLoaderOption?: IOption
+
+  /** 针对 png | jpg | jpeg | gif | bpm | svg 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
   imageUrlLoaderOption?: IOption
+
+  /** [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) 的附加配置 */
   miniCssExtractPluginOption?: IOption
+
+  /** 配置需要额外的经由 Taro 预设的 postcss 编译的模块 */
   esnextModules?: string[]
+
+  /** 用于控制在 H5 端是否使用兼容性组件库，详情请看 [React 兼容性组件库](https://taro-docs.jd.com/docs/next/h5#react-兼容性组件库)。(默认值：false) */
   useHtmlComponents?: boolean
+
+  /** 用于控制在 H5 端是否使用旧版本适配器，旧版本采用全局注册组件，懒加载组件相关依赖；新版本适配器会自动注册相关组件，不再需要引入 @tarojs/components/loader 中的全局 defineCustomElements 方法。(默认值：false) */
   useDeprecatedAdapterComponent?: boolean
 
+  /** 配置 postcss 相关插件 */
   postcss?: IPostcssOption
+
+  /** html-webpack-plugin 的具体配置 */
   htmlPluginOption?: HtmlWebpackPlugin.Options
 
+  /** Web 编译过程的相关配置 */
   compile?: {
     exclude?: any[]
     include?: any[]

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

@@ -1,6 +1,6 @@
 import type Webpack from 'webpack'
 import type Chain from 'webpack-chain'
-import type { IMINI_APP_FILE_TYPE, IOption, IPostcssOption } from './util'
+import type { IOption, IPostcssOption } from './util'
 
 interface Runtime {
   enableInnerHTML: boolean
@@ -13,36 +13,88 @@ interface Runtime {
 }
 
 export interface IMiniAppConfig {
-  appOutput?: boolean
+  /** 默认值：'cheap-module-source-map'， 具体参考[Webpack devtool 配置](https://webpack.js.org/configuration/devtool/#devtool) */
   sourceMapType?: string
+
+  /** 指定 React 框架相关的代码是否使用开发环境（未压缩）代码，默认使用生产环境（压缩后）代码 */
   debugReact?: boolean
+
+  /** 压缩小程序 xml 文件的相关配置 */
   minifyXML?: {
+    /** 是否合并 xml 文件中的空格 (默认false) */
     collapseWhitespace?: boolean
   }
 
+  /**
+   * 自定义 Webpack 配置
+   * @param chain  [webpackChain](https://github.com/neutrinojs/webpack-chain) 对象
+   * @param webpack webpack 实例
+   * @param PARSE_AST_TYPE 小程序编译时的文件类型集合
+   * @returns
+   */
   webpackChain?: (chain: Chain, webpack: typeof Webpack, PARSE_AST_TYPE: any) => void
-  output?: Webpack.Configuration['output']
+
+  /** 可用于修改、拓展 Webpack 的 [output](https://webpack.js.org/configuration/output/) 选项 */
+  output?: Webpack.Configuration['output'] & {
+    /**
+     * 编译前清空输出目录
+     * @since Taro v3.6.9
+     * @description 
+     * - 默认清空输出目录，可设置 clean: false 不清空
+     * - 可设置 clean: { keep: ['project.config.json'] } 保留指定文件
+     * - 注意 clean.keep 不支持函数
+     */
+    clean?: boolean | {
+      /** 保留指定文件不删除 */
+      keep?: Array<string | RegExp> | string | RegExp
+    }
+  }
+
+  /** 配置 postcss 相关插件 */
   postcss?: IPostcssOption
+
+  /** [css-loader](https://github.com/webpack-contrib/css-loader) 的附加配置 */
   cssLoaderOption?: IOption
+
+  /** [sass-loader](https://github.com/webpack-contrib/sass-loader) 的附加配置 */
   sassLoaderOption?: IOption
+
+  /** [less-loader](https://github.com/webpack-contrib/less-loader) 的附加配置 */
   lessLoaderOption?: IOption
+
+  /** [stylus-loader](https://github.com/shama/stylus-loader) 的附加配置 */
   stylusLoaderOption?: IOption
+
+  /** 针对 mp4 | webm | ogg | mp3 | wav | flac | aac 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
   mediaUrlLoaderOption?: IOption
+
+  /** 针对 woff | woff2 | eot | ttf | otf 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
   fontUrlLoaderOption?: IOption
+
+  /** 针对 png | jpg | jpeg | gif | bpm | svg 文件的 [url-loader](https://github.com/webpack-contrib/url-loader) 配置 */
   imageUrlLoaderOption?: IOption
+
+  /** [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) 的附加配置 */
   miniCssExtractPluginOption?: IOption
 
-  customFilesTypes?: IMINI_APP_FILE_TYPE
+  /** 用于告诉 Taro 编译器需要抽取的公共文件 */
   commonChunks?: string[] | ((commonChunks: string[]) => string[])
-  addChunkPages?: ((pages: Map<string, string[]>, pagesNames?: string[]) => void)
+
+  /** 为某些页面单独指定需要引用的公共文件 */
+  addChunkPages?: (pages: Map<string, string[]>, pagesNames?: string[]) => void
+
+  /** 优化主包的体积大小 */
   optimizeMainPackage?: {
     enable?: boolean
     exclude?: any[]
   }
 
+  /** 小程序编译过程的相关配置 */
   compile?: {
     exclude?: any[]
     include?: any[]
   }
+
+  /** 插件内部使用 */
   runtime?: Runtime
 }