sfmc-dataloader 2.5.0 → 2.6.1

package/README.md

@@ -175,6 +175,14 @@ Interactive: type `YES` when prompted. In CI, add `--i-accept-clear-data-risk` a
 
 Log lines include **row counts** and show file paths as **absolute paths in double-quotes** (e.g. `"C:\data\MyCred\DEV\Contact.mcdata.csv"`) so they are clickable in VS Code's integrated terminal.
 
+## Programmatic API (Node.js)
+
+Import from `sfmc-dataloader` for use in other tools (for example the **SFMC Data Loader** VS Code extension):
+
+| Export | Purpose |
+|--------|---------|
+| `fetchDeList(projectRoot, credential, bu)` | Returns all Data Extension **names** and **customer keys** for one BU via SOAP `retrieveBulk` (pagination handled by **sfmc-sdk**). Not a CLI command — intended for in-process callers that already have mcdev/mcdata config on disk. |
+
 ## License
 
 MIT — Author: Jörn Berkefeld

package/lib/business-units.mjs

@@ -46,7 +46,18 @@ export function processBusinessUnitResults(results, enterpriseId) {
         }
     }
 
-    return { eid, businessUnits };
+    /** @type {Record<string, number>} */
+    const sorted = {};
+    if (Object.hasOwn(businessUnits, '_ParentBU_')) {
+        sorted['_ParentBU_'] = businessUnits['_ParentBU_'];
+    }
+    for (const key of Object.keys(businessUnits)
+        .filter((k) => k !== '_ParentBU_')
+        .toSorted((a, b) => a.localeCompare(b, undefined, { sensitivity: 'base' }))) {
+        sorted[key] = businessUnits[key];
+    }
+
+    return { eid, businessUnits: sorted };
 }
 
 /**

package/lib/config.mjs

@@ -170,9 +170,32 @@ export function buildSdkAuthObject(authCred, mid) {
  */
 export function buildSdkOptions(logger = null) {
     /** @type {import('sfmc-sdk').SdkOptions} */
-    const options = { requestAttempts: 3 };
+    const options = {
+        requestAttempts: 3,
+        retryOnConnectionError: true,
+        eventHandlers: {
+            onLoop: (_type, accumulator) => {
+                process.stdout.write(
+                    ` - Requesting next batch (currently ${accumulator?.length ?? 0} records)\n`,
+                );
+            },
+            onConnectionError: (ex, remainingAttempts) => {
+                const endpointStr = ex.endpoint ? String(ex.endpoint) : '';
+                const endpointSuffix = endpointStr
+                    ? ` - ${endpointStr.split('rest.marketingcloudapis.com')[1] ?? endpointStr}`
+                    : '';
+                process.stdout.write(
+                    ` - Connection problem (Code: ${ex.code}). Retrying ${remainingAttempts} time${
+                        remainingAttempts > 1 ? 's' : ''
+                    }${endpointSuffix}\n`,
+                );
+                console.error(ex);
+            },
+        },
+    };
     if (logger) {
         options.eventHandlers = {
+            ...options.eventHandlers,
             logRequest: (req) => {
                 const msg = structuredClone(req);
                 if (msg.headers?.Authorization) {

package/lib/de-list.mjs

@@ -0,0 +1,59 @@
+import SDK from 'sfmc-sdk';
+import {
+    loadProjectConfig,
+    resolveCredentialAndMid,
+    buildSdkAuthObject,
+    buildSdkOptions,
+} from './config.mjs';
+
+/**
+ * Maps a SOAP retrieveBulk result for DataExtension into sorted `{ name, key }` rows.
+ * Exported for unit tests; not part of the stable public API contract beyond testing.
+ *
+ * @param {object|null|undefined} bulkResult - `sdk.soap.retrieveBulk` response
+ * @returns {{ name: string, key: string }[]}
+ */
+export function normalizeDeListFromBulkResult(bulkResult) {
+    const rows = bulkResult?.Results;
+    if (!Array.isArray(rows) || rows.length === 0) {
+        return [];
+    }
+
+    const items = rows
+        .map((row) => ({
+            name: String(row.Name ?? ''),
+            key: String(row.CustomerKey ?? ''),
+        }))
+        .filter((item) => item.key.length > 0);
+
+    items.sort((a, b) => a.name.localeCompare(b.name, undefined, { sensitivity: 'base' }));
+    return items;
+}
+
+/**
+ * Retrieves all Data Extension `Name` and `CustomerKey` values for a credential/BU via SOAP
+ * (`retrieveBulk` handles pagination). For programmatic use (e.g. VS Code extension cache), not the CLI.
+ *
+ * @param {string} projectRoot - Absolute path to project root (mcdev or mcdata config pair)
+ * @param {string} credential - Credential name from config
+ * @param {string} bu - Business unit key from config
+ * @returns {Promise.<{ name: string, key: string }[]>}
+ */
+export async function fetchDeList(projectRoot, credential, bu) {
+    const { mcdevrc, mcdevAuth } = loadProjectConfig(projectRoot);
+    const { mid, authCred } = resolveCredentialAndMid(mcdevrc, mcdevAuth, credential, bu);
+    const sdk = new SDK(buildSdkAuthObject(authCred, mid), buildSdkOptions());
+
+    let bulkResult;
+    try {
+        bulkResult = await sdk.soap.retrieveBulk('DataExtension', ['Name', 'CustomerKey'], {});
+    } catch (ex) {
+        const message = ex instanceof Error ? ex.message : String(ex);
+        throw new Error(
+            `Could not retrieve Data Extensions — check credentials and BU. Original error: ${message}`,
+            { cause: ex },
+        );
+    }
+
+    return normalizeDeListFromBulkResult(bulkResult);
+}

package/lib/index.mjs

@@ -29,3 +29,4 @@ export { multiBuExport } from './multi-bu-export.mjs';
 export { crossBuImport } from './cross-bu-import.mjs';
 export { getDeRowCount } from './row-count.mjs';
 export { projectRelativePosix } from './paths.mjs';
+export { fetchDeList } from './de-list.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sfmc-dataloader",
-    "version": "2.5.0",
+    "version": "2.6.1",
     "description": "SFMC Data Loader CLI (mcdata) — standalone export/import of Marketing Cloud Data Extension rows; optional mcdev integration",
     "author": "Jörn Berkefeld <joern.berkefeld@gmail.com>",
     "license": "MIT",