@pixelated-tech/components 3.11.8 → 3.12.0

package/dist/components/integrations/lipsum.js

@@ -0,0 +1,45 @@
+import PropTypes from 'prop-types';
+// https://www.outsystems.com/forge/component-documentation/12204/lorem-ipsum-lipsum-com-o11/0
+/**
+ * getLipsum — Fetch placeholder text from lipsum.com and return an array of paragraphs.
+ *
+ * @param {oneOf} [props.LipsumTypeId] - Type of content to request ('Paragraph', 'Word', 'Char').
+ * @param {number} [props.Amount] - Quantity to request (number of paragraphs/words/chars).
+ * @param {boolean} [props.StartWithLoremIpsum] - Whether the text should start with the classic Lorem Ipsum opening.
+ */
+getLipsum.propTypes = {
+    /** Type of lipsum content to request */
+    LipsumTypeId: PropTypes.oneOf(['Paragraph', 'Word', 'Char']).isRequired,
+    /** Number of items to request */
+    Amount: PropTypes.number.isRequired,
+    /** Start with the canonical Lorem Ipsum text */
+    StartWithLoremIpsum: PropTypes.bool,
+};
+export async function getLipsum(props) {
+    const { LipsumTypeId, Amount, StartWithLoremIpsum } = props;
+    const proxyURL = "https://proxy.pixelated.tech/prod/proxy?url=";
+    const baseURL = "https://www.lipsum.com/feed/html";
+    const qs = `?LipsumTypeId=${LipsumTypeId}&amount=${Amount}&StartWithLoremIpsum=${StartWithLoremIpsum}`;
+    const fulURL = `${proxyURL}${baseURL}${qs}`;
+    const res = await fetch(fulURL)
+        .then((response) => {
+        return response.text();
+    })
+        .then((html) => {
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(html, 'text/html');
+        const lipsum = doc.getElementById('lipsum');
+        // const lipsums = doc.getElementById('lipsum')?.innerHTML || "";
+        const paragraphs = lipsum?.querySelectorAll('p');
+        const strings = [];
+        paragraphs?.forEach((p) => {
+            strings.push(p.textContent.trim());
+        });
+        return strings;
+    })
+        .catch(error => {
+        console.error('Failed to fetch page: ', error);
+        return [];
+    });
+    return res;
+}

package/dist/components/integrations/loremipsum.js

@@ -2,12 +2,24 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { useEffect, useState } from 'react';
 import PropTypes from 'prop-types';
-import { usePixelatedConfig } from '@/components/config/config.client';
+import { usePixelatedConfig } from '../config/config.client';
 const debug = false;
