Skip to content

feat(vtex/plp): rich typing + JSDoc on PLPProps for CMS admin #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JonasJesus42 merged 1 commit into from
Jun 18, 2026
Merged

feat(vtex/plp): rich typing + JSDoc on PLPProps for CMS admin #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 35 additions & 4 deletions vtex/inline-loaders/productListingPage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
toFacetPath,
} from "../client";
import { pickSku, toProduct } from "../utils/transform";
import type { Product as ProductVTEX } from "../utils/types";
import type { Product as ProductVTEX, Sort } from "../utils/types";

export interface SelectedFacet {
key: string;
Expand Down Expand Up @@ -42,12 +42,40 @@ export const mapLabelledFuzzyToFuzzy = (label?: LabelledFuzzy): "0" | "1" | "aut
};

export interface PLPProps {
/**
* @title Query
* @description Overrides the search term used to fetch the listing.
*/
query?: string;
/**
* @title Items per page
* @description Number of products per page to display.
*/
count?: number;
sort?: string;
fuzzy?: string;
/**
* @title Sorting
* @description Order in which products are returned.
*/
sort?: Sort;
/**
* @title Fuzzy
* @description Controls Intelligent Search typo tolerance.
*/
fuzzy?: LabelledFuzzy;
/**
* @title Page offset
* @description Starting page (0-indexed) for the listing query.
*/
page?: number;
/**
* @title Selected Facets
* @description Override selected facets from the URL (e.g. force a collection).
*/
selectedFacets?: SelectedFacet[];
/**
* @title Hide Unavailable Items
* @description Do not return out-of-stock items.
*/
hideUnavailableItems?: boolean;
/** Injected by CMS resolve — the matched page path (e.g. "/pisos/piso-vinilico-clicado") */
__pagePath?: string;
Expand Down Expand Up @@ -301,7 +329,10 @@ export default async function vtexProductListingPage(props: PLPProps): Promise<a
const rawCount = Number(countFromUrl ?? props.count ?? 12);
const count = Number.isFinite(rawCount) && rawCount > 0 ? rawCount : 12;
const sort = props.sort || pageUrl?.searchParams.get("sort") || "";
const fuzzy = props.fuzzy ?? pageUrl?.searchParams.get("fuzzy") ?? undefined;
// props.fuzzy is a friendly LabelledFuzzy ("automatic"|…) — translate it to the
// raw IS API value. The URL param is already a raw value, so it passes through.
const fuzzy =
mapLabelledFuzzyToFuzzy(props.fuzzy) ?? pageUrl?.searchParams.get("fuzzy") ?? undefined;
const pageFromUrl = pageUrl?.searchParams.get("page");
const rawPage = props.page ?? (pageFromUrl ? Number(pageFromUrl) - 1 : 0);
const page = Number.isFinite(rawPage) && rawPage >= 0 ? Math.floor(rawPage) : 0;
Expand Down
Loading