@soloworks/smking-next 0.12.2 → 0.14.0

package/src/types.ts

@@ -58,6 +58,25 @@ export type CmsStatus = "ready" | "pending" | "not_found";
 
 export type CmsContentType = "article" | "landing" | "listing";
 
+/**
+ * Theme mode (v0.14+) — decides how `<SmkingCms>` ships styling.
+ *
+ * - `'css'` (Mode A, default) — SDK inlines the canonical
+ *   `<style data-smking="cms-styles">` once per render plus emits
+ *   `.smk-*` class hooks on every block. Zero dependency on Tailwind.
+ *   Customers theme via CSS variable overrides (`:root { --smk-accent: … }`).
+ *
+ * - `'tailwind-prose'` (Mode B) — SDK skips the inline stylesheet,
+ *   wraps the article in `<article class="prose dark:prose-invert">`
+ *   and emits Tailwind utility classes on each block. Customer must
+ *   have `@tailwindcss/typography` plugin wired up and the required
+ *   classes safelisted (the wizard does this on install).
+ *
+ * Resolution order: explicit `<SmkingCms mode>` prop → `SMKING_CMS_THEME`
+ * env var → 'css'.
+ */
+export type CmsThemeMode = "css" | "tailwind-prose";
+
 /**
  * v2 substrate block primitives. Mirrors `apps/web/src/features/cms/types.ts`
  * on the SaaS side (kept in sync manually — when the v1 block catalog
@@ -79,10 +98,30 @@ export interface ModuleHeader {
   viewAll?: { label: string; href: string };
 }
 export type NavLayout = "grid" | "list" | "carousel";
+
+/**
+ * Materialized snapshot entry — published pages on the smking SaaS
+ * pre-resolve their nav-* block data at publish time and bake it into
+ * `block.props.snapshot`. Customer SDK echoes this verbatim, never
+ * round-trips back to smking for nav rendering. If smking is down,
+ * customer pages still render whatever was last published.
+ */
+export interface NavSnapshotEntry {
+  slug: string;
+  title: string | null;
+  excerpt: string | null;
+  featuredImageUrl: string | null;
+  /** ISO string. */
+  publishedAt: string | null;
+  contentType: "article" | "landing" | "listing" | null;
+}
+
 export interface NavRecentPostsProps extends ModuleHeader {
   limit: number;
   layout: NavLayout;
   contentType?: "article" | "all";
+  /** Publish-time materialized — never fetched live. */
+  snapshot?: NavSnapshotEntry[];
 }
 export interface NavTaxonomyListProps extends ModuleHeader {
   /** category-by-path: slug prefix; tag: taxonomies.slug */
@@ -90,15 +129,49 @@ export interface NavTaxonomyListProps extends ModuleHeader {
   path: string;
   limit: number;
   layout: NavLayout;
+  /** Publish-time materialized — never fetched live. */
+  snapshot?: NavSnapshotEntry[];
+}
+
+/**
+ * Search index entry. Customer SDK does client-side fuzzy filter
+ * against this list; clicking a result navigates to the slug.
+ */
+export interface NavSearchIndexEntry {
+  slug: string;
+  title: string | null;
+  excerpt: string | null;
 }
+
 export interface NavSearchProps {
   placeholder: string;
   contentType?: "article" | "all";
+  /** Publish-time materialized full-site search index. */
+  index?: NavSearchIndexEntry[];
+}
+
+export interface CarouselSlideProps {
+  imageUrl: string;
+  caption: string;
+}
+
+export type CarouselAspectRatio =
+  | "16:9"
+  | "4:3"
+  | "1:1"
+  | "3:4"
+  | "9:16";
+
+export interface CarouselProps {
+  slides: CarouselSlideProps[];
+  /** Fixed aspect ratio for all slides — image fills via `object-fit: cover`. Default `16:9`. */
+  aspectRatio?: CarouselAspectRatio;
 }
 
 export type Block =
   | { component: "hero"; id: string; props: HeroProps }
   | { component: "article"; id: string; props: ArticleProps }
+  | { component: "carousel"; id: string; props: CarouselProps }
   | {
       component: "nav-recent-posts";
       id: string;