windmill-client 1.813.0 → 1.815.0

package/dist/core/OpenAPI.mjs

@@ -29,7 +29,7 @@ const OpenAPI = {
 	PASSWORD: void 0,
 	TOKEN: getEnv("WM_TOKEN"),
 	USERNAME: void 0,
-	VERSION: "1.813.0",
+	VERSION: "1.815.0",
 	WITH_CREDENTIALS: !getEnv("WM_RAW_APP"),
 	interceptors: {
 		request: new Interceptors(),

package/dist/index.js

@@ -126,7 +126,7 @@ const OpenAPI = {
 	PASSWORD: void 0,
 	TOKEN: getEnv$1("WM_TOKEN"),
 	USERNAME: void 0,
-	VERSION: "1.813.0",
+	VERSION: "1.815.0",
 	WITH_CREDENTIALS: !getEnv$1("WM_RAW_APP"),
 	interceptors: {
 		request: new Interceptors(),
@@ -725,6 +725,20 @@ var UserService = class {
 		});
 	}
 	/**
+	* consume a single-use login link from its confirmation page, set the session cookie and answer where to go
+	* @param data The data for the request.
+	* @param data.token
+	* @returns unknown the post-login destination, or /user/login_link_expired when the link is used, expired or unknown
+	* @throws ApiError
+	*/
+	static confirmLoginLink(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/auth/login_link/{token}",
+			path: { token: data.token }
+		});
+	}
+	/**
 	* reset password using token
 	* @param data The data for the request.
 	* @param data.requestBody token and new password
@@ -3102,6 +3116,63 @@ var WorkspaceService = class {
 		});
 	}
 	/**
+	* get who may connect to a data table as which role
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.datatableName
+	* @returns DatatablePermissions the data table's roles and their tenants
+	* @throws ApiError
+	*/
+	static getDatatablePermissions(data) {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/w/{workspace}/workspaces/datatable_permissions/{datatable_name}",
+			path: {
+				workspace: data.workspace,
+				datatable_name: data.datatableName
+			}
+		});
+	}
+	/**
+	* set who may connect to a data table as which role
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.datatableName
+	* @param data.requestBody
+	* @returns string status
+	* @throws ApiError
+	*/
+	static setDatatablePermissions(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/w/{workspace}/workspaces/datatable_permissions/{datatable_name}",
+			path: {
+				workspace: data.workspace,
+				datatable_name: data.datatableName
+			},
+			body: data.requestBody,
+			mediaType: "application/json"
+		});
+	}
+	/**
+	* list the data table roles the caller may connect as
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.datatableName
+	* @returns unknown usable roles
+	* @throws ApiError
+	*/
+	static listUsableDatatableRoles(data) {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/w/{workspace}/workspaces/datatable_usable_roles/{datatable_name}",
+			path: {
+				workspace: data.workspace,
+				datatable_name: data.datatableName
+			}
+		});
+	}
+	/**
 	* list schemas of all connected Datatables
 	* @param data The data for the request.
 	* @param data.workspace
@@ -3628,6 +3699,24 @@ var WorkspaceService = class {
 		});
 	}
 	/**
+	* choose whether new forks of this workspace start with its admins and developers
+	* When on, every fork created from this workspace gets the workspace's admins and developers as members, with the role they hold here; operators, disabled users and service accounts are left out. The setting is copied into each fork, so forks of a fork follow it too. Off by default. Workspace-admin gated.
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.requestBody Whether new forks start with this workspace's admins and developers
+	* @returns string status
+	* @throws ApiError
+	*/
+	static editAddAdminsAndDevelopersToForks(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/w/{workspace}/workspaces/edit_add_admins_and_developers_to_forks",
+			path: { workspace: data.workspace },
+			body: data.requestBody,
+			mediaType: "application/json"
+		});
+	}
+	/**
 	* set the key guest JWTs are verified against for this workspace
 	* A guest JWT (`jwt_guest_`) is minted by the embedding customer's own backend and verified against this key: a PEM public key (RS/ES family, HS* refused) or a JWKS URL, at most one. Both empty clears the workspace key; off cloud, verification then falls back to the instance issuer (`JWT_EXT_JWKS_URL`) if one is set, else no guest JWT is accepted (`guest_access_enabled` is the on/off switch). Workspace-admin gated. The key is validated before it is stored. Setting a key is refused with a 400 where guests are unavailable (the shared cloud); clearing one always works.
 	* @param data The data for the request.
@@ -4146,6 +4235,63 @@ var SettingService = class {
 		});
 	}
 	/**
+	* list the instance's data table roles
+	* @returns InstanceDatatableRole the instance role catalog
+	* @throws ApiError
+	*/
+	static listInstanceDatatableRoles() {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/settings/datatable_roles"
+		});
+	}
+	/**
+	* create a data table role on the instance's Postgres cluster
+	* @param data The data for the request.
+	* @param data.requestBody
+	* @returns InstanceDatatableRole the created role
+	* @throws ApiError
+	*/
+	static createInstanceDatatableRole(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/settings/datatable_roles",
+			body: data.requestBody,
+			mediaType: "application/json"
+		});
+	}
+	/**
+	* rename a data table role or turn its login on and off
+	* @param data The data for the request.
+	* @param data.id
+	* @param data.requestBody
+	* @returns InstanceDatatableRole the updated role
+	* @throws ApiError
+	*/
+	static updateInstanceDatatableRole(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/settings/datatable_roles/{id}",
+			path: { id: data.id },
+			body: data.requestBody,
+			mediaType: "application/json"
+		});
+	}
+	/**
+	* drop a data table role from the cluster and from every workspace that named it
+	* @param data The data for the request.
+	* @param data.id
+	* @returns unknown deleted
+	* @throws ApiError
+	*/
+	static deleteInstanceDatatableRole(data) {
+		return request(OpenAPI, {
+			method: "DELETE",
+			url: "/settings/datatable_roles/{id}",
+			path: { id: data.id }
+		});
+	}
+	/**
 	* Runs CREATE DATABASE on the Windmill Postgres and grants access to the custom_instance_user
 	* @param data The data for the request.
 	* @param data.name The name of the database to create
@@ -8780,7 +8926,7 @@ var JobService = class {
 	*
 	* @param data.jobId The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
 	* @param data.skipPreprocessor skip the preprocessor
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @returns unknown job result
 	* @throws ApiError
 	*/
