@aryacode/dsh-engineering 0.4.5 → 0.4.7

package/vendor/l5x/lib/engine/cip-request.js

@@ -0,0 +1,134 @@
+/**
+ * Validation for one-shot controller transactions.
+ *
+ * Nothing here opens a socket. Every argument is resolved against the open
+ * export first, so a mistyped tag, an alias, an array or a type-mismatched write
+ * is refused before the controller is contacted.
+ *
+ * @module dsh-engineering-l5x/engine/cip-request
+ */
+import { isIPv4 } from 'node:net';
+import { EngineeringError } from "../session.js";
+import { aliasesOf } from "./configuration.js";
+import { findReferences } from "./analysis.js";
+import { controllerElementOf } from "../model/parse.js";
+import { elementChildren, firstChild } from "../model/xml.js";
+/** Scalar types this surface can read and write. */
+const SCALARS = ['BOOL', 'INT', 'DINT', 'REAL'];
+/** Integer ranges enforced before a write leaves the machine. */
+const RANGES = { INT: [-32768, 32767], DINT: [-2147483648, 2147483647] };
+const isScalar = (value) => typeof value === 'string' && SCALARS.includes(value);
+/**
+ * Resolve the controller address and slot both read and write share.
+ * @param input - Tool arguments.
+ * @param config - Resolved deployment limits.
+ * @returns The validated target.
+ */
+export function controllerTarget(input, config) {
+    if (!config.enabled)
+        throw new EngineeringError('DIRECT_POLLING_DISABLED', 'Enable directPollingEnabled to use SDK-independent reads');
+    const ip = input.ip_address;
+    if (typeof ip !== 'string' || !isIPv4(ip) || (config.allowedAddresses.length > 0 && !config.allowedAddresses.includes(ip)))
+        throw new EngineeringError('INVALID_CONTROLLER', 'Select an explicit IPv4 address allowed by this profile');
+    const slot = input.slot ?? 0;
+    if (typeof slot !== 'number' || !Number.isInteger(slot) || slot < 0 || slot > 31)
+        throw new EngineeringError('INVALID_POLL', 'slot must be an integer between 0 and 31');
+    return { ip, slot, timeout: config.requestTimeoutMs };
+}
+/**
+ * Resolve declared scalar tags for a batch read, then bound the batch.
+ * @param project - Fresh export snapshot.
+ * @param input - Tool arguments carrying `tags`.
+ * @param config - Resolved deployment limits.
+ * @param maxBatch - Largest accepted batch.
+ * @returns Worker request and operand evidence.
+ */
+export function batchReadRequest(project, input, config, maxBatch) {
+    const target = controllerTarget(input, config);
+    const raw = typeof input.tags_json === 'string' ? JSON.parse(input.tags_json) : null;
+    if (!Array.isArray(raw) || raw.length < 1 || raw.length > maxBatch)
+        throw new EngineeringError('INVALID_POLL', `tags must contain 1 through ${String(maxBatch)} declared scalar tags`);
+    const tags = raw.map((entry) => resolveScalar(project, entry));
+    const seen = new Set();
+    for (const tag of tags) {
+        const key = `${tag.program ?? 'controller'}::${tag.name}`.toLowerCase();
+        if (seen.has(key))
+            throw new EngineeringError('INVALID_POLL', 'Duplicate tag in the batch');
+        seen.add(key);
+    }
+    return {
+        request: { op: 'read', ...target, tags },
+        evidence: tags.map(tag => ({
+            tag: tag.name,
+            scope: tag.program ?? 'controller',
+            references: findReferences(project, tag.name)
+                .filter(reference => reference.resolved?.toLowerCase() === `${tag.program ?? 'controller'}::${tag.name}`.toLowerCase()),
+            reference_completeness: 'static_partial',
+        })),
+    };
+}
+/**
+ * Resolve one writable scalar and check the value against its declared type.
+ * @param project - Fresh export snapshot.
+ * @param input - Tool arguments carrying `name`, optional `program`, and `value`.
+ * @param config - Resolved deployment limits.
+ * @returns The validated worker request.
+ */
+export function writableTagRequest(project, input, config) {
+    const target = controllerTarget(input, config);
+    const name = input.name;
+    const program = input.program;
+    const tag = resolveScalar(project, { name, ...(program === undefined ? {} : { scope: program }) });
+    const value = input.value;
+    if (tag.data_type === 'BOOL') {
+        if (typeof value !== 'boolean')
+            throw new EngineeringError('INVALID_WRITE', `${tag.name} is BOOL; value must be true or false`, 'Pass value: true or value: false.');
+    }
+    else if (typeof value !== 'number' || !Number.isFinite(value)) {
+        throw new EngineeringError('INVALID_WRITE', `${tag.name} is ${tag.data_type}; value must be a finite number`, 'Pass a number for INT, DINT or REAL.');
+    }
+    else if (tag.data_type !== 'REAL') {
+        const [min, max] = RANGES[tag.data_type];
+        if (!Number.isInteger(value) || value < min || value > max)
+            throw new EngineeringError('INVALID_WRITE', `${tag.name} is ${tag.data_type}; value must be an integer between ${String(min)} and ${String(max)}`, 'Use whole numbers inside the declared range.');
+    }
+    return { request: { op: 'write', ...target, tag, value } };
+}
+/**
+ * Bound a discovery window.
+ * @param input - Tool arguments carrying optional `duration_seconds`.
+ * @param config - Resolved deployment limits.
+ * @returns Worker request with the window in milliseconds.
+ */
+export function discoverRequest(input, config) {
+    if (!config.enabled)
+        throw new EngineeringError('DIRECT_POLLING_DISABLED', 'Enable directPollingEnabled to use controller discovery');
+    const seconds = input.duration_seconds ?? 3;
+    if (typeof seconds !== 'number' || !Number.isInteger(seconds) || seconds < 1 || seconds > 15)
+        throw new EngineeringError('INVALID_POLL', 'duration_seconds must be an integer between 1 and 15');
+    return { request: { op: 'discover', duration: seconds * 1000, timeout: config.requestTimeoutMs } };
+}
+/** Resolve one declared scalar (never an alias, array or unknown tag). */
+function resolveScalar(project, entry) {
+    if (!entry || typeof entry !== 'object' || !('name' in entry) || typeof entry.name !== 'string'
+        || !/^[A-Za-z_][A-Za-z0-9_]*$/u.test(entry.name)
+        || !Object.keys(entry).every(key => key === 'name' || key === 'scope'))
+        throw new EngineeringError('UNSUPPORTED_WRITE_TAG', 'Each tag needs an exact scalar name and optional scope only');
+    const scope = 'scope' in entry ? entry.scope : 'controller';
+    if (typeof scope !== 'string' || (scope !== 'controller' && !/^[A-Za-z_][A-Za-z0-9_]*$/u.test(scope)))
+        throw new EngineeringError('INVALID_POLL', 'scope must be controller or an exact program name');
+    const declared = project.document.tags.find(tag => tag.name === entry.name && tag.scope === scope);
+    const controller = controllerElementOf(project.document);
+    const programs = firstChild(controller, 'Programs');
+    const container = scope === 'controller' ? controller : programs === undefined ? undefined
+        : elementChildren(programs, 'Program').find(program => program.attrs.Name === scope);
+    const tagContainer = container === undefined ? undefined : firstChild(container, 'Tags');
+    const declaration = tagContainer === undefined ? undefined : elementChildren(tagContainer, 'Tag').find(tag => tag.attrs.Name === entry.name);
+    const dimensions = declaration?.attrs.Dimensions ?? declaration?.attrs.Dimension ?? '';
+    if (!declared || aliasesOf(project.document).has(`${scope}::${declared.name}`)
+        || !isScalar(declared.dataType)
+        || (dimensions !== '' && dimensions !== '0')
+        || declaration?.attrs.ExternalAccess === 'None')
+        throw new EngineeringError('UNSUPPORTED_WRITE_TAG', `${String(entry.name)} is not a writable declared scalar BOOL, INT, DINT or REAL`, 'Reads accept the same tags; writes additionally need ExternalAccess and no array dimensions.');
+    return { name: declared.name, ...(scope === 'controller' ? {} : { program: scope }), data_type: declared.dataType };
+}

