@contentful/experiences-core 1.25.1 → 1.26.0-beta.0

package/dist/fetchers/fetchById.d.ts

@@ -2,17 +2,22 @@ import { Experience } from '../types.js';
 import { ContentfulClientApi } from 'contentful';
 import { EntityStore } from '../entity/EntityStore.js';
 
-/**
- * Fetch experience entry using slug as the identifier
- * @param {string} experienceTypeId - id of the content type associated with the experience
- * @param {string} slug - slug of the experience (defined in entry settings)
- * @param {string} localeCode - locale code to fetch the experience. Falls back to the currently active locale in the state
- */
-declare function fetchById({ client, experienceTypeId, id, localeCode, }: {
+type FetchByIdParams = {
+    /** instantiated client from the Contentful SDK */
     client: ContentfulClientApi<undefined>;
+    /** id of the content type associated with the experience */
     experienceTypeId: string;
+    /** id of the experience (defined in entry settings) */
     id: string;
+    /** locale code to fetch the experience */
     localeCode: string;
-}): Promise<Experience<EntityStore> | undefined>;
+    /** if the experience is being loaded in the Contentful Studio editor or not. If true, this function is a noop. */
+    isEditorMode?: boolean;
+};
+/**
+ * Fetches an experience object by its id
+ * @param {FetchByIdParams} options - options to fetch the experience
+ */
+declare function fetchById({ client, experienceTypeId, id, localeCode, isEditorMode, }: FetchByIdParams): Promise<Experience<EntityStore> | undefined>;
 
 export { fetchById };

package/dist/fetchers/fetchBySlug.d.ts

@@ -2,17 +2,22 @@ import { Experience } from '../types.js';
 import { ContentfulClientApi } from 'contentful';
 import { EntityStore } from '../entity/EntityStore.js';
 
-/**
- * Fetch experience entry using slug as the identifier
- * @param {string} experienceTypeId - id of the content type associated with the experience
- * @param {string} slug - slug of the experience (defined in entry settings)
- * @param {string} localeCode - locale code to fetch the experience. Falls back to the currently active locale in the state
- */
-declare function fetchBySlug({ client, experienceTypeId, slug, localeCode, }: {
+type FetchBySlugParams = {
+    /** instantiated client from the Contentful SDK */
     client: ContentfulClientApi<undefined>;
+    /** id of the content type associated with the experience */
     experienceTypeId: string;
+    /** slug of the experience (defined in entry settings) */
     slug: string;
+    /** locale code to fetch the experience */
     localeCode: string;
-}): Promise<Experience<EntityStore> | undefined>;
+    /** if the experience is being loaded in the Contentful Studio editor or not. If true, this function is a noop. */
+    isEditorMode?: boolean;
+};
+/**
+ * Fetches an experience object by its slug
+ * @param {FetchBySlugParams} options - options to fetch the experience
+ */
+declare function fetchBySlug({ client, experienceTypeId, slug, localeCode, isEditorMode, }: FetchBySlugParams): Promise<Experience<EntityStore> | undefined>;
 
 export { fetchBySlug };

package/dist/index.js

@@ -3554,13 +3554,13 @@ const handleError$1 = (generalMessage, error) => {
     throw Error(message);
 };
 /**
- * Fetch experience entry using slug as the identifier
- * @param {string} experienceTypeId - id of the content type associated with the experience
- * @param {string} slug - slug of the experience (defined in entry settings)
- * @param {string} localeCode - locale code to fetch the experience. Falls back to the currently active locale in the state
+ * Fetches an experience object by its slug
+ * @param {FetchBySlugParams} options - options to fetch the experience
  */
-//  Promise<Experience<EntityStore> | undefined> =>
-async function fetchBySlug({ client, experienceTypeId, slug, localeCode, }) {
+async function fetchBySlug({ client, experienceTypeId, slug, localeCode, isEditorMode, }) {
+    //Be a no-op if in editor mode
+    if (isEditorMode)
+        return;
     let experienceEntry = undefined;
     try {
         experienceEntry = await fetchExperienceEntry({
@@ -3606,12 +3606,13 @@ const handleError = (generalMessage, error) => {
     throw Error(message);
 };
 /**
- * Fetch experience entry using slug as the identifier
- * @param {string} experienceTypeId - id of the content type associated with the experience
- * @param {string} slug - slug of the experience (defined in entry settings)
- * @param {string} localeCode - locale code to fetch the experience. Falls back to the currently active locale in the state
+ * Fetches an experience object by its id
+ * @param {FetchByIdParams} options - options to fetch the experience
  */
-async function fetchById({ client, experienceTypeId, id, localeCode, }) {
+async function fetchById({ client, experienceTypeId, id, localeCode, isEditorMode, }) {
+    //Be a no-op if in editor mode
+    if (isEditorMode)
+        return;
     let experienceEntry = undefined;
     try {
         experienceEntry = await fetchExperienceEntry({