@liquid-js/qr-code-styling 1.6.0-rc.1

package/lib/types/index.d.ts

@@ -0,0 +1,171 @@
+/// <reference types="node" />
+import { browserImageTools } from "../tools/browserImageTools";
+export interface UnknownObject {
+    [key: string]: any;
+}
+export declare enum DotType {
+    dots = "dots",
+    rounded = "rounded",
+    classy = "classy",
+    classyRounded = "classy-rounded",
+    square = "square",
+    extraRounded = "extra-rounded"
+}
+export declare enum CornerDotType {
+    dot = "dot",
+    square = "square"
+}
+export declare enum CornerSquareType {
+    dot = "dot",
+    square = "square",
+    extraRounded = "extra-rounded"
+}
+export declare enum GradientType {
+    radial = "radial",
+    linear = "linear"
+}
+export declare enum ShapeType {
+    square = "square",
+    circle = "circle"
+}
+export declare type Gradient = {
+    type: GradientType;
+    rotation?: number;
+    colorStops: {
+        offset: number;
+        color: string;
+    }[];
+};
+declare type TypeNumber = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40;
+declare const TypeNumber: {
+    0: 0;
+    1: 1;
+    2: 2;
+    3: 3;
+    4: 4;
+    5: 5;
+    6: 6;
+    7: 7;
+    8: 8;
+    9: 9;
+    10: 10;
+    11: 11;
+    12: 12;
+    13: 13;
+    14: 14;
+    15: 15;
+    16: 16;
+    17: 17;
+    18: 18;
+    19: 19;
+    20: 20;
+    21: 21;
+    22: 22;
+    23: 23;
+    24: 24;
+    25: 25;
+    26: 26;
+    27: 27;
+    28: 28;
+    29: 29;
+    30: 30;
+    31: 31;
+    32: 32;
+    33: 33;
+    34: 34;
+    35: 35;
+    36: 36;
+    37: 37;
+    38: 38;
+    39: 39;
+    40: 40;
+};
+export { TypeNumber };
+export declare enum ErrorCorrectionLevel {
+    L = "L",
+    M = "M",
+    Q = "Q",
+    H = "H"
+}
+export declare enum Mode {
+    numeric = "Numeric",
+    alphanumeric = "Alphanumeric",
+    byte = "Byte",
+    kanji = "Kanji"
+}
+export interface QRCode {
+    addData(data: string, mode?: Mode): void;
+    make(): void;
+    getModuleCount(): number;
+    isDark(row: number, col: number): boolean;
+}
+export declare type Options = {
+    document?: Document;
+    shape?: ShapeType;
+    width?: number;
+    height?: number;
+    margin?: number;
+    data?: string;
+    image?: string | Buffer | Blob;
+    imageTools?: typeof browserImageTools;
+    qrOptions?: {
+        typeNumber?: TypeNumber;
+        mode?: Mode;
+        errorCorrectionLevel?: ErrorCorrectionLevel;
+    };
+    imageOptions?: {
+        hideBackgroundDots?: boolean;
+        imageSize?: number;
+        crossOrigin?: string;
+        margin?: number;
+    };
+    dotsOptions?: {
+        type?: DotType;
+        color?: string;
+        gradient?: Gradient;
+    };
+    cornersSquareOptions?: {
+        type?: CornerSquareType;
+        color?: string;
+        gradient?: Gradient;
+    };
+    cornersDotOptions?: {
+        type?: CornerDotType;
+        color?: string;
+        gradient?: Gradient;
+    };
+    backgroundOptions?: {
+        round?: number;
+        color?: string;
+        gradient?: Gradient;
+    } | false;
+};
+export declare type FilterFunction = (i: number, j: number) => boolean;
+export declare type DrawArgs = {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+    getNeighbor?: GetNeighbor;
+};
+export declare type BasicFigureDrawArgs = {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+};
+export declare type RotateFigureArgs = {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+    draw: () => void;
+};
+export declare type GetNeighbor = (x: number, y: number) => boolean;
+export declare type ExtensionFunction = (svg: SVGElement, options: Options) => void;
+export declare enum FileExtension {
+    svg = "svg",
+    png = "png",
+    jpeg = "jpeg",
+    webp = "webp"
+}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@liquid-js/qr-code-styling",
+  "version": "1.6.0-rc.1",
+  "description": "Add a style and an image to your QR code",
+  "main": "lib/qr-code-styling-node.js",
+  "browser": "lib/qr-code-styling-node.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "dependencies": {
+    "file-type": "<17.0.0",
+    "jsdom": "^19.0.0",
+    "node-fetch": "<3.0.0",
+    "qrcode-generator": "^1.4.4",
+    "sharp": "^0.30.4"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^22.0.0",
+    "@rollup/plugin-typescript": "^8.3.2",
+    "@types/jsdom": "^16.2.14",
+    "@types/node": "^17.0.31",
+    "@types/node-fetch": "^2.6.1",
+    "@types/sharp": "^0.30.2",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "@typescript-eslint/parser": "^5.22.0",
+    "canvas": "^2.9.1",
+    "clean-webpack-plugin": "^4.0.0",
+    "eslint": "^8.14.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jest": "^26.1.5",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-webpack-plugin": "^3.1.1",
+    "html-webpack-plugin": "^5.5.0",
+    "jest": "^28.0.3",
+    "jest-environment-jsdom": "^28.0.2",
+    "prettier": "^2.6.2",
+    "rollup": "^2.72.0",
+    "ts-jest": "^28.0.1",
+    "ts-loader": "^9.3.0",
+    "typescript": "^4.6.4",
+    "webpack": "^5.72.0",
+    "webpack-cli": "^4.9.2",
+    "webpack-dev-server": "^4.9.0",
+    "webpack-merge": "^5.8.0"
+  },
+  "scripts": {
+    "build": "webpack --mode=production --config webpack.config.build.js && rollup -c rollup.config.js",
+    "build:dev": "webpack --mode=development --config webpack.config.build.js",
+    "test": "jest",
+    "start": "webpack serve --open --config webpack.config.dev-server.js",
+    "lint": "eslint . --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kozakdenys/qr-code-styling.git"
+  },
+  "keywords": [
+    "qr",
+    "qrcode",
+    "qr-code",
+    "js",
+    "qrjs",
+    "qrstyling",
+    "styling",
+    "qrbranding",
+    "branding",
+    "qrimage",
+    "image",
+    "qrlogo",
+    "logo",
+    "design"
+  ],
+  "author": "Denys Kozak <kozak.denys.dev@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kozakdenys/qr-code-styling/issues"
+  },
+  "homepage": "https://qr-code-styling.com"
+}