@liquid-js/qr-code-styling 2.1.0 → 2.1.1

package/lib/tools/browserImageTools.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="node" />
-import { RequiredOptions } from "../core/QROptions";
+import { Options } from "../types";
 export declare const browserImageTools: {
     toDataURL(url: string | Buffer | Blob): Promise<string>;
-    getSize(options: RequiredOptions): Promise<{
+    getSize(options: Options): Promise<{
         width: number;
         height: number;
     }>;

package/lib/types/index.d.ts

@@ -29,10 +29,23 @@ export declare enum ShapeType {
     circle = "circle"
 }
 export type Gradient = {
+    /**
+     * Type of gradient spread
+     *
+     * @default GradientType.linear
+     */
     type: GradientType;
+    /**
+     * Rotation of gradient (in radians, Math.PI === 180 degrees)
+     *
+     * @default 0
+     */
     rotation?: number;
+    /** Gradient colors. */
     colorStops: {
+        /** Position of color in gradient range */
         offset: number;
+        /** Color of stop in gradient range */
         color: string;
     }[];
 };
@@ -100,43 +113,108 @@ export interface QRCode {
     isDark(row: number, col: number): boolean;
 }
 export type Options = {
+    /** Use a custom DOM domplementation */
     document?: Document;
-    shape?: ShapeType;
+    /** Use a custom image fetching & serializaton implementation */
+    imageTools?: typeof browserImageTools;
+    /** @ignore */
     width?: number;
+    /** @ignore */
     height?: number;
+    /** The data will be encoded in the QR code */
     data?: string;
+    /** The image will be copied to the center of the QR code */
     image?: string | Buffer | Blob;
-    imageTools?: typeof browserImageTools;
+    /**
+     * QR code shape
+     *
+     * @default ShapeType.square
+     */
+    shape?: ShapeType;
+    /** Options will be passed to `qrcode-generator` lib */
     qrOptions?: {
         typeNumber?: TypeNumber;
         mode?: Mode;
+        /** @default ErrorCorrectionLevel.Q */
         errorCorrectionLevel?: ErrorCorrectionLevel;
     };
     imageOptions?: {
+        /**
+         * Hide all dots covered by the image
+         *
+         * @default true
+         */
         hideBackgroundDots?: boolean;
+        /**
+         * Coefficient of the image size
+         *
+         * @default 0.4
+         */
         imageSize?: number;
-        crossOrigin?: string;
+        /**
+         * Margin of the image (in blocks)
+         *
+         * @default 0
+         */
         margin?: number;
+        /**
+         * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLImageElement/crossOrigin)
+         */
+        crossOrigin?: string;
     };
     dotsOptions?: {
-        type?: DotType;
+        /**
+         * QR dot size (in pixels)
+         *
+         * @default 10
+         */
+        size?: number;
+        /**
+         * Color of QR dots
+         *
+         * @default "#000"
+         */
         color?: string;
+        /** Gradient of QR dots */
         gradient?: Gradient;
+        /**
+         * Style of QR dots
+         *
+         * @default DotType.square
+         */
+        type?: DotType;
     };
+    /** Corners Square options, omitted values match dots */
     cornersSquareOptions?: {
-        type?: CornerSquareType;
+        /** Color of Corners Square */
         color?: string;
+        /** Gradient of Corners Square */
         gradient?: Gradient;
+        /** Style of Corners Square */
+        type?: CornerSquareType;
     };
+    /** Corners Dot options, omitted values match squares */
     cornersDotOptions?: {
-        type?: CornerDotType;
+        /** Color of Corners Dot */
         color?: string;
+        /** Gradient of Corners Dot */
         gradient?: Gradient;
+        /** Style of Corners Dot */
+        type?: CornerDotType;
     };
+    /** QR background styling options, false to disable background */
     backgroundOptions?: {
+        /** Background roundnes, from 0 (square) to 1 (circle) */
         round?: number;
+        /** Background color */
         color?: string;
+        /** Background Gradient */
         gradient?: Gradient;
+        /**
+         * Margin (in blocks) between background and the QR code
+         *
+         * @default 0
+         */
         margin?: number;
     } | false;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liquid-js/qr-code-styling",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Add a style and an image to your QR code",
   "type": "module",
   "main": "./lib/qr-code-styling-node.js",
@@ -24,7 +24,8 @@
     "file-type": "^19.0.0",
     "qrcode-generator": "^1.4.4",
     "sharp": ">0.32.1 <1.0.0",
-    "tslib": "^2.6.2"
+    "tslib": "^2.6.2",
+    "typedoc": "^0.25.13"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.3.0",
@@ -63,7 +64,8 @@
     "lint": "prettier -w . && eslint . --fix",
     "prepublishOnly": "npm run build",
     "prepare": "husky",
-    "release": "git diff --exit-code && standard-version && git push --follow-tags origin"
+    "release": "git diff --exit-code && standard-version && git push --follow-tags origin",
+    "docs": "typedoc ./src/index.ts ./src/tools/browserUtils.ts ./src/tools/browserImageTools.ts"
   },
   "repository": {
     "type": "git",