@sitecore-feaas/clientside 0.3.11-alpha.1 → 0.3.12

package/types/ui/FEAASExternal.d.ts

@@ -107,6 +107,9 @@ declare global {
             };
         }
     }
+    interface Window {
+        FEAASExternalComponents: RegisteredComponents;
+    }
 }
 export declare const getComponent: typeof FEAASExternal.getComponent, linkComponents: typeof FEAASExternal.linkComponents, registerComponent: typeof FEAASExternal.registerComponent;
 export { FEAASExternal as External };

package/types/ui/FEAASExternal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FEAASExternal.d.ts","sourceRoot":"","sources":["../../src/ui/FEAASExternal.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,QAAQ,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAE3E,OAAO,EAAa,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,UAAU,EAAY,MAAM,qBAAqB,CAAA;AAiB5G,oDAAoD;AACpD,eAAO,MAAM,qBAAqB;;;;CAI1B,CAAA;AAoCR,yGAAyG;AACzG,eAAO,MAAM,UAAU,aAAc,MAAM,SAAS,MAAM,cAAc,UAAU,CAAC,YAAY,CAAC,QAyB/F,CAAA;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,YAAY,GAAG,GAAG,CAK7D;AAED,wBAAgB,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,GAAG,CAUvF;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAChC,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,CAAA;AAEnG,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,YAAY,CAAC,kBAAkB,EAAE,YAAY,CAAC;IACvF,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAK;IAC5C,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAAC,OAAO,CAAA;IAC3C,IAAI;;;;IAIJ,MAAM;IAON,MAAM,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,EAAE,YAAY,GAAG,QAAQ;IASpE,QAAQ;IAIR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CAAC,iBAAiB,CACtB,SAAS,EAAE,KAAK,CAAC,aAAa,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,EAClF,OAAO,EAAE,wBAAwB;IAsBnC,MAAM,CAAC,uBAAuB;IAsC9B,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE;IAMzE,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,GAAG;IAI5D,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM;CAG/B;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,GAAG,CAAC;QACZ,UAAU,iBAAiB;YACzB,gBAAgB,EAAE;gBAChB,kBAAkB,EAAE,MAAM,CAAA;gBAC1B,QAAQ,CAAC,EAAE,GAAG,CAAA;gBACd,uBAAuB,CAAC,EAAE;oBAAE,MAAM,EAAE,MAAM,CAAA;iBAAE,CAAA;gBAC5C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aACnB,CAAA;YACD,oBAAoB,EAAE;gBACpB,wBAAwB,CAAC,EAAE,OAAO,CAAA;gBAClC,UAAU,EAAE,MAAM,CAAA;aACnB,CAAA;SACF;KACF;CACF;AAKD,eAAO,MAAQ,YAAY,qCAAE,cAAc,uCAAE,iBAAiB,wCAAkB,CAAA;AAChF,OAAO,EAAE,aAAa,IAAI,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"FEAASExternal.d.ts","sourceRoot":"","sources":["../../src/ui/FEAASExternal.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,QAAQ,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,YAAY,EAAgB,MAAM,+BAA+B,CAAA;AAC1E,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAE3E,OAAO,EAAa,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,UAAU,EAAY,MAAM,qBAAqB,CAAA;AAiB5G,oDAAoD;AACpD,eAAO,MAAM,qBAAqB;;;;CAI1B,CAAA;AAoCR,yGAAyG;AACzG,eAAO,MAAM,UAAU,aAAc,MAAM,SAAS,MAAM,cAAc,UAAU,CAAC,YAAY,CAAC,QAyB/F,CAAA;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,YAAY,GAAG,GAAG,CAK7D;AAED,wBAAgB,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,GAAG,CAUvF;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAChC,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,CAAA;AAEnG,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,YAAY,CAAC,kBAAkB,EAAE,YAAY,CAAC;IACvF,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAK;IAC5C,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAAC,OAAO,CAAA;IAC3C,IAAI;;;;IAIJ,MAAM;IAON,MAAM,CAAC,KAAK,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,EAAE,YAAY,GAAG,QAAQ;IASpE,QAAQ;IAIR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,MAAM,CAAC,iBAAiB,CACtB,SAAS,EAAE,KAAK,CAAC,aAAa,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,EAClF,OAAO,EAAE,wBAAwB;IAsBnC,MAAM,CAAC,uBAAuB;IAsC9B,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE;IAMzE,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,GAAG;IAI5D,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM;CAG/B;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,GAAG,CAAC;QACZ,UAAU,iBAAiB;YACzB,gBAAgB,EAAE;gBAChB,kBAAkB,EAAE,MAAM,CAAA;gBAC1B,QAAQ,CAAC,EAAE,GAAG,CAAA;gBACd,uBAAuB,CAAC,EAAE;oBAAE,MAAM,EAAE,MAAM,CAAA;iBAAE,CAAA;gBAC5C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aACnB,CAAA;YACD,oBAAoB,EAAE;gBACpB,wBAAwB,CAAC,EAAE,OAAO,CAAA;gBAClC,UAAU,EAAE,MAAM,CAAA;aACnB,CAAA;SACF;KACF;IACD,UAAU,MAAM;QACd,uBAAuB,EAAE,oBAAoB,CAAA;KAC9C;CACF;AAsBD,eAAO,MAAQ,YAAY,qCAAE,cAAc,uCAAE,iBAAiB,wCAAkB,CAAA;AAChF,OAAO,EAAE,aAAa,IAAI,QAAQ,EAAE,CAAA"}

