xl-public-utils 1.0.4 → 1.0.6

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outFile": "./index.d.ts" // 可选，定义.d.ts文件输出目录
+  },
+  "include": ["index.js", "src/*.mjs"] // 指定包含的 JavaScript 文件路径
+}

package/types/bwip-js.d.mts

@@ -0,0 +1,106 @@
+export function datamatrix(opts: any, dwg: any): any;
+export function qrcode(opts: any, dwg: any): any;
+export function raw(bcid: any, text: any, options: any): true | any[];
+declare namespace _default {
+    export { ToCanvas as toCanvas };
+    export { ToSVG as toSVG };
+    export { Render as render };
+    export { ToRaw as raw };
+    export { DrawingCanvas as drawingCanvas };
+    export { DrawingSVG as drawingSVG };
+    export { FixupOptions as fixupOptions };
+    export { LoadFont as loadFont };
+    export { FontLib };
+    export { BWIPJS_VERSION };
+    export { BWIPP_VERSION };
+}
+export default _default;
+declare function ToCanvas(cvs: any, opts: any): any;
+declare function ToSVG(opts: any): any;
+declare function Render(options: any, drawing: any): any;
+declare function LoadFont(...args: any[]): any;
+declare function DrawingCanvas(canvas: any, maybe: any): {
+    setopts(options: any): void;
+    scale: (sx: any, sy: any) => any[];
+    measure: (str: any, font: any, fwidth: any, fheight: any) => {
+        width: number;
+        ascent: number;
+        descent: number;
+    };
+    init: (width: any, height: any) => void;
+    line: (x0: any, y0: any, x1: any, y1: any, lw: any, rgb: any) => void;
+    polygon: (pts: any) => void;
+    hexagon: (pts: any, rgb: any) => void;
+    ellipse: (x: any, y: any, rx: any, ry: any, ccw: any) => void;
+    fill: (rgb: any) => void;
+    clip: (polys: any) => void;
+    unclip: () => void;
+    text: (x: any, y: any, str: any, rgb: any, font: any) => void;
+    end: () => void;
+};
+declare function DrawingSVG(): {
+    setopts(options: any): void;
+    scale(sx: any, sy: any): void;
+    measure(str: any, font: any, fwidth: any, fheight: any): {
+        width: number;
+        ascent: number;
+        descent: number;
+    };
+    init(width: any, height: any): void;
+    line(x0: any, y0: any, x1: any, y1: any, lw: any, rgb: any): void;
+    polygon(pts: any): void;
+    hexagon(pts: any, rgb: any): void;
+    ellipse(x: any, y: any, rx: any, ry: any, ccw: any): void;
+    fill(rgb: any): void;
+    clip: (polys: any) => void;
+    unclip: () => void;
+    text(x: any, y: any, str: any, rgb: any, font: any): void;
+    end(): string;
+};
+export const BWIPJS_VERSION: "4.5.1 (2024-08-12)";
+import { BWIPP_VERSION } from './bwipp.mjs';
+declare function ToRaw(bcid: any, text: any, options: any, ...args: any[]): true | any[];
+declare function FixupOptions(opts: any): any;
+declare namespace FontLib {
+    export { lookup };
+    export { monochrome };
+    export { getglyph };
+    export { getpaths };
+    export { loadFont };
+}
+declare function lookup(name: any): any;
+declare function monochrome(mono: any): void;
+declare function getglyph(fontid: any, charcode: any, width: any, height: any): any;
+declare function getpaths(fontid: any, charcode: any, width: any, height: any): ({
+    type: string;
+    x: number;
+    y: number;
+    cx?: undefined;
+    cy?: undefined;
+    cx1?: undefined;
+    cy1?: undefined;
+    cx2?: undefined;
+    cy2?: undefined;
+} | {
+    type: string;
+    x: number;
+    y: number;
+    cx: number;
+    cy: number;
+    cx1?: undefined;
+    cy1?: undefined;
+    cx2?: undefined;
+    cy2?: undefined;
+} | {
+    type: string;
+    x: number;
+    y: number;
+    cx1: number;
+    cy1: number;
+    cx2: number;
+    cy2: number;
+    cx?: undefined;
+    cy?: undefined;
+})[];
+declare function loadFont(name: any, ...args: any[]): number;
+export { ToCanvas as toCanvas, ToSVG as toSVG, Render as render, LoadFont as loadFont, DrawingCanvas as drawingCanvas, DrawingSVG as drawingSVG, BWIPP_VERSION };

