catalyst-relay 0.5.2 → 0.5.3

package/dist/index.d.mts

@@ -182,7 +182,7 @@ type ApiResponse<T> = SuccessResponse<T> | ErrorResponse;
 /**
  * Machine-readable error codes
  */
-type ErrorCode = 'AUTH_FAILED' | 'SESSION_EXPIRED' | 'SESSION_NOT_FOUND' | 'CSRF_INVALID' | 'OBJECT_LOCKED' | 'OBJECT_NOT_FOUND' | 'TRANSPORT_REQUIRED' | 'ACTIVATION_FAILED' | 'VALIDATION_ERROR' | 'NETWORK_ERROR' | 'UNKNOWN_ERROR';
+type ErrorCode = 'AUTH_FAILED' | 'SESSION_EXPIRED' | 'SESSION_NOT_FOUND' | 'CSRF_INVALID' | 'OBJECT_LOCKED' | 'OBJECT_NOT_FOUND' | 'TRANSPORT_REQUIRED' | 'ACTIVATION_FAILED' | 'CHECK_FAILED' | 'VALIDATION_ERROR' | 'NETWORK_ERROR' | 'UNKNOWN_ERROR';
 
 /**
  * Session management type definitions
@@ -308,6 +308,13 @@ interface ActivationMessage {
     column?: number;
 }
 
+interface CheckResult {
+    name: string;
+    extension: string;
+    status: 'success' | 'warning' | 'error';
+    messages: ActivationMessage[];
+}
+
 /**
  * Tree types — Public and internal type definitions
  */
@@ -341,6 +348,21 @@ interface Package {
     name: string;
     description?: string;
 }
+/**
+ * Get list of available packages
+ *
+ * Uses the ADT search API with DEVC/K object type to search for packages,
+ * then enriches results with descriptions from the virtualfolders API.
+ *
+ * @param client - ADT client
+ * @param filter - Package name filter pattern (default: '*' for all packages)
+ *                 Examples: 'Z*' for custom packages, '$TMP' for local, 'ZSNAP*' for specific prefix
+ * @returns Array of packages or error
+ */
+interface GetPackagesOptions {
+    filter?: string;
+    includeDescriptions?: boolean;
+}
 
 /**
  * Transports — List transport requests for a package
@@ -543,8 +565,9 @@ interface ADTClient {
     update(object: ObjectContent, transport?: string): AsyncResult<void>;
     upsert(objects: ObjectContent[], packageName: string, transport?: string): AsyncResult<UpsertResult[]>;
     activate(objects: ObjectRef[]): AsyncResult<ActivationResult[]>;
+    checkSyntax(objects: ObjectRef[]): AsyncResult<CheckResult[]>;
     delete(objects: ObjectRef[], transport?: string): AsyncResult<void>;
-    getPackages(filter?: string): AsyncResult<Package[]>;
+    getPackages(options?: GetPackagesOptions): AsyncResult<Package[]>;
     getTree(query: TreeQuery): AsyncResult<TreeResponse>;
     getPackageStats(packageName: string): AsyncResult<PackageNode>;
     getPackageStats(packageNames: string[]): AsyncResult<PackageNode[]>;

package/dist/index.d.ts

@@ -182,7 +182,7 @@ type ApiResponse<T> = SuccessResponse<T> | ErrorResponse;
 /**
  * Machine-readable error codes
  */
-type ErrorCode = 'AUTH_FAILED' | 'SESSION_EXPIRED' | 'SESSION_NOT_FOUND' | 'CSRF_INVALID' | 'OBJECT_LOCKED' | 'OBJECT_NOT_FOUND' | 'TRANSPORT_REQUIRED' | 'ACTIVATION_FAILED' | 'VALIDATION_ERROR' | 'NETWORK_ERROR' | 'UNKNOWN_ERROR';
+type ErrorCode = 'AUTH_FAILED' | 'SESSION_EXPIRED' | 'SESSION_NOT_FOUND' | 'CSRF_INVALID' | 'OBJECT_LOCKED' | 'OBJECT_NOT_FOUND' | 'TRANSPORT_REQUIRED' | 'ACTIVATION_FAILED' | 'CHECK_FAILED' | 'VALIDATION_ERROR' | 'NETWORK_ERROR' | 'UNKNOWN_ERROR';
 
 /**
  * Session management type definitions
@@ -308,6 +308,13 @@ interface ActivationMessage {
     column?: number;
 }
 
+interface CheckResult {
+    name: string;
+    extension: string;
+    status: 'success' | 'warning' | 'error';
+    messages: ActivationMessage[];
+}
+
 /**
  * Tree types — Public and internal type definitions
  */
