npm - create-cartbase - Versions diffs - 0.1.16 → 0.1.18 - Mend

create-cartbase 0.1.16 → 0.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

package/LICENSE +21 -21
package/README.md +25 -25
package/dist/index.js +20 -20
package/package.json +1 -1
package/template/app/docs/auth.md +105 -105
package/template/app/docs/carts.md +376 -376
package/template/app/docs/categories.md +194 -194
package/template/app/docs/checkout.md +714 -714
package/template/app/docs/components.md +55 -11
package/template/app/docs/consent.md +91 -91
package/template/app/docs/deploy.md +197 -197
package/template/app/docs/gift-cards.md +153 -153
package/template/app/docs/metaobjects.md +126 -126
package/template/app/docs/orders.md +221 -221
package/template/app/docs/products.md +51 -2
package/template/app/docs/regions.md +269 -269
package/template/app/docs/reviews.md +223 -223
package/template/app/docs/search.md +227 -227
package/template/app/docs/store.md +47 -47
package/template/app/docs/subscriptions.md +148 -148
package/template/app/docs/variables.md +315 -315
package/template/app/package.json +1 -1
package/template/app/postcss.config.cjs +11 -11
package/template/app/src/app/checkout/checkout-page-client.tsx +73 -73
package/template/app/src/app/checkout/page.tsx +48 -48
package/template/app/src/app/globals.css +26 -26
package/template/app/src/app/page.tsx +28 -28
package/template/app/src/app/products/[handle]/page.tsx +87 -87
package/template/app/src/app/providers.tsx +68 -64
package/template/app/src/app/search/page.tsx +23 -23
package/template/app/src/lib/browser-client.ts +35 -35
package/template/app/src/lib/config.ts +41 -41
package/template/app/src/lib/server-client.ts +25 -25
package/template/app/src/lib/cart-actions.ts +0 -47

package/template/app/src/app/providers.tsx CHANGED Viewed

