puter-cli 1.2.1 → 1.3.0

package/.github/workflows/npm-build.yml

@@ -1,5 +1,4 @@
 # This workflow will run tests using node on every push
-
 name: Build package
 
 on: push
@@ -11,11 +10,18 @@ jobs:
     strategy:
       matrix:
         node-version: ['18.x', '20.x', '23.x']
-    
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm ci
-      - run: npm test
+    - uses: actions/checkout@v4
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+      with:
+        version: 10
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'pnpm'
+    - name: Install dependencies
+      run: pnpm install
+    - name: Run tests
+      run: pnpm test

package/CHANGELOG.md

@@ -4,8 +4,16 @@ 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.3.0](https://github.com/bitsnaps/puter-cli/compare/v1.2.1...v1.3.0)
+
+- ci: simplify workflow [`757b41c`](https://github.com/bitsnaps/puter-cli/commit/757b41caa62dc71946e7f1ffb34a32f2871248e0)
+- test: setup coverage [`2dd6500`](https://github.com/bitsnaps/puter-cli/commit/2dd650088ad9ecb6f7f9cd60b3dab80d48ac2611)
+- ci: update packages [`b346932`](https://github.com/bitsnaps/puter-cli/commit/b346932c4b6af2d8e43279ad3f35c45e451fd9f0)
+
 #### [v1.2.1](https://github.com/bitsnaps/puter-cli/compare/v1.2.0...v1.2.1)
 
+> 18 January 2025
+
 - feat: update changelog [`028ca0c`](https://github.com/bitsnaps/puter-cli/commit/028ca0cf72e09bb63468d2b0a0ba7602d3b870ad)
 - feat: auto-update changelog [`3004bed`](https://github.com/bitsnaps/puter-cli/commit/3004beda6afcf68cc916d544a45be85fa7e658e3)
 

package/README.md

@@ -330,7 +330,7 @@ This project is licensed under the **[NoHarm License](https://github.com/raisely
 
 ## Support
 
-For issues or questions, please open an issue on [GitHub](https://github.com/bitsnaps/puter-cli/issues) or contact [puter's team](hey@puter.com) if you found an issue related to Puter's APIs.
+For issues or questions, please open an issue on [GitHub](https://github.com/bitsnaps/puter-cli/issues) or contact [puter's team](mailto:hey@puter.com) if you found an issue related to Puter's APIs.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "puter-cli",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Command line interface for Puter cloud platform",
   "main": "index.js",
   "bin": {
@@ -12,7 +12,8 @@
     "start": "node bin/index.js",
     "test": "vitest run tests/*",
     "test:watch": "vitest --watch tests/*",
-    "version": "auto-changelog -p && git add CHANGELOG.md"
+    "version": "auto-changelog -p && git add CHANGELOG.md",
+    "coverage": "vitest run --coverage"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -39,6 +40,7 @@
     "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "2.1.8",
     "auto-changelog": "^2.5.0",
     "vitest": "^2.1.8"
   },

package/src/commands/auth.js

@@ -97,9 +97,10 @@ export async function login() {
  * @returns void
  */
 export async function logout() {
-  const spinner = ora('Logging out from Puter...').start();
   
+  let spinner;
   try {
+    spinner = ora('Logging out from Puter...').start();
     const token = config.get('auth_token');
     if (!token) {
       spinner.info(chalk.yellow('Already logged out'));
@@ -109,7 +110,9 @@ export async function logout() {
     config.clear(); // Remove all stored data
     spinner.succeed(chalk.green('Successfully logged out from Puter!'));
   } catch (error) {
-    spinner.fail(chalk.red('Failed to logout'));
+    if (spinner){
+      spinner.fail(chalk.red('Failed to logout'));
+    }
     console.error(chalk.red(`Error: ${error.message}`));
   }
 }

package/src/commands/shell.js

@@ -2,7 +2,7 @@ import readline from 'node:readline';
 import chalk from 'chalk';
 import Conf from 'conf';
 import { execCommand, getPrompt } from '../executor.js';
-import { getAuthToken } from './auth.js';
+import { getAuthToken, login } from './auth.js';
 import { PROJECT_NAME } from '../commons.js';
 
 const config = new Conf({ projectName: PROJECT_NAME });
@@ -24,16 +24,17 @@ export function updatePrompt(currentPath) {
 /**
  * Start the interactive shell
  */
-export function startShell() {
+export async function startShell() {
   if (!getAuthToken()) {
-    console.log(chalk.red('Please login first using: puter login'));
-    process.exit(1);
+    console.log(chalk.cyan('Please login first (or use CTRL+C to exit):'));
+    await login();
+    console.log(chalk.green(`Now just type: ${chalk.cyan('puter')} to begin.`));
+    process.exit(0);
   }
 
-  rl.setPrompt(getPrompt());
-
   try {
     console.log(chalk.green('Welcome to Puter-CLI! Type "help" for available commands.'));
+    rl.setPrompt(getPrompt());
     rl.prompt();
 
     rl.on('line', async (line) => {

package/tests/login.test.js

@@ -6,7 +6,7 @@ import ora from 'ora';
 import chalk from 'chalk';
 import fetch from 'node-fetch';
 import Conf from 'conf';
-import { BASE_URL } from '../src/commons.js';
+import { BASE_URL, PROJECT_NAME, API_BASE } from '../src/commons.js';
 
 // Mock console to prevent actual logging
 vi.spyOn(console, 'log').mockImplementation(() => {});
@@ -18,26 +18,19 @@ vi.mock('chalk', () => ({
   default: {
     green: vi.fn(text => text),
     red: vi.fn(text => text),
-    dim: vi.fn(text => text)
+    dim: vi.fn(text => text),
+    yellow: vi.fn(text => text),
+    cyan: vi.fn(text => text),
   }
 }));
 vi.mock('node-fetch');
 
-// Mock Conf
-vi.mock('conf', () => {
-  return {
-    default: vi.fn().mockImplementation(() => ({
-      set: vi.fn(),
-      get: vi.fn(),
-    }))
-  }
-});
-
 // Create a mock spinner object
 const mockSpinner = {
   start: vi.fn().mockReturnThis(),
   succeed: vi.fn().mockReturnThis(),
-  fail: vi.fn().mockReturnThis()
+  fail: vi.fn().mockReturnThis(),
+  info: vi.fn().mockReturnThis(),
 };
 
 // Mock ora
@@ -45,10 +38,23 @@ vi.mock('ora', () => ({
   default: vi.fn(() => mockSpinner)
 }));
 
+// Mock Conf
+vi.mock('conf', () => {
+  return {
+    default: vi.fn().mockImplementation(() => ({
+      set: vi.fn(),
+      get: vi.fn(),
+      clear: vi.fn(),
+    })),
+  };
+});
 
 describe('auth.js', () => {
+  // let config;
+
   beforeEach(() => {
     vi.clearAllMocks();
+    // config = new Conf({ projectName: PROJECT_NAME });
   });
 
   describe('login', () => {
@@ -85,73 +91,74 @@ describe('auth.js', () => {
       // Verify spinner methods were called
       expect(mockSpinner.start).toHaveBeenCalled();
       expect(mockSpinner.succeed).toHaveBeenCalled();
-      
     });
-/*
+
     it('should fail login with invalid credentials', async () => {
       inquirer.prompt.mockResolvedValue({ username: 'testuser', password: 'testpass' });
       fetch.mockResolvedValue({
         json: vi.fn().mockResolvedValue({ proceed: false }),
         ok: true,
       });
-      const spinner = { start: vi.fn(), fail: vi.fn() };
-      ora.mockReturnValue(spinner);
 
       await login();
-
-      expect(spinner.fail).toHaveBeenCalledWith(chalk.red('Login failed. Please check your credentials.'));
+      expect(mockSpinner.fail).toHaveBeenCalledWith(chalk.red('Login failed. Please check your credentials.'));
     });
 
     it('should handle login error', async () => {
       inquirer.prompt.mockResolvedValue({ username: 'testuser', password: 'testpass' });
       fetch.mockRejectedValue(new Error('Network error'));
-      const spinner = { start: vi.fn(), fail: vi.fn() };
-      ora.mockReturnValue(spinner);
-
-      await login();
 
-      expect(spinner.fail).toHaveBeenCalledWith(chalk.red('Failed to login'));
-    });*/
+      await expect(login()).rejects.toThrow('Network error');
+      expect(mockSpinner.fail).toHaveBeenCalledWith(chalk.red('Failed to login'));
+      expect(console.error).toHaveBeenCalledWith(chalk.red('Error: Network error'));
+    });
   });
-/*
+
+
   describe('logout', () => {
-    it('should logout successfully', async () => {
-      config.get.mockReturnValue('testtoken');
-      const spinner = { start: vi.fn(), succeed: vi.fn() };
-      ora.mockReturnValue(spinner);
+    let config;
 
-      await logout();
+    beforeEach(() => {
+      vi.clearAllMocks();
+      config = new Conf({ projectName: PROJECT_NAME });
+      // config.clear = vi.fn();      
+    });
 
+    it.skip('should logout successfully', async () => {
+      // Mock config.get to return a token
+      config.get = vi.fn().mockReturnValue('testtoken');
+      await logout();
+      // Verify config.clear was called
       expect(config.clear).toHaveBeenCalled();
-      expect(spinner.succeed).toHaveBeenCalledWith(chalk.green('Successfully logged out from Puter!'));
+      expect(mockSpinner.succeed).toHaveBeenCalledWith(chalk.green('Successfully logged out from Puter!'));
     });
 
     it('should handle already logged out', async () => {
-      config.get.mockReturnValue(null);
-      const spinner = { start: vi.fn(), info: vi.fn() };
-      ora.mockReturnValue(spinner);
+      config.get = vi.fn().mockReturnValue(null);
 
       await logout();
 
-      expect(spinner.info).toHaveBeenCalledWith(chalk.yellow('Already logged out'));
+      expect(mockSpinner.info).toHaveBeenCalledWith(chalk.yellow('Already logged out'));
     });
 
-    it('should handle logout error', async () => {
-      config.get.mockReturnValue('testtoken');
-      config.clear.mockImplementation(() => { throw new Error('Config error'); });
-      const spinner = { start: vi.fn(), fail: vi.fn() };
-      ora.mockReturnValue(spinner);
+    it.skip('should handle logout error', async () => {
+      config.get = vi.fn().mockReturnValue('testtoken');
+      config.clear = vi.fn().mockImplementation(() => { throw new Error('Config error'); });
 
       await logout();
 
-      expect(spinner.fail).toHaveBeenCalledWith(chalk.red('Failed to logout'));
+      expect(mockSpinner.fail).toHaveBeenCalled();
+      expect(mockSpinner.fail).toHaveBeenCalledWith(chalk.red('Failed to logout'));
     });
+    
   });
+  
 
   describe('getUserInfo', () => {
     it('should fetch user info successfully', async () => {
+      // Mock fetch response
       fetch.mockResolvedValue({
-        json: vi.fn().mockResolvedValue({
+        json: () => Promise.resolve({
           username: 'testuser',
           uuid: 'testuuid',
           email: 'test@example.com',
@@ -165,6 +172,7 @@ describe('auth.js', () => {
 
       await getUserInfo();
 
+      // Verify fetch was called with correct parameters
       expect(fetch).toHaveBeenCalledWith(`${API_BASE}/whoami`, {
         method: 'GET',
         headers: expect.any(Object),
@@ -172,21 +180,23 @@ describe('auth.js', () => {
     });
 
     it('should handle fetch user info error', async () => {
+      // Mock fetch to throw an error
       fetch.mockRejectedValue(new Error('Network error'));
 
       await getUserInfo();
 
+      // Verify console.error was called
       expect(console.error).toHaveBeenCalledWith(chalk.red('Failed to get user info.\nError: Network error'));
     });
   });
 
-  describe('isAuthenticated', () => {
-    it('should return true if auth token exists', () => {
-      config.get.mockReturnValue('testtoken');
 
-      const result = isAuthenticated();
+  describe('Authentication', () => {
+    let config;
 
-      expect(result).toBe(true);
+    beforeEach(() => {
+      vi.clearAllMocks();
+      config = new Conf({ projectName: PROJECT_NAME });
     });
 
     it('should return false if auth token does not exist', () => {
@@ -196,37 +206,42 @@ describe('auth.js', () => {
 
       expect(result).toBe(false);
     });
-  });
 
-  describe('getAuthToken', () => {
-    it('should return the auth token', () => {
-      config.get.mockReturnValue('testtoken');
+    it('should return null if the auth_token is not defined', () => {
+      config.get.mockReturnValue(null);
 
       const result = getAuthToken();
 
-      expect(result).toBe('testtoken');
+      expect(result).toBeUndefined();
     });
-  });
 
-  describe('getCurrentUserName', () => {
-    it('should return the current username', () => {
-      config.get.mockReturnValue('testuser');
+    it('should return the current username if it is defined', () => {
+      config.get.mockReturnValue(null);
 
       const result = getCurrentUserName();
 
-      expect(result).toBe('testuser');
+      expect(result).toBeUndefined();
     });
+
   });
 
-  describe('getCurrentDirectory', () => {
-    it('should return the current directory', () => {
-      config.get.mockReturnValue('/testuser');
+  // describe('getCurrentDirectory', () => {
+  //   let config;
 
-      const result = getCurrentDirectory();
+  //   beforeEach(() => {
+  //     vi.clearAllMocks();
+  //     config = new Conf({ projectName: PROJECT_NAME });
+  //     // config.get = vi.fn().mockReturnValue('testtoken')
+  //   });
 
-      expect(result).toBe('/testuser');
-    });
-  });
+  //   it('should return the current directory', () => {
+  //     config.get.mockReturnValue('/testuser');
+
+  //     const result = getCurrentDirectory();
+
+  //     expect(result).toBe('/testuser');
+  //   });
+  // });
 
   describe('getUsageInfo', () => {
     it('should fetch usage info successfully', async () => {
@@ -264,5 +279,6 @@ describe('auth.js', () => {
       expect(console.error).toHaveBeenCalledWith(chalk.red('Failed to fetch usage information.\nError: Network error'));
     });
   });
-  */
+  
+
 });