@tarojs/taro 3.8.0-canary.0 → 4.0.0-alpha.2

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

@@ -49,6 +49,10 @@ declare module '../../index' {
       keys: string[]
       /** 限制的空间大小，单位 KB */
       limitSize: number
+      /** 是否执行成功
+       * @supported alipay
+       */
+      success?: boolean
     }
   }
 
@@ -102,9 +106,54 @@ declare module '../../index' {
     }
   }
 
+  namespace batchSetStorageSync {
+    interface Option {
+      /** [{ key, value }] */
+      kvList: kv[]
+    }
+    interface kv {
+      /** key 本地缓存中指定的 key */
+      key: string
+      /** data 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。*/
+      value: any
+    }
+  }
+
+  namespace batchSetStorage {
+    interface Option {
+      /** [{ key, value }] */
+      kvList: kv[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface kv {
+      /** key 本地缓存中指定的 key */
+      key: string
+      /** data 需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。*/
+      value: any
+    }
+  }
+
+  namespace batchGetStorage {
+    interface Option {
+      /** 本地缓存中指定的 keyList */
+      keyList: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
   interface TaroStatic {
     /** Taro.setStorage 的同步版本
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, harmony_hybrid
      * @example
      * ```tsx
      * Taro.setStorage({
@@ -128,7 +177,7 @@ declare module '../../index' {
     ): void
 
     /** 将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony, harmony_hybrid
      * @example
      * ```tsx
      * Taro.setStorage({
@@ -155,7 +204,7 @@ declare module '../../index' {
     ): void
 
     /** Taro.removeStorage 的同步版本
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, harmony_hybrid
      * @example
      * ```tsx
      * try {
@@ -172,7 +221,7 @@ declare module '../../index' {
     ): void
 
     /** 从本地缓存中移除指定 key
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony, harmony_hybrid
      * @example
      * ```tsx
      * Taro.removeStorage({
@@ -187,7 +236,7 @@ declare module '../../index' {
     removeStorage(option: removeStorage.Option): Promise<TaroGeneral.CallbackResult>
 
     /** Taro.getStorage 的同步版本
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, harmony_hybrid
      * @example
      * ```tsx
      * try {
@@ -207,7 +256,7 @@ declare module '../../index' {
     ): T
 
     /** Taro.getStorageInfo 的同步版本
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony_hybrid
      * @example
      * ```tsx
      * try {
@@ -224,7 +273,7 @@ declare module '../../index' {
     getStorageInfoSync(): getStorageInfoSync.Option
 
     /** 异步获取当前storage的相关信息
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony_hybrid
      * @example
      * ```tsx
      * Taro.getStorageInfo({
@@ -240,7 +289,7 @@ declare module '../../index' {
     getStorageInfo(option?: getStorageInfo.Option): Promise<TaroGeneral.CallbackResult>
 
     /** 从本地缓存中异步获取指定 key 的内容
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony, harmony_hybrid
      * @example
      * ```tsx
      * Taro.getStorage({
@@ -264,7 +313,7 @@ declare module '../../index' {
     ): void
 
     /** Taro.clearStorage 的同步版本
-     * @supported weapp, h5, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, harmony_hybrid
      * @example
      * ```tsx
      * try {
@@ -278,7 +327,7 @@ declare module '../../index' {
     clearStorageSync(): void
 
     /** 清理本地数据缓存
-     * @supported weapp, h5, rn, tt
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony, harmony_hybrid
      * @example
      * ```tsx
      * Taro.clearStorage()
@@ -286,5 +335,71 @@ declare module '../../index' {
      * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.clearStorage.html
      */
     clearStorage(option?: clearStorage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 将数据批量存储在本地缓存中指定的 key 中。
+     * 会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。
+     * 单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * try {
+     *   Taro.batchSetStorageSync([{key: 'key', value: 'value'}])
+     * } catch (e) { }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorageSync.html
+     */
+    batchSetStorageSync(option: batchSetStorageSync.Option): void
+
+    /** 将数据批量存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。
+     * 除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。
+     * 单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.batchGetStorage({
+     *   keyList: ['key']
+     *   success(res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorage.html
+     */
+    batchSetStorage(option: batchSetStorage.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 从本地缓存中同步批量获取指定 key 的内容。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * try {
+     *   var valueList = Taro.batchGetStorageSync(['key'])
+     *   if (valueList) {
+     *     // Do something with return value
+     *   }
+     * } catch (e) {
+     *   // Do something when catch error
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorageSync.html
+     */
+    batchGetStorageSync<T = any>(
+      /** 本地缓存中指定的 key 数组 */
+      keyList: string[]
+    ): T[]
+
+    /** 从本地缓存中异步批量获取指定 key 的内容。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.batchGetStorage({
+     *   keyList: ['key'],
+     *   success(res) {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/storage/wx.batchGetStorage.html
+     */
+    batchGetStorage(option: batchGetStorage.Option): Promise<TaroGeneral.CallbackResult>
   }
 }

package/types/api/swan/bookshelf.d.ts

@@ -0,0 +1,307 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace insertBookshelf {
+    interface Option {
+      /** 添加的内容分类 */
+      category: keyof Category | string
+      /** 要添加到书架内容的 id，支持传多个，最多 100 条；注释：contentId 为内容 id，内容的唯一标识，自定义，最长 22 字符（不能含有空格、中文字符） */
+      contentIds: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface Category {
+      /** 专栏模板 */
+      article
+      /** 文档模板 */
+      doc
+      /** 动漫模板 */
+      cartoon
+      /** 影音模板 */
+      av
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 添加到书架的结果列表 */
+      list: IListItem[]
+    }
+    interface IListItem {
+      /** 内容的唯一标识 */
+      contentId: string
+      /** 添加状态：值为 0 时是失败，为 1 时是成功 */
+      status: keyof Status
+      /** 添加信息 */
+      msg: string
+    }
+    interface Status {
+      /** 失败 */
+      0
+      /** 成功 */
+      1
+    }
+  }
+
+  namespace deleteBookshelf {
+    interface Option {
+      /** 要删除的内容分类 */
+      category: keyof Category | string
+      /** 要删除书架内容的 id，支持传多个，最多 100 条；注释：contentId 为内容 id，内容的唯一标识，自定义，最长 22 字符（不能含有空格、中文字符）。支持批量删除的同一个 category 下的多个 id，不同 category 下的 id 请分别调用该接口删除 */
+      contentIds: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface Category {
+      /** 专栏模板 */
+      article
+      /** 文档模板 */
+      doc
+      /** 动漫模板 */
+      cartoon
+      /** 影音模板 */
+      av
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 添加到书架的结果列表 */
+      list: IListItem[]
+    }
+    interface IListItem {
+      /** 内容的唯一标识 */
+      contentId: string
+      /** 删除状态：值为 0 时是失败，为 1 时是成功 */
+      status: keyof Status
+      /** 删除信息 */
+      msg: string
+    }
+    interface Status {
+      /** 失败 */
+      0
+      /** 成功 */
+      1
+    }
+  }
+
+  namespace queryBookshelf {
+    interface Option {
+      /** 要查询内容的 id，支持传多个，最多 100 条；注释：contentId 为内容 id，内容的唯一标识，自定义，最长 22 字符（不能含有空格、中文字符） */
+      contentIds: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 查询的内容结果列表 */
+      list: IListItem[]
+    }
+    interface IListItem {
+      /** 内容的唯一标识 */
+      contentId: string
+      /** 状态 */
+      status: keyof Status
+    }
+    interface Status {
+      /** 不存在 */
+      0
+      /** 存在 */
+      1
+    }
+  }
+
+  namespace updateBookshelfReadTime {
+    interface Option {
+      /** 添加的内容分类 */
+      category: keyof Category | string
+      /** 要更新内容的 id；注释：contentId 为内容 id，内容的唯一标识，自定义，最长 22 字符（不能含有空格、中文字符） */
+      contentIds: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface Category {
+      /** 专栏模板 */
+      article
+      /** 文档模板 */
+      doc
+      /** 动漫模板 */
+      cartoon
+      /** 影音模板 */
+      av
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 更新状态 */
+      status: keyof Status
+      /** 更新的结果信息 */
+      msg: string
+    }
+    interface Status {
+      /** 失败 */
+      0
+      /** 成功 */
+      1
+    }
+  }
+
+  namespace navigateToBookshelf {
+    interface Option {
+      /** 跳转到指定的内容分类
+       * @supported swan
+       */
+      category: keyof Category | string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    interface Category {
+      /** 专栏模板 */
+      article
+      /** 文档模板 */
+      doc
+      /** 动漫模板 */
+      cartoon
+      /** 影音模板 */
+      av
+    }
+  }
+
+  interface TaroStatic {
+    /** 添加内容到宿主书架
+     * @supported swan, qq
+     * @swan （需宿主支持书架入口）
+     * @example
+     * ```tsx
+     * Taro.insertBookshelf({
+     *   category: 'doc',
+     *   contentIds: ['test1', 'test2'],
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'success',
+     *       content: JSON.stringify(res)
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-insertBookshelf/
+     */
+    insertBookshelf(option: insertBookshelf.Option): void
+
+    /** 删除书架中的内容（需宿主支持书架入口)
+     * @supported swan
+     * @example
+     * ```tsx
+     * Taro.deleteBookshelf({
+     *   category: 'doc',
+     *   contentIds: ['test1', 'test2'],
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'success',
+     *       content: JSON.stringify(res)
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * ```
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-deleteBookshelf/
+     */
+    deleteBookshelf(option: deleteBookshelf.Option): void
+
+    /** 查询宿主书架的相关内容
+     * @supported swan, qq
+     * @swan （需宿主支持书架入口）
+     * @example
+     * ```tsx
+     * Taro.queryBookshelf({
+     *   contentIds: ['test1', 'test2'],
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'success',
+     *       content: JSON.stringify(res)
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * ```
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-queryBookshelf/
+     */
+    queryBookshelf(option: queryBookshelf.Option): void
+
+    /** 更新已加入宿主书架的内容的阅读时间
+     * @supported swan, qq
+     * @swan （需宿主支持书架入口）
+     * @example
+     * ```tsx
+     * Taro.updateBookshelfReadTime({
+     *   category: 'doc',
+     *   contentIds: 'test1',
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'success',
+     *       content: JSON.stringify(res)
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-queryBookshelf/
+     */
+    updateBookshelfReadTime(option: updateBookshelfReadTime.Option): void
+
+    /** 跳转到宿主书架
+     * @supported swan
+     * @swan （需宿主支持书架入口）
+     * @example
+     * ```tsx
+     * Taro.navigateToBookshelf({
+     *   category: 'article',
+     *   contentIds: 'test1',
+     *   success(res) {
+     *     Taro.showModal({
+     *       title: 'navigateToBookshelf',
+     *       content: 'success'
+     *     })
+     *   },
+     *   fail(err) {
+     *     Taro.showModal({
+     *       title: 'fail',
+     *       content: JSON.stringify(err)
+     *     })
+     *   }
+     * })
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-navigateToBookshelf/
+     */
+    navigateToBookshelf(option: navigateToBookshelf.Option): void
+  }
+}

package/types/api/swan/download-package.d.ts

@@ -0,0 +1,80 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace downloadPackage {
+    interface Option {
+      /** 预下载的小程序的 appKey */
+      appKey: string
+      /** 预下载的小程序的 pageUrl ，默认值为小程序的首页页面 */
+      pageUrl?: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: TaroGeneral.CallbackResult) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => any
+    }
+  }
+
+  namespace downloadPackages {
+    interface Option {
+      /** 预下载的小程序的列表。 */
+      pageList: IPageItem[]
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: TaroGeneral.CallbackResult) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => any
+    }
+    interface IPageItem {
+      /** 预下载的小程序的 appKey */
+      appKey: string
+      /** 页面路径 */
+      pages: string[]
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 小程序包预下载结果回调 */
+      [key: string]: IAppKeyResult[]
+    }
+    interface IAppKeyResult {
+      /** 页面路径 */
+      pageUrl: string
+      /** 预下载能力调用结果。值为 "0" 时是成功，非 "0" 时是失败 */
+      status: string
+      /** 预下载结果信息 */
+      message: string
+    }
+  }
+
+  namespace loadSubPackage {
+    interface Option {
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => any
+      /** 接口调用失败的回调函数 */
+      fail?: (err: TaroGeneral.CallbackResult) => any
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => any
+    }
+  }
+
+  interface TaroStatic {
+    /** 针对在小程序中调用其他小程序的场景，预下载其他小程序的包内容。
+     * Web 态说明：Web 态不支持预下载的能力。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-downloadPackage/
+     */
+    downloadPackage(option: downloadPackage.Option): void
+    /** 针对在小程序中调用其他小程序的场景，预下载其他小程序的包内容。
+     * Web 态说明：Web 态不支持预下载的能力。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-downloadPackages/
+     */
+    downloadPackages(option: downloadPackages.Option): void
+    /** 提前下载好子包的资源，目录结构配置参考[分包加载](https://smartprogram.baidu.com/docs/develop/framework/subpackages/)。
+     * @supported swan
+     * @see https://smartprogram.baidu.com/docs/develop/api/open/swan-loadSubPackage/
+     */
+    loadSubPackage(option: loadSubPackage.Option): void
+  }
+}