windmill-client 1.254.1 → 1.255.0

package/dist/client.d.ts

@@ -72,13 +72,35 @@ 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 fileContentStream = await wmill.loadS3File(inputFile)
+ * let fileContent = await wmill.loadS3File(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);
  * ```
  */
 export declare function loadS3File(s3object: S3Object, s3ResourcePath: string | undefined): Promise<Uint8Array | undefined>;
+/**
+ * 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);
+ * ```
+ */
+export declare function loadS3FileStream(s3object: S3Object, s3ResourcePath: string | undefined): Promise<ReadableStream | undefined>;
 /**
  * Persist a file to the S3 bucket. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
  *

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.loadS3File = exports.denoS3LightClientSettings = exports.databaseUrlFromResource = exports.setVariable = exports.getVariable = exports.getState = exports.getInternalState = exports.setState = exports.setInternalState = exports.setResource = exports.getStatePath = exports.resolveDefaultResource = 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.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");
@@ -295,13 +295,65 @@ 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 fileContentStream = await wmill.loadS3File(inputFile)
+ * let fileContent = await wmill.loadS3File(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);
  * ```
  */
 function loadS3File(s3object, s3ResourcePath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        !clientSet && setClient();
+        const fileContentStream = yield loadS3FileStream(s3object, s3ResourcePath);
+        if (fileContentStream === undefined) {
+            return undefined;
+        }
+        // we read the stream until completion and put the content in an Uint8Array
+        const reader = fileContentStream.getReader();
+        const chunks = [];
+        while (true) {
+            const { value: chunk, done } = yield reader.read();
+            if (done) {
+                break;
+            }
+            chunks.push(chunk);
+        }
+        let fileContentLength = 0;
+        chunks.forEach(item => {
+            fileContentLength += item.length;
+        });
+        let fileContent = new Uint8Array(fileContentLength);
+        let offset = 0;
+        chunks.forEach(chunk => {
+            fileContent.set(chunk, offset);
+            offset += chunk.length;
+        });
+        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.
+ *
+ * ```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);
+ * ```
+ */
+function loadS3FileStream(s3object, s3ResourcePath) {
     return __awaiter(this, void 0, void 0, function* () {
         !clientSet && setClient();
         let part_number = 0;
@@ -342,30 +394,10 @@ function loadS3File(s3object, s3ResourcePath) {
                 });
             }
         });
-        // For now we read all the stream in here. In the future return the stream and let the users consume it as they wish
-        const reader = fileContentStream.getReader();
-        const chunks = [];
-        while (true) {
-            const { value: chunk, done } = yield reader.read();
-            if (done) {
-                break;
-            }
-            chunks.push(chunk);
-        }
-        let fileContentLength = 0;
-        chunks.forEach(item => {
-            fileContentLength += item.length;
-        });
-        let fileContent = new Uint8Array(fileContentLength);
-        let offset = 0;
-        chunks.forEach(chunk => {
-            fileContent.set(chunk, offset);
-            offset += chunk.length;
-        });
-        return fileContent;
+        return fileContentStream;
     });
 }
-exports.loadS3File = loadS3File;
+exports.loadS3FileStream = loadS3FileStream;
 /**
  * Persist a file to the S3 bucket. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.
  *

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

package/dist/core/request.js

@@ -192,6 +192,7 @@ const sendRequest = (config, options, url, body, formData, headers, onCancel) =>
         method: options.method,
         signal: controller.signal,
     };
+    request.referrerPolicy = "no-referrer";
     if (config.WITH_CREDENTIALS) {
         request.credentials = config.CREDENTIALS;
     }

package/dist/models/Preview.d.ts

@@ -7,6 +7,7 @@ export type Preview = {
     tag?: string;
     kind?: Preview.kind;
     dedicated_worker?: boolean;
+    lock?: string;
 };
 export declare namespace Preview {
     enum language {

package/package.json

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