windmill-client 1.775.1 → 1.776.0

package/dist/client.d.ts

@@ -335,8 +335,11 @@ export declare function base64ToUint8Array(data: string): Uint8Array;
 export declare function uint8ArrayToBase64(arrayBuffer: Uint8Array): string;
 /**
  * Get email from workspace username
- * This method is particularly useful for apps that require the email address of the viewer.
- * Indeed, in the viewer context, WM_USERNAME is set to the username of the viewer but WM_EMAIL is set to the email of the creator of the app.
+ * @deprecated Read the contextual variables instead: `process.env.WM_END_USER_EMAIL || process.env.WM_EMAIL`.
+ * WM_END_USER_EMAIL is the email of whoever triggered the run when it came from an app, so the fallback
+ * yields the app viewer inside an app and the executing user everywhere else - without an extra API call,
+ * and unlike this function it also resolves viewers who are not workspace members. An app viewed
+ * anonymously has no identity to report: the variable is then empty and the fallback yields the publisher.
  * @param username
  * @returns email address
  */

package/dist/client.mjs

@@ -791,8 +791,11 @@ function uint8ArrayToBase64(arrayBuffer) {
 }
 /**
 * Get email from workspace username
-* This method is particularly useful for apps that require the email address of the viewer.
-* Indeed, in the viewer context, WM_USERNAME is set to the username of the viewer but WM_EMAIL is set to the email of the creator of the app.
+* @deprecated Read the contextual variables instead: `process.env.WM_END_USER_EMAIL || process.env.WM_EMAIL`.
+* WM_END_USER_EMAIL is the email of whoever triggered the run when it came from an app, so the fallback
+* yields the app viewer inside an app and the executing user everywhere else - without an extra API call,
+* and unlike this function it also resolves viewers who are not workspace members. An app viewed
+* anonymously has no identity to report: the variable is then empty and the fallback yields the publisher.
 * @param username
 * @returns email address
 */

package/dist/core/OpenAPI.mjs

