@keboola/api-fixtures 30.0.0 → 34.0.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.
Files changed (9) hide show
  1. package/AGENTS.md +3 -0
  2. package/CHANGELOG.md +54 -0
  3. package/dist/index.cjs +128 -121
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.cts +94 -199
  6. package/dist/index.d.ts +94 -199
  7. package/dist/index.js +126 -122
  8. package/dist/index.js.map +1 -1
  9. package/package.json +6 -6
package/dist/index.d.cts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { App, AppRun, Deployment } from "@keboola/api-client/apps/types";
2
+ import { BusinessWorkspaceDashboard, BusinessWorkspaceDashboardSummary, DashboardInput } from "@keboola/api-client/businessWorkspaceApi/types";
2
3
  import { AdminVendor, App as App$1, AppChange, ServiceAccount, User, Vendor, VendorListItem } from "@keboola/api-client/developerPortal/types";
3
4
  import { ServiceId } from "@keboola/api-client/constants";
4
5
  import { DevBranch, StackInfo, StorageToken, Table, TableDetail } from "@keboola/api-client/storage/types";
@@ -11,74 +12,40 @@ declare const appFixtures: {
11
12
  branchId: string;
12
13
  configId: string;
13
14
  type: 'streamlit';
14
- mode: 'prod';
15
15
  url: string;
16
- configVersion: string;
17
16
  production: {
18
- desiredNumber: null;
19
- desiredId: null;
20
- actualNumber: null;
21
- actualId: null;
17
+ desiredDeploymentId: null;
18
+ actualDeploymentId: null;
22
19
  };
23
- undeployedChanges: false;
24
- state: 'NOT_DEPLOYED';
20
+ state: 'notDeployed';
25
21
  };
26
22
  legacyV1Serving: {
27
- id: string;
28
23
  projectId: string;
29
24
  componentId: string;
30
25
  branchId: string;
31
26
  configId: string;
32
- configVersion: string;
33
27
  type: 'streamlit';
34
- mode: 'dev';
35
28
  url: string;
36
- production: {
37
- desiredNumber: null;
38
- desiredId: null;
39
- actualNumber: null;
40
- actualId: null;
41
- };
42
- undeployedChanges: false;
43
- state: 'NOT_DEPLOYED';
44
- };
45
- running: {
46
29
  id: string;
47
- projectId: string;
48
- componentId: string;
49
- branchId: string;
50
- configId: string;
51
- type: 'streamlit';
52
- mode: 'prod';
53
- url: string;
54
- configVersion: string;
55
30
  production: {
56
- desiredNumber: number;
57
- desiredId: string;
58
- actualNumber: number;
59
- actualId: string;
31
+ desiredDeploymentId: null;
32
+ actualDeploymentId: null;
60
33
  };
61
- undeployedChanges: false;
62
- state: 'RUNNING';
34
+ state: 'notDeployed';
63
35
  };
