abapgit-agent 1.3.0 → 1.4.0

package/API.md

@@ -12,6 +12,7 @@ The ABAP system exposes these endpoints via SICF handler: `sap/bc/z_abapgit_agen
 | POST | `/unit` | Execute unit tests (AUnit) |
 | POST | `/tree` | Display package hierarchy tree |
 | POST | `/view` | View ABAP object definitions |
+| POST | `/preview` | Preview table/CDS view data |
 
 ## GET /health
 
@@ -441,7 +442,158 @@ View ABAP object definitions directly from ABAP system.
 }
 ```
 
-## Response Structure
+## POST /preview
+
+Preview data from ABAP tables or CDS views directly from the ABAP system. This is useful for exploring table/view contents without writing queries.
+
+### Request Body
+
+```json
+{
+  "objects": ["SFLIGHT", "ZC_MY_CDS_VIEW"],
+  "type": "TABL",
+  "limit": 10,
+  "where": "CARRID = 'AA'",
+  "columns": ["CARRID", "CONNID", "PRICE"]
+}
+```
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `objects` | Array | List of table/view names (required) |
+| `type` | String | Object type (TABL, DDLS). Auto-detected if not specified |
+| `limit` | Integer | Maximum rows to return (default: 10, max: 100) |
+| `where` | String | WHERE clause filter (e.g., `CARRID = 'AA'`) |
+| `columns` | Array | Column names to display (optional) |
+
+### Supported Object Types
+
+| Type | Description |
+|------|-------------|
+| TABL | Database table |
+| DDLS | CDS View/Entity |
+
+### Auto-Detection Rules
+
+If `type` is not specified, the system detects the type from TADIR:
+- CDS views (DDLS) are preferred if found in TADIR
+- Otherwise defaults to table (TABL)
+
+### Response (success - table)
+
+```json
+{
+  "success": true,
+  "command": "PREVIEW",
+  "message": "Retrieved data",
+  "objects": [
+    {
+      "name": "SFLIGHT",
+      "type": "TABL",
+      "type_text": "Table",
+      "row_count": 5,
+      "total_rows": 10,
+      "rows": [
+        {
+          "MANDT": "100",
+          "CARRID": "AA",
+          "CONNID": 17,
+          "FLDATE": "2024-10-24",
+          "PRICE": 422.94,
+          "CURRENCY": "USD",
+          "PLANETYPE": "747-400"
+        }
+      ],
+      "fields": [
+        { "field": "MANDT", "type": "CLNT", "length": 3 },
+        { "field": "CARRID", "type": "CHAR", "length": 3 },
+        { "field": "CONNID", "type": "NUMC", "length": 4 },
+        { "field": "FLDATE", "type": "DATS", "length": 8 },
+        { "field": "PRICE", "type": "CURR", "length": 16, "decimals": 2 },
+        { "field": "CURRENCY", "type": "CUKY", "length": 5 }
+      ],
+      "columns_displayed": 6,
+      "columns_hidden": ["SEATSMAX", "SEATSOCC", "PAYMENTSUM"],
+      "error": ""
+    }
+  ],
+  "summary": {
+    "total_objects": 1,
+    "total_rows": 5
+  },
+  "error": ""
+}
+```
+
+### Response (success - CDS view)
+
+```json
+{
+  "success": true,
+  "command": "PREVIEW",
+  "message": "Retrieved data",
+  "objects": [
+    {
+      "name": "ZC_MY_CDS_VIEW",
+      "type": "DDLS",
+      "type_text": "CDS View",
+      "row_count": 10,
+      "total_rows": 25,
+      "rows": [
+        {
+          "PACKAGE": "ZMY_PACKAGE",
+          "DESCRIPTION": "My Package",
+          "PARENT": "$ZROOT"
+        }
+      ],
+      "fields": [
+        { "field": "PACKAGE", "type": "CHAR", "length": 30 },
+        { "field": "DESCRIPTION", "type": "CHAR", "length": 60 },
+        { "field": "PARENT", "type": "CHAR", "length": 30 }
+      ],
+      "columns_displayed": 3,
+      "columns_hidden": [],
+      "error": ""
+    }
+  ],
+  "summary": {
+    "total_objects": 1,
+    "total_rows": 10
+  },
+  "error": ""
+}
+```
+
+### Response (error - not found)
+
+```json
+{
+  "success": true,
+  "command": "PREVIEW",
+  "message": "Retrieved data",
+  "objects": [
+    {
+      "name": "Z_NONEXISTENT",
+      "type": "TABL",
+      "type_text": "Table",
+      "row_count": 0,
+      "total_rows": 0,
+      "rows": [],
+      "fields": [],
+      "columns_displayed": 0,
+      "columns_hidden": [],
+      "error": "Table or view not found: Z_NONEXISTENT"
+    }
+  ],
+  "summary": {
+    "total_objects": 1,
+    "total_rows": 0
+  },
+  "error": ""
+}
+```
+
+### Response Structure
 
 ### Pull Response Fields
 
