windmill-client 1.295.4 → 1.296.0

package/dist/client.d.ts

@@ -55,6 +55,19 @@ export declare function setInternalState(state: any): Promise<void>;
  * @param state state to set
  */
 export declare function setState(state: any): Promise<void>;
+/**
+ * Set a flow user state
+ * @param key key of the state
+ * @param value value of the state
+
+ */
+export declare function setFlowUserState(key: string, value: any, errorIfNotPossible?: boolean): Promise<void>;
+/**
+ * Get a flow user state
+ * @param path path of the variable
+
+ */
+export declare function getFlowUserState(key: string, errorIfNotPossible?: boolean): Promise<void>;
 /**
  * Get the internal state
  * @deprecated use getState instead

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.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.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;
 const index_1 = require("./index");
 const index_2 = require("./index");
 var index_3 = require("./index");
@@ -313,6 +313,62 @@ function setState(state) {
     });
 }
 exports.setState = setState;
+/**
+ * Set a flow user state
+ * @param key key of the state
+ * @param value value of the state
+
+ */
+function setFlowUserState(key, value, errorIfNotPossible) {
+    return __awaiter(this, void 0, void 0, function* () {
+        !clientSet && setClient();
+        const workspace = getWorkspace();
+        try {
+            yield index_1.JobService.setFlowUserState({
+                workspace,
+                id: yield getRootJobId(),
+                key,
+                requestBody: value,
+            });
+        }
+        catch (e) {
+            if (errorIfNotPossible) {
+                throw Error(`Error setting flow user state at ${key}: ${e.body}`);
+            }
+            else {
+                console.error(`Error setting flow user state at ${key}: ${e.body}`);
+            }
+        }
+    });
+}
+exports.setFlowUserState = setFlowUserState;
+/**
+ * Get a flow user state
+ * @param path path of the variable
+
+ */
+function getFlowUserState(key, errorIfNotPossible) {
+    return __awaiter(this, void 0, void 0, function* () {
+        !clientSet && setClient();
+        const workspace = getWorkspace();
+        try {
+            yield index_1.JobService.getFlowUserState({
+                workspace,
+                id: yield getRootJobId(),
+                key,
+            });
+        }
+        catch (e) {
+            if (errorIfNotPossible) {
+                throw Error(`Error setting flow user state at ${key}: ${e.body}`);
+            }
+            else {
+                console.error(`Error setting flow user state at ${key}: ${e.body}`);
+            }
+        }
+    });
+}
+exports.getFlowUserState = getFlowUserState;
 // /**
 //  * Set the shared state
 //  * @param state state to set

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.295.4',
+    VERSION: '1.296.0',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/dist/index.d.ts

@@ -177,4 +177,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, task, runScript, runScriptAsync, waitJob, getRootJobId } from "./client";
+export { type Base64, setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, getState, getIdToken, denoS3LightClientSettings, loadS3FileStream, loadS3File, writeS3File, task, runScript, runScriptAsync, waitJob, getRootJobId, setFlowUserState, getFlowUserState } 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.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;
+exports.getFlowUserState = exports.setFlowUserState = 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 not edit */
 /* istanbul ignore file */
 /* tslint:disable */
@@ -128,3 +128,5 @@ Object.defineProperty(exports, "runScript", { enumerable: true, get: function ()
 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; } });
+Object.defineProperty(exports, "setFlowUserState", { enumerable: true, get: function () { return client_1.setFlowUserState; } });
+Object.defineProperty(exports, "getFlowUserState", { enumerable: true, get: function () { return client_1.getFlowUserState; } });

package/dist/services/JobService.d.ts

@@ -923,6 +923,30 @@ export declare class JobService {
         requestBody: Record<string, any>;
         approver?: string;
     }): CancelablePromise<string>;
+    /**
+     * set flow user state at a given key
+     * @returns string flow user state updated
+     * @throws ApiError
+     */
+    static setFlowUserState({ workspace, id, key, requestBody, }: {
+        workspace: string;
+        id: string;
+        key: string;
+        /**
+         * new value
+         */
+        requestBody: any;
+    }): CancelablePromise<string>;
+    /**
+     * get flow user state at a given key
+     * @returns any flow user state updated
+     * @throws ApiError
+     */
+    static getFlowUserState({ workspace, id, key, }: {
+        workspace: string;
+        id: string;
+        key: string;
+    }): CancelablePromise<any>;
     /**
      * resume a job for a suspended flow as an owner
      * @returns string job resumed

package/dist/services/JobService.js

@@ -752,6 +752,40 @@ class JobService {
             mediaType: 'application/json',
         });
     }
+    /**
+     * set flow user state at a given key
+     * @returns string flow user state updated
+     * @throws ApiError
+     */
+    static setFlowUserState({ workspace, id, key, requestBody, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/w/{workspace}/jobs/flow/user_states/{id}/{key}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'key': key,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * get flow user state at a given key
+     * @returns any flow user state updated
+     * @throws ApiError
+     */
+    static getFlowUserState({ workspace, id, key, }) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/w/{workspace}/jobs/flow/user_states/{id}/{key}',
+            path: {
+                'workspace': workspace,
+                'id': id,
+                'key': key,
+            },
+        });
+    }
     /**
      * resume a job for a suspended flow as an owner
      * @returns string job resumed

package/package.json

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