package/vendor/l5x/lib/engine/cip-transaction.d.ts

@@ -0,0 +1,115 @@
+/**
+ * One-shot EtherNet/IP transactions: batch reads, identity/clock, writes and
+ * discovery, each in its own worker so a hung socket cannot hold the host.
+ *
+ * Reads are the normal case. Writes are only ever reached through a tool that
+ * has already asked a human for this exact operation, and every write result is
+ * the readback the controller returned, never an assumption that it worked.
+ *
+ * @module dsh-engineering-l5x/engine/cip-transaction
+ */
+/** One observed value from a batch read. */
+export interface CipValue {
+    tag: string;
+    data_type: string;
+    actual_data_type?: string;
+    value: boolean | number | null;
+    quality: 'good' | 'bad';
+    observed_at: string;
+    error?: string;
+}
+/** Controller identity as CIP reports it. */
+export interface CipIdentity {
+    product_name: string;
+    serial_number: number;
+    revision: string;
+    status: number;
+}
+/** Result of the batch read. */
+export interface CipReadResult {
+    controller: CipIdentity;
+    request_count: number;
+    observed_at: string;
+    values: CipValue[];
+}
+/** Result of the clock read. */
+export interface CipClockResult {
+    controller: CipIdentity;
+    supported: boolean;
+    controller_time?: string;
+    host_time: string;
+    reason?: string;
+}
+/** Result of one tag write. */
+export interface CipWriteResult {
+    tag: string;
+    declared_data_type: string;
+    actual_data_type?: string;
+    previous_value: boolean | number | null;
+    requested_value: boolean | number;
+    readback: boolean | number | null;
+    verified: boolean;
+    written_at: string;
+}
+/** Result of a wall-clock write. */
+export interface CipWriteClockResult {
+    requested_time: string;
+    readback: string;
+    verified: boolean;
+}
+/** One discovered device. */
+export interface CipDevice {
+    ip_address: string;
+    product_name: string;
+    revision: string;
+    serial_number: string;
+    vendor_id: number;
+    device_type: number;
+    status: number;
+}
+/** Result of discovery. */
+export interface CipDiscoverResult {
+    seconds: number;
+    devices: CipDevice[];
+}
+/** Validate a batch-read result. */
+export declare function decodeReadResult(value: unknown): CipReadResult;
+/** Validate a clock result. */
+export declare function decodeClockResult(value: unknown): CipClockResult;
+/** Validate a write result. */
+export declare function decodeWriteResult(value: unknown): CipWriteResult;
+/** Validate a wall-clock write result. */
+export declare function decodeWriteClockResult(value: unknown): CipWriteClockResult;
+/** Validate a discovery result. */
+export declare function decodeDiscoverResult(value: unknown): CipDiscoverResult;
+/** Bounds shared with the polling engine. */
+export interface TransactionLimits {
+    /** Per-request driver timeout, in milliseconds. */
+    timeout: number;
+    /** Most simultaneous transactions. */
+    maxConcurrent: number;
+}
+/**
+ * Run one worker transaction and enforce its deadline.
+ *
+ * The worker emits exactly one message: `{ ok: true, value }` or
+ * `{ ok: false, message }`. Anything else, or a worker that outlives the
+ * deadline, fails the call rather than returning a partial answer.
+ */
+export declare class CipTransactions {
+    private readonly workerPath;
+    private readonly limits;
+    private active;
+    private disposed;
+    constructor(workerPath: string, limits: TransactionLimits);
+    /**
+     * Run one operation.
+     * @param spec - Worker request, already validated by the caller.
+     * @param signal - Optional lifetime, aborted by the calling turn.
+     * @param extraMs - Deadline beyond the driver timeout (discovery needs its window).
+     * @returns The raw `value` of the worker's reply.
+     */
+    run(spec: Readonly<Record<string, unknown>>, signal?: AbortSignal, extraMs?: number): Promise<unknown>;
+    /** Refuse new work and let running transactions finish. */
+    dispose(): Promise<void>;
+}

