@liquid-js/qr-code-styling 5.0.0-2 → 5.0.0-3

package/lib/utils/options.d.ts

@@ -1,5 +1,6 @@
 import { ErrorCorrectionLevel, Mode, TypeNumber } from '@liquid-js/qrcode-generator/lib/qrcode/QRCodeMinimal.js';
 import { browserImageTools } from '../tools/browser-image-tools.js';
+import { DrawArgs } from '../types/helper.js';
 import { Gradient } from './gradient.js';
 export declare enum DotType {
     dot = "dot",
@@ -63,6 +64,30 @@ export declare enum ImageMode {
      */
     background = "background"
 }
+export interface Plugin {
+    /**
+     * Draw a single dot
+     *
+     * @returns Dot element; if undefined, try to use the next plugin or the default function
+     */
+    drawDot?: (args: DrawArgs) => SVGElement | undefined;
+    /**
+     * Draw corner dot
+     *
+     * @returns Corner dot element; if undefined, try to use the next plugin or the default function
+     */
+    drawCornerDot?: (args: DrawArgs) => SVGElement | undefined;
+    /**
+     * Draw corner square
+     *
+     * @returns Corner square element and corner mask (used with ImageMode.background); if undefined, try to use the next plugin or the default function
+     */
+    drawCornerSquare?: (args: DrawArgs) => readonly [SVGElement, SVGElement] | undefined;
+    /**
+     * Alter the generated SVG, e.g. add borders
+     */
+    postProcess?: (svg: SVGSVGElement, options: Options) => void;
+}
 export interface Options {
     /** Use a custom DOM domplementation */
     document: Document;
@@ -185,6 +210,7 @@ export interface Options {
     stringToBytesFuncs?: {
         [encoding: string]: (s: string) => number[];
     };
+    plugins?: Plugin[];
 }
 export declare const defaultOptions: Options;
 export declare function sanitizeOptions(options: Options): Options;

package/lib/utils/svg.d.ts

@@ -1,5 +1,5 @@
 import { RotateFigureArgs } from '../types/helper.js';
-export declare function numToAttr(value: number): string;
+export declare function numToAttr(value: number | string): string;
 export declare function svgPath(strings: TemplateStringsArray, ...values: unknown[]): string;
 export declare function rotateFigure<T extends SVGElement | ReadonlyArray<SVGElement>>({ draw, ...args }: RotateFigureArgs<T>): T;
 export declare function scalePath(path: Array<string | number>, { x, y, size }: {
@@ -7,3 +7,9 @@ export declare function scalePath(path: Array<string | number>, { x, y, size }:
     y: number;
     size: number;
 }): string;
+export declare function extendSVG(svg: SVGSVGElement, padding: number): {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+} | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liquid-js/qr-code-styling",
-  "version": "5.0.0-2",
+  "version": "5.0.0-3",
   "description": "Generate styled QR codes on web or in Node",
   "type": "module",
   "main": "./lib/qr-code-styling-node.js",
@@ -18,6 +18,14 @@
     "./kanji": {
       "types": "./lib/kanji.d.ts",
       "default": "./lib/kanji.js"
+    },
+    "./plugin-utils": {
+      "types": "./lib/plugins/utils.d.ts",
+      "default": "./lib/plugin-utils.js"
+    },
+    "./border-plugin": {
+      "types": "./lib/plugins/border.d.ts",
+      "default": "./lib/border-plugin.js"
     }
   },
   "files": [
@@ -49,7 +57,9 @@
     "logo",
     "design",
     "node",
-    "nodejs"
+    "nodejs",
+    "plugin",
+    "plugins"
   ],
   "author": "HitkoDev <development@hitko.si>",
   "license": "MIT",