abb-rws-client 0.7.2 → 1.0.0

package/examples/06-pull-module-source.mjs

@@ -5,34 +5,27 @@
 //
 // Run: RWS_HOST=192.168.125.1 node examples/06-pull-module-source.mjs MotionTest
 
-import { createClient } from 'abb-rws-client';
-import { RobotManager, RWS2Adapter } from 'abb-rws-client';
+import { RobotManager } from 'abb-rws-client';
 import * as fs from 'node:fs/promises';
 
 const moduleName = process.argv[2] ?? 'user';
+const host = process.env.RWS_HOST || '127.0.0.1';
+const port = process.env.RWS_PORT ? Number(process.env.RWS_PORT) : undefined;
 
-const client = await createClient({
-  host: process.env.RWS_HOST || '127.0.0.1',
-  port: Number(process.env.RWS_PORT) || undefined,
-});
+// RobotManager auto-detects RWS 1.0 vs 2.0 and exposes getModuleSource()
+// uniformly over both protocols (it reads via the controller's fileservice).
+const robot = new RobotManager();
+await robot.connect(host, process.env.RWS_USER || 'Admin', process.env.RWS_PASS || 'robotics', port);
 
-// Wrap with RobotManager only if you need lifecycle features. For a one-shot
-// pull, the raw client is enough.
-const isRws2 = client.constructor.name === 'RwsClient2';
-let source;
-if (isRws2) {
-  // RwsClient2 doesn't expose getModuleSource directly — go through the adapter.
-  const robot = new RobotManager({ adapter: new RWS2Adapter(client) });
-  await robot.start();
-  source = await robot.getModuleSource('T_ROB1', moduleName);
-  await robot.stop();
-} else {
-  // RWS 1.0 has it on the client.
-  source = await client.getModuleSource?.('T_ROB1', moduleName) ?? '';
+const source = await robot.getModuleSource('T_ROB1', moduleName);
+if (!source) {
+  console.error(`✗ Module '${moduleName}' not found (or empty) in task T_ROB1.`);
+  await robot.disconnect();
+  process.exit(1);
 }
 
 await fs.writeFile(`${moduleName}.mod`, source, 'utf8');
 console.log(`✓ Wrote ${moduleName}.mod (${source.length} bytes)`);
 console.log('Now: git diff, edit, git commit, push back via loadModule.');
 
-await client.disconnect();
+await robot.disconnect();

package/package.json

@@ -1,60 +1,62 @@
-{
-  "name": "abb-rws-client",
-  "version": "0.7.2",
-  "description": "Typed TypeScript/Node.js client for ABB Robot Web Services — supports both RWS 1.0 (IRC5/RobotWare 6) and RWS 2.0 (OmniCore/RobotWare 7).",
-  "keywords": [
-    "abb",
-    "robot",
-    "rws",
-    "robot-web-services",
-    "irc5",
-    "omnicore",
-    "robotstudio",
-    "robotware",
-    "industrial-robot"
-  ],
-  "license": "MIT",
-  "homepage": "https://github.com/merajsafari/abb-rws-client",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/merajsafari/abb-rws-client.git"
-  },
-  "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "files": [
-    "dist",
-    "examples",
-    "README.md",
-    "LICENSE",
-    "CHANGELOG.md"
-  ],
-  "engines": {
-    "node": ">=18"
-  },
-  "scripts": {
-    "build": "tsc",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "eslint src",
-    "prepublishOnly": "npm run build && npm test"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "@types/ws": "^8.18.1",
-    "@typescript-eslint/eslint-plugin": "^8.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
-    "eslint": "^9.0.0",
-    "typescript": "^5.4.0",
-    "vitest": "^1.6.1"
-  },
-  "dependencies": {
-    "ws": "^8.20.0"
-  }
-}
+{
+  "name": "abb-rws-client",
+  "version": "1.0.0",
+  "description": "Typed TypeScript/Node.js client for ABB Robot Web Services — supports both RWS 1.0 (IRC5/RobotWare 6) and RWS 2.0 (OmniCore/RobotWare 7).",
+  "keywords": [
+    "abb",
+    "robot",
+    "rws",
+    "robot-web-services",
+    "irc5",
+    "omnicore",
+    "robotstudio",
+    "robotware",
+    "industrial-robot"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/ichbinmeraj/abb-rws-client",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ichbinmeraj/abb-rws-client.git"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "examples",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src",
+    "prepack": "npm run build && npm test",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/ws": "^8.18.1",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^9.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.6.1"
+  },
+  "dependencies": {
+    "ws": "^8.20.0"
+  }
+}

package/src/HalJsonParser.ts