package/types/bwipp.d.mts

@@ -0,0 +1,5 @@
+export function bwipp_datamatrix(): void;
+export function bwipp_qrcode(): void;
+export function bwipp_lookup(symbol: any): typeof bwipp_qrcode;
+export function bwipp_encode(bwipjs: any, encoder: any, text: any, opts: any, dontdraw: any): true | any[];
+export var BWIPP_VERSION: string;

package/types/drcUtils.d.mts

@@ -0,0 +1,129 @@
+/**
+ * @typedef {Object} AttrOption
+ * @property {number[]} [colors] 颜色数组
+ * @property {number[]} [generics] 属性数组
+ * @property {number[]} [normals] 法向量数组
+ */
+/**
+ * 将数据进行压缩
+ * @param {number[]} vertices 网格点
+ * @param {number[]} faces 网格面，必须是三角化之后的面，每连续的三个点索引标识一个面
+ * @param {number} byteLength=14 byteLength 压缩率
+ * @param {AttrOption} [attr] 其他需要压缩的属性
+ * @returns {Int8Array} 压缩之后的DRC数据
+ */
+export function enCodeMeshByVF(vertices: number[], faces: number[], byteLength?: number, attr?: AttrOption): Int8Array;
+/**
+ * 使用drc压缩点
+ * @param {vec3[] | number[]} points 点数组
+ * @returns {Int8Array} 压缩之后的drc data
+ */
+export function enCodePointCloud(points: vec3[] | number[]): Int8Array;
+/**
+ * 解压drc格式的点云数据
+ * @param {ArrayBuffer} byteArray drc点数据
+ * @returns {Float32Array} 点数组
+ */
+export function decodePointCloud(byteArray: ArrayBuffer): Float32Array;
+/**
+ * @typedef {Object} DrcMeshData
+ * @property {Uint32Array} faces 网格面数组
+ * @property {Float32Array} vertices 网格点数组
+ * @property {Float32Array} [colors] 颜色数组
+ * @property {Float32Array} [generics] 属性数组
+ * @property {Float32Array} [normals] 法向量数组
+ */
+/**
+ * 解压drc格式的网格数据
+ * @param {ArrayBuffer} byteArray drc网格数据
+ * @returns {DrcMeshData} 网格数据
+ */
+export function decodeDrcBufferArray(byteArray: ArrayBuffer): DrcMeshData;
+/**
+ * @typedef {Object} Decoder
+ */
+/**
+ * 输入一个Drc数据，反会对应的解压器
+ * @param {ArrayBuffer} arrayBuffer 输入的数据
+ * @returns {Decoder} drc解压类
+ */
+export function decodeBuffer(arrayBuffer: ArrayBuffer): Decoder;
+/**
+ * 获取decoder中的属性
+ * @param {Decoder} dracoGeometry DRC Decoder
+ * @param {number} attributeId 需要获取的属性id
+ * @returns {Float32Array} 对应decoder中的属性
+ */
+export function getDracoAttributeAsFloat32Array(dracoGeometry: Decoder, attributeId: number): Float32Array;
+/**
+ * 将点数据使用drc压缩处理为 base64 string
+ * @param {vec3[] | number[]} points 点数据
+ * @returns {string} drc压缩之后的base64数据
+ */
+export function enCloudPointTobase64(points: vec3[] | number[]): string;
+/**
+ * @typedef {Object} Mesh
+ * @property {number[][]} vertices 点信息
+ * @property {number[][]} faces 面信息
+ */
+/**
+ * 使用drc压缩网格信息
+ * @param {Mesh | vtkPolyData} mesh
+ * @param {number} byteLength=14  压缩率
+ * @param {AttrOption} [attr] 其他需要压缩的属性
+ * @returns {Int8Array} 压缩之后的DRC数据
+ */
+export function enCodeMesh(mesh: Mesh | vtkPolyData, byteLength?: number, attr?: AttrOption): Int8Array;
+/**
+ * 初始化Draco文件
+ */
+export function initDrcCoder(): void;
+export type AttrOption = {
+    /**
+     * 颜色数组
+     */
+    colors?: number[];
+    /**
+     * 属性数组
+     */
+    generics?: number[];
+    /**
+     * 法向量数组
+     */
+    normals?: number[];
+};
+export type DrcMeshData = {
+    /**
+     * 网格面数组
+     */
+    faces: Uint32Array;
+    /**
+     * 网格点数组
+     */
+    vertices: Float32Array;
+    /**
+     * 颜色数组
+     */
+    colors?: Float32Array;
+    /**
+     * 属性数组
+     */
+    generics?: Float32Array;
+    /**
+     * 法向量数组
+     */
+    normals?: Float32Array;
+};
+export type Decoder = any;
+export type Mesh = {
+    /**
+     * 点信息
+     */
+    vertices: number[][];
+    /**
+     * 面信息
+     */
+    faces: number[][];
+};
+import { vec3 } from "gl-matrix";
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";

