@contentful/experiences-sdk-react 0.0.1-alpha.2

package/dist/src/index.d.ts

@@ -0,0 +1,19 @@
+export { ExperienceRoot } from './ExperienceRoot';
+export { useExperienceBuilder, useFetchExperience, useFetchById, useFetchBySlug } from './hooks';
+export { defineComponents } from './core/componentRegistry';
+export { calculateNodeDefaultHeight, 
+/** @deprecated use `checkIsAssemblyNode` instead. Will be removed with SDK v5. */
+checkIsAssembly, checkIsAssemblyNode, checkIsAssemblyEntry, defineDesignTokens, supportedModes, VisualEditorMode, fetchById, fetchBySlug, createExperience, } from '@contentful/experiences-core';
+export { 
+/** @deprecated use `CONTENTFUL_COMPONENTS.section.id` instead. This will be removed in version 4. */
+CONTENTFUL_SECTION_ID, 
+/** @deprecated use `CONTENTFUL_COMPONENTS.container.id` instead. This will be removed in version 4. */
+CONTENTFUL_CONTAINER_ID, CONTENTFUL_COMPONENTS, OUTGOING_EVENTS, INCOMING_EVENTS, CONTENTFUL_COMPONENT_CATEGORY, LATEST_SCHEMA_VERSION, CF_STYLE_ATTRIBUTES, 
+/** @deprecated use `ASSEMBLY_BLOCK_NODE_TYPE` instead. This will be removed in version 5. */
+DESIGN_COMPONENT_BLOCK_NODE_TYPE, 
+/** @deprecated use `ASSEMBLY_NODE_TYPE` instead. This will be removed in version 5. */
+DESIGN_COMPONENT_NODE_TYPE, 
+/** @deprecated use `ASSEMBLY_NODE_TYPES` instead. This will be removed in version 5. */
+DESIGN_COMPONENT_NODE_TYPES, ASSEMBLY_BLOCK_NODE_TYPE, ASSEMBLY_NODE_TYPE, ASSEMBLY_NODE_TYPES, SCROLL_STATES, } from '@contentful/experiences-core/constants';
+export type { InternalSDKMode, ExternalSDKMode, ComponentDefinition, } from '@contentful/experiences-core/types';
+export { EntityStore } from '@contentful/experiences-core';

package/dist/src/sdkVersion.d.ts

@@ -0,0 +1 @@
+export declare const SDK_VERSION = "0.0.1-alpha.1";

package/dist/src/utils/withComponentWrapper.d.ts

@@ -0,0 +1,36 @@
+import { ComponentRegistration } from '@contentful/experiences-core/types';
+import React from 'react';
+interface CFProps {
+    /**
+     * Classes to be applied to the container component if `wrapComponent` is true, or directly to the child component if false.
+     */
+    className?: string;
+    /**
+     * Classes to be applied to the child component if `wrapComponent` is true, or directly to the child component if false.
+     */
+    classes?: string;
+    onMouseDown?: React.MouseEventHandler;
+    onMouseUp?: React.MouseEventHandler;
+    onClick?: React.MouseEventHandler;
+    /**
+     * Prop required by Experience Builder to identify the component.
+     */
+    'data-cf-node-id'?: string;
+    /**
+     * Prop required by Experience Builder to identify the component.
+     */
+    'data-cf-node-block-id'?: string;
+    /**
+     * Prop required by Experience Builder to identify the component's type.
+     */
+    'data-cf-node-block-type'?: string;
+}
+/**
+ * Sets up a component to be consumed by Experience Builder. This function can be used to wrap a component with a container component, or to pass props to the component directly.
+ * @param Component Component to be used by Experience Builder.
+ * @param options Options for the `withComponentWrapper` function.
+ * @default { wrapComponent: true, wrapContainerTag: 'div' }
+ * @returns A component that can be passed to `defineComponents`.
+ */
+export declare function withComponentWrapper<T extends object>(Component: React.ElementType<T>, options?: ComponentRegistration['options']): ({ classes, className, "data-cf-node-id": dataCfNodeId, "data-cf-node-block-id": dataCfNodeBlockId, "data-cf-node-block-type": dataCfNodeBlockType, onClick, onMouseDown, onMouseUp, ...props }: CFProps & T) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/src/utils/withComponentWrapper.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/__fixtures__/assembly.d.ts

