@qr-platform/qr-code.js 0.8.17

package/lib/templates/borders.d.ts

@@ -0,0 +1,129 @@
+import * as _browserUtils from '../tools/browser-utils.js';
+export { ErrorCorrectionLevel, Mode, TypeNumber } from '~/lib/qrcode/QRCodeMinimal.js';
+export { QRCodeJs, type ExtensionFunction } from '../core/qr-code-js.js';
+export { FileExtension } from '../tools/browser-utils.js';
+export { type RecursivePartial } from '../types/helper.js';
+export { type CanvasOptions } from '../utils/canvas-options.js';
+export { GradientType, type Gradient } from '../utils/gradient';
+export { CornerDotType, CornerSquareType, DotType, ImageMode, ShapeType, type Options } from '../utils/options.js';
+export { ErrorCorrectionPercents } from '../utils/qrcode.js';
+export declare const codes: {
+    borderOptions: {
+        hasBorder: boolean;
+        radius: string;
+        thickness: number;
+        color: string;
+        decorations: {
+            top: {
+                disabled: boolean;
+                enableText: boolean;
+                offset: number;
+                curveAdjustment: number;
+                curveDisabled: boolean;
+                type: "text" | "image";
+                value: string;
+                style: {
+                    fontFace: string;
+                    fontSize: number;
+                    fontColor: string;
+                    letterSpacing: number;
+                    fontWeight: string;
+                };
+            };
+            bottom: {
+                disabled: boolean;
+                enableText: boolean;
+                offset: number;
+                curveAdjustment: number;
+                curveDisabled: boolean;
+                type: "text" | "image";
+                value: string;
+                style: {
+                    fontFace: string;
+                    fontSize: number;
+                    fontColor: string;
+                    letterSpacing: number;
+                    fontWeight: string;
+                };
+            };
+            left: {
+                disabled: boolean;
+                enableText: boolean;
+                offset: number;
+                curveAdjustment: number;
+                curveDisabled: boolean;
+                type: "text" | "image";
+                value: string;
+                style: {
+                    fontFace: string;
+                    fontSize: number;
+                    fontColor: string;
+                    letterSpacing: number;
+                    fontWeight: string;
+                };
+            };
+            right: {
+                disabled: boolean;
+                enableText: boolean;
+                offset: number;
+                curveAdjustment: number;
+                curveDisabled: boolean;
+                type: "text" | "image";
+                value: string;
+                style: {
+                    fontFace: string;
+                    fontSize: number;
+                    fontColor: string;
+                    letterSpacing: number;
+                    fontWeight: string;
+                };
+            };
+        };
+        borderOuter: {
+            color: string;
+            thickness: number;
+        };
+        borderInner: {
+            color: string;
+            thickness: number;
+        };
+    };
+    name: string;
+    description: string;
+    data: string;
+    image: string;
+    scale: number;
+    margin: number;
+    isResopnsive: boolean;
+    verticalOffset: 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;
+            }[];
+        };
+    };
+}[];
+export declare const browserUtils: typeof _browserUtils | undefined;

package/lib/templates/scales.d.ts

