@centimoo/capacitor-tcp-printer 1.0.0

package/CentimooCapacitorTcpPrinter.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CentimooCapacitorTcpPrinter'
+  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/Package.swift

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

package/README.md

@@ -0,0 +1,181 @@
+# @centimoo/capacitor-tcp-printer
+
+Native TCP printer plugin for Capacitor using Apple Network.framework. Enables raw socket printing (ESC/POS) to LAN printers on iOS.
+
+## Install
+
+```bash
+npm install @centimoo/capacitor-tcp-printer
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`connect(...)`](#connect)
+* [`send(...)`](#send)
+* [`read(...)`](#read)
+* [`disconnect(...)`](#disconnect)
+* [Interfaces](#interfaces)
+* [Enums](#enums)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+TCP Socket Plugin interface for Capacitor
+Provides methods for TCP socket communication
+
+### connect(...)
+
+```typescript
+connect(options: ConnectOptions) => Promise<ConnectResult>
+```
+
+Connects to a TCP server
+
+| Param         | Type                                                      | Description                                      |
+| ------------- | --------------------------------------------------------- | ------------------------------------------------ |
+| **`options`** | <code><a href="#connectoptions">ConnectOptions</a></code> | Connection options including IP address and port |
+
+**Returns:** <code>Promise&lt;<a href="#connectresult">ConnectResult</a>&gt;</code>
+
+--------------------
+
+
+### send(...)
+
+```typescript
+send(options: SendOptions) => Promise<void>
+```
+
+Sends data to a connected TCP server
+
+| Param         | Type                                                | Description                                         |
+| ------------- | --------------------------------------------------- | --------------------------------------------------- |
+| **`options`** | <code><a href="#sendoptions">SendOptions</a></code> | Send options including client ID, data and encoding |
+
+--------------------
+
+
+### read(...)
+
+```typescript
+read(options: ReadOptions) => Promise<ReadResult>
+```
+
+Reads data from a connected TCP server
+
+| Param         | Type                                                | Description                                                   |
+| ------------- | --------------------------------------------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#readoptions">ReadOptions</a></code> | Read options including client ID, expected length and timeout |
+
+**Returns:** <code>Promise&lt;<a href="#readresult">ReadResult</a>&gt;</code>
+
+--------------------
+
+
+### disconnect(...)
+
+```typescript
+disconnect(options: DisconnectOptions) => Promise<DisconnectResult>
+```
+
+Disconnects from a TCP server
+
+| Param         | Type                                                            | Description                       |
+| ------------- | --------------------------------------------------------------- | --------------------------------- |
+| **`options`** | <code><a href="#disconnectoptions">DisconnectOptions</a></code> | Disconnect options with client ID |
+
+**Returns:** <code>Promise&lt;<a href="#disconnectresult">DisconnectResult</a>&gt;</code>
+
+--------------------
+
+
+### Interfaces
+
+
+#### ConnectResult
+
+Result of a successful connection
+
+| Prop         | Type                | Description                                          |
+| ------------ | ------------------- | ---------------------------------------------------- |
+| **`client`** | <code>number</code> | Client ID that can be used for subsequent operations |
+
+
+#### ConnectOptions
+
+Options for connecting to a TCP server
+
+| Prop            | Type                | Description                            | Default           |
+| --------------- | ------------------- | -------------------------------------- | ----------------- |
+| **`ipAddress`** | <code>string</code> | IP address of the server to connect to |                   |
+| **`port`**      | <code>number</code> | Port number of the TCP server          | <code>9100</code> |
+
+
+#### SendOptions
+
+Options for sending data to a TCP server
+
+| Prop           | Type                                                  | Description                            | Default                        |
+| -------------- | ----------------------------------------------------- | -------------------------------------- | ------------------------------ |
+| **`client`**   | <code>number</code>                                   | Client ID from a previous connect call |                                |
+| **`data`**     | <code>number[]</code>                                 | Data string to send to the server      |                                |
+| **`encoding`** | <code><a href="#dataencoding">DataEncoding</a></code> | Encoding type for the data             | <code>DataEncoding.UTF8</code> |
+
+
+#### ReadResult
+
+Result of a read operation
+
+| Prop           | Type                                                  | Description                                                                                                          |
+| -------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| **`result`**   | <code>string</code>                                   | Data read from the server Can be UTF-8 string, Base64 encoded string, or Hex string depending on the encoding option |
+| **`encoding`** | <code><a href="#dataencoding">DataEncoding</a></code> | The encoding of the returned result                                                                                  |
+
+
+#### ReadOptions
+
+Options for reading data from a TCP server
+
+| Prop            | Type                                                  | Description                            | Default                        |
+| --------------- | ----------------------------------------------------- | -------------------------------------- | ------------------------------ |
+| **`client`**    | <code>number</code>                                   | Client ID from a previous connect call |                                |
+| **`expectLen`** | <code>number</code>                                   | Expected number of bytes to read       |                                |
+| **`timeout`**   | <code>number</code>                                   | Read timeout in seconds                | <code>10</code>                |
+| **`encoding`**  | <code><a href="#dataencoding">DataEncoding</a></code> | Preferred encoding for returned data   | <code>DataEncoding.UTF8</code> |
+
+
+#### DisconnectResult
+
+Result of a disconnect operation
+
+| Prop         | Type                | Description                     |
+| ------------ | ------------------- | ------------------------------- |
+| **`client`** | <code>number</code> | Client ID that was disconnected |
+
+
+#### DisconnectOptions
+
+Options for disconnecting from a TCP server
+
+| Prop         | Type                | Description                            |
+| ------------ | ------------------- | -------------------------------------- |
+| **`client`** | <code>number</code> | Client ID from a previous connect call |
+
+
+### Enums
+
+
+#### DataEncoding
+
+| Members      | Value                 | Description         |
+| ------------ | --------------------- | ------------------- |
+| **`UTF8`**   | <code>'utf8'</code>   | UTF-8 text encoding |
+| **`BASE64`** | <code>'base64'</code> | Base64 encoded data |
+| **`HEX`**    | <code>'hex'</code>    | Hexadecimal string  |
+
+</docgen-api>

package/dist/docs.json

@@ -0,0 +1,343 @@
+{
+  "api": {
+    "name": "TcpPrinterPlugin",
+    "slug": "tcpprinterplugin",
+    "docs": "TCP Socket Plugin interface for Capacitor\nProvides methods for TCP socket communication",
+    "tags": [],
+    "methods": [
+      {
+        "name": "connect",
+        "signature": "(options: ConnectOptions) => Promise<ConnectResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Connection options including IP address and port",
+            "type": "ConnectOptions"
+          }
+        ],
+        "returns": "Promise<ConnectResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Connection options including IP address and port"
+          },
+          {
+            "name": "returns",
+            "text": "Promise with the client identifier"
+          }
+        ],
+        "docs": "Connects to a TCP server",
+        "complexTypes": [
+          "ConnectResult",
+          "ConnectOptions"
+        ],
+        "slug": "connect"
+      },
+      {
+        "name": "send",
+        "signature": "(options: SendOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Send options including client ID, data and encoding",
+            "type": "SendOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Send options including client ID, data and encoding"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when data is sent"
+          }
+        ],
+        "docs": "Sends data to a connected TCP server",
+        "complexTypes": [
+          "SendOptions"
+        ],
+        "slug": "send"
+      },
+      {
+        "name": "read",
+        "signature": "(options: ReadOptions) => Promise<ReadResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Read options including client ID, expected length and timeout",
+            "type": "ReadOptions"
+          }
+        ],
+        "returns": "Promise<ReadResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Read options including client ID, expected length and timeout"
+          },
+          {
+            "name": "returns",
+            "text": "Promise with the data read from the server"
+          }
+        ],
+        "docs": "Reads data from a connected TCP server",
+        "complexTypes": [
+          "ReadResult",
+          "ReadOptions"
+        ],
+        "slug": "read"
+      },
+      {
+        "name": "disconnect",
+        "signature": "(options: DisconnectOptions) => Promise<DisconnectResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Disconnect options with client ID",
+            "type": "DisconnectOptions"
+          }
+        ],
+        "returns": "Promise<DisconnectResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Disconnect options with client ID"
+          },
+          {
+            "name": "returns",
+            "text": "Promise with the disconnected client ID"
+          }
+        ],
+        "docs": "Disconnects from a TCP server",
+        "complexTypes": [
+          "DisconnectResult",
+          "DisconnectOptions"
+        ],
+        "slug": "disconnect"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ConnectResult",
+      "slug": "connectresult",
+      "docs": "Result of a successful connection",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "client",
+          "tags": [],
+          "docs": "Client ID that can be used for subsequent operations",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "ConnectOptions",
+      "slug": "connectoptions",
+      "docs": "Options for connecting to a TCP server",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "ipAddress",
+          "tags": [],
+          "docs": "IP address of the server to connect to",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "port",
+          "tags": [
+            {
+              "text": "9100",
+              "name": "default"
+            }
+          ],
+          "docs": "Port number of the TCP server",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SendOptions",
+      "slug": "sendoptions",
+      "docs": "Options for sending data to a TCP server",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "client",
+          "tags": [],
+          "docs": "Client ID from a previous connect call",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "data",
+          "tags": [],
+          "docs": "Data string to send to the server",
+          "complexTypes": [],
+          "type": "number[]"
+        },
+        {
+          "name": "encoding",
+          "tags": [
+            {
+              "text": "DataEncoding.UTF8",
+              "name": "default"
+            }
+          ],
+          "docs": "Encoding type for the data",
+          "complexTypes": [
+            "DataEncoding"
+          ],
+          "type": "DataEncoding"
+        }
+      ]
+    },
+    {
+      "name": "ReadResult",
+      "slug": "readresult",
+      "docs": "Result of a read operation",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "result",
+          "tags": [],
+          "docs": "Data read from the server\nCan be UTF-8 string, Base64 encoded string, or Hex string depending on the encoding option",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "encoding",
+          "tags": [],
+          "docs": "The encoding of the returned result",
+          "complexTypes": [
+            "DataEncoding"
+          ],
+          "type": "DataEncoding"
+        }
+      ]
+    },
+    {
+      "name": "ReadOptions",
+      "slug": "readoptions",
+      "docs": "Options for reading data from a TCP server",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "client",
+          "tags": [],
+          "docs": "Client ID from a previous connect call",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "expectLen",
+          "tags": [],
+          "docs": "Expected number of bytes to read",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "timeout",
+          "tags": [
+            {
+              "text": "10",
+              "name": "default"
+            },
+            {
+              "text": "Only available on iOS platform",
+              "name": "note"
+            }
+          ],
+          "docs": "Read timeout in seconds",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "encoding",
+          "tags": [
+            {
+              "text": "DataEncoding.UTF8",
+              "name": "default"
+            }
+          ],
+          "docs": "Preferred encoding for returned data",
+          "complexTypes": [
+            "DataEncoding"
+          ],
+          "type": "DataEncoding"
+        }
+      ]
+    },
+    {
+      "name": "DisconnectResult",
+      "slug": "disconnectresult",
+      "docs": "Result of a disconnect operation",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "client",
+          "tags": [],
+          "docs": "Client ID that was disconnected",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "DisconnectOptions",
+      "slug": "disconnectoptions",
+      "docs": "Options for disconnecting from a TCP server",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "client",
+          "tags": [],
+          "docs": "Client ID from a previous connect call",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "DataEncoding",
+      "slug": "dataencoding",
+      "members": [
+        {
+          "name": "UTF8",
+          "value": "'utf8'",
+          "tags": [],
+          "docs": "UTF-8 text encoding"
+        },
+        {
+          "name": "BASE64",
+          "value": "'base64'",
+          "tags": [],
+          "docs": "Base64 encoded data"
+        },
+        {
+          "name": "HEX",
+          "value": "'hex'",
+          "tags": [],
+          "docs": "Hexadecimal string"
+        }
+      ]
+    }
+  ],
+  "typeAliases": [],
+  "pluginConfigs": []
+}