@@ -506,6 +658,32 @@ View ABAP object definitions directly from ABAP system.
 | `summary` | Object | Summary with total and by_type |
 | `error` | String | Error message (empty if success) |
 
+### Preview Response Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `success` | Boolean | Whether the request succeeded |
+| `command` | String | Command name ("PREVIEW") |
+| `message` | String | Status message |
+| `objects` | Array | List of table/view results |
+| `summary` | Object | Summary with total_objects and total_rows |
+| `error` | String | Error message (empty if success) |
+
+### Preview Object Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | String | Table/view name |
+| `type` | String | Object type (TABL, DDLS) |
+| `type_text` | String | Human-readable type (Table, CDS View) |
+| `row_count` | Integer | Number of rows returned |
+| `total_rows` | Integer | Total rows available (before limit) |
+| `rows` | Array | Array of row objects with field:value pairs |
+| `fields` | Array | Field metadata (field, type, length, decimals) |
+| `columns_displayed` | Integer | Number of columns in output |
+| `columns_hidden` | Array | Column names not displayed (if limited) |
+| `error` | String | Error message (empty if success) |
+
 ### Object Fields (for View)
 
 | Field | Type | Description |

package/CLAUDE.md

@@ -2,6 +2,36 @@
 
 This is the **abapgit-agent** CLI tool project - a Node.js application for pulling and activating ABAP code from git repositories.
 
