@kontent-ai/delivery-sdk 16.4.3 → 17.0.0-preview.0

package/.npmignore

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

package/LICENSE.md

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2023 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:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# MIT License
+
+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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,261 @@
+[![npm version](https://badge.fury.io/js//%40kontent-ai%2Fdelivery-sdk.svg)](https://www.npmjs.com/package/@kontent-ai/delivery-sdk)
+[![Build](https://github.com/kontent-ai/delivery-sdk-js/actions/workflows/build.yml/badge.svg)](https://github.com/kontent-ai/delivery-sdk-js/actions/workflows/build.yml)
+[![Integration Tests](https://github.com/kontent-ai/delivery-sdk-js/actions/workflows/integration-tests.yml/badge.svg)](https://github.com/kontent-ai/delivery-sdk-js/actions/workflows/integration-tests.yml)
+[![Unit Tests](https://github.com/kontent-ai/delivery-sdk-js/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/kontent-ai/delivery-sdk-js/actions/workflows/unit-tests.yml)
+[![npm](https://img.shields.io/npm/dt/@kontent-ai/delivery-sdk.svg)](https://www.npmjs.com/package/@kontent-ai/delivery-sdk)
+[![Known Vulnerabilities](https://snyk.io/test/github/Kontent-ai/delivery-sdk-js/badge.svg)](https://snyk.io/test/github/kontent-ai/delivery-sdk-js)
+[![GitHub license](https://img.shields.io/github/license/Kontent-ai/delivery-sdk-js.svg)](https://github.com/kontent-ai/delivery-sdk-js)
+
+# Kontent.ai Delivery SDK for JavaScript
+
+A TypeScript/JavaScript SDK for the [Kontent.ai Delivery API](https://kontent.ai/learn/docs/apis/openapi/delivery-api/).
+It fetches content items, types, taxonomies, and languages, with first-class TypeScript typing and optional
+runtime validation.
+
+> **Upgrading from v16?** See the [migration guide](./migration.md).
+
+## Installation
+
+The SDK has three peer dependencies: `@kontent-ai/core-sdk`, `zod`, and `ts-pattern`.
+
+```bash
+# npm installs peer dependencies automatically
+npm install @kontent-ai/delivery-sdk
+
+# pnpm needs them listed explicitly
+pnpm add @kontent-ai/delivery-sdk @kontent-ai/core-sdk zod ts-pattern
+```
+
+Requires Node.js ≥ 22.
+
+## Quick start
+
+```typescript
+import { createDeliveryClient } from "@kontent-ai/delivery-sdk";
+
+const client = createDeliveryClient({
+    apiMode: "public",
+    environmentId: "<your-environment-id>",
+});
+
+// Fetch a single content item
+const { response } = await client.fetchContentItem({ codename: "my_article" }).fetchSafe();
+```
+
+Every query returns `{ payload, meta }`. The `payload` is the raw API response (content lives in
+`payload.items` / `payload.item`); `meta` holds response metadata such as the continuation token.
+
+## Configuration
+
+The API mode is set once, when you create the client:
+
+```typescript
+// Public — published content
+createDeliveryClient({ apiMode: "public", environmentId: "<id>" });
+
+// Preview — unpublished content
+createDeliveryClient({ apiMode: "preview", environmentId: "<id>", deliveryApiKey: "<preview-key>" });
+
+// Secure — published content with Secured access enabled
+createDeliveryClient({ apiMode: "secure", environmentId: "<id>", deliveryApiKey: "<secure-key>" });
+```
+
+| Option | Required | Description |
+|---|---|---|
+| `apiMode` | yes | `"public"`, `"preview"`, or `"secure"` |
+| `environmentId` | yes | Your Kontent.ai environment ID |
+| `deliveryApiKey` | for preview/secure | The preview or secure access API key |
+| `baseUrl`, `httpService`, `retryStrategy` | no | Advanced options from [`@kontent-ai/core-sdk`](https://github.com/kontent-ai/core-sdk-js) |
+| `runtimeValidation` | no | Opt-in Zod validation of responses (see [Runtime validation](#runtime-validation)) |
+
+## Safe vs. throwing queries
+
+Every query offers two execution styles:
+
+- **Safe** (`fetchSafe` / `fetchPageSafe` / `fetchAllPagesSafe`) — never throws; returns
+  `{ success, response, error }`.
+- **Throwing** (`fetch` / `fetchPage` / `fetchAllPages`) — returns the response directly and throws on
+  failure.
+
+```typescript
+// Safe — handle the result object
+const { success, response, error } = await client.listContentItems().fetchPageSafe();
+if (success) {
+    console.log(response.payload.items);
+}
+
+// Throwing — use try/catch
+try {
+    const response = await client.listContentItems().fetchPage();
+    console.log(response.payload.items);
+} catch (error) {
+    // error is a DeliverySdkError
+}
+```
+
+Use single-item queries with `fetch` / `fetchSafe`; paged queries (`listContentItems`, `listContentTypes`,
+`listTaxonomies`, `listLanguages`, `itemsFeed`, …) with `fetchPage` / `fetchPageSafe` /
+`fetchAllPages` / `fetchAllPagesSafe`.
+
+## Error handling
+
+Failures are reported as a `DeliverySdkError`. With safe queries, inspect `error` on the result; with
+throwing queries, catch it.
+
+```typescript
+const { success, error } = await client.fetchContentItem({ codename: "missing" }).fetchSafe();
+
+if (!success) {
+    console.error(error.message);
+    console.error(error.details.reason); // e.g. "parsingFailed"
+}
+```
+
+## Paging
+
+```typescript
+// One page
+const { response } = await client
+    .listContentItems({ query: { limit: 10, skip: 0 } })
+    .fetchPageSafe();
+
+console.log(response?.payload.items);
+
+// All pages at once
+const { success, responses } = await client.listContentItems().fetchAllPagesSafe();
+if (success) {
+    const allItems = responses.flatMap((r) => r.payload.items);
+}
+
+// Or iterate page-by-page
+for await (const page of client.listContentItems().pages()) {
+    console.log(page.payload.items.length);
+}
+```
+
+The `itemsFeed` query pages with a continuation token instead of skip/limit — pass it via the request
+headers and read the next token from `response.meta.continuationToken`:
+
+```typescript
+const { response } = await client
+    .itemsFeed({ headers: { "X-Continuation": "<token>" } })
+    .fetchPageSafe();
+
+console.log(response?.meta.continuationToken);
+```
+
+## Strong typing
+
+Pass a `DeliveryClientSchema` to `createDeliveryClient` to narrow every codename, then describe each
+content type with `ContentItemOf` and the `Elements` namespace. (We recommend generating both with
+[`@kontent-ai/model-generator`](https://github.com/kontent-ai/model-generator-js) rather than writing them
+by hand.)
+
+```typescript
+import { createDeliveryClient, type ContentItemOf, type DeliveryClientSchema, type Elements } from "@kontent-ai/delivery-sdk";
+
+type MySchema = DeliveryClientSchema<{
+    readonly languageCodenames: readonly ["en-US"];
+    readonly collectionCodenames: readonly ["default"];
+    readonly workflowCodenames: readonly ["default"];
+    readonly workflowStepCodenames: readonly ["published"];
+    readonly taxonomies: { readonly genre: readonly ["action", "comedy"] };
+    readonly contentTypes: {
+        readonly movie: readonly ["title", "stars"];
+        readonly actor: readonly ["first_name"];
+    };
+}>;
+
+type Actor = ContentItemOf<MySchema, "actor", {
+    readonly first_name: Elements.Text;
+}>;
+
+type Movie = ContentItemOf<MySchema, "movie", {
+    readonly title: Elements.Text;
+    readonly stars: Elements.LinkedItems<Actor>;
+}>;
+
+const client = createDeliveryClient<MySchema>({ apiMode: "public", environmentId: "<id>" });
+```
+
+Codenames are now checked at compile time, and linked items are resolved onto each element's `items`
+array (e.g. `movie.elements.stars.items` is `Actor[]`).
+
+## Type guards
+
+When a query returns items of mixed types, narrow each one to its typed model with a guard on
+`system.type`:
+
+```typescript
+import type { ContentItemPayload } from "@kontent-ai/delivery-sdk";
+
+function isMovie(item: ContentItemPayload<MySchema>): item is Movie {
+    return item.system.type === "movie";
+}
+
+const { response } = await client.listContentItems().fetchPageSafe();
+
+for (const item of response?.payload.items ?? []) {
+    if (isMovie(item)) {
+        console.log(item.elements.title.value);     // typed as string
+        const stars = item.elements.stars.items;     // resolved Actor[]
+    }
+}
+```
+
+`@kontent-ai/model-generator` generates one of these guards (`isMovie`, `isActor`, …) per content type.
+
+## Runtime validation
+
+Optionally validate responses against the SDK's Zod schemas at runtime — handy for catching unexpected
+payload shapes early:
+
+```typescript
+const client = createDeliveryClient({
+    apiMode: "public",
+    environmentId: "<id>",
+    runtimeValidation: { validateResponses: true },
+});
+```
+
+The schemas are also exported on their own subpath for standalone use:
+
+```typescript
+import { listContentItemsSchema } from "@kontent-ai/delivery-sdk/schemas";
+
+const result = await listContentItemsSchema<MySchema>().safeParseAsync(storedJson);
+```
+
+## Resolved linked items & serialization
+
+By default, content-item queries (`fetchContentItem`, `listContentItems`, `itemsFeed`) return an
+**extended** response: every rich-text and linked-items (modular content) element is augmented with a
+mapped `items` property holding the fully-resolved referenced items. This lets you traverse the content
+tree directly instead of looking codenames up in `modular_content` yourself — `element.value` still holds
+the referenced codenames, while `element.items` holds the resolved items.
+
+```typescript
+const { response } = await client.listContentItems().fetchPageSafe();
+const movie = response?.payload.items[0];
+
+const starCodenames = movie?.elements.stars.value; // string[] of codenames
+const stars = movie?.elements.stars.items;          // resolved items
+```
+
+Because resolved items can reference one another — possibly in a **circular** way — the extended response
+is **not** safe to `JSON.stringify`. When you need to serialize the response (caching, SSR payloads,
+sending it over the wire), use the query's `raw()` variant. It returns the plain API payload with **no**
+resolved `items`; linked items remain referenced by codename in `modular_content`.
+
+```typescript
+// Raw payload — safe to serialize (no resolved `items`, so no circular references)
+const { response } = await client.listContentItems().raw().fetchPageSafe();
+
+const json = JSON.stringify(response?.payload); // safe
+
+// In the raw payload, resolve linked items yourself from `payload.modular_content` when needed.
+```
+
+## License
+
+MIT

package/dist/client/delivery-client.d.ts

@@ -0,0 +1,9 @@
+import type { DeliveryClient, DeliveryClientConfig, DeliveryClientSchema } from "../models/core.models.js";
+/**
+ * Creates a delivery client. When you supply a `TSchema` type argument, codenames are narrowed for type safety.
+ * Without a type argument, codenames fall back to generic strings.
+ *
+ * We highly recommend generating the schema type using the `@kontent-ai/model-generator` npm package
+ * and passing it as the type argument for full compile-time safety.
+ */
+export declare function createDeliveryClient<const TSchema extends DeliveryClientSchema = DeliveryClientSchema>(config: DeliveryClientConfig): DeliveryClient<TSchema>;

package/dist/client/delivery-client.js

@@ -0,0 +1,35 @@
+import { fetchContentItemQuery } from "../queries/content-items/fetch-content-item-query.js";
+import { itemsFeedQuery } from "../queries/content-items/items-feed-query.js";
+import { itemsReferencingAssetQuery, } from "../queries/content-items/items-referencing-asset-query.js";
+import { itemsReferencingItemQuery } from "../queries/content-items/items-referencing-item-query.js";
+import { listContentItemsQuery } from "../queries/content-items/list-content-items-query.js";
+import { fetchContentTypeElementQuery, } from "../queries/content-types/fetch-content-type-element-query.js";
+import { fetchContentTypeQuery } from "../queries/content-types/fetch-content-type-query.js";
+import { listContentTypesQuery } from "../queries/content-types/list-content-types-query.js";
+import { listLanguagesQuery } from "../queries/languages/list-languages-query.js";
+import { fetchTaxonomyQuery } from "../queries/taxonomies/fetch-taxonomy-query.js";
+import { listTaxonomiesQuery } from "../queries/taxonomies/list-taxonomies-query.js";
+/**
+ * Creates a delivery client. When you supply a `TSchema` type argument, codenames are narrowed for type safety.
+ * Without a type argument, codenames fall back to generic strings.
+ *
+ * We highly recommend generating the schema type using the `@kontent-ai/model-generator` npm package
+ * and passing it as the type argument for full compile-time safety.
+ */
+export function createDeliveryClient(config) {
+    return {
+        config,
+        listTaxonomies: (request) => listTaxonomiesQuery(config, request),
+        listLanguages: (request) => listLanguagesQuery(config, request),
+        listContentTypes: (request) => listContentTypesQuery(config, request),
+        fetchTaxonomy: (request) => fetchTaxonomyQuery(config, request),
+        fetchContentType: (request) => fetchContentTypeQuery(config, request),
+        fetchContentTypeElement: (request) => fetchContentTypeElementQuery(config, request),
+        fetchContentItem: (request) => fetchContentItemQuery(config, request),
+        listContentItems: (request) => listContentItemsQuery(config, request),
+        itemsFeed: (request) => itemsFeedQuery(config, request),
+        itemsReferencingAsset: (request) => itemsReferencingAssetQuery(config, request),
+        itemsReferencingItem: (request) => itemsReferencingItemQuery(config, request),
+    };
+}
+//# sourceMappingURL=delivery-client.js.map

package/dist/client/delivery-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delivery-client.js","sourceRoot":"","sources":["../../lib/client/delivery-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAqC,qBAAqB,EAAE,MAAM,sDAAsD,CAAC;AAChI,OAAO,EAA8B,cAAc,EAAE,MAAM,8CAA8C,CAAC;AAC1G,OAAO,EAEN,0BAA0B,GAC1B,MAAM,2DAA2D,CAAC;AACnE,OAAO,EAAyC,yBAAyB,EAAE,MAAM,0DAA0D,CAAC;AAC5I,OAAO,EAAqC,qBAAqB,EAAE,MAAM,sDAAsD,CAAC;AAChI,OAAO,EAEN,4BAA4B,GAC5B,MAAM,8DAA8D,CAAC;AACtE,OAAO,EAAqC,qBAAqB,EAAE,MAAM,sDAAsD,CAAC;AAChI,OAAO,EAAqC,qBAAqB,EAAE,MAAM,sDAAsD,CAAC;AAEhI,OAAO,EAAkC,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClH,OAAO,EAAkC,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AACnH,OAAO,EAAmC,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AAGtH;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CACnC,MAA4B;IAE5B,OAAO;QACN,MAAM;QACN,cAAc,EAAE,CAAC,OAAoC,EAAE,EAAE,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;QAC9F,aAAa,EAAE,CAAC,OAAmC,EAAE,EAAE,CAAC,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC;QAC3F,gBAAgB,EAAE,CAAC,OAA+C,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC;QAC7G,aAAa,EAAE,CAAsD,OAAsD,EAAE,EAAE,CAC9H,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC;QACpC,gBAAgB,EAAE,CACjB,OAAyD,EACxD,EAAE,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC;QAC3C,uBAAuB,EAAE,CACxB,OAAgE,EAC/D,EAAE,CAAC,4BAA4B,CAAC,MAAM,EAAE,OAAO,CAAC;QAClD,gBAAgB,EAAE,CAAC,OAA8C,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC;QAC5G,gBAAgB,EAAE,CAAC,OAA+C,EAAE,EAAE,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC;QAC7G,SAAS,EAAE,CAAC,OAAwC,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC;QACxF,qBAAqB,EAAE,CAAC,OAAmD,EAAE,EAAE,CAAC,0BAA0B,CAAC,MAAM,EAAE,OAAO,CAAC;QAC3H,oBAAoB,EAAE,CAAC,OAAkD,EAAE,EAAE,CAAC,yBAAyB,CAAC,MAAM,EAAE,OAAO,CAAC;KACxH,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,2 @@
+import type { SdkInfo } from "@kontent-ai/core-sdk";
+export declare const deliverySdkInfo: SdkInfo;

package/dist/delivery-sdk-info.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"delivery-sdk-info.js","sourceRoot":"","sources":["../lib/delivery-sdk-info.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,eAAe,GAAY;IACvC,OAAO,EAAE,aAAa;IACtB,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,WAAW;CACjB,CAAC"}

package/dist/models/core.models.d.ts

@@ -0,0 +1,93 @@
+import type { FetchQuery, JsonValue, PagedFetchQuery, PickStringLiteral, SdkConfig } from "@kontent-ai/core-sdk";
+import type { FetchContentItemQuery, FetchContentItemQueryRequest } from "../queries/content-items/fetch-content-item-query.js";
+import type { ItemsFeedQuery, ItemsFeedQueryRequest } from "../queries/content-items/items-feed-query.js";
+import type { ItemsReferencingAssetQuery, ItemsReferencingAssetQueryRequest } from "../queries/content-items/items-referencing-asset-query.js";
+import type { ItemsReferencingItemQuery, ItemsReferencingItemQueryRequest } from "../queries/content-items/items-referencing-item-query.js";
+import type { ListContentItemsQuery, ListContentItemsQueryRequest } from "../queries/content-items/list-content-items-query.js";
+import type { FetchContentTypeElementQuery, FetchContentTypeElementQueryRequest } from "../queries/content-types/fetch-content-type-element-query.js";
+import type { FetchContentTypeQuery, FetchContentTypeQueryRequest } from "../queries/content-types/fetch-content-type-query.js";
+import type { ListContentTypesQuery, ListContentTypesQueryRequest } from "../queries/content-types/list-content-types-query.js";
+import type { ContentTypeCodenameOf } from "../queries/content-types/models/content-type.models.js";
+import type { ListLanguagesQuery, ListLanguagesQueryRequest } from "../queries/languages/list-languages-query.js";
+import type { FetchTaxonomyQuery, FetchTaxonomyQueryRequest } from "../queries/taxonomies/fetch-taxonomy-query.js";
+import type { ListTaxonomiesQuery, ListTaxonomiesQueryRequest } from "../queries/taxonomies/list-taxonomies-query.js";
+import type { TaxonomyCodenameOf } from "../queries/taxonomies/models/taxonomy.models.js";
+import type { DeliverySdkError } from "./error.models.js";
+export type DeliveryClientSchema<TSchema extends DeliveryClientSchema = {
+    readonly languageCodenames: readonly string[];
+    readonly taxonomies: {
+        readonly [taxonomyCodename: string]: readonly string[];
+    };
+    readonly contentTypes: {
+        readonly [contentTypeCodename: string]: readonly string[];
+    };
+    readonly collectionCodenames: readonly string[];
+    readonly workflowCodenames: readonly string[];
+    readonly workflowStepCodenames: readonly string[];
+}> = TSchema;
+/**
+ * Placeholder type if extension is needed in future
+ */
+export type DeliveryMetadata = Record<string, never>;
+export type DeliveryMetadataWithToken = {
+    readonly continuationToken: string | undefined;
+};
+export type TokenPagingDeliveryExtraResponseProps = {
+    readonly nextContinuationToken: string | undefined;
+};
+export type UrlPagingDeliveryExtraResponseProps = {
+    readonly nextPageUrl: string | undefined;
+};
+export type ApiMode = "public" | "preview" | "secure";
+export type DeliveryClientConfig = SdkConfig<DeliveryApiConfig & {
+    /**
+     * The environment ID of your Kontent.ai project. Can be found in the Kontent.ai app.
+     */
+    readonly environmentId: string;
+}>;
+export type DeliveryApiConfig = PublicDeliveryClientConfig | PreviewDeliveryClientConfig | SecureDeliveryClientConfig;
+export type DeliveryClient<TSchema extends DeliveryClientSchema = DeliveryClientSchema> = {
+    readonly config: DeliveryClientConfig;
+    listLanguages(request?: ListLanguagesQueryRequest): ListLanguagesQuery<TSchema>;
+    listTaxonomies(request?: ListTaxonomiesQueryRequest): ListTaxonomiesQuery<TSchema>;
+    listContentTypes(request?: ListContentTypesQueryRequest<TSchema>): ListContentTypesQuery<TSchema>;
+    fetchTaxonomy<const TCodename extends TaxonomyCodenameOf<TSchema>>(request: FetchTaxonomyQueryRequest<TSchema, TCodename>): FetchTaxonomyQuery<TSchema, TCodename>;
+    fetchContentType<const TCodename extends ContentTypeCodenameOf<TSchema>>(request: FetchContentTypeQueryRequest<TSchema, TCodename>): FetchContentTypeQuery<TSchema>;
+    fetchContentTypeElement<const TCodename extends ContentTypeCodenameOf<TSchema>>(request: FetchContentTypeElementQueryRequest<TSchema, TCodename>): FetchContentTypeElementQuery;
+    fetchContentItem(request: FetchContentItemQueryRequest<TSchema>): FetchContentItemQuery<TSchema>;
+    listContentItems(request?: ListContentItemsQueryRequest<TSchema>): ListContentItemsQuery<TSchema>;
+    itemsFeed(request?: ItemsFeedQueryRequest<TSchema>): ItemsFeedQuery<TSchema>;
+    itemsReferencingAsset(request: ItemsReferencingAssetQueryRequest<TSchema>): ItemsReferencingAssetQuery<TSchema>;
+    itemsReferencingItem(request: ItemsReferencingItemQueryRequest<TSchema>): ItemsReferencingItemQuery<TSchema>;
+};
+export type DeliveryFetchQuery<TPayload extends JsonValue, TMeta extends DeliveryMetadata | DeliveryMetadataWithToken> = FetchQuery<TPayload, DeliverySdkError, TMeta>;
+export type DeliveryPagedFetchQuery<TPayload extends JsonValue, TMeta extends DeliveryMetadata | DeliveryMetadataWithToken> = PagedFetchQuery<TPayload, DeliverySdkError, TMeta>;
+export type DeliveryEndpoint = "languages" | "items" | `items/${string}` | "items-feed" | `assets/${string}/used-in` | `items/${string}/used-in` | "taxonomies" | `taxonomies/${string}` | "types" | `types/${string}` | `types/${string}/elements/${string}`;
+export type WaitForLoadingNewContentHeaderName = "X-KC-Wait-For-Loading-New-Content";
+type PublicDeliveryClientConfig = {
+    /**
+     * The API mode of the delivery client. Public access is the default mode.
+     */
+    readonly apiMode: PickStringLiteral<ApiMode, "public">;
+};
+type PreviewDeliveryClientConfig = {
+    /**
+     * The API mode of the delivery client.
+     */
+    readonly apiMode: PickStringLiteral<ApiMode, "preview">;
+    /**
+     * The delivery API key of your Kontent.ai project with preview access enabled.
+     */
+    readonly deliveryApiKey: string;
+};
+type SecureDeliveryClientConfig = {
+    /**
+     * The API mode of the delivery client.
+     */
+    readonly apiMode: PickStringLiteral<ApiMode, "secure">;
+    /**
+     * The delivery API key of your Kontent.ai project with secure access enabled.
+     */
+    readonly deliveryApiKey: string;
+};
+export {};

package/dist/models/core.models.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=core.models.js.map

package/dist/models/core.models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.models.js","sourceRoot":"","sources":["../../lib/models/core.models.ts"],"names":[],"mappings":""}

package/dist/models/error.models.d.ts

@@ -0,0 +1,4 @@
+import { KontentSdkError } from "@kontent-ai/core-sdk";
+export declare class DeliverySdkError extends KontentSdkError {
+    constructor(error: KontentSdkError);
+}

package/dist/models/error.models.js

@@ -0,0 +1,15 @@
+import { KontentSdkError } from "@kontent-ai/core-sdk";
+export class DeliverySdkError extends KontentSdkError {
+    constructor(error) {
+        super({
+            baseErrorData: {
+                message: error.message,
+                url: error.url,
+                retryStrategyOptions: error.retryStrategyOptions,
+                retryAttempt: error.retryAttempt,
+            },
+            details: error.details,
+        });
+    }
+}
+//# sourceMappingURL=error.models.js.map

package/dist/models/error.models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.models.js","sourceRoot":"","sources":["../../lib/models/error.models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,OAAO,gBAAiB,SAAQ,eAAe;IACpD,YAAY,KAAsB;QACjC,KAAK,CAAC;YACL,aAAa,EAAE;gBACd,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,oBAAoB,EAAE,KAAK,CAAC,oBAAoB;gBAChD,YAAY,EAAE,KAAK,CAAC,YAAY;aAChC;YACD,OAAO,EAAE,KAAK,CAAC,OAAO;SACtB,CAAC,CAAC;IACJ,CAAC;CACD"}

package/dist/models/filter.models.d.ts

@@ -0,0 +1,19 @@
+export declare const emptyRichTextOperators: readonly ["isEmptyRichText", "isNotEmptyRichText"];
+export declare const emptyRichTextToFilterOperator: Readonly<Record<EmptyRichTextOperator, FilterOperator>>;
+export type ObjectFilter<TSystemProperties extends string, TElementProperties extends string> = {
+    readonly property: FilterProperty<TSystemProperties, TElementProperties>;
+    readonly value: string | number | boolean | undefined | string[];
+    readonly operator: SpecialFilterOperator | FilterOperator;
+};
+export type EmptyRichTextFilter<TElementProperties extends string> = {
+    readonly property: `elements.${TElementProperties}`;
+    readonly operator: EmptyRichTextOperator;
+    readonly value?: never;
+};
+export type Filter<TSystemProperties extends string, TElementProperties extends string> = ObjectFilter<TSystemProperties, TElementProperties> | EmptyRichTextFilter<TElementProperties> | SystemOrElementsFilterQuery<TSystemProperties, TElementProperties>;
+type SpecialFilterOperator = "=" | "!=";
+type EmptyRichTextOperator = (typeof emptyRichTextOperators)[number];
+type FilterOperator = "eq" | "neq" | "empty" | "nempty" | "lt" | "lte" | "gt" | "gte" | "range" | "in" | "nin" | "contains" | "any" | "all";
+type SystemOrElementsFilterQuery<TSystemProperties extends string, TElementProperties extends string> = `system.${TSystemProperties}[${FilterOperator}]=${string}` | `elements.${TElementProperties}[${FilterOperator}]=${string}`;
+type FilterProperty<TSystemProperties extends string, TElementProperties extends string> = `system.${TSystemProperties}` | `elements.${TElementProperties}`;
+export {};

package/dist/models/filter.models.js

@@ -0,0 +1,6 @@
+export const emptyRichTextOperators = ["isEmptyRichText", "isNotEmptyRichText"];
+export const emptyRichTextToFilterOperator = {
+    isEmptyRichText: "eq",
+    isNotEmptyRichText: "neq",
+};
+//# sourceMappingURL=filter.models.js.map

package/dist/models/filter.models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.models.js","sourceRoot":"","sources":["../../lib/models/filter.models.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,iBAAiB,EAAE,oBAAoB,CAAU,CAAC;AACzF,MAAM,CAAC,MAAM,6BAA6B,GAA4D;IACrG,eAAe,EAAE,IAAI;IACrB,kBAAkB,EAAE,KAAK;CACzB,CAAC"}

package/dist/models/pagination.models.d.ts

@@ -0,0 +1,4 @@
+import type * as z from "zod/mini";
+import type { paginationSchema, paginationWithTotalCountSchema } from "./pagination.schemas.js";
+export type PaginationPayload = Readonly<z.infer<typeof paginationSchema>>;
+export type PaginationWithTotalCountPayload = Readonly<z.infer<typeof paginationWithTotalCountSchema>>;

package/dist/models/pagination.models.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pagination.models.js.map

package/dist/models/pagination.models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.models.js","sourceRoot":"","sources":["../../lib/models/pagination.models.ts"],"names":[],"mappings":""}

package/dist/models/pagination.schemas.d.ts

@@ -0,0 +1,18 @@
+import * as z from "zod/mini";
+export declare const paginationSchema: z.ZodMiniObject<{
+    pagination: z.ZodMiniReadonly<z.ZodMiniObject<{
+        skip: z.ZodMiniNumber<number>;
+        limit: z.ZodMiniNumber<number>;
+        count: z.ZodMiniNumber<number>;
+        next_page: z.ZodMiniUnion<readonly [z.ZodMiniURL, z.ZodMiniLiteral<"">]>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const paginationWithTotalCountSchema: z.ZodMiniObject<{
+    pagination: z.ZodMiniReadonly<z.ZodMiniObject<{
+        skip: z.ZodMiniNumber<number>;
+        limit: z.ZodMiniNumber<number>;
+        count: z.ZodMiniNumber<number>;
+        next_page: z.ZodMiniUnion<readonly [z.ZodMiniURL, z.ZodMiniLiteral<"">]>;
+        total_count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;

package/dist/models/pagination.schemas.js

@@ -0,0 +1,18 @@
+import * as z from "zod/mini";
+const nextPageSchema = z.union([z.url(), z.literal("")]);
+const paginationObjectSchema = z.object({
+    skip: z.number(),
+    limit: z.number(),
+    count: z.number(),
+    next_page: nextPageSchema,
+});
+export const paginationSchema = z.object({
+    pagination: z.readonly(paginationObjectSchema),
+});
+export const paginationWithTotalCountSchema = z.object({
+    pagination: z.readonly(z.object({
+        ...paginationObjectSchema.shape,
+        total_count: z.optional(z.number()),
+    })),
+});
+//# sourceMappingURL=pagination.schemas.js.map

package/dist/models/pagination.schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.schemas.js","sourceRoot":"","sources":["../../lib/models/pagination.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAE9B,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEzD,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,SAAS,EAAE,cAAc;CACzB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC;CAC9C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACtD,UAAU,EAAE,CAAC,CAAC,QAAQ,CACrB,CAAC,CAAC,MAAM,CAAC;QACR,GAAG,sBAAsB,CAAC,KAAK;QAC/B,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KACnC,CAAC,CACF;CACD,CAAC,CAAC"}