windmill-client 1.591.4 → 1.592.0

package/dist/client.d.ts

@@ -7,6 +7,11 @@ export type Email = string;
 export type Base64 = string;
 export type Resource<S extends string> = any;
 export declare const SHARED_FOLDER = "/shared";
+/**
+ * Initialize the Windmill client with authentication token and base URL
+ * @param token - Authentication token (defaults to WM_TOKEN env variable)
+ * @param baseUrl - API base URL (defaults to BASE_INTERNAL_URL or BASE_URL env variable)
+ */
 export declare function setClient(token?: string, baseUrl?: string): void;
 /**
  * Create a client configuration from env variables
@@ -30,7 +35,21 @@ export declare function getRootJobId(jobId?: string): Promise<string>;
  * @deprecated Use runScriptByPath or runScriptByHash instead
  */
 export declare function runScript(path?: string | null, hash_?: string | null, args?: Record<string, any> | null, verbose?: boolean): Promise<any>;
+/**
+ * Run a script synchronously by its path and wait for the result
+ * @param path - Script path in Windmill
+ * @param args - Arguments to pass to the script
+ * @param verbose - Enable verbose logging
+ * @returns Script execution result
+ */
 export declare function runScriptByPath(path: string, args?: Record<string, any> | null, verbose?: boolean): Promise<any>;
+/**
+ * Run a script synchronously by its hash and wait for the result
+ * @param hash_ - Script hash in Windmill
+ * @param args - Arguments to pass to the script
+ * @param verbose - Enable verbose logging
+ * @returns Script execution result
+ */
 export declare function runScriptByHash(hash_: string, args?: Record<string, any> | null, verbose?: boolean): Promise<any>;
 /**
  * Append a text to the result stream
@@ -42,17 +61,67 @@ export declare function appendToResultStream(text: string): void;
  * @param stream stream to stream to the result stream
  */
 export declare function streamResult(stream: AsyncIterable<string>): Promise<void>;
+/**
+ * Run a flow synchronously by its path and wait for the result
+ * @param path - Flow path in Windmill
+ * @param args - Arguments to pass to the flow
+ * @param verbose - Enable verbose logging
+ * @returns Flow execution result
+ */
 export declare function runFlow(path?: string | null, args?: Record<string, any> | null, verbose?: boolean): Promise<any>;
+/**
+ * Wait for a job to complete and return its result
+ * @param jobId - ID of the job to wait for
+ * @param verbose - Enable verbose logging
+ * @returns Job result when completed
+ */
 export declare function waitJob(jobId: string, verbose?: boolean): Promise<any>;
+/**
+ * Get the result of a completed job
+ * @param jobId - ID of the completed job
+ * @returns Job result
+ */
 export declare function getResult(jobId: string): Promise<any>;
+/**
+ * Get the result of a job if completed, or its current status
+ * @param jobId - ID of the job
+ * @returns Object with started, completed, success, and result properties
+ */
 export declare function getResultMaybe(jobId: string): Promise<any>;
+/**
+ * Wrap a function to execute as a Windmill task within a flow context
+ * @param f - Function to wrap as a task
+ * @returns Async wrapper function that executes as a Windmill job
+ */
 export declare function task<P, T>(f: (_: P) => T): (_: P) => Promise<T>;
 /**
  * @deprecated Use runScriptByPathAsync or runScriptByHashAsync instead
  */
 export declare function runScriptAsync(path: string | null, hash_: string | null, args: Record<string, any> | null, scheduledInSeconds?: number | null): Promise<string>;
+/**
+ * Run a script asynchronously by its path
+ * @param path - Script path in Windmill
+ * @param args - Arguments to pass to the script
+ * @param scheduledInSeconds - Schedule execution for a future time (in seconds)
+ * @returns Job ID of the created job
+ */
 export declare function runScriptByPathAsync(path: string, args?: Record<string, any> | null, scheduledInSeconds?: number | null): Promise<string>;
+/**
+ * Run a script asynchronously by its hash
+ * @param hash_ - Script hash in Windmill
+ * @param args - Arguments to pass to the script
+ * @param scheduledInSeconds - Schedule execution for a future time (in seconds)
+ * @returns Job ID of the created job
+ */
 export declare function runScriptByHashAsync(hash_: string, args?: Record<string, any> | null, scheduledInSeconds?: number | null): Promise<string>;
