@contentful/experiences-core 1.42.3 → 2.0.0-beta.0

package/dist/types.d.ts

@@ -84,8 +84,6 @@ type ComponentRegistration = {
          */
         enableCustomEditorView?: boolean;
         wrapComponent?: boolean;
-        /** @deprecated use wrapContainer instead */
-        wrapContainerTag?: keyof JSX.IntrinsicElements;
         wrapContainer?: keyof JSX.IntrinsicElements | React.ReactElement;
         wrapContainerWidth?: React.CSSProperties['width'];
     };
@@ -109,7 +107,7 @@ type BindingMapByBlockId = Record<string, BindingMap>;
 type DataSourceEntryValueType = Link<'Entry' | 'Asset'>;
 /** Type of a single node of the experience tree exchanged via postMessage between the SDK and Contentful Web app */
 type ExperienceTreeNode = {
-    type: 'block' | 'root' | 'editorRoot' | 'designComponent' | 'designComponentBlock' | 'assembly' | 'assemblyBlock';
+    type: 'block' | 'root' | 'assembly' | 'assemblyBlock';
     data: {
         id: string;
         blockId?: string;
@@ -310,7 +308,7 @@ type RequestedEntitiesMessage = {
     entities: Array<Entry | Asset>;
     missingEntityIds?: string[];
 };
-type BoundComponentPropertyTypes = string | number | boolean | AssetFile | Record<string, AssetFile | undefined> | Document | OptimizedBackgroundImageAsset | OptimizedImageAsset | Link<'Asset'> | Entry | Asset | (string | Entry | Asset<ChainModifiers, string> | undefined)[] | undefined;
+type BoundComponentPropertyTypes = string | number | boolean | AssetFile | Record<string, AssetFile | undefined> | Document | OptimizedBackgroundImageAsset | OptimizedImageAsset | Link<'Asset'> | Link<'Entry'> | Array<Link<'Asset' | 'Entry'>> | Entry | Asset | (string | Entry | Asset<ChainModifiers, string> | undefined)[] | undefined;
 type OptimizedImageAsset = {
     url: string;
     srcSet?: string[];
@@ -326,7 +324,7 @@ type OptimizedBackgroundImageAsset = {
     file: AssetFile;
 };
 type ImageObjectFitOption = 'contain' | 'cover' | 'none';
-type ImageObjectPositionOption = 'left' | 'right' | 'top' | 'bottom' | 'left top' | 'left center' | 'left bottom' | 'right top' | 'right center' | 'right bottom' | 'center top' | 'center center' | 'center bottom';
+type ImageObjectPositionOption = 'left top' | 'left center' | 'left bottom' | 'right top' | 'right center' | 'right bottom' | 'center top' | 'center center' | 'center bottom';
 type ImageLoadingOption = 'lazy' | 'eager';
 type ImageOptions = {
     format?: string;
@@ -339,7 +337,7 @@ type ImageOptions = {
     targetSize: string;
 };
 type BackgroundImageScalingOption = 'fit' | 'fill' | 'tile';
-type BackgroundImageAlignmentOption = 'left' | 'right' | 'top' | 'bottom' | 'left top' | 'left center' | 'left bottom' | 'right top' | 'right center' | 'right bottom' | 'center top' | 'center center' | 'center bottom';
+type BackgroundImageAlignmentOption = 'left top' | 'left center' | 'left bottom' | 'right top' | 'right center' | 'right bottom' | 'center top' | 'center center' | 'center bottom';
 type BackgroundImageOptions = {
     format?: string;
     scaling: BackgroundImageScalingOption;
@@ -472,12 +470,8 @@ type RequestReadOnlyModePayload = undefined;
 type RequestEditorModePayload = undefined;
 type ExperienceUpdatedPayload = {
     tree: ExperienceTree;
-    /** @deprecated in favor of assemblies */
-    designComponents?: ExperienceUsedComponents;
     assemblies?: ExperienceUsedComponents;
     locale: string;
-    /** @deprecated maybe? */
-    defaultLocaleCode?: string;
     changedNode?: ExperienceTreeNode;
     changedValueType?: SelectedValueTypes;
 };

package/dist/utils/breakpoints.d.ts

@@ -1,4 +1,4 @@
-import { Breakpoint, PrimitiveValue, ValuesByBreakpoint } from '@contentful/experiences-validators';
+import { Breakpoint, PrimitiveValue, ValuesByBreakpoint, DesignValue } from '@contentful/experiences-validators';
 
 declare const MEDIA_QUERY_REGEXP: RegExp;
 declare const mediaQueryMatcher: (breakpoints: Breakpoint[]) => [{
@@ -9,5 +9,8 @@ declare const getActiveBreakpointIndex: (breakpoints: Breakpoint[], mediaQueryMa
 declare const getFallbackBreakpointIndex: (breakpoints: Breakpoint[]) => number;
 declare const isValidBreakpointValue: (value: PrimitiveValue) => value is Exclude<PrimitiveValue, undefined>;
 declare const getValueForBreakpoint: (valuesByBreakpoint: ValuesByBreakpoint | undefined, breakpoints: Breakpoint[], activeBreakpointIndex: number, fallbackBreakpointIndex: number, propertyName?: string, resolveDesignTokens?: boolean) => string | number | boolean | Record<any, any> | undefined;
+declare function mergeDesignValuesByBreakpoint(defaultValue: DesignValue, overwriteValue: DesignValue | undefined): DesignValue;
+declare function mergeDesignValuesByBreakpoint(defaultValue: DesignValue | undefined, overwriteValue: DesignValue): DesignValue;
+declare function mergeDesignValuesByBreakpoint(defaultValue: DesignValue | undefined, overwriteValue: DesignValue | undefined): DesignValue | undefined;
 
-export { MEDIA_QUERY_REGEXP, getActiveBreakpointIndex, getFallbackBreakpointIndex, getValueForBreakpoint, isValidBreakpointValue, mediaQueryMatcher };
+export { MEDIA_QUERY_REGEXP, getActiveBreakpointIndex, getFallbackBreakpointIndex, getValueForBreakpoint, isValidBreakpointValue, mediaQueryMatcher, mergeDesignValuesByBreakpoint };

package/dist/utils/isLinkToAsset.d.ts

@@ -1,5 +1,5 @@
 import { Link } from '../types.js';
 
-declare const isLinkToAsset: (variable: any) => variable is Link<"Asset">;
+declare const isLinkToAsset: (variable: unknown) => variable is Link<"Asset">;
 
 export { isLinkToAsset };

package/dist/utils/isLinkToEntry.d.ts

@@ -0,0 +1,5 @@
+import { Link } from '../types.js';
+
+declare const isLinkToEntry: (variable: unknown) => variable is Link<"Entry">;
+
+export { isLinkToEntry };

package/dist/utils/schema/experienceSchema.d.ts

@@ -0,0 +1,23 @@
+import { Experience, Link } from '../../types.js';
+
+/**
+ * Parses experience and extracts all leaf links that are referenced from the experience.
+ * PRECONDITION: Relies on the fact that entityStore is preloaded with all dataSource
+ * entries using include=2 (meaning that up to L3 entries are already preloaded into EntitStore).
+ *
+ * The function iterates over all entries in the entityStore (assuming they can be L1, L2, L3) and
+ * over all of their references. Any references that are NOT available in the entityStore are considered
+ * "leaf references" aka "leaf links" and are returned.
+ *
+ * The EntityStore happens to contain also entities representing patterns, which we do NOT consider
+ * as entries that point to leaf links. So we don't iterate over patterns only over entries which
+ * can be used for binding.
+ */
+declare const extractLeafLinksReferencedFromExperience: (experience: Experience) => {
+    assetLinks: Link<"Asset">[];
+    entryLinks: Link<"Entry">[];
+    assetIds: string[];
+    entryIds: string[];
+};
+
+export { extractLeafLinksReferencedFromExperience };

package/dist/utils/schema/references.d.ts

@@ -0,0 +1,18 @@
+import { Entry, UnresolvedLink } from 'contentful';
+
+type FnShouldFollowReferencesOfEntryField = (fieldName: string, entry: Entry) => boolean;
+declare const uniqueById: <T extends {
+    sys: {
+        id: string;
+    };
+}>(arr: Array<T>) => T[];
+/**
+ * Extracts all references from an entry.
+ * Handles both: reference and multi-reference fields.
+ * Returns unique array of references (even if they repeat within the entry).
+ */
+declare const referencesOf: (entry: Entry, fnShouldFollowReferencesOfEntryField?: FnShouldFollowReferencesOfEntryField) => UnresolvedLink<"Asset" | "Entry">[];
+declare function extractReferencesFromEntriesAsIds(entries: Array<Entry>): [string[], string[], string[]];
+declare function extractReferencesFromEntries(entries: Array<Entry>): [UnresolvedLink<'Entry'>[], UnresolvedLink<'Asset'>[], UnresolvedLink<'Entry' | 'Asset'>[]];
+
+export { type FnShouldFollowReferencesOfEntryField, extractReferencesFromEntries, extractReferencesFromEntriesAsIds, referencesOf, uniqueById };

package/dist/utils/typeguards.d.ts

@@ -1,6 +1,15 @@
 import { ExperienceEntry } from '../types.js';
-import { Entry } from 'contentful';
+import { Entry, Asset, UnresolvedLink } from 'contentful';
 
 declare const isExperienceEntry: (entry: ExperienceEntry | Entry) => entry is ExperienceEntry;
+declare const isPatternEntry: (entry: Entry | ExperienceEntry) => entry is ExperienceEntry;
+declare const isEntry: (value: unknown) => value is Entry;
+declare const isAsset: (value: unknown) => value is Asset;
+/**
+ * Checks if the values is an array of links.
+ * Note: we use convention where empty arrays are considered valid "arrays of links"
+ * as they don't contradict the type definition.
+ */
+declare const isArrayOfLinks: (value: unknown) => value is Array<UnresolvedLink<"Asset"> | UnresolvedLink<"Entry">>;
 
-export { isExperienceEntry };
+export { isArrayOfLinks, isAsset, isEntry, isExperienceEntry, isPatternEntry };

package/dist/utils/utils.d.ts

@@ -31,11 +31,6 @@ declare const checkIsAssemblyNode: ({ componentId, usedComponents, }: {
     componentId: string;
     usedComponents: ExperienceEntry["fields"]["usedComponents"];
 }) => boolean;
-/** @deprecated use `checkIsAssemblyNode` instead. Will be removed with SDK v5. */
-declare const checkIsAssembly: ({ componentId, usedComponents, }: {
-    componentId: string;
-    usedComponents: ExperienceEntry["fields"]["usedComponents"];
-}) => boolean;
 /**
  * This check assumes that the entry is already ensured to be an experience, i.e. the
  * content type of the entry is an experience type with the necessary annotations.
@@ -49,4 +44,4 @@ interface ParsedValue {
 declare function parseCSSValue(input: string): ParsedValue | null;
 declare function getTargetValueInPixels(targetWidthObject: ParsedValue): number;
 
-export { checkIsAssembly, checkIsAssemblyDefinition, checkIsAssemblyEntry, checkIsAssemblyNode, generateRandomId, getDataFromTree, getInsertionData, getTargetValueInPixels, parseCSSValue };
+export { checkIsAssemblyDefinition, checkIsAssemblyEntry, checkIsAssemblyNode, generateRandomId, getDataFromTree, getInsertionData, getTargetValueInPixels, parseCSSValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experiences-core",
-  "version": "1.42.3",
+  "version": "2.0.0-beta.0",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -70,11 +70,11 @@
     "vitest": "^2.1.1"
   },
   "dependencies": {
-    "@contentful/experiences-validators": "1.42.3",
+    "@contentful/experiences-validators": "2.0.0-beta.0",
     "@contentful/rich-text-types": "^17.0.0"
   },
   "peerDependencies": {
     "contentful": ">=10.6.0"
   },
-  "gitHead": "2e8c57075449792a63c61eec013b954985f187aa"
+  "gitHead": "a7120e1a627761937b699afea0a5b6c4961cfa00"
 }

package/dist/utils/entityTypeChecks.d.ts

@@ -1,6 +0,0 @@
-import { Asset, Entry } from 'contentful';
-
-declare const isAsset: (value: unknown) => value is Asset;
-declare const isEntry: (value: unknown) => value is Entry;
-
-export { isAsset, isEntry };