@keboola/api-client 21.0.0 → 24.0.0

package/API-SURFACE.md

@@ -4,7 +4,7 @@
 
 Every namespace and method reachable from a ready `KeboolaApi` — the `api` half of a keboola client (`createKeboola(...).api` / `createLegacyKeboola(...).api`, or `useApiClient()`). Generated from the TypeScript type checker — see `scripts/gen-surface.mjs`.
 
-22 top-level namespaces, 472 methods. This index lists method **names** only — full signatures live per namespace under [`surface/`](./surface). Open `surface/<namespace>.md` for the one you need.
+22 top-level namespaces, 543 methods. This index lists method **names** only — full signatures live per namespace under [`surface/`](./surface). Open `surface/<namespace>.md` for the one you need.
 
 ## [`api.ai`](./surface/ai.md)
 
@@ -25,8 +25,14 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 - `login.withOidc`
 - `login.withPassword`
 - `mfa.regenerateRecoveryCodes`
+- `mfa.totp.disable`
+- `mfa.totp.setup`
+- `mfa.totp.verify`
 - `mfa.verifyWithCode`
 - `mfa.verifyWithWebauthn`
+- `password.change`
+- `password.reset`
+- `password.resetRequest`
 - `pat.create`
 - `pat.exchange`
 - `pat.getAll`
@@ -124,6 +130,7 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 ## [`api.import`](./surface/import.md)
 
 - `uploadFile`
+- `writeTable`
 
 ## [`api.kaiAgent`](./surface/kaiAgent.md)
 
@@ -160,6 +167,7 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 - `currentUser.getOrganizationInvitations`
 - `currentUser.getProjectInvitation`
 - `currentUser.getProjectInvitations`
+- `currentUser.getProjectJoinRequest`
 - `currentUser.getProjectJoinRequests`
 - `currentUser.rejectMaintainerInvitation`
 - `currentUser.rejectOrganizationInvitation`
@@ -172,25 +180,42 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 - `features.getFeature`
 - `features.getFeatureAdmins`
 - `features.getFeatureProjects`
+- `fileStorage.createFileStorageAbs`
+- `fileStorage.createFileStorageGcs`
+- `fileStorage.createFileStorageS3`
 - `fileStorage.getFileStoragesAbs`
 - `fileStorage.getFileStoragesGcs`
 - `fileStorage.getFileStoragesS3`
+- `fileStorage.rotateFileStorageAbsCredentials`
+- `fileStorage.rotateFileStorageGcsCredentials`
+- `fileStorage.rotateFileStorageS3Credentials`
+- `fileStorage.setFileStorageAbsDefault`
+- `fileStorage.setFileStorageGcsDefault`
+- `fileStorage.setFileStorageS3Default`
 - `maintainers.addMaintainerUser`
+- `maintainers.completeMaintainerSamlSetup`
 - `maintainers.createMaintainer`
 - `maintainers.createMaintainerInvitation`
 - `maintainers.createMaintainerOrganization`
+- `maintainers.createMaintainerSamlConfig`
 - `maintainers.deleteMaintainer`
 - `maintainers.deleteMaintainerInvitation`
 - `maintainers.deleteMaintainerMetadata`
+- `maintainers.deleteMaintainerSamlConfig`
 - `maintainers.getMaintainer`
 - `maintainers.getMaintainerInvitation`
 - `maintainers.getMaintainerInvitations`
 - `maintainers.getMaintainerMetadata`
+- `maintainers.getMaintainerOrganizations`
+- `maintainers.getMaintainerSamlConfig`
+- `maintainers.getMaintainerSamlConfigs`
 - `maintainers.getMaintainerUsers`
 - `maintainers.getMaintainers`
+- `maintainers.joinMaintainer`
 - `maintainers.removeMaintainerUser`
 - `maintainers.setMaintainerMetadata`
 - `maintainers.updateMaintainer`
+- `maintainers.updateMaintainerSamlConfig`
 - `organizations.addOrganizationUser`
 - `organizations.createOrganizationInvitation`
 - `organizations.createOrganizationProject`
@@ -211,31 +236,67 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 - `organizations.setOrganizationMetadata`
 - `organizations.updateOrganization`
 - `projects.addProjectFeature`
+- `projects.addProjectTemplateFeature`
 - `projects.addProjectUser`
