windmill-client 0.2.1 → 0.3.2

package/dist/client.js

@@ -0,0 +1,340 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uint8ArrayToBase64 = exports.base64ToUint8Array = exports.getResumeEndpoints = exports.databaseUrlFromResource = exports.setVariable = exports.getVariable = exports.getState = exports.getInternalState = exports.setState = exports.setInternalState = exports.setResource = exports.getStatePath = exports.getFullResource = 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_ts_1 = require("./index.ts");
+const index_ts_2 = require("./index.ts");
+var index_ts_3 = require("./index.ts");
+Object.defineProperty(exports, "AdminService", { enumerable: true, get: function () { return index_ts_3.AdminService; } });
+Object.defineProperty(exports, "AuditService", { enumerable: true, get: function () { return index_ts_3.AuditService; } });
+Object.defineProperty(exports, "FlowService", { enumerable: true, get: function () { return index_ts_3.FlowService; } });
+Object.defineProperty(exports, "GranularAclService", { enumerable: true, get: function () { return index_ts_3.GranularAclService; } });
+Object.defineProperty(exports, "GroupService", { enumerable: true, get: function () { return index_ts_3.GroupService; } });
+Object.defineProperty(exports, "JobService", { enumerable: true, get: function () { return index_ts_3.JobService; } });
+Object.defineProperty(exports, "ResourceService", { enumerable: true, get: function () { return index_ts_3.ResourceService; } });
+Object.defineProperty(exports, "VariableService", { enumerable: true, get: function () { return index_ts_3.VariableService; } });
+Object.defineProperty(exports, "ScriptService", { enumerable: true, get: function () { return index_ts_3.ScriptService; } });
+Object.defineProperty(exports, "ScheduleService", { enumerable: true, get: function () { return index_ts_3.ScheduleService; } });
+Object.defineProperty(exports, "SettingsService", { enumerable: true, get: function () { return index_ts_3.SettingsService; } });
+Object.defineProperty(exports, "UserService", { enumerable: true, get: function () { return index_ts_3.UserService; } });
+Object.defineProperty(exports, "WorkspaceService", { enumerable: true, get: function () { return index_ts_3.WorkspaceService; } });
+exports.SHARED_FOLDER = "/shared";
+function setClient(token, baseUrl) {
+    var _a, _b, _c;
+    if (baseUrl === undefined) {
+        baseUrl = (_b = (_a = getEnv("BASE_INTERNAL_URL")) !== null && _a !== void 0 ? _a : getEnv("BASE_URL")) !== null && _b !== void 0 ? _b : "http://localhost:8000";
+    }
+    if (token === undefined) {
+        baseUrl = (_c = getEnv("WM_TOKEN")) !== null && _c !== void 0 ? _c : "no_token",
+        ;
+    }
+    index_ts_2.OpenAPI.WITH_CREDENTIALS = true;
+    index_ts_2.OpenAPI.TOKEN = token;
+    index_ts_2.OpenAPI.BASE = baseUrl + "/api";
+}
+exports.setClient = setClient;
+const getEnv = (key) => {
+    if (typeof window === 'undefined') {
+        // node
+        return process.env[key];
+    }
+    // browser
+    return window.process.env[key];
+};
+/**
+ * Create a client configuration from env variables
+ * @returns client configuration
+ */
+function getWorkspace() {
+    var _a;
+    return (_a = getEnv("WM_WORKSPACE")) !== null && _a !== void 0 ? _a : "no_workspace";
+}
+exports.getWorkspace = getWorkspace;
+/**
+ * Get a resource value by path
+ * @param path path of the resource,  default to internal state path
+ * @param undefinedIfEmpty if the resource does not exist, return undefined instead of throwing an error
+ * @returns resource value
+ */
+async function getResource(path, undefinedIfEmpty) {
+    const workspace = getWorkspace();
+    path = path !== null && path !== void 0 ? path : getStatePath();
+    try {
+        const resource = await index_ts_1.ResourceService.getResource({ workspace, path });
+        return await _transformLeaf(resource.value);
+    }
+    catch (e) {
+        if (undefinedIfEmpty && e.status === 404) {
+            return undefined;
+        }
+        else {
+            throw Error(`Resource not found at ${path} or not visible to you`);
+        }
+    }
+}
+exports.getResource = getResource;
+/**
+ * Resolve a resource value in case the default value was picked because the input payload was undefined
+ * @param obj resource value or path of the resource under the format `$res:path`
+ * @returns resource value
+ */
+async function resolveDefaultResource(obj) {
+    if (typeof obj === "string" && obj.startsWith("$res:")) {
+        return await getResource(obj.substring(5), true);
+    }
+    else {
+        return obj;
+    }
+}
+exports.resolveDefaultResource = resolveDefaultResource;
+/**
+ * Get the full resource value by path
+ * @param path path of the resource,  default to internal state path
+ * @param undefinedIfEmpty if the resource does not exist, return undefined instead of throwing an error
+ * @returns full resource
+ */
+async function getFullResource(path, undefinedIfEmpty) {
+    const workspace = getWorkspace();
+    path = path !== null && path !== void 0 ? path : getStatePath();
+    try {
+        const resource = await index_ts_1.ResourceService.getResource({ workspace, path });
+        const value = await _transformLeaf(resource.value);
+        return { ...resource, value };
+    }
+    catch (e) {
+        if (undefinedIfEmpty && e.status === 404) {
+            return undefined;
+        }
+        else {
+            throw Error(`Resource not found at ${path} or not visible to you`);
+        }
+    }
+}
+exports.getFullResource = getFullResource;
+function getStatePath() {
+    const state_path = getEnv("WM_STATE_PATH");
+    if (state_path === undefined) {
+        throw Error("State path not set");
+    }
+    return state_path;
+}
+exports.getStatePath = getStatePath;
+/**
+ * Set a resource value by path
+ * @param path path of the resource to set, default to state path
+ * @param value new value of the resource to set
+ * @param initializeToTypeIfNotExist if the resource does not exist, initialize it with this type
+ */
+async function setResource(value, path, initializeToTypeIfNotExist) {
+    path = path !== null && path !== void 0 ? path : getStatePath();
+    const workspace = getWorkspace();
+    if (await index_ts_1.ResourceService.existsResource({ workspace, path })) {
+        await index_ts_1.ResourceService.updateResourceValue({
+            workspace,
+            path,
+            requestBody: { value },
+        });
+    }
+    else if (initializeToTypeIfNotExist) {
+        await index_ts_1.ResourceService.createResource({
+            workspace,
+            requestBody: { path, value, resource_type: initializeToTypeIfNotExist },
+        });
+    }
+    else {
+        throw Error(`Resource at path ${path} does not exist and no type was provided to initialize it`);
+    }
+}
+exports.setResource = setResource;
+/**
+ * Set the state
+ * @param state state to set
+ * @deprecated use setState instead
+ */
+async function setInternalState(state) {
+    await setResource(state, undefined, "state");
+}
+exports.setInternalState = setInternalState;
+/**
+ * Set the state
+ * @param state state to set
+ */
+async function setState(state) {
+    await setResource(state, undefined, "state");
+}
+exports.setState = setState;
+// /**
+//  * 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
+ */
+async function getInternalState() {
+    return await getResource(getStatePath(), true);
+}
+exports.getInternalState = getInternalState;
+/**
+ * Get the state shared across executions
+ */
+async function getState() {
+    return await getResource(getStatePath(), true);
+}
+exports.getState = getState;
+/**
+ * Get a variable by path
+ * @param path path of the variable
+ * @returns variable value
+ */
+async function getVariable(path) {
+    const workspace = getWorkspace();
+    try {
+        const variable = await index_ts_1.VariableService.getVariable({ workspace, path });
+        return variable.value;
+    }
+    catch (e) {
+        throw Error(`Variable not found at ${path} or not visible to you`);
+    }
+}
+exports.getVariable = getVariable;
+/**
+ * Set a variable by path, create if not exist
+ * @param path path of the variable
+ * @param value value of the variable
+ * @param isSecretIfNotExist if the variable does not exist, create it as secret or not (default: false)
+ * @param descriptionIfNotExist if the variable does not exist, create it with this description (default: "")
+ */
+async function setVariable(path, value, isSecretIfNotExist, descriptionIfNotExist) {
+    const workspace = getWorkspace();
+    if (await index_ts_1.VariableService.existsVariable({ workspace, path })) {
+        await index_ts_1.VariableService.updateVariable({
+            workspace,
+            path,
+            requestBody: { value },
+        });
+    }
+    else {
+        await index_ts_1.VariableService.createVariable({
+            workspace,
+            requestBody: {
+                path,
+                value,
+                is_secret: isSecretIfNotExist !== null && isSecretIfNotExist !== void 0 ? isSecretIfNotExist : false,
+                description: descriptionIfNotExist !== null && descriptionIfNotExist !== void 0 ? descriptionIfNotExist : "",
+            },
+        });
+    }
+}
+exports.setVariable = setVariable;
+async function transformLeaves(d) {
+    for (const k in d) {
+        d[k] = await _transformLeaf(d[k]);
+    }
+    return d;
+}
+const VAR_RESOURCE_PREFIX = "$var:";
+const RES_RESOURCE_PREFIX = "$res:";
+async function _transformLeaf(v) {
+    if (typeof v === "object") {
+        return transformLeaves(v);
+    }
+    else if (typeof v === "string" && v.startsWith(VAR_RESOURCE_PREFIX)) {
+        const varName = v.substring(VAR_RESOURCE_PREFIX.length);
+        return await getVariable(varName);
+    }
+    else if (typeof v === "string" && v.startsWith(RES_RESOURCE_PREFIX)) {
+        const resName = v.substring(RES_RESOURCE_PREFIX.length);
+        return await getResource(resName);
+    }
+    else {
+        return v;
+    }
+}
+async function databaseUrlFromResource(path) {
+    const resource = await getResource(path);
+    return `postgresql://${resource.user}:${resource.password}@${resource.host}:${resource.port}/${resource.dbname}?sslmode=${resource.sslmode}`;
+}
+exports.databaseUrlFromResource = databaseUrlFromResource;
+// /**
+//  * 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
+//  */
+// export async function getResumeUrls(approver?: string): Promise<{
+//   approvalPage: string;
+//   resume: string;
+//   cancel: string;
+// }> {
+//   const nonce = Math.floor(Math.random() * 4294967295);
+//   const workspace = getWorkspace();
+//   return await JobService.getResumeUrls({
+//     workspace,
+//     resumeId: nonce,
+//     approver,
+//     id: process.env.get("WM_JOB_ID") ?? "NO_JOB_ID",
+//   });
+// }
+/**
+ * @deprecated use getResumeUrls instead
+ */
+function getResumeEndpoints(approver) {
+    return getResumeUrls(approver);
+}
+exports.getResumeEndpoints = getResumeEndpoints;
+function base64ToUint8Array(data) {
+    return Uint8Array.from(atob(data), (c) => c.charCodeAt(0));
+}
+exports.base64ToUint8Array = base64ToUint8Array;
+function uint8ArrayToBase64(arrayBuffer) {
+    let base64 = "";
+    const encodings = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+    const bytes = new Uint8Array(arrayBuffer);
+    const byteLength = bytes.byteLength;
+    const byteRemainder = byteLength % 3;
+    const mainLength = byteLength - byteRemainder;
+    let a, b, c, d;
+    let chunk;
+    // Main loop deals with bytes in chunks of 3
+    for (let i = 0; i < mainLength; i = i + 3) {
+        // Combine the three bytes into a single integer
+        chunk = (bytes[i] << 16) | (bytes[i + 1] << 8) | bytes[i + 2];
+        // Use bitmasks to extract 6-bit segments from the triplet
+        a = (chunk & 16515072) >> 18; // 16515072 = (2^6 - 1) << 18
+        b = (chunk & 258048) >> 12; // 258048   = (2^6 - 1) << 12
+        c = (chunk & 4032) >> 6; // 4032     = (2^6 - 1) << 6
+        d = chunk & 63; // 63       = 2^6 - 1
+        // Convert the raw binary segments to the appropriate ASCII encoding
+        base64 += encodings[a] + encodings[b] + encodings[c] + encodings[d];
+    }
+    // Deal with the remaining bytes and padding
+    if (byteRemainder == 1) {
+        chunk = bytes[mainLength];
+        a = (chunk & 252) >> 2; // 252 = (2^6 - 1) << 2
+        // Set the 4 least significant bits to zero
+        b = (chunk & 3) << 4; // 3   = 2^2 - 1
+        base64 += encodings[a] + encodings[b] + "==";
+    }
+    else if (byteRemainder == 2) {
+        chunk = (bytes[mainLength] << 8) | bytes[mainLength + 1];
+        a = (chunk & 64512) >> 10; // 64512 = (2^6 - 1) << 10
+        b = (chunk & 1008) >> 4; // 1008  = (2^6 - 1) << 4
+        // Set the 2 least significant bits to zero
+        c = (chunk & 15) << 2; // 15    = 2^4 - 1
+        base64 += encodings[a] + encodings[b] + encodings[c] + "=";
+    }
+    return base64;
+}
+exports.uint8ArrayToBase64 = uint8ArrayToBase64;

