windmill-client 1.258.4 → 1.259.1

package/dist/client.d.ts

@@ -72,7 +72,7 @@ export declare function denoS3LightClientSettings(s3_resource_path: string | und
  * Load the content of a file stored in S3. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
  *
  * ```typescript
- * let fileContent = await wmill.loadS3File(inputFile)
+ * let fileContent = await wmill.loadS3FileContent(inputFile)
  * // if the file is a raw text file, it can be decoded and printed directly:
  * const text = new TextDecoder().decode(fileContentStream)
  * console.log(text);
@@ -83,24 +83,12 @@ export declare function loadS3File(s3object: S3Object, s3ResourcePath: string |
  * 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.
  *
  * ```typescript
- * let fileContentStream = await wmill.loadS3FileStream(inputFile)
- * // Use a read to read the stream:
- * const chunks: Uint8Array[] = [];
- * const reader = fileContentStream.getReader()
- * while (true) {
- *   const {value, done} = await reader.read();
- *   if (done) {
- *     break;
- *   }
- *   chunks.push(chunk);
- * }
- * // then the chunks can be concatenated into a single Uint8Array and if the
- * // file is a raw text file, it can be decoded and printed directly:
- * const text = new TextDecoder().decode(fileContent)
- * console.log(text);
+ * let fileContentBlob = await wmill.loadS3FileStream(inputFile)
+ * // if the content is plain text, the blob can be read directly:
+ * console.log(await fileContentBlob.text());
  * ```
  */
-export declare function loadS3FileStream(s3object: S3Object, s3ResourcePath: string | undefined): Promise<ReadableStream | undefined>;
+export declare function loadS3FileStream(s3object: S3Object, s3ResourcePath: string | undefined): Promise<Blob | undefined>;
 /**
  * Persist a file to the S3 bucket. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
  *
@@ -110,7 +98,7 @@ export declare function loadS3FileStream(s3object: S3Object, s3ResourcePath: str
  * console.log(fileContentAsUtf8Str)
  * ```
  */
-export declare function writeS3File(s3object: S3Object | undefined, fileContent: string | ReadableStream<Uint8Array>, fileExpiration: Date | undefined, s3ResourcePath: string | undefined): Promise<S3Object>;
+export declare function writeS3File(s3object: S3Object | undefined, fileContent: string | Blob, s3ResourcePath: string | undefined): Promise<S3Object>;
 /**
  * Get URLs needed for resuming a flow after this step
  * @param approver approver name

package/dist/client.js

@@ -295,7 +295,7 @@ 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.
  *
  * ```typescript
- * let fileContent = await wmill.loadS3File(inputFile)
+ * let fileContent = await wmill.loadS3FileContent(inputFile)
  * // if the file is a raw text file, it can be decoded and printed directly:
  * const text = new TextDecoder().decode(fileContentStream)
  * console.log(text);
@@ -304,12 +304,12 @@ exports.denoS3LightClientSettings = denoS3LightClientSettings;
 function loadS3File(s3object, s3ResourcePath) {
     return __awaiter(this, void 0, void 0, function* () {
         !clientSet && setClient();
-        const fileContentStream = yield loadS3FileStream(s3object, s3ResourcePath);
-        if (fileContentStream === undefined) {
+        const fileContentBlob = yield loadS3FileStream(s3object, s3ResourcePath);
+        if (fileContentBlob === undefined) {
             return undefined;
         }
         // we read the stream until completion and put the content in an Uint8Array
-        const reader = fileContentStream.getReader();
+        const reader = fileContentBlob.stream().getReader();
         const chunks = [];
         while (true) {
             const { value: chunk, done } = yield reader.read();
@@ -336,65 +336,28 @@ 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.
  *
  * ```typescript
- * let fileContentStream = await wmill.loadS3FileStream(inputFile)
- * // Use a read to read the stream:
- * const chunks: Uint8Array[] = [];
- * const reader = fileContentStream.getReader()
- * while (true) {
- *   const {value, done} = await reader.read();
- *   if (done) {
- *     break;
- *   }
- *   chunks.push(chunk);
- * }
- * // then the chunks can be concatenated into a single Uint8Array and if the
- * // file is a raw text file, it can be decoded and printed directly:
- * const text = new TextDecoder().decode(fileContent)
- * console.log(text);
+ * let fileContentBlob = await wmill.loadS3FileStream(inputFile)
+ * // if the content is plain text, the blob can be read directly:
+ * console.log(await fileContentBlob.text());
  * ```
  */
 function loadS3FileStream(s3object, s3ResourcePath) {
     return __awaiter(this, void 0, void 0, function* () {
         !clientSet && setClient();
-        let part_number = 0;
-        let file_total_size = undefined;
-        let fetch = function (controller) {
-            return __awaiter(this, void 0, void 0, function* () {
-                // console.log("fetching part", part_number)
-                if (part_number === undefined || part_number === null) {
-                    // console.log("finished, closing")
-                    controller.close();
-                    return;
-                }
-                let part_response = yield index_1.HelpersService.multipartFileDownload({
-                    workspace: getWorkspace(),
-                    requestBody: {
-                        file_key: s3object.s3,
-                        part_number: part_number,
-                        file_size: file_total_size,
-                        s3_resource_path: s3ResourcePath,
-                    }
-                });
-                if (part_response.part_content.length > 0) {
-                    // console.log("enqueueing part", part_number, part_response.part_content.length)
-                    let chunk = new Uint8Array(part_response.part_content.length);
-                    part_response.part_content.forEach((value, index) => {
-                        chunk[index] = value;
-                    });
-                    controller.enqueue(chunk);
-                }
-                part_number = part_response.next_part_number;
-                file_total_size = part_response.file_size;
-            });
-        };
-        let fileContentStream = new ReadableStream({
-            pull(controller) {
-                return __awaiter(this, void 0, void 0, function* () {
-                    yield fetch(controller);
-                });
-            }
+        let params = {};
+        params["file_key"] = s3object.s3;
+        if (s3ResourcePath !== undefined) {
+            params["s3_resource_path"] = s3ResourcePath;
+        }
+        const queryParams = new URLSearchParams(params);
+        // We use raw fetch here b/c OpenAPI generated client doesn't handle Blobs nicely
+        const fileContentBlob = yield fetch(`${index_2.OpenAPI.BASE}/w/${getWorkspace()}/job_helpers/download_s3_file?${queryParams}`, {
+            method: 'GET',
+            headers: {
+                'Authorization': `Bearer ${index_2.OpenAPI.TOKEN}`,
+            },
         });
-        return fileContentStream;
+        return fileContentBlob.blob();
     });
 }
 exports.loadS3FileStream = loadS3FileStream;
@@ -407,65 +370,27 @@ exports.loadS3FileStream = loadS3FileStream;
  * console.log(fileContentAsUtf8Str)
  * ```
  */
-function writeS3File(s3object, fileContent, fileExpiration, s3ResourcePath) {
+function writeS3File(s3object, fileContent, s3ResourcePath) {
     return __awaiter(this, void 0, void 0, function* () {
         !clientSet && setClient();
-        let fileContentStream;
+        let fileContentBlob;
         if (typeof fileContent === 'string') {
-            fileContentStream = new Blob([fileContent], {
+            fileContentBlob = new Blob([fileContent], {
                 type: 'text/plain'
-            }).stream();
+            });
         }
         else {
-            fileContentStream = fileContent;
-        }
-        let path = s3object === null || s3object === void 0 ? void 0 : s3object.s3;
-        let upload_id = undefined;
-        let parts = [];
-        const reader = fileContentStream.getReader();
-        let { value: chunk, done: readerDone } = yield reader.read();
-        if (chunk === undefined || readerDone) {
-            throw Error('Error reading stream, no data read');
-        }
-        while (true) {
-            let { value: chunk_2, done: readerDone } = yield reader.read();
-            if (!readerDone && chunk_2 !== undefined && chunk.length <= 5 * 1024 * 1024) {
-                // AWS enforces part to be bigger than 5MB, so we accumulate bytes until we reach that limit before triggering the request to the BE
-                chunk = new Uint8Array([...chunk, ...chunk_2]);
-                continue;
-            }
-            try {
-                let response = yield index_1.HelpersService.multipartFileUpload({
-                    workspace: getWorkspace(),
-                    requestBody: {
-                        file_key: path,
-                        file_extension: undefined,
-                        part_content: Array.from(chunk),
-                        upload_id: upload_id,
-                        parts: parts,
-                        is_final: readerDone,
-                        cancel_upload: false,
-                        s3_resource_path: s3ResourcePath,
-                        file_expiration: fileExpiration === null || fileExpiration === void 0 ? void 0 : fileExpiration.toString(),
-                    }
-                });
-                path = response.file_key;
-                upload_id = response.upload_id;
-                parts = response.parts;
-                if (response.is_done) {
-                    break;
-                }
-                if (chunk_2 === undefined) {
-                    throw Error('File upload is not finished, yet there is no more data to stream. This is unexpected');
-                }
-                chunk = chunk_2;
-            }
-            catch (e) {
-                throw Error(`Unexpected error uploading data to S3 ${e}`);
-            }
+            fileContentBlob = fileContent;
         }
+        const response = yield index_1.HelpersService.fileUpload({
+            workspace: getWorkspace(),
+            fileKey: s3object === null || s3object === void 0 ? void 0 : s3object.s3,
+            fileExtension: undefined,
+            s3ResourcePath: s3ResourcePath,
+            requestBody: fileContentBlob,
+        });
         return {
-            s3: path
+            s3: response.file_key
         };
     });
 }

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

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 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.Http = 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.denoS3LightClientSettings = exports.getIdToken = exports.getState = exports.setState = exports.getResumeUrls = exports.setResource = exports.getResource = exports.setVariable = exports.getVariable = exports.setClient = exports.WorkspaceService = exports.WorkerService = exports.VariableService = 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 = exports.VariableService = void 0;
 /* generated using openapi-typescript-codegen -- do no edit */
 /* istanbul ignore file */
 /* tslint:disable */
@@ -122,5 +122,6 @@ Object.defineProperty(exports, "setState", { enumerable: true, get: function ()
 Object.defineProperty(exports, "getState", { enumerable: true, get: function () { return client_1.getState; } });
 Object.defineProperty(exports, "getIdToken", { enumerable: true, get: function () { return client_1.getIdToken; } });
 Object.defineProperty(exports, "denoS3LightClientSettings", { enumerable: true, get: function () { return client_1.denoS3LightClientSettings; } });
+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; } });

package/dist/services/HelpersService.d.ts

@@ -1,6 +1,5 @@
 import type { PolarsClientKwargs } from '../models/PolarsClientKwargs';
 import type { S3Resource } from '../models/S3Resource';
-import type { UploadFilePart } from '../models/UploadFilePart';
 import type { WindmillFileMetadata } from '../models/WindmillFileMetadata';
 import type { WindmillFilePreview } from '../models/WindmillFilePreview';
 import type { WindmillLargeFile } from '../models/WindmillLargeFile';
@@ -116,10 +115,11 @@ export declare class HelpersService {
      * @returns any List of file keys
      * @throws ApiError
      */
-    static listStoredFiles({ workspace, maxKeys, marker, }: {
+    static listStoredFiles({ workspace, maxKeys, marker, prefix, }: {
         workspace: string;
         maxKeys: number;
         marker?: string;
+        prefix?: string;
     }): CancelablePromise<{
         next_marker?: string;
         windmill_large_files: Array<WindmillLargeFile>;
@@ -164,17 +164,6 @@ export declare class HelpersService {
         searchCol?: string;
         searchTerm?: string;
     }): CancelablePromise<any>;
-    /**
-     * Generate a unique URL to download the file
-     * @returns any Download URL
-     * @throws ApiError
-     */
-    static generateDownloadUrl({ workspace, fileKey, }: {
-        workspace: string;
-        fileKey: string;
-    }): CancelablePromise<{
-        download_url: string;
-    }>;
     /**
      * Permanently delete file from S3
      * @returns any Confirmation
@@ -195,51 +184,30 @@ export declare class HelpersService {
         destFileKey: string;
     }): CancelablePromise<any>;
     /**
-     * Upload file to S3 bucket using multipart upload
-     * @returns any Chunk upload status
+     * Upload file to S3 bucket
+     * @returns any File upload status
      * @throws ApiError
      */
-    static multipartFileUpload({ workspace, requestBody, }: {
+    static fileUpload({ workspace, requestBody, fileKey, fileExtension, s3ResourcePath, }: {
         workspace: string;
         /**
-         * Query args for a multipart file upload to S3
+         * File content
          */
-        requestBody: {
-            file_key?: string;
-            file_extension?: string;
-            part_content: Array<number>;
-            upload_id?: string;
-            parts: Array<UploadFilePart>;
-            is_final: boolean;
-            cancel_upload: boolean;
-            s3_resource_path?: string;
-            file_expiration?: string;
-        };
+        requestBody: Blob;
+        fileKey?: string;
+        fileExtension?: string;
+        s3ResourcePath?: string;
     }): CancelablePromise<{
-        upload_id: string;
-        parts: Array<UploadFilePart>;
-        is_done: boolean;
         file_key: string;
     }>;
     /**
      * Download file to S3 bucket
-     * @returns any Chunk of the downloaded file
+     * @returns binary Chunk of the downloaded file
      * @throws ApiError
      */
-    static multipartFileDownload({ workspace, requestBody, }: {
+    static fileDownload({ workspace, fileKey, s3ResourcePath, }: {
         workspace: string;
-        /**
-         * Query args for a multipart file upload to S3
-         */
-        requestBody: {
-            file_key: string;
-            part_number: number;
-            file_size?: number;
-            s3_resource_path?: string;
-        };
-    }): CancelablePromise<{
-        file_size?: number;
-        part_content: Array<number>;
-        next_part_number?: number;
-    }>;
+        fileKey: string;
+        s3ResourcePath?: string;
+    }): CancelablePromise<Blob>;
 }

package/dist/services/HelpersService.js

@@ -103,7 +103,7 @@ class HelpersService {
      * @returns any List of file keys
      * @throws ApiError
      */
-    static listStoredFiles({ workspace, maxKeys, marker, }) {
+    static listStoredFiles({ workspace, maxKeys, marker, prefix, }) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
             url: '/w/{workspace}/job_helpers/list_stored_files',
@@ -113,6 +113,7 @@ class HelpersService {
             query: {
                 'max_keys': maxKeys,
                 'marker': marker,
+                'prefix': prefix,
             },
         });
     }
@@ -179,23 +180,6 @@ class HelpersService {
             },
         });
     }
-    /**
-     * Generate a unique URL to download the file
-     * @returns any Download URL
-     * @throws ApiError
-     */
-    static generateDownloadUrl({ workspace, fileKey, }) {
-        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
-            method: 'GET',
-            url: '/w/{workspace}/job_helpers/generate_download_url',
-            path: {
-                'workspace': workspace,
-            },
-            query: {
-                'file_key': fileKey,
-            },
-        });
-    }
     /**
      * Permanently delete file from S3
      * @returns any Confirmation
@@ -232,35 +216,42 @@ class HelpersService {
         });
     }
     /**
-     * Upload file to S3 bucket using multipart upload
-     * @returns any Chunk upload status
+     * Upload file to S3 bucket
+     * @returns any File upload status
      * @throws ApiError
      */
-    static multipartFileUpload({ workspace, requestBody, }) {
+    static fileUpload({ workspace, requestBody, fileKey, fileExtension, s3ResourcePath, }) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'POST',
-            url: '/w/{workspace}/job_helpers/multipart_upload_s3_file',
+            url: '/w/{workspace}/job_helpers/upload_s3_file',
             path: {
                 'workspace': workspace,
             },
+            query: {
+                'file_key': fileKey,
+                'file_extension': fileExtension,
+                's3_resource_path': s3ResourcePath,
+            },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: 'application/octet-stream',
         });
     }
     /**
      * Download file to S3 bucket
-     * @returns any Chunk of the downloaded file
+     * @returns binary Chunk of the downloaded file
      * @throws ApiError
      */
-    static multipartFileDownload({ workspace, requestBody, }) {
+    static fileDownload({ workspace, fileKey, s3ResourcePath, }) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
-            method: 'POST',
-            url: '/w/{workspace}/job_helpers/multipart_download_s3_file',
+            method: 'GET',
+            url: '/w/{workspace}/job_helpers/download_s3_file',
             path: {
                 'workspace': workspace,
             },
-            body: requestBody,
-            mediaType: 'application/json',
+            query: {
+                'file_key': fileKey,
+                's3_resource_path': s3ResourcePath,
+            },
         });
     }
 }

package/dist/services/WorkspaceService.d.ts

@@ -178,6 +178,7 @@ export declare class WorkspaceService {
         slack_command_script?: string;
         auto_invite_domain?: string;
         auto_invite_operator?: boolean;
+        auto_add?: boolean;
         plan?: string;
         customer_id?: string;
         webhook?: string;
@@ -277,6 +278,7 @@ export declare class WorkspaceService {
         requestBody: {
             operator?: boolean;
             invite_all?: boolean;
+            auto_add?: boolean;
         };
     }): CancelablePromise<string>;
     /**

package/package.json

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