@qr-platform/qr-code.js 0.9.10 → 0.10.1

package/lib/options-demo.d.ts

@@ -1,239 +1,2 @@
-import { ShapeType } from './utils/options';
-export declare const options2: {
-    shape: ShapeType;
-    verticalOffset: number;
-    isResponive: string;
-    margin: number;
-    scale: number;
-    data: string;
-    image: string;
-    dotsOptions: {
-        type: string;
-        color: string;
-        size: number;
-    };
-    backgroundOptions: {
-        color: string;
-    };
-    cornersDotOptions: {
-        type: string;
-        color: string;
-    };
-    cornersSquareOptions: {
-        type: string;
-        color: string;
-    };
-    imageOptions: {
-        crossOrigin: string;
-        imageSize: number;
-        margin: number;
-    };
-    borderOptions: {
-        hasBorder: boolean;
-        radius: string;
-        thickness: number;
-        inner: {
-            radius: string;
-            scale: number;
-            horizontalOffset: number;
-            verticalOffset: number;
-        };
-        color: string;
-        decorations: {
-            top: {
-                disabled: boolean;
-                enableText: boolean;
-                offset: number;
-                curveAdjustment: number;
-                curveDisabled: boolean;
-                curveRadius: string;
-                type: string;
-                value: string;
-                style: {
-                    fontFace: string;
-                    fontSize: number;
-                    fontColor: string;
-                    letterSpacing: number;
-                    fontWeight: string;
-                };
-            };
-            bottom: {
-                disabled: boolean;
-                enableText: boolean;
-                offset: number;
-                curveAdjustment: number;
-                curveRadius: string;
-                curveDisabled: boolean;
-                type: string;
-                value: string;
-                style: {
-                    fontFace: string;
-                    fontSize: number;
-                    fontColor: string;
-                    letterSpacing: number;
-                    fontWeight: string;
-                };
-            };
-            left: {
-                disabled: boolean;
-                enableText: boolean;
-                offset: number;
-                curveAdjustment: number;
-                curveRadius: string;
-                curveDisabled: boolean;
-                type: string;
-                value: string;
-                style: {
-                    fontFace: string;
-                    fontSize: number;
-                    fontColor: string;
-                    letterSpacing: number;
-                    fontWeight: string;
-                };
-            };
-            right: {
-                disabled: boolean;
-                enableText: boolean;
-                offset: number;
-                curveAdjustment: number;
-                curveDisabled: boolean;
-                curveRadius: string;
-                type: string;
-                value: string;
-                style: {
-                    fontFace: string;
-                    fontSize: number;
-                    fontColor: string;
-                    letterSpacing: number;
-                    fontWeight: string;
-                };
-            };
-        };
-        borderOuter: {
-            color: string;
-            thickness: number;
-        };
-        borderInner: {
-            color: string;
-            thickness: number;
-        };
-    };
-};
-export declare const options: {
-    name: string;
-    description: string;
-    data: string;
-    image: string;
-    margin: number;
-    verticalOffset: number;
-    scale: number;
-    shape: string;
-    qrOptions: {};
-    imageOptions: {
-        imageSize: number;
-        margin: number;
-        roundedValue: number;
-    };
-    dotsOptions: {
-        type: string;
-        color: string;
-    };
-    cornersSquareOptions: {
-        type: string;
-        color: string;
-    };
-    cornersDotOptions: {
-        type: string;
-        color: string;
-    };
-    backgroundOptions: {
-        color: string;
-        gradient: {
-            type: string;
-            colorStops: {
-                offset: number;
-                color: string;
-            }[];
-        };
-    };
-    borderOptions: {
-        hasBorder: boolean;
-        radius: string;
-        innerRadius: string;
-        thickness: number;
-        color: string;
-        isTopBorderOnly: boolean;
-        isBottomBorderOnly: boolean;
-        isTopBottomBorderOnly: boolean;
-        decorations: {
-            top: {
-                enableText: boolean;
-                verticalOffset: number;
-                curveAdjustment: number;
-                disableCurve: boolean;
-                type: string;
-                value: string;
-                style: {
-                    fontFace: string;
-                    fontSize: number;
-                    fontColor: string;
-                    letterSpacing: number;
-                    fontWeight: string;
-                };
-            };
-            bottom: {
-                enableText: boolean;
-                verticalOffset: number;
-                curveAdjustment: number;
-                disableCurve: boolean;
-                type: string;
-                value: string;
-                style: {
-                    fontFace: string;
-                    fontSize: number;
-                    fontColor: string;
-                    letterSpacing: number;
-                    fontWeight: string;
-                };
-            };
-            left: {
-                enableText: boolean;
-                verticalOffset: number;
-                curveAdjustment: number;
-                disableCurve: boolean;
-                type: string;
-                value: string;
-                style: {
-                    fontFace: string;
-                    fontSize: number;
-                    fontColor: string;
-                    letterSpacing: number;
-                    fontWeight: string;
-                };
-            };
-            right: {
-                enableText: boolean;
-                verticalOffset: number;
-                curveAdjustment: number;
-                disableCurve: boolean;
-                type: string;
-                value: string;
-                style: {
-                    fontFace: string;
-                    fontSize: number;
-                    fontColor: string;
-                    letterSpacing: number;
-                    fontWeight: string;
-                };
-            };
-        };
-        borderOuter: {
-            color: string;
-            thickness: number;
-        };
-        borderInner: {
-            color: string;
-            thickness: number;
-        };
-    };
-};
+import { Options } from '.';
+export declare const options: Options;

