abapgit-agent 1.4.0 → 1.5.0

package/docs/list-command.md

@@ -0,0 +1,289 @@
+# list Command Requirements
+
+## Overview
+
+List ABAP objects in a package with filtering and pagination capabilities. This command provides a flat list of objects with support for filtering by type, name pattern, and pagination.
+
+## Command
+
+```bash
+# List all objects in a package
+abapgit-agent list --package $ZMY_PACKAGE
+
+# Filter by object type
+abapgit-agent list --package $ZMY_PACKAGE --type CLAS,INTF
+
+# Filter by name pattern
+abapgit-agent list --package $ZMY_PACKAGE --name ZCL_*
+
+# Limit results
+abapgit-agent list --package $ZMY_PACKAGE --limit 50
+
+# Paginate results
+abapgit-agent list --package $ZMY_PACKAGE --offset 100 --limit 50
+
+# JSON output for scripting
+abapgit-agent list --package $ZMY_PACKAGE --json
+```
+
+## Prerequisite
+
+- `.abapGitAgent` exists with valid credentials
+- Package must exist in the ABAP system
+
+## Parameters
+
+| Parameter | Required | Default | Description |
+|-----------|----------|---------|-------------|
+| `--package` | Yes | - | Package name (e.g., `$ZMY_PACKAGE`, `ZMY_PACKAGE`) |
+| `--type` | No | All types | Comma-separated object types (e.g., `CLAS,INTF,PROG`) |
+| `--name` | No | - | Name pattern with wildcard support (e.g., `ZCL_*`) |
+| `--limit` | No | 100 | Maximum objects to return (max: 1000) |
+| `--offset` | No | 0 | Number of objects to skip |
+| `--json` | No | false | Output raw JSON only |
+
+---
+
+## Tasks
+
+### 1. Validate Parameters
+
+- `--package` must be specified
+- Package name must be valid (1-30 characters)
+- `--limit` must be between 1 and 1000
+
+### 2. Load Configuration
+
+Read `.abapGitAgent` for credentials
+
+### 3. Fetch CSRF Token
+
+```bash
+GET /health (with X-CSRF-Token: fetch)
+```
+
+### 4. Make List Request
+
+**Endpoint:** `POST /list`
+
+**Request Body:**
+```json
+{
+  "package": "$ZMY_PACKAGE",
+  "type": "CLAS,INTF",
+  "name": "ZCL_*",
+  "limit": 100,
+  "offset": 0
+}
+```
+
+### 5. Display Results
+
+---
+
+## Output
+
+### Human-Readable Output
+
+```
+📋 Objects in $ZMY_PACKAGE (Total: 15)
+
+  CLAS (5)
+    ZCL_CLASS1
+    ZCL_CLASS2
+    ZCL_CLASS3
+    ZCL_CLASS4
+    ZCL_CLASS5
+
+  INTF (2)
+    ZIF_INTERFACE1
+    ZIF_INTERFACE2
+
+  PROG (3)
+    ZPROG1
+    ZPROG2
+    ZPROG3
+
+  TABL (5)
+    ZTABLE1
+    ZTABLE2
+    ZTABLE3
+    ZTABLE4
+    ZTABLE5
+```
+
+### With Type Filter
+
+```
+📋 Objects in $ZMY_PACKAGE (CLAS only, Total: 5)
+
+  CLAS (5)
+    ZCL_CLASS1
+    ZCL_CLASS2
+    ZCL_CLASS3
+    ZCL_CLASS4
+    ZCL_CLASS5
+```
+
+### JSON Output
+
+```json
+{
+  "SUCCESS": true,
+  "COMMAND": "LIST",
+  "PACKAGE": "$ZMY_PACKAGE",
+  "TOTAL": 15,
+  "LIMIT": 100,
+  "OFFSET": 0,
+  "OBJECTS": [
+    { "TYPE": "CLAS", "NAME": "ZCL_CLASS1" },
+    { "TYPE": "CLAS", "NAME": "ZCL_CLASS2" },
+    { "TYPE": "CLAS", "NAME": "ZCL_CLASS3" },
+    { "TYPE": "CLAS", "NAME": "ZCL_CLASS4" },
+    { "TYPE": "CLAS", "NAME": "ZCL_CLASS5" },
+    { "TYPE": "INTF", "NAME": "ZIF_INTERFACE1" },
+    { "TYPE": "INTF", "NAME": "ZIF_INTERFACE2" },
+    { "TYPE": "PROG", "NAME": "ZPROG1" },
+    { "TYPE": "PROG", "NAME": "ZPROG2" },
+    { "TYPE": "PROG", "NAME": "ZPROG3" },
+    { "TYPE": "TABL", "NAME": "ZTABLE1" },
+    { "TYPE": "TABL", "NAME": "ZTABLE2" },
+    { "TYPE": "TABL", "NAME": "ZTABLE3" },
+    { "TYPE": "TABL", "NAME": "ZTABLE4" },
+    { "TYPE": "TABL", "NAME": "ZTABLE5" }
+  ],
+  "BY_TYPE": [
+    { "TYPE": "CLAS", "COUNT": 5 },
+    { "TYPE": "INTF", "COUNT": 2 },
+    { "TYPE": "PROG", "COUNT": 3 },
+    { "TYPE": "TABL", "COUNT": 5 }
+  ],
+  "ERROR": ""
+}
+```
+
+**Response Fields:**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `SUCCESS` | boolean | Whether the request succeeded |
+| `COMMAND` | string | Command name ("LIST") |
+| `PACKAGE` | string | Package name |
+| `TOTAL` | number | Total objects matching filter |
+| `LIMIT` | number | Requested limit |
+| `OFFSET` | number | Requested offset |
+| `OBJECTS` | array | List of objects [{TYPE, NAME}] |
+| `BY_TYPE` | array | Object counts by type [{TYPE, COUNT}] |
+| `ERROR` | string | Error message (empty if success) |
+
+---
+
+## Error Handling
+
+| Error | Message |
+|-------|---------|
+| Package not specified | `Package parameter is required` |
+| Package not found | `Package <name> does not exist` |
+| Invalid type | `Invalid object type: <type>` |
+| Limit too high | `Limit value too high (max: 1000)` |
+
+### Error Output
+
+```
+❌ Package not found: $ZNONEXISTENT
+
+Error: Package $ZNONEXISTENT does not exist in the system.
+```
+
+---
+
+## Example
+
+```bash
+# List all objects
+abapgit-agent list --package $ZMY_PACKAGE
+
+# Filter by type
+abapgit-agent list --package $ZMY_PACKAGE --type CLAS,INTF
+
+# Filter by name pattern
+abapgit-agent list --package $ZMY_PACKAGE --name ZCL_*
+
+# Paginate
+abapgit-agent list --package $ZMY_PACKAGE --limit 50 --offset 50
+
+# JSON for scripting
+abapgit-agent list --package $ZMY_PACKAGE --json > objects.json
+
+# CI/CD: Count classes
+CLASS_COUNT=$(abapgit-agent list --package $ZMY_PACKAGE --type CLAS --json | jq '.TOTAL')
+echo "Package has $CLASS_COUNT classes"
+```
+
+---
+
+## Implementation
+
+### ABAP Tables Used
+
+| Table | Purpose |
+|-------|---------|
+| **TDEVC** | Package definitions (validate package exists) |
+| **TADIR** | Object directory (fetch objects in package) |
+
+### Supported Object Types
+
+| Type | Description |
+|------|-------------|
+| CLAS | Class |
+| INTF | Interface |
+| PROG | Program |
+| FUGR | Function Group |
+| TABL | Table |
+| STRU | Structure |
+| DTEL | Data Element |
+| TTYP | Table Type |
+| DDLS | CDS View |
+| DDLX | CDS View Entity |
+
+### Query Logic
+
+```abap
+" Validate package exists
+SELECT SINGLE devclass FROM tdevc
+  INTO lv_package
+ WHERE devclass = iv_package.
+
+" Get objects with filters
+SELECT object obj_name FROM tadir
+  INTO TABLE lt_objects
+ WHERE devclass = iv_package
+   AND object IN lt_types
+   AND obj_name LIKE lv_name_pattern
+ ORDER BY object obj_name
+ LIMIT iv_limit
+ OFFSET iv_offset.
+
+" Get counts by type (for summary)
+SELECT object COUNT(*) AS count FROM tadir
+  INTO TABLE lt_counts
+ WHERE devclass = iv_package
+   AND object IN lt_types
+ GROUP BY object.
+```
+
+### Files to Create
+
+| File | Description |
+|------|-------------|
+| `zcl_abgagt_command_list.clas.abap` | Command implementation |
+| `zcl_abgagt_command_list.clas.xml` | Class metadata |
+| `zcl_abgagt_resource_list.clas.abap` | REST resource handler |
+| `zcl_abgagt_resource_list.clas.xml` | Resource metadata |
+
+### Files to Modify
+
+| File | Description |
+|------|-------------|
+| `zif_abgagt_command.intf.abap` | Add LIST constant |
+| `zcl_abgagt_cmd_factory.clas.abap` | Add LIST command mapping |