@@ -0,0 +1,130 @@
+import * as _browserUtils from '../tools/browser-utils.js';
+export { ErrorCorrectionLevel, Mode, TypeNumber } from '~/lib/qrcode/QRCodeMinimal.js';
+export { QRCodeJs, type ExtensionFunction } from '../core/qr-code-js.js';
+export { FileExtension } from '../tools/browser-utils.js';
+export { type RecursivePartial } from '../types/helper.js';
+export { type CanvasOptions } from '../utils/canvas-options.js';
+export { GradientType, type Gradient } from '../utils/gradient';
+export { CornerDotType, CornerSquareType, DotType, ImageMode, ShapeType, type Options } from '../utils/options.js';
+export { ErrorCorrectionPercents } from '../utils/qrcode.js';
+export declare const codes: {
+    borderOptions: {
+        hasBorder: boolean;
+        radius: string;
+        thickness: number;
+        color: string;
+        decorations: {
+            top: {
+                disabled: boolean;
+                enableText: boolean;
+                offset: number;
+                curveAdjustment: number;
+                curveDisabled: boolean;
+                type: "text" | "image";
+                value: string;
+                style: {
+                    fontFace: string;
+                    fontSize: number;
+                    fontColor: string;
+                    letterSpacing: number;
+                    fontWeight: string;
+                };
+            };
+            bottom: {
+                disabled: boolean;
+                enableText: boolean;
+                offset: number;
+                curveAdjustment: number;
+                curveDisabled: boolean;
+                type: "text" | "image";
+                value: string;
+                style: {
+                    fontFace: string;
+                    fontSize: number;
+                    fontColor: string;
+                    letterSpacing: number;
+                    fontWeight: string;
+                };
+            };
+            left: {
+                disabled: boolean;
+                enableText: boolean;
+                offset: number;
+                curveAdjustment: number;
+                curveDisabled: boolean;
+                type: "text" | "image";
+                value: string;
+                style: {
+                    fontFace: string;
+                    fontSize: number;
+                    fontColor: string;
+                    letterSpacing: number;
+                    fontWeight: string;
+                };
+            };
+            right: {
+                disabled: boolean;
+                enableText: boolean;
+                offset: number;
+                curveAdjustment: number;
+                curveDisabled: boolean;
+                type: "text" | "image";
+                value: string;
+                style: {
+                    fontFace: string;
+                    fontSize: number;
+                    fontColor: string;
+                    letterSpacing: number;
+                    fontWeight: string;
+                };
+            };
+        };
+        borderOuter: {
+            color: string;
+            thickness: number;
+        };
+        borderInner: {
+            color: string;
+            thickness: number;
+        };
+    };
+    name: string;
+    description: string;
+    data: string;
+    image: string;
+    scale: number;
+    margin: number;
+    isResopnsive: boolean;
+    verticalOffset: number;
+    shape: string;
+    qrOptions: {};
+    imageOptions: {
+        imageSize: number;
+        margin: number;
+        roundedValue: number;
+    };
+    dotsOptions: {
+        type: string;
+        color: string;
+        size: number;
+    };
+    cornersSquareOptions: {
+        type: string;
+        color: string;
+    };
+    cornersDotOptions: {
+        type: string;
+        color: string;
+    };
+    backgroundOptions: {
+        color: string;
+        gradient: {
+            type: string;
+            colorStops: {
+                offset: number;
+                color: string;
+            }[];
+        };
+    };
+}[];
+export declare const browserUtils: typeof _browserUtils | undefined;

package/lib/templates/scan-validators/index.d.ts

@@ -0,0 +1 @@
+export declare function createNavigationHeader(currentPage?: string, targetElement?: HTMLElement, basePath?: string): HTMLElement;

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

@@ -0,0 +1,9 @@
+declare const _default: {
+    expect: {
+        isValid: boolean;
+        isInverted: boolean | undefined;
+    };
+    options: any;
+    name: string;
+}[];
+export default _default;

package/lib/templates/scan-validators/tests/cases/basic-no-license.d.ts

@@ -0,0 +1,3 @@
+import { TestCase } from '../index';
+declare const cases: TestCase[];
+export default cases;

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

@@ -0,0 +1,3 @@
+import { TestCase } from '../index';
+declare const cases: TestCase[];
+export default cases;

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

@@ -0,0 +1,2 @@
+declare const cases: any[];
+export default cases;

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

@@ -0,0 +1,58 @@
+import { TestCase } from '..';
+export declare const baseOptions: {
+    name: string;
+    description: string;
+    data: string;
+    scale: number;
+    margin: number;
+    shape: string;
+    qrOptions: {
+        errorCorrectionLevel: string;
+    };
+    dotsOptions: {
+        type: string;
+        color: string;
+    };
+    cornersSquareOptions: {
+        type: string;
+        color: string;
+    };
+    cornersDotOptions: {
+        type: string;
+        color: string;
+    };
+    backgroundOptions: {
+        color: string;
+    };
+};
+export declare const darkContrastColors: (alpha: number | string) => string[];
+export declare const lightContrastColors: (alpha: number | string) => string[];
+export declare const buildOptions: (elementColor: string, backgroundColor: string) => {
+    dotsOptions: {
+        color: string;
+        type: string;
+    };
+    cornersSquareOptions: {
+        color: string;
+        type: string;
+    };
+    cornersDotOptions: {
+        color: string;
+        type: string;
+    };
+    backgroundOptions: {
+        color: string;
+    };
+    name: string;
+    description: string;
+    data: string;
+    scale: number;
+    margin: number;
+    shape: string;
+    qrOptions: {
+        errorCorrectionLevel: string;
+    };
+};
+export declare const alphas: number[];
+declare const cases: TestCase[];
+export default cases;

package/lib/templates/scan-validators/tests/cases/out-of-borders-inverted.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    options: any;
+    expect: {
+        isValid: boolean;
+        isInverted: boolean | undefined;
+    };
+    name: string;
+}[];
+export default _default;

package/lib/templates/scan-validators/tests/cases/out-of-borders.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    options: any;
+    name: string;
+    expect: {
+        isValid: boolean;
+        isInverted?: boolean;
+    };
+}[];
+export default _default;

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

@@ -0,0 +1,9 @@
+declare const _default: {
+    expect: {
+        isValid: boolean;
+        isInverted: boolean | undefined;
+    };
+    options: any;
+    name: string;
+}[];
+export default _default;

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

