@node-i3x/app 0.1.0

package/README.md

@@ -0,0 +1,139 @@
+# @node-i3x/app
+
+> **Expose any OPC UA server as an i3X REST API -- one command.**
+
+[![npm](https://img.shields.io/npm/v/@node-i3x/app)](https://www.npmjs.com/package/@node-i3x/app)
+[![Node.js >=20](https://img.shields.io/badge/node-%3E%3D20-brightgreen)](https://nodejs.org)
+[![TypeScript](https://img.shields.io/badge/TypeScript-ESM--only-blue)](https://www.typescriptlang.org)
+[![License: AGPL-3.0-or-later OR Commercial](https://img.shields.io/badge/license-AGPL--3.0--or--later%20OR%20Commercial-orange)](../../LICENSE)
+[![Built by Sterfive](https://img.shields.io/badge/built%20by-Sterfive-ff6600)](https://sterfive.com)
+
+## Quick Start
+
+```bash
+npx @node-i3x/app -e opc.tcp://my-plc:4840
+```
+
+That's it. The i3X REST API is now available at `http://localhost:8080`.
+
+## Installation
+
+```bash
+npm install -g @node-i3x/app
+```
+
+Or use directly with `npx` (no install needed).
+
+## CLI Options
+
+```
+Usage: i3x [options]
+
+Expose OPC UA servers as i3X REST APIs
+
+Options:
+  -V, --version                      Show version
+  -e, --endpoint <url>               OPC UA endpoint URL
+  -p, --port <port>                  REST API port (default: 8080)
+  -H, --host <host>                  REST API bind address (default: 0.0.0.0)
+  --security-mode <mode>             OPC UA security mode (default: None)
+  --optimized-client <mode>          Optimized client: auto | disabled
+  --subscription-interval <seconds>  Subscription interval in seconds
+  --log-level <level>                debug | info | warn | error
+  --no-model-preload                 Skip model preload on startup
+  -c, --config <path>                Path to config file
+  -h, --help                         Show help
+```
+
+## Configuration
+
+i3X uses layered configuration. Each layer overrides the previous:
+
+```
+1. Built-in defaults
+2. Config file (i3x.config.yml)
+3. Environment variables (I3X_*)
+4. CLI arguments (--endpoint, --port, ...)
+```
+
+### Config File
+
+Create an `i3x.config.yml` in your project root:
+
+```yaml
+# i3x.config.yml
+endpoint: opc.tcp://192.168.1.100:4840
+port: 8080
+host: 0.0.0.0
+logLevel: info
+subscriptionInterval: 5
+modelPreload: true
+```
+
+Supported file names (auto-discovered):
+
+| File | Format |
+|---|---|
+| `i3x.config.yml` | YAML |
+| `i3x.config.yaml` | YAML |
+| `i3x.config.json` | JSON |
+| `.i3xrc` | JSON |
+| `.i3xrc.json` | JSON |
+| `.i3xrc.yml` | YAML |
+| `package.json` (`"i3x"` key) | JSON |
+
+### Environment Variables
+
+All environment variables are prefixed with `I3X_`:
+
+| Variable | Config key | Default |
+|---|---|---|
+| `I3X_OPCUA_ENDPOINT` | `endpoint` | `opc.tcp://localhost:4840` |
+| `I3X_PORT` | `port` | `8080` |
+| `I3X_HOST` | `host` | `0.0.0.0` |
+| `I3X_OPCUA_SECURITY_MODE` | `securityMode` | `None` |
+| `I3X_OPCUA_OPTIMIZED_CLIENT` | `optimizedClient` | `auto` |
+| `I3X_SUBSCRIPTION_INTERVAL_SECONDS` | `subscriptionInterval` | `5` |
+| `I3X_LOG_LEVEL` | `logLevel` | `info` |
+| `I3X_MODEL_PRELOAD_ON_STARTUP` | `modelPreload` | `true` |
+
+## Programmatic Usage
+
+```ts
+import { resolveConfig, startServer } from '@node-i3x/app';
+
+const config = await resolveConfig({
+  endpoint: 'opc.tcp://my-plc:4840',
+  port: 9090,
+});
+
+await startServer(config, '1.0.0');
+```
+
+## How It Works
+
+```
+  Your OPC UA Server           i3X (@node-i3x/app)
+  +-----------------+          +---------------------------+
+  | AddressSpace    |  <-----> | OpcUaDataSourceAdapter    |
+  | (PLCs, sensors) | opc.tcp  | ModelService              |
+  +-----------------+          | ValueService              |
+                               | HistoryService            |
+                               | SubscriptionService       |
+                               |                           |
+                               | i3X REST API (Fastify)    |
+                               +----------+----------------+
+                                          |
+                                   http://0.0.0.0:8080
+                                          |
+                               +----------v----------------+
+                               | Your Web App / Dashboard  |
+                               +---------------------------+
+```
+
+## License
+
+**AGPL-3.0-or-later** -- Free for open-source projects.
+
+For commercial / proprietary use, contact [Sterfive](https://sterfive.com)
+for a commercial license.

package/dist/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import{createRequire as R}from"module";import{Command as U}from"commander";import{cosmiconfig as h}from"cosmiconfig";import{load as u}from"js-yaml";var O={endpoint:"opc.tcp://localhost:4840",port:8080,host:"0.0.0.0",securityMode:"None",optimizedClient:"auto",subscriptionInterval:5,logLevel:"info",modelPreload:!0,failOnPreloadError:!1};function d(o){return process.env[o]}function g(o){let e=process.env[o];return e?parseInt(e,10):void 0}function v(o){let e=process.env[o];if(e)return e==="1"||e.toLowerCase()==="true"}function y(){let o={},e=d("I3X_OPCUA_ENDPOINT")??d("I3X_ENDPOINT");e&&(o.endpoint=e);let n=g("I3X_PORT");n!==void 0&&(o.port=n);let t=d("I3X_HOST");t&&(o.host=t);let r=d("I3X_OPCUA_SECURITY_MODE");r&&(o.securityMode=r);let i=d("I3X_OPCUA_OPTIMIZED_CLIENT");(i==="auto"||i==="disabled")&&(o.optimizedClient=i);let s=g("I3X_SUBSCRIPTION_INTERVAL_SECONDS");s!==void 0&&(o.subscriptionInterval=s);let c=d("I3X_LOG_LEVEL");c&&(o.logLevel=c);let l=v("I3X_MODEL_PRELOAD_ON_STARTUP");l!==void 0&&(o.modelPreload=l);let a=v("I3X_FAIL_STARTUP_ON_MODEL_PRELOAD_ERROR");return a!==void 0&&(o.failOnPreloadError=a),o}async function I(o,e){let n={},t=h("i3x",{searchPlaces:["i3x.config.yml","i3x.config.yaml","i3x.config.json",".i3xrc",".i3xrc.json",".i3xrc.yml",".i3xrc.yaml","package.json"],loaders:{".yml":(i,s)=>u(s),".yaml":(i,s)=>u(s)}});try{let i=e?await t.load(e):await t.search();i&&!i.isEmpty&&(n=i.config)}catch{}let r=y();return{...O,...n,...r,...o}}import{consoleLogger as E,HistoryService as _,ModelService as b,SubscriptionService as L,ValueService as w}from"@node-i3x/core";import{OpcUaClient as A,OpcUaDataSourceAdapter as T}from"@node-i3x/opcua-connector";import{createApp as M}from"@node-i3x/rest-server";function C(o,e,n){let t=["","  i3X Server v"+o,"","  OPC UA:  "+e.endpoint,"  REST:    http://"+e.host+":"+e.port];n!==void 0&&t.push("  Model:   "+n+" nodes"),t.push(""),t.push("  Press Ctrl+C to stop"),t.push("");let i=Math.max(...t.map(a=>a.length))+2,s="-".repeat(i),c="  +"+s+"+",l="  +"+s+"+";console.log(c);for(let a of t)console.log("  |"+a.padEnd(i)+"|");console.log(l),console.log()}async function P(o,e){let n=E,t=new A({endpointUrl:o.endpoint,securityMode:o.securityMode,optimizedClient:o.optimizedClient},n),r=new T(t,n),i=new b(r,n),s=new w(r,i,n),c=new _(r,i,n),l=new L(r,i,n,o.subscriptionInterval),a=await M({dataSource:r,modelService:i,valueService:s,historyService:c,subscriptionService:l,logger:n});await r.connect();let p;if(o.modelPreload)try{p=(await i.preloadModel()).nodesById.size}catch(m){n.error("Model preload failed: "+String(m)),o.failOnPreloadError&&process.exit(1)}await a.listen({port:o.port,host:o.host}),C(e,o,p);let f=async()=>{n.info("Shutting down..."),await a.close(),await l.close(),await r.disconnect(),process.exit(0)};process.on("SIGINT",f),process.on("SIGTERM",f)}var z=R(import.meta.url),x=z("../package.json"),S=new U;S.name("i3x").description("Expose OPC UA servers as i3X REST APIs").version(x.version).option("-e, --endpoint <url>","OPC UA endpoint URL").option("-p, --port <port>","REST API port",parseInt).option("-H, --host <host>","REST API bind address").option("--security-mode <mode>","OPC UA security mode").option("--optimized-client <mode>","Optimized client: auto | disabled").option("--subscription-interval <seconds>","Subscription interval in seconds",parseInt).option("--log-level <level>","Log level: debug | info | warn | error").option("--no-model-preload","Skip model preload on startup").option("-c, --config <path>","Path to config file").action(async o=>{let e={};o.endpoint&&(e.endpoint=o.endpoint),o.port!==void 0&&(e.port=o.port),o.host&&(e.host=o.host),o.securityMode&&(e.securityMode=o.securityMode),o.optimizedClient&&(e.optimizedClient=o.optimizedClient),o.subscriptionInterval!==void 0&&(e.subscriptionInterval=o.subscriptionInterval),o.logLevel&&(e.logLevel=o.logLevel),o.modelPreload===!1&&(e.modelPreload=!1);let n=await I(e,o.config);await P(n,x.version)});S.parse();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/cli.ts","../src/config.ts","../src/server.ts","../src/banner.ts"],"mappings":";AAAA,OAAS,iBAAAA,MAAqB,SAC9B,OAAS,WAAAC,MAAe,YCDxB,OAAS,eAAAC,MAAmB,cAC5B,OAAS,QAAQC,MAAgB,UAcjC,IAAMC,EAAsB,CAC1B,SAAU,2BACV,KAAM,KACN,KAAM,UACN,aAAc,OACd,gBAAiB,OACjB,qBAAsB,EACtB,SAAU,OACV,aAAc,GACd,mBAAoB,EACtB,EAGA,SAASC,EAAOC,EAAiC,CAC/C,OAAO,QAAQ,IAAIA,CAAG,CACxB,CACA,SAASC,EAAOD,EAAiC,CAC/C,IAAME,EAAI,QAAQ,IAAIF,CAAG,EACzB,OAAOE,EAAI,SAASA,EAAG,EAAE,EAAI,MAC/B,CACA,SAASC,EAAQH,EAAkC,CACjD,IAAME,EAAI,QAAQ,IAAIF,CAAG,EACzB,GAAKE,EACL,OAAOA,IAAM,KAAOA,EAAE,YAAY,IAAM,MAC1C,CAEA,SAASE,GAA8B,CACrC,IAAMC,EAA6B,CAAC,EAC9BC,EAAWP,EAAO,oBAAoB,GAAKA,EAAO,cAAc,EAClEO,IAAUD,EAAO,SAAWC,GAEhC,IAAMC,EAAON,EAAO,UAAU,EAC1BM,IAAS,SAAWF,EAAO,KAAOE,GAEtC,IAAMC,EAAOT,EAAO,UAAU,EAC1BS,IAAMH,EAAO,KAAOG,GAExB,IAAMC,EAAeV,EAAO,yBAAyB,EACjDU,IAAcJ,EAAO,aAAeI,GAExC,IAAMC,EAAkBX,EAAO,4BAA4B,GACvDW,IAAoB,QAAUA,IAAoB,cACpDL,EAAO,gBAAkBK,GAE3B,IAAMC,EAAWV,EAAO,mCAAmC,EACvDU,IAAa,SAAWN,EAAO,qBAAuBM,GAE1D,IAAMC,EAAWb,EAAO,eAAe,EACnCa,IAAUP,EAAO,SAAWO,GAEhC,IAAMC,EAAUV,EAAQ,8BAA8B,EAClDU,IAAY,SAAWR,EAAO,aAAeQ,GAEjD,IAAMC,EAAgBX,EAAQ,yCAAyC,EACvE,OAAIW,IAAkB,SAAWT,EAAO,mBAAqBS,GAEtDT,CACT,CAGA,eAAsBU,EACpBC,EACAC,EACoB,CAEpB,IAAIC,EAAiC,CAAC,EAChCC,EAAWvB,EAAY,MAAO,CAClC,aAAc,CACZ,iBACA,kBACA,kBACA,SACA,cACA,aACA,cACA,cACF,EACA,QAAS,CACP,OAAQ,CAACwB,EAAmBC,IAAoBxB,EAASwB,CAAO,EAChE,QAAS,CAACD,EAAmBC,IAAoBxB,EAASwB,CAAO,CACnE,CACF,CAAC,EAED,GAAI,CACF,IAAMhB,EAASY,EACX,MAAME,EAAS,KAAKF,CAAU,EAC9B,MAAME,EAAS,OAAO,EACtBd,GAAU,CAACA,EAAO,UACpBa,EAAab,EAAO,OAExB,MAAQ,CAER,CAGA,IAAMiB,EAAYlB,EAAQ,EAE1B,MAAO,CACL,GAAGN,EACH,GAAGoB,EACH,GAAGI,EACH,GAAGN,CACL,CACF,CCtHA,OACE,iBAAAO,EACA,kBAAAC,EACA,gBAAAC,EACA,uBAAAC,EACA,gBAAAC,MACK,iBACP,OAAS,eAAAC,EAAa,0BAAAC,MAA8B,4BACpD,OAAS,aAAAC,MAAiB,wBCNnB,SAASC,EACdC,EACAC,EACAC,EACM,CACN,IAAMC,EAAQ,CACZ,GACA,iBAAmBH,EACnB,GACA,cAAgBC,EAAO,SACvB,qBAAuBA,EAAO,KAAO,IAAMA,EAAO,IACpD,EAEIC,IAAc,QAChBC,EAAM,KAAK,cAAgBD,EAAY,QAAQ,EAGjDC,EAAM,KAAK,EAAE,EACbA,EAAM,KAAK,wBAAwB,EACnCA,EAAM,KAAK,EAAE,EAIb,IAAMC,EADS,KAAK,IAAI,GAAGD,EAAM,IAAKE,GAAMA,EAAE,MAAM,CAAC,EAC9B,EAEjBC,EAAK,IAAI,OAAOF,CAAK,EACrBG,EAAM,MAAQD,EAAK,IACnBE,EAAM,MAAQF,EAAK,IAEzB,QAAQ,IAAIC,CAAG,EACf,QAAWE,KAAQN,EACjB,QAAQ,IAAI,MAAQM,EAAK,OAAOL,CAAK,EAAI,GAAG,EAE9C,QAAQ,IAAII,CAAG,EACf,QAAQ,IAAI,CACd,CDzBA,eAAsBE,EACpBC,EACAC,EACe,CACf,IAAMC,EAASC,EAGTC,EAAc,IAAIC,EACtB,CACE,YAAaL,EAAO,SACpB,aAAcA,EAAO,aACrB,gBAAiBA,EAAO,eAC1B,EACAE,CACF,EACMI,EAAa,IAAIC,EAAuBH,EAAaF,CAAM,EAG3DM,EAAe,IAAIC,EAAaH,EAAYJ,CAAM,EAClDQ,EAAe,IAAIC,EAAaL,EAAYE,EAAcN,CAAM,EAChEU,EAAiB,IAAIC,EAAeP,EAAYE,EAAcN,CAAM,EACpEY,EAAsB,IAAIC,EAC9BT,EACAE,EACAN,EACAF,EAAO,oBACT,EAGMgB,EAAM,MAAMC,EAAU,CAC1B,WAAAX,EACA,aAAAE,EACA,aAAAE,EACA,eAAAE,EACA,oBAAAE,EACA,OAAAZ,CACF,CAAC,EAGD,MAAMI,EAAW,QAAQ,EAGzB,IAAIY,EACJ,GAAIlB,EAAO,aACT,GAAI,CAEFkB,GADc,MAAMV,EAAa,aAAa,GAC5B,UAAU,IAC9B,OAASW,EAAK,CACZjB,EAAO,MAAM,yBAA2B,OAAOiB,CAAG,CAAC,EAC/CnB,EAAO,oBAAoB,QAAQ,KAAK,CAAC,CAC/C,CAIF,MAAMgB,EAAI,OAAO,CAAE,KAAMhB,EAAO,KAAM,KAAMA,EAAO,IAAK,CAAC,EAGzDoB,EAAYnB,EAASD,EAAQkB,CAAS,EAGtC,IAAMG,EAAW,SAAY,CAC3BnB,EAAO,KAAK,kBAAkB,EAC9B,MAAMc,EAAI,MAAM,EAChB,MAAMF,EAAoB,MAAM,EAChC,MAAMR,EAAW,WAAW,EAC5B,QAAQ,KAAK,CAAC,CAChB,EACA,QAAQ,GAAG,SAAUe,CAAQ,EAC7B,QAAQ,GAAG,UAAWA,CAAQ,CAChC,CF3EA,IAAMC,EAAUC,EAAc,YAAY,GAAG,EACvCC,EAAMF,EAAQ,iBAAiB,EAE/BG,EAAU,IAAIC,EAEpBD,EACG,KAAK,KAAK,EACV,YAAY,wCAAwC,EACpD,QAAQD,EAAI,OAAO,EACnB,OAAO,uBAAwB,qBAAqB,EACpD,OAAO,oBAAqB,gBAAiB,QAAQ,EACrD,OAAO,oBAAqB,uBAAuB,EACnD,OAAO,yBAA0B,sBAAsB,EACvD,OACC,4BACA,mCACF,EACC,OACC,oCACA,mCACA,QACF,EACC,OAAO,sBAAuB,wCAAwC,EACtE,OAAO,qBAAsB,+BAA+B,EAC5D,OAAO,sBAAuB,qBAAqB,EACnD,OAAO,MAAOG,GAAS,CAEtB,IAAMC,EAA8B,CAAC,EACjCD,EAAK,WAAUC,EAAQ,SAAWD,EAAK,UACvCA,EAAK,OAAS,SAAWC,EAAQ,KAAOD,EAAK,MAC7CA,EAAK,OAAMC,EAAQ,KAAOD,EAAK,MAC/BA,EAAK,eAAcC,EAAQ,aAAeD,EAAK,cAC/CA,EAAK,kBACPC,EAAQ,gBAAkBD,EAAK,iBAC7BA,EAAK,uBAAyB,SAChCC,EAAQ,qBAAuBD,EAAK,sBAClCA,EAAK,WAAUC,EAAQ,SAAWD,EAAK,UACvCA,EAAK,eAAiB,KAAOC,EAAQ,aAAe,IAExD,IAAMC,EAAS,MAAMC,EAAcF,EAASD,EAAK,MAAM,EACvD,MAAMI,EAAYF,EAAQL,EAAI,OAAO,CACvC,CAAC,EAEHC,EAAQ,MAAM","names":["createRequire","Command","cosmiconfig","loadYaml","DEFAULTS","envStr","key","envInt","v","envBool","fromEnv","result","endpoint","port","host","securityMode","optimizedClient","interval","logLevel","preload","failOnPreload","resolveConfig","cliArgs","configPath","fileConfig","explorer","_filepath","content","envConfig","consoleLogger","HistoryService","ModelService","SubscriptionService","ValueService","OpcUaClient","OpcUaDataSourceAdapter","createApp","printBanner","version","config","nodeCount","lines","width","l","hr","top","bot","line","startServer","config","version","logger","consoleLogger","opcuaClient","OpcUaClient","dataSource","OpcUaDataSourceAdapter","modelService","ModelService","valueService","ValueService","historyService","HistoryService","subscriptionService","SubscriptionService","app","createApp","nodeCount","err","printBanner","shutdown","require","createRequire","pkg","program","Command","opts","cliArgs","config","resolveConfig","startServer"]}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+interface I3xConfig {
+    endpoint: string;
+    port: number;
+    host: string;
+    securityMode: string;
+    optimizedClient: 'auto' | 'disabled';
+    subscriptionInterval: number;
+    logLevel: string;
+    modelPreload: boolean;
+    failOnPreloadError: boolean;
+}
+declare function resolveConfig(cliArgs: Partial<I3xConfig>, configPath?: string): Promise<I3xConfig>;
+
+declare function startServer(config: I3xConfig, version: string): Promise<void>;
+
+export { type I3xConfig, resolveConfig, startServer };

package/dist/index.js

@@ -0,0 +1,2 @@
+import{cosmiconfig as C}from"cosmiconfig";import{load as m}from"js-yaml";var x={endpoint:"opc.tcp://localhost:4840",port:8080,host:"0.0.0.0",securityMode:"None",optimizedClient:"auto",subscriptionInterval:5,logLevel:"info",modelPreload:!0,failOnPreloadError:!1};function d(o){return process.env[o]}function g(o){let e=process.env[o];return e?parseInt(e,10):void 0}function I(o){let e=process.env[o];if(e)return e==="1"||e.toLowerCase()==="true"}function P(){let o={},e=d("I3X_OPCUA_ENDPOINT")??d("I3X_ENDPOINT");e&&(o.endpoint=e);let n=g("I3X_PORT");n!==void 0&&(o.port=n);let r=d("I3X_HOST");r&&(o.host=r);let i=d("I3X_OPCUA_SECURITY_MODE");i&&(o.securityMode=i);let t=d("I3X_OPCUA_OPTIMIZED_CLIENT");(t==="auto"||t==="disabled")&&(o.optimizedClient=t);let s=g("I3X_SUBSCRIPTION_INTERVAL_SECONDS");s!==void 0&&(o.subscriptionInterval=s);let c=d("I3X_LOG_LEVEL");c&&(o.logLevel=c);let l=I("I3X_MODEL_PRELOAD_ON_STARTUP");l!==void 0&&(o.modelPreload=l);let a=I("I3X_FAIL_STARTUP_ON_MODEL_PRELOAD_ERROR");return a!==void 0&&(o.failOnPreloadError=a),o}async function S(o,e){let n={},r=C("i3x",{searchPlaces:["i3x.config.yml","i3x.config.yaml","i3x.config.json",".i3xrc",".i3xrc.json",".i3xrc.yml",".i3xrc.yaml","package.json"],loaders:{".yml":(t,s)=>m(s),".yaml":(t,s)=>m(s)}});try{let t=e?await r.load(e):await r.search();t&&!t.isEmpty&&(n=t.config)}catch{}let i=P();return{...x,...n,...i,...o}}import{consoleLogger as _,HistoryService as O,ModelService as h,SubscriptionService as E,ValueService as y}from"@node-i3x/core";import{OpcUaClient as w,OpcUaDataSourceAdapter as L}from"@node-i3x/opcua-connector";import{createApp as b}from"@node-i3x/rest-server";function v(o,e,n){let r=["","  i3X Server v"+o,"","  OPC UA:  "+e.endpoint,"  REST:    http://"+e.host+":"+e.port];n!==void 0&&r.push("  Model:   "+n+" nodes"),r.push(""),r.push("  Press Ctrl+C to stop"),r.push("");let t=Math.max(...r.map(a=>a.length))+2,s="-".repeat(t),c="  +"+s+"+",l="  +"+s+"+";console.log(c);for(let a of r)console.log("  |"+a.padEnd(t)+"|");console.log(l),console.log()}async function T(o,e){let n=_,r=new w({endpointUrl:o.endpoint,securityMode:o.securityMode,optimizedClient:o.optimizedClient},n),i=new L(r,n),t=new h(i,n),s=new y(i,t,n),c=new O(i,t,n),l=new E(i,t,n,o.subscriptionInterval),a=await b({dataSource:i,modelService:t,valueService:s,historyService:c,subscriptionService:l,logger:n});await i.connect();let p;if(o.modelPreload)try{p=(await t.preloadModel()).nodesById.size}catch(u){n.error("Model preload failed: "+String(u)),o.failOnPreloadError&&process.exit(1)}await a.listen({port:o.port,host:o.host}),v(e,o,p);let f=async()=>{n.info("Shutting down..."),await a.close(),await l.close(),await i.disconnect(),process.exit(0)};process.on("SIGINT",f),process.on("SIGTERM",f)}export{S as resolveConfig,T as startServer};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/config.ts","../src/server.ts","../src/banner.ts"],"mappings":"AAAA,OAAS,eAAAA,MAAmB,cAC5B,OAAS,QAAQC,MAAgB,UAcjC,IAAMC,EAAsB,CAC1B,SAAU,2BACV,KAAM,KACN,KAAM,UACN,aAAc,OACd,gBAAiB,OACjB,qBAAsB,EACtB,SAAU,OACV,aAAc,GACd,mBAAoB,EACtB,EAGA,SAASC,EAAOC,EAAiC,CAC/C,OAAO,QAAQ,IAAIA,CAAG,CACxB,CACA,SAASC,EAAOD,EAAiC,CAC/C,IAAME,EAAI,QAAQ,IAAIF,CAAG,EACzB,OAAOE,EAAI,SAASA,EAAG,EAAE,EAAI,MAC/B,CACA,SAASC,EAAQH,EAAkC,CACjD,IAAME,EAAI,QAAQ,IAAIF,CAAG,EACzB,GAAKE,EACL,OAAOA,IAAM,KAAOA,EAAE,YAAY,IAAM,MAC1C,CAEA,SAASE,GAA8B,CACrC,IAAMC,EAA6B,CAAC,EAC9BC,EAAWP,EAAO,oBAAoB,GAAKA,EAAO,cAAc,EAClEO,IAAUD,EAAO,SAAWC,GAEhC,IAAMC,EAAON,EAAO,UAAU,EAC1BM,IAAS,SAAWF,EAAO,KAAOE,GAEtC,IAAMC,EAAOT,EAAO,UAAU,EAC1BS,IAAMH,EAAO,KAAOG,GAExB,IAAMC,EAAeV,EAAO,yBAAyB,EACjDU,IAAcJ,EAAO,aAAeI,GAExC,IAAMC,EAAkBX,EAAO,4BAA4B,GACvDW,IAAoB,QAAUA,IAAoB,cACpDL,EAAO,gBAAkBK,GAE3B,IAAMC,EAAWV,EAAO,mCAAmC,EACvDU,IAAa,SAAWN,EAAO,qBAAuBM,GAE1D,IAAMC,EAAWb,EAAO,eAAe,EACnCa,IAAUP,EAAO,SAAWO,GAEhC,IAAMC,EAAUV,EAAQ,8BAA8B,EAClDU,IAAY,SAAWR,EAAO,aAAeQ,GAEjD,IAAMC,EAAgBX,EAAQ,yCAAyC,EACvE,OAAIW,IAAkB,SAAWT,EAAO,mBAAqBS,GAEtDT,CACT,CAGA,eAAsBU,EACpBC,EACAC,EACoB,CAEpB,IAAIC,EAAiC,CAAC,EAChCC,EAAWvB,EAAY,MAAO,CAClC,aAAc,CACZ,iBACA,kBACA,kBACA,SACA,cACA,aACA,cACA,cACF,EACA,QAAS,CACP,OAAQ,CAACwB,EAAmBC,IAAoBxB,EAASwB,CAAO,EAChE,QAAS,CAACD,EAAmBC,IAAoBxB,EAASwB,CAAO,CACnE,CACF,CAAC,EAED,GAAI,CACF,IAAMhB,EAASY,EACX,MAAME,EAAS,KAAKF,CAAU,EAC9B,MAAME,EAAS,OAAO,EACtBd,GAAU,CAACA,EAAO,UACpBa,EAAab,EAAO,OAExB,MAAQ,CAER,CAGA,IAAMiB,EAAYlB,EAAQ,EAE1B,MAAO,CACL,GAAGN,EACH,GAAGoB,EACH,GAAGI,EACH,GAAGN,CACL,CACF,CCtHA,OACE,iBAAAO,EACA,kBAAAC,EACA,gBAAAC,EACA,uBAAAC,EACA,gBAAAC,MACK,iBACP,OAAS,eAAAC,EAAa,0BAAAC,MAA8B,4BACpD,OAAS,aAAAC,MAAiB,wBCNnB,SAASC,EACdC,EACAC,EACAC,EACM,CACN,IAAMC,EAAQ,CACZ,GACA,iBAAmBH,EACnB,GACA,cAAgBC,EAAO,SACvB,qBAAuBA,EAAO,KAAO,IAAMA,EAAO,IACpD,EAEIC,IAAc,QAChBC,EAAM,KAAK,cAAgBD,EAAY,QAAQ,EAGjDC,EAAM,KAAK,EAAE,EACbA,EAAM,KAAK,wBAAwB,EACnCA,EAAM,KAAK,EAAE,EAIb,IAAMC,EADS,KAAK,IAAI,GAAGD,EAAM,IAAKE,GAAMA,EAAE,MAAM,CAAC,EAC9B,EAEjBC,EAAK,IAAI,OAAOF,CAAK,EACrBG,EAAM,MAAQD,EAAK,IACnBE,EAAM,MAAQF,EAAK,IAEzB,QAAQ,IAAIC,CAAG,EACf,QAAWE,KAAQN,EACjB,QAAQ,IAAI,MAAQM,EAAK,OAAOL,CAAK,EAAI,GAAG,EAE9C,QAAQ,IAAII,CAAG,EACf,QAAQ,IAAI,CACd,CDzBA,eAAsBE,EACpBC,EACAC,EACe,CACf,IAAMC,EAASC,EAGTC,EAAc,IAAIC,EACtB,CACE,YAAaL,EAAO,SACpB,aAAcA,EAAO,aACrB,gBAAiBA,EAAO,eAC1B,EACAE,CACF,EACMI,EAAa,IAAIC,EAAuBH,EAAaF,CAAM,EAG3DM,EAAe,IAAIC,EAAaH,EAAYJ,CAAM,EAClDQ,EAAe,IAAIC,EAAaL,EAAYE,EAAcN,CAAM,EAChEU,EAAiB,IAAIC,EAAeP,EAAYE,EAAcN,CAAM,EACpEY,EAAsB,IAAIC,EAC9BT,EACAE,EACAN,EACAF,EAAO,oBACT,EAGMgB,EAAM,MAAMC,EAAU,CAC1B,WAAAX,EACA,aAAAE,EACA,aAAAE,EACA,eAAAE,EACA,oBAAAE,EACA,OAAAZ,CACF,CAAC,EAGD,MAAMI,EAAW,QAAQ,EAGzB,IAAIY,EACJ,GAAIlB,EAAO,aACT,GAAI,CAEFkB,GADc,MAAMV,EAAa,aAAa,GAC5B,UAAU,IAC9B,OAASW,EAAK,CACZjB,EAAO,MAAM,yBAA2B,OAAOiB,CAAG,CAAC,EAC/CnB,EAAO,oBAAoB,QAAQ,KAAK,CAAC,CAC/C,CAIF,MAAMgB,EAAI,OAAO,CAAE,KAAMhB,EAAO,KAAM,KAAMA,EAAO,IAAK,CAAC,EAGzDoB,EAAYnB,EAASD,EAAQkB,CAAS,EAGtC,IAAMG,EAAW,SAAY,CAC3BnB,EAAO,KAAK,kBAAkB,EAC9B,MAAMc,EAAI,MAAM,EAChB,MAAMF,EAAoB,MAAM,EAChC,MAAMR,EAAW,WAAW,EAC5B,QAAQ,KAAK,CAAC,CAChB,EACA,QAAQ,GAAG,SAAUe,CAAQ,EAC7B,QAAQ,GAAG,UAAWA,CAAQ,CAChC","names":["cosmiconfig","loadYaml","DEFAULTS","envStr","key","envInt","v","envBool","fromEnv","result","endpoint","port","host","securityMode","optimizedClient","interval","logLevel","preload","failOnPreload","resolveConfig","cliArgs","configPath","fileConfig","explorer","_filepath","content","envConfig","consoleLogger","HistoryService","ModelService","SubscriptionService","ValueService","OpcUaClient","OpcUaDataSourceAdapter","createApp","printBanner","version","config","nodeCount","lines","width","l","hr","top","bot","line","startServer","config","version","logger","consoleLogger","opcuaClient","OpcUaClient","dataSource","OpcUaDataSourceAdapter","modelService","ModelService","valueService","ValueService","historyService","HistoryService","subscriptionService","SubscriptionService","app","createApp","nodeCount","err","printBanner","shutdown"]}

package/i3x.config.example.yml

@@ -0,0 +1,21 @@
+# i3X configuration
+# See: npx @node-i3x/app --help
+
+# OPC UA server to connect to
+endpoint: opc.tcp://localhost:4840
+
+# REST API settings
+port: 8080
+host: 0.0.0.0
+
+# OPC UA security
+securityMode: None
+# optimizedClient: auto
+
+# Domain settings
+subscriptionInterval: 5
+modelPreload: true
+# failOnPreloadError: false
+
+# Logging
+logLevel: info

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@node-i3x/app",
+  "version": "0.1.0",
+  "description": "i3X CLI -- expose OPC UA servers as i3X REST APIs",
+  "license": "AGPL-3.0-or-later OR LicenseRef-Sterfive-Commercial",
+  "author": "Sterfive SAS <contact@sterfive.com> (https://sterfive.com)",
+  "homepage": "https://sterfive.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/node-opcua/i3x2ua-node.git",
+    "directory": "packages/app"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "i3x": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsx src/cli.ts",
+    "start": "node dist/cli.js",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@node-i3x/core": "*",
+    "@node-i3x/opcua-connector": "*",
+    "@node-i3x/rest-server": "*",
+    "commander": "^13.0.0",
+    "cosmiconfig": "^9.0.0",
+    "fastify": "^5.0.0",
+    "@fastify/cors": "^11.0.0",
+    "fastify-plugin": "^5.0.0",
+    "js-yaml": "^4.1.0",
+    "node-opcua": "^2.128.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "tsup": "^8.0.0",
+    "tsx": "^4.16.0"
+  }
+}

package/src/banner.ts

@@ -0,0 +1,38 @@
+import type { I3xConfig } from './config.js';
+
+export function printBanner(
+  version: string,
+  config: I3xConfig,
+  nodeCount?: number,
+): void {
+  const lines = [
+    '',
+    '  i3X Server v' + version,
+    '',
+    '  OPC UA:  ' + config.endpoint,
+    '  REST:    http://' + config.host + ':' + config.port,
+  ];
+
+  if (nodeCount !== undefined) {
+    lines.push('  Model:   ' + nodeCount + ' nodes');
+  }
+
+  lines.push('');
+  lines.push('  Press Ctrl+C to stop');
+  lines.push('');
+
+  // Calculate box width
+  const maxLen = Math.max(...lines.map((l) => l.length));
+  const width = maxLen + 2;
+
+  const hr = '-'.repeat(width);
+  const top = '  +' + hr + '+';
+  const bot = '  +' + hr + '+';
+
+  console.log(top);
+  for (const line of lines) {
+    console.log('  |' + line.padEnd(width) + '|');
+  }
+  console.log(bot);
+  console.log();
+}

package/src/cli.ts

@@ -0,0 +1,50 @@
+import { createRequire } from 'node:module';
+import { Command } from 'commander';
+import type { I3xConfig } from './config.js';
+import { resolveConfig } from './config.js';
+import { startServer } from './server.js';
+
+const require = createRequire(import.meta.url);
+const pkg = require('../package.json') as { version: string };
+
+const program = new Command();
+
+program
+  .name('i3x')
+  .description('Expose OPC UA servers as i3X REST APIs')
+  .version(pkg.version)
+  .option('-e, --endpoint <url>', 'OPC UA endpoint URL')
+  .option('-p, --port <port>', 'REST API port', parseInt)
+  .option('-H, --host <host>', 'REST API bind address')
+  .option('--security-mode <mode>', 'OPC UA security mode')
+  .option(
+    '--optimized-client <mode>',
+    'Optimized client: auto | disabled',
+  )
+  .option(
+    '--subscription-interval <seconds>',
+    'Subscription interval in seconds',
+    parseInt,
+  )
+  .option('--log-level <level>', 'Log level: debug | info | warn | error')
+  .option('--no-model-preload', 'Skip model preload on startup')
+  .option('-c, --config <path>', 'Path to config file')
+  .action(async (opts) => {
+    // Build partial config from CLI args
+    const cliArgs: Partial<I3xConfig> = {};
+    if (opts.endpoint) cliArgs.endpoint = opts.endpoint;
+    if (opts.port !== undefined) cliArgs.port = opts.port;
+    if (opts.host) cliArgs.host = opts.host;
+    if (opts.securityMode) cliArgs.securityMode = opts.securityMode;
+    if (opts.optimizedClient)
+      cliArgs.optimizedClient = opts.optimizedClient;
+    if (opts.subscriptionInterval !== undefined)
+      cliArgs.subscriptionInterval = opts.subscriptionInterval;
+    if (opts.logLevel) cliArgs.logLevel = opts.logLevel;
+    if (opts.modelPreload === false) cliArgs.modelPreload = false;
+
+    const config = await resolveConfig(cliArgs, opts.config);
+    await startServer(config, pkg.version);
+  });
+
+program.parse();

package/src/config.ts

@@ -0,0 +1,119 @@
+import { cosmiconfig } from 'cosmiconfig';
+import { load as loadYaml } from 'js-yaml';
+
+export interface I3xConfig {
+  endpoint: string;
+  port: number;
+  host: string;
+  securityMode: string;
+  optimizedClient: 'auto' | 'disabled';
+  subscriptionInterval: number;
+  logLevel: string;
+  modelPreload: boolean;
+  failOnPreloadError: boolean;
+}
+
+const DEFAULTS: I3xConfig = {
+  endpoint: 'opc.tcp://localhost:4840',
+  port: 8080,
+  host: '0.0.0.0',
+  securityMode: 'None',
+  optimizedClient: 'auto',
+  subscriptionInterval: 5,
+  logLevel: 'info',
+  modelPreload: true,
+  failOnPreloadError: false,
+};
+
+// ── Environment variable helpers ───────────────────────────
+function envStr(key: string): string | undefined {
+  return process.env[key];
+}
+function envInt(key: string): number | undefined {
+  const v = process.env[key];
+  return v ? parseInt(v, 10) : undefined;
+}
+function envBool(key: string): boolean | undefined {
+  const v = process.env[key];
+  if (!v) return undefined;
+  return v === '1' || v.toLowerCase() === 'true';
+}
+
+function fromEnv(): Partial<I3xConfig> {
+  const result: Partial<I3xConfig> = {};
+  const endpoint = envStr('I3X_OPCUA_ENDPOINT') ?? envStr('I3X_ENDPOINT');
+  if (endpoint) result.endpoint = endpoint;
+
+  const port = envInt('I3X_PORT');
+  if (port !== undefined) result.port = port;
+
+  const host = envStr('I3X_HOST');
+  if (host) result.host = host;
+
+  const securityMode = envStr('I3X_OPCUA_SECURITY_MODE');
+  if (securityMode) result.securityMode = securityMode;
+
+  const optimizedClient = envStr('I3X_OPCUA_OPTIMIZED_CLIENT');
+  if (optimizedClient === 'auto' || optimizedClient === 'disabled')
+    result.optimizedClient = optimizedClient;
+
+  const interval = envInt('I3X_SUBSCRIPTION_INTERVAL_SECONDS');
+  if (interval !== undefined) result.subscriptionInterval = interval;
+
+  const logLevel = envStr('I3X_LOG_LEVEL');
+  if (logLevel) result.logLevel = logLevel;
+
+  const preload = envBool('I3X_MODEL_PRELOAD_ON_STARTUP');
+  if (preload !== undefined) result.modelPreload = preload;
+
+  const failOnPreload = envBool('I3X_FAIL_STARTUP_ON_MODEL_PRELOAD_ERROR');
+  if (failOnPreload !== undefined) result.failOnPreloadError = failOnPreload;
+
+  return result;
+}
+
+// ── Config file discovery ──────────────────────────────────
+export async function resolveConfig(
+  cliArgs: Partial<I3xConfig>,
+  configPath?: string,
+): Promise<I3xConfig> {
+  // 1. Load config file (i3x.config.yml, i3x.config.json, ...)
+  let fileConfig: Partial<I3xConfig> = {};
+  const explorer = cosmiconfig('i3x', {
+    searchPlaces: [
+      'i3x.config.yml',
+      'i3x.config.yaml',
+      'i3x.config.json',
+      '.i3xrc',
+      '.i3xrc.json',
+      '.i3xrc.yml',
+      '.i3xrc.yaml',
+      'package.json',
+    ],
+    loaders: {
+      '.yml': (_filepath: string, content: string) => loadYaml(content),
+      '.yaml': (_filepath: string, content: string) => loadYaml(content),
+    },
+  });
+
+  try {
+    const result = configPath
+      ? await explorer.load(configPath)
+      : await explorer.search();
+    if (result && !result.isEmpty) {
+      fileConfig = result.config as Partial<I3xConfig>;
+    }
+  } catch {
+    // No config file found -- that's fine
+  }
+
+  // 2. Layer: defaults < config file < env vars < CLI args
+  const envConfig = fromEnv();
+
+  return {
+    ...DEFAULTS,
+    ...fileConfig,
+    ...envConfig,
+    ...cliArgs,
+  };
+}