@contentful/optimization-api-schemas 0.1.0-alpha

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2026 Contentful Inc.
+
+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,127 @@
+<p align="center">
+  <a href="https://www.contentful.com/developers/docs/personalization/">
+    <img alt="Contentful Logo" title="Contentful" src="../../contentful-icon.png" width="150">
+  </a>
+</p>
+
+<h1 align="center">Contentful Personalization & Analytics</h1>
+
+<h3 align="center">API Schema Library</h3>
+
+<div align="center">
+
+[Readme](./README.md) · [Reference](https://contentful.github.io/optimization) ·
+[Contributing](/CONTRIBUTING.md)
+
+</div>
+
+> [!WARNING]
+>
+> The Optimization SDK Suite is currently ALPHA! Breaking changes may be published at any time.
+
+The Contentful Optimization API Schema Library is a collection of Zod Mini schemas and their
+inferred TypeScript types. These schemas help provide run-time validation when working with requests
+and responses for the APIs referenced within Optimization SDKs.
+
+<details>
+  <summary>Table of Contents</summary>
+<!-- mtoc-start -->
+
+- [Getting Started](#getting-started)
+- [Contentful CDA Schemas](#contentful-cda-schemas)
+  - [Essential Schemas](#essential-schemas)
+  - [Essential Functions](#essential-functions)
+- [Experience API Schemas](#experience-api-schemas)
+  - [Essential Experience API Request Schemas](#essential-experience-api-request-schemas)
+  - [Essential Experience API Response Schemas](#essential-experience-api-response-schemas)
+- [Insights API Schemas](#insights-api-schemas)
+  - [Essential Insights API Response Schemas](#essential-insights-api-response-schemas)
+
+<!-- mtoc-end -->
+</details>
+
+## Getting Started
+
+Install using an NPM-compatible package manager, pnpm for example:
+
+```sh
+pnpm install @contentful/optimization-api-schemas
+```
+
+Consult [Zod's documentation](https://zod.dev/basics) for more information on working with
+[Zod Mini](https://zod.dev/packages/mini) schemas.
+
+## Contentful CDA Schemas
+
+These schemas assist in determining whether Contentful content entries provided by the CDA and its
+SDK are valid for personalization. These schemas do not encapsulate all features and functionality
+specified in the CDA SDK's exported TypeScript type system, but strive to remain compatible enough
+for the purposes of personalization.
+
+### Essential Schemas
+
+- `CtflEntry`: Zod schema describing a generic Contentful entry; the `fields` member is loosely
+  typed as any valid JSON
+- `PersonalizedEntry`: Zod schema describing a `CtflEntry` that has associated personalization
+  entries
+- `PersonalizationEntry`: Zod schema describing a personalization entry, which is associated with a
+  `PersonalizedEntry` via its `fields.nt_experiences` property
+- `PersonalizationConfig`: Zod schema describing the configuration of a `PersonalizationEntry` via
+  its `fields.nt_config` property
+
+### Essential Functions
+
+- `isEntry<S extends SkeletonType, M extends ChainModifiers, L extends string>`: Type guard that
+  checks whether the given value is a Contentful Entry, passing through the specified skeleton,
+  chain modifiers, and locale
+- `isPersonalizedEntry`: Type guard for `PersonalizedEntry`
+- `isPersonalizationEntry`: Type guard for `PersonalizationEntry`
+
+## Experience API Schemas
+
+These schemas help validate at run-time that both the request and response data for Experience API
+requests conform to current API specifications.
+
+### Essential Experience API Request Schemas
+
+- `ExperienceRequestData`: Zod schema describing the data payload for an experience request
+- `ExperienceEvent`: Zod schema union of supported experience/personalization events
+- `BatchExperienceEvent`: Zod schema describing each valid experience/personalization event within a
+  batch; Similar to `ExperienceEvent`, but with an additional `anonymousId` member on each event
+  schema
+
+Experience/personalization event schemas:
+
+- `AliasEvent`: Zod schema describing an `alias` event
+- `ComponentViewEvent`: Zod schema describing a `component` view event (may be a Contentful entry or
+  a Custom Flag)
+- `IdentifyEvent`: Zod schema describing an `identify` event
+- `PageViewEvent`: Zod schema describing a `page` view event
+- `ScreenViewEvent`: Zod schema describing a `screen` view event
+- `TrackEvent`: Zod schema describing a custom `track` event
+
+### Essential Experience API Response Schemas
+
+- `ExperienceResponse`: Zod schema describing a full Experience API response; includes a `data`
+  object with `changes`, `experiences`, and `profile` properties
+- `BatchExperienceResponse`: Zod schema describing a batch experience response from the Experience
+  API; includes a `profiles` collection
+- `Change`: Union of supported change types, which currently only includes `VariableChange`; this
+  change type is used for Custom Flags
+- `SelectedPersonalization`: Zod schema describing a selected personalization outcome for a user
+- `Profile`: Zod schema describing a full user profile as received from the Experience API
+
+## Insights API Schemas
+
+Insights API endpoints currently do not return response data.
+
+### Essential Insights API Response Schemas
+
+- `InsightsEvent`: Zod schema union of supported insights/analytics events
+- `BatchInsightsEvent`: Zod schema describing a batched Insights event payload; expects a `profile`
+  property alongside a collection of `events`
+
+Insights/analytics event schemas:
+
+- `ComponentViewEvent`: Zod schema describing a `component` view event (may be a Contentful entry or
+  a Custom Flag)

package/dist/contentful/AudienceEntry.d.ts

@@ -0,0 +1,73 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing the fields of an Audience entry.
+ *
+ * @remarks
+ * Extends the base {@link EntryFields} with audience-specific properties.
+ */
+export declare const AudienceEntryFields: z.ZodMiniObject<{
+    nt_audience_id: z.ZodMiniString<string>;
+    nt_name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    nt_description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$catchall<z.ZodMiniJSONSchema>>;
+/**
+ * TypeScript type inferred from {@link AudienceEntryFields}.
+ */
+export type AudienceEntryFields = z.infer<typeof AudienceEntryFields>;
+/**
+ * Zod schema for a Contentful Audience entry, including system metadata.
+ *
+ * @remarks
+ * Extends the generic {@link CtflEntry} with {@link AudienceEntryFields} as the `fields` payload.
+ */
+export declare const AudienceEntry: z.ZodMiniObject<{
+    metadata: z.ZodMiniObject<{
+        tags: z.ZodMiniArray<z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Tag">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Entry">;
+        contentType: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"ContentType">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        publishedVersion: z.ZodMiniNumber<number>;
+        id: z.ZodMiniString<string>;
+        createdAt: z.ZodMiniAny;
+        updatedAt: z.ZodMiniAny;
+        locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        revision: z.ZodMiniNumber<number>;
+        space: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Space">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        environment: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Environment">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    fields: z.ZodMiniObject<{
+        nt_audience_id: z.ZodMiniString<string>;
+        nt_name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        nt_description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link AudienceEntry}.
+ */
+export type AudienceEntry = z.infer<typeof AudienceEntry>;
+//# sourceMappingURL=AudienceEntry.d.ts.map

package/dist/contentful/AudienceEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AudienceEntry.d.ts","sourceRoot":"","sources":["../../src/contentful/AudienceEntry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAG7B;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;;;yCAwB9B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAExB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}

package/dist/contentful/AudienceEntry.js

@@ -0,0 +1,41 @@
+import * as z from 'zod/mini';
+import { CtflEntry, EntryFields } from './CtflEntry';
+/**
+ * Zod schema describing the fields of an Audience entry.
+ *
+ * @remarks
+ * Extends the base {@link EntryFields} with audience-specific properties.
+ */
+export const AudienceEntryFields = z.extend(EntryFields, {
+    /**
+     * The internal id of the audience (Short Text).
+     *
+     * @remarks
+     * This usually corresponds to a stable identifier used by the personalization system.
+     */
+    nt_audience_id: z.string(),
+    /**
+     * The name of the audience (Short Text).
+     *
+     * @remarks
+     * Optional field used for display purposes in tools and UI.
+     */
+    nt_name: z.optional(z.string()),
+    /**
+     * The description of the audience (Short Text).
+     *
+     * @remarks
+     * Optional field intended for internal documentation and operator context.
+     */
+    nt_description: z.optional(z.string()),
+});
+/**
+ * Zod schema for a Contentful Audience entry, including system metadata.
+ *
+ * @remarks
+ * Extends the generic {@link CtflEntry} with {@link AudienceEntryFields} as the `fields` payload.
+ */
+export const AudienceEntry = z.extend(CtflEntry, {
+    fields: AudienceEntryFields,
+});
+//# sourceMappingURL=AudienceEntry.js.map

package/dist/contentful/AudienceEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AudienceEntry.js","sourceRoot":"","sources":["../../src/contentful/AudienceEntry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAEpD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE;IACvD;;;;;OAKG;IACH,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAE1B;;;;;OAKG;IACH,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAE/B;;;;;OAKG;IACH,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CACvC,CAAC,CAAA;AAOF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE;IAC/C,MAAM,EAAE,mBAAmB;CAC5B,CAAC,CAAA"}

package/dist/contentful/CtflEntry.d.ts

@@ -0,0 +1,206 @@
+import type { ChainModifiers, Entry, EntrySkeletonType, LocaleCode } from 'contentful';
+import * as z from 'zod/mini';
+/**
+ * Base Zod schema for entry fields.
+ *
+ * @remarks
+ * This is modeled as a catch-all map from string keys to JSON-compatible values.
+ * The strong typing ot consumer-specified Contentful Entry fields is not
+ * validated by these schemas.
+ */
+export declare const EntryFields: z.ZodMiniObject<{}, z.core.$catchall<z.ZodMiniJSONSchema>>;
+/**
+ * TypeScript type inferred from {@link EntryFields}.
+ */
+export type EntryFields = z.infer<typeof EntryFields>;
+/**
+ * Zod schema representing a generic Contentful Link object.
+ *
+ * @remarks
+ * This is used for references to other Contentful resources where `linkType` is not constrained.
+ */
+export declare const Link: z.ZodMiniObject<{
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Link">;
+        linkType: z.ZodMiniString<string>;
+        id: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link Link}.
+ */
+export type Link = z.infer<typeof Link>;
+/**
+ * Zod schema representing a Contentful ContentType link.
+ */
+export declare const ContentTypeLink: z.ZodMiniObject<{
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Link">;
+        linkType: z.ZodMiniLiteral<"ContentType">;
+        id: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link ContentTypeLink}.
+ */
+export type ContentTypeLink = z.infer<typeof ContentTypeLink>;
+/**
+ * Zod schema representing a Contentful Environment link.
+ */
+export declare const EnvironmentLink: z.ZodMiniObject<{
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Link">;
+        linkType: z.ZodMiniLiteral<"Environment">;
+        id: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link EnvironmentLink}.
+ */
+export type EnvironmentLink = z.infer<typeof EnvironmentLink>;
+/**
+ * Zod schema representing a Contentful Space link.
+ */
+export declare const SpaceLink: z.ZodMiniObject<{
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Link">;
+        linkType: z.ZodMiniLiteral<"Space">;
+        id: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link SpaceLink}.
+ */
+export type SpaceLink = z.infer<typeof SpaceLink>;
+/**
+ * Zod schema representing a Contentful Tag link.
+ */
+export declare const TagLink: z.ZodMiniObject<{
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Link">;
+        linkType: z.ZodMiniLiteral<"Tag">;
+        id: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link TagLink}.
+ */
+export type TagLink = z.infer<typeof TagLink>;
+/**
+ * Zod schema describing the `sys` block for a Contentful entry.
+ *
+ * @remarks
+ * This mirrors the structure of `Entry['sys']` from the Contentful SDK with
+ * a subset of fields used by this library.
+ */
+export declare const EntrySys: z.ZodMiniObject<{
+    type: z.ZodMiniLiteral<"Entry">;
+    contentType: z.ZodMiniObject<{
+        sys: z.ZodMiniObject<{
+            type: z.ZodMiniLiteral<"Link">;
+            linkType: z.ZodMiniLiteral<"ContentType">;
+            id: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    publishedVersion: z.ZodMiniNumber<number>;
+    id: z.ZodMiniString<string>;
+    createdAt: z.ZodMiniAny;
+    updatedAt: z.ZodMiniAny;
+    locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    revision: z.ZodMiniNumber<number>;
+    space: z.ZodMiniObject<{
+        sys: z.ZodMiniObject<{
+            type: z.ZodMiniLiteral<"Link">;
+            linkType: z.ZodMiniLiteral<"Space">;
+            id: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    environment: z.ZodMiniObject<{
+        sys: z.ZodMiniObject<{
+            type: z.ZodMiniLiteral<"Link">;
+            linkType: z.ZodMiniLiteral<"Environment">;
+            id: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link EntrySys}.
+ */
+export type EntrySys = z.infer<typeof EntrySys>;
+/**
+ * Zod schema describing a generic Contentful entry.
+ *
+ * @remarks
+ * This model is intentionally loose: `fields` is any JSON-compliant object and
+ * `metadata` is modeled as a catch-all object that must contain an array of
+ * {@link TagLink} tags.
+ */
+export declare const CtflEntry: z.ZodMiniObject<{
+    /**
+     * The entry fields payload.
+     */
+    fields: z.ZodMiniObject<{}, z.core.$catchall<z.ZodMiniJSONSchema>>;
+    /**
+     * Contentful metadata, including tags.
+     */
+    metadata: z.ZodMiniObject<{
+        tags: z.ZodMiniArray<z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Tag">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+    /**
+     * System-managed properties describing the entry.
+     */
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Entry">;
+        contentType: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"ContentType">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        publishedVersion: z.ZodMiniNumber<number>;
+        id: z.ZodMiniString<string>;
+        createdAt: z.ZodMiniAny;
+        updatedAt: z.ZodMiniAny;
+        locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        revision: z.ZodMiniNumber<number>;
+        space: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Space">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        environment: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Environment">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link CtflEntry}.
+ */
+export type CtflEntry = z.infer<typeof CtflEntry>;
+/**
+ * Type guard that checks whether the given value is a Contentful {@link Entry},
+ * passing through the specified skeleton, chain modifiers, and locale.
+ *
+ * @typeParam S - The entry skeleton type.
+ * @typeParam M - The chain modifiers type. Defaults to {@link ChainModifiers}.
+ * @typeParam L - The locale code type. Defaults to {@link LocaleCode}.
+ *
+ * @param entry - The value to test.
+ * @returns `true` if the object conforms to {@link CtflEntry} and can be treated
+ * as a typed {@link Entry}, otherwise `false`.
+ */
+export declare function isEntry<S extends EntrySkeletonType, M extends ChainModifiers = ChainModifiers, L extends LocaleCode = LocaleCode>(entry: Entry | undefined): entry is Entry<S, M, L>;
+//# sourceMappingURL=CtflEntry.d.ts.map

package/dist/contentful/CtflEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CtflEntry.d.ts","sourceRoot":"","sources":["../../src/contentful/CtflEntry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACtF,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,4DAAqC,CAAA;AAE7D;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAA;AAErD;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;iBAMf,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAA;AAEvC;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;iBAM1B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;iBAM1B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;iBAMpB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,OAAO;;;;;;iBAMlB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAA;AAE7C;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAWnB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAA;AAE/C;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS;IACpB;;OAEG;;IAGH;;OAEG;;;;;;;;;;IAQH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAEjD;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CACrB,CAAC,SAAS,iBAAiB,EAC3B,CAAC,SAAS,cAAc,GAAG,cAAc,EACzC,CAAC,SAAS,UAAU,GAAG,UAAU,EACjC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAEnD"}

package/dist/contentful/CtflEntry.js

@@ -0,0 +1,122 @@
+import * as z from 'zod/mini';
+/**
+ * Base Zod schema for entry fields.
+ *
+ * @remarks
+ * This is modeled as a catch-all map from string keys to JSON-compatible values.
+ * The strong typing ot consumer-specified Contentful Entry fields is not
+ * validated by these schemas.
+ */
+export const EntryFields = z.catchall(z.object({}), z.json());
+/**
+ * Zod schema representing a generic Contentful Link object.
+ *
+ * @remarks
+ * This is used for references to other Contentful resources where `linkType` is not constrained.
+ */
+export const Link = z.object({
+    sys: z.object({
+        type: z.literal('Link'),
+        linkType: z.string(),
+        id: z.string(),
+    }),
+});
+/**
+ * Zod schema representing a Contentful ContentType link.
+ */
+export const ContentTypeLink = z.object({
+    sys: z.object({
+        type: z.literal('Link'),
+        linkType: z.literal('ContentType'),
+        id: z.string(),
+    }),
+});
+/**
+ * Zod schema representing a Contentful Environment link.
+ */
+export const EnvironmentLink = z.object({
+    sys: z.object({
+        type: z.literal('Link'),
+        linkType: z.literal('Environment'),
+        id: z.string(),
+    }),
+});
+/**
+ * Zod schema representing a Contentful Space link.
+ */
+export const SpaceLink = z.object({
+    sys: z.object({
+        type: z.literal('Link'),
+        linkType: z.literal('Space'),
+        id: z.string(),
+    }),
+});
+/**
+ * Zod schema representing a Contentful Tag link.
+ */
+export const TagLink = z.object({
+    sys: z.object({
+        type: z.literal('Link'),
+        linkType: z.literal('Tag'),
+        id: z.string(),
+    }),
+});
+/**
+ * Zod schema describing the `sys` block for a Contentful entry.
+ *
+ * @remarks
+ * This mirrors the structure of `Entry['sys']` from the Contentful SDK with
+ * a subset of fields used by this library.
+ */
+export const EntrySys = z.object({
+    type: z.literal('Entry'),
+    contentType: ContentTypeLink,
+    publishedVersion: z.number(),
+    id: z.string(),
+    createdAt: z.any(),
+    updatedAt: z.any(),
+    locale: z.optional(z.string()),
+    revision: z.number(),
+    space: SpaceLink,
+    environment: EnvironmentLink,
+});
+/**
+ * Zod schema describing a generic Contentful entry.
+ *
+ * @remarks
+ * This model is intentionally loose: `fields` is any JSON-compliant object and
+ * `metadata` is modeled as a catch-all object that must contain an array of
+ * {@link TagLink} tags.
+ */
+export const CtflEntry = z.object({
+    /**
+     * The entry fields payload.
+     */
+    fields: EntryFields,
+    /**
+     * Contentful metadata, including tags.
+     */
+    metadata: z.catchall(z.object({
+        tags: z.array(TagLink),
+    }), z.json()),
+    /**
+     * System-managed properties describing the entry.
+     */
+    sys: EntrySys,
+});
+/**
+ * Type guard that checks whether the given value is a Contentful {@link Entry},
+ * passing through the specified skeleton, chain modifiers, and locale.
+ *
+ * @typeParam S - The entry skeleton type.
+ * @typeParam M - The chain modifiers type. Defaults to {@link ChainModifiers}.
+ * @typeParam L - The locale code type. Defaults to {@link LocaleCode}.
+ *
+ * @param entry - The value to test.
+ * @returns `true` if the object conforms to {@link CtflEntry} and can be treated
+ * as a typed {@link Entry}, otherwise `false`.
+ */
+export function isEntry(entry) {
+    return CtflEntry.safeParse(entry).success;
+}
+//# sourceMappingURL=CtflEntry.js.map

package/dist/contentful/CtflEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CtflEntry.js","sourceRoot":"","sources":["../../src/contentful/CtflEntry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;AAO7D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3B,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACvB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;KACf,CAAC;CACH,CAAC,CAAA;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACvB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;QAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;KACf,CAAC;CACH,CAAC,CAAA;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACvB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;QAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;KACf,CAAC;CACH,CAAC,CAAA;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACvB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAC5B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;KACf,CAAC;CACH,CAAC,CAAA;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACvB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QAC1B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;KACf,CAAC;CACH,CAAC,CAAA;AAOF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACxB,WAAW,EAAE,eAAe;IAC5B,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE;IAClB,SAAS,EAAE,CAAC,CAAC,GAAG,EAAE;IAClB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,KAAK,EAAE,SAAS;IAChB,WAAW,EAAE,eAAe;CAC7B,CAAC,CAAA;AAOF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC;;OAEG;IACH,MAAM,EAAE,WAAW;IAEnB;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAClB,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;KACvB,CAAC,EACF,CAAC,CAAC,IAAI,EAAE,CACT;IAED;;OAEG;IACH,GAAG,EAAE,QAAQ;CACd,CAAC,CAAA;AAOF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,OAAO,CAIrB,KAAwB;IACxB,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAA;AAC3C,CAAC"}

package/dist/contentful/MergeTagEntry.d.ts

@@ -0,0 +1,68 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema for a Merge Tag Contentful entry.
+ *
+ * @remarks
+ * Extends {@link CtflEntry} with merge-tag-specific fields and constrains the
+ * `contentType` to the `nt_mergetag` content type.
+ */
+export declare const MergeTagEntry: z.ZodMiniObject<{
+    metadata: z.ZodMiniObject<{
+        tags: z.ZodMiniArray<z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Tag">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+    fields: z.ZodMiniObject<{
+        /**
+         * Human-readable name of the merge tag.
+         */
+        nt_name: z.ZodMiniString<string>;
+        /**
+         * Fallback value to use when the merge tag cannot be resolved.
+         */
+        nt_fallback: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        /**
+         * Internal identifier of the merge tag.
+         */
+        nt_mergetag_id: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Entry">;
+        publishedVersion: z.ZodMiniNumber<number>;
+        id: z.ZodMiniString<string>;
+        createdAt: z.ZodMiniAny;
+        updatedAt: z.ZodMiniAny;
+        locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        revision: z.ZodMiniNumber<number>;
+        space: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Space">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        environment: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Environment">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        contentType: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"ContentType">;
+                id: z.ZodMiniLiteral<"nt_mergetag">;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link MergeTagEntry}.
+ */
+export type MergeTagEntry = z.infer<typeof MergeTagEntry>;
+//# sourceMappingURL=MergeTagEntry.d.ts.map