+## Quick Reference
+
+```bash
+# Quick commands
+abapgit-agent pull                              # Pull and activate all
+abapgit-agent pull --files file.clas.abap      # Pull specific file(s)
+abapgit-agent inspect --files file.clas.abap    # Syntax check
+abapgit-agent unit --files test.clas.testclasses.abap  # Run tests
+abapgit-agent preview --objects TABLE           # Preview table data
+abapgit-agent view --objects OBJ               # View object definition
+abapgit-agent tree --package $PACKAGE          # Show package hierarchy
+```
+
+## Common Tasks
+
+**Making code changes:**
+```bash
+1. Edit ABAP file(s)
+2. git add && git commit && git push
+3. abapgit-agent pull --files file.clas.abap
+4. Check for errors in output
+5. If "Error updating where-used list" → use inspect for details
+```
+
+**Exploring unknown tables:**
+```bash
+abapgit-agent preview --objects SFLIGHT              # See sample data
+abapgit-agent view --objects SFLIGHT --type TABL    # See structure
+```
+
 ## Project Structure
 
 ```
@@ -83,6 +113,14 @@ abapgit-agent view --objects ZCL_MY_CLASS
 abapgit-agent view --objects ZIF_MY_INTERFACE --type INTF
 abapgit-agent view --objects ZCL_CLASS1,ZCL_CLASS2 --json
 
+# Preview table/CDS view data
+abapgit-agent preview --objects SFLIGHT
+abapgit-agent preview --objects ZC_MY_CDS_VIEW --type DDLS
+abapgit-agent preview --objects SFLIGHT --columns CARRID,CONNID,PRICE --limit 20
+abapgit-agent preview --objects SFLIGHT --where "CARRID = 'AA'"
+abapgit-agent preview --objects SFLIGHT --vertical
+abapgit-agent preview --objects SFLIGHT --compact
+
 # Health check
 abapgit-agent health
 
@@ -579,6 +617,148 @@ where devclass not like '$%'
 | Object not found | `Object <name> not found` |
 | Invalid object type | `Unsupported object type: <type>` |
 
+## Preview Command
+
+### Description
+Preview data from ABAP tables or CDS views directly from the ABAP system. This command retrieves sample data rows to help developers understand table/view contents without needing to query manually.
+
+**This is the PRIMARY way to explore table and CDS view DATA.**
+
+### Usage
+```bash
+# Preview table data (auto-detect type)
+abapgit-agent preview --objects SFLIGHT
+
+# Preview CDS view data
+abapgit-agent preview --objects ZC_MY_CDS_VIEW --type DDLS
+
+# Preview with explicit type
+abapgit-agent preview --objects SFLIGHT --type TABL
+
+# Preview with row limit
+abapgit-agent preview --objects SFLIGHT --limit 20
+
+# Preview with WHERE clause filter
+abapgit-agent preview --objects SFLIGHT --where "CARRID = 'AA'"
+
+# Preview specific columns only
+abapgit-agent preview --objects SFLIGHT --columns CARRID,CONNID,FLDATE,PRICE
+
+# Vertical format (for wide tables)
+abapgit-agent preview --objects SFLIGHT --vertical
+
+# JSON output (for scripting/AI processing)
+abapgit-agent preview --objects SFLIGHT --json
+```
+
+### Parameters
+
+| Parameter | Required | Description |
+|-----------|----------|-------------|
+| `--objects` | Yes | Comma-separated list of table/view names |
+| `--type` | No | Object type (TABL, DDLS). Auto-detected from TADIR if not specified |
+| `--limit` | No | Maximum rows to return (default: 10, max: 100) |
+| `--where` | No | WHERE clause filter (e.g., `CARRID = 'AA'`) |
+| `--columns` | No | Comma-separated column names to display |
+| `--vertical` | No | Show data in vertical format (one field per line) |
+| `--compact` | No | Truncate values to fit columns |
+| `--json` | No | Output raw JSON only |
+
+### Output
+
+**Default (first 6 columns shown with indicator):**
+```
+📊 Preview: SFLIGHT (Table)
+
+┌──────────┬────────┬──────────┬───────────┬─────────┬─────────┐
+│ CARRID   │ CONNID │ FLDATE   │ PRICE     │ CURRENCY│ PLANETYPE│
+├──────────┼────────┼──────────┼───────────┼─────────┼─────────┤
+│ AA       │ 0017   │ 20240201 │    422.94 │ USD     │ 747-400 │
+│ AA       │ 0017   │ 20240202 │    422.94 │ USD     │ 747-400 │
+└──────────┴────────┴──────────┴───────────┴─────────┴─────────┘
+
+Showing 2 of 10 rows
+⚠️  Note: 3 more columns hidden (SEATSMAX, SEATSOCC, PAYMENTSUM)
+   Use --columns to select specific columns
+   Use --json for full data
+```
+
+**With WHERE Filter:**
+```
+📊 Preview: SFLIGHT (filtered)
+
+┌──────────┬────────┬──────────┬─────────┐
+│ CARRID   │ CONNID │ FLDATE   │ PRICE   │
+├──────────┼────────┼──────────┼─────────┤
+│ AA       │ 0017   │ 20240201 │  422.94 │
+│ AA       │ 0017   │ 20240202 │  422.94 │
+└──────────┴────────┴──────────┴─────────┘
+
+WHERE: CARRID = 'AA'
+```
+
+**Vertical Format (for wide tables):**
+```
+📊 Preview: SFLIGHT (1 of 10 rows, vertical)
+
+Row 1:
+────────────────────────────────────────────────────────────
+  CARRID:      AA
+  CONNID:      0017
+  FLDATE:      20240201
+  PRICE:       422.94
+  CURRENCY:    USD
+  PLANETYPE:   747-400
+  SEATSMAX:    400
+  SEATSOCC:    350
+  PAYMENTSUM:  145000
+────────────────────────────────────────────────────────────
+```
+
+### JSON Output
+```json
+{
+  "SUCCESS": true,
+  "COMMAND": "PREVIEW",
+  "OBJECTS": [
+    {
+      "NAME": "SFLIGHT",
+      "TYPE": "TABL",
+      "TYPE_TEXT": "Table",
+      "ROW_COUNT": 2,
+      "TOTAL_ROWS": 10,
+      "ROWS": [
+        { "CARRID": "AA", "CONNID": "0017", "FLDATE": "20240201", "PRICE": "422.94", ... }
+      ],
+      "FIELDS": [
+        { "FIELD": "CARRID", "TYPE": "CHAR", "LENGTH": 3 },
+        { "FIELD": "PRICE", "TYPE": "CURR", "LENGTH": 16 }
+      ],
+      "COLUMNS_DISPLAYED": 6,
+      "COLUMNS_HIDDEN": ["SEATSMAX", "SEATSOCC", "PAYMENTSUM"]
+    }
+  ],
+  "SUMMARY": { "TOTAL_OBJECTS": 1, "TOTAL_ROWS": 2 },
+  "ERROR": ""
+}
+```
+
+### Error Handling
+
+| Error | Message |
+|-------|---------|
+| Table not found | `Table not found: Z_NONEXISTENT` |
+| CDS View not found | `CDS View not found: Z_NONEXISTENT` |
+| Access denied | `Access denied to table: SFLIGHT` |
+| Invalid WHERE clause | `Invalid WHERE clause: <reason>` |
+
+### Auto-Detection Rules
+
+| Object Name Pattern | Default Type |
+|---------------------|--------------|
+| `ZC_*` or `zc_*` | DDLS (CDS View) |
+| Other | TABL (Table) |
+
 ## Status Check
 
 ### Description
@@ -642,6 +822,28 @@ export GIT_USERNAME="git-username"
 export GIT_PASSWORD="git-token"
 ```
 