@@ -0,0 +1,137 @@
+/**
+ * Parser for RWS 2.0 HAL JSON responses (`application/hal+json;v=2.0`) — the
+ * officially supported primary GET representation on OmniCore controllers.
+ *
+ * Live-verified 2026-07-09 on OmniCore VC RW7.21 across every GET endpoint
+ * family the client touches (panel, rapid, motionsystem, system, ctrl, elog,
+ * iosystem, cfg, mastership, users/rmmp). The wire shape is:
+ *
+ *   { "_links":    { "base": {...}, "self": {...} [, "next": {...}] },
+ *     "status":    { "code": 294912 },                  // negative on errors, plus "msg"
+ *     "state":     [ { "_type": "...", "_title": "...", ...fields } ],
+ *     "_embedded": { "resources": [ { "_type": "...", ...fields } ] } }
+ *
+ * `_type` carries the same identifier the XHTML representation puts in the
+ * `<li class="...">` attribute, `_title` mirrors the `title` attribute, and
+ * the former `<span class="X">` fields become plain JSON keys. Resources can
+ * nest (e.g. `sys-options-li` holds an `options` array of typed objects,
+ * `cfg-dt-instance-li` an `attrib` array of `cfg-ia-t` entries), so lookups
+ * recurse — mirroring how the XHTML parser finds `<li>` anywhere in the
+ * document. Presents the same read interface as `XhtmlParser` so `RwsClient2`
+ * can treat both representations alike.
+ */
+
+type JsonNode = string | number | boolean | null | JsonNode[] | { [key: string]: JsonNode };
+type JsonObject = { [key: string]: JsonNode };
+
+export class HalJsonParser {
+  private readonly root: JsonNode | null;
+
+  constructor(body: string) {
+    let parsed: JsonNode | null = null;
+    try { parsed = JSON.parse(body) as JsonNode; } catch { parsed = null; }
+    this.root = parsed;
+  }
+
+  /** Cheap sniff used to pick a parser: HAL bodies are single JSON objects. */
+  static looksLikeJson(body: string): boolean {
+    return body.trimStart().startsWith('{');
+  }
+
+  /** Returns the field map of the first resource whose `_type` matches. */
+  getState(type: string): Record<string, string> {
+    return this.getAllStates(type)[0] ?? {};
+  }
+
+  /** Returns field maps for every resource with a matching `_type`, in document order. */
+  getAllStates(type: string): Array<Record<string, string>> {
+    const results: Array<Record<string, string>> = [];
+    this.walk(this.root, obj => {
+      if (obj['_type'] === type) { results.push(HalJsonParser.flatten(obj)); }
+    });
+    return results;
+  }
+
+  /** First scalar value stored under `key` in any resource (XhtmlParser.get analogue). */
+  get(key: string): string | undefined {
+    let found: string | undefined;
+    this.walk(this.root, obj => {
+      if (found !== undefined) { return; }
+      const v = obj[key];
+      if (v !== undefined && v !== null && typeof v !== 'object' && !key.startsWith('_')) {
+        found = String(v);
+      }
+    });
+    return found;
+  }
+
+  /**
+   * Error details from the top-level status block. Success responses carry a
+   * positive code (294912 observed live); errors a negative code plus `msg`.
+   */
+  getError(): { code: string; msg: string } | null {
+    const status = this.rootObject()?.['status'];
+    if (!status || typeof status !== 'object' || Array.isArray(status)) { return null; }
+    const code = (status as JsonObject)['code'];
+    if (typeof code !== 'number' || code >= 0) { return null; }
+    const msg = (status as JsonObject)['msg'];
+    return { code: String(code), msg: typeof msg === 'string' ? msg : '' };
+  }
+
+  /**
+   * Pagination link (`_links.next.href`), raw as sent. Live-verified quirk:
+   * the controller XML-escapes ampersands even inside JSON strings
+   * (`"signals?start=3&amp;limit=3"`) — callers must unescape, exactly as on
+   * the XHTML `rel="next"` path.
+   */
+  nextHref(): string | undefined {
+    const links = this.rootObject()?.['_links'];
+    if (!links || typeof links !== 'object' || Array.isArray(links)) { return undefined; }
+    const next = (links as JsonObject)['next'];
+    if (!next || typeof next !== 'object' || Array.isArray(next)) { return undefined; }
+    const href = (next as JsonObject)['href'];
+    return typeof href === 'string' && href ? href : undefined;
+  }
+
+  private rootObject(): JsonObject | null {
+    return this.root && typeof this.root === 'object' && !Array.isArray(this.root)
+      ? this.root as JsonObject
+      : null;
+  }
+
+  /** Depth-first visit of every object in the tree, skipping `_links` blocks. */
+  private walk(node: JsonNode | null, visit: (obj: JsonObject) => void): void {
+    if (Array.isArray(node)) {
+      for (const item of node) { this.walk(item, visit); }
+      return;
+    }
+    if (node && typeof node === 'object') {
+      visit(node as JsonObject);
+      for (const [key, value] of Object.entries(node)) {
+        if (key === '_links') { continue; }
+        if (value && typeof value === 'object') { this.walk(value, visit); }
+      }
+    }
+  }
+
+  /** Scalar fields → strings; `_title` kept; self link exposed as `_href` (XHTML parity). */
+  private static flatten(obj: JsonObject): Record<string, string> {
+    const fields: Record<string, string> = {};
+    const title = obj['_title'];
+    if (typeof title === 'string') { fields['_title'] = title; }
+    const links = obj['_links'];
+    if (links && typeof links === 'object' && !Array.isArray(links)) {
+      const self = (links as JsonObject)['self'];
+      if (self && typeof self === 'object' && !Array.isArray(self)) {
+        const href = (self as JsonObject)['href'];
+        if (typeof href === 'string') { fields['_href'] = href; }
+      }
+    }
+    for (const [key, value] of Object.entries(obj)) {
+      if (key.startsWith('_')) { continue; }
+      if (value === null || typeof value === 'object') { continue; } // nested resources have their own _type
+      fields[key] = String(value);
+    }
+    return fields;
+  }
+}