@dimer47/capacitor-plugin-printer 2.0.0

package/ios/Sources/PrinterPlugin/PrinterPlugin.swift

@@ -0,0 +1,327 @@
+import Foundation
+import Capacitor
+import UIKit
+
+@objc(PrinterPlugin)
+public class PrinterPlugin: CAPPlugin, CAPBridgedPlugin, UIPrintInteractionControllerDelegate {
+    public let identifier = "PrinterPlugin"
+    public let jsName = "Printer"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "print", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "printHtml", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "printPdf", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "printBase64", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "printFile", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "printWebView", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "canPrintItem", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getPrintableTypes", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "pick", returnType: CAPPluginReturnPromise),
+    ]
+
+    private var previousPrinter: UIPrinter?
+    private var currentSettings: [String: Any] = [:]
+
+    // MARK: - Plugin Methods
+
+    @objc func canPrintItem(_ call: CAPPluginCall) {
+        let uri = call.getString("uri")
+
+        DispatchQueue.main.async {
+            let available = PrinterItem.canPrintURL(uri)
+            call.resolve(["available": available])
+        }
+    }
+
+    @objc func getPrintableTypes(_ call: CAPPluginCall) {
+        DispatchQueue.main.async {
+            let utis = UIPrintInteractionController.printableUTIs
+            let typesArray = utis.map { $0 as String }
+            call.resolve(["types": typesArray])
+        }
+    }
+
+    @objc func pick(_ call: CAPPluginCall) {
+        let uiOptions = call.getObject("ui") ?? [:]
+
+        DispatchQueue.main.async {
+            let controller = UIPrinterPickerController(initiallySelectedPrinter: nil)
+
+            let handler: UIPrinterPickerController.CompletionHandler = { [weak self] pickerController, selected, error in
+                guard let self = self else { return }
+
+                if let printer = pickerController.selectedPrinter {
+                    self.rememberPrinter(printer)
+                    call.resolve(["url": printer.url.absoluteString])
+                } else {
+                    call.resolve([:])
+                }
+            }
+
+            if UIDevice.current.userInterfaceIdiom == .pad {
+                let rect = self.rectFromDictionary(uiOptions)
+                if let webView = self.bridge?.webView {
+                    controller.present(from: rect, in: webView, animated: true, completionHandler: handler)
+                } else {
+                    controller.present(animated: true, completionHandler: handler)
+                }
+            } else {
+                controller.present(animated: true, completionHandler: handler)
+            }
+        }
+    }
+
+    @objc func print(_ call: CAPPluginCall) {
+        let content = call.getString("content")
+        let settings = self.extractSettings(from: call)
+
+        DispatchQueue.global(qos: .userInitiated).async {
+            self.printContent(content, withSettings: settings, call: call)
+        }
+    }
+
+    @objc func printHtml(_ call: CAPPluginCall) {
+        guard let html = call.getString("html") else {
+            call.reject("The 'html' parameter is required")
+            return
+        }
+        let settings = self.extractSettings(from: call)
+
+        DispatchQueue.global(qos: .userInitiated).async {
+            self.printContent(html, withSettings: settings, call: call)
+        }
+    }
+
+    @objc func printPdf(_ call: CAPPluginCall) {
+        guard let path = call.getString("path") else {
+            call.reject("The 'path' parameter is required")
+            return
+        }
+        let settings = self.extractSettings(from: call)
+
+        DispatchQueue.global(qos: .userInitiated).async {
+            self.printContent(path, withSettings: settings, call: call)
+        }
+    }
+
+    @objc func printBase64(_ call: CAPPluginCall) {
+        guard let data = call.getString("data") else {
+            call.reject("The 'data' parameter is required")
+            return
+        }
+        guard call.getString("mimeType") != nil else {
+            call.reject("The 'mimeType' parameter is required")
+            return
+        }
+        let content = "base64:" + data
+        let settings = self.extractSettings(from: call)
+
+        DispatchQueue.global(qos: .userInitiated).async {
+            self.printContent(content, withSettings: settings, call: call)
+        }
+    }
+
+    @objc func printFile(_ call: CAPPluginCall) {
+        guard let path = call.getString("path") else {
+            call.reject("The 'path' parameter is required")
+            return
+        }
+        let settings = self.extractSettings(from: call)
+
+        DispatchQueue.global(qos: .userInitiated).async {
+            self.printContent(path, withSettings: settings, call: call)
+        }
+    }
+
+    @objc func printWebView(_ call: CAPPluginCall) {
+        let settings = self.extractSettings(from: call)
+
+        DispatchQueue.global(qos: .userInitiated).async {
+            self.printContent(nil, withSettings: settings, call: call)
+        }
+    }
+
+    // MARK: - UIPrintInteractionControllerDelegate
+
+    public func printInteractionController(
+        _ printInteractionController: UIPrintInteractionController,
+        choosePaper paperList: [UIPrintPaper]
+    ) -> UIPrintPaper {
+        if let paperSpec = currentSettings["paper"] as? [String: Any] {
+            let paper = PrinterPaper(dictionary: paperSpec)
+            if let bestPaper = paper.bestPaper(from: paperList) {
+                return bestPaper
+            }
+        }
+        return paperList.first ?? UIPrintPaper.bestPaper(forPageSize: CGSize(width: 612, height: 792), withPapersFrom: paperList)
+    }
+
+    public func printInteractionController(
+        _ printInteractionController: UIPrintInteractionController,
+        cutLengthFor paper: UIPrintPaper
+    ) -> CGFloat {
+        if let paperSpec = currentSettings["paper"] as? [String: Any] {
+            let paperObj = PrinterPaper(dictionary: paperSpec)
+            if paperObj.length > 0 {
+                return paperObj.length
+            }
+        }
+        return paper.paperSize.height
+    }
+
+    // MARK: - Core Printing
+
+    private func printContent(_ content: String?, withSettings settings: [String: Any], call: CAPPluginCall) {
+        var item: Any?
+        var ctrl: UIPrintInteractionController!
+
+        DispatchQueue.main.sync {
+            ctrl = PrinterControllerHelper.sharedController(with: settings)
+            ctrl.delegate = self
+            self.currentSettings = settings
+        }
+
+        if content == nil || content?.isEmpty == true {
+            DispatchQueue.main.sync {
+                if let webView = self.bridge?.webView {
+                    item = webView.viewPrintFormatter()
+                }
+            }
+        } else if let content = content, content.hasPrefix("<") {
+            DispatchQueue.main.sync {
+                item = UIMarkupTextPrintFormatter(markupText: content)
+            }
+        } else if let content = content, URL(string: content)?.scheme != nil {
+            item = PrinterItem.item(from: content)
+        } else if let content = content {
+            DispatchQueue.main.sync {
+                item = UISimpleTextPrintFormatter(text: content)
+            }
+        }
+
+        self.useController(ctrl, toPrintItem: item, withSettings: settings, call: call)
+    }
+
+    private func useController(
+        _ ctrl: UIPrintInteractionController,
+        toPrintItem item: Any?,
+        withSettings settings: [String: Any],
+        call: CAPPluginCall
+    ) {
+        let printerURL = settings["printer"] as? String
+
+        if let formatter = item as? UIPrintFormatter {
+            ctrl.printPageRenderer = PrinterRenderer(dictionary: settings, formatter: formatter)
+        } else {
+            ctrl.printingItem = item
+        }
+
+        if let printerURL = printerURL, !printerURL.isEmpty {
+            self.printToPrinter(ctrl, withSettings: settings, call: call)
+        } else {
+            self.presentController(ctrl, withSettings: settings, call: call)
+        }
+    }
+
+    private func printToPrinter(
+        _ ctrl: UIPrintInteractionController,
+        withSettings settings: [String: Any],
+        call: CAPPluginCall
+    ) {
+        let printerURLString = settings["printer"] as? String ?? ""
+        guard let printer = self.printer(withURL: printerURLString) else {
+            self.presentController(ctrl, withSettings: settings, call: call)
+            return
+        }
+
+        DispatchQueue.main.async {
+            ctrl.print(to: printer) { [weak self] _, completed, _ in
+                self?.rememberPrinter(completed ? printer : nil)
+                call.resolve(["success": completed])
+            }
+        }
+    }
+
+    private func presentController(
+        _ ctrl: UIPrintInteractionController,
+        withSettings settings: [String: Any],
+        call: CAPPluginCall
+    ) {
+        let uiOptions = settings["ui"] as? [String: Any] ?? [:]
+        let rect = self.rectFromDictionary(uiOptions)
+
+        let handler: UIPrintInteractionController.CompletionHandler = { _, completed, _ in
+            call.resolve(["success": completed])
+        }
+
+        DispatchQueue.main.async {
+            if UIDevice.current.userInterfaceIdiom == .pad {
+                if let webView = self.bridge?.webView {
+                    ctrl.present(from: rect, in: webView, animated: true, completionHandler: handler)
+                } else {
+                    ctrl.present(animated: true, completionHandler: handler)
+                }
+            } else {
+                ctrl.present(animated: true, completionHandler: handler)
+            }
+        }
+    }
+
+    // MARK: - Helpers
+
+    private func extractSettings(from call: CAPPluginCall) -> [String: Any] {
+        var settings: [String: Any] = [:]
+
+        if let name = call.getString("name") { settings["name"] = name }
+        if let orientation = call.getString("orientation") { settings["orientation"] = orientation }
+        if let duplex = call.getString("duplex") { settings["duplex"] = duplex }
+        if let printer = call.getString("printer") { settings["printer"] = printer }
+        if let maxWidth = call.getString("maxWidth") ?? (call.getInt("maxWidth").map { String($0) }) { settings["maxWidth"] = maxWidth }
+        if let maxHeight = call.getString("maxHeight") ?? (call.getInt("maxHeight").map { String($0) }) { settings["maxHeight"] = maxHeight }
+
+        settings["monochrome"] = call.getBool("monochrome") ?? false
+        settings["photo"] = call.getBool("photo") ?? false
+        settings["copies"] = call.getInt("copies") ?? 1
+
+        if let pageCount = call.getInt("pageCount") { settings["pageCount"] = pageCount }
+
+        if let margin = call.getObject("margin") {
+            settings["margin"] = margin
+        } else if let marginBool = call.getBool("margin") {
+            if !marginBool {
+                settings["margin"] = false
+            }
+        }
+
+        if let font = call.getObject("font") { settings["font"] = font }
+        if let header = call.getObject("header") { settings["header"] = header }
+        if let footer = call.getObject("footer") { settings["footer"] = footer }
+        if let paper = call.getObject("paper") { settings["paper"] = paper }
+        if let ui = call.getObject("ui") { settings["ui"] = ui }
+
+        return settings
+    }
+
+    private func rememberPrinter(_ printer: UIPrinter?) {
+        previousPrinter = printer
+        if let printer = printer {
+            _ = UIPrinterPickerController(initiallySelectedPrinter: printer)
+        }
+    }
+
+    private func printer(withURL urlString: String) -> UIPrinter? {
+        if let prev = previousPrinter, prev.url.absoluteString == urlString {
+            return prev
+        }
+        guard let url = URL(string: urlString) else { return nil }
+        return UIPrinter(url: url)
+    }
+
+    private func rectFromDictionary(_ pos: [String: Any]) -> CGRect {
+        let left = (pos["left"] as? NSNumber)?.doubleValue ?? 40.0
+        let top = (pos["top"] as? NSNumber)?.doubleValue ?? 30.0
+        let width = (pos["width"] as? NSNumber)?.doubleValue ?? 0.0
+        let height = (pos["height"] as? NSNumber)?.doubleValue ?? 0.0
+
+        return CGRect(x: left, y: top, width: width, height: height)
+    }
+}

