@keboola/api-client 16.0.0 → 18.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 (41) hide show
  1. package/API-SURFACE.md +16 -9
  2. package/README.md +1 -5
  3. package/dist/assets/index.cjs +20 -7
  4. package/dist/assets/index.cjs.map +1 -1
  5. package/dist/assets/index.js +22 -2
  6. package/dist/assets/index.js.map +1 -1
  7. package/dist/index.cjs +9 -22
  8. package/dist/index.cjs.map +1 -1
  9. package/dist/index.d.cts +63 -31
  10. package/dist/index.d.ts +63 -31
  11. package/dist/index.js +9 -22
  12. package/dist/index.js.map +1 -1
  13. package/dist/metastore/index.d.cts +1 -1
  14. package/dist/metastore/index.d.ts +1 -1
  15. package/dist/metastore/types.d.cts +1 -1
  16. package/dist/metastore/types.d.ts +1 -1
  17. package/dist/sdk/tag/index.d.cts +1 -1
  18. package/dist/sdk/tag/index.d.ts +1 -1
  19. package/dist/sdk/tag/types.d.cts +1 -1
  20. package/dist/sdk/tag/types.d.ts +1 -1
  21. package/dist/status/index.cjs +16 -7
  22. package/dist/status/index.cjs.map +1 -1
  23. package/dist/status/index.js +18 -2
  24. package/dist/status/index.js.map +1 -1
  25. package/dist/storage/types.d.cts +1 -1
  26. package/dist/storage/types.d.ts +1 -1
  27. package/dist/{types-DTkxk0fW.d.cts → types-BCPmAXOQ.d.cts} +4 -4
  28. package/dist/{types-Mghz1gMD.d.ts → types-BowqtZ7v.d.ts} +4 -4
  29. package/package.json +2 -2
  30. package/surface/metastore.md +24 -0
  31. package/surface/queue.md +1 -1
  32. package/dist/chunk-O3PPKRMA.js +0 -20
  33. package/dist/chunk-O3PPKRMA.js.map +0 -1
  34. package/dist/chunk-OT3DV5QD.cjs +0 -26
  35. package/dist/chunk-OT3DV5QD.cjs.map +0 -1
  36. package/dist/chunk-Q5NHIVV2.js +0 -24
  37. package/dist/chunk-Q5NHIVV2.js.map +0 -1
  38. package/dist/chunk-WQWWUE6Z.cjs +0 -22
  39. package/dist/chunk-WQWWUE6Z.cjs.map +0 -1
  40. package/surface/assets.md +0 -7
  41. package/surface/status.md +0 -7
package/API-SURFACE.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Every namespace and method reachable from an initialized `ApiClient` (`createApiClient()` after `init()`, or `useApiClient()`). Generated from the TypeScript type checker — see `scripts/gen-surface.mjs`.
6
6
 
7
- 23 top-level namespaces, 439 methods. This index lists method **names** only — full signatures live per namespace under [`surface/`](./surface). Open `surface/<namespace>.md` for the one you need.
7
+ 22 top-level namespaces, 449 methods. This index lists method **names** only — full signatures live per namespace under [`surface/`](./surface). Open `surface/<namespace>.md` for the one you need.
8
8
 
9
9
  ## [`api.ai`](./surface/ai.md)
10
10
 
