@thinremote/thinr-cli 1.3.4 → 1.4.0

package/lib/product.js

@@ -1,5 +1,5 @@
-import api from './api.js';
-import { apiError, inputError } from './errors.js';
+import api from '@thinger-io/cli-core/api';
+import { apiError, inputError } from '@thinger-io/cli-core/errors';
 import {
     storageExists,
     createStorage,
@@ -9,17 +9,25 @@ import {
     storageFileExists,
     writeStorageFile,
     deleteStorageFile,
-} from './storage.js';
+} from '@thinger-io/cli-core/storage';
+import {
+    deleteProduct,
+    deleteProductProperty,
+    getProduct,
+    getProductApi,
+    getProductProperty,
+    productExists,
+    setProductProperty,
+    updateProduct,
+} from '@thinger-io/cli-core/product';
+import { deleteProductApiResource, setProductApiResource } from '@thinger-io/cli-core/profile';
 import { parsePlaybook } from './playbook/loader.js';
-import { v1 } from './paths.js';
+import { v1 } from '@thinger-io/cli-core/paths';
 
 /**
- * Helpers for ThinRemote products and the product-script workflow.
- *
- * Low-level helpers (`getProducts`, `getProduct`, `createProduct`, …)
- * each map to a single REST endpoint and throw `apiError` on failure
- * — except `*Exists` (boolean) and `delete*` (true if removed, false
- * if the resource was already absent).
+ * ThinRemote's product workflows: product scripts, dashboard metrics and
+ * playbooks. The generic product helpers (CRUD, properties, API
+ * resources) come from @thinger-io/cli-core.
  *
  * Higher-level orchestrators (`installProductScript`,
  * `removeProductScript`, `deleteProductWithStorage`) compose those
@@ -28,151 +36,6 @@ import { v1 } from './paths.js';
  * sequence.
  */
 
-// ─── Low-level: products ─────────────────────────────────────────────
-
-export async function getProducts(user) {
-    try {
-        const res = await api.get(`${v1(user)}/products`);
-        return res.data || [];
-    } catch (e) {
-        throw apiError(e);
-    }
-}
-
-export async function getProduct(productId, user) {
-    try {
-        const res = await api.get(`${v1(user)}/products/${productId}`);
-        return res.data || {};
-    } catch (e) {
-        throw apiError(e, { notFound: `Product not found: ${productId}` });
-    }
-}
-
-export async function productExists(productId, user) {
-    try {
-        await api.get(`${v1(user)}/products/${productId}`);
-        return true;
-    } catch (e) {
-        if (e.response?.status === 404) return false;
-        throw apiError(e);
-    }
-}
-
-/**
- * Create a product with the standard ThinRemote scaffold: `type:
- * thinremote`, a Font Awesome icon (defaults to Linux), and a
- * `monitoring` bucket fed every 60 s from the device's `monitoring`
- * resource. Caller controls only `icon`, `name`, `description`.
- */
-export async function createProduct(
-    productId,
-    user,
-    { icon = 'fab fa-linux', name, description } = {},
-) {
-    // Icons accept either a Font Awesome class (string, legacy short form)
-    // or a structured object { type: 'fa'|'svg', source, color, background }.
-    // The structured form lets callers ship inline SVG markup directly.
-    const iconSpec =
-        typeof icon === 'object' && icon !== null
-            ? {
-                  type: icon.type === 'svg' ? 'svg' : 'fa',
-                  source: icon.source,
-                  color: icon.color || '#000000',
-                  background: icon.background || '#ffffff',
-              }
-            : { type: 'fa', source: icon, color: '#000000', background: '#ffffff' };
-    try {
-        await api.post(`${v1(user)}/products`, {
-            product: productId,
-            name: name || productId,
-            description: description || 'ThinRemote product',
-            enabled: true,
-            config: {
-                type: 'thinremote',
-                icons: [
-                    {
-                        conditions: [],
-                        icon: iconSpec,
-                    },
-                ],
-            },
-            profile: {
-                buckets: {
-                    monitoring: {
-                        name: 'Monitoring Data',
-                        description: 'ThinRemote device metrics',
-                        enabled: true,
-                        backend: 'mongodb',
-                        data: {
-                            source: 'resource',
-                            resource: 'monitoring',
-                            update: 'interval',
-                            interval: 60,
-                            magnitude: 'second',
-                            payload: '{{payload}}',
-                            payload_function: '',
-                            payload_type: 'source_payload',
-                        },
-                        retention: { period: 3, unit: 'months' },
-                        tags: [],
-                    },
-                },
-            },
-        });
-    } catch (e) {
-        throw apiError(e);
-    }
-}
-
-export async function updateProduct(productId, user, patch) {
-    try {
-        await api.put(`${v1(user)}/products/${productId}`, patch);
-    } catch (e) {
-        throw apiError(e, { notFound: `Product not found: ${productId}` });
-    }
-}
-
-export async function deleteProduct(productId, user) {
-    try {
-        await api.delete(`${v1(user)}/products/${productId}`);
-        return true;
-    } catch (e) {
-        if (e.response?.status === 404) return false;
-        throw apiError(e);
-    }
-}
-
-// ─── Low-level: product API resources (profile/api/<name>) ───────────
-
-/** Returns the `{ resourceName: definition }` map; `{}` when none. */
-export async function getProductApi(productId, user) {
-    try {
-        const res = await api.get(`${v1(user)}/products/${productId}/profile/api`);
-        return res.data || {};
-    } catch (e) {
-        if (e.response?.status === 404) return {};
-        throw apiError(e);
-    }
-}
-
-export async function setProductApiResource(productId, resourceName, user, payload) {
-    try {
-        await api.put(`${v1(user)}/products/${productId}/profile/api/${resourceName}`, payload);
-    } catch (e) {
-        throw apiError(e);
-    }
-}
-
-export async function deleteProductApiResource(productId, resourceName, user) {
-    try {
-        await api.delete(`${v1(user)}/products/${productId}/profile/api/${resourceName}`);
-        return true;
-    } catch (e) {
-        if (e.response?.status === 404) return false;
-        throw apiError(e);
-    }
-}
-
 // ─── Low-level: product code link (profile/code) ─────────────────────
 
 export async function getProductCode(productId, user) {
@@ -193,68 +56,6 @@ export async function setProductCode(productId, user, payload) {
     }
 }
 
