@machinemetrics/io-adapter-lib 2.36.0 → 2.38.0

package/.circleci/config.yml

@@ -27,31 +27,45 @@ jobs:
             - lib
             - index.js
             - package.json
-  
+
+  # Publish jobs use npm trusted publishing (OIDC): no stored NPM token.
+  # npm >= 11.5.1 reads NPM_ID_TOKEN and exchanges it for a short-lived publish
+  # token. Provenance is not generated on CircleCI, and is unavailable for
+  # private repos regardless of CI provider.
   publish:
     docker:
-      - image: cimg/node:22.13.1
+      - image: cimg/node:22.14
     steps:
       - checkout
       - attach_workspace:
           at: .
+      - run:
+          name: Update npm for trusted publishing
+          command: sudo npm install -g npm@latest
       - run:
           name: Publish to NPM
           command: |
-            echo "//registry.npmjs.org/:_authToken=${NPM_PUBLISH_TOKEN}" > .npmrc
+            echo "node $(node --version) / npm $(npm --version)"
+            export NPM_ID_TOKEN="$(circleci run oidc get --claims '{"aud": "npm:registry.npmjs.org"}')"
+            test -n "$NPM_ID_TOKEN" || { echo "ERROR: empty OIDC token (NPM_ID_TOKEN) — cannot use trusted publishing"; exit 1; }
             npm publish --access public
 
   publish-beta:
     docker:
-      - image: cimg/node:22.13.1
+      - image: cimg/node:22.14
     steps:
       - checkout
       - attach_workspace:
           at: .
+      - run:
+          name: Update npm for trusted publishing
+          command: sudo npm install -g npm@latest
       - run:
           name: Publish Beta to NPM
           command: |
-            echo "//registry.npmjs.org/:_authToken=${NPM_PUBLISH_TOKEN}" > .npmrc
+            echo "node $(node --version) / npm $(npm --version)"
+            export NPM_ID_TOKEN="$(circleci run oidc get --claims '{"aud": "npm:registry.npmjs.org"}')"
+            test -n "$NPM_ID_TOKEN" || { echo "ERROR: empty OIDC token (NPM_ID_TOKEN) — cannot use trusted publishing"; exit 1; }
             npm publish --access public --tag beta
 
   validate-version:

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [2.38.0]
+- Added object-keys and object-values transforms
+
+## [2.37.0]
+- Brother config changes in support of d00 (c00<->d00 may not be the exact cutoff)
+
 ## [2.36.0]
 - Added if / else-if / else branch transform
 

package/lib/config/device/brotherHTTPConfig.js

@@ -16,7 +16,10 @@ class BrotherHTTPConfig {
     };
 
     const mode = expressionService.config['collection-mode'];
-    const defaultMode = this.DataCollectionModes.MIXED;
+    const deviceName = expressionService.config.device;
+    const defaultMode = deviceName === 'brother-ftp'
+      ? this.DataCollectionModes.FTP
+      : this.DataCollectionModes.MIXED;
     if (mode === undefined) this.dataCollectionMode = defaultMode;
     else if (mode.toLowerCase() === 'http') this.dataCollectionMode = this.DataCollectionModes.HTTP;
     else if (mode.toLowerCase() === 'ftp') this.dataCollectionMode = this.DataCollectionModes.FTP;
@@ -141,15 +144,23 @@ class BrotherHTTPConfig {
 
     /** Configuration indicates how to collect data:
     *  HTTP only,
-    *  FTP only (default),
+    *  FTP only (default for device brother-ftp),
     *  HTTP + FTP for program headers
     */
-    let mode = config['collection-mode'] ?? '';
-    if (_.isString(mode)) {
-      mode = mode.toLowerCase();
+    const isBrotherFtp = config.device === 'brother-ftp';
+    let mode = config['collection-mode'];
+    if (mode === undefined || mode === null || mode === '') {
+      mode = isBrotherFtp ? 'ftp' : '';
+    }
+    if (!_.isString(mode)) {
+      throw new ConfigError('collection-mode must be a string').atAttribute('collection-mode');
+    }
+    mode = mode.toLowerCase();
+    if (isBrotherFtp && mode !== 'ftp') {
+      throw new ConfigError('device brother-ftp requires collection-mode ftp').atAttribute('collection-mode');
     }
     if (!_.includes(['http', 'ftp', 'mixed'], mode)) {
-      throw new ConfigError('collection-mode must be one of: {http, ftp, mixed}').atAttribute('macros');
+      throw new ConfigError('collection-mode must be one of: {http, ftp, mixed}').atAttribute('collection-mode');
     }
 
     let keysThatAlreadyExist = '';
@@ -191,6 +202,36 @@ class BrotherHTTPConfig {
         throw new ConfigError(`The value of macros key ${key} must be a valid integer`).atAttribute(key);
       }
     });
