qreator 9.0.6

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Short.cm inc
+Copyright (c) 2013 Yandex 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+# qreator
+
+[![npm version](https://badge.fury.io/js/qreator.svg)](https://badge.fury.io/js/qreator)
+
+QR Code generator for browser and node.js with tree shaking and logo support
+
+![image](https://github.com/Short-io/qreator/assets/75169/02b84738-56f2-44d8-8d11-f40e263302ed)
+
+## Overview
+
+-   generate image in `png`, `svg` and `pdf` formats
+-   numeric and alphanumeric modes
+-   support UTF-8
+-   supports color customization
+-   supports logos
+-   tree shaking support
+-   browser / node.js
+
+[Releases](https://github.com/Short-io/qreator/releases)
+
+## Installing
+
+```shell
+npm install qreator
+# or
+yarn add qreator
+```
+
+## Usage
+
+Example:
+
+```javascript
+import { getSVG } from "qreator/lib/svg";
+import { getPNG } from "qreator/lib/png"; // imports canvas implementation in browser and sharp module in node.js
+import { getPDF } from "qreator/lib/pdf"; // this import is large, consider async import
+const svgString = await getSVG("I love QR", {
+    logo: fs.openFileSync("my-logo.svg"),
+    color: "#000000",
+    bgColor: "#FFFFFF",
+});
+const pngBuffer = await getPNG("I love QR", {
+    logo: fs.openFileSync("my-logo.svg"),
+    color: "rgb(0, 0, 0)",
+    bgColor: "rgb(255, 255, 255)",
+});
+```
+
+[More examples](./examples)
+
+### Syntax
+
+-   `getPNG(text, [options])`: Readable stream with image data.
+-   `getSVG(text, [options])`: Readable stream with image data.
+-   `getPDF(text, [options])`: Readable stream with image data.
+
+### Options
+
+-   `text`: text to encode
+-   `options`: additional image options object
+
+#### Additional Options
+
+|      Name      |                    Description                     |    Type     |    Possible Values    |                 Default                  |
+| :------------: | :------------------------------------------------: | :---------: | :-------------------: | :--------------------------------------: |
+|   `ec_level`   |               error correction level               |   string    |  `L`, `M`, `Q`, `H`   |                   `M`                    |
+|     `type`     |                     image type                     |   string    |  `png`, `svg`, `pdf`  |                  `png`                   |
+|     `size`     | png and svg only<br />size of one module in pixels |   number    |        `0` - n        |       `5` (png)<br />`0` (others)        |
+|    `margin`    |       white space around QR image in modules       |   number    |        `0` - n        |       `4` (png)<br />`1` (others)        |
+|  `parse_url`   | EXPERIMENTAL<br />try to optimize QR-code for URLs |   boolean   |    `true`, `false`    |                 `false`                  |
+|     `logo`     |             buffer with png/jpeg image             | ArrayBuffer |           -           |               `undefined`                |
+|  `logoWidth`   |             height of logo in percent              |   number    |      `0` - `100`      |                   `20`                   |
+|  `logoHeight`  |              width of logo in percent              |   number    |      `0` - `100`      |                   `20`                   |
+|    `color`     |         module color in rgba or hex format         |   number    | `#000000` - `#000000` | `#000000`<br />(black with 100% opacity) |
+|   `bgColor`    |       background color in rgba or hex format       |   number    | `#000000` - `#FFFFFF` | `#FFFFFF`<br />(white with 100% opacity) |
+| `borderRadius` |             border-radius (in pixels)              |   number    |    0 - `size / 2`     |                   `0`                    |
+
+## Benchmarks
+
+```
+getPNG x 229 ops/sec ±0.45% (84 runs sampled)
+getPDF x 186 ops/sec ±24.91% (86 runs sampled)
+getSVG x 2,482 ops/sec ±0.18% (90 runs sampled)
+getPNG with logo x 69.96 ops/sec ±0.72% (68 runs sampled)
+getPDF with logo x 44.83 ops/sec ±9.52% (77 runs sampled)
+getSVG with logo x 2,494 ops/sec ±0.19% (88 runs sampled)
+```
+
+## TODO
+
+-   Use lighter versions of PDF library
+-   Background

package/lib/browser/encode.d.ts

@@ -0,0 +1,2 @@
+import { NumberData } from "./typing/types";
+export declare function encode(inData: string | number | ArrayBuffer, parse_url: boolean): NumberData;

package/lib/browser/errorcode.d.ts

@@ -0,0 +1 @@
+export declare function calculateEC(msg: number[], ec_len: number): Uint8Array;

package/lib/browser/matrix.d.ts

@@ -0,0 +1,9 @@
+import { Data, EcLevel, Matrix } from "./typing/types";
+export declare function init(version: number): Matrix;
+export declare function fillFinders(matrix: Matrix): void;
+export declare function fillAlignAndTiming(matrix: Matrix): void;
+export declare function fillStub(matrix: Matrix): void;
+export declare const fillReserved: (matrix: Matrix, ec_level: EcLevel, mask: number) => void;
+export declare const fillData: (matrix: Matrix, data: Data, mask: number) => void;
+export declare function calculatePenalty(matrix: Matrix): number;
+export declare function getMatrix(data: Data): number[][];

package/lib/browser/pdf.d.ts

@@ -0,0 +1,2 @@
+import { ImageOptions } from "./typing/types";
+export declare function getPDF(text: string, inOptions: ImageOptions): Promise<Uint8Array>;