-// ─── Low-level: product properties (/v1/.../products/<id>/properties) ─
-//
-// Product-level properties are structured JSON values attached to the
-// product itself (not to any single device). Typical uses: dashboard
-// configuration, shared feature flags, a list of metrics to stream.
-// Endpoint mirrors device properties but lives under the v1 product
-// namespace on the server.
-
-export async function getProductProperties(productId, user) {
-    try {
-        const res = await api.get(`${v1(user)}/products/${productId}/properties`);
-        return res.data || [];
-    } catch (e) {
-        throw apiError(e, { notFound: `Product not found: ${productId}` });
-    }
-}
-
-export async function getProductProperty(productId, propertyId, user) {
-    try {
-        const res = await api.get(
-            `${v1(user)}/products/${productId}/properties/${propertyId}`,
-        );
-        return res.data?.value;
-    } catch (e) {
-        throw apiError(e, {
-            notFound: `Property not found: ${propertyId} on product ${productId}`,
-        });
-    }
-}
-
-export async function setProductProperty(productId, propertyId, value, user) {
-    try {
-        const res = await api.put(
-            `${v1(user)}/products/${productId}/properties/${propertyId}`,
-            { value },
-        );
-        return res.data;
-    } catch (e) {
-        throw apiError(e, { notFound: `Product not found: ${productId}` });
-    }
-}
-
-export async function deleteProductProperty(productId, propertyId, user) {
-    try {
-        await api.delete(`${v1(user)}/products/${productId}/properties/${propertyId}`);
-        return true;
-    } catch (e) {
-        if (e.response?.status === 404) return false;
-        throw apiError(e);
-    }
-}
-
-// ─── Low-level: device ↔ product binding ─────────────────────────────
-
-export async function setDeviceProduct(deviceId, productId, user) {
-    try {
-        await api.put(`${v1(user)}/devices/${deviceId}`, { product: productId });
-    } catch (e) {
-        throw apiError(e, { notFound: `Device not found: ${deviceId}` });
-    }
-}
-
 // ─── Orchestrators ───────────────────────────────────────────────────
 
 /**
@@ -380,12 +181,13 @@ export async function installProductScript({ product, name, content, user, input
 
     // 1. Refuse to silently create the product. The agent flow is
     //    list → create → write-script: if the product is missing, the
-    //    caller has to create it explicitly with `thinr_product_create`
+    //    caller has to create it explicitly (`thinr_resource_create` type
+    //    "product")
     //    so its name, description and icon are set deliberately rather
     //    than picking up defaults from a side effect.
     if (!(await productExists(product, user))) {
         const err = new Error(
-            `Product "${product}" does not exist. Create it first with thinr_product_create.`,
+            `Product "${product}" does not exist. Create it first with thinr_resource_create type "product".`,
         );
         err.code = 'not_found';
         throw err;
@@ -745,8 +547,8 @@ export async function uploadProductPlaybook({
             typeof description === 'string'
                 ? description
                 : typeof parsedDescription === 'string'
-                ? parsedDescription
-                : '',
+                  ? parsedDescription
+                  : '',
         path,
     };
     const next = [...existing];
@@ -818,12 +620,12 @@ export async function uploadFleetRunReport({ product, report, user, filename } =
 }
 
 function defaultRunReportFilename(report) {
-    const name = typeof report.name === 'string' && PLAYBOOK_NAME_RE.test(report.name)
-        ? report.name
-        : 'run';
-    const user = typeof report.user === 'string' && /^[A-Za-z0-9_.-]+$/.test(report.user)
-        ? report.user
-        : 'unknown';
+    const name =
+        typeof report.name === 'string' && PLAYBOOK_NAME_RE.test(report.name) ? report.name : 'run';
+    const user =
+        typeof report.user === 'string' && /^[A-Za-z0-9_.-]+$/.test(report.user)
+            ? report.user
+            : 'unknown';
     const ts = typeof report.startedAt === 'string' ? report.startedAt : new Date().toISOString();
     const stamp = ts.replace(/[:.]/g, '').replace(/[^0-9TZ]/g, '');
     return `${stamp}-${name}-${user}.json`;

package/lib/proxy.js

@@ -1,10 +1,10 @@
 import open, { apps } from 'open';
 import ora from 'ora';
-import { readConfig, requireConfig } from './config.js';
-import api from './api.js';
+import { readConfig, requireConfig } from '@thinger-io/cli-core/config';
+import api from '@thinger-io/cli-core/api';
 import { PROXY_PORTS } from './constants.js';
-import { apiError } from './errors.js';
-import { info, accent, hint, warning, error as errorStyle } from './format.js';
+import { apiError } from '@thinger-io/cli-core/errors';
+import { info, accent, hint, warning, error as errorStyle } from '@thinger-io/cli-core/format';
 
 /**
  * Parse target argument into address and port

package/lib/status.js

@@ -1,8 +1,16 @@
-import { resolveUser } from './config.js';
-import { v1 } from './paths.js';
-import api from './api.js';
-import { apiError } from './errors.js';
-import { formatUptime, colorPct, formatBytes, label, muted, success, error } from './format.js';
+import { resolveUser } from '@thinger-io/cli-core/config';
+import { v1 } from '@thinger-io/cli-core/paths';
+import api from '@thinger-io/cli-core/api';
+import { apiError } from '@thinger-io/cli-core/errors';
+import {
+    formatUptime,
+    colorPct,
+    formatBytes,
+    label,
+    muted,
+    success,
+    error,
+} from '@thinger-io/cli-core/format';
 
 /**
  * Get device status

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thinremote/thinr-cli",
-    "version": "1.3.4",
+    "version": "1.4.0",
     "description": "CLI for ThinRemote — remote management for IoT devices, with an MCP server for AI clients",
     "main": "bin/thinr.js",
     "bin": {
@@ -10,6 +10,7 @@
         "bin",
         "commands",
         "lib",
+        "docs/guides",
         "dist",
         "CHANGELOG.md",
         "LICENSE",
@@ -49,6 +50,7 @@
         "@inkjs/ui": "^2.0.0",
         "@inquirer/prompts": "^8.4.1",
         "@modelcontextprotocol/sdk": "^1.29.0",
+        "@thinger-io/cli-core": "^0.3.0",
         "axios": "^1.10.0",
         "chalk": "^5.4.1",
         "cli-progress": "^3.12.0",
@@ -67,7 +69,7 @@
     },
     "type": "module",
     "engines": {
-        "node": ">=18"
+        "node": ">=20"
     },
     "devDependencies": {
         "@eslint/js": "^10.0.1",

package/commands/device/delete.js

@@ -1,53 +0,0 @@
-// @ts-check
-import { confirm } from '@inquirer/prompts';
-import { deleteDevice } from '../../lib/devices.js';
-import { isJsonMode, printOk, printErr, classifyError } from '../../lib/output.js';
-import { hint, info } from '../../lib/format.js';
-import { applyJsonFlag, ensureConfigured, getGlobalUser } from './_shared.js';
-
-export function registerDeleteCommand(device) {
-    device
-        .command('delete <deviceId>')
-        .helpGroup('State & resources:')
-        .description('Delete a device record from the platform (irreversible)')
-        .option('-y, --yes', 'Skip the interactive confirmation prompt')
-        .option('-j, --json', 'Output as JSON')
-        .action(async (deviceId, opts, cmd) => {
-            applyJsonFlag(opts);
-            ensureConfigured();
-            const user = getGlobalUser(cmd);
-
-            if (!opts.yes && !isJsonMode()) {
-                if (!process.stdin.isTTY) {
-                    printErr('Refusing to delete without --yes in a non-interactive shell', {
-                        code: 'needs_confirm',
-                    });
-                    return;
-                }
-                const ok = await confirm({
-                    message: `Delete device ${deviceId}? This cannot be undone.`,
-                    default: false,
-                });
-                if (!ok) {
-                    console.log(hint('Cancelled.'));
-                    return;
-                }
-            }
-
-            try {
-                const removed = await deleteDevice(deviceId, user);
-                if (isJsonMode()) {
-                    printOk({ device: deviceId, removed });
-                    return;
-                }
-                console.log(
-                    removed
-                        ? `Deleted ${info(deviceId)}`
-                        : `Device ${info(deviceId)} did not exist`,
-                );
-            } catch (error) {
-                const { message, code } = classifyError(error);
-                printErr(message, { code });
-            }
-        });
-}

package/commands/device/list.js

@@ -1,55 +0,0 @@
-// @ts-check
-import { getDevices } from '../../lib/devices.js';
-import { isJsonMode, printOk } from '../../lib/output.js';
-import { success, hint, label } from '../../lib/format.js';
-import {
-    applyJsonFlag,
-    ensureConfigured,
-    getGlobalUser,
-    runDeviceCommand,
-} from './_shared.js';
-
-export function registerListCommand(device) {
-    device
-        .command('list [pattern]')
-        .helpGroup('Discovery:')
-        .description(
-            'List devices, optionally filtered by name/id pattern (case-insensitive regex)',
-        )
-        .option('-j, --json', 'Output as JSON')
-        .action(async (pattern, opts, cmd) => {
-            applyJsonFlag(opts);
-            ensureConfigured();
-            const user = getGlobalUser(cmd);
-            const filter = pattern ? { name: pattern } : {};
-            await runDeviceCommand({
-                start: pattern
-                    ? `Searching devices matching "${pattern}"...`
-                    : 'Fetching devices...',
-                fn: () => getDevices(filter, user),
-                success: (devices) => `Found ${devices.length} device(s)`,
-                failure: 'Failed to list devices',
-                onSuccess: (devices) => {
-                    if (isJsonMode()) {
-                        printOk(devices);
-                        return;
-                    }
-                    // Pad the device id column so trailing names line up
-                    // even when ids have very different widths — same
-                    // treatment as thinr product list.
-                    const idWidth = devices.reduce(
-                        (w, d) => Math.max(w, d.device.length),
-                        0,
-                    );
-                    for (const d of devices) {
-                        const online = d.connection?.active
-                            ? success('online ')
-                            : hint('offline');
-                        const name = d.name ? hint(`(${d.name})`) : '';
-                        const id = label(d.device.padEnd(idWidth));
-                        console.log(`  ${online}  ${id}${name ? '  ' + name : ''}`);
-                    }
-                },
-            });
-        });
-}

package/commands/device/property.js

@@ -1,52 +0,0 @@
-// @ts-check
-import {
-    formatDeviceProperty,
-    getDeviceProperty,
-    getDeviceProperties,
-    formatDeviceProperties,
-} from '../../lib/property.js';
-import { isJsonMode, printOk } from '../../lib/output.js';
-import {
-    applyJsonFlag,
-    ensureConfigured,
-    extractField,
-    runDeviceCommand,
-} from './_shared.js';
-
-export function registerPropertyCommand(device) {
-    device
-        .command('property <deviceId> [propertyId]')
-        .helpGroup('State & resources:')
-        .description('List device properties, or read one by ID')
-        .option('-j, --json', 'Output as JSON')
-        .option('-f, --field <field>', 'Extract a sub-field (dot path, e.g. data.value)')
-        .action(async (deviceId, propertyId, opts) => {
-            applyJsonFlag(opts);
-            ensureConfigured();
-            if (!propertyId) {
-                await runDeviceCommand({
-                    start: `Getting properties for ${deviceId}...`,
-                    fn: () => getDeviceProperties(deviceId),
-                    success: `Properties for ${deviceId} retrieved successfully`,
-                    failure: 'Property retrieval failed',
-                    onSuccess: (result) => {
-                        if (isJsonMode()) printOk(result);
-                        else console.log(formatDeviceProperties(deviceId, result));
-                    },
-                });
-                return;
-            }
-            await runDeviceCommand({
-                start: `Retrieving property for ${deviceId}...`,
-                fn: () => getDeviceProperty(deviceId, propertyId),
-                success: `Property ${propertyId} for ${deviceId} found`,
-                failure: 'Property retrieval failed',
-                onSuccess: (property) => {
-                    const value = extractField(property, opts.field);
-                    if (isJsonMode()) printOk(value);
-                    else if (opts.field) console.log(value);
-                    else console.log(formatDeviceProperty(deviceId, propertyId, property));
-                },
-            });
-        });
-}

package/commands/device/resource.js

@@ -1,52 +0,0 @@
-// @ts-check
-import {
-    callDeviceResource,
-    listDeviceResourcesWithSchemas,
-    formatDeviceResourcesWithSchemas,
-} from '../../lib/resource.js';
-import { isJsonMode, printOk } from '../../lib/output.js';
-import {
-    applyJsonFlag,
-    collectInput,
-    ensureConfigured,
-    extractField,
-    runDeviceCommand,
-} from './_shared.js';
-
-export function registerResourceCommand(device) {
-    device
-        .command('resource <deviceId> [resource]')
-        .helpGroup('State & resources:')
-        .description('List device resources, or call one by name')
-        .option('-j, --json', 'Output as JSON')
-        .option('-f, --field <field>', 'Extract a sub-field from the result (dot path)')
-        .option('-i, --input <key=value>', 'Resource input (repeatable)', collectInput, {})
-        .action(async (deviceId, resource, opts) => {
-            applyJsonFlag(opts);
-            ensureConfigured();
-            if (!resource) {
-                await runDeviceCommand({
-                    start: `Getting resources for ${deviceId}...`,
-                    fn: () => listDeviceResourcesWithSchemas(deviceId),
-                    success: `Successfully retrieved resources for ${deviceId}`,
-                    failure: 'Resource retrieval failed',
-                    onSuccess: (entries) => {
-                        if (isJsonMode()) printOk(entries);
-                        else console.log(formatDeviceResourcesWithSchemas(deviceId, entries));
-                    },
-                });
-                return;
-            }
-            await runDeviceCommand({
-                start: `Calling resource ${resource} for ${deviceId}...`,
-                fn: () => callDeviceResource(deviceId, resource, opts.input),
-                success: `Resource ${resource} returned successfully for ${deviceId}`,
-                failure: 'Resource call failed',
-                onSuccess: (result) => {
-                    const value = extractField(result, opts.field);
-                    if (isJsonMode()) printOk(value);
-                    else console.log(value);
-                },
-            });
-        });
-}

package/commands/logout.js

@@ -1,47 +0,0 @@
-import ora from 'ora';
-import { deleteConfig, configExists } from '../lib/config.js';
-import { warning, error, hint } from '../lib/format.js';
-
-/**
- * Register the logout command
- * @param {Command} program - Commander program instance
- */
-export function logoutCommand(program) {
-    program
-        .command('logout')
-        .helpGroup('Configuration:')
-        .description('Remove stored credentials and configuration')
-        .action(async () => {
-            // Check if configured
-            if (!configExists()) {
-                console.log(warning('No configuration found. Already logged out.'));
-                return;
-            }
-
-            const spinner = ora('Removing configuration...').start();
-
-            try {
-                // Delete local configuration
-                spinner.text = 'Removing local configuration...';
-                const ok = deleteConfig();
-
-                if (ok) {
-                    spinner.succeed('Logged out successfully. Configuration removed.');
-                } else {
-                    spinner.fail('Failed to remove configuration.');
-                    console.error(
-                        error(
-                            'Error: Unable to delete configuration file. You may need to remove it manually.',
-                        ),
-                    );
-                    console.error(
-                        hint('Configuration is stored in ~/.config/thinr-cli/config.json'),
-                    );
-                }
-            } catch (err) {
-                spinner.fail('Failed to remove configuration.');
-                console.error(error(`Error: ${err.message}`));
-                console.error(hint('Configuration is stored in ~/.config/thinr-cli/config.json'));
-            }
-        });
-}