@leonsilicon/napi-magick 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,43 @@
-# Temporary Holding Version
+# @leonsilicon/napi-magick
 
-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.
+Native ImageMagick for Node.js with the **magick-wasm 0.0.44 API**, backed by **napi-rs and magick_rust 2.1.1**. ImageMagick and its codec libraries are included in platform packages; consumers need no compiler, system ImageMagick installation, or WASM download.
+
+Requires Node.js 22 or newer. The build matrix produces macOS 15+ arm64, Linux glibc arm64/x64, and Windows x64 packages. The native API uses Q8 without HDRI, matching the pinned upstream WASM build.
+
+```ts
+import { ImageMagick, MagickFormat, initializeImageMagick } from "@leonsilicon/napi-magick";
+
+await initializeImageMagick();
+ImageMagick.read(inputBytes, (image) => {
+  image.resize(320, 240);
+  image.write(MagickFormat.Png, (bytes) => {
+    // bytes is a Uint8Array. Copy it with bytes.slice() to retain independent data.
+  });
+});
+```
+
+The classes, enums, overloads, callbacks, errors, and asynchronous disposal behavior come from the pinned magick-wasm facade. Existing initialization arguments are accepted for migration; a WASM binary is unnecessary. Native ImageMagick settings are shared within a Node.js process. Pixel buffers are snapshots that remain valid after image mutation or disposal; use `setPixel` / `setArea` to write pixels. Encoded output views retain their native allocation until garbage collection. External buffers cannot be transferred to another worker; copy them first.
+
+## Upstream compatibility
+
+All **770 upstream tests** are retained. Source and fixture hashes are verified before generation, and the complete reviewed patch is checked in at `patches.gen/magick-wasm.patch`. No tests are skipped. CI runs the full suite against both the source facade and a clean npm installation on Node.js 24 and 22, including upstream CommonJS and ESM distribution checks. Seven additional tests cover native bounds, ownership, asynchronous output, and worker isolation.
+
+Five assertions have approved native portability patches: AVIF/JPEG XL encoding validates bounded output size, decoded dimensions/format, and RMS distortion below 0.03; quantization allows RMS drift below 0.00005; remapping allows at most eight pixels of count drift while preserving the palette and total count; polynomial uses a defined zero exponent for its final constant, correcting an upstream out-of-bounds read. The rest of the upstream behavior assertions are retained. The facade also corrects upstream's OffsetInfo use of PrimaryInfo setters.
+
+ImageMagick 7.1.2-32 and the upstream static codec SDK are pinned and verified. Build patches preserve WASM exception tags, seeded random behavior, and resource defaults. Full licenses, the codec SBOM, source revisions, and relinking instructions accompany the platform artifacts; see `THIRD_PARTY_NOTICES.md`.
+
+## Development
+
+```sh
+vp install
+vp run build:deps
+vp run build
+vp check
+vp test
+vp run test:upstream
+vp run check:rust
+```
+
+POSIX builds require Clang C/C++ compilers, make, autoconf, automake, libtool, and pkg-config. Windows builds require Visual Studio 2026 C++ tools and LLVM/libclang. All codecs are downloaded as checksum-verified build SDKs. `vp run patch:upstream` regenerates reviewed patches; `vp run verify:upstream` checks upstream hashes and patch drift. Vite+ bundles the facade and publishing helper; helper packages are development dependencies only.
+
+GitHub Actions assembles and tests all four platform packages. Version tags matching `package.json` use the `npm` environment and OIDC publishing. An initial npm publication and registry-side trusted publisher registration are needed before the first automated release.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,9 @@
+This package includes the Apache-2.0 magick-wasm facade and Magick.Native compatibility shim, magick_rust, and ImageMagick with its codec libraries. Original copyright notices remain in the vendored source. Full license texts are in `licenses/`, and each platform package includes its upstream codec SBOM and exact source revisions.
+
+The pinned ImageMagick/Dependencies SDK is release 2026.09.26.1516; archive SHA-256 digests are enforced by `scripts/build-deps.mjs`. The upstream dependency source revisions are recorded in `vendor/dependency-sources.json`. Their complete corresponding source is available at `https://github.com/ImageMagick/<name>/tree/<revision>` for every entry. Optional codec source licenses are included conservatively even when that codec is disabled in this build. LibRaw is available under LGPL-2.1 or CDDL-1.0; both license texts are provided.
+
+To rebuild or relink the addon with modified codec libraries, replace the libraries in `.native/dependencies/lib` and run `vp run build:deps -- --force`, then `vp run build:native`. The GitHub build artifacts include the static engine and compatibility libraries, Rust build intermediates, and these instructions for relinking. No build tools are required to install or use the npm packages.
+
+The SDK uses the MIT proxy-libintl implementation, pinned by GLib to tag 0.1 (commit e792f40de9b2d5c660003276c022ba8d3038fe62), whose license is included. Rust dependency license texts are included conservatively in `licenses/rust/`; exact crate revisions and checksums are in Cargo.lock.
+
+magick_rust 2.1.1 is vendored with a one-line Windows import fix recorded in `patches.gen/magick-rust.patch`. Its original crate checksum and the complete vendored source hashes are recorded in `vendor/upstream.json`.