@@ -341,6 +348,21 @@ interface Package {
     name: string;
     description?: string;
 }
+/**
+ * Get list of available packages
+ *
+ * Uses the ADT search API with DEVC/K object type to search for packages,
+ * then enriches results with descriptions from the virtualfolders API.
+ *
+ * @param client - ADT client
+ * @param filter - Package name filter pattern (default: '*' for all packages)
+ *                 Examples: 'Z*' for custom packages, '$TMP' for local, 'ZSNAP*' for specific prefix
+ * @returns Array of packages or error
+ */
+interface GetPackagesOptions {
+    filter?: string;
+    includeDescriptions?: boolean;
+}
 
 /**
  * Transports — List transport requests for a package
@@ -543,8 +565,9 @@ interface ADTClient {
     update(object: ObjectContent, transport?: string): AsyncResult<void>;
     upsert(objects: ObjectContent[], packageName: string, transport?: string): AsyncResult<UpsertResult[]>;
     activate(objects: ObjectRef[]): AsyncResult<ActivationResult[]>;
+    checkSyntax(objects: ObjectRef[]): AsyncResult<CheckResult[]>;
     delete(objects: ObjectRef[], transport?: string): AsyncResult<void>;
-    getPackages(filter?: string): AsyncResult<Package[]>;
+    getPackages(options?: GetPackagesOptions): AsyncResult<Package[]>;
     getTree(query: TreeQuery): AsyncResult<TreeResponse>;
     getPackageStats(packageName: string): AsyncResult<PackageNode>;
     getPackageStats(packageNames: string[]): AsyncResult<PackageNode[]>;

package/dist/index.js

@@ -1535,8 +1535,201 @@ function extractActivationErrors(objects, xml, _extension) {
   return ok(results);
 }
 
+// src/core/adt/craud/syntaxCheck.ts
+async function checkSyntax(client, objects) {
+  if (objects.length === 0) {
+    return ok([]);
+  }
+  const extension = objects[0].extension;
+  const config = getConfigByExtension(extension);
+  if (!config) return err(new Error(`Unsupported extension: ${extension}`));
+  for (const obj of objects) {
+    if (obj.extension !== extension) {
+      return err(new Error("All objects must have the same extension for batch syntax check"));
+    }
+  }
+  const sources = /* @__PURE__ */ new Map();
+  for (const obj of objects) {
+    const [result, readErr] = await readObject(client, obj);
+    if (readErr) return err(new Error(`Failed to read ${obj.name}: ${readErr.message}`));
+    sources.set(obj.name.toLowerCase(), result.content);
+  }
+  const objectRefs = objects.map((obj) => {
+    const uri = `/sap/bc/adt/${config.endpoint}/${obj.name.toLowerCase()}`;
+    const sourceUri = `${uri}/source/main`;
+    const content = sources.get(obj.name.toLowerCase()) ?? "";
+    const encoded = Buffer.from(content).toString("base64");
+    return `<chkrun:checkObject adtcore:uri="${uri}" chkrun:version="active">
+        <chkrun:artifacts>
+            <chkrun:artifact chkrun:contentType="text/plain; charset=utf-8" chkrun:uri="${sourceUri}">
+                <chkrun:content>${encoded}</chkrun:content>
+            </chkrun:artifact>
+        </chkrun:artifacts>
+    </chkrun:checkObject>`;
+  }).join("\n    ");
+  const body = `<?xml version="1.0" encoding="UTF-8"?>
+<chkrun:checkObjectList xmlns:chkrun="http://www.sap.com/adt/checkrun"
+                        xmlns:adtcore="http://www.sap.com/adt/core">
+    ${objectRefs}
+</chkrun:checkObjectList>`;
+  const [response, requestErr] = await client.request({
+    method: "POST",
+    path: "/sap/bc/adt/checkruns",
+    params: {
+      "reporters": "abapCheckRun"
+    },
+    headers: {
+      "Content-Type": "application/vnd.sap.adt.checkobjects+xml",
+      "Accept": "application/vnd.sap.adt.checkmessages+xml"
+    },
+    body
+  });
+  if (requestErr) {
+    return err(requestErr);
+  }
+  const text = await response.text();
+  debug(`Syntax check response status: ${response.status}`);
+  debug(`Syntax check response: ${text.substring(0, 500)}`);
+  if (!response.ok) {
+    const errorMsg = extractError(text);
+    return err(new Error(`Syntax check failed: ${errorMsg}`));
+  }
+  const [results, parseErr] = extractCheckMessages(objects, text);
+  if (parseErr) {
+    return err(parseErr);
+  }
+  return ok(results);
+}
+function extractCheckMessages(objects, xml) {
+  const [doc, parseErr] = safeParseXml(xml);
+  if (parseErr) {
+    return err(parseErr);
+  }
+  const messageMap = /* @__PURE__ */ new Map();
+  objects.forEach((obj) => messageMap.set(obj.name.toLowerCase(), []));
+  let msgElements = doc.getElementsByTagName("chkrun:checkMessage");
+  if (msgElements.length === 0) {
+    msgElements = doc.getElementsByTagName("checkMessage");
+  }
+  const startRegex = /#start=(\d+),(\d+)/;
+  for (let i = 0; i < msgElements.length; i++) {
+    const msg = msgElements[i];
+    if (!msg) continue;
+    const type = msg.getAttribute("chkrun:type") ?? msg.getAttribute("type");
+    if (!type) continue;
+    const uri = msg.getAttribute("chkrun:uri") ?? msg.getAttribute("uri") ?? "";
+    let line;
+    let column;
+    const match = startRegex.exec(uri);
+    if (match && match[1] && match[2]) {
+      line = parseInt(match[1], 10);
+      column = parseInt(match[2], 10);
+    }
+    const matchingObj = objects.find(
+      (obj) => uri.toLowerCase().includes(obj.name.toLowerCase())
+    );
+    if (!matchingObj) continue;
+    const text = msg.getAttribute("chkrun:shortText") ?? msg.getAttribute("shortText");
+    if (!text) continue;
+    const message = {
+      severity: type === "E" ? "error" : type === "W" ? "warning" : "info",
+      text,
+      ...line !== void 0 && { line },
+      ...column !== void 0 && { column }
+    };
+    const messages = messageMap.get(matchingObj.name.toLowerCase()) || [];
+    messages.push(message);
+    messageMap.set(matchingObj.name.toLowerCase(), messages);
+  }
+  const results = objects.map((obj) => {
+    const messages = messageMap.get(obj.name.toLowerCase()) || [];
+    const hasErrors = messages.some((m) => m.severity === "error");
+    return {
+      name: obj.name,
+      extension: obj.extension,
+      status: hasErrors ? "error" : messages.length > 0 ? "warning" : "success",
+      messages
+    };
+  });
+  return ok(results);
+}
+
+// src/core/adt/discovery/tree/packageStats.ts
+function constructPackageStatsBody(packageNames) {
+  const names = packageNames.length === 1 ? [...packageNames, "SRIS_TEST_DATA_VFS_EMPTY"] : packageNames;
+  const values = names.map((name) => `    <vfs:value>${name}</vfs:value>`).join("\n");
+  return `<?xml version="1.0" encoding="UTF-8"?>
+<vfs:virtualFoldersRequest xmlns:vfs="http://www.sap.com/adt/ris/virtualFolders" objectSearchPattern="*">
+  <vfs:preselection facet="package">
+${values}
+  </vfs:preselection>
+  <vfs:facetorder>
+    <vfs:facet>package</vfs:facet>
+    <vfs:facet>group</vfs:facet>
+    <vfs:facet>type</vfs:facet>
+  </vfs:facetorder>
+</vfs:virtualFoldersRequest>`;
+}
+function parsePackageStats(xml) {
+  const [doc, parseErr] = safeParseXml(xml);
+  if (parseErr) return [];
+  const packages = [];
+  const virtualFolders = doc.getElementsByTagName("vfs:virtualFolder");
+  for (let i = 0; i < virtualFolders.length; i++) {
+    const vf = virtualFolders[i];
+    if (!vf) continue;
+    const facet = vf.getAttribute("facet")?.toUpperCase();
+    if (facet !== "PACKAGE") continue;
+    const name = vf.getAttribute("name");
+    if (!name) continue;
+    const countAttr = vf.getAttribute("counter");
+    const count = countAttr ? parseInt(countAttr, 10) : 0;
+    const description = vf.getAttribute("text");
+    const pkg = {
+      name,
+      numContents: count
+    };
+    if (description) pkg.description = description;
+    packages.push(pkg);
+  }
+  return packages;
+}
+async function getPackageStats(client, packageNames) {
+  const isSingle = typeof packageNames === "string";
+  const names = isSingle ? [packageNames] : packageNames;
+  if (names.length === 0) {
+    return ok([]);
+  }
+  const body = constructPackageStatsBody(names);
+  const [response, requestErr] = await client.request({
+    method: "POST",
+    path: "/sap/bc/adt/repository/informationsystem/virtualfolders/contents",
+    headers: {
+      "Content-Type": "application/vnd.sap.adt.repository.virtualfolders.request.v1+xml",
+      "Accept": "application/vnd.sap.adt.repository.virtualfolders.result.v1+xml"
+    },
+    body
+  });
+  if (requestErr) return err(requestErr);
+  if (!response.ok) {
+    const text = await response.text();
+    const errorMsg = extractError(text);
+    return err(new Error(`Package stats fetch failed: ${errorMsg}`));
+  }
+  const xml = await response.text();
+  const packages = parsePackageStats(xml).filter((pkg) => pkg.name !== "SRIS_TEST_DATA_VFS_EMPTY");
+  if (isSingle) {
+    if (packages.length === 0) {
+      return err(new Error(`Package ${packageNames} not found`));
+    }
+    return ok(packages[0]);
+  }
+  return ok(packages);
+}
+
 // src/core/adt/discovery/packages.ts