package/vendor/l5x/lib/engine/cip-transaction.js

@@ -0,0 +1,185 @@
+/**
+ * One-shot EtherNet/IP transactions: batch reads, identity/clock, writes and
+ * discovery, each in its own worker so a hung socket cannot hold the host.
+ *
+ * Reads are the normal case. Writes are only ever reached through a tool that
+ * has already asked a human for this exact operation, and every write result is
+ * the readback the controller returned, never an assumption that it worked.
+ *
+ * @module dsh-engineering-l5x/engine/cip-transaction
+ */
+import { Worker } from 'node:worker_threads';
+import { EngineeringError } from "../session.js";
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const isText = (value) => typeof value === 'string';
+const isInteger = (value) => typeof value === 'number' && Number.isInteger(value);
+const isFiniteNumber = (value) => typeof value === 'number' && Number.isFinite(value);
+const isScalar = (value) => typeof value === 'boolean' || isFiniteNumber(value);
+/** Narrow one identity record. */
+function identityOf(value) {
+    if (!isRecord(value) || !isText(value.product_name) || !isInteger(value.serial_number)
+        || !isText(value.revision) || !isFiniteNumber(value.status))
+        throw new Error('Invalid controller identity in CIP result');
+    return { product_name: value.product_name, serial_number: value.serial_number, revision: value.revision, status: value.status };
+}
+/** Narrow one observed value. */
+function valueOf(value) {
+    if (!isRecord(value) || !isText(value.tag) || !isText(value.data_type) || !isText(value.observed_at)
+        || !(value.value === null || isScalar(value.value)) || (value.quality !== 'good' && value.quality !== 'bad'))
+        throw new Error('Invalid CIP read value');
+    return {
+        tag: value.tag,
+        data_type: value.data_type,
+        ...(isText(value.actual_data_type) ? { actual_data_type: value.actual_data_type } : {}),
+        value: value.value,
+        quality: value.quality,
+        observed_at: value.observed_at,
+        ...(isText(value.error) ? { error: value.error.slice(0, 1000) } : {}),
+    };
+}
+/** Validate a batch-read result. */
+export function decodeReadResult(value) {
+    if (!isRecord(value) || !isInteger(value.request_count) || !isText(value.observed_at)
+        || !Array.isArray(value.values) || value.values.length > 256)
+        throw new Error('Invalid CIP read result');
+    return {
+        controller: identityOf(value.controller),
+        request_count: value.request_count,
+        observed_at: value.observed_at,
+        values: value.values.map(valueOf),
+    };
+}
+/** Validate a clock result. */
+export function decodeClockResult(value) {
+    if (!isRecord(value) || typeof value.supported !== 'boolean' || !isText(value.host_time))
+        throw new Error('Invalid CIP clock result');
+    return {
+        controller: identityOf(value.controller),
+        supported: value.supported,
+        host_time: value.host_time,
+        ...(isText(value.controller_time) ? { controller_time: value.controller_time } : {}),
+        ...(isText(value.reason) ? { reason: value.reason.slice(0, 500) } : {}),
+    };
+}
+/** Validate a write result. */
+export function decodeWriteResult(value) {
+    if (!isRecord(value) || !isText(value.tag) || !isText(value.declared_data_type) || !isText(value.written_at)
+        || !(value.previous_value === null || isScalar(value.previous_value))
+        || !isScalar(value.requested_value) || !(value.readback === null || isScalar(value.readback))
+        || typeof value.verified !== 'boolean')
+        throw new Error('Invalid CIP write result');
+    return {
+        tag: value.tag,
+        declared_data_type: value.declared_data_type,
+        ...(isText(value.actual_data_type) ? { actual_data_type: value.actual_data_type } : {}),
+        previous_value: value.previous_value,
+        requested_value: value.requested_value,
+        readback: value.readback,
+        verified: value.verified,
+        written_at: value.written_at,
+    };
+}
+/** Validate a wall-clock write result. */
+export function decodeWriteClockResult(value) {
+    if (!isRecord(value) || !isText(value.requested_time) || !isText(value.readback) || typeof value.verified !== 'boolean')
+        throw new Error('Invalid CIP clock write result');
+    return { requested_time: value.requested_time, readback: value.readback, verified: value.verified };
+}
+/** Validate a discovery result. */
+export function decodeDiscoverResult(value) {
+    if (!isRecord(value) || !isFiniteNumber(value.seconds) || !Array.isArray(value.devices) || value.devices.length > 512)
+        throw new Error('Invalid CIP discovery result');
+    return {
+        seconds: value.seconds,
+        devices: value.devices.map((device) => {
+            if (!isRecord(device) || !isText(device.ip_address) || !isText(device.product_name) || !isText(device.revision)
+                || !isText(device.serial_number) || !isFiniteNumber(device.vendor_id) || !isFiniteNumber(device.device_type)
+                || !isFiniteNumber(device.status))
+                throw new Error('Invalid discovered device');
+            return {
+                ip_address: device.ip_address,
+                product_name: device.product_name,
+                revision: device.revision,
+                serial_number: device.serial_number,
+                vendor_id: device.vendor_id,
+                device_type: device.device_type,
+                status: device.status,
+            };
+        }),
+    };
+}
+/**
+ * Run one worker transaction and enforce its deadline.
+ *
+ * The worker emits exactly one message: `{ ok: true, value }` or
+ * `{ ok: false, message }`. Anything else, or a worker that outlives the
+ * deadline, fails the call rather than returning a partial answer.
+ */
+export class CipTransactions {
+    workerPath;
+    limits;
+    active = 0;
+    disposed = false;
+    constructor(workerPath, limits) {
+        this.workerPath = workerPath;
+        this.limits = limits;
+    }
+    /**
+     * Run one operation.
+     * @param spec - Worker request, already validated by the caller.
+     * @param signal - Optional lifetime, aborted by the calling turn.
+     * @param extraMs - Deadline beyond the driver timeout (discovery needs its window).
+     * @returns The raw `value` of the worker's reply.
+     */
+    async run(spec, signal, extraMs = 0) {
+        if (this.disposed)
+            throw new EngineeringError('CONTROLLER_BUSY', 'The controller bridge is shutting down');
+        if (this.active >= this.limits.maxConcurrent)
+            throw new EngineeringError('CONTROLLER_BUSY', 'Controller transaction capacity is occupied');
+        signal?.throwIfAborted();
+        this.active += 1;
+        const worker = new Worker(this.workerPath, { workerData: spec, env: {}, stdout: true, stderr: true });
+        worker.stdout.resume();
+        worker.stderr.resume();
+        const deadline = this.limits.timeout + extraMs;
+        const timer = setTimeout(() => { void worker.terminate(); }, deadline);
+        const onAbort = () => { void worker.terminate(); };
+        signal?.addEventListener('abort', onAbort, { once: true });
+        try {
+            return await new Promise((resolve, reject) => {
+                let settled = false;
+                const settle = (fn) => { if (!settled) {
+                    settled = true;
+                    fn();
+                } };
+                worker.on('message', (message) => {
+                    if (!isRecord(message))
+                        return settle(() => reject(new Error('Malformed controller reply')));
+                    if (message.ok === true)
+                        return settle(() => resolve(message.value));
+                    settle(() => reject(new Error(isText(message.message) ? message.message : 'Controller transaction failed')));
+                });
+                worker.once('error', error => settle(() => reject(error)));
+                worker.once('exit', code => {
+                    settle(() => reject(new Error(`Controller transaction ended without a reply (exit ${String(code)})`)));
+                });
+            });
+        }
+        catch (error) {
+            if (signal?.aborted)
+                throw new EngineeringError('CONTROLLER_CANCELLED', 'The controller transaction was cancelled');
+            throw error instanceof EngineeringError ? error : new EngineeringError('CONTROLLER_UNREACHABLE', error instanceof Error ? error.message : 'Controller transaction failed', 'Check the controller address and slot, that the port is reachable, and retry.');
+        }
+        finally {
+            clearTimeout(timer);
+            signal?.removeEventListener('abort', onAbort);
+            this.active -= 1;
+            void worker.terminate();
+        }
+    }
+    /** Refuse new work and let running transactions finish. */
+    async dispose() {
+        this.disposed = true;
+        this.active = 0;
+    }
+}

