@kontent-ai/core-sdk 12.0.0-preview.2 → 12.0.0-preview.21

package/.npmignore

@@ -1,10 +1,6 @@
 # Ignore everything
 *
-
-# But descend into directories
-
-# Recursively allow files under subtree
-!/lib/**
+# And allow following
 !/dist/**
 !package.json
 !.npmignore

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2025 Kontent s.r.o.
+Copyright (c) 2026 Kontent s.r.o.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -12,6 +12,22 @@ The **Core SDK** provides foundational functionality leveraged by dependent Kont
 
 ---
 
+## Requirements
+
+Before using this package, make sure your environment matches the published package requirements:
+
+- Node.js `>=22`
+- ESM-compatible runtime, because the package is published as an ES module
+- Peer dependencies: `zod` and `ts-pattern`
+
+With modern package managers such as npm, peer dependencies are typically installed automatically, so you usually only need:
+
+```bash
+npm install @kontent-ai/core-sdk
+```
+
+---
+
 ## HTTP Request Infrastructure
 
 The SDK includes a default implementation of the `HttpService` and `HttpAdapter` components, which handle HTTP requests to the Kontent.ai APIs.
@@ -25,32 +41,98 @@ These implementations are designed to work out-of-the-box but are also fully cus
 The `HttpService` comes with several built-in capabilities, such as:
 
 - **Retry policies**
-- **Request validation**
+- **Request parsing and validation** (URL parsing, body serialization)
 - **Automatic header and tracking management**
 - **Kontent.ai-specific error extraction**
 
 To customize these behaviors entirely, you can replace the `HttpService` with your own implementation.
 
-However, if your goal is to retain the core features (e.g., retry policies, request validation) and only swap out the underlying HTTP client, you can do so by supplying a custom `HttpAdapter` to the `getDefaultHttpService` method.
+However, if your goal is to retain the core features (e.g., retry policies, request parsing) and only swap out the underlying HTTP client, you can do so by supplying a custom `HttpAdapter` to the `getDefaultHttpService` method.
 
 ---
 
 ## Example: Custom `HttpAdapter` Implementation
 
-Below is an example demonstrating how to provide your own HTTP client by implementing a custom `HttpAdapter`:
+Below is an example demonstrating how to provide your own HTTP client by implementing a custom `HttpAdapter`. Both `executeRequest` and `downloadFile` are optional, so you only need to implement the methods you want to override.
+
+If you want the SDK to preserve specific `error.details.reason` values for custom adapters, throw:
+
+- `AdapterAbortError` when the request is aborted
+- `AdapterParseError` when the response cannot be parsed as JSON or `Blob`
+
+If you throw some other error, the SDK will classify it as `adapterError`.
 
 ```typescript
-const httpService = await getDefaultHttpService({
+import { AdapterAbortError, AdapterParseError, getDefaultHttpService } from "@kontent-ai/core-sdk";
+
+const httpService = getDefaultHttpService({
   adapter: {
-    requestAsync: async (options) => {
-      // Execute the request using your custom HTTP client
+    executeRequest: async (options) => {
+      let response: Response;
+
+      try {
+        response = await fetch(options.url, {
+          method: options.method,
+          headers: Object.fromEntries((options.requestHeaders ?? []).map((header) => [header.name, header.value])),
+          body: options.body,
+          signal: options.abortSignal ?? undefined,
+        });
+      } catch (error) {
+        if (error instanceof DOMException && error.name === "AbortError") {
+          throw new AdapterAbortError(error);
+        }
+
+        throw error;
+      }
+
+      let payload = null;
+
+      if (response.headers.get("content-type")?.includes("application/json")) {
+        try {
+          payload = await response.json();
+        } catch (error) {
+          throw new AdapterParseError(error);
+        }
+      }
+
       return {
-        isValidResponse: <true | false>,
-        responseHeaders: <arrayOfHeaders>,
-        status: <statusCode>,
-        statusText: <statusText>,
-        toJsonAsync: async () => <responseInJson>,
-        toBlobAsync: async () => <responseInBlob>,
+        payload,
+        responseHeaders: [...response.headers.entries()].map(([name, value]) => ({ name, value })),
+        status: response.status,
+        statusText: response.statusText,
+        url: options.url,
+      };
+    },
+    downloadFile: async (options) => {
+      let response: Response;
+
+      try {
+        response = await fetch(options.url, {
+          headers: Object.fromEntries((options.requestHeaders ?? []).map((header) => [header.name, header.value])),
+          signal: options.abortSignal ?? undefined,
+        });
+      } catch (error) {
+        if (error instanceof DOMException && error.name === "AbortError") {
+          throw new AdapterAbortError(error);
+        }
+
+        throw error;
+      }
+
+      let payload: Blob;
+
+      try {
+        payload = await response.blob();
+      } catch (error) {
+        throw new AdapterParseError(error);
+      }
+
+      return {
+        payload,
+        responseHeaders: [...response.headers.entries()].map(([name, value]) => ({ name, value })),
+        status: response.status,
+        statusText: response.statusText,
+        url: options.url,
       };
     },
   },
@@ -58,3 +140,86 @@ const httpService = await getDefaultHttpService({
 ```
 
 This approach gives you fine-grained control over how requests are made, while still benefiting from the core service's additional functionalities.
+
+---
+
+## Error Handling
+
+All operations return a discriminated `success`/`error` result — the SDK never throws. Errors are represented by `KontentSdkError`, which carries a `details` object with a `reason` discriminant that can be narrowed for type-safe handling:
+
+```typescript
+const { success, response, error } = await httpService.request({
+  url: "https://manage.kontent.ai/v2/projects/...",
+  method: "GET"
+});
+
+if (!success) {
+  switch (error.details.reason) {
+    case "unauthorized":
+      // error.details includes: status, statusText, responseHeaders, kontentErrorResponse
+      console.error("Check your API key:", error.details.kontentErrorResponse?.message);
+      break;
+    case "notFound":
+      console.error("Resource not found:", error.url);
+      break;
+    case "invalidResponse":
+      // Any non-2xx response that isn't 401 or 404
+      console.error(`HTTP ${error.details.status}:`, error.details.kontentErrorResponse?.message);
+      break;
+    case "parseError":
+      // The response claimed to be JSON, but parsing it failed
+      console.error("Failed to parse response:", error.details.originalError);
+      break;
+    case "adapterError":
+      // Network failure, timeout, or other transport-level issue
+      console.error("Request failed:", error.details.originalError);
+      break;
+    case "invalidUrl":
+      // The provided URL could not be parsed before the request was sent
+      console.error("Invalid URL:", error.details.originalError);
+      break;
+    case "invalidBody":
+      // The request body could not be serialized before the request was sent
+      console.error("Invalid body:", error.details.originalError);
+      break;
+    case "validationFailed":
+      // Zod schema validation failed (when responseValidation is enabled)
+      console.error("Unexpected response shape for", error.details.url, error.details.zodError);
+      break;
+    case "noResponses":
+      // Paging query completed without any responses
+      console.error("No data returned for", error.details.url);
+      break;
+    case "aborted":
+      // The request was cancelled before it could complete
+      console.error("Request was aborted:", error.details.originalError);
+      break;
+  }
+  return;
+}
+
+// response is fully typed here
+console.log(response.payload);
+```
+
+---
+
+## Retry Strategy
+
+The default `HttpService` includes configurable retry logic. HTTP 429 (rate limit) responses are always retried automatically with a delay based on the `Retry-After` header. All other HTTP error responses are not retried.
+
+For transport-level failures (network errors, timeouts), you can control retry behavior via `canRetryAdapterError`:
+
+```typescript
+const httpService = getDefaultHttpService({
+  retryStrategy: {
+    maxRetries: 3,
+    canRetryAdapterError: (error) => {
+      // `error` is typed as KontentSdkError<ErrorDetailsFor<"adapterError">>
+      // Return true to retry, false to stop
+      return true;
+    },
+    logRetryAttempt: "logToConsole",
+  },
+});
+```

package/dist/core-sdk-info.d.ts

@@ -0,0 +1,2 @@
+import type { SDKInfo } from "./models/core.models.js";
+export declare const coreSdkInfo: SDKInfo;

package/dist/core-sdk-info.js

@@ -0,0 +1,6 @@
+export const coreSdkInfo = {
+    host: "npmjs.com",
+    version: "12.0.0-preview.21",
+    name: "@kontent-ai/core-sdk",
+};
+//# sourceMappingURL=core-sdk-info.js.map

package/dist/core-sdk-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-sdk-info.js","sourceRoot":"","sources":["../lib/core-sdk-info.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,WAAW,GAAY;IACnC,IAAI,EAAE,WAAW;IACjB,OAAO,EAAE,aAAa;IACtB,IAAI,EAAE,sBAAsB;CAC5B,CAAC"}

package/dist/devkit/console.utils.d.ts

@@ -0,0 +1,2 @@
+export type ConsoleColor = "red" | "green" | "yellow" | "blue" | "cyan" | "magenta" | "white" | "gray";
+export declare function colorize(color: ConsoleColor, text: string): string;

package/dist/devkit/console.utils.js

@@ -0,0 +1,5 @@
+import { styleText } from "node:util";
+export function colorize(color, text) {
+    return styleText(color, text);
+}
+//# sourceMappingURL=console.utils.js.map

package/dist/devkit/console.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"console.utils.js","sourceRoot":"","sources":["../../lib/devkit/console.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAItC,MAAM,UAAU,QAAQ,CAAC,KAAmB,EAAE,IAAY;IACzD,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAC/B,CAAC"}

package/dist/devkit/environment.utils.d.ts

@@ -0,0 +1,2 @@
+export declare function getEnvironmentRequiredValue(variableName: string): string;
+export declare function getEnvironmentOptionalValue(variableName: string): string | undefined;

package/dist/devkit/environment.utils.js

@@ -0,0 +1,12 @@
+import { colorize } from "./console.utils.js";
+export function getEnvironmentRequiredValue(variableName) {
+    const value = getEnvironmentOptionalValue(variableName);
+    if (!value) {
+        throw new Error(`Missing environment variable '${colorize("red", variableName)}'`);
+    }
+    return value;
+}
+export function getEnvironmentOptionalValue(variableName) {
+    return process.env[variableName];
+}
+//# sourceMappingURL=environment.utils.js.map

package/dist/devkit/environment.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.utils.js","sourceRoot":"","sources":["../../lib/devkit/environment.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,MAAM,UAAU,2BAA2B,CAAC,YAAoB;IAC/D,MAAM,KAAK,GAAG,2BAA2B,CAAC,YAAY,CAAC,CAAC;IAExD,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC;IACpF,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,YAAoB;IAC/D,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC"}

package/dist/devkit/script.utils.js

@@ -1,11 +1,11 @@
 import { rmSync } from "node:fs";
-import chalk from "chalk";
+import { colorize } from "./console.utils.js";
 export function deleteFolderRecursive(path) {
-    console.log(`Deleting existing folder '${chalk.yellow(path)}'`);
+    console.log(`Deleting existing folder '${colorize("yellow", path)}'`);
     rmSync(path, {
         recursive: true,
         force: true,
     });
-    console.log(`Folder '${chalk.yellow(path)}' deleted successfully`);
+    console.log(`Folder '${colorize("yellow", path)}' deleted successfully`);
 }
 //# sourceMappingURL=script.utils.js.map

package/dist/devkit/script.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"script.utils.js","sourceRoot":"","sources":["../../lib/devkit/script.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,UAAU,qBAAqB,CAAC,IAAY;IACjD,OAAO,CAAC,GAAG,CAAC,6BAA6B,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,MAAM,CAAC,IAAI,EAAE;QACZ,SAAS,EAAE,IAAI;QACf,KAAK,EAAE,IAAI;KACX,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;AACpE,CAAC"}
+{"version":3,"file":"script.utils.js","sourceRoot":"","sources":["../../lib/devkit/script.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,MAAM,UAAU,qBAAqB,CAAC,IAAY;IACjD,OAAO,CAAC,GAAG,CAAC,6BAA6B,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACtE,MAAM,CAAC,IAAI,EAAE;QACZ,SAAS,EAAE,IAAI;QACf,KAAK,EAAE,IAAI;KACX,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;AAC1E,CAAC"}

package/dist/devkit_api.d.ts

@@ -1,2 +1,5 @@
+/** biome-ignore-all lint/performance/noBarrelFile: One barrel for exported API is fine */
+export { type ConsoleColor, colorize } from "./devkit/console.utils.js";
+export { getEnvironmentOptionalValue, getEnvironmentRequiredValue } from "./devkit/environment.utils.js";
 export { deleteFolderRecursive } from "./devkit/script.utils.js";
 export { replaceSdkVersionPlaceholder } from "./utils/sdk-version.utils.js";