+
+    this.assignOptionalRelativePath(config, 'memory-path', 'memoryPath');
+    this.assignOptionalRelativePath(config, 'production-path', 'productionPath');
+    this.assignOptionalRelativePath(config, 'panel-path', 'panelPath');
+    this.assignOptionalRelativePath(config, 'position-path', 'positionPath');
+    this.assignOptionalRelativePath(config, 'work-counter-path', 'workCounterPath');
+    this.assignOptionalRelativePath(config, 'alarm-path', 'alarmPath');
+    this.assignOptionalRelativePath(config, 'macro-path', 'macroPath');
+
+    if (_.has(config, 'cnc-version')) {
+      const cncVersion = config['cnc-version'];
+      if (cncVersion !== 'legacy' && cncVersion !== 'd00') {
+        throw new ConfigError('cnc-version must be one of: legacy, d00').atAttribute('cnc-version');
+      }
+      this.cncVersion = cncVersion;
+    }
+  }
+
+  assignOptionalRelativePath(config, yamlKey, propertyName) {
+    if (!_.has(config, yamlKey)) {
+      return;
+    }
+    const value = config[yamlKey];
+    if (!_.isString(value) || value.trim() === '') {
+      throw new ConfigError(`${yamlKey} must be a non-empty string`).atAttribute(yamlKey);
+    }
+    if (value.includes('..')) {
+      throw new ConfigError(`${yamlKey} must not contain '..'`).atAttribute(yamlKey);
+    }
+    this[propertyName] = value;
   }
 
   checkScanInterval(config) {

package/lib/config/index.js

@@ -204,6 +204,7 @@ class Config {
         return new OPCUAConfig(expressionService);
       case 'brother':
       case 'brother-http':
+      case 'brother-ftp':
         return new BrotherHTTPConfig(expressionService);
       case 'adam-6052':
         return new AdamConfig(expressionService);
@@ -315,6 +316,7 @@ class Config {
       'opc-ua',
       'brother',
       'brother-http',
+      'brother-ftp',
       'adam-6052',
       'mtconnect',
       'mtconnect-haas',

package/lib/transform/index.js

@@ -21,6 +21,8 @@ const MaxFilter = require('./max');
 const MaxLengthFilter = require('./maxLength');
 const MinDeltaFilter = require('./minDelta');
 const MinFilter = require('./min');
+const ObjectKeysFilter = require('./objectKeys');
+const ObjectValuesFilter = require('./objectValues');
 const OffDelayFilter = require('./offDelay');
 const OnDelayFilter = require('./onDelay');
 const PatternEscapeFilter = require('./patternEscape');
@@ -68,6 +70,8 @@ module.exports = {
   maxLength: MaxLengthFilter,
   min: MinFilter,
   minDelta: MinDeltaFilter,
+  objectKeys: ObjectKeysFilter,
+  objectValues: ObjectValuesFilter,
   offDelay: OffDelayFilter,
   onDelay: OnDelayFilter,
   patternEscape: PatternEscapeFilter,

package/lib/transform/objectKeys.js

@@ -0,0 +1,28 @@
+'use strict';
+
+const _ = require('lodash');
+const TransformState = require('./transformState');
+
+/**
+ * Returns the keys of an object sample.  Arrays return their numeric indexes;
+ * other values pass through unchanged.
+ */
+class ObjectKeysFilter extends TransformState {
+  static op = 'object-keys';
+
+  static create(_args) {
+    return new ObjectKeysFilter();
+  }
+
+  filter(context, value, time) {
+    if (_.isArray(value)) {
+      this.commitValue(context, _.range(value.length), time);
+    } else if (_.isObject(value)) {
+      this.commitValue(context, Object.keys(value), time);
+    } else {
+      this.commitValue(context, value, time);
+    }
+  }
+}
+
+module.exports = ObjectKeysFilter;

package/lib/transform/objectValues.js

@@ -0,0 +1,28 @@
+'use strict';
+
+const _ = require('lodash');
+const TransformState = require('./transformState');
+
+/**
+ * Returns the values of an object sample.  Arrays pass through unchanged;
+ * other non-object values also pass through unchanged.
+ */
+class ObjectValuesFilter extends TransformState {
+  static op = 'object-values';
+
+  static create(_args) {
+    return new ObjectValuesFilter();
+  }
+
+  filter(context, value, time) {
+    if (_.isArray(value)) {
+      this.commitValue(context, value, time);
+    } else if (_.isObject(value)) {
+      this.commitValue(context, Object.values(value), time);
+    } else {
+      this.commitValue(context, value, time);
+    }
+  }
+}
+
+module.exports = ObjectValuesFilter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@machinemetrics/io-adapter-lib",
-  "version": "2.36.0",
+  "version": "2.38.0",
   "description": "Configuration and engine implementation for MachineMetrics AdapterScripts and adapters",
   "main": "index.js",
   "license": "UNLICENSED",

package/test/config/brother-ftp.test.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const expect = require('chai').expect;
+const ConfigError = require('../../lib/config/configError');
+const testUtils = require('../util/testUtils');
+
+describe('Brother FTP device config', function () {
+  it('accepts brother-ftp without collection-mode (defaults to ftp)', async function () {
+    const cfg = await testUtils.loadConfig('device/brother-ftp-minimal.yml');
+    expect(cfg.deviceName).to.eq('brother-ftp');
+    expect(cfg.device.dataCollectionMode).to.eq(cfg.device.DataCollectionModes.FTP);
+  });
+
+  it('passes through optional FTP paths and cnc-version', async function () {
+    const cfg = await testUtils.loadConfig('device/brother-ftp-paths.yml');
+    expect(cfg.device.cncVersion).to.eq('d00');
+    expect(cfg.device.memoryPath).to.eq('_DAT/MEM.NC');
+    expect(cfg.device.productionPath).to.eq('_PRD/PRDD2.NC');
+    expect(cfg.device.panelPath).to.eq('_DAT/PANEL.NC');
+    expect(cfg.device.positionPath).to.eq('_DAT/PDSP.NC');
+    expect(cfg.device.workCounterPath).to.eq('_DAT/WKCNTR.NC');
+    expect(cfg.device.alarmPath).to.eq('_DAT/ALARM.NC');
+    expect(cfg.device.macroPath).to.eq('_DAT/MCRNI1.NC');
+  });
+
+  it('does not set path properties when keys are omitted', async function () {
+    const cfg = await testUtils.loadConfig('device/brother-ftp-minimal.yml');
+    expect(cfg.device.memoryPath).to.eq(undefined);
+    expect(cfg.device.cncVersion).to.eq(undefined);
+  });
+
+  it('accepts cnc-version legacy', async function () {
+    const cfg = await testUtils.loadConfig('device/brother-ftp-cnc-legacy.yml');
+    expect(cfg.device.cncVersion).to.eq('legacy');
+  });
+
+  it('rejects invalid cnc-version', async function () {
+    try {
+      await testUtils.loadConfig('device/brother-ftp-bad-cnc.yml');
+      expect.fail('Expected ConfigError');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+    }
+  });
+
+  it('rejects paths containing ..', async function () {
+    try {
+      await testUtils.loadConfig('device/brother-ftp-bad-path.yml');
+      expect.fail('Expected ConfigError');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+    }
+  });
+
+  it('rejects brother-ftp with non-ftp collection-mode', async function () {
+    try {
+      await testUtils.loadConfig('device/brother-ftp-bad-mode.yml');
+      expect.fail('Expected ConfigError');
+    } catch (err) {
+      expect(err).to.be.instanceof(ConfigError);
+    }
+  });
+});

package/test/config/brother-http.test.js

@@ -15,5 +15,7 @@ describe('Brother HTTP config tests', function () {
     expect(defaultConfig.device.port).to.eq(21);
     expect(defaultConfig.device.scanInterval).to.eq(1000);
     expect(defaultConfig.device.httpInterval).to.eq(50);
+    expect(defaultConfig.device.memoryPath).to.eq(undefined);
+    expect(defaultConfig.device.cncVersion).to.eq(undefined);
   });
 });

package/test/configFiles/device/brother-ftp-bad-cnc.yml

@@ -0,0 +1,3 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+cnc-version: bogus

package/test/configFiles/device/brother-ftp-bad-mode.yml

@@ -0,0 +1,3 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+collection-mode: http

package/test/configFiles/device/brother-ftp-bad-path.yml

@@ -0,0 +1,3 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+memory-path: _DAT/../MEM.NC

package/test/configFiles/device/brother-ftp-cnc-legacy.yml

@@ -0,0 +1,3 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+cnc-version: legacy

package/test/configFiles/device/brother-ftp-minimal.yml

@@ -0,0 +1,2 @@
+device: brother-ftp
+endpoint: 192.168.1.50

package/test/configFiles/device/brother-ftp-paths.yml

@@ -0,0 +1,11 @@
+device: brother-ftp
+endpoint: 192.168.1.50
+collection-mode: ftp
+cnc-version: d00
+memory-path: _DAT/MEM.NC
+production-path: _PRD/PRDD2.NC
+panel-path: _DAT/PANEL.NC
+position-path: _DAT/PDSP.NC
+work-counter-path: _DAT/WKCNTR.NC
+alarm-path: _DAT/ALARM.NC
+macro-path: _DAT/MCRNI1.NC

package/test/configFiles/repro/active-condition-codes-repro.yml

@@ -0,0 +1,15 @@
+version: 2
+device: mtconnect-adapter
+endpoint: localhost:8001
+mtconnect-port: 8002
+declare-keys:
+  - cond1:
+      type: condition
+variables:
+  activeCodes:
+    - source: cond1
+    - object-values
+    - reject:
+        expression: this.level != 'FAULT' and this.level != 'WARNING'
+    - map:
+      - expression: this.code

package/test/configFiles/transform/object-keys.yml

@@ -0,0 +1,14 @@
+version: 2
+device: mtconnect-adapter
+endpoint: localhost:8001
+mtconnect-port: 8002
+declare-keys:
+  - obj
+  - arr
+variables:
+  objKeys:
+    - source: obj
+    - object-keys
+  arrKeys:
+    - source: arr
+    - object-keys

package/test/configFiles/transform/object-values.yml

@@ -0,0 +1,14 @@
+version: 2
+device: mtconnect-adapter
+endpoint: localhost:8001
+mtconnect-port: 8002
+declare-keys:
+  - obj
+  - arr
+variables:
+  objValues:
+    - source: obj
+    - object-values
+  arrValues:
+    - source: arr
+    - object-values

package/test/repro/active-condition-codes-repro.test.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const EngineV2 = require('../../lib/engine/engineV2');
+const Builder = require('../../lib/engine/transformBuilderV2');
+const testUtils = require('../util/testUtils');
+
+describe('repro active condition codes via object-values pipeline', async function () {
+  let config;
+  before(async () => {
+    config = await testUtils.loadConfig('repro/active-condition-codes-repro.yml');
+  });
+
+  it('emits the list of FAULT/WARNING codes as the condition table evolves', function () {
+    const engine = new EngineV2(config);
+    const builder = new Builder(config);
+    builder.build(engine);
+
+    const source = testUtils.mtconnectSource(config.device.keys);
+    testUtils.attachEngineTransformValidator(engine, engine.variablePool.activeCodes, source);
+
+    source.sendCondition('cond1', { level: 'NORMAL' }, 0);
+    source.sendCondition('cond1', { code: 'X01', level: 'WARNING', message: 'W X01' }, 1000);
+    source.sendCondition('cond1', { code: 'X02', level: 'FAULT', message: 'F X02' }, 2000);
+    source.sendCondition('cond1', { code: 'X01', level: 'NORMAL' }, 3000);
+    source.sendCondition('cond1', { code: 'X01', level: 'FAULT', message: 'F X01' }, 4000);
+    source.sendCondition('cond1', { level: 'UNAVAILABLE' }, 5000);
+    source.sendCondition('cond1', { code: 'X02', level: 'WARNING', message: 'W X02' }, 6000);
+    source.sendCondition('cond1', { level: 'UNAVAILABLE' }, 7000);
+
+    engine.validateFilter([
+      [[], 0],
+      [['X01'], 1],
+      [['X01', 'X02'], 2],
+      [['X02'], 3],
+      [['X01', 'X02'], 4],
+      [[], 5],
+      [['X02'], 6],
+      [[], 7],
+    ]);
+  });
+});

package/test/transform/objectKeys.test.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const EngineV2 = require('../../lib/engine/engineV2');
+const Builder = require('../../lib/engine/transformBuilderV2');
+const ObjectKeys = require('../../lib/transform').objectKeys;
+const testUtils = require('../util/testUtils');
+
+describe('object-keys transform tests', function () {
+  it('returns keys for objects', async function () {
+    await testUtils.testValue(new ObjectKeys(), { a: 1, b: 2 }, ['a', 'b']);
+    await testUtils.testValue(new ObjectKeys(), { x: 'hello', y: 'world', z: '!' }, ['x', 'y', 'z']);
+    await testUtils.testValue(new ObjectKeys(), {}, []);
+  });
+
+  it('returns indexes for arrays', async function () {
+    await testUtils.testValue(new ObjectKeys(), ['a', 'b', 'c'], [0, 1, 2]);
+    await testUtils.testValue(new ObjectKeys(), [10, 20], [0, 1]);
+    await testUtils.testValue(new ObjectKeys(), [], []);
+  });
+
+  it('passes through non-object values', async function () {
+    await testUtils.testValue(new ObjectKeys(), 42, 42);
+    await testUtils.testValue(new ObjectKeys(), 'hello', 'hello');
+    await testUtils.testValue(new ObjectKeys(), null, null);
+  });
+});
+
+describe('object-keys full engine config file tests', function () {
+  let config;
+  before(async () => {
+    config = await testUtils.loadConfig('transform/object-keys.yml');
+  });
+
+  it('returns keys for objects', function () {
+    const engine = new EngineV2(config);
+    const builder = new Builder(config);
+    builder.build(engine);
+
+    const source = testUtils.valueSource();
+    testUtils.attachEngineTransformValidator(engine, engine.variablePool.objKeys, source);
+
+    source.sendValue('obj', { a: 1, b: 2, c: 3 }, 0);
+
+    engine.validateFilter([
+      [['a', 'b', 'c'], 0],
+    ]);
+  });
+
+  it('returns indexes for arrays', function () {
+    const engine = new EngineV2(config);
+    const builder = new Builder(config);
+    builder.build(engine);
+
+    const source = testUtils.valueSource();
+    testUtils.attachEngineTransformValidator(engine, engine.variablePool.arrKeys, source);
+
+    source.sendValue('arr', ['x', 'y', 'z'], 0);
+
+    engine.validateFilter([
+      [[0, 1, 2], 0],
+    ]);
+  });
+});

package/test/transform/objectValues.test.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const EngineV2 = require('../../lib/engine/engineV2');
+const Builder = require('../../lib/engine/transformBuilderV2');
+const ObjectValues = require('../../lib/transform').objectValues;
+const testUtils = require('../util/testUtils');
+
+describe('object-values transform tests', function () {
+  it('returns values for objects', async function () {
+    await testUtils.testValue(new ObjectValues(), { a: 1, b: 2 }, [1, 2]);
+    await testUtils.testValue(new ObjectValues(), { x: 'hello', y: 'world', z: '!' }, ['hello', 'world', '!']);
+    await testUtils.testValue(new ObjectValues(), {}, []);
+  });
+
+  it('returns array itself for arrays', async function () {
+    await testUtils.testValue(new ObjectValues(), ['a', 'b', 'c'], ['a', 'b', 'c']);
+    await testUtils.testValue(new ObjectValues(), [10, 20], [10, 20]);
+    await testUtils.testValue(new ObjectValues(), [], []);
+  });
+
+  it('passes through non-object values', async function () {
+    await testUtils.testValue(new ObjectValues(), 42, 42);
+    await testUtils.testValue(new ObjectValues(), 'hello', 'hello');
+    await testUtils.testValue(new ObjectValues(), null, null);
+  });
+});
+
+describe('object-values full engine config file tests', function () {
+  let config;
+  before(async () => {
+    config = await testUtils.loadConfig('transform/object-values.yml');
+  });
+
+  it('returns values for objects', function () {
+    const engine = new EngineV2(config);
+    const builder = new Builder(config);
+    builder.build(engine);
+
+    const source = testUtils.valueSource();
+    testUtils.attachEngineTransformValidator(engine, engine.variablePool.objValues, source);
+
+    source.sendValue('obj', { a: 1, b: 2, c: 3 }, 0);
+
+    engine.validateFilter([
+      [[1, 2, 3], 0],
+    ]);
+  });
+
+  it('returns the array itself for arrays', function () {
+    const engine = new EngineV2(config);
+    const builder = new Builder(config);
+    builder.build(engine);
+
+    const source = testUtils.valueSource();
+    testUtils.attachEngineTransformValidator(engine, engine.variablePool.arrValues, source);
+
+    source.sendValue('arr', ['x', 'y', 'z'], 0);
+
+    engine.validateFilter([
+      [['x', 'y', 'z'], 0],
+    ]);
+  });
+});