+- `projects.approveProjectJoinRequest`
 - `projects.changeProjectUserRole`
 - `projects.createProjectInvitation`
 - `projects.deleteProject`
 - `projects.deleteProjectInvitation`
+- `projects.deleteProjectMetadata`
 - `projects.getProject`
+- `projects.getProjectInvitation`
 - `projects.getProjectInvitations`
+- `projects.getProjectJoinRequest`
+- `projects.getProjectJoinRequests`
 - `projects.getProjectMetadata`
 - `projects.getProjectReviewers`
+- `projects.getProjectTemplate`
+- `projects.getProjectTemplateFeatures`
 - `projects.getProjectTemplates`
 - `projects.getProjectUsers`
+- `projects.joinProject`
 - `projects.moveProject`
+- `projects.rejectProjectJoinRequest`
 - `projects.removeProjectFeature`
+- `projects.removeProjectLimit`
+- `projects.removeProjectTemplateFeature`
 - `projects.removeProjectUser`
+- `projects.requestProjectAccess`
 - `projects.setProjectDisabled`
 - `projects.setProjectLimits`
 - `projects.setProjectMetadata`
 - `projects.setProjectReviewers`
 - `projects.updateProject`
+- `storageBackends.activateStorageBackend`
+- `storageBackends.createBigqueryStorageBackend`
+- `storageBackends.createSnowflakeStorageBackend`
+- `storageBackends.deleteStorageBackend`
 - `storageBackends.getStorageBackend`
 - `storageBackends.getStorageBackendMaintainers`
 - `storageBackends.getStorageBackendProjects`
 - `storageBackends.getStorageBackends`
+- `storageBackends.updateBigqueryStorageBackend`
+- `storageBackends.updateStorageBackend`
+- `uiApps.activateUiAppVersion`
+- `uiApps.deleteUiApp`
+- `uiApps.getUiApps`
+- `uiApps.registerUiApp`
 - `users.addUserAdminFeature`
+- `users.deleteUser`
+- `users.deleteUserMetadata`
+- `users.disableUserMfa`
+- `users.getUser`
+- `users.getUserMaintainers`
+- `users.getUserMetadata`
+- `users.getUserOrganizations`
+- `users.getUserProjects`
+- `users.getUsers`
+- `users.grantSuperAdmin`
+- `users.removeSuperAdmin`
 - `users.removeUserAdminFeature`
+- `users.setUserMetadata`
+- `users.updateUser`
 - `verifyToken`
 
 ## [`api.metastore`](./surface/metastore.md)
@@ -256,7 +317,9 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 ## [`api.notifications`](./surface/notifications.md)
 
 - `createSubscription`
+- `createSubscriptions`
 - `deleteSubscription`
+- `deleteSubscriptions`
 - `getSubscription`
 - `getSubscriptions`
 
@@ -278,7 +341,12 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 
 ## [`api.queue`](./surface/queue.md)
 
+- `createJob`
 - `getJob`
+- `getOrchestrationRerunPlan`
+- `killJob`
+- `searchAllJobs`
+- `searchGroupedJobs`
 - `searchJobs`
 
 ## [`api.scheduler`](./surface/scheduler.md)
@@ -286,6 +354,7 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 - `activateSchedule`
 - `deleteSchedule`
 - `deleteSchedulesForConfiguration`
+- `deleteSchedulesForConfigurations`
 - `getSchedule`
 - `getSchedules`
 - `refreshScheduleToken`
@@ -301,6 +370,8 @@ Every namespace and method reachable from a ready `KeboolaApi` — the `api` hal
 - `semanticLayer.createObjects`
 - `semanticLayer.deleteModel`
 - `semanticLayer.deleteObject`
+- `semanticLayer.findObjectsByName`
+- `semanticLayer.listModelChildren`
 - `semanticLayer.listModels`
 - `semanticLayer.listObjects`
 - `semanticLayer.updateModel`

package/README.md

@@ -164,6 +164,7 @@ src/
     createFetchClient/          # Core fetch wrapper, middleware composition
     createGenericFetchClient.ts # Untyped HTTP client (manual generics)
     createOpenapiFetchClient.ts # Typed HTTP client (from OpenAPI schemas)
+    xhrFetch.ts                 # XHR-backed `fetch` — upload progress (see Custom transport)
     types.ts                    # OpenAPI type-level helpers
   clients/
     storage/                    # Storage API (buckets, tables, files, branches, ...)
