@contentful/experiences-core 1.36.0-beta.0 → 1.36.0-beta.2

package/dist/fetchers/createExperience.d.ts

@@ -2,17 +2,24 @@ import { Entry, Asset } from 'contentful';
 import { Experience } from '../types.js';
 import { EntityStore } from '../entity/EntityStore.js';
 
-type createExperienceArgs = {
+type CreateExperienceParams = {
     experienceEntry: Entry;
     referencedEntries: Array<Entry>;
     referencedAssets: Array<Asset>;
     locale: string;
 };
 /**
- * Create an experience instance
+ * Create an experience instance using a serialized version of the entity store for SSR purposes.
  * @param {string} json - JSON representation of the experience
  */
 declare function createExperience(json: string): Experience<EntityStore>;
-declare function createExperience(args: createExperienceArgs): Experience<EntityStore>;
+/**
+ * Create an experience instance using the already fetched entries and assets.
+ * @param options.experienceEntry - Localized experience entry which will be rendered
+ * @param options.referencedEntries - Array of localized entries which are referenced by the experience entry in its dataSource
+ * @param options.referencedAssets - Array of localized assets which are referenced by the experience entry in its dataSource
+ * @param options.locale - (Soon to be removed unused parameter)
+ */
+declare function createExperience(options: CreateExperienceParams): Experience<EntityStore>;
 
 export { createExperience };

package/dist/fetchers/fetchAllEntities.d.ts

@@ -2,7 +2,7 @@ import { ContentfulClientApi, Entry, Asset } from 'contentful';
 import { MinimalEntryCollection } from './gatherAutoFetchedReferentsFromIncludes.js';
 
 declare const fetchAllEntries: ({ client, ids, locale, skip, limit, responseItems, responseIncludes, }: {
-    client: ContentfulClientApi<undefined>;
+    client: ContentfulClientApi<undefined> | ContentfulClientApi<"WITH_ALL_LOCALES">;
     ids: string[];
     locale?: string;
     skip?: number;
@@ -17,7 +17,7 @@ declare const fetchAllEntries: ({ client, ids, locale, skip, limit, responseItem
     };
 }>;
 declare const fetchAllAssets: ({ client, ids, locale, skip, limit, responseItems, }: {
-    client: ContentfulClientApi<undefined>;
+    client: ContentfulClientApi<undefined> | ContentfulClientApi<"WITH_ALL_LOCALES">;
     ids: string[];
     locale?: string;
     skip?: number;

package/dist/fetchers/fetchById.d.ts

@@ -15,7 +15,8 @@ type FetchByIdParams = {
     isEditorMode?: boolean;
 };
 /**
- * Fetches an experience object by its id
+ * Fetches an experience entry by its id and additionally fetches all its references to return
+ * an initilized experience instance.
  * @param {FetchByIdParams} options - options to fetch the experience
  */
 declare function fetchById({ client, experienceTypeId, id, localeCode, isEditorMode, }: FetchByIdParams): Promise<Experience<EntityStore> | undefined>;

package/dist/fetchers/fetchBySlug.d.ts

@@ -15,7 +15,8 @@ type FetchBySlugParams = {
     isEditorMode?: boolean;
 };
 /**
- * Fetches an experience object by its slug
+ * Fetches an experience entry by its slug and additionally fetches all its references to return
+ * an initilized experience instance.
  * @param {FetchBySlugParams} options - options to fetch the experience
  */
 declare function fetchBySlug({ client, experienceTypeId, slug, localeCode, isEditorMode, }: FetchBySlugParams): Promise<Experience<EntityStore> | undefined>;

package/dist/fetchers/fetchExperienceEntry.d.ts

@@ -0,0 +1,30 @@
+import { Entry, ContentfulClientApi } from 'contentful';
+
+type ClientAndLocaleParams = {
+    client: ContentfulClientApi<undefined>;
+    locale?: string;
+} | {
+    client: ContentfulClientApi<'WITH_ALL_LOCALES'>;
+    /** When fetching all locales, this may not be defined */
+    locale?: undefined;
+};
+type FetchExperienceEntryParams = {
+    experienceTypeId: string;
+    identifier: {
+        slug: string;
+    } | {
+        id: string;
+    };
+} & ClientAndLocaleParams;
+/**
+ * Fetches an experience entry by its slug or id. Throws an error if there are multiple
+ * entries with the same slug. Additionally, it resolves all nested pattern entries inside `fields.usedComponents`.
+ * @param options.client - Instantiated client from the Contentful SDK. If this is using the `withAllLocales` modifier, you may not provide a specific locale.
+ * @param options.locale - Provide a locale if your experience contains custom localized fields. Otherwise, it will fallback to the default locale.
+ * @param options.experienceTypeId - id of the content type associated with the experience
+ * @param options.identifier - identifying condition to find the correct experience entry
+ *
+ */
+declare const fetchExperienceEntry: ({ client, experienceTypeId, locale, identifier, }: FetchExperienceEntryParams) => Promise<Entry | undefined>;
+
+export { fetchExperienceEntry };

package/dist/fetchers/fetchReferencedEntities.d.ts

@@ -0,0 +1,28 @@
+import { ExperienceEntry } from '../types.js';
+import { Entry, Asset, ContentfulClientApi } from 'contentful';
+
+type ClientAndLocaleParams = {
+    client: ContentfulClientApi<undefined>;
+    locale?: string;
+} | {
+    client: ContentfulClientApi<'WITH_ALL_LOCALES'>;
+    /** When fetching all locales, this may not be defined */
+    locale?: undefined;
+};
+type FetchReferencedEntitiesArgs = {
+    experienceEntry: Entry | ExperienceEntry;
+} & ClientAndLocaleParams;
+/**
+ * Fetches all entries and assets from the `dataSource` of the given experience entry. This will
+ * also consider deep references that are not listed explicitly but linked through deep binding paths.
+ * @param options.client - Instantiated client from the Contentful SDK. If this is using the `withAllLocales` modifier, you may not provide a specific locale.
+ * @param options.experienceEntry - Localized experience entry. To localize a multi locale entry, use the `localizeEntity` function.
+ * @param options.locale - Retrieve a specific localized version of the referenced entities. Otherwise, it will fallback to the default locale.
+ * @returns object with a list of `entries` and a list of `assets`
+ */
+declare const fetchReferencedEntities: ({ client, experienceEntry, locale, }: FetchReferencedEntitiesArgs) => Promise<{
+    entries: Entry[];
+    assets: Asset[];
+}>;
+
+export { fetchReferencedEntities };

package/dist/index.d.ts

@@ -1,18 +1,19 @@
 export { isComponentAllowedOnRoot, isContentfulComponent, isContentfulStructureComponent, isPatternComponent, isStructureWithRelativeHeight } from './utils/components.js';
-export { findOutermostCoordinates, getElementCoordinates } from './utils/domValues.js';
-export { doesMismatchMessageSchema, tryParseMessage, validateExperienceBuilderConfig } from './utils/validations.js';
-export { addMinHeightForEmptyStructures, buildCfStyles, buildStyleTag, calculateNodeDefaultHeight, stringifyCssProperties, toCSSAttribute } from './utils/styleUtils/stylesUtils.js';
-export { detachExperienceStyles, flattenDesignTokenRegistry, indexByBreakpoint, isCfStyleAttribute, maybePopulateDesignTokenValue, resolveBackgroundImageBinding, toMediaQuery } from './utils/styleUtils/ssrStyles.js';
-export { transformBoundContentValue } from './utils/transformers/transformBoundContentValue.js';
-export { checkIsAssembly, checkIsAssemblyDefinition, checkIsAssemblyEntry, checkIsAssemblyNode, generateRandomId, getDataFromTree, getInsertionData, getTargetValueInPixels, parseCSSValue } from './utils/utils.js';
-export { isExperienceEntry } from './utils/typeguards.js';
 export { MEDIA_QUERY_REGEXP, getActiveBreakpointIndex, getFallbackBreakpointIndex, getValueForBreakpoint, isValidBreakpointValue, mediaQueryMatcher } from './utils/breakpoints.js';
+export { DebugLogger, debug, disableDebug, enableDebug } from './utils/debugLogger.js';
+export { findOutermostCoordinates, getElementCoordinates } from './utils/domValues.js';
 export { isLinkToAsset } from './utils/isLinkToAsset.js';
 export { isLink } from './utils/isLink.js';
+export { localizeEntity } from './utils/localizeEntity.js';
 export { Fieldset, UnresolvedFieldset, isDeepPath, lastPathNamedSegmentEq, parseDataSourcePathIntoFieldset, parseDataSourcePathWithL1DeepBindings } from './utils/pathSchema.js';
 export { addLocale, buildTemplate, getTemplateValue, resolveHyperlinkPattern } from './utils/resolveHyperlinkPattern.js';
 export { sanitizeNodeProps } from './utils/sanitizeNodeProps.js';
-export { DebugLogger, debug, disableDebug, enableDebug } from './utils/debugLogger.js';
+export { addMinHeightForEmptyStructures, buildCfStyles, buildStyleTag, calculateNodeDefaultHeight, stringifyCssProperties, toCSSAttribute } from './utils/styleUtils/stylesUtils.js';
+export { detachExperienceStyles, flattenDesignTokenRegistry, indexByBreakpoint, isCfStyleAttribute, maybePopulateDesignTokenValue, resolveBackgroundImageBinding, toMediaQuery } from './utils/styleUtils/ssrStyles.js';
+export { transformBoundContentValue } from './utils/transformers/transformBoundContentValue.js';
+export { isExperienceEntry } from './utils/typeguards.js';
+export { checkIsAssembly, checkIsAssemblyDefinition, checkIsAssemblyEntry, checkIsAssemblyNode, generateRandomId, getDataFromTree, getInsertionData, getTargetValueInPixels, parseCSSValue } from './utils/utils.js';
+export { doesMismatchMessageSchema, tryParseMessage, validateExperienceBuilderConfig } from './utils/validations.js';
 export { builtInStyles, columnsBuiltInStyles, containerBuiltInStyles, dividerBuiltInStyles, optionalBuiltInStyles, sectionBuiltInStyles, singleColumnBuiltInStyles } from './definitions/styles.js';
 export { EditorModeEntityStore } from './entity/EditorModeEntityStore.js';
 export { EntityStore } from './entity/EntityStore.js';
@@ -23,6 +24,8 @@ export { fetchBySlug } from './fetchers/fetchBySlug.js';
 export { fetchById } from './fetchers/fetchById.js';
 export { fetchAllAssets, fetchAllEntries } from './fetchers/fetchAllEntities.js';
 export { createExperience } from './fetchers/createExperience.js';
+export { fetchReferencedEntities } from './fetchers/fetchReferencedEntities.js';
+export { fetchExperienceEntry } from './fetchers/fetchExperienceEntry.js';
 export { defineDesignTokens, designTokensRegistry, getDesignTokenRegistration, resetDesignTokenRegistry } from './registries/designTokenRegistry.js';
 export { breakpointsRegistry, defineBreakpoints, getBreakpointRegistration, resetBreakpointsRegistry, runBreakpointsValidation } from './registries/breakpointsRegistry.js';
 export { DeepReference, gatherDeepReferencesFromExperienceEntry, gatherDeepReferencesFromTree } from './deep-binding/DeepReference.js';