package/types/exportPLY.d.mts

@@ -0,0 +1,16 @@
+/**
+ * 将polyData转换为ply文件
+ * @param {vtkPolyData} polyData 需要导出的polydata
+ * @param {'ascii' | 'binary'} format 导出文件格式
+ * @param {0 | 1} dataByteOrder=0 字节序,默认为0, 0为大端模式， 1小端模式
+ * @param {string[]} headerComments=[] 文件头描述
+ * @param {string} textureFileName='' header描述文件名
+ * @param {['u', 'v']} textureCoordinatesName=['u', 'v'] header添加u和v
+ * @param {boolean} withNormals=false 是否需要法向量
+ * @param {boolean} withUVs=false 是否需要UV
+ * @param {boolean} withColors=false 是否需要Colors
+ * @param {boolean} withColors=true 面使用点索引
+ * @returns {string | DataView} 返回文件内容
+ */
+export function writePLY(polyData: vtkPolyData, format: "ascii" | "binary", dataByteOrder?: 0 | 1, headerComments?: string[], textureFileName?: string, textureCoordinatesName?: ["u", "v"], withNormals?: boolean, withUVs?: boolean, withColors?: boolean, withIndices?: boolean): string | DataView;
+import vtkPolyData from "@kitware/vtk.js/Common/DataModel/PolyData";

package/types/exportSTL.d.mts

@@ -0,0 +1,19 @@
+/**
+ * 导出stl模型的时候 需要离散点 防止被认为是同一个点 精度到e-7就够了
+ * @param {number[]} points 网格点
+ */
+export function dispersedPoints2Stl(points: number[]): void;
+/**
+ * 获取网格的BinarySTL文件类容
+ * @param {vtkPolyData} polydata 网格
+ * @param {boolean} colorMagic=false 颜色
+ * @returns {Blob} 网格的BinarySTL文件内容
+ */
+export function exportBinarySTL(polydata: vtkPolyData, colorMagic?: boolean): Blob;
+/**
+ * 获取网格的AsciiSTL文件类容
+ * @param {vtkPolyData} polydata 网格
+ * @returns {string} 网格的asciiSTL文件内容
+ */
+export function exportAsciiSTL(polydata: vtkPolyData): string;
+import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData';

package/types/qrcode.d.mts

