windmill-client 1.805.0 → 1.807.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.
@@ -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). NOT column lineage — `manifest.json` carries none.
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
  */
@@ -2608,9 +2637,10 @@ export type ExternalJwtToken = {
2608
2637
  last_used_at: string;
2609
2638
  };
2610
2639
  /**
2611
- * Guests are free up to `free_allowance` distinct emails over the trailing `window_days`. Past that an Enterprise plan meters them (`metered`, four guests to one seat: `billable_guests`, `guest_seats`); every other plan and build admits no new email until the count drops. `instance_enabled` is the superadmin switch (`guest_access_disabled` global setting) every workspace switch sits under.
2640
+ * Guests are free up to `free_allowance` distinct emails over the trailing `window_days`. Past that an Enterprise plan meters them (`metered`, four guests to one seat: `billable_guests`, `guest_seats`); every other plan and build admits no new email until the count drops. `instance_enabled` is the superadmin switch (`guest_access_disabled` global setting) every workspace switch sits under. `available` is whether this deployment can have guests at all: false on the shared cloud, where guest access requires a self-hosted or dedicated deployment, and every other field and switch is then moot.
2612
2641
  */
2613
2642
  export type GuestUsage = {
2643
+ available: boolean;
2614
2644
  instance_enabled: boolean;
2615
2645
  guest_count: number;
2616
2646
  window_days: number;
@@ -6026,6 +6056,36 @@ export type GitRepositorySettings = {
6026
6056
  * server-owned, last failure opening a PR for a deploy branch of this repo
6027
6057
  */
6028
6058
  open_pr_error?: string;
6059
+ credential?: GitCredentialStatus;
6060
+ };
6061
+ /**
6062
+ * server-owned, what the repo's own credential reports about itself
6063
+ */
6064
+ export type GitCredentialStatus = {
6065
+ provider: 'gitlab';
6066
+ token_id?: number;
6067
+ /**
6068
+ * absent for a non-expiring token
6069
+ */
6070
+ expires_at?: string;
6071
+ scopes?: Array<(string)>;
6072
+ /**
6073
+ * whether this workspace renews the credential itself
6074
+ */
6075
+ rotatable: boolean;
6076
+ checked_at: number;
6077
+ error?: string;
6078
+ };
6079
+ /**
6080
+ * a GitLab project a token can sync, as the resource form needs it
6081
+ */
6082
+ export type GitlabProject = {
6083
+ /**
6084
+ * nested group path plus project name, which is also GitLab's project id
6085
+ */
6086
+ path_with_namespace: string;
6087
+ http_url_to_repo: string;
6088
+ default_branch?: string;
6029
6089
  };
6030
6090
  export type AutoPullMode = 'auto' | 'webhook' | 'polling';
6031
6091
  export type AutoPullStatus = {
@@ -6706,6 +6766,10 @@ export type NativeTrigger = {
6706
6766
  * Short summary to be displayed when listed
6707
6767
  */
6708
6768
  summary?: string | null;
6769
+ /**
6770
+ * Whether the trigger starts a job when it fires
6771
+ */
6772
+ enabled: boolean;
6709
6773
  };
6710
6774
  /**
6711
6775
  * Full trigger response containing both Windmill data and external service data
@@ -6742,6 +6806,10 @@ export type NativeTriggerWithExternal = {
6742
6806
  * Short summary to be displayed when listed
6743
6807
  */
6744
6808
  summary?: string | null;
6809
+ /**
6810
+ * Whether the trigger starts a job when it fires
6811
+ */
6812
+ enabled: boolean;
6745
6813
  /**
6746
6814
  * 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
6815
  */
@@ -6812,6 +6880,10 @@ export type NativeTriggerData = {
6812
6880
  * Short summary to be displayed when listed
6813
6881
  */
6814
6882
  summary?: string | null;
6883
+ /**
6884
+ * 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.
6885
+ */
6886
+ enabled?: boolean;
6815
6887
  };
6816
6888
  /**
6817
6889
  * Response returned when a native trigger is created
@@ -7762,6 +7834,49 @@ export type ImportInstallationData = {
7762
7834
  workspace: string;
7763
7835
  };
7764
7836
  export type ImportInstallationResponse = unknown;
7837
+ export type ListGitlabProjectsData = {
7838
+ requestBody: {
7839
+ /**
7840
+ * The GitLab instance, e.g. https://gitlab.com
7841
+ */
7842
+ base_url: string;
7843
+ /**
7844
+ * A project access token with the api scope, or a group token that reaches the project
7845
+ */
7846
+ token: string;
7847
+ /**
7848
+ * Narrow the list to projects matching this text
7849
+ */
7850
+ search?: string;
7851
+ };
7852
+ workspace: string;
7853
+ };
7854
+ export type ListGitlabProjectsResponse = Array<GitlabProject>;
7855
+ export type GetCredentialOriginData = {
7856
+ /**
7857
+ * 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.
7858
+ */
7859
+ path: string;
7860
+ workspace: string;
7861
+ };
7862
+ export type GetCredentialOriginResponse = {
7863
+ origin?: 'held' | 'borrowed';
7864
+ provider?: 'gitlab';
7865
+ };
7866
+ export type SetGitCredentialData = {
7867
+ requestBody: {
7868
+ /**
7869
+ * 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.
7870
+ */
7871
+ repo_url: string;
7872
+ /**
7873
+ * The access token, as pasted
7874
+ */
7875
+ token: string;
7876
+ };
7877
+ workspace: string;
7878
+ };
7879
+ export type SetGitCredentialResponse = string;
7765
7880
  export type GhesInstallationCallbackData = {
7766
7881
  requestBody: {
7767
7882
  /**
@@ -14266,6 +14381,19 @@ export type GetDbtRunGraphData = {
14266
14381
  workspace: string;
14267
14382
  };
14268
14383
  export type GetDbtRunGraphResponse = AssetGraph;
14384
+ export type GetDbtRunColumnLineageData = {
14385
+ /**
14386
+ * 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.
14387
+ *
14388
+ */
14389
+ assetPath: Array<(string)>;
14390
+ /**
14391
+ * The job whose graph the lineage is read from
14392
+ */
14393
+ id: string;
14394
+ workspace: string;
14395
+ };
14396
+ export type GetDbtRunColumnLineageResponse = DbtColumnLineage;
14269
14397
  export type GetRunProgressData = {
14270
14398
  /**
14271
14399
  * The job whose per-relation progress to read
@@ -15428,6 +15556,21 @@ export type DeleteNativeTriggerData = {
15428
15556
  workspace: string;
15429
15557
  };
15430
15558
  export type DeleteNativeTriggerResponse = string;
15559
+ export type SetNativeTriggerEnabledData = {
15560
+ /**
15561
+ * The external ID of the trigger from the external service
15562
+ */
15563
+ externalId: string;
15564
+ /**
15565
+ * updated enabled state
15566
+ */
15567
+ requestBody: {
15568
+ enabled: boolean;
15569
+ };
15570
+ serviceName: NativeServiceName;
15571
+ workspace: string;
15572
+ };
15573
+ export type SetNativeTriggerEnabledResponse = string;
15431
15574
  export type ListNativeTriggersData = {
15432
15575
  /**
15433
15576
  * When true, append per-user draft rows whose path has no
@@ -17473,6 +17616,21 @@ export type GetAssetsGraphData = {
17473
17616
  workspace: string;
17474
17617
  };
17475
17618
  export type GetAssetsGraphResponse = AssetGraph;
17619
+ export type GetDbtColumnLineageData = {
17620
+ /**
17621
+ * 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.
17622
+ *
17623
+ */
17624
+ assetPath: Array<(string)>;
17625
+ /**
17626
+ * 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.
17627
+ * 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}`.
17628
+ *
17629
+ */
17630
+ dbtScriptHash?: string;
17631
+ workspace: string;
17632
+ };
17633
+ export type GetDbtColumnLineageResponse = DbtColumnLineage;
17476
17634
  export type ListWorkspaceMacrosData = {
17477
17635
  workspace: string;
17478
17636
  };
@@ -17842,6 +18000,10 @@ export type DiscardHubProjectUpdateData = {
17842
18000
  workspace: string;
17843
18001
  };
17844
18002
  export type DiscardHubProjectUpdateResponse = string;
18003
+ export type ListHubProjectsData = {
18004
+ workspace: string;
18005
+ };
18006
+ export type ListHubProjectsResponse = string;
17845
18007
  export type GetHubProjectBySourceData = {
17846
18008
  /**
17847
18009
  * workspace folder scoping the Hub publication: a workspace can publish
@@ -19057,6 +19219,76 @@ export type $OpenApiTs = {
19057
19219
  };
19058
19220
  };
19059
19221
  };
19222
+ '/w/{workspace}/git_sync/gitlab/projects': {
19223
+ post: {
19224
+ req: {
19225
+ requestBody: {
19226
+ /**
19227
+ * The GitLab instance, e.g. https://gitlab.com
19228
+ */
19229
+ base_url: string;
19230
+ /**
19231
+ * A project access token with the api scope, or a group token that reaches the project
19232
+ */
19233
+ token: string;
19234
+ /**
19235
+ * Narrow the list to projects matching this text
19236
+ */
19237
+ search?: string;
19238
+ };
19239
+ workspace: string;
19240
+ };
19241
+ res: {
19242
+ /**
19243
+ * the projects the token can sync
19244
+ */
19245
+ 200: Array<GitlabProject>;
19246
+ };
19247
+ };
19248
+ };
19249
+ '/w/{workspace}/git_sync/credential/origin': {
19250
+ get: {
19251
+ req: {
19252
+ /**
19253
+ * 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.
19254
+ */
19255
+ path: string;
19256
+ workspace: string;
19257
+ };
19258
+ res: {
19259
+ /**
19260
+ * where the credential comes from
19261
+ */
19262
+ 200: {
19263
+ origin?: 'held' | 'borrowed';
19264
+ provider?: 'gitlab';
19265
+ };
19266
+ };
19267
+ };
19268
+ };
19269
+ '/w/{workspace}/git_sync/credential': {
19270
+ post: {
19271
+ req: {
19272
+ requestBody: {
19273
+ /**
19274
+ * 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.
19275
+ */
19276
+ repo_url: string;
19277
+ /**
19278
+ * The access token, as pasted
19279
+ */
19280
+ token: string;
19281
+ };
19282
+ workspace: string;
19283
+ };
19284
+ res: {
19285
+ /**
19286
+ * the credential was stored
19287
+ */
19288
+ 200: string;
19289
+ };
19290
+ };
19291
+ };
19060
19292
  '/w/{workspace}/github_app/ghes_installation_callback': {
19061
19293
  post: {
19062
19294
  req: {
@@ -19376,7 +19608,7 @@ export type $OpenApiTs = {
19376
19608
  };
19377
19609
  res: {
19378
19610
  /**
19379
- * github app token
19611
+ * git credential
19380
19612
  */
19381
19613
  200: {
19382
19614
  token: string;
@@ -29799,6 +30031,28 @@ export type $OpenApiTs = {
29799
30031
  };
29800
30032
  };
29801
30033
  };
30034
+ '/w/{workspace}/jobs/dbt_column_lineage/{id}': {
30035
+ get: {
30036
+ req: {
30037
+ /**
30038
+ * 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.
30039
+ *
30040
+ */
30041
+ assetPath: Array<(string)>;
30042
+ /**
30043
+ * The job whose graph the lineage is read from
30044
+ */
30045
+ id: string;
30046
+ workspace: string;
30047
+ };
30048
+ res: {
30049
+ /**
30050
+ * the relations' column-level lineage
30051
+ */
30052
+ 200: DbtColumnLineage;
30053
+ };
30054
+ };
30055
+ };
29802
30056
  '/w/{workspace}/jobs/run_progress/{id}': {
29803
30057
  get: {
29804
30058
  req: {
@@ -31797,6 +32051,30 @@ export type $OpenApiTs = {
31797
32051
  };
31798
32052
  };
31799
32053
  };
32054
+ '/w/{workspace}/native_triggers/{service_name}/setenabled/{external_id}': {
32055
+ post: {
32056
+ req: {
32057
+ /**
32058
+ * The external ID of the trigger from the external service
32059
+ */
32060
+ externalId: string;
32061
+ /**
32062
+ * updated enabled state
32063
+ */
32064
+ requestBody: {
32065
+ enabled: boolean;
32066
+ };
32067
+ serviceName: NativeServiceName;
32068
+ workspace: string;
32069
+ };
32070
+ res: {
32071
+ /**
32072
+ * native trigger enabled state updated
32073
+ */
32074
+ 200: string;
32075
+ };
32076
+ };
32077
+ };
31800
32078
  '/w/{workspace}/native_triggers/{service_name}/list': {
31801
32079
  get: {
31802
32080
  req: {
@@ -35516,6 +35794,30 @@ export type $OpenApiTs = {
35516
35794
  };
35517
35795
  };
35518
35796
  };
35797
+ '/w/{workspace}/assets/column_lineage': {
35798
+ get: {
35799
+ req: {
35800
+ /**
35801
+ * 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.
35802
+ *
35803
+ */
35804
+ assetPath: Array<(string)>;
35805
+ /**
35806
+ * 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.
35807
+ * 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}`.
35808
+ *
35809
+ */
35810
+ dbtScriptHash?: string;
35811
+ workspace: string;
35812
+ };
35813
+ res: {
35814
+ /**
35815
+ * the relations' column-level lineage
35816
+ */
35817
+ 200: DbtColumnLineage;
35818
+ };
35819
+ };
35820
+ };
35519
35821
  '/w/{workspace}/assets/macros': {
35520
35822
  get: {
35521
35823
  req: {
@@ -36165,6 +36467,23 @@ export type $OpenApiTs = {
36165
36467
  };
36166
36468
  };
36167
36469
  };
36470
+ '/w/{workspace}/hub/projects': {
36471
+ get: {
36472
+ req: {
36473
+ workspace: string;
36474
+ };
36475
+ res: {
36476
+ /**
36477
+ * raw Hub response body (status code is passed through from the Hub)
36478
+ */
36479
+ 200: string;
36480
+ /**
36481
+ * the Hub is disabled on this instance
36482
+ */
36483
+ 400: unknown;
36484
+ };
36485
+ };
36486
+ };
36168
36487
  '/w/{workspace}/hub/project': {
36169
36488
  get: {
36170
36489
  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.805.0",
4
+ "version": "1.807.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",