@wirunrom/hqr-generate 0.2.2 → 0.2.22

package/README.md

@@ -1,6 +1,6 @@
 # @wirunrom/hqr-generate
 
-A **stable black-and-white QR Code generator** that returns a **PNG Data URL or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
+A **stable black-and-white QR Code generator** that returns **PNG Data URLs or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
 
 This library is designed with a **scan-reliability-first** mindset and a **frontend-first API**, making it easy to use in modern web applications without additional configuration.
 
@@ -12,11 +12,11 @@ This library is designed with a **scan-reliability-first** mindset and a **front
 - Optimized for both **old and new mobile devices**
 - Deterministic and consistent QR output
 - Lightweight and fast (**Rust + WASM**)
-- Supports both:
+- Supports:
   - **PNG Data URL** (simple usage)
-  - **PNG raw bytes** (best performance)
+  - **PNG raw bytes** (best performance, no Base64 overhead)
 - Works out of the box with:
-  - Plain HTML
+  - Plain HTML / JavaScript
   - React
   - Next.js (Pages Router & App Router)
   - Modern bundlers (Vite, Webpack, etc.)
@@ -29,33 +29,52 @@ This library is designed with a **scan-reliability-first** mindset and a **front
 npm install @wirunrom/hqr-generate
 ```
 
-## Basic Usage (Browser / React / Next.js)
+## Basic Usage (Bundler / React / Next.js)
 
-Generate PNG Data URL (simple & compatible)
+**Generate PNG Data URL**
+
+Simple and widely compatible. Recommended for most use cases.
 
 ```ts
-import { qr_png_data_url } from "@wirunrom/hqr-generate";
+import { qrPngDataUrl } from "@wirunrom/hqr-generate";
+
+const src = await qrPngDataUrl("hello world", {
+  size: 320,
+  margin: 4,
+  ecc: "Q",
+});
 
-const src = await qr_png_data_url("hello", 320, 4, "Q");
 <img src={src} alt="QR Code" />
 ```
 
-Generate PNG Bytes
+**Generate PNG Bytes (Best Performance)**
+
 Using raw bytes avoids Base64 overhead and is more memory-efficient.
 
 ```ts
-import { qr_png_bytes } from "@wirunrom/hqr-generate";
+import { qrPngBytes } from "@wirunrom/hqr-generate";
 
-const bytes = await qr_png_bytes("hello", 320, 4, "Q");
-const url = URL.createObjectURL(new Blob([bytes], { type: "image/png" }));
+const bytes = await qrPngBytes("hello world", {
+  size: 320,
+  margin: 4,
+  ecc: "Q",
+});
+
+const url = URL.createObjectURL(
+  new Blob([bytes], { type: "image/png" })
+);
 
 <img src={url} alt="QR Code" />
+
 ```
 
-## React Hook Helper
+## React Hook Helper (/react)
+
+For React or Next.js applications, the library provides idiomatic React hooks that automatically update when inputs change.
 
 **useQrPngDataUrl**
-A React hook that generates a PNG Data URL and updates automatically when inputs change.
+
+Generates a PNG Data URL and updates automatically when dependencies change.
 
 ```ts
 import { useQrPngDataUrl } from "@wirunrom/hqr-generate/react";
