@constructor-io/constructorio-ui-autocomplete 1.18.1 → 1.19.0

package/lib/mjs/hooks/useFetchRecommendationPod.js

@@ -5,7 +5,10 @@ const useFetchRecommendationPod = (cioClient, recommendationPods) => {
         if (!cioClient || !Array.isArray(recommendationPods) || recommendationPods.length === 0)
             return;
         const fetchRecommendationResults = async () => {
-            const responses = await Promise.all(recommendationPods.map(({ identifier: podId, ...parameters }) => cioClient.recommendations.getRecommendations(podId, parameters)));
+            const responses = await Promise.all(recommendationPods.map(({ podId, indexSectionName, ...parameters }) => cioClient.recommendations.getRecommendations(podId, {
+                ...parameters,
+                section: indexSectionName,
+            })));
             const recommendationPodResults = {};
             responses.forEach(({ response }, index) => {
                 const { pod, results } = response;
@@ -13,7 +16,7 @@ const useFetchRecommendationPod = (cioClient, recommendationPods) => {
                     recommendationPodResults[pod.id] = results?.map((item) => ({
                         ...item,
                         id: item?.data?.id,
-                        section: recommendationPods[index]?.section || 'Products',
+                        section: recommendationPods[index]?.indexSectionName,
                         podId: pod.id,
                     }));
                 }

package/lib/mjs/hooks/useRecommendationsObserver.js

@@ -1,4 +1,5 @@
 import { useEffect } from 'react';
+import { isRecommendationsSection } from '../typeGuards';
 /**
  * Custom hook that observes the visibility of recommendation sections and calls trackRecommendationView event.
  * This is done by using the IntersectionObserver API to observe the visibility of each recommendation section.
@@ -14,7 +15,7 @@ import { useEffect } from 'react';
 function useRecommendationsObserver(menuIsOpen, sections, constructorIO, trackRecommendationView) {
     // Get refs for each section
     const refs = sections
-        .filter((section) => section.type === 'recommendations')
+        .filter((section) => isRecommendationsSection(section))
         .map((section) => section.ref);
     useEffect(() => {
         const intersectionObserverOptions = {

package/lib/mjs/hooks/useSections.js

@@ -3,14 +3,15 @@ import { createRef, useEffect, useMemo, useRef, useState } from 'react';
 import { getActiveSectionsWithData } from '../utils';
 import useDebouncedFetchSection from './useDebouncedFetchSections';
 import useFetchRecommendationPod from './useFetchRecommendationPod';
+import { isAutocompleteSection, isRecommendationsSection } from '../typeGuards';
 export default function useSections(query, cioClient, sections, zeroStateSections, advancedParameters) {
     const zeroStateActiveSections = !query.length && zeroStateSections;
     // Define All Sections
     const activeSections = zeroStateActiveSections ? zeroStateSections : sections;
     const sectionsRefs = useRef(activeSections.map(() => createRef()));
     const [activeSectionsWithData, setActiveSectionsWithData] = useState([]);
-    const autocompleteSections = useMemo(() => activeSections?.filter((config) => config.type === 'autocomplete' || !config.type), [activeSections]);
-    const recommendationsSections = useMemo(() => activeSections?.filter((config) => config.type === 'recommendations'), [activeSections]);
+    const autocompleteSections = useMemo(() => activeSections?.filter((config) => isAutocompleteSection(config)), [activeSections]);
+    const recommendationsSections = useMemo(() => activeSections?.filter((config) => isRecommendationsSection(config)), [activeSections]);
     // Fetch Autocomplete Results
     const { sectionsData: autocompleteResults, request } = useDebouncedFetchSection(query, cioClient, autocompleteSections, advancedParameters);
     // Fetch Recommendations Results

package/lib/mjs/typeGuards.js

@@ -8,5 +8,11 @@ export function isInGroupSuggestion(item) {
     return item.groupName !== undefined;
 }
 export function isCustomSection(config) {
-    return config.data !== undefined;
+    return config.type === 'custom';
+}
+export function isAutocompleteSection(config) {
+    return config.type === 'autocomplete' || !config.type;
+}
+export function isRecommendationsSection(config) {
+    return config.type === 'recommendations';
 }

package/lib/mjs/utils.js

@@ -1,5 +1,5 @@
 import ConstructorIOClient from '@constructor-io/constructorio-client-javascript';
-import { isCustomSection } from './typeGuards';
+import { isRecommendationsSection } from './typeGuards';
 import version from './version';
 export function getSearchSuggestionFeatures(request) {
     let featureDisplaySearchSuggestionImages = false;
@@ -35,6 +35,11 @@ export const camelToStartCase = (camelCaseString) => camelCaseString
     .replace(/([A-Z])/g, ' $1')
     // uppercase the first character
     .replace(/^./, (str) => str.toUpperCase());
+export const toKebabCase = (str) => str
+    .replace(/([A-Z])([A-Z][a-z])/g, '$1-$2')
+    .replace(/([a-z])([A-Z])/g, '$1-$2')
+    .replace(/[\s_]+/g, '-')
+    .toLowerCase();
 export function isTrackingRequestSent(trackingRequestUrl) {
     // eslint-disable-next-line
     const trackingRequestsQueue = window.localStorage?._constructorio_requests;
@@ -110,17 +115,22 @@ export const getCioClient = (apiKey, cioJsClientOptions) => {
 export const getActiveSectionsWithData = (activeSections, sectionResults, sectionsRefs) => {
     const activeSectionsWithData = [];
     activeSections?.forEach((sectionConfig, index) => {
-        const { identifier } = sectionConfig;
+        const { type } = sectionConfig;
         let sectionData;
-        if (isCustomSection(sectionConfig)) {
-            // Copy id from data to the top level
-            sectionData = sectionConfig.data.map((item) => ({
-                ...item,
-                id: item?.id || item?.data?.id,
-            }));
-        }
-        else {
-            sectionData = sectionResults[identifier];
+        switch (type) {
+            case 'recommendations':
+                sectionData = sectionResults[sectionConfig.podId];
+                break;
+            case 'custom':
+                // Copy id from data to the top level
+                sectionData = sectionConfig.data.map((item) => ({
+                    ...item,
+                    id: item?.id || item?.data?.id,
+                }));
+                break;
+            default:
+                // Autocomplete
+                sectionData = sectionResults[sectionConfig.indexSectionName];
         }
         if (Array.isArray(sectionData)) {
             const section = {
@@ -141,7 +151,8 @@ export const escapeRegExp = (string) => string.replace(/[.*+?^${}()|[\]\\]/g, '\
 export const trackRecommendationView = (target, activeSectionsWithData, cioClient) => {
     if (target.dataset.cnstrcRecommendationsPodId) {
         // Pull recommendations from activeSectionsWithData by podId surfaced on target
-        const recommendationSection = activeSectionsWithData.find((section) => section.identifier === target.dataset.cnstrcRecommendationsPodId);
+        const recommendationSection = activeSectionsWithData.find((section) => isRecommendationsSection(section) &&
+            section.podId === target.dataset.cnstrcRecommendationsPodId);
         const recommendationItems = recommendationSection?.data.map((item) => ({
             itemId: item.data?.id,
             itemName: item.value,

package/lib/mjs/version.js

@@ -1 +1 @@
-export default '1.18.1';
+export default '1.19.0';

package/lib/types/constants.d.ts

@@ -2,9 +2,9 @@ import { AutocompleteSubmitEvent } from './types';
 export declare const apiKey = "key_M57QS8SMPdLdLx4x";
 export declare const componentDescription = "- import `CioAutocomplete` to render in your JSX.\n- This component handles state management, data fetching, and rendering logic.\n- To use this component, an `apiKey` or `cioJsClient` are required, and an `onSubmit` callback must be passed. All other values are optional.\n- Use different props to configure the behavior of this component.\n- The following stories shows how different props affect the component's behavior\n\n> Note: when we say `cioJsClient`, we are referring to an instance of the [constructorio-client-javascript](https://www.npmjs.com/package/@constructor-io/constructorio-client-javascript)\n";
 export declare const hookDescription = "- import `useCioAutocomplete` and call this custom hook in a functional component.\n- This hook leaves rendering logic up to you, while handling:\n  - state management\n  - data fetching\n  - keyboard navigation\n  - mouse interactions\n  - focus and submit event handling\n- To use this hook, an `apiKey` or `cioJsClient` are required, and an `onSubmit` callback must be passed to the `useCioAutocomplete` hook to configure behavior. All other values are optional.\n- use the <a href=\"https://kentcdodds.com/blog/how-to-give-rendering-control-to-users-with-prop-getters\" target=\"__blank\">prop getters</a> and other variables returned by this hook (below) to leverage the functionality described above with jsx elements in your react component definitions\n\nCalling the `useCioAutocomplete` hook returns an object with the following keys:\n\n```jsx\nconst {\n  // must be used for a hooks integrations\n  query: string, // current input field value\n  sections: [{...}], // array of sections data to render in menu list\n  getFormProps: () => ({...})), // prop getter for jsx form element\n  getInputProps: () => ({...})), // prop getter for jsx input element\n  getMenuProps: () => ({...})), // prop getter for jsx element rendering the results container\n  getItemProps: (item) => ({...})), // prop getter for jsx element rendering each result\n  getSectionProps: (section: Section) => ({...})), // prop getter for jsx element rendering each section.\n\n  // available for use, but not required for all use cases\n  selectedItem: item, // undefined or current selected item (via hover or arrow keys)\n  isOpen: boolean, // current state of the menu list\n  openMenu: () => void, // open menu\n  closeMenu: () => void, // close menu\n  setQuery: () => void, // update the current input field value\n  getLabelProps: () => ({...})), // prop getter for a jsx label element\n  cioJsClient, // instance of constructorio-client-javascript\n } = useCioAutocomplete(args);\n```\n\n> Note: when we say `cioJsClient`, we are referring to an instance of the [constructorio-client-javascript](https://www.npmjs.com/package/@constructor-io/constructorio-client-javascript)\n\nThe following stories show how different options affect the hook's behavior!\n";
-export declare const sectionsDescription = "- by default, typing a query will fetch data for search suggestions and Products\n- to override this, pass an array of sections objects\n- the order of the objects in the `sections` array determines the order of the results\n- each section object must have an `identifier`\n- each section object can specify a `type`\n- each section object can override the default `numResults` of 8\n\nWhen no values are passed for the `sections` argument, the following defaults are used:\n\n```jsx\n[\n  {\n    identifier: 'Search Suggestions',\n    type: 'autocomplete',\n    numResults: 8\n  },\n  {\n    identifier: 'Products',\n    type: 'autocomplete',\n    numResults: 8\n  }\n]\n```\n";
+export declare const sectionsDescription = "- by default, typing a query will fetch data for Search Suggestions and Products\n- to override this, pass an array of sections objects\n- the order of the objects in the `sections` array determines the order of the results\n- each autocomplete section object must have a `indexSectionName`\n- each recommendation section object must have a `podId`\n- each custom section object must have a `displayName`\n- each section object can specify a `type`\n- each section object can override the default `numResults` of 8\n\n`indexSectionName` refers to a section under an index. The default sections are \"Products\" and \"Search Suggestions\". You can find all the sections that exist in your index under the \"Indexes\" tab of Constructor dashboard.\n\nWhen no values are passed for the `sections` argument, the following defaults are used:\n\n```jsx\n[\n  {\n    indexSectionName: 'Search Suggestions',\n    type: 'autocomplete',\n    numResults: 8\n  },\n  {\n    indexSectionName: 'Products',\n    type: 'autocomplete',\n    numResults: 8\n  }\n]\n```\n";
 export declare const userEventsDescription = "- pass callback functions to respond to user events\n- if provided, the onFocus callback function will be called each time the user focuses on the text input field\n- if provided, the onChange callback function will be called each time the user changes the value in the text input field\n- the onSubmit callback function will be called each time the user submits the form\n- the user can submit the form by pressing the enter key in the text input field, clicking a submit button within the form, clicking on a result, or pressing enter while a result is selected\n\n> \u26A0\uFE0F NOTE \u26A0\uFE0F Use the Storybook Canvas Actions tab to explore the behavior of all of these `OnEvent` callback functions as you interact with our Default User Events example rendered in the Canvas. In the stories below, Storybook Canvas Actions have been disabled to focus on each of these callback functions in isolation. Each of the example callback functions in the stories below log output to the console tab of the browser's developer tools.";
-export declare const zeroStateDescription = "- when the text input field has no text, we call this zero state\n- by default, the autocomplete shows nothing in the menu it's for zero state\n- to show zero state results, pass an array of section objects for `zeroStateSections`\n- when `zeroStateSections` has sections, the menu will open on user focus by default\n- set `openOnFocus` to false, to only show `zeroStateSections` after user has typed and then cleared the text input, instead of as soon as the user focuses on the text input\n- the order of the objects in the `zeroStateSections` array determines the order of the results\n- each section object must have an `identifier`\n- each section object can specify a `type`\n- each section object can override the default `numResults` of 8";
+export declare const zeroStateDescription = "- when the text input field has no text, we call this zero state\n- by default, the autocomplete shows nothing in the menu it's for zero state\n- to show zero state results, pass an array of section objects for `zeroStateSections`\n- when `zeroStateSections` has sections, the menu will open on user focus by default\n- set `openOnFocus` to false, to only show `zeroStateSections` after user has typed and then cleared the text input, instead of as soon as the user focuses on the text input\n- the order of the objects in the `zeroStateSections` array determines the order of the results\n- each autocomplete section object must have a `indexSectionName`\n- each recommendation section object must have a `podId`\n- each custom section object must have a `displayName`\n- each section object can specify a `type`\n- each section object can override the default `numResults` of 8";
 export declare const fullFeaturedAndStyledExampleDescription = "Using the default options, the library displays clean and minimal visual elements, with the intent of making it easy for consumers to easily extend and customize the styles to suit unique needs. The example below shows a full featured and styled example to demonstrate what is possible using Constructor.io's advanced Autocomplete UI library.";
 export declare const apiKeyDescription = "Pass an `apiKey` to request results from constructor's servers";
 export declare const cioJsClientDescription = "If you are already using an instance of the `ConstructorIOClient`, you can pass a `cioJsClient` instead of an `apiKey` to request results from constructor's servers\n\n> Note: when we say `cioJsClient`, we are referring to an instance of the [constructorio-client-javascript](https://www.npmjs.com/package/@constructor-io/constructorio-client-javascript)";

package/lib/types/hooks/useDebouncedFetchSections.d.ts

@@ -1,5 +1,5 @@
 import ConstructorIOClient from '@constructor-io/constructorio-client-javascript';
 import { Nullable } from '@constructor-io/constructorio-client-javascript/lib/types';
-import { AutocompleteResultSections, UserDefinedSection, AdvancedParameters } from '../types';
-declare const useDebouncedFetchSection: (query: string, cioClient: Nullable<ConstructorIOClient>, autocompleteSections: UserDefinedSection[], advancedParameters?: AdvancedParameters) => AutocompleteResultSections;
+import { AutocompleteResultSections, AdvancedParameters, AutocompleteSectionConfiguration } from '../types';
+declare const useDebouncedFetchSection: (query: string, cioClient: Nullable<ConstructorIOClient>, autocompleteSections: AutocompleteSectionConfiguration[], advancedParameters?: AdvancedParameters) => AutocompleteResultSections;
 export default useDebouncedFetchSection;

package/lib/types/hooks/useFetchRecommendationPod.d.ts

@@ -1,5 +1,5 @@
 import ConstructorIOClient from '@constructor-io/constructorio-client-javascript';
 import { Nullable } from '@constructor-io/constructorio-client-javascript/lib/types';
-import { RecommendationsSection, SectionsData } from '../types';
-declare const useFetchRecommendationPod: (cioClient: Nullable<ConstructorIOClient>, recommendationPods: RecommendationsSection[]) => SectionsData;
+import { SectionsData, RecommendationsSectionConfiguration } from '../types';
+declare const useFetchRecommendationPod: (cioClient: Nullable<ConstructorIOClient>, recommendationPods: RecommendationsSectionConfiguration[]) => SectionsData;
 export default useFetchRecommendationPod;

package/lib/types/hooks/useSections.d.ts

@@ -1,6 +1,6 @@
 import ConstructorIO from '@constructor-io/constructorio-client-javascript';
 import { Nullable } from '@constructor-io/constructorio-client-javascript/lib/types';
-import { AdvancedParameters, Section, UserDefinedSection } from '../types';
+import { AdvancedParameters, UserDefinedSection, Section } from '../types';
 export default function useSections(query: string, cioClient: Nullable<ConstructorIO>, sections: UserDefinedSection[], zeroStateSections: UserDefinedSection[] | undefined, advancedParameters?: AdvancedParameters): {
     activeSections: UserDefinedSection[];
     activeSectionsWithData: Section[];

package/lib/types/typeGuards.d.ts

@@ -1,5 +1,7 @@
-import { CustomSection, InGroupSuggestion, Item, Product, UserDefinedSection, SearchSuggestion } from './types';
+import { CustomSection, InGroupSuggestion, Item, Product, UserDefinedSection, SearchSuggestion, AutocompleteSection, RecommendationsSection } from './types';
 export declare function isProduct(item: Item): item is Product;
 export declare function isSearchSuggestion(item: Item): item is SearchSuggestion;
 export declare function isInGroupSuggestion(item: Item): item is InGroupSuggestion;
 export declare function isCustomSection(config: UserDefinedSection): config is CustomSection;
+export declare function isAutocompleteSection(config: UserDefinedSection): config is AutocompleteSection;
+export declare function isRecommendationsSection(config: UserDefinedSection): config is RecommendationsSection;

package/lib/types/types.d.ts

@@ -51,7 +51,7 @@ export type GetAutocompleteResultsOptions = {
     };
 };
 export type SectionsData = {
-    [key: string]: Item[] | undefined;
+    [key: string]: Item[];
 };
 /** CIO API Response Data */
 export type AutocompleteResultSections = {
@@ -61,29 +61,41 @@ export type AutocompleteResultSections = {
 type SectionType = 'autocomplete' | 'recommendations' | 'custom';
 export type SectionConfiguration = {
     type?: SectionType;
-    identifier: string;
     displayName?: string;
     numResults?: number;
     displaySearchTermHighlights?: boolean;
     ref?: React.RefObject<HTMLElement>;
 };
-export interface AutocompleteSection extends SectionConfiguration {
+export interface AutocompleteSectionConfiguration extends SectionConfiguration {
     type?: 'autocomplete';
-    data: Item[];
+    indexSectionName: string;
+    /** @deprecated use indexSectionName field instead */
+    identifier?: string;
 }
-export interface RecommendationsSection extends SectionConfiguration {
+export interface RecommendationsSectionConfiguration extends SectionConfiguration {
     type: 'recommendations';
-    data: Item[];
+    indexSectionName?: string;
+    podId: string;
     itemIds?: string[];
-    section?: string;
     term?: string;
+    /** @deprecated use podId field instead */
+    identifier?: string;
 }
-export interface CustomSection extends SectionConfiguration {
+export interface CustomSectionConfiguration extends SectionConfiguration {
     type: 'custom';
+    displayName: string;
+}
+export interface AutocompleteSection extends AutocompleteSectionConfiguration {
+    data: Item[];
+}
+export interface RecommendationsSection extends RecommendationsSectionConfiguration {
+    data: Item[];
+}
+export interface CustomSection extends CustomSectionConfiguration {
     data: Item[];
 }
 export type Section = AutocompleteSection | RecommendationsSection | CustomSection;
-export type UserDefinedSection = CustomSection | SectionConfiguration;
+export type UserDefinedSection = AutocompleteSectionConfiguration | RecommendationsSectionConfiguration | CustomSection;
 export type Product = ProductFromClient & {
     section: 'Products';
 };

package/lib/types/utils.d.ts

@@ -15,9 +15,10 @@ export declare function getSearchSuggestionFeatures(request: Partial<Autocomplet
 export declare const getItemPosition: GetItemPosition;
 type CamelToStartCase = (camelCaseString: string) => string;
 export declare const camelToStartCase: CamelToStartCase;
-export declare function isTrackingRequestSent(trackingRequestUrl: any): any;
+export declare const toKebabCase: (str: string) => string;
+export declare function isTrackingRequestSent(trackingRequestUrl: string): any;
 export declare function clearConstructorRequests(): void;
-export declare function sleep(ms: any): Promise<unknown>;
+export declare function sleep(ms: number): Promise<unknown>;
 export declare const getStoryParams: (storyCode: any, templateCode: any, importCode: any) => {
     docs: {
         source: {

package/lib/types/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.18.1";
+declare const _default: "1.19.0";
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-ui-autocomplete",
-  "version": "1.18.1",
+  "version": "1.19.0",
   "description": "Constructor.io Autocomplete UI library for web applications",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",