@@ -1,64 +1,68 @@
-"use client"
-import type { Cart } from "@cartbase/storefront/api/carts"
-import { CartDrawerProvider } from "@cartbase/storefront/cart-drawer/context"
-import { CartDrawerTemplate } from "@cartbase/storefront/cart-drawer/template"
-import { ConsentBanner } from "@cartbase/storefront/tracking/consent-banner"
-import {
-  pickConsentCopy,
-  shouldRenderBanner,
-  type ConsentSettings,
-} from "@cartbase/storefront/tracking/consent"
-import { StorefrontLocaleProvider } from "@cartbase/storefront/locales"
-import { CART_COOKIE, CART_COOKIE_MAX_AGE, STORE_LOCALE } from "@/lib/config"
-import { browserClient } from "@/lib/browser-client"
-/**
- * Client-side shell: the store's language, ONE CartDrawerProvider per app
- * (cart-drawer family mount rule) + the consent banner (consent.md: render
- * the builtin banner only when `enabled && mode === "builtin"`; ConsentInit
- * stays in the server layout as the first child of <body>).
- *
- * The language is mounted once, here. Every client component inside reads
- * it, the cart drawer included, so nothing is handed over below. The
- * server-rendered templates cannot read it, so each page hands them their
- * area (`labels={STORE_LOCALE.store}`), and those props are required.
- */
-export function Providers({
-  cart,
-  consent,
-  children,
-}: {
-  cart: Cart | null
-  consent: ConsentSettings
-  children: React.ReactNode
-}) {
-  // The store's own consent copy, in the store's language where it has it;
-  // pickConsentCopy falls back to English and then to whatever exists.
-  const copy = pickConsentCopy(consent.copy, STORE_LOCALE.code)
-  return (
-    <StorefrontLocaleProvider locale={STORE_LOCALE}>
-      <CartDrawerProvider
-        cart={cart}
-        client={browserClient}
-        onCartChange={(next) => {
-          // Persist the cart id (carts.md: the app owns the cart cookie).
-          document.cookie = `${CART_COOKIE}=${encodeURIComponent(
-            next.id
-          )};path=/;max-age=${CART_COOKIE_MAX_AGE};samesite=lax`
-        }}
-      >
-        {children}
-        <CartDrawerTemplate />
-        {shouldRenderBanner(consent) && copy && (
-          <ConsentBanner
-            copy={copy}
-            layout={consent.layout}
-            privacyHref={consent.privacy_href}
-            rejectOnFirstLayer={consent.reject_on_first_layer}
-          />
-        )}
-      </CartDrawerProvider>
-    </StorefrontLocaleProvider>
-  )
-}
+"use client"
+import type { Cart } from "@cartbase/storefront/api/carts"
+import { CartDrawerProvider } from "@cartbase/storefront/cart-drawer/context"
+import { CartDrawerTemplate } from "@cartbase/storefront/cart-drawer/template"
+import { ConsentBanner } from "@cartbase/storefront/tracking/consent-banner"
+import {
+  pickConsentCopy,
+  shouldRenderBanner,
+  type ConsentSettings,
+} from "@cartbase/storefront/tracking/consent"
+import { StorefrontLocaleProvider } from "@cartbase/storefront/locales"
+import { clearCartCookie } from "@cartbase/storefront/lib/cookie-names"
+import { CART_COOKIE, CART_COOKIE_MAX_AGE, STORE_LOCALE } from "@/lib/config"
+import { browserClient } from "@/lib/browser-client"
+/**
+ * Client-side shell: the store's language, ONE CartDrawerProvider per app
+ * (cart-drawer family mount rule) + the consent banner (consent.md: render
+ * the builtin banner only when `enabled && mode === "builtin"`; ConsentInit
+ * stays in the server layout as the first child of <body>).
+ *
+ * The language is mounted once, here. Every client component inside reads
+ * it, the cart drawer included, so nothing is handed over below. The
+ * server-rendered templates cannot read it, so each page hands them their
+ * area (`labels={STORE_LOCALE.store}`), and those props are required.
+ */
+export function Providers({
+  cart,
+  consent,
+  children,
+}: {
+  cart: Cart | null
+  consent: ConsentSettings
+  children: React.ReactNode
+}) {
+  // The store's own consent copy, in the store's language where it has it;
+  // pickConsentCopy falls back to English and then to whatever exists.
+  const copy = pickConsentCopy(consent.copy, STORE_LOCALE.code)
+  return (
+    <StorefrontLocaleProvider locale={STORE_LOCALE}>
+      <CartDrawerProvider
+        cart={cart}
+        client={browserClient}
+        onCartChange={(next) => {
+          // Persist the cart id (carts.md: the app owns the cart cookie).
+          document.cookie = `${CART_COOKIE}=${encodeURIComponent(
+            next.id
+          )};path=/;max-age=${CART_COOKIE_MAX_AGE};samesite=lax`
+        }}
+        // The cart is over (ordered, or gone): forget the stored id, so the
+        // next add starts a new cart.
+        onCartEnd={clearCartCookie}
+      >
+        {children}
+        <CartDrawerTemplate />
+        {shouldRenderBanner(consent) && copy && (
+          <ConsentBanner
+            copy={copy}
+            layout={consent.layout}
+            privacyHref={consent.privacy_href}
+            rejectOnFirstLayer={consent.reject_on_first_layer}
+          />
+        )}
+      </CartDrawerProvider>
+    </StorefrontLocaleProvider>
+  )
+}

package/template/app/src/app/search/page.tsx CHANGED Viewed