@@ -73,7 +92,9 @@ function QR() {
 ```
 
 **useQrPngBlobUrl**
-A React hook that generates a Blob URL and updates automatically when inputs change.
+
+Generates a Blob URL instead of a Base64 Data URL.
+Recommended for larger QR codes or frequent updates.
 
 ```ts
 import { useQrPngBlobUrl } from "@wirunrom/hqr-generate/react";
@@ -90,21 +111,37 @@ function QR() {
 }
 ```
 
-## API Reference
+## Plain HTML / No Bundler (/web)
 
-**qr_png_data_url(text, size?, margin?, ecc?)**
-Generate a QR code and return a PNG Data URL.
+Use this entry when working with static HTML, CDN, or environments without a bundler.
 
-| Name   | Type                       | Default | Description                  |
-| ------ | -------------------------- | ------- | ---------------------------- |
-| text   | `string`                   | —       | Text to encode               |
-| size   | `number`                   | `320`   | Image size in pixels         |
-| margin | `number`                   | `4`     | Quiet zone (recommended ≥ 4) |
-| ecc    | `"L" \| "M" \| "Q" \| "H"` | `"Q"`   | Error correction level       |
+```html
+<script type="module">
+  import { qr_png_bytes, qr_png_data_url } from "@wirunrom/hqr-generate/web";
 
-**qr_png_bytes(text, size?, margin?, ecc?)**
-Generate a QR code and return PNG raw bytes (Uint8Array).
-This is the fastest and most memory-efficient option.
+  const src = await qr_png_bytes("hello world", {
+    size: 320,
+    margin: 4,
+    ecc: "Q",
+  });
+
+  // or
+
+  const src = await qr_png_data_url("hello world", {
+    size: 320,
+    margin: 4,
+    ecc: "Q",
+  });
+
+  document.getElementById("qr").src = src;
+</script>
+
+<img id="qr" />
+```
+
+## API Reference
+
+Generate a QR code and return a PNG Data URL.
 
 | Name   | Type                       | Default | Description                  |
 | ------ | -------------------------- | ------- | ---------------------------- |

package/index.bundler.js

@@ -5,6 +5,19 @@ import init, {
 
 let _initPromise;
 
+function eccToU8(ecc) {
+  switch (ecc) {
+    case "L":
+      return 0;
+    case "M":
+      return 1;
+    case "H":
+      return 3;
+    default:
+      return 2;
+  }
+}
+
 async function ensureInit() {
   if (!_initPromise) _initPromise = init();
   await _initPromise;
@@ -12,10 +25,10 @@ async function ensureInit() {
 
 export async function qr_png_data_url(text, size = 320, margin = 4, ecc = "Q") {
   await ensureInit();
-  return _qr_png_data_url(text, size, margin, ecc);
+  return _qr_png_data_url(text, size, margin, eccToU8(ecc));
 }
 
 export async function qr_png_bytes(text, size = 320, margin = 4, ecc = "Q") {
   await ensureInit();
-  return _qr_png_bytes(text, size, margin, ecc);
+  return _qr_png_bytes(text, size, margin, eccToU8(ecc));
 }

package/index.web.js

@@ -5,6 +5,19 @@ import init, {
 
 let _initPromise;
 
+function eccToU8(ecc) {
+  switch (ecc) {
+    case "L":
+      return 0;
+    case "M":
+      return 1;
+    case "H":
+      return 3;
+    default:
+      return 2;
+  }
+}
+
 /** @returns {Promise<void>} */
 async function ensureInit() {
   if (!_initPromise) _initPromise = init();
@@ -20,10 +33,10 @@ async function ensureInit() {
  */
 export async function qr_png_data_url(text, size = 320, margin = 4, ecc = "Q") {
   await ensureInit();
-  return _qr_png_data_url(text, size, margin, ecc);
+  return _qr_png_data_url(text, size, margin, eccToU8(ecc));
 }
 
 export async function qr_png_bytes(text, size = 320, margin = 4, ecc = "Q") {
   await ensureInit();
-  return _qr_png_bytes(text, size, margin, ecc);
+  return _qr_png_bytes(text, size, margin, eccToU8(ecc));
 }

package/package.json

@@ -1,27 +1,28 @@
 {
   "name": "@wirunrom/hqr-generate",
-  "version": "0.2.2",
+  "version": "0.2.22",
   "description": "Stable black/white QR code generator (PNG data URL) powered by Rust + WASM",
+  "license": "MIT",
   "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wirunrom/hqr-generate.git"
+  },
+  "homepage": "https://github.com/wirunrom/hqr-generate#readme",
   "files": [
     "pkg/**",
     "index.web.js",
     "index.bundler.js",
     "index.d.ts",
     "react/**",
-    "bundler/**",
     "README.md",
     "LICENSE"
   ],
-  "main": "./index.web.js",
-  "module": "./index.web.js",
   "types": "./index.d.ts",
+  "main": "./index.bundler.js",
+  "module": "./index.bundler.js",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "default": "./index.web.js"
-    },
-    "./bundler": {
       "types": "./index.d.ts",
       "default": "./index.bundler.js"
     },
@@ -29,14 +30,18 @@
       "types": "./react/index.d.ts",
       "default": "./react/index.js"
     },
-    "./bundler/react": {
-      "types": "./bundler/react.d.ts",
-      "default": "./bundler/react.js"
+    "./web": {
+      "types": "./index.d.ts",
+      "default": "./index.web.js"
     }
   },
   "peerDependencies": {
-    "react": ">=17",
-    "react-dom": ">=17"
+    "react": ">=17"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
   },
   "scripts": {
     "clean": "rm -rf pkg",
@@ -50,8 +55,10 @@
   "keywords": [
     "qrcode",
     "qr",
+    "rust",
     "wasm",
-    "rust"
-  ],
-  "license": "MIT"
+    "react",
+    "png",
+    "performance"
+  ]
 }

package/pkg/bundler/README.md

@@ -1,6 +1,6 @@
 # @wirunrom/hqr-generate
 
-A **stable black-and-white QR Code generator** that returns a **PNG Data URL or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
+A **stable black-and-white QR Code generator** that returns **PNG Data URLs or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
 
 This library is designed with a **scan-reliability-first** mindset and a **frontend-first API**, making it easy to use in modern web applications without additional configuration.
 
@@ -12,11 +12,11 @@ This library is designed with a **scan-reliability-first** mindset and a **front
 - Optimized for both **old and new mobile devices**
 - Deterministic and consistent QR output
 - Lightweight and fast (**Rust + WASM**)
-- Supports both:
+- Supports:
   - **PNG Data URL** (simple usage)
-  - **PNG raw bytes** (best performance)
+  - **PNG raw bytes** (best performance, no Base64 overhead)
 - Works out of the box with:
-  - Plain HTML
+  - Plain HTML / JavaScript
   - React
   - Next.js (Pages Router & App Router)
   - Modern bundlers (Vite, Webpack, etc.)
@@ -29,33 +29,52 @@ This library is designed with a **scan-reliability-first** mindset and a **front
 npm install @wirunrom/hqr-generate
 ```
 
-## Basic Usage (Browser / React / Next.js)
+## Basic Usage (Bundler / React / Next.js)
 
-Generate PNG Data URL (simple & compatible)
+**Generate PNG Data URL**
+
+Simple and widely compatible. Recommended for most use cases.
 
 ```ts
-import { qr_png_data_url } from "@wirunrom/hqr-generate";
+import { qrPngDataUrl } from "@wirunrom/hqr-generate";
+
+const src = await qrPngDataUrl("hello world", {
+  size: 320,
+  margin: 4,
+  ecc: "Q",
+});
 
-const src = await qr_png_data_url("hello", 320, 4, "Q");
 <img src={src} alt="QR Code" />
 ```
 
-Generate PNG Bytes
+**Generate PNG Bytes (Best Performance)**
+
 Using raw bytes avoids Base64 overhead and is more memory-efficient.
 
 ```ts
-import { qr_png_bytes } from "@wirunrom/hqr-generate";
+import { qrPngBytes } from "@wirunrom/hqr-generate";
 
-const bytes = await qr_png_bytes("hello", 320, 4, "Q");
-const url = URL.createObjectURL(new Blob([bytes], { type: "image/png" }));
+const bytes = await qrPngBytes("hello world", {
+  size: 320,
+  margin: 4,
+  ecc: "Q",
+});
+
+const url = URL.createObjectURL(
+  new Blob([bytes], { type: "image/png" })
+);
 
 <img src={url} alt="QR Code" />
+
 ```
 
-## React Hook Helper
+## React Hook Helper (/react)
+
+For React or Next.js applications, the library provides idiomatic React hooks that automatically update when inputs change.
 
 **useQrPngDataUrl**
-A React hook that generates a PNG Data URL and updates automatically when inputs change.
+
+Generates a PNG Data URL and updates automatically when dependencies change.
 
 ```ts
 import { useQrPngDataUrl } from "@wirunrom/hqr-generate/react";
@@ -73,7 +92,9 @@ function QR() {
 ```
 
 **useQrPngBlobUrl**
-A React hook that generates a Blob URL and updates automatically when inputs change.
+
+Generates a Blob URL instead of a Base64 Data URL.
+Recommended for larger QR codes or frequent updates.
 
 ```ts
 import { useQrPngBlobUrl } from "@wirunrom/hqr-generate/react";
@@ -90,21 +111,37 @@ function QR() {
 }
 ```
 
-## API Reference
+## Plain HTML / No Bundler (/web)
 
-**qr_png_data_url(text, size?, margin?, ecc?)**
-Generate a QR code and return a PNG Data URL.
+Use this entry when working with static HTML, CDN, or environments without a bundler.
 
-| Name   | Type                       | Default | Description                  |
-| ------ | -------------------------- | ------- | ---------------------------- |
-| text   | `string`                   | —       | Text to encode               |
-| size   | `number`                   | `320`   | Image size in pixels         |
-| margin | `number`                   | `4`     | Quiet zone (recommended ≥ 4) |
-| ecc    | `"L" \| "M" \| "Q" \| "H"` | `"Q"`   | Error correction level       |
+```html
+<script type="module">
+  import { qr_png_bytes, qr_png_data_url } from "@wirunrom/hqr-generate/web";
 
-**qr_png_bytes(text, size?, margin?, ecc?)**
-Generate a QR code and return PNG raw bytes (Uint8Array).
-This is the fastest and most memory-efficient option.
+  const src = await qr_png_bytes("hello world", {
+    size: 320,
+    margin: 4,
+    ecc: "Q",
+  });
+
+  // or
+
+  const src = await qr_png_data_url("hello world", {
+    size: 320,
+    margin: 4,
+    ecc: "Q",
+  });
+
+  document.getElementById("qr").src = src;
+</script>
+
+<img id="qr" />
+```
+
+## API Reference
+
+Generate a QR code and return a PNG Data URL.
 
 | Name   | Type                       | Default | Description                  |
 | ------ | -------------------------- | ------- | ---------------------------- |

package/pkg/bundler/package.json

@@ -2,11 +2,11 @@
   "name": "hqr-generate",
   "type": "module",
   "description": "Stable black/white QR code generator (PNG data URL) powered by Rust + WASM",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/heart569522/hqr-generate"
+    "url": "https://github.com/wirunrom/hqr-generate"
   },
   "files": [
     "hqr_generate_bg.wasm",

package/pkg/web/README.md

@@ -1,6 +1,6 @@
 # @wirunrom/hqr-generate
 
-A **stable black-and-white QR Code generator** that returns a **PNG Data URL or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
+A **stable black-and-white QR Code generator** that returns **PNG Data URLs or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
 
 This library is designed with a **scan-reliability-first** mindset and a **frontend-first API**, making it easy to use in modern web applications without additional configuration.
 
@@ -12,11 +12,11 @@ This library is designed with a **scan-reliability-first** mindset and a **front
 - Optimized for both **old and new mobile devices**
 - Deterministic and consistent QR output
 - Lightweight and fast (**Rust + WASM**)
-- Supports both:
+- Supports:
   - **PNG Data URL** (simple usage)
-  - **PNG raw bytes** (best performance)
+  - **PNG raw bytes** (best performance, no Base64 overhead)
 - Works out of the box with:
-  - Plain HTML
+  - Plain HTML / JavaScript
   - React
   - Next.js (Pages Router & App Router)
   - Modern bundlers (Vite, Webpack, etc.)
@@ -29,33 +29,52 @@ This library is designed with a **scan-reliability-first** mindset and a **front
 npm install @wirunrom/hqr-generate
 ```
 
-## Basic Usage (Browser / React / Next.js)
+## Basic Usage (Bundler / React / Next.js)
 
-Generate PNG Data URL (simple & compatible)
+**Generate PNG Data URL**
+
+Simple and widely compatible. Recommended for most use cases.
 
 ```ts
-import { qr_png_data_url } from "@wirunrom/hqr-generate";
+import { qrPngDataUrl } from "@wirunrom/hqr-generate";
+
+const src = await qrPngDataUrl("hello world", {
+  size: 320,
+  margin: 4,
+  ecc: "Q",
+});
 
-const src = await qr_png_data_url("hello", 320, 4, "Q");
 <img src={src} alt="QR Code" />
 ```
 
-Generate PNG Bytes
+**Generate PNG Bytes (Best Performance)**
+
 Using raw bytes avoids Base64 overhead and is more memory-efficient.
 
 ```ts
-import { qr_png_bytes } from "@wirunrom/hqr-generate";
+import { qrPngBytes } from "@wirunrom/hqr-generate";
 
-const bytes = await qr_png_bytes("hello", 320, 4, "Q");
-const url = URL.createObjectURL(new Blob([bytes], { type: "image/png" }));
+const bytes = await qrPngBytes("hello world", {
+  size: 320,
+  margin: 4,
+  ecc: "Q",
+});
+
+const url = URL.createObjectURL(
+  new Blob([bytes], { type: "image/png" })
+);
 
 <img src={url} alt="QR Code" />
+
 ```
 
-## React Hook Helper
+## React Hook Helper (/react)
+
+For React or Next.js applications, the library provides idiomatic React hooks that automatically update when inputs change.
 
 **useQrPngDataUrl**
-A React hook that generates a PNG Data URL and updates automatically when inputs change.
+
+Generates a PNG Data URL and updates automatically when dependencies change.
 
 ```ts
 import { useQrPngDataUrl } from "@wirunrom/hqr-generate/react";
@@ -73,7 +92,9 @@ function QR() {
 ```
 
 **useQrPngBlobUrl**
-A React hook that generates a Blob URL and updates automatically when inputs change.
+
+Generates a Blob URL instead of a Base64 Data URL.
+Recommended for larger QR codes or frequent updates.
 
 ```ts
 import { useQrPngBlobUrl } from "@wirunrom/hqr-generate/react";
@@ -90,21 +111,37 @@ function QR() {
 }
 ```
 
-## API Reference
+## Plain HTML / No Bundler (/web)
 
-**qr_png_data_url(text, size?, margin?, ecc?)**
-Generate a QR code and return a PNG Data URL.
+Use this entry when working with static HTML, CDN, or environments without a bundler.
 
-| Name   | Type                       | Default | Description                  |
-| ------ | -------------------------- | ------- | ---------------------------- |
-| text   | `string`                   | —       | Text to encode               |
-| size   | `number`                   | `320`   | Image size in pixels         |
-| margin | `number`                   | `4`     | Quiet zone (recommended ≥ 4) |
-| ecc    | `"L" \| "M" \| "Q" \| "H"` | `"Q"`   | Error correction level       |
+```html
+<script type="module">
+  import { qr_png_bytes, qr_png_data_url } from "@wirunrom/hqr-generate/web";
 
-**qr_png_bytes(text, size?, margin?, ecc?)**
-Generate a QR code and return PNG raw bytes (Uint8Array).
-This is the fastest and most memory-efficient option.
+  const src = await qr_png_bytes("hello world", {
+    size: 320,
+    margin: 4,
+    ecc: "Q",
+  });
+
+  // or
+
+  const src = await qr_png_data_url("hello world", {
+    size: 320,
+    margin: 4,
+    ecc: "Q",
+  });
+
+  document.getElementById("qr").src = src;
+</script>
+
+<img id="qr" />
+```
+
+## API Reference
+
+Generate a QR code and return a PNG Data URL.
 
 | Name   | Type                       | Default | Description                  |
 | ------ | -------------------------- | ------- | ---------------------------- |

package/pkg/web/package.json

@@ -2,11 +2,11 @@
   "name": "hqr-generate",
   "type": "module",
   "description": "Stable black/white QR code generator (PNG data URL) powered by Rust + WASM",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/heart569522/hqr-generate"
+    "url": "https://github.com/wirunrom/hqr-generate"
   },
   "files": [
     "hqr_generate_bg.wasm",

package/react/index.d.ts

@@ -1,4 +1,4 @@
-export type QrEcc = "L" | "M" | "Q" | "H";
+import type { QrEcc } from "../index";
 
 export interface UseQrPngOptions {
   size?: number;

package/bundler/react.d.ts

@@ -1,23 +0,0 @@
-export type QrEcc = "L" | "M" | "Q" | "H";
-
-export interface UseQrPngOptions {
-  size?: number;
-  margin?: number;
-  ecc?: QrEcc;
-}
-
-/**
- * React hook that returns PNG Data URL string (base64).
- */
-export declare function useQrPngDataUrl(
-  text: string,
-  opts?: UseQrPngOptions
-): string;
-
-/**
- * React hook that returns Blob URL string.
- */
-export declare function useQrPngBlobUrl(
-  text: string,
-  opts?: UseQrPngOptions
-): string;

package/bundler/react.js

@@ -1,73 +0,0 @@
-import { useEffect, useState } from "react";
-import { qr_png_data_url, qr_png_bytes } from "../index.bundler.js";
-
-export function useQrPngDataUrl(text, opts) {
-  const size = opts?.size ?? 320;
-  const margin = opts?.margin ?? 4;
-  const ecc = opts?.ecc ?? "Q";
-
-  const [src, setSrc] = useState("");
-
-  useEffect(() => {
-    let alive = true;
-
-    if (!text) {
-      setSrc("");
-      return () => {
-        alive = false;
-      };
-    }
-
-    qr_png_data_url(text, size, margin, ecc)
-      .then((res) => alive && setSrc(res))
-      .catch(() => alive && setSrc(""));
-
-    return () => {
-      alive = false;
-    };
-  }, [text, size, margin, ecc]);
-
-  return src;
-}
-
-/**
- * Faster than base64 data url: uses Blob URL + revokes on cleanup
- */
-export function useQrPngBlobUrl(text, opts) {
-  const size = opts?.size ?? 320;
-  const margin = opts?.margin ?? 4;
-  const ecc = opts?.ecc ?? "Q";
-
-  const [src, setSrc] = useState("");
-
-  useEffect(() => {
-    let alive = true;
-    let objectUrl = "";
-
-    if (!text) {
-      setSrc("");
-      return () => {
-        alive = false;
-        if (objectUrl) URL.revokeObjectURL(objectUrl);
-      };
-    }
-
-    qr_png_bytes(text, size, margin, ecc)
-      .then((bytes) => {
-        if (!alive) return;
-        if (objectUrl) URL.revokeObjectURL(objectUrl);
-        objectUrl = URL.createObjectURL(
-          new Blob([bytes], { type: "image/png" }),
-        );
-        setSrc(objectUrl);
-      })
-      .catch(() => alive && setSrc(""));
-
-    return () => {
-      alive = false;
-      if (objectUrl) URL.revokeObjectURL(objectUrl);
-    };
-  }, [text, size, margin, ecc]);
-
-  return src;
-}