xl-public-utils 1.0.1 → 1.0.3

package/index.d.ts

@@ -19,7 +19,7 @@ import vtkRenderer from "@kitware/vtk.js/Rendering/Core/Renderer";
  * @property {string} [textColor='#000'] - 字体颜色
  * @property {string} [textContent] - 右侧文字内容
  */
-declare module "public-utils" {
+declare module "xl-public-utils" {
   export interface QrCodeOptions {
     /** 二维码类型，具体支持请查看文档 */
     bcid?: string; // 默认值 'qrcode'
@@ -70,7 +70,7 @@ declare module "public-utils" {
     textContent?: string;
   }
 
-  export module vtk {
+  export namespace vtk {
     /**
      * 计算屏幕坐标到三维坐标
      * @param {vtkRenderer} renderer vtkRenderer
@@ -102,7 +102,7 @@ declare module "public-utils" {
     ): [number, number, number];
   }
 
-  export module window {
+  export namespace public {
     /**
      * 获取当前屏幕分辨率(百分制,默认100)
      * @returns {number} 当前屏幕分辨率
@@ -115,7 +115,7 @@ declare module "public-utils" {
      */
     export function detectZoom(): number;
   }
-  export module qrcode {
+  export namespace qrcode {
     /**
      * 生成一个二维码图片，可以在二维码右侧添加二维码文字内容信息
      * @param {string} content 二维码内容
@@ -127,4 +127,177 @@ declare module "public-utils" {
       options?: QrCodeOptions
     ): string | false;
   }
+
+  export namespace BwipJs {
+    export interface BwippOptions {
+      includecheck?: boolean | undefined;
+      includecheckintext?: boolean | undefined;
+
+      parse?: boolean | undefined;
+      parsefnc?: boolean | undefined;
+
+      height?: number | undefined;
+      width?: number | undefined;
+
+      inkspread?: number | undefined;
+      inkspreadh?: number | undefined;
+      inkspreadv?: number | undefined;
+      dotty?: boolean | undefined;
+
+      binarytext?: boolean | undefined; // really a bwip-js option but better positioned here
+      includetext?: boolean | undefined;
+      textfont?: string | undefined;
+      textsize?: number | undefined;
+      textgaps?: number | undefined;
+      alttext?: string | undefined;
+
+      textxalign?:
+        | "offleft"
+        | "left"
+        | "center"
+        | "right"
+        | "offright"
+        | "justify"
+        | undefined;
+      textyalign?: "below" | "center" | "above" | undefined;
+      textxoffset?: number | undefined;
+      textyoffset?: number | undefined;
+
+      showborder?: boolean | undefined;
+      borderwidth?: number | undefined;
+      borderleft?: number | undefined;
+      borderright?: number | undefined;
+      bordertop?: number | undefined;
+      boraderbottom?: number | undefined;
+
+      barcolor?: string | undefined;
+      backgroundcolor?: string | undefined;
+      bordercolor?: string | undefined;
+      textcolor?: string | undefined;
+
+      addontextxoffset?: number | undefined;
+      addontextyoffset?: number | undefined;
+      addontextfont?: string | undefined;
+      addontextsize?: number | undefined;
+
+      guardwhitespace?: boolean | undefined;
+      guardwidth?: number | undefined;
+      guardheight?: number | undefined;
+      guardleftpos?: number | undefined;
+      guardrightpos?: number | undefined;
+      guardleftypos?: number | undefined;
+      guardrightypos?: number | undefined;
+    }
+    export interface RenderOptions extends BwippOptions {
+      bcid: string;
+      text: string;
+
+      scaleX?: number | undefined;
+      scaleY?: number | undefined;
+      scale?: number | undefined;
+
+      rotate?: "N" | "R" | "L" | "I" | undefined;
+
+      paddingwidth?: number | undefined;
+      paddingheight?: number | undefined;
+
+      paddingleft?: number | undefined;
+      paddingright?: number | undefined;
+      paddingtop?: number | undefined;
+      paddingbottom?: number | undefined;
+
+      monochrome?: boolean | undefined;
+      sizelimit?: number | undefined;
+    }
+    export interface RawOptions extends BwippOptions {
+      bcid: string;
+      text: string;
+    }
+    export interface DrawingContext<T> {
+      setopts?(options: RenderOptions): void;
+      scale(sx: number, sy: number): [number, number] | null;
+      measure(
+          str: string,
+          font: string,
+          fwidth: number,
+          fheight: number,
+      ): { width: number; ascent: number; descent: number };
+      init(width: number, height: number): void;
+      line(x0: number, y0: number, x1: number, y1: number, lw: number, rgb: string): void;
+      polygon(pts: Array<[number, number]>): void;
+      hexagon(pts: [[number, number], [number, number], [number, number], [number, number], [number, number]]): void;
+      ellipse(x: number, y: number, rx: number, ry: number, ccw: boolean): void;
+      fill(rgb: string): void;
+      text(x: number, y: number, str: string, rgb: string, font: { name: string; width: number; height: number; dx: number },): void;
+      end(): T;
+    }
+    
+    export function render<T>(params: RenderOptions, drawing: DrawingContext<T>): T;
+    export function raw(
+      bcid: string,
+      text: string,
+      opts?: BwippOptions,
+    ):
+      | Array<{ bbs: number[]; bhs: number[]; sbs: number[] }>
+      | Array<{ pixs: number[]; pixx: number; pixy: number; height: number; width: number }>;
+    }
+    export const BWIPP_VERSION: string;
+    export const BWIPJS_VERSION: string;
+
+    // wrapper around FontLib.loadFont()
+    export function loadFont(name: string, data: string | Uint8Array): void;
+    export function loadFont(name: string, mult: number, data: string | Uint8Array): void;
+    export function loadFont(name: string, multy: number, multx: number, data: string | Uint8Array): void;
+
+    export namespace FontLib {
+      export interface PathData
+          extends Array<
+              | { type: 'M'; x: number; y: number }
+              | { type: 'L'; x: number; y: number }
+              | { type: 'Q'; x: number; y: number; cx: number; cy: number }
+              | { type: 'C'; x: number; y: number; cx1: number; cy1: number; cx2: number; cy2: number }
+          > {
+          ascent: number;
+          descent: number;
+          advance: number;
+      }
+      export function lookup(font: string): number;
+      export function monochrome(mono: boolean): void;
+      export function getglyph(
+          fontid: number,
+          charcode: number,
+          width: number,
+          height: number,
+      ): {
+          glyph: number;
+          top: number;
+          left: number;
+          width: number;
+          height: number;
+          advance: number;
+          pixels: Uint8Array;
+          bytes: Uint8Array;
+          cachekey: string;
+          offset: number;
+      };
+      export function getpaths(fontid: number, charcode: number, width: number, height: number): PathData;
+      export function loadFont(name: string, data: string | Uint8Array): void;
+      export function loadFont(name: string, mult: number, data: string | Uint8Array): void;
+      export function loadFont(name: string, multy: number, multx: number, data: string | Uint8Array): void;
+    }
+    export function toSVG(opts: RenderOptions): string;
+    export function drawingSVG(): DrawingContext<string>;
+
+    // platform-specific exports
+    export function toCanvas(canvas: string | HTMLCanvasElement, opts: RenderOptions): HTMLCanvasElement;
+    export function drawingCanvas(canvas: string | HTMLCanvasElement): DrawingContext<HTMLCanvasElement>;
+    
+    export function datamatrix(canvas: string | HTMLCanvasElement, opts: RenderOptions): HTMLCanvasElement;
+    export function datamatrix<T>(opts: RenderOptions, drawing: DrawingContext<Promise<T>>): Promise<T>;
+    export function datamatrix<T>(opts: RenderOptions, drawing: DrawingContext<T>): T;
+
+    
+    export function qrcode(canvas: string | HTMLCanvasElement, opts: RenderOptions): HTMLCanvasElement;
+    export function qrcode<T>(opts: RenderOptions, drawing: DrawingContext<Promise<T>>): Promise<T>;
+    export function qrcode<T>(opts: RenderOptions, drawing: DrawingContext<T>): T;
 }

package/index.js

@@ -1,4 +1,5 @@
-import * as vtk from './src/vtk.js';
-import * as window from './src/window.js'
-import * as qrcode from './src/qrcode.js'
-export { vtk, window, qrcode };
+import * as vtkUtils from './src/vtkUtils.mjs';
+import * as utils from './src/utils.mjs'
+import * as qrcode from './src/qrcode.mjs'
+import * as BwipJs from './src/bwip-js.mjs';
+export { vtkUtils, utils, qrcode, BwipJs };

package/package.json

@@ -1,21 +1,25 @@
 {
   "name": "xl-public-utils",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "一些通用的方法",
   "main": "index.js",
   "module": "index.js",
   "types": "index.d.ts",
   "peerDependencies": {
-    "@kitware/vtk.js": "^25.7.2",
-    "bwip-js": "4.3.1"
+    "@kitware/vtk.js": ">=25.7.2"
+  },
+  "peerDependenciesMeta": {
+    "@kitware/vtk.js": {
+      "optional": true
+    }
   },
   "exports": {
     ".": "./index.js",
-    "./qrcode": "./src/qrcode.js",
-    "./vtk": "./src/vtk.js",
-    "./window": "./src/window.js"
+    "./qrcode": "./src/qrcode.mjs",
+    "./vtkUtils": "./src/vtkUtils.mjs",
+    "./utils": "./src/utils.mjs",
+    "./bwipJs": "./src/bwip-js.mjs"
   },
-  "devDependencies": {},
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },