windmill-client 1.805.0 → 1.806.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +47 -1
- package/dist/client.mjs +128 -44
- package/dist/core/OpenAPI.mjs +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +261 -47
- package/dist/services.gen.d.ts +78 -3
- package/dist/services.gen.mjs +132 -2
- package/dist/types.gen.d.ts +299 -2
- package/package.json +1 -1
package/dist/types.gen.d.ts
CHANGED
|
@@ -88,6 +88,25 @@ export type AssetGraph = {
|
|
|
88
88
|
*/
|
|
89
89
|
dbt_graph_ingested_at?: string;
|
|
90
90
|
};
|
|
91
|
+
/**
|
|
92
|
+
* The direct column-to-column lineage the asked-for relations' columns sit in — the connected component around them — in the terms the canvas draws: relations and columns, never dbt's node ids.
|
|
93
|
+
*/
|
|
94
|
+
export type DbtColumnLineage = {
|
|
95
|
+
edges: Array<{
|
|
96
|
+
from_asset_path: string;
|
|
97
|
+
from_column: string;
|
|
98
|
+
to_asset_path: string;
|
|
99
|
+
to_column: string;
|
|
100
|
+
/**
|
|
101
|
+
* dbt's own word for how the value travelled — `copy` (passthrough) or `mod` (transformed). Not an enum: the engine treats the set as open.
|
|
102
|
+
*/
|
|
103
|
+
kind: string;
|
|
104
|
+
}>;
|
|
105
|
+
/**
|
|
106
|
+
* The component reaches further than `edges`, which holds the part nearest the asked-for relations. A trace that stops short is otherwise indistinguishable from one that ends.
|
|
107
|
+
*/
|
|
108
|
+
truncated: boolean;
|
|
109
|
+
};
|
|
91
110
|
/**
|
|
92
111
|
* What dbt says about the model, snapshot, seed or source that produces (or, for a source, is read at) this relation. A dbt project is one runnable node with many model assets, so per-model metadata belongs here rather than on the script.
|
|
93
112
|
*/
|
|
@@ -122,11 +141,21 @@ export type DbtAssetProvenance = {
|
|
|
122
141
|
severity?: string;
|
|
123
142
|
}>;
|
|
124
143
|
/**
|
|
125
|
-
* Declared column metadata (name -> description)
|
|
144
|
+
* Declared column metadata (name -> description) — what `manifest.json` carries, which is only the columns an author wrote down. Omitted when the caller cannot read the script.
|
|
126
145
|
*/
|
|
127
146
|
columns?: {
|
|
128
147
|
[key: string]: unknown;
|
|
129
148
|
};
|
|
149
|
+
/**
|
|
150
|
+
* Every column of the relation, typed and in the order the model produces them, from the engine's static analysis. Present only for a project that opted into it, and gated like `columns` and the model's SQL: a full column list is the shape of what the author wrote.
|
|
151
|
+
*/
|
|
152
|
+
column_schema?: Array<{
|
|
153
|
+
name: string;
|
|
154
|
+
/**
|
|
155
|
+
* The declared type where `schema.yml` gives one, else the inferred one. Omitted when neither is known.
|
|
156
|
+
*/
|
|
157
|
+
type?: string;
|
|
158
|
+
}>;
|
|
130
159
|
/**
|
|
131
160
|
* A source's declared freshness policy, for the staleness chip.
|
|
132
161
|
*/
|
|
@@ -6026,6 +6055,36 @@ export type GitRepositorySettings = {
|
|
|
6026
6055
|
* server-owned, last failure opening a PR for a deploy branch of this repo
|
|
6027
6056
|
*/
|
|
6028
6057
|
open_pr_error?: string;
|
|
6058
|
+
credential?: GitCredentialStatus;
|
|
6059
|
+
};
|
|
6060
|
+
/**
|
|
6061
|
+
* server-owned, what the repo's own credential reports about itself
|
|
6062
|
+
*/
|
|
6063
|
+
export type GitCredentialStatus = {
|
|
6064
|
+
provider: 'gitlab';
|
|
6065
|
+
token_id?: number;
|
|
6066
|
+
/**
|
|
6067
|
+
* absent for a non-expiring token
|
|
6068
|
+
*/
|
|
6069
|
+
expires_at?: string;
|
|
6070
|
+
scopes?: Array<(string)>;
|
|
6071
|
+
/**
|
|
6072
|
+
* whether this workspace renews the credential itself
|
|
6073
|
+
*/
|
|
6074
|
+
rotatable: boolean;
|
|
6075
|
+
checked_at: number;
|
|
6076
|
+
error?: string;
|
|
6077
|
+
};
|
|
6078
|
+
/**
|
|
6079
|
+
* a GitLab project a token can sync, as the resource form needs it
|
|
6080
|
+
*/
|
|
6081
|
+
export type GitlabProject = {
|
|
6082
|
+
/**
|
|
6083
|
+
* nested group path plus project name, which is also GitLab's project id
|
|
6084
|
+
*/
|
|
6085
|
+
path_with_namespace: string;
|
|
6086
|
+
http_url_to_repo: string;
|
|
6087
|
+
default_branch?: string;
|
|
6029
6088
|
};
|
|
6030
6089
|
export type AutoPullMode = 'auto' | 'webhook' | 'polling';
|
|
6031
6090
|
export type AutoPullStatus = {
|
|
@@ -6706,6 +6765,10 @@ export type NativeTrigger = {
|
|
|
6706
6765
|
* Short summary to be displayed when listed
|
|
6707
6766
|
*/
|
|
6708
6767
|
summary?: string | null;
|
|
6768
|
+
/**
|
|
6769
|
+
* Whether the trigger starts a job when it fires
|
|
6770
|
+
*/
|
|
6771
|
+
enabled: boolean;
|
|
6709
6772
|
};
|
|
6710
6773
|
/**
|
|
6711
6774
|
* Full trigger response containing both Windmill data and external service data
|
|
@@ -6742,6 +6805,10 @@ export type NativeTriggerWithExternal = {
|
|
|
6742
6805
|
* Short summary to be displayed when listed
|
|
6743
6806
|
*/
|
|
6744
6807
|
summary?: string | null;
|
|
6808
|
+
/**
|
|
6809
|
+
* Whether the trigger starts a job when it fires
|
|
6810
|
+
*/
|
|
6811
|
+
enabled: boolean;
|
|
6745
6812
|
/**
|
|
6746
6813
|
* Configuration data from the external service. Null when the service has no such API, or when it could not be read — see external_error.
|
|
6747
6814
|
*/
|
|
@@ -6812,6 +6879,10 @@ export type NativeTriggerData = {
|
|
|
6812
6879
|
* Short summary to be displayed when listed
|
|
6813
6880
|
*/
|
|
6814
6881
|
summary?: string | null;
|
|
6882
|
+
/**
|
|
6883
|
+
* Whether the trigger starts a job when it fires. Honoured on create only, so a trigger can be registered already paused; an update ignores it and setenabled is the only way to change an existing trigger's state. Defaults to true.
|
|
6884
|
+
*/
|
|
6885
|
+
enabled?: boolean;
|
|
6815
6886
|
};
|
|
6816
6887
|
/**
|
|
6817
6888
|
* Response returned when a native trigger is created
|
|
@@ -7762,6 +7833,49 @@ export type ImportInstallationData = {
|
|
|
7762
7833
|
workspace: string;
|
|
7763
7834
|
};
|
|
7764
7835
|
export type ImportInstallationResponse = unknown;
|
|
7836
|
+
export type ListGitlabProjectsData = {
|
|
7837
|
+
requestBody: {
|
|
7838
|
+
/**
|
|
7839
|
+
* The GitLab instance, e.g. https://gitlab.com
|
|
7840
|
+
*/
|
|
7841
|
+
base_url: string;
|
|
7842
|
+
/**
|
|
7843
|
+
* A project access token with the api scope, or a group token that reaches the project
|
|
7844
|
+
*/
|
|
7845
|
+
token: string;
|
|
7846
|
+
/**
|
|
7847
|
+
* Narrow the list to projects matching this text
|
|
7848
|
+
*/
|
|
7849
|
+
search?: string;
|
|
7850
|
+
};
|
|
7851
|
+
workspace: string;
|
|
7852
|
+
};
|
|
7853
|
+
export type ListGitlabProjectsResponse = Array<GitlabProject>;
|
|
7854
|
+
export type GetCredentialOriginData = {
|
|
7855
|
+
/**
|
|
7856
|
+
* Path of the git repository resource, with or without the `$res:` prefix. A path rather than a URL, because a resource URL may carry a token and a URL in a query string lands in logs.
|
|
7857
|
+
*/
|
|
7858
|
+
path: string;
|
|
7859
|
+
workspace: string;
|
|
7860
|
+
};
|
|
7861
|
+
export type GetCredentialOriginResponse = {
|
|
7862
|
+
origin?: 'held' | 'borrowed';
|
|
7863
|
+
provider?: 'gitlab';
|
|
7864
|
+
};
|
|
7865
|
+
export type SetGitCredentialData = {
|
|
7866
|
+
requestBody: {
|
|
7867
|
+
/**
|
|
7868
|
+
* The repository the credential is for, and the key it is stored under. It is served for this repository and no other, so repointing a resource elsewhere cannot carry the token along.
|
|
7869
|
+
*/
|
|
7870
|
+
repo_url: string;
|
|
7871
|
+
/**
|
|
7872
|
+
* The access token, as pasted
|
|
7873
|
+
*/
|
|
7874
|
+
token: string;
|
|
7875
|
+
};
|
|
7876
|
+
workspace: string;
|
|
7877
|
+
};
|
|
7878
|
+
export type SetGitCredentialResponse = string;
|
|
7765
7879
|
export type GhesInstallationCallbackData = {
|
|
7766
7880
|
requestBody: {
|
|
7767
7881
|
/**
|
|
@@ -14266,6 +14380,19 @@ export type GetDbtRunGraphData = {
|
|
|
14266
14380
|
workspace: string;
|
|
14267
14381
|
};
|
|
14268
14382
|
export type GetDbtRunGraphResponse = AssetGraph;
|
|
14383
|
+
export type GetDbtRunColumnLineageData = {
|
|
14384
|
+
/**
|
|
14385
|
+
* The `dbt://` relations whose lineage to return. Repeated, once per relation, and answered as one union. At least one, and at most 1000 — a request naming none, or more than that, is refused rather than answered with an empty component.
|
|
14386
|
+
*
|
|
14387
|
+
*/
|
|
14388
|
+
assetPath: Array<(string)>;
|
|
14389
|
+
/**
|
|
14390
|
+
* The job whose graph the lineage is read from
|
|
14391
|
+
*/
|
|
14392
|
+
id: string;
|
|
14393
|
+
workspace: string;
|
|
14394
|
+
};
|
|
14395
|
+
export type GetDbtRunColumnLineageResponse = DbtColumnLineage;
|
|
14269
14396
|
export type GetRunProgressData = {
|
|
14270
14397
|
/**
|
|
14271
14398
|
* The job whose per-relation progress to read
|
|
@@ -15428,6 +15555,21 @@ export type DeleteNativeTriggerData = {
|
|
|
15428
15555
|
workspace: string;
|
|
15429
15556
|
};
|
|
15430
15557
|
export type DeleteNativeTriggerResponse = string;
|
|
15558
|
+
export type SetNativeTriggerEnabledData = {
|
|
15559
|
+
/**
|
|
15560
|
+
* The external ID of the trigger from the external service
|
|
15561
|
+
*/
|
|
15562
|
+
externalId: string;
|
|
15563
|
+
/**
|
|
15564
|
+
* updated enabled state
|
|
15565
|
+
*/
|
|
15566
|
+
requestBody: {
|
|
15567
|
+
enabled: boolean;
|
|
15568
|
+
};
|
|
15569
|
+
serviceName: NativeServiceName;
|
|
15570
|
+
workspace: string;
|
|
15571
|
+
};
|
|
15572
|
+
export type SetNativeTriggerEnabledResponse = string;
|
|
15431
15573
|
export type ListNativeTriggersData = {
|
|
15432
15574
|
/**
|
|
15433
15575
|
* When true, append per-user draft rows whose path has no
|
|
@@ -17473,6 +17615,21 @@ export type GetAssetsGraphData = {
|
|
|
17473
17615
|
workspace: string;
|
|
17474
17616
|
};
|
|
17475
17617
|
export type GetAssetsGraphResponse = AssetGraph;
|
|
17618
|
+
export type GetDbtColumnLineageData = {
|
|
17619
|
+
/**
|
|
17620
|
+
* The `dbt://` relations whose lineage to return. Repeated, once per relation, and answered as one union. At least one, and at most 1000 — a request naming none, or more than that, is refused rather than answered with an empty component.
|
|
17621
|
+
*
|
|
17622
|
+
*/
|
|
17623
|
+
assetPath: Array<(string)>;
|
|
17624
|
+
/**
|
|
17625
|
+
* The deployed version a view is drawing, when it is drawing one — the dbt editor, which shows a single project as of a single deploy. A version-pinned answer is that version's project alone, the same as a job-pinned one, and only the unpinned answer crosses projects: a pin says which stored graph is on screen, and another project's live graph is not part of it.
|
|
17626
|
+
* A run's or an editor buffer's own graph is not reachable here: that pins to a job, and costs the job-read gate — see `jobs/dbt_column_lineage/{id}`.
|
|
17627
|
+
*
|
|
17628
|
+
*/
|
|
17629
|
+
dbtScriptHash?: string;
|
|
17630
|
+
workspace: string;
|
|
17631
|
+
};
|
|
17632
|
+
export type GetDbtColumnLineageResponse = DbtColumnLineage;
|
|
17476
17633
|
export type ListWorkspaceMacrosData = {
|
|
17477
17634
|
workspace: string;
|
|
17478
17635
|
};
|
|
@@ -19057,6 +19214,76 @@ export type $OpenApiTs = {
|
|
|
19057
19214
|
};
|
|
19058
19215
|
};
|
|
19059
19216
|
};
|
|
19217
|
+
'/w/{workspace}/git_sync/gitlab/projects': {
|
|
19218
|
+
post: {
|
|
19219
|
+
req: {
|
|
19220
|
+
requestBody: {
|
|
19221
|
+
/**
|
|
19222
|
+
* The GitLab instance, e.g. https://gitlab.com
|
|
19223
|
+
*/
|
|
19224
|
+
base_url: string;
|
|
19225
|
+
/**
|
|
19226
|
+
* A project access token with the api scope, or a group token that reaches the project
|
|
19227
|
+
*/
|
|
19228
|
+
token: string;
|
|
19229
|
+
/**
|
|
19230
|
+
* Narrow the list to projects matching this text
|
|
19231
|
+
*/
|
|
19232
|
+
search?: string;
|
|
19233
|
+
};
|
|
19234
|
+
workspace: string;
|
|
19235
|
+
};
|
|
19236
|
+
res: {
|
|
19237
|
+
/**
|
|
19238
|
+
* the projects the token can sync
|
|
19239
|
+
*/
|
|
19240
|
+
200: Array<GitlabProject>;
|
|
19241
|
+
};
|
|
19242
|
+
};
|
|
19243
|
+
};
|
|
19244
|
+
'/w/{workspace}/git_sync/credential/origin': {
|
|
19245
|
+
get: {
|
|
19246
|
+
req: {
|
|
19247
|
+
/**
|
|
19248
|
+
* Path of the git repository resource, with or without the `$res:` prefix. A path rather than a URL, because a resource URL may carry a token and a URL in a query string lands in logs.
|
|
19249
|
+
*/
|
|
19250
|
+
path: string;
|
|
19251
|
+
workspace: string;
|
|
19252
|
+
};
|
|
19253
|
+
res: {
|
|
19254
|
+
/**
|
|
19255
|
+
* where the credential comes from
|
|
19256
|
+
*/
|
|
19257
|
+
200: {
|
|
19258
|
+
origin?: 'held' | 'borrowed';
|
|
19259
|
+
provider?: 'gitlab';
|
|
19260
|
+
};
|
|
19261
|
+
};
|
|
19262
|
+
};
|
|
19263
|
+
};
|
|
19264
|
+
'/w/{workspace}/git_sync/credential': {
|
|
19265
|
+
post: {
|
|
19266
|
+
req: {
|
|
19267
|
+
requestBody: {
|
|
19268
|
+
/**
|
|
19269
|
+
* The repository the credential is for, and the key it is stored under. It is served for this repository and no other, so repointing a resource elsewhere cannot carry the token along.
|
|
19270
|
+
*/
|
|
19271
|
+
repo_url: string;
|
|
19272
|
+
/**
|
|
19273
|
+
* The access token, as pasted
|
|
19274
|
+
*/
|
|
19275
|
+
token: string;
|
|
19276
|
+
};
|
|
19277
|
+
workspace: string;
|
|
19278
|
+
};
|
|
19279
|
+
res: {
|
|
19280
|
+
/**
|
|
19281
|
+
* the credential was stored
|
|
19282
|
+
*/
|
|
19283
|
+
200: string;
|
|
19284
|
+
};
|
|
19285
|
+
};
|
|
19286
|
+
};
|
|
19060
19287
|
'/w/{workspace}/github_app/ghes_installation_callback': {
|
|
19061
19288
|
post: {
|
|
19062
19289
|
req: {
|
|
@@ -19376,7 +19603,7 @@ export type $OpenApiTs = {
|
|
|
19376
19603
|
};
|
|
19377
19604
|
res: {
|
|
19378
19605
|
/**
|
|
19379
|
-
*
|
|
19606
|
+
* git credential
|
|
19380
19607
|
*/
|
|
19381
19608
|
200: {
|
|
19382
19609
|
token: string;
|
|
@@ -29799,6 +30026,28 @@ export type $OpenApiTs = {
|
|
|
29799
30026
|
};
|
|
29800
30027
|
};
|
|
29801
30028
|
};
|
|
30029
|
+
'/w/{workspace}/jobs/dbt_column_lineage/{id}': {
|
|
30030
|
+
get: {
|
|
30031
|
+
req: {
|
|
30032
|
+
/**
|
|
30033
|
+
* The `dbt://` relations whose lineage to return. Repeated, once per relation, and answered as one union. At least one, and at most 1000 — a request naming none, or more than that, is refused rather than answered with an empty component.
|
|
30034
|
+
*
|
|
30035
|
+
*/
|
|
30036
|
+
assetPath: Array<(string)>;
|
|
30037
|
+
/**
|
|
30038
|
+
* The job whose graph the lineage is read from
|
|
30039
|
+
*/
|
|
30040
|
+
id: string;
|
|
30041
|
+
workspace: string;
|
|
30042
|
+
};
|
|
30043
|
+
res: {
|
|
30044
|
+
/**
|
|
30045
|
+
* the relations' column-level lineage
|
|
30046
|
+
*/
|
|
30047
|
+
200: DbtColumnLineage;
|
|
30048
|
+
};
|
|
30049
|
+
};
|
|
30050
|
+
};
|
|
29802
30051
|
'/w/{workspace}/jobs/run_progress/{id}': {
|
|
29803
30052
|
get: {
|
|
29804
30053
|
req: {
|
|
@@ -31797,6 +32046,30 @@ export type $OpenApiTs = {
|
|
|
31797
32046
|
};
|
|
31798
32047
|
};
|
|
31799
32048
|
};
|
|
32049
|
+
'/w/{workspace}/native_triggers/{service_name}/setenabled/{external_id}': {
|
|
32050
|
+
post: {
|
|
32051
|
+
req: {
|
|
32052
|
+
/**
|
|
32053
|
+
* The external ID of the trigger from the external service
|
|
32054
|
+
*/
|
|
32055
|
+
externalId: string;
|
|
32056
|
+
/**
|
|
32057
|
+
* updated enabled state
|
|
32058
|
+
*/
|
|
32059
|
+
requestBody: {
|
|
32060
|
+
enabled: boolean;
|
|
32061
|
+
};
|
|
32062
|
+
serviceName: NativeServiceName;
|
|
32063
|
+
workspace: string;
|
|
32064
|
+
};
|
|
32065
|
+
res: {
|
|
32066
|
+
/**
|
|
32067
|
+
* native trigger enabled state updated
|
|
32068
|
+
*/
|
|
32069
|
+
200: string;
|
|
32070
|
+
};
|
|
32071
|
+
};
|
|
32072
|
+
};
|
|
31800
32073
|
'/w/{workspace}/native_triggers/{service_name}/list': {
|
|
31801
32074
|
get: {
|
|
31802
32075
|
req: {
|
|
@@ -35516,6 +35789,30 @@ export type $OpenApiTs = {
|
|
|
35516
35789
|
};
|
|
35517
35790
|
};
|
|
35518
35791
|
};
|
|
35792
|
+
'/w/{workspace}/assets/column_lineage': {
|
|
35793
|
+
get: {
|
|
35794
|
+
req: {
|
|
35795
|
+
/**
|
|
35796
|
+
* The `dbt://` relations whose lineage to return. Repeated, once per relation, and answered as one union. At least one, and at most 1000 — a request naming none, or more than that, is refused rather than answered with an empty component.
|
|
35797
|
+
*
|
|
35798
|
+
*/
|
|
35799
|
+
assetPath: Array<(string)>;
|
|
35800
|
+
/**
|
|
35801
|
+
* The deployed version a view is drawing, when it is drawing one — the dbt editor, which shows a single project as of a single deploy. A version-pinned answer is that version's project alone, the same as a job-pinned one, and only the unpinned answer crosses projects: a pin says which stored graph is on screen, and another project's live graph is not part of it.
|
|
35802
|
+
* A run's or an editor buffer's own graph is not reachable here: that pins to a job, and costs the job-read gate — see `jobs/dbt_column_lineage/{id}`.
|
|
35803
|
+
*
|
|
35804
|
+
*/
|
|
35805
|
+
dbtScriptHash?: string;
|
|
35806
|
+
workspace: string;
|
|
35807
|
+
};
|
|
35808
|
+
res: {
|
|
35809
|
+
/**
|
|
35810
|
+
* the relations' column-level lineage
|
|
35811
|
+
*/
|
|
35812
|
+
200: DbtColumnLineage;
|
|
35813
|
+
};
|
|
35814
|
+
};
|
|
35815
|
+
};
|
|
35519
35816
|
'/w/{workspace}/assets/macros': {
|
|
35520
35817
|
get: {
|
|
35521
35818
|
req: {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "windmill-client",
|
|
3
3
|
"description": "Windmill SDK client for browsers and Node.js",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.806.0",
|
|
5
5
|
"author": "Ruben Fiszel",
|
|
6
6
|
"license": "Apache 2.0",
|
|
7
7
|
"homepage": "https://github.com/windmill-labs/windmill/tree/main/typescript-client#readme",
|