@wocart/storefront 1.7.0 → 1.8.0

package/CHANGELOG.md

@@ -5,6 +5,28 @@ follows [semantic versioning](https://semver.org/): breaking changes ship only
 in a new major version, and an export is marked `@deprecated` for at least one
 minor release before a major removes it.
 
+## 1.8.0 — 2026-10-17
+
+### Added
+
+- **Collections.** `products.list({ collection: "best-sellers" })` lists a
+  collection — a list of products the merchant curates by hand — in the
+  merchant's order; an unknown handle lists nothing. `products.list({ onSale:
+  true })` lists the products priced below their compare-at price. Both need
+  a server with collections.
+
+### Deprecated
+
+- `products.list({ featured: true })` and `ProductList.storeFeatured`: they
+  mean the `featured` collection; removed in 2.0.
+- `StoreConfig.primaryColor`, `accentColor`, `bgColor`, `fontFamily` and
+  `fontUrl`. A store's colors and font are its theme's settings: a theme
+  declares them (`defineTheme({ settings })` in `@wocart/theme`) and reads
+  `themeSettings`. The fields still arrive — the values saved before, no
+  longer editable (`fontUrl` is always null) — and are removed in 2.0.
+- `StoreConfig.announcementBar`: always null. An announcement is a theme's
+  own content, declared as a theme setting; removed in 2.0.
+
 ## 1.7.0 — 2026-10-17
 
 ### Added

package/USAGE.md

@@ -483,23 +483,25 @@ store.
 ## Store configuration
 
 Use config.get() near the root of every page. It is the theme's starting point
-for branding and feature flags:
+for store identity and feature flags:
 
 ~~~ts
 const config = await store.config.get();
 
 const cartEnabled = config?.cartEnabled === true;
 const currencySymbol = config?.currencySymbol ?? "دج";
-const announcement = config?.announcementBar ?? null;
 ~~~
 
 StoreConfig contains the current store identity and presentation fields,
 including:
 
-- name, domain, logoUrl, themeId, colors, fontFamily, and fontUrl;
+- name, domain, logoUrl and themeId (the colors, fontFamily and fontUrl
+  fields are deprecated: colors and fonts are theme settings, read from
+  themeSettings);
 - lang (the primary language), locales, contentOverrides, themeSettings,
   currency, currencySymbol, metaTitle, metaDescription, and ogImage;
-- announcementBar and reviewsEnabled;
+- reviewsEnabled (announcementBar is deprecated and always null: an
+  announcement is a theme's own setting);
 - cartEnabled, freeShippingThreshold, and cartShippingMode;
 - checkoutForm policy;
 - OTP and Turnstile settings;
@@ -630,11 +632,28 @@ decides whether a product is publicly available.
 ~~~ts
 const products = await store.products.list({
   categoryId: selectedCategoryId,
-  featured: true,
   limit: 12,
 });
 ~~~
 
+**Collections** are lists of products the merchant curates by hand in the
+dashboard (Products → Collections): every store starts with `featured`,
+`best-sellers` and `new-arrivals`, and may add any other. A collection lists
+in the merchant's order:
+
+~~~ts
+const bestSellers = await store.products.list({ collection: "best-sellers", limit: 8 });
+const onSale = await store.products.list({ onSale: true, limit: 8 });
+~~~
+
+- Never hardcode which collection a section shows: declare a `collection`
+  field (`@wocart/theme`) with a default handle, so the merchant picks it.
+- An empty or unknown collection lists nothing — show nothing, never the
+  whole catalog instead: "Best sellers" means the merchant's picks.
+- `onSale` is computed: a product priced below its compare-at price.
+- `featured: true` and `ProductList.storeFeatured` are deprecated: they mean
+  the `featured` collection.
+
 Product lists return ProductList objects. ProductList and Product are
 different shapes: a list item is not a detail object and must not be cast to
 Product. ProductList carries list-oriented fields such as coverImage and

package/dist/client/products.d.ts

@@ -26,7 +26,7 @@ export interface ProductsNamespace {
     get(handle: string): Promise<Product | null>;
     /**
      * List products with optional filters
-     * @param filters - Optional category, featured flag, limit and offset
+     * @param filters - Optional collection, category, on-sale flag, limit and offset
      * @returns Array of products
      */
     list(filters?: ProductListFilters): Promise<ProductList[]>;

package/dist/client/products.js

@@ -28,6 +28,8 @@ export function createProductsNamespace(core) {
         try {
             const products = await core.get(localizedPath(core.config, "/store/products", {
                 categoryId: filters?.categoryId || undefined,
+                collection: filters?.collection || undefined,
+                onSale: filters?.onSale ? "true" : undefined,
                 featured: filters?.featured ? "true" : undefined,
                 limit: filters?.limit === undefined ? undefined : String(filters.limit),
                 offset: filters?.offset ? String(filters.offset) : undefined,

package/dist/schemas.js

@@ -82,6 +82,7 @@ const productBaseFields = {
     visibility: z.boolean(),
     status: z.enum(["DRAFT", "ACTIVE", "ARCHIVED"]),
     showInStore: z.boolean(),
+    /** @deprecated Whether the product is in the `featured` collection; list it with `collection: "featured"`. Removed in 2.0. */
     storeFeatured: z.boolean(),
     /**
      * @deprecated Always null: the server never serves a removed product. The

package/dist/types.d.ts

@@ -64,10 +64,31 @@ export interface StoreConfig {
     domain: string | null;
     logoUrl: string | null;
     themeId: string;
+    /**
+     * @deprecated A store's colors and font are its theme's settings: declare
+     * them in `defineTheme({ settings })` and read `themeSettings`. This is the
+     * value saved before that, no longer editable; removed in 2.0.
+     */
     primaryColor: string;
+    /**
+     * @deprecated A store's colors and font are its theme's settings: declare
+     * them in `defineTheme({ settings })` and read `themeSettings`. This is the
+     * value saved before that, no longer editable; removed in 2.0.
+     */
     accentColor: string;
+    /**
+     * @deprecated A store's colors and font are its theme's settings: declare
+     * them in `defineTheme({ settings })` and read `themeSettings`. This is the
+     * value saved before that, no longer editable; removed in 2.0.
+     */
     bgColor: string;
+    /**
+     * @deprecated A store's colors and font are its theme's settings: declare
+     * them in `defineTheme({ settings })` and read `themeSettings`. This is the
+     * value saved before that, no longer editable; removed in 2.0.
+     */
     fontFamily: string;
+    /** @deprecated Always null; removed in 2.0. */
     fontUrl: string | null;
     /** The store's primary language: a BCP 47 code such as `ar`. */
     lang: string;
@@ -99,6 +120,10 @@ export interface StoreConfig {
     metaTitle: string | null;
     metaDescription: string | null;
     ogImage: string | null;
+    /**
+     * @deprecated Always null. An announcement is a theme's own content: declare
+     * it as a theme setting and read `themeSettings`. Removed in 2.0.
+     */
     announcementBar: string | null;
     reviewsEnabled: boolean;
     /** When true the storefront renders the cart alongside the direct order form. */
@@ -494,6 +519,16 @@ export interface ReviewSubmitResult {
  */
 export interface ProductListFilters {
     categoryId?: string;
+    /**
+     * Only this collection's products, by handle (`best-sellers`), in the order
+     * the merchant gave them. A collection is a list the merchant curates in the
+     * dashboard; a theme names it through a `collection` theme setting. An
+     * unknown handle lists nothing.
+     */
+    collection?: string;
+    /** Only products priced below their compare-at price. */
+    onSale?: boolean;
+    /** @deprecated Use `collection: "featured"`. */
     featured?: boolean;
     /** Server-side cap; the server clamps anything larger. */
     limit?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wocart/storefront",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Typed, validated SDK for Wocart cash-on-delivery storefronts: catalog reads, basket, checkout, OTP and order tracking, with Astro adapters.",
   "keywords": [
     "wocart",