@thinremote/thinr-cli 1.0.2-alpha.2 → 1.1.0-alpha.1

package/lib/storage.js

@@ -0,0 +1,128 @@
+import api from './api.js';
+import { apiError } from './errors.js';
+import { requireConfig } from './config.js';
+
+/**
+ * Helpers for ThinRemote file storages — independent buckets that the
+ * platform exposes alongside products. The product script workflow
+ * uses them to host the actual JS files; storages are also useful on
+ * their own (config blobs, firmware artefacts, etc.).
+ *
+ * Functions return raw data and throw `apiError` on failure, except
+ * the `*Exists` and `delete*` helpers which use boolean return values
+ * so orchestration code can stay branch-light.
+ */
+
+function resolveUser(user) {
+    return user || requireConfig().username;
+}
+
+function v1(user) {
+    return `/v1/users/${resolveUser(user)}`;
+}
+function v2(user) {
+    return `/v2/users/${resolveUser(user)}`;
+}
+
+export async function getStorage(storageId, user) {
+    try {
+        const res = await api.get(`${v1(user)}/storages/${storageId}`);
+        return res.data || {};
+    } catch (e) {
+        throw apiError(e, { notFound: `Storage not found: ${storageId}` });
+    }
+}
+
+export async function storageExists(storageId, user) {
+    try {
+        await api.get(`${v1(user)}/storages/${storageId}`);
+        return true;
+    } catch (e) {
+        if (e.response?.status === 404) return false;
+        throw apiError(e);
+    }
+}
+
+export async function createStorage(
+    storageId,
+    user,
+    { name, description, public: isPublic = false } = {},
+) {
+    try {
+        await api.post(`${v1(user)}/storages`, {
+            storage: storageId,
+            name: name || storageId,
+            description: description || `Storage for ${storageId}`,
+            public: isPublic,
+        });
+    } catch (e) {
+        throw apiError(e);
+    }
+}
+
+export async function deleteStorage(storageId, user) {
+    try {
+        await api.delete(`${v1(user)}/storages/${storageId}`);
+        return true;
+    } catch (e) {
+        if (e.response?.status === 404) return false;
+        throw apiError(e);
+    }
+}
+
+export async function listStorageFiles(storageId, user) {
+    try {
+        const res = await api.get(`${v1(user)}/storages/${storageId}/files`);
+        return res.data || [];
+    } catch (e) {
+        if (e.response?.status === 404) return [];
+        throw apiError(e);
+    }
+}
+
+/**
+ * Read a file as raw text (no JSON parsing). The agent stores script
+ * bodies as `text/plain` — parsing them as JSON would corrupt them.
+ */
+export async function readStorageFile(storageId, filePath, user) {
+    try {
+        const res = await api.get(`${v2(user)}/storages/${storageId}/files/${filePath}`, {
+            transformResponse: [(x) => x],
+        });
+        return res.data;
+    } catch (e) {
+        throw apiError(e, { notFound: `File not found in storage "${storageId}": ${filePath}` });
+    }
+}
+
+export async function storageFileExists(storageId, filePath, user) {
+    try {
+        await api.get(`${v2(user)}/storages/${storageId}/files/${filePath}`);
+        return true;
+    } catch (e) {
+        if (e.response?.status === 404) return false;
+        throw apiError(e);
+    }
+}
+
+export async function writeStorageFile(storageId, filePath, content, user) {
+    try {
+        await api.put(
+            `${v2(user)}/storages/${storageId}/files/${filePath}?overwrite=true`,
+            content,
+            { headers: { 'Content-Type': 'text/plain' } },
+        );
+    } catch (e) {
+        throw apiError(e);
+    }
+}
+
+export async function deleteStorageFile(storageId, filePath, user) {
+    try {
+        await api.delete(`${v2(user)}/storages/${storageId}/files/${filePath}`);
+        return true;
+    } catch (e) {
+        if (e.response?.status === 404) return false;
+        throw apiError(e);
+    }
+}

package/package.json

