@thinremote/thinr-cli 1.3.4 → 1.4.0

package/lib/playbook/loader.js

@@ -21,10 +21,9 @@ export function parsePlaybook(source, { sourcePath } = {}) {
     try {
         raw = YAML.parse(source);
     } catch (err) {
-        throw new Error(
-            `Invalid YAML${sourcePath ? ` in ${sourcePath}` : ''}: ${err.message}`,
-            { cause: err },
-        );
+        throw new Error(`Invalid YAML${sourcePath ? ` in ${sourcePath}` : ''}: ${err.message}`, {
+            cause: err,
+        });
     }
 
     const errors = [];
@@ -98,7 +97,9 @@ function validateVars(v, errors) {
     const variables = [];
     for (const [name, raw] of Object.entries(v)) {
         if (!IDENT_RE.test(name)) {
-            errors.push(`\`vars.${name}\` is not a valid identifier (letters, digits, underscore; no leading digit).`);
+            errors.push(
+                `\`vars.${name}\` is not a valid identifier (letters, digits, underscore; no leading digit).`,
+            );
             continue;
         }
         const def = normaliseVarDef(name, raw, errors);
@@ -132,7 +133,9 @@ function normaliseVarDef(name, raw, errors) {
 
     for (const key of Object.keys(raw)) {
         if (!VAR_META_KEY_SET.has(key)) {
-            errors.push(`\`vars.${name}\`: unknown metadata key "${key}" (expected: ${VAR_META_KEYS.join(', ')}).`);
+            errors.push(
+                `\`vars.${name}\`: unknown metadata key "${key}" (expected: ${VAR_META_KEYS.join(', ')}).`,
+            );
             return null;
         }
     }
@@ -230,8 +233,13 @@ function validateSteps(s, errors) {
             errors.push(`${where}: \`when\` must be a string expression.`);
             return;
         }
-        if (register !== undefined && (typeof register !== 'string' || !/^[A-Za-z_][A-Za-z0-9_]*$/.test(register))) {
-            errors.push(`${where}: \`register\` must be a valid identifier (letters, digits, underscore; no leading digit).`);
+        if (
+            register !== undefined &&
+            (typeof register !== 'string' || !/^[A-Za-z_][A-Za-z0-9_]*$/.test(register))
+        ) {
+            errors.push(
+                `${where}: \`register\` must be a valid identifier (letters, digits, underscore; no leading digit).`,
+            );
             return;
         }
         out.push({

package/lib/playbook/runner.js

@@ -1,6 +1,6 @@
 // @ts-check
-import { filterActiveDevices, getDevices } from '../devices.js';
-import { runPool } from '../concurrency.js';
+import { filterActiveDevices, getDevices } from '@thinger-io/cli-core/devices';
+import { runPool } from '@thinger-io/cli-core/concurrency';
 import { HANDLERS, CHECKERS, createActionContext } from './actions.js';
 
 /** Actions whose effect isn't derivable from observable state, so
@@ -37,7 +37,9 @@ export async function resolveTargets(pb, opts = {}) {
         // id isn't in the user's fleet (unlikely).
         const all = await getDevices({}, user);
         const byId = Object.fromEntries(all.map((d) => [d.device, d]));
-        return target.devices.map((id) => byId[id] || { device: id, connection: { active: false } });
+        return target.devices.map(
+            (id) => byId[id] || { device: id, connection: { active: false } },
+        );
     }
     if (!target.product) {
         throw new Error('playbook target has no product/devices after overrides');
@@ -98,6 +100,7 @@ export function buildDryRunPlan(pb, opts) {
  *   failFast?: boolean,
  *   continueOnError?: boolean,
  *   baseDir?: string,
+ *   localRoot?: string,
  *   checkMode?: boolean,
  *   overrides?: Record<string, unknown>,
  *   onStepStart?: (args: { deviceId: string, stepIndex: number, step: any }) => void,
@@ -117,7 +120,7 @@ export async function runPlaybook(pb, devices, opts = {}) {
 
     const results = await runPool(devices, concurrency, async (device) => {
         const deviceId = device.device;
-        const ctx = createActionContext({ deviceId, user, baseDir });
+        const ctx = createActionContext({ deviceId, user, baseDir, localRoot: opts.localRoot });
         /** @type {Record<string, unknown>} */
         const scope = buildScope(pb, opts, { device: deviceId });
         const steps = [];
@@ -125,7 +128,14 @@ export async function runPlaybook(pb, devices, opts = {}) {
 
         for (let i = 0; i < pb.steps.length; i++) {
             if (aborted) {
-                steps.push({ index: i, name: pb.steps[i].name, ok: false, skipped: true, summary: 'skipped (fail-fast)', durationMs: 0 });
+                steps.push({
+                    index: i,
+                    name: pb.steps[i].name,
+                    ok: false,
+                    skipped: true,
+                    summary: 'skipped (fail-fast)',
+                    durationMs: 0,
+                });
                 continue;
             }
             const step = pb.steps[i];
@@ -149,7 +159,15 @@ export async function runPlaybook(pb, devices, opts = {}) {
                         error: msg,
                         durationMs,
                     });
-                    opts.onStepEnd?.({ deviceId, stepIndex: i, step, ok: false, summary: msg, error: msg, durationMs });
+                    opts.onStepEnd?.({
+                        deviceId,
+                        stepIndex: i,
+                        step,
+                        ok: false,
+                        summary: msg,
+                        error: msg,
+                        durationMs,
+                    });
                     deviceOk = false;
                     if (failFast) aborted = true;
                     break;
@@ -163,7 +181,14 @@ export async function runPlaybook(pb, devices, opts = {}) {
                         summary: `skipped (when: ${step.when})`,
                         durationMs: 0,
                     });
-                    opts.onStepEnd?.({ deviceId, stepIndex: i, step, ok: true, summary: 'skipped', durationMs: 0 });
+                    opts.onStepEnd?.({
+                        deviceId,
+                        stepIndex: i,
+                        step,
+                        ok: true,
+                        summary: 'skipped',
+                        durationMs: 0,
+                    });
                     continue;
                 }
             }
@@ -245,7 +270,14 @@ export async function runPlaybook(pb, devices, opts = {}) {
                 const stdout = err && typeof err === 'object' ? err.stdout : undefined;
                 const stderr = err && typeof err === 'object' ? err.stderr : undefined;
                 const exitCode = err && typeof err === 'object' ? err.exitCode : undefined;
-                const entry = { index: i, name: step.name, ok: false, summary: msg, error: msg, durationMs };
+                const entry = {
+                    index: i,
+                    name: step.name,
+                    ok: false,
+                    summary: msg,
+                    error: msg,
+                    durationMs,
+                };
                 if (stdout !== undefined) entry.stdout = stdout;
                 if (stderr !== undefined) entry.stderr = stderr;
                 if (exitCode !== undefined) entry.exitCode = exitCode;

package/lib/playbook/schema.js

@@ -20,8 +20,17 @@ export const ACTIONS = [
         name: 'exec',
         description: 'Run a shell command on the device and fail the step on non-zero exit.',
         params: [
-            { name: 'command', type: 'string', required: true, description: 'Shell command to run.' },
-            { name: 'timeout', type: 'number', description: 'Per-device timeout in seconds (default: 30).' },
+            {
+                name: 'command',
+                type: 'string',
+                required: true,
+                description: 'Shell command to run.',
+            },
+            {
+                name: 'timeout',
+                type: 'number',
+                description: 'Per-device timeout in seconds (default: 30).',
+            },
         ],
         summary: (p) => `exec: ${p.command}`,
     },
@@ -35,10 +44,21 @@ export const ACTIONS = [
     },
     {
         name: 'write',
-        description: 'Write inline content to a file on the device. Use `push` to upload a local file instead.',
+        description:
+            'Write inline content to a file on the device. Use `push` to upload a local file instead.',
         params: [
-            { name: 'path', type: 'string', required: true, description: 'Absolute path on the device.' },
-            { name: 'content', type: 'string', required: true, description: 'Inline content to write.' },
+            {
+                name: 'path',
+                type: 'string',
+                required: true,
+                description: 'Absolute path on the device.',
+            },
+            {
+                name: 'content',
+                type: 'string',
+                required: true,
+                description: 'Inline content to write.',
+            },
         ],
         summary: (p) => `write ${p.path}`,
     },
@@ -46,8 +66,19 @@ export const ACTIONS = [
         name: 'push',
         description: 'Upload a local file to the device.',
         params: [
-            { name: 'source', type: 'string', required: true, description: 'Local file path (relative paths resolve against the playbook directory).' },
-            { name: 'destination', type: 'string', required: true, description: 'Absolute path on the device.' },
+            {
+                name: 'source',
+                type: 'string',
+                required: true,
+                description:
+                    'Local file path (relative paths resolve against the playbook directory).',
+            },
+            {
+                name: 'destination',
+                type: 'string',
+                required: true,
+                description: 'Absolute path on the device.',
+            },
         ],
         summary: (p) => `push ${p.source} → ${p.destination}`,
     },
@@ -55,44 +86,79 @@ export const ACTIONS = [
         name: 'pull',
         description: 'Download a remote file from the device to the local disk.',
         params: [
-            { name: 'source', type: 'string', required: true, description: 'Absolute path on the device.' },
-            { name: 'destination', type: 'string', required: true, description: 'Local file path (relative paths resolve against the playbook directory).' },
+            {
+                name: 'source',
+                type: 'string',
+                required: true,
+                description: 'Absolute path on the device.',
+            },
+            {
+                name: 'destination',
+                type: 'string',
+                required: true,
+                description:
+                    'Local file path (relative paths resolve against the playbook directory).',
+            },
         ],
         summary: (p) => `pull ${p.source} → ${p.destination}`,
     },
     {
-        name: 'rm',
+        name: 'delete',
         description: 'Remove a file or directory on the device.',
         params: [
-            { name: 'path', type: 'string', required: true, description: 'Absolute path on the device.' },
-            { name: 'recursive', type: 'boolean', description: 'Recurse into directories (default: true).' },
+            {
+                name: 'path',
+                type: 'string',
+                required: true,
+                description: 'Absolute path on the device.',
+            },
+            {
+                name: 'recursive',
+                type: 'boolean',
+                description: 'Recurse into directories (default: true).',
+            },
         ],
-        summary: (p) => `rm ${p.path}`,
+        summary: (p) => `delete ${p.path}`,
     },
     {
         name: 'mkdir',
         description: 'Create a directory on the device.',
         params: [
-            { name: 'path', type: 'string', required: true, description: 'Absolute directory path on the device.' },
+            {
+                name: 'path',
+                type: 'string',
+                required: true,
+                description: 'Absolute directory path on the device.',
+            },
         ],
         summary: (p) => `mkdir ${p.path}`,
     },
     {
-        name: 'mv',
-        description: 'Move or rename a path on the device. Handy for atomic deploys (write to tmp, mv into place).',
+        name: 'move',
+        description:
+            'Move or rename a path on the device. Handy for atomic deploys (write to tmp, move into place).',
         params: [
             { name: 'source', type: 'string', required: true, description: 'Path to move from.' },
             { name: 'destination', type: 'string', required: true, description: 'Target path.' },
-            { name: 'overwrite', type: 'boolean', description: 'Overwrite destination if it exists (default: false).' },
+            {
+                name: 'overwrite',
+                type: 'boolean',
+                description: 'Overwrite destination if it exists (default: false).',
+            },
         ],
-        summary: (p) => `mv ${p.source} → ${p.destination}`,
+        summary: (p) => `move ${p.source} → ${p.destination}`,
     },
     {
         name: 'property_set',
         description: 'Create or overwrite a device property.',
         params: [
             { name: 'property', type: 'string', required: true, description: 'Property name.' },
-            { name: 'value', type: 'object', required: true, description: 'Any JSON-serialisable value.' },
+            {
+                name: 'value',
+                type: 'object',
+                required: true,
+                description: 'Any JSON-serialisable value.',
+            },
         ],
         summary: (p) => `property_set ${p.property}`,
     },
@@ -101,7 +167,11 @@ export const ACTIONS = [
         description: 'Invoke a device resource. Inputs are forwarded as the resource payload.',
         params: [
             { name: 'resource', type: 'string', required: true, description: 'Resource name.' },
-            { name: 'inputs', type: 'object', description: 'Resource inputs (omit for read-only resources).' },
+            {
+                name: 'inputs',
+                type: 'object',
+                description: 'Resource inputs (omit for read-only resources).',
+            },
         ],
         summary: (p) => `resource ${p.resource}`,
     },
@@ -118,18 +188,25 @@ export const ACTIONS = [
         name: 'script_install',
         description: 'Install or replace a custom script on the device. Triggers a scripts reload.',
         params: [
-            { name: 'name', type: 'string', required: true, description: 'Script filename (e.g. "battery.sh").' },
+            {
+                name: 'name',
+                type: 'string',
+                required: true,
+                description: 'Script filename (e.g. "battery.sh").',
+            },
             { name: 'content', type: 'string', description: 'Inline script source.' },
-            { name: 'content_file', type: 'string', description: 'Local file with the script source.' },
+            {
+                name: 'content_file',
+                type: 'string',
+                description: 'Local file with the script source.',
+            },
         ],
         summary: (p) => `script_install ${p.name}`,
     },
     {
         name: 'script_delete',
         description: 'Remove a custom script from the device.',
-        params: [
-            { name: 'name', type: 'string', required: true, description: 'Script filename.' },
-        ],
+        params: [{ name: 'name', type: 'string', required: true, description: 'Script filename.' }],
         summary: (p) => `script_delete ${p.name}`,
     },
 ];
@@ -164,7 +241,8 @@ export function playbookSchema() {
             description:
                 'Extended form for a single `vars` entry. Use it when a variable needs a description, an explicit type for override validation, or must be marked non-overridable or required.',
             fields: {
-                default: 'Default value. Optional when `required: true`. Must match the declared `type`.',
+                default:
+                    'Default value. Optional when `required: true`. Must match the declared `type`.',
                 description: 'Optional human-readable text shown in the dashboard form.',
                 type: 'Expected value type for overrides: "string", "number", "boolean", or "object".',
                 overridable:
@@ -183,17 +261,13 @@ export function playbookSchema() {
             action: 'Action name — one of the actions below.',
             pause_after: 'Optional seconds to wait after this step completes.',
             when: 'Optional boolean expression. When present and falsy the step is skipped. See `when_expression` below for supported syntax.',
-            register: 'Optional identifier. When set, the step outcome is exposed under that name to later `when` expressions and string interpolation as `{ ok, result | error, duration_ms }`.',
+            register:
+                'Optional identifier. When set, the step outcome is exposed under that name to later `when` expressions and string interpolation as `{ ok, result | error, duration_ms }`.',
             '...': 'Additional fields are the action parameters (see `actions` below).',
         },
         when_expression: {
-            syntax:
-                'Minimal boolean mini-language: `==`, `!=`, `>`, `<`, `>=`, `<=`, `and`, `or`, `not`, parentheses; literals for strings (single or double quoted), numbers, `true`, `false`, `null`; dotted identifier paths resolve against the current scope.',
-            examples: [
-                'env == "prod"',
-                'check.ok and agent.version != "1.6.0"',
-                'not dry_run',
-            ],
+            syntax: 'Minimal boolean mini-language: `==`, `!=`, `>`, `<`, `>=`, `<=`, `and`, `or`, `not`, parentheses; literals for strings (single or double quoted), numbers, `true`, `false`, `null`; dotted identifier paths resolve against the current scope.',
+            examples: ['env == "prod"', 'check.ok and agent.version != "1.6.0"', 'not dry_run'],
         },
         actions: ACTIONS.map((a) => ({
             name: a.name,

package/lib/product/log-presets.js

@@ -115,7 +115,7 @@ export const LEVEL_SEVERITY = /** @type {Record<string, number>} */ ({
 
 /**
  * Return all presets as a sorted list. Used by `thinr product logs presets`
- * and by the MCP `thinr_product_logs_presets` tool.
+ * and by `thinr_resource_describe` type `product_log_source` (MCP).
  *
  * @returns {LogPreset[]}
  */

package/lib/product/logs.js

@@ -1,10 +1,10 @@
 // @ts-check
-import { inputError } from '../errors.js';
+import { inputError } from '@thinger-io/cli-core/errors';
 import {
     getProductProperty,
     setProductProperty,
     deleteProductProperty,
-} from '../product.js';
+} from '@thinger-io/cli-core/product';
 import { LEVEL_SEVERITY, PRESET_NAMES, getPreset, listPresets } from './log-presets.js';
 
 export { LEVEL_SEVERITY, getPreset, listPresets };

package/lib/product-orchestrator.js

@@ -1,11 +1,11 @@
 // @ts-check
-import { getDevices, filterActiveDevices } from './devices.js';
-import { runPool } from './concurrency.js';
+import { getDevices, filterActiveDevices } from '@thinger-io/cli-core/devices';
+import { runPool } from '@thinger-io/cli-core/concurrency';
 
 /**
  * Resolve the target devices of a product (optionally filtered by
- * asset group and active connection), then run `worker(device)` over
- * them with bounded concurrency.
+ * asset group and active connection), or take the `devices` given, then
+ * run `worker(device)` over them with bounded concurrency.
  *
  * The worker is responsible for its own error handling and always
  * returns a fully-populated entry. Any escaping throw is caught and
@@ -26,7 +26,8 @@ import { runPool } from './concurrency.js';
  *
  * @template E
  * @param {{
- *     product: string,
+ *     product?: string,
+ *     devices?: any[],
  *     group?: string,
  *     includeOffline?: boolean,
  *     user?: string | null,
@@ -49,6 +50,7 @@ import { runPool } from './concurrency.js';
 export async function runProductFanOut(opts) {
     const {
         product,
+        devices: given,
         group,
         includeOffline = false,
         user,
@@ -63,10 +65,13 @@ export async function runProductFanOut(opts) {
         onItemFinish,
     } = opts;
 
-    const filter = { product };
-    if (group) filter.asset_group = group;
-    let devices = await getDevices(filter, user || undefined);
-    if (!includeOffline) devices = filterActiveDevices(devices);
+    let devices = given;
+    if (!devices) {
+        const filter = { product };
+        if (group) filter.asset_group = group;
+        devices = await getDevices(filter, user || undefined);
+        if (!includeOffline) devices = filterActiveDevices(devices);
+    }
 
     onDevicesResolved?.(devices);