-async function getPackages(client, filter = "*") {
+async function getPackages(client, options = {}) {
+  const { filter = "*", includeDescriptions = false } = options;
   const params = new URLSearchParams([
     ["operation", "quickSearch"],
     ["query", filter],
@@ -1560,18 +1753,31 @@ async function getPackages(client, filter = "*") {
   if (parseErr) {
     return err(parseErr);
   }
-  const packages = [];
+  const packageNames = [];
   const objectRefs = doc.getElementsByTagNameNS("http://www.sap.com/adt/core", "objectReference");
   for (let i = 0; i < objectRefs.length; i++) {
     const obj = objectRefs[i];
     if (!obj) return err(new Error("Invalid object reference in package search results"));
     const name = obj.getAttributeNS("http://www.sap.com/adt/core", "name") || obj.getAttribute("adtcore:name");
-    const description = obj.getAttributeNS("http://www.sap.com/adt/core", "description") || obj.getAttribute("adtcore:description");
     if (!name) return err(new Error("Package name missing in object reference"));
+    packageNames.push(name);
+  }
+  if (packageNames.length === 0) return ok([]);
+  if (!includeDescriptions) return ok(packageNames.map((name) => ({ name })));
+  const [stats, statsErr] = await getPackageStats(client, packageNames);
+  if (statsErr) {
+    return ok(packageNames.map((name) => ({ name })));
+  }
+  const descriptionMap = /* @__PURE__ */ new Map();
+  for (const stat2 of stats) {
+    if (stat2.description) descriptionMap.set(stat2.name, stat2.description);
+  }
+  const packages = packageNames.map((name) => {
     const pkg = { name };
+    const description = descriptionMap.get(name);
     if (description) pkg.description = description;
-    packages.push(pkg);
-  }
+    return pkg;
+  });
   return ok(packages);
 }
 
@@ -1811,79 +2017,6 @@ async function getTree(client, query = {}) {
   return ok(result);
 }
 
-// src/core/adt/discovery/tree/packageStats.ts
-function constructPackageStatsBody(packageNames) {
-  const names = packageNames.length === 1 ? [...packageNames, "SRIS_TEST_DATA_VFS_EMPTY"] : packageNames;
-  const values = names.map((name) => `    <vfs:value>${name}</vfs:value>`).join("\n");
-  return `<?xml version="1.0" encoding="UTF-8"?>
-<vfs:virtualFoldersRequest xmlns:vfs="http://www.sap.com/adt/ris/virtualFolders" objectSearchPattern="*">
-  <vfs:preselection facet="package">
-${values}
-  </vfs:preselection>
-  <vfs:facetorder>
-    <vfs:facet>package</vfs:facet>
-    <vfs:facet>group</vfs:facet>
-    <vfs:facet>type</vfs:facet>
-  </vfs:facetorder>
-</vfs:virtualFoldersRequest>`;
-}
-function parsePackageStats(xml) {
-  const [doc, parseErr] = safeParseXml(xml);
-  if (parseErr) return [];
-  const packages = [];
-  const virtualFolders = doc.getElementsByTagName("vfs:virtualFolder");
-  for (let i = 0; i < virtualFolders.length; i++) {
-    const vf = virtualFolders[i];
-    if (!vf) continue;
-    const facet = vf.getAttribute("facet")?.toUpperCase();
-    if (facet !== "PACKAGE") continue;
-    const name = vf.getAttribute("name");
-    if (!name) continue;
-    const countAttr = vf.getAttribute("counter");
-    const count = countAttr ? parseInt(countAttr, 10) : 0;
-    const description = vf.getAttribute("text");
-    const pkg = {
-      name,
-      numContents: count
-    };
-    if (description) pkg.description = description;
-    packages.push(pkg);
-  }
-  return packages;
-}
-async function getPackageStats(client, packageNames) {
-  const isSingle = typeof packageNames === "string";
-  const names = isSingle ? [packageNames] : packageNames;
-  if (names.length === 0) {
-    return ok([]);
-  }
-  const body = constructPackageStatsBody(names);
-  const [response, requestErr] = await client.request({
-    method: "POST",
-    path: "/sap/bc/adt/repository/informationsystem/virtualfolders/contents",
-    headers: {
-      "Content-Type": "application/vnd.sap.adt.repository.virtualfolders.request.v1+xml",
-      "Accept": "application/vnd.sap.adt.repository.virtualfolders.result.v1+xml"
-    },
-    body
-  });
-  if (requestErr) return err(requestErr);
-  if (!response.ok) {
-    const text = await response.text();
-    const errorMsg = extractError(text);
-    return err(new Error(`Package stats fetch failed: ${errorMsg}`));
-  }
-  const xml = await response.text();
-  const packages = parsePackageStats(xml).filter((pkg) => pkg.name !== "SRIS_TEST_DATA_VFS_EMPTY");
-  if (isSingle) {
-    if (packages.length === 0) {
-      return err(new Error(`Package ${packageNames} not found`));
-    }
-    return ok(packages[0]);
-  }
-  return ok(packages);
-}
-
 // src/core/adt/transports/transports.ts
 async function getTransports(client, packageName) {
   const contentType = "application/vnd.sap.as+xml; charset=UTF-8; dataname=com.sap.adt.transport.service.checkData";
@@ -2539,10 +2672,16 @@ async function deleteObjects(state, requestor, objects, transport) {
   return ok(void 0);
 }
 
+// src/client/methods/craud/checkSyntax.ts
+async function checkSyntax2(state, requestor, objects) {
+  if (!state.session) return err(new Error("Not logged in"));
+  return checkSyntax(requestor, objects);
+}
+
 // src/client/methods/discovery/getPackages.ts
-async function getPackages2(state, requestor, filter) {
+async function getPackages2(state, requestor, options) {
   if (!state.session) return err(new Error("Not logged in"));
-  return getPackages(requestor, filter);
+  return getPackages(requestor, options);
 }
 
 // src/client/methods/discovery/getTree.ts
@@ -2935,12 +3074,15 @@ var ADTClientImpl = class {
   async activate(objects) {
     return activate(this.state, this.requestor, objects);
   }
+  async checkSyntax(objects) {
+    return checkSyntax2(this.state, this.requestor, objects);
+  }
   async delete(objects, transport) {
     return deleteObjects(this.state, this.requestor, objects, transport);
   }
   // --- Discovery ---
-  async getPackages(filter) {
-    return getPackages2(this.state, this.requestor, filter);
+  async getPackages(options) {
+    return getPackages2(this.state, this.requestor, options);
   }
   async getTree(query) {
     return getTree2(this.state, this.requestor, query);