+/**
+ * Run a flow asynchronously by its path
+ * @param path - Flow path in Windmill
+ * @param args - Arguments to pass to the flow
+ * @param scheduledInSeconds - Schedule execution for a future time (in seconds)
+ * @param doNotTrackInParent - If false, tracks state in parent job (only use when fully awaiting the job)
+ * @returns Job ID of the created job
+ */
 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
@@ -60,6 +129,10 @@ export declare function runFlowAsync(path: string | null, args: Record<string, a
  * @returns resource value
  */
 export declare function resolveDefaultResource(obj: any): Promise<any>;
+/**
+ * Get the state file path from environment variables
+ * @returns State path string
+ */
 export declare function getStatePath(): string;
 /**
  * Set a resource value by path
@@ -128,7 +201,17 @@ export declare function getVariable(path: string): Promise<string>;
  * @param descriptionIfNotExist if the variable does not exist, create it with this description (default: "")
  */
 export declare function setVariable(path: string, value: string, isSecretIfNotExist?: boolean, descriptionIfNotExist?: string): Promise<void>;
+/**
+ * Build a PostgreSQL connection URL from a database resource
+ * @param path - Path to the database resource
+ * @returns PostgreSQL connection URL string
+ */
 export declare function databaseUrlFromResource(path: string): Promise<string>;
+/**
+ * Get S3 client settings from a resource or workspace default
+ * @param s3_resource_path - Path to S3 resource (uses workspace default if undefined)
+ * @returns S3 client configuration settings
+ */
 export declare function denoS3LightClientSettings(s3_resource_path: string | undefined): Promise<DenoS3LightClientSettings>;
 /**
  * Load the content of a file stored in S3. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
@@ -215,7 +298,17 @@ export declare function getResumeEndpoints(approver?: string): Promise<{
  * @returns jwt token
  */
 export declare function getIdToken(audience: string, expiresIn?: number): Promise<string>;
+/**
+ * Convert a base64-encoded string to Uint8Array
+ * @param data - Base64-encoded string
+ * @returns Decoded Uint8Array
+ */
 export declare function base64ToUint8Array(data: string): Uint8Array;
+/**
+ * Convert a Uint8Array to base64-encoded string
+ * @param arrayBuffer - Uint8Array to encode
+ * @returns Base64-encoded string
+ */
 export declare function uint8ArrayToBase64(arrayBuffer: Uint8Array): string;
 /**
  * Get email from workspace username
@@ -309,4 +402,9 @@ export declare function requestInteractiveSlackApproval({ slackResourcePath, cha
  * **Note:** This function requires execution within a Windmill flow or flow preview.
  */
 export declare function requestInteractiveTeamsApproval({ teamName, channelName, message, approver, defaultArgsJson, dynamicEnumsJson, }: TeamsApprovalOptions): Promise<void>;
+/**
+ * Parse an S3 object from URI string or record format
+ * @param s3Object - S3 object as URI string (s3://storage/key) or record
+ * @returns S3 object record with storage and s3 key
+ */
 export declare function parseS3Object(s3Object: S3Object): S3ObjectRecord;

package/dist/client.js

@@ -88,6 +88,11 @@ Object.defineProperty(exports, "WorkspaceService", { enumerable: true, get: func
 Object.defineProperty(exports, "TeamsService", { enumerable: true, get: function () { return index_3.TeamsService; } });
 exports.SHARED_FOLDER = "/shared";
 let mockedApi = undefined;
+/**
+ * Initialize the Windmill client with authentication token and base URL
+ * @param token - Authentication token (defaults to WM_TOKEN env variable)
+ * @param baseUrl - API base URL (defaults to BASE_INTERNAL_URL or BASE_URL env variable)
+ */
 function setClient(token, baseUrl) {
     var _a, _b, _c;
     if (baseUrl === undefined) {
@@ -200,11 +205,25 @@ function _runScriptInternal() {
         return yield waitJob(jobId, verbose);
     });
 }
+/**
+ * Run a script synchronously by its path and wait for the result
+ * @param path - Script path in Windmill
+ * @param args - Arguments to pass to the script
+ * @param verbose - Enable verbose logging
+ * @returns Script execution result
+ */
 function runScriptByPath(path_1) {
     return __awaiter(this, arguments, void 0, function* (path, args = null, verbose = false) {
         return _runScriptInternal(path, null, args, verbose);
     });
 }
+/**
+ * Run a script synchronously by its hash and wait for the result
+ * @param hash_ - Script hash in Windmill
+ * @param args - Arguments to pass to the script
+ * @param verbose - Enable verbose logging
+ * @returns Script execution result
+ */
 function runScriptByHash(hash_1) {
     return __awaiter(this, arguments, void 0, function* (hash_, args = null, verbose = false) {
         return _runScriptInternal(null, hash_, args, verbose);
@@ -242,6 +261,13 @@ function streamResult(stream) {
         }
     });
 }
+/**
+ * Run a flow synchronously by its path and wait for the result
+ * @param path - Flow path in Windmill
+ * @param args - Arguments to pass to the flow
+ * @param verbose - Enable verbose logging
+ * @returns Flow execution result
+ */
 function runFlow() {
     return __awaiter(this, arguments, void 0, function* (path = null, args = null, verbose = false) {
         args = args || {};
@@ -252,6 +278,12 @@ function runFlow() {
         return yield waitJob(jobId, verbose);
     });
 }
+/**
+ * Wait for a job to complete and return its result
+ * @param jobId - ID of the job to wait for
+ * @param verbose - Enable verbose logging
+ * @returns Job result when completed
+ */
 function waitJob(jobId_1) {
     return __awaiter(this, arguments, void 0, function* (jobId, verbose = false) {
         while (true) {
@@ -280,12 +312,22 @@ function waitJob(jobId_1) {
         }
     });
 }
+/**
+ * Get the result of a completed job
+ * @param jobId - ID of the completed job
+ * @returns Job result
+ */
 function getResult(jobId) {
     return __awaiter(this, void 0, void 0, function* () {
         const workspace = getWorkspace();
         return yield index_1.JobService.getCompletedJobResult({ workspace, id: jobId });
     });
 }
+/**
+ * Get the result of a job if completed, or its current status
+ * @param jobId - ID of the job
+ * @returns Object with started, completed, success, and result properties
+ */
 function getResultMaybe(jobId) {
     return __awaiter(this, void 0, void 0, function* () {
         const workspace = getWorkspace();
@@ -303,6 +345,11 @@ function getParamNames(func) {
         result = [];
     return result;
 }
+/**
+ * Wrap a function to execute as a Windmill task within a flow context
+ * @param f - Function to wrap as a task
+ * @returns Async wrapper function that executes as a Windmill job
+ */
 function task(f) {
     return (...y) => __awaiter(this, void 0, void 0, function* () {
         const args = {};
@@ -374,16 +421,38 @@ function _runScriptAsyncInternal() {
         }).then((res) => res.text());
     });
 }
+/**
+ * Run a script asynchronously by its path
+ * @param path - Script path in Windmill
+ * @param args - Arguments to pass to the script
+ * @param scheduledInSeconds - Schedule execution for a future time (in seconds)
+ * @returns Job ID of the created job
+ */
 function runScriptByPathAsync(path_1) {
     return __awaiter(this, arguments, void 0, function* (path, args = null, scheduledInSeconds = null) {
         return _runScriptAsyncInternal(path, null, args, scheduledInSeconds);
     });
 }
+/**
+ * Run a script asynchronously by its hash
+ * @param hash_ - Script hash in Windmill
+ * @param args - Arguments to pass to the script
+ * @param scheduledInSeconds - Schedule execution for a future time (in seconds)
+ * @returns Job ID of the created job
+ */
 function runScriptByHashAsync(hash_1) {
     return __awaiter(this, arguments, void 0, function* (hash_, args = null, scheduledInSeconds = null) {
         return _runScriptAsyncInternal(null, hash_, args, scheduledInSeconds);
     });
 }
+/**
+ * Run a flow asynchronously by its path
+ * @param path - Flow path in Windmill
+ * @param args - Arguments to pass to the flow
+ * @param scheduledInSeconds - Schedule execution for a future time (in seconds)
+ * @param doNotTrackInParent - If false, tracks state in parent job (only use when fully awaiting the job)
+ * @returns Job ID of the created job
+ */
 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
@@ -440,6 +509,10 @@ function resolveDefaultResource(obj) {
         }
     });
 }
+/**
+ * Get the state file path from environment variables
+ * @returns State path string
+ */
 function getStatePath() {
     var _a;
     const state_path = (_a = getEnv("WM_STATE_PATH_NEW")) !== null && _a !== void 0 ? _a : getEnv("WM_STATE_PATH");
@@ -603,23 +676,6 @@ function getFlowUserState(key, errorIfNotPossible) {
         }
     });
 }
-// /**
-//  * Set the shared state
-//  * @param state state to set
-//  */
-// export async function setSharedState(
-//   state: any,
-//   path = "state.json"
-// ): Promise<void> {
-//   await Deno.writeTextFile(SHARED_FOLDER + "/" + path, JSON.stringify(state));
-// }
-// /**
-//  * Get the shared state
-//  * @param state state to set
-//  */
-// export async function getSharedState(path = "state.json"): Promise<any> {
-//   return JSON.parse(await Deno.readTextFile(SHARED_FOLDER + "/" + path));
-// }
 /**
  * Get the internal state
  * @deprecated use getState instead
@@ -701,6 +757,11 @@ function setVariable(path, value, isSecretIfNotExist, descriptionIfNotExist) {
         }
     });
 }
+/**
+ * Build a PostgreSQL connection URL from a database resource
+ * @param path - Path to the database resource
+ * @returns PostgreSQL connection URL string
+ */
 function databaseUrlFromResource(path) {
     return __awaiter(this, void 0, void 0, function* () {
         const resource = yield getResource(path);
@@ -726,6 +787,11 @@ function databaseUrlFromResource(path) {
 // 		}
 //   });
 // }
+/**
+ * Get S3 client settings from a resource or workspace default
+ * @param s3_resource_path - Path to S3 resource (uses workspace default if undefined)
+ * @returns S3 client configuration settings
+ */
 function denoS3LightClientSettings(s3_resource_path) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
@@ -959,9 +1025,19 @@ function getIdToken(audience, expiresIn) {
         });
     });
 }
+/**
+ * Convert a base64-encoded string to Uint8Array
+ * @param data - Base64-encoded string
+ * @returns Decoded Uint8Array
+ */
 function base64ToUint8Array(data) {
     return Uint8Array.from(atob(data), (c) => c.charCodeAt(0));
 }
+/**
+ * Convert a Uint8Array to base64-encoded string
+ * @param arrayBuffer - Uint8Array to encode
+ * @returns Base64-encoded string
+ */
 function uint8ArrayToBase64(arrayBuffer) {
     let base64 = "";
     const encodings = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
@@ -1194,6 +1270,11 @@ function parseResourceSyntax(s) {
     if (s === null || s === void 0 ? void 0 : s.startsWith("res://"))
         return s.substring(6);
 }
+/**
+ * Parse an S3 object from URI string or record format
+ * @param s3Object - S3 object as URI string (s3://storage/key) or record
+ * @returns S3 object record with storage and s3 key
+ */
 function parseS3Object(s3Object) {
     var _a;
     if (typeof s3Object === "object")

package/dist/core/OpenAPI.js

@@ -39,7 +39,7 @@ exports.OpenAPI = {
     PASSWORD: undefined,
     TOKEN: getEnv("WM_TOKEN"),
     USERNAME: undefined,
-    VERSION: '1.591.4',
+    VERSION: '1.592.0',
     WITH_CREDENTIALS: true,
     interceptors: {
         request: new Interceptors(),

package/dist/s3Types.d.ts

@@ -1,16 +1,38 @@
+/**
+ * S3 object representation, either as a URI string or a record object
+ */
 export type S3Object = S3ObjectURI | S3ObjectRecord;
+/**
+ * S3 object URI in the format `s3://storage/key`
+ */
 export type S3ObjectURI = `s3://${string}/${string}`;
+/**
+ * S3 object record with file key, optional storage identifier, and optional presigned token
+ */
 export type S3ObjectRecord = {
+    /** File key/path in S3 bucket */
     s3: string;
+    /** Storage backend identifier */
     storage?: string;
+    /** Presigned URL query string for public access */
     presigned?: string;
 };
+/**
+ * S3 client configuration settings for Deno S3 light client
+ */
 export type DenoS3LightClientSettings = {
+    /** S3 endpoint URL */
     endPoint: string;
+    /** AWS region */
     region: string;
+    /** Bucket name */
     bucket?: string;
+    /** Use HTTPS connection */
     useSSL?: boolean;
+    /** AWS access key */
     accessKey?: string;
+    /** AWS secret key */
     secretKey?: string;
+    /** Use path-style URLs instead of virtual-hosted style */
     pathStyle?: boolean;
 };

package/dist/sqlUtils.d.ts

@@ -3,16 +3,37 @@ type FetchParams<ResultCollectionT extends ResultCollection> = {
     resultCollection?: ResultCollectionT;
 };
 type SqlResult<ResultCollectionT extends ResultCollection> = ResultCollectionT extends "last_statement_first_row" ? object : ResultCollectionT extends "all_statements_first_row" ? object[] : ResultCollectionT extends "last_statement_all_rows" ? object[] : ResultCollectionT extends "all_statements_all_rows" ? object[][] : ResultCollectionT extends "last_statement_all_rows_scalar" ? any[] : ResultCollectionT extends "all_statements_all_rows_scalar" ? any[][] : ResultCollectionT extends "last_statement_first_row_scalar" ? any : ResultCollectionT extends "all_statements_first_row_scalar" ? any[] : unknown;
+/**
+ * SQL statement object with query content, arguments, and execution methods
+ */
 export type SqlStatement = {
+    /** Raw SQL content with formatted arguments */
     content: string;
+    /** Argument values keyed by parameter name */
     args: Record<string, any>;
+    /**
+     * Execute the SQL query and return results
+     * @param params - Optional parameters including result collection mode
+     * @returns Query results based on the result collection mode
+     */
     fetch<ResultCollectionT extends ResultCollection = "last_statement_all_rows">(params?: FetchParams<ResultCollectionT | ResultCollection>): Promise<SqlResult<ResultCollectionT>>;
+    /**
+     * Execute the SQL query and return only the first row
+     * @param params - Optional parameters
+     * @returns First row of the query result
+     */
     fetchOne(params?: Omit<FetchParams<"last_statement_first_row">, "resultCollection">): Promise<SqlResult<"last_statement_first_row">>;
 };
+/**
+ * Template tag function for creating SQL statements with parameterized values
+ */
 export interface SqlTemplateFunction {
     (strings: TemplateStringsArray, ...values: any[]): SqlStatement;
 }
 /**
+ * Create a SQL template function for PostgreSQL/datatable queries
+ * @param name - Database/datatable name (default: "main")
+ * @returns SQL template function for building parameterized queries
  * @example
  * let sql = wmill.datatable()
  * let name = 'Robin'
@@ -24,6 +45,9 @@ export interface SqlTemplateFunction {
  */
 export declare function datatable(name?: string): SqlTemplateFunction;
 /**
+ * Create a SQL template function for DuckDB/ducklake queries
+ * @param name - DuckDB database name (default: "main")
+ * @returns SQL template function for building parameterized queries
  * @example
  * let sql = wmill.ducklake()
  * let name = 'Robin'

package/dist/sqlUtils.js

@@ -13,6 +13,9 @@ exports.datatable = datatable;
 exports.ducklake = ducklake;
 const client_1 = require("./client");
 /**
+ * Create a SQL template function for PostgreSQL/datatable queries
+ * @param name - Database/datatable name (default: "main")
+ * @returns SQL template function for building parameterized queries
  * @example
  * let sql = wmill.datatable()
  * let name = 'Robin'
@@ -26,6 +29,9 @@ function datatable(name = "main") {
     return sqlProviderImpl(name, "datatable");
 }
 /**
+ * Create a SQL template function for DuckDB/ducklake queries
+ * @param name - DuckDB database name (default: "main")
+ * @returns SQL template function for building parameterized queries
  * @example
  * let sql = wmill.ducklake()
  * let name = 'Robin'

package/package.json

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