@cimplify/sdk 0.40.0 → 0.41.0

package/templates/storefront-retail/lib/brand.ts

@@ -0,0 +1,567 @@
+/**
+ * Brand & content configuration — the **single source of truth** for every
+ * visible string in this storefront.
+ *
+ * To rebrand the entire site, edit this file. Every page, component,
+ * metadata block, JSON-LD object, sitemap, robots.txt, and llms.txt entry
+ * reads from `brand`.
+ *
+ * Schema is intentionally generous: optional fields (tradeIn, trustItems,
+ * brandStrip, promo) only render when present, so the same Brand type
+ * works across industry templates.
+ */
+
+export interface BrandSocial {
+  /** Display label (Instagram, X, YouTube, …). Used as aria-label and footer chip. */
+  label: string;
+  href: string;
+  /** Optional icon override — defaults to inline SVG keyed by `label`. */
+  icon?: "instagram" | "x" | "tiktok" | "facebook" | "youtube" | "linkedin" | "whatsapp";
+}
+
+export interface BrandFaqEntry {
+  q: string;
+  a: string;
+}
+
+export interface BrandFaqSection {
+  title: string;
+  items: BrandFaqEntry[];
+}
+
+export interface BrandPolicySection {
+  heading: string;
+  /** Plain prose, or { intro + bullets } for list-style sections. */
+  body: string | { intro: string; bullets: string[] };
+}
+
+export interface BrandSitemapSection {
+  title: string;
+  links: { label: string; href: string }[];
+}
+
+export interface Brand {
+  // ─── Identity ─────────────────────────────────────────────────
+  name: string;
+  /** Short brand mark for compact spaces. */
+  shortName: string;
+  /** Microtag shown in the header beside the brand mark. */
+  microTag: string;
+  /** SEO description and default OG description. */
+  description: string;
+  /** Schema.org `@type` for the Organization JSON-LD on the layout. */
+  schemaType:
+    | "Store"
+    | "Bakery"
+    | "Restaurant"
+    | "BeautySalon"
+    | "GroceryStore"
+    | "LocalBusiness"
+    | "Organization";
+
+  // ─── Currency / locale ────────────────────────────────────────
+  currency: string;
+  locale: string;
+
+  // ─── Contact ──────────────────────────────────────────────────
+  contact: {
+    address: string;
+    streetAddress: string;
+    city: string;
+    countryCode: string;
+    /** Display phone, with formatting. */
+    phone: string;
+    /** Phone in `tel:` format (digits + country code). */
+    phoneTel: string;
+    email: string;
+    privacyEmail: string;
+    supportEmail?: string;
+    businessEmail?: string;
+    hours: string;
+  };
+
+  socials: BrandSocial[];
+
+  // ─── Header ───────────────────────────────────────────────────
+  header: {
+    /** Top-level nav links. Order is preserved. */
+    nav: { label: string; href: string }[];
+  };
+
+  // ─── Hero ─────────────────────────────────────────────────────
+  hero: {
+    badge: string;
+    title: string;
+    /** Subtitle. May span multiple paragraphs by separating with \n\n. */
+    subtitle: string;
+    primaryCtaLabel: string;
+    secondaryCtaLabel?: string;
+    secondaryCtaHref?: string;
+  };
+
+  // ─── Trust bar (optional) ─────────────────────────────────────
+  trustItems?: { label: string; value: string; description: string; iconKey: string }[];
+
+  // ─── Brand authority strip (optional) ─────────────────────────
+  brandStrip?: {
+    headline: string;
+    brands: string[];
+  };
+
+  // ─── Promo banner (optional) ──────────────────────────────────
+  promo?: {
+    badge: string;
+    title: string;
+    body: string;
+    ctaLabel: string;
+    ctaHref: string;
+  };
+
+  // ─── Trade-in CTA (optional) ──────────────────────────────────
+  tradeIn?: {
+    eyebrow: string;
+    title: string;
+    body: string;
+    primaryCtaLabel: string;
+    primaryCtaHref: string;
+    secondaryCtaLabel: string;
+    secondaryCtaHref: string;
+    steps: { step: string; title: string; body: string }[];
+  };
+
+  // ─── Newsletter ───────────────────────────────────────────────
+  newsletter: {
+    eyebrow: string;
+    title: string;
+    body: string;
+    placeholder: string;
+    submitLabel: string;
+    successLabel: string;
+  };
+
+  // ─── About page ───────────────────────────────────────────────
+  about: {
+    eyebrow: string;
+    /** Title — supports a single \n for a hard line break. */
+    title: string;
+    paragraphs: string[];
+    sections: { heading: string; body: string }[];
+  };
+
+  // ─── FAQ ──────────────────────────────────────────────────────
+  faq: {
+    eyebrow: string;
+    title: string;
+    sections: BrandFaqSection[];
+    contactPrompt: string;
+    contactEmail: string;
+  };
+
+  // ─── Terms ────────────────────────────────────────────────────
+  terms: {
+    eyebrow: string;
+    title: string;
+    lastUpdated: string;
+    sections: BrandPolicySection[];
+  };
+
+  // ─── Privacy ──────────────────────────────────────────────────
+  privacy: {
+    eyebrow: string;
+    title: string;
+    lastUpdated: string;
+    sections: BrandPolicySection[];
+  };
+
+  // ─── Footer ───────────────────────────────────────────────────
+  footer: {
+    blurb: string;
+    sitemap: BrandSitemapSection[];
+    poweredBy?: { label: string; href: string };
+  };
+
+  // ─── llms.txt summary (LLM-friendly site index) ───────────────
+  llms: {
+    summary: string;
+  };
+
+  // ─── Mock seed ────────────────────────────────────────────────
+  mock: {
+    seed: string;
+    businessId: string;
+  };
+}
+
+export const brand: Brand = {
+  name: "Currents Electronics",
+  shortName: "Currents",
+  microTag: "ELECTRONICS",
+  description:
+    "The latest laptops, phones, audio, and accessories — curated, in-stock, shipped same-day from Accra to Africa.",
+  schemaType: "Store",
+
+  currency: "GHS",
+  locale: "en_GH",
+
+  contact: {
+    address: "Atomic Junction, East Legon, Accra",
+    streetAddress: "Atomic Junction, East Legon",
+    city: "Accra",
+    countryCode: "GH",
+    phone: "+233 244 000 000",
+    phoneTel: "+233244000000",
+    email: "hello@currentselectronics.test",
+    privacyEmail: "privacy@currentselectronics.test",
+    supportEmail: "support@currentselectronics.test",
+    businessEmail: "business@currentselectronics.test",
+    hours: "Mon–Sat · 9am–8pm",
+  },
+
+  socials: [
+    { label: "Instagram", href: "https://instagram.com/currentselectronics", icon: "instagram" },
+    { label: "X", href: "https://x.com/currentselectronics", icon: "x" },
+    { label: "YouTube", href: "https://youtube.com/@currentselectronics", icon: "youtube" },
+    { label: "WhatsApp", href: "https://wa.me/233244000000", icon: "whatsapp" },
+  ],
+
+  header: {
+    nav: [
+      { label: "Shop", href: "/shop" },
+      { label: "Deals", href: "/categories/deals" },
+      { label: "Support", href: "/faq" },
+    ],
+  },
+
+  hero: {
+    badge: "LAPTOPS · PHONES · AUDIO · ACCESSORIES",
+    title: "The tech you want, in stock today.",
+    subtitle:
+      "Authorised dealer for Apple, Samsung, Sony, Bose. Same-day delivery in Accra. Two-year warranty on every product.",
+    primaryCtaLabel: "Shop now",
+    secondaryCtaLabel: "See deals",
+    secondaryCtaHref: "/categories/deals",
+  },
+
+  trustItems: [
+    {
+      label: "Delivery",
+      value: "Same-day in Accra",
+      description: "Orders before 4pm, free over GH₵500.",
+      iconKey: "delivery",
+    },
+    {
+      label: "Warranty",
+      value: "2 years on everything",
+      description: "1yr manufacturer + 1yr Currents.",
+      iconKey: "warranty",
+    },
+    {
+      label: "Payment",
+      value: "Pay in 3, interest-free",
+      description: "Or 6/12 months via Fidelity Bank.",
+      iconKey: "payment",
+    },
+    {
+      label: "Genuine",
+      value: "Authorised dealer",
+      description: "Direct from Apple, Samsung, Sony, Bose.",
+      iconKey: "verified",
+    },
+  ],
+
+  brandStrip: {
+    headline: "Authorised dealer · genuine stock · 2-year warranty",
+    brands: [
+      "Apple",
+      "Samsung",
+      "Sony",
+      "Bose",
+      "Logitech",
+      "Anker",
+      "JBL",
+      "Microsoft",
+      "Lenovo",
+      "DJI",
+    ],
+  },
+
+  promo: {
+    badge: "Limited · ends Sunday",
+    title: "Trade in your old phone, get up to GH₵3,500 off.",
+    body: "Send us your last-gen iPhone or Galaxy. We'll quote within 48 hours and credit the value toward your next upgrade.",
+    ctaLabel: "Start trade-in",
+    ctaHref: "/about",
+  },
+
+  tradeIn: {
+    eyebrow: "Trade-in programme",
+    title: "Last year's phone, this year's discount.",
+    body: "Send us your iPhone, Galaxy, or MacBook. We'll quote within 48 hours and credit the value toward your next purchase. Devices head to certified refurbishers across the continent — yours stays in service for years more.",
+    primaryCtaLabel: "Get a quote",
+    primaryCtaHref: "/about",
+    secondaryCtaLabel: "How it works",
+    secondaryCtaHref: "/faq",
+    steps: [
+      { step: "01", title: "Tell us what you have", body: "Model + condition + photos. 2 minutes." },
+      { step: "02", title: "Ship it free", body: "Drop at our store or book a free pickup." },
+      { step: "03", title: "Get credited", body: "Within 48 hours, in store credit or Mobile Money." },
+    ],
+  },
+
+  newsletter: {
+    eyebrow: "The shortlist",
+    title: "New drops, real prices, in your inbox.",
+    body: "One email a week. Curated launches, our actual price (not the launch price), and the deals worth knowing about. No newsletter chaff.",
+    placeholder: "you@email.com",
+    submitLabel: "Subscribe",
+    successLabel: "Subscribed ✓",
+  },
+
+  about: {
+    eyebrow: "About Currents",
+    title: "Tech that lasts.\nService that doesn't flake.",
+    paragraphs: [
+      "We started Currents in 2017 because the best phones, laptops, and headphones were either three months out of stock in Accra, or obviously fake. Either way, you ended up calling someone's cousin in London. That's a bad way to buy a thousand-dollar device.",
+      "Today we're an authorised dealer for Apple, Samsung, Sony, Bose, Logitech, and Anker. Every product is sourced direct from the manufacturer or their certified distributor — no parallel imports, no refurbished-as-new, no \"dual SIM Asia spec\" on a US iPhone. What you order is what we open in front of you on delivery.",
+      "We back everything with a two-year warranty (one year manufacturer + one year Currents), free same-day Accra delivery, and a 14-day no-questions-asked return on anything sealed.",
+    ],
+    sections: [
+      {
+        heading: "Trade-in",
+        body: "Got an iPhone, Galaxy, or MacBook you no longer use? Bring it in or ship it to us — we'll quote you within 48 hours and credit the value toward your next purchase. We work with refurbishers across the continent so your old kit stays in service for years more.",
+      },
+      {
+        heading: "Business sales",
+        body: "Equipping a team or kitting out a co-working space? We do volume quotes, delivery scheduling, asset tagging, and on-site setup. Email business@currentselectronics.test.",
+      },
+      {
+        heading: "Visit",
+        body: "Atomic Junction, East Legon, Accra · Mon–Sat, 9am–8pm.",
+      },
+    ],
+  },
+
+  faq: {
+    eyebrow: "Support",
+    title: "Questions, answered.",
+    sections: [
+      {
+        title: "Ordering & delivery",
+        items: [
+          {
+            q: "How fast is shipping?",
+            a: "Free same-day delivery within Greater Accra for orders placed before 4pm. Outside Accra, we use a partner courier — usually 1–3 business days, with tracking sent by SMS.",
+          },
+          {
+            q: "Can I pick up in store?",
+            a: "Yes. Choose 'Pickup' at checkout and we'll have your order boxed at our Atomic Junction store within 30 minutes. Bring a photo ID matching the order name.",
+          },
+          {
+            q: "Do you ship internationally?",
+            a: "We ship across West Africa via DHL — rates and ETAs are calculated at checkout once you enter your destination.",
+          },
+          {
+            q: "How do I track my order?",
+            a: "You'll get an SMS and email with a tracking link within 30 minutes of dispatch. Same-day Accra orders include the rider's phone number.",
+          },
+        ],
+      },
+      {
+        title: "Warranty & repairs",
+        items: [
+          {
+            q: "What does the two-year warranty cover?",
+            a: "Manufacturing defects, electrical failures, and battery degradation below 80% within the first 24 months. Accidental damage, water damage, and software issues caused by user installs are excluded.",
+          },
+          {
+            q: "Where do I send a faulty device?",
+            a: "Drop it at our Atomic Junction store, or request a free pickup from your address by emailing support@currentselectronics.test. Loaner devices are available for warranty claims while we diagnose.",
+          },
+          {
+            q: "Can you fix devices bought elsewhere?",
+            a: "We offer paid repairs on Apple and Samsung devices regardless of where they were purchased. Expect a quote within 48 hours of inspection.",
+          },
+        ],
+      },
+      {
+        title: "Trade-in & financing",
+        items: [
+          {
+            q: "How does trade-in work?",
+            a: "Tell us the model and condition of your device, get an instant estimate, and ship it free or drop it at our store. Once we verify, we credit your account or pay out via Mobile Money — your choice.",
+          },
+          {
+            q: "Do you offer instalment payments?",
+            a: "Yes. Pay in 3 (interest-free) or 6/12 monthly instalments via our partner Fidelity Bank. Available at checkout for orders over GH₵2,000.",
+          },
+          {
+            q: "Are there bulk discounts for businesses?",
+            a: "Yes. Email business@currentselectronics.test with your shopping list and team size — most orders over 5 units qualify for a discount, plus free on-site setup.",
+          },
+        ],
+      },
+      {
+        title: "Payment & returns",
+        items: [
+          {
+            q: "What payment methods do you accept?",
+            a: "Mobile Money (MTN, Telecel, AirtelTigo), Visa/Mastercard, instalments via Fidelity Bank, and cash on delivery for Accra orders.",
+          },
+          {
+            q: "What's your return policy?",
+            a: "14 days, no questions asked, on any sealed product. For opened items, returns are accepted within 7 days subject to a 10% restocking fee. We can't accept returns on activated SIM-bundled phones once the SIM is registered.",
+          },
+          {
+            q: "Are products genuine?",
+            a: "Yes. We're an authorised dealer for every brand we stock. Every product ships with the manufacturer's serial number registered to your name — verify it on the brand's official portal anytime.",
+          },
+        ],
+      },
+    ],
+    contactPrompt: "Still stuck? Email",
+    contactEmail: "support@currentselectronics.test",
+  },
+
+  terms: {
+    eyebrow: "Terms of service",
+    title: "Terms of Service",
+    lastUpdated: "1 May 2026",
+    sections: [
+      {
+        heading: "1. Who we are",
+        body: "Currents Electronics (\"we\", \"us\") is a consumer electronics retailer based at Atomic Junction, East Legon, Accra, Ghana. By placing an order, you (\"you\", \"customer\") agree to these terms.",
+      },
+      {
+        heading: "2. Authorised dealer status",
+        body: "We are authorised dealers for the brands listed on our About page. Every product is sourced direct from the manufacturer or a certified distributor. Serial numbers can be verified on the brand's official portal at any time.",
+      },
+      {
+        heading: "3. Pricing and payment",
+        body: "Prices are in Ghana Cedis (GH₵) and include VAT where applicable. Payment is due at checkout via Mobile Money, card, or instalments via our partner bank. Cash on delivery is available for Accra orders only.",
+      },
+      {
+        heading: "4. Warranty",
+        body: "Every product carries a two-year warranty: the standard manufacturer warranty in year one, plus a Currents-backed extension in year two. Coverage includes manufacturing defects and battery degradation below 80%. Accidental damage, liquid damage, and unauthorised modifications are excluded.",
+      },
+      {
+        heading: "5. Returns",
+        body: "Sealed products: 14 days, no questions asked. Opened products: 7 days, subject to a 10% restocking fee for non-defective items. Activated SIM-bundled phones cannot be returned once the SIM is registered. Custom orders and bulk corporate orders are non-refundable except for defects.",
+      },
+      {
+        heading: "6. Trade-in",
+        body: "Trade-in quotes are estimates only. Final value is determined after inspection by our refurbishment partner. We reserve the right to revise the quote, and you may decline the revised offer and receive your device back at our cost.",
+      },
+      {
+        heading: "7. Liability",
+        body: "To the maximum extent permitted by Ghanaian law, our liability for any claim arising from this website or your order is limited to the value of the order. We're not liable for indirect or consequential losses, including data loss.",
+      },
+      {
+        heading: "8. Governing law",
+        body: "These terms are governed by the laws of Ghana. Disputes will be resolved in the courts of Greater Accra.",
+      },
+      {
+        heading: "9. Contact",
+        body: "Questions? Email hello@currentselectronics.test.",
+      },
+    ],
+  },
+
+  privacy: {
+    eyebrow: "Privacy",
+    title: "Privacy Policy",
+    lastUpdated: "1 May 2026",
+    sections: [
+      {
+        heading: "What we collect",
+        body: "We collect what we need to fulfil your order: name, phone, delivery address, email, and the items in your order. For warranty service and trade-ins, we also collect device serial numbers. Payment details are processed by our payment partners (Paystack, Stripe, Fidelity Bank) and never stored on our servers.",
+      },
+      {
+        heading: "How we use it",
+        body: {
+          intro: "We use your data to:",
+          bullets: [
+            "Prepare, deliver, and confirm your order.",
+            "Register product warranties on your behalf.",
+            "Send order updates by SMS and email.",
+            "Send occasional product news and deals — only if you opted in. Unsubscribe anytime in one click.",
+            "Analyse aggregated, anonymised browsing patterns so we can improve the site and recommend products.",
+          ],
+        },
+      },
+      {
+        heading: "Who we share it with",
+        body: "We share data only with the partners required to fulfil your order and warranty: payment processors (Paystack, Stripe, Fidelity Bank), delivery couriers (DHL, local riders), manufacturer warranty portals (for serial registration), and our email/SMS providers. We do not sell or rent personal data to third parties — ever.",
+      },
+      {
+        heading: "Cookies",
+        body: "We use a small number of strictly-necessary cookies to keep your cart working and your session signed in, plus optional analytics cookies (you can disable these in our cookie banner).",
+      },
+      {
+        heading: "Your rights",
+        body: "Under the Ghana Data Protection Act, 2012 (Act 843), you have the right to access the data we hold about you, correct it, or have it deleted (subject to our tax-record retention obligations). Email privacy@currentselectronics.test and we'll respond within 14 days.",
+      },
+      {
+        heading: "Retention",
+        body: "We keep order records for 7 years to comply with Ghanaian tax law. Warranty records are retained for the life of the warranty plus 24 months. Marketing-list opt-ins are kept until you unsubscribe.",
+      },
+      {
+        heading: "Changes",
+        body: "If we make material changes to this policy, we'll email customers on our marketing list and update the \"last updated\" date above.",
+      },
+    ],
+  },
+
+  footer: {
+    blurb:
+      "Authorised dealer for Apple, Samsung, Sony, Bose. Same-day delivery in Accra; nationwide via partner courier. Two-year warranty on every product.",
+    sitemap: [
+      {
+        title: "Shop",
+        links: [
+          { label: "All products", href: "/shop" },
+          { label: "Laptops", href: "/categories/laptops" },
+          { label: "Phones", href: "/categories/phones" },
+          { label: "Audio", href: "/categories/audio" },
+          { label: "Accessories", href: "/categories/accessories" },
+          { label: "Deals", href: "/categories/deals" },
+        ],
+      },
+      {
+        title: "Support",
+        links: [
+          { label: "Contact", href: "mailto:hello@currentselectronics.test" },
+          { label: "Warranty", href: "/faq" },
+          { label: "Returns", href: "/faq" },
+          { label: "Shipping", href: "/faq" },
+        ],
+      },
+      {
+        title: "Company",
+        links: [
+          { label: "About", href: "/about" },
+          { label: "Trade-in", href: "/about" },
+          { label: "Business sales", href: "mailto:business@currentselectronics.test" },
+          { label: "Careers", href: "/about" },
+        ],
+      },
+      {
+        title: "Legal",
+        links: [
+          { label: "Terms of Service", href: "/terms" },
+          { label: "Privacy Policy", href: "/privacy" },
+        ],
+      },
+    ],
+    poweredBy: { label: "Cimplify", href: "https://app.cimplify.io" },
+  },
+
+  llms: {
+    summary:
+      "Authorised dealer for Apple, Samsung, Sony, Bose. Same-day delivery in Accra; nationwide via partner courier. Two-year warranty on every product. Trade-in and instalment payments available.",
+  },
+
+  mock: {
+    seed: "retail",
+    businessId: "bus_currents_electronics",
+  },
+};