package/dist/src/client.d.ts

@@ -0,0 +1,85 @@
+export { AdminService, AuditService, FlowService, GranularAclService, GroupService, JobService, ResourceService, VariableService, ScriptService, ScheduleService, SettingsService, UserService, WorkspaceService, } from "./index.ts";
+export type Sql = string;
+export type Email = string;
+export type Base64 = string;
+export type Resource<S extends string> = any;
+export declare const SHARED_FOLDER = "/shared";
+export declare function setClient(token?: string, baseUrl?: string): void;
+/**
+ * Create a client configuration from env variables
+ * @returns client configuration
+ */
+export declare function getWorkspace(): string;
+/**
+ * Get a resource value by path
+ * @param path path of the resource,  default to internal state path
+ * @param undefinedIfEmpty if the resource does not exist, return undefined instead of throwing an error
+ * @returns resource value
+ */
+export declare function getResource(path?: string, undefinedIfEmpty?: boolean): Promise<any>;
+/**
+ * Resolve a resource value in case the default value was picked because the input payload was undefined
+ * @param obj resource value or path of the resource under the format `$res:path`
+ * @returns resource value
+ */
+export declare function resolveDefaultResource(obj: any): Promise<any>;
+/**
+ * Get the full resource value by path
+ * @param path path of the resource,  default to internal state path
+ * @param undefinedIfEmpty if the resource does not exist, return undefined instead of throwing an error
+ * @returns full resource
+ */
+export declare function getFullResource(path?: string, undefinedIfEmpty?: boolean): Promise<any>;
+export declare function getStatePath(): string;
+/**
+ * Set a resource value by path
+ * @param path path of the resource to set, default to state path
+ * @param value new value of the resource to set
+ * @param initializeToTypeIfNotExist if the resource does not exist, initialize it with this type
+ */
+export declare function setResource(value: any, path?: string, initializeToTypeIfNotExist?: string): Promise<void>;
+/**
+ * Set the state
+ * @param state state to set
+ * @deprecated use setState instead
+ */
+export declare function setInternalState(state: any): Promise<void>;
+/**
+ * Set the state
+ * @param state state to set
+ */
+export declare function setState(state: any): Promise<void>;
+/**
+ * Get the internal state
+ * @deprecated use getState instead
+ */
+export declare function getInternalState(): Promise<any>;
+/**
+ * Get the state shared across executions
+ */
+export declare function getState(): Promise<any>;
+/**
+ * Get a variable by path
+ * @param path path of the variable
+ * @returns variable value
+ */
+export declare function getVariable(path: string): Promise<string | undefined>;
+/**
+ * Set a variable by path, create if not exist
+ * @param path path of the variable
+ * @param value value of the variable
+ * @param isSecretIfNotExist if the variable does not exist, create it as secret or not (default: false)
+ * @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>;
+export declare function databaseUrlFromResource(path: string): Promise<string>;
+/**
+ * @deprecated use getResumeUrls instead
+ */
+export declare function getResumeEndpoints(approver?: string): Promise<{
+    approvalPage: string;
+    resume: string;
+    cancel: string;
+}>;
+export declare function base64ToUint8Array(data: string): Uint8Array;
+export declare function uint8ArrayToBase64(arrayBuffer: Uint8Array): string;