@@ -17,10 +17,6 @@ Every namespace and method reachable from an initialized `ApiClient` (`createApi
17
17
  - `getComponentDetail`
18
18
  - `suggestComponent`
19
19
 
20
- ## [`api.assets`](./surface/assets.md)
21
-
22
- - `getPublishedChangelogPosts`
23
-
24
20
  ## [`api.auth`](./surface/auth.md)
25
21
 
26
22
  - `device.approve`
@@ -234,6 +230,21 @@ Every namespace and method reachable from an initialized `ApiClient` (`createApi
234
230
  - `users.removeUserAdminFeature`
235
231
  - `verifyToken`
236
232
 
233
+ ## [`api.metastore`](./surface/metastore.md)
234
+
235
+ - `healthCheck`
236
+ - `repository.createMetaObject`
237
+ - `repository.deleteMetaObject`
238
+ - `repository.deleteMetaObjectRevision`
239
+ - `repository.getMetaObject`
240
+ - `repository.getMetaObjectRevision`
241
+ - `repository.getMetaObjectRevisions`
242
+ - `repository.getMetaObjects`
243
+ - `repository.replaceMetaObject`
244
+ - `repository.updateMetaObject`
245
+ - `schema.getSchema`
246
+ - `schema.getVersionedSchema`
247
+
237
248
  ## [`api.notifications`](./surface/notifications.md)
238
249
 
239
250
  - `createSubscription`
@@ -315,10 +326,6 @@ Every namespace and method reachable from an initialized `ApiClient` (`createApi
315
326
  - `vault.setVariablesGroup`
316
327
  - `vault.updateVariable`
317
328
 
318
- ## [`api.status`](./surface/status.md)
319
-
320
- - `getSummary`
321
-
322
329
  ## [`api.storage`](./surface/storage.md)
323
330
 
324
331
  - `branches.createDevBranchJob`
package/README.md CHANGED
@@ -27,8 +27,6 @@ await api.init({
27
27
  storageApi: 'your-storage-token',
28
28
  managementApi: 'your-management-token', // optional
29
29
  },
30
- assetsBaseUrl: 'https://assets.keboola.com',
31
- statusBaseUrl: 'https://status.keboola.com',
32
30
  metastoreBaseUrl: 'https://metastore.keboola.com',
33
31
  });
34
32
 
@@ -38,7 +36,7 @@ const jobs = await api.queue.searchJobs();
38
36
 
39
37
  ### Single-service client (recommended when you only need one service)
40
38
 
41
- For a single service — including in a **browser SPA** that only talks to Storage — use the per-service factory. It needs only `baseUrl` + `token`, so you avoid the full client's required `assetsBaseUrl` / `statusBaseUrl` / `metastoreBaseUrl`. Reach for the full client (below) only when you need multiple stack services.
39
+ For a single service — including in a **browser SPA** that only talks to Storage — use the per-service factory. It needs only `baseUrl` + `token`, so you avoid the full client's required `metastoreBaseUrl`. Reach for the full client (below) only when you need multiple stack services.
42
40
 
43
41
  ```typescript
44
42
  import { createStorageClient } from '@keboola/api-client/storage';
@@ -134,8 +132,6 @@ Clients backed by OpenAPI specs are marked with (OpenAPI); the rest use the gene
134
132
  | `api.queryService` | Query Service (OpenAPI) | `createQueryJob()`, `cancelQueryJob()`, `getQueryJob()`, `getQueryResults()`, `getQueryHistory()`, `exportResults()` |
135
133
  | `api.syncActions` | Sync Actions (OpenAPI) | `enrollMFA()`, `gitRepository.*` |
136
134
  | `api.telemetry` | Telemetry | `provisioning.*` |
137
- | `api.assets` | Assets | `getPublishedChangelogPosts()` |
138
- | `api.status` | Status | `getSummary()` |
139
135
  | `api.import` | Import | `uploadFile()` |
140
136
 
141
137
  Additional accessors on the initialized client:
@@ -1,13 +1,26 @@
1
1
  'use strict';
2
2
 
3
- var chunkOT3DV5QD_cjs = require('../chunk-OT3DV5QD.cjs');
4
- require('../chunk-PC522LKL.cjs');
3
+ var chunkPC522LKL_cjs = require('../chunk-PC522LKL.cjs');
5
4
 
5
+ // src/clients/assets/assetsClient.ts
6
+ var createAssetsClient = ({ baseUrl, middlewares }) => {
7
+ const client = chunkPC522LKL_cjs.createGenericFetchClient({
8
+ baseUrl,
9
+ middlewares
10
+ });
11
+ const getPublishedChangelogPosts = async (signal) => {
12
+ const { data } = await client.get(
13
+ "/platform-changelog/published-posts.json",
14
+ {},
15
+ { signal }
16
+ );
17
+ return data;
18
+ };
19
+ return {
20
+ getPublishedChangelogPosts
21
+ };
22
+ };
6
23
 
7
-
8
- Object.defineProperty(exports, "createAssetsClient", {
9
- enumerable: true,
10
- get: function () { return chunkOT3DV5QD_cjs.createAssetsClient; }
11
- });
24
+ exports.createAssetsClient = createAssetsClient;
12
25
  //# sourceMappingURL=index.cjs.map
13
26
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}
1
+ {"version":3,"sources":["../../src/clients/assets/assetsClient.ts"],"names":["createGenericFetchClient"],"mappings":";;;;;AAKO,IAAM,kBAAA,GAAqB,CAAC,EAAE,OAAA,EAAS,aAAY,KAAwC;AAChG,EAAA,MAAM,SAASA,0CAAA,CAAyB;AAAA,IACtC,OAAA;AAAA,IACA;AAAA,GACD,CAAA;AAED,EAAA,MAAM,0BAAA,GAA6B,OAAO,MAAA,KAAyB;AACjE,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,GAAA;AAAA,MAC5B,0CAAA;AAAA,MACA,EAAC;AAAA,MACD,EAAE,MAAA;AAAO,KACX;AAEA,IAAA,OAAO,IAAA;AAAA,EACT,CAAA;AAEA,EAAA,OAAO;AAAA,IACL;AAAA,GACF;AACF","file":"index.cjs","sourcesContent":["import { createGenericFetchClient } from '../../fetchClient';\nimport type { ClientInitOptions } from '../types';\n\nimport type { Post } from './types';\n\nexport const createAssetsClient = ({ baseUrl, middlewares }: Omit<ClientInitOptions, 'token'>) => {\n const client = createGenericFetchClient({\n baseUrl,\n middlewares,\n });\n\n const getPublishedChangelogPosts = async (signal?: AbortSignal) => {\n const { data } = await client.get<Post[]>(\n '/platform-changelog/published-posts.json',\n {},\n { signal },\n );\n\n return data;\n };\n\n return {\n getPublishedChangelogPosts,\n };\n};\n"]}
@@ -1,4 +1,24 @@
1
- export { createAssetsClient } from '../chunk-Q5NHIVV2.js';
2
- import '../chunk-FDFISPDO.js';
1
+ import { createGenericFetchClient } from '../chunk-FDFISPDO.js';
2
+
3
+ // src/clients/assets/assetsClient.ts
4
+ var createAssetsClient = ({ baseUrl, middlewares }) => {
5
+ const client = createGenericFetchClient({
6
+ baseUrl,
7
+ middlewares
8
+ });
9
+ const getPublishedChangelogPosts = async (signal) => {
10
+ const { data } = await client.get(
11
+ "/platform-changelog/published-posts.json",
12
+ {},
13
+ { signal }
14
+ );
15
+ return data;
16
+ };
17
+ return {
18
+ getPublishedChangelogPosts
19
+ };
20
+ };
21
+
22
+ export { createAssetsClient };
3
23
  //# sourceMappingURL=index.js.map
4
24
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}
1
+ {"version":3,"sources":["../../src/clients/assets/assetsClient.ts"],"names":[],"mappings":";;;AAKO,IAAM,kBAAA,GAAqB,CAAC,EAAE,OAAA,EAAS,aAAY,KAAwC;AAChG,EAAA,MAAM,SAAS,wBAAA,CAAyB;AAAA,IACtC,OAAA;AAAA,IACA;AAAA,GACD,CAAA;AAED,EAAA,MAAM,0BAAA,GAA6B,OAAO,MAAA,KAAyB;AACjE,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,GAAA;AAAA,MAC5B,0CAAA;AAAA,MACA,EAAC;AAAA,MACD,EAAE,MAAA;AAAO,KACX;AAEA,IAAA,OAAO,IAAA;AAAA,EACT,CAAA;AAEA,EAAA,OAAO;AAAA,IACL;AAAA,GACF;AACF","file":"index.js","sourcesContent":["import { createGenericFetchClient } from '../../fetchClient';\nimport type { ClientInitOptions } from '../types';\n\nimport type { Post } from './types';\n\nexport const createAssetsClient = ({ baseUrl, middlewares }: Omit<ClientInitOptions, 'token'>) => {\n const client = createGenericFetchClient({\n baseUrl,\n middlewares,\n });\n\n const getPublishedChangelogPosts = async (signal?: AbortSignal) => {\n const { data } = await client.get<Post[]>(\n '/platform-changelog/published-posts.json',\n {},\n { signal },\n );\n\n return data;\n };\n\n return {\n getPublishedChangelogPosts,\n };\n};\n"]}
package/dist/index.cjs CHANGED
@@ -8,8 +8,6 @@ var chunkAWRMGLMT_cjs = require('./chunk-AWRMGLMT.cjs');
8
8
  var chunkUFQVOZZ6_cjs = require('./chunk-UFQVOZZ6.cjs');
