@qrdx/cli 0.0.6 → 0.0.8

package/README.md

@@ -2,9 +2,6 @@
 
 QR code generator CLI for developers. Generate styled, scannable QR codes as SVG, PNG, WebP or vector EPS. It runs non-interactively in scripts and CI, and guides you with prompts when run in a terminal. It renders with the same [`qrdx`](https://www.npmjs.com/package/qrdx) library as the [QRdx](https://qrdx.dev) web app.
 
-> [!NOTE]
-> This README documents `@qrdx/cli` 0.0.6, the version in this repository. WebP output is new in 0.0.6; 0.0.5 has every other option here. Run `npm view @qrdx/cli version` to see what npm installs. Until it is 0.0.6, get WebP from the [image API](https://qrdx.dev/docs/developers/image-api): `curl -o qr.webp "https://api.qrdx.dev/v1/qr?data=https://example.com&format=webp"`.
-
 ## Install
 
 Run without installing:

package/dist/index.js

@@ -3,6 +3,7 @@ import { readFileSync, mkdirSync, writeFileSync, createReadStream } from 'fs';
 import { join, resolve, extname } from 'path';
 import { readFile } from 'fs/promises';
 import { BODY_PATTERN, CORNER_EYE_PATTERNS, CORNER_EYE_DOT_PATTERNS, getTemplateIds, FRAME_STYLES, DEFAULT_FRAME_TEXT, FRAME_TEXT_MAX_LENGTH, DEFAULT_MARGIN, getFrameDimensions, colorConfigSchema, errorLevelSchema, QRCodeSVG, svgToEPS } from 'qrdx';
+import { getQRAsPNG } from 'qrdx/node';
 import { createElement } from 'react';
 import { renderToStaticMarkup } from 'react-dom/server';
 import * as readline from 'readline';
@@ -138,7 +139,6 @@ var OUTPUT_FORMATS = [
   "webp",
   "eps"
 ];
-var encodeRaster = (image, format) => format === "webp" ? image.webp({ lossless: true }) : image.png();
 function buildSVGString(props) {
   const element = createElement(QRCodeSVG, {
     size: props.size ?? 512,
@@ -198,24 +198,6 @@ async function buildEPSString(props) {
   }
   return await svgToEPS(buildSVGString(epsProps));
 }
-async function findLogoBox(sharp, svgString) {
-  const imageTag = svgString.match(/<image\b[^>]*?(?:\/>|><\/image>)/)?.[0];
-  if (!imageTag) {
-    return null;
-  }
-  const markerTag = imageTag.replace(/^<image\b/, '<rect class="qrdx-logo-box"').replace(/\shref="[^"]*"/, "").replace(/(?:\/>|><\/image>)$/, ' fill="#000"/>');
-  const markerSvg = svgString.replace(imageTag, markerTag).replace(
-    /<svg\b[^>]*>/,
-    (open) => `${open}<style>*{visibility:hidden}.qrdx-logo-box{visibility:visible}</style>`
-  );
-  const { info } = await sharp(Buffer.from(markerSvg, "utf-8")).png().trim().toBuffer({ resolveWithObject: true });
-  return {
-    left: -(info.trimOffsetLeft ?? 0),
-    top: -(info.trimOffsetTop ?? 0),
-    width: info.width,
-    height: info.height
-  };
-}
 async function saveOutput(options) {
   const { outputPath, format, ...qrProps } = options;
   const svgString = buildSVGString(qrProps);
@@ -229,33 +211,24 @@ ${svgString}`;
     writeFileSync(outputPath, await buildEPSString(qrProps), "utf-8");
     return;
   }
+  const pngBytes = await getQRAsPNG(qrProps, {
+    size: qrProps.size ?? 512,
+    loadExternalLogos: true
+  });
+  if (format === "png") {
+    writeFileSync(outputPath, pngBytes);
+    return;
+  }
   let sharp;
   try {
     const mod = await import('sharp');
     sharp = mod.default;
   } catch {
     throw new Error(
-      `${format === "webp" ? "WebP" : "PNG"} output needs the sharp package (native binaries). It is optional and may not have installed; use SVG or reinstall: https://sharp.pixelplumbing.com/install`
+      "WebP output needs the sharp package (native binaries). It is optional and may not have installed; use SVG or reinstall: https://sharp.pixelplumbing.com/install"
     );
   }
-  const svgBuffer = Buffer.from(svgString, "utf-8");
-  const size = qrProps.size ?? 512;
-  const { width, height } = getFrameDimensions(size, qrProps.frame);
-  const qrImage = sharp(svgBuffer).resize(
-    Math.round(width),
-    Math.round(height)
-  );
-  const logoSrc = qrProps.imageSettings?.src;
-  const box = logoSrc ? await findLogoBox(sharp, svgString) : null;
-  if (!(logoSrc && box)) {
-    await encodeRaster(qrImage, format).toFile(outputPath);
-    return;
-  }
-  const logo = await sharp(await loadLogo(logoSrc)).resize(box.width, box.height, { fit: "fill" }).png().toBuffer();
-  const composited = sharp(await qrImage.png().toBuffer()).composite([
-    { input: logo, left: box.left, top: box.top }
-  ]);
-  await encodeRaster(composited, format).toFile(outputPath);
+  await sharp(Buffer.from(pngBytes)).webp({ lossless: true }).toFile(outputPath);
 }
 var RESET = "\x1B[0m";
 var TEXT = "\x1B[38;5;145m";
@@ -563,7 +536,7 @@ function isCancel2(value) {
 function handleCancel() {
   p.cancel("Cancelled.");
   console.error(
-    `${DIM}Tip:${RESET} ${TEXT}qrdx generate "https://\u2026" -o qr.svg${RESET} \u2014 local dev: ${TEXT}pnpm qrdx -- generate \u2026${RESET}`
+    `${DIM}Tip:${RESET} ${TEXT}qrdx generate "https://\u2026" -o qr.svg${RESET} \u2014 local dev: ${TEXT}bun run qrdx generate \u2026${RESET}`
   );
   process.exit(0);
 }
@@ -1262,7 +1235,7 @@ ${BOLD}Generate Options:${RESET3}
   --dot               Corner dot pattern, e.g.:
                         ${DIM3}square, rounded, circle, leaf, drop, squircle,${RESET3}
                         ${DIM3}octagon, flower, heart, plus, dots${RESET3}
-                        ${DIM3}All options: https://qrdx.dev/docs/styles${RESET3}
+                        ${DIM3}All options: https://qrdx.dev/docs/styles?ref=cli${RESET3}
   --fg                Foreground color \u2014 hex or JSON gradient  ${DIM3}(default: #000000)${RESET3}
   --bg                Background color \u2014 hex or JSON gradient  ${DIM3}(default: #ffffff)${RESET3}
   --eye-color         Corner eye color \u2014 hex or JSON gradient  ${DIM3}(default: matches --fg)${RESET3}
@@ -1276,7 +1249,7 @@ ${BOLD}Generate Options:${RESET3}
   --frame             Call-to-action frame (adds space around the code), e.g.:
                         ${DIM3}none, banner-bottom, banner-top, rounded-border,${RESET3}
                         ${DIM3}speech-bubble, polaroid, phone, ticket, sticker${RESET3}
-                        ${DIM3}All frames: https://qrdx.dev/docs/styles${RESET3}
+                        ${DIM3}All frames: https://qrdx.dev/docs/styles?ref=cli${RESET3}
   --frame-text        Frame label, up to 24 characters  ${DIM3}(default: Scan me; "" hides it)${RESET3}
   --frame-color       Frame color \u2014 hex  ${DIM3}(default: #000000)${RESET3}
   --frame-text-color  Frame label color \u2014 hex  ${DIM3}(default: white on banners)${RESET3}
@@ -1318,7 +1291,7 @@ ${BOLD}Examples:${RESET3}
   ${DIM3}$${RESET3} qrdx batch products.csv -o codes --format png --size 1024 --body circle
   ${DIM3}$${RESET3} qrdx generate "https://qrdx.dev" --fg '{"type":"linear","stops":[{"color":"#6366f1","offset":0},{"color":"#ec4899","offset":100}],"angle":135}' -o gradient.svg
 
-  Visit ${TEXT3}https://qrdx.dev${RESET3} for more.
+  Visit ${TEXT3}https://qrdx.dev/?ref=cli${RESET3} for more.
 `);
 }
 async function main() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qrdx/cli",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "QR code generator CLI for developers: styled SVG, PNG, WebP and vector EPS QR codes from the command line",
   "keywords": [
     "qr-code",
@@ -32,38 +32,39 @@
     "dist",
     "README.md"
   ],
+  "scripts": {
+    "qrdx": "node ./dist/index.js",
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "git clean -xdf .cache .turbo dist node_modules",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "node -e \"if(!(process.env.npm_config_user_agent||'').startsWith('bun/')){console.error('Publish through the Publish workflow, or with bun publish, which replaces workspace ranges with real versions.');process.exit(1)}\" && bun run build && bun run test && node ../qrdx/scripts/readme-catalogue.mjs --check"
+  },
   "dependencies": {
     "@clack/prompts": "^1.8.1",
     "picocolors": "^1.1.1",
+    "qrdx": "0.0.50",
     "react": "19.3.1",
-    "react-dom": "19.3.1",
-    "qrdx": "0.0.48"
+    "react-dom": "19.3.1"
   },
   "optionalDependencies": {
     "sharp": "^0.35.5"
   },
   "devDependencies": {
+    "@repo/typescript-config": "0.0.0",
     "@types/node": "^26.6.6",
     "@types/react": "19.3.0",
     "@types/react-dom": "19.3.0",
     "tsup": "^9.0.0",
     "typescript": "6.0.3",
-    "vitest": "^5.0.5",
-    "@repo/typescript-config": "0.0.0"
+    "vitest": "^5.0.5"
   },
   "engines": {
     "node": ">=22"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "qrdx": "node ./dist/index.js",
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "clean": "git clean -xdf .cache .turbo dist node_modules",
-    "typecheck": "tsc --noEmit"
   }
-}
+}