@contentful/experiences-core 0.0.1-alpha.2

package/dist/utils/breakpoints.d.ts

@@ -0,0 +1,12 @@
+import { Breakpoint, ValuesByBreakpoint } from '@contentful/experiences-validators';
+
+declare const MEDIA_QUERY_REGEXP: RegExp;
+declare const mediaQueryMatcher: (breakpoints: Breakpoint[]) => [{
+    id: string;
+    signal: MediaQueryList;
+}[], Record<string, boolean>];
+declare const getActiveBreakpointIndex: (breakpoints: Breakpoint[], mediaQueryMatches: Record<string, boolean>, fallbackBreakpointIndex: number) => number;
+declare const getFallbackBreakpointIndex: (breakpoints: Breakpoint[]) => number;
+declare const getValueForBreakpoint: (valuesByBreakpoint: ValuesByBreakpoint, breakpoints: Breakpoint[], activeBreakpointIndex: number, variableName: string) => string | number | boolean | Record<any, any> | undefined;
+
+export { MEDIA_QUERY_REGEXP, getActiveBreakpointIndex, getFallbackBreakpointIndex, getValueForBreakpoint, mediaQueryMatcher };

package/dist/utils/components.d.ts

@@ -0,0 +1,4 @@
+declare const isContentfulStructureComponent: (componentId?: string) => boolean;
+declare const isEmptyStructureWithRelativeHeight: (children: number, componentId?: string, height?: string | number) => boolean;
+
+export { isContentfulStructureComponent, isEmptyStructureWithRelativeHeight };

package/dist/utils/domValues.d.ts

@@ -0,0 +1,15 @@
+type Rect = {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+};
+declare const findOutermostCoordinates: (first: Rect, second: Rect) => {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+};
+declare const getElementCoordinates: (element: Element) => DOMRect;
+
+export { findOutermostCoordinates, getElementCoordinates };

package/dist/utils/isLink.d.ts

@@ -0,0 +1,5 @@
+import { UnresolvedLink, Entry, Asset } from 'contentful';
+
+declare const isLink: (maybeLink: UnresolvedLink<'Entry' | 'Asset'> | Entry | Asset | string | unknown) => maybeLink is UnresolvedLink<"Entry" | "Asset">;
+
+export { isLink };

package/dist/utils/isLinkToAsset.d.ts

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

package/dist/utils/pathSchema.d.ts

@@ -0,0 +1,30 @@
+import { Entry, Asset } from 'contentful';
+
+/**
+ * This module encapsulates format of the path to a deep reference.
+ */
+
+type UnresolvedFieldset = Array<[null, string, string?]>;
+type Fieldset = Array<[Entry | Asset, string, string?]>;
+declare const parseDataSourcePathIntoFieldset: (path: string) => UnresolvedFieldset;
+/**
+ * Parse path into components, supports  L1 references (one reference follow) atm.
+ * @param path from data source. eg. `/uuid123/fields/image/~locale/fields/file/~locale`
+ *                               eg. `/uuid123/fields/file/~locale/fields/title/~locale`
+ * @returns
+ */
+declare const parseDataSourcePathWithL1DeepBindings: (path: string) => {
+    key: string;
+    field: string;
+    referentField: string;
+};
+/**
+ * Detects if paths is valid deep-path, like:
+ *  - /gV6yKXp61hfYrR7rEyKxY/fields/mainStory/~locale/fields/cover/~locale/fields/title/~locale
+ * or regular, like:
+ *  - /6J8eA60yXwdm5eyUh9fX6/fields/mainStory/~locale
+ * @returns
+ */
+declare const isDeepPath: (deepPathCandidate: string) => boolean;
+
+export { type Fieldset, type UnresolvedFieldset, isDeepPath, parseDataSourcePathIntoFieldset, parseDataSourcePathWithL1DeepBindings };

package/dist/utils/stylesUtils.d.ts