@@ -29,7 +29,7 @@ const OpenAPI = {
 	PASSWORD: void 0,
 	TOKEN: getEnv("WM_TOKEN"),
 	USERNAME: void 0,
-	VERSION: "1.775.1",
+	VERSION: "1.776.0",
 	WITH_CREDENTIALS: true,
 	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.775.1",
+	VERSION: "1.776.0",
 	WITH_CREDENTIALS: true,
 	interceptors: {
 		request: new Interceptors(),
@@ -2153,6 +2153,25 @@ var WorkspaceService = class {
 		});
 	}
 	/**
+	* Seed the diff candidate set against an arbitrary workspace
+	* Enumerates every item of both workspaces as an undecided diff candidate so `compareWorkspaces` can compare a pair the fork lineage does not track. Requires being an admin of both workspaces, and is rejected for a pair already linked by the lineage (whose diff is tallied continuously). The comparison itself is what compares the candidates, and is the expensive step.
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.targetWorkspaceId The ID of the workspace to compare with
+	* @returns unknown Scan seeded
+	* @throws ApiError
+	*/
+	static seedFullDiffScan(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/w/{workspace}/workspaces/seed_full_diff/{target_workspace_id}",
+			path: {
+				workspace: data.workspace,
+				target_workspace_id: data.targetWorkspaceId
+			}
+		});
+	}
+	/**
 	* Resets the ahead and behind deployement counter after a deployement
 	* This endpoint should be called after a fork deployement
 	* @param data The data for the request.
@@ -2216,7 +2235,7 @@ var WorkspaceService = class {
 		});
 	}
 	/**
-	* get deploy to
+	* get the workspace this one deploys into (its fork parent)
 	* @param data The data for the request.
 	* @param data.workspace
 	* @returns unknown status
@@ -2555,23 +2574,6 @@ var WorkspaceService = class {
 		});
 	}
 	/**
-	* edit deploy to
-	* @param data The data for the request.
-	* @param data.workspace
-	* @param data.requestBody
-	* @returns string status
-	* @throws ApiError
-	*/
-	static editDeployTo(data) {
-		return request(OpenAPI, {
-			method: "POST",
-			url: "/w/{workspace}/workspaces/edit_deploy_to",
-			path: { workspace: data.workspace },
-			body: data.requestBody,
-			mediaType: "application/json"
-		});
-	}
-	/**
 	* edit auto invite
 	* @param data The data for the request.
 	* @param data.workspace
@@ -2719,6 +2721,23 @@ var WorkspaceService = class {
 		});
 	}
 	/**
+	* edit the workspace's dbt warehouses
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.requestBody dbt warehouses, by name
+	* @returns unknown status
+	* @throws ApiError
+	*/
+	static editDbtWarehouses(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/w/{workspace}/workspaces/edit_dbt_warehouses",
+			path: { workspace: data.workspace },
+			body: data.requestBody,
+			mediaType: "application/json"
+		});
+	}
+	/**
 	* list ducklakes
 	* @param data The data for the request.
 	* @param data.workspace
@@ -4214,6 +4233,17 @@ var SettingService = class {
 		});
 	}
 	/**
+	* list git-sync repositories whose webhook still points at a previous receiver
+	* @returns unknown repositories needing their git sync settings re-saved
+	* @throws ApiError
+	*/
+	static githubAppStaleWebhooks() {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/settings/github_app_stale_webhooks"
+		});
+	}
+	/**
 	* get full instance config (global settings + worker configs)
 	* @returns InstanceConfig full instance configuration
 	* @throws ApiError
@@ -4501,6 +4531,64 @@ var SettingService = class {
 		});
 	}
 };
+var DbtService = class {
+	/**
+	* record the running job's settled dbt nodes
+	* Job-scoped: needs a job token, and the job is taken from the token rather than the body. For workers with no database access.
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.requestBody
+	* @returns unknown recorded
+	* @throws ApiError
+	*/
+	static recordDbtRunProgress(data) {
+		return request(OpenAPI, {
+			method: "POST",
+			url: "/w/{workspace}/dbt/run_progress",
+			path: { workspace: data.workspace },
+			body: data.requestBody,
+			mediaType: "application/json"
+		});
+	}
+	/**
+	* resolve a dbt warehouse to the connection it names
+	* Job-scoped: needs a job token, because the response carries the warehouse's credentials. dbt is unpermissioned by design, so a running job reaches any warehouse the workspace configures.
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.name
+	* @returns DbtWarehouseConnection the connection the warehouse names
+	* @throws ApiError
+	*/
+	static getDbtWarehouse(data) {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/w/{workspace}/dbt/warehouse/{name}",
+			path: {
+				workspace: data.workspace,
+				name: data.name
+			}
+		});
+	}
+	/**
+	* check that a dbt warehouse is configured, without resolving it
+	* Job-scoped: needs a job token. For a project bringing its own `profiles.yml`, which names a warehouse only to say where its assets belong and never opens the connection.
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.name
+	* @returns unknown the warehouse is configured
+	* @throws ApiError
+	*/
+	static dbtWarehouseExists(data) {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/w/{workspace}/dbt/warehouse_exists/{name}",
+			path: {
+				workspace: data.workspace,
+				name: data.name
+			}
+		});
+	}
+};
 var DataMetricService = class {
 	/**
 	* list declared measures and dimensions on DuckLake tables
@@ -10523,6 +10611,95 @@ var JobService = class {
 			}
 		});
 	}
+	/**
+	* Whether a dbt retry by this caller would resume this run
+	* One failed run is saved per script per execution principal, so a `retry` resumes that one — not necessarily the run being looked at. Answers about THIS run alone: its own id when a retry submitted by this caller would resume it, null otherwise (a later run holds the state, the run left nothing to rebuild, or the caller's runs execute as another principal). Authorized through the job, like `run_progress`.
+	*
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.id The job whose script and principal decide the saved failure
+	* @returns string this job's id when a retry would resume it, or null
+	* @throws ApiError
+	*/
+	static getDbtResumable(data) {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/w/{workspace}/jobs/dbt_resumable/{id}",
+			path: {
+				workspace: data.workspace,
+				id: data.id
+			}
+		});
+	}
+	/**
+	* Which run a dbt retry of this script would resume for the caller
+	* A `retry` requires `dbt_retry_job`, and the run form has no job id to hand. Returns the one the caller's own retry would land on — the saved failure for the principal the run would execute as, which is the script's author for an `on_behalf_of` script and the caller otherwise — and only when that run is one the caller may read. Null when there is nothing to resume, or nothing this caller may be told about.
+	*
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.path
+	* @returns string the job id a retry would resume, or null
+	* @throws ApiError
+	*/
+	static getDbtResumableForScript(data) {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/w/{workspace}/jobs/dbt_resumable_script/p/{path}",
+			path: {
+				workspace: data.workspace,
+				path: data.path
+			}
+		});
+	}
+	/**
+	* Get the asset graph as one run saw it
+	* The workspace asset graph with its dbt half pinned to what a single run built. Only a dynamic descriptor (a `{{ }}` placeholder in `vars`) leaves a per-run snapshot; without one for this job the pinned version's own graph answers, so a run page may use this route unconditionally. Authorized through the job, the same gate as `run_progress` — pinning to a run is job-scoped, which is why `assets/graph` cannot do it.
+	*
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.id The job whose graph to render
+	* @param data.assetKinds Filter by asset kinds (comma-separated list)
+	* @param data.folder Scope the graph to runnables in a single folder
+	* @param data.dbtScriptHash Fallback only, for a job that names no deployed script — a preview or a flow. For a script job the version comes from the job row itself, so this is ignored: which deploy's models, SQL and `ref()` lineage are shown is not the caller's to choose.
+	*
+	* @returns AssetGraph asset graph nodes, lineage edges and trigger edges
+	* @throws ApiError
+	*/
+	static getDbtRunGraph(data) {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/w/{workspace}/jobs/dbt_graph/{id}",
+			path: {
+				workspace: data.workspace,
+				id: data.id
+			},
+			query: {
+				asset_kinds: data.assetKinds,
+				folder: data.folder,
+				dbt_script_hash: data.dbtScriptHash
+			}
+		});
+	}
+	/**
+	* List the per-relation progress one job has recorded so far
+	* Live materialization state for the relations a single job writes, keyed by relation. Polled while a run is in flight so a graph can move a node as its model completes. Authorized through the job, so a caller who may not read it is refused rather than told the run has no progress. An empty list means the job exists and has recorded nothing yet, or is unknown to this workspace.
+	*
+	* @param data The data for the request.
+	* @param data.workspace
+	* @param data.id The job whose per-relation progress to read
+	* @returns AssetProgress per-relation status for this run
+	* @throws ApiError
+	*/
+	static getRunProgress(data) {
+		return request(OpenAPI, {
+			method: "GET",
+			url: "/w/{workspace}/jobs/run_progress/{id}",
+			path: {
+				workspace: data.workspace,
+				id: data.id
+			}
+		});
+	}
 };
 var FlowConversationsService = class {
 	/**
@@ -15796,7 +15973,9 @@ var AssetService = class {
 	* @param data.workspace
 	* @param data.assetKinds Filter by asset kinds (comma-separated list)
 	* @param data.folder Scope the graph to runnables in a single folder
-	* @returns unknown asset graph nodes, lineage edges and trigger edges
+	* @param data.dbtScriptHash Render the dbt half of the graph as one version of a dbt script had it, rather than as the currently deployed one. Given this, `folder` no longer scopes the dbt nodes: the pinned version's own models and lineage are the answer, including models a later deploy removed.
+	*
+	* @returns AssetGraph asset graph nodes, lineage edges and trigger edges
 	* @throws ApiError
 	*/
 	static getAssetsGraph(data) {
@@ -15806,7 +15985,8 @@ var AssetService = class {
 			path: { workspace: data.workspace },
 			query: {
 				asset_kinds: data.assetKinds,
-				folder: data.folder
+				folder: data.folder,
+				dbt_script_hash: data.dbtScriptHash
 			}
 		});
 	}