+## Troubleshooting
+
+**Pull fails with "Error updating where-used list":**
+- This means SYNTAX ERROR in the object
+- Run `abapgit-agent inspect --files <file>` for detailed errors
+
+**Pull shows "Failed Objects" > 0:**
+- Objects failed to activate - check the error messages
+- Fix syntax errors and pull again
+
+**Preview/View command fails:**
+- Check table/view exists in the ABAP system
+- Verify credentials in `.abapGitAgent`
+
+**"Table or view not found":**
+- Table may not exist or may have different name
+- Use `view` command to check available tables
+
+**Terminal width issues with preview:**
+- Use `--columns` to specify exact columns
+- Use `--vertical` for wide tables
+
 ## Development Workflow
 
 ### Exploring Unknown ABAP Objects

package/INSTALL.md

@@ -12,17 +12,12 @@ Claude (VS Code) → CLI Tool → ABAP System (REST/HTTP)
 
 ### ABAP Side - REST Implementation
 
-| File | Type | Description |
-|------|------|-------------|
-| `zif_abgagt_agent.intf.abap` | Interface | Type definitions and method signatures |
-| `zcl_abgagt_agent.clas.abap` | Class | Main agent with `pull`, `inspect`, `run_tests` methods |
-| `zcl_abgagt_rest_handler.clas.abap` | Class | REST router for endpoints |
-| `zcl_abgagt_resource_pull.clas.abap` | Class | POST /pull handler |
-| `zcl_abgagt_resource_inspect.clas.abap` | Class | POST /inspect handler |
-| `zcl_abgagt_resource_unit.clas.abap` | Class | POST /unit handler |
-| `zcl_abgagt_resource_health.clas.abap` | Class | GET /health handler |
-
-**Note:** Error details are returned directly in the REST response via `error_detail` field.
+The ABAP backend consists of:
+- **Main agent** - Core logic for pull, inspect, unit operations
+- **REST handler** - Routes HTTP requests to appropriate resources
+- **Resource handlers** - Individual endpoints (/pull, /inspect, /unit, /tree, /view, /preview, /health)
+
+Deploy all ABAP objects using abapGit from the `/abap` folder.
 
 ### CLI Tool (Node.js)
 - REST client for ABAP communication

