@kajoo-ai/sitecore-react 0.0.11 → 14.0.0

package/README.md

@@ -1,15 +1,33 @@
-# Introduction
-
-This project is an npm package for Kajoo & Kajoo Sitecore components.
-
-# Getting Started
-
-_This package requires React & ReactDOM greater than v17.0.1_
-
-`npm install `
-
-`yarn add`
-
-# Usage
-
-To import kajoo-sitecore-nextjs components: `import { ... } from '@kajoo-ai/sitecore-react`
+# Kajoo-ai Sitecore React Components
+
+## Introduction
+
+The Kajoo-ai Sitecore React components are a lightweight wrapper around the `@sitecore-jss/sitecore-jss-react` library. They are designed to provide a seamless integration with your Sitecore JSS React projects.
+
+## Compatibility
+
+Please ensure to use a version of this package that matches with your project's `@sitecore-jss/sitecore-jss-react` version. For instance, if your project is using `@sitecore-jss/sitecore-jss-react@14.x`, then you should use `@kajoo-ai/sitecore-react@14.x`.
+
+## Installation
+
+You can install the package using either npm or yarn:
+
+With npm:
+
+```sh
+npm install @kajoo-ai/sitecore-react
+```
+
+Or with yarn:
+
+```sh
+yarn add @kajoo-ai/sitecore-react
+```
+
+## Usage
+
+To utilize Kajoo Sitecore React components in your project, import the specific components you need:
+
+```js
+import { Text, Image } from "@kajoo-ai/sitecore-react";
+```

package/dist/cjs/components/button.d.ts

@@ -1,14 +1,11 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-import Link from "./link";
-type ITextField = {
-    value?: string | number;
-    editable?: string;
-};
-interface IButton {
-    text: ITextField | string;
-    link?: Parameters<typeof Link>[0]["href"];
-    [key: string]: unknown;
-}
-declare const Button: FC<IButton>;
-export default Button;
+import { FC } from "react";
+type ITextField = {
+    value?: string | number;
+    editable?: string;
+};
+interface IButton {
+    text: ITextField | string;
+    [key: string]: unknown;
+}
+declare const Button: FC<IButton>;
+export default Button;

package/dist/cjs/components/check-box.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export interface IProps {
-    className: string;
-    [key: string]: unknown;
-}
-declare const CheckBox: FC<IProps>;
-export default CheckBox;
+import { FC } from "react";
+export interface IProps {
+    className: string;
+    [key: string]: unknown;
+}
+declare const CheckBox: FC<IProps>;
+export default CheckBox;

package/dist/cjs/components/container.d.ts

@@ -1,13 +1,13 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export interface IProps {
-    bgImage?: {
-        value: {
-            src: string;
-        };
-    };
-    tag?: keyof JSX.IntrinsicElements;
-    [key: string]: any;
-}
-declare const Container: FC<IProps>;
-export default Container;
+import { FC, ReactNode } from 'react';
+export interface IProps {
+    bgImage?: {
+        value: {
+            src: string;
+        };
+    };
+    tag?: keyof JSX.IntrinsicElements;
+    [key: string]: any;
+    children: ReactNode | ReactNode[];
+}
+declare const Container: FC<IProps>;
+export default Container;

package/dist/cjs/components/drop-down/drop-down.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const Dropdown: FC<any>;
-export default Dropdown;
+import { FC } from "react";
+declare const Dropdown: FC<any>;
+export default Dropdown;

package/dist/cjs/components/drop-down/index.d.ts

@@ -1 +1 @@
-export { default } from './drop-down';
+export { default } from './drop-down';

package/dist/cjs/components/header.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const Header: FC<any>;
-export default Header;
+import { FC } from "react";
+declare const Header: FC<any>;
+export default Header;

package/dist/cjs/components/image.d.ts

@@ -1,17 +1,16 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-interface ImageFieldValue {
-    [attributeName: string]: unknown;
-    src?: string;
-    alt?: string;
-}
-interface ImageField {
-    value?: ImageFieldValue;
-    editable?: string;
-}
-export interface IProps {
-    src: ImageField | ImageFieldValue;
-    alt?: string;
-}
-declare const Image: FC<IProps>;
-export default Image;
+interface ImageFieldValue {
+    [attributeName: string]: unknown;
+    src?: string;
+    alt?: string;
+}
+interface ImageField {
+    value?: ImageFieldValue;
+    editable?: string;
+}
+export interface IProps {
+    src: ImageField | ImageFieldValue;
+    alt?: string;
+    srcSet?: string | any[];
+}
+declare const Image: ({ src, alt, srcSet: htmlSrcSet, ...rest }: IProps) => JSX.Element;
+export default Image;