package/vendor/l5x/lib/live.d.ts

@@ -32,6 +32,10 @@ export interface Config {
     maxConcurrent?: number;
     /** Optional IPv4 allowlist; empty permits any explicit address. */
     allowedAddresses?: string[];
+    /** Permit one-shot writes (tag and wall clock). Each write still needs human approval. Defaults to false. */
+    allowWrites?: boolean;
+    /** Largest accepted batch read. Defaults to 64. */
+    maxBatchTags?: number;
     /** Chart redraw interval, independent of reads. Defaults to 250 ms. */
     displayRefreshMs?: number;
     /** Most points retained per chart. Defaults to 1200. */
@@ -45,4 +49,5 @@ export interface Config {
  */
 export declare function apply(ctx: PluginContext, config?: Config): void;
 export { DirectPolling } from './engine/direct-polling.ts';
+export { CipTransactions } from './engine/cip-transaction.ts';
 export { liveTools } from './tools/live.ts';

package/vendor/l5x/lib/live.js

@@ -9,6 +9,7 @@
  */
 import { fileURLToPath } from 'node:url';
 import { DirectPolling } from "./engine/direct-polling.js";
+import { CipTransactions } from "./engine/cip-transaction.js";
 import { liveTools } from "./tools/live.js";
 import { PROJECTS_SERVICE } from "./index.js";
 /** Plugin name in a composition. */
@@ -39,10 +40,20 @@ export function apply(ctx, config = {}) {
         displayRefreshMs: config.displayRefreshMs ?? 250,
         displayMaxSamples: config.displayMaxSamples ?? 1200,
     });
+    const transactions = new CipTransactions(fileURLToPath(new URL('../cip-worker.mjs', import.meta.url)), {
+        timeout: config.requestTimeoutMs ?? 3000,
+        maxConcurrent: config.maxConcurrent ?? 2,
+    });
     const effect = ctx.effect;
-    effect?.(() => () => { void polling.dispose(); });
-    for (const definition of liveTools(session, polling, ctx))
+    effect?.(() => () => { void polling.dispose(); void transactions.dispose(); });
+    const extensions = {
+        transactions,
+        allowWrites: config.allowWrites === true,
+        maxBatchTags: config.maxBatchTags ?? 64,
+    };
+    for (const definition of liveTools(session, polling, ctx, extensions))
         ctx.tools.register(definition);
 }
 export { DirectPolling } from "./engine/direct-polling.js";
