@ninetailed/experience.js-utils-contentful 7.20.4 → 7.20.6

package/src/lib/ExperienceMapper.d.ts

@@ -1,118 +1,118 @@
-import { Reference } from '@ninetailed/experience.js';
-import { BaselineWithExperiencesEntry } from '../types/BaselineWithExperiencesEntry';
-import { EntryLike } from '../types/Entry';
-import type { EntryFields } from '../types/EntryFields';
-import { ExperienceEntry, ExperienceEntryLike } from '../types/ExperienceEntry';
-import { ExperimentEntry } from '../types/ExperimentEntry';
-export type MapVariantFunction<In extends EntryFields, Out extends Reference> = (input: EntryLike<In>) => Out;
-export type MapVariantFunctionAsync<In extends EntryFields, Out extends Reference> = (input: EntryLike<In>) => Promise<Out>;
-export declare class ExperienceMapper {
-    static isExperienceEntry<VariantFields extends EntryFields>(entry: ExperienceEntryLike<VariantFields>): entry is ExperienceEntry<VariantFields>;
-    /**
-     * Maps a Contentful Ninetailed Experience Entry to a format compatible with the Experience.js SDK.
-     *
-     * @param ctfEntry A Contentful Ninetailed Experience Entry
-     */
-    static mapExperience<VariantFields extends EntryFields>(ctfEntry: ExperienceEntryLike<VariantFields>): import("@ninetailed/experience.js").ExperienceConfiguration<{
-        id: string;
-        sys: {
-            id: string;
-            type?: string | undefined;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-            locale?: string | undefined;
-            revision?: number | undefined;
-            space?: {
-                sys: {
-                    id: string;
-                    type?: string | undefined;
-                    linkType?: string | undefined;
-                };
-            } | undefined;
-            environment?: {
-                sys: {
-                    id: string;
-                    type?: string | undefined;
-                    linkType?: string | undefined;
-                };
-            } | undefined;
-            contentType?: {
-                sys: {
-                    id: string;
-                    type?: string | undefined;
-                    linkType?: string | undefined;
-                };
-            } | undefined;
-        };
-        metadata?: {
-            tags: {
-                sys: {
-                    id: string;
-                    linkType: string;
-                    type?: string | undefined;
-                };
-            }[];
-        } | undefined;
-        fields: VariantFields;
-    }>;
-    /**
-     *
-     * Maps a Contentful Ninetailed Experience Entry to a format compatible with the Experience.js SDK
-     * using a custom mapping function for the Experience's variants.
-     *
-     * @param ctfEntry A Contentful Ninetailed Experience Entry
-     * @param mapFn  A custom function to map the Experience's variants
-     */
-    static mapCustomExperience<Variant extends Reference, VariantFields extends EntryFields>(ctfEntry: ExperienceEntryLike<VariantFields>, mapFn: MapVariantFunction<VariantFields, Variant>): import("@ninetailed/experience.js").ExperienceConfiguration<Variant>;
-    /**
-     * Similar to `mapCustomExperience` but supports asynchronous mapping functions.
-     * @see mapCustomExperience
-     */
-    static mapCustomExperienceAsync<Variant extends Reference, VariantFields extends EntryFields>(ctfEntry: ExperienceEntryLike<VariantFields>, mapFn: MapVariantFunctionAsync<VariantFields, Variant>): Promise<import("@ninetailed/experience.js").ExperienceConfiguration<Awaited<Variant>>>;
-    static isExperiment(entry: ExperienceEntryLike): entry is ExperimentEntry;
-    static mapExperiment(entry: ExperienceEntryLike): import("@ninetailed/experience.js").ExperienceConfiguration<{
-        id: string;
-    }>;
-    static mapBaselineWithExperiences<Fields extends EntryFields>(entry: BaselineWithExperiencesEntry<Fields>): import("@ninetailed/experience.js").ExperienceConfiguration<{
-        id: string;
-        sys: {
-            id: string;
-            type?: string | undefined;
-            createdAt?: string | undefined;
-            updatedAt?: string | undefined;
-            locale?: string | undefined;
-            revision?: number | undefined;
-            space?: {
-                sys: {
-                    id: string;
-                    type?: string | undefined;
-                    linkType?: string | undefined;
-                };
-            } | undefined;
-            environment?: {
-                sys: {
-                    id: string;
-                    type?: string | undefined;
-                    linkType?: string | undefined;
-                };
-            } | undefined;
-            contentType?: {
-                sys: {
-                    id: string;
-                    type?: string | undefined;
-                    linkType?: string | undefined;
-                };
-            } | undefined;
-        };
-        metadata?: {
-            tags: {
-                sys: {
-                    id: string;
-                    linkType: string;
-                    type?: string | undefined;
-                };
-            }[];
-        } | undefined;
-        fields: {};
-    }>[];
-}
+import type { Reference } from '@ninetailed/experience.js-shared';
+import { BaselineWithExperiencesEntry } from '../types/BaselineWithExperiencesEntry';
+import { EntryLike } from '../types/Entry';
+import type { EntryFields } from '../types/EntryFields';
+import { ExperienceEntry, ExperienceEntryLike } from '../types/ExperienceEntry';
+import { ExperimentEntry } from '../types/ExperimentEntry';
+export type MapVariantFunction<In extends EntryFields, Out extends Reference> = (input: EntryLike<In>) => Out;
+export type MapVariantFunctionAsync<In extends EntryFields, Out extends Reference> = (input: EntryLike<In>) => Promise<Out>;
+export declare class ExperienceMapper {
+    static isExperienceEntry<VariantFields extends EntryFields>(entry: ExperienceEntryLike<VariantFields>): entry is ExperienceEntry<VariantFields>;
+    /**
+     * Maps a Contentful Ninetailed Experience Entry to a format compatible with the Experience.js SDK.
+     *
+     * @param ctfEntry A Contentful Ninetailed Experience Entry
+     */
+    static mapExperience<VariantFields extends EntryFields>(ctfEntry: ExperienceEntryLike<VariantFields>): import("@ninetailed/experience.js-shared").ExperienceConfiguration<{
+        id: string;
+        sys: {
+            id: string;
+            type?: string | undefined;
+            createdAt?: string | undefined;
+            updatedAt?: string | undefined;
+            locale?: string | undefined;
+            revision?: number | undefined;
+            space?: {
+                sys: {
+                    id: string;
+                    type?: string | undefined;
+                    linkType?: string | undefined;
+                };
+            } | undefined;
+            environment?: {
+                sys: {
+                    id: string;
+                    type?: string | undefined;
+                    linkType?: string | undefined;
+                };
+            } | undefined;
+            contentType?: {
+                sys: {
+                    id: string;
+                    type?: string | undefined;
+                    linkType?: string | undefined;
+                };
+            } | undefined;
+        };
+        metadata?: {
+            tags: {
+                sys: {
+                    linkType: string;
+                    id: string;
+                    type?: string | undefined;
+                };
+            }[];
+        } | undefined;
+        fields: VariantFields;
+    }>;
+    /**
+     *
+     * Maps a Contentful Ninetailed Experience Entry to a format compatible with the Experience.js SDK
+     * using a custom mapping function for the Experience's variants.
+     *
+     * @param ctfEntry A Contentful Ninetailed Experience Entry
+     * @param mapFn  A custom function to map the Experience's variants
+     */
+    static mapCustomExperience<Variant extends Reference, VariantFields extends EntryFields>(ctfEntry: ExperienceEntryLike<VariantFields>, mapFn: MapVariantFunction<VariantFields, Variant>): import("@ninetailed/experience.js-shared").ExperienceConfiguration<Variant>;
+    /**
+     * Similar to `mapCustomExperience` but supports asynchronous mapping functions.
+     * @see mapCustomExperience
+     */
+    static mapCustomExperienceAsync<Variant extends Reference, VariantFields extends EntryFields>(ctfEntry: ExperienceEntryLike<VariantFields>, mapFn: MapVariantFunctionAsync<VariantFields, Variant>): Promise<import("@ninetailed/experience.js-shared").ExperienceConfiguration<Awaited<Variant>>>;
+    static isExperiment(entry: ExperienceEntryLike): entry is ExperimentEntry;
+    static mapExperiment(entry: ExperienceEntryLike): import("@ninetailed/experience.js-shared").ExperienceConfiguration<{
+        id: string;
+    }>;
+    static mapBaselineWithExperiences<Fields extends EntryFields>(entry: BaselineWithExperiencesEntry<Fields>): import("@ninetailed/experience.js-shared").ExperienceConfiguration<{
+        id: string;
+        sys: {
+            id: string;
+            type?: string | undefined;
+            createdAt?: string | undefined;
+            updatedAt?: string | undefined;
+            locale?: string | undefined;
+            revision?: number | undefined;
+            space?: {
+                sys: {
+                    id: string;
+                    type?: string | undefined;
+                    linkType?: string | undefined;
+                };
+            } | undefined;
+            environment?: {
+                sys: {
+                    id: string;
+                    type?: string | undefined;
+                    linkType?: string | undefined;
+                };
+            } | undefined;
+            contentType?: {
+                sys: {
+                    id: string;
+                    type?: string | undefined;
+                    linkType?: string | undefined;
+                };
+            } | undefined;
+        };
+        metadata?: {
+            tags: {
+                sys: {
+                    linkType: string;
+                    id: string;
+                    type?: string | undefined;
+                };
+            }[];
+        } | undefined;
+        fields: {};
+    }>[];
+}

