@mcp-abap-adt/interfaces 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -7,6 +7,65 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.5] - 2025-12-09
+
+### Added
+- **High-Level ADT Object Operations Interface**: Added `IAdtObject` interface for high-level CRUD operations
+  - `IAdtObject<TConfig, TReadResult>` - Main interface for ADT object operations
+  - Provides simplified CRUD operations with automatic operation chains, error handling, and resource cleanup
+  - Methods: `validate()`, `create()`, `read()`, `update()`, `delete()`, `activate()`, `check()`
+  - Supports full operation chains:
+    - Create: validate → create → check → lock → check(inactive) → update → unlock → check → activate
+    - Update: lock → check(inactive) → update → unlock → check → activate
+    - Delete: check(deletion) → delete
+- **Operation Options Interfaces**: Added options interfaces for create and update operations
+  - `CreateOptions` - Options for create operations:
+    - `activateOnCreate?: boolean` - Activate object after creation (default: false)
+    - `deleteOnFailure?: boolean` - Delete object if creation fails (default: false)
+    - `sourceCode?: string` - Source code to use for update after create
+    - `xmlContent?: string` - XML content to use for update after create
+  - `UpdateOptions` - Options for update operations:
+    - `activateOnUpdate?: boolean` - Activate object after update (default: false)
+    - `deleteOnFailure?: boolean` - Delete object if update fails (default: false)
+    - `lockHandle?: string` - Lock handle if object is already locked
+- **ADT Domain**: New domain for ADT client interfaces
+  - All interfaces exported from `@mcp-abap-adt/interfaces` under ADT domain
+  - Located in `src/adt/IAdtObject.ts`
+
+## [0.1.4] - 2025-12-08
+
+### Breaking Changes
+
+- **Session State Methods Removed from IAbapConnection**: Removed session state management methods from connection interface
+  - `getSessionState()` method removed from `IAbapConnection`
+  - `setSessionState()` method removed from `IAbapConnection`
+  - Session state management is no longer a responsibility of connection package
+  - Connection package now focuses solely on HTTP communication
+  - Session state persistence should be handled by higher-level packages (e.g., auth-broker)
+
+### Changed
+
+- **Connection Package Scope**: Updated `IAbapConnection` interface to reflect connection package responsibilities
+  - Connection package handles only HTTP communication and session headers
+  - Token refresh is not a responsibility of connection package - handled by `@mcp-abap-adt/auth-broker` package
+  - Session state persistence is not part of connection package scope
+
+### Migration Guide
+
+If you were using session state methods:
+
+**Before (0.1.x)**:
+```typescript
+const state = connection.getSessionState();
+connection.setSessionState(state);
+```
+
+**After (0.1.4)**:
+```typescript
+// Session state management is now handled by auth-broker or other higher-level packages
+// Connection package only handles HTTP communication
+```
+
 ## [0.1.3] - 2025-12-07
 
 ### Added

package/README.md

@@ -95,6 +95,9 @@ This package is responsible for:
 
 ### Connection Domain (`connection/`)
 - `IAbapConnection` - Main connection interface for ADT operations
+  - Handles HTTP communication with SAP systems
+  - Manages session headers (stateful/stateless mode via `setSessionType()`)
+  - Note: Token refresh and session state persistence are handled by other packages (e.g., auth-broker)
 - `IAbapRequestOptions` - Request options for ADT operations
 
 ### SAP Domain (`sap/`)

package/dist/adt/IAdtObject.d.ts

@@ -0,0 +1,121 @@
+/**
+ * High-level ADT Object Operations Interface
+ *
+ * Defines the interface for high-level CRUD operations on ADT objects.
+ * This interface is implemented by Adt{Entity} classes (e.g., AdtClass, AdtDomain).
+ *
+ * Unlike Builders which provide low-level method chaining, this interface
+ * provides high-level operation chains with automatic error handling and cleanup.
+ */
+import { AxiosResponse } from 'axios';
+/**
+ * Options for create operations
+ */
+export interface CreateOptions {
+    /**
+     * Activate object after creation
+     * @default false
+     */
+    activateOnCreate?: boolean;
+    /**
+     * Delete object if creation fails
+     * @default false
+     */
+    deleteOnFailure?: boolean;
+    /**
+     * Source code to use for update after create
+     */
+    sourceCode?: string;
+    /**
+     * XML content to use for update after create
+     */
+    xmlContent?: string;
+}
+/**
+ * Options for update operations
+ */
+export interface UpdateOptions {
+    /**
+     * Activate object after update
+     * @default false
+     */
+    activateOnUpdate?: boolean;
+    /**
+     * Delete object if update fails
+     * @default false
+     */
+    deleteOnFailure?: boolean;
+    /**
+     * Lock handle if object is already locked
+     */
+    lockHandle?: string;
+}
+/**
+ * High-level ADT Object Operations Interface
+ *
+ * Provides simplified CRUD operations with automatic operation chains,
+ * error handling, and resource cleanup.
+ *
+ * @template TConfig - Configuration type for the object (e.g., ClassBuilderConfig)
+ * @template TReadResult - Result type for read operations (defaults to TConfig)
+ */
+export interface IAdtObject<TConfig, TReadResult = TConfig> {
+    /**
+     * Validate object configuration before creation
+     * @param config - Object configuration
+     * @returns Validation response from ADT
+     */
+    validate(config: Partial<TConfig>): Promise<AxiosResponse>;
+    /**
+     * Create object with full operation chain:
+     * validate → create → check → lock → check(inactive) → update → unlock → check → activate (optional)
+     *
+     * @param config - Object configuration
+     * @param options - Create options (activation, cleanup, source code)
+     * @returns Created object configuration
+     * @throws Error if validation fails (object is not created)
+     * @throws Error if any operation fails (with cleanup if deleteOnFailure=true)
+     */
+    create(config: TConfig, options?: CreateOptions): Promise<TReadResult>;
+    /**
+     * Read object
+     * @param config - Object identification (name, etc.)
+     * @param version - 'active' or 'inactive'
+     * @returns Object configuration or source code, or undefined if not found
+     */
+    read(config: Partial<TConfig>, version?: 'active' | 'inactive'): Promise<TReadResult | undefined>;
+    /**
+     * Update object with full operation chain:
+     * lock → check(inactive) → update → unlock → check → activate (optional)
+     *
+     * @param config - Object configuration with updates
+     * @param options - Update options (activation, cleanup, lock handle)
+     * @returns Updated object configuration
+     * @throws Error if lock fails
+     * @throws Error if any operation fails (with cleanup if deleteOnFailure=true)
+     */
+    update(config: Partial<TConfig>, options?: UpdateOptions): Promise<TReadResult>;
+    /**
+     * Delete object
+     * Performs deletion check before deleting.
+     *
+     * @param config - Object identification
+     * @returns Delete response from ADT
+     * @throws Error if deletion check fails (object is not deleted)
+     */
+    delete(config: Partial<TConfig>): Promise<AxiosResponse>;
+    /**
+     * Activate object
+     * @param config - Object identification
+     * @returns Activation response from ADT
+     */
+    activate(config: Partial<TConfig>): Promise<AxiosResponse>;
+    /**
+     * Check object (syntax, consistency, etc.)
+     * @param config - Object identification
+     * @param status - Optional status to check ('active', 'inactive', 'deletion')
+     * @returns Check response from ADT
+     */
+    check(config: Partial<TConfig>, status?: string): Promise<AxiosResponse>;
+}
+//# sourceMappingURL=IAdtObject.d.ts.map

