windmill-client 1.227.1 → 1.228.0

package/dist/s3Types.d.ts

@@ -0,0 +1,12 @@
+export type S3Object = {
+    s3: string;
+};
+export type DenoS3LightClientSettings = {
+    endPoint: string;
+    region: string;
+    bucket?: string;
+    useSSL?: boolean;
+    accessKey?: string;
+    secretKey?: string;
+    pathStyle?: boolean;
+};

package/dist/{client.d.ts → src/client.d.ts}

@@ -1,3 +1,4 @@
+import { DenoS3LightClientSettings } from "./s3Types";
 export { AdminService, AuditService, FlowService, GranularAclService, GroupService, JobService, ResourceService, VariableService, ScriptService, ScheduleService, SettingsService, UserService, WorkspaceService, } from "./index";
 export type Sql = string;
 export type Email = string;
@@ -66,12 +67,11 @@ export declare function getVariable(path: string): Promise<string>;
  */
 export declare function setVariable(path: string, value: string, isSecretIfNotExist?: boolean, descriptionIfNotExist?: string): Promise<void>;
 export declare function databaseUrlFromResource(path: string): Promise<string>;
-export declare function polarsConnectionSettings(s3_resource_path: string | undefined): Promise<any>;
-export declare function duckdbConnectionSettings(s3_resource_path: string | undefined): Promise<any>;
+export declare function denoS3LightClientSettings(s3_resource_path: string | undefined): Promise<DenoS3LightClientSettings>;
 /**
  * Get URLs needed for resuming a flow after this step
  * @param approver approver name
- * @returns approval page UI URL, resume and cancel API URLs for resumeing the flow
+ * @returns approval page UI URL, resume and cancel API URLs for resuming the flow
  */
 export declare function getResumeUrls(approver?: string): Promise<{
     approvalPage: string;

package/dist/{client.js → src/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.getResumeEndpoints = exports.getResumeUrls = exports.duckdbConnectionSettings = exports.polarsConnectionSettings = 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.getResumeEndpoints = exports.getResumeUrls = 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");
@@ -257,34 +257,43 @@ function databaseUrlFromResource(path) {
     });
 }
 exports.databaseUrlFromResource = databaseUrlFromResource;