@@ -0,0 +1,20 @@
+import { CSSProperties, StyleProps, CompositionComponentNode } from '../types.js';
+import { PrimitiveValue } from '@contentful/experiences-validators';
+
+declare const buildStyleTag: ({ styles, nodeId }: {
+    styles: CSSProperties;
+    nodeId?: string | undefined;
+}) => string[];
+declare const buildCfStyles: ({ cfHorizontalAlignment, cfVerticalAlignment, cfFlexDirection, cfFlexWrap, cfMargin, cfPadding, cfBackgroundColor, cfWidth, cfHeight, cfMaxWidth, cfBorder, cfGap, cfBackgroundImageUrl, cfBackgroundImageAlignment, cfBackgroundImageScaling, cfFontSize, cfFontWeight, cfLineHeight, cfLetterSpacing, cfTextColor, cfTextAlign, cfTextTransform, cfTextBold, cfTextItalic, cfTextUnderline, cfColumnSpan, }: Partial<StyleProps>) => CSSProperties;
+/**
+ * Container/section default behaviour:
+ * Default height => height: EMPTY_CONTAINER_HEIGHT (120px)
+ * If a container component has children => height: 'fit-content'
+ */
+declare const calculateNodeDefaultHeight: ({ blockId, children, value, }: {
+    blockId?: string | undefined;
+    children: CompositionComponentNode['children'];
+    value: PrimitiveValue;
+}) => string | number | boolean | Record<any, any> | undefined;
+
+export { buildCfStyles, buildStyleTag, calculateNodeDefaultHeight };

package/dist/utils/supportedModes.d.ts

@@ -0,0 +1,5 @@
+import { InternalSDKMode } from '../types.js';
+
+declare const supportedModes: InternalSDKMode[];
+
+export { supportedModes };

package/dist/utils/transformers.d.ts

@@ -0,0 +1,24 @@
+import { Document } from '@contentful/rich-text-types';
+import { CSSProperties, StyleProps, ComponentDefinitionVariable } from '../types.js';
+import { Link } from 'contentful';
+import { PrimitiveValue } from '@contentful/experiences-validators';
+
+declare const transformFill: (value?: string) => string | undefined;
+declare const transformGridColumn: (span?: string) => CSSProperties;
+declare const transformBorderStyle: (value?: string) => CSSProperties;
+declare const transformAlignment: (cfHorizontalAlignment?: string, cfVerticalAlignment?: string, cfFlexDirection?: string) => CSSProperties;
+interface CSSPropertiesForBackground extends CSSProperties {
+    backgroundImage: string;
+    backgroundRepeat: 'repeat' | 'no-repeat';
+    backgroundSize?: 'cover' | 'contain';
+    backgroundPosition?: 'left top' | 'left center' | 'left bottom' | 'right top' | 'right center' | 'right bottom' | 'center top' | 'center center' | 'center bottom';
+}
+declare const transformBackgroundImage: (cfBackgroundImageUrl: string | null | undefined, cfBackgroundImageScaling?: StyleProps['cfBackgroundImageScaling'], cfBackgroundImageAlignment?: StyleProps['cfBackgroundImageAlignment']) => CSSPropertiesForBackground | undefined;
+declare const transformContentValue: (value: PrimitiveValue | Link<'Asset'>, variableDefinition: ComponentDefinitionVariable) => string | number | boolean | Document | Record<any, any> | Link<"Asset"> | undefined;
+declare const transformRichText: (value: PrimitiveValue) => Document | undefined;
+declare const transformWidthSizing: ({ value, cfMargin, }: {
+    value: string | undefined;
+    cfMargin: string | undefined;
+}) => string | undefined;
+
+export { transformAlignment, transformBackgroundImage, transformBorderStyle, transformContentValue, transformFill, transformGridColumn, transformRichText, transformWidthSizing };

package/dist/utils/typeguards.d.ts

@@ -0,0 +1,7 @@
+import { ExperienceEntry, Experience, DeprecatedExperience } from '../types.js';
+import { Entry } from 'contentful';
+
+declare const isExperienceEntry: (entry: ExperienceEntry | Entry) => entry is ExperienceEntry;
+declare const isDeprecatedExperience: (experience: Experience | DeprecatedExperience) => experience is DeprecatedExperience;
+
+export { isDeprecatedExperience, isExperienceEntry };

package/dist/utils/utils.d.ts

