@mcp-abap-adt/adt-clients 18.0.0 → 18.0.2

package/README.md

@@ -69,6 +69,10 @@ This package interacts with external packages **ONLY through interfaces**:
 - **`@mcp-abap-adt/connection`**: Uses the `IAbapConnection` interface for HTTP requests — does not know about the concrete connection implementation. It is a **dev** dependency; consumers supply their own implementation.
 - **No other direct package dependencies**: all remaining interactions happen through well-defined interfaces
 
+> **Coming from 17.x?** 18.0.0 is a breaking release — see
+> [docs/usage/MIGRATION-18.0.md](docs/usage/MIGRATION-18.0.md) for what changes
+> and why.
+
 ## Installation
 
 ### As npm Package

package/dist/runtime/atc/types.d.ts

@@ -44,10 +44,12 @@ export type IAtcRunResult = {
      * `FINDING_STATS` as the server sent it — a comma-separated triple, for
      * example `"0,0,1"`.
      *
-     * Not parsed into named counts. Which position is which severity has been
-     * seen once, in a worklist with a single finding at priority 3, which fits
-     * several orderings; inventing `{ errors, warnings, infos }` would publish
-     * two guesses to save a caller one `split(',')`.
+     * Not parsed into named counts, though the ordering is now measured
+     * twice: one priority-3 finding read `"0,0,1"`, one priority-2 finding
+     * read `"0,1,0"` (BTP trial, 2026-09-08 — see the ATC integration test).
+     * Both fit `(priority 1, priority 2, priority 3)` and nothing else fits
+     * both. What is still unseen is a non-zero first position, so naming the
+     * fields would publish one guess to save a caller one `split(',')`.
      */
     findingStats: string;
 };

package/dist/runtime/atc/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/runtime/atc/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GACrB;IACE;;;;;OAKG;IACH,MAAM,EAAE,KAAK,CAAC;IACd,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,GACD;IACE,8DAA8D;IAC9D,MAAM,EAAE,IAAI,CAAC;IACb,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;;OAQG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN,kEAAkE;AAClE,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;OAYG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/runtime/atc/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GACrB;IACE;;;;;OAKG;IACH,MAAM,EAAE,KAAK,CAAC;IACd,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,GACD;IACE,8DAA8D;IAC9D,MAAM,EAAE,IAAI,CAAC;IACb,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;;;;OAUG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN,kEAAkE;AAClE,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;OAYG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/docs/README.md

