@yarkivaev/scada 2.3.48 → 2.3.49

package/README.md

@@ -200,14 +200,18 @@ import stateDataFake from '@yarkivaev/scada/stateDataFake';
 
 ## Package boundary
 
-| This package (`@yarkivaev/scada`) | Downstream plant package |
+**Hard rule:** this package is factory-agnostic. It must not contain Sokol melting/bath domain, chem-analysis UI, HMI copy (e.g. Болото), `weight_after` fold semantics, or plant-specific sensors/routes. Those belong in `sokol-scada` (or another plant package).
+
+Opaque operation `kind` strings and generic ports (`latestForMachine`, list/upsert/stream) are allowed; never treat a kind as a first-class domain type here.
+
+| This package (`@yarkivaev/scada`) | Downstream plant package (`sokol-scada`, …) |
 |------------------------|--------------------------|
-| Generic plant, timeline, alerts, ingest | Site domain, sensors, HMI strings, tag taxonomy |
+| Generic plant, shop, machine, timeline, alerts, operations ports | Melting bath, chem, cycles HMI, site sensors |
 | Empty/injectable alert `translations` | Localized rule messages |
-| Opaque operation `kind` strings | Site-specific kinds (`sample`, `load`, …) |
-| `plantApi`, `siteServer`, `supervisorSink` | Site bins and routes |
+| Opaque operation `kind` strings | Site kinds (`bath`, `chem`, …) and fold/prefix logic |
+| `plantApi`, `siteServer`, `supervisorSink` | Site bins, routes, `bathSensor`, reports |
 | Export ports `Query` / `Stream` / `Sink` / `Job` | Export jobs + destination adapters |
-| ClickHouse + PG adapters | Plant wiring (`metricsPlant`, shops, machines) |
+| ClickHouse + PG adapters | Plant wiring (`sokolPlant` / `edgePlant`) |
 
 Depend on a pinned version (`"@yarkivaev/scada": "…#v2.3.46"`), not a local path, in downstream packages.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarkivaev/scada",
