salesforce-metadata-mcp 2.5.2 → 2.5.3

package/dist/services/deployment.js

@@ -1,7 +1,7 @@
 import JSZip from "jszip";
 import { API_VERSION, x, fetchWithTimeout, sanitizeError } from "./salesforce.js";
 // ─── Zip-based deploy helpers ─────────────────────────────────────────────────
-function buildPackageXml(types, apiVersion) {
+export function buildPackageXml(types, apiVersion) {
     const typesXml = types.map(t => `
     <types>
       ${t.members.map(m => `<members>${m}</members>`).join("\n      ")}
@@ -59,8 +59,9 @@ export async function buildStaticResourceZip(resourceName, content, contentType,
     const zip = new JSZip();
     const packageXml = buildPackageXml([{ name: "StaticResource", members: [resourceName] }], apiVersion);
     zip.file("package.xml", packageXml);
-    zip.file(`staticresources/${resourceName}`, content);
-    zip.file(`staticresources/${resourceName}.resource-meta.xml`, `<?xml version="1.0" encoding="UTF-8"?>\n<StaticResource xmlns="http://soap.sforce.com/2006/04/metadata">\n  <cacheControl>Public</cacheControl>\n  <contentType>${contentType}</contentType>\n</StaticResource>`);
+    // Content must be in the .resource file; do NOT embed in the meta XML
+    zip.file(`staticresources/${resourceName}.resource`, content);
+    zip.file(`staticresources/${resourceName}.resource-meta.xml`, `<?xml version="1.0" encoding="UTF-8"?>\n<StaticResource xmlns="http://soap.sforce.com/2006/04/metadata">\n  <cacheControl>${contentType === "text/plain" ? "Public" : "Private"}</cacheControl>\n  <contentType>${contentType}</contentType>\n</StaticResource>`);
     const buffer = await zip.generateAsync({ type: "nodebuffer" });
     return buffer.toString("base64");
 }
@@ -89,15 +90,16 @@ export async function buildGenAiActionZip(params, apiVersion) {
     const isApex = params.invocationTargetType === "ApexClass";
     const invocationTarget = isApex ? (params.apexClassName ?? "") : (params.flowApiName ?? "");
     const invocationTargetType = isApex ? "apexClass" : "flow";
+    // WSDL alphabetical order: description, invocationTarget, invocationTargetType, isConfirmationRequired, mappingAttributes, masterLabel
     const functionXml = `<?xml version="1.0" encoding="UTF-8"?>
 <GenAiFunction xmlns="http://soap.sforce.com/2006/04/metadata">
-    <description>${escapeXml(params.description)}</description>
+    <description>${escapeXml(params.description ?? "")}</description>
     <invocationTarget>${escapeXml(invocationTarget)}</invocationTarget>
     <invocationTargetType>${invocationTargetType}</invocationTargetType>
     <isConfirmationRequired>false</isConfirmationRequired>
-    <masterLabel>${escapeXml(params.label)}</masterLabel>
     ${inputsXml}
     ${outputsXml}
+    <masterLabel>${escapeXml(params.label)}</masterLabel>
 </GenAiFunction>`;
     zip.file(`genAiFunctions/${functionName}/${functionName}.genAiFunction-meta.xml`, functionXml);
     // Build input schema JSON
@@ -219,7 +221,7 @@ export async function deployZip(auth, base64Zip, options = {}) {
         ${options.testLevel && options.testLevel !== "RunAllTestsInOrg" ? `<met:testLevel>${options.testLevel}</met:testLevel>` : ""}
         ${testsXml}
         <met:rollbackOnError>${options.rollbackOnError !== false}</met:rollbackOnError>
-        <met:singlePackage>true</met:singlePackage>
+        <met:singlePackage>${options.singlePackage !== false}</met:singlePackage>
       </met:DeployOptions>
     </met:deploy>
   </soapenv:Body>
@@ -294,18 +296,15 @@ export async function checkDeployStatus(auth, deployId) {
     return { done, success, status, message };
 }
 // ─── Retrieve metadata ────────────────────────────────────────────────────────
-export async function retrieveMetadata(auth, components) {
+function buildRetrieveEnvelope(auth, components) {
     const typeMap = new Map();
     for (const c of components) {
         const existing = typeMap.get(c.type) ?? [];
         existing.push(c.name);
         typeMap.set(c.type, existing);
     }
-    const typesXml = [...typeMap.entries()].map(([name, members]) => `
-    <met:unpackaged>
-      ${members.map(m => `<met:types><met:members>${m}</met:members><met:name>${name}</met:name></met:types>`).join("\n")}
-    </met:unpackaged>`).join("\n");
-    const envelope = `<?xml version="1.0" encoding="utf-8"?>
+    const typesXml = [...typeMap.entries()].map(([name, members]) => `<types>${members.map(m => `<members>${m}</members>`).join("")}<name>${name}</name></types>`).join("");
+    return `<?xml version="1.0" encoding="utf-8"?>
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:met="http://soap.sforce.com/2006/04/metadata">
   <soapenv:Header>
     <met:CallOptions><met:client>salesforce-metadata-mcp</met:client></met:CallOptions>
@@ -315,12 +314,18 @@ export async function retrieveMetadata(auth, components) {
     <met:retrieve>
       <met:retrieveRequest>
         <met:apiVersion>${API_VERSION}</met:apiVersion>
-        ${typesXml}
+        <met:unpackaged>${typesXml}</met:unpackaged>
       </met:retrieveRequest>
     </met:retrieve>
   </soapenv:Body>
 </soapenv:Envelope>`;
+}
+export async function retrieveMetadata(auth, components) {
+    if (!components || !Array.isArray(components) || components.length === 0) {
+        return { success: false, message: "No components specified for retrieval. Provide components array, e.g. [{type:'CustomObject',name:'MyObj__c'}]." };
+    }
     try {
+        const envelope = buildRetrieveEnvelope(auth, components);
         const response = await fetchWithTimeout(`${auth.instanceUrl}/services/Soap/m/${API_VERSION}`, { method: "POST", headers: { "Content-Type": "text/xml; charset=utf-8", SOAPAction: '"retrieve"' }, body: envelope }, 60_000);
         if (!response.ok)
             throw new Error(`Retrieve SOAP request failed with HTTP ${response.status}.`);
@@ -339,4 +344,55 @@ export async function retrieveMetadata(auth, components) {
         return { success: false, message: sanitizeError(err instanceof Error ? err.message : String(err)) };
     }
 }
+// ─── Poll retrieve status and return zip ─────────────────────────────────────
+export async function pollRetrieveAndGetZip(auth, retrieveId, maxWaitMs = 3 * 60 * 1000) {
+    const start = Date.now();
+    while (Date.now() - start < maxWaitMs) {
+        await new Promise(r => setTimeout(r, 5_000));
+        const envelope = `<?xml version="1.0" encoding="utf-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:met="http://soap.sforce.com/2006/04/metadata">
+  <soapenv:Header>
+    <met:CallOptions><met:client>salesforce-metadata-mcp</met:client></met:CallOptions>
+    <met:SessionHeader><met:sessionId>${auth.accessToken}</met:sessionId></met:SessionHeader>
+  </soapenv:Header>
+  <soapenv:Body>
+    <met:checkRetrieveStatus>
+      <met:asyncProcessId>${retrieveId}</met:asyncProcessId>
+      <met:includeZip>true</met:includeZip>
+    </met:checkRetrieveStatus>
+  </soapenv:Body>
+</soapenv:Envelope>`;
+        const resp = await fetchWithTimeout(`${auth.instanceUrl}/services/Soap/m/${API_VERSION}`, { method: "POST", headers: { "Content-Type": "text/xml; charset=utf-8", SOAPAction: '"checkRetrieveStatus"' }, body: envelope }, 60_000);
+        if (!resp.ok) throw new Error(`checkRetrieveStatus HTTP ${resp.status}`);
+        const xml = await resp.text();
+        const doneMatch = xml.match(/<done>(true|false)<\/done>/i);
+        if (doneMatch?.[1] !== "true") continue;
+        const successMatch = xml.match(/<success>(true|false)<\/success>/i);
+        if (successMatch?.[1] !== "true") {
+            const errMsg = xml.match(/<errorMessage[^>]*>([\s\S]*?)<\/errorMessage>/i);
+            throw new Error(errMsg ? errMsg[1].trim() : "Retrieve failed");
+        }
+        const zipMatch = xml.match(/<zipFile[^>]*>([\s\S]*?)<\/zipFile>/i);
+        if (!zipMatch) throw new Error("Retrieve completed but no zip in response");
+        return zipMatch[1].replace(/\s/g, "");
+    }
+    throw new Error(`Retrieve timed out after ${maxWaitMs / 1000}s`);
+}
+// ─── Retrieve then deploy (for validate/deploy of existing org components) ───
+export async function retrieveAndDeploy(auth, components, deployOptions, waitMinutes = 10) {
+    const envelope = buildRetrieveEnvelope(auth, components);
+    const response = await fetchWithTimeout(`${auth.instanceUrl}/services/Soap/m/${API_VERSION}`, { method: "POST", headers: { "Content-Type": "text/xml; charset=utf-8", SOAPAction: '"retrieve"' }, body: envelope }, 60_000);
+    if (!response.ok) throw new Error(`Retrieve SOAP request failed with HTTP ${response.status}.`);
+    const xml = await response.text();
+    const idMatch = xml.match(/<id[^>]*>([A-Za-z0-9]{15,18})<\/id>/);
+    if (!idMatch) {
+        const fault = xml.match(/<faultstring[^>]*>([\s\S]*?)<\/faultstring>/i);
+        throw new Error(fault ? fault[1].trim() : "Retrieve failed to start");
+    }
+    const retrieveId = idMatch[1];
+    const base64Zip = await pollRetrieveAndGetZip(auth, retrieveId, waitMinutes * 30 * 1000);
+    // Retrieved zips use unpackaged/ folder structure, so singlePackage must be false
+    const deployId = await deployZip(auth, base64Zip, { ...deployOptions, singlePackage: false });
+    return await pollDeployStatus(auth, deployId, waitMinutes * 60 * 1000);
+}
 //# sourceMappingURL=deployment.js.map