@la-main-verte/shared-types 1.0.90 → 1.0.92

package/src/home.api.d.ts

@@ -1,352 +1,354 @@
-import type { PlantI } from './plant'
-import type { SelectionI } from './selection'
-import type { TaskI } from './task'
-
-export namespace HOME {
-  export type HeroCardMode = 'featuredSelection' | 'featuredPlant'
-
-  export type SectionComponentType =
-    | 'Header'
-    | 'HeroCards'
-    | 'PlantCarousel'
-    | 'HeroCardsCarousel'
-    | 'WideCardsCarousel'
-    | 'Weather'
-    | 'AdviceCarousel'
-    | 'OnboardingCard'
-    | 'MissionCard'
-    | 'UpcomingTasks'
-
-  export type CarouselComponentType = Extract<
-    SectionComponentType,
-    'PlantCarousel' | 'HeroCardsCarousel' | 'WideCardsCarousel'
-  >
-
-  export interface WeatherDayI {
-    /**
-     * Forecast date anchored at noon UTC, e.g. `2026-06-10T12:00:00Z`.
-     * Noon avoids clients parsing a bare `YYYY-MM-DD` as UTC midnight and
-     * displaying the previous local day in negative-offset timezones.
-     */
-    date: string
-    /**
-     * Localized weekday label (e.g. "samedi" / "Saturday") pre-computed
-     * server-side. Provided so clients can render the correct day without
-     * reparsing `date`.
-     */
-    weekday: string
-    minTempC: number
-    maxTempC: number
-    iconUrl: string | null
-    condition?: string | null
-  }
-
-  export interface WeatherSectionI {
-    componentType: 'Weather'
-    title: string
-    subtitle?: string
-    locationName: string
-    timezone: string
-    days: WeatherDayI[]
-    lastUpdatedAt: string
-    dataSource: 'weatherapi'
-    backgroundColor?: string
-  }
-
-  export interface HeaderSectionI {
-    componentType: 'Header'
-    title: string
-    subtitle: string
-  }
-
-  export interface AdviceI {
-    id?: string | number
-    title: string
-    markdownContent: string
-    titleColor?: string
-    backgroundColor?: string
-  }
-
-  export interface AdviceSectionI {
-    componentType: 'AdviceCarousel'
-    title?: string
-    subtitle?: string
-    advices: AdviceI[]
-  }
-
-  export interface WideCardAuthorI {
-    name?: string | null
-    imageURL?: string | null
-  }
-
-  export interface WideCardItemI {
-    id?: string | number
-    title?: string | null
-    text: string
-    badgeText?: string | null
-    thumbnailImageURL: string
-    author?: WideCardAuthorI | null
-    link?: string | null
-    metadata?: Record<string, unknown>
-  }
-
-  export interface WideCardsCarouselSectionI {
-    componentType: 'WideCardsCarousel'
-    title: string
-    subtitle?: string
-    cards: WideCardItemI[]
-  }
-
-  export interface HeroCardBlueprintI {
-    mode: HeroCardMode
-    title?: string | null
-    description?: string | null
-    backgroundColor?: string | null
-    backgroundImageUrl?: string | null
-    ctaLabel?: string | null
-    ctaRoute?: string | null
-    previewPlants?: PlantI[]
-    selection?: SelectionI | null
-    plant?: PlantI | null
-  }
-
-  export interface HeroCardsSectionI {
-    componentType: 'HeroCards'
-    title?: string | null
-    subtitle?: string | null
-    cards: HeroCardBlueprintI[]
-  }
-
-  export interface PlantCarouselSectionI {
-    componentType: 'PlantCarousel'
-    title: string
-    subtitle?: string
-    selection: SelectionI
-    displayRanking?: boolean
-  }
-
-  export interface HeroCardsCarouselSectionI {
-    componentType: 'HeroCardsCarousel'
-    selections: SelectionI[]
-  }
-
-  export interface FamilyRecommendationI {
-    family: string
-    headline: string
-    plants: PlantI[]
-  }
-
-  export interface FamilyExplorerSectionI {
-    componentType: 'FamilyExplorer'
-    title: string
-    subtitle?: string
-    families: FamilyRecommendationI[]
-  }
-
-  export interface OnboardingStepI {
-    id: string
-    title: string
-    description: string
-    isCompleted: boolean
-    ctaLink: string
-  }
-
-  export interface OnboardingCardSectionI {
-    componentType: 'OnboardingCard'
-    title: string
-    subtitle: string
-    steps: OnboardingStepI[]
-    completedStepsCount: number
-    totalStepsCount: number
-  }
-
-  /**
-   * Mission Engine
-   * --------------
-   * A mission is a reusable, data-driven collection of measurable steps that
-   * guides a member toward an objective. Completing every step unlocks the
-   * reward and (server-side) enrolls the member into the mission's Audience for
-   * downstream automation. The frontend only renders the completion state the
-   * backend computes — it never decides whether a step is done.
-   *
-   * Shipped under a NEW `componentType` ('MissionCard') so older app builds that
-   * only know 'OnboardingCard' gracefully skip it instead of rendering the new
-   * (incompatible) shape.
-   */
-  /** Visual identity of a mission — drives all color decisions on the card. */
-  export interface MissionThemeI {
-    /** Accent color: badge, progress bar, reward text, icon tints. */
-    accentColor: string
-    /** Background color: card surface and reward card surface. */
-    backgroundColor: string
-  }
-
-  export interface MissionRewardI {
-    /** Heading above the reward, e.g. "Ta récompense". */
-    title: string
-    /** Fine print, e.g. "À utiliser sur ta prochaine commande !". */
-    description: string
-    /** Short highlight, e.g. "-10%" or "5 $ de rabais". */
-    badgeText: string
-    /** Partner brand the reward belongs to, e.g. "Semences du Portage". Null for first-party rewards. */
-    partnerName?: string | null
-    partnerLogoURL?: string | null
-    /** Coupon / discount code to redeem the reward. Revealed on completion. */
-    discountCode?: string | null
-    /** Outbound link to redeem (partner store, already UTM/discount-decorated). */
-    ctaLink?: string | null
-  }
-
-  export interface MissionStepI {
-    id: string
-    title: string
-    subtitle?: string
-    /** FontAwesome icon name. Ignored when `imageURL` is set. */
-    icon?: string | null
-    /** Custom image shown instead of an icon. */
-    imageURL?: string | null
-    /** Completion is decided by the backend; the client just displays it. */
-    isCompleted: boolean
-    /** Deep link / route opened when the step is tapped (every step has a CTA). */
-    ctaLink: string
-    /**
-     * When present, tapping this step activates the named onboarding flow on
-     * the destination screen. Null means no tutorial is attached to this step.
-     */
-    onboardingFlowId?: string | null
-  }
-
-  export interface MissionCardSectionI {
-    componentType: 'MissionCard'
-    /** Stable mission identifier (slug) — also used as the section id. */
-    id: string
-    title: string
-    subtitle: string
-    description?: string
-    /** Visual theme applied to the card and all its sub-elements. */
-    theme: MissionThemeI
-    /** Illustration aligned to the right of the card. */
-    backgroundImageURL?: string
-    steps: MissionStepI[]
-    completedStepsCount: number
-    totalStepsCount: number
-    /** True once every step is complete (reward unlocked). */
-    isCompleted: boolean
-    reward: MissionRewardI
-    /** Display order across missions (ascending). */
-    sortOrder: number
-  }
-
-  /** Minimal plant info for preview display (e.g. parent plant in grouped tasks) */
-  export interface TaskPlantPreviewI {
-    name: string
-    slug: string
-    imageURL?: string | null
-  }
-
-  /** Plant info within a family group — includes the task ID specific to this plant */
-  export interface TaskFamilyPlantPreviewI extends TaskPlantPreviewI {
-    taskId: number
-  }
-
-  /** Family group info when multiple plants share the same task */
-  export interface TaskFamilyGroupI {
-    familyName: string
-    plantsCount: number
-    plants: TaskFamilyPlantPreviewI[]
-  }
-
-  export interface UpcomingTaskI {
-    task: TaskI
-    /** PlantSelection id used by task list views to group tasks per planted item. */
-    plantSelectionId?: number
-    plantName: string
-    plantSlug: string
-    plantImageURL?: string | null
-    gardenName: string
-    gardenCategory: string
-    selectionSlug: string
-    /** If this task is grouped by family */
-    familyGroup?: TaskFamilyGroupI
-  }
-
-  export type TaskListView = 'current' | 'completed' | 'earlier'
-
-  export interface UpcomingTaskAdviceI {
-    /** @deprecated Since 1.9.10, this field is always `''`. */
-    content: string
-    taskName: string
-    plantName: string
-    plantSlug: string
-    plantImageURL?: string | null
-    gardenName: string
-    gardenCategory: string
-    selectionSlug: string
-    task: TaskI
-    /** If this task is grouped by family */
-    familyGroup?: TaskFamilyGroupI
-  }
-
-  export interface UpcomingTasksSectionI {
-    componentType: 'UpcomingTasks'
-    title: string
-    subtitle?: string
-    advices: UpcomingTaskAdviceI[]
-  }
-
-  /** Preview plant for WhenToSeedWhat section */
-  export interface WhenToSeedWhatPlantPreviewI {
-    id: number
-    name: string
-    family?: string | null
-    slug: string
-    imageURL?: string | null
-  }
-
-  /** A generic link card section with title, subtitle, URL, and optional preview images */
-  export interface LinkCardSectionI {
-    componentType: 'LinkCard'
-    title: string
-    subtitle?: string
-    url: string
-    previewPlants?: WhenToSeedWhatPlantPreviewI[]
-    backgroundColor?: string
-    /** Show a red badge indicator (replaces the plant preview stack when true) */
-    showBadge?: boolean
-    /** Optional badge count to display */
-    badgeCount?: number
-  }
-
-  export type SectionI =
-    | HeaderSectionI
-    | HeroCardsSectionI
-    | PlantCarouselSectionI
-    | HeroCardsCarouselSectionI
-    | WideCardsCarouselSectionI
-    | WeatherSectionI
-    | AdviceSectionI
-    | OnboardingCardSectionI
-    | MissionCardSectionI
-    | UpcomingTasksSectionI
-    | LinkCardSectionI
-
-  export interface Response {
-    sections: SectionI[]
-    weather?: WeatherSectionI
-    advice?: AdviceSectionI
-  }
-
-  export interface HeroCardItemI {
-    id?: string | null
-    mode: HeroCardMode
-    title?: string | null
-    description?: string | null
-    backgroundColor?: string | null
-    backgroundImageUrl?: string | null
-    previewPlants?: PlantI[]
-    ctaLabel?: string | null
-    selection?: SelectionI | null
-    plant?: PlantI | null
-    ctaRoute?: string | null
-  }
-}
+import type { PlantI } from './plant'
+import type { SelectionI } from './selection'
+import type { TaskI } from './task'
+
+export namespace HOME {
+  export type HeroCardMode = 'featuredSelection' | 'featuredPlant'
+
+  export type SectionComponentType =
+    | 'Header'
+    | 'HeroCards'
+    | 'PlantCarousel'
+    | 'HeroCardsCarousel'
+    | 'WideCardsCarousel'
+    | 'Weather'
+    | 'AdviceCarousel'
+    | 'OnboardingCard'
+    | 'MissionCard'
+    | 'UpcomingTasks'
+
+  export type CarouselComponentType = Extract<
+    SectionComponentType,
+    'PlantCarousel' | 'HeroCardsCarousel' | 'WideCardsCarousel'
+  >
+
+  export interface WeatherDayI {
+    /**
+     * Forecast date anchored at noon UTC, e.g. `2026-06-10T12:00:00Z`.
+     * Noon avoids clients parsing a bare `YYYY-MM-DD` as UTC midnight and
+     * displaying the previous local day in negative-offset timezones.
+     */
+    date: string
+    /**
+     * Localized weekday label (e.g. "samedi" / "Saturday") pre-computed
+     * server-side. Provided so clients can render the correct day without
+     * reparsing `date`.
+     */
+    weekday: string
+    minTempC: number
+    maxTempC: number
+    iconUrl: string | null
+    condition?: string | null
+  }
+
+  export interface WeatherSectionI {
+    componentType: 'Weather'
+    title: string
+    subtitle?: string
+    locationName: string
+    timezone: string
+    days: WeatherDayI[]
+    lastUpdatedAt: string
+    dataSource: 'weatherapi'
+    backgroundColor?: string
+  }
+
+  export interface HeaderSectionI {
+    componentType: 'Header'
+    title: string
+    subtitle: string
+  }
+
+  export interface AdviceI {
+    id?: string | number
+    title: string
+    markdownContent: string
+    titleColor?: string
+    backgroundColor?: string
+  }
+
+  export interface AdviceSectionI {
+    componentType: 'AdviceCarousel'
+    title?: string
+    subtitle?: string
+    advices: AdviceI[]
+  }
+
+  export interface WideCardAuthorI {
+    name?: string | null
+    imageURL?: string | null
+  }
+
+  export interface WideCardItemI {
+    id?: string | number
+    title?: string | null
+    text: string
+    badgeText?: string | null
+    thumbnailImageURL: string
+    author?: WideCardAuthorI | null
+    link?: string | null
+    metadata?: Record<string, unknown>
+  }
+
+  export interface WideCardsCarouselSectionI {
+    componentType: 'WideCardsCarousel'
+    title: string
+    subtitle?: string
+    cards: WideCardItemI[]
+  }
+
+  export interface HeroCardBlueprintI {
+    mode: HeroCardMode
+    title?: string | null
+    description?: string | null
+    backgroundColor?: string | null
+    backgroundImageUrl?: string | null
+    ctaLabel?: string | null
+    ctaRoute?: string | null
+    previewPlants?: PlantI[]
+    selection?: SelectionI | null
+    plant?: PlantI | null
+  }
+
+  export interface HeroCardsSectionI {
+    componentType: 'HeroCards'
+    title?: string | null
+    subtitle?: string | null
+    cards: HeroCardBlueprintI[]
+  }
+
+  export interface PlantCarouselSectionI {
+    componentType: 'PlantCarousel'
+    title: string
+    subtitle?: string
+    selection: SelectionI
+    displayRanking?: boolean
+  }
+
+  export interface HeroCardsCarouselSectionI {
+    componentType: 'HeroCardsCarousel'
+    selections: SelectionI[]
+  }
+
+  export interface FamilyRecommendationI {
+    family: string
+    headline: string
+    plants: PlantI[]
+  }
+
+  export interface FamilyExplorerSectionI {
+    componentType: 'FamilyExplorer'
+    title: string
+    subtitle?: string
+    families: FamilyRecommendationI[]
+  }
+
+  export interface OnboardingStepI {
+    id: string
+    title: string
+    description: string
+    isCompleted: boolean
+    ctaLink: string
+  }
+
+  export interface OnboardingCardSectionI {
+    componentType: 'OnboardingCard'
+    title: string
+    subtitle: string
+    steps: OnboardingStepI[]
+    completedStepsCount: number
+    totalStepsCount: number
+  }
+
+  /**
+   * Mission Engine
+   * --------------
+   * A mission is a reusable, data-driven collection of measurable steps that
+   * guides a member toward an objective. Completing every step unlocks the
+   * reward and (server-side) enrolls the member into the mission's Audience for
+   * downstream automation. The frontend only renders the completion state the
+   * backend computes — it never decides whether a step is done.
+   *
+   * Shipped under a NEW `componentType` ('MissionCard') so older app builds that
+   * only know 'OnboardingCard' gracefully skip it instead of rendering the new
+   * (incompatible) shape.
+   */
+  /** Visual identity of a mission — drives all color decisions on the card. */
+  export interface MissionThemeI {
+    /** Accent color: badge, progress bar, reward text, icon tints. */
+    accentColor: string
+    /** Background color: card header and reward section surface. */
+    backgroundColor: string
+    /** Text color for content rendered on the backgroundColor surface. */
+    textColor: string
+  }
+
+  export interface MissionRewardI {
+    /** Heading above the reward, e.g. "Ta récompense". */
+    title: string
+    /** Fine print, e.g. "À utiliser sur ta prochaine commande !". */
+    description: string
+    /** Short highlight, e.g. "-10%" or "5 $ de rabais". */
+    badgeText: string
+    /** Partner brand the reward belongs to, e.g. "Semences du Portage". Null for first-party rewards. */
+    partnerName?: string | null
+    partnerLogoURL?: string | null
+    /** Coupon / discount code to redeem the reward. Revealed on completion. */
+    discountCode?: string | null
+    /** Outbound link to redeem (partner store, already UTM/discount-decorated). */
+    ctaLink?: string | null
+  }
+
+  export interface MissionStepI {
+    id: string
+    title: string
+    subtitle?: string
+    /** FontAwesome icon name. Ignored when `imageURL` is set. */
+    icon?: string | null
+    /** Custom image shown instead of an icon. */
+    imageURL?: string | null
+    /** Completion is decided by the backend; the client just displays it. */
+    isCompleted: boolean
+    /** Deep link / route opened when the step is tapped (every step has a CTA). */
+    ctaLink: string
+    /**
+     * When present, tapping this step activates the named onboarding flow on
+     * the destination screen. Null means no tutorial is attached to this step.
+     */
+    onboardingFlowId?: string | null
+  }
+
+  export interface MissionCardSectionI {
+    componentType: 'MissionCard'
+    /** Stable mission identifier (slug) — also used as the section id. */
+    id: string
+    title: string
+    subtitle: string
+    description?: string
+    /** Visual theme applied to the card and all its sub-elements. */
+    theme: MissionThemeI
+    /** Illustration aligned to the right of the card. */
+    backgroundImageURL?: string
+    steps: MissionStepI[]
+    completedStepsCount: number
+    totalStepsCount: number
+    /** True once every step is complete (reward unlocked). */
+    isCompleted: boolean
+    reward?: MissionRewardI | null
+    /** Display order across missions (ascending). */
+    sortOrder: number
+  }
+
+  /** Minimal plant info for preview display (e.g. parent plant in grouped tasks) */
+  export interface TaskPlantPreviewI {
+    name: string
+    slug: string
+    imageURL?: string | null
+  }
+
+  /** Plant info within a family group — includes the task ID specific to this plant */
+  export interface TaskFamilyPlantPreviewI extends TaskPlantPreviewI {
+    taskId: number
+  }
+
+  /** Family group info when multiple plants share the same task */
+  export interface TaskFamilyGroupI {
+    familyName: string
+    plantsCount: number
+    plants: TaskFamilyPlantPreviewI[]
+  }
+
+  export interface UpcomingTaskI {
+    task: TaskI
+    /** PlantSelection id used by task list views to group tasks per planted item. */
+    plantSelectionId?: number
+    plantName: string
+    plantSlug: string
+    plantImageURL?: string | null
+    gardenName: string
+    gardenCategory: string
+    selectionSlug: string
+    /** If this task is grouped by family */
+    familyGroup?: TaskFamilyGroupI
+  }
+
+  export type TaskListView = 'current' | 'completed' | 'earlier'
+
+  export interface UpcomingTaskAdviceI {
+    /** @deprecated Since 1.9.10, this field is always `''`. */
+    content: string
+    taskName: string
+    plantName: string
+    plantSlug: string
+    plantImageURL?: string | null
+    gardenName: string
+    gardenCategory: string
+    selectionSlug: string
+    task: TaskI
+    /** If this task is grouped by family */
+    familyGroup?: TaskFamilyGroupI
+  }
+
+  export interface UpcomingTasksSectionI {
+    componentType: 'UpcomingTasks'
+    title: string
+    subtitle?: string
+    advices: UpcomingTaskAdviceI[]
+  }
+
+  /** Preview plant for WhenToSeedWhat section */
+  export interface WhenToSeedWhatPlantPreviewI {
+    id: number
+    name: string
+    family?: string | null
+    slug: string
+    imageURL?: string | null
+  }
+
+  /** A generic link card section with title, subtitle, URL, and optional preview images */
+  export interface LinkCardSectionI {
+    componentType: 'LinkCard'
+    title: string
+    subtitle?: string
+    url: string
+    previewPlants?: WhenToSeedWhatPlantPreviewI[]
+    backgroundColor?: string
+    /** Show a red badge indicator (replaces the plant preview stack when true) */
+    showBadge?: boolean
+    /** Optional badge count to display */
+    badgeCount?: number
+  }
+
+  export type SectionI =
+    | HeaderSectionI
+    | HeroCardsSectionI
+    | PlantCarouselSectionI
+    | HeroCardsCarouselSectionI
+    | WideCardsCarouselSectionI
+    | WeatherSectionI
+    | AdviceSectionI
+    | OnboardingCardSectionI
+    | MissionCardSectionI
+    | UpcomingTasksSectionI
+    | LinkCardSectionI
+
+  export interface Response {
+    sections: SectionI[]
+    weather?: WeatherSectionI
+    advice?: AdviceSectionI
+  }
+
+  export interface HeroCardItemI {
+    id?: string | null
+    mode: HeroCardMode
+    title?: string | null
+    description?: string | null
+    backgroundColor?: string | null
+    backgroundImageUrl?: string | null
+    previewPlants?: PlantI[]
+    ctaLabel?: string | null
+    selection?: SelectionI | null
+    plant?: PlantI | null
+    ctaRoute?: string | null
+  }
+}