format-png 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+## 0.2.0
+
+The WebAssembly module is now embedded in the package, and `init()` with no
+argument uses it, in browsers, bundlers, Web Workers and Node alike. Nothing is
+fetched: the package makes no network requests.
+
+### Breaking
+
+- The `.wasm` file is no longer in the package, so the
+  `format-png/format_png_wasm_bg.wasm` export is gone.
+- `init` no longer takes a URL or string to fetch the module from. It still
+  takes a compiled `WebAssembly.Module`.
+
+### Upgrading
+
+- Node: replace `init(await readFile(...format_png_wasm_bg.wasm...))` with
+  `init()`.
+- Browsers and bundlers: `init()` keeps working as before. With Vite,
+  `optimizeDeps: { exclude: ["format-png"] }` is no longer needed.
+- If you passed a URL to `init`, call `init()` instead.
+
+## 0.1.2
+
+- Built against the `format-png` crate 0.1.1. The API and behavior are unchanged.
+- Released with npm staged publishing: each version is approved by a maintainer
+  with 2FA before it goes live, and is published with provenance.
+- README: badges for npm, CI and the license.
+
+## 0.1.1
+
+- The first version released from GitHub Actions, with provenance. The code is
+  the same as 0.1.0.
+
+## 0.1.0
+
+The first release: the `format-png` crate compiled to WebAssembly, with a
+TypeScript API for decoding, encoding, reading chunks and making PNGs smaller.

package/README.md

@@ -1,5 +1,9 @@
 # format-png
 
+[![npm](https://img.shields.io/npm/v/format-png.svg)](https://www.npmjs.com/package/format-png)
+[![CI](https://github.com/YohanSandun/format-png-web/actions/workflows/ci.yml/badge.svg)](https://github.com/YohanSandun/format-png-web/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/YohanSandun/format-png-web/blob/main/LICENSE)
+
 A PNG decoder and encoder for the browser and Node, compiled from Rust to WebAssembly.
 
 - **Decodes every PNG:** every color type, bit depth from 1 to 16, and Adam7 interlacing. Decode to 8-bit RGBA for a canvas, or in the file's own format with nothing lost.
@@ -17,9 +21,7 @@ npm install format-png
 
 ## Load the module
 
-Call `init()` once before anything else.
-
-**Browsers and bundlers** (Vite, webpack, Rollup, esbuild): the `.wasm` file is fetched from next to the module.
+Call `init()` once before anything else. It works the same in browsers, bundlers (Vite, webpack, Rollup, esbuild), Web Workers and Node 20.6 and later: the WebAssembly module is embedded in the package, so nothing is fetched and no bundler setup is needed.
 
 ```js
 import { init } from "format-png";
@@ -27,23 +29,7 @@ import { init } from "format-png";
 await init();
 ```
 
-With Vite, exclude the package from dependency pre-bundling, so the module stays next to its `.wasm` file:
-
-```js
-// vite.config.js
-export default { optimizeDeps: { exclude: ["format-png"] } };
-```
-
-**Node 20.6 and later**: pass the file's bytes.
-
-```js
-import { readFile } from "node:fs/promises";
-import { init } from "format-png";
-
-await init(await readFile(new URL(import.meta.resolve("format-png/format_png_wasm_bg.wasm"))));
-```
-
-`init` also takes a URL to fetch the module from, or a compiled `WebAssembly.Module`.
+`init` also takes a compiled `WebAssembly.Module`, for example one a page compiled once and posted to its workers.
 
 ## Display a PNG
 

package/dist/index.d.ts

@@ -300,17 +300,12 @@ export declare class PngError extends Error {
  * Loads the WebAssembly module. Call it once before anything else; later calls
  * return the same promise.
  *
- * In browsers and bundlers, call it with no argument: the `.wasm` file is
- * fetched from next to this module. In Node, pass its bytes:
- *
- * ```js
- * import { readFile } from "node:fs/promises";
- * await init(await readFile(new URL(import.meta.resolve("format-png/format_png_wasm_bg.wasm"))));
- * ```
- *
- * You can also pass a URL to fetch it from, or a compiled `WebAssembly.Module`.
+ * With no argument it uses the copy embedded in this package, in browsers,
+ * bundlers and Node alike: nothing is fetched. You can instead pass a
+ * `WebAssembly.Module` compiled from it, for example one a page compiled once
+ * and posted to its workers.
  */
-export declare function init(source?: BufferSource | WebAssembly.Module | URL | string): Promise<void>;
+export declare function init(source?: BufferSource | WebAssembly.Module | Response | Promise<Response>): Promise<void>;
 /**
  * Decodes a PNG in its own format, without conversion: every bit depth and
  * color type as stored, with its palette and transparency. Pass the result to

package/dist/index.js

@@ -1,4 +1,5 @@
 import initWasm, * as wasm from "./wasm/format_png_wasm.js";
+import wasmBase64 from "./wasm/format_png_wasm_bg.wasm.base64.js";
 /** Thrown for malformed PNGs; `message` says what's wrong. */
 export class PngError extends Error {
     name = "PngError";
@@ -9,18 +10,13 @@ let initialized = false;
  * Loads the WebAssembly module. Call it once before anything else; later calls
  * return the same promise.
  *
- * In browsers and bundlers, call it with no argument: the `.wasm` file is
- * fetched from next to this module. In Node, pass its bytes:
- *
- * ```js
- * import { readFile } from "node:fs/promises";
- * await init(await readFile(new URL(import.meta.resolve("format-png/format_png_wasm_bg.wasm"))));
- * ```
- *
- * You can also pass a URL to fetch it from, or a compiled `WebAssembly.Module`.
+ * With no argument it uses the copy embedded in this package, in browsers,
+ * bundlers and Node alike: nothing is fetched. You can instead pass a
+ * `WebAssembly.Module` compiled from it, for example one a page compiled once
+ * and posted to its workers.
  */
 export function init(source) {
-    ready ??= initWasm(source === undefined ? undefined : { module_or_path: source })
+    ready ??= initWasm({ module_or_path: source ?? decodeBase64(wasmBase64) })
         .then(() => {
         initialized = true;
     })
@@ -30,6 +26,13 @@ export function init(source) {
     });
     return ready;
 }
+function decodeBase64(text) {
+    const binary = atob(text);
+    const bytes = new Uint8Array(binary.length);
+    for (let i = 0; i < binary.length; i++)
+        bytes[i] = binary.charCodeAt(i);
+    return bytes;
+}
 function call(fn) {
     if (!initialized)
         throw new PngError("format-png: call init() first");

package/dist/wasm/format_png_wasm.js

@@ -1501,13 +1501,10 @@ async function __wbg_init(module_or_path) {
     }
 
     if (module_or_path === undefined) {
-        module_or_path = new URL('format_png_wasm_bg.wasm', import.meta.url);
+        throw new Error("format-png: no WebAssembly module given");
     }
     const imports = __wbg_get_imports();
 
-    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
-        module_or_path = fetch(module_or_path);
-    }
 
     const { instance, module } = await __wbg_load(await module_or_path, imports);
 

package/dist/wasm/format_png_wasm_bg.wasm.base64.d.ts

@@ -0,0 +1,3 @@
+/** `format_png_wasm_bg.wasm`, base64-encoded. */
+declare const wasm: string;
+export default wasm;