package/src/lib/__test__/contentful-generated-types.d.ts

@@ -1,53 +1,53 @@
-import type { Entry, EntryFieldTypes, EntrySkeletonType } from 'contentful';
-/** Your custom methods (optional so real CDA entries still type-check) */
-type EntryMethods = {
-    toPlainObject?: () => object;
-    update?: () => Promise<unknown>;
-};
-/**
- * Recursively adds EntryMethods to every Contentful Entry found inside `T`.
- * - Recurse into `fields` (so linked entries get the methods too)
- * - Recurse into arrays (for multi-reference fields)
- * - Leave everything else alone (keeps JSON/object fields and your variants generic)
- */
-type WithEntryMethods<T> = T extends Entry<any, any, any> ? Omit<T, 'fields'> & {
-    fields: {
-        [K in keyof T['fields']]: WithEntryMethods<T['fields'][K]>;
-    };
-} & EntryMethods : T extends Array<infer U> ? Array<WithEntryMethods<U>> : T;
-/** Convenience alias for your preferred modifiers/locales */
-type CtflEntry<S extends EntrySkeletonType> = WithEntryMethods<Entry<S, 'WITHOUT_UNRESOLVABLE_LINKS', string>>;
-/**
- * ---------- NT Audience ----------
- */
-export interface INtAudienceFields {
-    nt_name: EntryFieldTypes.Symbol;
-    nt_rules: EntryFieldTypes.Object;
-    nt_audience_id: EntryFieldTypes.Symbol;
-}
-export type INtAudienceSkeleton = EntrySkeletonType<INtAudienceFields, 'nt_audience'>;
-export type INtAudience = CtflEntry<INtAudienceSkeleton>;
-/**
- * ---------- NT Experience ----------
- */
-export interface INtExperienceFields {
-    nt_name: EntryFieldTypes.Symbol;
-    nt_description: EntryFieldTypes.Text;
-    nt_type: EntryFieldTypes.Symbol;
-    nt_experience_id: EntryFieldTypes.Symbol;
-    nt_config: EntryFieldTypes.Object;
-    nt_audience: EntryFieldTypes.EntryLink<INtAudienceSkeleton>;
-    nt_variants: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<EntrySkeletonType>>;
-}
-export type INtExperienceSkeleton = EntrySkeletonType<INtExperienceFields, 'nt_experience'>;
-export type INtExperience = CtflEntry<INtExperienceSkeleton>;
-/**
- * ---------- Hero ----------
- */
-export interface IHeroFields {
-    name: EntryFieldTypes.Symbol;
-    nt_experiences: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<INtExperienceSkeleton>>;
-}
-export type IHeroSkeleton = EntrySkeletonType<IHeroFields, 'hero'>;
-export type IHero = CtflEntry<IHeroSkeleton>;
-export {};
+import type { Entry, EntryFieldTypes, EntrySkeletonType } from 'contentful';
+/** Your custom methods (optional so real CDA entries still type-check) */
+type EntryMethods = {
+    toPlainObject?: () => object;
+    update?: () => Promise<unknown>;
+};
+/**
+ * Recursively adds EntryMethods to every Contentful Entry found inside `T`.
+ * - Recurse into `fields` (so linked entries get the methods too)
+ * - Recurse into arrays (for multi-reference fields)
+ * - Leave everything else alone (keeps JSON/object fields and your variants generic)
+ */
+type WithEntryMethods<T> = T extends Entry<any, any, any> ? Omit<T, 'fields'> & {
+    fields: {
+        [K in keyof T['fields']]: WithEntryMethods<T['fields'][K]>;
+    };
+} & EntryMethods : T extends Array<infer U> ? Array<WithEntryMethods<U>> : T;
+/** Convenience alias for your preferred modifiers/locales */
+type CtflEntry<S extends EntrySkeletonType> = WithEntryMethods<Entry<S, 'WITHOUT_UNRESOLVABLE_LINKS', string>>;
+/**
+ * ---------- NT Audience ----------
+ */
+export interface INtAudienceFields {
+    nt_name: EntryFieldTypes.Symbol;
+    nt_rules: EntryFieldTypes.Object;
+    nt_audience_id: EntryFieldTypes.Symbol;
+}
+export type INtAudienceSkeleton = EntrySkeletonType<INtAudienceFields, 'nt_audience'>;
+export type INtAudience = CtflEntry<INtAudienceSkeleton>;
+/**
+ * ---------- NT Experience ----------
+ */
+export interface INtExperienceFields {
+    nt_name: EntryFieldTypes.Symbol;
+    nt_description: EntryFieldTypes.Text;
+    nt_type: EntryFieldTypes.Symbol;
+    nt_experience_id: EntryFieldTypes.Symbol;
+    nt_config: EntryFieldTypes.Object;
+    nt_audience: EntryFieldTypes.EntryLink<INtAudienceSkeleton>;
+    nt_variants: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<EntrySkeletonType>>;
+}
+export type INtExperienceSkeleton = EntrySkeletonType<INtExperienceFields, 'nt_experience'>;
+export type INtExperience = CtflEntry<INtExperienceSkeleton>;
+/**
+ * ---------- Hero ----------
+ */
+export interface IHeroFields {
+    name: EntryFieldTypes.Symbol;
+    nt_experiences: EntryFieldTypes.Array<EntryFieldTypes.EntryLink<INtExperienceSkeleton>>;
+}
+export type IHeroSkeleton = EntrySkeletonType<IHeroFields, 'hero'>;
+export type IHero = CtflEntry<IHeroSkeleton>;
+export {};

package/src/lib/__test__/ctfHero.d.ts

@@ -1,2 +1,2 @@
-import { IHero } from './contentful-generated-types';
-export declare const ctfHero: IHero;
+import { IHero } from './contentful-generated-types';
+export declare const ctfHero: IHero;