baize-compress 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -1,3 +1,83 @@
-# Temporary Holding Version
+# baize-compress
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+浏览器端图片、音视频压缩库。插件按需引入，共用 Web Worker 池，支持批量压缩、超时和取消。
+
+## 安装
+
+```sh
+pnpm add baize-compress
+```
+
+## 使用
+
+```typescript
+import { ImageCompressor } from "baize-compress";
+import { jpegWebp } from "baize-compress/plugins/jpeg-webp";
+import { png } from "baize-compress/plugins/png";
+import { svg } from "baize-compress/plugins/svg";
+import { gif } from "baize-compress/plugins/gif";
+import { media } from "baize-compress/plugins/media";
+
+const compressor = new ImageCompressor({
+  workerNum: 2,
+  plugins: [jpegWebp(), png(), svg(), gif(), media()],
+});
+
+try {
+  const results = await compressor.compressFilesWorker(files); // File[]
+  for (const result of results) {
+    if (result.status === "fulfilled") {
+      console.log(result.value.file, result.value.compressInfo);
+    } else {
+      console.error(result.reason);
+    }
+  }
+} finally {
+  compressor.cancelAll();
+}
+```
+
+按需保留需要的插件。返回结果与输入顺序一致，每个文件独立成功或失败；多个插件匹配同一类型时，使用先注册的插件。
+
+## 插件
+
+| 插件       | 支持格式        | 默认参数                                     |
+| ---------- | --------------- | -------------------------------------------- |
+| `jpegWebp` | JPEG、WebP      | `quality: 0.75`                              |
+| `png`      | PNG             | `quality: 0.8`                               |
+| `svg`      | SVG             | `floatPrecision: 8`                          |
+| `gif`      | GIF             | `quality: 0.75`、`optimize: 1`               |
+| `media`    | 音频、视频、Ogg | `quality: 0.5`、`keepOriginalIfLarger: true` |
+
+参数传入对应工厂函数，如 `jpegWebp({ quality: 0.8 })`。`quality` 范围为 0–1，越大质量越高。完整配置与扩展方式见 [插件指南](./docs/plugins.md)。
+
+## API
+
+`new ImageCompressor({ plugins, workerNum })`：`plugins` 必填，`workerNum` 为安全正整数，默认 `4`。文件读取与压缩共用并发上限，Worker 按需创建并复用。
+
+| 方法                                  | 用途                                                               |
+| ------------------------------------- | ------------------------------------------------------------------ |
+| `compressFilesWorker(files: File[])`  | 批量压缩，返回 `Promise<PromiseSettledResult<CompressBackInfo>[]>` |
+| `compressImagesWorker(files: File[])` | 兼容入口，与 `compressFilesWorker` 行为一致                        |
+| `cancelAll()`                         | 取消未完成的任务并释放 Worker，之后可再次提交                      |
+
+成功结果的 `value` 包含：
+
+| 字段                          | 含义               |
+| ----------------------------- | ------------------ |
+| `file`                        | 压缩后的 `File`    |
+| `compressInfo.rate`           | 压缩率（%）        |
+| `compressInfo.time`           | 压缩耗时（毫秒）   |
+| `compressInfo.originalSize`   | 压缩前体积（字节） |
+| `compressInfo.compressedSize` | 压缩后体积（字节） |
+
+## 使用约定
+
+- 使用支持 ESM Worker 的现代浏览器；JPEG / WebP 需要 OffscreenCanvas，音视频需要 HTTPS 或 localhost 及 WebCodecs 支持。
+- 文件需具有正确的 MIME 类型。图片最大 50 MB，音视频不设固定上限，但在内存中处理，建议音视频并发设为 `1` 或 `2`。
+- 默认在结果未变小时保留原文件；APNG 始终保留原始动画数据。音视频必须转换到指定格式时，设置 `keepOriginalIfLarger: false`。
+- 音视频默认仅保留主要视频轨道和主要音频轨道；支持的编解码取决于浏览器，不支持时返回该文件失败。
+- 图片任务默认超时 30 秒，音视频 10 分钟。取消会立即结束任务等待，已开始的原生文件读取会自行完成并丢弃结果。
+- 启用 CSP 时允许同源脚本和 Worker；GIF 还需 `script-src 'wasm-unsafe-eval'`，音视频还需 `worker-src 'self' blob:`。
+
+开发、构建和测试说明见 [开发指南](./docs/development.md)。