windmill-client 1.450.0-beta.0 → 1.450.0-beta.2

package/dist/client.d.ts

@@ -19,17 +19,19 @@ export declare function getWorkspace(): string;
  */
 export declare function getResource(path?: string, undefinedIfEmpty?: boolean): Promise<any>;
 /**
- * Get a resource value by path
+ * Get the true root job id
  * @param jobId job id to get the root job id from (default to current job)
  * @returns root job id
  */
 export declare function getRootJobId(jobId?: string): Promise<string>;
 export declare function runScript(path?: string | null, hash_?: string | null, args?: Record<string, any> | null, verbose?: boolean): Promise<any>;
+export declare function runFlow(path?: string | null, args?: Record<string, any> | null, verbose?: boolean): Promise<any>;
 export declare function waitJob(jobId: string, verbose?: boolean): Promise<any>;
 export declare function getResult(jobId: string): Promise<any>;
 export declare function getResultMaybe(jobId: string): Promise<any>;
 export declare function task<P, T>(f: (_: P) => T): (_: P) => Promise<T>;
 export declare function runScriptAsync(path: string | null, hash_: string | null, args: Record<string, any> | null, scheduledInSeconds?: number | null): Promise<string>;
+export declare function runFlowAsync(path: string | null, args: Record<string, any> | null, scheduledInSeconds?: number | null, doNotTrackInParent?: boolean): Promise<string>;
 /**
  * Resolve a resource value in case the default value was picked because the input payload was undefined
  * @param obj resource value or path of the resource under the format `$res:path`
@@ -55,6 +57,19 @@ export declare function setInternalState(state: any): Promise<void>;
  * @param state state to set
  */
 export declare function setState(state: any): Promise<void>;
+/**
+ * Set the progress
+ * Progress cannot go back and limited to 0% to 99% range
+ * @param percent Progress to set in %
+ * @param jobId? Job to set progress for
+ */
+export declare function setProgress(percent: number, jobId?: any): Promise<void>;
+/**
+ * Get the progress
+ * @param jobId? Job to get progress from
+ * @returns Optional clamped between 0 and 100 progress value
+ */
+export declare function getProgress(jobId?: any): Promise<number | null>;
 /**
  * Set a flow user state
  * @param key key of the state
@@ -123,7 +138,7 @@ export declare function loadS3FileStream(s3object: S3Object, s3ResourcePath?: st
  * console.log(fileContentAsUtf8Str)
  * ```
  */
-export declare function writeS3File(s3object: S3Object | undefined, fileContent: string | Blob, s3ResourcePath?: string | undefined): Promise<S3Object>;
+export declare function writeS3File(s3object: S3Object | undefined, fileContent: string | Blob, s3ResourcePath?: string | undefined, contentType?: string | undefined, contentDisposition?: string | undefined): Promise<S3Object>;
 /**
  * Get URLs needed for resuming a flow after this step
  * @param approver approver name
@@ -158,3 +173,45 @@ export declare function uint8ArrayToBase64(arrayBuffer: Uint8Array): string;
  * @returns email address
  */
 export declare function usernameToEmail(username: string): Promise<string>;