@@ -1,23 +1,23 @@
-import { SearchTemplate } from "@cartbase/storefront/store/search-template"
-import { PRICING_CONTEXT, STORE_LOCALE } from "@/lib/config"
-import { getServerClient } from "@/lib/server-client"
-/** Search page (runbook step 5) — fully URL-state driven search-template. */
-export default async function SearchPage({
-  searchParams,
-}: {
-  searchParams: Promise<Record<string, string | string[] | undefined>>
-}) {
-  const params = await searchParams
-  const client = await getServerClient()
-  return (
-    <SearchTemplate
-      client={client}
-      searchParams={params}
-      pricingContext={PRICING_CONTEXT}
-      // Server-rendered: the locale provider cannot reach it, so the pack
-      // comes as a prop, and the prop is required.
-      labels={STORE_LOCALE.store}
-    />
-  )
-}
+import { SearchTemplate } from "@cartbase/storefront/store/search-template"
+import { PRICING_CONTEXT, STORE_LOCALE } from "@/lib/config"
+import { getServerClient } from "@/lib/server-client"
+/** Search page (runbook step 5) — fully URL-state driven search-template. */
+export default async function SearchPage({
+  searchParams,
+}: {
+  searchParams: Promise<Record<string, string | string[] | undefined>>
+}) {
+  const params = await searchParams
+  const client = await getServerClient()
+  return (
+    <SearchTemplate
+      client={client}
+      searchParams={params}
+      pricingContext={PRICING_CONTEXT}
+      // Server-rendered: the locale provider cannot reach it, so the pack
+      // comes as a prop, and the prop is required.
+      labels={STORE_LOCALE.store}
+    />
+  )
+}

package/template/app/src/lib/browser-client.ts CHANGED Viewed

@@ -1,35 +1,35 @@
-"use client"
-import { StorefrontClient } from "@cartbase/storefront/api/http"
-import {
-  BARTER_CLIENT_ID,
-  BARTER_PUBLISHABLE_KEY,
-  BARTER_URL,
-  LOCALE_COOKIE,
-} from "./config"
-function readCookie(name: string): string | null {
-  if (typeof document === "undefined") return null
-  const match = document.cookie
-    .split("; ")
-    .find((row) => row.startsWith(`${name}=`))
-  return match ? decodeURIComponent(match.slice(name.length + 1)) : null
-}
-/**
- * Browser-scope StorefrontClient (runbook step 2): constructed once per
- * app. Guest-only reference app — no auth token store.
- *
- * baseUrl is the APP origin, not the API origin: the store API ships no
- * CORS headers, so browser calls ride the same-origin `/api/store/*`
- * rewrite (next.config.ts). During SSR of client components no fetches
- * run — the API origin stands in only to satisfy the constructor.
- */
-export const browserClient = new StorefrontClient({
-  baseUrl:
-    typeof window !== "undefined" ? window.location.origin : BARTER_URL,
-  clientId: BARTER_CLIENT_ID,
-  publishableKey: BARTER_PUBLISHABLE_KEY,
-  getAuthToken: () => null,
-  getLocale: () => readCookie(LOCALE_COOKIE),
-})
+"use client"
+import { StorefrontClient } from "@cartbase/storefront/api/http"
+import {
+  BARTER_CLIENT_ID,
+  BARTER_PUBLISHABLE_KEY,
+  BARTER_URL,
+  LOCALE_COOKIE,
+} from "./config"
+function readCookie(name: string): string | null {
+  if (typeof document === "undefined") return null
+  const match = document.cookie
+    .split("; ")
+    .find((row) => row.startsWith(`${name}=`))
+  return match ? decodeURIComponent(match.slice(name.length + 1)) : null
+}
+/**
+ * Browser-scope StorefrontClient (runbook step 2): constructed once per
+ * app. Guest-only reference app — no auth token store.
+ *
+ * baseUrl is the APP origin, not the API origin: the store API ships no
+ * CORS headers, so browser calls ride the same-origin `/api/store/*`
+ * rewrite (next.config.ts). During SSR of client components no fetches
+ * run — the API origin stands in only to satisfy the constructor.
+ */
+export const browserClient = new StorefrontClient({
+  baseUrl:
+    typeof window !== "undefined" ? window.location.origin : BARTER_URL,
+  clientId: BARTER_CLIENT_ID,
+  publishableKey: BARTER_PUBLISHABLE_KEY,
+  getAuthToken: () => null,
+  getLocale: () => readCookie(LOCALE_COOKIE),
+})

package/template/app/src/lib/config.ts CHANGED Viewed