package/dist/devkit_api.js

@@ -1,4 +1,6 @@
-// biome-ignore lint/performance/noBarrelFile: One barrel for the Devkit API is fine
+/** biome-ignore-all lint/performance/noBarrelFile: One barrel for exported API is fine */
+export { colorize } from "./devkit/console.utils.js";
+export { getEnvironmentOptionalValue, getEnvironmentRequiredValue } from "./devkit/environment.utils.js";
 export { deleteFolderRecursive } from "./devkit/script.utils.js";
 export { replaceSdkVersionPlaceholder } from "./utils/sdk-version.utils.js";
 //# sourceMappingURL=devkit_api.js.map

package/dist/devkit_api.js.map

@@ -1 +1 @@
-{"version":3,"file":"devkit_api.js","sourceRoot":"","sources":["../lib/devkit_api.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC"}
+{"version":3,"file":"devkit_api.js","sourceRoot":"","sources":["../lib/devkit_api.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAE1F,OAAO,EAAqB,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACzG,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/http/http.adapter.d.ts

@@ -1,2 +1,2 @@
 import type { HttpAdapter } from "./http.models.js";
-export declare function getDefaultHttpAdapter(): HttpAdapter;
+export declare function getDefaultHttpAdapter(): Required<HttpAdapter>;

package/dist/http/http.adapter.js

@@ -1,31 +1,85 @@
-import { toFetchHeaders, toSdkHeaders } from "../utils/header.utils.js";
+import { AdapterAbortError, AdapterParseError } from "../models/error.models.js";
+import { runWithAbortSignal } from "../utils/abort.utils.js";
+import { isApplicationJsonResponseType, toFetchHeaders, toSdkHeaders } from "../utils/header.utils.js";
+import { tryCatchAsync } from "../utils/try-catch.utils.js";
 export function getDefaultHttpAdapter() {
     return {
-        requestAsync: async (options) => {
-            const response = await fetch(options.url, {
-                method: options.method,
-                headers: toFetchHeaders(options.requestHeaders ?? []),
-                body: options.body,
+        executeRequest: async (options) => {
+            const response = await getResponse(options);
+            const sdkHeaders = toSdkHeaders(response.headers);
+            const payload = isApplicationJsonResponseType(sdkHeaders)
+                ? await parseResponse({
+                    parseFunc: async () => (await response.json()),
+                    abortSignal: options.abortSignal,
+                })
+                : null;
+            return createAdapterResponse(options.url, response, payload, sdkHeaders);
+        },
+        downloadFile: async (options) => {
+            const response = await getResponse({
+                ...options,
+                method: "GET",
             });
-            const sdkResponseHeaders = toSdkHeaders(response.headers);
-            return {
-                isValidResponse: response.ok,
-                responseHeaders: sdkResponseHeaders,
-                status: response.status,
-                statusText: response.statusText,
-                toBlobAsync: async () => await response.blob(),
-                toJsonAsync: async () => {
-                    const contentTypeResponseHeader = sdkResponseHeaders
-                        .find((m) => m.name.toLowerCase() === "Content-Type".toLowerCase())
-                        ?.value.toLowerCase();
-                    if (contentTypeResponseHeader?.includes("application/json")) {
-                        // Includes instead of equal due to the fact that the header value can be 'application/json; charset=utf-8' or similar
-                        return (await response.json());
-                    }
-                    return null;
-                },
-            };
+            const file = await parseResponse({ parseFunc: async () => response.blob(), abortSignal: options.abortSignal });
+            return createAdapterResponse(options.url, response, file, toSdkHeaders(response.headers));
         },
     };
 }
+async function getResponse(options) {
+    const { error, data, success } = await tryCatchAsync(async () => await fetch(options.url, {
+        method: options.method,
+        headers: toFetchHeaders(options.requestHeaders ?? []),
+        body: options.body ?? null,
+        signal: options.abortSignal ?? null,
+    }));
+    if (success) {
+        return data;
+    }
+    if (isAbortError(error)) {
+        // this is to notify the HttpService that the request was aborted
+        // HttpService will then convert the error to a KontentSdkError with the reason "aborted"
+        throw new AdapterAbortError(error);
+    }
+    // re-throw original error
+    throw error;
+}
+async function parseResponse({ parseFunc, abortSignal, }) {
+    const runParseFunc = async () => {
+        const { success, data, error } = await tryCatchAsync(async () => {
+            return await parseFunc();
+        });
+        if (!success) {
+            // this is to notify the HttpService that the response is not valid JSON or BLOB
+            // HttpService will then convert the error to a KontentSdkError with the reason "parseError"
+            throw new AdapterParseError(error);
+        }
+        return data;
+    };
+    if (!abortSignal) {
+        return await runParseFunc();
+    }
+    const { isAborted, data } = await runWithAbortSignal({
+        func: runParseFunc,
+        abortSignal: abortSignal,
+    });
+    if (isAborted) {
+        throw new AdapterAbortError(new Error("Adapter has aborted the request while parsing the response."));
+    }
+    return data;
+}
+function isAbortError(error) {
+    if (!error || typeof error !== "object") {
+        return false;
+    }
+    return "name" in error && error.name === "AbortError";
+}
+function createAdapterResponse(url, response, payload, responseHeaders) {
+    return {
+        responseHeaders,
+        status: response.status,
+        statusText: response.statusText,
+        url: url,
+        payload,
+    };
+}
 //# sourceMappingURL=http.adapter.js.map

package/dist/http/http.adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"http.adapter.js","sourceRoot":"","sources":["../../lib/http/http.adapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAGxE,MAAM,UAAU,qBAAqB;IACpC,OAAO;QACN,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAC/B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;gBACzC,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,cAAc,IAAI,EAAE,CAAC;gBACrD,IAAI,EAAE,OAAO,CAAC,IAAI;aAClB,CAAC,CAAC;YAEH,MAAM,kBAAkB,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAE1D,OAAO;gBACN,eAAe,EAAE,QAAQ,CAAC,EAAE;gBAC5B,eAAe,EAAE,kBAAkB;gBACnC,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE;gBAC9C,WAAW,EAAE,KAAK,IAAI,EAAE;oBACvB,MAAM,yBAAyB,GAAG,kBAAkB;yBAClD,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAM,cAA2C,CAAC,WAAW,EAAE,CAAC;wBACjG,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;oBAEvB,IAAI,yBAAyB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;wBAC7D,sHAAsH;wBACtH,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAc,CAAC;oBAC7C,CAAC;oBAED,OAAO,IAAI,CAAC;gBACb,CAAC;aACD,CAAC;QACH,CAAC;KACD,CAAC;AACH,CAAC"}
+{"version":3,"file":"http.adapter.js","sourceRoot":"","sources":["../../lib/http/http.adapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAEjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,6BAA6B,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACvG,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAG5D,MAAM,UAAU,qBAAqB;IACpC,OAAO;QACN,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACjC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;YAC5C,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAClD,MAAM,OAAO,GAAG,6BAA6B,CAAC,UAAU,CAAC;gBACxD,CAAC,CAAC,MAAM,aAAa,CAAY;oBAC/B,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAc;oBAC3D,WAAW,EAAE,OAAO,CAAC,WAAW;iBAChC,CAAC;gBACH,CAAC,CAAC,IAAI,CAAC;YAER,OAAO,qBAAqB,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1E,CAAC;QACD,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YAC/B,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC;gBAClC,GAAG,OAAO;gBACV,MAAM,EAAE,KAAK;aACb,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;YAE/G,OAAO,qBAAqB,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC3F,CAAC;KACD,CAAC;AACH,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,OAAqC;IAC/D,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,aAAa,CACnD,KAAK,IAAI,EAAE,CACV,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,cAAc,IAAI,EAAE,CAAC;QACrD,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,IAAI;QAC1B,MAAM,EAAE,OAAO,CAAC,WAAW,IAAI,IAAI;KACnC,CAAC,CACH,CAAC;IAEF,IAAI,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,iEAAiE;QACjE,yFAAyF;QACzF,MAAM,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,0BAA0B;IAC1B,MAAM,KAAK,CAAC;AACb,CAAC;AAED,KAAK,UAAU,aAAa,CAAkC,EAC7D,SAAS,EACT,WAAW,GAIX;IACA,MAAM,YAAY,GAAG,KAAK,IAAuB,EAAE;QAClD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,aAAa,CAAC,KAAK,IAAI,EAAE;YAC/D,OAAO,MAAM,SAAS,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,gFAAgF;YAChF,4FAA4F;YAC5F,MAAM,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC,CAAC;IAEF,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,OAAO,MAAM,YAAY,EAAE,CAAC;IAC7B,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,kBAAkB,CAAW;QAC9D,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,WAAW;KACxB,CAAC,CAAC;IAEH,IAAI,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,iBAAiB,CAAC,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC,CAAC;IACvG,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IACnC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC;AACvD,CAAC;AAED,SAAS,qBAAqB,CAC7B,GAAW,EACX,QAAkB,EAClB,OAAiB,EACjB,eAAkC;IAElC,OAAO;QACN,eAAe;QACf,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,GAAG,EAAE,GAAG;QACR,OAAO;KACP,CAAC;AACH,CAAC"}

package/dist/http/http.models.d.ts

@@ -1,17 +1,14 @@
-import type { Header, HttpMethod, LiteralUnionNumber, RetryStrategyOptions } from "../models/core.models.js";
-import type { CoreSdkError } from "../models/error.models.js";
-import type { JsonValue } from "../models/json.models.js";
-type Success<TData> = {
-    readonly success: true;
-    readonly response: TData;
-    readonly error?: never;
-};
-type Failure = {
-    readonly success: false;
+import type { Header, HttpMethod, RetryStrategyOptions } from "../models/core.models.js";
+import type { KontentSdkError } from "../models/error.models.js";
+import type { JsonObject, JsonValue } from "../models/json.models.js";
+import type { LiteralUnionNumber } from "../models/utility.types.js";
+import type { QueryResponse } from "../sdk/sdk-models.js";
+import type { Failure, Success } from "../utils/try-catch.utils.js";
+export type HttpResult<TResponse> = Success<{
+    readonly response: TResponse;
+}> | Failure<{
     readonly response?: never;
-    readonly error: CoreSdkError;
-};
-export type HttpResult<TData> = Success<TData> | Failure;
+}, KontentSdkError>;
 /**
  * Helper status codes for the HTTP service.
  * It can be any valid number status code as this type only serves as a helper.
@@ -31,23 +28,26 @@ export type DefaultHttpServiceConfig = {
      */
     readonly adapter?: HttpAdapter;
 };
-export type HttpResponse<TResponseData extends JsonValue | Blob, TBodyData extends JsonValue | Blob> = HttpResult<{
-    readonly data: TResponseData;
-    readonly body: TBodyData;
+export type HttpPayload = JsonValue | Blob;
+export type HttpRequestBody = JsonObject | Blob | null;
+export type HttpResponse<TPayload extends AdapterPayload, TRequestBody extends HttpRequestBody> = HttpResult<{
+    readonly payload: TPayload;
+    readonly body?: TRequestBody;
     readonly method: HttpMethod;
     readonly requestHeaders: readonly Header[];
-    readonly adapterResponse: Omit<AdapterResponse, "toJsonAsync" | "toBlobAsync">;
+    readonly adapterResponse: AdapterResponse<TPayload>;
 }>;
-export type ExecuteRequestOptions<TBodyData extends JsonValue | Blob> = {
+export type ExecuteRequestOptions<TRequestBody extends HttpRequestBody> = {
     readonly url: string;
     readonly method: HttpMethod;
-    readonly body: TBodyData;
+    readonly body?: TRequestBody;
     readonly requestHeaders?: readonly Header[];
+    readonly abortSignal?: AbortSignal | undefined;
 };
 export type UploadFileRequestOptions = Omit<ExecuteRequestOptions<Blob>, "method"> & {
     readonly method: Extract<HttpMethod, "POST" | "PUT" | "PATCH">;
 };
-export type DownloadFileRequestOptions = Pick<ExecuteRequestOptions<Blob>, "url" | "requestHeaders">;
+export type DownloadFileRequestOptions = Pick<ExecuteRequestOptions<null>, "url" | "requestHeaders" | "abortSignal">;
 /**
  * Represents the HTTP service used for making requests to the Kontent.ai API.
  *
@@ -62,29 +62,39 @@ export type HttpService = {
     /**
      * Executes request with the given method and body.
      */
-    requestAsync<TResponseData extends JsonValue, TBodyData extends JsonValue>(opts: ExecuteRequestOptions<TBodyData>): Promise<HttpResponse<TResponseData, TBodyData>>;
+    request<TResponsePayload extends JsonValue, TRequestBody extends HttpRequestBody>(opts: ExecuteRequestOptions<TRequestBody>): Promise<HttpResponse<TResponsePayload, TRequestBody>>;
     /**
      * Downloads a file from the given URL as a blob.
      */
-    downloadFileAsync(opts: DownloadFileRequestOptions): Promise<HttpResponse<Blob, null>>;
+    downloadFile(opts: DownloadFileRequestOptions): Promise<HttpResponse<Blob, null>>;
     /**
      * This method is used to upload a kontent.ai binary file.
      */
-    uploadFileAsync<TResponseData extends JsonValue>(opts: UploadFileRequestOptions): Promise<HttpResponse<TResponseData, Blob>>;
+    uploadFile<TResponsePayload extends JsonValue>(opts: UploadFileRequestOptions): Promise<HttpResponse<TResponsePayload, Blob>>;
 };
-export type AdapterResponse<TStatusCode extends HttpServiceStatus = HttpServiceStatus> = {
-    readonly toJsonAsync: () => Promise<JsonValue>;
-    readonly toBlobAsync: () => Promise<Blob>;
-    readonly isValidResponse: boolean;
+export type AdapterResponse<TPayload extends AdapterPayload> = {
+    readonly payload: TPayload;
     readonly responseHeaders: readonly Header[];
-    readonly status: TStatusCode;
+    readonly status: HttpServiceStatus;
     readonly statusText: string;
+    readonly url: string;
 };
-export type AdapterRequestOptions = {
+export type AdapterBody = string | Blob | null;
+export type AdapterPayload = JsonValue | Blob;
+export type AdapterExecuteRequestOptions = {
     readonly url: string;
     readonly method: HttpMethod;
-    readonly body: string | Blob | undefined | null;
+    readonly body?: AdapterBody;
     readonly requestHeaders?: readonly Header[];
+    readonly abortSignal?: AbortSignal | undefined;
+};
+export type AdapterDownloadFileOptions = Pick<AdapterExecuteRequestOptions, "url" | "requestHeaders" | "abortSignal">;
+export type GetNextPageData<TResponsePayload extends JsonValue, TMeta> = (response: QueryResponse<TResponsePayload, TMeta>) => {
+    readonly continuationToken?: string | undefined;
+    readonly nextPageUrl?: string | undefined;
+};
+export type PaginationConfig = {
+    readonly maxPagesCount?: number;
 };
 /**
  * Defines the adapter responsible solely for executing HTTP requests.
@@ -98,6 +108,6 @@ export type AdapterRequestOptions = {
  * Alternatively, you may implement the entire `HttpService` interface to create a fully customized HTTP service.
  */
 export type HttpAdapter = {
-    readonly requestAsync: (options: AdapterRequestOptions) => Promise<AdapterResponse>;
+    readonly executeRequest?: (options: AdapterExecuteRequestOptions) => Promise<AdapterResponse<JsonValue>>;
+    readonly downloadFile?: (options: AdapterDownloadFileOptions) => Promise<AdapterResponse<Blob>>;
 };
-export {};