+interface SlackApprovalOptions {
+    slackResourcePath: string;
+    channelId: string;
+    message?: string;
+    approver?: string;
+    defaultArgsJson?: Record<string, any>;
+    dynamicEnumsJson?: Record<string, any>;
+}
+/**
+ * Sends an interactive approval request via Slack, allowing optional customization of the message, approver, and form fields.
+ *
+ * **[Enterprise Edition Only]** To include form fields in the Slack approval request, go to **Advanced -> Suspend -> Form**
+ * and define a form. Learn more at [Windmill Documentation](https://www.windmill.dev/docs/flows/flow_approval#form).
+ *
+ * @param {Object} options - The configuration options for the Slack approval request.
+ * @param {string} options.slackResourcePath - The path to the Slack resource in Windmill.
+ * @param {string} options.channelId - The Slack channel ID where the approval request will be sent.
+ * @param {string} [options.message] - Optional custom message to include in the Slack approval request.
+ * @param {string} [options.approver] - Optional user ID or name of the approver for the request.
+ * @param {DefaultArgs} [options.defaultArgsJson] - Optional object defining or overriding the default arguments to a form field.
+ * @param {Enums} [options.dynamicEnumsJson] - Optional object overriding the enum default values of an enum form field.
+ *
+ * @returns {Promise<void>} Resolves when the Slack approval request is successfully sent.
+ *
+ * @throws {Error} If the function is not called within a flow or flow preview.
+ * @throws {Error} If the `JobService.getSlackApprovalPayload` call fails.
+ *
+ * **Usage Example:**
+ * ```typescript
+ * await requestInteractiveSlackApproval({
+ *   slackResourcePath: "/u/alex/my_slack_resource",
+ *   channelId: "admins-slack-channel",
+ *   message: "Please approve this request",
+ *   approver: "approver123",
+ *   defaultArgsJson: { key1: "value1", key2: 42 },
+ *   dynamicEnumsJson: { foo: ["choice1", "choice2"], bar: ["optionA", "optionB"] },
+ * });
+ * ```
+ *
+ * **Note:** This function requires execution within a Windmill flow or flow preview.
+ */
+export declare function requestInteractiveSlackApproval({ slackResourcePath, channelId, message, approver, defaultArgsJson, dynamicEnumsJson, }: SlackApprovalOptions): Promise<void>;

package/dist/client.js

@@ -9,7 +9,44 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.usernameToEmail = exports.uint8ArrayToBase64 = exports.base64ToUint8Array = exports.getIdToken = exports.getResumeEndpoints = exports.getResumeUrls = exports.writeS3File = exports.loadS3FileStream = exports.loadS3File = exports.denoS3LightClientSettings = exports.databaseUrlFromResource = exports.setVariable = exports.getVariable = exports.getState = exports.getInternalState = exports.getFlowUserState = exports.setFlowUserState = exports.setState = exports.setInternalState = exports.setResource = exports.getStatePath = exports.resolveDefaultResource = exports.runScriptAsync = exports.task = exports.getResultMaybe = exports.getResult = exports.waitJob = exports.runScript = exports.getRootJobId = exports.getResource = exports.getWorkspace = exports.setClient = exports.SHARED_FOLDER = exports.WorkspaceService = exports.UserService = exports.SettingsService = exports.ScheduleService = exports.ScriptService = exports.VariableService = exports.ResourceService = exports.JobService = exports.GroupService = exports.GranularAclService = exports.FlowService = exports.AuditService = exports.AdminService = void 0;
+exports.SHARED_FOLDER = exports.WorkspaceService = exports.UserService = exports.SettingsService = exports.ScheduleService = exports.ScriptService = exports.VariableService = exports.ResourceService = exports.JobService = exports.GroupService = exports.GranularAclService = exports.FlowService = exports.AuditService = exports.AdminService = void 0;
+exports.setClient = setClient;
+exports.getWorkspace = getWorkspace;
+exports.getResource = getResource;
+exports.getRootJobId = getRootJobId;
+exports.runScript = runScript;
+exports.runFlow = runFlow;
+exports.waitJob = waitJob;
+exports.getResult = getResult;
+exports.getResultMaybe = getResultMaybe;
+exports.task = task;
+exports.runScriptAsync = runScriptAsync;
+exports.runFlowAsync = runFlowAsync;
+exports.resolveDefaultResource = resolveDefaultResource;
+exports.getStatePath = getStatePath;
+exports.setResource = setResource;
+exports.setInternalState = setInternalState;
+exports.setState = setState;
+exports.setProgress = setProgress;
+exports.getProgress = getProgress;
+exports.setFlowUserState = setFlowUserState;
+exports.getFlowUserState = getFlowUserState;
+exports.getInternalState = getInternalState;
+exports.getState = getState;
+exports.getVariable = getVariable;
+exports.setVariable = setVariable;
+exports.databaseUrlFromResource = databaseUrlFromResource;
+exports.denoS3LightClientSettings = denoS3LightClientSettings;
+exports.loadS3File = loadS3File;
+exports.loadS3FileStream = loadS3FileStream;
+exports.writeS3File = writeS3File;
+exports.getResumeUrls = getResumeUrls;
+exports.getResumeEndpoints = getResumeEndpoints;
+exports.getIdToken = getIdToken;
+exports.base64ToUint8Array = base64ToUint8Array;
+exports.uint8ArrayToBase64 = uint8ArrayToBase64;
+exports.usernameToEmail = usernameToEmail;
+exports.requestInteractiveSlackApproval = requestInteractiveSlackApproval;
 const index_1 = require("./index");
 const index_2 = require("./index");
 var index_3 = require("./index");
