feat: ✨ 支持直接返回压缩包 Blob 对象

Author: xiaohuohumax

apps/libs/downloader/CHANGELOG.md

@@ -1,5 +1,11 @@
 # downloader
 
+## 1.2.0
+
+### Minor Changes
+
+- 支持直接返回压缩包 Blob 对象
+
 ## 1.1.0
 
 ### Minor Changes

apps/libs/downloader/README.md

@@ -17,29 +17,73 @@
 
 ## 📖 使用方式
 
-1. 添加 `// @require https://**/downloader.js?sha384-*` 库引用
-2. 添加 `// @grant GM_download` 下载权限
-3. 使用 `downloader` 方法下载资源
+### ✍ 添加元数据
 
 ```typescript
 // ==UserScript==
 // @require      https://**/downloader.js?sha384-*
 // @grant        GM_download
 // ==/UserScript==
+```
+
+### 📥 参数说明
+
+**Options 参数说明：**
+
+| 参数名        | 类型                             | 是否必填 | 默认值 | 说明                                                                             |
+| ------------- | -------------------------------- | -------- | ------ | -------------------------------------------------------------------------------- |
+| `filename`    | string                           | 否       |        | 保存的文件名，**添加此参数时会将压缩包保存到本地，未配置返回压缩包的 Blob 对象** |
+| `resources`   | Resource[]                       | 是       |        | 资源列表，数组，每个元素为对象，包含 `name` 和 `url` 或者 `blob` 字段            |
+| `concurrency` | number                           | 否       | `10`   | 并发数，默认 `10`                                                                |
+| `onProgress`  | (index: number) => Promise<void> | 否       |        | 下载进度回调函数，参数为当前正在下载的资源索引                                   |
+
+**Resource 参数说明：**
+
+| 参数名 | 类型   | 是否必填 | 默认值 | 说明          |
+| ------ | ------ | -------- | ------ | ------------- |
+| `name` | string | 是       |        | 资源名称      |
+| `url`  | string | 否       |        | URL 类型资源  |
+| `blob` | Blob   | 否       |        | Blob 类型资源 |
+
+### 📦 使用示例
 
-(async () => {
-  'use strict'
-  await downloader({
-    filename: 'index.zip', // 文件名
-    resources: [ // 资源列表
-      { name: 'index.html', url: location.href },
-    ],
-    concurrency: 10, // 并发数
-    onProgress(index) { // 下载进度回调
-      console.log(`正在下载第 ${index + 1} 个资源`)
+**下载，压缩，并保存到本地**
+
+```typescript
+await downloader({
+  filename: 'index.zip',
+  resources: [
+    { name: 'index.html', url: location.href },
+    {
+      name: 'hello.txt',
+      blob: new Blob(['hello world'], { type: 'text/plain' }),
+    },
+  ],
+  concurrency: 10,
+  async onProgress(index) {
+    console.log(`正在下载第 ${index + 1} 个资源`)
+  },
+})
+```
+
+**仅下载和压缩**
+
+```typescript
+const blob = await downloader({
+  resources: [
+    { name: 'index.html', url: location.href },
+    {
+      name: 'hello.txt',
+      blob: new Blob(['hello world'], { type: 'text/plain' }),
     },
-  })
-})()
+  ],
+  concurrency: 10,
+  async onProgress(index) {
+    console.log(`正在下载第 ${index + 1} 个资源`)
+  },
+})
+// 自行处理
+// GM_download(URL.createObjectURL(blob), 'index.zip')
 ```
 
 ## 🚨 免责声明

apps/libs/downloader/package.json

@@ -1,7 +1,7 @@
 {
   "name": "downloader",
   "type": "module",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "private": true,
   "description": "Downloader -- 资源下载器（下载资源、Zip 压缩、下载到本地）",
   "author": {

apps/libs/downloader/src/index.ts

@@ -1,26 +1,55 @@
-import { BlobWriter, HttpReader, ZipWriter } from '@zip.js/zip.js'
+import { BlobReader, BlobWriter, HttpReader, ZipWriter } from '@zip.js/zip.js'
 import pLimit from 'p-limit'
 
-export interface Resource {
+export interface UrlResource {
   name: string
   url: string | URL
 }
 
-export interface Options {
-  filename: string
+export interface BlobResource {
+  name: string
+  blob: Blob
+}
+
+function isBlobResource(resource: Resource): resource is BlobResource {
+  return (resource as BlobResource).blob instanceof Blob
+}
+
+export type Resource = UrlResource | BlobResource
+
+interface OptionsBase {
   resources: Resource[]
   concurrency?: number
   onProgress?: (index: number) => Promise<void>
 }
 
-export default async function downloader(options: Options): Promise<void> {
+export interface SaveOptions extends OptionsBase {
+  filename: string
+}
+
+function isSaveOptions(options: Options): options is SaveOptions {
+  return 'filename' in options
+}
+
+export interface ZipOptions extends OptionsBase { }
+
+export type Options = ZipOptions | SaveOptions
+
+export default async function downloader(options: SaveOptions): Promise<void>
+export default async function downloader(options: ZipOptions): Promise<Blob>
+export default async function downloader(options: Options): Promise<void | Blob> {
   const writer = new ZipWriter(new BlobWriter('application/zip'))
   const limit = pLimit(options.concurrency || 10)
   await Promise.all(options.resources.map((resource, index) => limit(async () => {
     await options.onProgress?.(index)
-    return writer.add(resource.name, new HttpReader(resource.url))
+    const reader = isBlobResource(resource)
+      ? new BlobReader(resource.blob)
+      : new HttpReader(resource.url)
+    return writer.add(resource.name, reader)
   })))
   const blob = await writer.close()
-  const url = URL.createObjectURL(blob)
-  GM_download(url, options.filename)
+  if (!isSaveOptions(options)) {
+    return blob
+  }
+  GM_download(URL.createObjectURL(blob), options.filename)
 }

dist/downloader.js

@@ -6624,17 +6624,41 @@ var __privateWrapper = (obj, member, setter, getter) => ({
       throw new TypeError("Expected `concurrency` to be a number from 1 and up");
     }
   }
+  function isBlobResource(resource) {
+    return resource.blob instanceof Blob;
+  }
+  function isSaveOptions(options) {
+    return "filename" in options;
+  }
   async function downloader2(options) {
     const writer = new ZipWriter(new BlobWriter("application/zip"));
     const limit = pLimit(options.concurrency || 10);
     await Promise.all(options.resources.map((resource, index) => limit(async () => {
       var _a;
       await ((_a = options.onProgress) == null ? void 0 : _a.call(options, index));
-      return writer.add(resource.name, new HttpReader(resource.url));
+      const reader = isBlobResource(resource) ? new BlobReader(resource.blob) : new HttpReader(resource.url);
+      return writer.add(resource.name, reader);
     })));
     const blob = await writer.close();
-    const url = URL.createObjectURL(blob);
-    GM_download(url, options.filename);
-  }
+    if (!isSaveOptions(options)) {
+      return blob;
+    }
+    GM_download(URL.createObjectURL(blob), options.filename);
+  }
+  (async () => {
+    await downloader2({
+      resources: [
+        { name: "index.html", url: location.href },
+        {
+          name: "hello.txt",
+          blob: new Blob(["hello world"], { type: "text/plain" })
+        }
+      ],
+      concurrency: 10,
+      async onProgress(index) {
+        console.log(`正在下载第 ${index + 1} 个资源`);
+      }
+    });
+  })();
   return downloader2;
 }();