@heyputer/shell 2.1.0 → 3.0.0

package/src/commons.js

@@ -8,11 +8,10 @@ import dotenv from 'dotenv';
 
 dotenv.config();
 
-export const PROJECT_NAME = 'puter-cli';
+export const PROJECT_NAME = 'puter-sh';
 // If you haven't defined your own values in .env file, we'll assume you're running Puter on a local instance:
 export let API_BASE = process.env.PUTER_API_BASE || 'https://api.puter.com';
 export let BASE_URL = process.env.PUTER_BASE_URL || 'https://puter.com';
-export const NULL_UUID = '00000000-0000-0000-0000-000000000000';
 
 export const reconfigureURLs = ({ api, base }) => {
     API_BASE = api;
@@ -39,64 +38,6 @@ export function getHeaders(contentType = 'application/json') {
     }
 }
 
-/**
- * Generate a random app name
- * @returns a random app name or null if it fails
- * @see: [randName](https://github.com/HeyPuter/puter/blob/06a67a3b223a6cbd7ec2e16853b6d2304f621a88/src/puter-js/src/index.js#L389)
- */
-export function generateAppName(separateWith = '-'){
-  console.log(chalk.cyan('Generating random name...'));
-  try {        
-      const first_adj = ['helpful','sensible', 'loyal', 'honest', 'clever', 'capable','calm', 'smart', 'genius', 'bright', 'charming', 'creative', 'diligent', 'elegant', 'fancy', 
-      'colorful', 'avid', 'active', 'gentle', 'happy', 'intelligent', 'jolly', 'kind', 'lively', 'merry', 'nice', 'optimistic', 'polite', 
-      'quiet', 'relaxed', 'silly', 'victorious', 'witty', 'young', 'zealous', 'strong', 'brave', 'agile', 'bold'];
-
-      const nouns = ['street', 'roof', 'floor', 'tv', 'idea', 'morning', 'game', 'wheel', 'shoe', 'bag', 'clock', 'pencil', 'pen', 
-      'magnet', 'chair', 'table', 'house', 'dog', 'room', 'book', 'car', 'cat', 'tree', 
-      'flower', 'bird', 'fish', 'sun', 'moon', 'star', 'cloud', 'rain', 'snow', 'wind', 'mountain', 
-      'river', 'lake', 'sea', 'ocean', 'island', 'bridge', 'road', 'train', 'plane', 'ship', 'bicycle', 
-      'horse', 'elephant', 'lion', 'tiger', 'bear', 'zebra', 'giraffe', 'monkey', 'snake', 'rabbit', 'duck', 
-      'goose', 'penguin', 'frog', 'crab', 'shrimp', 'whale', 'octopus', 'spider', 'ant', 'bee', 'butterfly', 'dragonfly', 
-      'ladybug', 'snail', 'camel', 'kangaroo', 'koala', 'panda', 'piglet', 'sheep', 'wolf', 'fox', 'deer', 'mouse', 'seal',
-      'chicken', 'cow', 'dinosaur', 'puppy', 'kitten', 'circle', 'square', 'garden', 'otter', 'bunny', 'meerkat', 'harp']
-
-      // return a random combination of first_adj + noun + number (between 0 and 9999)
-      // e.g. clever-idea-123
-      const appName = first_adj[Math.floor(Math.random() * first_adj.length)] + separateWith + nouns[Math.floor(Math.random() * nouns.length)] + separateWith + Math.floor(Math.random() * 10000);
-      console.log(chalk.green(`Name: "${appName}"`));
-      return appName;
-  } catch (error) {
-      console.error(`Error: ${error.message}`);
-      return null;
-  }
-}
-
-/**
- * Display data in a structured format
- * @param {Array} data - The data to display
- * @param {Object} options - Display options
- * @param {Array} options.headers - Headers for the table
- * @param {Array} options.columns - Columns to display
- * @param {number} options.columnWidth - Width of each column
- */
-export function displayTable(data, options = {}) {
-  const { headers = [], columns = [], columnWidth = 20 } = options;
-
-  // Create the header row
-  const headerRow = headers.map(header => chalk.cyan(header.padEnd(columnWidth))).join(' | ');
-  console.log(headerRow);
-  console.log(chalk.dim('-'.repeat(headerRow.length)));
-
-  // Create and display each row of data
-  data.forEach(item => {
-      const row = columns.map(col => {
-          const value = item[col] || 'N/A';
-          return value.toString().padEnd(columnWidth);
-      }).join(' | ');
-      console.log(row);
-  });
-}
-
 /**
  * Display structured ouput of disk usage informations
  */
