@foris/avocado-not-front 0.6.0 → 0.8.0

package/dist/components/breadcrumbs/Breadcrumbs.d.ts

@@ -0,0 +1,11 @@
+import { BreadcrumbsNotFrontProps } from '../../types';
+/**
+ * Extended props for NotFront Breadcrumbs component.
+ * Includes context identifiers for the userFlow and pageId.
+ */
+interface BreadcrumbsNotFrontExtendedProps extends BreadcrumbsNotFrontProps {
+    userFlow: string;
+    pageId: string;
+}
+declare const BreadcrumbsNotFront: ({ userFlow, items, responseKey, }: BreadcrumbsNotFrontExtendedProps) => JSX.Element;
+export default BreadcrumbsNotFront;

package/dist/components/checkbox/Checkbox.d.ts

@@ -0,0 +1,12 @@
+import type { FC } from 'react';
+import { CheckboxNotFrontProps } from '../../types';
+/**
+ * Extended props for NotFront Checkbox component.
+ * Includes context identifiers for the userFlow and pageId.
+ */
+interface CheckboxNotFrontExtendedProps extends CheckboxNotFrontProps {
+    userFlow: string;
+    pageId: string;
+}
+declare const CheckboxNotFront: FC<CheckboxNotFrontExtendedProps>;
+export default CheckboxNotFront;

package/dist/components/index.d.ts

@@ -1,8 +1,10 @@
 import Body from './body/Body';
+import Breadcrumbs from './breadcrumbs/Breadcrumbs';
 import Button from './button/Button';
+import Checkbox from './checkbox/Checkbox';
 import CodeEditor from './code-editor/CodeEditor';
 import ContentWrapper from './content-wrapper/ContentWrapper';
 import Header from './header/Header';
 import Select from './select';
 import TextField from './text-field/TextField';
-export { Body, Button, CodeEditor, ContentWrapper, Header, Select, TextField };
+export { Body, Breadcrumbs, Button, Checkbox, CodeEditor, ContentWrapper, Header, Select, TextField, };

package/dist/components/select/select.util.d.ts

@@ -7,6 +7,14 @@
  * @returns A string with the full URL including query parameters.
  */
 export declare const buildPaginatedURL: (baseUrl: string, search: string, page: number) => string;
+/**
+ * Converts an object of key-value pairs into a URI-encoded query string.
+ *
+ * @param {Record<string, any>} params - An object where keys and values represent query parameters.
+ *                                       Values that are `null` or `undefined` will be skipped.
+ * @returns {string} A properly URI-encoded query string (e.g., "key1=value1&key2=value2").
+ */
+export declare const buildQueryString: (params: Record<string, any>) => string;
 /**
  * Extracts and transforms a list of options from a JSON response using JSONPath expressions.
  *

package/dist/hooks/builder/usePage.d.ts

@@ -1,4 +1,4 @@
-import { ApiConfig, Page } from '../../types';
+import { ApiConfig, PageContent } from '../../types';
 /**
  * Custom hook to manage page rendering based on API or provided JSON configuration.
  *
@@ -6,4 +6,4 @@ import { ApiConfig, Page } from '../../types';
  * @param jsonPage - Optional page configuration object.
  * @returns JSX content to render the page (header and body).
  */
-export declare const usePage: (userFlow: string, apiConfig: ApiConfig, jsonPage?: Page | null) => JSX.Element;
+export declare const usePage: (userFlow: string, apiConfig: ApiConfig, jsonPage?: PageContent | null) => JSX.Element;

package/dist/hooks/useAction.d.ts

@@ -1,10 +1,11 @@
 import { AxiosResponse } from 'axios';
 import { NotFrontDataSource } from '../types/componentsCore.type';
