@mablhq/mabl-cli 2.100.6 → 2.101.2

package/mablscript/steps/DownloadStep.js

@@ -30,6 +30,7 @@ class DownloadStep extends MablStepV2_1.MablStepV2 {
             file_size_bytes_max: descriptor.sizeBytesMax,
             file_size_bytes_min: descriptor.sizeBytesMin,
             ai_prompt: descriptor.aiPrompt,
+            file_name_match_mode: descriptor.fileNameMatchMode,
         };
     }
     getStepName() {
@@ -57,6 +58,7 @@ class DownloadStep extends MablStepV2_1.MablStepV2 {
             fileMd5: fileAttributes.file_md5,
             fileSha256: fileAttributes.file_sha256,
             aiPrompt: fileAttributes.ai_prompt,
+            fileNameMatchMode: fileAttributes.file_name_match_mode,
         };
         const isPdfDownload = awaitDownloadAction instanceof AwaitPDFDownloadAction_1.AwaitPDFDownloadAction;
         if (isPdfDownload) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mablhq/mabl-cli",
-  "version": "2.100.6",
+  "version": "2.101.2",
   "license": "SEE LICENSE IN LICENSE.txt",
   "description": "The official mabl command line interface tool",
   "main": "index.js",

package/trainer/sharedUtils/mablscript/canonical/DownloadBaseStep.js

@@ -16,6 +16,7 @@ const type_utils_1 = require("../../type-utils");
 const variable_names_util_1 = require("../../variable-names-util");
 const BaseStep_1 = __importDefault(require("./BaseStep"));
 const DownloadStep_1 = require("../../../../mablscript/steps/DownloadStep");
+const fileNameMatchUtil_1 = require("../../../../util/fileNameMatchUtil");
 const yaml_utils_1 = require("../yaml-utils");
 exports.DOWNLOAD_COMPLETE_POLLING_INTERVAL_MILLISECONDS = 200;
 const MISSING_DATA_STATUS = 'MISSING DATA';
@@ -90,6 +91,7 @@ class DownloadBaseStep extends BaseStep_1.default {
         this.stepSymbol = 'assert_download';
         this.awaitParams = values.awaitParameters || {};
         this.aiPrompt = values.aiPrompt;
+        this.fileNameMatchMode = values.fileNameMatchMode;
         this.options = {
             editable: true,
             executionContext: 'background',
@@ -146,6 +148,7 @@ class DownloadBaseStep extends BaseStep_1.default {
             fileMd5: getAssertionValue(DownloadProperty.FileMd5),
             fileSha256: getAssertionValue(DownloadProperty.FileSha256),
             aiPrompt: this.aiPrompt,
+            fileNameMatchMode: this.fileNameMatchMode,
             detected: {
                 file_mime_type: this.detectedProps?.file_mime_type,
                 file_name: this.detectedProps?.file_name,
@@ -168,6 +171,9 @@ class DownloadBaseStep extends BaseStep_1.default {
         if (this.aiPrompt) {
             stepParams.ai_prompt = this.aiPrompt;
         }
+        if (this.fileNameMatchMode && this.fileNameMatchMode !== 'equals') {
+            stepParams.file_name_match_mode = this.fileNameMatchMode;
+        }
         this.assertions
             .filter((assertion) => assertion.expected)
             .forEach((assertion) => {
@@ -235,11 +241,14 @@ function fileMimeTypeChecker(assertion, downloadData) {
     }
     return MISSING_DATA_STATUS;
 }
-function fileNameChecker(assertion, downloadData) {
+function fileNameChecker(assertion, downloadData, fileNameMatchMode) {
     if (downloadData?.[DownloadProperty.FileName]) {
         const filename = removeFileAutoNumbering(DownloadBaseStep.downloadPathToFilename(downloadData[DownloadProperty.FileName]) ?? '');
         const expected = removeFileAutoNumbering(assertion.expected);
-        return filename === expected || expected === ''
+        if (expected === '') {
+            return exports.SUCCESS_STATUS;
+        }
+        return (0, fileNameMatchUtil_1.evaluateFileNameMatch)(filename, expected, fileNameMatchMode)
             ? exports.SUCCESS_STATUS
             : generateFail(expected, filename, 'Unexpected file name');
     }
@@ -297,7 +306,12 @@ function humanizeDownloadBaseStep(step) {
             (!assertion.expected || !cleanFilename)) {
             return 'Assert file downloaded';
         }
-        return `Assert ${assertion.desc} equals ${assertionTarget} for download ${cleanFilename}`;
+        const matchVerb = assertion.name === DownloadProperty.FileName &&
+            typeof step.fileNameMatchMode === 'string' &&
+            step.fileNameMatchMode !== 'equals'
+            ? step.fileNameMatchMode.replace('_', ' ')
+            : 'equals';
+        return `Assert ${assertion.desc} ${matchVerb} ${assertionTarget} for download ${cleanFilename}`;
     })
         .join('\t');
 }
@@ -313,6 +327,11 @@ function downloadBaseStepToAIString(step) {
         result.assertions = activeAssertions.map((a) => ({
             property: a.name,
             expected: a.expected,
+            ...(a.name === DownloadProperty.FileName &&
+                step.fileNameMatchMode &&
+                step.fileNameMatchMode !== 'equals'
+                ? { match_mode: step.fileNameMatchMode }
+                : {}),
         }));
     }
     if (step.aiPrompt?.userPrompt) {

package/trainer/sharedUtils/mablscript/canonical/DownloadPdfStep.js

@@ -97,6 +97,7 @@ class DownloadPdfStep extends DownloadBaseStep_1.default {
             assertions,
             awaitParameters,
             aiPrompt: mablDownloadStep.descriptor.aiPrompt,
+            fileNameMatchMode: mablDownloadStep.descriptor.fileNameMatchMode,
         });
     }
     static create(descriptor) {
@@ -121,6 +122,11 @@ function downloadPdfStepToAIString(step) {
         result.assertions = activeAssertions.map((a) => ({
             property: a.name,
             expected: a.expected,
+            ...(a.name === DownloadBaseStep_1.DownloadProperty.FileName &&
+                step.fileNameMatchMode &&
+                step.fileNameMatchMode !== 'equals'
+                ? { match_mode: step.fileNameMatchMode }
+                : {}),
         }));
     }
     if (step.aiPrompt?.userPrompt) {

package/trainer/sharedUtils/mablscript/canonical/DownloadStep.js

@@ -82,6 +82,7 @@ class DownloadStep extends DownloadBaseStep_1.default {
             assertions,
             awaitParameters,
             aiPrompt: mablDownloadStep.descriptor.aiPrompt,
+            fileNameMatchMode: mablDownloadStep.descriptor.fileNameMatchMode,
         });
     }
 }

package/util/downloadUtil.js

@@ -34,6 +34,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PROCESSED_DIR_NAME = void 0;
+exports.createFilenameMatcher = createFilenameMatcher;
 exports.getAwaitDownloadTimeout = getAwaitDownloadTimeout;
 exports.awaitDownload = awaitDownload;
 exports.getLatestFile = getLatestFile;
@@ -47,15 +48,41 @@ const AWAIT_DOWNLOAD_MAX_TIMEOUT_MILLIS = 60_000;
 const FILE_MIN_STABLE_TIME_MILLIS = 3000;
 const AWAIT_DOWNLOAD_POLLING_INTERVAL_MILLISECONDS = 500;
 exports.PROCESSED_DIR_NAME = 'Processed';
+function createFilenameMatcher(pattern, mode) {
+    if (!pattern) {
+        return () => true;
+    }
+    switch (mode) {
+        case 'contains':
+            return (fullPath) => path.basename(fullPath).includes(pattern);
+        case 'starts_with':
+            return (fullPath) => path.basename(fullPath).startsWith(pattern);
+        case 'ends_with':
+            return (fullPath) => path.basename(fullPath).endsWith(pattern);
+        case 'matches_regex': {
+            let regex;
+            try {
+                regex = new RegExp(pattern);
+            }
+            catch {
+                return () => false;
+            }
+            return (fullPath) => regex.test(path.basename(fullPath));
+        }
+        case 'equals':
+        default:
+            return (fullPath) => fullPath.toLowerCase().endsWith(pattern.toLowerCase());
+    }
+}
 function getAwaitDownloadTimeout() {
     return AWAIT_DOWNLOAD_MAX_TIMEOUT_MILLIS;
 }
-async function awaitDownload(downloadDirectory, filePathSuffix, timeoutMillis = getAwaitDownloadTimeout()) {
+async function awaitDownload(downloadDirectory, fileMatcher, timeoutMillis = getAwaitDownloadTimeout()) {
     const startTime = Date.now();
     let foundDownloadPath;
     let downloadComplete = false;
     while (Date.now() - timeoutMillis < startTime && !downloadComplete) {
-        const latestFile = await getLatestFile(downloadDirectory, filePathSuffix);
+        const latestFile = await getLatestFile(downloadDirectory, fileMatcher);
         if (latestFile) {
             downloadComplete = true;
             foundDownloadPath = latestFile;
@@ -66,7 +93,10 @@ async function awaitDownload(downloadDirectory, filePathSuffix, timeoutMillis =
     }
     return foundDownloadPath;
 }
-async function getLatestFile(downloadDirectory, filePathSuffix) {
+async function getLatestFile(downloadDirectory, fileMatcher) {
+    const matchFn = typeof fileMatcher === 'string'
+        ? (fullPath) => fullPath.toLowerCase().endsWith(fileMatcher.toLowerCase())
+        : fileMatcher;
     const readDirectoryAsync = util.promisify(fs.readdir);
     const filesInDownloadDir = await readDirectoryAsync(downloadDirectory);
     let latestFileTime = 0;
@@ -79,7 +109,7 @@ async function getLatestFile(downloadDirectory, filePathSuffix) {
                 stats.ctimeMs > latestFileTime &&
                 Date.now() - stats.mtimeMs >= FILE_MIN_STABLE_TIME_MILLIS &&
                 !fullPath.includes('.crDownload') &&
-                fullPath.toLowerCase().endsWith(filePathSuffix.toLowerCase())) {
+                matchFn(fullPath)) {
                 latestFileTime = stats.ctimeMs;
                 latestFilePath = fullPath;
             }

package/util/fileNameMatchUtil.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateFileNameMatch = evaluateFileNameMatch;
+function evaluateFileNameMatch(actualFileName, expectedPattern, mode) {
+    if (!expectedPattern) {
+        return true;
+    }
+    switch (mode) {
+        case 'contains':
+            return actualFileName.includes(expectedPattern);
+        case 'starts_with':
+            return actualFileName.startsWith(expectedPattern);
+        case 'ends_with':
+            return actualFileName.endsWith(expectedPattern);
+        case 'matches_regex': {
+            try {
+                return new RegExp(expectedPattern).test(actualFileName);
+            }
+            catch {
+                return false;
+            }
+        }
+        case 'equals':
+        default:
+            return actualFileName === expectedPattern;
+    }
+}