@mcp-abap-adt/interfaces 0.1.4 → 0.1.6

package/CHANGELOG.md

@@ -7,6 +7,54 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.6] - 2025-12-09
+
+### Added
+- **Unified Operation Options Interface**: Created `IAdtOperationOptions` interface
+  - Unified interface for both create and update operations (replaces `CreateOptions` and `UpdateOptions`)
+  - Includes all fields from both interfaces: `activateOnCreate`, `activateOnUpdate`, `deleteOnFailure`, `sourceCode`, `xmlContent`, `timeout`
+  - `sourceCode` and `xmlContent` now available for update operations (previously only in create)
+  - `timeout?: number` - Timeout for operations in milliseconds (default: 1000)
+    - Prevents operation failures due to system not completing commands in time
+    - Increase timeout for complex operations or slow systems
+
+### Changed
+- **Operation Options Interfaces**: Unified `CreateOptions` and `UpdateOptions` into `IAdtOperationOptions`
+  - Both create and update operations now use the same interface
+  - `sourceCode` and `xmlContent` are now available for update operations
+  - Removed `lockHandle` field from update options (update operations always start with lock internally)
+  - All interfaces now follow `I` prefix convention (`IAdtOperationOptions`)
+
+### Removed
+- **Deprecated Interfaces**: Removed `CreateOptions` and `UpdateOptions` interfaces
+  - Replaced by unified `IAdtOperationOptions` interface
+  - No backward compatibility maintained (version < 1.0.0)
+
+## [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

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 ADT operations (create and update)
+ * Unified interface for both create and update operations
+ */
+export interface IAdtOperationOptions {
+    /**
+     * Activate object after creation (for create operations)
+     * @default false
+     */
+    activateOnCreate?: boolean;
+    /**
+     * Activate object after update (for update operations)
+     * @default false
+     */
+    activateOnUpdate?: boolean;
+    /**
+     * Delete object if operation fails
+     * @default false
+     */
+    deleteOnFailure?: boolean;
+    /**
+     * Source code to use for update
+     * Used in create operations for update after create, and in update operations
+     */
+    sourceCode?: string;
+    /**
+     * XML content to use for update
+     * Used for objects that use XML format (e.g., Domain, DataElement)
+     * Used in create operations for update after create, and in update operations
+     */
+    xmlContent?: string;
+    /**
+     * Timeout for operations in milliseconds
+     * @default 1000 (1 second)
+     *
+     * CRITICAL: Without timeouts, operations may fail due to system not completing commands in time.
+     * Increase timeout for complex operations or slow systems.
+     *
+     * Example: timeout: 5000 for 5 seconds
+     */
+    timeout?: number;
+}
+/**
+ * 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?: IAdtOperationOptions): 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?: IAdtOperationOptions): 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;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;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,oBAAoB,GAC7B,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,oBAAoB,GAC7B,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/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, IAdtOperationOptions } 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,oBAAoB,EAAE,MAAM,kBAAkB,CAAC"}

package/package.json

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