+import { NextUIResponseData } from '../types/builder.type';
 /**
  * Custom hook that encapsulates actions related to navigation and data fetching for dynamic UI flows.
  */
 export declare const useAction: () => {
-    getNextUI: (userFlow: string, pageId: string, entries: any, responseKey: string) => Promise<AxiosResponse<any, any>>;
+    getNextUI: (userFlow: string, pageHash: string, entries: any, responseKey: string) => Promise<AxiosResponse<NextUIResponseData, any>>;
     fetchDataSource: (dataSource: NotFrontDataSource) => Promise<AxiosResponse<any, any> | undefined>;
-    fetchAndGetNextUI: (userFlow: string, pageId: string, entries: any, responseKey: string, dataSource: NotFrontDataSource) => Promise<AxiosResponse<any, any> | undefined>;
+    fetchAndGetNextUI: (userFlow: string, pageHash: string, entries: any, responseKey: string, dataSource: NotFrontDataSource) => Promise<AxiosResponse<NextUIResponseData, any> | undefined>;
 };

package/dist/store/useStore.d.ts

@@ -1,7 +1,7 @@
-import type { ApiConfig, Page } from '../types/builder.type';
+import type { ApiConfig, NextUIResponseData, PageContent } from '../types/builder.type';
 export type NotFrontStore = Record<string, UserFlow>;
 export type PageStore = {
-    page?: Page | null;
+    page?: PageContent | null;
 };
 export type UserFlow = {
     apiConfig: ApiConfig;
@@ -10,8 +10,8 @@ export type UserFlow = {
     pages: Record<string, PageStore>;
 };
 export declare const useStore: import("zustand").UseBoundStore<import("zustand").StoreApi<NotFrontStore>>;
-export declare const setNotFrontStore: (userFlowId: string, pageId: string, apiConfig: ApiConfig, page: Page | null) => void;
-export declare const setPage: (userFlow: string, page: Page) => void;
+export declare const setNotFrontStore: (userFlowId: string, apiConfig: ApiConfig, page: PageContent) => void;
+export declare const setPage: (userFlow: string, response: NextUIResponseData) => void;
 /**
  * Updates the `entries` object of a specific userFlow in the store.
  *

package/dist/types/builder.type.d.ts

@@ -1,4 +1,5 @@
 import { NotFrontComponent } from './components.type';
+import { NotFrontDataSource } from './componentsCore.type';
 /**
  * Interface for the configuration required to interact with the API.
  * This interface includes the necessary details for the API connection.
@@ -49,7 +50,8 @@ export interface ObjectNotFront {
  * Interface for the page data used in the NotFront system.
  * Contains a collection of components, a hash for caching, a title, and optional header and body objects.
  */
-export interface Page {
+export type PageContent = {
+    type: 'page';
     /**
      * A collection of components to be rendered in the page.
      * These components make up the structure of the page content.
@@ -60,11 +62,6 @@ export interface Page {
      * Used for caching and page state management.
      */
     hash: string;
-    /**
-     * The title of the page, displayed as the main header.
-     * This is typically used for the page's title in the browser.
-     */
-    title: string;
     /**
      * An optional header object containing its components and properties.
      * If not provided, the page will not render a header section.
@@ -75,4 +72,15 @@ export interface Page {
      * If not provided, the page will not render a body section.
      */
     body?: ObjectNotFront | null;
+};
+export type FetchContent = {
+    type: 'fetch';
+    hash: string;
+    responseKey: string;
+    dataSource: NotFrontDataSource;
+};
+export interface NextUIResponseData {
+    content: PageContent | FetchContent;
+    deprecatedStateKeys: string[];
+    sessionId: string;
 }

package/dist/types/components.type.d.ts

@@ -1,5 +1,40 @@
-import { ButtonProps, CardNotificationProps, HeadingProps, SelectProps, TextFieldProps, TextProps } from '../../../avocado-suite';
+import { ButtonProps, CardNotificationProps, HeadingProps, SelectProps, TextFieldProps, TextProps, CheckboxProps } from '../../../avocado-suite';
 import { NotFrontActionType, NotFrontBaseProps, NotFrontDataSource, NotFrontDataSourceSelect } from './componentsCore.type';
+/**
+ * Represents a single breadcrumb item for the NotFront component
+ */
+export interface BreadcrumbsItemNotFront {
+    /**
+     * Visible label of the breadcrumb item.
+     */
+    title: string;
+    /**
+     * Type of action to be triggered when the breadcrumb is clicked.
+     */
+    actionType: NotFrontActionType;
+    /**
+     * Optional URL to redirect the user when the breadcrumb is clicked.
+     * Used only if `actionType` is `REDIRECT`.
+     */
+    redirectUrl: string;
+    /**
+     * Unique page identifier associated with this breadcrumb
+     */
+    hashCode: string;
+}
+/**
+ * Interface for the props used in the ButtonNotFrontProps component.
+ */
+export interface BreadcrumbsNotFrontProps extends NotFrontBaseProps {
+    /**
+     * Identifier to specify that this is a breadcrumbs component.
+     */
+    component: 'breadcrumbs';
+    /**
+     * List of breadcrumb items to render in order.
+     */
+    items: BreadcrumbsItemNotFront[];
+}
 /**
  * Interface for the props used in the ButtonNotFrontProps component.
  */
@@ -27,6 +62,28 @@ export interface ButtonNotFrontProps extends NotFrontBaseProps, ButtonProps {
      */
     redirectUrl: string;
 }
+/**
+ * Interface for the props used in the CheckboxNotFront component.
+ */
+export interface CheckboxNotFrontProps extends NotFrontBaseProps, CheckboxProps {
+    component: 'checkbox';
+    /**
+     * Defines the action triggered when the button is clicked.
+     */
+    actionType: NotFrontActionType;
+    /**
+     * The text label displayed next to the checkbox.
+     */
+    label: string;
+    /**
+     * Indicates if the checkbox input is mandatory.
+     */
+    required: boolean;
+    /**
+     * Determines if the checkbox is initially checked.
+     */
+    value: boolean;
+}
 /**
  * Interface for the props used in the CardNotificationNotFront component.
  */
@@ -103,6 +160,10 @@ export interface SelectNotFrontProps extends NotFrontBaseProps, SelectProps {
      * Indicates whether the component is mandatory.
      */
     required: boolean;
+    /**
+     * Support multiple selected options
+     */
+    isMulti: boolean;
 }
 /**
  * Interface for the props used in the TextNotFront component.
@@ -128,13 +189,15 @@ export interface TextFieldNotFrontProps extends NotFrontBaseProps, TextFieldProp
 /**
  * Union type representing all possible NotFront component prop types.
  */
-export type NotFrontComponent = ButtonNotFrontProps | CardNotificationNotFrontProps | CodeEditorNotFrontProps | HeadingNotFrontProps | SelectNotFrontProps | TextNotFrontProps | TextFieldNotFrontProps;
+export type NotFrontComponent = BreadcrumbsNotFrontProps | ButtonNotFrontProps | CardNotificationNotFrontProps | CheckboxNotFrontProps | CodeEditorNotFrontProps | HeadingNotFrontProps | SelectNotFrontProps | TextFieldNotFrontProps | TextNotFrontProps;
 /**
  * Mapping of component identifiers (as strings) to their corresponding prop types.
  */
 export type NotFrontComponentTypeMap = {
+    breadcrumbs: BreadcrumbsNotFrontProps;
     button: ButtonNotFrontProps;
     cardNotification: CardNotificationNotFrontProps;
+    checkbox: CheckboxNotFrontProps;
     code: CodeEditorNotFrontProps;
     heading: HeadingNotFrontProps;
     select: SelectNotFrontProps;

package/dist/types/componentsCore.type.d.ts

@@ -13,6 +13,7 @@ export interface NotFrontDataSource {
     url: string;
 }
 export interface NotFrontDataSourceSelect extends NotFrontDataSource {
+    params: any;
     jsonPathOptions: string;
     jsonPathLabel: string;
     jsonPathValue?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foris/avocado-not-front",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "publishConfig": {
     "access": "public"
   },
@@ -31,7 +31,7 @@
     "zustand": "4.5.4",
     "@foris/avocado-core": "0.10.0",
     "@foris/avocado-icons": "1.13.0",
-    "@foris/avocado-suite": "0.32.1"
+    "@foris/avocado-suite": "0.33.0"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "6.4.0",