@@ -0,0 +1,111 @@
+# Documentation
+
+Complete documentation for the `@mcp-abap-adt/adt-clients` package.
+
+## Quick Start
+
+- [Main README](../README.md) - Package overview, installation, and quick start guide
+- [CHANGELOG](../CHANGELOG.md) - Version history and release notes
+
+## Architecture
+
+- [**ARCHITECTURE.md**](architecture/ARCHITECTURE.md) - System architecture, design patterns, and type system organization
+- [**LEGACY.md**](architecture/LEGACY.md) - Legacy system support (BASIS < 7.50): supported types, RFC transport, endpoint availability
+
+## Usage Guides
+
+- [**MIGRATION-18.0.md**](usage/MIGRATION-18.0.md) — what a consumer on 17.x has to change, and why the compiler is right
+- [**OBJECT_LIFECYCLE.md**](usage/OBJECT_LIFECYCLE.md) — create → lock → update → unlock → activate: the calls you make, what each one does, where the flow does not hold
+- [**CLIENT_API_REFERENCE.md**](usage/CLIENT_API_REFERENCE.md) - Complete API reference for `AdtClient`
+- [**RFC_CONNECTION.md**](usage/RFC_CONNECTION.md) - RFC connection guide for legacy systems
+- [**STATEFUL_SESSION_GUIDE.md**](usage/STATEFUL_SESSION_GUIDE.md) - Guide for stateful session management
+- [**CHECK_LOCAL_TEST_CLASS.md**](usage/CHECK_LOCAL_TEST_CLASS.md) - Guide for validating ABAP Unit test classes
+- [**DEBUG.md**](usage/DEBUG.md) - Debugging and troubleshooting guide
+- [TROUBLESHOOTING.md](usage/TROUBLESHOOTING.md) — what ADT answers when it refuses, and why the message is often accurate about the wrong thing
+- [**OPERATION_DELAYS.md**](usage/OPERATION_DELAYS.md) - Detailed guide on operation delays and timing
+- [**OPERATION_DELAYS_SUMMARY.md**](usage/OPERATION_DELAYS_SUMMARY.md) - Quick reference for operation delays
+
+## Development
+- [**RUNNING_TESTS.md**](development/RUNNING_TESTS.md) — how to run the suite, why an agent CLI must run it detached, and what order things go in
+- [**TEST_CONFIG_SCHEMA.md**](development/TEST_CONFIG_SCHEMA.md) - Test configuration schema and guidelines
+- [**UPDATE_CONTENT_TYPES.md**](development/UPDATE_CONTENT_TYPES.md) - Content types for update operations (text/plain vs XML)
+- [**RFC_TESTING.md**](development/RFC_TESTING.md) - RFC testing setup and environment variables
+
+## Documentation Structure
+
+```
+docs/
+├── README.md                          # This file - documentation index
+├── architecture/
+│   ├── ARCHITECTURE.md               # System architecture and design
+│   ├── LEGACY.md                     # Legacy system support (BASIS < 7.50)
+│   ├── discovery.md                  # ADT Discovery documentation
+│   └── discovery.xml                 # Pretty-printed ADT discovery XML
+├── usage/
+│   ├── OBJECT_LIFECYCLE.md           # The create → … → activate flow and its exceptions
+│   ├── CLIENT_API_REFERENCE.md       # Client API reference
+│   ├── STATEFUL_SESSION_GUIDE.md     # Session management
+│   ├── CHECK_LOCAL_TEST_CLASS.md     # Local test class validation
+│   ├── DEBUG.md                      # Debugging guide
+│   ├── OPERATION_DELAYS.md           # Operation delays (detailed)
+│   └── OPERATION_DELAYS_SUMMARY.md   # Operation delays (summary)
+└── development/
+    ├── TEST_CONFIG_SCHEMA.md         # Test configuration
+    ├── UPDATE_CONTENT_TYPES.md       # Update content types reference
+    └── BUILDER_TEST_PATTERN.md       # Integration test pattern (AdtClient/BaseTester)
+```
+
+## Key Concepts
+
+### Client Classes
+
+The package provides the main client classes:
+
+- **AdtClient** - High-level CRUD API; one member, one ADT request (recommended)
+- **AdtRuntimeClient** - Runtime operations (ABAP debugger, traces, dumps, logs, feeds, ATC check runs)
+
+See [CLIENT_API_REFERENCE.md](usage/CLIENT_API_REFERENCE.md) for complete method documentation.
+
+### Usage Examples
+
+**Using AdtClient (recommended):**
+```typescript
+const client = new AdtClient(connection, logger);
+
+// Every member answers a contract: a result or a failure, never both.
+const created = await client.getClass().create({
+  className: 'ZCL_TEST',
+  packageName: 'ZPACKAGE',
+  description: 'Test',
+});
+if (!created.ok) throw new Error(created.getError().message);
+
+// Utility operations
+const found = await client.getUtils().search({ query: 'Z*', objectType: 'CLAS' });
+if (found.ok) found.getResult().value;   // ISearchResult[]
+```
+
+### Type System
+
+The package uses a dual naming convention:
+- **snake_case** - Low-level ADT parameters
+- **camelCase** - Adt* configuration and high-level APIs
+
+See [ARCHITECTURE.md](architecture/ARCHITECTURE.md#type-system-organization) for details.
+
+### Session Management
+
+The package supports stateful sessions with automatic lock handle tracking and session persistence.
+
+See [STATEFUL_SESSION_GUIDE.md](usage/STATEFUL_SESSION_GUIDE.md) for implementation details.
+
+## Contributing
+
+- [CONTRIBUTORS.md](../CONTRIBUTORS.md) - Contribution guidelines and contributor list
+- [LICENSE](../LICENSE) - MIT License
+
+## Support
+
+For issues and questions:
+- GitHub Issues: [mcp-abap-adt-clients repository](https://github.com/fr0ster/mcp-abap-adt-clients)
+- See [DEBUG.md](usage/DEBUG.md) for troubleshooting common issues

package/docs/usage/ADT_OBJECT_ENTITIES.md

@@ -0,0 +1,248 @@
+# ADT Object Entities
+
+_Generated by `tools/adt-object-entities.js`. Do not edit by hand._
+
+## AccessControl
+- Core module: `accessControl`
+- Core classes: `AdtAccessControl`
+- Client methods: `AdtClient.getAccessControl`
+- Core functions: `activation.ts:activateAccessControl`, `check.ts:checkAccessControl`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteAccessControl`, `lock.ts:lockAccessControl`, `read.ts:getAccessControl`, `read.ts:getAccessControlSource`, `read.ts:getAccessControlTransport`, `unlock.ts:unlockAccessControl`, `update.ts:updateAccessControl`, `validation.ts:validateAccessControlName`, `versions.ts:getAccessControlVersions`, `versions.ts:getAccessControlVersionSource`
+
+## AppendStructure
+- Core module: `appendStructure`
+- Core classes: `AdtAppendStructure`
+- Client methods: `AdtClient.getAppendStructure`
+- Core functions: `activation.ts:activateAppendStructure`, `check.ts:checkAppendStructure`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteAppendStructure`, `lock.ts:lockAppendStructure`, `read.ts:getAppendStructure`, `read.ts:getAppendStructureSource`, `read.ts:getAppendStructureTransport`, `unlock.ts:unlockAppendStructure`, `update.ts:updateAppendStructure`, `validation.ts:validateAppendStructureName`, `versions.ts:getAppendStructureVersions`, `versions.ts:getAppendStructureVersionSource`
+
+## AuthorizationField
+- Core module: `authorizationField`
+- Core classes: `AdtAuthorizationField`
+- Client methods: `AdtClient.getAuthorizationField`
+- Core functions: `activation.ts:activateAuthorizationField`, `check.ts:checkAuthorizationField`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteAuthorizationField`, `lock.ts:lockAuthorizationField`, `read.ts:readAuthorizationField`, `unlock.ts:unlockAuthorizationField`, `update.ts:updateAuthorizationField`, `validation.ts:validateAuthorizationFieldName`, `xmlBuilder.ts:buildAuthorizationFieldXml`
+
+## BehaviorDefinition
+- Core module: `behaviorDefinition`
+- Core classes: `AdtBehaviorDefinition`
+- Client methods: `AdtClient.getBehaviorDefinition`
+- Core functions: `activation.ts:activate`, `check.ts:check`, `check.ts:checkAbap`, `check.ts:checkImplementation`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteBehaviorDefinition`, `lock.ts:lock`, `lock.ts:lockForUpdate`, `read.ts:getBehaviorDefinitionTransport`, `read.ts:read`, `read.ts:readSource`, `unlock.ts:unlock`, `update.ts:update`, `validation.ts:validate`, `versions.ts:getBehaviorDefinitionVersions`, `versions.ts:getBehaviorDefinitionVersionSource`
+
+## BehaviorImplementation
+- Core module: `behaviorImplementation`
+- Core classes: `AdtBehaviorImplementation`
+- Client methods: `AdtClient.getBehaviorImplementation`
+- Core functions: `read.ts:getBehaviorImplementationImplementations`, `read.ts:getBehaviorImplementationMetadata`, `read.ts:getBehaviorImplementationSource`, `read.ts:getBehaviorImplementationTransport`, `update.ts:updateBehaviorImplementation`, `validation.ts:validateBehaviorImplementationName`, `versions.ts:getBehaviorImplementationVersions`, `versions.ts:getBehaviorImplementationVersionSource`
+
+## CdsUnitTest
+- Core module: `unitTest`
+- Core classes: `AdtCdsUnitTest`, `AdtUnitTest`, `AdtUnitTestLegacy`
+- Client methods: `AdtClient.getCdsUnitTest`
+- Core functions: `checkCdsTestDoublesAvailability.ts:checkCdsTestDoublesAvailability`, `run.ts:getClassUnitTestResult`, `run.ts:getClassUnitTestStatus`, `run.ts:startClassUnitTestRun`, `run.ts:startClassUnitTestRunByObject`, `runLegacy.ts:getClassUnitTestResultLegacy`, `runLegacy.ts:getClassUnitTestStatusLegacy`, `runLegacy.ts:startClassUnitTestRunLegacy`
+
+## Class
+- Core module: `class`
+- Core classes: `AdtClass`, `AdtClassLegacy`, `AdtLocalDefinitions`, `AdtLocalMacros`, `AdtLocalTestClass`, `AdtLocalTypes`
+- Client methods: `AdtClient.getClass`
+- Core functions: `activation.ts:activateClass`, `check.ts:checkClass`, `check.ts:checkClassDefinitions`, `check.ts:checkClassLocalTestClass`, `check.ts:checkClassLocalTypes`, `check.ts:checkClassMacros`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteClass`, `includes.ts:updateClassDefinitions`, `includes.ts:updateClassLocalTypes`, `includes.ts:updateClassMacros`, `lock.ts:lockClass`, `lock.ts:lockClassForUpdate`, `read.ts:getClass`, `read.ts:getClassDefinitionsInclude`, `read.ts:getClassImplementationsInclude`, `read.ts:getClassMacrosInclude`, `read.ts:getClassMetadata`, `read.ts:getClassSource`, `read.ts:getClassTestClassesInclude`, `read.ts:getClassTransport`, `run.ts:getClassUnitTestResult`, `run.ts:getClassUnitTestStatus`, `run.ts:runClass`, `run.ts:startClassUnitTestRun`, `run.ts:startClassUnitTestRunByObject`, `testclasses.ts:activateClassTestClasses`, `testclasses.ts:updateClassTestInclude`, `unlock.ts:unlockClass`, `update.ts:updateClass`, `update.ts:updateClassImplementations`, `update.ts:updateClassWithCheck`, `validation.ts:validateClassName`, `validation.ts:validateClassSource`, `versions.ts:getClassIncludeVersions`, `versions.ts:getClassVersionSource`
+
+## DataElement
+- Core module: `dataElement`
+- Core classes: `AdtDataElement`
+- Client methods: `AdtClient.getDataElement`
+- Core functions: `activation.ts:activateDataElement`, `check.ts:checkDataElement`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteDataElement`, `lock.ts:lockDataElement`, `read.ts:getDataElement`, `read.ts:getDataElementTransport`, `unlock.ts:unlockDataElement`, `update.ts:getDomainInfo`, `update.ts:updateDataElement`, `update.ts:updateDataElementInternal`, `validation.ts:validateDataElementName`
+
+## Ddl
+- Core module: `ddl`
+- Core classes: `AdtDdl`, `AdtDdlLegacy`
+- Client methods: `AdtClient.getDdl`
+- Core functions: `activation.ts:activateDDLS`, `check.ts:checkDdl`, `create.ts:createDdl`, `delete.ts:checkDeletion`, `delete.ts:deleteDdl`, `lock.ts:lockDDLS`, `lock.ts:lockDDLSForUpdate`, `read.ts:getDdl`, `read.ts:getDdlMetadata`, `read.ts:getDdlSource`, `read.ts:getDdlTransport`, `unlock.ts:unlockDDLS`, `update.ts:updateDdl`, `validation.ts:validateDdlName`, `versions.ts:getDdlVersions`, `versions.ts:getDdlVersionSource`
+
+## Domain
+- Core module: `domain`
+- Core classes: `AdtDomain`
+- Client methods: `AdtClient.getDomain`
+- Core functions: `activation.ts:activateDomain`, `check.ts:checkDomainSyntax`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteDomain`, `lock.ts:acquireLockHandle`, `lock.ts:lockDomain`, `read.ts:getDomain`, `read.ts:getDomainTransport`, `unlock.ts:unlockDomain`, `update.ts:updateDomain`, `validation.ts:validateDomainName`
+
+## Enhancement
+- Core module: `enhancement`
+- Core classes: `AdtEnhancement`
+- Client methods: `AdtClient.getEnhancement`
+- Core functions: `activation.ts:activateEnhancement`, `check.ts:check`, `check.ts:checkEnhancement`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteEnhancement`, `lock.ts:lockEnhancement`, `lock.ts:lockEnhancementForUpdate`, `read.ts:getEnhancementMetadata`, `read.ts:getEnhancementSource`, `read.ts:getEnhancementTransport`, `unlock.ts:unlockEnhancement`, `update.ts:update`, `update.ts:updateEnhancement`, `validation.ts:validate`, `validation.ts:validateEnhancementName`, `versions.ts:getEnhancementVersions`, `versions.ts:getEnhancementVersionSource`
+
+## FeatureToggle
+- Core module: `featureToggle`
+- Core classes: `AdtFeatureToggle`
+- Client methods: `AdtClient.getFeatureToggle`
+- Core functions: `activation.ts:activateFeatureToggle`, `check.ts:checkFeatureToggle`, `checkState.ts:checkFeatureToggleState`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteFeatureToggle`, `getState.ts:getFeatureToggleState`, `lock.ts:lockFeatureToggle`, `read.ts:readFeatureToggle`, `readSource.ts:readFeatureToggleSource`, `switch.ts:toggleFeatureToggle`, `unlock.ts:unlockFeatureToggle`, `update.ts:updateFeatureToggle`, `updateSource.ts:uploadFeatureToggleSource`, `validation.ts:validateFeatureToggleName`, `xmlBuilder.ts:buildFeatureToggleXml`
+
+## FunctionGroup
+- Core module: `functionGroup`
+- Core classes: `AdtFunctionGroup`, `AdtFunctionGroupLegacy`
+- Client methods: `AdtClient.getFunctionGroup`
+- Core functions: `activation.ts:activateFunctionGroup`, `check.ts:checkFunctionGroup`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteFunctionGroup`, `lock.ts:lockFunctionGroup`, `lock.ts:unlockFunctionGroup`, `read.ts:getFunctionGroup`, `read.ts:getFunctionGroupTransport`, `update.ts:updateFunctionGroup`, `validation.ts:validateFunctionGroupName`
+
+## FunctionInclude
+- Core module: `functionInclude`
+- Core classes: `AdtFunctionInclude`
+- Client methods: `AdtClient.getFunctionInclude`
+- Core functions: `activation.ts:activateFunctionInclude`, `check.ts:checkFunctionInclude`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteFunctionInclude`, `lock.ts:lockFunctionInclude`, `read.ts:readFunctionInclude`, `readSource.ts:readFunctionIncludeSource`, `unlock.ts:unlockFunctionInclude`, `update.ts:updateFunctionInclude`, `updateSource.ts:uploadFunctionIncludeSource`, `validation.ts:validateFunctionIncludeName`, `versions.ts:getFunctionIncludeVersions`, `versions.ts:getFunctionIncludeVersionSource`, `xmlBuilder.ts:buildFunctionIncludeXml`
+
+## FunctionModule
+- Core module: `functionModule`
+- Core classes: `AdtFunctionModule`, `AdtFunctionModuleLegacy`
+- Client methods: `AdtClient.getFunctionModule`
+- Core functions: `activation.ts:activateFunctionModule`, `check.ts:checkFunctionModule`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteFunctionModule`, `lock.ts:lockFunctionModule`, `lock.ts:lockFunctionModuleForUpdate`, `read.ts:getFunction`, `read.ts:getFunctionMetadata`, `read.ts:getFunctionModuleTransport`, `read.ts:getFunctionSource`, `unlock.ts:unlockFunctionModule`, `update.ts:update`, `validation.ts:validateFunctionModuleName`, `validation.ts:validateFunctionModuleSource`, `versions.ts:getFunctionModuleVersions`, `versions.ts:getFunctionModuleVersionSource`
+
+## Interface
+- Core module: `interface`
+- Core classes: `AdtInterface`, `AdtInterfaceLegacy`
+- Client methods: `AdtClient.getInterface`
+- Core functions: `activation.ts:activateInterface`, `check.ts:checkInterface`, `create.ts:create`, `create.ts:generateInterfaceTemplate`, `delete.ts:checkDeletion`, `delete.ts:deleteInterface`, `lock.ts:lockInterface`, `lock.ts:lockInterfaceForUpdate`, `read.ts:getInterface`, `read.ts:getInterfaceMetadata`, `read.ts:getInterfaceSource`, `read.ts:getInterfaceTransport`, `unlock.ts:unlockInterface`, `update.ts:upload`, `validation.ts:validateInterfaceName`, `versions.ts:getInterfaceVersions`, `versions.ts:getInterfaceVersionSource`
+
+## LocalDefinitions
+- Core module: `class`
+- Core classes: `AdtClass`, `AdtClassLegacy`, `AdtLocalDefinitions`, `AdtLocalMacros`, `AdtLocalTestClass`, `AdtLocalTypes`
+- Client methods: `AdtClient.getLocalDefinitions`
+- Core functions: `activation.ts:activateClass`, `check.ts:checkClass`, `check.ts:checkClassDefinitions`, `check.ts:checkClassLocalTestClass`, `check.ts:checkClassLocalTypes`, `check.ts:checkClassMacros`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteClass`, `includes.ts:updateClassDefinitions`, `includes.ts:updateClassLocalTypes`, `includes.ts:updateClassMacros`, `lock.ts:lockClass`, `lock.ts:lockClassForUpdate`, `read.ts:getClass`, `read.ts:getClassDefinitionsInclude`, `read.ts:getClassImplementationsInclude`, `read.ts:getClassMacrosInclude`, `read.ts:getClassMetadata`, `read.ts:getClassSource`, `read.ts:getClassTestClassesInclude`, `read.ts:getClassTransport`, `run.ts:getClassUnitTestResult`, `run.ts:getClassUnitTestStatus`, `run.ts:runClass`, `run.ts:startClassUnitTestRun`, `run.ts:startClassUnitTestRunByObject`, `testclasses.ts:activateClassTestClasses`, `testclasses.ts:updateClassTestInclude`, `unlock.ts:unlockClass`, `update.ts:updateClass`, `update.ts:updateClassImplementations`, `update.ts:updateClassWithCheck`, `validation.ts:validateClassName`, `validation.ts:validateClassSource`, `versions.ts:getClassIncludeVersions`, `versions.ts:getClassVersionSource`
+
+## LocalMacros
+- Core module: `class`
+- Core classes: `AdtClass`, `AdtClassLegacy`, `AdtLocalDefinitions`, `AdtLocalMacros`, `AdtLocalTestClass`, `AdtLocalTypes`
+- Client methods: `AdtClient.getLocalMacros`
+- Core functions: `activation.ts:activateClass`, `check.ts:checkClass`, `check.ts:checkClassDefinitions`, `check.ts:checkClassLocalTestClass`, `check.ts:checkClassLocalTypes`, `check.ts:checkClassMacros`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteClass`, `includes.ts:updateClassDefinitions`, `includes.ts:updateClassLocalTypes`, `includes.ts:updateClassMacros`, `lock.ts:lockClass`, `lock.ts:lockClassForUpdate`, `read.ts:getClass`, `read.ts:getClassDefinitionsInclude`, `read.ts:getClassImplementationsInclude`, `read.ts:getClassMacrosInclude`, `read.ts:getClassMetadata`, `read.ts:getClassSource`, `read.ts:getClassTestClassesInclude`, `read.ts:getClassTransport`, `run.ts:getClassUnitTestResult`, `run.ts:getClassUnitTestStatus`, `run.ts:runClass`, `run.ts:startClassUnitTestRun`, `run.ts:startClassUnitTestRunByObject`, `testclasses.ts:activateClassTestClasses`, `testclasses.ts:updateClassTestInclude`, `unlock.ts:unlockClass`, `update.ts:updateClass`, `update.ts:updateClassImplementations`, `update.ts:updateClassWithCheck`, `validation.ts:validateClassName`, `validation.ts:validateClassSource`, `versions.ts:getClassIncludeVersions`, `versions.ts:getClassVersionSource`
+
+## LocalTestClass
+- Core module: `class`
+- Core classes: `AdtClass`, `AdtClassLegacy`, `AdtLocalDefinitions`, `AdtLocalMacros`, `AdtLocalTestClass`, `AdtLocalTypes`
+- Client methods: `AdtClient.getLocalTestClass`
+- Core functions: `activation.ts:activateClass`, `check.ts:checkClass`, `check.ts:checkClassDefinitions`, `check.ts:checkClassLocalTestClass`, `check.ts:checkClassLocalTypes`, `check.ts:checkClassMacros`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteClass`, `includes.ts:updateClassDefinitions`, `includes.ts:updateClassLocalTypes`, `includes.ts:updateClassMacros`, `lock.ts:lockClass`, `lock.ts:lockClassForUpdate`, `read.ts:getClass`, `read.ts:getClassDefinitionsInclude`, `read.ts:getClassImplementationsInclude`, `read.ts:getClassMacrosInclude`, `read.ts:getClassMetadata`, `read.ts:getClassSource`, `read.ts:getClassTestClassesInclude`, `read.ts:getClassTransport`, `run.ts:getClassUnitTestResult`, `run.ts:getClassUnitTestStatus`, `run.ts:runClass`, `run.ts:startClassUnitTestRun`, `run.ts:startClassUnitTestRunByObject`, `testclasses.ts:activateClassTestClasses`, `testclasses.ts:updateClassTestInclude`, `unlock.ts:unlockClass`, `update.ts:updateClass`, `update.ts:updateClassImplementations`, `update.ts:updateClassWithCheck`, `validation.ts:validateClassName`, `validation.ts:validateClassSource`, `versions.ts:getClassIncludeVersions`, `versions.ts:getClassVersionSource`
+
+## LocalTypes
+- Core module: `class`
+- Core classes: `AdtClass`, `AdtClassLegacy`, `AdtLocalDefinitions`, `AdtLocalMacros`, `AdtLocalTestClass`, `AdtLocalTypes`
+- Client methods: `AdtClient.getLocalTypes`
+- Core functions: `activation.ts:activateClass`, `check.ts:checkClass`, `check.ts:checkClassDefinitions`, `check.ts:checkClassLocalTestClass`, `check.ts:checkClassLocalTypes`, `check.ts:checkClassMacros`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteClass`, `includes.ts:updateClassDefinitions`, `includes.ts:updateClassLocalTypes`, `includes.ts:updateClassMacros`, `lock.ts:lockClass`, `lock.ts:lockClassForUpdate`, `read.ts:getClass`, `read.ts:getClassDefinitionsInclude`, `read.ts:getClassImplementationsInclude`, `read.ts:getClassMacrosInclude`, `read.ts:getClassMetadata`, `read.ts:getClassSource`, `read.ts:getClassTestClassesInclude`, `read.ts:getClassTransport`, `run.ts:getClassUnitTestResult`, `run.ts:getClassUnitTestStatus`, `run.ts:runClass`, `run.ts:startClassUnitTestRun`, `run.ts:startClassUnitTestRunByObject`, `testclasses.ts:activateClassTestClasses`, `testclasses.ts:updateClassTestInclude`, `unlock.ts:unlockClass`, `update.ts:updateClass`, `update.ts:updateClassImplementations`, `update.ts:updateClassWithCheck`, `validation.ts:validateClassName`, `validation.ts:validateClassSource`, `versions.ts:getClassIncludeVersions`, `versions.ts:getClassVersionSource`
+
+## MessageClass
+- Core module: `messageClass`
+- Core classes: `AdtMessageClass`, `AdtMessageClassMessage`
+- Client methods: `AdtClient.getMessageClass`
+- Core functions: `create.ts:createMessageClass`, `delete.ts:checkDeletion`, `delete.ts:deleteMessageClass`, `lock.ts:lockClassForMessage`, `lock.ts:lockMessage`, `lock.ts:lockMessageClass`, `read.ts:getMessageClassSource`, `unlock.ts:unlockAllMessages`, `unlock.ts:unlockMessageClass`, `update.ts:updateMessageClass`, `xml.ts:buildMessageClassXml`, `xml.ts:parseMessageClass`
+
+## MessageClassMessage
+- Core module: `messageClass`
+- Core classes: `AdtMessageClass`, `AdtMessageClassMessage`
+- Client methods: `AdtClient.getMessageClassMessage`
+- Core functions: `create.ts:createMessageClass`, `delete.ts:checkDeletion`, `delete.ts:deleteMessageClass`, `lock.ts:lockClassForMessage`, `lock.ts:lockMessage`, `lock.ts:lockMessageClass`, `read.ts:getMessageClassSource`, `unlock.ts:unlockAllMessages`, `unlock.ts:unlockMessageClass`, `update.ts:updateMessageClass`, `xml.ts:buildMessageClassXml`, `xml.ts:parseMessageClass`
+
+## MetadataExtension
+- Core module: `metadataExtension`
+- Core classes: `AdtMetadataExtension`
+- Client methods: `AdtClient.getMetadataExtension`
+- Core functions: `activate.ts:activateMetadataExtension`, `check.ts:checkMetadataExtension`, `create.ts:createMetadataExtension`, `delete.ts:deleteMetadataExtension`, `lock.ts:lockMetadataExtension`, `read.ts:getMetadataExtensionTransport`, `read.ts:readMetadataExtension`, `read.ts:readMetadataExtensionSource`, `unlock.ts:unlockMetadataExtension`, `update.ts:updateMetadataExtension`, `validation.ts:validateMetadataExtension`, `versions.ts:getMetadataExtensionVersions`, `versions.ts:getMetadataExtensionVersionSource`
+
+## Package
+- Core module: `package`
+- Core classes: `AdtPackage`, `AdtPackageLegacy`
+- Client methods: `AdtClient.getPackage`
+- Core functions: `check.ts:checkPackage`, `create.ts:createPackage`, `delete.ts:checkPackageDeletion`, `delete.ts:deletePackage`, `delete.ts:parsePackageDeletionCheck`, `lock.ts:lockPackage`, `read.ts:getPackage`, `read.ts:getPackageTransport`, `transportCheck.ts:checkTransportRequirements`, `unlock.ts:unlockPackage`, `update.ts:updatePackage`, `update.ts:updatePackageDescription`, `validation.ts:validatePackageBasic`, `validation.ts:validatePackageFull`
+
+## Program
+- Core module: `program`
+- Core classes: `AdtProgram`, `AdtProgramLegacy`
+- Client methods: `AdtClient.getProgram`
+- Core functions: `activation.ts:activateProgram`, `check.ts:checkProgram`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteProgram`, `lock.ts:lockProgram`, `lock.ts:lockProgramForUpdate`, `read.ts:getProgram`, `read.ts:getProgramMetadata`, `read.ts:getProgramSource`, `read.ts:getProgramTransport`, `run.ts:runProgram`, `unlock.ts:unlockProgram`, `update.ts:uploadProgramSource`, `validation.ts:validateProgramName`, `versions.ts:getProgramVersions`, `versions.ts:getProgramVersionSource`
+
+## Request
+- Core module: `transport`
+- Core classes: `AdtRequest`, `AdtRequestLegacy`
+- Client methods: `AdtClient.getRequest`
+- Core functions: `create.ts:createTransport`, `delete.ts:deleteTransport`, `list.ts:getTransportSearchConfigurations`, `list.ts:listTransports`, `parseSearchConfigurations.ts:parseSearchConfigurations`, `parseTransportTree.ts:parseTransportTree`, `read.ts:getTransport`, `readLegacy.ts:getTransportLegacy`, `readLegacy.ts:listTransportsLegacy`, `update.ts:updateTransport`
+
+## ScalarFunction
+- Core module: `scalarFunction`
+- Core classes: `AdtScalarFunction`
+- Client methods: `AdtClient.getScalarFunction`
+- Core functions: `activation.ts:activateScalarFunction`, `check.ts:checkScalarFunction`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteScalarFunction`, `lock.ts:lockScalarFunction`, `read.ts:getScalarFunction`, `read.ts:getScalarFunctionSource`, `read.ts:getScalarFunctionTransport`, `unlock.ts:unlockScalarFunction`, `update.ts:updateScalarFunction`, `validation.ts:validateScalarFunctionName`, `versions.ts:getScalarFunctionVersions`, `versions.ts:getScalarFunctionVersionSource`
+
+## ScalarFunctionImplementation
+- Core module: `scalarFunctionImplementation`
+- Core classes: `AdtScalarFunctionImplementation`
+- Client methods: `AdtClient.getScalarFunctionImplementation`
+- Core functions: `activation.ts:activateScalarFunctionImplementation`, `check.ts:checkScalarFunctionImplementation`, `create.ts:buildServerDrivenContent`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteScalarFunctionImplementation`, `lock.ts:lockScalarFunctionImplementation`, `read.ts:getScalarFunctionImplementation`, `read.ts:getScalarFunctionImplementationSource`, `read.ts:getScalarFunctionImplementationTransport`, `unlock.ts:unlockScalarFunctionImplementation`, `update.ts:updateScalarFunctionImplementation`, `updateMetadata.ts:updateScalarFunctionImplementationMetadata`, `validation.ts:validateScalarFunctionImplementationName`, `versions.ts:getScalarFunctionImplementationVersions`, `versions.ts:getScalarFunctionImplementationVersionSource`
+
+## Service
+- Core module: `service`
+- Core classes: `AdtService`, `AdtServiceBinding`
+- Client methods: `AdtClient.getService`
+- Core functions: —
+
+## ServiceBinding
+- Core module: `service`
+- Core classes: `AdtService`, `AdtServiceBinding`
+- Client methods: `AdtClient.getServiceBinding`
+- Core functions: —
+
+## ServiceDefinition
+- Core module: `serviceDefinition`
+- Core classes: `AdtServiceDefinition`
+- Client methods: `AdtClient.getServiceDefinition`
+- Core functions: `activation.ts:activateServiceDefinition`, `check.ts:checkServiceDefinition`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteServiceDefinition`, `lock.ts:lockServiceDefinition`, `read.ts:getServiceDefinition`, `read.ts:getServiceDefinitionSource`, `read.ts:getServiceDefinitionTransport`, `unlock.ts:unlockServiceDefinition`, `update.ts:updateServiceDefinition`, `validation.ts:validateServiceDefinitionName`, `versions.ts:getServiceDefinitionVersions`, `versions.ts:getServiceDefinitionVersionSource`
+
+## Structure
+- Core module: `structure`
+- Core classes: `AdtStructure`
+- Client methods: `AdtClient.getStructure`
+- Core functions: `activation.ts:activateStructure`, `check.ts:checkStructure`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteStructure`, `lock.ts:lockStructure`, `read.ts:getStructure`, `read.ts:getStructureMetadata`, `read.ts:getStructureSource`, `read.ts:getStructureTransport`, `unlock.ts:unlockStructure`, `update.ts:updateStructure`, `update.ts:upload`, `validation.ts:validateStructureName`, `versions.ts:getStructureVersions`, `versions.ts:getStructureVersionSource`
+
+## Table
+- Core module: `table`
+- Core classes: `AdtTable`
+- Client methods: `AdtClient.getTable`
+- Core functions: `activation.ts:activateTable`, `check.ts:runTableCheckRun`, `create.ts:createTable`, `delete.ts:checkDeletion`, `delete.ts:deleteTable`, `lock.ts:acquireTableLockHandle`, `read.ts:getTable`, `read.ts:getTableMetadata`, `read.ts:getTableSource`, `read.ts:getTableTransport`, `unlock.ts:deleteTableLock`, `unlock.ts:unlockTable`, `update.ts:updateTable`, `validation.ts:validateTableName`, `versions.ts:getTableVersions`, `versions.ts:getTableVersionSource`
+
+## TableType
+- Core module: `tabletype`
+- Core classes: `AdtDdicTableType`
+- Client methods: `AdtClient.getTableType`
+- Core functions: `activation.ts:activateTableType`, `check.ts:runTableTypeCheckRun`, `create.ts:createTableType`, `delete.ts:checkDeletion`, `delete.ts:deleteTableType`, `lock.ts:acquireTableTypeLockHandle`, `read.ts:getTableType`, `read.ts:getTableTypeMetadata`, `read.ts:getTableTypeSource`, `read.ts:getTableTypeTransport`, `unlock.ts:deleteTableTypeLock`, `unlock.ts:unlockTableType`, `update.ts:updateTableType`, `validation.ts:validateTableTypeName`, `versions.ts:getTableTypeVersions`, `versions.ts:getTableTypeVersionSource`
+
+## Transformation
+- Core module: `transformation`
+- Core classes: `AdtTransformation`
+- Client methods: `AdtClient.getTransformation`
+- Core functions: `activation.ts:activateTransformation`, `check.ts:checkTransformation`, `create.ts:create`, `delete.ts:checkDeletion`, `delete.ts:deleteTransformation`, `lock.ts:lockTransformation`, `read.ts:getTransformation`, `read.ts:getTransformationSource`, `read.ts:getTransformationTransport`, `unlock.ts:unlockTransformation`, `update.ts:updateTransformation`, `validation.ts:validateTransformationName`, `versions.ts:getTransformationVersions`, `versions.ts:getTransformationVersionSource`
+
+## UnitTest
+- Core module: `unitTest`
+- Core classes: `AdtCdsUnitTest`, `AdtUnitTest`, `AdtUnitTestLegacy`
+- Client methods: `AdtClient.getUnitTest`
+- Core functions: `checkCdsTestDoublesAvailability.ts:checkCdsTestDoublesAvailability`, `run.ts:getClassUnitTestResult`, `run.ts:getClassUnitTestStatus`, `run.ts:startClassUnitTestRun`, `run.ts:startClassUnitTestRunByObject`, `runLegacy.ts:getClassUnitTestResultLegacy`, `runLegacy.ts:getClassUnitTestStatusLegacy`, `runLegacy.ts:startClassUnitTestRunLegacy`
+
+## Standalone Clients
+
+Top-level client classes instantiated directly (not via `AdtClient.getXxx()`). They live under `src/clients/` alongside `AdtClient` and wrap non-`IAdtObject` surfaces.
+
+### AdtAbapGitClient
+- Source: `src/clients/AdtAbapGitClient.ts`
+- Public methods: `checkExternalRepo`, `getErrorLog`, `getRepo`, `link`, `listRepos`, `pull`, `unlink`
+
+### AdtClientLegacy
+- Source: `src/clients/AdtClientLegacy.ts`
+- Public methods: —
+
+### AdtClientsWS
+- Source: `src/clients/AdtClientsWS.ts`
+- Public methods: `connect`, `disconnect`, `getDebuggerSessionClient`, `isConnected`, `onEvent`, `request`, `sendEvent`
+
+### AdtExecutor
+- Source: `src/clients/AdtExecutor.ts`
+- Public methods: `getClassExecutor`, `getProgramExecutor`
+
+### AdtRuntimeClient
+- Source: `src/clients/AdtRuntimeClient.ts`
+- Public methods: `getApplicationLog`, `getAtc`, `getAtcLog`, `getCrossTrace`, `getDdicActivation`, `getDebugger`, `getDumps`, `getFeeds`, `getGatewayErrorLog`, `getProfiler`, `getSt05Trace`, `getSystemMessages`
+
+### DebuggerSessionClient
+- Source: `src/clients/DebuggerSessionClient.ts`
+- Public methods: `attach`, `detach`, `getStack`, `getVariables`, `listen`, `step`
+

package/docs/usage/CHECK_LOCAL_TEST_CLASS.md

@@ -0,0 +1,46 @@
+# Check Local Test Class
+
+This guide shows how to validate local test classes using `AdtClient`.
+
+## Using AdtClient
+
+```typescript
+import {
+  AdtOnPremConnector,
+  BasicAuthProvider,
+  OnPremHttpTransport,
+} from '@mcp-abap-adt/connection';
+import { AdtClient } from '@mcp-abap-adt/adt-clients';
+
+const config = {
+  url: process.env.SAP_URL!,
+  authType: 'basic' as const,
+  username: process.env.SAP_USERNAME!,
+  password: process.env.SAP_PASSWORD!,
+  client: process.env.SAP_CLIENT,
+};
+
+// System, credential and wire — all stated, never inferred.
+const connection = new AdtOnPremConnector(
+  config,
+  new BasicAuthProvider(config.username, config.password),
+  new OnPremHttpTransport(() => ({}), null, {
+    client: config.client,
+    baseUrl: config.url,
+  }),
+);
+await connection.connect();
+
+const client = new AdtClient(connection);
+
+const result = await client.getLocalTestClass().check({
+  className: 'ZCL_MY_CLASS',
+});
+
+console.log(result.checkResult?.status);
+```
+
+## Notes
+
+- Local test class checks use the same ADT endpoints as class checks.
+- If you need to read metadata, use `readMetadata` on the same object.