@@ -17762,8 +17942,11 @@ function uint8ArrayToBase64(arrayBuffer) {
 }
 /**
 * Get email from workspace username
-* This method is particularly useful for apps that require the email address of the viewer.
-* Indeed, in the viewer context, WM_USERNAME is set to the username of the viewer but WM_EMAIL is set to the email of the creator of the app.
+* @deprecated Read the contextual variables instead: `process.env.WM_END_USER_EMAIL || process.env.WM_EMAIL`.
+* WM_END_USER_EMAIL is the email of whoever triggered the run when it came from an app, so the fallback
+* yields the app viewer inside an app and the executing user everywhere else - without an extra API call,
+* and unlike this function it also resolves viewers who are not workspace members. An app viewed
+* anonymously has no identity to report: the variable is then empty and the fallback yields the publisher.
 * @param username
 * @returns email address
 */
@@ -18575,6 +18758,7 @@ exports.CaptureService = CaptureService;
 exports.ConcurrencyGroupsService = ConcurrencyGroupsService;
 exports.ConfigService = ConfigService;
 exports.DataMetricService = DataMetricService;
+exports.DbtService = DbtService;
 exports.DocumentationService = DocumentationService;
 exports.DraftService = DraftService;
 exports.EmailTriggerService = EmailTriggerService;

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { ApiError } from "./core/ApiError.mjs";
 import { CancelError, CancelablePromise } from "./core/CancelablePromise.mjs";
 import { OpenAPI } from "./core/OpenAPI.mjs";