@@ -27,6 +64,7 @@ Object.defineProperty(exports, "SettingsService", { enumerable: true, get: funct
 Object.defineProperty(exports, "UserService", { enumerable: true, get: function () { return index_3.UserService; } });
 Object.defineProperty(exports, "WorkspaceService", { enumerable: true, get: function () { return index_3.WorkspaceService; } });
 exports.SHARED_FOLDER = "/shared";
+let mockedApi = undefined;
 function setClient(token, baseUrl) {
     var _a, _b, _c;
     if (baseUrl === undefined) {
@@ -40,7 +78,6 @@ function setClient(token, baseUrl) {
     index_2.OpenAPI.TOKEN = token;
     index_2.OpenAPI.BASE = baseUrl + "/api";
 }
-exports.setClient = setClient;
 const getEnv = (key) => {
     var _a, _b, _c;
     if (typeof window === "undefined") {
@@ -58,7 +95,6 @@ function getWorkspace() {
     var _a;
     return (_a = getEnv("WM_WORKSPACE")) !== null && _a !== void 0 ? _a : "no_workspace";
 }
-exports.getWorkspace = getWorkspace;
 /**
  * Get a resource value by path
  * @param path path of the resource,  default to internal state path
@@ -67,8 +103,17 @@ exports.getWorkspace = getWorkspace;
  */
 function getResource(path, undefinedIfEmpty) {
     return __awaiter(this, void 0, void 0, function* () {
-        const workspace = getWorkspace();
         path = path !== null && path !== void 0 ? path : getStatePath();
+        const mockedApi = yield getMockedApi();
+        if (mockedApi) {
+            if (mockedApi.resources[path]) {
+                return mockedApi.resources[path];
+            }
+            else {
+                console.log(`MockedAPI present, but resource not found at ${path}, falling back to real API`);
+            }
+        }
+        const workspace = getWorkspace();
         try {
             return yield index_1.ResourceService.getResourceValueInterpolated({
                 workspace,
@@ -85,9 +130,8 @@ function getResource(path, undefinedIfEmpty) {
         }
     });
 }
-exports.getResource = getResource;
 /**
- * Get a resource value by path
+ * Get the true root job id
  * @param jobId job id to get the root job id from (default to current job)
  * @returns root job id
  */
@@ -101,7 +145,6 @@ function getRootJobId(jobId) {
         return yield index_1.JobService.getRootJobId({ workspace, id: jobId });
     });
 }
-exports.getRootJobId = getRootJobId;
 function runScript() {
     return __awaiter(this, arguments, void 0, function* (path = null, hash_ = null, args = null, verbose = false) {
         args = args || {};
@@ -112,7 +155,16 @@ function runScript() {
         return yield waitJob(jobId, verbose);
     });
 }
-exports.runScript = runScript;
+function runFlow() {
+    return __awaiter(this, arguments, void 0, function* (path = null, args = null, verbose = false) {
+        args = args || {};
+        if (verbose) {
+            console.info(`running \`${path}\` synchronously with args:`, args);
+        }
+        const jobId = yield runFlowAsync(path, args, null, false);
+        return yield waitJob(jobId, verbose);
+    });
+}
 function waitJob(jobId_1) {
     return __awaiter(this, arguments, void 0, function* (jobId, verbose = false) {
         while (true) {
@@ -141,21 +193,18 @@ function waitJob(jobId_1) {
         }
     });
 }
-exports.waitJob = waitJob;
 function getResult(jobId) {
     return __awaiter(this, void 0, void 0, function* () {
         const workspace = getWorkspace();
         return yield index_1.JobService.getCompletedJobResult({ workspace, id: jobId });
     });
 }
-exports.getResult = getResult;
 function getResultMaybe(jobId) {
     return __awaiter(this, void 0, void 0, function* () {
         const workspace = getWorkspace();
         return yield index_1.JobService.getCompletedJobResultMaybe({ workspace, id: jobId });
     });
 }
-exports.getResultMaybe = getResultMaybe;
 const STRIP_COMMENTS = /(\/\/.*$)|(\/\*[\s\S]*?\*\/)|(\s*=[^,\)]*(('(?:\\'|[^'\r\n])*')|("(?:\\"|[^"\r\n])*"))|(\s*=[^,\)]*))/gm;
 const ARGUMENT_NAMES = /([^\s,]+)/g;
 function getParamNames(func) {
@@ -187,7 +236,6 @@ function task(f) {
         return r;
     });
 }
-exports.task = task;
 function runScriptAsync(path_1, hash_1, args_1) {
     return __awaiter(this, arguments, void 0, function* (path, hash_, args, scheduledInSeconds = null) {
         // Create a script job and return its job id.
@@ -229,7 +277,47 @@ function runScriptAsync(path_1, hash_1, args_1) {
         }).then((res) => res.text());
     });
 }
-exports.runScriptAsync = runScriptAsync;
+function runFlowAsync(path_1, args_1) {
+    return __awaiter(this, arguments, void 0, function* (path, args, scheduledInSeconds = null, 
+    // can only be set to false if this the job will be fully await and not concurrent with any other job
+    // as otherwise the child flow and its own child will store their state in the parent job which will
+    // lead to incorrectness and failures
+    doNotTrackInParent = true) {
+        // Create a script job and return its job id.
+        args = args || {};
+        const params = {};
+        if (scheduledInSeconds) {
+            params["scheduled_in_secs"] = scheduledInSeconds;
+        }
+        if (!doNotTrackInParent) {
+            let parentJobId = getEnv("WM_JOB_ID");
+            if (parentJobId !== undefined) {
+                params["parent_job"] = parentJobId;
+            }
+            let rootJobId = getEnv("WM_ROOT_FLOW_JOB_ID");
+            if (rootJobId != undefined && rootJobId != "") {
+                params["root_job"] = rootJobId;
+            }
+        }
+        let endpoint;
+        if (path) {
+            endpoint = `/w/${getWorkspace()}/jobs/run/f/${path}`;
+        }
+        else {
+            throw new Error("path must be provided");
+        }
+        let url = new URL(index_2.OpenAPI.BASE + endpoint);
+        url.search = new URLSearchParams(params).toString();
+        return fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${index_2.OpenAPI.TOKEN}`,
+            },
+            body: JSON.stringify(args),
+        }).then((res) => res.text());
+    });
+}
 /**
  * Resolve a resource value in case the default value was picked because the input payload was undefined
  * @param obj resource value or path of the resource under the format `$res:path`
@@ -245,7 +333,6 @@ function resolveDefaultResource(obj) {
         }
     });
 }
-exports.resolveDefaultResource = resolveDefaultResource;
 function getStatePath() {
     var _a;
     const state_path = (_a = getEnv("WM_STATE_PATH_NEW")) !== null && _a !== void 0 ? _a : getEnv("WM_STATE_PATH");
@@ -254,7 +341,6 @@ function getStatePath() {
     }
     return state_path;
 }
-exports.getStatePath = getStatePath;
 /**
  * Set a resource value by path
  * @param path path of the resource to set, default to state path
@@ -264,6 +350,11 @@ exports.getStatePath = getStatePath;
 function setResource(value, path, initializeToTypeIfNotExist) {
     return __awaiter(this, void 0, void 0, function* () {
         path = path !== null && path !== void 0 ? path : getStatePath();
+        const mockedApi = yield getMockedApi();
+        if (mockedApi) {
+            mockedApi.resources[path] = value;
+            return;
+        }
         const workspace = getWorkspace();
         if (yield index_1.ResourceService.existsResource({ workspace, path })) {
             yield index_1.ResourceService.updateResourceValue({
@@ -283,7 +374,6 @@ function setResource(value, path, initializeToTypeIfNotExist) {
         }
     });
 }
-exports.setResource = setResource;
 /**
  * Set the state
  * @param state state to set
@@ -294,7 +384,6 @@ function setInternalState(state) {
         yield setResource(state, undefined, "state");
     });
 }
-exports.setInternalState = setInternalState;
 /**
  * Set the state
  * @param state state to set
@@ -304,7 +393,53 @@ function setState(state) {
         yield setResource(state, undefined, "state");
     });
 }
-exports.setState = setState;
+/**
+ * Set the progress
+ * Progress cannot go back and limited to 0% to 99% range
+ * @param percent Progress to set in %
+ * @param jobId? Job to set progress for
+ */
+function setProgress(percent, jobId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const workspace = getWorkspace();
+        let flowId = getEnv("WM_FLOW_JOB_ID");
+        // If jobId specified we need to find if there is a parent/flow
+        if (jobId) {
+            const job = yield index_1.JobService.getJob({
+                id: jobId !== null && jobId !== void 0 ? jobId : "NO_JOB_ID",
+                workspace,
+                noLogs: true,
+            });
+            // Could be actual flowId or undefined
+            flowId = job.parent_job;
+        }
+        yield index_1.MetricsService.setJobProgress({
+            id: (_a = jobId !== null && jobId !== void 0 ? jobId : getEnv("WM_JOB_ID")) !== null && _a !== void 0 ? _a : "NO_JOB_ID",
+            workspace,
+            requestBody: {
+                // In case user inputs float, it should be converted to int
+                percent: Math.floor(percent),
+                flow_job_id: flowId == "" ? undefined : flowId,
+            },
+        });
+    });
+}
+/**
+ * Get the progress
+ * @param jobId? Job to get progress from
+ * @returns Optional clamped between 0 and 100 progress value
+ */
+function getProgress(jobId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        // TODO: Delete or set to 100 completed job metrics
+        return yield index_1.MetricsService.getJobProgress({
+            id: (_a = jobId !== null && jobId !== void 0 ? jobId : getEnv("WM_JOB_ID")) !== null && _a !== void 0 ? _a : "NO_JOB_ID",
+            workspace: getWorkspace(),
+        });
+    });
+}
 /**
  * Set a flow user state
  * @param key key of the state
@@ -335,7 +470,6 @@ function setFlowUserState(key, value, errorIfNotPossible) {
         }
     });
 }
-exports.setFlowUserState = setFlowUserState;
 /**
  * Get a flow user state
  * @param path path of the variable
@@ -361,7 +495,6 @@ function getFlowUserState(key, errorIfNotPossible) {
         }
     });
 }
-exports.getFlowUserState = getFlowUserState;
 // /**
 //  * Set the shared state
 //  * @param state state to set
@@ -388,7 +521,6 @@ function getInternalState() {
         return yield getResource(getStatePath(), true);
     });
 }
-exports.getInternalState = getInternalState;
 /**
  * Get the state shared across executions
  */
@@ -397,7 +529,6 @@ function getState() {
         return yield getResource(getStatePath(), true);
     });
 }
-exports.getState = getState;
 /**
  * Get a variable by path
  * @param path path of the variable
@@ -405,6 +536,15 @@ exports.getState = getState;
  */
 function getVariable(path) {
     return __awaiter(this, void 0, void 0, function* () {
+        const mockedApi = yield getMockedApi();
+        if (mockedApi) {
+            if (mockedApi.variables[path]) {
+                return mockedApi.variables[path];
+            }
+            else {
+                console.log(`MockedAPI present, but variable not found at ${path}, falling back to real API`);
+            }
+        }
         const workspace = getWorkspace();
         try {
             return yield index_1.VariableService.getVariableValue({ workspace, path });
@@ -414,7 +554,6 @@ function getVariable(path) {
         }
     });
 }
-exports.getVariable = getVariable;
 /**
  * Set a variable by path, create if not exist
  * @param path path of the variable
@@ -424,6 +563,11 @@ exports.getVariable = getVariable;
  */
 function setVariable(path, value, isSecretIfNotExist, descriptionIfNotExist) {
     return __awaiter(this, void 0, void 0, function* () {
+        const mockedApi = yield getMockedApi();
+        if (mockedApi) {
+            mockedApi.variables[path] = value;
+            return;
+        }
         const workspace = getWorkspace();
         if (yield index_1.VariableService.existsVariable({ workspace, path })) {
             yield index_1.VariableService.updateVariable({
@@ -445,14 +589,12 @@ function setVariable(path, value, isSecretIfNotExist, descriptionIfNotExist) {
         }
     });
 }
-exports.setVariable = setVariable;
 function databaseUrlFromResource(path) {
     return __awaiter(this, void 0, void 0, function* () {
         const resource = yield getResource(path);
         return `postgresql://${resource.user}:${resource.password}@${resource.host}:${resource.port}/${resource.dbname}?sslmode=${resource.sslmode}`;
     });
 }
-exports.databaseUrlFromResource = databaseUrlFromResource;
 // TODO(gb): need to investigate more how Polars and DuckDB work in TS
 // export async function polarsConnectionSettings(s3_resource_path: string | undefined): Promise<any> {
 //   const workspace = getWorkspace();
@@ -485,7 +627,6 @@ function denoS3LightClientSettings(s3_resource_path) {
         return settings;
     });
 }
-exports.denoS3LightClientSettings = denoS3LightClientSettings;
 /**
  * Load the content of a file stored in S3. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
  *
@@ -525,7 +666,6 @@ function loadS3File(s3object_1) {
         return fileContent;
     });
 }
-exports.loadS3File = loadS3File;
 /**
  * Load the content of a file stored in S3 as a stream. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
  *
@@ -556,7 +696,6 @@ function loadS3FileStream(s3object_1) {
         return fileContentBlob.blob();
     });
 }
-exports.loadS3FileStream = loadS3FileStream;
 /**
  * Persist a file to the S3 bucket. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
  *
@@ -567,7 +706,7 @@ exports.loadS3FileStream = loadS3FileStream;
  * ```
  */
 function writeS3File(s3object_1, fileContent_1) {
-    return __awaiter(this, arguments, void 0, function* (s3object, fileContent, s3ResourcePath = undefined) {
+    return __awaiter(this, arguments, void 0, function* (s3object, fileContent, s3ResourcePath = undefined, contentType = undefined, contentDisposition = undefined) {
         let fileContentBlob;
         if (typeof fileContent === "string") {
             fileContentBlob = new Blob([fileContent], {
@@ -584,13 +723,14 @@ function writeS3File(s3object_1, fileContent_1) {
             s3ResourcePath: s3ResourcePath,
             requestBody: fileContentBlob,
             storage: s3object === null || s3object === void 0 ? void 0 : s3object.storage,
+            contentType,
+            contentDisposition,
         });
         return {
             s3: response.file_key,
         };
     });
 }
-exports.writeS3File = writeS3File;
 /**
  * Get URLs needed for resuming a flow after this step
  * @param approver approver name
@@ -609,14 +749,12 @@ function getResumeUrls(approver) {
         });
     });
 }
-exports.getResumeUrls = getResumeUrls;
 /**
  * @deprecated use getResumeUrls instead
  */
 function getResumeEndpoints(approver) {
     return getResumeUrls(approver);
 }
-exports.getResumeEndpoints = getResumeEndpoints;
 /**
  * Get an OIDC jwt token for auth to external services (e.g: Vault, AWS) (ee only)
  * @param audience audience of the token
@@ -631,11 +769,9 @@ function getIdToken(audience) {
         });
     });
 }
-exports.getIdToken = getIdToken;
 function base64ToUint8Array(data) {
     return Uint8Array.from(atob(data), (c) => c.charCodeAt(0));
 }
-exports.base64ToUint8Array = base64ToUint8Array;
 function uint8ArrayToBase64(arrayBuffer) {
     let base64 = "";
     const encodings = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
@@ -675,7 +811,6 @@ function uint8ArrayToBase64(arrayBuffer) {
     }
     return base64;
 }
-exports.uint8ArrayToBase64 = uint8ArrayToBase64;
 /**
  * Get email from workspace username
  * This method is particularly useful for apps that require the email address of the viewer.
@@ -689,4 +824,107 @@ function usernameToEmail(username) {
         return yield index_1.UserService.usernameToEmail({ username, workspace });
     });
 }
-exports.usernameToEmail = usernameToEmail;
+/**
+ * Sends an interactive approval request via Slack, allowing optional customization of the message, approver, and form fields.
+ *
+ * **[Enterprise Edition Only]** To include form fields in the Slack approval request, go to **Advanced -> Suspend -> Form**
+ * and define a form. Learn more at [Windmill Documentation](https://www.windmill.dev/docs/flows/flow_approval#form).
+ *
+ * @param {Object} options - The configuration options for the Slack approval request.
+ * @param {string} options.slackResourcePath - The path to the Slack resource in Windmill.
+ * @param {string} options.channelId - The Slack channel ID where the approval request will be sent.
+ * @param {string} [options.message] - Optional custom message to include in the Slack approval request.
+ * @param {string} [options.approver] - Optional user ID or name of the approver for the request.
+ * @param {DefaultArgs} [options.defaultArgsJson] - Optional object defining or overriding the default arguments to a form field.
+ * @param {Enums} [options.dynamicEnumsJson] - Optional object overriding the enum default values of an enum form field.
+ *
+ * @returns {Promise<void>} Resolves when the Slack approval request is successfully sent.
+ *
+ * @throws {Error} If the function is not called within a flow or flow preview.
+ * @throws {Error} If the `JobService.getSlackApprovalPayload` call fails.
+ *
+ * **Usage Example:**
+ * ```typescript
+ * await requestInteractiveSlackApproval({
+ *   slackResourcePath: "/u/alex/my_slack_resource",
+ *   channelId: "admins-slack-channel",
+ *   message: "Please approve this request",
+ *   approver: "approver123",
+ *   defaultArgsJson: { key1: "value1", key2: 42 },
+ *   dynamicEnumsJson: { foo: ["choice1", "choice2"], bar: ["optionA", "optionB"] },
+ * });
+ * ```
+ *
+ * **Note:** This function requires execution within a Windmill flow or flow preview.
+ */
+function requestInteractiveSlackApproval(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ slackResourcePath, channelId, message, approver, defaultArgsJson, dynamicEnumsJson, }) {
+        var _b;
+        const workspace = getWorkspace();
+        const flowJobId = getEnv("WM_FLOW_JOB_ID");
+        if (!flowJobId) {
+            throw new Error("You can't use this function in a standalone script or flow step preview. Please use it in a flow or a flow preview.");
+        }
+        const flowStepId = getEnv("WM_FLOW_STEP_ID");
+        if (!flowStepId) {
+            throw new Error("This function can only be called as a flow step");
+        }
+        // Only include non-empty parameters
+        const params = {
+            slackResourcePath,
+            channelId,
+            flowStepId,
+        };
+        if (message) {
+            params.message = message;
+        }
+        if (approver) {
+            params.approver = approver;
+        }
+        if (defaultArgsJson) {
+            params.defaultArgsJson = JSON.stringify(defaultArgsJson);
+        }
+        if (dynamicEnumsJson) {
+            params.dynamicEnumsJson = JSON.stringify(dynamicEnumsJson);
+        }
+        yield index_1.JobService.getSlackApprovalPayload(Object.assign(Object.assign({ workspace }, params), { id: (_b = getEnv("WM_JOB_ID")) !== null && _b !== void 0 ? _b : "NO_JOB_ID" }));
+    });
+}
+function getMockedApi() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const mockedPath = getEnv("WM_MOCKED_API_FILE");
+        if (mockedApi) {
+            return mockedApi;
+        }
+        if (mockedPath) {
+            console.info("Using mocked API from", mockedPath);
+        }
+        const path = getEnv("WM_MOCKED_API_FILE");
+        if (!path) {
+            console.warn("No mocked API file path provided at env variable WM_MOCKED_API_FILE");
+            return undefined;
+        }
+        try {
+            const fs = yield Promise.resolve().then(() => require("node:fs/promises"));
+            const file = yield fs.readFile(path, "utf-8");
+            try {
+                mockedApi = JSON.parse(file);
+                if (!mockedApi.variables) {
+                    mockedApi.variables = {};
+                }
+                if (!mockedApi.resources) {
+                    mockedApi.resources = {};
+                }
+                return mockedApi;
+            }
+            catch (_a) {
+                console.warn("Error parsing mocked API file at path", path);
+                return undefined;
+            }
+        }
+        catch (_b) {
+            console.warn("Error reading mocked API file at path", path);
+            return undefined;
+        }
+    });
+}