package/README.md

@@ -104,6 +104,15 @@ abapgit-agent tree --package $MY_PACKAGE
 abapgit-agent view --objects ZCL_MY_CLASS
 abapgit-agent view --objects SFLIGHT --type TABL
 abapgit-agent view --objects S_CARR_ID --type DTEL
+
+# Preview table or CDS view data
+abapgit-agent preview --objects SFLIGHT
+abapgit-agent preview --objects ZC_MY_CDS_VIEW --type DDLS
+abapgit-agent preview --objects SFLIGHT --limit 20
+abapgit-agent preview --objects SFLIGHT --where "CARRID = 'AA'"
+abapgit-agent preview --objects SFLIGHT --columns CARRID,CONNID,PRICE
+abapgit-agent preview --objects SFLIGHT --vertical
+abapgit-agent preview --objects SFLIGHT --compact
 ```
 
 ### Utility Commands
@@ -143,6 +152,7 @@ npm run pull -- --url <git-url> --branch main
 | unit Command | [docs/unit-command.md](docs/unit-command.md) |
 | tree Command | [docs/tree-command.md](docs/tree-command.md) |
 | view Command | [docs/view-command.md](docs/view-command.md) |
+| preview Command | [docs/preview-command.md](docs/preview-command.md) |
 | REST API Reference | [API.md](API.md) |
 | Error Handling | [ERROR_HANDLING.md](ERROR_HANDLING.md) |
 | ABAP Coding Guidelines | [abap/CLAUDE.md](abap/CLAUDE.md) |

package/RELEASE_NOTES.md

@@ -1,5 +1,49 @@
 # Release Notes
 
+## v1.4.0
+
+### New Features
+
+#### preview Command
+Preview data from ABAP tables or CDS views directly from the ABAP system:
+
+```bash
+# Preview table data (auto-detect type)
+abapgit-agent preview --objects SFLIGHT
+
+# Preview CDS view data
+abapgit-agent preview --objects ZC_MY_CDS_VIEW --type DDLS
+
+# Preview with row limit
+abapgit-agent preview --objects SFLIGHT --limit 20
+
+# Preview with WHERE clause filter
+abapgit-agent preview --objects SFLIGHT --where "CARRID = 'AA'"
+
+# Preview specific columns only
+abapgit-agent preview --objects SFLIGHT --columns CARRID,CONNID,PRICE
+
+# Vertical format (for wide tables)
+abapgit-agent preview --objects SFLIGHT --vertical
+
+# Compact mode (truncated values)
+abapgit-agent preview --objects SFLIGHT --compact
+
+# JSON output
+abapgit-agent preview --objects SFLIGHT --json
+```
+
+### Documentation
+
+- Added comprehensive docs/preview-command.md
+- Updated API.md with /preview endpoint
+- Updated IMPLEMENTATION_PLAN.md with tree, view, preview commands
+- Simplified INSTALL.md ABAP components section
+- Updated README.md with preview command examples
+- Improved CLAUDE.md files with best practices
+
+---
+
 ## v1.3.0
 
 ### New Features

package/abap/CLAUDE.md

@@ -4,6 +4,30 @@ This file provides guidelines for **generating ABAP code** in abapGit repositori
 
 **Use this file as a template**: Copy it to your ABAP repository root when setting up new projects with Claude Code.
 
+## Quick Reference
+
+```bash
+# After editing ABAP files:
+git add . && git commit -m "feat: description" && git push
+abapgit-agent pull --files abap/zcl_my_class.clas.abap
+
+# If pull fails with syntax error:
+abapgit-agent inspect --files abap/zcl_my_class.clas.abap
+
+# Explore tables/views:
+abapgit-agent preview --objects ZTABLE
+abapgit-agent view --objects ZTABLE --type TABL
+abapgit-agent tree --package $MY_PACKAGE
+```
+
+## Common Workflow
+
+1. Generate/edit ABAP code
+2. Push to git: `git add . && git commit && git push`
+3. Activate in ABAP: `abapgit-agent pull --files file.clas.abap`
+4. Check for errors - fix if needed
+5. Repeat
+
 ## ABAP Syntax Validation
 
 This is an ABAP project. **Do not attempt local syntax validation** - ABAP code can only be validated in an SAP system.
@@ -214,6 +238,112 @@ DATA ELEMENT ZMY_DTEL:
    Key Definition: WITH KEY
 ```
 