@@ -0,0 +1,92 @@
+/**
+ * @typedef {Object} QrCodeOptions
+ * @property {'qrcode' | 'dataMatrix'} bcid='qrcode' - 二维码类型，具体支持请查看文档
+ * @property {number} width=1056 - 最终图片宽度
+ * @property {number} height=342 - 最终图片高度
+ * @property {number} qrcodeW=300 - 二维码宽度
+ * @property {number} qrcodeH=300 - 二维码高度
+ * @property {boolean} addText=true - 是否在右侧添加文字
+ * @property {number} top=10 - 顶部距离
+ * @property {number} left=10 - 左侧距离
+ * @property {number} lineHeight=1 - 文字行高，换行后下一行文字的y位置计算为fontSize * lineHeight
+ * @property {number} fontSize=60 - 文字大小
+ * @property {string} fontFamily='黑体' - 字体类型
+ * @property {string} bgColor='#fff' - 背景颜色
+ * @property {number} textLeftMargin=20 - 文字距离二维码间隔
+ * @property {boolean} fontWeight=700 - 字体加粗
+ * @property {string} textColor='#000' - 字体颜色
+ * @property {string} textContent - 右侧文字内容
+ */
+/**
+ * 生成一个二维码图片，可以在二维码右侧添加二维码文字内容信息
+ * @param {string} content 二维码内容
+ * @param {QrCodeOptions} options 图片参数
+ * @returns {string | false} 返回图片的base64
+ */
+export function generateQRCodeWithText(content: string, options?: QrCodeOptions): string | false;
+export type QrCodeOptions = {
+    /**
+     * ='qrcode' - 二维码类型，具体支持请查看文档
+     */
+    bcid: "qrcode" | "dataMatrix";
+    /**
+     * =1056 - 最终图片宽度
+     */
+    width: number;
+    /**
+     * =342 - 最终图片高度
+     */
+    height: number;
+    /**
+     * =300 - 二维码宽度
+     */
+    qrcodeW: number;
+    /**
+     * =300 - 二维码高度
+     */
+    qrcodeH: number;
+    /**
+     * =true - 是否在右侧添加文字
+     */
+    addText: boolean;
+    /**
+     * =10 - 顶部距离
+     */
+    top: number;
+    /**
+     * =10 - 左侧距离
+     */
+    left: number;
+    /**
+     * =1 - 文字行高，换行后下一行文字的y位置计算为fontSize * lineHeight
+     */
+    lineHeight: number;
+    /**
+     * =60 - 文字大小
+     */
+    fontSize: number;
+    /**
+     * ='黑体' - 字体类型
+     */
+    fontFamily: string;
+    /**
+     * ='#fff' - 背景颜色
+     */
+    bgColor: string;
+    /**
+     * =20 - 文字距离二维码间隔
+     */
+    textLeftMargin: number;
+    /**
+     * =700 - 字体加粗
+     */
+    fontWeight: boolean;
+    /**
+     * ='#000' - 字体颜色
+     */
+    textColor: string;
+    /**
+     * - 右侧文字内容
+     */
+    textContent: string;
+};

package/types/utils.d.mts

@@ -0,0 +1,28 @@
+/**
+ * 获取当前屏幕分辨率(百分制,默认100)
+ * @returns {number} 当前屏幕分辨率
+ */
+export function getRatio(): number;
+/**
+ * 将Base64转换为ArrayBuffer
+ * @param {string} base64String
+ * @returns {ArrayBuffer} base64的ArrayBuffer
+ */
+export function base64ToArrayBuffer(base64String: string): ArrayBuffer;
+/**
+ * 将Int8Array转换为Base64格式的字符串
+ * @param {Int8Array} int8
+ * @returns {string} base64格式的字符串
+ */
+export function int8ArrayToBase64(int8: Int8Array): string;
+/**
+ * 将ArrayBuffer转换为Base64格式的字符串
+ * @param {ArrayBuffer} outputBuffer
+ * @returns {string} base64格式的字符串
+ */
+export function arrayBufferToBase64(outputBuffer: ArrayBuffer): string;
+/**
+ * 获取当前屏幕分辨率(百分制,默认100)
+ * @returns {number} 当前屏幕分辨率
+ */
+export function detectZoom(): number;