package/dist/cjs/components/kajoo-component/index.d.ts

@@ -1 +1 @@
-export { default } from "./kajoo-component";
+export { default } from "./kajoo-component";

package/dist/cjs/components/kajoo-component/kajoo-component.d.ts

@@ -1,33 +1,33 @@
-/// <reference types="@types/react" />
-/// <reference types="react" resolution-mode="require"/>
-import { JsonObject } from "type-fest";
-export interface IProps {
-    component: ({ fields }: {
-        fields: JsonObject;
-    }) => JSX.Element;
-    datasource: IConsciaIntegration | IContentstackIntegration;
-    loadingComponent?: JSX.Element;
-    errorComponent?: JSX.Element;
-    emptyComponent?: JSX.Element;
-}
-export interface IContentstackIntegration {
-    provider: "contentstack";
-    hostUrl?: string;
-    apiKey: string;
-    deliveryToken: string;
-    language?: string;
-    branch?: string;
-    environment: string;
-    contentTypeUid: string;
-    entryUid: string;
-}
-export interface IConsciaIntegration {
-    provider: "conscia.ai";
-    hostUrl: string;
-    customerCode: string;
-    apiToken: string;
-    environment: string;
-    componentCode: string;
-}
-declare const KajooComponent: (props: IProps) => JSX.Element;
-export default KajooComponent;
+import React from 'react';
+import { JsonObject } from 'type-fest';
+export interface IProps {
+    component: ({ fields, children }: React.PropsWithChildren<{
+        fields: JsonObject;
+    }>) => JSX.Element;
+    datasource: IConsciaIntegration | IContentstackIntegration;
+    loadingComponent?: JSX.Element;
+    errorComponent?: JSX.Element;
+    emptyComponent?: JSX.Element;
+    children?: JSX.Element[];
+}
+export interface IContentstackIntegration {
+    provider: 'contentstack';
+    hostUrl?: string;
+    apiKey: string;
+    deliveryToken: string;
+    language?: string;
+    branch?: string;
+    environment: string;
+    contentTypeUid: string;
+    entryUid: string;
+}
+export interface IConsciaIntegration {
+    provider: 'conscia.ai';
+    hostUrl: string;
+    customerCode: string;
+    apiToken: string;
+    environment: string;
+    componentCode: string;
+}
+declare const KajooComponent: (props: IProps) => JSX.Element;
+export default KajooComponent;

package/dist/cjs/components/kajoo-component/services.d.ts

@@ -1,5 +1,5 @@
-import { IConsciaIntegration, IContentstackIntegration } from "./kajoo-component";
-export declare const contentstackService: {
-    getSingleEntry: (datasource: IContentstackIntegration) => Promise<any>;
-};
-export declare const queryComponent: (datasource: IConsciaIntegration) => Promise<any>;
+import { IConsciaIntegration, IContentstackIntegration } from "./kajoo-component";
+export declare const contentstackService: {
+    getSingleEntry: (datasource: IContentstackIntegration) => Promise<any>;
+};
+export declare const queryComponent: (datasource: IConsciaIntegration) => Promise<any>;

package/dist/cjs/components/label.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const Label: FC<any>;
-export default Label;
+import { FC } from "react";
+declare const Label: FC<any>;
+export default Label;

package/dist/cjs/components/linebreak.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export type IProps = JSX.IntrinsicElements["hr"];
-declare const Linebreak: FC<IProps>;
-export default Linebreak;
+import { FC } from "react";
+export type IProps = JSX.IntrinsicElements["hr"];
+declare const Linebreak: FC<IProps>;
+export default Linebreak;

package/dist/cjs/components/link.d.ts

@@ -1,14 +1,13 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-import { Link as SitecoreLink } from "@sitecore-jss/sitecore-jss-react";
-type ISitecoreLink = Parameters<typeof SitecoreLink>[0];
-type ITextField = {
-    value?: string | number;
-    editable?: string;
-};
-interface ILink extends Omit<ISitecoreLink, "field" | "href"> {
-    text?: ITextField | string;
-    href: ISitecoreLink["field"] | string;
-}
-declare const Link: FC<ILink>;
-export default Link;
+import { FC } from "react";
+import { Link as SitecoreLink } from "@sitecore-jss/sitecore-jss-react";
+type ISitecoreLink = Parameters<typeof SitecoreLink>[0];
+type ITextField = {
+    value?: string | number;
+    editable?: string;
+};
+interface ILink extends Omit<ISitecoreLink, "field" | "href"> {
+    text?: ITextField | string;
+    href: ISitecoreLink["field"] | string;
+}
+declare const Link: FC<ILink>;
+export default Link;