+export { CipTransactions } from "./engine/cip-transaction.js";
 export { liveTools } from "./tools/live.js";

package/vendor/l5x/lib/tools/live.d.ts

@@ -1,21 +1,32 @@
 /**
- * SDK-free live reads over EtherNet/IP.
+ * SDK-free EtherNet/IP surface: reads, identity, discovery and the two
+ * approval-gated writes.
  *
- * Two tools: a bounded foreground poll, and a session-owned trend job the chart
- * can follow without a model call per sample. Both read declared scalar tags,
- * never write, and state that live logic is not the exported logic.
+ * Reads never change the controller and need no approval. Writes do: a write is
+ * refused unless the row's config allows writes AND a human approves that exact
+ * operation, and its result is the value read back over CIP, not an assumption.
  *
  * @module dsh-engineering-l5x/tools/live
  */
 import type { PluginContext, ToolDefinition } from '../core/tool.ts';
 import type { ProjectSession } from '../session.ts';
 import { type DirectPolling } from '../engine/direct-polling.ts';
+import { type CipTransactions } from '../engine/cip-transaction.ts';
+/** Extra capabilities the live entry mounts beside polling. */
+export interface LiveExtensions {
+    readonly transactions: CipTransactions;
+    /** Writes are refused unless the row config enables them. */
+    readonly allowWrites: boolean;
+    /** Largest accepted batch read. */
+    readonly maxBatchTags: number;
+}
 /**
  * The live tools.
  *
  * @param session - Project handles for the calling chat.
  * @param polling - The polling engine and its configuration.
- * @param ctx - Plugin context that may provide the job service.
+ * @param ctx - Plugin context that may provide the job and approval services.
+ * @param extensions - One-shot transactions and the write switch.
  * @returns Tool definitions in registration order.
  */
-export declare function liveTools(session: ProjectSession, polling: DirectPolling, ctx: PluginContext): readonly ToolDefinition[];
+export declare function liveTools(session: ProjectSession, polling: DirectPolling, ctx: PluginContext, extensions: LiveExtensions): readonly ToolDefinition[];