@mcp-abap-adt/interfaces 0.1.7 → 0.1.9

package/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.9] - 2025-12-10
+
+### Changed
+- **IAdtObject Interface - Unified Return Types**: All methods now return `Promise<TReadResult>` instead of mixed types
+  - `validate()`: Changed from `Promise<AxiosResponse>` to `Promise<TReadResult>`
+  - `check()`: Changed from `Promise<AxiosResponse>` to `Promise<TReadResult>`
+  - `activate()`: Changed from `Promise<AxiosResponse>` to `Promise<TReadResult>`
+  - `delete()`: Changed from `Promise<AxiosResponse>` to `Promise<TReadResult>`
+  - This provides consistent return types across all IAdtObject methods
+  - State types (e.g., `ClassBuilderState`) should include fields for all operation results
+
+## [0.1.8] - 2025-12-10
+
+### Added
+- **ADT Object Error Codes**: Added `AdtObjectErrorCodes` constants for error handling
+  - Constants for all IAdtObject operation errors: `OBJECT_NOT_FOUND`, `OBJECT_NOT_READY`, `VALIDATION_FAILED`, `CREATE_FAILED`, `UPDATE_FAILED`, `DELETE_FAILED`, `ACTIVATE_FAILED`, `CHECK_FAILED`, `LOCK_FAILED`, `UNLOCK_FAILED`
+  - Allows consumers to catch specific errors by error code
+  - Exported from package root: `import { AdtObjectErrorCodes } from '@mcp-abap-adt/interfaces'`
+
 ## [0.1.7] - 2025-12-10
 
 ### Added

package/dist/adt/IAdtObject.d.ts

@@ -7,7 +7,45 @@
  * 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';
+/**
+ * Error codes that can be thrown by IAdtObject methods
+ * Consumers can catch specific errors using these constants
+ *
+ * Example:
+ * ```typescript
+ * try {
+ *   await adtObject.read({ className: 'ZTEST' });
+ * } catch (error: any) {
+ *   if (error.code === AdtObjectErrorCodes.OBJECT_NOT_FOUND) {
+ *     // Handle not found
+ *   } else if (error.code === AdtObjectErrorCodes.OBJECT_NOT_READY) {
+ *     // Handle not ready
+ *   }
+ * }
+ * ```
+ */
+export declare const AdtObjectErrorCodes: {
+    /** Object not found (404) */
+    readonly OBJECT_NOT_FOUND: "ADT_OBJECT_NOT_FOUND";
+    /** Object not ready yet (400) - e.g., just created, not available for reading */
+    readonly OBJECT_NOT_READY: "ADT_OBJECT_NOT_READY";
+    /** Object validation failed */
+    readonly VALIDATION_FAILED: "ADT_VALIDATION_FAILED";
+    /** Object creation failed */
+    readonly CREATE_FAILED: "ADT_CREATE_FAILED";
+    /** Object update failed */
+    readonly UPDATE_FAILED: "ADT_UPDATE_FAILED";
+    /** Object deletion failed */
+    readonly DELETE_FAILED: "ADT_DELETE_FAILED";
+    /** Object activation failed */
+    readonly ACTIVATE_FAILED: "ADT_ACTIVATE_FAILED";
+    /** Object check failed */
+    readonly CHECK_FAILED: "ADT_CHECK_FAILED";
+    /** Lock operation failed */
+    readonly LOCK_FAILED: "ADT_LOCK_FAILED";
+    /** Unlock operation failed */
+    readonly UNLOCK_FAILED: "ADT_UNLOCK_FAILED";
+};
 /**
  * Options for ADT operations (create and update)
  * Unified interface for both create and update operations
@@ -63,9 +101,9 @@ export interface IAdtObject<TConfig, TReadResult = TConfig> {
     /**
      * Validate object configuration before creation
      * @param config - Object configuration
-     * @returns Validation response from ADT
+     * @returns State with validation result
      */
-    validate(config: Partial<TConfig>): Promise<AxiosResponse>;
+    validate(config: Partial<TConfig>): Promise<TReadResult>;
     /**
      * Create object with full operation chain:
      * validate → create → check → lock → check(inactive) → update → unlock → check → activate (optional)
@@ -100,22 +138,23 @@ export interface IAdtObject<TConfig, TReadResult = TConfig> {
      * Performs deletion check before deleting.
      *
      * @param config - Object identification
-     * @returns Delete response from ADT
+     * @returns State with delete result
      * @throws Error if deletion check fails (object is not deleted)
      */
-    delete(config: Partial<TConfig>): Promise<AxiosResponse>;
+    delete(config: Partial<TConfig>): Promise<TReadResult>;
     /**
      * Activate object
      * @param config - Object identification
-     * @returns Activation response from ADT
+     * @returns State with activation result
      */
