@nitra/zebra 6.1.4 → 6.1.5

package/android/src/main/res/xml/capacitor_plugins.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<plugins>
+    <plugin name="ZebraPrinter" class="com.nitra.zebra_printer_plugin.ZebraPrinter" />
+</plugins>

package/android/variables.gradle

@@ -0,0 +1,14 @@
+ext {
+    minSdkVersion = 22
+    compileSdkVersion = 34
+    targetSdkVersion = 34
+    androidxActivityVersion = '1.8.2'
+    androidxAppCompatVersion = '1.6.1'
+    androidxCoordinatorLayoutVersion = '1.2.0'
+    androidxCoreVersion = '1.12.0'
+    androidxFragmentVersion = '1.6.2'
+    junitVersion = '4.13.2'
+    androidxJunitVersion = '1.1.5'
+    androidxEspressoCoreVersion = '3.5.1'
+    cordovaAndroidVersion = '12.0.0'
+}

package/dist/plugin.js

@@ -0,0 +1,219 @@
+import { WebPlugin, registerPlugin } from '@capacitor/core';
+
+/**
+ * @typedef {import('../definitions').EchoOptions} EchoOptions
+ * @typedef {import('../definitions').EchoResult} EchoResult
+ * @typedef {import('../definitions').PrintTextOptions} PrintTextOptions
+ * @typedef {import('../definitions').PrintResult} PrintResult
+ * @typedef {import('../definitions').PrinterStatus} PrinterStatus
+ * @typedef {import('../definitions').PrinterStatusResult} PrinterStatusResult
+ * @typedef {import('../definitions').ScanResult} ScanResult
+ * @typedef {import('../definitions').ConnectOptions} ConnectOptions
+ * @typedef {import('../definitions').ConnectResult} ConnectResult
+ * @typedef {import('../definitions').DisconnectResult} DisconnectResult
+ * @typedef {import('../definitions').PermissionResult} PermissionResult
+ */
+
+class ZebraPrinterWeb extends WebPlugin {
+  /**
+   * Echo a value
+   * @param {EchoOptions} options - Options containing the value to echo
+   * @returns {Promise<EchoResult>} Promise that resolves with the echoed value
+   */
+  // eslint-disable-next-line require-await
+  async echo(options) {
+    // eslint-disable-next-line no-console
+    console.log('ZebraPrinter: echo called with options:', options);
+    return {
+      value: options.value,
+    };
+  }
+
+  /**
+   * Check if required permissions are granted
+   * @returns {Promise<PermissionResult>} Promise that resolves with permission status
+   */
+  // eslint-disable-next-line require-await
+  async checkPermissions() {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: checkPermissions called on web platform - not supported'
+    );
+    return {
+      hasPermissions: false,
+      missingPermissions: ['bluetooth', 'location'],
+      bluetoothSupported: false,
+      bleSupported: false,
+    };
+  }
+
+  /**
+   * Request required permissions
+   * @returns {Promise<PermissionResult>} Promise that resolves with permission status
+   */
+  // eslint-disable-next-line require-await
+  async requestPermissions() {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: requestPermissions called on web platform - not supported'
+    );
+    return {
+      hasPermissions: false,
+      missingPermissions: ['bluetooth', 'location'],
+      bluetoothSupported: false,
+      bleSupported: false,
+    };
+  }
+
+  /**
+   * Print text to the connected printer
+   * @param {PrintTextOptions} _options - Options containing the text to print
+   * @returns {Promise<PrintResult>} Promise that resolves with print result
+   */
+  // eslint-disable-next-line require-await
+  async printText(_options) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: printText called on web platform - not supported'
+    );
+    return {
+      success: false,
+      message:
+        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',
+      error: 'Web platform not supported',
+    };
+  }
+
+  /**
+   * Get printer status
+   * @returns {Promise<PrinterStatus>} Promise that resolves with printer status
+   */
+  // eslint-disable-next-line require-await
+  async getStatus() {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: getStatus called on web platform - not supported'
+    );
+    return {
+      connected: false,
+      status: 'disconnected',
+    };
+  }
+
+  /**
+   * Scan for available printers
+   * @returns {Promise<ScanResult>} Promise that resolves with scan results
+   */
+  // eslint-disable-next-line require-await
+  async scanForPrinters() {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: scanForPrinters called on web platform - not supported'
+    );
+    return {
+      success: false,
+      error:
+        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',
+      printers: [],
+      count: 0,
+    };
+  }
+
+  /**
+   * Connect to a printer
+   * @param {ConnectOptions} _options - Connection options
+   * @returns {Promise<ConnectResult>} Promise that resolves with connection result
+   */
+  // eslint-disable-next-line require-await
+  async connect(_options) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: connect called on web platform - not supported'
+    );
+    return {
+      success: false,
+      connected: false,
+      error:
+        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',
+    };
+  }
+
+  /**
+   * Connect to printer by MAC address
+   * @param {ConnectOptions} _options - Connection options with address
+   * @returns {Promise<ConnectResult>} Promise that resolves with connection result
+   */
+  // eslint-disable-next-line require-await
+  async connectByAddress(_options) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: connectByAddress called on web platform - not supported'
+    );
+    return {
+      success: false,
+      connected: false,
+      error:
+        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',
+    };
+  }
+
+  /**
+   * Check device by MAC address
+   * @param {ConnectOptions} _options - Connection options with address
+   * @returns {Promise<ConnectResult>} Promise that resolves with device info
+   */
+  // eslint-disable-next-line require-await
+  async checkDeviceByAddress(_options) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: checkDeviceByAddress called on web platform - not supported'
+    );
+    return {
+      success: false,
+      error:
+        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',
+    };
+  }
+
+  /**
+   * Disconnect from the printer
+   * @returns {Promise<DisconnectResult>} Promise that resolves with disconnection result
+   */
+  // eslint-disable-next-line require-await
+  async disconnect() {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: disconnect called on web platform - not supported'
+    );
+    return {
+      success: true,
+      connected: false,
+    };
+  }
+
+  /**
+   * Check printer status with ZPL command
+   * @returns {Promise<PrinterStatusResult>} Promise that resolves with printer status result
+   */
+  // eslint-disable-next-line require-await
+  async checkPrinterStatus() {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'ZebraPrinter: checkPrinterStatus called on web platform - not supported'
+    );
+    return {
+      success: false,
+      message:
+        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',
+      error: 'Web platform not supported',
+    };
+  }
+}
+
+const ZebraPrinter = registerPlugin('ZebraPrinter', {
+  web: () => new ZebraPrinterWeb(),
+  // iOS and Android plugins will be auto-discovered via the Capacitor config
+});
+
+export { ZebraPrinter };
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["../src/web/index.js","../src/index.js"],"sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\n/**\n * @typedef {import('../definitions').EchoOptions} EchoOptions\n * @typedef {import('../definitions').EchoResult} EchoResult\n * @typedef {import('../definitions').PrintTextOptions} PrintTextOptions\n * @typedef {import('../definitions').PrintResult} PrintResult\n * @typedef {import('../definitions').PrinterStatus} PrinterStatus\n * @typedef {import('../definitions').PrinterStatusResult} PrinterStatusResult\n * @typedef {import('../definitions').ScanResult} ScanResult\n * @typedef {import('../definitions').ConnectOptions} ConnectOptions\n * @typedef {import('../definitions').ConnectResult} ConnectResult\n * @typedef {import('../definitions').DisconnectResult} DisconnectResult\n * @typedef {import('../definitions').PermissionResult} PermissionResult\n */\n\nexport class ZebraPrinterWeb extends WebPlugin {\n  /**\n   * Echo a value\n   * @param {EchoOptions} options - Options containing the value to echo\n   * @returns {Promise<EchoResult>} Promise that resolves with the echoed value\n   */\n  // eslint-disable-next-line require-await\n  async echo(options) {\n    // eslint-disable-next-line no-console\n    console.log('ZebraPrinter: echo called with options:', options);\n    return {\n      value: options.value,\n    };\n  }\n\n  /**\n   * Check if required permissions are granted\n   * @returns {Promise<PermissionResult>} Promise that resolves with permission status\n   */\n  // eslint-disable-next-line require-await\n  async checkPermissions() {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: checkPermissions called on web platform - not supported'\n    );\n    return {\n      hasPermissions: false,\n      missingPermissions: ['bluetooth', 'location'],\n      bluetoothSupported: false,\n      bleSupported: false,\n    };\n  }\n\n  /**\n   * Request required permissions\n   * @returns {Promise<PermissionResult>} Promise that resolves with permission status\n   */\n  // eslint-disable-next-line require-await\n  async requestPermissions() {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: requestPermissions called on web platform - not supported'\n    );\n    return {\n      hasPermissions: false,\n      missingPermissions: ['bluetooth', 'location'],\n      bluetoothSupported: false,\n      bleSupported: false,\n    };\n  }\n\n  /**\n   * Print text to the connected printer\n   * @param {PrintTextOptions} _options - Options containing the text to print\n   * @returns {Promise<PrintResult>} Promise that resolves with print result\n   */\n  // eslint-disable-next-line require-await\n  async printText(_options) {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: printText called on web platform - not supported'\n    );\n    return {\n      success: false,\n      message:\n        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',\n      error: 'Web platform not supported',\n    };\n  }\n\n  /**\n   * Get printer status\n   * @returns {Promise<PrinterStatus>} Promise that resolves with printer status\n   */\n  // eslint-disable-next-line require-await\n  async getStatus() {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: getStatus called on web platform - not supported'\n    );\n    return {\n      connected: false,\n      status: 'disconnected',\n    };\n  }\n\n  /**\n   * Scan for available printers\n   * @returns {Promise<ScanResult>} Promise that resolves with scan results\n   */\n  // eslint-disable-next-line require-await\n  async scanForPrinters() {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: scanForPrinters called on web platform - not supported'\n    );\n    return {\n      success: false,\n      error:\n        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',\n      printers: [],\n      count: 0,\n    };\n  }\n\n  /**\n   * Connect to a printer\n   * @param {ConnectOptions} _options - Connection options\n   * @returns {Promise<ConnectResult>} Promise that resolves with connection result\n   */\n  // eslint-disable-next-line require-await\n  async connect(_options) {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: connect called on web platform - not supported'\n    );\n    return {\n      success: false,\n      connected: false,\n      error:\n        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',\n    };\n  }\n\n  /**\n   * Connect to printer by MAC address\n   * @param {ConnectOptions} _options - Connection options with address\n   * @returns {Promise<ConnectResult>} Promise that resolves with connection result\n   */\n  // eslint-disable-next-line require-await\n  async connectByAddress(_options) {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: connectByAddress called on web platform - not supported'\n    );\n    return {\n      success: false,\n      connected: false,\n      error:\n        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',\n    };\n  }\n\n  /**\n   * Check device by MAC address\n   * @param {ConnectOptions} _options - Connection options with address\n   * @returns {Promise<ConnectResult>} Promise that resolves with device info\n   */\n  // eslint-disable-next-line require-await\n  async checkDeviceByAddress(_options) {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: checkDeviceByAddress called on web platform - not supported'\n    );\n    return {\n      success: false,\n      error:\n        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',\n    };\n  }\n\n  /**\n   * Disconnect from the printer\n   * @returns {Promise<DisconnectResult>} Promise that resolves with disconnection result\n   */\n  // eslint-disable-next-line require-await\n  async disconnect() {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: disconnect called on web platform - not supported'\n    );\n    return {\n      success: true,\n      connected: false,\n    };\n  }\n\n  /**\n   * Check printer status with ZPL command\n   * @returns {Promise<PrinterStatusResult>} Promise that resolves with printer status result\n   */\n  // eslint-disable-next-line require-await\n  async checkPrinterStatus() {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'ZebraPrinter: checkPrinterStatus called on web platform - not supported'\n    );\n    return {\n      success: false,\n      message:\n        'Zebra Printer Plugin is not available on web platform. Please use a native mobile device (iOS/Android).',\n      error: 'Web platform not supported',\n    };\n  }\n}\n","import { registerPlugin } from '@capacitor/core';\n\nimport { ZebraPrinterWeb } from './web';\n\nconst ZebraPrinter = registerPlugin('ZebraPrinter', {\n  web: () => new ZebraPrinterWeb(),\n  // iOS and Android plugins will be auto-discovered via the Capacitor config\n});\n\nexport { ZebraPrinter };\n"],"names":[],"mappings":";;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEO,MAAM,eAAe,SAAS,SAAS,CAAC;AAC/C;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,IAAI,CAAC,OAAO,EAAE;AACtB;AACA,IAAI,OAAO,CAAC,GAAG,CAAC,yCAAyC,EAAE,OAAO,CAAC;AACnE,IAAI,OAAO;AACX,MAAM,KAAK,EAAE,OAAO,CAAC,KAAK;AAC1B,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,gBAAgB,GAAG;AAC3B;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,cAAc,EAAE,KAAK;AAC3B,MAAM,kBAAkB,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC;AACnD,MAAM,kBAAkB,EAAE,KAAK;AAC/B,MAAM,YAAY,EAAE,KAAK;AACzB,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,kBAAkB,GAAG;AAC7B;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,cAAc,EAAE,KAAK;AAC3B,MAAM,kBAAkB,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC;AACnD,MAAM,kBAAkB,EAAE,KAAK;AAC/B,MAAM,YAAY,EAAE,KAAK;AACzB,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,SAAS,CAAC,QAAQ,EAAE;AAC5B;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,OAAO,EAAE,KAAK;AACpB,MAAM,OAAO;AACb,QAAQ,yGAAyG;AACjH,MAAM,KAAK,EAAE,4BAA4B;AACzC,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,SAAS,GAAG;AACpB;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,SAAS,EAAE,KAAK;AACtB,MAAM,MAAM,EAAE,cAAc;AAC5B,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,eAAe,GAAG;AAC1B;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,OAAO,EAAE,KAAK;AACpB,MAAM,KAAK;AACX,QAAQ,yGAAyG;AACjH,MAAM,QAAQ,EAAE,EAAE;AAClB,MAAM,KAAK,EAAE,CAAC;AACd,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,OAAO,CAAC,QAAQ,EAAE;AAC1B;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,OAAO,EAAE,KAAK;AACpB,MAAM,SAAS,EAAE,KAAK;AACtB,MAAM,KAAK;AACX,QAAQ,yGAAyG;AACjH,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,gBAAgB,CAAC,QAAQ,EAAE;AACnC;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,OAAO,EAAE,KAAK;AACpB,MAAM,SAAS,EAAE,KAAK;AACtB,MAAM,KAAK;AACX,QAAQ,yGAAyG;AACjH,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,oBAAoB,CAAC,QAAQ,EAAE;AACvC;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,OAAO,EAAE,KAAK;AACpB,MAAM,KAAK;AACX,QAAQ,yGAAyG;AACjH,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,UAAU,GAAG;AACrB;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,OAAO,EAAE,IAAI;AACnB,MAAM,SAAS,EAAE,KAAK;AACtB,KAAK;AACL,EAAE;;AAEF;AACA;AACA;AACA;AACA;AACA,EAAE,MAAM,kBAAkB,GAAG;AAC7B;AACA,IAAI,OAAO,CAAC,IAAI;AAChB,MAAM;AACN,KAAK;AACL,IAAI,OAAO;AACX,MAAM,OAAO,EAAE,KAAK;AACpB,MAAM,OAAO;AACb,QAAQ,yGAAyG;AACjH,MAAM,KAAK,EAAE,4BAA4B;AACzC,KAAK;AACL,EAAE;AACF;;AC9MK,MAAC,YAAY,GAAG,cAAc,CAAC,cAAc,EAAE;AACpD,EAAE,GAAG,EAAE,MAAM,IAAI,eAAe,EAAE;AAClC;AACA,CAAC;;;;"}

