@contentful/experiences-sdk-react 1.8.2-dev-20240625T1531-940b953.0 → 1.8.2-dev-20240625T1857-ee5ef2b.0

package/dist/hooks/useFetchByBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFetchByBase.js","sources":["../../../src/hooks/useFetchByBase.ts"],"sourcesContent":["'use client';\nimport { useEffect, useState } from 'react';\nimport { EntityStore } from '@contentful/experiences-core';\nimport type { Experience } from '@contentful/experiences-core/types';\n\nexport const useFetchByBase = (\n  fetchMethod: () => Promise<Experience<EntityStore> | undefined>,\n  isEditorMode: boolean,\n) => {\n  const [experience, setExperience] = useState<Experience<EntityStore>>();\n  const [isLoading, setIsLoading] = useState(false);\n  const [error, setError] = useState<Error>();\n\n  useEffect(() => {\n    (async () => {\n      // if we are in editor mode, we don't want to fetch the experience here\n      // it is passed via postMessage instead\n      if (isEditorMode) {\n        return;\n      }\n      setIsLoading(true);\n      setError(undefined);\n      try {\n        const exp = await fetchMethod();\n        setExperience(exp);\n      } catch (error) {\n        setError(error as Error);\n      } finally {\n        setIsLoading(false);\n      }\n    })();\n  }, [fetchMethod, isEditorMode]);\n\n  return {\n    error,\n    experience,\n    isLoading,\n    isEditorMode,\n  };\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAsBM;AACE;;;;;;;;;;AAQN;;;;;;;AAQF;;"}

package/dist/hooks/useFetchById.js

@@ -0,0 +1,16 @@
+import { useCallback } from 'react';
+import { useFetchByBase } from './useFetchByBase.js';
+import { fetchById } from '@contentful/experiences-core';
+import { useDetectEditorMode } from './useDetectEditorMode.js';
+
+const useFetchById = ({ id, localeCode, client, experienceTypeId, hyperlinkPattern, }) => {
+    const isEditorMode = useDetectEditorMode({ isClientSide: typeof window !== 'undefined' });
+    const fetchMethod = useCallback(() => {
+        return fetchById({ id, localeCode, client, experienceTypeId });
+    }, [id, localeCode, client, experienceTypeId]);
+    const fetchResult = useFetchByBase(fetchMethod, isEditorMode);
+    return { ...fetchResult, experience: { ...fetchResult.experience, hyperlinkPattern } };
+};
+
+export { useFetchById };
+//# sourceMappingURL=useFetchById.js.map

package/dist/hooks/useFetchById.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFetchById.js","sources":["../../../src/hooks/useFetchById.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport type { ContentfulClientApi } from 'contentful';\nimport { useFetchByBase } from './useFetchByBase';\nimport { fetchById } from '@contentful/experiences-core';\nimport { useDetectEditorMode } from './useDetectEditorMode';\n\nexport type UseFetchByIdArgs = {\n  client: ContentfulClientApi<undefined>;\n  id: string;\n  experienceTypeId: string;\n  localeCode: string;\n  hyperlinkPattern?: string;\n};\n\nexport const useFetchById = ({\n  id,\n  localeCode,\n  client,\n  experienceTypeId,\n  hyperlinkPattern,\n}: UseFetchByIdArgs) => {\n  const isEditorMode = useDetectEditorMode({ isClientSide: typeof window !== 'undefined' });\n\n  const fetchMethod = useCallback(() => {\n    return fetchById({ id, localeCode, client, experienceTypeId });\n  }, [id, localeCode, client, experienceTypeId]);\n\n  const fetchResult = useFetchByBase(fetchMethod, isEditorMode);\n\n  return { ...fetchResult, experience: { ...fetchResult.experience, hyperlinkPattern } };\n};\n"],"names":[],"mappings":";;;;;AAca,MAAA,YAAY,GAAG,CAAC,EAC3B,EAAE,EACF,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,gBAAgB,GACC,KAAI;AACrB,IAAA,MAAM,YAAY,GAAG,mBAAmB,CAAC,EAAE,YAAY,EAAE,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC,CAAC;AAE1F,IAAA,MAAM,WAAW,GAAG,WAAW,CAAC,MAAK;AACnC,QAAA,OAAO,SAAS,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;KAChE,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAE/C,MAAM,WAAW,GAAG,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;AAE9D,IAAA,OAAO,EAAE,GAAG,WAAW,EAAE,UAAU,EAAE,EAAE,GAAG,WAAW,CAAC,UAAU,EAAE,gBAAgB,EAAE,EAAE,CAAC;AACzF;;;;"}

package/dist/hooks/useFetchBySlug.js

@@ -0,0 +1,16 @@
+import { useCallback } from 'react';
+import { useFetchByBase } from './useFetchByBase.js';
+import { fetchBySlug } from '@contentful/experiences-core';
+import { useDetectEditorMode } from './useDetectEditorMode.js';
+
+const useFetchBySlug = ({ slug, localeCode, client, experienceTypeId, hyperlinkPattern, }) => {
+    const isEditorMode = useDetectEditorMode({ isClientSide: typeof window !== 'undefined' });
+    const fetchMethod = useCallback(() => {
+        return fetchBySlug({ slug, localeCode, client, experienceTypeId });
+    }, [slug, localeCode, client, experienceTypeId]);
+    const fetchResult = useFetchByBase(fetchMethod, isEditorMode);
+    return { ...fetchResult, experience: { ...fetchResult.experience, hyperlinkPattern } };
+};
+
+export { useFetchBySlug };
+//# sourceMappingURL=useFetchBySlug.js.map

package/dist/hooks/useFetchBySlug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFetchBySlug.js","sources":["../../../src/hooks/useFetchBySlug.ts"],"sourcesContent":["import { useCallback } from 'react';\nimport type { ContentfulClientApi } from 'contentful';\nimport { useFetchByBase } from './useFetchByBase';\nimport { fetchBySlug } from '@contentful/experiences-core';\nimport { useDetectEditorMode } from './useDetectEditorMode';\n\nexport type UseFetchBySlugArgs = {\n  client: ContentfulClientApi<undefined>;\n  slug: string;\n  experienceTypeId: string;\n  localeCode: string;\n  /** The pattern being used to generate links for hyperlink properties **/\n  hyperlinkPattern?: string;\n};\n\nexport const useFetchBySlug = ({\n  slug,\n  localeCode,\n  client,\n  experienceTypeId,\n  hyperlinkPattern,\n}: UseFetchBySlugArgs) => {\n  const isEditorMode = useDetectEditorMode({ isClientSide: typeof window !== 'undefined' });\n\n  const fetchMethod = useCallback(() => {\n    return fetchBySlug({ slug, localeCode, client, experienceTypeId });\n  }, [slug, localeCode, client, experienceTypeId]);\n\n  const fetchResult = useFetchByBase(fetchMethod, isEditorMode);\n\n  return { ...fetchResult, experience: { ...fetchResult.experience, hyperlinkPattern } };\n};\n"],"names":[],"mappings":";;;;;AAea,MAAA,cAAc,GAAG,CAAC,EAC7B,IAAI,EACJ,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,gBAAgB,GACG,KAAI;AACvB,IAAA,MAAM,YAAY,GAAG,mBAAmB,CAAC,EAAE,YAAY,EAAE,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC,CAAC;AAE1F,IAAA,MAAM,WAAW,GAAG,WAAW,CAAC,MAAK;AACnC,QAAA,OAAO,WAAW,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;KACpE,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAEjD,MAAM,WAAW,GAAG,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;AAE9D,IAAA,OAAO,EAAE,GAAG,WAAW,EAAE,UAAU,EAAE,EAAE,GAAG,WAAW,CAAC,UAAU,EAAE,gBAAgB,EAAE,EAAE,CAAC;AACzF;;;;"}

package/dist/hooks/useInitializeVisualEditor.js

@@ -0,0 +1,56 @@
+import { useState, useRef, useEffect } from 'react';
+import { runBreakpointsValidation, designTokensRegistry, breakpointsRegistry } from '@contentful/experiences-core';
+import { runRegisteredComponentValidations, sendConnectedEventWithRegisteredComponents, sendRegisteredComponentsMessage, componentRegistry } from '../core/componentRegistry.js';
+import { INTERNAL_EVENTS, VISUAL_EDITOR_EVENTS } from '@contentful/experiences-core/constants';
+
+const useInitializeVisualEditor = (params) => {
+    const { initialLocale, initialEntities } = params;
+    const [locale, setLocale] = useState(initialLocale);
+    const hasConnectEventBeenSent = useRef(false);
+    // sends component definitions to the web app
+    // InternalEvents.COMPONENTS_REGISTERED is triggered by defineComponents function
+    useEffect(() => {
+        if (!hasConnectEventBeenSent.current) {
+            runRegisteredComponentValidations();
+            runBreakpointsValidation();
+            // sending CONNECT but with the registered components now
+            sendConnectedEventWithRegisteredComponents();
+            hasConnectEventBeenSent.current = true;
+        }
+        const onComponentsRegistered = () => {
+            runRegisteredComponentValidations();
+            sendRegisteredComponentsMessage();
+        };
+        if (typeof window !== 'undefined') {
+            window.addEventListener(INTERNAL_EVENTS.ComponentsRegistered, onComponentsRegistered);
+        }
+        return () => {
+            if (typeof window !== 'undefined') {
+                window.removeEventListener(INTERNAL_EVENTS.ComponentsRegistered, onComponentsRegistered);
+            }
+        };
+    }, []);
+    useEffect(() => {
+        setLocale(initialLocale);
+    }, [initialLocale]);
+    useEffect(() => {
+        const onVisualEditorReady = () => {
+            window.dispatchEvent(new CustomEvent(INTERNAL_EVENTS.VisualEditorInitialize, {
+                detail: {
+                    componentRegistry,
+                    designTokens: designTokensRegistry,
+                    breakpoints: breakpointsRegistry,
+                    locale,
+                    entities: initialEntities ?? [],
+                },
+            }));
+        };
+        window.addEventListener(VISUAL_EDITOR_EVENTS.Ready, onVisualEditorReady);
+        return () => {
+            window.removeEventListener(VISUAL_EDITOR_EVENTS.Ready, onVisualEditorReady);
+        };
+    }, [locale, initialEntities]);
+};
+
+export { useInitializeVisualEditor };
+//# sourceMappingURL=useInitializeVisualEditor.js.map

package/dist/hooks/useInitializeVisualEditor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useInitializeVisualEditor.js","sources":["../../../src/hooks/useInitializeVisualEditor.ts"],"sourcesContent":["import { useEffect, useRef, useState } from 'react';\nimport { EntityStore, breakpointsRegistry } from '@contentful/experiences-core';\nimport {\n  componentRegistry,\n  sendConnectedEventWithRegisteredComponents,\n  sendRegisteredComponentsMessage,\n  runRegisteredComponentValidations,\n} from '../core/componentRegistry';\nimport { INTERNAL_EVENTS, VISUAL_EDITOR_EVENTS } from '@contentful/experiences-core/constants';\nimport { designTokensRegistry, runBreakpointsValidation } from '@contentful/experiences-core';\n\ntype InitializeVisualEditorParams = {\n  initialLocale: string;\n  initialEntities?: EntityStore['entities'];\n};\n\nexport const useInitializeVisualEditor = (params: InitializeVisualEditorParams) => {\n  const { initialLocale, initialEntities } = params;\n  const [locale, setLocale] = useState<string>(initialLocale);\n  const hasConnectEventBeenSent = useRef(false);\n\n  // sends component definitions to the web app\n  // InternalEvents.COMPONENTS_REGISTERED is triggered by defineComponents function\n  useEffect(() => {\n    if (!hasConnectEventBeenSent.current) {\n      runRegisteredComponentValidations();\n      runBreakpointsValidation();\n      // sending CONNECT but with the registered components now\n      sendConnectedEventWithRegisteredComponents();\n      hasConnectEventBeenSent.current = true;\n    }\n\n    const onComponentsRegistered = () => {\n      runRegisteredComponentValidations();\n      sendRegisteredComponentsMessage();\n    };\n\n    if (typeof window !== 'undefined') {\n      window.addEventListener(INTERNAL_EVENTS.ComponentsRegistered, onComponentsRegistered);\n    }\n\n    return () => {\n      if (typeof window !== 'undefined') {\n        window.removeEventListener(INTERNAL_EVENTS.ComponentsRegistered, onComponentsRegistered);\n      }\n    };\n  }, []);\n\n  useEffect(() => {\n    setLocale(initialLocale);\n  }, [initialLocale]);\n\n  useEffect(() => {\n    const onVisualEditorReady = () => {\n      window.dispatchEvent(\n        new CustomEvent(INTERNAL_EVENTS.VisualEditorInitialize, {\n          detail: {\n            componentRegistry,\n            designTokens: designTokensRegistry,\n            breakpoints: breakpointsRegistry,\n            locale,\n            entities: initialEntities ?? [],\n          },\n        }),\n      );\n    };\n\n    window.addEventListener(VISUAL_EDITOR_EVENTS.Ready, onVisualEditorReady);\n    return () => {\n      window.removeEventListener(VISUAL_EDITOR_EVENTS.Ready, onVisualEditorReady);\n    };\n  }, [locale, initialEntities]);\n};\n"],"names":[],"mappings":";;;;;AAgBa,MAAA,yBAAyB,GAAG,CAAC,MAAoC,KAAI;AAChF,IAAA,MAAM,EAAE,aAAa,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;IAClD,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAS,aAAa,CAAC,CAAC;AAC5D,IAAA,MAAM,uBAAuB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;;;IAI9C,SAAS,CAAC,MAAK;AACb,QAAA,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE;AACpC,YAAA,iCAAiC,EAAE,CAAC;AACpC,YAAA,wBAAwB,EAAE,CAAC;;AAE3B,YAAA,0CAA0C,EAAE,CAAC;AAC7C,YAAA,uBAAuB,CAAC,OAAO,GAAG,IAAI,CAAC;SACxC;QAED,MAAM,sBAAsB,GAAG,MAAK;AAClC,YAAA,iCAAiC,EAAE,CAAC;AACpC,YAAA,+BAA+B,EAAE,CAAC;AACpC,SAAC,CAAC;AAEF,QAAA,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;YACjC,MAAM,CAAC,gBAAgB,CAAC,eAAe,CAAC,oBAAoB,EAAE,sBAAsB,CAAC,CAAC;SACvF;AAED,QAAA,OAAO,MAAK;AACV,YAAA,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;gBACjC,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAC,oBAAoB,EAAE,sBAAsB,CAAC,CAAC;aAC1F;AACH,SAAC,CAAC;KACH,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,MAAK;QACb,SAAS,CAAC,aAAa,CAAC,CAAC;AAC3B,KAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpB,SAAS,CAAC,MAAK;QACb,MAAM,mBAAmB,GAAG,MAAK;YAC/B,MAAM,CAAC,aAAa,CAClB,IAAI,WAAW,CAAC,eAAe,CAAC,sBAAsB,EAAE;AACtD,gBAAA,MAAM,EAAE;oBACN,iBAAiB;AACjB,oBAAA,YAAY,EAAE,oBAAoB;AAClC,oBAAA,WAAW,EAAE,mBAAmB;oBAChC,MAAM;oBACN,QAAQ,EAAE,eAAe,IAAI,EAAE;AAChC,iBAAA;AACF,aAAA,CAAC,CACH,CAAC;AACJ,SAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;AACzE,QAAA,OAAO,MAAK;YACV,MAAM,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;AAC9E,SAAC,CAAC;AACJ,KAAC,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;AAChC;;;;"}

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import { ContentfulClientApi } from 'contentful';
 export { CF_STYLE_ATTRIBUTES, CONTENTFUL_COMPONENTS, LATEST_SCHEMA_VERSION } from '@contentful/experiences-core/constants';
 
 type ExperienceRootProps = {
-    experience?: Experience<EntityStore>;
+    experience?: Experience<EntityStore> | string | null;
     locale: string;
     visualEditorMode?: VisualEditorMode;
 };