package/dist/cjs/components/list.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const List: FC<any>;
-export default List;
+import { FC } from "react";
+declare const List: FC<any>;
+export default List;

package/dist/cjs/components/paragraph.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const Paragraph: FC<any>;
-export default Paragraph;
+import { FC } from "react";
+declare const Paragraph: FC<any>;
+export default Paragraph;

package/dist/cjs/components/progress-bar.d.ts

@@ -1,7 +1,6 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export interface IProps {
-    className: string;
-}
-declare const ProgressBar: FC<IProps>;
-export default ProgressBar;
+import { FC } from "react";
+export interface IProps {
+    className: string;
+}
+declare const ProgressBar: FC<IProps>;
+export default ProgressBar;

package/dist/cjs/components/radio-button.d.ts

@@ -1,7 +1,6 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export interface IProps {
-    className: string;
-}
-declare const Radiobutton: FC<IProps>;
-export default Radiobutton;
+import { FC } from "react";
+export interface IProps {
+    className: string;
+}
+declare const Radiobutton: FC<IProps>;
+export default Radiobutton;

package/dist/cjs/components/repeater.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const Repeater: FC<any>;
-export default Repeater;
+import { FC } from "react";
+declare const Repeater: FC<any>;
+export default Repeater;

package/dist/cjs/components/rich-text.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const RichText: FC<any>;
-export default RichText;
+import { FC } from "react";
+declare const RichText: FC<any>;
+export default RichText;

package/dist/cjs/components/slider.d.ts

@@ -1,7 +1,6 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export interface IProps {
-    className: string;
-}
-declare const Slider: FC<IProps>;
-export default Slider;
+import { FC } from "react";
+export interface IProps {
+    className: string;
+}
+declare const Slider: FC<IProps>;
+export default Slider;

package/dist/cjs/components/text-area.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export type IProps = JSX.IntrinsicElements["textarea"];
-declare const Textarea: FC<IProps>;
-export default Textarea;
+import { FC } from "react";
+export type IProps = JSX.IntrinsicElements["textarea"];
+declare const Textarea: FC<IProps>;
+export default Textarea;

package/dist/cjs/components/text-input.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export type IProps = Omit<JSX.IntrinsicElements["input"], "type">;
-declare const Textinput: FC<IProps>;
-export default Textinput;
+import { FC } from "react";
+export type IProps = Omit<JSX.IntrinsicElements["input"], "type">;
+declare const Textinput: FC<IProps>;
+export default Textinput;

package/dist/cjs/components/text.d.ts

@@ -1,12 +1,11 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-export interface IProps {
-    text?: {
-        value?: string | number;
-        editable?: string;
-    } | string;
-    tag?: keyof JSX.IntrinsicElements;
-    [key: string]: any;
-}
-declare const Text: FC<IProps>;
-export default Text;
+import { FC } from 'react';
+export interface IProps {
+    text?: {
+        value?: string | number;
+        editable?: string;
+    } | string;
+    tag?: keyof JSX.IntrinsicElements;
+    [key: string]: any;
+}
+declare const Text: FC<IProps>;
+export default Text;

package/dist/cjs/components/toggle/index.d.ts

@@ -1 +1 @@
-export { default } from './toggle';
+export { default } from './toggle';

package/dist/cjs/components/toggle/toggle.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const Toggle: FC<any>;
-export default Toggle;
+import { FC } from "react";
+declare const Toggle: FC<any>;
+export default Toggle;

package/dist/cjs/components/type-form/index.d.ts

@@ -1 +1 @@
-export { default } from './type-form';
+export { default } from './type-form';

package/dist/cjs/components/type-form/type-form.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const TypeForm: FC<any>;
-export default TypeForm;
+import { FC } from 'react';
+declare const TypeForm: FC<any>;
+export default TypeForm;

package/dist/cjs/components/video.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@types/react" />
-import { FC } from "react";
-declare const Video: FC<any>;
-export default Video;
+import { FC } from "react";
+declare const Video: FC<any>;
+export default Video;

package/dist/cjs/factories/KajooLayoutFactory.d.ts