9
9
  require('./chunk-TTPJSPZA.cjs');
10
10
  var chunkGF4XZK5N_cjs = require('./chunk-GF4XZK5N.cjs');
11
- var chunkWQWWUE6Z_cjs = require('./chunk-WQWWUE6Z.cjs');
12
- require('./chunk-XPDEQND7.cjs');
13
11
  var chunkBCCSLO2Q_cjs = require('./chunk-BCCSLO2Q.cjs');
14
12
  var chunkCVV4HROS_cjs = require('./chunk-CVV4HROS.cjs');
15
13
  var chunkYLZDOSIG_cjs = require('./chunk-YLZDOSIG.cjs');
@@ -27,7 +25,6 @@ var chunkIPOWRVLR_cjs = require('./chunk-IPOWRVLR.cjs');
27
25
  var chunkHACGJDAD_cjs = require('./chunk-HACGJDAD.cjs');
28
26
  var chunkEAWA66EE_cjs = require('./chunk-EAWA66EE.cjs');
29
27
  var chunkKIVPVVFK_cjs = require('./chunk-KIVPVVFK.cjs');
30
- var chunkOT3DV5QD_cjs = require('./chunk-OT3DV5QD.cjs');
31
28
  var chunkRZIBC7G4_cjs = require('./chunk-RZIBC7G4.cjs');