package/lib/templates/scan-validators/tests/cases/colors.d.ts

@@ -6,9 +6,6 @@ export declare const baseOptions: {
     scale: number;
     margin: number;
     shape: string;
-    qrOptions: {
-        errorCorrectionLevel: string;
-    };
     dotsOptions: {
         type: string;
         color: string;
@@ -49,9 +46,6 @@ export declare const buildOptions: (elementColor: string, backgroundColor: strin
     scale: number;
     margin: number;
     shape: string;
-    qrOptions: {
-        errorCorrectionLevel: string;
-    };
 };
 export declare const alphas: number[];
 declare const cases: TestCase[];

package/lib/types/helper.d.ts

@@ -21,3 +21,6 @@ export interface RotateFigureArgs {
     rotation?: number;
     draw: () => void;
 }
+export interface MethodOverrideOptions {
+    override?: boolean;
+}

package/lib/types/style-options.d.ts

@@ -20,11 +20,17 @@ export interface StyleOptions {
     logoSize?: number;
     logoMode?: ImageMode;
     logoMargin?: number;
-    logoFillColor?: string;
-    logoFillGradient?: Gradient;
+    logoBackgroundColor?: string;
+    logoPadding?: number;
+    logoRadius?: string | number;
     borderColor?: string;
     borderThickness?: number;
     borderRadius?: string | number;
+    borderInnerColor?: string;
+    borderInnerThickness?: number;
+    borderInnerRadius?: string | number;
+    borderOuterColor?: string;
+    borderOuterThickness?: number;
     borderTextTop?: string;
     borderTextRight?: string;
     borderTextBottom?: string;

package/lib/types/text-options.d.ts

@@ -0,0 +1,11 @@
+export interface TextOptions {
+    topValue?: string | null;
+    leftValue?: string | null;
+    rightValue?: string | null;
+    bottomValue?: string | null;
+}
+export interface QRTextTemplateDefinition {
+    id: string;
+    name: string;
+    options: TextOptions;
+}

package/lib/utils/_network-helpers_multi_env.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Fetches an image directly from its URL and converts it to a Data URL.
+ * Handles potential CORS issues and other fetch errors.
+ *
+ * @param imageUrl The URL of the image to fetch.
+ * @param crossOrigin The crossOrigin attribute value ('anonymous', 'use-credentials').
+ * @returns A Promise resolving to the Data URL string, or null if fetching fails.
+ */
+export declare function fetchImageDataUrlDirectly(imageUrl: string, crossOrigin?: string): Promise<string | null>;
+/**
+ * Fetches an image via a proxy service, which returns the image as a Data URL.
+ *
+ * @param imageUrl The original URL of the image to fetch via proxy.
+ * @returns A Promise resolving to the Data URL string from the proxy, or null if fetching fails.
+ */
+export declare function fetchImageDataUrlViaProxy(imageUrl: string): Promise<string | null>;

package/lib/utils/gradient.d.ts

@@ -2,13 +2,14 @@ export declare enum GradientType {
     radial = "radial",
     linear = "linear"
 }
+export type GradientTypeStrings = `${GradientType}`;
 export interface Gradient {
     /**
      * Type of gradient spread
      *
      * @default GradientType.linear
      */
-    type: GradientType;
+    type: GradientType | GradientTypeStrings;
     /**
      * Rotation of gradient (in radians, Math.PI === 180 degrees)
      *

package/lib/utils/network-helpers.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Fetches an image directly from its URL and converts it to a Data URL.
+ * Handles potential CORS issues and other fetch errors.
+ * Works in Browser, Node.js, and Worker environments.
+ *
+ * @param imageUrl The URL of the image to fetch.
+ * @param crossOrigin The crossOrigin attribute value ('anonymous', 'use-credentials').
+ * @returns A Promise resolving to the Data URL string, or null if fetching fails.
+ */
+export declare function fetchImageDataUrlDirectly(imageUrl: string, crossOrigin?: string): Promise<string | null>;
+/**
+ * Fetches an image via a proxy service, which returns the image as a Data URL.
+ *
+ * @param imageUrl The original URL of the image to fetch via proxy.
+ * @returns A Promise resolving to the Data URL string from the proxy, or null if fetching fails.
+ */
+export declare function fetchImageDataUrlViaProxy(imageUrl: string): Promise<string | null>;

package/lib/utils/options.d.ts

@@ -10,8 +10,8 @@ export interface DecorationOption {
     curveDisabled?: boolean;
     curveRadius?: string;
     enableText?: boolean;
-    type: 'text' | 'image';
-    value: string;
+    type?: 'text' | 'image';
+    value?: string;
     style?: QRBorderPluginStyleOptions;
 }
 export interface BorderOptions {
@@ -28,17 +28,17 @@ export interface BorderOptions {
     innerVerticalOffset?: number;
     thickness: number;
     noBorderThickness?: number;
-    color: string;
+    color?: string;
     background?: string;
     decorations?: {
         [key in Position]?: DecorationOption;
     };
     borderOuter?: {
-        color: string;
+        color?: string;
         thickness: number;
     };
     borderInner?: {
-        color: string;
+        color?: string;
         thickness: number;
     };
 }
@@ -93,6 +93,11 @@ export declare enum ImageMode {
      */
     background = "background"
 }
+type ShapeTypeStrings = `${ShapeType}`;
+type DotTypeStrings = `${DotType}`;
+type CornerSquareTypeStrings = `${CornerSquareType}`;
+type CornerDotTypeStrings = `${CornerDotType}`;
+type ImageModeStrings = `${ImageMode}`;
 export interface Options {
     /** Use a custom DOM domplementation */
     document: Document;
@@ -116,7 +121,7 @@ export interface Options {
      *
      * @default ShapeType.square
      */
-    shape: ShapeType;
+    shape: ShapeType | ShapeTypeStrings;
     /** Options will be passed to `~` lib */
     scale?: number;
     offset?: number;
@@ -132,20 +137,17 @@ export interface Options {
          *
          * @default ImageMode.center
          */
-        mode?: ImageMode;
+        mode?: ImageMode | ImageModeStrings;
         /**
-         * Fill blank areas of the code with selected color
+         * Background color of QR code image (logo, image, etc.)
+         */
+        backgroundColor?: string;
+        /**
+         * Padding around the image (in blocks)
+         *
+         * @default 0
          */
-        fill?: {
-            /**
-             * Color of QR dots
-             *
-             * @default "rgba(255,255,255,0.75)"
-             */
-            color: string;
-            /** Gradient of Corners Dot */
-            gradient?: Gradient;
-        };
+        padding?: number;
         /**
          * Coefficient of the image size
          *
@@ -158,6 +160,8 @@ export interface Options {
          * @default 0
          */
         margin: number;
+        /** Radius of the image */
+        radius?: string | number;
         /**
          * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLImageElement/crossOrigin)
          */
@@ -183,7 +187,7 @@ export interface Options {
          *
          * @default DotType.square
          */
-        type: DotType;
+        type: DotType | DotTypeStrings;
     };
     /** Corners Square options, omitted values match dots */
     cornersSquareOptions?: {
@@ -192,7 +196,7 @@ export interface Options {
         /** Gradient of Corners Square */
         gradient?: Gradient;
         /** Style of Corners Square */
-        type?: CornerSquareType;
+        type?: CornerSquareType | CornerSquareTypeStrings;
     };
     /** Corners Dot options, omitted values match squares */
     cornersDotOptions?: {
@@ -201,7 +205,7 @@ export interface Options {
         /** Gradient of Corners Dot */
         gradient?: Gradient;
         /** Style of Corners Dot */
-        type?: CornerDotType;
+        type?: CornerDotType | CornerDotTypeStrings;
     };
     /** QR background styling options, false to disable background */
     backgroundOptions?: {
@@ -218,3 +222,4 @@ export interface Options {
     borderOptions?: BorderOptions;
 }
 export declare function sanitizeOptions(options: Options): Options;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qr-platform/qr-code.js",
-  "version": "0.9.10",
+  "version": "0.10.1",
   "description": "QRCode.js is a professional JavaScript/TypeScript library for creating customized QR codes, offering a blend of simplicity and sophistication. With versatile styling options—dot shapes, colors, gradients, embedded images, borders, and text—it enables you to design unique, visually appealing QR codes that work flawlessly with standard scanners. QRCode.js is part of QR-Platform: All-in-One QR Codes Management Solution.",
   "type": "module",
   "main": "./lib/node.js",

package/lib/core/qr-styles.d.ts

@@ -1,4 +0,0 @@
-import { StyleOptions } from '../types/style-options';
-export declare const qrStyles: {
-    [key: string]: StyleOptions;
-};

package/lib/core/qr-templates.d.ts

@@ -1,10 +0,0 @@
-import { type Options } from '~/utils/options';
-import { RecursivePartial } from '~/types/helper';
-export declare const plainQRTemplate: RecursivePartial<Options>;
-export declare const basicQRTemplate: RecursivePartial<Options>;
-export declare const roundedQRTemplate: RecursivePartial<Options>;
-export declare const dotsQRTemplate: RecursivePartial<Options>;
-export declare const classyQRTemplate: RecursivePartial<Options>;
-export declare const qrTemplates: {
-    [key: string]: RecursivePartial<Options>;
-};

package/lib/node/core/qr-styles.d.ts

@@ -1,4 +0,0 @@
-import { StyleOptions } from '../types/style-options';
-export declare const qrStyles: {
-    [key: string]: StyleOptions;
-};

package/lib/node/core/qr-templates.d.ts

@@ -1,10 +0,0 @@
-import { type Options } from '~/utils/options';
-import { RecursivePartial } from '~/types/helper';
-export declare const plainQRTemplate: RecursivePartial<Options>;
-export declare const basicQRTemplate: RecursivePartial<Options>;
-export declare const roundedQRTemplate: RecursivePartial<Options>;
-export declare const dotsQRTemplate: RecursivePartial<Options>;
-export declare const classyQRTemplate: RecursivePartial<Options>;
-export declare const qrTemplates: {
-    [key: string]: RecursivePartial<Options>;
-};