-  "version": "2.3.48",
+  "version": "2.3.49",
   "description": "SCADA domain objects, state persistence, and plant monitoring",
   "repository": {
     "type": "git",

package/src/domain/operation/operations.js

@@ -41,8 +41,8 @@ function resolveKinds(kinds, sources) {
  *
  * @example
  *   const ops = operations(store, bus, { temp: temperaturePort });
- *   await ops.listForMachine('m1', ['chem', 'temp'], { from: new Date() });
- *   await ops.latestForMachine('m1', 'chem', { to: new Date() });
+ *   await ops.listForMachine('m1', ['sample', 'temp'], { from: new Date() });
+ *   await ops.latestForMachine('m1', 'sample', { to: new Date() });
  *   await ops.remove('m1', 'nb-1');
  */
 export default function operations(persistence, bus, kindSources) {

package/src/infrastructure/client/machineClient.js

@@ -48,7 +48,7 @@ function rangeQuery(options) {
  * @example
  *   const machine = machineClient(baseUrl, 'm1', fetch, EventSource, logger);
  *   const info = await machine.info();
- *   await machine.createOperation({ kind: 'bath', payload: { action: 'load' } });
+ *   await machine.createOperation({ kind: 'load', payload: { action: 'add' } });
  *   await machine.updateOperation(key, { payload: { action: 'load' } });
  *   await machine.deleteOperation(key);
  */

package/src/infrastructure/client/machineOperationsClient.js

@@ -121,7 +121,7 @@ function deleteRequest(request, key, fields) {
  *
  * @example
  *   const ops = machineOperationsClient(baseUrl, request, EventSource, logger);
- *   await ops.createOperation({ kind: 'bath', payload: {}, operatorId: 2 });
+ *   await ops.createOperation({ kind: 'load', payload: {}, operatorId: 2 });
  *   await ops.operationDecisions(key);
  */
 export default function machineOperationsClient(baseUrl, request, eventSource, logger) {

package/src/infrastructure/http/plant/json/operationJson.js

@@ -12,7 +12,7 @@ function iso(value) {
  * @returns {object} API item with external_key and source_updated_at
  *
  * @example
- *   operationJson({ key: 'nb-1', occurred_at: new Date(), kind: 'chem', payload: {}, machine: 'm1' });
+ *   operationJson({ key: 'nb-1', occurred_at: new Date(), kind: 'sample', payload: {}, machine: 'm1' });
  */
 export default function operationJson(row) {
     const occurred = iso(row.occurred_at);

package/src/infrastructure/messaging/ownership/httpOperations.js

@@ -45,7 +45,7 @@ async function readJson(res) {
  *
  * @example
  *   const port = httpOperations({ baseUrl: 'http://edge/api/v1' }, 'm2');
- *   await port.create({ kind: 'bath', payload: {}, operatorId: 2 });
+ *   await port.create({ kind: 'load', payload: {}, operatorId: 2 });
  */
 export default function httpOperations(site, machineId) {
     const base = trimBase(site.baseUrl);

package/src/infrastructure/persistence/pg/operations.js

@@ -101,8 +101,8 @@ async function removeOperation(pool, machineId, key) {
  *
  * @example
  *   const store = operationStatePg(pool);
- *   await store.upsert({ machine: 'm1', key: 'nb-1', kind: 'chem', ... });
- *   await store.latestForMachine('m1', 'chem', { to: new Date() });
+ *   await store.upsert({ machine: 'm1', key: 'nb-1', kind: 'sample', ... });
+ *   await store.latestForMachine('m1', 'sample', { to: new Date() });
  *   await store.remove('m1', 'nb-1');
  */
 export default function operationStatePg(pool) {

package/src/infrastructure/persistence/pg/userDecisions.js

@@ -12,7 +12,7 @@
  *   const catalog = userDecisionsFromPg(pool);
  *   await catalog.insert({
  *     machine: 'm1', startTime: new Date(), username: 'Ivan',
- *     decidedAt: new Date(), payload: { kind: 'operation_op', verb: 'create', key: 'bath:m1:1' }
+ *     decidedAt: new Date(), payload: { kind: 'operation_op', verb: 'create', key: 'op:m1:1' }
  *   });
  */
 function mapRow(row) {

package/src/infrastructure/sync/operationCodec.js

@@ -55,8 +55,8 @@ async function decode(parsed, collector) {
  *
  * @example
  *   const codec = operationCodec(collector);
- *   await codec.accept(Buffer.from('{"machine":"m1","occurred_at":"2024-06-01T10:00:00.000Z","kind":"chem","external_key":"nb-1","payload":{}}'));
- *   await codec.accept(Buffer.from('{"type":"deleted","machine":"m1","occurred_at":"2024-06-01T10:00:00.000Z","kind":"bath","external_key":"k"}'));
+ *   await codec.accept(Buffer.from('{"machine":"m1","occurred_at":"2024-06-01T10:00:00.000Z","kind":"sample","external_key":"nb-1","payload":{}}'));
+ *   await codec.accept(Buffer.from('{"type":"deleted","machine":"m1","occurred_at":"2024-06-01T10:00:00.000Z","kind":"load","external_key":"k"}'));
  */
 export default function operationCodec(collector) {
     if (!collector || typeof collector.accept !== 'function') {

package/src/infrastructure/sync/operationSyncSink.js

@@ -8,8 +8,8 @@ import processingErrorLog from '../ingest/processingErrorLog.js';
  *
  * @example
  *   const sink = operationSyncSink(dataAccess.operations);
- *   await sink.accept({ machine: 'm1', occurred_at: new Date(), kind: 'chem', key: 'nb-1', payload: {} });
- *   await sink.remove({ machine: 'm1', kind: 'chem', key: 'nb-1', occurred_at: new Date() });
+ *   await sink.accept({ machine: 'm1', occurred_at: new Date(), kind: 'sample', key: 'nb-1', payload: {} });
+ *   await sink.remove({ machine: 'm1', kind: 'sample', key: 'nb-1', occurred_at: new Date() });
  */
 export default function operationSyncSink(operations) {
     return {