@machinemetrics/io-adapter-lib 2.37.0 → 2.38.1

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.1]
+- Fixed 'amount' argument for count op
+
+## [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)
 

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/lib/transform/risingEdgeCounter.js

@@ -10,13 +10,13 @@ const TransformState = require('./transformState');
  * the counter will be incremented before the output value is emitted.
  */
 class RisingEdgeCounterFilter extends TransformState {
-  constructor({ engine, path, args: { mergeWindow, accum = {}, reset = {} } }) {
+  constructor({ engine, path, args: { mergeWindow, amount = {}, reset = {} } }) {
     super();
 
     this.mergeWindow = mergeWindow || 0;
     this.engine = engine;
-    this.accumExpression = accum.compiledExpression;
-    this.accumSources = engine.expressionService.expressionTriggers(`${path}.accum`);
+    this.accumExpression = amount.compiledExpression;
+    this.accumSources = engine.expressionService.expressionTriggers(`${path}.amount`);
     this.resetExpression = reset.compiledExpression;
     this.resetSources = engine.expressionService.expressionTriggers(`${path}.reset`);
 
@@ -37,12 +37,12 @@ class RisingEdgeCounterFilter extends TransformState {
       defaultAttribute: 'amount',
     });
 
-    let accum = _.get(defn.args, 'amount', defn.args.count);
-    if (!_.isUndefined(accum)) {
+    let amount = _.get(defn.args, 'amount', defn.args.count);
+    if (!_.isUndefined(amount)) {
       try {
-        const expression = accum.toString();
+        const expression = amount.toString();
         const compiledExpression = configUtil.compileExpression(expression, this.op);
-        accum = { expression, compiledExpression };
+        amount = { expression, compiledExpression };
       } catch (err) {
         configUtil.throwConfigError(`Problem evaluating expression: ${err.message}`, this.op);
       }
@@ -64,12 +64,12 @@ class RisingEdgeCounterFilter extends TransformState {
       configUtil.requirePositive(mergeWindow, 'merge-window', this.op);
     }
 
-    defn.args = { accum, reset, mergeWindow };
+    defn.args = { amount, reset, mergeWindow };
   }
 
   static getExpressions(configUtil, body, info) {
     return [
-      ...configUtil.getExpressions(body, { ...info, field: 'accum' }, true),
+      ...configUtil.getExpressions(body, { ...info, field: 'amount' }, true),
       ...configUtil.getExpressions(body, { ...info, field: 'reset' }),
     ];
   }

package/package.json

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

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/configFiles/transform/risingEdgeCounter.yml

@@ -34,3 +34,7 @@ variables:
   var7:
     - source: active
     - count: ppc
+  var8:
+    - source: active
+    - count:
+        amount: ppc

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],
+    ]);
+  });
+});

package/test/transform/risingEdgeCounter.test.js

@@ -224,4 +224,23 @@ describe('rising-edge-counter full engine config file tests', function () {
       [14, 8], [17, 10], [17, 12], [20, 14],
     ]);
   });
+
+  it('count by expression 3', function () {
+    const engine = new EngineV2(config);
+    const builder = new Builder(config);
+    builder.build(engine);
+
+    const source = testUtils.valueSource();
+    testUtils.attachEngineTransformValidator(engine, engine.variablePool.var8, source);
+
+    source.sendValue('ppc', 7, 0);
+    source.sendValues('active', [[false, 0], [true, 2], [false, 4], [true, 6]]);
+    source.sendValue('ppc', 3, 7);
+    source.sendValues('active', [[false, 8], [true, 10], [false, 12], [true, 14]]);
+
+    engine.validateFilter([
+      [0, 0], [7, 2], [7, 4], [14, 6], [14, 7],
+      [14, 8], [17, 10], [17, 12], [20, 14],
+    ]);
+  });
 });