@omicron-x/daedalus-sdk 1.0.0 → 1.0.2

package/README.md

@@ -1,63 +1,137 @@
-# Daedalus Node.js Worker SDK
+# Daedalus Node.js Worker SDK 👷⚙️
 
-Node.js/TypeScript SDK for interacting with the Daedalus Orchestrator.
+Node.js/TypeScript SDK for interacting with the **Daedalus Orchestrator**.
 
-## Installation
+---
 
-```bash
-cd sdk/nodejs-sdk
-npm install
-```
+## 📦 Installation
 
-## How to Build
-
-You can compile the SDK using Nx from the project root:
+To install the SDK as a dependency in your project:
 
 ```bash
-nx run server:build-sdk-nodejs
+npm install @omicron-x/daedalus-sdk
 ```
 
-Or manually within the `sdk/nodejs-sdk` folder:
-
-```bash
-npm run build
+---
+
+## 🚀 Quick Start (Usage Example)
+
+Here is a basic example of how to connect and create a worker to process messages using the SDK:
+
+```typescript
+import { DaedalusSDK } from '@omicron-x/daedalus-sdk';
+
+async function main() {
+    // 1. Initialize the SDK
+    const sdk = new DaedalusSDK({
+        uri: 'http://localhost:4000', // Orchestrator gRPC/HTTP endpoint
+        username: 'admin',
+        password: 'admin'
+    });
+
+    // 2. Connect to the Orchestrator
+    await sdk.connect();
+
+    // 3. Register a worker to consume tasks
+    await sdk.createWorker({
+        workerName: 'my-custom-worker',
+        intervalMs: 500,
+        capacityPolicies: [
+            {
+                maxQueueMessages: 10,
+                claimWorkFilter: {}
+            }
+        ],
+        onMessage: async (message, ack) => {
+            console.log('👷 Processing message:', message.message.content);
+            
+            // Your message processing logic here...
+
+            // Acknowledge the message when finished
+            await ack();
+        }
+    });
+
+    console.log('✅ Worker is running. Press Ctrl+C to stop.');
+}
+
+main().catch(err => {
+    console.error('💥 Fatal error:', err);
+});
 ```
 
-## Examples
+> [!NOTE]
+> **Protobuf Dependency Note:** Currently, the SDK resolves gRPC protobuf definitions relative to the monorepo directory structure (looking for `server/internal/infrastructure/server/grpc/proto/definitions` three levels up from the package folder). If you use this package standalone outside the monorepo, make sure to place or symlink the protobuf definitions at the expected relative path, or install the package within the monorepo context.
 
-### Simple Worker
+---
 
-To run the simple worker example:
+## 🛠️ Monorepo Development & Contribution
 
-```bash
-nx run server:run-nodejs-simple-worker
-```
+If you are developing inside the [Daedalus Orchestrator Monorepo](file:///Users/angel/Documents/daedalus-orchestrator-project/daedalus-orchestrator), follow these steps to build and run the SDK.
+
+### Prerequisites
 
-Or manually:
+To execute build tasks and run examples inside the monorepo, you must have **Nx** installed globally (or run using `npx nx`):
 
 ```bash
-cd sdk/nodejs-sdk
-npx ts-node examples/simple-worker/index.ts
+npm install -g nx
 ```
 
-### Assert Resources
+### How to Build the SDK
 
-To run the assert resources example:
+Compile the SDK from the project root directory:
 
 ```bash
-nx run server:run-nodejs-assert-resources
+nx run server:build-sdk-nodejs
 ```
 
-Demonstrates how to upsert a tenant, exchange, queue, and binding using the `assertTenant`, `assertExchange`, `assertQueue`, and `assertBinding` methods.
+Alternatively, you can compile manually within the `sdk/nodejs-sdk` folder:
 
 ```bash
 cd sdk/nodejs-sdk
-npm run example:assert-resources
+npm install
+npm run build
 ```
 
-Or manually:
+---
 
-```bash
-cd sdk/nodejs-sdk
-npx ts-node examples/assert-resources/index.ts
-```
+## 📚 Examples Reference
+
+We provide fully functional examples in the [examples/](file:///Users/angel/Documents/daedalus-orchestrator-project/daedalus-orchestrator/sdk/nodejs-sdk/examples) folder:
+
+- **[Simple Worker](file:///Users/angel/Documents/daedalus-orchestrator-project/daedalus-orchestrator/sdk/nodejs-sdk/examples/simple-worker/index.ts)**: A basic worker showing connection and message consumption.
+- **[Assert Resources](file:///Users/angel/Documents/daedalus-orchestrator-project/daedalus-orchestrator/sdk/nodejs-sdk/examples/assert-resources/index.ts)**: A comprehensive example demonstrating how to upsert a tenant, exchange, queue, and binding, plus publishing and enqueueing messages.
+
+### Running the Examples
+
+#### Option A: Running from the Monorepo Root (Using Nx)
+
+Run the examples directly using Nx:
+
+- **Simple Worker**:
+  ```bash
+  nx run server:run-nodejs-simple-worker
+  ```
+
+- **Assert Resources**:
+  ```bash
+  nx run server:run-nodejs-assert-resources
+  ```
+
+#### Option B: Running from the SDK Directory
+
+Navigate to `sdk/nodejs-sdk` first, then run:
+
+- **Simple Worker**:
+  ```bash
+  npm run example:simple-worker
+  # or manually:
+  npx ts-node examples/simple-worker/index.ts
+  ```
+
+- **Assert Resources**:
+  ```bash
+  npm run example:assert-resources
+  # or manually:
+  npx ts-node examples/assert-resources/index.ts
+  ```

package/package.json

@@ -1,7 +1,16 @@
 {
     "name": "@omicron-x/daedalus-sdk",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Daedalus Orchestrator Node.js Worker",
+    "homepage": "https://github.com/angel-zguerrero/daedalus-orchestrator/tree/main/sdk/nodejs-sdk",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/angel-zguerrero/daedalus-orchestrator.git",
+        "directory": "sdk/nodejs-sdk"
+    },
+    "bugs": {
+        "url": "https://github.com/angel-zguerrero/daedalus-orchestrator/issues"
+    },
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
     "files": [