@cappitolian/http-local-server 0.0.5 → 0.0.6

package/CappitolianHttpLocalServer.podspec

@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   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.ios.deployment_target = '14.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
 end

package/README.md

@@ -1,126 +1,84 @@
 # @cappitolian/http-local-server
 
-Runs a local HTTP server on your device, accessible over LAN. Supports connect, disconnect, GET, and POST methods with IP and port discovery.
+A Capacitor plugin to run a local HTTP server on your device, allowing you to receive and respond to HTTP requests directly from Angular/JavaScript.
 
-## Install
+---
 
-```bash
-npm install @cappitolian/http-local-server
-npx cap sync
-```
-
-## API
-
-<docgen-index>
-
-* [`connect()`](#connect)
-* [`disconnect()`](#disconnect)
-* [`sendResponse(...)`](#sendresponse)
-* [`addListener('onRequest', ...)`](#addlisteneronrequest-)
-* [`removeAllListeners()`](#removealllisteners)
-* [Interfaces](#interfaces)
-
-</docgen-index>
+## Features
 
-<docgen-api>
-<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+- Embed a real HTTP server (NanoHTTPD on Android, GCDWebServer on iOS).
+- Receive requests via events and send responses back from the JS layer.
+- CORS support enabled by default for local communication.
+- Tested with **Capacitor 7** and **Ionic 8**.
 
-### connect()
+---
 
-```typescript
-connect() => Promise<HttpConnectResult>
-```
-
-Inicia el servidor local en el dispositivo nativo.
-Devuelve la IP y el puerto asignado.
-
-**Returns:** <code>Promise&lt;<a href="#httpconnectresult">HttpConnectResult</a>&gt;</code>
+## Installation
 
---------------------
-
-
-### disconnect()
-
-```typescript
-disconnect() => Promise<void>
+```bash
+npm install @cappitolian/http-local-server
+npx cap sync
 ```
 
-Detiene el servidor local.
-
---------------------
+---
 
+## Usage
 
-### sendResponse(...)
+### Import
 
 ```typescript
-sendResponse(options: { requestId: string; body: string; }) => Promise<void>
+import { HttpLocalServer } from '@cappitolian/http-local-server';
 ```
 
-Envía la respuesta de vuelta al cliente que hizo la petición.
-El requestId debe coincidir con el recibido en 'onRequest'.
-
-| Param         | Type                                              |
-| ------------- | ------------------------------------------------- |
-| **`options`** | <code>{ requestId: string; body: string; }</code> |
-
---------------------
-
-
-### addListener('onRequest', ...)
+### Listen and Respond
 
 ```typescript
-addListener(eventName: 'onRequest', listenerFunc: (data: HttpRequestData) => void) => Promise<PluginListenerHandle>
+// 1. Set up the listener for incoming requests
+HttpLocalServer.addListener('onRequest', async (request) => {
+  console.log('Request received:', request.path, request.body);
+
+  // 2. Send a response back to the client using the requestId
+  await HttpLocalServer.sendResponse({
+    requestId: request.requestId,
+    body: JSON.stringify({ message: "Hello from Ionic!" })
+  });
+});
+
+// 3. Start the server
+HttpLocalServer.connect().then(result => {
+  console.log('Server running at:', result.ip, 'Port:', result.port);
+});
 ```
 
-Escucha las peticiones HTTP entrantes.
-
-| Param              | Type                                                                           |
-| ------------------ | ------------------------------------------------------------------------------ |
-| **`eventName`**    | <code>'onRequest'</code>                                                       |
-| **`listenerFunc`** | <code>(data: <a href="#httprequestdata">HttpRequestData</a>) =&gt; void</code> |
-
-**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
-
---------------------
-
-
-### removeAllListeners()
+### Stop Server
 
 ```typescript
-removeAllListeners() => Promise<void>
+HttpLocalServer.disconnect()
 ```
 
-Elimina todos los listeners registrados.
-
---------------------
-
+---
 
-### Interfaces
+## Platforms
 
+- **iOS** (Swift)
+- **Android** (Java)
+- **Web** (Returns mock values for development)
 
-#### HttpConnectResult
+---
 
-| Prop       | Type                |
-| ---------- | ------------------- |
-| **`ip`**   | <code>string</code> |
-| **`port`** | <code>number</code> |
+## Requirements
 
+- [Capacitor 7](https://capacitorjs.com/)
+- [Ionic 8](https://ionicframework.com/) (optional, but tested)
 
-#### PluginListenerHandle
+---
 
-| Prop         | Type                                      |
-| ------------ | ----------------------------------------- |
-| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+## License
 
+MIT
 
-#### HttpRequestData
+---
 
-| Prop            | Type                |
-| --------------- | ------------------- |
-| **`requestId`** | <code>string</code> |
-| **`method`**    | <code>string</code> |
-| **`path`**      | <code>string</code> |
-| **`body`**      | <code>string</code> |
-| **`headers`**   | <code>any</code>    |
+## Support
 
-</docgen-api>
+If you have any issues or feature requests, please open an issue on the repository.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cappitolian/http-local-server",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Runs a local HTTP server on your device, accessible over LAN. Supports connect, disconnect, GET, and POST methods with IP and port discovery.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",