package/templates/storefront-services/.env.example

@@ -0,0 +1,16 @@
+# Cimplify API base URL.
+# Dev: leave empty so the SDK uses the current origin (localhost:3000),
+# which Next.js rewrites to the mock at 127.0.0.1:8787 (see next.config.ts).
+# Production: set to your Cimplify host (e.g. https://api.cimplify.io).
+NEXT_PUBLIC_CIMPLIFY_API_URL=
+
+# Tenant public key. The mock accepts any value.
+NEXT_PUBLIC_CIMPLIFY_PUBLIC_KEY=mock-dev
+
+# Business id used by the mock seed (services: Serene Spa).
+NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID=bus_serene_spa
+
+# Canonical public site URL — used by sitemap.xml, robots.txt, llms.txt,
+# and OpenGraph metadata. Set this on production deploys (Vercel auto-injects
+# via VERCEL_URL but Next prefers an explicit value).
+NEXT_PUBLIC_SITE_URL=https://example.com

package/templates/storefront-services/AGENTS.md

@@ -0,0 +1,41 @@
+# AGENTS.md — Services / spa / wellness storefront template
+
+If you are an AI agent (Claude, Cursor, Aider, devin, …) working on this storefront, **start here.**
+
+## TL;DR for rebranding
+
+1. **Edit `lib/brand.ts`** — every visible string lives here.
+2. **Edit `app/globals.css`** — the `@theme { … }` block holds the palette + radius.
+3. **Edit `.env.local`** — `NEXT_PUBLIC_CIMPLIFY_BUSINESS_ID=bus_serene_spa` for the bundled seed.
+
+## Aesthetic
+
+Calm, refined wellness — Booksy / Mindbody / boutique-spa territory:
+
+- **Fraunces serif** for headings (warm, slightly editorial).
+- **Inter** for body and UI.
+- **Sand + sage palette**: warm cream background, deep sage primary.
+- **Soft corners**: `--radius: 1rem` — generous rounding throughout.
+- **Lower-contrast** than retail / fashion; calm-feeling.
+
+## Industry-specific copy patterns
+
+The bundled brand presets:
+- `brand.hero.badge` reads `"Now booking · April"` — month-based availability.
+- `brand.hero.primaryCtaLabel` is `"Book a treatment"`.
+- `brand.tradeIn` is omitted (irrelevant for services).
+- `brand.faq` covers booking, cancellation, contraindications, memberships.
+- Schema.org type is `BeautySalon`.
+
+## Mock seed
+
+Wired to `--seed services` (Serene Spa). Products in this seed are *services* (`type: "service"`), so the SDK's variant cards render `StandardServiceCard` automatically.
+
+## Quick start
+
+```bash
+bun install
+bun dev
+```
+
+Open <http://localhost:3000>.