@@ -226,7 +227,7 @@ Clients backed by OpenAPI specs are marked with (OpenAPI); the rest use the gene
 | `api.queryService` | Query Service (OpenAPI) | `createQueryJob()`, `cancelQueryJob()`, `getQueryJob()`, `getQueryResults()`, `getQueryHistory()`, `exportResults()`                                                            |
 | `api.syncActions`  | Sync Actions (OpenAPI)  | `enrollMFA()`, `gitRepository.*`                                                                                                                                                |
 | `api.telemetry`    | Telemetry               | `provisioning.*`                                                                                                                                                                |
-| `api.import`       | Import                  | `uploadFile()`                                                                                                                                                                  |
+| `api.import`       | Import (OpenAPI)        | `uploadFile()`, `writeTable()`                                                                                                                                                  |
 
 Additional accessors on the ready client:
 
@@ -306,6 +307,39 @@ const loggingMiddleware: MiddlewareFn = (next) => async (request) => {
 };
 ```
 
+A middleware receives the whole request context (`{ request, validateStatus, fetchFn }`) and must
+pass it on. Forward it as-is, or spread it when replacing a field — `next({ ...ctx, request: mine })`,
+never `next({ request: mine })`, which silently drops the caller's `validateStatus` and transport.
+
+## Custom transport (`fetchFn`)
+
+Every client takes a `fetchFn` — its own `fetch` implementation — either for the whole client or for
+a single request, where it wins over the client-level one:
+
+```typescript
+const client = createGenericFetchClient({ baseUrl, fetchFn: myFetch }); // all requests
+await client.post('/upload-file', { body }, { fetchFn: myFetch }); // just this one
+```
+
+Only the transport is swapped: the `Request` is still built by the client, middleware still wraps the
+call, and `validateStatus`, response parsing and the error contract are untouched. It is the seam for
+things `fetch` cannot express — and the reason `xhrFetch` exists. `fetch` cannot observe request-body
+upload progress outside Chromium, so `import.uploadFile` sends that one request over XHR when a
+caller asks for progress:
+
+```typescript
+// clients/import/importClient.ts
+const createRequestOptions = ({ signal, onProgress }: ImportRequestOptions) => ({
+  signal,
+  fetchFn: onProgress ? xhrFetch(onProgress) : undefined,
+});
+
+await client.post('/upload-file', { body: formData }, createRequestOptions(options));
+```
+
+Keep such transports inside the SDK and expose the capability (an `onProgress` callback), not the
+transport — consumers must not import from `@keboola/api-client/fetchClient`.
+
 ## Utilities
 
 ### concurrent / series
@@ -459,7 +493,14 @@ Run the type generation command:
 pnpm gen:types
 ```
 
-This will create the TypeScript definitions at the specified output path.
+This will create the TypeScript definitions at the specified output path. Two manual steps follow,
+because the generator's raw output does not satisfy the repo's own checks:
+
+- `openapi-typescript` emits `export interface operations` even with `--export-type`, which trips
+  oxlint's `consistent-type-definitions`. Convert it to `export type operations = { … };` — every
+  committed schema is in that form.
+- Run `oxfmt` on the new file, and revert the other schemas the command regenerated (it rewrites all
+  of them, mostly reformatting) — see [`docs/regenerate-api-types.md`](./docs/regenerate-api-types.md).
 
 #### Step 3: Create the Client Implementation
 

package/dist/{ManagementClientAuthError-CJu_hpGi.d.cts → ManagementClientAuthError-BuqHAOBO.d.cts}

