catalyst-relay 0.4.3 → 0.4.4

package/dist/index.d.mts

@@ -64,6 +64,15 @@ interface SsoAuthConfig {
  * Union of all auth configurations
  */
 type AuthConfig = BasicAuthConfig | SamlAuthConfig | SsoAuthConfig;
+/**
+ * Auto-refresh configuration for session keepalive
+ */
+interface AutoRefreshConfig {
+    /** Enable automatic session refresh (default: true) */
+    enabled: boolean;
+    /** Refresh interval in milliseconds (default: 7200000 = 2 hours) */
+    intervalMs?: number;
+}
 /**
  * Client configuration for connecting to SAP ADT
  */
@@ -78,6 +87,8 @@ interface ClientConfig {
     timeout?: number;
     /** Skip SSL verification (dev only) */
     insecure?: boolean;
+    /** Auto-refresh configuration for session keepalive (default: enabled with 2-hour interval) */
+    autoRefresh?: AutoRefreshConfig;
 }
 
 /**
@@ -187,6 +198,27 @@ interface Session {
     expiresAt: number;
 }
 
+/**
+ * Session Refresh via Reentrance Ticket
+ *
+ * Fetches a reentrance ticket from SAP ADT to keep the session alive.
+ * Eclipse ADT uses this mechanism to maintain sessions across extended periods.
+ *
+ * Endpoint: GET /sap/bc/adt/security/reentranceticket
+ * - Returns a base64-encoded SSO ticket
+ * - Refreshes server-side session cookies (MYSAPSSO2)
+ */
+
+/**
+ * Result of a session refresh operation
+ */
+interface RefreshResult {
+    /** Base64-encoded reentrance ticket */
+    ticket: string;
+    /** Updated session expiration timestamp (ms since epoch) */
+    expiresAt: number;
+}
+
 interface ObjectConfig {
     /** ADT endpoint path (e.g., 'ddic/ddl/sources') */
     endpoint: string;
@@ -273,16 +305,11 @@ interface FolderNode {
     displayName: string;
     numContents: number;
 }
-interface ApiState {
-    useInCloudDevelopment: boolean;
-    useInCloudDvlpmntActive: boolean;
-    useInKeyUserApps: boolean;
-}
 interface ObjectNode {
     name: string;
     objectType: string;
     extension: string;
-    apiState?: ApiState;
+    description?: string;
 }
 
 /**
@@ -487,6 +514,7 @@ interface ADTClient {
     readonly session: Session | null;
     login(): AsyncResult<Session>;
     logout(): AsyncResult<void>;
+    refreshSession(): AsyncResult<RefreshResult>;
     read(objects: ObjectRef[]): AsyncResult<ObjectWithContent[]>;
     create(object: ObjectContent, packageName: string, transport?: string): AsyncResult<void>;
     update(object: ObjectContent, transport?: string): AsyncResult<void>;
@@ -509,4 +537,4 @@ interface ADTClient {
 }
 declare function createClient(config: ClientConfig): Result<ADTClient, Error>;
 
-export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type ApiState, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, type BetweenFilter, type ClientConfig, type ColumnInfo, type DataFrame, type DataPreviewQuery, type Dependency, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type FolderNode, type ListFilter, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectNode, type ObjectRef, type ObjectWithContent, type Package, type PackageNode, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchResult, type Session, type Sorting, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeQuery, type TreeResponse, type UpsertResult, buildSQLQuery, createClient, err, ok };
+export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, type BetweenFilter, type ClientConfig, type ColumnInfo, type DataFrame, type DataPreviewQuery, type Dependency, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type FolderNode, type ListFilter, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectNode, type ObjectRef, type ObjectWithContent, type Package, type PackageNode, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchResult, type Session, type Sorting, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeQuery, type TreeResponse, type UpsertResult, buildSQLQuery, createClient, err, ok };

package/dist/index.d.ts

@@ -64,6 +64,15 @@ interface SsoAuthConfig {
  * Union of all auth configurations
  */
 type AuthConfig = BasicAuthConfig | SamlAuthConfig | SsoAuthConfig;
+/**
+ * Auto-refresh configuration for session keepalive
+ */
+interface AutoRefreshConfig {
+    /** Enable automatic session refresh (default: true) */
+    enabled: boolean;
+    /** Refresh interval in milliseconds (default: 7200000 = 2 hours) */
+    intervalMs?: number;
+}
 /**
  * Client configuration for connecting to SAP ADT
  */
@@ -78,6 +87,8 @@ interface ClientConfig {
     timeout?: number;
     /** Skip SSL verification (dev only) */
     insecure?: boolean;
+    /** Auto-refresh configuration for session keepalive (default: enabled with 2-hour interval) */
+    autoRefresh?: AutoRefreshConfig;
 }
 
 /**
@@ -187,6 +198,27 @@ interface Session {
     expiresAt: number;
 }
 
+/**
+ * Session Refresh via Reentrance Ticket
+ *
+ * Fetches a reentrance ticket from SAP ADT to keep the session alive.
+ * Eclipse ADT uses this mechanism to maintain sessions across extended periods.
+ *
+ * Endpoint: GET /sap/bc/adt/security/reentranceticket
+ * - Returns a base64-encoded SSO ticket
+ * - Refreshes server-side session cookies (MYSAPSSO2)
+ */
+
+/**
+ * Result of a session refresh operation
+ */
+interface RefreshResult {
+    /** Base64-encoded reentrance ticket */
+    ticket: string;
+    /** Updated session expiration timestamp (ms since epoch) */
+    expiresAt: number;
+}
+
 interface ObjectConfig {
     /** ADT endpoint path (e.g., 'ddic/ddl/sources') */
     endpoint: string;
@@ -273,16 +305,11 @@ interface FolderNode {
     displayName: string;
     numContents: number;
 }
-interface ApiState {
-    useInCloudDevelopment: boolean;
-    useInCloudDvlpmntActive: boolean;
-    useInKeyUserApps: boolean;
-}
 interface ObjectNode {
     name: string;
     objectType: string;
     extension: string;
-    apiState?: ApiState;
+    description?: string;
 }
 
 /**
@@ -487,6 +514,7 @@ interface ADTClient {
     readonly session: Session | null;
     login(): AsyncResult<Session>;
     logout(): AsyncResult<void>;
+    refreshSession(): AsyncResult<RefreshResult>;
     read(objects: ObjectRef[]): AsyncResult<ObjectWithContent[]>;
     create(object: ObjectContent, packageName: string, transport?: string): AsyncResult<void>;
     update(object: ObjectContent, transport?: string): AsyncResult<void>;
@@ -509,4 +537,4 @@ interface ADTClient {
 }
 declare function createClient(config: ClientConfig): Result<ADTClient, Error>;
 
-export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type ApiState, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, type BetweenFilter, type ClientConfig, type ColumnInfo, type DataFrame, type DataPreviewQuery, type Dependency, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type FolderNode, type ListFilter, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectNode, type ObjectRef, type ObjectWithContent, type Package, type PackageNode, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchResult, type Session, type Sorting, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeQuery, type TreeResponse, type UpsertResult, buildSQLQuery, createClient, err, ok };
+export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, type BetweenFilter, type ClientConfig, type ColumnInfo, type DataFrame, type DataPreviewQuery, type Dependency, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type FolderNode, type ListFilter, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectNode, type ObjectRef, type ObjectWithContent, type Package, type PackageNode, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchResult, type Session, type Sorting, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeQuery, type TreeResponse, type UpsertResult, buildSQLQuery, createClient, err, ok };

package/dist/index.js

@@ -237,7 +237,11 @@ var clientConfigSchema = import_zod.z.object({
     })
   ]),
   timeout: import_zod.z.number().positive().optional(),
-  insecure: import_zod.z.boolean().optional()
+  insecure: import_zod.z.boolean().optional(),
+  autoRefresh: import_zod.z.object({
+    enabled: import_zod.z.boolean(),
+    intervalMs: import_zod.z.number().positive().optional()
+  }).optional()
 });
 
 // src/core/session/types.ts
@@ -351,6 +355,33 @@ async function sessionReset(state, request3) {
   return ok(void 0);
 }
 
+// src/core/session/refresh.ts
+var REENTRANCE_TICKET_PATH = "/sap/bc/adt/security/reentranceticket";
+async function refreshSession(state, request3) {
+  if (!state.session) {
+    return err(new Error("Not logged in"));
+  }
+  debug("Fetching reentrance ticket to refresh session...");
+  const [response, reqErr] = await request3({
+    method: "GET",
+    path: REENTRANCE_TICKET_PATH,
+    headers: { "Accept": "text/plain" }
+  });
+  if (reqErr) {
+    return err(new Error(`Session refresh failed: ${reqErr.message}`));
+  }
+  if (!response.ok) {
+    const text = await response.text();
+    return err(new Error(`Session refresh failed (${response.status}): ${text}`));
+  }
+  const ticket = await response.text();
+  debug(`Received reentrance ticket: ${ticket.substring(0, 20)}...`);
+  const timeout = getSessionTimeout(state.config.auth.type);
+  state.session.expiresAt = Date.now() + timeout;
+  debug(`Session refreshed, new expiration: ${new Date(state.session.expiresAt).toISOString()}`);
+  return ok({ ticket, expiresAt: state.session.expiresAt });
+}
+
 // src/core/adt/types.ts
 var OBJECT_CONFIG_MAP = {
   "asddls": {
@@ -745,14 +776,6 @@ async function getPackages(client, filter = "*") {
   return ok(packages);
 }
 
-// src/core/adt/discovery/tree/types.ts
-var API_FOLDERS = [
-  "NOT_RELEASED",
-  "USE_IN_CLOUD_DEVELOPMENT",
-  "USE_IN_CLOUD_DVLPMNT_ACTIVE",
-  "USE_IN_KEY_USER_APPS"
-];
-
 // src/core/adt/discovery/tree/parsers.ts
 function buildQueryFromPath(packageName, path) {
   const query = {
@@ -795,13 +818,14 @@ function constructTreeBody(query, searchPattern) {
   const specifiedXml = Object.entries(specified).map(([facet, name]) => `  <vfs:preselection facet="${facet.toLowerCase()}">
     <vfs:value>${name}</vfs:value>
   </vfs:preselection>`).join("\n");
-  const facetsXml = facets.map((facet) => `    <vfs:facet>${facet.toLowerCase()}</vfs:facet>`).join("\n");
+  const atObjectLevel = query.PACKAGE && query.GROUP && query.TYPE;
+  const facetorderXml = atObjectLevel || facets.length === 0 ? "  <vfs:facetorder/>" : `  <vfs:facetorder>
+${facets.map((f) => `    <vfs:facet>${f.toLowerCase()}</vfs:facet>`).join("\n")}
+  </vfs:facetorder>`;
   return `<?xml version="1.0" encoding="UTF-8"?>
 <vfs:virtualFoldersRequest xmlns:vfs="http://www.sap.com/adt/ris/virtualFolders" objectSearchPattern="${searchPattern}">
 ${specifiedXml}
-  <vfs:facetorder>
-${facetsXml}
-  </vfs:facetorder>
+${facetorderXml}
 </vfs:virtualFoldersRequest>`;
 }
 function parseTreeXml(xml) {
@@ -842,11 +866,14 @@ function parseTreeXml(xml) {
     if (!name || !type) continue;
     const config = getConfigByType(type);
     if (!config) continue;
-    objects.push({
+    const text = obj.getAttribute("text");
+    const parsedObj = {
       name,
       objectType: config.label,
       extension: config.extension
-    });
+    };
+    if (text) parsedObj.description = text;
+    objects.push(parsedObj);
   }
   return ok({ folders, objects });
 }
@@ -870,11 +897,15 @@ function transformToTreeResponse(parsed, queryPackage) {
       });
     }
   }
-  const objects = parsed.objects.map((obj) => ({
-    name: obj.name,
-    objectType: obj.objectType,
-    extension: obj.extension
-  }));
+  const objects = parsed.objects.map((obj) => {
+    const node = {
+      name: obj.name,
+      objectType: obj.objectType,
+      extension: obj.extension
+    };
+    if (obj.description) node.description = obj.description;
+    return node;
+  });
   return { packages, folders, objects };
 }
 
@@ -938,58 +969,6 @@ async function fetchVirtualFolders(client, query) {
   const text = await response.text();
   return parseTreeXml(text);
 }
-async function fetchObjectsWithApiState(client, packageName, pathSegments, apiFolders) {
-  const group = pathSegments[0];
-  const type = pathSegments[1];
-  if (!group || !type) return ok([]);
-  const apiQueries = apiFolders.map((apiFolder) => ({
-    apiFolder,
-    query: {
-      PACKAGE: { name: `..${packageName}`, hasChildrenOfSameFacet: false },
-      GROUP: { name: group, hasChildrenOfSameFacet: false },
-      TYPE: { name: type, hasChildrenOfSameFacet: false },
-      API: { name: apiFolder, hasChildrenOfSameFacet: false }
-    }
-  }));
-  const results = await Promise.all(
-    apiQueries.map(async ({ apiFolder, query }) => {
-      const [parsed, parseErr] = await fetchVirtualFolders(client, query);
-      if (parseErr) return { apiFolder, objects: [], error: parseErr };
-      return { apiFolder, objects: parsed.objects, error: null };
-    })
-  );
-  const errors = results.filter((r) => r.error !== null);
-  if (errors.length === results.length) {
-    return err(errors[0].error);
-  }
-  const objectMap = /* @__PURE__ */ new Map();
-  for (const { apiFolder, objects } of results) {
-    for (const obj of objects) {
-      let node = objectMap.get(obj.name);
-      if (!node) {
-        node = {
-          name: obj.name,
-          objectType: obj.objectType,
-          extension: obj.extension,
-          apiState: {
-            useInCloudDevelopment: false,
-            useInCloudDvlpmntActive: false,
-            useInKeyUserApps: false
-          }
-        };
-        objectMap.set(obj.name, node);
-      }
-      if (apiFolder === "USE_IN_CLOUD_DEVELOPMENT") {
-        node.apiState.useInCloudDevelopment = true;
-      } else if (apiFolder === "USE_IN_CLOUD_DVLPMNT_ACTIVE") {
-        node.apiState.useInCloudDvlpmntActive = true;
-      } else if (apiFolder === "USE_IN_KEY_USER_APPS") {
-        node.apiState.useInKeyUserApps = true;
-      }
-    }
-  }
-  return ok(Array.from(objectMap.values()));
-}
 
 // src/core/adt/discovery/tree/index.ts
 async function getTree(client, query = {}) {
@@ -1019,22 +998,6 @@ async function getTree(client, query = {}) {
   const internalQuery = buildQueryFromPath(query.package, query.path);
   const [parsed, parseErr] = await fetchVirtualFolders(client, internalQuery);
   if (parseErr) return err(parseErr);
-  const pathSegments = query.path?.split("/").filter((s) => s.length > 0) ?? [];
-  const hasApiFolders = parsed.folders.length > 0 && parsed.folders.every((f) => f.facet === "API");
-  if (pathSegments.length >= 2 && hasApiFolders) {
-    const [objects, objErr] = await fetchObjectsWithApiState(
-      client,
-      query.package,
-      pathSegments,
-      API_FOLDERS
-    );
-    if (objErr) return err(objErr);
-    return ok({
-      packages,
-      folders: [],
-      objects
-    });
-  }
   const result = transformToTreeResponse(parsed, query.package);
   result.packages = packages;
   return ok(result);
@@ -2321,6 +2284,7 @@ async function httpsRequest2(url, options) {
     req.end();
   });
 }
+var DEFAULT_REFRESH_INTERVAL = 30 * 60 * 1e3;
 function buildParams(baseParams, clientNum) {
   const params = new URLSearchParams();
   if (baseParams) {
@@ -2345,6 +2309,8 @@ var ADTClientImpl = class {
   requestor;
   // Store SSO certificates for mTLS authentication
   ssoCerts;
+  // Auto-refresh timer handle
+  refreshTimer = null;
   constructor(config) {
     const authOptions = {
       config: config.auth,
@@ -2382,6 +2348,22 @@ var ADTClientImpl = class {
     if (this.state.cookies.size === 0) return null;
     return Array.from(this.state.cookies.entries()).map(([name, value]) => `${name}=${value}`).join("; ");
   }
+  startAutoRefresh(intervalMs) {
+    this.stopAutoRefresh();
+    this.refreshTimer = setInterval(async () => {
+      if (!this.state.session) return;
+      const [, refreshErr] = await this.refreshSession();
+      if (refreshErr) {
+        debug(`Auto-refresh failed: ${refreshErr.message}`);
+      }
+    }, intervalMs);
+  }
+  stopAutoRefresh() {
+    if (this.refreshTimer) {
+      clearInterval(this.refreshTimer);
+      this.refreshTimer = null;
+    }
+  }
   // Core HTTP request function with CSRF token injection and automatic retry on 403 errors
   async request(options) {
     const { method, path, params, headers: customHeaders, body } = options;
@@ -2473,9 +2455,9 @@ var ADTClientImpl = class {
   async login() {
     const { authStrategy } = this.state;
     if (authStrategy.performLogin) {
-      const [, loginErr] = await authStrategy.performLogin(fetch);
-      if (loginErr) {
-        return err(loginErr);
+      const [, loginErr2] = await authStrategy.performLogin(fetch);
+      if (loginErr2) {
+        return err(loginErr2);
       }
     }
     if (authStrategy.type === "saml" && authStrategy.getCookies) {
@@ -2495,11 +2477,28 @@ var ADTClientImpl = class {
         debug("Stored mTLS certificates for SSO authentication");
       }
     }
-    return login(this.state, this.request.bind(this));
+    const [session, loginErr] = await login(this.state, this.request.bind(this));
+    if (loginErr) {
+      return err(loginErr);
+    }
+    const autoRefresh = this.state.config.autoRefresh ?? { enabled: true };
+    if (autoRefresh.enabled) {
+      const interval = autoRefresh.intervalMs ?? DEFAULT_REFRESH_INTERVAL;
+      this.startAutoRefresh(interval);
+      debug(`Auto-refresh started with ${interval}ms interval`);
+    }
+    return ok(session);
   }
   async logout() {
+    this.stopAutoRefresh();
     return logout(this.state, this.request.bind(this));
   }
+  async refreshSession() {
+    if (!this.state.session) {
+      return err(new Error("Not logged in"));
+    }
+    return refreshSession(this.state, this.request.bind(this));
+  }
   // --- CRAUD Operations ---
   async read(objects) {
     if (!this.state.session) return err(new Error("Not logged in"));