@@ -0,0 +1,46 @@
+import { CompositionTree, ExperienceEntry, ComponentDefinition, CompositionComponentNode, StyleProps } from '../types.js';
+import { Entry } from 'contentful';
+import { ExperienceDataSource, ExperienceUnboundValues } from '@contentful/experiences-validators';
+
+declare const getDataFromTree: (tree: CompositionTree) => {
+    dataSource: ExperienceDataSource;
+    unboundValues: ExperienceUnboundValues;
+};
+type GetInsertionDataParams = {
+    dropReceiverNode: CompositionComponentNode;
+    dropReceiverParentNode: CompositionComponentNode;
+    flexDirection?: StyleProps['cfFlexDirection'];
+    isMouseAtTopBorder: boolean;
+    isMouseAtBottomBorder: boolean;
+    isMouseInLeftHalf: boolean;
+    isMouseInUpperHalf: boolean;
+    isOverTopIndicator: boolean;
+    isOverBottomIndicator: boolean;
+};
+type InsertionData = {
+    node: CompositionComponentNode;
+    index: number;
+};
+/**
+ * Gets calculates the index to drop the dragged component based on the mouse position
+ * @returns {InsertionData} a object containing a node that will become a parent for dragged component and index at which it must be inserted
+ */
+declare const getInsertionData: ({ dropReceiverParentNode, dropReceiverNode, flexDirection, isMouseAtTopBorder, isMouseAtBottomBorder, isMouseInLeftHalf, isMouseInUpperHalf, isOverTopIndicator, isOverBottomIndicator, }: GetInsertionDataParams) => InsertionData;
+declare const generateRandomId: (letterCount: number) => string;
+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.
+ **/
+declare const checkIsAssemblyEntry: (entry: Entry) => boolean;
+declare const checkIsAssemblyDefinition: (component?: ComponentDefinition) => boolean;
+
+export { checkIsAssembly, checkIsAssemblyDefinition, checkIsAssemblyEntry, checkIsAssemblyNode, generateRandomId, getDataFromTree, getInsertionData };

package/dist/utils/validations.d.ts

@@ -0,0 +1,15 @@
+import { IncomingEvent } from '../types.js';
+
+type VisualEditorMessagePayload = {
+    source: string;
+    eventType: IncomingEvent;
+    payload: any;
+};
+declare const doesMismatchMessageSchema: (event: MessageEvent) => false | string;
+declare const tryParseMessage: (event: MessageEvent) => VisualEditorMessagePayload;
+declare const validateExperienceBuilderConfig: ({ locale, isEditorMode, }: {
+    locale: string;
+    isEditorMode: boolean;
+}) => void;
+
+export { type VisualEditorMessagePayload, doesMismatchMessageSchema, tryParseMessage, validateExperienceBuilderConfig };

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@contentful/experiences-core",
+  "version": "0.0.1-alpha.2",
+  "description": "",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/contentful/experience-builder.git"
+  },
+  "files": [
+    "readme.md",
+    "package.json",
+    "dist/**/*.*"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./constants": "./dist/constants.js"
+  },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/"
+  },
+  "typesVersions": {
+    "*": {
+      "types": [
+        "./dist/types.d.ts"
+      ],
+      "constants": [
+        "./dist/constants.d.ts"
+      ]
+    }
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "build": "rollup -c ./rollup.config.mjs",
+    "predev": "npm run clean",
+    "dev": "rollup -c ./rollup.config.mjs --watch --environment DEV",
+    "lint": "eslint src --ext '.ts,.tsx,.js,.jsx' --max-warnings 0 --ignore-path ../../.eslintignore",
+    "lint:fix": "eslint src --ext '.ts,.tsx,.js,.jsx' --fix",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "depcruise": "depcruise src"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/lodash-es": "^4.17.12",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
+    "@vitest/coverage-v8": "^1.0.4",
+    "contentful": "^10.6.4",
+    "eslint": "^8.54.0",
+    "happy-dom": "^13.3.8",
+    "rimraf": "^5.0.5",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-ts": "^3.4.5",
+    "vite-tsconfig-paths": "^4.2.2",
+    "vitest": "^1.0.4"
+  },
+  "dependencies": {
+    "@contentful/experiences-validators": "0.0.1-alpha.3",
+    "@contentful/rich-text-types": "^16.3.0"
+  },
+  "peerDependencies": {
+    "contentful": ">=10.6.0"
+  },
+  "gitHead": "ed1b56b4398d7aaff1b0ea40c14514fb3a2e3d09"
+}