@@ -1,4 +1,4 @@
-import { a as ApiError, A as ApiResponse } from './types-DqxZDbM1.cjs';
+import { a as ApiError, A as ApiResponse } from './types-DNg4M5JV.cjs';
 
 declare class ManagementClientAuthError extends ApiError {
     title: string;

package/dist/{ManagementClientAuthError-B3PZRWBU.d.ts → ManagementClientAuthError-C7q1Jd9I.d.ts}

@@ -1,4 +1,4 @@
-import { a as ApiError, A as ApiResponse } from './types-DqxZDbM1.js';
+import { a as ApiError, A as ApiResponse } from './types-DNg4M5JV.js';
 
 declare class ManagementClientAuthError extends ApiError {
     title: string;

package/dist/ai/index.cjs

@@ -1,14 +1,14 @@
 'use strict';
 
-var chunkSB7AVZQU_cjs = require('../chunk-SB7AVZQU.cjs');
-require('../chunk-UQWVZTEA.cjs');
-require('../chunk-IUN2ZSU3.cjs');
+var chunkIDWGBCSB_cjs = require('../chunk-IDWGBCSB.cjs');
+require('../chunk-7RO6PKZ4.cjs');
+require('../chunk-MMOAH3EH.cjs');
 
 
 
 Object.defineProperty(exports, "createAiClient", {
   enumerable: true,
-  get: function () { return chunkSB7AVZQU_cjs.createAiClient; }
+  get: function () { return chunkIDWGBCSB_cjs.createAiClient; }
 });
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/ai/index.d.cts

@@ -1,6 +1,6 @@
-import { D as DescribeConfigurationVersionBody, a as DescribeConfigurationMergeBody, E as ExplainErrorBody, b as DescribeConfigurationBody, S as SuggestComponentBody, c as components, F as FeedbackBody, d as DocsQuestionBody } from '../types-CvHPHNH0.cjs';
-import { C as ClientInitOptions } from '../types-DqxZDbM1.cjs';
-import '../types-jKnx7Tm_.cjs';
+import { D as DescribeConfigurationVersionBody, a as DescribeConfigurationMergeBody, E as ExplainErrorBody, b as DescribeConfigurationBody, S as SuggestComponentBody, c as components, F as FeedbackBody, d as DocsQuestionBody } from '../types-DYnHIm7m.cjs';
+import { C as ClientInitOptions } from '../types-DNg4M5JV.cjs';
+import '../types-gcShAmmi.cjs';
 import 'qs';
 
 declare const createAiClient: ({ baseUrl, middlewares, auth }: ClientInitOptions) => {
@@ -46,6 +46,7 @@ declare const createAiClient: ({ baseUrl, middlewares, auth }: ClientInitOptions
         rootConfigurationExamples: Record<string, never>[] | null;
         rowConfigurationExamples: Record<string, never>[] | null;
         componentFlags: string[] | null;
+        synchronousActions?: string[] | null;
     }>;
 };
 

package/dist/ai/index.d.ts

@@ -1,6 +1,6 @@
-import { D as DescribeConfigurationVersionBody, a as DescribeConfigurationMergeBody, E as ExplainErrorBody, b as DescribeConfigurationBody, S as SuggestComponentBody, c as components, F as FeedbackBody, d as DocsQuestionBody } from '../types-D3Kkh6yW.js';
-import { C as ClientInitOptions } from '../types-DqxZDbM1.js';
-import '../types-jKnx7Tm_.js';
+import { D as DescribeConfigurationVersionBody, a as DescribeConfigurationMergeBody, E as ExplainErrorBody, b as DescribeConfigurationBody, S as SuggestComponentBody, c as components, F as FeedbackBody, d as DocsQuestionBody } from '../types-CrLjE5xf.js';
+import { C as ClientInitOptions } from '../types-DNg4M5JV.js';
+import '../types-gcShAmmi.js';
 import 'qs';
 
 declare const createAiClient: ({ baseUrl, middlewares, auth }: ClientInitOptions) => {
@@ -46,6 +46,7 @@ declare const createAiClient: ({ baseUrl, middlewares, auth }: ClientInitOptions
         rootConfigurationExamples: Record<string, never>[] | null;
         rowConfigurationExamples: Record<string, never>[] | null;
         componentFlags: string[] | null;
+        synchronousActions?: string[] | null;
     }>;
 };
 

package/dist/ai/index.js

@@ -1,5 +1,5 @@
-export { createAiClient } from '../chunk-YVC4NGW2.js';
-import '../chunk-6JXSO3AR.js';
-import '../chunk-RK2VGHJE.js';
+export { createAiClient } from '../chunk-G66EP527.js';
+import '../chunk-EDX5D6UY.js';
+import '../chunk-XHDYLUM4.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/ai/types.d.cts

@@ -1,2 +1,2 @@
-import '../types-jKnx7Tm_.cjs';
-export { C as ComponentDocsDetail, e as ComponentSuggestion, b as DescribeConfigurationBody, a as DescribeConfigurationMergeBody, D as DescribeConfigurationVersionBody, f as DocsAnswer, d as DocsQuestionBody, g as ErrorExplanation, E as ExplainErrorBody, F as FeedbackBody, O as ObjectDescription, S as SuggestComponentBody } from '../types-CvHPHNH0.cjs';
+import '../types-gcShAmmi.cjs';
+export { C as ComponentDocsDetail, e as ComponentSuggestion, b as DescribeConfigurationBody, a as DescribeConfigurationMergeBody, D as DescribeConfigurationVersionBody, f as DocsAnswer, d as DocsQuestionBody, g as ErrorExplanation, E as ExplainErrorBody, F as FeedbackBody, O as ObjectDescription, S as SuggestComponentBody } from '../types-DYnHIm7m.cjs';

package/dist/ai/types.d.ts

@@ -1,2 +1,2 @@
-import '../types-jKnx7Tm_.js';
-export { C as ComponentDocsDetail, e as ComponentSuggestion, b as DescribeConfigurationBody, a as DescribeConfigurationMergeBody, D as DescribeConfigurationVersionBody, f as DocsAnswer, d as DocsQuestionBody, g as ErrorExplanation, E as ExplainErrorBody, F as FeedbackBody, O as ObjectDescription, S as SuggestComponentBody } from '../types-D3Kkh6yW.js';
+import '../types-gcShAmmi.js';
+export { C as ComponentDocsDetail, e as ComponentSuggestion, b as DescribeConfigurationBody, a as DescribeConfigurationMergeBody, D as DescribeConfigurationVersionBody, f as DocsAnswer, d as DocsQuestionBody, g as ErrorExplanation, E as ExplainErrorBody, F as FeedbackBody, O as ObjectDescription, S as SuggestComponentBody } from '../types-CrLjE5xf.js';

package/dist/assets/index.cjs

@@ -1,23 +1,38 @@
 'use strict';
 
-var chunkIUN2ZSU3_cjs = require('../chunk-IUN2ZSU3.cjs');
+var chunkBCZPCMGL_cjs = require('../chunk-BCZPCMGL.cjs');
+var chunkMMOAH3EH_cjs = require('../chunk-MMOAH3EH.cjs');
 
 // src/clients/assets/assetsClient.ts
 var createAssetsClient = ({ baseUrl, middlewares }) => {
-  const client = chunkIUN2ZSU3_cjs.createGenericFetchClient({
+  const client = chunkMMOAH3EH_cjs.createGenericFetchClient({
     baseUrl,
     middlewares
   });
   const getPublishedChangelogPosts = async (signal) => {
+    const { data } = await client.get("/platform-changelog/published-posts.json", {}, { signal });
+    return chunkBCZPCMGL_cjs.publishedPostsSchema.parse(data);
+  };
+  const getComponentTemplates = async (componentId, signal) => {
+    const { data } = await client.get(
+      "/kbc-ui-templates/{componentId}.json",
+      { path: { componentId } },
+      { signal }
+    );
+    return chunkBCZPCMGL_cjs.componentTemplatesSchema.parse(data);
+  };
+  const getAnnouncements = async (signal) => {
     const { data } = await client.get(
-      "/platform-changelog/published-posts.json",
+      "/platform-announcements/announcements.json",
       {},
       { signal }
     );
     return data;
   };
   return {
-    getPublishedChangelogPosts
+    getPublishedChangelogPosts,
+    getComponentTemplates,
+    getAnnouncements
   };
 };
 

package/dist/assets/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/clients/assets/assetsClient.ts"],"names":["createGenericFetchClient"],"mappings":";;;;;AAKO,IAAM,kBAAA,GAAqB,CAAC,EAAE,OAAA,EAAS,aAAY,KAAuC;AAC/F,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, 'auth'>) => {\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"]}
+{"version":3,"sources":["../../src/clients/assets/assetsClient.ts"],"names":["createGenericFetchClient","publishedPostsSchema","componentTemplatesSchema"],"mappings":";;;;;;AAKO,IAAM,kBAAA,GAAqB,CAAC,EAAE,OAAA,EAAS,aAAY,KAAuC;AAC/F,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,CAAI,0CAAA,EAA4C,EAAC,EAAG,EAAE,MAAA,EAAQ,CAAA;AAE5F,IAAA,OAAOC,sCAAA,CAAqB,MAAM,IAAI,CAAA;AAAA,EACxC,CAAA;AAEA,EAAA,MAAM,qBAAA,GAAwB,OAAO,WAAA,EAAqB,MAAA,KAAyB;AACjF,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,GAAA;AAAA,MAC5B,sCAAA;AAAA,MACA,EAAE,IAAA,EAAM,EAAE,WAAA,EAAY,EAAE;AAAA,MACxB,EAAE,MAAA;AAAO,KACX;AAEA,IAAA,OAAOC,0CAAA,CAAyB,MAAM,IAAI,CAAA;AAAA,EAC5C,CAAA;AAOA,EAAA,MAAM,gBAAA,GAAmB,OAAO,MAAA,KAAyB;AACvD,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,GAAA;AAAA,MAC5B,4CAAA;AAAA,MACA,EAAC;AAAA,MACD,EAAE,MAAA;AAAO,KACX;AAEA,IAAA,OAAO,IAAA;AAAA,EACT,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,0BAAA;AAAA,IACA,qBAAA;AAAA,IACA;AAAA,GACF;AACF","file":"index.cjs","sourcesContent":["import { createGenericFetchClient } from '../../fetchClient';\nimport type { ClientInitOptions } from '../types';\n\nimport { componentTemplatesSchema, publishedPostsSchema } from './schema';\n\nexport const createAssetsClient = ({ baseUrl, middlewares }: Omit<ClientInitOptions, 'auth'>) => {\n  const client = createGenericFetchClient({\n    baseUrl,\n    middlewares,\n  });\n\n  const getPublishedChangelogPosts = async (signal?: AbortSignal) => {\n    const { data } = await client.get('/platform-changelog/published-posts.json', {}, { signal });\n\n    return publishedPostsSchema.parse(data);\n  };\n\n  const getComponentTemplates = async (componentId: string, signal?: AbortSignal) => {\n    const { data } = await client.get(\n      '/kbc-ui-templates/{componentId}.json',\n      { path: { componentId } },\n      { signal },\n    );\n\n    return componentTemplatesSchema.parse(data);\n  };\n\n  /**\n   * Static in-platform announcements feed. Returned untyped on purpose: the feed is authored by\n   * hand outside this repo, so the consumer owns runtime validation and decides what a malformed\n   * entry means for its surface.\n   */\n  const getAnnouncements = async (signal?: AbortSignal) => {\n    const { data } = await client.get<unknown>(\n      '/platform-announcements/announcements.json',\n      {},\n      { signal },\n    );\n\n    return data;\n  };\n\n  return {\n    getPublishedChangelogPosts,\n    getComponentTemplates,\n    getAnnouncements,\n  };\n};\n"]}

package/dist/assets/index.d.cts

@@ -1,9 +1,24 @@
-import { C as ClientInitOptions } from '../types-DqxZDbM1.cjs';
-import { Post } from './types.cjs';
+import { C as ClientInitOptions } from '../types-DNg4M5JV.cjs';
 import 'qs';
 
 declare const createAssetsClient: ({ baseUrl, middlewares }: Omit<ClientInitOptions, "auth">) => {
-    getPublishedChangelogPosts: (signal?: AbortSignal) => Promise<Post[]>;
+    getPublishedChangelogPosts: (signal?: AbortSignal) => Promise<{
+        title: string;
+        slug: string;
+        excerpt: string;
+        published_at: string;
+    }[]>;
+    getComponentTemplates: (componentId: string, signal?: AbortSignal) => Promise<{
+        templates?: {
+            config?: {
+                name: string;
+                data: Record<string, unknown>;
+                description?: string | undefined;
+            }[] | undefined;
+            api?: Record<string, unknown> | undefined;
+        } | undefined;
+    }>;
+    getAnnouncements: (signal?: AbortSignal) => Promise<unknown>;
 };
 
 export { createAssetsClient };

package/dist/assets/index.d.ts

@@ -1,9 +1,24 @@
-import { C as ClientInitOptions } from '../types-DqxZDbM1.js';
-import { Post } from './types.js';
+import { C as ClientInitOptions } from '../types-DNg4M5JV.js';
 import 'qs';
 
 declare const createAssetsClient: ({ baseUrl, middlewares }: Omit<ClientInitOptions, "auth">) => {
-    getPublishedChangelogPosts: (signal?: AbortSignal) => Promise<Post[]>;
+    getPublishedChangelogPosts: (signal?: AbortSignal) => Promise<{
+        title: string;
+        slug: string;
+        excerpt: string;
+        published_at: string;
+    }[]>;
+    getComponentTemplates: (componentId: string, signal?: AbortSignal) => Promise<{
+        templates?: {
+            config?: {
+                name: string;
+                data: Record<string, unknown>;
+                description?: string | undefined;
+            }[] | undefined;
+            api?: Record<string, unknown> | undefined;
+        } | undefined;
+    }>;
+    getAnnouncements: (signal?: AbortSignal) => Promise<unknown>;
 };
 
 export { createAssetsClient };

package/dist/assets/index.js

@@ -1,4 +1,5 @@
-import { createGenericFetchClient } from '../chunk-RK2VGHJE.js';
+import { publishedPostsSchema, componentTemplatesSchema } from '../chunk-FPB6OGTV.js';
+import { createGenericFetchClient } from '../chunk-XHDYLUM4.js';
 
 // src/clients/assets/assetsClient.ts
 var createAssetsClient = ({ baseUrl, middlewares }) => {
@@ -7,15 +8,29 @@ var createAssetsClient = ({ baseUrl, middlewares }) => {
     middlewares
   });
   const getPublishedChangelogPosts = async (signal) => {
+    const { data } = await client.get("/platform-changelog/published-posts.json", {}, { signal });
+    return publishedPostsSchema.parse(data);
+  };
+  const getComponentTemplates = async (componentId, signal) => {
+    const { data } = await client.get(
+      "/kbc-ui-templates/{componentId}.json",
+      { path: { componentId } },
+      { signal }
+    );
+    return componentTemplatesSchema.parse(data);
+  };
+  const getAnnouncements = async (signal) => {
     const { data } = await client.get(
-      "/platform-changelog/published-posts.json",
+      "/platform-announcements/announcements.json",
       {},
       { signal }
     );
     return data;
   };
   return {
-    getPublishedChangelogPosts
+    getPublishedChangelogPosts,
+    getComponentTemplates,
+    getAnnouncements
   };
 };
 

package/dist/assets/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/clients/assets/assetsClient.ts"],"names":[],"mappings":";;;AAKO,IAAM,kBAAA,GAAqB,CAAC,EAAE,OAAA,EAAS,aAAY,KAAuC;AAC/F,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, 'auth'>) => {\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"]}
+{"version":3,"sources":["../../src/clients/assets/assetsClient.ts"],"names":[],"mappings":";;;;AAKO,IAAM,kBAAA,GAAqB,CAAC,EAAE,OAAA,EAAS,aAAY,KAAuC;AAC/F,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,CAAI,0CAAA,EAA4C,EAAC,EAAG,EAAE,MAAA,EAAQ,CAAA;AAE5F,IAAA,OAAO,oBAAA,CAAqB,MAAM,IAAI,CAAA;AAAA,EACxC,CAAA;AAEA,EAAA,MAAM,qBAAA,GAAwB,OAAO,WAAA,EAAqB,MAAA,KAAyB;AACjF,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,GAAA;AAAA,MAC5B,sCAAA;AAAA,MACA,EAAE,IAAA,EAAM,EAAE,WAAA,EAAY,EAAE;AAAA,MACxB,EAAE,MAAA;AAAO,KACX;AAEA,IAAA,OAAO,wBAAA,CAAyB,MAAM,IAAI,CAAA;AAAA,EAC5C,CAAA;AAOA,EAAA,MAAM,gBAAA,GAAmB,OAAO,MAAA,KAAyB;AACvD,IAAA,MAAM,EAAE,IAAA,EAAK,GAAI,MAAM,MAAA,CAAO,GAAA;AAAA,MAC5B,4CAAA;AAAA,MACA,EAAC;AAAA,MACD,EAAE,MAAA;AAAO,KACX;AAEA,IAAA,OAAO,IAAA;AAAA,EACT,CAAA;AAEA,EAAA,OAAO;AAAA,IACL,0BAAA;AAAA,IACA,qBAAA;AAAA,IACA;AAAA,GACF;AACF","file":"index.js","sourcesContent":["import { createGenericFetchClient } from '../../fetchClient';\nimport type { ClientInitOptions } from '../types';\n\nimport { componentTemplatesSchema, publishedPostsSchema } from './schema';\n\nexport const createAssetsClient = ({ baseUrl, middlewares }: Omit<ClientInitOptions, 'auth'>) => {\n  const client = createGenericFetchClient({\n    baseUrl,\n    middlewares,\n  });\n\n  const getPublishedChangelogPosts = async (signal?: AbortSignal) => {\n    const { data } = await client.get('/platform-changelog/published-posts.json', {}, { signal });\n\n    return publishedPostsSchema.parse(data);\n  };\n\n  const getComponentTemplates = async (componentId: string, signal?: AbortSignal) => {\n    const { data } = await client.get(\n      '/kbc-ui-templates/{componentId}.json',\n      { path: { componentId } },\n      { signal },\n    );\n\n    return componentTemplatesSchema.parse(data);\n  };\n\n  /**\n   * Static in-platform announcements feed. Returned untyped on purpose: the feed is authored by\n   * hand outside this repo, so the consumer owns runtime validation and decides what a malformed\n   * entry means for its surface.\n   */\n  const getAnnouncements = async (signal?: AbortSignal) => {\n    const { data } = await client.get<unknown>(\n      '/platform-announcements/announcements.json',\n      {},\n      { signal },\n    );\n\n    return data;\n  };\n\n  return {\n    getPublishedChangelogPosts,\n    getComponentTemplates,\n    getAnnouncements,\n  };\n};\n"]}

package/dist/assets/schema.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+var chunkBCZPCMGL_cjs = require('../chunk-BCZPCMGL.cjs');
+
+
+
+Object.defineProperty(exports, "componentTemplatesSchema", {
+  enumerable: true,
+  get: function () { return chunkBCZPCMGL_cjs.componentTemplatesSchema; }
+});
+Object.defineProperty(exports, "publishedPostsSchema", {
+  enumerable: true,
+  get: function () { return chunkBCZPCMGL_cjs.publishedPostsSchema; }
+});
+//# sourceMappingURL=schema.cjs.map
+//# sourceMappingURL=schema.cjs.map

package/dist/assets/schema.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"schema.cjs"}

package/dist/assets/schema.d.cts

@@ -0,0 +1,28 @@
+import * as zod from 'zod';
+
+declare const postSchema: zod.ZodObject<{
+    title: zod.ZodString;
+    slug: zod.ZodString;
+    excerpt: zod.ZodString;
+    published_at: zod.ZodString;
+}, zod.core.$strip>;
+declare const publishedPostsSchema: zod.ZodArray<zod.ZodObject<{
+    title: zod.ZodString;
+    slug: zod.ZodString;
+    excerpt: zod.ZodString;
+    published_at: zod.ZodString;
+}, zod.core.$strip>>;
+declare const componentTemplatesSchema: zod.ZodObject<{
+    templates: zod.ZodOptional<zod.ZodObject<{
+        config: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+            name: zod.ZodString;
+            description: zod.ZodOptional<zod.ZodString>;
+            data: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
+        }, zod.core.$strip>>>;
+        api: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+    }, zod.core.$strip>>;
+}, zod.core.$strip>;
+type Post = zod.infer<typeof postSchema>;
+type ComponentTemplates = zod.infer<typeof componentTemplatesSchema>;
+
+export { type ComponentTemplates, type Post, componentTemplatesSchema, publishedPostsSchema };

package/dist/assets/schema.d.ts

@@ -0,0 +1,28 @@
+import * as zod from 'zod';
+
+declare const postSchema: zod.ZodObject<{
+    title: zod.ZodString;
+    slug: zod.ZodString;
+    excerpt: zod.ZodString;
+    published_at: zod.ZodString;
+}, zod.core.$strip>;
+declare const publishedPostsSchema: zod.ZodArray<zod.ZodObject<{
+    title: zod.ZodString;
+    slug: zod.ZodString;
+    excerpt: zod.ZodString;
+    published_at: zod.ZodString;
+}, zod.core.$strip>>;
+declare const componentTemplatesSchema: zod.ZodObject<{
+    templates: zod.ZodOptional<zod.ZodObject<{
+        config: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+            name: zod.ZodString;
+            description: zod.ZodOptional<zod.ZodString>;
+            data: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
+        }, zod.core.$strip>>>;
+        api: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+    }, zod.core.$strip>>;
+}, zod.core.$strip>;
+type Post = zod.infer<typeof postSchema>;
+type ComponentTemplates = zod.infer<typeof componentTemplatesSchema>;
+
+export { type ComponentTemplates, type Post, componentTemplatesSchema, publishedPostsSchema };

package/dist/assets/schema.js

@@ -0,0 +1,3 @@
+export { componentTemplatesSchema, publishedPostsSchema } from '../chunk-FPB6OGTV.js';
+//# sourceMappingURL=schema.js.map
+//# sourceMappingURL=schema.js.map

package/dist/assets/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"schema.js"}