32
29
  var chunkR34WMOOF_cjs = require('./chunk-R34WMOOF.cjs');
33
30
  require('./chunk-U5SE6W5M.cjs');
@@ -627,9 +624,6 @@ var createLiveToken = ({ initialToken }) => {
627
624
  var createClients = async ({
628
625
  baseUrl,
629
626
  token,
630
- assetsBaseUrl,
631
- statusBaseUrl,
632
- metastoreBaseUrl,
633
627
  clientServiceUrls,
634
628
  middlewares
635
629
  }) => {
@@ -808,22 +802,17 @@ var createClients = async ({
808
802
  middlewares: middlewareFor("notifications", [liveToken.attachTokenMiddleware]),
809
803
  token: token.storageApi
810
804
  })
805
+ }).add({
806
+ serviceId: "metastore",
807
+ clientName: "metastore",
808
+ clientFn: (serviceBaseUrl) => chunkKWO5WJUT_cjs.createMetastoreClient({
809
+ baseUrl: serviceBaseUrl,
810
+ middlewares: middlewareFor("metastore", [liveToken.attachTokenMiddleware]),
811
+ token: token.storageApi
812
+ })
811
813
  }).build();
812
- const metastore = chunkKWO5WJUT_cjs.createMetastoreClient({
813
- baseUrl: metastoreBaseUrl,
814
- middlewares: middlewareFor("metastore", [liveToken.attachTokenMiddleware]),
815
- token: token.storageApi
816
- });
817
- const assets = chunkOT3DV5QD_cjs.createAssetsClient({
818
- baseUrl: assetsBaseUrl,
819
- middlewares: middlewareFor("assets")
820
- });
821
- const status = chunkWQWWUE6Z_cjs.createStatusClient({
822
- baseUrl: statusBaseUrl,
823
- middlewares: middlewareFor("status")
824
- });
825
814
  const tag = chunkBR3SBEFE_cjs.createTagSdk({
826
- metastoreClient: metastore
815
+ metastoreClient: client.metastore
827
816
  });
828
817
  const storageSdk = chunkAWRMGLMT_cjs.createStorageSdk({
829
818
  storageClient: storage
@@ -855,8 +844,6 @@ var createClients = async ({
855
844
  context,
856
845
  // clients
857
846
  storage,
858
- assets,
859
- status,
860
847
  management,
861
848
  auth,
862
849
  ...client,