canvaslms-cli 1.1.0

package/commands/config.js

@@ -0,0 +1,242 @@
+/**
+ * Config command
+ */
+
+const { 
+  configExists, 
+  readConfig, 
+  saveConfig, 
+  deleteConfig, 
+  getConfigPath 
+} = require('../lib/config');
+const { createReadlineInterface, askQuestion } = require('../lib/interactive');
+
+async function showConfig() {
+  console.log('📋 Canvas CLI Configuration\n');
+  
+  const configPath = getConfigPath();
+  const hasConfig = configExists();
+  
+  console.log(`Configuration file: ${configPath}`);
+  console.log(`Status: ${hasConfig ? '✅ Found' : '❌ Not found'}\n`);
+  
+  if (hasConfig) {
+    const config = readConfig();
+    if (config) {
+      console.log('Current configuration:');
+      console.log(`  🌐 Canvas Domain: ${config.domain || 'Not set'}`);
+      console.log(`  🔑 API Token: ${config.token ? config.token.substring(0, 10) + '...' : 'Not set'}`);
+      console.log(`  📅 Created: ${config.createdAt ? new Date(config.createdAt).toLocaleString() : 'Unknown'}`);
+      console.log(`  🔄 Last Updated: ${config.lastUpdated ? new Date(config.lastUpdated).toLocaleString() : 'Unknown'}`);
+    }  } else {
+    console.log('❌ No configuration found.');
+  }
+  
+  console.log('\n📚 Available commands:');
+  console.log('  canvas config setup      # Interactive setup wizard');
+  console.log('  canvas config edit       # Edit existing configuration');
+  console.log('  canvas config show       # Show current configuration');
+  console.log('  canvas config delete     # Delete configuration file');
+  console.log('  canvas config path       # Show configuration file path');
+  
+  console.log('\n🔧 Manual setup:');
+  console.log('1. Get your Canvas API token:');
+  console.log('   - Log into your Canvas instance');
+  console.log('   - Go to Account → Settings');
+  console.log('   - Scroll down to "Approved Integrations"');
+  console.log('   - Click "+ New Access Token"');
+  console.log('   - Copy the generated token');
+  console.log('2. Run "canvas config setup" to configure');
+  
+  console.log('\n📖 Example usage after setup:');
+  console.log('  canvas list              # List starred courses');
+  console.log('  canvas list -a           # List all enrolled courses');
+  console.log('  canvas submit            # Interactive assignment submission');
+  console.log('  canvas profile           # Show user profile');
+  console.log('  canvas assignments 12345 # Show assignments for course');
+  console.log('  canvas grades            # Show grades for all courses');
+}
+
+async function setupConfig() {
+  const rl = createReadlineInterface();
+  
+  try {
+    console.log('🚀 Canvas CLI Configuration Setup\n');
+    
+    // Check if config already exists
+    if (configExists()) {
+      const config = readConfig();
+      console.log('📋 Existing configuration found:');
+      console.log(`  Domain: ${config.domain || 'Not set'}`);
+      console.log(`  Token: ${config.token ? 'Set (hidden)' : 'Not set'}\n`);
+      
+      const overwrite = await askQuestion(rl, 'Do you want to overwrite the existing configuration? (y/N): ');
+      if (overwrite.toLowerCase() !== 'y' && overwrite.toLowerCase() !== 'yes') {
+        console.log('Setup cancelled.');
+        return;
+      }
+      console.log('');
+    }
+      // Get Canvas domain
+    const currentConfig = readConfig();
+      let domain = await askQuestion(rl, `Enter your Canvas domain${currentConfig?.domain ? ` (${currentConfig.domain})` : ''}: `);
+    if (!domain && currentConfig?.domain) {
+      domain = currentConfig.domain;
+    }
+    
+    if (!domain) {
+      console.log('❌ Canvas domain is required.');
+      return;
+    }
+    
+    // Validate and clean domain
+    domain = domain.replace(/^https?:\/\//, '').replace(/\/$/, '');
+    if (!domain.includes('.')) {
+      console.log('❌ Invalid domain format. Please enter a valid domain (e.g., school.instructure.com)');
+      return;
+    }
+    
+    console.log(`✅ Domain set to: ${domain}\n`);
+      // Get API token
+    const defaultToken = currentConfig?.token || '';
+    let token = await askQuestion(rl, `Enter your Canvas API token${defaultToken ? ' (press Enter to keep current)' : ''}: `);
+    if (!token && defaultToken) {
+      token = defaultToken;
+    }
+    
+    if (!token) {
+      console.log('❌ Canvas API token is required.');
+      console.log('\n🔑 To get your API token:');
+      console.log('1. Log into your Canvas instance');
+      console.log('2. Go to Account → Settings');
+      console.log('3. Scroll down to "Approved Integrations"');
+      console.log('4. Click "+ New Access Token"');
+      console.log('5. Copy the generated token');
+      return;
+    }
+    
+    // Validate token format (basic check)
+    if (token.length < 10) {
+      console.log('❌ API token seems too short. Please check your token.');
+      return;
+    }
+    
+    console.log('✅ Token received\n');
+    
+    // Save configuration
+    const saved = saveConfig(domain, token);
+    if (saved) {
+      console.log('🎉 Configuration setup completed successfully!');
+      console.log('\n📝 Next steps:');
+      console.log('  canvas list              # Test your setup by listing courses');
+      console.log('  canvas profile           # View your profile');
+      console.log('  canvas config show       # View your configuration');
+    }
+    
+  } catch (error) {
+    console.error(`❌ Setup failed: ${error.message}`);
+  } finally {
+    rl.close();
+  }
+}
+
+async function editConfig() {
+  const rl = createReadlineInterface();
+  
+  try {
+    if (!configExists()) {
+      console.log('❌ No configuration file found. Run "canvas config setup" first.');
+      return;
+    }
+    
+    const config = readConfig();
+    console.log('✏️  Edit Canvas CLI Configuration\n');
+    console.log('Current values:');
+    console.log(`  Domain: ${config.domain}`);
+    console.log(`  Token: ${config.token ? config.token.substring(0, 10) + '...' : 'Not set'}\n`);
+    
+    // Edit domain
+    const newDomain = await askQuestion(rl, `New Canvas domain (${config.domain}): `);
+    const domain = newDomain.trim() || config.domain;
+    
+    // Edit token
+    const changeToken = await askQuestion(rl, 'Change API token? (y/N): ');
+    let token = config.token;
+    
+    if (changeToken.toLowerCase() === 'y' || changeToken.toLowerCase() === 'yes') {
+      const newToken = await askQuestion(rl, 'New API token: ');
+      if (newToken.trim()) {
+        token = newToken.trim();
+      }
+    }
+    
+    // Confirm changes
+    console.log('\n📋 New configuration:');
+    console.log(`  Domain: ${domain}`);
+    console.log(`  Token: ${token ? token.substring(0, 10) + '...' : 'Not set'}`);
+    
+    const confirm = await askQuestion(rl, '\nSave changes? (Y/n): ');
+    if (confirm.toLowerCase() === 'n' || confirm.toLowerCase() === 'no') {
+      console.log('Changes cancelled.');
+      return;
+    }
+    
+    const saved = saveConfig(domain, token);
+    if (saved) {
+      console.log('✅ Configuration updated successfully!');
+    }
+    
+  } catch (error) {
+    console.error(`❌ Edit failed: ${error.message}`);
+  } finally {
+    rl.close();
+  }
+}
+
+function showConfigPath() {
+  console.log(`📁 Configuration file location: ${getConfigPath()}`);
+  console.log(`📊 Exists: ${configExists() ? 'Yes' : 'No'}`);
+}
+
+function deleteConfigFile() {
+  console.log('🗑️  Delete Configuration\n');
+  
+  if (!configExists()) {
+    console.log('❌ No configuration file found.');
+    return;
+  }
+  
+  const config = readConfig();
+  console.log('Current configuration:');
+  console.log(`  Domain: ${config.domain}`);
+  console.log(`  Token: ${config.token ? 'Set (hidden)' : 'Not set'}`);
+  console.log(`  File: ${getConfigPath()}\n`);
+  
+  // For safety, require explicit confirmation
+  console.log('⚠️  This will permanently delete your Canvas CLI configuration.');
+  console.log('You will need to run "canvas config setup" again to use the CLI.');
+  console.log('\nTo confirm deletion, type: DELETE');
+  
+  const readline = require('readline');
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  
+  rl.question('Confirmation: ', (answer) => {
+    if (answer === 'DELETE') {
+      deleteConfig();
+    } else {
+      console.log('Deletion cancelled.');
+    }
+    rl.close();
+  });
+}
+
+module.exports = {
+  showConfig,
+  setupConfig,
+  editConfig,
+  showConfigPath,
+  deleteConfigFile
+};

package/commands/grades.js

@@ -0,0 +1,68 @@
+/**
+ * Grades command
+ */
+
+const { makeCanvasRequest } = require('../lib/api-client');
+
+async function showGrades(courseId, options) {
+  try {
+    if (courseId) {
+      // Get grades for specific course
+      const enrollments = await makeCanvasRequest('get', `courses/${courseId}/enrollments`, ['user_id=self', 'include[]=grades']);
+      
+      if (!enrollments || enrollments.length === 0) {
+        console.log('No enrollment found for this course.');
+        return;
+      }
+      
+      const enrollment = enrollments[0];
+      console.log(`Grades for course: ${enrollment.course_id}`);
+      console.log(`Current Score: ${enrollment.grades?.current_score || 'N/A'}%`);
+      console.log(`Final Score: ${enrollment.grades?.final_score || 'N/A'}%`);
+      console.log(`Current Grade: ${enrollment.grades?.current_grade || 'N/A'}`);
+      console.log(`Final Grade: ${enrollment.grades?.final_grade || 'N/A'}`);
+    } else {
+      // Get grades for all courses
+      const courses = await makeCanvasRequest('get', 'courses', [
+        'enrollment_state=active', 
+        'include[]=enrollments',
+        'include[]=total_scores'
+      ]);
+      
+      if (!courses || courses.length === 0) {
+        console.log('No courses found.');
+        return;
+      }
+      
+      console.log('Grades Summary:\n');
+      
+      courses.forEach((course, index) => {
+        console.log(`${index + 1}. ${course.name}`);
+        console.log(`   ID: ${course.id}`);
+        
+        if (course.enrollments && course.enrollments.length > 0) {
+          const enrollment = course.enrollments[0];
+          if (enrollment.grades) {
+            console.log(`   Current Score: ${enrollment.grades.current_score || 'N/A'}%`);
+            console.log(`   Final Score: ${enrollment.grades.final_score || 'N/A'}%`);
+            console.log(`   Current Grade: ${enrollment.grades.current_grade || 'N/A'}`);
+          } else {
+            console.log(`   Grades: Not available`);
+          }
+        } else {
+          console.log(`   Enrollment: Not found`);
+        }
+        
+        console.log('');
+      });
+    }
+    
+  } catch (error) {
+    console.error('Error fetching grades:', error.message);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  showGrades
+};

package/commands/list.js

@@ -0,0 +1,70 @@
+/**
+ * List courses command
+ */
+
+const { makeCanvasRequest } = require('../lib/api-client');
+
+async function listCourses(options) {
+  try {
+    const queryParams = [];
+    
+    // Always show only active courses
+    queryParams.push('enrollment_state=active');
+    
+    // Include additional course information
+    queryParams.push('include[]=term');
+    queryParams.push('include[]=course_progress');
+    queryParams.push('include[]=total_students');
+    queryParams.push('include[]=favorites'); // Include favorite status
+    
+    const courses = await makeCanvasRequest('get', 'courses', queryParams);
+    
+    if (!courses || courses.length === 0) {
+      console.log('No courses found.');
+      return;
+    }
+    
+    // By default, show only starred courses unless -a flag is used
+    let filteredCourses = courses;
+    if (!options.all) {
+      filteredCourses = courses.filter(course => course.is_favorite);
+      
+      if (filteredCourses.length === 0) {
+        console.log('No starred courses found. Use -a to see all courses.');
+        return;
+      }
+    }
+    
+    const courseLabel = options.all ? 'enrolled course(s)' : 'starred course(s)';
+    console.log(`Found ${filteredCourses.length} ${courseLabel}:\n`);
+    
+    filteredCourses.forEach((course, index) => {
+      const starIcon = course.is_favorite ? '⭐ ' : '';
+      console.log(`${index + 1}. ${starIcon}${course.name}`);
+      console.log(`   ID: ${course.id}`);
+      console.log(`   Code: ${course.course_code || 'N/A'}`);
+      
+      if (options.verbose) {
+        console.log(`   Term: ${course.term?.name || 'N/A'}`);
+        console.log(`   Students: ${course.total_students || 'N/A'}`);
+        console.log(`   Start Date: ${course.start_at ? new Date(course.start_at).toLocaleDateString() : 'N/A'}`);
+        console.log(`   End Date: ${course.end_at ? new Date(course.end_at).toLocaleDateString() : 'N/A'}`);
+        console.log(`   Workflow State: ${course.workflow_state}`);
+        
+        if (course.course_progress) {
+          console.log(`   Progress: ${course.course_progress.requirement_completed_count || 0}/${course.course_progress.requirement_count || 0} requirements`);
+        }
+      }
+      
+      console.log(''); // Empty line between courses
+    });
+    
+  } catch (error) {
+    console.error('Error fetching courses:', error.message);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  listCourses
+};

package/commands/profile.js

@@ -0,0 +1,34 @@
+/**
+ * Profile command
+ */
+
+const { makeCanvasRequest } = require('../lib/api-client');
+
+async function showProfile(options) {
+  try {
+    const user = await makeCanvasRequest('get', 'users/self', ['include[]=email', 'include[]=locale']);
+    
+    console.log('User Profile:\n');
+    console.log(`Name: ${user.name}`);
+    console.log(`ID: ${user.id}`);
+    console.log(`Email: ${user.email || 'N/A'}`);
+    console.log(`Login ID: ${user.login_id || 'N/A'}`);
+    
+    if (options.verbose) {
+      console.log(`Short Name: ${user.short_name || 'N/A'}`);
+      console.log(`Sortable Name: ${user.sortable_name || 'N/A'}`);
+      console.log(`Locale: ${user.locale || 'N/A'}`);
+      console.log(`Time Zone: ${user.time_zone || 'N/A'}`);
+      console.log(`Avatar URL: ${user.avatar_url || 'N/A'}`);
+      console.log(`Created: ${user.created_at ? new Date(user.created_at).toLocaleString() : 'N/A'}`);
+    }
+    
+  } catch (error) {
+    console.error('Error fetching profile:', error.message);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  showProfile
+};