package/types/ui/react.d.ts

@@ -1,4 +1,4 @@
-import { FEAASComponentProps, FEAASStylesheetProps } from './index.js';
+import { FEAASComponentProps, FEAASCDNStylesheetSource, FEAASCDNStylesheetParams } from './index.js';
 import React from 'react';
 import { renderHTMLContent, HTMLNode } from '../dom/html.js';
 export { renderHTMLContent };
@@ -14,19 +14,77 @@ export type FEAASReactComponentProps = FEAASComponentProps & {
     preload?: boolean;
     lastModified?: Date | string;
 };
-export declare const FEAASReactStylesheet: (props: FEAASStylesheetProps) => JSX.Element;
+/**
+ * A component to include a stylesheet using a <link> tag. Placing one in the HEAD ensures that there will be no flash
+ * of unstyled content.
+ *
+ * @param {FEAASCDNStylesheetParams | FEAASCDNStylesheetSource} props  - The properties for including the stylesheet.
+ * @returns {JSX.Element} The <link> element for the stylesheet.
+ */
+export declare const FEAASReactStylesheet: (props: FEAASCDNStylesheetParams | FEAASCDNStylesheetSource) => JSX.Element;
+/**
+ * An asynchronous wrapper over FEAAS.Component for use in React, especially suited for Next.js.
+ * This component fetches HTML and data asynchronously for server-side rendering with data mapping.
+ *
+ * @param {FEAASReactComponentProps} props  - The properties for the component.
+ * @returns {Promise<JSX.Element>} The JSX element representing the component.
+ */
 export declare const FEAASReactServerComponent: ({ ...props }: FEAASReactComponentProps) => Promise<JSX.Element>;
+/**
+ * A wrapper over FEAAS.Component for use in React. It converts a passed template HTML into React,
+ * allowing external components in the render tree. Data can be provided in JSON format.
+ *
+ * @param {FEAASReactComponentProps} props  - The properties for the component.
+ * @returns {JSX.Element} The JSX element representing the component.
+ */
 export declare function FEAASReactComponent({ data, ...props }: FEAASReactComponentProps): JSX.Element;
+/**
+ * A wrapper over External component that accepts a fallback for rendering in case of a missing component.
+ * It accepts properties in camelcase format and ensures no hydration errors on the client-side.
+ *
+ * @param {FEAASReactExternalComponentProps} props  - The properties for the component.
+ * @returns {JSX.Element} The JSX element representing the component.
+ */
 export declare function FEAASReactExternalComponent(props: FEAASReactExternalComponentProps): JSX.Element;
-/** Turn HTMLNode into React tree. It accepts callback to customize the behavior */
+/**
+ * Converts an HTMLNode into a React tree, ensuring proper context access for external components.
+ *
+ * @param {HTMLNode} node        - The HTML node to be converted.
+ * @param {any}      [callback]  - Callback to customize turning of HTML node into react tree.
+ * @param {any}      [key]       - The key for the React element.
+ * @returns {React.ReactNode} The resulting React node.
+ */
 export declare function HTMLNodeToReact(node: HTMLNode, callback?: (node: HTMLNode, attributes: Record<string, any>) => [tagName: any, attributes: Record<string, any>], key?: any): React.ReactNode;
+/**
+ * A special case of ExternalComponent designed for Next.js.
+ * It uses `next/dynamic` to control rendering on the client, server, or both.
+ *
+ * @param {FEAASReactExternalComponentProps} props  - The properties for the component.
+ * @returns {JSX.Element} The JSX element representing the component.
+ */
 export declare function FEAASNextExternalComponent(props: FEAASReactExternalComponentProps): JSX.Element;
+/**
+ * Enables Next.js client/server rendering options for registered components.
+ * The `component` argument should be a function exported from a file with a `use client` directive.
+ *
+ * @param {any} dynamic    - The Next dynamic function.
+ * @param {any} component  - The component function.
+ * @returns {any} Augmented bundle.
+ */
 export declare function enableNextClientsideComponents(dynamic: any, component: any): any;