package/docs/pull-command.md

@@ -24,6 +24,9 @@ abapgit-agent pull --transport DEVK900001
 
 # Combined options
 abapgit-agent pull --branch develop --files src/zcl_my_class.clas.abap --transport DEVK900001
+
+# Using transport from config/environment (no --transport flag needed)
+abapgit-agent pull
 ```
 
 ## Prerequisite
@@ -39,7 +42,18 @@ abapgit-agent pull --branch develop --files src/zcl_my_class.clas.abap --transpo
 | `--url` | No | Git repository URL (auto-detected if not specified) |
 | `--branch` | No | Branch name (default: current branch) |
 | `--files` | No | Comma-separated list of files to pull |
-| `--transport` | No | Transport request for activation |
+| `--transport` | No | Transport request (config/env takes priority if not specified) |
+
+## Transport Request Precedence
+
+The transport request is determined in this order:
+
+| Priority | Source | Example |
+|----------|--------|---------|
+| 1 | CLI `--transport` argument | `--transport DEVK900001` |
+| 2 | Config file `transport` | `"transport": "DEVK900001"` in `.abapGitAgent` |
+| 3 | Environment variable `ABAP_TRANSPORT` | `export ABAP_TRANSPORT="DEVK900001"` |
+| 4 (default) | Not set | abapGit creates/uses default |
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abapgit-agent",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "ABAP Git Agent - Pull and activate ABAP code via abapGit from any git repository",
   "main": "src/index.js",
   "bin": {
@@ -10,7 +10,9 @@
     "start": "node src/server.js",
     "dev": "nodemon src/server.js",
     "test": "jest",
-    "pull": "node bin/abapgit-agent"
+    "pull": "node bin/abapgit-agent",
+    "release": "node scripts/release.js",
+    "unrelease": "node scripts/unrelease.js"
   },
   "dependencies": {
     "cors": "^2.8.5",

package/scripts/release.js

@@ -0,0 +1,298 @@
+/**
+ * Release script - Creates release for github.com
+ *
+ * Usage: npm run release [--dry-run]
+ *
+ * Options:
+ *   --dry-run    Test the release flow without pushing to github.com
+ *
+ * This script:
+ * 1. Reads version from package.json
+ * 2. Updates the ABAP health resource with the new version
+ * 3. Uses Claude CLI to generate release notes from commits
+ * 4. Updates RELEASE_NOTES.md with new version notes
+ * 5. Pushes to github.com to trigger GitHub Actions (unless --dry-run)
+ * 6. GitHub Actions will publish to npm and create GitHub release
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+const packageJsonPath = path.join(__dirname, '..', 'package.json');
+const abapHealthPath = path.join(__dirname, '..', 'abap', 'zcl_abgagt_resource_health.clas.abap');
+const releaseNotesPath = path.join(__dirname, '..', 'RELEASE_NOTES.md');
+const repoRoot = path.join(__dirname, '..');
+
+// Check for --dry-run flag
+const args = process.argv.slice(2);
+const dryRun = args.includes('--dry-run');
+
+if (dryRun) {
+  console.log('🔹 DRY RUN MODE - No actual release will be created\n');
+}
+
+// Read version from package.json
+const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+const version = pkg.version;
+
+console.log(`Current version: ${version}`);
+console.log('');
+
+// Check if version has been bumped - version must be greater than or equal to latest tag
+const allTags = execSync('git tag --sort=-v:refname', { cwd: repoRoot, encoding: 'utf8' });
+const tagList = allTags.trim().split('\n').filter(t => t.startsWith('v'));
+const latestTag = tagList[0] ? tagList[0].replace('v', '') : '';
+
+const versionTag = `v${version}`;
+
+if (version === latestTag) {
+  // Check if the tag points to HEAD (new release we just created)
+  try {
+    const tagRef = execSync(`git rev-parse ${versionTag}^{commit}`, { cwd: repoRoot, encoding: 'utf8' }).trim();
+    const headRef = execSync('git rev-parse HEAD', { cwd: repoRoot, encoding: 'utf8' }).trim();
+
+    if (tagRef !== headRef) {
+      console.log(`Version ${version} has already been released (tag v${version} exists on different commit)`);
+      console.log('');
+      console.log('To bump version, run one of:');
+      console.log('  npm version patch    # e.g., 1.4.0 -> 1.4.1');
+      console.log('  npm version minor    # e.g., 1.4.0 -> 1.5.0');
+      console.log('  npm version major    # e.g., 1.4.0 -> 2.0.0');
+      console.log('');
+      process.exit(1);
+    }
+    // If tag points to HEAD, this is the new release we just created - continue
+  } catch (e) {
+    // Tag doesn't exist - this is a new version
+  }
+}
+
+console.log(`Current version: ${version} (tag: ${versionTag})`);
+console.log('');
+
+// Check if there's a remote for github.com
+let remoteName = 'origin';
+try {
+  const remotes = execSync('git remote -v', { cwd: repoRoot, encoding: 'utf8' });
+  if (remotes.includes('github.com') && !remotes.includes('github.tools.sap')) {
+    remoteName = 'origin';
+  } else if (remotes.includes('public') && remotes.includes('github.com')) {
+    remoteName = 'public';
+  }
+  console.log(`Using remote: ${remoteName}`);
+} catch (e) {
+  console.log('Could not determine remote, using origin');
+}
+
+console.log('');
+
+// Read ABAP health resource file
+let abapContent = fs.readFileSync(abapHealthPath, 'utf8');
+
+// Update version in ABAP file (replace existing version)
+const oldVersionMatch = abapContent.match(/version":"(\d+\.\d+\.\d+)"/);
+if (oldVersionMatch) {
+  const oldVersion = oldVersionMatch[1];
+  abapContent = abapContent.replace(
+    `version":"${oldVersion}"`,
+    `version":"${version}"`
+  );
+
+  // Write updated content
+  fs.writeFileSync(abapHealthPath, abapContent);
+  console.log(`📦 ABAP version: ${oldVersion} -> ${version}`);
+  if (dryRun) {
+    console.log('   (file modified, not committed)');
+  }
+  console.log('');
+} else {
+  console.error('Could not find version in ABAP file');
+  process.exit(1);
+}
+
+// Get commits since last tag for release notes
+console.log('Generating release notes with Claude...');
+console.log('');
+
+let releaseNotesContent = '';
+
+try {
+  // Find previous tag
+  const allTags = execSync('git tag --sort=-v:refname', { cwd: repoRoot, encoding: 'utf8' });
+  const tagList = allTags.trim().split('\n').filter(t => t.startsWith('v'));
+  const previousTag = tagList[1] || 'HEAD~10';
+
+  // Get commits since last release
+  const commits = execSync(`git log ${previousTag}..HEAD --oneline`, { cwd: repoRoot, encoding: 'utf8' });
+
+  if (commits.trim()) {
+    console.log(`Found ${commits.trim().split('\n').length} commits since last release`);
+    console.log('');
+
+    // Create Claude prompt - escape for shell
+    const commitsEscaped = commits.replace(/"/g, '\\"').replace(/\n/g, '\\n');
+    const prompt = `Generate concise release notes for version ${version} of a Node.js CLI tool called abapgit-agent.
+
+Commits since last release:
+${commitsEscaped}
+
+Instructions:
+1. IGNORE commits that revert, undo, or remove previous changes
+2. IGNORE commits that fix/improve the release process itself
+3. Focus on actual USER-FACING features and fixes
+4. Use 2-4 bullet points MAX per category
+5. Keep each bullet brief (under 10 words)
+6. START your response with "## v${version}" and END with "---"
+7. OUTPUT ONLY the release notes - do NOT add any intro text, explanation, or commentary
+8. Use this exact format with blank lines between categories:
+## v${version}
+
+### New Features
+
+- Brief feature description
+
+### Bug Fixes
+
+- Brief fix description
+
+### Improvements
+
+- Brief improvement
+
+### Documentation
+
+- Brief doc update
+
+---
+
+OMIT any category that has no items.`;
+
+    // Call Claude CLI
+    try {
+      releaseNotesContent = execSync(`claude --print "${prompt}"`, { cwd: repoRoot, encoding: 'utf8', timeout: 60000 });
+      releaseNotesContent = releaseNotesContent.trim();
+      console.log('Generated release notes:');
+      console.log(releaseNotesContent);
+      console.log('');
+    } catch (e) {
+      console.log('Claude CLI not available, using fallback');
+      releaseNotesContent = `## v${version}\n\nSee commit history for changes.`;
+    }
+  } else {
+    console.log('No commits since last release');
+    releaseNotesContent = `## v${version}\n\nSee commit history for changes.`;
+  }
+} catch (e) {
+  console.log('Could not generate release notes:', e.message);
+  releaseNotesContent = `## v${version}\n\nSee commit history for changes.`;
+}
+
+// Show release notes in dry-run mode
+if (dryRun) {
+  console.log('📝 Generated Release Notes:');
+  console.log('─'.repeat(50));
+  console.log(releaseNotesContent);
+  console.log('─'.repeat(50));
+  console.log('');
+}
+
+// Update RELEASE_NOTES.md
+if (fs.existsSync(releaseNotesPath)) {
+  const existingContent = fs.readFileSync(releaseNotesPath, 'utf8');
+
+  // Check if version already exists
+  if (existingContent.includes(`## v${version}`)) {
+    console.log(`Release notes for v${version} already exist`);
+  } else {
+    let newContent;
+
+    // Check if there's a "# Release Notes" header - insert after it if present
+    if (existingContent.startsWith('# Release Notes')) {
+      // Find the position after "# Release Notes" and any following content
+      const lines = existingContent.split('\n');
+      let insertIndex = 0;
+      for (let i = 0; i < lines.length; i++) {
+        if (lines[i].match(/^## v\d+\.\d+\.\d+/)) {
+          insertIndex = i;
+          break;
+        }
+      }
+      // Insert new content before the first version header
+      const before = lines.slice(0, insertIndex).join('\n');
+      const after = lines.slice(insertIndex).join('\n');
+      newContent = before + '\n\n' + releaseNotesContent + '\n\n---\n\n' + after;
+    } else {
+      // Add new version at the top
+      newContent = releaseNotesContent + '\n\n---\n\n' + existingContent;
+    }
+
+    fs.writeFileSync(releaseNotesPath, newContent);
+    if (dryRun) {
+      console.log('📄 RELEASE_NOTES.md: would add new version at top');
+    } else {
+      console.log(`Updated RELEASE_NOTES.md with v${version}`);
+    }
+  }
+} else {
+  // Create new RELEASE_NOTES.md
+  fs.writeFileSync(releaseNotesPath, releaseNotesContent);
+  console.log(`Created RELEASE_NOTES.md with v${version}`);
+}
+console.log('');
+
+// Check git status and commit (skip in dry-run)
+const status = execSync('git status --porcelain', { cwd: repoRoot, encoding: 'utf8' });
+
+if (status.trim()) {
+  if (dryRun) {
+    console.log('🔹 DRY RUN - Would create commit with changes:');
+    console.log(status);
+    console.log('');
+  } else {
+    // Stage and commit
+    try {
+      execSync('git add abap/zcl_abgagt_resource_health.clas.abap package.json RELEASE_NOTES.md', { cwd: repoRoot });
+      execSync(`git commit -m "chore: release v${version}"`, { cwd: repoRoot });
+      console.log('Created git commit for version update');
+      console.log('');
+    } catch (e) {
+      console.log('No changes to commit or commit failed');
+    }
+  }
+} else {
+  console.log('No changes to commit (version already up to date)');
+  console.log('');
+}
+
+// Push to trigger GitHub Actions
+if (dryRun) {
+  console.log('🔹 DRY RUN - Skipping push to github.com');
+  console.log('');
+  console.log('To actually release, run:');
+  console.log(`  git push ${remoteName} master --follow-tags`);
+  console.log('');
+} else {
+  console.log('Pushing to github.com to trigger release...');
+  console.log('');
+
+  try {
+    // Push master and tags to github.com
+    execSync(`git push ${remoteName} master --follow-tags`, { cwd: repoRoot });
+    console.log('Pushed to github.com successfully!');
+    console.log('');
+  } catch (e) {
+    console.log('Push failed, please push manually');
+    console.log('');
+  }
+
+  console.log('Release workflow triggered!');
+  console.log('');
+  console.log('The GitHub Actions workflow will:');
+  console.log('1. Run tests');
+  console.log('2. Publish to npm');
+  console.log('3. Create GitHub release with Claude-generated notes');
+  console.log('');
+  console.log('Next step for ABAP system:');
+  console.log('  abapgit-agent pull --files abap/zcl_abgagt_resource_health.clas.abap');
+}