@mohasinac/feat-homepage 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,387 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { IRepository, SieveQuery, PagedResult, FeatureManifest } from '@mohasinac/contracts';
+import { NextResponse } from 'next/server';
+
+type HomepageSectionType = "hero" | "featured_categories" | "featured_products" | "banner" | "testimonials" | "promotions" | "blog_posts" | "sellers" | "custom";
+interface HomepageSectionContent {
+    title?: string;
+    subtitle?: string;
+    ctaLabel?: string;
+    ctaUrl?: string;
+    imageUrl?: string;
+    videoUrl?: string;
+    itemIds?: string[];
+    html?: string;
+}
+interface HomepageSection {
+    id: string;
+    type: HomepageSectionType;
+    title?: string;
+    /** Primary enable/disable flag stored in Firestore as `enabled` */
+    enabled?: boolean;
+    /** Alias kept for older consumers */
+    isVisible?: boolean;
+    order?: number;
+    content?: HomepageSectionContent;
+    mobile?: Partial<HomepageSectionContent>;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface HomepageData {
+    sections: HomepageSection[];
+}
+interface HotspotPin {
+    id: string;
+    name: string;
+    universe: string;
+    description: string;
+    href: string;
+    /** Percentage from left edge, 0–100 */
+    xPct: number;
+    /** Percentage from top edge, 0–100 */
+    yPct: number;
+    /** Hex accent colour for popup header/button */
+    accent: string;
+    /** Small label on pin (optional) */
+    badge?: string;
+    /** CTA button label */
+    buyText: string;
+}
+interface CharacterHotspotConfig {
+    imageUrl: string;
+    imageAlt: string;
+    active: boolean;
+    pins: HotspotPin[];
+    updatedAt?: string;
+}
+interface Banner {
+    id: string;
+    title: string;
+    subtitle?: string;
+    ctaLabel?: string;
+    ctaUrl?: string;
+    backgroundImage?: string;
+    backgroundColor?: string;
+    textColor?: string;
+    sortOrder: number;
+    active: boolean;
+}
+interface PromoBanner {
+    id: string;
+    title: string;
+    ctaLabel: string;
+    ctaUrl: string;
+    image: string;
+    sortOrder: number;
+    active: boolean;
+}
+type TrustBadgeIconKey = "shipping" | "support" | "rewards" | "secure";
+interface TrustBadge {
+    id: string;
+    title: string;
+    sub: string;
+    iconKey: TrustBadgeIconKey;
+    sortOrder: number;
+    active: boolean;
+}
+interface Testimonial {
+    id: string;
+    name: string;
+    rating: 1 | 2 | 3 | 4 | 5;
+    text: string;
+    avatarUrl?: string;
+    featured: boolean;
+    sortOrder: number;
+    active: boolean;
+}
+interface BeforeAfterItem {
+    id: string;
+    beforeImage: string;
+    afterImage: string;
+    productId?: string;
+    caption: string;
+    sortOrder: number;
+}
+interface CarouselSlideCard {
+    id: string;
+    gridRow: 1 | 2;
+    gridCol: 1 | 2 | 3;
+    background: {
+        type: "color" | "gradient" | "image" | "transparent";
+        value: string;
+    };
+    content?: {
+        title?: string;
+        subtitle?: string;
+        description?: string;
+    };
+    buttons?: Array<{
+        id: string;
+        text: string;
+        link: string;
+        variant: "primary" | "secondary" | "outline";
+        openInNewTab: boolean;
+    }>;
+    isButtonOnly: boolean;
+    sizing?: {
+        widthPct?: 25 | 50 | 75 | 100;
+        heightPct?: 25 | 50 | 75 | 100;
+        padding?: "none" | "sm" | "md" | "lg";
+    };
+}
+interface CarouselSlide {
+    id: string;
+    title: string;
+    order: number;
+    active: boolean;
+    media: {
+        type: "image" | "video";
+        url: string;
+        alt: string;
+        thumbnail?: string;
+    };
+    link?: {
+        url: string;
+        openInNewTab: boolean;
+    };
+    mobileMedia?: {
+        type: "image" | "video";
+        url: string;
+        alt: string;
+    };
+    cards: CarouselSlideCard[];
+    overlay?: {
+        title?: string;
+        subtitle?: string;
+        description?: string;
+        button?: {
+            id: string;
+            text: string;
+            link: string;
+            variant: "primary" | "secondary" | "outline";
+            openInNewTab: boolean;
+        };
+    };
+    createdAt?: string;
+    updatedAt?: string;
+}
+
+interface UseHomepageOptions {
+    initialData?: HomepageData;
+    enabled?: boolean;
+}
+declare function useHomepage(opts?: UseHomepageOptions): {
+    sections: HomepageSection[];
+    isLoading: boolean;
+    error: Error | null;
+};
+
+interface HeroSectionProps {
+    section: HomepageSection;
+    onCtaClick?: () => void;
+}
+declare function HeroSection({ section, onCtaClick }: HeroSectionProps): react_jsx_runtime.JSX.Element;
+
+interface CharacterHotspotProps {
+    config?: CharacterHotspotConfig | null;
+    /**
+     * Override the default fallback hotspot pins shown when no config is supplied.
+     * Useful for non-collectibles storefronts.
+     */
+    defaultHotspots?: HotspotPin[];
+    /** Universe quick-browse links shown below the panorama. */
+    universeLinks?: {
+        label: string;
+        href: string;
+        color: string;
+        icon: string;
+    }[];
+    /** "Shop all" button href */
+    shopAllHref?: string;
+    /** Section heading */
+    heading?: string;
+    /** Sub-heading / helper text */
+    subheading?: string;
+}
+declare function CharacterHotspot({ config, defaultHotspots, universeLinks, shopAllHref, heading, subheading, }: CharacterHotspotProps): react_jsx_runtime.JSX.Element | null;
+
+interface CharacterHotspotFormProps {
+    initial?: CharacterHotspotConfig | null;
+    /**
+     * Upload an image and return its public URL.
+     * Implement however suits your storage backend:
+     * ```ts
+     * onUploadImage={async (file) => {
+     *   const storage = getStorage(getFirebaseApp());
+     *   const storageRef = ref(storage, `character-hotspot/${Date.now()}_${file.name}`);
+     *   await uploadBytes(storageRef, file);
+     *   return getDownloadURL(storageRef);
+     * }}
+     * ```
+     */
+    onUploadImage: (file: File) => Promise<string>;
+    /**
+     * Persist the final config (e.g. write to Firestore).
+     */
+    onSave: (config: CharacterHotspotConfig) => Promise<void>;
+    /**
+     * Optional callback after a successful save (e.g. revalidate cache).
+     */
+    onAfterSave?: () => void | Promise<void>;
+}
+declare function CharacterHotspotForm({ initial, onUploadImage, onSave, onAfterSave, }: CharacterHotspotFormProps): react_jsx_runtime.JSX.Element;
+
+interface HeroBannerProps {
+    banners: Banner[];
+    /** Milliseconds between automatic slide advances. Default: 5000. */
+    autoplayMs?: number;
+}
+declare function HeroBanner({ banners, autoplayMs }: HeroBannerProps): react_jsx_runtime.JSX.Element | null;
+
+interface PromoGridProps {
+    banners: PromoBanner[];
+    /** Eyebrow label above the section heading. Default: "LIMITED TIME". */
+    eyebrow?: string;
+    /** Section heading. Default: "HOT DEALS & PROMOS". */
+    heading?: string;
+}
+declare function PromoGrid({ banners, eyebrow, heading, }: PromoGridProps): react_jsx_runtime.JSX.Element | null;
+
+interface TrustBadgesProps {
+    badges?: TrustBadge[];
+}
+declare function TrustBadges({ badges }: TrustBadgesProps): react_jsx_runtime.JSX.Element;
+
+interface TestimonialsCarouselProps {
+    testimonials: Testimonial[];
+    /** Eyebrow label. Default: "COLLECTOR REVIEWS". */
+    eyebrow?: string;
+    /** Section heading. Default: "WHAT OUR COLLECTORS SAY". */
+    heading?: string;
+}
+declare function TestimonialsCarousel({ testimonials, eyebrow, heading, }: TestimonialsCarouselProps): react_jsx_runtime.JSX.Element | null;
+
+interface BeforeAfterCardProps {
+    item: BeforeAfterItem;
+    /** Label shown on the left (before) side. Default: "Before". */
+    beforeLabel?: string;
+    /** Label shown on the right (after) side. Default: "After". */
+    afterLabel?: string;
+}
+declare function BeforeAfterCard({ item, beforeLabel, afterLabel, }: BeforeAfterCardProps): react_jsx_runtime.JSX.Element;
+
+interface NewsletterBannerProps {
+    /**
+     * Called when the user submits the form. Throw on failure — the component
+     * will show a generic error message.
+     */
+    onSubscribe: (email: string) => Promise<void>;
+    /** Eyebrow label. Default: "STAY CONNECTED". */
+    eyebrow?: string;
+    /** Section heading. Default: "Join Our Newsletter". */
+    heading?: string;
+    /** Sub-heading. Default: "Get exclusive offers, new arrivals and more." */
+    subheading?: string;
+    /** Email placeholder text. Default: "Enter your email". */
+    placeholder?: string;
+    /** CTA button label. Default: "Subscribe". */
+    ctaLabel?: string;
+    /** Success message shown after subscribe. Default: "You're in! Check your inbox." */
+    successMessage?: string;
+    /** Error message on failure. Default: "Something went wrong. Please try again." */
+    errorMessage?: string;
+}
+declare function NewsletterBanner({ onSubscribe, eyebrow, heading, subheading, placeholder, ctaLabel, successMessage, errorMessage, }: NewsletterBannerProps): react_jsx_runtime.JSX.Element;
+
+declare class HomepageSectionsRepository {
+    private readonly repo;
+    constructor(repo: IRepository<HomepageSection>);
+    findAll(query?: SieveQuery): Promise<PagedResult<HomepageSection>>;
+    findById(id: string): Promise<HomepageSection | null>;
+    create(data: Omit<HomepageSection, "id">): Promise<HomepageSection>;
+    update(id: string, data: Partial<HomepageSection>): Promise<HomepageSection>;
+    delete(id: string): Promise<void>;
+}
+
+declare const manifest: FeatureManifest;
+
+/**
+ * feat-homepage — Next.js App Router API handlers (GET/POST /api/homepage-sections)
+ *
+ * Pure stub:
+ * ```ts
+ * // app/api/homepage-sections/route.ts
+ * export { GET, POST } from "@mohasinac/feat-homepage";
+ * ```
+ */
+
+declare function GET$3(request: Request): Promise<NextResponse>;
+declare const POST: (request: Request, context: {
+    params: Promise<Record<string, string>>;
+}) => Promise<NextResponse>;
+
+/**
+ * feat-homepage — GET / PATCH / DELETE /api/homepage-sections/[id]
+ *
+ * Pure stub:
+ * ```ts
+ * // app/api/homepage-sections/[id]/route.ts
+ * export { homepageSectionItemGET as GET, homepageSectionItemPATCH as PATCH, homepageSectionItemDELETE as DELETE }
+ *   from "@mohasinac/feat-homepage";
+ * ```
+ */
+
+declare function GET$2(_request: Request, context: {
+    params: Promise<{
+        id: string;
+    }>;
+}): Promise<NextResponse>;
+
+declare const homepageSectionItemPATCH: (request: Request, context: {
+    params: Promise<Record<string, string>>;
+}) => Promise<NextResponse>;
+declare const homepageSectionItemDELETE: (request: Request, context: {
+    params: Promise<Record<string, string>>;
+}) => Promise<NextResponse>;
+
+/**
+ * feat-homepage — Next.js App Router API handler (GET/POST /api/carousel)
+ *
+ * Pure stub:
+ * ```ts
+ * // app/api/carousel/route.ts
+ * export { carouselGET as GET, carouselPOST as POST } from "@mohasinac/feat-homepage";
+ * ```
+ */
+
+declare function GET$1(request: Request): Promise<NextResponse>;
+
+declare const carouselPOST: (request: Request, context: {
+    params: Promise<Record<string, string>>;
+}) => Promise<NextResponse>;
+
+/**
+ * feat-homepage — GET / PATCH / DELETE /api/carousel/[id]
+ *
+ * Pure stub:
+ * ```ts
+ * // app/api/carousel/[id]/route.ts
+ * export { carouselItemGET as GET, carouselItemPATCH as PATCH, carouselItemDELETE as DELETE }
+ *   from "@mohasinac/feat-homepage";
+ * ```
+ */
+
+declare function GET(_request: Request, context: {
+    params: Promise<{
+        id: string;
+    }>;
+}): Promise<NextResponse>;
+
+declare const carouselItemPATCH: (request: Request, context: {
+    params: Promise<Record<string, string>>;
+}) => Promise<NextResponse>;
+declare const carouselItemDELETE: (request: Request, context: {
+    params: Promise<Record<string, string>>;
+}) => Promise<NextResponse>;
+
+export { type Banner, BeforeAfterCard, type BeforeAfterCardProps, type BeforeAfterItem, type CarouselSlide, type CarouselSlideCard, CharacterHotspot, type CharacterHotspotConfig, CharacterHotspotForm, type CharacterHotspotFormProps, type CharacterHotspotProps, GET$3 as GET, HeroBanner, type HeroBannerProps, HeroSection, type HomepageData, type HomepageSection, type HomepageSectionContent, type HomepageSectionType, HomepageSectionsRepository, type HotspotPin, NewsletterBanner, type NewsletterBannerProps, POST, type PromoBanner, PromoGrid, type PromoGridProps, type Testimonial, TestimonialsCarousel, type TestimonialsCarouselProps, type TrustBadge, type TrustBadgeIconKey, TrustBadges, type TrustBadgesProps, GET$1 as carouselGET, carouselItemDELETE, GET as carouselItemGET, carouselItemPATCH, carouselPOST, GET$3 as homepageGET, homepageSectionItemDELETE, GET$2 as homepageSectionItemGET, homepageSectionItemPATCH, manifest, useHomepage };