-function polarsConnectionSettings(s3_resource_path) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const workspace = getWorkspace();
-        return yield index_1.HelpersService.polarsConnectionSettingsV2({
-            workspace: workspace,
-            requestBody: {
-                s3_resource_path: s3_resource_path
-            }
-        });
-    });
-}
-exports.polarsConnectionSettings = polarsConnectionSettings;
-function duckdbConnectionSettings(s3_resource_path) {
+// TODO(gb): need to investigate more how Polars and DuckDB work in TS
+// export async function polarsConnectionSettings(s3_resource_path: string | undefined): Promise<any> {
+//   const workspace = getWorkspace();
+//   return await HelpersService.polarsConnectionSettingsV2({
+//     workspace: workspace,
+// 		requestBody: {
+// 			s3_resource_path: s3_resource_path
+// 		}
+//   });
+// }
+// export async function duckdbConnectionSettings(s3_resource_path: string | undefined): Promise<any> {
+//   const workspace = getWorkspace();
+//   return await HelpersService.duckdbConnectionSettingsV2({
+//     workspace: workspace,
+// 		requestBody: {
+// 			s3_resource_path: s3_resource_path
+// 		}
+//   });
+// }
+function denoS3LightClientSettings(s3_resource_path) {
     return __awaiter(this, void 0, void 0, function* () {
         const workspace = getWorkspace();
-        return yield index_1.HelpersService.duckdbConnectionSettingsV2({
+        const s3Resource = yield index_1.HelpersService.s3ResourceInfo({
             workspace: workspace,
             requestBody: {
                 s3_resource_path: s3_resource_path
             }
         });
+        let settings = Object.assign({}, s3Resource);
+        return settings;
     });
 }
-exports.duckdbConnectionSettings = duckdbConnectionSettings;
+exports.denoS3LightClientSettings = denoS3LightClientSettings;
 /**
  * Get URLs needed for resuming a flow after this step
  * @param approver approver name
- * @returns approval page UI URL, resume and cancel API URLs for resumeing the flow
+ * @returns approval page UI URL, resume and cancel API URLs for resuming the flow
  */
 function getResumeUrls(approver) {
     var _a;

package/dist/src/core/ApiResult.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/{core → src/core}/OpenAPI.js

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

package/dist/{index.d.ts → src/index.d.ts}

@@ -163,4 +163,5 @@ export { UserService } from './services/UserService';
 export { VariableService } from './services/VariableService';
 export { WorkerService } from './services/WorkerService';
 export { WorkspaceService } from './services/WorkspaceService';
-export { setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, getState } from "./client";
+export { type S3Object } from "./s3Types";
+export { setClient, getVariable, setVariable, getResource, setResource, getResumeUrls, setState, getState, denoS3LightClientSettings } from "./client";

package/dist/{index.js → src/index.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setClient = exports.WorkspaceService = exports.WorkerService = exports.VariableService = exports.UserService = exports.SettingsService = exports.SettingService = exports.ScriptService = exports.ScheduleService = exports.ResourceService = exports.RawAppService = exports.OauthService = exports.JobService = exports.IntegrationService = exports.InputService = exports.HelpersService = exports.GroupService = exports.GranularAclService = exports.FolderService = exports.FlowService = exports.FavoriteService = exports.DraftService = exports.ConfigService = exports.CaptureService = exports.AuditService = exports.AppService = exports.AdminService = exports.WindmillFilePreview = exports.Script = exports.RunnableType = 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.getState = exports.setState = exports.getResumeUrls = exports.setResource = exports.getResource = exports.setVariable = exports.getVariable = void 0;
+exports.denoS3LightClientSettings = exports.getState = exports.setState = exports.getResumeUrls = exports.setResource = exports.getResource = exports.setVariable = exports.getVariable = void 0;
 /* generated using openapi-typescript-codegen -- do no edit */
 /* istanbul ignore file */
 /* tslint:disable */
@@ -112,3 +112,4 @@ Object.defineProperty(exports, "setResource", { enumerable: true, get: function
 Object.defineProperty(exports, "getResumeUrls", { enumerable: true, get: function () { return client_1.getResumeUrls; } });
 Object.defineProperty(exports, "setState", { enumerable: true, get: function () { return client_1.setState; } });
 Object.defineProperty(exports, "getState", { enumerable: true, get: function () { return client_1.getState; } });
+Object.defineProperty(exports, "denoS3LightClientSettings", { enumerable: true, get: function () { return client_1.denoS3LightClientSettings; } });

package/dist/src/s3Types.d.ts

@@ -0,0 +1,12 @@
+export type S3Object = {
+    s3: string;
+};
+export type DenoS3LightClientSettings = {
+    endPoint: string;
+    region: string;
+    bucket?: string;
+    useSSL?: boolean;
+    accessKey?: string;
+    secretKey?: string;
+    pathStyle?: boolean;
+};

package/dist/src/s3Types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/{services → src/services}/HelpersService.d.ts

@@ -89,25 +89,19 @@ export declare class HelpersService {
         };
     }>;
     /**
-     * Converts an S3 resource to the set of arguments necessary to connect to an S3 bucket using boto3 in Python
-     * @returns any Connection settings
+     * Returns the s3 resource associated to the provided path, or the workspace default S3 resource
+     * @returns S3Resource Connection settings
      * @throws ApiError
      */
-    static boto3ConnectionSettingsV2({ workspace, requestBody, }: {
+    static s3ResourceInfo({ workspace, requestBody, }: {
         workspace: string;
         /**
-         * S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used
+         * S3 resource path to use. If empty, the S3 resource defined in the workspace settings will be used
          */
         requestBody: {
             s3_resource_path?: string;
         };
-    }): CancelablePromise<{
-        endpoint_url: string;
-        region_name: string;
-        use_ssl: boolean;
-        aws_access_key_id?: string;
-        aws_secret_access_key?: string;
-    }>;
+    }): CancelablePromise<S3Resource>;
     /**
      * Test connection to the workspace datasets storage
      * @returns any Connection settings

package/dist/{services → src/services}/HelpersService.js

@@ -69,14 +69,14 @@ class HelpersService {
         });
     }
     /**
-     * Converts an S3 resource to the set of arguments necessary to connect to an S3 bucket using boto3 in Python
-     * @returns any Connection settings
+     * Returns the s3 resource associated to the provided path, or the workspace default S3 resource
+     * @returns S3Resource Connection settings
      * @throws ApiError
      */
-    static boto3ConnectionSettingsV2({ workspace, requestBody, }) {
+    static s3ResourceInfo({ workspace, requestBody, }) {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'POST',
-            url: '/w/{workspace}/job_helpers/v2/boto3_connection_settings',
+            url: '/w/{workspace}/job_helpers/v2/s3_resource_info',
             path: {
                 'workspace': workspace,
             },

package/package.json

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