@contentful/experiences-core 1.9.1-dev-20240708T2121-56f0f54.0 → 1.10.0-dev-20240711T1608-55292da.0

package/dist/fetchers/fetchAllEntities.d.ts

@@ -0,0 +1,30 @@
+import { ContentfulClientApi, Entry, Asset } from 'contentful';
+import { MinimalEntryCollection } from './gatherAutoFetchedReferentsFromIncludes.js';
+
+declare const fetchAllEntries: ({ client, ids, locale, skip, limit, responseItems, responseIncludes, }: {
+    client: ContentfulClientApi<undefined>;
+    ids: string[];
+    locale?: string;
+    skip?: number;
+    limit?: number;
+    responseItems?: Entry[];
+    responseIncludes?: MinimalEntryCollection["includes"];
+}) => Promise<{
+    items: Entry[];
+    includes: {
+        Entry: Entry[];
+        Asset: Asset[];
+    };
+}>;
+declare const fetchAllAssets: ({ client, ids, locale, skip, limit, responseItems, }: {
+    client: ContentfulClientApi<undefined>;
+    ids: string[];
+    locale?: string;
+    skip?: number;
+    limit?: number;
+    responseItems?: Asset[];
+}) => Promise<{
+    items: Asset[];
+}>;
+
+export { fetchAllAssets, fetchAllEntries };

package/dist/fetchers/gatherAutoFetchedReferentsFromIncludes.d.ts

@@ -0,0 +1,11 @@
+import { Entry, Asset } from 'contentful';
+
+type MinimalEntryCollection = {
+    items: Entry[];
+    includes: {
+        Entry: Entry[];
+        Asset: Asset[];
+    };
+};
+
+export type { MinimalEntryCollection };

package/dist/index.d.ts

@@ -21,6 +21,7 @@ export { sendMessage } from './communication/sendMessage.js';
 export { VisualEditorMode } from './enums.js';
 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 { defineDesignTokens, designTokensRegistry, getDesignTokenRegistration, resetDesignTokenRegistry } from './registries/designTokenRegistry.js';
 export { breakpointsRegistry, defineBreakpoints, getBreakpointRegistration, resetBreakpointsRegistry, runBreakpointsValidation } from './registries/breakpointsRegistry.js';

package/dist/index.js

@@ -1,7 +1,7 @@
 import md5 from 'md5';
 import { z, ZodIssueCode } from 'zod';
 import { BLOCKS } from '@contentful/rich-text-types';
