@nuskin/react-search-sdk 1.0.1-code-cleanup.1 → 1.1.0-pa-1255.1

package/README.md

@@ -1,12 +1,12 @@
-# @nuskin/react-search-sdk
+# @nuskin/react-search-sdk
 
-The search experience for the NuSkin storefront: typeahead and recent searches over the Equinox
+The search experience for the Nu Skin storefront: typeahead and recent searches over the Equinox
 catalog, and the NUi agent when a signed-in shopper searches for something with no products.
 
 A host renders one component, `CommerceSearch`, and gives it the market, who the customer is, how to
 navigate, and its logo. The package works out the rest itself: the market's catalog lookup, the
 minimum search length, which NUi app to use, the panel's text and the analytics events. The panel UI
-comes from [`@nuskin/react-search-components`](../react-search-components) and the agent from
+comes from `@nuskin/react-search-components` and the agent from
 `@nuskin/react-nui-chat-sdk`.
 
 ## Requirements

package/dist/index.d.mts

@@ -16,8 +16,8 @@ type NavigationTarget = {
 /**
  * The account types the suggestions API distinguishes, sent as `X-Customer-Type`.
  *
- * TODO: this set is a best guess from the values the storefront sends. Confirm what the
- * suggestions API accepts, experimentally, once the search runs against it.
+ * TODO: PA-1254 validates this set, which is a best guess from the values the storefront sends,
+ * against the storefront's customer types and what the suggestions API accepts.
  */
 type CustomerAccountType = 'guest' | 'Brand Affiliate' | 'Retail Customer' | 'Preferred Customer/Member';
 /** Who is searching. */
@@ -46,18 +46,25 @@ interface CommerceSearchProps {
     country: string;
     /** ISO 639-1 language, for example `en`. */
     language: string;
+    /**
+     * The client id the configuration service knows the host by. Without one the Configuration
+     * SDK uses its own (the run config's), and the search's plain suggestions fail where there is
+     * none, so a host that cannot rely on the run config should pass it.
+     */
+    clientId?: string;
     /** Shown at the top of the panel, for example the brand logo. */
     logo?: ReactNode;
 }
 /**
  * The commerce website's single search entry point: typeahead and recent searches over the
- * product catalog today, with the NUi agent taking over in the same panel when a signed-in
- * shopper (guests too, where the configuration allows it) searches for something with no products. What it can answer is not limited to
- * products — it is the commerce site's search, not a product-only search box.
+ * product catalog today, with the NUi agent taking over in the same panel when a shopper the
+ * configuration enables it for searches for something with no products. What it can answer is not
+ * limited to products — it is the commerce site's search, not a product-only search box.
  *
- * The package works out the rest itself: the market's catalog lookup, the minimum search length,
- * which NUi app to use, the panel's text and the analytics fields.
+ * The package works out the rest itself: the market's catalog lookup, the minimum search length
+ * and the number of suggestions, which NUi app to use and for whom, the panel's text and the
+ * analytics fields.
  */
-declare function CommerceSearch({ isOpen, onClose, navigate, customer, country, language, logo, }: Readonly<CommerceSearchProps>): ReactElement | null;
+declare function CommerceSearch(props: Readonly<CommerceSearchProps>): ReactElement | null;
 
 export { CommerceSearch, type CommerceSearchCustomer, type CommerceSearchProps, type CustomerAccountType, type NavigationTarget };

package/dist/index.d.ts

@@ -16,8 +16,8 @@ type NavigationTarget = {
 /**
  * The account types the suggestions API distinguishes, sent as `X-Customer-Type`.
  *
- * TODO: this set is a best guess from the values the storefront sends. Confirm what the
- * suggestions API accepts, experimentally, once the search runs against it.
+ * TODO: PA-1254 validates this set, which is a best guess from the values the storefront sends,
+ * against the storefront's customer types and what the suggestions API accepts.
  */
 type CustomerAccountType = 'guest' | 'Brand Affiliate' | 'Retail Customer' | 'Preferred Customer/Member';
 /** Who is searching. */
@@ -46,18 +46,25 @@ interface CommerceSearchProps {
     country: string;
     /** ISO 639-1 language, for example `en`. */
     language: string;
+    /**
+     * The client id the configuration service knows the host by. Without one the Configuration
+     * SDK uses its own (the run config's), and the search's plain suggestions fail where there is
+     * none, so a host that cannot rely on the run config should pass it.
+     */
+    clientId?: string;
     /** Shown at the top of the panel, for example the brand logo. */
     logo?: ReactNode;
 }
 /**
  * The commerce website's single search entry point: typeahead and recent searches over the
- * product catalog today, with the NUi agent taking over in the same panel when a signed-in
- * shopper (guests too, where the configuration allows it) searches for something with no products. What it can answer is not limited to
- * products — it is the commerce site's search, not a product-only search box.
+ * product catalog today, with the NUi agent taking over in the same panel when a shopper the
+ * configuration enables it for searches for something with no products. What it can answer is not
+ * limited to products — it is the commerce site's search, not a product-only search box.
  *
- * The package works out the rest itself: the market's catalog lookup, the minimum search length,
- * which NUi app to use, the panel's text and the analytics fields.
+ * The package works out the rest itself: the market's catalog lookup, the minimum search length
+ * and the number of suggestions, which NUi app to use and for whom, the panel's text and the
+ * analytics fields.
  */
-declare function CommerceSearch({ isOpen, onClose, navigate, customer, country, language, logo, }: Readonly<CommerceSearchProps>): ReactElement | null;
+declare function CommerceSearch(props: Readonly<CommerceSearchProps>): ReactElement | null;
 
 export { CommerceSearch, type CommerceSearchCustomer, type CommerceSearchProps, type CustomerAccountType, type NavigationTarget };