@@ -0,0 +1,3 @@
+import { TestCase } from '..';
+declare const cases: TestCase[];
+export default cases;

package/lib/templates/scan-validators/tests/index.d.ts

@@ -0,0 +1,27 @@
+export declare const testStatusFailed = "failed";
+export declare const testStatusPassed = "passed";
+export declare const defaultValidatorId = "zbar";
+export declare const validators: {
+    id: string;
+    name: string;
+}[];
+export declare const testCases: {
+    id: string;
+    name: string;
+}[];
+export interface TestCase {
+    name: string;
+    expect: {
+        isValid: boolean;
+        isInverted?: boolean;
+    };
+    options: any;
+}
+export declare const invertCases: (cases: TestCase[], isValid?: boolean, isInverted?: boolean) => {
+    expect: {
+        isValid: boolean;
+        isInverted: boolean | undefined;
+    };
+    options: any;
+    name: string;
+}[];

package/lib/tools/browser-image-tools.d.ts

@@ -0,0 +1,7 @@
+export declare const browserImageTools: {
+    toDataURL: (url: string | Buffer | Blob) => Promise<string>;
+    getSize: (src: string | Blob | Buffer, crossOrigin?: string) => Promise<{
+        width: number;
+        height: number;
+    }>;
+};

package/lib/tools/browser-utils.d.ts

@@ -0,0 +1,18 @@
+import { QRCodeJs } from '../core/qr-code-js.js';
+import { RecursivePartial } from '../types/helper.js';
+import { CanvasOptions } from '../utils/canvas-options.js';
+export declare enum FileExtension {
+    svg = "svg",
+    png = "png",
+    jpeg = "jpeg",
+    webp = "webp"
+}
+export declare function drawToCanvas(qrCode: QRCodeJs, options?: RecursivePartial<CanvasOptions>): {
+    canvas: HTMLCanvasElement;
+    canvasDrawingPromise: Promise<void> | undefined;
+} | undefined;
+export declare function download(qrCode: QRCodeJs, downloadOptions?: {
+    name?: string;
+    extension: `${FileExtension}`;
+}, options?: RecursivePartial<CanvasOptions>): Promise<void>;
+export declare function downloadURI(uri: string, name: string): void;

package/lib/types/helper.d.ts

@@ -0,0 +1,23 @@
+export type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends Array<infer U> ? Array<RecursivePartial<U>> : T[P] extends object | undefined ? RecursivePartial<T[P]> : T[P];
+};
+export interface DrawArgs {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+    getNeighbor?: (x: number, y: number) => boolean;
+}
+export interface BasicFigureDrawArgs {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+}
+export interface RotateFigureArgs {
+    x: number;
+    y: number;
+    size: number;
+    rotation?: number;
+    draw: () => void;
+}

package/lib/utils/canvas-options.d.ts

@@ -0,0 +1,7 @@
+export interface CanvasOptions {
+    width: number;
+    height: number;
+    margin: number;
+}
+export declare const defaultCanvasOptions: CanvasOptions;
+export declare function sanitizeCanvasOptions(options: CanvasOptions): CanvasOptions;

package/lib/utils/color.d.ts

@@ -0,0 +1,4 @@
+export declare function parseColor(cstr: string): {
+    value: string;
+    alpha: number;
+};

package/lib/utils/gradient.d.ts

@@ -0,0 +1,26 @@
+export declare enum GradientType {
+    radial = "radial",
+    linear = "linear"
+}
+export interface 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: Array<{
+        /** Position of color in gradient range */
+        offset: number;
+        /** Color of stop in gradient range */
+        color: string;
+    }>;
+}
+export declare function sanitizeGradient(gradient: Gradient): Gradient;

package/lib/utils/image.d.ts

@@ -0,0 +1,16 @@
+interface ImageSizeOptions {
+    originalHeight: number;
+    originalWidth: number;
+    maxHiddenDots: number;
+    maxHiddenAxisDots?: number;
+    dotSize: number;
+    margin: number;
+}
+interface ImageSizeResult {
+    height: number;
+    width: number;
+    hideYDots: number;
+    hideXDots: number;
+}
+export declare function calculateImageSize({ originalHeight, originalWidth, maxHiddenDots, maxHiddenAxisDots, dotSize, margin }: ImageSizeOptions): ImageSizeResult;
+export {};

package/lib/utils/merge.d.ts

@@ -0,0 +1,5 @@
+export type UnknownObject = {
+    [key: string]: any;
+} | undefined;
+export declare function rv(s: string, toUpperCase?: boolean): string;
+export declare function mergeDeep(target: UnknownObject, ...sources: UnknownObject[]): UnknownObject;