-import { uniqBy } from 'lodash-es';
+import { isArray, uniqBy } from 'lodash-es';
 
 const INCOMING_EVENTS = {
     RequestEditorMode: 'requestEditorMode',
@@ -1051,6 +1051,8 @@ const DefinitionPropertyTypeSchema = z.enum([
     'Media',
     'Object',
     'Hyperlink',
+    'Array',
+    'Link',
 ]);
 const DefinitionPropertyKeySchema = z
     .string()
@@ -2028,19 +2030,61 @@ const transformMedia = (asset, variables, resolveDesignValue, variableName, path
     return asset.fields.file?.url;
 };
 
+function getResolvedEntryFromLink(entryOrAsset, path, entityStore) {
+    if (entryOrAsset.sys.type === 'Asset') {
+        return entryOrAsset;
+    }
+    const value = get(entryOrAsset, path.split('/').slice(2, -1));
+    if (value?.sys.type !== 'Link') {
+        console.warn(`Expected a link to a reference, but got: ${JSON.stringify(value)}`);
+        return;
+    }
+    //Look up the reference in the entity store
+    const resolvedEntity = entityStore.getEntityFromLink(value);
+    return resolvedEntity;
+}
+
+function getArrayValue(entryOrAsset, path, entityStore) {
+    if (entryOrAsset.sys.type === 'Asset') {
+        return entryOrAsset;
+    }
+    const arrayValue = get(entryOrAsset, path.split('/').slice(2, -1));
+    if (!isArray(arrayValue)) {
+        console.warn(`Expected a value to be an array, but got: ${JSON.stringify(arrayValue)}`);
+        return;
+    }
+    const result = arrayValue.map((value) => {
+        if (typeof value === 'string') {
+            return value;
+        }
+        else if (value?.sys?.type === 'Link') {
+            return entityStore.getEntityFromLink(value);
+        }
+        else {
+            console.warn(`Expected value to be a string or Link, but got: ${JSON.stringify(value)}`);
+            return undefined;
+        }
+    });
+    return result;
+}
+
 const transformBoundContentValue = (variables, entityStore, binding, resolveDesignValue, variableName, variableDefinition, path) => {
     const entityOrAsset = entityStore.getEntryOrAsset(binding, path);
     if (!entityOrAsset)
         return;
     switch (variableDefinition.type) {
         case 'Media':
-            // If we bound a normal entry field to the media veriable we just return the bound value
+            // If we bound a normal entry field to the media variable we just return the bound value
             if (entityOrAsset.sys.type === 'Entry') {
                 return getBoundValue(entityOrAsset, path);
             }
             return transformMedia(entityOrAsset, variables, resolveDesignValue, variableName, path);
         case 'RichText':
             return transformRichText(entityOrAsset, path);
+        case 'Array':
+            return getArrayValue(entityOrAsset, path, entityStore);
+        case 'Link':
+            return getResolvedEntryFromLink(entityOrAsset, path, entityStore);
         default:
             return getBoundValue(entityOrAsset, path);
     }
@@ -2808,8 +2852,8 @@ class EditorModeEntityStore extends EditorEntityStore {
     async fetchEntities({ missingEntryIds, missingAssetIds, skipCache = false, }) {
         // Entries and assets will be stored in entryMap and assetMap
         await Promise.all([
-            this.fetchEntries(missingEntryIds, skipCache),
-            this.fetchAssets(missingAssetIds, skipCache),
+            super.fetchEntries(missingEntryIds, skipCache),
+            super.fetchAssets(missingAssetIds, skipCache),
         ]);
     }
     getMissingEntityIds(entityLinks) {
@@ -3250,11 +3294,13 @@ const fetchReferencedEntities = async ({ client, experienceEntry, locale, }) =>
     // Using client getEntries resolves all linked entry references, so we do not need to resolve entries in usedComponents
     const allResolvedEntries = [
         ...(entriesResponse?.items ?? []),
+        ...(entriesResponse.includes?.Entry ?? []),
         ...(experienceEntry.fields.usedComponents || []),
         ...autoFetchedReferentEntries,
     ];
     const allResolvedAssets = [
         ...(assetsResponse.items ?? []),
+        ...(entriesResponse?.includes?.Asset ?? []),
         ...autoFetchedReferentAssets,
     ];
     return {
@@ -3366,5 +3412,5 @@ async function fetchById({ client, experienceTypeId, id, localeCode, }) {
     }
 }
 
-export { DeepReference, EditorModeEntityStore, EntityStore, EntityStoreBase, MEDIA_QUERY_REGEXP, VisualEditorMode, addLocale, breakpointsRegistry, buildCfStyles, buildStyleTag, buildTemplate, builtInStyles, calculateNodeDefaultHeight, checkIsAssembly, checkIsAssemblyDefinition, checkIsAssemblyEntry, checkIsAssemblyNode, columnsBuiltInStyles, columnsDefinition, containerBuiltInStyles, containerDefinition, createExperience, defineBreakpoints, defineDesignTokens, designTokensRegistry, detachExperienceStyles, dividerBuiltInStyles, dividerDefinition, doesMismatchMessageSchema, fetchById, fetchBySlug, findOutermostCoordinates, flattenDesignTokenRegistry, gatherDeepReferencesFromExperienceEntry, gatherDeepReferencesFromTree, generateRandomId, getActiveBreakpointIndex, getBreakpointRegistration, getDataFromTree, getDesignTokenRegistration, getElementCoordinates, getFallbackBreakpointIndex, getInsertionData, getTemplateValue, getValueForBreakpoint, indexByBreakpoint, isCfStyleAttribute, isComponentAllowedOnRoot, isContentfulStructureComponent, isDeepPath, isExperienceEntry, isLink, isLinkToAsset, isStructureWithRelativeHeight, lastPathNamedSegmentEq, maybePopulateDesignTokenValue, mediaQueryMatcher, optionalBuiltInStyles, parseDataSourcePathIntoFieldset, parseDataSourcePathWithL1DeepBindings, resetBreakpointsRegistry, resetDesignTokenRegistry, resolveBackgroundImageBinding, resolveHyperlinkPattern, runBreakpointsValidation, sectionBuiltInStyles, sectionDefinition, sendMessage, singleColumnBuiltInStyles, singleColumnDefinition, supportedModes, toCSSAttribute, toCSSString, toMediaQuery, transformBoundContentValue, tryParseMessage, validateExperienceBuilderConfig };
+export { DeepReference, EditorModeEntityStore, EntityStore, EntityStoreBase, MEDIA_QUERY_REGEXP, VisualEditorMode, addLocale, breakpointsRegistry, buildCfStyles, buildStyleTag, buildTemplate, builtInStyles, calculateNodeDefaultHeight, checkIsAssembly, checkIsAssemblyDefinition, checkIsAssemblyEntry, checkIsAssemblyNode, columnsBuiltInStyles, columnsDefinition, containerBuiltInStyles, containerDefinition, createExperience, defineBreakpoints, defineDesignTokens, designTokensRegistry, detachExperienceStyles, dividerBuiltInStyles, dividerDefinition, doesMismatchMessageSchema, fetchAllAssets, fetchAllEntries, fetchById, fetchBySlug, findOutermostCoordinates, flattenDesignTokenRegistry, gatherDeepReferencesFromExperienceEntry, gatherDeepReferencesFromTree, generateRandomId, getActiveBreakpointIndex, getBreakpointRegistration, getDataFromTree, getDesignTokenRegistration, getElementCoordinates, getFallbackBreakpointIndex, getInsertionData, getTemplateValue, getValueForBreakpoint, indexByBreakpoint, isCfStyleAttribute, isComponentAllowedOnRoot, isContentfulStructureComponent, isDeepPath, isExperienceEntry, isLink, isLinkToAsset, isStructureWithRelativeHeight, lastPathNamedSegmentEq, maybePopulateDesignTokenValue, mediaQueryMatcher, optionalBuiltInStyles, parseDataSourcePathIntoFieldset, parseDataSourcePathWithL1DeepBindings, resetBreakpointsRegistry, resetDesignTokenRegistry, resolveBackgroundImageBinding, resolveHyperlinkPattern, runBreakpointsValidation, sectionBuiltInStyles, sectionDefinition, sendMessage, singleColumnBuiltInStyles, singleColumnDefinition, supportedModes, toCSSAttribute, toCSSString, toMediaQuery, transformBoundContentValue, tryParseMessage, validateExperienceBuilderConfig };
 //# sourceMappingURL=index.js.map