@@ -1,41 +1,41 @@
-/** Shared storefront configuration (BUILD-A-STOREFRONT.md — the one input). */
-import { cartbaseApiOrigin } from "@cartbase/storefront/lib/platform"
-/**
- * The store's publishable key names the store and scopes its catalog: the
- * ONE value a storefront needs (one key, 2026-09-07). The origin is the
- * platform's, overridable for a local or staging platform; the client id is
- * the platform's own door (hosted builds carry it) and never something to
- * copy by hand.
- */
-export const BARTER_PUBLISHABLE_KEY =
-  process.env.NEXT_PUBLIC_CARTBASE_PUBLISHABLE_KEY || undefined
-export const BARTER_URL = cartbaseApiOrigin(process.env.NEXT_PUBLIC_CARTBASE_URL)
-export const BARTER_CLIENT_ID = process.env.NEXT_PUBLIC_CARTBASE_CLIENT_ID || undefined
-/**
- * Cart-id cookie — owned by the app (the SDK never persists the cart);
- * the NAME is owned by the library so every consumer emits the same wire
- * fingerprint (platform-fingerprints card). `readCartCookie` is the
- * backward-compat reader for the legacy `_barter_cart_id` name.
- */
-export { CART_COOKIE, readCartCookie } from "@cartbase/storefront/lib/cookie-names"
-export const CART_COOKIE_MAX_AGE = 60 * 60 * 24 * 30 // 30 days
-/** Locale cookie read by the clients' `getLocale`. */
-export const LOCALE_COOKIE = "_barter_locale"
-/**
- * THE STORE'S LANGUAGE, declared once. The library speaks international
- * English and knows no other language; a language is a typed pack the store
- * imports. Swap `en` for `bg` or `es` here (`@cartbase/storefront/locales/bg`)
- * and every screen follows: providers.tsx mounts it for the client
- * components, and each page hands the server-rendered templates their area
- * from it (`labels={STORE_LOCALE.store}`), because a server component cannot
- * read a client context. Those props are required, so a page cannot forget.
- */
-export { en as STORE_LOCALE } from "@cartbase/storefront/locales/en"
-/** Pricing context for every catalog surface (runbook step 5). EUR only. */
-export const PRICING_CONTEXT = { currency_code: "eur" } as const
+/** Shared storefront configuration (BUILD-A-STOREFRONT.md — the one input). */
+import { cartbaseApiOrigin } from "@cartbase/storefront/lib/platform"
+/**
+ * The store's publishable key names the store and scopes its catalog: the
+ * ONE value a storefront needs (one key, 2026-09-07). The origin is the
+ * platform's, overridable for a local or staging platform; the client id is
+ * the platform's own door (hosted builds carry it) and never something to
+ * copy by hand.
+ */
+export const BARTER_PUBLISHABLE_KEY =
+  process.env.NEXT_PUBLIC_CARTBASE_PUBLISHABLE_KEY || undefined
+export const BARTER_URL = cartbaseApiOrigin(process.env.NEXT_PUBLIC_CARTBASE_URL)
+export const BARTER_CLIENT_ID = process.env.NEXT_PUBLIC_CARTBASE_CLIENT_ID || undefined
+/**
+ * Cart-id cookie — owned by the app (the SDK never persists the cart);
+ * the NAME is owned by the library so every consumer emits the same wire
+ * fingerprint (platform-fingerprints card). `readCartCookie` is the
+ * backward-compat reader for the legacy `_barter_cart_id` name.
+ */
+export { CART_COOKIE, readCartCookie } from "@cartbase/storefront/lib/cookie-names"
+export const CART_COOKIE_MAX_AGE = 60 * 60 * 24 * 30 // 30 days
+/** Locale cookie read by the clients' `getLocale`. */
+export const LOCALE_COOKIE = "_barter_locale"
+/**
+ * THE STORE'S LANGUAGE, declared once. The library speaks international
+ * English and knows no other language; a language is a typed pack the store
+ * imports. Swap `en` for `bg` or `es` here (`@cartbase/storefront/locales/bg`)
+ * and every screen follows: providers.tsx mounts it for the client
+ * components, and each page hands the server-rendered templates their area
+ * from it (`labels={STORE_LOCALE.store}`), because a server component cannot
+ * read a client context. Those props are required, so a page cannot forget.
+ */
+export { en as STORE_LOCALE } from "@cartbase/storefront/locales/en"
+/** Pricing context for every catalog surface (runbook step 5). EUR only. */
+export const PRICING_CONTEXT = { currency_code: "eur" } as const