64
- undeployedChanges: {
36
+ running: {
65
37
  id: string;
66
38
  projectId: string;
67
39
  componentId: string;
68
40
  branchId: string;
69
41
  configId: string;
70
42
  type: 'streamlit';
71
- mode: 'prod';
72
43
  url: string;
73
- configVersion: string;
74
44
  production: {
75
- desiredNumber: number;
76
- desiredId: string;
77
- actualNumber: number;
78
- actualId: string;
45
+ desiredDeploymentId: string;
46
+ actualDeploymentId: string;
79
47
  };
80
- undeployedChanges: true;
81
- state: 'RUNNING';
48
+ state: 'running';
82
49
  };
83
50
  promoting: {
84
51
  id: string;
@@ -87,55 +54,40 @@ declare const appFixtures: {
87
54
  branchId: string;
88
55
  configId: string;
89
56
  type: 'streamlit';
90
- mode: 'prod';
91
57
  url: string;
92
- configVersion: string;
93
58
  production: {
94
- desiredNumber: number;
95
- desiredId: string;
96
- actualNumber: number;
97
- actualId: string;
59
+ desiredDeploymentId: string;
60
+ actualDeploymentId: string;
98
61
  };
99
- undeployedChanges: true;
100
- state: 'RUNNING';
62
+ state: 'running';
101
63
  };
102
- sleeping: {
64
+ suspended: {
103
65
  id: string;
104
66
  projectId: string;
105
67
  componentId: string;
106
68
  branchId: string;
107
69
  configId: string;
108
70
  type: 'streamlit';
109
- mode: 'prod';
110
71
  url: string;
111
- configVersion: string;
112
72
  production: {
113
- desiredNumber: number;
114
- desiredId: string;
115
- actualNumber: number;
116
- actualId: string;
73
+ desiredDeploymentId: string;
74
+ actualDeploymentId: string;
117
75
  };
118
- undeployedChanges: false;
119
- state: 'SLEEPING';
76
+ state: 'suspended';
120
77
  };
121
- suspended: {
78
+ disabled: {
122
79
  id: string;
123
80
  projectId: string;
124
81
  componentId: string;
125
82
  branchId: string;
126
83
  configId: string;
127
84
  type: 'streamlit';
128
- mode: 'prod';
129
85
  url: string;
130
- configVersion: string;
131
86
  production: {
132
- desiredNumber: number;
133
- desiredId: string;
134
- actualNumber: number;
135
- actualId: string;
87
+ desiredDeploymentId: string;
88
+ actualDeploymentId: string;
136
89
  };
137
- undeployedChanges: false;
138
- state: 'SUSPENDED';
90
+ state: 'disabled';
139
91
  };
140
92
  };
141
93
  declare const getApp: () => App;
@@ -145,65 +97,55 @@ declare const listApps: () => App[];
145
97
  declare const deploymentFixtures: {
146
98
  archived: {
147
99
  id: string;
148
- number: number;
149
- configId: string;
150
100
  configVersion: string;
151
101
  gitCommitSha: null;
152
- size: 'tiny';
153
- buildState: 'PREBUILT';
154
- runState: 'STOPPED';
102
+ runtimeSize: 'tiny';
103
+ buildState: 'ready';
104
+ runState: 'stopped';
155
105
  archived: true;
156
106
  archivedAt: string;
157
107
  createdAt: string;
158
108
  };
159
109
  live: {
160
110
  id: string;
161
- number: number;
162
- configId: string;
163
111
  configVersion: string;
164
112
  gitCommitSha: null;
165
- size: 'small';
166
- buildState: 'PREBUILT';
167
- runState: 'RUNNING';
113
+ runtimeSize: 'small';
114
+ buildState: 'ready';
115
+ runState: 'running';
168
116
  archived: false;
169
117
  archivedAt: null;
170
118
  createdAt: string;
171
119
  };
172
120
  staged: {
173
121
  id: string;
174
- number: number;
175
- configId: string;
176
122
  configVersion: string;
177
123
  gitCommitSha: null;
178
- size: 'small';
179
- buildState: 'PREBUILT';
180
- runState: 'NEVER_RUN';
124
+ runtimeSize: 'small';
125
+ buildState: 'ready';
126
+ runState: 'neverRun';
181
127
  archived: false;
182
128
  archivedAt: null;
183
129
  createdAt: string;
184
130
  };
185
131
  buildFailed: {
186
132
  id: string;
187
- number: number;
188
- configId: string;
189
133
  configVersion: string;
190
134
  gitCommitSha: null;
191
- size: 'small';
192
- buildState: 'FAILED';
193
- runState: 'NEVER_RUN';
135
+ runtimeSize: 'small';
136
+ buildState: 'failed';
137
+ runState: 'neverRun';
194
138
  archived: false;
195
139
  archivedAt: null;
196
140
  createdAt: string;
197
141
  };
198
142
  runFailed: {
199
143
  id: string;
200
- number: number;
201
- configId: string;
202
144
  configVersion: string;
203
145
  gitCommitSha: null;
204
- size: 'small';
205
- buildState: 'PREBUILT';
206
- runState: 'FAILED';
146
+ runtimeSize: 'small';
147
+ buildState: 'ready';
148
+ runState: 'failed';
207
149
  archived: false;
208
150
  archivedAt: null;
209
151
  createdAt: string;
@@ -211,16 +153,16 @@ declare const deploymentFixtures: {
211
153
  };
212
154
  declare const getDeployment: () => Deployment;
213
155
  /**
214
- * One continuous history: #1 retired, #2 serving, #3 staged, #4 failed to build, #5 built but its
215
- * run failed.
156
+ * One continuous history: the oldest deleted, the next serving, then one staged, one that failed to
157
+ * build and one that built but whose run failed.
216
158
  *
217
- * All five, because `runFixtures.failed` names #5 as its deployment — a list that left the failed
218
- * ones out could not be joined to the runs, which is the join a timeline is built from.
159
+ * All five, because `runFixtures.failed` names the last one as its deployment — a list that left
160
+ * the failed ones out could not be joined to the runs, which is the join a timeline is built from.
219
161
  *
220
- * Returned in ascending `number` order. The endpoint does not specify an order, so consumers must
221
- * sort for themselves — this order is a fixture convention, not a contract to rely on, and it is
222
- * ascending on purpose: a consumer that assumes newest-first gets the wrong answer here rather
223
- * than in production.
162
+ * Returned oldest first. The endpoint does not specify an order, so consumers must sort for
163
+ * themselves — this order is a fixture convention, not a contract to rely on, and it is oldest
164
+ * first on purpose: a consumer that assumes newest-first gets the wrong answer here rather than in
165
+ * production.
224
166
  */
225
167
  declare const listDeployments: () => Deployment[];
226
168
  //#endregion
@@ -302,6 +244,11 @@ declare const getAppRun: () => AppRun;
302
244
  */
303
245
  declare const listAppRuns: () => AppRun[];
304
246
  //#endregion
247
+ //#region src/clients/businessWorkspaceApi/dashboards.d.ts
248
+ declare const getBusinessWorkspaceDashboard: () => BusinessWorkspaceDashboard;
249
+ declare const listBusinessWorkspaceDashboards: () => BusinessWorkspaceDashboardSummary[];
250
+ declare const getBusinessWorkspaceDashboardInput: () => DashboardInput;
251
+ //#endregion
305
252
  //#region src/clients/developerPortal/apps.d.ts
306
253
  /** The public catalog list: published, non-`other` apps only. */
307
254
  declare const listPublishedApps: () => App$1[];
@@ -1030,74 +977,40 @@ declare const fixtures: {
1030
977
  branchId: string;
1031
978
  configId: string;
1032
979
  type: 'streamlit';
1033
- mode: 'prod';
1034
980
  url: string;
1035
- configVersion: string;
1036
981
  production: {
1037
- desiredNumber: null;
1038
- desiredId: null;
1039
- actualNumber: null;
1040
- actualId: null;
982
+ desiredDeploymentId: null;
983
+ actualDeploymentId: null;
1041
984
  };
1042
- undeployedChanges: false;
1043
- state: 'NOT_DEPLOYED';
985
+ state: 'notDeployed';
1044
986
  };
1045
987
  legacyV1Serving: {
1046
- id: string;
1047
988
  projectId: string;
1048
989
  componentId: string;
1049
990
  branchId: string;
1050
991
  configId: string;
1051
- configVersion: string;
1052
992
  type: 'streamlit';
1053
- mode: 'dev';
1054
993
  url: string;
1055
- production: {
1056
- desiredNumber: null;
1057
- desiredId: null;
1058
- actualNumber: null;
1059
- actualId: null;
1060
- };
1061
- undeployedChanges: false;
1062
- state: 'NOT_DEPLOYED';
1063
- };
1064
- running: {
1065
994
  id: string;
1066
- projectId: string;
1067
- componentId: string;
1068
- branchId: string;
1069
- configId: string;
1070
- type: 'streamlit';
1071
- mode: 'prod';
1072
- url: string;
1073
- configVersion: string;
1074
995
  production: {
1075
- desiredNumber: number;
1076
- desiredId: string;
1077
- actualNumber: number;
1078
- actualId: string;
996
+ desiredDeploymentId: null;
997
+ actualDeploymentId: null;
1079
998
  };
1080
- undeployedChanges: false;
1081
- state: 'RUNNING';
999
+ state: 'notDeployed';
1082
1000
  };
1083
- undeployedChanges: {
1001
+ running: {
1084
1002
  id: string;
1085
1003
  projectId: string;
1086
1004
  componentId: string;
1087
1005
  branchId: string;
1088
1006
  configId: string;
1089
1007
  type: 'streamlit';
1090
- mode: 'prod';
1091
1008
  url: string;
1092
- configVersion: string;
1093
1009
  production: {
1094
- desiredNumber: number;
1095
- desiredId: string;
1096
- actualNumber: number;
1097
- actualId: string;
1010
+ desiredDeploymentId: string;
1011
+ actualDeploymentId: string;
1098
1012
  };
1099
- undeployedChanges: true;
1100
- state: 'RUNNING';
1013
+ state: 'running';
1101
1014
  };
1102
1015
  promoting: {
1103
1016
  id: string;
@@ -1106,55 +1019,40 @@ declare const fixtures: {
1106
1019
  branchId: string;
1107
1020
  configId: string;
1108
1021
  type: 'streamlit';
1109
- mode: 'prod';
1110
1022
  url: string;
1111
- configVersion: string;
1112
1023
  production: {
1113
- desiredNumber: number;
1114
- desiredId: string;
1115
- actualNumber: number;
1116
- actualId: string;
1024
+ desiredDeploymentId: string;
1025
+ actualDeploymentId: string;
1117
1026
  };
1118
- undeployedChanges: true;
1119
- state: 'RUNNING';
1027
+ state: 'running';
1120
1028
  };
1121
- sleeping: {
1029
+ suspended: {
1122
1030
  id: string;
1123
1031
  projectId: string;
1124
1032
  componentId: string;
1125
1033
  branchId: string;
1126
1034
  configId: string;
1127
1035
  type: 'streamlit';
1128
- mode: 'prod';
1129
1036
  url: string;
1130
- configVersion: string;
1131
1037
  production: {
1132
- desiredNumber: number;
1133
- desiredId: string;
1134
- actualNumber: number;
1135
- actualId: string;
1038
+ desiredDeploymentId: string;
1039
+ actualDeploymentId: string;
1136
1040
  };
1137
- undeployedChanges: false;
1138
- state: 'SLEEPING';
1041
+ state: 'suspended';
1139
1042
  };
1140
- suspended: {
1043
+ disabled: {
1141
1044
  id: string;
1142
1045
  projectId: string;
1143
1046
  componentId: string;
1144
1047
  branchId: string;
1145
1048
  configId: string;
1146
1049
  type: 'streamlit';
1147
- mode: 'prod';
1148
1050
  url: string;
1149
- configVersion: string;
1150
1051
  production: {
1151
- desiredNumber: number;
1152
- desiredId: string;
1153
- actualNumber: number;
1154
- actualId: string;
1052
+ desiredDeploymentId: string;
1053
+ actualDeploymentId: string;
1155
1054
  };
1156
- undeployedChanges: false;
1157
- state: 'SUSPENDED';
1055
+ state: 'disabled';
1158
1056
  };
1159
1057
  };
1160
1058
  };
@@ -1164,65 +1062,55 @@ declare const fixtures: {
1164
1062
  fixtures: {
1165
1063
  archived: {
1166
1064
  id: string;
1167
- number: number;
1168
- configId: string;
1169
1065
  configVersion: string;
1170
1066
  gitCommitSha: null;
1171
- size: 'tiny';
1172
- buildState: 'PREBUILT';
1173
- runState: 'STOPPED';
1067
+ runtimeSize: 'tiny';
1068
+ buildState: 'ready';
1069
+ runState: 'stopped';
1174
1070
  archived: true;
1175
1071
  archivedAt: string;
1176
1072
  createdAt: string;
1177
1073
  };
1178
1074
  live: {
1179
1075
  id: string;
1180
- number: number;
1181
- configId: string;
1182
1076
  configVersion: string;
1183
1077
  gitCommitSha: null;
1184
- size: 'small';
1185
- buildState: 'PREBUILT';
1186
- runState: 'RUNNING';
1078
+ runtimeSize: 'small';
1079
+ buildState: 'ready';
1080
+ runState: 'running';
1187
1081
  archived: false;
1188
1082
  archivedAt: null;
1189
1083
  createdAt: string;
1190
1084
  };
1191
1085
  staged: {
1192
1086
  id: string;
1193
- number: number;
1194
- configId: string;
1195
1087
  configVersion: string;
1196
1088
  gitCommitSha: null;
1197
- size: 'small';
1198
- buildState: 'PREBUILT';
1199
- runState: 'NEVER_RUN';
1089
+ runtimeSize: 'small';
1090
+ buildState: 'ready';
1091
+ runState: 'neverRun';
1200
1092
  archived: false;
1201
1093
  archivedAt: null;
1202
1094
  createdAt: string;
1203
1095
  };
1204
1096
  buildFailed: {
1205
1097
  id: string;
1206
- number: number;
1207
- configId: string;
1208
1098
  configVersion: string;
1209
1099
  gitCommitSha: null;
1210
- size: 'small';
1211
- buildState: 'FAILED';
1212
- runState: 'NEVER_RUN';
1100
+ runtimeSize: 'small';
1101
+ buildState: 'failed';
1102
+ runState: 'neverRun';
1213
1103
  archived: false;
1214
1104
  archivedAt: null;
1215
1105
  createdAt: string;
1216
1106
  };
1217
1107
  runFailed: {
1218
1108
  id: string;
1219
- number: number;
1220
- configId: string;
1221
1109
  configVersion: string;
1222
1110
  gitCommitSha: null;
1223
- size: 'small';
1224
- buildState: 'PREBUILT';
1225
- runState: 'FAILED';
1111
+ runtimeSize: 'small';
1112
+ buildState: 'ready';
1113
+ runState: 'failed';
1226
1114
  archived: false;
1227
1115
  archivedAt: null;
1228
1116
  createdAt: string;
@@ -1303,6 +1191,13 @@ declare const fixtures: {
1303
1191
  };
1304
1192
  };
1305
1193
  };
1194
+ businessWorkspaceApi: {
1195
+ dashboards: {
1196
+ getDashboard: typeof getBusinessWorkspaceDashboard;
1197
+ listDashboards: typeof listBusinessWorkspaceDashboards;
1198
+ getDashboardInput: typeof getBusinessWorkspaceDashboardInput;
1199
+ };
1200
+ };
1306
1201
  developerPortal: {
1307
1202
  listPublishedApps: typeof listPublishedApps;
1308
1203
  listVendorApps: typeof listVendorApps;
@@ -1646,5 +1541,5 @@ declare const fixtures: {
1646
1541
  };
1647
1542
  };
1648
1543
  //#endregion
1649
- export { DEFAULT_BASE_URL, type Table, type TableDetail, appFixtures, deploymentFixtures, developerPortalFixtures, fixtures, getApp, getAppRun, getDeployment, getDevBranches, getStackInfo, getTable, getVendor, listAllApps, listAllVendors, listAppChanges, listAppRuns, listApps, listDeployments, listPublishedApps, listServiceAccounts, listTables, listUsers, listVendorApps, listVendors, runFixtures, tableFixtures, verifyStorageToken };
1544
+ export { DEFAULT_BASE_URL, type Table, type TableDetail, appFixtures, deploymentFixtures, developerPortalFixtures, fixtures, getApp, getAppRun, getBusinessWorkspaceDashboard, getBusinessWorkspaceDashboardInput, getDeployment, getDevBranches, getStackInfo, getTable, getVendor, listAllApps, listAllVendors, listAppChanges, listAppRuns, listApps, listBusinessWorkspaceDashboards, listDeployments, listPublishedApps, listServiceAccounts, listTables, listUsers, listVendorApps, listVendors, runFixtures, tableFixtures, verifyStorageToken };
1650
1545
  //# sourceMappingURL=index.d.cts.map