@@ -1,39 +1,70 @@
 {
-  "name": "@thinremote/thinr-cli",
-  "version": "1.0.2-alpha.2",
-  "description": "CLI for ThinRemote - Remote management for IoT devices",
-  "main": "bin/thinr.js",
-  "bin": {
-    "thinr": "bin/thinr.js"
-  },
-  "scripts": {
-    "start": "node bin/thinr.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
-    "cli",
-    "iot",
-    "remote",
-    "management",
-    "thing",
-    "thinger"
-  ],
-  "author": "ThinRemote",
-  "license": "MIT",
-  "dependencies": {
-    "axios": "^1.10.0",
-    "chalk": "^5.4.1",
-    "commander": "^14.0.0",
-    "conf": "^14.0.0",
-    "figlet": "^1.8.1",
-    "@inquirer/prompts": "^7.5.3",
-    "jsonwebtoken": "^9.0.2",
-    "open": "^10.1.2",
-    "ora": "^8.2.0",
-    "ws": "^8.18.2"
-  },
-  "type": "module",
-  "engines": {
-    "node": ">=14.16"
-  }
+    "name": "@thinremote/thinr-cli",
+    "version": "1.1.0-alpha.1",
+    "description": "CLI for ThinRemote — remote management for IoT devices, with an MCP server for AI clients",
+    "main": "bin/thinr.js",
+    "bin": {
+        "thinr": "bin/thinr.js"
+    },
+    "files": [
+        "bin",
+        "commands",
+        "lib",
+        "CHANGELOG.md",
+        "LICENSE",
+        "README.md"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Thin-Remote/thinr-cli.git"
+    },
+    "bugs": "https://github.com/Thin-Remote/thinr-cli/issues",
+    "homepage": "https://github.com/Thin-Remote/thinr-cli#readme",
+    "scripts": {
+        "start": "node bin/thinr.js",
+        "lint": "eslint .",
+        "lint:fix": "eslint . --fix",
+        "format": "prettier --write .",
+        "format:check": "prettier --check .",
+        "typecheck": "tsc",
+        "test": "node --test 'tests/**/*.test.js'"
+    },
+    "keywords": [
+        "cli",
+        "iot",
+        "remote",
+        "management",
+        "thinremote",
+        "thinr",
+        "thinger",
+        "mcp"
+    ],
+    "author": "ThinRemote",
+    "license": "MIT",
+    "dependencies": {
+        "@inquirer/prompts": "^7.5.3",
+        "@modelcontextprotocol/sdk": "^1.29.0",
+        "axios": "^1.10.0",
+        "chalk": "^5.4.1",
+        "commander": "^14.0.0",
+        "conf": "^14.0.0",
+        "figlet": "^1.8.1",
+        "jsonwebtoken": "^9.0.2",
+        "open": "^10.1.2",
+        "ora": "^8.2.0",
+        "ws": "^8.18.2"
+    },
+    "type": "module",
+    "engines": {
+        "node": ">=18"
+    },
+    "devDependencies": {
+        "@eslint/js": "^10.0.1",
+        "@types/node": "^25.6.0",
+        "eslint": "^10.2.0",
+        "eslint-config-prettier": "^10.1.8",
+        "globals": "^17.5.0",
+        "prettier": "^3.8.3",
+        "typescript": "^6.0.2"
+    }
 }

package/.github/workflows/publish.yml

@@ -1,79 +0,0 @@
-name: "publish"
-
-on:
-  push:
-    branches: [ main, develop ]
-
-jobs:
-  publish:
-    name: publish
-    runs-on: ubuntu-latest
-
-    steps:
-
-      - name: Extract branch name
-        shell: bash
-        run: echo "branch=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
-
-      - name: checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          ref: ${{ env.branch }}
-
-      - name: node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 22
-          registry-url: https://registry.npmjs.org
-
-      - name: Get tag version
-        run: |
-          echo "tag_version=`cat package.json | jq '.version' | tr -d '"'`"  >> $GITHUB_ENV
-
-      - name: Check if tag is for develop and if it already exists
-        run: |
-          git fetch --prune --tags
-          if [ ${{ env.branch }} == 'develop' ]; then
-              for i in {1..100}; do
-                  if [ `git tag --list | grep ${{ env.tag_version }}"-alpha.${i}" | wc -l` -eq 0 ]; then
-                      tag_version=${{ env.tag_version }}"-alpha.${i}"
-                      echo "tag_version=${tag_version}" >> $GITHUB_ENV
-                      echo "npm_tag_version=develop" >> $GITHUB_ENV
-                      break;
-                  fi
-              done
-          elif [ ${{ env.branch }} == 'main' ]; then
-              echo "npm_tag_version=latest" >> $GITHUB_ENV
-          elif [ `git tag --list | grep -q ${{ env.tag_version }}` -ne 0 ]; then exit 1; fi
-
-      - name: update version
-        run: |
-          npm version --no-git-tag-version --allow-same-version ${{ env.tag_version }}
-
-      - name: publish
-        run: npm publish --tag ${{ env.npm_tag_version }} --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-
-      - name: Get changelog body
-        run: |
-          awk '/^## \[[0-9]+/,EOF' CHANGELOG.md | awk '(NR>1)' | awk '1;/^## \[[0-9]+/{exit}' | sed '$d' > release_body.md
-
-      - name: Set pre-release boolean
-        run: |
-          prerelease=false
-          if [ ${{ env.branch }} == 'develop' ]; then
-              prerelease=true
-          fi
-          echo "prerelease=$prerelease" >> $GITHUB_ENV
-
-      - name: Create GitHub release
-        uses: ncipollo/release-action@v1
-        with:
-          prerelease: ${{ env.prerelease }}
-          commit: ${{ env.branch }}
-          tag: ${{ env.tag_version }}
-          name: ${{ env.tag_version }}
-          token: ${{ secrets.GITHUB_TOKEN }}
-          bodyFile: "release_body.md"

