@vkontakte/vk-qr 2.1.1 → 3.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 VK.com
+Copyright (c) 2019-present, VK LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -27,12 +27,23 @@ npm install @vkontakte/vk-qr
 And use in your code
 
 ```js
-import vkQr from '@vkontakte/vk-qr';
+import * as vkQr from '@vkontakte/vk-qr';
 
 // Returns SVG code of generated 256x256 QR code with VK logo
 const qrSvg = vkQr.createQR('Text to encode', {
   qrSize: 256,
-  isShowLogo: true
+  isShowLogo: true,
+});
+```
+
+Customize the background frame thickness and corner radius in pixels:
+
+```js
+const qrSvg = vkQr.createQR('Text to encode', {
+  qrSize: 256,
+  isShowBackground: true,
+  backgroundPadding: 12,
+  backgroundRadius: 16,
 });
 ```
 
@@ -51,7 +62,6 @@ generatedSvgCode = vkQr.createQR(text[, qrOptions]);
 
 - `options` _optional_
   An options object containing any custom settings that you want to apply to the generated QR code. The possible options are:
-
   - `qrSize`: Size of QR code.
     Default is 128
 
@@ -64,6 +74,10 @@ generatedSvgCode = vkQr.createQR(text[, qrOptions]);
 
   - `backgroundColor`: QR code background HEX color. Works if `isShowBackground` is enabled. Default is "#ffffff"
 
+  - `backgroundPadding`: Background frame thickness (padding on each side) in output pixels. Works if `isShowBackground` is enabled. Default is 20
+
+  - `backgroundRadius`: Background corner radius in output pixels. Works if `isShowBackground` is enabled. Default is 36
+
   - `foregroundColor`: QR code HEX color
 
   - `logoColor`: Color of logo. Default is "#4680c2"
@@ -74,6 +88,11 @@ generatedSvgCode = vkQr.createQR(text[, qrOptions]);
 
   - `ecc`: ECC level in range [0-3] (0 - low, 3 - high)
 
+`backgroundPadding` and `backgroundRadius` accept finite, non-negative numbers, including 0.
+Invalid values use the defaults. Both are limited to half of `qrSize`.
+The outer SVG size stays `qrSize` × `qrSize`; padding reduces the space available to the QR code
+equally on all sides. If padding fills the entire image, only the background is rendered.
+
 ### Return value
 
 A string with SVG code.

package/dist/constants.d.ts

@@ -0,0 +1,10 @@
+/** SVG units per QR module. */
+export declare const TILE_SIZE = 100;
+export declare const FINDER_PATTERN_SIZE = 7;
+export declare const SMALL_QR_SIZE = 25;
+export declare const MODULE_CORNER_RADIUS = 35;
+export declare const FINDER_CORNER_RADIUS = 67;
+/** Default background dimensions in output pixels. */
+export declare const BACKGROUND_PADDING = 20;
+export declare const BACKGROUND_RADIUS = 36;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,eAAO,MAAM,SAAS,MAAM,CAAC;AAC7B,eAAO,MAAM,mBAAmB,IAAI,CAAC;AACrC,eAAO,MAAM,aAAa,KAAK,CAAC;AAChC,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,sDAAsD;AACtD,eAAO,MAAM,kBAAkB,KAAK,CAAC;AACrC,eAAO,MAAM,iBAAiB,KAAK,CAAC"}

package/dist/figures.d.ts

@@ -0,0 +1,9 @@
+/** A connected group of modules stored in its smallest bounding box. */
+export interface Figure {
+    x: number;
+    y: number;
+    pixels: boolean[][];
+}
+export declare function isFinderPattern(figure: Figure, size: number): boolean;
+export declare function extractFigures(image: boolean[][]): Figure[];
+//# sourceMappingURL=figures.d.ts.map

package/dist/figures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"figures.d.ts","sourceRoot":"","sources":["../src/figures.ts"],"names":[],"mappings":"AAEA,wEAAwE;AACxE,MAAM,WAAW,MAAM;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC;CACrB;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAoBrE;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,MAAM,EAAE,CA0E3D"}

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import type { QrOptions } from './types.js';
+/**
+ * Generates SVG QR code by a text
+ * @param text String to encode
+ * @param options QR code options
+ */
+export declare function createQR(text: string, options?: QrOptions): string;
+/**
+ * Legacy interface
+ * @deprecated
+ * @param text String to encode
+ * @param qrSize Size of QR code
+ * @param className SVG element class name
+ * @param options Options of the QR code
+ */
+export declare function createQR(text: string, qrSize: number, className: string, options?: QrOptions): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAqB,MAAM,YAAY,CAAC;AAe/D;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;AAEpE;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,SAAS,GAClB,MAAM,CAAC"}