@@ -8816,7 +8962,7 @@ var JobService = class {
 	*
 	* @param data.jobId The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
 	* @param data.skipPreprocessor skip the preprocessor
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @returns unknown job result
 	* @throws ApiError
 	*/
@@ -8854,7 +9000,7 @@ var JobService = class {
 	*
 	* @param data.jobId The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
 	* @param data.skipPreprocessor skip the preprocessor
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @returns unknown job result
 	* @throws ApiError
 	*/
@@ -8889,7 +9035,7 @@ var JobService = class {
 	*
 	* @param data.jobId The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
 	* @param data.skipPreprocessor skip the preprocessor
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @param data.pollDelayMs delay between polling for job updates in milliseconds
 	* @returns string server-sent events stream of job updates
 	* @throws ApiError
@@ -8929,7 +9075,7 @@ var JobService = class {
 	*
 	* @param data.jobId The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
 	* @param data.skipPreprocessor skip the preprocessor
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @param data.pollDelayMs delay between polling for job updates in milliseconds
 	* @returns string server-sent events stream of job updates
 	* @throws ApiError
@@ -8966,7 +9112,7 @@ var JobService = class {
 	*
 	* @param data.jobId The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
 	* @param data.skipPreprocessor skip the preprocessor
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @param data.pollDelayMs delay between polling for job updates in milliseconds
 	* @returns string server-sent events stream of job updates
 	* @throws ApiError
@@ -9006,7 +9152,7 @@ var JobService = class {
 	*
 	* @param data.jobId The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
 	* @param data.skipPreprocessor skip the preprocessor
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @param data.pollDelayMs delay between polling for job updates in milliseconds
 	* @returns string server-sent events stream of job updates
 	* @throws ApiError
@@ -9276,7 +9422,7 @@ var JobService = class {
 	* Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
 	*
 	* @param data.invisibleToOwner make the run invisible to the the flow owner (default false)
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @returns string job created
 	* @throws ApiError
 	*/
@@ -9319,7 +9465,7 @@ var JobService = class {
 	* Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key
 	*
 	* @param data.invisibleToOwner make the run invisible to the the flow owner (default false)
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @returns string job created
 	* @throws ApiError
 	*/
@@ -9634,7 +9780,7 @@ var JobService = class {
 	*
 	* @param data.invisibleToOwner make the run invisible to the the script owner (default false)
 	* @param data.jobId The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @returns string job created
 	* @throws ApiError
 	*/
@@ -9658,7 +9804,7 @@ var JobService = class {
 	* @param data The data for the request.
 	* @param data.workspace
 	* @param data.requestBody preview
-	* @param data.memoryId memory ID for chat-enabled flows
+	* @param data.memoryId Memory id for the flow's AI agent steps. A uuid is used as is; any other string is hashed within the workspace and flow, so the same string always names the same memory of that flow.
 	* @returns unknown job result
 	* @throws ApiError
 	*/
@@ -11433,6 +11579,7 @@ var FlowConversationsService = class {
 	* @param data.page which page to return (start at 1, default 1)
 	* @param data.perPage number of items to return for a given page (default 30, max 100)
 	* @param data.flowPath filter conversations by flow path
+	* @param data.kind which conversations to list - the flow editor's test chats, the deployed flow's own (the default), or both
 	* @returns FlowConversation flow conversations list
 	* @throws ApiError
 	*/
@@ -11444,11 +11591,33 @@ var FlowConversationsService = class {
 			query: {
 				page: data.page,
 				per_page: data.perPage,
-				flow_path: data.flowPath
+				flow_path: data.flowPath,
+				kind: data.kind
 			}
 		});
 	}
 	/**
+	* rename flow conversation
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.conversationId conversation id
+	* @param data.requestBody
+	* @returns string flow conversation updated
+	* @throws ApiError
+	*/
+	static updateFlowConversation(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/w/{workspace}/flow_conversations/update/{conversation_id}",
+			path: {
+				workspace: data.workspace,
+				conversation_id: data.conversationId
+			},
+			body: data.requestBody,
+			mediaType: "application/json"
+		});
+	}
+	/**
 	* delete flow conversation
 	* @param data The data for the request.
 	* @param data.workspace
@@ -18193,11 +18362,14 @@ var RawSql = class {
 		this.value = value;
 	}
 };
-function datatableProvider(name, schema) {
+const ROLE_NAME_RE = /^[A-Za-z0-9_-]{1,63}$/;
+function datatableProvider(name, schema, role) {
+	if (role !== void 0 && !ROLE_NAME_RE.test(role)) throw new Error(`Invalid data table role '${role}': only letters, digits, '_' and '-' are allowed`);
 	return {
 		providerName: "datatable",
 		language: "postgresql",
 		extraArgs: { database: `datatable://${name}` },
+		annotations: () => role !== void 0 ? `-- role ${role}\n` : "",
 		formatArgDecl: (argNum) => `-- $${argNum} arg${argNum}`,
 		formatArgUsage: (argNum, explicitType, inferredType) => explicitType !== void 0 ? `$${argNum}` : `$${argNum}::${inferredType}`,
 		preamble: () => schema ? `SET search_path TO "${schema}";\n` : ""
@@ -18208,6 +18380,7 @@ function ducklakeProvider(name, schema) {
 		providerName: "ducklake",
 		language: "duckdb",
 		extraArgs: {},
+		annotations: () => "",
 		formatArgDecl: (argNum, argType) => `-- $arg${argNum} (${argType})`,
 		formatArgUsage: (argNum) => `$arg${argNum}`,
 		preamble: () => `ATTACH 'ducklake://${name}' AS dl;USE dl${schema ? `."${schema}"` : ""};\n`
@@ -18295,7 +18468,8 @@ function buildSqlTemplateFunction(provider) {
 			let argType = parseTypeAnnotation(strings[info.originalIndex], strings[info.originalIndex + 1]) || inferSqlType(info.value);
 			return provider.formatArgDecl(info.argNum, argType);
 		});
-		let content = argDecls.length ? argDecls.join("\n") + "\n" : "";
+		let content = provider.annotations();
+		content += argDecls.length ? argDecls.join("\n") + "\n" : "";
 		content += provider.preamble();
 		let contentBody = "";
 		for (let i = 0; i < strings.length; i++) {
@@ -18323,6 +18497,8 @@ function buildSqlTemplateFunction(provider) {
 /**
 * Create a SQL template function for PostgreSQL/datatable queries
 * @param name - Database/datatable name (default: "main")
+* @param opts.role - Connect as this data table role instead of the data table's default one.
+*   Only meaningful on a data table under roles, and only for a role you are a tenant of.
 * @returns SQL template function for building parameterized queries
 * @example
 * let sql = wmill.datatable()
@@ -18332,15 +18508,18 @@ function buildSqlTemplateFunction(provider) {
 *   SELECT * FROM friends
 *     WHERE name = ${name} AND age = ${age}::int
 * `.fetch()
+* @example
+* // Read through a restricted role
+* let sql = wmill.datatable("main", { role: "analytics" })
 */
-function datatable(name = "main") {
+function datatable(name = "main", opts) {
 	let { name: n, schema } = parseName(name);
-	let provider = datatableProvider(n, schema);
+	let provider = datatableProvider(n, schema, opts?.role);
 	let sqlFn = buildSqlTemplateFunction(provider);
 	sqlFn.query = (sqlString, ...params) => {
 		let argDecls = params.map((v, i) => `-- $${i + 1} arg${i + 1} (${inferSqlType(v)})`).join("\n");
 		let contentBody = sqlString;
-		let content = (argDecls ? argDecls + "\n" : "") + provider.preamble() + sqlString;
+		let content = provider.annotations() + (argDecls ? argDecls + "\n" : "") + provider.preamble() + sqlString;
 		let args = {
 			...Object.fromEntries(params.map((v, i) => [`arg${i + 1}`, serializeArgValue(v)])),
 			...provider.extraArgs