puter-cli 1.5.3 → 1.5.5

package/.env.example

@@ -0,0 +1,3 @@
+# Default Puter's API
+PUTER_API_BASE='https://api.puter.com'
+PUTER_BASE_URL='https://puter.com'

package/CHANGELOG.md

@@ -4,8 +4,24 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.5.5](https://github.com/HeyPuter/puter-cli/compare/v1.5.4...v1.5.5)
+
+- fix: improve error handling [`d1fa91d`](https://github.com/HeyPuter/puter-cli/commit/d1fa91db09f08238c6be684ffe4688a0064f06cd)
+
+#### [v1.5.4](https://github.com/HeyPuter/puter-cli/compare/v1.5.3...v1.5.4)
+
+> 13 February 2025
+
+- Remove "subdomain deletion" under Known Issues in README.md [`#8`](https://github.com/HeyPuter/puter-cli/pull/8)
+- dev: add last-error command, context, and modules [`#7`](https://github.com/HeyPuter/puter-cli/pull/7)
+- fix: delete a subdomain error message [`ed676dc`](https://github.com/HeyPuter/puter-cli/commit/ed676dc9d1364fabf242098e142a84c305dff177)
+- ci: fix timezone issue [`8ee6a66`](https://github.com/HeyPuter/puter-cli/commit/8ee6a66db36f7ca00eb81a12c8bac094e057f534)
+- ci: simplify timezone check [`ecf3bb9`](https://github.com/HeyPuter/puter-cli/commit/ecf3bb98bec5c093c23772280e3ee52aab8f3e8f)
+
 #### [v1.5.3](https://github.com/HeyPuter/puter-cli/compare/v1.5.2...v1.5.3)
 
+> 7 February 2025
+
 - refactor: early return in fallback behavior [`#6`](https://github.com/HeyPuter/puter-cli/pull/6)
 - fix: ignore undefined appDir when listing sites [`#5`](https://github.com/HeyPuter/puter-cli/pull/5)
 - fix: use array args when calling DeleteSubdomain [`#4`](https://github.com/HeyPuter/puter-cli/pull/4)

package/README.md

@@ -273,7 +273,12 @@ If you want to customize this tool you can follow these steps:
  ```bash
    npm install
  ```
-3. Link the CLI globally:
+3. Set your own variable environnements:
+```
+cp .env.example .env
+# update your own values in .env file
+```
+4. Link the CLI globally:
  ```bash
    npm link
  ```
@@ -282,15 +287,7 @@ If you want to customize this tool you can follow these steps:
 
 ## Known issues:
 
-Most of the functionalities are just working fine, however, some APIs related to Puter's SDK have some known issues. We tried to fix most of them but some of them are not related to us, so we let you about that in case it'll be fixed by Puter's in the future:
-
-## Delete a subdomain
-When you try to delete a subdomain which you own, you'll get `Permission denied`:
-```bash
-Failed to delete subdomain: Permission denied.
-Site ID: "sd-b019b654-e06f-48a8-917e-ae1e83825ab7" may already be deleted!
-```
-However, the query is executed successfully in the cloud and the subdomain is actually deleted.
+Most features are working fine. If you have any issues with this project or the Puter SDK, please let us know:
 
 ## Interactive Shell prompt:
 If you want to stay in the interactive shell you should provide "-f" (aka: force delete) argument, when want to delete any object:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "puter-cli",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "description": "Command line interface for Puter cloud platform",
   "main": "index.js",
   "bin": {
@@ -10,10 +10,10 @@
   "type": "module",
   "scripts": {
     "start": "node bin/index.js",
-    "test": "vitest run tests/*",
-    "test:watch": "vitest --watch tests/*",
+    "test": "TZ=UTC vitest run tests/*",
+    "test:watch": "TZ=UTC vitest --watch tests/*",
     "version": "auto-changelog -p && git add CHANGELOG.md",
-    "coverage": "vitest run --coverage"
+    "coverage": "TZ=UTC vitest run --coverage"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -26,11 +26,13 @@
   "author": "Ibrahim.H",
   "license": "MIT",
   "dependencies": {
+    "@heyputer/putility": "^1.0.2",
     "chalk": "^5.3.0",
     "cli-table3": "^0.6.5",
     "commander": "^13.0.0",
     "conf": "^12.0.0",
     "cross-spawn": "^7.0.3",
+    "dotenv": "^16.4.7",
     "glob": "^11.0.0",
     "inquirer": "^9.2.12",
     "minimatch": "^10.0.1",

package/src/commands/shell.js

@@ -4,6 +4,8 @@ import Conf from 'conf';
 import { execCommand, getPrompt } from '../executor.js';
 import { getAuthToken, login } from './auth.js';
 import { PROJECT_NAME } from '../commons.js';
+import ErrorModule from '../modules/ErrorModule.js';
+import putility, { AdvancedBase } from '@heyputer/putility';
 
 const config = new Conf({ projectName: PROJECT_NAME });
 
@@ -32,6 +34,16 @@ export async function startShell() {
     process.exit(0);
   }
 
+  const modules = [
+    ErrorModule,
+  ];
+
+  const context = new putility.libs.context.Context({
+    events: new putility.libs.event.Emitter(),
+  });
+
+  for ( const module of modules ) module({ context });
+
   try {
     console.log(chalk.green('Welcome to Puter-CLI! Type "help" for available commands.'));
     rl.setPrompt(getPrompt());
@@ -41,7 +53,7 @@ export async function startShell() {
       const trimmedLine = line.trim();
       if (trimmedLine) {
         try {
-          await execCommand(trimmedLine);
+          await execCommand(context, trimmedLine);
         } catch (error) {
           console.error(chalk.red(error.message));
         }

package/src/commands/sites.js

@@ -5,12 +5,13 @@ import { getCurrentUserName, getCurrentDirectory } from './auth.js';
 import { API_BASE, getHeaders, generateAppName, resolvePath, isValidAppName } from '../commons.js';
 import { displayNonNullValues, formatDate, isValidAppUuid } from '../utils.js';
 import { getSubdomains, createSubdomain, deleteSubdomain } from './subdomains.js';
+import { ErrorAPI } from '../modules/ErrorModule.js';
 
 
 /**
  * Listing subdomains
  */
-export async function listSites(args = {}) {
+export async function listSites(args = {}, context) {
     try {
       const data = await getSubdomains(args);
 
@@ -57,6 +58,7 @@ export async function listSites(args = {}) {
       }
   
     } catch (error) {
+      context.events.emit('error', { error });
       console.error(chalk.red('Error listing sites:'), error.message);
       throw error;
     }
@@ -121,14 +123,12 @@ export async function infoSite(args = []) {
         }
     
         const data = await response.json();
-        const result = await deleteSubdomain([uuid]);
-        if (result){
-            // check if data is empty object
-            if (Object.keys(data).length === 0){
-                console.log(chalk.green(`Site ID: "${uuid}" should be deleted.`));
-            }
+        if (Object.keys(data).length==0) {
+          console.log(chalk.green(`Site ID: "${uuid}" has been deleted.`));
+          return;
         }
-        console.log(chalk.yellow(`Site ID: "${uuid}" may already be deleted!`));
+
+        console.log(chalk.yellow(`Site ID: "${uuid}" should be deleted.`));
     } catch (error) {
         console.error(chalk.red('Error deleting site:'), error.message);
         return false;

package/src/commons.js

@@ -4,10 +4,14 @@ import { formatSize } from './utils.js';
 import { readFile } from 'fs/promises';
 import { fileURLToPath } from 'url';
 import { dirname, join } from 'path';
+import dotenv from 'dotenv';
+
+dotenv.config();
 
 export const PROJECT_NAME = 'puter-cli';
-export const API_BASE = 'https://api.puter.com';
-export const BASE_URL = 'https://puter.com';
+// If you haven't defined your own values in .env file, we'll assume you're running Puter on a local instance:
+export const API_BASE = process.env.PUTER_API_BASE || 'http://api.puter.localhost:4100';
+export const BASE_URL = process.env.PUTER_BASE_URL || 'http://puter.localhost:4100';
 
 /**
  * Get headers with the correct Content-Type for multipart form data.

package/src/executor.js

@@ -12,6 +12,7 @@ import inquirer from 'inquirer';
 import { exec } from 'node:child_process';
 import { parseArgs } from './utils.js';
 import { rl } from './commands/shell.js';
+import { ErrorAPI } from './modules/ErrorModule.js';
 
 const config = new Conf({ projectName: PROJECT_NAME });
 
@@ -61,6 +62,9 @@ const commands = {
       rl.write(commandToCopy);
     }
   },
+  'last-error': async (_, context) => {
+    context[ErrorAPI].showLast();
+  },
   'app:create': async (rawArgs) => {
     try {
       const args = parseArgs(rawArgs.join(' '));
@@ -150,7 +154,7 @@ const commands = {
  * Execute a command
  * @param {string} input The command line input
  */
-export async function execCommand(input) {
+export async function execCommand(context, input) {
   const [cmd, ...args] = input.split(' ');
 
   
@@ -184,7 +188,7 @@ export async function execCommand(input) {
   }
   if (commands[cmd]) {
     try {
-      await commands[cmd](args);
+      await commands[cmd](args, context);
     } catch (error) {
       console.error(chalk.red(`Error executing command: ${error.message}`));
     }

package/src/modules/ErrorModule.js

@@ -0,0 +1,33 @@
+const ERROR_BUFFER_LIMIT = 20;
+
+export const ErrorAPI = Symbol('ErrorAPI');
+
+export default ({ context }) => {
+    // State Variables
+    const errors = [];
+
+    context.events.on('error', (error) => {
+        context[ErrorAPI].report(error);
+    });
+
+    // Module Methods
+    context[ErrorAPI] = {
+        // Add an error to the error history
+        report (error) {
+            errors.push(error);
+            if (errors.length > ERROR_BUFFER_LIMIT) {
+                errors = errors.slice(errors.length - ERROR_BUFFER_LIMIT);
+            }
+        },
+        // Print the last error from the error history,
+        // and remove it from the history
+        showLast () {
+            const err = errors.pop();
+            if (err) {
+                console.error(err);
+            } else {
+                console.log('No errors to report');
+            }
+        }
+    };
+};

package/tests/utils.test.js

@@ -15,14 +15,15 @@ describe('formatDate', () => {
   });
 
   it('should handle different date and time', () => {
-    const dateString = '2023-01-01T00:00:00.000Z';
-    const expected = '01/01/2023, 24:00:00';
+    const dateString = '2023-01-01T01:30:05.000Z';
+    const expected = '01/01/2023, 01:30:05';
     expect(formatDate(dateString)).toBe(expected);
   });
-    it('should handle invalid date', () => {
-        const dateString = 'invalid-date';
-        expect(formatDate(dateString)).toBe('Invalid Date');
-    });
+
+  it('should handle invalid date', () => {
+      const dateString = 'invalid-date';
+      expect(formatDate(dateString)).toBe('Invalid Date');
+  });
 });
 
 describe('formatDateTime', () => {