@@ -1,13 +1,12 @@
-/// <reference types="@types/react" />
-import { RouteData, LayoutServiceData } from "@sitecore-jss/sitecore-jss-react";
-import React from "react";
-interface ILayoutProps extends RouteData {
-    layoutData: LayoutServiceData;
-}
-type ILayout = React.FC<ILayoutProps>;
-export declare class KajooLayoutFactory {
-    private static readonly layoutsByName;
-    static getLayout: (route: RouteData) => ILayout;
-    static registerLayout: (name: string, layout: ILayout) => void;
-}
-export default KajooLayoutFactory;
+import { RouteData, LayoutServiceData } from "@sitecore-jss/sitecore-jss-react";
+import React from "react";
+interface ILayoutProps extends RouteData {
+    layoutData: LayoutServiceData;
+}
+type ILayout = React.FC<ILayoutProps>;
+export declare class KajooLayoutFactory {
+    private static readonly layoutsByName;
+    static getLayout: (route: RouteData) => ILayout;
+    static registerLayout: (name: string, layout: ILayout) => void;
+}
+export default KajooLayoutFactory;

package/dist/cjs/index.d.ts

@@ -1,37 +1,37 @@
-/**
- * Exported Components
- */
-export { default as Button } from "./components/button";
-export { default as Checkbox } from "./components/check-box";
-export { default as Container } from "./components/container";
-export { default as Dropdown } from "./components/drop-down";
-export { default as Header } from "./components/header";
-export { default as Image } from "./components/image";
-export { default as Label } from "./components/label";
-export { default as Linebreak } from "./components/linebreak";
-export { default as Link } from "./components/link";
-export { default as List } from "./components/list";
-export { default as Paragraph } from "./components/paragraph";
-export { default as ProgressBar } from "./components/progress-bar";
-export { default as Radiobutton } from "./components/radio-button";
-export { default as Slider } from "./components/slider";
-export { default as Textarea } from "./components/text-area";
-export { default as Textinput } from "./components/text-input";
-export { default as Toggle } from "./components/toggle";
-export { default as TypeForm } from "./components/type-form";
-export { default as Video } from "./components/video";
-export { default as Text } from "./components/text";
-export { default as RichText } from "./components/rich-text";
-export { default as Repeater } from "./components/repeater";
-export { default as KajooComponent } from "./components/kajoo-component";
-export { default as KajooLayoutFactory } from "./factories/KajooLayoutFactory";
-/**
- * Exported Types
- */
-export type { IProps as CheckboxProps } from "./components/check-box";
-export type { IProps as LinebreakProps } from "./components/linebreak";
-export type { IProps as RadiobuttonProps } from "./components/radio-button";
-export type { IProps as SliderProps } from "./components/slider";
-export type { IProps as TextareaProps } from "./components/text-area";
-export type { IProps as TextinputProps } from "./components/text-input";
-export type { IProps as KajooComponentProps } from "./components/kajoo-component/kajoo-component";
+/**
+ * Exported Components
+ */
+export { default as Button } from "./components/button";
+export { default as Checkbox } from "./components/check-box";
+export { default as Container } from "./components/container";
+export { default as Dropdown } from "./components/drop-down";
+export { default as Header } from "./components/header";
+export { default as Image } from "./components/image";
+export { default as Label } from "./components/label";
+export { default as Linebreak } from "./components/linebreak";
+export { default as Link } from "./components/link";
+export { default as List } from "./components/list";
+export { default as Paragraph } from "./components/paragraph";
+export { default as ProgressBar } from "./components/progress-bar";
+export { default as Radiobutton } from "./components/radio-button";
+export { default as Slider } from "./components/slider";
+export { default as Textarea } from "./components/text-area";
+export { default as Textinput } from "./components/text-input";
+export { default as Toggle } from "./components/toggle";
+export { default as TypeForm } from "./components/type-form";
+export { default as Video } from "./components/video";
+export { default as Text } from "./components/text";
+export { default as RichText } from "./components/rich-text";
+export { default as Repeater } from "./components/repeater";
+export { default as KajooComponent } from "./components/kajoo-component";
+export { default as KajooLayoutFactory } from "./factories/KajooLayoutFactory";
+/**
+ * Exported Types
+ */
+export type { IProps as CheckboxProps } from "./components/check-box";
+export type { IProps as LinebreakProps } from "./components/linebreak";
+export type { IProps as RadiobuttonProps } from "./components/radio-button";
+export type { IProps as SliderProps } from "./components/slider";
+export type { IProps as TextareaProps } from "./components/text-area";
+export type { IProps as TextinputProps } from "./components/text-input";
+export type { IProps as KajooComponentProps } from "./components/kajoo-component/kajoo-component";