package/ios/Info.plist

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+	<dict>
+		<!-- Bluetooth permissions for iOS 13+ -->
+		<key>NSBluetoothAlwaysUsageDescription</key>
+		<string>This app needs Bluetooth access to connect to Zebra printers for printing labels and
+			receipts.</string>
+
+		<!-- Legacy Bluetooth permissions for iOS 12 and earlier -->
+		<key>NSBluetoothPeripheralUsageDescription</key>
+		<string>This app needs Bluetooth access to connect to Zebra printers for printing labels and
+			receipts.</string>
+
+		<!-- Background modes for Bluetooth -->
+		<key>UIBackgroundModes</key>
+		<array>
+			<string>bluetooth-central</string>
+		</array>
+
+		<!-- Required device capabilities -->
+		<key>UIRequiredDeviceCapabilities</key>
+		<array>
+			<string>bluetooth-le</string>
+		</array>
+
+		<!-- Privacy usage descriptions for better permission handling -->
+		<key>NSLocationWhenInUseUsageDescription</key>
+		<string>This app needs location access to scan for nearby Bluetooth devices like Zebra
+			printers.</string>
+
+		<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
+		<string>This app needs location access to scan for nearby Bluetooth devices like Zebra
+			printers.</string>
+	</dict>
+</plist>

package/ios/Plugin/ZebraPrinterPlugin.m

@@ -0,0 +1,16 @@
+#import <Foundation/Foundation.h>
+#import <Capacitor/Capacitor.h>
+
+// Define the plugin using the CAP_PLUGIN macro
+CAP_PLUGIN(ZebraPrinterPlugin, "ZebraPrinter",
+           CAP_PLUGIN_METHOD(echo, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(checkPermissions, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(requestPermissions, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(printText, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(getStatus, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(checkPrinterStatus, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(scanForPrinters, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(connect, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(disconnect, CAPPluginReturnPromise);
+)
+