+/**
+ * LoremIpsum — Fetch and render placeholder paragraphs via an external API (with optional proxy fallback).
+ *
+ * @param {number} [props.paragraphs] - Number of paragraphs to fetch.
+ * @param {string} [props.seed] - Optional seed to generate deterministic content.
+ * @param {string} [props.proxyBase] - Optional proxy base URL to use when direct fetch fails due to CORS.
+ * @param {string} [props.className] - CSS class name(s) applied to the wrapper element.
+ */
 LoremIpsum.propTypes = {
+    /** Paragraph count to request */
     paragraphs: PropTypes.number,
+    /** Optional deterministic seed for content */
     seed: PropTypes.string,
+    /** Proxy base URL used as a fallback */
     proxyBase: PropTypes.string,
+    /** Wrapper CSS class name */
     className: PropTypes.string,
 };
 export function LoremIpsum({ paragraphs = 1, seed = '', proxyBase, className = '' }) {

package/dist/components/integrations/socialcard.js

@@ -31,7 +31,13 @@ function removeDeadHrefs(element) {
     return doc.body.innerHTML;
 }
 /* ========== SOCIALCARD ========== */
+/**
+ * SocialCards — Aggregate feeds from configured sources (RSS, APIs) and render as social cards.
+ *
+ * @param {object} [props.sources] - Map of source configurations (url/userID/entryCount/iconSrc/iconSrcAlt) keyed by source name.
+ */
 SocialCards.propTypes = {
+    /** Map of feed source configurations (e.g., { instagram: { userID, entryCount }, blog: { url, entryCount }, ... }) */
     sources: PropTypes.object.isRequired
 };
 export function SocialCards(props) {
@@ -289,9 +295,19 @@ export function SocialCards(props) {
         return (state.mySocialCards);
     }
 }
+/**
+ * SocialCard — Render a single social feed item as a card with icon, title, description, and date.
+ *
+ * @param {string} [props.iconSrc] - URL/path to the source icon image.
+ * @param {string} [props.iconSrcAlt] - Alt text for the source icon.
+ * @param {any} [props.card] - Feed item object containing title, link, description and pubDate.
+ */
 SocialCard.propTypes = {
+    /** Source icon image URL */
     iconSrc: PropTypes.string.isRequired,
+    /** Alt text for the icon */
     iconSrcAlt: PropTypes.string.isRequired,
+    /** Feed item object with title/link/description/pubDate */
     card: PropTypes.any.isRequired
 };
 export function SocialCard(props) {
@@ -299,7 +315,10 @@ export function SocialCard(props) {
     return (_jsx("div", { className: "masonryItem", children: _jsxs("div", { className: "card", children: [_jsx("div", { className: "cardTitle", children: _jsxs("a", { href: props.card.link, target: "_blank", rel: "noopener noreferrer", children: [_jsx(SmartImage, { className: "cardIcon", src: props.iconSrc, title: props.iconSrcAlt, alt: props.iconSrcAlt, cloudinaryEnv: config?.cloudinary?.product_env, cloudinaryDomain: config?.cloudinary?.baseUrl, cloudinaryTransforms: config?.cloudinary?.transforms }), props.card.title] }) }), _jsx("div", { className: "cardBody", dangerouslySetInnerHTML: { __html: removeDeadHrefs(props.card.description) } }), _jsx("div", { className: "cardDate", children: props.card.pubDate })] }) }, props.card.guid));
 }
 /* ========== SPINNER ========== */
-SocialCardsLoading.propTypes = {};
+/** SocialCardsLoading.propTypes — No props (simple loading indicator).
+ * @param {any} [props] - No props are accepted by SocialCardsLoading.
+ */
+SocialCardsLoading.propTypes = { /** no props */};
 export function SocialCardsLoading() {
     return (_jsx("div", { className: "cardsLoading", children: _jsx("div", { children: "Loading..." }) }));
 }

package/dist/components/integrations/wordpress.components.js

@@ -14,11 +14,25 @@ function decodeString(str) {
     textarea.innerHTML = str;
     return textarea.value;
 }
+/**
+ * BlogPostList — Render a list of WordPress posts. If `posts` are provided they are used directly; otherwise the component will fetch posts from the configured WordPress endpoint.
+ *
+ * @param {string} [props.site] - WordPress site identifier (overrides provider config).
+ * @param {string} [props.baseURL] - Base URL for WordPress API if not using site config.
+ * @param {number} [props.count] - Maximum number of posts to fetch/display.
+ * @param {array} [props.posts] - Optional pre-fetched posts to render (bypasses remote fetch).
+ * @param {boolean} [props.showCategories] - Whether to show category icons for each post.
+ */
 BlogPostList.propTypes = {
+    /** WordPress site identifier */
     site: PropTypes.string,
+    /** Optional WordPress base URL */
     baseURL: PropTypes.string,
+    /** Max number of posts to fetch/display */
     count: PropTypes.number,
+    /** Optional array of pre-fetched posts */
     posts: PropTypes.array,
+    /** Show category icons next to posts */
     showCategories: PropTypes.bool,
 };
 export function BlogPostList(props) {
@@ -55,14 +69,34 @@ export function BlogPostList(props) {
     }, [site, baseURL, count, cachedPosts]);
     return (_jsxs(_Fragment, { children: [_jsx(Loading, {}), posts.map((post) => (_jsx(PageGridItem, { children: _jsx(BlogPostSummary, { ID: post.ID, title: post.title, date: post.date, excerpt: post.excerpt, URL: post.URL, categories: post.categories, featured_image: post.featured_image, showCategories: showCategories }) }, post.ID)))] }));
 }
+/**
+ * BlogPostSummary — Render a compact summary card for a single WordPress post.
+ *
+ * @param {oneOfType} [props.ID] - Post ID (string or number).
+ * @param {string} [props.title] - Post title.
+ * @param {string} [props.date] - Post publish date (ISO string).
+ * @param {string} [props.excerpt] - HTML excerpt to display as the summary.
+ * @param {string} [props.URL] - Canonical URL for the post.
+ * @param {object} [props.categories] - Categories object (keys -> category name) used to derive icons.
+ * @param {string} [props.featured_image] - URL of the post's featured image.
+ * @param {boolean} [props.showCategories] - Whether to render category icons beneath the summary.
+ */
 BlogPostSummary.propTypes = {
+    /** Post ID (string or number) */
     ID: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+    /** Post title */
     title: PropTypes.string,
+    /** Post publish date (ISO string) */
     date: PropTypes.string,
+    /** HTML excerpt */
     excerpt: PropTypes.string,
+    /** Canonical URL for the post */
     URL: PropTypes.string,
+    /** Categories object used for icons */
     categories: PropTypes.object,
+    /** Featured image URL */
     featured_image: PropTypes.string,
+    /** Show categories flag */
     showCategories: PropTypes.bool,
 };
 export function BlogPostSummary(props) {
@@ -72,7 +106,13 @@ export function BlogPostSummary(props) {
     return (_jsx("div", { className: "blog-post-summary", children: _jsxs("article", { className: "h-entry", children: [_jsx("h2", { className: "p-name", children: _jsx("a", { className: "u-url blog-post-url", href: props.URL || '', target: "_blank", rel: "noopener noreferrer", children: props.title ? decodeString(props.title) : '' }) }), _jsxs("div", { className: "dt-published", children: ["Published: ", props.date ? new Date(props.date).toLocaleDateString() : ''] }), props.featured_image ? (_jsxs("div", { className: "article-body row-12col", children: [_jsx("div", { className: "article-featured-image grid-s1-e4", children: _jsx(SmartImage, { className: "u-photo", src: props.featured_image, alt: props.title ? decodeString(props.title) : '', title: props.title ? decodeString(props.title) : '', style: {}, cloudinaryEnv: config?.cloudinary?.product_env ?? undefined, cloudinaryDomain: config?.cloudinary?.baseUrl ?? undefined, cloudinaryTransforms: config?.cloudinary?.transforms ?? undefined }) }), _jsx("div", { className: "article-excerpt grid-s4-e13", children: _jsx("div", { className: "p-summary", dangerouslySetInnerHTML: { __html: myExcerpt } }) })] })) :
                     _jsx("div", { className: "article-excerpt grid-s1-e13", children: _jsx("div", { className: "p-summary", dangerouslySetInnerHTML: { __html: myExcerpt } }) }), props.showCategories !== false && (_jsxs("div", { children: ["Categories:", myCategoryImages.map(([categoryImg, index]) => (_jsx("span", { className: "p-category", children: _jsx(SmartImage, { src: `/images/icons/${categoryImg}.png`, title: String(categoryImg), alt: String(categoryImg), cloudinaryEnv: config?.cloudinary?.product_env ?? undefined, cloudinaryDomain: config?.cloudinary?.baseUrl ?? undefined, cloudinaryTransforms: config?.cloudinary?.transforms ?? undefined }) }, categoryImg + "-" + index)))] }))] }) }, props.ID));
 }
+/**
+ * BlogPostCategories — Render a compact list of category names or icons for a post.
+ *
+ * @param {arrayOf} [props.categories] - Array of category strings to render.
+ */
 BlogPostCategories.propTypes = {
+    /** Array of category names */
     categories: PropTypes.arrayOf(PropTypes.string),
 };
 export function BlogPostCategories(props) {

package/dist/components/integrations/wordpress.functions.js

@@ -4,9 +4,19 @@ import PropTypes from "prop-types";
 // const wpSite = "blog.pixelated.tech";
 const wpApiURL = "https://public-api.wordpress.com/rest/v1/sites/";
 const wpCategoriesPath = "/categories";
+/**
+ * getWordPressItems — Fetch posts from the WordPress REST API for a given site.
+ *
+ * @param {string} [props.site] - WordPress site identifier (site slug or domain).
+ * @param {number} [props.count] - Optional number of posts to fetch (omit to fetch all available).
+ * @param {string} [props.baseURL] - Optional base URL for the WordPress API (defaults to public WordPress API URL).
+ */
 getWordPressItems.propTypes = {
+    /** WordPress site identifier (slug or domain) */
     site: PropTypes.string.isRequired,
+    /** Number of posts to fetch (optional) */
     count: PropTypes.number,
+    /** Base URL for WordPress API (optional) */
     baseURL: PropTypes.string,
 };
 export async function getWordPressItems(props) {
@@ -43,7 +53,13 @@ export async function getWordPressItems(props) {
     }
     return posts;
 }
+/**
+ * getWordPressItemImages — Extract image objects from a WordPress post for use in sitemaps and galleries.
+ *
+ * @param {object} [props.item] - WordPress post object to extract image URLs from.
+ */
 getWordPressItemImages.propTypes = {
+    /** WordPress post object */
     item: PropTypes.object.isRequired,
 };
 export function getWordPressItemImages(item) {
@@ -87,8 +103,16 @@ export function getWordPressItemImages(item) {
     }
     return images;
 }
+/**
+ * getWordPressCategories — Retrieve categories for a WordPress site.
+ *
+ * @param {string} [props.site] - WordPress site identifier (slug or domain).
+ * @param {string} [props.baseURL] - Optional base URL for the WordPress API.
+ */
 getWordPressCategories.propTypes = {
+    /** WordPress site identifier (slug or domain) */
     site: PropTypes.string.isRequired,
+    /** Base URL for WordPress API (optional) */
     baseURL: PropTypes.string,
 };
 export async function getWordPressCategories(props) {

package/dist/components/integrations/yelp.js

@@ -13,8 +13,16 @@ https://www.google.com/search?q=yelp+reviews+react+component&oq=yelp+reviews+rea
 https://www.reddit.com/r/nextjs/comments/16smhqa/next_js_fetching_data_from_yelp_api/
 https://helloputnam.medium.com/easiest-way-to-include-business-reviews-on-a-web-app-google-facebook-yelp-etc-de3e243bbe75
 */
+/**
+ * YelpReviews — Fetch and display Yelp reviews for a given business ID (note: Yelp API access may require paid plan).
+ *
+ * @param {string} [props.businessID] - Yelp business ID used to fetch reviews (required).
+ * @param {string} [props.key] - Optional API key (not used by the demo placeholder implementation).
+ */
 YelpReviews.propTypes = {
+    /** Yelp business identifier */
     businessID: PropTypes.string.isRequired,
+    /** Optional Yelp API key */
     key: PropTypes.string,
 };
 export function YelpReviews(props) {

package/dist/components/shoppingcart/ebay.components.js

@@ -14,8 +14,16 @@ import "../../css/pixelated.grid.scss";
 import "./ebay.css";
 const debug = false;
 /* ========== EBAY ITEMS PAGE ========== */
+/**
+ * EbayItems — Fetch and display eBay items using the configured API parameters and optional Cloudinary transforms.
+ *
+ * @param {object} [props.apiProps] - eBay API configuration and query parameters.
+ * @param {string} [props.cloudinaryProductEnv] - Optional Cloudinary cloud name used to transform image URLs.
+ */
 EbayItems.propTypes = {
+    /** eBay API configuration and query params */
     apiProps: PropTypes.object.isRequired,
+    /** Optional Cloudinary product environment for image transforms */
     cloudinaryProductEnv: PropTypes.string,
 };
 export function EbayItems(props) {
@@ -24,8 +32,16 @@ export function EbayItems(props) {
     const [items, setItems] = useState([]);
     const [aspects, setAspects] = useState([]);
     const apiProps = { ...(config?.ebay || {}), ...props.apiProps };
+    /**
+     * paintItems — Map raw eBay item data into rendered `EbayListItem` elements.
+     *
+     * @param {array} [props.items] - Array of eBay item objects returned by the API.
+ * @param {string} [props.cloudinaryProductEnv] - Optional Cloudinary cloud name for image URL transformations.
+     */
     paintItems.propTypes = {
+        /** Array of eBay item objects */
         items: PropTypes.array.isRequired,
+        /** Optional Cloudinary product environment */
         cloudinaryProductEnv: PropTypes.string,
     };
     function paintItems(props) {
@@ -39,8 +55,16 @@ export function EbayItems(props) {
         }
         return newItems;
     }
+    /**
+     * fetchItems — Perform a search query against eBay and update component state with results.
+     *
+     * @param {string} [props.aspectName] - Optional aspect name to filter search results.
+ * @param {string} [props.aspectValue] - Optional aspect value corresponding to `aspectName` to filter results.
+     */
     fetchItems.propTypes = {
+        /** Filter aspect name for the search (optional) */
         aspectName: PropTypes.string,
+        /** Filter aspect value for the search (optional) */
         aspectValue: PropTypes.string,
     };
     async function fetchItems(props) {
@@ -80,8 +104,16 @@ export function EbayItems(props) {
         return (_jsx("div", { className: "section-container", children: _jsx("div", { id: "ebayItems", className: "ebayItems", children: _jsx(Loading, {}) }) }));
     }
 }
+/**
+ * EbayListFilter — UI for filtering eBay item lists by aspect values.
+ *
+ * @param {any} [props.aspects] - Aspect distributions returned by eBay used to build filter controls.
+ * @param {function} [props.callback] - Callback invoked when a filter selection changes; receives filter criteria.
+ */
 EbayListFilter.propTypes = {
+    /** Aspect distributions used to render filter controls */
     aspects: PropTypes.any.isRequired,
+    /** Callback to fetch filtered results */
     callback: PropTypes.func.isRequired,
 };
 export function EbayListFilter(props) {
@@ -124,9 +156,19 @@ export function EbayListFilter(props) {
     }
     return (_jsxs("form", { name: "ebayItemsFilter", id: "ebayItemsFilter", children: [_jsxs("span", { className: "filterInput", children: [_jsx("label", { htmlFor: "aspectName", children: "Aspect:" }), _jsxs("select", { id: "aspectName", onChange: onAspectNameChange, children: [_jsx("option", { value: "" }), aspectNames.map((aspectName, index) => _jsx("option", { value: aspectName, children: aspectName }, index))] })] }), _jsxs("span", { className: "filterInput", children: [_jsx("label", { htmlFor: "aspectValue", onChange: onAspectValueChange, children: "Value:" }), _jsx("select", { id: "aspectValue", children: _jsx("option", { value: "" }) })] }), _jsx("span", { className: "filterInput", children: _jsx("button", { type: "button", onClick: handleAspectFilter, children: "Filter" }) })] }));
 }
+/**
+ * EbayListItem — Render a single eBay item with thumbnail, metadata and add-to-cart actions.
+ *
+ * @param {any} [props.item] - eBay item object returned by the API.
+ * @param {string} [props.cloudinaryProductEnv] - Optional Cloudinary cloud name to transform image URLs.
+ * @param {any} [props.apiProps] - eBay API properties (for link generation or calls).
+ */
 EbayListItem.propTypes = {
+    /** eBay item object */
     item: PropTypes.any.isRequired,
+    /** Optional Cloudinary product environment */
     cloudinaryProductEnv: PropTypes.string,
+    /** eBay API properties */
     apiProps: PropTypes.any,
 };
 export function EbayListItem(props) {
@@ -151,9 +193,19 @@ export function EbayListItem(props) {
                             ? _jsxs("a", { href: itemURL, target: itemURLTarget, rel: "noreferrer", children: ["$", thisItem.price.value + " " + thisItem.price.currency] })
                             : "$" + thisItem.price.value + " " + thisItem.price.currency }), _jsx("br", {}), _jsxs("div", { className: "ebayItemAddToCart", children: [_jsx(ViewItemDetails, { href: "/store", itemID: thisItem.legacyItemId }), _jsx(AddToCartButton, { handler: addToShoppingCart, item: shoppingCartItem, itemID: thisItem.legacyItemId })] })] })] }));
 }
