@mcp-abap-adt/interfaces 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.2] - 2025-12-19
+
+### Added
+- **Token Provider Error Codes**: Added standardized error codes for token provider operations
+  - `TOKEN_PROVIDER_ERROR_CODES` - Object containing error codes for token provider failures:
+    - `VALIDATION_ERROR` - Authentication configuration validation failed
+    - `REFRESH_ERROR` - Token refresh operation failed
+    - `SESSION_DATA_ERROR` - Session data is invalid or incomplete
+    - `SERVICE_KEY_ERROR` - Service key data is invalid or incomplete
+    - `BROWSER_AUTH_ERROR` - Browser authentication failed or was cancelled
+  - `TokenProviderErrorCode` - Type for token provider error codes
+  - These constants enable consistent error handling across token providers and auth-broker
+  - Error codes help distinguish between different types of authentication failures
+  - Exported from `@mcp-abap-adt/interfaces` package in token domain
+
+## [0.2.1] - 2025-12-19
+
+### Added
+- **Token Refresh Methods in ITokenProvider**: Added two new methods to `ITokenProvider` interface for explicit refresh scenarios
+  - `refreshTokenFromSession(authConfig, options?)` - Refresh token using refresh token from session
+    - Uses refresh token from `authConfig.refreshToken` to get new access token
+    - Typically uses refresh_token grant type or browser-based re-authentication
+    - Returns new authorization token and optional new refresh token
+  - `refreshTokenFromServiceKey(authConfig, options?)` - Refresh token using UAA credentials from service key
+    - Uses UAA credentials (uaaUrl, uaaClientId, uaaClientSecret) without refresh token
+    - Typically uses browser-based authorization flow to ensure proper role assignment
+    - Returns new authorization token and optional refresh token
+  - These methods provide explicit control over token refresh strategy in AuthBroker
+  - Allows separation of refresh-by-session vs refresh-by-service-key logic in token providers
+
 ## [0.2.0] - 2025-12-19
 
 ### Added

package/dist/index.d.ts

@@ -11,6 +11,8 @@ export type { AuthType } from './auth/AuthType';
 export type { ITokenProvider } from './token/ITokenProvider';
 export type { ITokenProviderResult } from './token/ITokenProviderResult';
 export type { ITokenProviderOptions } from './token/ITokenProviderOptions';
+export { TOKEN_PROVIDER_ERROR_CODES } from './token/TokenProviderErrorCodes';
+export type { TokenProviderErrorCode } from './token/TokenProviderErrorCodes';
 export type { ISessionStore } from './session/ISessionStore';
 export type { IServiceKeyStore } from './serviceKey/IServiceKeyStore';
 export type { IAbapConnection } from './connection/IAbapConnection';

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;AAC5E,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjF,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAGnE,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;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG9C,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,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,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;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,YAAY,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAG9E,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;AAC5E,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjF,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAGnE,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;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG9C,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,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/index.js

@@ -20,7 +20,9 @@ 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.AdtObjectErrorCodes = exports.AuthMethodPriority = exports.LogLevel = exports.isNetworkError = exports.NETWORK_ERROR_CODES = void 0;
+exports.AdtObjectErrorCodes = exports.AuthMethodPriority = exports.LogLevel = exports.isNetworkError = exports.NETWORK_ERROR_CODES = exports.TOKEN_PROVIDER_ERROR_CODES = void 0;
+var TokenProviderErrorCodes_1 = require("./token/TokenProviderErrorCodes");
+Object.defineProperty(exports, "TOKEN_PROVIDER_ERROR_CODES", { enumerable: true, get: function () { return TokenProviderErrorCodes_1.TOKEN_PROVIDER_ERROR_CODES; } });
 var NetworkErrors_1 = require("./connection/NetworkErrors");
 Object.defineProperty(exports, "NETWORK_ERROR_CODES", { enumerable: true, get: function () { return NetworkErrors_1.NETWORK_ERROR_CODES; } });
 Object.defineProperty(exports, "isNetworkError", { enumerable: true, get: function () { return NetworkErrors_1.isNetworkError; } });

package/dist/token/ITokenProvider.d.ts