package/commands/device.js

@@ -1,268 +0,0 @@
-import { handleProxyAction } from '../lib/proxy.js';
-import { connectToDeviceConsole } from '../lib/console.js';
-import { getDeviceStatus, formatDeviceStatus } from '../lib/status.js';
-import { formatDeviceProperty, getDeviceProperty, getDeviceProperties, formatDeviceProperties } from '../lib/property.js';
-import chalk from 'chalk';
-import ora from 'ora';
-import { configExists } from '../lib/config.js';
-import { getDeviceResources, executeDeviceResource, formatDeviceResources } from "../lib/resource.js";
-
-
-/**
- * Register the device command with all device-related subcommands
- * @param {Command} program - Commander program instance
- */
-export function deviceCommand(program) {
-
-    const device = program.command('device').description('Device commands');
-
-    device
-        .argument('<deviceId>', 'ID of the device to manage')
-        .description('Manage device connections and proxies')
-        .allowUnknownOption(true)
-        .allowExcessArguments(true)
-        .action(async (deviceId, options, command) => {
-            // Get additional arguments manually
-            const args = command.args.slice(1); // Skip deviceId
-            const action = args[0];
-            const target = args[1] && !args[1].startsWith('-') ? args[1] : null; // Check if target is provided, skip if it's an option
-
-            // Check if configured
-            if (!configExists()) {
-                console.error(chalk.red('Error: Not configured. Run thinr without parameters to set up.'));
-                process.exit(1);
-            }
-
-            // If no action provided, show help
-            if (!action) {
-                printHelp(deviceId);
-                return;
-            }
-
-            // Parse options manually from process.argv
-            const parsedOptions = {
-                port: null,
-                json: false,
-                openBrowser: true,
-                inputs: {},
-                field: "",
-            };
-
-            const argv = process.argv;
-            for (let i = 0; i < argv.length; i++) {
-                if (argv[i] === '-p' || argv[i] === '--port') {
-                    parsedOptions.port = argv[i + 1];
-                    i++; // Skip the value
-                } else if (argv[i] === '-j' || argv[i] === '--json') {
-                    parsedOptions.json = true;
-                } else if (argv[i] === '--no-open') {
-                    parsedOptions.open = false;
-                } else if (argv[i] === '-i' || argv[i] === '--input') {
-                    let inputPair = argv[i + 1].split('=');
-                    parsedOptions.inputs[inputPair[0]] = inputPair[1];
-                } else if (argv[i] === '-f' || argv[i] === '--field') {
-                    parsedOptions.field = argv[i + 1];
-                } else if (argv[i] === '-h' || argv[i] === '--help') {
-                    printHelp(deviceId);
-                    return;
-                }
-            }
-
-            switch (action.toLowerCase()) {
-                case 'tcp':
-                    await handleProxyAction(deviceId, 'tcp', target, parsedOptions);
-                    break;
-                
-                case 'tls':
-                    await handleProxyAction(deviceId, 'tls', target, parsedOptions);
-                    break;
-                
-                case 'http':
-                    await handleProxyAction(deviceId, 'http', target, parsedOptions);
-                    break;
-                
-                case 'console':
-                    try {
-                        await connectToDeviceConsole(deviceId);
-                    } catch (error) {
-                        console.error(chalk.red(`Error: ${error.message}`));
-                        process.exit(1);
-                    }
-                    break;
-                
-                case 'status': {
-                    const spinner = ora(`Checking status of ${deviceId}...`).start();
-                    try {
-                        const status = await getDeviceStatus(deviceId);
-                        spinner.succeed(`Device ${deviceId} found`);
-
-                        if (parsedOptions.json) {
-                            console.log(JSON.stringify(status, null, 2));
-                        } else {
-                            console.log(formatDeviceStatus(deviceId, status));
-                        }
-                    } catch (error) {
-                        spinner.fail(`Status check failed`);
-                        console.error(chalk.red(`Error: ${error.message}`));
-                        process.exit(1);
-                    }
-                    break;
-                }
-
-                case 'property': {
-
-                    if ( !target ) {
-                        const spinner = ora(`Getting properties for ${deviceId}...`).start();
-                        try {
-                            const result = await getDeviceProperties(deviceId);
-                            spinner.succeed(`Properties for ${deviceId} retrieved successfully`);
-                            if (parsedOptions.json) {
-                                console.log(result);
-                            } else {
-                                console.log(chalk.green(`Resource result for device ${deviceId}:`));
-                                console.log(formatDeviceProperties(deviceId, result));
-                            }
-                        } catch (error) {
-                            spinner.fail(`Property retrieval failed`);
-                            console.error(chalk.red(`Error: ${error.message}`));
-                            process.exit(1);
-                        }
-                    } else {
-                        const spinner = ora(`Retrieving property for ${deviceId}...`).start();
-                        try {
-                            const property = await getDeviceProperty(deviceId, target);
-                            spinner.succeed(`Property ${target} for ${deviceId} found`);
-
-                            if (parsedOptions.json) {
-                                if ( parsedOptions.field ) {
-                                    console.log(parsedOptions.field.split('.').reduce((obj, key) => obj && obj[key], property));
-                                } else {
-                                    console.log(JSON.stringify(property, null, 2));
-                                }
-                            } else {
-                                console.log(formatDeviceProperty(deviceId, target, property));
-                            }
-                        } catch (error) {
-                            spinner.fail(`Property retrieval failed`);
-                            console.error(chalk.red(`Error: ${error.message}`));
-                            process.exit(1);
-                        }
-
-                    }
-
-                    break;
-                }
-
-                case 'resource': {
-
-                    if (!target) {
-                        const spinner = ora(`Getting resources for ${deviceId}...`).start();
-                        try {
-
-                            const result = await getDeviceResources(deviceId);
-                            spinner.succeed(`Succesfully retrieved resources for ${deviceId}`);
-
-                            if (parsedOptions.json) {
-                                console.log(result);
-                            } else {
-                                //console.log(chalk.green(`Resource ${target} result for device ${deviceId}:`));
-                                console.log(chalk.green(`Resource result for device ${deviceId}:`));
-                                console.log(formatDeviceResources(deviceId, result));
-                            }
-                        } catch (error) {
-                            spinner.fail(`Resource retrieval failed`);
-                            console.error(chalk.red(`Error: ${error.message}`));
-                            process.exit(1);
-                        }
-
-                    } else {
-                        const spinner = ora(`Executing resource ${target} for ${deviceId}...`).start();
-                        try {
-
-                            const result = await executeDeviceResource(deviceId, target, parsedOptions.inputs);
-                            spinner.succeed(`Resource ${target} executed successfully for ${deviceId}`);
-
-                            if ( parsedOptions.field ) {
-                                console.log(parsedOptions.field.split('.').reduce((obj, key) => obj && obj[key], result));
-                            } else {
-                                console.log(result);
-                            }
-
-                        } catch (error) {
-                            spinner.fail(`Resource execution failed`);
-                            console.error(chalk.red(`Error: ${error.message}`));
-                            process.exit(1);
-                        }
-                    }
-
-                    break;
-                }
-
-                default:
-                    console.error(chalk.red(`Error: Unknown action '${action}'. Available actions: tcp, tls, http, console, status, property, resource.\n`));
-                    printHelp(deviceId);
-                    process.exit(1);
-            }
-        });
-
-}
-function printHelp(deviceId) {
-    console.log(`Usage: thinr device ${deviceId} <command> [options]
-
-Available commands for device "${deviceId}":
-
-  tcp [target]                  Create a TCP proxy (no TLS)
-                                Example: thinr device ${deviceId} tcp 22
-  
-  tls [target]                  Create a TLS proxy  
-                                Example: thinr device ${deviceId} tls 443
-  
-  http [target]                 Create an HTTP proxy
-                                Example: thinr device ${deviceId} http 8080
-  
-  console                       Open terminal console
-                                Example: thinr device ${deviceId} console
-  
-  status                        Check device status
-                                Example: thinr device ${deviceId} status
-                            
-  property                      Get device properties
-                                Example: thinr device ${deviceId} property
-                     
-  property [propertyId]         Get a specific property of the device
-                                Example: thinr device ${deviceId} property uptime
-                            
-  resource                      Get resources of the device
-                                Example: thinr device ${deviceId} resource
-                            
-  resource [resource]           Execute a specific resource of the device
-                                Example: thinr device ${deviceId} resource reboot
-
-Arguments:
-
-  target                        Target for proxy commands (address:port, port, or address)
-                                Defaults: tcp=22, tls=443, http=80
-                     
-  propertyId                    ID of the property to retrieve (for property command)
-  
-  resource                      Name of the resource to execute (for resource command)
-
-Options (for proxy commands):
-  -p, --port <port>  Local port to use (default: random)
-  --no-open          Do not open browser (http only)
-
-Options (for status command):
-  -j, --json         Output as JSON
-  
-Options (for property command):
-  -j, --json         Output as JSON
-  -f, --field <field>          Field to extract from the property (e.g., -f data.value)
-    
-Options (for resource command):
-  -i, --input <input>=<value>  Input for the resource (e.g., -i param1=value1 -i param2=value2)
-  -j, --json         Output as JSON
-  -f, --field <field>          Field to extract from the property (e.g., -f data.value)
-
-Use "thinr device ${deviceId} <command> --help" for more details on each command.`);
-
-}