+/**
+ * EbayItemHeader — Render a heading for an eBay item; optionally wrap in a link when a `url` is provided.
+ *
+ * @param {string} [props.title] - The item title to display.
+ * @param {string} [props.url] - Optional URL to link the title to (opens in `props.target`).
+ * @param {string} [props.target] - Link target attribute (e.g., '_blank').
+ */
 EbayItemHeader.propTypes = {
+    /** The item title text */
     title: PropTypes.string.isRequired,
+    /** Optional link URL for the title */
     url: PropTypes.string,
+    /** Link target attribute (e.g., '_blank') */
     target: PropTypes.string,
 };
 export function EbayItemHeader(props) {
@@ -162,9 +214,19 @@ export function EbayItemHeader(props) {
             : _jsx("h2", { className: "", children: props.title }) }));
 }
 /* ========== EBAY ITEM DETAIL PAGE ========== */
+/**
+ * EbayItemDetail — Display detailed information for a single eBay item fetched via the API.
+ *
+ * @param {object} [props.apiProps] - eBay API configuration used to fetch the item.
+ * @param {string} [props.itemID] - eBay item identifier to fetch details for.
+ * @param {string} [props.cloudinaryProductEnv] - Optional Cloudinary product environment for image transforms.
+ */
 EbayItemDetail.propTypes = {
+    /** eBay API configuration */
     apiProps: PropTypes.object.isRequired,
+    /** eBay item ID to fetch details for */
     itemID: PropTypes.string.isRequired, // currently not used
+    /** Cloudinary product env for image transforms */
     cloudinaryProductEnv: PropTypes.string,
 };
 export function EbayItemDetail(props) {
@@ -209,8 +271,16 @@ export function EbayItemDetail(props) {
     }
 }
 /* ========== EBAY RATE LIMITS VISUALIZER ========== */
