@nimba/api-client 2.5.0 → 2.5.1

package/README.md

@@ -0,0 +1,37 @@
+# @nimba/api-client
+
+The typed SDK over the [Nimba](https://github.com/db-lyon/nimba) HTTP API. Every Nimba client — CLI, web, anything else — talks to the Nimba server through this package and never imports the engine, the bridge, or the tasks directly.
+
+> Part of **Nimba**, modern Salesforce DevOps orchestration in TypeScript.
+
+## Install
+
+```bash
+npm install @nimba/api-client
+```
+
+## Usage
+
+```ts
+import { NimbaApiClient } from '@nimba/api-client';
+
+const nimba = new NimbaApiClient({
+  baseUrl: 'http://localhost:3000',
+  token: process.env.NIMBA_TOKEN, // when auth is enabled
+});
+
+const flows = await nimba.listFlows();
+const result = await nimba.runFlow('dev_org', 'dev'); // (flowName, orgAlias, params?)
+```
+
+## What it is
+
+A small, dependency-light client that mirrors the Nimba server's flow/task operations with full TypeScript types (`FlowSummary`, `FlowInfo`, `FlowRunResponse`, …). It has **no dependency on the server-internal half of the monorepo** — that boundary is the point: clients cross to the engine only over HTTP.
+
+## Requirements
+
+- Node.js >= 22.19
+
+## Links
+
+- [Nimba on GitHub](https://github.com/db-lyon/nimba)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimba/api-client",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -13,6 +13,16 @@
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=22.19.0"
+  },
+  "description": "Typed SDK over the Nimba HTTP API.",
+  "homepage": "https://github.com/db-lyon/nimba/tree/main/packages/api-client#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/db-lyon/nimba.git",
+    "directory": "packages/api-client"
+  },
   "scripts": {
     "build": "tsc -b",
     "typecheck": "tsc -b --noEmit",