@hybrid-compute/core 0.0.14 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [0.2.0](https://github.com/phun-ky/hybrid-compute/compare/@hybrid-compute/core@0.1.0...@hybrid-compute/core@0.2.0) (2025-07-07)
+
+### Tasks
+
+* 🤖 @hybrid-compute/local@0.1.0 ([14599e9](https://github.com/phun-ky/hybrid-compute/commit/14599e91ec059f0f611e8ccbd444bf0b64b1f503))
+* 🤖 @hybrid-compute/remote@0.1.0 ([59292bd](https://github.com/phun-ky/hybrid-compute/commit/59292bd169fb0dbeff24c44183b2ae8d3fe37f3f))
+* 🤖 @hybrid-compute/worker@0.1.0 ([45b7f8c](https://github.com/phun-ky/hybrid-compute/commit/45b7f8ce9453aca1e3b3a3fc3b16cec36305a2dc))
+* 🤖 Add more keywords ([c5646a2](https://github.com/phun-ky/hybrid-compute/commit/c5646a20df3df7f005b08ab1216b987f1ec0430c))
+* 🤖 bump the minor-and-patch group across 1 directory with 7 updates ([2f5d9d6](https://github.com/phun-ky/hybrid-compute/commit/2f5d9d63cb7714c95ac0f69f37446f8497c891cc))
+
+## [0.1.0](https://github.com/phun-ky/hybrid-compute/compare/@hybrid-compute/core@0.0.14...@hybrid-compute/core@0.1.0) (2025-06-23)
+
+### Tasks
+
+* 🤖 @hybrid-compute/local@0.0.13 ([b6bf061](https://github.com/phun-ky/hybrid-compute/commit/b6bf0617bb3b5a8dfc22fddf634e07698f3df13e))
+* 🤖 @hybrid-compute/remote@0.0.13 ([c349cb9](https://github.com/phun-ky/hybrid-compute/commit/c349cb9b1ecf1ec2a1cf6565f84601f28f6143d6))
+* 🤖 @hybrid-compute/worker@0.0.13 ([290e15a](https://github.com/phun-ky/hybrid-compute/commit/290e15a7472062ec44a7b55d185dc94d38bb317d))
+
+### Documentation
+
+* ✏️ Add more examples ([d874e1d](https://github.com/phun-ky/hybrid-compute/commit/d874e1d044eadf94c6641e2e01b134fd04ec0799))
+
+### Feature
+
+* 🎸 Add svg logo ([ea5f9d2](https://github.com/phun-ky/hybrid-compute/commit/ea5f9d23fedda902ca3344e0b207bb7b2c647020))
+
 ## [0.0.14](https://github.com/phun-ky/hybrid-compute/compare/@hybrid-compute/core@0.0.13...@hybrid-compute/core@0.0.14) (2025-06-23)
 
 ### Tasks

package/README.md

@@ -41,6 +41,284 @@ npm install @hybrid-compute/core
 import { HybridCompute } from '@hybrid-compute/core';
 ```
 
+### Usage with local
+
+```bash
+npm install @hybrid-compute/core
+npm install @hybrid-compute/local
+```
+
+```ts
+import { createHybridCompute } from '@hybrid-compute/core';
+import { createLocalCompute } from '@hybrid-compute/local';
+
+// Define a simple echo task
+const echoTask = {
+  name: 'echo',
+  async run(input: string): Promise<string> {
+    return `Echo: ${input}`;
+  }
+};
+
+// Set up the local backend and register the task
+const local = createLocalCompute();
+local.registerTask(echoTask);
+
+// Set up the HybridCompute instance with only the local backend
+const compute = createHybridCompute({
+  local
+});
+
+// Run the task
+async function main() {
+  try {
+    const result = await compute.runTask('echo', 'Hello from HybridCompute!');
+    console.log(result); // Output: Echo: Hello from HybridCompute!
+  } catch (error) {
+    console.error('Task failed:', error);
+  }
+}
+
+main();
+```
+
+### Usage with remote
+
+```bash
+npm install @hybrid-compute/core
+npm install @hybrid-compute/remote
+```
+
+#### Fetch
+
+```ts
+import { createHybridCompute } from '@hybrid-compute/core';
+import { createRemoteCompute } from '@hybrid-compute/remote';
+
+const remote = createRemoteCompute({
+  transport: 'fetch',
+  endpoint: 'https://your-remote-service.com/compute',
+  canRunTasks: ['echo']
+});
+
+const compute = createHybridCompute({
+  remote
+});
+
+async function main() {
+  try {
+    const result = await compute.runTask('echo', 'Remote via fetch!');
+    console.log(result); // Output from remote server
+  } catch (error) {
+    console.error('Task failed:', error);
+  }
+}
+
+main();
+```
+
+##### Example server for the remote fetch example
+
+```js
+import express from 'express';
+
+const app = express();
+const port = 3000;
+
+// Middleware to parse JSON
+app.use(express.json());
+
+// Dummy task implementations
+const tasks = {
+  echo: async (input) => {
+    return `Echo from remote server: ${input}`;
+  },
+
+  // Example additional task
+  reverse: async (input) => {
+    if (typeof input !== 'string') throw new Error('Input must be a string');
+    return input.split('').reverse().join('');
+  }
+};
+
+// Route to handle compute requests
+app.post('/compute', async (req, res) => {
+  const { task, input } = req.body;
+
+  try {
+    if (!task || !tasks[task]) {
+      throw new Error(`Unknown task '${task}'`);
+    }
+
+    const result = await tasks[task](input);
+    res.json({ result });
+  } catch (error) {
+    res.status(400).json({ error: error.message });
+  }
+});
+
+app.listen(port, () => {
+  console.log(
+    `🧠 RemoteCompute server listening at http://localhost:${port}/compute`
+  );
+});
+```
+
+This can be tested locally:
+
+```curl
+curl -X POST http://localhost:3000/compute \
+  -H "Content-Type: application/json" \
+  -d '{"task": "echo", "input": "hello"}'
+```
+
+#### WebSocket
+
+```ts
+import { createHybridCompute } from '@hybrid-compute/core';
+import { createRemoteCompute } from '@hybrid-compute/remote';
+
+const remote = createRemoteCompute({
+  transport: 'websocket',
+  endpoint: 'wss://your-remote-service.com/socket',
+  canRunTasks: ['echo']
+});
+
+const compute = createHybridCompute({
+  remote
+});
+
+async function main() {
+  try {
+    const result = await compute.runTask('echo', 'Remote via WebSocket!');
+    console.log(result); // Output from remote service
+  } catch (error) {
+    console.error('Task failed:', error);
+  }
+}
+
+main();
+```
+
+##### Example server for the remote WebSocket example
+
+```js
+import { WebSocketServer } from 'ws';
+import http from 'http';
+
+// Simple task definitions
+const tasks = {
+  echo: async (input) => {
+    return `Echo from WebSocket server: ${input}`;
+  },
+
+  reverse: async (input) => {
+    if (typeof input !== 'string') throw new Error('Input must be a string');
+    return input.split('').reverse().join('');
+  }
+};
+
+// Create an HTTP server to attach WebSocket
+const server = http.createServer();
+const wss = new WebSocketServer({ server });
+
+wss.on('connection', (ws) => {
+  ws.on('message', async (message) => {
+    let request;
+
+    try {
+      request = JSON.parse(message.toString());
+    } catch (err) {
+      ws.send(JSON.stringify({ id: null, error: 'Invalid JSON' }));
+      return;
+    }
+
+    const { id, task, input } = request;
+
+    if (!id || typeof task !== 'string') {
+      ws.send(JSON.stringify({ id, error: 'Missing or invalid task name' }));
+      return;
+    }
+
+    try {
+      if (!tasks[task]) throw new Error(`Unknown task '${task}'`);
+
+      const result = await tasks[task](input);
+      ws.send(JSON.stringify({ id, result }));
+    } catch (error) {
+      ws.send(JSON.stringify({ id, error: error.message }));
+    }
+  });
+});
+
+server.listen(3001, () => {
+  console.log(
+    '🔌 WebSocket RemoteCompute server listening at ws://localhost:3001'
+  );
+});
+```
+
+### Usage with worker
+
+```bash
+npm install @hybrid-compute/core
+npm install @hybrid-compute/worker
+```
+
+Create a file named `worker.ts`:
+
+```ts
+self.onmessage = async (event) => {
+  const { task, input, id } = event.data;
+
+  try {
+    let result;
+
+    switch (task) {
+      case 'echo':
+        result = `Echo from Worker: ${input}`;
+        break;
+
+      // Add more cases for additional tasks
+      default:
+        throw new Error(`Unknown task: ${task}`);
+    }
+
+    self.postMessage({ id, result });
+  } catch (error) {
+    self.postMessage({ id, error: (error as Error).message });
+  }
+};
+```
+
+And your `main.ts`:
+
+```ts
+import { createHybridCompute } from '@hybrid-compute/core';
+import { createThreadedCompute } from '@hybrid-compute/worker';
+
+// Worker must be served as a module
+const worker = createThreadedCompute(
+  new URL('./worker.ts', import.meta.url).href,
+  ['echo']
+);
+
+const compute = createHybridCompute({
+  worker
+});
+
+const main = async () => {
+  try {
+    const result = await compute.runTask('echo', 'Hello from Worker!');
+    console.log(result); // Echo from Worker: Hello from Worker!
+  } catch (error) {
+    console.error('Task failed:', error);
+  }
+};
+
+main();
+```
+
 ---
 
 ## Contributing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hybrid-compute/core",
-  "version": "0.0.14",
+  "version": "0.2.0",
   "description": "Core orchestrator for dispatching compute tasks to local, threaded, or remote backends.",
   "keywords": [
     "compute",