package/ios/Sources/PrinterPlugin/PrinterRenderer.swift

@@ -0,0 +1,135 @@
+import Foundation
+import UIKit
+
+/// Custom page renderer supporting headers, footers, and page count control.
+class PrinterRenderer: UIPrintPageRenderer {
+
+    private let settings: [String: Any]
+
+    init(dictionary spec: [String: Any], formatter: UIPrintFormatter) {
+        self.settings = spec
+
+        super.init()
+
+        let _ = PrinterLayout.configureFormatter(formatter, withSettings: spec)
+        self.addPrintFormatter(formatter, startingAtPageAt: 0)
+
+        if let header = spec["header"] as? [String: Any] {
+            self.headerHeight = CGFloat(PrinterUnit.convert(header["height"]))
+        }
+
+        if let footer = spec["footer"] as? [String: Any] {
+            self.footerHeight = CGFloat(PrinterUnit.convert(footer["height"]))
+        }
+    }
+
+    override var numberOfPages: Int {
+        let num = super.numberOfPages
+        let maxPages = settings["pageCount"]
+
+        if let maxPagesInt = maxPages as? Int {
+            if maxPagesInt < 0 {
+                return max(1, num + maxPagesInt)
+            }
+            return maxPagesInt > 0 ? max(1, min(num, maxPagesInt)) : num
+        }
+
+        return num
+    }
+
+    override func drawHeaderForPage(at pageIndex: Int, in headerRect: CGRect) {
+        if let header = settings["header"] as? [String: Any] {
+            drawLabels(from: header, forPageAt: pageIndex, in: headerRect)
+        }
+    }
+
+    override func drawFooterForPage(at pageIndex: Int, in footerRect: CGRect) {
+        if let footer = settings["footer"] as? [String: Any] {
+            drawLabels(from: footer, forPageAt: pageIndex, in: footerRect)
+        }
+    }
+
+    // MARK: - Private
+
+    private func drawLabels(from spec: [String: Any], forPageAt index: Int, in rect: CGRect) {
+        var labels: [[String: Any]]?
+
+        if let label = spec["label"] as? [String: Any] {
+            labels = [label]
+        } else if let specLabels = spec["labels"] as? [[String: Any]] {
+            labels = specLabels
+        } else if let text = spec["text"] as? String, !text.isEmpty {
+            labels = [["text": text]]
+        }
+
+        guard let labelsList = labels else { return }
+
+        for label in labelsList {
+            drawLabel(from: label, forPageAt: index, in: rect)
+        }
+    }
+
+    private func drawLabel(from spec: [String: Any], forPageAt index: Int, in rect: CGRect) {
+        var label = spec["text"] as? String
+        let showIndex = spec["showPageIndex"] as? Bool ?? false
+
+        if showIndex {
+            let format: String
+            if let existingLabel = label, !existingLabel.isEmpty {
+                format = existingLabel
+            } else {
+                format = "%ld"
+            }
+            label = String(format: format, index + 1)
+        }
+
+        guard let labelText = label, !labelText.isEmpty else { return }
+
+        let font = PrinterFont(dictionary: spec["font"] as? [String: Any])
+        let attributes = font.attributes
+
+        let hasPosition =
+            spec["top"] != nil || spec["left"] != nil || spec["right"] != nil || spec["bottom"] != nil
+
+        if hasPosition {
+            let point = pointFromPosition(spec, forLabel: labelText, withAttributes: attributes, in: rect)
+            labelText.draw(at: point, withAttributes: attributes)
+        } else {
+            labelText.draw(in: rect, withAttributes: attributes)
+        }
+    }
+
+    private func pointFromPosition(
+        _ spec: [String: Any],
+        forLabel label: String,
+        withAttributes attributes: [NSAttributedString.Key: Any],
+        in rect: CGRect
+    ) -> CGPoint {
+        let top = spec["top"]
+        let left = spec["left"]
+        let right = spec["right"]
+        let bottom = spec["bottom"]
+
+        var x = rect.origin.x
+        var y = rect.origin.y
+
+        var size: CGSize = .zero
+        if bottom != nil || right != nil {
+            size = label.size(withAttributes: attributes)
+        }
+
+        if let top = top {
+            y = rect.origin.y + CGFloat(PrinterUnit.convert(top))
+        } else if let bottom = bottom {
+            y = rect.origin.y + rect.size.height - size.height - CGFloat(PrinterUnit.convert(bottom))
+        }
+
+        if let left = left {
+            x = rect.origin.x + CGFloat(PrinterUnit.convert(left))
+        } else if let right = right {
+            x = rect.origin.x + rect.size.width - size.width - CGFloat(PrinterUnit.convert(right))
+        }
+
+        return CGPoint(x: x, y: y)
+    }
+}

