@cimplify/sdk 0.42.0 → 0.43.0
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.
- package/package.json +1 -1
- package/templates/storefront-bakery/.claude/skills/cimplify-storefront/SKILL.md +145 -0
- package/templates/storefront-bakery/.cursor/rules/cimplify-storefront.mdc +25 -0
- package/templates/storefront-bakery/AGENTS.md +61 -10
- package/templates/storefront-bakery/CLAUDE.md +22 -0
- package/templates/storefront-fashion/.claude/skills/cimplify-storefront/SKILL.md +145 -0
- package/templates/storefront-fashion/.cursor/rules/cimplify-storefront.mdc +25 -0
- package/templates/storefront-fashion/AGENTS.md +80 -26
- package/templates/storefront-fashion/CLAUDE.md +22 -0
- package/templates/storefront-grocery/.claude/skills/cimplify-storefront/SKILL.md +145 -0
- package/templates/storefront-grocery/.cursor/rules/cimplify-storefront.mdc +25 -0
- package/templates/storefront-grocery/AGENTS.md +56 -11
- package/templates/storefront-grocery/CLAUDE.md +22 -0
- package/templates/storefront-restaurant/.claude/skills/cimplify-storefront/SKILL.md +145 -0
- package/templates/storefront-restaurant/.cursor/rules/cimplify-storefront.mdc +25 -0
- package/templates/storefront-restaurant/AGENTS.md +64 -13
- package/templates/storefront-restaurant/CLAUDE.md +22 -0
- package/templates/storefront-retail/.claude/skills/cimplify-storefront/SKILL.md +145 -0
- package/templates/storefront-retail/.cursor/rules/cimplify-storefront.mdc +25 -0
- package/templates/storefront-retail/AGENTS.md +65 -24
- package/templates/storefront-retail/CLAUDE.md +22 -0
- package/templates/storefront-services/.claude/skills/cimplify-storefront/SKILL.md +145 -0
- package/templates/storefront-services/.cursor/rules/cimplify-storefront.mdc +25 -0
- package/templates/storefront-services/AGENTS.md +64 -16
- package/templates/storefront-services/CLAUDE.md +22 -0
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: cimplify-storefront
|
|
3
|
+
description: Build, customize, rebrand, or deploy a Cimplify-scaffolded storefront. Triggers when the user asks to create a storefront, rebrand a Cimplify template, change the palette, add a page, deploy to Cimplify, or works in a project containing `lib/brand.ts` and `next.config.ts` with `cacheComponents`.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Cimplify Storefront skill
|
|
7
|
+
|
|
8
|
+
You're working on a project scaffolded from `bunx @cimplify/sdk init`. The architecture is opinionated and the rebrand surface is intentionally small. Read `AGENTS.md` at the project root for the file ↔ brand-field map for *this template's* industry; this skill gives you the playbook that's the same across all six.
|
|
9
|
+
|
|
10
|
+
## The contract — never break
|
|
11
|
+
|
|
12
|
+
1. **`lib/brand.ts` is the only place for content edits.** Every visible string reads from this file. If a string isn't in `brand`, *add a field* to the `Brand` interface — don't hardcode it in a page or component.
|
|
13
|
+
2. **`app/globals.css` `@theme { … }`** holds palette + radius + font references. To re-skin the entire site, edit only this block.
|
|
14
|
+
3. **Server Components are cached** via `'use cache'` + `cacheTag(tags.X())` + `cacheLife("hours")`. Don't downgrade them to `"use client"` to avoid an issue — fix the issue.
|
|
15
|
+
4. **Client islands** (anything reading `useSearchParams`, `usePathname`, `useRouter`, `useState`) live behind `<Suspense>`.
|
|
16
|
+
5. **`cacheComponents: true`** in `next.config.ts` is non-negotiable. Don't turn it off.
|
|
17
|
+
6. **`bun run test:run` (vitest)** is the canonical test runner. `bun test` will show false failures because Bun's `vi` shim is incomplete.
|
|
18
|
+
7. **Cart, checkout, orders stay client.** They're session-bound. Don't try to SSR them.
|
|
19
|
+
|
|
20
|
+
## The brand-field schema (in `lib/brand.ts`)
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
identity: name, shortName, microTag, description, schemaType, currency, locale
|
|
24
|
+
contact: address, streetAddress, city, countryCode, phone, phoneTel, email, privacyEmail, hours
|
|
25
|
+
socials: [{ label, href, icon }] // icon ∈ instagram|x|tiktok|facebook|youtube|linkedin|whatsapp
|
|
26
|
+
header: { nav: [{ label, href }] }
|
|
27
|
+
hero: { badge, title, subtitle, primaryCtaLabel, secondaryCtaLabel?, secondaryCtaHref? }
|
|
28
|
+
optional: trustItems[]?, brandStrip?, promo?, tradeIn? // render conditionally
|
|
29
|
+
newsletter: { eyebrow, title, body, placeholder, submitLabel, successLabel }
|
|
30
|
+
about: { eyebrow, title, paragraphs[], sections[{ heading, body }] }
|
|
31
|
+
faq: { eyebrow, title, sections[{ title, items[{ q, a }] }], contactPrompt, contactEmail }
|
|
32
|
+
terms,
|
|
33
|
+
privacy,
|
|
34
|
+
shipping,
|
|
35
|
+
returns,
|
|
36
|
+
accessibility: { eyebrow, title, lastUpdated, sections[{ heading, body | { intro, bullets[] } }] }
|
|
37
|
+
account: eyebrows + titles for /account, /login, /signup
|
|
38
|
+
contactPage: { eyebrow, title, body, reasons[], directLines[{ label, value, href }] }
|
|
39
|
+
trackOrder: { eyebrow, title, body }
|
|
40
|
+
footer: { blurb, sitemap[{ title, links[] }], poweredBy? }
|
|
41
|
+
llms: { summary } // opens /llms.txt
|
|
42
|
+
mock: { seed, businessId }
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Playbook — common tasks
|
|
46
|
+
|
|
47
|
+
### Rebrand a storefront for a new merchant
|
|
48
|
+
|
|
49
|
+
1. Edit `lib/brand.ts`. Replace every field with the merchant's content. Use the brief / context the user gave you.
|
|
50
|
+
2. Edit `app/globals.css` `@theme { … }`. Change `--color-primary`, `--color-background`, `--color-foreground`, optionally `--radius`. Use OKLCH; if the brand only gave hex, convert.
|
|
51
|
+
3. (Optional) Swap fonts in `app/layout.tsx` — `next/font/google` import + the variable wired into the `<html>` className.
|
|
52
|
+
4. Set `.env.local`: `NEXT_PUBLIC_CIMPLIFY_API_URL`, `NEXT_PUBLIC_CIMPLIFY_PUBLIC_KEY`, `NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID`, `NEXT_PUBLIC_SITE_URL`.
|
|
53
|
+
|
|
54
|
+
Don't touch any other file. If the rebrand needs content not in the schema, add the field to `Brand` first, populate it, then read it from the page.
|
|
55
|
+
|
|
56
|
+
### Add a new section / component
|
|
57
|
+
|
|
58
|
+
1. Build it as a Server Component in `components/` (or a client island in `*-client.tsx` if interactive).
|
|
59
|
+
2. Read merchant copy from `brand`. Add new fields to the `Brand` interface if needed.
|
|
60
|
+
3. Wrap interactive bits in `<Suspense fallback={…}>` so the cached chrome streams.
|
|
61
|
+
4. Compose into the page.
|
|
62
|
+
|
|
63
|
+
### Wire a Server Action that mutates data
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
"use server";
|
|
67
|
+
import { getServerClient, revalidateProducts } from "@cimplify/sdk/server";
|
|
68
|
+
|
|
69
|
+
export async function createProduct(input: ProductInput) {
|
|
70
|
+
await getServerClient().catalogue.createProduct(input);
|
|
71
|
+
revalidateProducts();
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
After every mutation, call the matching `revalidate*` helper from `@cimplify/sdk/server`: `revalidateProducts`, `revalidateProduct(id)`, `revalidateCategories`, `revalidateCategory(id)`, `revalidateCollections`, `revalidateCollection(id)`, `revalidateBusiness`.
|
|
76
|
+
|
|
77
|
+
### Add a Server Component data fetch
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
import { cacheTag, cacheLife } from "next/cache";
|
|
81
|
+
import { getServerClient, tags } from "@cimplify/sdk/server";
|
|
82
|
+
|
|
83
|
+
async function getX() {
|
|
84
|
+
"use cache";
|
|
85
|
+
cacheTag(tags.products());
|
|
86
|
+
cacheLife("hours");
|
|
87
|
+
const r = await getServerClient().catalogue.getProducts({ limit: 24 });
|
|
88
|
+
if (!r.ok) throw new Error(r.error.message);
|
|
89
|
+
return r.value.items;
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Eject an SDK component for deeper customization
|
|
94
|
+
|
|
95
|
+
Try `classNames`, `renderImage`, `renderLink`, slot props first. If those run out:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
bunx @cimplify/sdk eject --list
|
|
99
|
+
bunx @cimplify/sdk eject product-card --dir src/components/cimplify
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Once ejected, the file is yours. Hooks/types still come from `@cimplify/sdk`.
|
|
103
|
+
|
|
104
|
+
### Deploy
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
bunx @cimplify/sdk login
|
|
108
|
+
bunx @cimplify/sdk projects create my-store
|
|
109
|
+
bunx @cimplify/sdk link <project-id>
|
|
110
|
+
bunx @cimplify/sdk env push
|
|
111
|
+
bunx @cimplify/sdk deploy --prod
|
|
112
|
+
bunx @cimplify/sdk logs --follow
|
|
113
|
+
bunx @cimplify/sdk domains add my-store.com
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Pitfalls — explicit ❌ list
|
|
117
|
+
|
|
118
|
+
- ❌ Hardcoding any visible string in a page or component. Always `brand.X`.
|
|
119
|
+
- ❌ Disabling `cacheComponents: true` to silence a warning. Fix the warning by wrapping the dynamic call in `<Suspense>`.
|
|
120
|
+
- ❌ Using `unstable_cache` — Next 16's canonical primitive is `'use cache'` + `cacheTag` + `cacheLife`.
|
|
121
|
+
- ❌ Bypassing `getServerClient()` and calling `createCimplifyClient` directly in a Server Component — loses per-request memoization.
|
|
122
|
+
- ❌ Mutating data without calling the matching `revalidate*` helper.
|
|
123
|
+
- ❌ Adding an `app/error.tsx` handler that calls `reset()` without logging — silently swallowed errors hide bugs.
|
|
124
|
+
- ❌ Running `bun test` and reporting failures. Use `bun run test:run` (vitest).
|
|
125
|
+
- ❌ Editing the per-template `AGENTS.md` to remove notes about TODOs (contact form, newsletter fake submits) — they're real.
|
|
126
|
+
|
|
127
|
+
## Where things live
|
|
128
|
+
|
|
129
|
+
| Need | Look here |
|
|
130
|
+
|---|---|
|
|
131
|
+
| Which page reads which `brand.X` field | `AGENTS.md` at project root |
|
|
132
|
+
| Architectural rules | `AGENTS.md` at project root + this skill |
|
|
133
|
+
| Running locally | `bun dev` (boots mock + Next together) |
|
|
134
|
+
| Switching mock seed | edit `dev:mock` in `package.json` and `NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID` in `.env.local` |
|
|
135
|
+
| Full SDK reference | `docs/sdk/storefronts.md` in the Cimplify repo |
|
|
136
|
+
|
|
137
|
+
## What to do when the user asks something out-of-scope
|
|
138
|
+
|
|
139
|
+
If the user asks for something the template doesn't support out of the box:
|
|
140
|
+
|
|
141
|
+
1. **Check first** — is there an SDK component or hook that does it? `@cimplify/sdk/react` has 50+ components, 30+ hooks. Search `node_modules/@cimplify/sdk/dist/react.d.mts` if needed.
|
|
142
|
+
2. **Compose from existing parts** before authoring new ones.
|
|
143
|
+
3. **If genuinely missing** — build the new component, hoist its strings into `brand.ts`, document in `AGENTS.md`.
|
|
144
|
+
|
|
145
|
+
Don't introduce competing patterns (a new caching strategy, a new auth flow, a new theming system). The template's opinions are intentional.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Cimplify storefront — architectural rules and rebrand contract for a project scaffolded from `bunx @cimplify/sdk init`. Triggers when files like lib/brand.ts, app/globals.css, components/header.tsx, or .cimplify/project.json are in the workspace.
|
|
3
|
+
globs: ["lib/brand.ts", "app/**", "components/**", ".env.local", "next.config.ts"]
|
|
4
|
+
alwaysApply: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Cimplify storefront
|
|
8
|
+
|
|
9
|
+
This project was scaffolded from a Cimplify template. Read `AGENTS.md` at the project root for the file ↔ `brand.X` field map and `.claude/skills/cimplify-storefront/SKILL.md` for the full playbook.
|
|
10
|
+
|
|
11
|
+
## The contract
|
|
12
|
+
|
|
13
|
+
1. **`lib/brand.ts`** — every visible string. If something isn't there, add a field to the `Brand` interface; don't hardcode.
|
|
14
|
+
2. **`app/globals.css` `@theme` block** — palette, radius, font references.
|
|
15
|
+
3. **Server Components are cached** via `'use cache'` + `cacheTag(tags.X())` + `cacheLife("hours")`. Don't downgrade to client to silence a warning.
|
|
16
|
+
4. **Client islands** behind `<Suspense>`.
|
|
17
|
+
5. **`cacheComponents: true`** in `next.config.ts` is non-negotiable.
|
|
18
|
+
6. Use **`bun run test:run`** (vitest), not `bun test`.
|
|
19
|
+
|
|
20
|
+
## Don't
|
|
21
|
+
|
|
22
|
+
- Hardcode visible strings in pages/components.
|
|
23
|
+
- Use `unstable_cache` (Next 16 uses `'use cache'`).
|
|
24
|
+
- Bypass `getServerClient()` (loses per-request memoization).
|
|
25
|
+
- Mutate without calling the matching `revalidate*` helper from `@cimplify/sdk/server`.
|
|
@@ -4,39 +4,75 @@ If you are an AI agent (Claude, Cursor, Aider, devin, …) working on this store
|
|
|
4
4
|
|
|
5
5
|
## TL;DR for rebranding
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
1. **Edit `lib/brand.ts`** — every visible string lives here.
|
|
8
|
+
2. **Edit `app/globals.css`** — `@theme { … }` block for palette + radius + font references.
|
|
9
|
+
3. **Edit `.env.local`** — `NEXT_PUBLIC_CIMPLIFY_API_URL`, `NEXT_PUBLIC_CIMPLIFY_PUBLIC_KEY`, `NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID`, `NEXT_PUBLIC_SITE_URL`.
|
|
8
10
|
|
|
9
|
-
|
|
10
|
-
2. **Edit `app/globals.css`** — the `@theme { … }` block holds the design tokens (palette, radius, font references). Tweak to match the merchant's brand.
|
|
11
|
-
3. **Edit `.env.local`** — set `NEXT_PUBLIC_CIMPLIFY_API_URL`, `NEXT_PUBLIC_CIMPLIFY_PUBLIC_KEY`, `NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID`, `NEXT_PUBLIC_SITE_URL`.
|
|
11
|
+
## Aesthetic
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
- **Inter + JetBrains Mono** — clean modern sans, mono-spaced labels for spec-feel.
|
|
14
|
+
- **Cool navy + electric blue**: dark foreground, electric primary.
|
|
15
|
+
- **Sharp corners**: `0.5rem` — modern retail.
|
|
16
|
+
- **Section heroes** in dark with mono-spaced eyebrow labels.
|
|
14
17
|
|
|
15
|
-
##
|
|
18
|
+
## Page surface
|
|
16
19
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
-
|
|
20
|
-
|
|
21
|
-
-
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
```
|
|
21
|
+
app/
|
|
22
|
+
page.tsx Multi-section home — split hero, trust bar, category tiles,
|
|
23
|
+
promo banner, "Just dropped" grid, brand strip, collections,
|
|
24
|
+
trade-in CTA, best sellers, newsletter
|
|
25
|
+
shop/page.tsx SDK <CataloguePage/> with custom hero
|
|
26
|
+
search/page.tsx Search (SDK <SearchPage/>)
|
|
27
|
+
collections/[slug]/page.tsx Collection landing
|
|
28
|
+
categories/[slug]/page.tsx Category landing
|
|
29
|
+
products/[slug]/page.tsx Full product detail page (Product JSON-LD)
|
|
30
|
+
|
|
31
|
+
cart/page.tsx SDK <CartPage/>
|
|
32
|
+
checkout/page.tsx SDK <CheckoutPage/>
|
|
33
|
+
orders/[id]/page.tsx Post-checkout confirmation
|
|
34
|
+
|
|
35
|
+
account/page.tsx <CimplifyAccount /> (iframe)
|
|
36
|
+
account/orders/page.tsx <CimplifyAccount section="orders" />
|
|
37
|
+
account/addresses/page.tsx <CimplifyAccount section="addresses" />
|
|
38
|
+
account/settings/page.tsx <CimplifyAccount section="settings" />
|
|
39
|
+
login/page.tsx, signup/page.tsx redirects → /account
|
|
40
|
+
|
|
41
|
+
contact/page.tsx Branded contact form
|
|
42
|
+
track-order/page.tsx Guest lookup → /orders/[id]
|
|
43
|
+
|
|
44
|
+
about/page.tsx, faq/page.tsx Brand pages
|
|
45
|
+
shipping/page.tsx, returns/page.tsx, accessibility/page.tsx Standalone policies
|
|
46
|
+
terms/page.tsx, privacy/page.tsx
|
|
47
|
+
|
|
48
|
+
sitemap-page/page.tsx HTML sitemap
|
|
49
|
+
sitemap.ts, robots.ts XML sitemap, robots.txt
|
|
50
|
+
llms.txt/route.ts LLM-friendly site index
|
|
51
|
+
opensearch.xml/route.ts Browser search description
|
|
52
|
+
error.tsx, not-found.tsx Global boundaries
|
|
53
|
+
```
|
|
24
54
|
|
|
25
|
-
## File
|
|
55
|
+
## File ↔ brand-field map
|
|
26
56
|
|
|
27
57
|
| File | Reads from `brand` |
|
|
28
58
|
|---|---|
|
|
29
|
-
| `app/layout.tsx` |
|
|
59
|
+
| `app/layout.tsx` | identity, contact, socials, schemaType (Store JSON-LD) |
|
|
30
60
|
| `app/page.tsx` | `brand.hero`, `brand.trustItems`, `brand.brandStrip`, `brand.promo`, `brand.tradeIn`, `brand.newsletter` |
|
|
31
61
|
| `app/about/page.tsx` | `brand.about` |
|
|
32
62
|
| `app/faq/page.tsx` | `brand.faq` |
|
|
33
63
|
| `app/terms/page.tsx` | `brand.terms` |
|
|
34
64
|
| `app/privacy/page.tsx` | `brand.privacy` |
|
|
35
|
-
| `app/
|
|
65
|
+
| `app/shipping/page.tsx` | `brand.shipping` (warranty + returns + same-day delivery copy) |
|
|
66
|
+
| `app/returns/page.tsx` | `brand.returns` |
|
|
67
|
+
| `app/accessibility/page.tsx` | `brand.accessibility` |
|
|
68
|
+
| `app/contact/page.tsx` | `brand.contactPage`, `brand.contact` |
|
|
69
|
+
| `app/track-order/page.tsx` | `brand.trackOrder` |
|
|
70
|
+
| `app/account/*/page.tsx` | `brand.account` (Cimplify Link iframe owns the UI) |
|
|
71
|
+
| `app/products/[slug]/page.tsx` | `brand.name`, `brand.currency` (Product JSON-LD: brand, offer, availability) |
|
|
36
72
|
| `app/llms.txt/route.ts` | `brand.llms`, contact, currency |
|
|
37
|
-
| `app/
|
|
73
|
+
| `app/opensearch.xml/route.ts` | `brand.shortName`, `brand.name` |
|
|
38
74
|
| `components/header.tsx` | `brand.shortName`, `brand.microTag`, `brand.header.nav` |
|
|
39
|
-
| `components/footer.tsx` | `brand.footer`, contact
|
|
75
|
+
| `components/footer.tsx` | `brand.footer`, `brand.contact`, `brand.socials` |
|
|
40
76
|
| `components/promo-banner.tsx` | `brand.promo` (renders nothing if absent) |
|
|
41
77
|
| `components/trade-in-cta.tsx` | `brand.tradeIn` (renders nothing if absent) |
|
|
42
78
|
| `components/brand-marquee.tsx` | `brand.brandStrip` |
|
|
@@ -45,20 +81,25 @@ That is the entire rebrand. Do not modify any `.tsx` file in `app/` or `componen
|
|
|
45
81
|
|
|
46
82
|
## Retail-specific notes
|
|
47
83
|
|
|
48
|
-
- Product detail is a **full `/products/[slug]` page** with image gallery, customizer, related products rail, and Product JSON-LD.
|
|
49
|
-
- Schema.org type is `Store`.
|
|
50
|
-
- Optional sections render conditionally: `brand.promo`, `brand.tradeIn`, `brand.trustItems`, `brand.brandStrip`
|
|
51
|
-
- `app/page.tsx` uses Unsplash fallback hero
|
|
84
|
+
- Product detail is a **full `/products/[slug]` page** with image gallery, customizer, related products rail, and Product JSON-LD. Consideration purchases (phones, laptops, headphones) need real estate. Don't replace with a modal.
|
|
85
|
+
- Schema.org `@type` is `Store`.
|
|
86
|
+
- Optional sections render conditionally: set `brand.promo`, `brand.tradeIn`, `brand.trustItems`, or `brand.brandStrip` to `undefined` to hide them.
|
|
87
|
+
- `app/page.tsx` uses an Unsplash fallback hero (`HERO_FALLBACK_IMAGE`) — replace with the merchant's own product photography.
|
|
88
|
+
|
|
89
|
+
## Known TODOs
|
|
90
|
+
|
|
91
|
+
- Contact form + newsletter signup currently fake their submit. Wire `client.support.sendMessage(...)` for contact and a real list provider for newsletter.
|
|
92
|
+
- Trust-bar / brand-marquee imagery / wordmarks are placeholders — swap for the merchant's real partners.
|
|
52
93
|
|
|
53
94
|
## Mock seed
|
|
54
95
|
|
|
55
|
-
Wired to `--seed retail` (Currents Electronics)
|
|
96
|
+
Wired to `--seed retail` (Currents Electronics). Edit `dev:mock` in `package.json` to preview another seed.
|
|
56
97
|
|
|
57
98
|
## Quick start
|
|
58
99
|
|
|
59
100
|
```bash
|
|
60
101
|
bun install
|
|
61
|
-
bun dev
|
|
102
|
+
bun dev
|
|
62
103
|
```
|
|
63
104
|
|
|
64
105
|
Open <http://localhost:3000>.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
This project was scaffolded from a Cimplify storefront template (`bunx @cimplify/sdk init`).
|
|
4
|
+
|
|
5
|
+
## Read these first
|
|
6
|
+
|
|
7
|
+
- **`AGENTS.md`** at the project root — the file ↔ `brand.X` field map for *this template's* industry, plus the architectural rules.
|
|
8
|
+
- **`.claude/skills/cimplify-storefront/SKILL.md`** — the playbook for common tasks (rebrand, add a section, wire a Server Action, deploy, eject a component). Invoke it whenever you're asked to change content, palette, copy, or routing.
|
|
9
|
+
|
|
10
|
+
## The two-line summary
|
|
11
|
+
|
|
12
|
+
1. **Edit `lib/brand.ts`** for any visible string.
|
|
13
|
+
2. **Edit `app/globals.css` `@theme` block** for any palette / radius / font change.
|
|
14
|
+
|
|
15
|
+
That covers ~95% of what merchants ask for. For anything else, follow the `cimplify-storefront` skill.
|
|
16
|
+
|
|
17
|
+
## Don't do
|
|
18
|
+
|
|
19
|
+
- Hardcode strings in pages or components.
|
|
20
|
+
- Disable `cacheComponents: true` in `next.config.ts`.
|
|
21
|
+
- Use `unstable_cache` — Next 16's canonical primitive is `'use cache'`.
|
|
22
|
+
- Run `bun test` (Bun's `vi` shim is incomplete) — use `bun run test:run`.
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: cimplify-storefront
|
|
3
|
+
description: Build, customize, rebrand, or deploy a Cimplify-scaffolded storefront. Triggers when the user asks to create a storefront, rebrand a Cimplify template, change the palette, add a page, deploy to Cimplify, or works in a project containing `lib/brand.ts` and `next.config.ts` with `cacheComponents`.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Cimplify Storefront skill
|
|
7
|
+
|
|
8
|
+
You're working on a project scaffolded from `bunx @cimplify/sdk init`. The architecture is opinionated and the rebrand surface is intentionally small. Read `AGENTS.md` at the project root for the file ↔ brand-field map for *this template's* industry; this skill gives you the playbook that's the same across all six.
|
|
9
|
+
|
|
10
|
+
## The contract — never break
|
|
11
|
+
|
|
12
|
+
1. **`lib/brand.ts` is the only place for content edits.** Every visible string reads from this file. If a string isn't in `brand`, *add a field* to the `Brand` interface — don't hardcode it in a page or component.
|
|
13
|
+
2. **`app/globals.css` `@theme { … }`** holds palette + radius + font references. To re-skin the entire site, edit only this block.
|
|
14
|
+
3. **Server Components are cached** via `'use cache'` + `cacheTag(tags.X())` + `cacheLife("hours")`. Don't downgrade them to `"use client"` to avoid an issue — fix the issue.
|
|
15
|
+
4. **Client islands** (anything reading `useSearchParams`, `usePathname`, `useRouter`, `useState`) live behind `<Suspense>`.
|
|
16
|
+
5. **`cacheComponents: true`** in `next.config.ts` is non-negotiable. Don't turn it off.
|
|
17
|
+
6. **`bun run test:run` (vitest)** is the canonical test runner. `bun test` will show false failures because Bun's `vi` shim is incomplete.
|
|
18
|
+
7. **Cart, checkout, orders stay client.** They're session-bound. Don't try to SSR them.
|
|
19
|
+
|
|
20
|
+
## The brand-field schema (in `lib/brand.ts`)
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
identity: name, shortName, microTag, description, schemaType, currency, locale
|
|
24
|
+
contact: address, streetAddress, city, countryCode, phone, phoneTel, email, privacyEmail, hours
|
|
25
|
+
socials: [{ label, href, icon }] // icon ∈ instagram|x|tiktok|facebook|youtube|linkedin|whatsapp
|
|
26
|
+
header: { nav: [{ label, href }] }
|
|
27
|
+
hero: { badge, title, subtitle, primaryCtaLabel, secondaryCtaLabel?, secondaryCtaHref? }
|
|
28
|
+
optional: trustItems[]?, brandStrip?, promo?, tradeIn? // render conditionally
|
|
29
|
+
newsletter: { eyebrow, title, body, placeholder, submitLabel, successLabel }
|
|
30
|
+
about: { eyebrow, title, paragraphs[], sections[{ heading, body }] }
|
|
31
|
+
faq: { eyebrow, title, sections[{ title, items[{ q, a }] }], contactPrompt, contactEmail }
|
|
32
|
+
terms,
|
|
33
|
+
privacy,
|
|
34
|
+
shipping,
|
|
35
|
+
returns,
|
|
36
|
+
accessibility: { eyebrow, title, lastUpdated, sections[{ heading, body | { intro, bullets[] } }] }
|
|
37
|
+
account: eyebrows + titles for /account, /login, /signup
|
|
38
|
+
contactPage: { eyebrow, title, body, reasons[], directLines[{ label, value, href }] }
|
|
39
|
+
trackOrder: { eyebrow, title, body }
|
|
40
|
+
footer: { blurb, sitemap[{ title, links[] }], poweredBy? }
|
|
41
|
+
llms: { summary } // opens /llms.txt
|
|
42
|
+
mock: { seed, businessId }
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Playbook — common tasks
|
|
46
|
+
|
|
47
|
+
### Rebrand a storefront for a new merchant
|
|
48
|
+
|
|
49
|
+
1. Edit `lib/brand.ts`. Replace every field with the merchant's content. Use the brief / context the user gave you.
|
|
50
|
+
2. Edit `app/globals.css` `@theme { … }`. Change `--color-primary`, `--color-background`, `--color-foreground`, optionally `--radius`. Use OKLCH; if the brand only gave hex, convert.
|
|
51
|
+
3. (Optional) Swap fonts in `app/layout.tsx` — `next/font/google` import + the variable wired into the `<html>` className.
|
|
52
|
+
4. Set `.env.local`: `NEXT_PUBLIC_CIMPLIFY_API_URL`, `NEXT_PUBLIC_CIMPLIFY_PUBLIC_KEY`, `NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID`, `NEXT_PUBLIC_SITE_URL`.
|
|
53
|
+
|
|
54
|
+
Don't touch any other file. If the rebrand needs content not in the schema, add the field to `Brand` first, populate it, then read it from the page.
|
|
55
|
+
|
|
56
|
+
### Add a new section / component
|
|
57
|
+
|
|
58
|
+
1. Build it as a Server Component in `components/` (or a client island in `*-client.tsx` if interactive).
|
|
59
|
+
2. Read merchant copy from `brand`. Add new fields to the `Brand` interface if needed.
|
|
60
|
+
3. Wrap interactive bits in `<Suspense fallback={…}>` so the cached chrome streams.
|
|
61
|
+
4. Compose into the page.
|
|
62
|
+
|
|
63
|
+
### Wire a Server Action that mutates data
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
"use server";
|
|
67
|
+
import { getServerClient, revalidateProducts } from "@cimplify/sdk/server";
|
|
68
|
+
|
|
69
|
+
export async function createProduct(input: ProductInput) {
|
|
70
|
+
await getServerClient().catalogue.createProduct(input);
|
|
71
|
+
revalidateProducts();
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
After every mutation, call the matching `revalidate*` helper from `@cimplify/sdk/server`: `revalidateProducts`, `revalidateProduct(id)`, `revalidateCategories`, `revalidateCategory(id)`, `revalidateCollections`, `revalidateCollection(id)`, `revalidateBusiness`.
|
|
76
|
+
|
|
77
|
+
### Add a Server Component data fetch
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
import { cacheTag, cacheLife } from "next/cache";
|
|
81
|
+
import { getServerClient, tags } from "@cimplify/sdk/server";
|
|
82
|
+
|
|
83
|
+
async function getX() {
|
|
84
|
+
"use cache";
|
|
85
|
+
cacheTag(tags.products());
|
|
86
|
+
cacheLife("hours");
|
|
87
|
+
const r = await getServerClient().catalogue.getProducts({ limit: 24 });
|
|
88
|
+
if (!r.ok) throw new Error(r.error.message);
|
|
89
|
+
return r.value.items;
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Eject an SDK component for deeper customization
|
|
94
|
+
|
|
95
|
+
Try `classNames`, `renderImage`, `renderLink`, slot props first. If those run out:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
bunx @cimplify/sdk eject --list
|
|
99
|
+
bunx @cimplify/sdk eject product-card --dir src/components/cimplify
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Once ejected, the file is yours. Hooks/types still come from `@cimplify/sdk`.
|
|
103
|
+
|
|
104
|
+
### Deploy
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
bunx @cimplify/sdk login
|
|
108
|
+
bunx @cimplify/sdk projects create my-store
|
|
109
|
+
bunx @cimplify/sdk link <project-id>
|
|
110
|
+
bunx @cimplify/sdk env push
|
|
111
|
+
bunx @cimplify/sdk deploy --prod
|
|
112
|
+
bunx @cimplify/sdk logs --follow
|
|
113
|
+
bunx @cimplify/sdk domains add my-store.com
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Pitfalls — explicit ❌ list
|
|
117
|
+
|
|
118
|
+
- ❌ Hardcoding any visible string in a page or component. Always `brand.X`.
|
|
119
|
+
- ❌ Disabling `cacheComponents: true` to silence a warning. Fix the warning by wrapping the dynamic call in `<Suspense>`.
|
|
120
|
+
- ❌ Using `unstable_cache` — Next 16's canonical primitive is `'use cache'` + `cacheTag` + `cacheLife`.
|
|
121
|
+
- ❌ Bypassing `getServerClient()` and calling `createCimplifyClient` directly in a Server Component — loses per-request memoization.
|
|
122
|
+
- ❌ Mutating data without calling the matching `revalidate*` helper.
|
|
123
|
+
- ❌ Adding an `app/error.tsx` handler that calls `reset()` without logging — silently swallowed errors hide bugs.
|
|
124
|
+
- ❌ Running `bun test` and reporting failures. Use `bun run test:run` (vitest).
|
|
125
|
+
- ❌ Editing the per-template `AGENTS.md` to remove notes about TODOs (contact form, newsletter fake submits) — they're real.
|
|
126
|
+
|
|
127
|
+
## Where things live
|
|
128
|
+
|
|
129
|
+
| Need | Look here |
|
|
130
|
+
|---|---|
|
|
131
|
+
| Which page reads which `brand.X` field | `AGENTS.md` at project root |
|
|
132
|
+
| Architectural rules | `AGENTS.md` at project root + this skill |
|
|
133
|
+
| Running locally | `bun dev` (boots mock + Next together) |
|
|
134
|
+
| Switching mock seed | edit `dev:mock` in `package.json` and `NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID` in `.env.local` |
|
|
135
|
+
| Full SDK reference | `docs/sdk/storefronts.md` in the Cimplify repo |
|
|
136
|
+
|
|
137
|
+
## What to do when the user asks something out-of-scope
|
|
138
|
+
|
|
139
|
+
If the user asks for something the template doesn't support out of the box:
|
|
140
|
+
|
|
141
|
+
1. **Check first** — is there an SDK component or hook that does it? `@cimplify/sdk/react` has 50+ components, 30+ hooks. Search `node_modules/@cimplify/sdk/dist/react.d.mts` if needed.
|
|
142
|
+
2. **Compose from existing parts** before authoring new ones.
|
|
143
|
+
3. **If genuinely missing** — build the new component, hoist its strings into `brand.ts`, document in `AGENTS.md`.
|
|
144
|
+
|
|
145
|
+
Don't introduce competing patterns (a new caching strategy, a new auth flow, a new theming system). The template's opinions are intentional.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Cimplify storefront — architectural rules and rebrand contract for a project scaffolded from `bunx @cimplify/sdk init`. Triggers when files like lib/brand.ts, app/globals.css, components/header.tsx, or .cimplify/project.json are in the workspace.
|
|
3
|
+
globs: ["lib/brand.ts", "app/**", "components/**", ".env.local", "next.config.ts"]
|
|
4
|
+
alwaysApply: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Cimplify storefront
|
|
8
|
+
|
|
9
|
+
This project was scaffolded from a Cimplify template. Read `AGENTS.md` at the project root for the file ↔ `brand.X` field map and `.claude/skills/cimplify-storefront/SKILL.md` for the full playbook.
|
|
10
|
+
|
|
11
|
+
## The contract
|
|
12
|
+
|
|
13
|
+
1. **`lib/brand.ts`** — every visible string. If something isn't there, add a field to the `Brand` interface; don't hardcode.
|
|
14
|
+
2. **`app/globals.css` `@theme` block** — palette, radius, font references.
|
|
15
|
+
3. **Server Components are cached** via `'use cache'` + `cacheTag(tags.X())` + `cacheLife("hours")`. Don't downgrade to client to silence a warning.
|
|
16
|
+
4. **Client islands** behind `<Suspense>`.
|
|
17
|
+
5. **`cacheComponents: true`** in `next.config.ts` is non-negotiable.
|
|
18
|
+
6. Use **`bun run test:run`** (vitest), not `bun test`.
|
|
19
|
+
|
|
20
|
+
## Don't
|
|
21
|
+
|
|
22
|
+
- Hardcode visible strings in pages/components.
|
|
23
|
+
- Use `unstable_cache` (Next 16 uses `'use cache'`).
|
|
24
|
+
- Bypass `getServerClient()` (loses per-request memoization).
|
|
25
|
+
- Mutate without calling the matching `revalidate*` helper from `@cimplify/sdk/server`.
|
|
@@ -5,31 +5,79 @@ If you are an AI agent (Claude, Cursor, Aider, devin, …) working on this store
|
|
|
5
5
|
## TL;DR for rebranding
|
|
6
6
|
|
|
7
7
|
1. **Edit `lib/brand.ts`** — every visible string lives here.
|
|
8
|
-
2. **Edit `app/globals.css`** —
|
|
8
|
+
2. **Edit `app/globals.css`** — `@theme { … }` for palette + radius.
|
|
9
9
|
3. **Edit `.env.local`** — `NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID=bus_serene_spa` for the bundled seed.
|
|
10
10
|
|
|
11
11
|
## Aesthetic
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
- **Fraunces serif + Inter** — warm, slightly editorial headings.
|
|
14
|
+
- **Sand + sage palette** — warm cream background, deep sage primary.
|
|
15
|
+
- **Generous radius**: `1rem` — calm, soft.
|
|
16
|
+
- Lower-contrast than retail / fashion.
|
|
17
|
+
- Schema.org `@type` is `BeautySalon`.
|
|
14
18
|
|
|
15
|
-
|
|
16
|
-
- **Inter** for body and UI.
|
|
17
|
-
- **Sand + sage palette**: warm cream background, deep sage primary.
|
|
18
|
-
- **Soft corners**: `--radius: 1rem` — generous rounding throughout.
|
|
19
|
-
- **Lower-contrast** than retail / fashion; calm-feeling.
|
|
19
|
+
## Page surface
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
```
|
|
22
|
+
app/
|
|
23
|
+
page.tsx Home — hero ("Now booking"), service strips,
|
|
24
|
+
category grid, newsletter
|
|
25
|
+
shop/page.tsx Treatment menu (SDK <CataloguePage/>)
|
|
26
|
+
search/page.tsx Search
|
|
27
|
+
collections/[slug]/page.tsx Collection landing
|
|
28
|
+
categories/[slug]/page.tsx Category landing (e.g. memberships, packages)
|
|
29
|
+
|
|
30
|
+
book/page.tsx ⭐ Services-specific: full booking widget
|
|
31
|
+
(treatment + 14-day date + 30-min slot grid)
|
|
32
|
+
→ adds to cart with slot as note → /checkout
|
|
33
|
+
|
|
34
|
+
cart/page.tsx, checkout/page.tsx, orders/[id]/page.tsx
|
|
35
|
+
|
|
36
|
+
account/page.tsx <CimplifyAccount /> (iframe)
|
|
37
|
+
account/orders/page.tsx <CimplifyAccount section="orders" />
|
|
38
|
+
account/addresses/page.tsx <CimplifyAccount section="addresses" />
|
|
39
|
+
account/settings/page.tsx <CimplifyAccount section="settings" />
|
|
40
|
+
login/page.tsx, signup/page.tsx redirects → /account
|
|
41
|
+
|
|
42
|
+
contact/page.tsx, track-order/page.tsx (find a booking)
|
|
43
|
+
|
|
44
|
+
about/page.tsx, faq/page.tsx
|
|
45
|
+
shipping/page.tsx (what to expect at the studio), returns/page.tsx (cancellations),
|
|
46
|
+
accessibility/page.tsx, terms/page.tsx, privacy/page.tsx
|
|
47
|
+
|
|
48
|
+
sitemap-page/page.tsx, sitemap.ts, robots.ts, llms.txt/route.ts, opensearch.xml/route.ts
|
|
49
|
+
error.tsx, not-found.tsx
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## File ↔ brand-field map
|
|
53
|
+
|
|
54
|
+
| File | Reads from `brand` |
|
|
55
|
+
|---|---|
|
|
56
|
+
| `app/layout.tsx` | identity, contact, socials, BeautySalon JSON-LD |
|
|
57
|
+
| `app/page.tsx` | `brand.hero` ("Now booking") |
|
|
58
|
+
| `app/about/page.tsx` | `brand.about` |
|
|
59
|
+
| `app/faq/page.tsx` | `brand.faq` (booking, contraindications, memberships) |
|
|
60
|
+
| `app/shipping/page.tsx` | `brand.shipping` (what to expect at the studio) |
|
|
61
|
+
| `app/returns/page.tsx` | `brand.returns` (cancellation policy) |
|
|
62
|
+
| `app/accessibility/page.tsx` | `brand.accessibility` |
|
|
63
|
+
| `app/terms/page.tsx`, `app/privacy/page.tsx` | `brand.terms`, `brand.privacy` |
|
|
64
|
+
| `app/contact/page.tsx` | `brand.contactPage`, `brand.contact` |
|
|
65
|
+
| `app/track-order/page.tsx` | `brand.trackOrder` ("find a booking") |
|
|
66
|
+
| `app/account/*/page.tsx` | `brand.account` (iframe owns UI) |
|
|
67
|
+
| `app/book/*` | derives bookable services from product list (`type: "service"`) |
|
|
68
|
+
| `app/llms.txt/route.ts` | `brand.llms`, contact, currency |
|
|
69
|
+
| `components/header.tsx`, `footer.tsx` | `brand.header`, `brand.footer`, `brand.contact`, `brand.socials` |
|
|
70
|
+
|
|
71
|
+
## Services-specific notes
|
|
22
72
|
|
|
23
|
-
The
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
- `brand.tradeIn` is omitted (irrelevant for services).
|
|
27
|
-
- `brand.faq` covers booking, cancellation, contraindications, memberships.
|
|
28
|
-
- Schema.org type is `BeautySalon`.
|
|
73
|
+
- **Bookable services are `type: "service"` products.** The `/book` page filters the product list to type=service and treats them as treatments. Their `duration_minutes` is shown on the chip.
|
|
74
|
+
- Cart-item notes carry the booked time slot — checkout sends them through Cimplify's order pipeline. The merchant's downstream system reads the note to schedule the appointment.
|
|
75
|
+
- Mock seed: `--seed services` (Serene Spa).
|
|
29
76
|
|
|
30
|
-
##
|
|
77
|
+
## Known TODOs
|
|
31
78
|
|
|
32
|
-
|
|
79
|
+
- `/book` widget shows every slot as available. For production, wire `useAvailableSlots({ serviceId, date })` from `@cimplify/sdk/react` to filter to genuinely-free windows.
|
|
80
|
+
- Contact + newsletter fake submits.
|
|
33
81
|
|
|
34
82
|
## Quick start
|
|
35
83
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
This project was scaffolded from a Cimplify storefront template (`bunx @cimplify/sdk init`).
|
|
4
|
+
|
|
5
|
+
## Read these first
|
|
6
|
+
|
|
7
|
+
- **`AGENTS.md`** at the project root — the file ↔ `brand.X` field map for *this template's* industry, plus the architectural rules.
|
|
8
|
+
- **`.claude/skills/cimplify-storefront/SKILL.md`** — the playbook for common tasks (rebrand, add a section, wire a Server Action, deploy, eject a component). Invoke it whenever you're asked to change content, palette, copy, or routing.
|
|
9
|
+
|
|
10
|
+
## The two-line summary
|
|
11
|
+
|
|
12
|
+
1. **Edit `lib/brand.ts`** for any visible string.
|
|
13
|
+
2. **Edit `app/globals.css` `@theme` block** for any palette / radius / font change.
|
|
14
|
+
|
|
15
|
+
That covers ~95% of what merchants ask for. For anything else, follow the `cimplify-storefront` skill.
|
|
16
|
+
|
|
17
|
+
## Don't do
|
|
18
|
+
|
|
19
|
+
- Hardcode strings in pages or components.
|
|
20
|
+
- Disable `cacheComponents: true` in `next.config.ts`.
|
|
21
|
+
- Use `unstable_cache` — Next 16's canonical primitive is `'use cache'`.
|
|
22
|
+
- Run `bun test` (Bun's `vi` shim is incomplete) — use `bun run test:run`.
|