package/dist/adt/IAdtObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAdtObject.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtObject.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO;IACxD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE3D;;;;;;;;;OASG;IACH,MAAM,CACJ,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,WAAW,CAAC,CAAC;IAExB;;;;;OAKG;IACH,IAAI,CACF,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,OAAO,CAAC,EAAE,QAAQ,GAAG,UAAU,GAC9B,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IAEpC;;;;;;;;;OASG;IACH,MAAM,CACJ,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,WAAW,CAAC,CAAC;IAExB;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEzD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,KAAK,CACH,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,CAAC;CAC3B"}

package/dist/adt/IAdtObject.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * High-level ADT Object Operations Interface
+ *
+ * Defines the interface for high-level CRUD operations on ADT objects.
+ * This interface is implemented by Adt{Entity} classes (e.g., AdtClass, AdtDomain).
+ *
+ * Unlike Builders which provide low-level method chaining, this interface
+ * provides high-level operation chains with automatic error handling and cleanup.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/connection/IAbapConnection.d.ts

@@ -1,5 +1,4 @@
 import type { ISapConfig } from '../sap/ISapConfig';
-import type { ISessionState } from '../storage/ISessionState';
 import type { IAbapRequestOptions } from './IAbapRequestOptions';
 /**
  * Axios response type - using any to avoid dependency on axios package
@@ -15,7 +14,5 @@ export interface IAbapConnection {
     makeAdtRequest(options: IAbapRequestOptions): Promise<AxiosResponse>;
     connect(): Promise<void>;
     reset(): void;
-    getSessionState(): ISessionState | null;
-    setSessionState(state: ISessionState): void;
 }
 //# sourceMappingURL=IAbapConnection.d.ts.map

package/dist/connection/IAbapConnection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAbapConnection.d.ts","sourceRoot":"","sources":["../../src/connection/IAbapConnection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,GAAG,CAAC;AAEhC,MAAM,WAAW,eAAe;IAC9B,SAAS,IAAI,UAAU,CAAC;IACxB,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,YAAY,IAAI,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,WAAW,GAAG,IAAI,CAAC;IACrD,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,KAAK,IAAI,IAAI,CAAC;IACd,eAAe,IAAI,aAAa,GAAG,IAAI,CAAC;IACxC,eAAe,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;CAC7C"}
+{"version":3,"file":"IAbapConnection.d.ts","sourceRoot":"","sources":["../../src/connection/IAbapConnection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,GAAG,CAAC;AAEhC,MAAM,WAAW,eAAe;IAC9B,SAAS,IAAI,UAAU,CAAC;IACxB,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,YAAY,IAAI,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,WAAW,GAAG,IAAI,CAAC;IACrD,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,KAAK,IAAI,IAAI,CAAC;CACf"}

package/dist/index.d.ts

@@ -26,4 +26,5 @@ export { AuthMethodPriority } from './validation/IValidatedAuthConfig';
 export type { ITokenRefreshResult } from './utils/ITokenRefreshResult';
 export type { ITimeoutConfig } from './utils/ITimeoutConfig';
 export * from './Headers';
+export type { IAdtObject, CreateOptions, UpdateOptions } from './adt/IAdtObject';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,YAAY,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACxE,YAAY,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAGhD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,YAAY,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACzE,YAAY,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAG3E,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,YAAY,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGtE,YAAY,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,YAAY,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAG5E,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGrD,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,YAAY,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAGjD,YAAY,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAGvE,YAAY,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvE,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAG7D,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,YAAY,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACxE,YAAY,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAGhD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,YAAY,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACzE,YAAY,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAG3E,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,YAAY,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAGtE,YAAY,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,YAAY,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAG5E,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGrD,YAAY,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,YAAY,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAGjD,YAAY,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,YAAY,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAGvE,YAAY,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvE,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAG7D,cAAc,WAAW,CAAC;AAG1B,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mcp-abap-adt/interfaces",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Shared interfaces for MCP ABAP ADT packages",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",