package/ios/Sources/PrinterPlugin/PrinterUnit.swift

@@ -0,0 +1,45 @@
+import Foundation
+
+/// Converts various unit values (in, mm, cm, pt, numbers) to iOS points.
+class PrinterUnit {
+
+    /// Converts any unit value to points.
+    /// Supports: numbers, "Xpt", "Xin", "Xmm", "Xcm", or numeric strings.
+    static func convert(_ unit: Any?) -> Double {
+        guard let unit = unit, !(unit is NSNull) else {
+            return 0
+        }
+
+        if let number = unit as? NSNumber {
+            return number.doubleValue
+        }
+
+        if let number = unit as? Int {
+            return Double(number)
+        }
+
+        if let number = unit as? Double {
+            return number
+        }
+
+        guard let str = unit as? String, !str.isEmpty else {
+            return 0
+        }
+
+        if str.hasSuffix("pt") {
+            let value = String(str.dropLast(2))
+            return Double(value) ?? 0
+        } else if str.hasSuffix("in") {
+            let value = String(str.dropLast(2))
+            return (Double(value) ?? 0) * 72.0
+        } else if str.hasSuffix("mm") {
+            let value = String(str.dropLast(2))
+            return (Double(value) ?? 0) * 72.0 / 25.4
+        } else if str.hasSuffix("cm") {
+            let value = String(str.dropLast(2))
+            return (Double(value) ?? 0) * 72.0 / 2.54
+        }
+
+        return Double(str) ?? 0
+    }
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@dimer47/capacitor-plugin-printer",
+  "version": "2.0.0",
+  "description": "Capacitor plugin for printing HTML, PDF, images and plain text on iOS and Android",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Sources/",
+    "CapacitorPluginPrinter.podspec",
+    "Package.swift"
+  ],
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native",
+    "printer",
+    "print",
+    "pdf",
+    "html",
+    "ios",
+    "android"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
+    "build": "tsc && rollup -c rollup.config.mjs",
+    "test": "npm run test:ios && npm run test:android",
+    "test:ios": "xcodebuild test -scheme CapacitorPluginPrinter -destination 'platform=iOS Simulator,name=iPhone 17 Pro' -quiet",
+    "test:android": "cd \"${ANDROID_HOST_PROJECT:-../../../Solutions/Agri+/Codes/app-signing/code/android}\" && ./gradlew :capacitor-plugin-printer:testDebugUnitTest",
+    "prepublishOnly": "npm run build"
+  },
+  "author": "Dimer47",
+  "license": "Apache-2.0",
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dimer47/capacitor-plugin-printer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dimer47/capacitor-plugin-printer/issues"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^8.0.0",
+    "@capacitor/core": "^8.0.0",
+    "@capacitor/ios": "^8.0.0",
+    "typescript": "~5.6.0",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "rollup": "^4.0.0"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=8.0.0"
+  }
+}