+## CLI Commands Reference
+
+This section documents the available CLI commands for ABAP development.
+
+### Pull Command
+
+Pull and activate ABAP objects from git repository.
+
+```bash
+# Pull all files
+abapgit-agent pull
+
+# Pull specific files (faster)
+abapgit-agent pull --files abap/zcl_my_class.clas.abap
+
+# Pull with transport request
+abapgit-agent pull --files abap/zcl_my_class.clas.abap --transport DEVK900001
+```
+
+### Inspect Command
+
+Run syntax check on ABAP objects.
+
+```bash
+# Syntax check single file
+abapgit-agent inspect --files abap/zcl_my_class.clas.abap
+
+# Syntax check multiple files
+abapgit-agent inspect --files abap/zcl_class1.clas.abap,abap/zcl_class2.clas.abap
+
+# Syntax check CDS view
+abapgit-agent inspect --files abap/zc_my_view.ddls.asddls
+```
+
+### Unit Command
+
+Run ABAP unit tests.
+
+```bash
+# Run unit tests for test class
+abapgit-agent unit --files abap/zcl_my_test.clas.testclasses.abap
+
+# Run unit tests for package
+abapgit-agent unit --package $MY_PACKAGE
+```
+
+### Tree Command
+
+Display package hierarchy.
+
+```bash
+# Display package tree
+abapgit-agent tree --package $MY_PACKAGE
+
+# With object counts
+abapgit-agent tree --package $MY_PACKAGE --include-objects
+
+# JSON output
+abapgit-agent tree --package $MY_PACKAGE --json
+```
+
+### View Command
+
+View ABAP object definitions directly from the system.
+
+```bash
+# View table structure
+abapgit-agent view --objects ZMY_TABLE --type TABL
+
+# View class definition
+abapgit-agent view --objects ZCL_MY_CLASS
+
+# View CDS view
+abapgit-agent view --objects ZC_MY_CDS_VIEW --type DDLS
+
+# JSON output
+abapgit-agent view --objects ZCL_MY_CLASS --json
+```
+
+### Preview Command
+
+Preview data from tables or CDS views.
+
+```bash
+# Preview table data
+abapgit-agent preview --objects SFLIGHT
+
+# Preview with row limit
+abapgit-agent preview --objects SFLIGHT --limit 5
+
+# Preview with WHERE filter
+abapgit-agent preview --objects SFLIGHT --where "CARRID = 'AA'"
+
+# Preview specific columns
+abapgit-agent preview --objects SFLIGHT --columns CARRID,PRICE,FLDATE
+
+# Vertical format (for wide tables)
+abapgit-agent preview --objects SFLIGHT --vertical
+
+# Compact mode (truncated values)
+abapgit-agent preview --objects SFLIGHT --compact
+
+# JSON output
+abapgit-agent preview --objects SFLIGHT --json
+```
+
 ## JSON Handling - ALWAYS Use /ui2/cl_json
 
 **CRITICAL**: Always use `/ui2/cl_json` for JSON serialization and deserialization.

package/abap/zcl_abgagt_cmd_factory.clas.abap

@@ -29,6 +29,7 @@ CLASS zcl_abgagt_cmd_factory IMPLEMENTATION.
       ( command = zif_abgagt_command=>gc_import class_name = 'ZCL_ABGAGT_COMMAND_IMPORT' )
       ( command = zif_abgagt_command=>gc_tree   class_name = 'ZCL_ABGAGT_COMMAND_TREE' )
       ( command = zif_abgagt_command=>gc_view   class_name = 'ZCL_ABGAGT_COMMAND_VIEW' )
+      ( command = zif_abgagt_command=>gc_preview class_name = 'ZCL_ABGAGT_COMMAND_PREVIEW' )
     ).
   ENDMETHOD.