+/**
+ * Renders a registered external component in a React tree.
+ *
+ * @param {FEAASReactExternalComponentProps} props  - The properties for the component.
+ * @returns {JSX.Element} The JSX element representing the component.
+ */
 export declare function FEAASExternalComponent(props: FEAASReactExternalComponentProps): JSX.Element;
+export declare function FEAASReactExternalComponentBundle(): JSX.Element;
+export declare const ExternalComponentBundle: typeof FEAASReactExternalComponentBundle;
 export declare const ExternalComponent: typeof FEAASExternalComponent;
 export declare const ReactExternalComponent: typeof FEAASReactExternalComponent;
 export declare const NextExternalComponent: typeof FEAASNextExternalComponent;
 export declare const Component: typeof FEAASReactComponent;
 export declare const ServerComponent: ({ ...props }: FEAASReactComponentProps) => Promise<JSX.Element>;
-export declare const Stylesheet: (props: FEAASStylesheetProps) => JSX.Element;
+export declare const Stylesheet: (props: FEAASCDNStylesheetParams | FEAASCDNStylesheetSource) => JSX.Element;
 //# sourceMappingURL=react.d.ts.map

package/types/ui/react.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/ui/react.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAMnB,oBAAoB,EACrB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAoB,MAAM,gBAAgB,CAAA;AAI9E,OAAO,EAAE,iBAAiB,EAAE,CAAA;AAC5B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,iBAAiB,EAAE,YAAY,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AACxH,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAE9B,MAAM,MAAM,gCAAgC,GAAG;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAA;AAE7G,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG;IAC3D,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,YAAY,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;CAC7B,CAAA;AAED,eAAO,MAAM,oBAAoB,UAAW,oBAAoB,gBAE/D,CAAA;AAED,eAAO,MAAM,yBAAyB,iBAAwB,wBAAwB,yBAarF,CAAA;AAED,wBAAgB,mBAAmB,CAAC,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,wBAAwB,eA8C/E;AAED,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,gCAAgC,eAwBlF;AAED,mFAAmF;AACnF,wBAAgB,eAAe,CAC7B,IAAI,EAAE,QAAQ,EACd,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAC/G,GAAG,CAAC,EAAE,GAAG,GACR,KAAK,CAAC,SAAS,CA+BjB;AAKD,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,gCAAgC,eAgBjF;AACD,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,OAI1E;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,gCAAgC,eAS7E;AAED,eAAO,MAAM,iBAAiB,+BAAyB,CAAA;AACvD,eAAO,MAAM,sBAAsB,oCAA8B,CAAA;AACjE,eAAO,MAAM,qBAAqB,mCAA6B,CAAA;AAC/D,eAAO,MAAM,SAAS,4BAAsB,CAAA;AAC5C,eAAO,MAAM,eAAe,iBAxKkC,wBAAwB,yBAwK9B,CAAA;AACxD,eAAO,MAAM,UAAU,UA7KqB,oBAAoB,gBA6KlB,CAAA"}
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/ui/react.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAMnB,wBAAwB,EACxB,wBAAwB,EAGzB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAoB,MAAM,gBAAgB,CAAA;AAI9E,OAAO,EAAE,iBAAiB,EAAE,CAAA;AAC5B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,iBAAiB,EAAE,YAAY,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAA;AACxH,cAAc,YAAY,CAAA;AAC1B,cAAc,gBAAgB,CAAA;AAE9B,MAAM,MAAM,gCAAgC,GAAG;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,GAAG,CAAC;IAAC,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAA;AAE7G,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG;IAC3D,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,YAAY,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;CAC7B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,UAAW,wBAAwB,GAAG,wBAAwB,gBAK9F,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,iBAAwB,wBAAwB,yBAarF,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,wBAAwB,eA8C/E;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,gCAAgC,eAwBlF;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,QAAQ,EACd,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAC/G,GAAG,CAAC,EAAE,GAAG,GACR,KAAK,CAAC,SAAS,CA+BjB;AAMD;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,gCAAgC,eAgBjF;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,OAI1E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,gCAAgC,eAM7E;AACD,wBAAgB,iCAAiC,gBAQhD;AAED,eAAO,MAAM,uBAAuB,0CAAoC,CAAA;AACxE,eAAO,MAAM,iBAAiB,+BAAyB,CAAA;AACvD,eAAO,MAAM,sBAAsB,oCAA8B,CAAA;AACjE,eAAO,MAAM,qBAAqB,mCAA6B,CAAA;AAC/D,eAAO,MAAM,SAAS,4BAAsB,CAAA;AAC5C,eAAO,MAAM,eAAe,iBA3NkC,wBAAwB,yBA2N9B,CAAA;AACxD,eAAO,MAAM,UAAU,UA1OqB,wBAAwB,GAAG,wBAAwB,gBA0OjD,CAAA"}