@pushwoosh/dumb-components 1.1.215 → 1.1.216

package/helpers/__tests__/barcodeUrl.test.d.ts

@@ -0,0 +1 @@
+export {};

package/helpers/__tests__/barcodeUrl.test.js

@@ -0,0 +1,43 @@
+import { buildBarcodeUrl, barcodePlaceholderSafeEscape, isBarcodePlaceholder } from '../barcodeUrl';
+const BASE = 'https://rag-mcp.svc-nue.pushwoosh.com';
+describe('buildBarcodeUrl', () => {
+  it('omits every empty parameter', () => {
+    expect(buildBarcodeUrl({
+      value: '1234567890123456'
+    }, `${BASE}/`)).toBe(`${BASE}/barcode/v1/code.png?sym=code128&v=1234567890123456`);
+  });
+  // A percent-encoded brace never matches the substituter, on the server or on
+  // the device, so the barcode would encode the placeholder text itself.
+  it.each(['{{voucher}}', '{Coupon|String|}', 'BR-{{voucher}}'])('keeps the placeholder %s literal', value => {
+    expect(buildBarcodeUrl({
+      value
+    }, BASE).endsWith(`&v=${value}`)).toBe(true);
+  });
+  it('escapes what is not a placeholder', () => {
+    expect(barcodePlaceholderSafeEscape('a b&c={{v}}')).toBe('a+b%26c%3D{{v}}');
+  });
+  it('carries every set parameter', () => {
+    const url = buildBarcodeUrl({
+      value: '{Coupon|String|}',
+      symbology: 'qr',
+      showText: true,
+      width: 420,
+      height: 460,
+      quietModules: 6,
+      foregroundColor: '#101010',
+      backgroundColor: '#ffffff',
+      ecLevel: 'H'
+    }, BASE);
+    ['sym=qr', 'hri=1', 'w=420', 'h=460', 'q=6', 'fg=101010', 'bg=ffffff', 'ec=H'].forEach(part => expect(url).toContain(part));
+  });
+  it('drops the error-correction level outside QR', () => {
+    expect(buildBarcodeUrl({
+      value: '1',
+      ecLevel: 'H'
+    }, BASE)).not.toContain('ec=');
+  });
+  it('recognizes a value that still needs substituting', () => {
+    expect(isBarcodePlaceholder('{Coupon|String|}')).toBe(true);
+    expect(isBarcodePlaceholder('4012345678901')).toBe(false);
+  });
+});

package/helpers/barcodeUrl.d.ts

@@ -0,0 +1,29 @@
+export type BarcodeSymbology = 'code128' | 'ean13' | 'ean8' | 'upca' | 'qr';
+export interface BarcodeUrlParams {
+    /** What to encode; normally a placeholder resolved per recipient. */
+    value: string;
+    symbology?: BarcodeSymbology;
+    /** Print the value in digits under the code. */
+    showText?: boolean;
+    width?: number;
+    height?: number;
+    /** Hex `#rrggbb`; empty = black on white. */
+    foregroundColor?: string;
+    backgroundColor?: string;
+    /** QR only: L, M, Q or H. */
+    ecLevel?: string;
+    /** Blank margin per side in modules; 0 = renderer default. */
+    quietModules?: number;
+}
+/**
+ * Encodes the value but leaves `{`, `}` and `|` literal: a percent-encoded
+ * placeholder never matches the substituter, on the server or on the device.
+ */
+export declare function barcodePlaceholderSafeEscape(value: string): string;
+/**
+ * Builds a URL for the onyx barcode-PNG endpoint, shared by every editor. The
+ * value is appended after the encoded query so a `{tag|type|}` stays literal.
+ */
+export declare function buildBarcodeUrl(params: BarcodeUrlParams, baseUrl: string): string;
+/** A value that has to be resolved before the endpoint can encode it. */
+export declare function isBarcodePlaceholder(value: string): boolean;

package/helpers/barcodeUrl.js

@@ -0,0 +1,31 @@
+/**
+ * Encodes the value but leaves `{`, `}` and `|` literal: a percent-encoded
+ * placeholder never matches the substituter, on the server or on the device.
+ */
+export function barcodePlaceholderSafeEscape(value) {
+  const escaped = new URLSearchParams({
+    v: value
+  }).toString().slice('v='.length);
+  return escaped.replace(/%7B/gi, '{').replace(/%7D/gi, '}').replace(/%7C/gi, '|');
+}
+/**
+ * Builds a URL for the onyx barcode-PNG endpoint, shared by every editor. The
+ * value is appended after the encoded query so a `{tag|type|}` stays literal.
+ */
+export function buildBarcodeUrl(params, baseUrl) {
+  const q = new URLSearchParams();
+  q.set('sym', params.symbology ?? 'code128');
+  if (params.showText) q.set('hri', '1');
+  const hex = v => v.replace(/^#/, '');
+  if (params.foregroundColor) q.set('fg', hex(params.foregroundColor));
+  if (params.backgroundColor) q.set('bg', hex(params.backgroundColor));
+  if (params.width) q.set('w', String(params.width));
+  if (params.height) q.set('h', String(params.height));
+  if (params.quietModules) q.set('q', String(params.quietModules));
+  if (params.ecLevel && (params.symbology ?? 'code128') === 'qr') q.set('ec', params.ecLevel);
+  return `${baseUrl.replace(/\/$/, '')}/barcode/v1/code.png?${q.toString()}&v=${barcodePlaceholderSafeEscape(params.value)}`;
+}
+/** A value that has to be resolved before the endpoint can encode it. */
+export function isBarcodePlaceholder(value) {
+  return value.includes('{');
+}

package/helpers/index.d.ts

@@ -1 +1,2 @@
 export * from './assignRef';
+export * from './barcodeUrl';

package/helpers/index.js

@@ -1 +1,2 @@
-export * from './assignRef';
+export * from './assignRef';
+export * from './barcodeUrl';

package/index.d.ts

@@ -57,3 +57,4 @@ export { Alert } from './Alert';
 export { ApplicationPreloader, type ApplicationPreloaderProps, } from './ApplicationPreloader';
 export { NotificationInbox, NotificationBar, NotificationBell, type Notification, type NotificationInboxProps, type NotificationSeverity, type NotificationBarType, type NotificationBarProps, type NotificationBellProps, } from './NotificationInbox';
 export { LeafletTheme } from './LeafletTheme';
+export { buildBarcodeUrl, barcodePlaceholderSafeEscape, isBarcodePlaceholder, type BarcodeSymbology, type BarcodeUrlParams, } from './helpers/barcodeUrl';

package/index.js

@@ -54,4 +54,5 @@ export { SendRateEdit, SendRateReadonly } from './SendRate';
 export { Alert } from './Alert';
 export { ApplicationPreloader } from './ApplicationPreloader';
 export { NotificationInbox, NotificationBar, NotificationBell } from './NotificationInbox';
-export { LeafletTheme } from './LeafletTheme';
+export { LeafletTheme } from './LeafletTheme';
+export { buildBarcodeUrl, barcodePlaceholderSafeEscape, isBarcodePlaceholder } from './helpers/barcodeUrl';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/dumb-components",
-  "version": "1.1.215",
+  "version": "1.1.216",
   "description": "React components to build Pushwoosh products",
   "main": "index.js",
   "module": "index.js",