package/template/app/src/lib/server-client.ts CHANGED Viewed

@@ -1,25 +1,25 @@
-import { cookies } from "next/headers"
-import { StorefrontClient } from "@cartbase/storefront/api/http"
-import {
-  BARTER_CLIENT_ID,
-  BARTER_PUBLISHABLE_KEY,
-  BARTER_URL,
-  LOCALE_COOKIE,
-} from "./config"
-/**
- * Server-scope StorefrontClient (runbook step 2): construct per request;
- * `getLocale` reads the locale cookie. No customer accounts in this
- * reference app, so `getAuthToken` always answers null (guest).
- */
-export async function getServerClient(): Promise<StorefrontClient> {
-  const jar = await cookies()
-  const locale = jar.get(LOCALE_COOKIE)?.value ?? null
-  return new StorefrontClient({
-    baseUrl: BARTER_URL,
-    clientId: BARTER_CLIENT_ID,
-    publishableKey: BARTER_PUBLISHABLE_KEY,
-    getAuthToken: () => null,
-    getLocale: () => locale,
-  })
-}
+import { cookies } from "next/headers"
+import { StorefrontClient } from "@cartbase/storefront/api/http"
+import {
+  BARTER_CLIENT_ID,
+  BARTER_PUBLISHABLE_KEY,
+  BARTER_URL,
+  LOCALE_COOKIE,
+} from "./config"
+/**
+ * Server-scope StorefrontClient (runbook step 2): construct per request;
+ * `getLocale` reads the locale cookie. No customer accounts in this
+ * reference app, so `getAuthToken` always answers null (guest).
+ */
+export async function getServerClient(): Promise<StorefrontClient> {
+  const jar = await cookies()
+  const locale = jar.get(LOCALE_COOKIE)?.value ?? null
+  return new StorefrontClient({
+    baseUrl: BARTER_URL,
+    clientId: BARTER_CLIENT_ID,
+    publishableKey: BARTER_PUBLISHABLE_KEY,
+    getAuthToken: () => null,
+    getLocale: () => locale,
+  })
+}

package/template/app/src/lib/cart-actions.ts DELETED Viewed

@@ -1,47 +0,0 @@
-"use server"
-import { revalidatePath } from "next/cache"
-import { cookies } from "next/headers"
-import { addLineItem, createCart } from "@cartbase/storefront/api/carts"
-import { CART_COOKIE, CART_COOKIE_MAX_AGE, readCartCookie } from "./config"
-import { getServerClient } from "./server-client"
-/**
- * PDP add-to-cart server action (carts.md: create the cart lazily on the
- * first add — region falls back to the store default; persist `cart.id`
- * in a cookie). Passed into `ProductTemplate`'s `addToCart` seam.
- *
- * Reads via `readCartCookie` (new `_cartbase_cart` name, falls back to the
- * legacy `_barter_cart_id` — platform-fingerprints card); every WRITE uses
- * the new name only, so a visitor's cart survives the rename.
- */
-export async function addToCartAction(input: {
-  variantId: string
-  quantity: number
-}): Promise<void> {
-  const client = await getServerClient()
-  const jar = await cookies()
-  const cartId = readCartCookie((name) => jar.get(name)?.value)
-  if (cartId) {
-    await addLineItem(client, cartId, {
-      variant_id: input.variantId,
-      quantity: input.quantity,
-    })
-  } else {
-    const { cart } = await createCart(client, {
-      currency_code: "eur",
-      items: [{ variant_id: input.variantId, quantity: input.quantity }],
-    })
-    jar.set(CART_COOKIE, cart.id, {
-      path: "/",
-      sameSite: "lax",
-      httpOnly: false, // the browser-side drawer persists the same cookie
-      maxAge: CART_COOKIE_MAX_AGE,
-    })
-  }
-  // Layout refetches the cart snapshot → CartDrawerProvider sees the new
-  // product-line count and auto-opens the drawer.
-  revalidatePath("/", "layout")
-}