@@ -0,0 +1,96 @@
+import type { CompositionComponentNode, SchemaVersions } from '@contentful/experiences-core/types';
+type createAssemblyEntryArgs = {
+    schemaVersion: SchemaVersions;
+    id: string;
+};
+export declare const defaultAssemblyId = "assembly-id";
+export declare const assemblyGeneratedVariableName = "text_uuid1Assembly";
+export declare const createAssemblyEntry: ({ schemaVersion, id, }: createAssemblyEntryArgs) => {
+    sys: {
+        id: string;
+        type: string;
+        contentType: {
+            sys: {
+                id: string;
+                type: string;
+                linkType: string;
+            };
+        };
+        createdAt: string;
+        updatedAt: string;
+        revision: number;
+        space: {
+            sys: {
+                type: string;
+                linkType: string;
+                id: string;
+            };
+        };
+        environment: {
+            sys: {
+                type: string;
+                linkType: string;
+                id: string;
+            };
+        };
+    };
+    metadata: {
+        tags: never[];
+    };
+    fields: {
+        title: string;
+        slug: string;
+        componentTree: {
+            children: {
+                definitionId: string;
+                variables: {};
+                children: {
+                    definitionId: string;
+                    variables: {
+                        text: {
+                            key: string;
+                            type: string;
+                        };
+                    };
+                    children: never[];
+                }[];
+            }[];
+            breakpoints: {
+                id: string;
+                query: string;
+                previewSize: string;
+                displayName: string;
+            }[];
+            schemaVersion: "2023-09-28" | "2023-08-23" | "2023-07-26" | "2023-06-27";
+        };
+        dataSource: {};
+        unboundValues: {
+            unbound_uuid1Assembly: {
+                value: string;
+            };
+        };
+        componentSettings: {
+            variableDefinitions: {
+                text_uuid1Assembly: {
+                    displayName: string;
+                    name: string;
+                    type: string;
+                    defaultValue: {
+                        type: string;
+                        key: string;
+                    };
+                    required: boolean;
+                };
+            };
+        };
+    };
+};
+type createAssemblyNodeArgs = {
+    id: string;
+    blockId?: string;
+    unboundValue?: string;
+    unboundValueKey?: string;
+    boundValueKey?: string;
+};
+export declare const createAssemblyNode: ({ id, blockId, unboundValue, unboundValueKey, boundValueKey, }: createAssemblyNodeArgs) => CompositionComponentNode;
+export {};

package/dist/test/__fixtures__/composition.d.ts

@@ -0,0 +1,7 @@
+import type { ExperienceEntry, SchemaVersions } from '@contentful/experiences-core/types';
+export declare const compositionEntry: ExperienceEntry;
+type createCompositionEntryArgs = {
+    schemaVersion: SchemaVersions;
+};
+export declare const createCompositionEntry: ({ schemaVersion, }: createCompositionEntryArgs) => ExperienceEntry;
+export {};

package/dist/test/__fixtures__/entities.d.ts

@@ -0,0 +1,9 @@
+import { Asset, Entry } from 'contentful';
+export declare const entityIds: {
+    ENTRY1: string;
+    ENTRY2: string;
+    ASSET1: string;
+};
+export declare const entries: Entry[];
+export declare const assets: Asset[];
+export declare const entities: Array<Entry | Asset>;

package/dist/test/components/Test.d.ts

@@ -0,0 +1 @@
+export declare const Test: () => import("react/jsx-runtime").JSX.Element;

package/dist/test/components/Test.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@contentful/experiences-sdk-react",
+  "version": "0.0.1-alpha.2",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "typings": "./dist/src/index.d.ts",
+  "type": "module",
+  "author": "Contentful GmbH",
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "predev": "npm run clean",
+    "dev": "rollup -c ./rollup.config.mjs --watch --environment DEV",
+    "prepare": "node ./bin/injectSDKVersion.cjs",
+    "prebuild": "npm run clean && node ./bin/injectSDKVersion.cjs",
+    "build": "rollup -c rollup.config.mjs",
+    "watch": "vite build --watch",
+    "test": "NODE_ENV=test jest",
+    "test:watch": "NODE_ENV=test jest --watch",
+    "test:coverage": "NODE_ENV=test jest --coverage --maxWorkers 2",
+    "tsc": "tsc --noEmit",
+    "lint": "eslint ./src --ext '.ts,.tsx,.js,.jsx'",
+    "presemantic-release": "npm run build",
+    "semantic-release": "semantic-release",
+    "prettier:check": "prettier --check '**/*.{jsx,js,ts,tsx,css}'",
+    "prettier": "prettier --write '**/*.{jsx,js,ts,tsx,css}'",
+    "preview": "vite preview",
+    "depcruise": "depcruise src"
+  },
+  "dependencies": {
+    "@contentful/experiences-components-react": "0.0.1-alpha.2",
+    "@contentful/experiences-core": "0.0.1-alpha.2",
+    "@contentful/experiences-visual-editor-react": "0.0.1-alpha.2",
+    "@contentful/rich-text-types": "^16.2.1",
+    "classnames": "^2.3.2",
+    "csstype": "^3.1.2",
+    "immer": "^10.0.3",
+    "lodash-es": "^4.17.21",
+    "md5": "^2.3.0",
+    "style-inject": "^0.3.0",
+    "vite-plugin-css-injected-by-js": "^3.1.1"
+  },
+  "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",
+    "@semantic-release/changelog": "^6.0.3",
+    "@testing-library/jest-dom": "^6.1.4",
+    "@testing-library/react": "^14.0.0",
+    "@testing-library/user-event": "^14.4.3",
+    "@types/jest": "^29.5.6",
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^20.11.10",
+    "@types/react": "^18.0.28",
+    "@types/react-dom": "^18.0.11",
+    "@vitejs/plugin-react": "^4.2.1",
+    "@vitejs/plugin-react-swc": "^3.0.0",
+    "contentful": "^10.6.14",
+    "husky": "^9.0.10",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
+    "jsdom": "^24.0.0",
+    "postcss-import": "^15.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "relative-deps": "^1.0.7",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-node-externals": "^7.0.1",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-postcss": "^4.0.2",
+    "semantic-release": "23.0.2",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.2.2",
+    "vite": "^4.3.9",
+    "vite-plugin-dts": "^3.6.1",
+    "vite-plugin-svgr": "^4.1.0"
+  },
+  "peerDependencies": {
+    "contentful": ">=10.6.0",
+    "react": ">=16.0.0",
+    "react-dom": ">=16.0.0"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "gitHead": "ed1b56b4398d7aaff1b0ea40c14514fb3a2e3d09"
+}