@simplymobile/capacitor-printer-usb 8.0.0

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "SimplymobileCapacitorPrinterUsb",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(
+            name: "SimplymobileCapacitorPrinterUsb",
+            targets: ["PrinterUsbPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0")
+    ],
+    targets: [
+        .target(
+            name: "PrinterUsbPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/PrinterUsbPlugin"),
+        .testTarget(
+            name: "PrinterUsbPluginTests",
+            dependencies: ["PrinterUsbPlugin"],
+            path: "ios/Tests/PrinterUsbPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,94 @@
+# @simplymobile/capacitor-printer-usb
+
+Capacitor plugin for sending raw data to USB printers (devices with interface class
+`USB_CLASS_PRINTER`). Android-only; on iOS and web every method is unimplemented.
+
+USB permission is requested at runtime through the Android system dialog the first time a printer
+is used. No manifest permissions are required.
+
+## Install
+
+```bash
+npm install @simplymobile/capacitor-printer-usb
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`scan()`](#scan)
+* [`print(...)`](#print)
+* [`test(...)`](#test)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### scan()
+
+```typescript
+scan() => Promise<{ printers: UsbPrinterDevice[]; }>
+```
+
+Scan for connected USB printers (devices whose interface class is `USB_CLASS_PRINTER`).
+
+**Returns:** <code>Promise&lt;{ printers: UsbPrinterDevice[]; }&gt;</code>
+
+--------------------
+
+
+### print(...)
+
+```typescript
+print(options: { printerName: string; text: string; }) => Promise<{ message: string; }>
+```
+
+Send raw text to a USB printer identified by its product name.
+
+Requests USB permission (system dialog) if it has not been granted yet. The returned promise
+resolves once the data has been transferred, and rejects if permission is denied or an error
+occurs.
+
+| Param         | Type                                                |
+| ------------- | --------------------------------------------------- |
+| **`options`** | <code>{ printerName: string; text: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ message: string; }&gt;</code>
+
+--------------------
+
+
+### test(...)
+
+```typescript
+test(options: { printerName: string; }) => Promise<{ message: string; }>
+```
+
+Send a predefined test command (`~WC`) to the given USB printer.
+
+| Param         | Type                                  |
+| ------------- | ------------------------------------- |
+| **`options`** | <code>{ printerName: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ message: string; }&gt;</code>
+
+--------------------
+
+
+### Interfaces
+
+
+#### UsbPrinterDevice
+
+| Prop                   | Type                        | Description                                                           |
+| ---------------------- | --------------------------- | --------------------------------------------------------------------- |
+| **`productName`**      | <code>string \| null</code> | USB product name reported by the device.                              |
+| **`manufacturerName`** | <code>string \| null</code> | USB manufacturer name reported by the device.                         |
+| **`deviceId`**         | <code>number</code>         | Android USB device id.                                                |
+| **`serialNumber`**     | <code>string \| null</code> | USB serial number (may be `null` if not readable without permission). |
+| **`vendorId`**         | <code>number</code>         | USB vendor id.                                                        |
+
+</docgen-api>

package/SimplymobileCapacitorPrinterUsb.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'SimplymobileCapacitorPrinterUsb'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '15.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/android/build.gradle

@@ -0,0 +1,58 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace = "pl.simplymobile.plugins.printerusb"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion = project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion = project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError = false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,6 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <!-- USB host access is used to talk to the printer. USB permission is granted at runtime. -->
+    <uses-feature android:name="android.hardware.usb.host" android:required="false" />
+
+</manifest>

package/android/src/main/java/pl/simplymobile/plugins/printerusb/PrinterUsbPlugin.java

@@ -0,0 +1,228 @@
+package pl.simplymobile.plugins.printerusb;
+
+import android.app.PendingIntent;
+import android.content.BroadcastReceiver;
+import android.content.Context;
+import android.content.Intent;
+import android.content.IntentFilter;
+import android.hardware.usb.UsbDevice;
+import android.hardware.usb.UsbManager;
+import android.os.Build;
+import android.util.Log;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import java.util.List;
+
+@CapacitorPlugin(name = "PrinterUsb")
+public class PrinterUsbPlugin extends Plugin {
+
+    private static final String LOG_TAG = "PrinterUsb";
+    private static final String ACTION_USB_PERMISSION = "pl.simplymobile.plugins.printerusb.USB_PERMISSION";
+    private static final String TEST_MESSAGE = "~WC";
+    private static final String PRINT_SUCCESS_MESSAGE = "It was printed correctly...";
+
+    private UsbManager usbManager;
+    private UsbPrinter usbPrinter;
+
+    // State of an in-flight print operation (resolved when the transfer completes).
+    private PluginCall currentCall;
+    private String currentMessage;
+    private boolean receiverRegistered;
+
+    @PluginMethod
+    public void scan(PluginCall call) {
+        try {
+            UsbPrinter printer = new UsbPrinter(getUsbManager());
+            List<UsbDevice> devices = printer.findPrinters();
+
+            JSArray printers = new JSArray();
+            for (UsbDevice device : devices) {
+                JSObject obj = new JSObject();
+                obj.put("productName", device.getProductName());
+                obj.put("manufacturerName", device.getManufacturerName());
+                obj.put("deviceId", device.getDeviceId());
+                obj.put("serialNumber", safeSerialNumber(device));
+                obj.put("vendorId", device.getVendorId());
+                printers.put(obj);
+            }
+
+            JSObject ret = new JSObject();
+            ret.put("printers", printers);
+            call.resolve(ret);
+        } catch (Exception e) {
+            Log.e(LOG_TAG, "scan failed", e);
+            call.reject(e.getMessage(), e);
+        }
+    }
+
+    @PluginMethod
+    public void print(PluginCall call) {
+        String printerName = call.getString("printerName");
+        String text = call.getString("text");
+        if (printerName == null || printerName.isEmpty()) {
+            call.reject("Missing required parameter: printerName");
+            return;
+        }
+        if (text == null || text.isEmpty()) {
+            call.reject("Missing required parameter: text");
+            return;
+        }
+        startPrint(call, printerName, text);
+    }
+
+    @PluginMethod
+    public void test(PluginCall call) {
+        String printerName = call.getString("printerName");
+        if (printerName == null || printerName.isEmpty()) {
+            call.reject("Missing required parameter: printerName");
+            return;
+        }
+        startPrint(call, printerName, TEST_MESSAGE);
+    }
+
+    // region Print flow
+
+    private void startPrint(PluginCall call, String printerName, String message) {
+        if (currentCall != null) {
+            call.reject("A print operation is already in progress.");
+            return;
+        }
+
+        UsbManager manager = getUsbManager();
+        usbPrinter = new UsbPrinter(manager);
+        UsbDevice device = usbPrinter.findPrinterByName(printerName);
+        if (device == null) {
+            call.reject("There are no printers connected with name: " + printerName);
+            return;
+        }
+
+        currentCall = call;
+        currentMessage = message;
+
+        // If permission was already granted there is no need to show the system dialog.
+        if (manager.hasPermission(device)) {
+            transfer(device);
+            return;
+        }
+
+        try {
+            int flags = Build.VERSION.SDK_INT >= Build.VERSION_CODES.S ? PendingIntent.FLAG_MUTABLE : 0;
+            Intent intent = new Intent(ACTION_USB_PERMISSION).setPackage(getContext().getPackageName());
+            PendingIntent pendingIntent = PendingIntent.getBroadcast(getContext(), 0, intent, flags);
+
+            registerUsbReceiver();
+            manager.requestPermission(device, pendingIntent);
+        } catch (Exception e) {
+            Log.e(LOG_TAG, "requestPermission failed", e);
+            rejectCurrent(e.getMessage());
+        }
+    }
+
+    private final BroadcastReceiver usbReceiver = new BroadcastReceiver() {
+        @Override
+        public void onReceive(Context context, Intent intent) {
+            if (!ACTION_USB_PERMISSION.equals(intent.getAction())) {
+                return;
+            }
+            synchronized (this) {
+                unregisterUsbReceiver();
+                UsbDevice device = intent.getParcelableExtra(UsbManager.EXTRA_DEVICE);
+                boolean granted = intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false);
+                if (granted && device != null) {
+                    transfer(device);
+                } else {
+                    rejectCurrent("USB permission denied.");
+                }
+            }
+        }
+    };
+
+    private void transfer(final UsbDevice device) {
+        final PluginCall call = currentCall;
+        final String message = currentMessage;
+        new Thread(
+            new Runnable() {
+                @Override
+                public void run() {
+                    try {
+                        usbPrinter.open(device);
+                        usbPrinter.print(message);
+                        JSObject ret = new JSObject();
+                        ret.put("message", PRINT_SUCCESS_MESSAGE);
+                        if (call != null) {
+                            call.resolve(ret);
+                        }
+                    } catch (Exception e) {
+                        Log.e(LOG_TAG, "print failed", e);
+                        if (call != null) {
+                            call.reject(e.getMessage(), e);
+                        }
+                    } finally {
+                        usbPrinter.close();
+                        currentCall = null;
+                        currentMessage = null;
+                    }
+                }
+            }
+        ).start();
+    }
+
+    // endregion
+
+    // region Helpers
+
+    private UsbManager getUsbManager() {
+        if (usbManager == null) {
+            usbManager = (UsbManager) getContext().getSystemService(Context.USB_SERVICE);
+        }
+        return usbManager;
+    }
+
+    private void registerUsbReceiver() {
+        if (receiverRegistered) {
+            return;
+        }
+        IntentFilter filter = new IntentFilter(ACTION_USB_PERMISSION);
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+            getContext().registerReceiver(usbReceiver, filter, Context.RECEIVER_NOT_EXPORTED);
+        } else {
+            getContext().registerReceiver(usbReceiver, filter);
+        }
+        receiverRegistered = true;
+    }
+
+    private void unregisterUsbReceiver() {
+        if (!receiverRegistered) {
+            return;
+        }
+        try {
+            getContext().unregisterReceiver(usbReceiver);
+        } catch (IllegalArgumentException e) {
+            Log.w(LOG_TAG, "receiver already unregistered", e);
+        }
+        receiverRegistered = false;
+    }
+
+    private void rejectCurrent(String message) {
+        if (currentCall != null) {
+            currentCall.reject(message);
+            currentCall = null;
+            currentMessage = null;
+        }
+    }
+
+    private String safeSerialNumber(UsbDevice device) {
+        try {
+            return device.getSerialNumber();
+        } catch (SecurityException e) {
+            // getSerialNumber() requires USB permission on Android 10+.
+            return null;
+        }
+    }
+
+    // endregion
+}

package/android/src/main/java/pl/simplymobile/plugins/printerusb/UsbPrinter.java

@@ -0,0 +1,84 @@
+package pl.simplymobile.plugins.printerusb;
+
+import android.hardware.usb.UsbConstants;
+import android.hardware.usb.UsbDevice;
+import android.hardware.usb.UsbDeviceConnection;
+import android.hardware.usb.UsbEndpoint;
+import android.hardware.usb.UsbInterface;
+import android.hardware.usb.UsbManager;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Thin wrapper around the Android USB API for talking to a USB printer
+ * (interface 0, endpoint 1, bulk transfer).
+ */
+class UsbPrinter {
+
+    private final UsbManager usbManager;
+
+    private UsbDeviceConnection connection;
+    private UsbInterface usbInterface;
+    private UsbEndpoint usbEndpoint;
+
+    UsbPrinter(UsbManager usbManager) {
+        this.usbManager = usbManager;
+    }
+
+    /**
+     * @return all connected USB devices whose interface class is {@code USB_CLASS_PRINTER}.
+     */
+    List<UsbDevice> findPrinters() {
+        List<UsbDevice> printers = new ArrayList<>();
+        for (UsbDevice device : usbManager.getDeviceList().values()) {
+            if (device.getInterfaceCount() > 0 && device.getInterface(0).getInterfaceClass() == UsbConstants.USB_CLASS_PRINTER) {
+                printers.add(device);
+            }
+        }
+        return printers;
+    }
+
+    UsbDevice findPrinterByName(String name) {
+        if (name == null) {
+            return null;
+        }
+        for (UsbDevice device : usbManager.getDeviceList().values()) {
+            if (name.equals(device.getProductName())) {
+                return device;
+            }
+        }
+        return null;
+    }
+
+    void open(UsbDevice printerDevice) throws Exception {
+        // The first interface and its second endpoint are where the printer communication happens.
+        usbInterface = printerDevice.getInterface(0);
+        usbEndpoint = usbInterface.getEndpoint(1);
+        connection = usbManager.openDevice(printerDevice);
+        if (connection == null) {
+            throw new Exception("Could not open a connection to the USB device.");
+        }
+        if (!connection.claimInterface(usbInterface, true)) {
+            throw new Exception("Could not claim the USB interface.");
+        }
+    }
+
+    void print(String message) throws Exception {
+        byte[] bytes = message.getBytes(StandardCharsets.UTF_8);
+        int transferred = connection.bulkTransfer(usbEndpoint, bytes, bytes.length, 5000);
+        if (transferred < 0) {
+            throw new Exception("USB bulk transfer failed.");
+        }
+    }
+
+    void close() {
+        if (connection != null) {
+            if (usbInterface != null) {
+                connection.releaseInterface(usbInterface);
+            }
+            connection.close();
+            connection = null;
+        }
+    }
+}

package/dist/docs.json

@@ -0,0 +1,118 @@
+{
+  "api": {
+    "name": "PrinterUsbPlugin",
+    "slug": "printerusbplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "scan",
+        "signature": "() => Promise<{ printers: UsbPrinterDevice[]; }>",
+        "parameters": [],
+        "returns": "Promise<{ printers: UsbPrinterDevice[]; }>",
+        "tags": [],
+        "docs": "Scan for connected USB printers (devices whose interface class is `USB_CLASS_PRINTER`).",
+        "complexTypes": [
+          "UsbPrinterDevice"
+        ],
+        "slug": "scan"
+      },
+      {
+        "name": "print",
+        "signature": "(options: { printerName: string; text: string; }) => Promise<{ message: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ printerName: string; text: string; }"
+          }
+        ],
+        "returns": "Promise<{ message: string; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options.printerName USB product name of the target printer."
+          },
+          {
+            "name": "param",
+            "text": "options.text Raw text/commands to send to the printer."
+          }
+        ],
+        "docs": "Send raw text to a USB printer identified by its product name.\n\nRequests USB permission (system dialog) if it has not been granted yet. The returned promise\nresolves once the data has been transferred, and rejects if permission is denied or an error\noccurs.",
+        "complexTypes": [],
+        "slug": "print"
+      },
+      {
+        "name": "test",
+        "signature": "(options: { printerName: string; }) => Promise<{ message: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ printerName: string; }"
+          }
+        ],
+        "returns": "Promise<{ message: string; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options.printerName USB product name of the target printer."
+          }
+        ],
+        "docs": "Send a predefined test command (`~WC`) to the given USB printer.",
+        "complexTypes": [],
+        "slug": "test"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "UsbPrinterDevice",
+      "slug": "usbprinterdevice",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "productName",
+          "tags": [],
+          "docs": "USB product name reported by the device.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "manufacturerName",
+          "tags": [],
+          "docs": "USB manufacturer name reported by the device.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "deviceId",
+          "tags": [],
+          "docs": "Android USB device id.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "serialNumber",
+          "tags": [],
+          "docs": "USB serial number (may be `null` if not readable without permission).",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "vendorId",
+          "tags": [],
+          "docs": "USB vendor id.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,56 @@
+export interface UsbPrinterDevice {
+    /**
+     * USB product name reported by the device.
+     */
+    productName: string | null;
+    /**
+     * USB manufacturer name reported by the device.
+     */
+    manufacturerName: string | null;
+    /**
+     * Android USB device id.
+     */
+    deviceId: number;
+    /**
+     * USB serial number (may be `null` if not readable without permission).
+     */
+    serialNumber: string | null;
+    /**
+     * USB vendor id.
+     */
+    vendorId: number;
+}
+export interface PrinterUsbPlugin {
+    /**
+     * Scan for connected USB printers (devices whose interface class is `USB_CLASS_PRINTER`).
+     */
+    scan(): Promise<{
+        printers: UsbPrinterDevice[];
+    }>;
+    /**
+     * Send raw text to a USB printer identified by its product name.
+     *
+     * Requests USB permission (system dialog) if it has not been granted yet. The returned promise
+     * resolves once the data has been transferred, and rejects if permission is denied or an error
+     * occurs.
+     *
+     * @param options.printerName USB product name of the target printer.
+     * @param options.text Raw text/commands to send to the printer.
+     */
+    print(options: {
+        printerName: string;
+        text: string;
+    }): Promise<{
+        message: string;
+    }>;
+    /**
+     * Send a predefined test command (`~WC`) to the given USB printer.
+     *
+     * @param options.printerName USB product name of the target printer.
+     */
+    test(options: {
+        printerName: string;
+    }): Promise<{
+        message: string;
+    }>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface UsbPrinterDevice {\n  /**\n   * USB product name reported by the device.\n   */\n  productName: string | null;\n  /**\n   * USB manufacturer name reported by the device.\n   */\n  manufacturerName: string | null;\n  /**\n   * Android USB device id.\n   */\n  deviceId: number;\n  /**\n   * USB serial number (may be `null` if not readable without permission).\n   */\n  serialNumber: string | null;\n  /**\n   * USB vendor id.\n   */\n  vendorId: number;\n}\n\nexport interface PrinterUsbPlugin {\n  /**\n   * Scan for connected USB printers (devices whose interface class is `USB_CLASS_PRINTER`).\n   */\n  scan(): Promise<{ printers: UsbPrinterDevice[] }>;\n\n  /**\n   * Send raw text to a USB printer identified by its product name.\n   *\n   * Requests USB permission (system dialog) if it has not been granted yet. The returned promise\n   * resolves once the data has been transferred, and rejects if permission is denied or an error\n   * occurs.\n   *\n   * @param options.printerName USB product name of the target printer.\n   * @param options.text Raw text/commands to send to the printer.\n   */\n  print(options: { printerName: string; text: string }): Promise<{ message: string }>;\n\n  /**\n   * Send a predefined test command (`~WC`) to the given USB printer.\n   *\n   * @param options.printerName USB product name of the target printer.\n   */\n  test(options: { printerName: string }): Promise<{ message: string }>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { PrinterUsbPlugin } from './definitions';
+declare const PrinterUsb: PrinterUsbPlugin;
+export * from './definitions';
+export { PrinterUsb };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const PrinterUsb = registerPlugin('PrinterUsb', {
+    web: () => import('./web').then((m) => new m.PrinterUsbWeb()),
+});
+export * from './definitions';
+export { PrinterUsb };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,UAAU,GAAG,cAAc,CAAmB,YAAY,EAAE;IAChE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { PrinterUsbPlugin } from './definitions';\n\nconst PrinterUsb = registerPlugin<PrinterUsbPlugin>('PrinterUsb', {\n  web: () => import('./web').then((m) => new m.PrinterUsbWeb()),\n});\n\nexport * from './definitions';\nexport { PrinterUsb };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,18 @@
+import { WebPlugin } from '@capacitor/core';
+import type { PrinterUsbPlugin, UsbPrinterDevice } from './definitions';
+export declare class PrinterUsbWeb extends WebPlugin implements PrinterUsbPlugin {
+    scan(): Promise<{
+        printers: UsbPrinterDevice[];
+    }>;
+    print(options: {
+        printerName: string;
+        text: string;
+    }): Promise<{
+        message: string;
+    }>;
+    test(options: {
+        printerName: string;
+    }): Promise<{
+        message: string;
+    }>;
+}

package/dist/esm/web.js

@@ -0,0 +1,16 @@
+import { WebPlugin } from '@capacitor/core';
+export class PrinterUsbWeb extends WebPlugin {
+    async scan() {
+        console.log('NOT IMPLEMENTED');
+        return { printers: [] };
+    }
+    async print(options) {
+        console.log('NOT IMPLEMENTED', options.printerName, options.text);
+        return { message: 'NOT IMPLEMENTED' };
+    }
+    async test(options) {
+        console.log('NOT IMPLEMENTED', options.printerName);
+        return { message: 'NOT IMPLEMENTED' };
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C,KAAK,CAAC,IAAI;QACR,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC/B,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAA8C;QACxD,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAClE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAgC;QACzC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACpD,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;IACxC,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { PrinterUsbPlugin, UsbPrinterDevice } from './definitions';\n\nexport class PrinterUsbWeb extends WebPlugin implements PrinterUsbPlugin {\n  async scan(): Promise<{ printers: UsbPrinterDevice[] }> {\n    console.log('NOT IMPLEMENTED');\n    return { printers: [] };\n  }\n\n  async print(options: { printerName: string; text: string }): Promise<{ message: string }> {\n    console.log('NOT IMPLEMENTED', options.printerName, options.text);\n    return { message: 'NOT IMPLEMENTED' };\n  }\n\n  async test(options: { printerName: string }): Promise<{ message: string }> {\n    console.log('NOT IMPLEMENTED', options.printerName);\n    return { message: 'NOT IMPLEMENTED' };\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,30 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const PrinterUsb = core.registerPlugin('PrinterUsb', {
+    web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.PrinterUsbWeb()),
+});
+
+class PrinterUsbWeb extends core.WebPlugin {
+    async scan() {
+        console.log('NOT IMPLEMENTED');
+        return { printers: [] };
+    }
+    async print(options) {
+        console.log('NOT IMPLEMENTED', options.printerName, options.text);
+        return { message: 'NOT IMPLEMENTED' };
+    }
+    async test(options) {
+        console.log('NOT IMPLEMENTED', options.printerName);
+        return { message: 'NOT IMPLEMENTED' };
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    PrinterUsbWeb: PrinterUsbWeb
+});
+
+exports.PrinterUsb = PrinterUsb;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst PrinterUsb = registerPlugin('PrinterUsb', {\n    web: () => import('./web').then((m) => new m.PrinterUsbWeb()),\n});\nexport * from './definitions';\nexport { PrinterUsb };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class PrinterUsbWeb extends WebPlugin {\n    async scan() {\n        console.log('NOT IMPLEMENTED');\n        return { printers: [] };\n    }\n    async print(options) {\n        console.log('NOT IMPLEMENTED', options.printerName, options.text);\n        return { message: 'NOT IMPLEMENTED' };\n    }\n    async test(options) {\n        console.log('NOT IMPLEMENTED', options.printerName);\n        return { message: 'NOT IMPLEMENTED' };\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,UAAU,GAAGA,mBAAc,CAAC,YAAY,EAAE;AAChD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;AACjE,CAAC;;ACFM,MAAM,aAAa,SAASC,cAAS,CAAC;AAC7C,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;AACtC,QAAQ,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;AAC/B,IAAI;AACJ,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE;AACzB,QAAQ,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC;AACzE,QAAQ,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE;AAC7C,IAAI;AACJ,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE;AACxB,QAAQ,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,WAAW,CAAC;AAC3D,QAAQ,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE;AAC7C,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,33 @@
+var capacitorPrinterUsb = (function (exports, core) {
+    'use strict';
+
+    const PrinterUsb = core.registerPlugin('PrinterUsb', {
+        web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.PrinterUsbWeb()),
+    });
+
+    class PrinterUsbWeb extends core.WebPlugin {
+        async scan() {
+            console.log('NOT IMPLEMENTED');
+            return { printers: [] };
+        }
+        async print(options) {
+            console.log('NOT IMPLEMENTED', options.printerName, options.text);
+            return { message: 'NOT IMPLEMENTED' };
+        }
+        async test(options) {
+            console.log('NOT IMPLEMENTED', options.printerName);
+            return { message: 'NOT IMPLEMENTED' };
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        PrinterUsbWeb: PrinterUsbWeb
+    });
+
+    exports.PrinterUsb = PrinterUsb;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst PrinterUsb = registerPlugin('PrinterUsb', {\n    web: () => import('./web').then((m) => new m.PrinterUsbWeb()),\n});\nexport * from './definitions';\nexport { PrinterUsb };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class PrinterUsbWeb extends WebPlugin {\n    async scan() {\n        console.log('NOT IMPLEMENTED');\n        return { printers: [] };\n    }\n    async print(options) {\n        console.log('NOT IMPLEMENTED', options.printerName, options.text);\n        return { message: 'NOT IMPLEMENTED' };\n    }\n    async test(options) {\n        console.log('NOT IMPLEMENTED', options.printerName);\n        return { message: 'NOT IMPLEMENTED' };\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,UAAU,GAAGA,mBAAc,CAAC,YAAY,EAAE;IAChD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;IACjE,CAAC;;ICFM,MAAM,aAAa,SAASC,cAAS,CAAC;IAC7C,IAAI,MAAM,IAAI,GAAG;IACjB,QAAQ,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IACtC,QAAQ,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;IAC/B,IAAI;IACJ,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE;IACzB,QAAQ,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC;IACzE,QAAQ,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE;IAC7C,IAAI;IACJ,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE;IACxB,QAAQ,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,WAAW,CAAC;IAC3D,QAAQ,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE;IAC7C,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/ios/Sources/PrinterUsbPlugin/PrinterUsb.swift

@@ -0,0 +1,8 @@
+import Foundation
+
+@objc public class PrinterUsb: NSObject {
+    @objc public func echo(_ value: String) -> String {
+        print(value)
+        return value
+    }
+}

package/ios/Sources/PrinterUsbPlugin/PrinterUsbPlugin.swift

@@ -0,0 +1,33 @@
+import Foundation
+import Capacitor
+
+/**
+ * USB printer plugin.
+ *
+ * This is an Android-only plugin. On iOS every method rejects with `unimplemented`.
+ * Please read the Capacitor iOS Plugin Development Guide
+ * here: https://capacitorjs.com/docs/plugins/ios
+ */
+@objc(PrinterUsbPlugin)
+public class PrinterUsbPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "PrinterUsbPlugin"
+    public let jsName = "PrinterUsb"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "scan", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "print", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "test", returnType: CAPPluginReturnPromise)
+    ]
+    private let implementation = PrinterUsb()
+
+    @objc func scan(_ call: CAPPluginCall) {
+        call.unimplemented("PrinterUsb is Android-only.")
+    }
+
+    @objc func print(_ call: CAPPluginCall) {
+        call.unimplemented("PrinterUsb is Android-only.")
+    }
+
+    @objc func test(_ call: CAPPluginCall) {
+        call.unimplemented("PrinterUsb is Android-only.")
+    }
+}

package/ios/Tests/PrinterUsbPluginTests/PrinterUsbTests.swift

@@ -0,0 +1,25 @@
+import XCTest
+@testable import PrinterUsbPlugin
+
+class PrinterUsbTests: XCTestCase {
+    override func setUp() {
+        super.setUp()
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+    }
+
+    override func tearDown() {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+        super.tearDown()
+    }
+
+    func testEcho() {
+        // This is an example of a functional test case for a plugin.
+        // Use XCTAssert and related functions to verify your tests produce the correct results.
+
+        let implementation = PrinterUsb()
+        let value = "Hello, World!"
+        let result = implementation.echo(value)
+
+        XCTAssertEqual(value, result)
+    }
+}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@simplymobile/capacitor-printer-usb",
+  "version": "8.0.0",
+  "description": "Capacitor USB printer plugin",
+  "author": "SimplyMobile",
+  "license": "Apache-2.0",
+  "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",
+    "ios/Tests",
+    "Package.swift",
+    "SimplymobileCapacitorPrinterUsb.podspec"
+  ],
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native",
+    "usb",
+    "printer"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "xcodebuild -scheme SimplymobileCapacitorPrinterUsb -destination generic/platform=iOS",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api PrinterUsbPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^8.0.0",
+    "@capacitor/core": "^8.0.0",
+    "@capacitor/docgen": "^0.3.1",
+    "@capacitor/ios": "^8.0.0",
+    "@ionic/eslint-config": "^0.4.0",
+    "@ionic/prettier-config": "^4.0.0",
+    "@ionic/swiftlint-config": "^2.0.0",
+    "eslint": "^8.57.1",
+    "prettier": "^3.6.2",
+    "prettier-plugin-java": "^2.7.7",
+    "rimraf": "^6.1.0",
+    "rollup": "^4.53.2",
+    "swiftlint": "^2.0.0",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=8.0.0"
+  },
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/.git"
+  },
+  "bugs": {
+    "url": "https://github.com/issues"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}