windmill-client 1.285.4 → 1.286.1

package/dist/client.d.ts

@@ -24,6 +24,12 @@ export declare function getResource(path?: string, undefinedIfEmpty?: boolean):
  * @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 waitJob(jobId: string, verbose?: boolean, assertResultIsNotNull?: 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>;
 /**
  * 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`

package/dist/client.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.setState = exports.setInternalState = exports.setResource = exports.getStatePath = exports.resolveDefaultResource = 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.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.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;
 const index_1 = require("./index");
 const index_2 = require("./index");
 var index_3 = require("./index");
@@ -105,6 +105,140 @@ function getRootJobId(jobId) {
     });
 }
 exports.getRootJobId = getRootJobId;
+function runScript(path = null, hash_ = null, args = null, verbose = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        args = args || {};
+        if (verbose) {
+            console.info(`running \`${path}\` synchronously with args:`, args);
+        }
+        const jobId = yield runScriptAsync(path, hash_, args);
+        return yield waitJob(jobId, verbose);
+    });
+}
+exports.runScript = runScript;
+function waitJob(jobId, verbose = false, assertResultIsNotNull = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        while (true) {
+            // Implement your HTTP request logic here to get job result
+            const resultRes = yield getResult(jobId);
+            const started = resultRes.started;
+            const completed = resultRes.completed;
+            const success = resultRes.success;
+            if (!started && verbose) {
+                console.info(`job ${jobId} has not started yet`);
+            }
+            if (completed) {
+                const result = resultRes.result;
+                if (success) {
+                    if (result === null && assertResultIsNotNull) {
+                        throw new Error("Result was null");
+                    }
+                    return result;
+                }
+                else {
+                    const error = result.error;
+                    throw new Error(`Job ${jobId} was not successful: ${error}`);
+                }
+            }
+            if (verbose) {
+                console.info(`sleeping 0.5 seconds for jobId: ${jobId}`);
+            }
+            yield new Promise((resolve) => setTimeout(resolve, 500));
+        }
+    });
+}
+exports.waitJob = waitJob;
+function getResult(jobId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        !clientSet && setClient();
+        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* () {
+        !clientSet && setClient();
+        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) {
+    const fnStr = func.toString().replace(STRIP_COMMENTS, "");
+    let result = fnStr
+        .slice(fnStr.indexOf("(") + 1, fnStr.indexOf(")"))
+        .match(ARGUMENT_NAMES);
+    if (result === null)
+        result = [];
+    return result;
+}
+function task(f) {
+    !clientSet && setClient();
+    return (...y) => __awaiter(this, void 0, void 0, function* () {
+        const args = {};
+        const paramNames = getParamNames(f);
+        y.forEach((x, i) => (args[paramNames[i]] = x));
+        let req = yield fetch(`${index_2.OpenAPI.BASE}/w/${getWorkspace()}/jobs/run/workflow_as_code/${getEnv("WM_JOB_ID")}/${f.name}`, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${getEnv("WM_TOKEN")}`,
+            },
+            body: JSON.stringify({ args }),
+        });
+        let jobId = yield req.text();
+        return yield waitJob(jobId);
+    });
+}
+exports.task = task;
+function runScriptAsync(path, hash_, args, scheduledInSeconds = null) {
+    return __awaiter(this, void 0, void 0, function* () {
+        !clientSet && setClient();
+        // Create a script job and return its job id.
+        if (path && hash_) {
+            throw new Error("path and hash_ are mutually exclusive");
+        }
+        args = args || {};
+        const params = {};
+        if (scheduledInSeconds) {
+            params["scheduled_in_secs"] = scheduledInSeconds;
+        }
+        let parentJobId = getEnv("WM_JOB_ID");
+        if (parentJobId !== undefined) {
+            params["parent_job"] = parentJobId;
+        }
+        let rootJobId = getEnv("WM_ROOT_FLOW_JOB_ID");
+        if (rootJobId != undefined) {
+            params["root_job"] = rootJobId;
+        }
+        let endpoint;
+        if (path) {
+            endpoint = `/w/${getWorkspace()}/jobs/run/p/${path}`;
+        }
+        else if (hash_) {
+            endpoint = `/w/${getWorkspace()}/jobs/run/h/${hash_}`;
+        }
+        else {
+            throw new Error("path or hash_ 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.json())
+            .then((data) => data.id);
+    });
+}
+exports.runScriptAsync = runScriptAsync;
 /**
  * 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`

package/dist/core/OpenAPI.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAPI = void 0;
 exports.OpenAPI = {
     BASE: '/api',
-    VERSION: '1.285.4',
+    VERSION: '1.286.1',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/dist/index.d.ts

@@ -176,4 +176,4 @@ export { VariableService } from './services/VariableService';
 export { WorkerService } from './services/WorkerService';
 export { WorkspaceService } from './services/WorkspaceService';
 export type { S3Object, DenoS3LightClientSettings } from "./s3Types";
-export { type Base64, setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, getState, getIdToken, denoS3LightClientSettings, loadS3FileStream, loadS3File, writeS3File } from "./client";
+export { type Base64, setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, getState, getIdToken, denoS3LightClientSettings, loadS3FileStream, loadS3File, writeS3File, task, runScript, runScriptAsync, waitJob, getRootJobId } from "./client";

package/dist/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VariableService = exports.UserService = exports.SettingsService = exports.SettingService = exports.ScriptService = exports.ScheduleService = exports.ResourceService = exports.RawAppService = exports.OidcService = exports.OauthService = exports.MetricsService = exports.JobService = exports.IntegrationService = exports.InputService = exports.HelpersService = exports.GroupService = exports.GranularAclService = exports.FolderService = exports.FlowService = exports.FavoriteService = exports.DraftService = exports.ConfigService = exports.ConcurrencyGroupsService = exports.CaptureService = exports.AuditService = exports.AppService = exports.AdminService = exports.WindmillFilePreview = exports.Script = exports.RunnableType = exports.RawScriptForDependencies = exports.RawScript = exports.QueuedJob = exports.Preview = exports.Policy = exports.NewScript = exports.MainArgSignature = exports.ListableApp = exports.LargeFileStorage = exports.Job = exports.GlobalUserInfo = exports.FlowStatusModule = exports.CompletedJob = exports.AuditLog = exports.AppWithLastVersion = exports.ActionKind = exports.OpenAPI = exports.CancelError = exports.CancelablePromise = exports.ApiError = void 0;
-exports.writeS3File = exports.loadS3File = exports.loadS3FileStream = exports.denoS3LightClientSettings = exports.getIdToken = exports.getState = exports.setState = exports.getResumeUrls = exports.setResource = exports.getResource = exports.setVariable = exports.getVariable = exports.setClient = exports.WorkspaceService = exports.WorkerService = void 0;
+exports.getRootJobId = exports.waitJob = exports.runScriptAsync = exports.runScript = exports.task = exports.writeS3File = exports.loadS3File = exports.loadS3FileStream = exports.denoS3LightClientSettings = exports.getIdToken = exports.getState = exports.setState = exports.getResumeUrls = exports.setResource = exports.getResource = exports.setVariable = exports.getVariable = exports.setClient = exports.WorkspaceService = exports.WorkerService = void 0;
 /* generated using openapi-typescript-codegen -- do no edit */
 /* istanbul ignore file */
 /* tslint:disable */
@@ -123,3 +123,8 @@ Object.defineProperty(exports, "denoS3LightClientSettings", { enumerable: true,
 Object.defineProperty(exports, "loadS3FileStream", { enumerable: true, get: function () { return client_1.loadS3FileStream; } });
 Object.defineProperty(exports, "loadS3File", { enumerable: true, get: function () { return client_1.loadS3File; } });
 Object.defineProperty(exports, "writeS3File", { enumerable: true, get: function () { return client_1.writeS3File; } });
+Object.defineProperty(exports, "task", { enumerable: true, get: function () { return client_1.task; } });
+Object.defineProperty(exports, "runScript", { enumerable: true, get: function () { return client_1.runScript; } });
+Object.defineProperty(exports, "runScriptAsync", { enumerable: true, get: function () { return client_1.runScriptAsync; } });
+Object.defineProperty(exports, "waitJob", { enumerable: true, get: function () { return client_1.waitJob; } });
+Object.defineProperty(exports, "getRootJobId", { enumerable: true, get: function () { return client_1.getRootJobId; } });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "windmill-client",
   "description": "Windmill SDK client for browsers and Node.js",
-  "version": "1.285.4",
+  "version": "1.286.1",
   "author": "Ruben Fiszel",
   "license": "Apache 2.0",
   "devDependencies": {