@@ -114,225 +55,109 @@ export function showDiskSpaceUsage(data) {
 }
 
 /**
- * Resolve a relative path to an absolute path
+ * The home anchor as typed by the user.
+ */
+export const HOME = '~';
+
+/**
+ * The concrete home directory ("/<username>") for the active profile.
+ *
+ * Resolved from the token at login and refreshed on every run -- never read
+ * from a cached username -- so it always names the account's current home.
+ * Null until a profile is selected.
+ */
+export let HOME_PATH = null;
+
+/**
+ * Point the home anchor at the current account's home directory.
+ * @param {string} homePath - The concrete home path, e.g. "/alice"
+ */
+export const setHomePath = (homePath) => {
+    HOME_PATH = homePath;
+};
+
+/**
+ * Expand a leading "~" to the resolved home directory. Paths that are not
+ * home-anchored are returned untouched, as are all paths when no profile is
+ * active yet (nothing to expand against).
+ * @param {string} p - The path to expand
+ * @returns {string} The expanded path
+ */
+export function expandHome(p) {
+    if (!HOME_PATH || typeof p !== 'string') return p;
+    if (p === HOME) return HOME_PATH;
+    if (p.startsWith('~/')) return `${HOME_PATH}${p.slice(1)}`;
+    return p;
+}
+
+/**
+ * Check whether a path is already fully-qualified (root- or home-anchored) and
+ * therefore must NOT be resolved against the current working directory.
+ * @param {string} p - The path to test
+ * @returns {boolean} True if the path is absolute or home-anchored
+ */
+export function isAbsolutePath(p) {
+    if (typeof p !== 'string') return false;
+    return p === HOME || p.startsWith('~/') || p.startsWith('/');
+}
+
+/**
+ * Resolve a path against the current working directory.
+ *
+ * If `relativePath` is itself absolute ("/...") or home-anchored ("~", "~/..."),
+ * it replaces `currentPath` entirely instead of being appended to it.
+ *
  * @param {string} currentPath - The current working directory
- * @param {string} relativePath - The relative path to resolve
- * @returns {string} The resolved absolute path
+ * @param {string} relativePath - The path to resolve
+ * @returns {string} The resolved path, preserving a "~" root if present
  */
 export function resolvePath(currentPath, relativePath) {
-    // Normalize the current path (remove trailing slashes)
-    currentPath = currentPath.replace(/\/+$/, '');
+    // A fully-qualified path re-roots the resolution rather than extending it.
+    if (isAbsolutePath(relativePath)) {
+        currentPath = relativePath.startsWith('~') ? HOME : '/';
+        relativePath = relativePath.replace(/^~/, '');
+    }
+
+    // Track whether we are anchored at home so "~" survives normalization.
+    const atHome = currentPath === HOME || currentPath.startsWith('~/');
+    const root = atHome ? HOME : '';
 
-    // Split the relative path into parts
-    const parts = relativePath.split('/').filter(p => p); // Remove empty parts
+    // Strip the root and any trailing slashes, leaving bare segments.
+    let parts = currentPath
+        .replace(/^~/, '')
+        .split('/')
+        .filter(p => p);
 
-    // Handle each part of the relative path
-    for (const part of parts) {
+    for (const part of relativePath.split('/').filter(p => p)) {
         if (part === '..') {
-            // Move one level up
-            const currentParts = currentPath.split('/').filter(p => p);
-            if (currentParts.length > 0) {
-                currentParts.pop(); // Remove the last part
-            }
-            currentPath = '/' + currentParts.join('/');
+            // Clamp at the root: "~/.." stays at home, "/.." stays at "/".
+            parts.pop();
         } else if (part === '.') {
-            // Stay in the current directory (no change)
             continue;
         } else {
-            // Move into a subdirectory
-            currentPath += `/${part}`;
+            parts.push(part);
         }
     }
 
-    // Normalize the final path (remove duplicate slashes)
-    currentPath = currentPath.replace(/\/+/g, '/');
-
-    // Ensure the path ends with a slash if it's the root
-    if (currentPath === '') {
-        currentPath = '/';
-    }
-
-    return currentPath;
+    const joined = parts.join('/');
+    // Expand "~" so callers and the API always see a concrete "/<username>" path.
+    if (!joined) return expandHome(root || '/');
+    return expandHome(`${root}/${joined}`);
 }
 
 /**
- * Resolve a remote path to an absolute path, handling both absolute and relative paths.
+ * Resolve a remote path to a fully-qualified path.
  * @param {string} currentPath - The current working directory.
  * @param {string} remotePath - The remote path to resolve.
- * @returns {string} The resolved absolute path.
+ * @returns {string} The resolved path.
  */
 export function resolveRemotePath(currentPath, remotePath) {
-    if (remotePath.startsWith('/')) {
-        return remotePath;
+    if (isAbsolutePath(remotePath)) {
+        return expandHome(remotePath);
     }
     return resolvePath(currentPath, remotePath);
 }
 
-/**
-* Checks if a given string is a valid app name.
-* The name must:
-*  - Not be '.' or '..'
-*  - Not contain path separators ('/' or '\\')
-*  - Not contain wildcard characters ('*')
-*  - (Optional) Contain only allowed characters (letters, numbers, spaces, underscores, hyphens)
-*
-* @param {string} name - The app name to validate.
-* @returns {boolean} - Returns true if valid, false otherwise.
-*/
-export function isValidAppName(name) {
-   // Ensure the name is a non-empty string
-   if (typeof name !== 'string' || name.trim().length === 0) {
-       return false;
-   }
-
-   // Trim whitespace from both ends
-   const trimmedName = name.trim();
-
-   // Reject reserved names
-   if (trimmedName === '.' || trimmedName === '..') {
-       return false;
-   }
-
-   // Regex patterns for invalid characters
-   const invalidPattern = /[\/\\*]/; // Disallow /, \, and *
-
-   if (invalidPattern.test(trimmedName)) {
-       return false;
-   }
-
-   // Optional: Define allowed characters pattern
-   // Uncomment the following lines if you want to enforce allowed characters
-   /*
-   const allowedPattern = /^[A-Za-z0-9 _-]+$/;
-   if (!allowedPattern.test(trimmedName)) {
-       return false;
-   }
-   */
-
-   // All checks passed
-   return true;
-}
-
-/**
- * Generate the default home page for a new web application
- * @param {string} appName The name of the web application
- * @returns HTML template of the app
- */
-export function getDefaultHomePage(appName, jsFiles = [], cssFiles= []) {
-    const defaultIndexContent = `<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>${appName}</title>
-    ${cssFiles.map(css => `<link href="${css}" rel="stylesheet">`).join('\n  ')}
-    <style>
-        body {
-            font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
-            line-height: 1.6;
-            max-width: 800px;
-            margin: 0 auto;
-            padding: 20px;
-            background: #f9fafb;
-            color: #1f2937;
-        }
-        .container {
-            background: white;
-            padding: 2rem;
-            border-radius: 8px;
-            box-shadow: 0 1px 3px rgba(0,0,0,0.1);
-        }
-        h1 {
-            color: #2563eb;
-            margin-bottom: 1rem;
-        }
-        .code-block {
-            background: #f1f5f9;
-            padding: 1rem;
-            border-radius: 4px;
-            font-family: monospace;
-            overflow-x: auto;
-        }
-        .tip {
-            background: #dbeafe;
-            border-left: 4px solid #2563eb;
-            padding: 1rem;
-            margin: 1rem 0;
-        }
-        .links {
-            display: flex;
-            gap: 1rem;
-            margin-top: 2rem;
-        }
-        .links a {
-            color: #2563eb;
-            text-decoration: none;
-        }
-        .links a:hover {
-            text-decoration: underline;
-        }
-        .footer {
-            text-align: center;
-            margin-top: 50px;
-            color: var(--color-grey);
-            font-size: 0.9rem;
-        }
-    </style>
-</head>
-<body>
-    <div class="container">
-        <h1>🚀 Welcome to ${appName}!</h1>
-        
-        <p>This is your new website powered by Puter. You can start customizing it right away!</p>
-
-        <div class="tip">
-            <strong>Quick Tip:</strong> Replace this content with your own by editing the <code>index.html</code> file.
-        </div>
-
-        <h2>🌟 Getting Started</h2>
-        
-        <p>Here's a simple example using Puter.js:</p>
-        
-        <div class="code-block">
-&lt;script src="https://js.puter.com/v2/">&lt;/script>
-&lt;script>
-    // Create a new file in the cloud
-    puter.fs.write('hello.txt', 'Hello, Puter!')
-        .then(file => console.log(\`File created at: \${file.path}\`));
-&lt;/script>
-        </div>
-
-        <h2>💡 Key Features</h2>
-        <ul>
-            <li>Cloud Storage</li>
-            <li>AI Services (GPT-4, DALL-E)</li>
-            <li>Static Website Hosting</li>
-            <li>Key-Value Store</li>
-            <li>Authentication</li>
-        </ul>
-
-        <div class="links">
-            <a href="https://docs.puter.com" target="_blank">📚 Documentation</a>
-            <a href="https://discord.gg/puter" target="_blank">💬 Discord Community</a>
-            <a href="https://github.com/HeyPuter" target="_blank">👩‍💻 GitHub</a>
-        </div>
-    </div>
-
-<footer class="footer">
-    &copy; 2025 ${appName}. All rights reserved.
-</footer>
-
-    <div id="${(jsFiles.length && jsFiles.some(f => f.includes('react'))) ? 'root' : 'app'}"></div>
-${jsFiles.map(js => 
-`<script ${js.endsWith('app.js') ? 'type="text/babel"' : ''} src="${js}"></script>`
-).join('\n  ')}
-</body>
-</html>`;
-    
-    return defaultIndexContent;
-}
-
-
 /**
  * Read latest package from package file
  */

package/src/executor.js

@@ -1,21 +1,17 @@
 import chalk from 'chalk';
 import Conf from 'conf';
-import { listApps, appInfo, createApp, updateApp, deleteApp } from './commands/apps.js';
-import { listSites, createSite, deleteSite, infoSite } from './commands/sites.js';
 import {
   listFiles, makeDirectory, renameFileOrDirectory,
   removeFileOrDirectory, emptyTrash, changeDirectory, showCwd,
   getInfo, getDiskUsage, createFile, readFile, uploadFile,
   downloadFile, copyFile, syncDirectory, editFile
 } from './commands/files.js';
-import { getUserInfo, getUsageInfo, login } from './commands/auth.js';
-import { deploy } from './commands/deploy.js';
-import { PROJECT_NAME, API_BASE, getHeaders } from './commons.js';
-import inquirer from 'inquirer';
+import { getUserInfo, getUsageInfo, login, getCurrentDirectory } from './commands/auth.js';
+import { PROJECT_NAME, API_BASE, HOME, expandHome, getHeaders } from './commons.js';
 import { exec } from 'node:child_process';
-import { parseArgs, getSystemEditor } from './utils.js';
+import { getSystemEditor } from './utils.js';
 import { rl } from './commands/shell.js';
-import { showLast } from './modules/ErrorModule.js'
+import { showLast, report, formatError, isAuthError } from './modules/ErrorModule.js'
 
 const config = new Conf({ projectName: PROJECT_NAME });
 
@@ -27,7 +23,7 @@ const commandHistory = [];
  * @returns The current prompt
  */
 export function getPrompt() {
-  return chalk.cyan(`puter@${config.get('cwd').slice(1)}> `);
+  return chalk.cyan(`puter@${getCurrentDirectory().slice(1)}> `);
 }
 
 const commands = {
@@ -40,12 +36,6 @@ const commands = {
   login: login,
   whoami: getUserInfo,
   stat: getInfo,
-  apps: async (args) => {
-    await listApps({
-      statsPeriod: args[0] || 'all'
-    });
-  },
-  app: appInfo,
   history: async (args) => {
     const lineNumber = parseInt(args[0]);
 
@@ -67,64 +57,6 @@ const commands = {
     }
   },
   'last-error': showLast,
-  'app:create': async (rawArgs) => {
-    try {
-      const args = parseArgs(rawArgs.join(' '));
-      // Consider using explicit argument definition if necessary
-      // const args = parseArgs(rawArgs.join(' '), {string: ['description', 'url'],
-      //   alias: { d: 'description', u: 'url', },
-      // });
-
-      // NOTE: Keep the check for now at the function level, move the check here so in the future we'll use the function for non-interactive command mode.
-      await createApp({
-        name: args._[0],
-        directory: args._[1] || '',
-        description: args.description || '',
-        url: args.url || 'https://dev-center.puter.com/coming-soon.html'
-      });
-    } catch (error) {
-      console.error(chalk.red(error.message));
-    }
-  },
-  'app:update': async (args) => {
-    if (args.length < 1) {
-      console.log(chalk.red('Usage: app:update <name> <remote_dir>'));
-      return;
-    }
-    await updateApp(args);
-  },
-  'app:delete': async (rawArgs) => {
-    const args = parseArgs(rawArgs.join(' '), {
-      string: ['_'],
-      boolean: ['f'],
-      configuration: {
-        'populate--': true
-      }
-    });
-    if (args._.length < 1) {
-      console.log(chalk.red('You must specify the app name:'));
-      console.log(chalk.yellow('Example: app:delete <name>'));
-      return;
-    }
-    const name = args._[0];
-    const force = !!args.f;
-
-    if (!force) {
-      const { confirm } = await inquirer.prompt([
-        {
-          type: 'confirm',
-          name: 'confirm',
-          message: chalk.yellow(`Are you sure you want to delete "${name}"?`),
-          default: false
-        }
-      ]);
-      if (!confirm) {
-        console.log(chalk.yellow('Operation cancelled.'));
-        return false;
-      }
-    }
-    await deleteApp(name);
-  },
   ls: listFiles,
   cd: async (args) => {
     await changeDirectory(args);
@@ -144,11 +76,6 @@ const commands = {
   pull: downloadFile,
   update: syncDirectory,
   edit: editFile,
-  sites: listSites,
-  site: infoSite,
-  'site:delete': deleteSite,
-  'site:create': createSite,
-  'site:deploy': deploy,
 };
 
 /**
@@ -190,7 +117,13 @@ export async function execCommand(input) {
     try {
       await commands[cmd](args);
     } catch (error) {
-      console.error(chalk.red(`Error executing command: ${error.message}`));
+      report(error);
+      if (isAuthError(error)) {
+        console.error(chalk.red('Your session has expired or its token is no longer valid.'));
+        console.error(chalk.cyan('Type "login" to sign in again.'));
+      } else {
+        console.error(chalk.red(`Error executing command: ${formatError(error)}`));
+      }
     }
     return;
   }
@@ -238,32 +171,6 @@ function showHelp(command) {
       ${chalk.cyan('usage')}
       Show usage information.
     `,
-    apps: `
-      ${chalk.cyan('apps [period]')}
-      List all your apps.
-      period: today, yesterday, 7d, 30d, this_month, last_month
-      Example: apps today
-    `,
-    app: `
-      ${chalk.cyan('app <app_name>')}
-      Get application information.
-      Example: app myapp
-    `,
-    'app:create': `
-      ${chalk.cyan('app:create <name> <remote_dir>')}
-      Create a new app.
-      Example: app:create myapp https://myapp.puter.site
-    `,
-    'app:update': `
-      ${chalk.cyan('app:update <name> [dir]')}
-      Update an app.
-      Example: app:update myapp .
-    `,
-    'app:delete': `
-      ${chalk.cyan('app:delete <name>')}
-      Delete an app.
-      Example: app:delete myapp
-    `,
     ls: `
       ${chalk.cyan('ls [dir]')}
       List files and directories.
@@ -334,30 +241,6 @@ function showHelp(command) {
 
       System editor: ${chalk.green(getSystemEditor())}
     `,
-    sites: `
-      ${chalk.cyan('sites')}
-      List sites and subdomains.
-    `,
-    site: `
-      ${chalk.cyan('site <site_uid>')}
-      Get site information by UID.
-      Example: site sd-123456
-    `,
-    'site:delete': `
-      ${chalk.cyan('site:delete <uid>')}
-      Delete a site by UID.
-      Example: site:delete sd-123456
-    `,
-    'site:create': `
-      ${chalk.cyan('site:create <app_name> [<dir>] [--subdomain=<name>]')}
-      Create a static website from directory.
-      Example: site:create mywebsite /path/to/dir --subdomain=mywebsite
-    `,
-    'site:deploy': `
-      ${chalk.cyan('site:deploy [<remote_dir>] [--subdomain=<subdomain>]')}
-      Deploy a local web project to Puter.
-      Example: site:deploy ./my-app --subdomain my-app
-    `,
     '!': `
       ${chalk.cyan('!<command>')}
       Execute a command on the host machine.

package/src/modules/ErrorModule.js

@@ -17,4 +17,65 @@ export const showLast = () => {
   } else {
     console.log('No errors to report');
   }
-}
+}
+
+/**
+ * The Puter API rejects with plain objects rather than Error instances, e.g.
+ * `{ status: 401, message: 'Unauthorized' }`. Node renders such a value as the
+ * useless "#<Object>", so normalize everything to a real Error before it is
+ * shown or rethrown.
+ *
+ * @param {*} error - Any thrown or rejected value
+ * @returns {Error} An Error carrying the original `status`/`code` when present
+ */
+export const normalizeError = (error) => {
+  if (error instanceof Error) return error;
+
+  if (error && typeof error === 'object') {
+    // Puter nests driver failures one level down as `{ error: { code, message } }`.
+    const detail = error.error && typeof error.error === 'object' ? error.error : error;
+    const message = detail.message || detail.code || JSON.stringify(error);
+    const normalized = new Error(message);
+    if (detail.code !== undefined) normalized.code = detail.code;
+    if (error.status !== undefined) normalized.status = error.status;
+    return normalized;
+  }
+
+  return new Error(String(error ?? 'Unknown error'));
+};
+
+// Server codes that mean "this token will not work again", as opposed to a
+// transient failure worth retrying.
+const AUTH_ERROR_CODES = [
+  'token_auth_failed',
+  'token_unsupported',
+  'invalid_token',
+  'auth_failed',
+];
+
+/**
+ * Whether an error means the stored token is no longer usable and the user has
+ * to log in again.
+ *
+ * @param {*} error - Any thrown or rejected value
+ * @returns {boolean} True if the session is invalid
+ */
+export const isAuthError = (error) => {
+  const status = error?.status ?? error?.response?.status;
+  if (status === 401 || status === 403) return true;
+
+  const code = String(error?.code ?? error?.error?.code ?? '').toLowerCase();
+  if (AUTH_ERROR_CODES.includes(code)) return true;
+
+  const message = String(error?.message ?? '').toLowerCase();
+  return AUTH_ERROR_CODES.some(c => message.includes(c))
+    || message.includes('unauthorized')
+    || message.includes('invalid token');
+};
+
+/**
+ * A single-line, human-readable description of any thrown value.
+ * @param {*} error - Any thrown or rejected value
+ * @returns {string} The message to display
+ */
+export const formatError = (error) => normalizeError(error).message;