+/**
+ * EbayRateLimitsVisualizer — Visualize eBay API rate limit information for debugging and monitoring.
+ *
+ * @param {string} [props.token] - OAuth access token used to authorize analytics requests.
+ * @param {object} [props.apiProps] - eBay analytics API configuration (baseAnalyticsURL, proxyURL).
+ */
 EbayRateLimitsVisualizer.propTypes = {
+    /** OAuth access token for analytics endpoints */
     token: PropTypes.string,
+    /** eBay analytics API configuration */
     apiProps: PropTypes.object,
 };
 export function EbayRateLimitsVisualizer(props) {

package/dist/components/shoppingcart/ebay.functions.js

@@ -50,9 +50,19 @@ function getMergedEbayConfig(providedApiProps) {
     }
     return apiProps;
 }
+/**
+ * getShoppingCartItem — Convert an eBay API item object into the internal ShoppingCartType shape used by the cart.
+ *
+ * @param {any} [props.thisItem] - Raw eBay item object from the API.
+ * @param {string} [props.cloudinaryProductEnv] - Optional Cloudinary cloud name to transform image URLs.
+ * @param {any} [props.apiProps] - eBay API properties used to determine category/availability.
+ */
 getShoppingCartItem.propTypes = {
+    /** Raw eBay item object */
     thisItem: PropTypes.any.isRequired,
+    /** Optional Cloudinary product environment */
     cloudinaryProductEnv: PropTypes.string,
+    /** eBay API properties */
     apiProps: PropTypes.any,
 };
 export function getShoppingCartItem(props) {
@@ -91,7 +101,13 @@ item tokenScope: 'https://api.ebay.com/oauth/api_scope/buy.item.bulk',
 getItem tokenScope: 'https://api.ebay.com/oauth/api_scope',
 */
 /* ========== GET TOKEN ========== */
+/**
+ * getEbayAppToken — Retrieve an application access token from eBay for API calls.
+ *
+ * @param {object} [props.apiProps] - eBay API configuration (appId, appCertId, proxyURL, baseTokenURL, etc.).
+ */
 getEbayAppToken.propTypes = {
+    /** eBay API configuration for token retrieval */
     apiProps: PropTypes.object.isRequired,
 };
 export function getEbayAppToken(props) {
@@ -127,8 +143,16 @@ export function getEbayAppToken(props) {
     return fetchToken();
 }
 /* ========== ITEM SEARCH ========== */
+/**
+ * getEbayBrowseSearch — Execute a browse search request against the eBay Browse API and return results.
+ *
+ * @param {object} [props.apiProps] - eBay API configuration and query parameters.
+ * @param {string} [props.token] - OAuth token used to authorize the request.
+ */
 getEbayBrowseSearch.propTypes = {
+    /** eBay API configuration */
     apiProps: PropTypes.object.isRequired,
+    /** OAuth token to authorize the request */
     token: PropTypes.string.isRequired,
 };
 export function getEbayBrowseSearch(props) {
@@ -172,8 +196,16 @@ export function getEbayBrowseSearch(props) {
     return fetchData(props.token);
 }
 /* ========== GET ITEM ========== */
+/**
+ * getEbayBrowseItem — Retrieve a single item detail from the eBay Browse API.
+ *
+ * @param {object} [props.apiProps] - eBay API configuration (item URL/qsItemURL).
+ * @param {string} [props.token] - OAuth token used to authorize the request.
+ */
 getEbayBrowseItem.propTypes = {
+    /** eBay API configuration */
     apiProps: PropTypes.object.isRequired,
+    /** OAuth token to authorize the request */
     token: PropTypes.string.isRequired,
 };
 export function getEbayBrowseItem(props) {
@@ -217,8 +249,16 @@ export function getEbayBrowseItem(props) {
     return fetchData(props.token);
 }
 /* ========== RATE LIMITS ========== */
+/**
+ * getEbayRateLimits — Fetch API rate limit information for the eBay analytics endpoints.
+ *
+ * @param {object} [props.apiProps] - eBay analytics API config (baseAnalyticsURL, proxyURL).
+ * @param {string} [props.token] - OAuth token used to authorize analytics requests.
+ */
 getEbayRateLimits.propTypes = {
+    /** eBay analytics API configuration */
     apiProps: PropTypes.object.isRequired,
+    /** OAuth token for analytics requests */
     token: PropTypes.string.isRequired,
 };
 export function getEbayRateLimits(props) {
@@ -260,7 +300,13 @@ export function getEbayRateLimits(props) {
 }
 /* ========== EXPORTED FUNCTIONS ========== */
 /* ========== GET EBAY ITEMS ========== */
+/**
+ * getEbayItems — Fetch a list of eBay items using the configured browse search helper.
+ *
+ * @param {object} [props.apiProps] - eBay API configuration and query parameters.
+ */
 getEbayItems.propTypes = {
+    /** eBay API configuration and query params */
     apiProps: PropTypes.object.isRequired,
 };
 export async function getEbayItems(props) {
@@ -281,7 +327,13 @@ export async function getEbayItems(props) {
     return {};
 }
 /* ========== GET EBAY ITEMS ========== */
+/**
+ * getEbayItem — Fetch a single eBay item using the configured eBay item helper.
+ *
+ * @param {object} [props.apiProps] - eBay API item config (baseItemURL, qsItemURL, proxyURL).
+ */
 getEbayItem.propTypes = {
+    /** eBay API item config */
     apiProps: PropTypes.object.isRequired,
 };
 export async function getEbayItem(props) {