@oiij/js-pdf 0.0.1 → 0.0.2

package/README.md

@@ -1,25 +1,12 @@
-# JS-PDF
+# Use JS-PDF
 
-Features:
+[![NPM version](https://img.shields.io/npm/v/@oiij/js-pdf)](https://www.npmjs.com/package/@oiij/js-pdf)
+[![MIT-license](https://img.shields.io/npm/l/@oiij/js-pdf)](https://github.com/Eiog/@oiij/js-pdf/blob/main/LICENSE)
 
-- Bundle with [tsdown](https://github.com/rolldown/tsdown)
-- Test with [vitest](https://vitest.dev)
-
-# Usage
-
-### 安装
+## Usage
 
 ```bash
 pnpm add @oiij/js-pdf
 ```
 
-### 使用
-
-```ts
-import { openPdf } from '@oiij/js-pdf'
-const { pdf } = await openPdf()
-```
-
-## License
-
-MIT
+[在线文档](https://oiij-use.vercel.app/examples/js-pdf/started)

package/dist/index.cjs

@@ -1,4 +1,3 @@
-"use strict";
 //#region rolldown:runtime
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -22,13 +21,13 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 }) : target, mod));
 
 //#endregion
-const file_saver = __toESM(require("file-saver"));
 const jspdf = __toESM(require("jspdf"));
+const file_saver = __toESM(require("file-saver"));
 const jszip = __toESM(require("jszip"));
 const nanoid = __toESM(require("nanoid"));
 const pdfjs_dist = __toESM(require("pdfjs-dist"));
 
-//#region src/index.ts
+//#region src/utils.ts
 pdfjs_dist.GlobalWorkerOptions.workerSrc = `//unpkg.com/pdfjs-dist@${pdfjs_dist.version}/build/pdf.worker.min.mjs`;
 function file2Buffer(file) {
 	return new Promise((resolve, reject) => {
@@ -84,7 +83,7 @@ async function pdf2Canvases(pdf) {
 }
 async function openPdf(url) {
 	try {
-		if (url) {
+		if (url && (typeof url === "string" || url instanceof URL)) {
 			const pdf = await (0, pdfjs_dist.getDocument)(url).promise;
 			const { pages, id, canvases } = await pdf2Canvases(pdf);
 			return {
@@ -93,10 +92,9 @@ async function openPdf(url) {
 				id,
 				canvases
 			};
-		} else {
-			const [fileHandle] = await window.showOpenFilePicker({ types: [{ accept: { "application/pdf": [".pdf"] } }] });
-			const file = await fileHandle.getFile();
-			const buffer = await file2Buffer(file);
+		}
+		if (url instanceof File) {
+			const buffer = await file2Buffer(url);
 			const pdf = await (0, pdfjs_dist.getDocument)(buffer).promise;
 			const { pages, id, canvases } = await pdf2Canvases(pdf);
 			return {
@@ -153,8 +151,97 @@ function canvas2Zip(canvases, fileName) {
 		}).catch((error) => reject(error));
 	});
 }
+async function readPdfFile(buffer) {
+	const pdf = await (0, pdfjs_dist.getDocument)(buffer).promise;
+	const { pages, id, canvases } = await pdf2Canvases(pdf);
+	return {
+		pdf,
+		pages,
+		id,
+		canvases
+	};
+}
+
+//#endregion
+//#region src/index.ts
+function setDrawStyle(pdf, data) {
+	const { drawColor, fillColor, lineWidth } = data;
+	if (typeof fillColor === "string") pdf.setFillColor(fillColor);
+	else pdf.setFillColor(...fillColor);
+	if (typeof drawColor === "string") pdf.setDrawColor(drawColor);
+	else pdf.setDrawColor(...drawColor);
+	pdf.setLineWidth(lineWidth);
+}
+async function generatePDF(data, options, globalStyle) {
+	const pdf = new jspdf.jsPDF(options);
+	const font = pdf.getFont();
+	const { fontSize: _fontSize = pdf.getFontSize(), fontName: _fontName = font.fontName, fontStyle: _fontStyle = font.fontStyle, fontWeight: _fontWeight = "normal", textColor: _textColor = pdf.getTextColor() } = globalStyle ?? {};
+	const { drawColor: _drawColor = pdf.getDrawColor(), fillColor: _fillColor = pdf.getDrawColor(), charSpace: _charSpace = pdf.getCharSpace(), lineWidth: _lineWidth = pdf.getLineWidth(), style: _style = "S" } = globalStyle ?? {};
+	function setText(data$1) {
+		const { text, x, y, fontSize = _fontSize, fontName = _fontName, fontStyle = _fontStyle, fontWeight = _fontWeight,...textOpt } = data$1;
+		pdf.setFontSize(fontSize);
+		pdf.setFont(fontName, fontStyle, fontWeight);
+		pdf.text(text, x, y, textOpt);
+	}
+	async function setImage(data$1) {
+		const { imageData, x, y, width, height, alias, compression, rotation } = data$1;
+		const _imageData = typeof imageData === "function" ? await Promise.try(imageData) : imageData;
+		pdf.addImage(_imageData, x, y, width, height, alias, compression, rotation);
+	}
+	function setCircle(data$1) {
+		const { x, y, r } = data$1;
+		const { fillColor = _fillColor, drawColor = _drawColor, lineWidth = _lineWidth, style = _style } = data$1;
+		setDrawStyle(pdf, {
+			fillColor,
+			drawColor,
+			lineWidth
+		});
+		pdf.circle(x, y, r, style);
+	}
+	function setLine(data$1) {
+		const { x1, y1, x2, y2 } = data$1;
+		const { fillColor = _fillColor, drawColor = _drawColor, lineWidth = _lineWidth, style = _style } = data$1;
+		setDrawStyle(pdf, {
+			fillColor,
+			drawColor,
+			lineWidth
+		});
+		pdf.line(x1, y1, x2, y2, style);
+	}
+	function setLines(data$1) {
+		const { lines, x, y, scale = [1, 1], closed = false } = data$1;
+		const { fillColor = _fillColor, drawColor = _drawColor, lineWidth = _lineWidth, style = _style } = data$1;
+		setDrawStyle(pdf, {
+			fillColor,
+			drawColor,
+			lineWidth
+		});
+		pdf.lines(lines, x, y, scale, style, closed);
+	}
+	for (const { type,...opt } of data) switch (type) {
+		case "text":
+			setText(opt);
+			break;
+		case "image":
+			await setImage(opt);
+			break;
+		case "circle":
+			setCircle(opt);
+			break;
+		case "line":
+			setLine(opt);
+			break;
+		case "lines":
+			setLines(opt);
+			break;
+		default: break;
+	}
+	return { pdf };
+}
 
 //#endregion
-exports.canvas2Pdf = canvas2Pdf
-exports.canvas2Zip = canvas2Zip
-exports.openPdf = openPdf
+exports.canvas2Pdf = canvas2Pdf;
+exports.canvas2Zip = canvas2Zip;
+exports.generatePDF = generatePDF;
+exports.openPdf = openPdf;
+exports.readPdfFile = readPdfFile;

package/dist/index.d.cts

@@ -1,14 +1,67 @@
-import { PDFDocumentProxy, PDFPageProxy } from "pdfjs-dist/types/src/display/api";
+import { HTMLFontFace, ImageOptions, TextOptions, jsPDF, jsPDFOptions } from "jspdf";
+import * as pdfjs_dist_types_src_display_api0 from "pdfjs-dist/types/src/display/api";
 
-//#region src/index.d.ts
-declare function openPdf(url?: string | URL): Promise<{
-    pdf: PDFDocumentProxy;
-    pages: PDFPageProxy[];
-    id: string;
-    canvases: HTMLCanvasElement[];
-}>;
+//#region src/utils.d.ts
+declare function openPdf(url?: string | URL | File): Promise<{
+  pdf: pdfjs_dist_types_src_display_api0.PDFDocumentProxy;
+  pages: pdfjs_dist_types_src_display_api0.PDFPageProxy[];
+  id: string;
+  canvases: HTMLCanvasElement[];
+} | undefined>;
 declare function canvas2Pdf(canvases: HTMLCanvasElement[], fileName: string): void;
 declare function canvas2Zip(canvases: HTMLCanvasElement[], fileName: string): Promise<unknown>;
-
+declare function readPdfFile(buffer: ArrayBuffer): Promise<{
+  pdf: pdfjs_dist_types_src_display_api0.PDFDocumentProxy;
+  pages: pdfjs_dist_types_src_display_api0.PDFPageProxy[];
+  id: string;
+  canvases: HTMLCanvasElement[];
+}>;
+//#endregion
+//#region src/index.d.ts
+type Color = string | [number, number, number, number];
+interface TextStyle {
+  fontSize?: number;
+  fontName?: string;
+  fontStyle?: HTMLFontFace['style'];
+  fontWeight?: HTMLFontFace['weight'];
+  textColor?: Color;
+}
+interface DrawStyle {
+  drawColor?: Color;
+  fillColor?: Color;
+  charSpace?: number;
+  lineWidth?: number;
+  style?: 'S' | 'F' | 'FD' | 'DF' | null;
+}
+type PDFStyle = TextStyle & DrawStyle & {};
+type PDFDataType = 'text' | 'image' | 'circle' | 'line' | 'lines';
+type OTextOptions = TextOptions & TextStyle;
+type OImageOptions = Omit<ImageOptions, 'imageData'> & {
+  imageData: ImageOptions['imageData'] | (() => ImageOptions['imageData']) | (() => Promise<ImageOptions['imageData']>);
+};
+type OCircleOptions = DrawStyle & {
+  x: number;
+  y: number;
+  r: number;
+};
+type OLineOptions = DrawStyle & {
+  x1: number;
+  y1: number;
+  x2: number;
+  y2: number;
+};
+type OLinesOptions = DrawStyle & {
+  lines: number[][];
+  x: number;
+  y: number;
+  scale?: [number, number];
+  closed?: boolean;
+};
+type PDFDataRow<T extends PDFDataType = PDFDataType> = {
+  type: T;
+} & (T extends 'text' ? OTextOptions : T extends 'image' ? OImageOptions : T extends 'circle' ? OCircleOptions : T extends 'line' ? OLineOptions : T extends 'lines' ? OLinesOptions : never);
+declare function generatePDF(data: PDFDataRow[], options?: jsPDFOptions, globalStyle?: PDFStyle): Promise<{
+  pdf: jsPDF;
+}>;
 //#endregion
-export { canvas2Pdf, canvas2Zip, openPdf };
+export { PDFDataRow, canvas2Pdf, canvas2Zip, generatePDF, openPdf, readPdfFile };

package/dist/index.d.ts

@@ -1,14 +1,67 @@
-import { PDFDocumentProxy, PDFPageProxy } from "pdfjs-dist/types/src/display/api";
+import { HTMLFontFace, ImageOptions, TextOptions, jsPDF, jsPDFOptions } from "jspdf";
+import * as pdfjs_dist_types_src_display_api0 from "pdfjs-dist/types/src/display/api";
 
-//#region src/index.d.ts
-declare function openPdf(url?: string | URL): Promise<{
-    pdf: PDFDocumentProxy;
-    pages: PDFPageProxy[];
-    id: string;
-    canvases: HTMLCanvasElement[];
-}>;
+//#region src/utils.d.ts
+declare function openPdf(url?: string | URL | File): Promise<{
+  pdf: pdfjs_dist_types_src_display_api0.PDFDocumentProxy;
+  pages: pdfjs_dist_types_src_display_api0.PDFPageProxy[];
+  id: string;
+  canvases: HTMLCanvasElement[];
+} | undefined>;
 declare function canvas2Pdf(canvases: HTMLCanvasElement[], fileName: string): void;
 declare function canvas2Zip(canvases: HTMLCanvasElement[], fileName: string): Promise<unknown>;
-
+declare function readPdfFile(buffer: ArrayBuffer): Promise<{
+  pdf: pdfjs_dist_types_src_display_api0.PDFDocumentProxy;
+  pages: pdfjs_dist_types_src_display_api0.PDFPageProxy[];
+  id: string;
+  canvases: HTMLCanvasElement[];
+}>;
+//#endregion
+//#region src/index.d.ts
+type Color = string | [number, number, number, number];
+interface TextStyle {
+  fontSize?: number;
+  fontName?: string;
+  fontStyle?: HTMLFontFace['style'];
+  fontWeight?: HTMLFontFace['weight'];
+  textColor?: Color;
+}
+interface DrawStyle {
+  drawColor?: Color;
+  fillColor?: Color;
+  charSpace?: number;
+  lineWidth?: number;
+  style?: 'S' | 'F' | 'FD' | 'DF' | null;
+}
+type PDFStyle = TextStyle & DrawStyle & {};
+type PDFDataType = 'text' | 'image' | 'circle' | 'line' | 'lines';
+type OTextOptions = TextOptions & TextStyle;
+type OImageOptions = Omit<ImageOptions, 'imageData'> & {
+  imageData: ImageOptions['imageData'] | (() => ImageOptions['imageData']) | (() => Promise<ImageOptions['imageData']>);
+};
+type OCircleOptions = DrawStyle & {
+  x: number;
+  y: number;
+  r: number;
+};
+type OLineOptions = DrawStyle & {
+  x1: number;
+  y1: number;
+  x2: number;
+  y2: number;
+};
+type OLinesOptions = DrawStyle & {
+  lines: number[][];
+  x: number;
+  y: number;
+  scale?: [number, number];
+  closed?: boolean;
+};
+type PDFDataRow<T extends PDFDataType = PDFDataType> = {
+  type: T;
+} & (T extends 'text' ? OTextOptions : T extends 'image' ? OImageOptions : T extends 'circle' ? OCircleOptions : T extends 'line' ? OLineOptions : T extends 'lines' ? OLinesOptions : never);
+declare function generatePDF(data: PDFDataRow[], options?: jsPDFOptions, globalStyle?: PDFStyle): Promise<{
+  pdf: jsPDF;
+}>;
 //#endregion
-export { canvas2Pdf, canvas2Zip, openPdf };
+export { PDFDataRow, canvas2Pdf, canvas2Zip, generatePDF, openPdf, readPdfFile };

package/dist/index.js

@@ -1,10 +1,10 @@
-import { saveAs } from "file-saver";
 import { jsPDF } from "jspdf";
+import { saveAs } from "file-saver";
 import JsZip from "jszip";
 import { nanoid } from "nanoid";
 import { GlobalWorkerOptions, getDocument, version } from "pdfjs-dist";
 
-//#region src/index.ts
+//#region src/utils.ts
 GlobalWorkerOptions.workerSrc = `//unpkg.com/pdfjs-dist@${version}/build/pdf.worker.min.mjs`;
 function file2Buffer(file) {
 	return new Promise((resolve, reject) => {
@@ -60,7 +60,7 @@ async function pdf2Canvases(pdf) {
 }
 async function openPdf(url) {
 	try {
-		if (url) {
+		if (url && (typeof url === "string" || url instanceof URL)) {
 			const pdf = await getDocument(url).promise;
 			const { pages, id, canvases } = await pdf2Canvases(pdf);
 			return {
@@ -69,10 +69,9 @@ async function openPdf(url) {
 				id,
 				canvases
 			};
-		} else {
-			const [fileHandle] = await window.showOpenFilePicker({ types: [{ accept: { "application/pdf": [".pdf"] } }] });
-			const file = await fileHandle.getFile();
-			const buffer = await file2Buffer(file);
+		}
+		if (url instanceof File) {
+			const buffer = await file2Buffer(url);
 			const pdf = await getDocument(buffer).promise;
 			const { pages, id, canvases } = await pdf2Canvases(pdf);
 			return {
@@ -129,6 +128,93 @@ function canvas2Zip(canvases, fileName) {
 		}).catch((error) => reject(error));
 	});
 }
+async function readPdfFile(buffer) {
+	const pdf = await getDocument(buffer).promise;
+	const { pages, id, canvases } = await pdf2Canvases(pdf);
+	return {
+		pdf,
+		pages,
+		id,
+		canvases
+	};
+}
+
+//#endregion
+//#region src/index.ts
+function setDrawStyle(pdf, data) {
+	const { drawColor, fillColor, lineWidth } = data;
+	if (typeof fillColor === "string") pdf.setFillColor(fillColor);
+	else pdf.setFillColor(...fillColor);
+	if (typeof drawColor === "string") pdf.setDrawColor(drawColor);
+	else pdf.setDrawColor(...drawColor);
+	pdf.setLineWidth(lineWidth);
+}
+async function generatePDF(data, options, globalStyle) {
+	const pdf = new jsPDF(options);
+	const font = pdf.getFont();
+	const { fontSize: _fontSize = pdf.getFontSize(), fontName: _fontName = font.fontName, fontStyle: _fontStyle = font.fontStyle, fontWeight: _fontWeight = "normal", textColor: _textColor = pdf.getTextColor() } = globalStyle ?? {};
+	const { drawColor: _drawColor = pdf.getDrawColor(), fillColor: _fillColor = pdf.getDrawColor(), charSpace: _charSpace = pdf.getCharSpace(), lineWidth: _lineWidth = pdf.getLineWidth(), style: _style = "S" } = globalStyle ?? {};
+	function setText(data$1) {
+		const { text, x, y, fontSize = _fontSize, fontName = _fontName, fontStyle = _fontStyle, fontWeight = _fontWeight,...textOpt } = data$1;
+		pdf.setFontSize(fontSize);
+		pdf.setFont(fontName, fontStyle, fontWeight);
+		pdf.text(text, x, y, textOpt);
+	}
+	async function setImage(data$1) {
+		const { imageData, x, y, width, height, alias, compression, rotation } = data$1;
+		const _imageData = typeof imageData === "function" ? await Promise.try(imageData) : imageData;
+		pdf.addImage(_imageData, x, y, width, height, alias, compression, rotation);
+	}
+	function setCircle(data$1) {
+		const { x, y, r } = data$1;
+		const { fillColor = _fillColor, drawColor = _drawColor, lineWidth = _lineWidth, style = _style } = data$1;
+		setDrawStyle(pdf, {
+			fillColor,
+			drawColor,
+			lineWidth
+		});
+		pdf.circle(x, y, r, style);
+	}
+	function setLine(data$1) {
+		const { x1, y1, x2, y2 } = data$1;
+		const { fillColor = _fillColor, drawColor = _drawColor, lineWidth = _lineWidth, style = _style } = data$1;
+		setDrawStyle(pdf, {
+			fillColor,
+			drawColor,
+			lineWidth
+		});
+		pdf.line(x1, y1, x2, y2, style);
+	}
+	function setLines(data$1) {
+		const { lines, x, y, scale = [1, 1], closed = false } = data$1;
+		const { fillColor = _fillColor, drawColor = _drawColor, lineWidth = _lineWidth, style = _style } = data$1;
+		setDrawStyle(pdf, {
+			fillColor,
+			drawColor,
+			lineWidth
+		});
+		pdf.lines(lines, x, y, scale, style, closed);
+	}
+	for (const { type,...opt } of data) switch (type) {
+		case "text":
+			setText(opt);
+			break;
+		case "image":
+			await setImage(opt);
+			break;
+		case "circle":
+			setCircle(opt);
+			break;
+		case "line":
+			setLine(opt);
+			break;
+		case "lines":
+			setLines(opt);
+			break;
+		default: break;
+	}
+	return { pdf };
+}
 
 //#endregion
-export { canvas2Pdf, canvas2Zip, openPdf };
+export { canvas2Pdf, canvas2Zip, generatePDF, openPdf, readPdfFile };

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@oiij/js-pdf",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A simple PDF library for JavaScript",
   "author": "oiij",
   "license": "MIT",
-  "homepage": "https://github.com/oiij/js-pdf",
+  "homepage": "https://github.com/oiij/use",
   "repository": {
     "type": "git",
-    "url": "git@github.com:oiij/js-pdf.git"
+    "url": "git@github.com:oiij/use.git"
   },
-  "bugs": "https://github.com/oiij/js-pdf/issues",
+  "bugs": "https://github.com/oiij/use/issues",
   "keywords": [
+    "@oiij/use",
     "js-pdf"
   ],
   "sideEffects": false,
@@ -31,24 +32,6 @@
     "dist",
     "package.json"
   ],
-  "scripts": {
-    "dev": "tsdown --watch",
-    "build": "tsc --noEmit && tsdown",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "prepublishOnly": "pnpm build",
-    "release": "bumpp && npm publish",
-    "awe": "pnpx are-we-esm",
-    "nmi": "pnpx node-modules-inspector",
-    "start": "esno src/index.ts",
-    "test": "vitest",
-    "update:deps": "taze -w && pnpm i",
-    "type:check": "tsc --noEmit",
-    "cz": "czg",
-    "commit": "git pull && git add -A && pnpm cz && git push",
-    "link": "pnpm link --global",
-    "preinstall": "npx only-allow pnpm"
-  },
   "peerDependencies": {
     "file-saver": "^2.0.5",
     "jspdf": "^3.0.1",
@@ -57,40 +40,19 @@
     "pdfjs-dist": "^5.1.91"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.12.0",
-    "@oiij/tsconfig": "^0.0.1",
     "@types/file-saver": "^2.0.7",
-    "@types/node": "^22.14.1",
-    "@types/wicg-file-system-access": "^2023.10.6",
-    "@vitest/ui": "^3.1.2",
-    "bumpp": "^10.1.0",
-    "commitlint": "^19.8.0",
-    "cz-git": "^1.11.1",
-    "czg": "^1.11.1",
-    "eslint": "^9.25.1",
-    "eslint-plugin-format": "^1.0.1",
-    "esno": "^4.8.0",
     "file-saver": "^2.0.5",
     "jspdf": "^3.0.1",
     "jszip": "^3.10.1",
-    "lint-staged": "^15.5.1",
     "nanoid": "^5.1.5",
-    "pdfjs-dist": "^5.1.91",
-    "simple-git-hooks": "^2.12.1",
-    "taze": "^19.0.4",
-    "tsdown": "^0.9.3",
-    "typescript": "^5.8.3",
-    "vitest": "^3.1.2"
-  },
-  "simple-git-hooks": {
-    "pre-commit": "pnpm lint-staged && pnpm type:check"
-  },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx}": [
-      "pnpm lint:fix"
-    ]
+    "pdfjs-dist": "^5.3.31"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "dev": "tsdown --watch",
+    "build": "tsc --noEmit && tsdown",
+    "bumpp": "bumpp --no-push"
   }
-}
+}