Skip to content

[WC-3336] Barcode generator #2170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gjulivan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[WC-3336] Barcode generator #2170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/pluggableWidgets/barcode-generator-web/src/components/Barcode.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export function BarcodeRenderer({ config }: BarcodeRendererProps): ReactElement

const button = downloadButton && (
<DownloadButton
onClick={() => downloadCode(ref, config.type, downloadButton.fileName)}
onClick={() => downloadCode(ref, config, downloadButton.fileName)}
ariaLabel={downloadButton.label}
caption={downloadButton.caption}
/>
Expand Down
2 changes: 1 addition & 1 deletion packages/pluggableWidgets/barcode-generator-web/src/components/QRCode.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export function QRCodeRenderer({ config }: QRCodeRendererProps): ReactElement {

const button = downloadButton && (
<DownloadButton
onClick={() => downloadCode(ref, config.type, downloadButton.fileName)}
onClick={() => downloadCode(ref, config, downloadButton.fileName)}
ariaLabel={downloadButton.label}
caption={downloadButton.caption}
/>
Expand Down
31 changes: 4 additions & 27 deletions packages/pluggableWidgets/barcode-generator-web/src/config/Barcode.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
interface DownloadButtonConfig {
caption?: string;
label?: string;
fileName: string;
fileName?: string;
buttonPosition: "top" | "bottom";
}

Expand Down Expand Up @@ -65,7 +65,7 @@ export function barcodeConfig(props: BarcodeGeneratorContainerProps): BarcodeCon
? {
caption: props.downloadButtonCaption?.value,
label: props.downloadButtonAriaLabel?.value,
fileName: generateFileName(props.downloadFileName?.value, format, codeValue),
fileName: getFileName(props.downloadFileName?.value),
buttonPosition: props.buttonPosition ?? "bottom"
}
: undefined;
Expand Down Expand Up @@ -119,34 +119,11 @@ export function barcodeConfig(props: BarcodeGeneratorContainerProps): BarcodeCon
};
}

function generateFileName(customFileName: string | undefined, format: string, codeValue: string): string {
function getFileName(customFileName: string | undefined): string | undefined {
// Use custom filename if provided
if (customFileName && customFileName.trim()) {
return customFileName.trim().endsWith(".png") ? customFileName.trim() : `${customFileName.trim()}.png`;
}

// Auto-generate filename with format and hash
const hash = hashCode(codeValue);
if (format === "QRCode") {
return `qrcode_${hash}.png`;
}
return `barcode_${format}_${hash}.png`;
}

function hashCode(s: string): string {
if (!s) {
return "empty";
}

let hash = 0;
for (let i = 0; i < s.length; i++) {
const char = s.charCodeAt(i);
// eslint-disable-next-line no-bitwise
hash = (hash << 5) - hash + char;
// eslint-disable-next-line no-bitwise
hash = hash & hash; // Convert to 32-bit integer
}

// Convert to base36 and take first 10 characters
return Math.abs(hash).toString(36).substring(0, 10);
return undefined; // Let the download function generate a default filename based on content and timestamp
}
24 changes: 17 additions & 7 deletions packages/pluggableWidgets/barcode-generator-web/src/utils/download-code.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
import { RefObject } from "react";
import { convertSvgToPng, downloadBlob, prepareSvgForDownload, processQRImages } from "./download-utils";
import {
convertSvgToPng,
downloadBlob,
prepareSvgForDownload,
processQRImages,
generateFileName
} from "./download-utils";
import { BarcodeConfig } from "../config/Barcode.config";

export async function downloadCode(
ref: RefObject<SVGSVGElement | null>,
type: BarcodeConfig["type"],
fileName: string
config: BarcodeConfig,
fileName?: string
): Promise<void> {
try {
const svgElement = ref.current;
Expand All @@ -15,18 +21,22 @@ export async function downloadCode(
}

const clonedSvg = prepareSvgForDownload(svgElement);

let fileNamePrefix: string = config.type;
// Process overlay images for QR codes
if (type === "qrcode") {
if (config.type === "qrcode") {
await processQRImages(clonedSvg);
} else {
fileNamePrefix = `${config.type}_${config.format}`;
}

// Convert SVG to PNG with 2x scale for better quality
const pngBlob = await convertSvgToPng(clonedSvg, 2);

// Generate filename if not provided
const finalFileName = fileName || generateFileName(fileNamePrefix, config.codeValue);
// Trigger download
downloadBlob(pngBlob, fileName);
downloadBlob(pngBlob, finalFileName, ref.current?.ownerDocument || document);
} catch (error) {
console.error(`Error downloading ${type}:`, error);
console.error(`Error downloading ${config.type}:`, error);
}
}
53 changes: 48 additions & 5 deletions packages/pluggableWidgets/barcode-generator-web/src/utils/download-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,49 @@ const NAMESPACES = {
XLINK: "http://www.w3.org/1999/xlink"
} as const;

export function generateFileName(prefix: string, codeValue: string): string {
// Auto-generate filename with format and hash
const timestamp = generateTimestamp();
const hash = hashCode(codeValue);
return `${prefix}_${hash}_${timestamp}.png`;
}

function generateTimestamp(): string {
// Get current date and time
const now = new Date();

// Format: YYYYMMDD_HHMMSS
const timestamp =
Copy link
Copy Markdown
Collaborator

@iobuhov iobuhov Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use literal template?

now.getFullYear().toString() +
String(now.getMonth() + 1).padStart(2, "0") +
String(now.getDate()).padStart(2, "0") +
"_" +
String(now.getHours()).padStart(2, "0") +
String(now.getMinutes()).padStart(2, "0") +
String(now.getSeconds()).padStart(2, "0");

// Return formatted filename
return timestamp;
}

function hashCode(s: string): string {
if (!s) {
return "empty";
}

let hash = 0;
for (let i = 0; i < s.length; i++) {
const char = s.charCodeAt(i);
// eslint-disable-next-line no-bitwise
hash = (hash << 5) - hash + char;
// eslint-disable-next-line no-bitwise
hash = hash & hash; // Convert to 32-bit integer
}

// Convert to base36 and take first 10 characters
return Math.abs(hash).toString(36).substring(0, 10);
}

// Prepare SVG for download by setting namespaces
export const prepareSvgForDownload = (svgElement: SVGSVGElement): SVGSVGElement => {
const clonedSvg = svgElement.cloneNode(true) as SVGSVGElement;
Expand Down Expand Up @@ -52,14 +95,14 @@ export const processQRImages = async (clonedSvg: SVGSVGElement): Promise<void> =
}
};

export const downloadBlob = (blob: Blob, filename: string): void => {
export const downloadBlob = (blob: Blob, filename: string, currentDocument: Document = document): void => {
const url = URL.createObjectURL(blob);
const link = document.createElement("a");
const link = currentDocument.createElement("a");
link.href = url;
link.download = filename;
document.body.appendChild(link);
currentDocument.body.appendChild(link);
link.click();
document.body.removeChild(link);
currentDocument.body.removeChild(link);
URL.revokeObjectURL(url);
};

Expand All @@ -73,7 +116,7 @@ export const convertSvgToPng = async (svgElement: SVGSVGElement, scale = 2): Pro
const img = new Image();
img.onload = () => {
try {
const canvas = document.createElement("canvas");
const canvas = svgElement.ownerDocument.createElement("canvas");
const ctx = canvas.getContext("2d");

if (!ctx) {
Expand Down
Loading