-import { AdminService, AgentWorkersService, AmqpTriggerService, AppService, AssetService, AuditService, AzureTriggerService, CaptureService, ConcurrencyGroupsService, ConfigService, DataMetricService, DocumentationService, DraftService, EmailTriggerService, FavoriteService, FlowConversationsService, FlowService, FolderService, GcpTriggerService, GitSyncService, GranularAclService, GroupService, HealthService, HelpersService, HttpTriggerService, HubPublishService, IndexSearchService, InputService, IntegrationService, JobService, KafkaTriggerService, McpOauthService, McpService, MetricsService, MqttTriggerService, NativeTriggerService, NatsTriggerService, NpmProxyService, OauthService, OidcService, OpenapiService, PathAutocompleteService, PostgresTriggerService, RawAppService, ResourceService, ScheduleService, ScriptService, ServiceLogsService, SettingService, SettingsService, SqsTriggerService, TeamsService, TokenService, TriggerService, UserService, VariableService, VolumeService, WebsocketTriggerService, WorkerService, WorkspaceDependenciesService, WorkspaceIntegrationService, WorkspaceService } from "./services.gen.mjs";
+import { AdminService, AgentWorkersService, AmqpTriggerService, AppService, AssetService, AuditService, AzureTriggerService, CaptureService, ConcurrencyGroupsService, ConfigService, DataMetricService, DbtService, DocumentationService, DraftService, EmailTriggerService, FavoriteService, FlowConversationsService, FlowService, FolderService, GcpTriggerService, GitSyncService, GranularAclService, GroupService, HealthService, HelpersService, HttpTriggerService, HubPublishService, IndexSearchService, InputService, IntegrationService, JobService, KafkaTriggerService, McpOauthService, McpService, MetricsService, MqttTriggerService, NativeTriggerService, NatsTriggerService, NpmProxyService, OauthService, OidcService, OpenapiService, PathAutocompleteService, PostgresTriggerService, RawAppService, ResourceService, ScheduleService, ScriptService, ServiceLogsService, SettingService, SettingsService, SqsTriggerService, TeamsService, TokenService, TriggerService, UserService, VariableService, VolumeService, WebsocketTriggerService, WorkerService, WorkspaceDependenciesService, WorkspaceIntegrationService, WorkspaceService } from "./services.gen.mjs";
 import { parseS3Object } from "./s3Types.mjs";
 import { appendPartition, datatable, ducklake, upsertPartition } from "./sqlUtils.mjs";
 import { SHARED_FOLDER, StepSuspend, WorkflowCtx, _workflowCtx, appendToResultStream, base64ToUint8Array, commitKafkaOffsets, databaseUrlFromResource, deleteS3File, denoS3LightClientSettings, getApprovalUrls, getFlowUserState, getIdToken, getInternalState, getPresignedS3PublicUrl, getPresignedS3PublicUrls, getProgress, getResource, getResult, getResultMaybe, getResumeEndpoints, getResumeUrls, getRootJobId, getState, getStatePath, getVariable, getWorkspace, loadS3File, loadS3FileStream, parallel, requestInteractiveSlackApproval, requestInteractiveTeamsApproval, resolveDefaultResource, runFlow, runFlowAsync, runScript, runScriptAsync, runScriptByHash, runScriptByHashAsync, runScriptByPath, runScriptByPathAsync, setClient, setFlowUserState, setInternalState, setProgress, setResource, setState, setVariable, setWorkflowCtx, signS3Object, signS3Objects, sleep, step, streamResult, task, taskFlow, taskScript, uint8ArrayToBase64, usernameToEmail, waitForApproval, waitJob, workflow, writeS3File } from "./client.mjs";
