@gongbaodd/qr-renderer 0.1.0 → 0.1.1

package/README.md

@@ -12,12 +12,17 @@ npm install @gongbaodd/qr-renderer
 import { readFile, writeFile } from 'node:fs/promises'
 import { renderRecipeFile } from '@gongbaodd/qr-renderer/node'
 
-const { png, filename } = await renderRecipeFile(await readFile('mahu-qr.recipe.json'), { artifact: 'poster.png' })
+const { png, filename } = await renderRecipeFile(await readFile('mahu-qr.recipe.json'), {
+  artifact: 'poster.png',
+  content: 'https://example.com/new',
+})
 await writeFile(filename, png)
 ```
 
 `poster.png` is the default and contains the full assembled poster. Select `{ artifact: 'qr.png' }` for the standalone transparent QR image. The API returns `Uint8Array` PNG bytes and the matching filename; it does not read or write filesystem paths itself.
 
+Set the optional `content` option to replace the recipe's saved QR text for this render while preserving its poster, placement, and settings. It must be non-empty, one line, and within QR capacity.
+
 `renderRecipeFile(input, options?)` accepts UTF-8 JSON text or bytes. `renderRecipeJson(value, options?)` accepts an already parsed JSON value. Both validate the recipe schema and renderer version, enforce recipe and PNG limits, verify embedded image SHA-256 digests and dimensions, and run the normal assembly validation before returning an image. Invalid or unsupported recipes reject with an error. Inputs are processed locally: recipe content is never fetched, and this package makes no network requests.
 
 Recipes are versioned rendering inputs. A package release does not promise replay of renderer versions it does not support. Keep the recipe with its source assets and use a compatible renderer release for long-term reproduction.

package/dist/node.js

@@ -3083,8 +3083,9 @@ async function sha256Hex(bytes) {
   const digest = await crypto.subtle.digest("SHA-256", bytes.slice().buffer);
   return [...new Uint8Array(digest)].map((byte) => byte.toString(16).padStart(2, "0")).join("");
 }
-async function renderRecipe(imaging2, rawRecipe, artifact) {
+async function renderRecipe(imaging2, rawRecipe, artifact, contentOverride) {
   const recipe = recipeSchema.parse(rawRecipe);
+  const content = contentOverride === void 0 ? recipe.content : contentSchema.parse(contentOverride);
   const poster = fromBase64(recipe.source.poster.data);
   const regionMask = fromBase64(recipe.source.regionMask.data);
   const [posterSha, maskSha] = await Promise.all([sha256Hex(poster), sha256Hex(regionMask)]);
@@ -3099,7 +3100,7 @@ async function renderRecipe(imaging2, rawRecipe, artifact) {
     posterBytes: poster,
     maskBytes: regionMask,
     transparentBlank: recipe.source.transparentBlank,
-    content: recipe.content,
+    content,
     placement: recipe.placement,
     ...settings
   });
@@ -3111,7 +3112,7 @@ async function renderRecipe(imaging2, rawRecipe, artifact) {
 // src/node.ts
 async function renderRecipeJson(rawRecipe, options = {}) {
   const artifact = options.artifact ?? "poster.png";
-  const result = await renderRecipe(nodeImaging, rawRecipe, artifact);
+  const result = await renderRecipe(nodeImaging, rawRecipe, artifact, options.content);
   return { png: new Uint8Array(await result.png.arrayBuffer()), filename: result.filename };
 }
 async function renderRecipeFile(input, options = {}) {

package/dist/types/node.d.ts

@@ -2,6 +2,7 @@ import { type PortableRecipe } from './recipe';
 export type RecipeArtifact = 'poster.png' | 'qr.png';
 export interface RenderRecipeOptions {
     artifact?: RecipeArtifact;
+    content?: string;
 }
 export interface RenderRecipeResult {
     png: Uint8Array;

package/dist/types/recipe.d.ts

@@ -126,7 +126,7 @@ export declare const recipeSchema: z.ZodObject<{
 }, z.core.$strict>;
 export type PortableRecipe = z.infer<typeof recipeSchema>;
 export declare function createRecipeBlob(input: AssembleInput, finalMask: Blob): Promise<Blob>;
-export declare function renderRecipe(imaging: Imaging, rawRecipe: unknown, artifact: 'poster.png' | 'qr.png'): Promise<{
+export declare function renderRecipe(imaging: Imaging, rawRecipe: unknown, artifact: 'poster.png' | 'qr.png', contentOverride?: string): Promise<{
     png: Blob;
     filename: string;
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gongbaodd/qr-renderer",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Generate artistic QR posters from mahu-QR portable recipe JSON.",
   "license": "MIT",
   "repository": {

package/src/node.ts

@@ -6,6 +6,7 @@ export type RecipeArtifact = 'poster.png' | 'qr.png'
 
 export interface RenderRecipeOptions {
   artifact?: RecipeArtifact
+  content?: string
 }
 
 export interface RenderRecipeResult {
@@ -19,7 +20,7 @@ export async function renderRecipeJson(
   options: RenderRecipeOptions = {},
 ): Promise<RenderRecipeResult> {
   const artifact = options.artifact ?? 'poster.png'
-  const result = await renderRecipe(nodeImaging, rawRecipe, artifact)
+  const result = await renderRecipe(nodeImaging, rawRecipe, artifact, options.content)
   return { png: new Uint8Array(await result.png.arrayBuffer()), filename: result.filename as RecipeArtifact }
 }
 

package/src/recipe.ts

@@ -129,8 +129,10 @@ export async function renderRecipe(
   imaging: Imaging,
   rawRecipe: unknown,
   artifact: 'poster.png' | 'qr.png',
+  contentOverride?: string,
 ): Promise<{ png: Blob; filename: string }> {
   const recipe = recipeSchema.parse(rawRecipe)
+  const content = contentOverride === undefined ? recipe.content : contentSchema.parse(contentOverride)
   const poster = fromBase64(recipe.source.poster.data)
   const regionMask = fromBase64(recipe.source.regionMask.data)
   const [posterSha, maskSha] = await Promise.all([sha256Hex(poster), sha256Hex(regionMask)])
@@ -151,7 +153,7 @@ export async function renderRecipe(
     posterBytes: poster,
     maskBytes: regionMask,
     transparentBlank: recipe.source.transparentBlank,
-    content: recipe.content,
+    content,
     placement: recipe.placement,
     ...settings,
   })