package/lib/device.js

@@ -1,76 +0,0 @@
-import chalk from 'chalk';
-import { readConfig } from './config.js';
-import api from './api.js';
-
-/**
- * Get devices belonging to a product
- * @param {Object} filter - Filters to query devices
- * @return {Promise<Array>} List of devices
- */
-export async function getDevices(filter) {
-    // Get configuration
-    const config = readConfig();
-
-    if (!config.token || !config.server || !config.username) {
-        throw new Error('Not configured. Run thinr without parameters to set up.');
-    }
-
-    let devices = [];
-
-    // Query parameters to string
-    let queryParametersString = "";
-    for (const [key, value] of Object.entries(filter)) {
-        if ( value ) queryParametersString += key+"="+value+"&";
-    }
-
-    try {
-        const count = 50;
-        let url = `/v1/users/${config.username}/devices?count=${count}&${queryParametersString}`;
-
-        let index = 0;
-        let res_length = 0;
-
-        do {
-            // Fetch devices for the product
-            const response = await api.get(
-                `${url}index=${index}`,
-            );
-
-            res_length = response.data.length;
-            index += res_length;
-            devices = devices.concat(response.data);
-
-        } while ( res_length === count );
-
-        return devices;
-
-    } catch (error) {
-        if (error.response) {
-            // The request was made and the server responded with a status code
-            if (error.response.status === 404) {
-                throw new Error(`Product not found: ${productId}`);
-            } else if (error.response.status === 401) {
-                throw new Error('Unauthorized. Your token may have expired. Please reconfigure.');
-            } else {
-                throw new Error(`Server error: ${error.response.status} ${error.response.statusText}`);
-            }
-        } else if (error.request) {
-            // The request was made but no response was received
-            throw new Error('No response from server. Please check your connection.');
-        } else {
-            // Something happened in setting up the request that triggered an Error
-            throw new Error(`Error: ${error.message}`);
-        }
-    }
-
-}
-
-/**
- * Filter active devices from a list of devices
- * @param {Array} devices - List of devices to filter
- * @return {Array} List of active devices
- */
-export function filterActiveDevices(devices) {
-    return devices.filter(device => device.connection && device.connection.active === true);
-}
-