-    activate(config: Partial<TConfig>): Promise<AxiosResponse>;
+    activate(config: Partial<TConfig>): Promise<TReadResult>;
     /**
      * Check object (syntax, consistency, etc.)
      * @param config - Object identification
      * @param status - Optional status to check ('active', 'inactive', 'deletion')
-     * @returns Check response from ADT
+     * @returns State with check result
+     * @throws Error if check finds errors (type E in XML response)
      */
-    check(config: Partial<TConfig>, status?: string): Promise<AxiosResponse>;
+    check(config: Partial<TConfig>, status?: string): Promise<TReadResult>;
 }
 //# sourceMappingURL=IAdtObject.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"IAdtObject.d.ts","sourceRoot":"","sources":["../../src/adt/IAdtObject.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB;IAC9B,6BAA6B;;IAE7B,iFAAiF;;IAEjF,+BAA+B;;IAE/B,6BAA6B;;IAE7B,2BAA2B;;IAE3B,6BAA6B;;IAE7B,+BAA+B;;IAE/B,0BAA0B;;IAE1B,4BAA4B;;IAE5B,8BAA8B;;CAEtB,CAAC;AAEX;;;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,WAAW,CAAC,CAAC;IAEzD;;;;;;;;;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,WAAW,CAAC,CAAC;IAEvD;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEzD;;;;;;OAMG;IACH,KAAK,CACH,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACxB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,WAAW,CAAC,CAAC;CACzB"}

package/dist/adt/IAdtObject.js

@@ -9,3 +9,43 @@
  * provides high-level operation chains with automatic error handling and cleanup.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdtObjectErrorCodes = void 0;
+/**
+ * Error codes that can be thrown by IAdtObject methods
+ * Consumers can catch specific errors using these constants
+ *
+ * Example:
+ * ```typescript
+ * try {
+ *   await adtObject.read({ className: 'ZTEST' });
+ * } catch (error: any) {
+ *   if (error.code === AdtObjectErrorCodes.OBJECT_NOT_FOUND) {
+ *     // Handle not found
+ *   } else if (error.code === AdtObjectErrorCodes.OBJECT_NOT_READY) {
+ *     // Handle not ready
+ *   }
+ * }
+ * ```
+ */
+exports.AdtObjectErrorCodes = {
+    /** Object not found (404) */
+    OBJECT_NOT_FOUND: 'ADT_OBJECT_NOT_FOUND',
+    /** Object not ready yet (400) - e.g., just created, not available for reading */
+    OBJECT_NOT_READY: 'ADT_OBJECT_NOT_READY',
+    /** Object validation failed */
+    VALIDATION_FAILED: 'ADT_VALIDATION_FAILED',
+    /** Object creation failed */
+    CREATE_FAILED: 'ADT_CREATE_FAILED',
+    /** Object update failed */
+    UPDATE_FAILED: 'ADT_UPDATE_FAILED',
+    /** Object deletion failed */
+    DELETE_FAILED: 'ADT_DELETE_FAILED',
+    /** Object activation failed */
+    ACTIVATE_FAILED: 'ADT_ACTIVATE_FAILED',
+    /** Object check failed */
+    CHECK_FAILED: 'ADT_CHECK_FAILED',
+    /** Lock operation failed */
+    LOCK_FAILED: 'ADT_LOCK_FAILED',
+    /** Unlock operation failed */
+    UNLOCK_FAILED: 'ADT_UNLOCK_FAILED',
+};

package/dist/index.d.ts

@@ -27,6 +27,7 @@ export type { ITokenRefreshResult } from './utils/ITokenRefreshResult';
 export type { ITimeoutConfig } from './utils/ITimeoutConfig';
 export * from './Headers';
 export type { IAdtObject, IAdtOperationOptions } from './adt/IAdtObject';
+export { AdtObjectErrorCodes } from './adt/IAdtObject';
 export type { ITransportBuilderConfig } from './adt/ITransportBuilderConfig';
 export type { IUnitTestBuilderConfig, IClassUnitTestDefinition, IClassUnitTestRunOptions } from './adt/IUnitTestBuilderConfig';
 //# 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;AAG1B,YAAY,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACzE,YAAY,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAC7E,YAAY,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,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;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,YAAY,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAC7E,YAAY,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/index.js

@@ -20,8 +20,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthMethodPriority = void 0;
+exports.AdtObjectErrorCodes = exports.AuthMethodPriority = void 0;
 var IValidatedAuthConfig_1 = require("./validation/IValidatedAuthConfig");
 Object.defineProperty(exports, "AuthMethodPriority", { enumerable: true, get: function () { return IValidatedAuthConfig_1.AuthMethodPriority; } });
 // Headers domain
 __exportStar(require("./Headers"), exports);
+var IAdtObject_1 = require("./adt/IAdtObject");
+Object.defineProperty(exports, "AdtObjectErrorCodes", { enumerable: true, get: function () { return IAdtObject_1.AdtObjectErrorCodes; } });

package/package.json

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