@@ -94,4 +94,4 @@ const wmill = {
 var src_default = wmill;
 
 //#endregion
-export { AdminService, AgentWorkersService, AmqpTriggerService, ApiError, AppService, AssetService, AuditService, AzureTriggerService, CancelError, CancelablePromise, CaptureService, ConcurrencyGroupsService, ConfigService, DataMetricService, DocumentationService, DraftService, EmailTriggerService, FavoriteService, FlowConversationsService, FlowService, FolderService, GcpTriggerService, GitSyncService, GranularAclService, GroupService, HealthService, HelpersService, HttpTriggerService, HubPublishService, IndexSearchService, InputService, IntegrationService, JobService, KafkaTriggerService, McpOauthService, McpService, MetricsService, MqttTriggerService, NativeTriggerService, NatsTriggerService, NpmProxyService, OauthService, OidcService, OpenAPI, OpenapiService, PathAutocompleteService, PostgresTriggerService, RawAppService, ResourceService, ScheduleService, ScriptService, ServiceLogsService, SettingService, SettingsService, SqsTriggerService, StepSuspend, TeamsService, TokenService, TriggerService, UserService, VariableService, VolumeService, WebsocketTriggerService, WorkerService, WorkflowCtx, WorkspaceDependenciesService, WorkspaceIntegrationService, WorkspaceService, _workflowCtx, appendPartition, appendToResultStream, commitKafkaOffsets, datatable, src_default as default, deleteS3File, denoS3LightClientSettings, ducklake, getApprovalUrls, getFlowUserState, getIdToken, getPresignedS3PublicUrl, getPresignedS3PublicUrls, getProgress, getResource, getResumeUrls, getRootJobId, getState, getVariable, loadS3File, loadS3FileStream, parallel, requestInteractiveSlackApproval, requestInteractiveTeamsApproval, runFlow, runFlowAsync, runScript, runScriptAsync, runScriptByHash, runScriptByHashAsync, runScriptByPath, runScriptByPathAsync, setClient, setFlowUserState, setProgress, setResource, setState, setVariable, setWorkflowCtx, signS3Object, signS3Objects, sleep, step, streamResult, task, taskFlow, taskScript, upsertPartition, usernameToEmail, waitForApproval, waitJob, workflow, writeS3File };
+export { AdminService, AgentWorkersService, AmqpTriggerService, ApiError, AppService, AssetService, AuditService, AzureTriggerService, CancelError, CancelablePromise, CaptureService, ConcurrencyGroupsService, ConfigService, DataMetricService, DbtService, DocumentationService, DraftService, EmailTriggerService, FavoriteService, FlowConversationsService, FlowService, FolderService, GcpTriggerService, GitSyncService, GranularAclService, GroupService, HealthService, HelpersService, HttpTriggerService, HubPublishService, IndexSearchService, InputService, IntegrationService, JobService, KafkaTriggerService, McpOauthService, McpService, MetricsService, MqttTriggerService, NativeTriggerService, NatsTriggerService, NpmProxyService, OauthService, OidcService, OpenAPI, OpenapiService, PathAutocompleteService, PostgresTriggerService, RawAppService, ResourceService, ScheduleService, ScriptService, ServiceLogsService, SettingService, SettingsService, SqsTriggerService, StepSuspend, TeamsService, TokenService, TriggerService, UserService, VariableService, VolumeService, WebsocketTriggerService, WorkerService, WorkflowCtx, WorkspaceDependenciesService, WorkspaceIntegrationService, WorkspaceService, _workflowCtx, appendPartition, appendToResultStream, commitKafkaOffsets, datatable, src_default as default, deleteS3File, denoS3LightClientSettings, ducklake, getApprovalUrls, getFlowUserState, getIdToken, getPresignedS3PublicUrl, getPresignedS3PublicUrls, getProgress, getResource, getResumeUrls, getRootJobId, getState, getVariable, loadS3File, loadS3FileStream, parallel, requestInteractiveSlackApproval, requestInteractiveTeamsApproval, runFlow, runFlowAsync, runScript, runScriptAsync, runScriptByHash, runScriptByHashAsync, runScriptByPath, runScriptByPathAsync, setClient, setFlowUserState, setProgress, setResource, setState, setVariable, setWorkflowCtx, signS3Object, signS3Objects, sleep, step, streamResult, task, taskFlow, taskScript, upsertPartition, usernameToEmail, waitForApproval, waitJob, workflow, writeS3File };