@@ -22,6 +22,24 @@ export interface ITokenProvider {
      * @returns Promise that resolves to connection configuration with authorization token and optional refresh token
      */
     getConnectionConfig(authConfig: IAuthorizationConfig, options?: ITokenProviderOptions): Promise<ITokenProviderResult>;
+    /**
+     * Refresh token using refresh token from session (authorization config with refreshToken)
+     * This method uses the refresh token from the session to get a new access token.
+     * Typically uses refresh_token grant type or browser-based re-authentication.
+     * @param authConfig Authorization configuration including refreshToken from session
+     * @param options Optional provider-specific options (e.g., browser type for BTP)
+     * @returns Promise that resolves to connection configuration with new authorization token and optional new refresh token
+     */
+    refreshTokenFromSession(authConfig: IAuthorizationConfig, options?: ITokenProviderOptions): Promise<ITokenProviderResult>;
+    /**
+     * Refresh token using UAA credentials from service key (authorization config without refreshToken)
+     * This method uses UAA credentials (uaaUrl, uaaClientId, uaaClientSecret) to get a new token.
+     * Typically uses browser-based authorization flow to ensure proper role assignment.
+     * @param authConfig Authorization configuration with UAA credentials from service key (no refreshToken)
+     * @param options Optional provider-specific options (e.g., browser type for BTP)
+     * @returns Promise that resolves to connection configuration with new authorization token and optional refresh token
+     */
+    refreshTokenFromServiceKey(authConfig: IAuthorizationConfig, options?: ITokenProviderOptions): Promise<ITokenProviderResult>;
     /**
      * Validate JWT token by testing connection to service
      * @param token JWT token to validate

package/dist/token/ITokenProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ITokenProvider.d.ts","sourceRoot":"","sources":["../../src/token/ITokenProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,mBAAmB,CACjB,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,aAAa,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtE"}
+{"version":3,"file":"ITokenProvider.d.ts","sourceRoot":"","sources":["../../src/token/ITokenProvider.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,mBAAmB,CACjB,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,uBAAuB,CACrB,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,0BAA0B,CACxB,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,aAAa,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtE"}

package/dist/token/TokenProviderErrorCodes.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Token Provider Error Codes
+ *
+ * Constants for error codes that token providers can throw.
+ * Used to enable better error handling and categorization.
+ */
+/**
+ * Error codes for token provider operations
+ */
+export declare const TOKEN_PROVIDER_ERROR_CODES: {
+    /** Authentication configuration validation failed */
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+    /** Token refresh operation failed */
+    readonly REFRESH_ERROR: "REFRESH_ERROR";
+    /** Session data is invalid or incomplete */
+    readonly SESSION_DATA_ERROR: "SESSION_DATA_ERROR";
+    /** Service key data is invalid or incomplete */
+    readonly SERVICE_KEY_ERROR: "SERVICE_KEY_ERROR";
+    /** Browser authentication failed or was cancelled */
+    readonly BROWSER_AUTH_ERROR: "BROWSER_AUTH_ERROR";
+};
+/**
+ * Type for token provider error codes
+ */
+export type TokenProviderErrorCode = typeof TOKEN_PROVIDER_ERROR_CODES[keyof typeof TOKEN_PROVIDER_ERROR_CODES];
+//# sourceMappingURL=TokenProviderErrorCodes.d.ts.map

package/dist/token/TokenProviderErrorCodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenProviderErrorCodes.d.ts","sourceRoot":"","sources":["../../src/token/TokenProviderErrorCodes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,eAAO,MAAM,0BAA0B;IACrC,qDAAqD;;IAErD,qCAAqC;;IAErC,4CAA4C;;IAE5C,gDAAgD;;IAEhD,qDAAqD;;CAE7C,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,0BAA0B,CAAC,MAAM,OAAO,0BAA0B,CAAC,CAAC"}

package/dist/token/TokenProviderErrorCodes.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Token Provider Error Codes
+ *
+ * Constants for error codes that token providers can throw.
+ * Used to enable better error handling and categorization.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TOKEN_PROVIDER_ERROR_CODES = void 0;
+/**
+ * Error codes for token provider operations
+ */
+exports.TOKEN_PROVIDER_ERROR_CODES = {
+    /** Authentication configuration validation failed */
+    VALIDATION_ERROR: 'VALIDATION_ERROR',
+    /** Token refresh operation failed */
+    REFRESH_ERROR: 'REFRESH_ERROR',
+    /** Session data is invalid or incomplete */
+    SESSION_DATA_ERROR: 'SESSION_DATA_ERROR',
+    /** Service key data is invalid or incomplete */
+    SERVICE_KEY_ERROR: 'SERVICE_KEY_ERROR',
+    /** Browser authentication failed or was cancelled */
+    BROWSER_AUTH_ERROR: 'BROWSER_AUTH_ERROR',
+};

package/package.json

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