@la-main-verte/shared-types 1.0.54 → 1.0.56

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@la-main-verte/shared-types",
-  "version": "1.0.54",
+  "version": "1.0.56",
   "description": "Shared TypeScript interfaces for frontend of la-main-verte app",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/alert.d.ts

@@ -1,7 +1,101 @@
+export type IconNameI =
+  | 'arrow-down'
+  | 'arrow-down-a-z'
+  | 'arrow-up-a-z'
+  | 'arrow-left'
+  | 'arrow-up'
+  | 'arrow-up-short-wide'
+  | 'arrow-up-91'
+  | 'arrow-down-91'
+  | 'arrow-up-square-triangle'
+  | 'arrow-down-square-triangle'
+  | 'arrow-up-big-small'
+  | 'arrow-down-big-small'
+  | 'bag-seedling'
+  | 'bars'
+  | 'bell'
+  | 'broom-wide'
+  | 'bug'
+  | 'calendar-check'
+  | 'calendar-day'
+  | 'calendar-days'
+  | 'calendar-minus'
+  | 'calendar-pen'
+  | 'calendar-plus'
+  | 'camera'
+  | 'chart-pie'
+  | 'chart-tree-map'
+  | 'check'
+  | 'chevron-down'
+  | 'chevron-left'
+  | 'chevron-right'
+  | 'circle-question'
+  | 'city'
+  | 'cog'
+  | 'comment'
+  | 'comment-dots'
+  | 'comments-question-check'
+  | 'copy'
+  | 'columns-3'
+  | 'distribute-spacing-horizontal'
+  | 'distribute-spacing-vertical'
+  | 'envelope'
+  | 'eye'
+  | 'eye-slash'
+  | 'filter-circle-xmark'
+  | 'filter-list'
+  | 'flask'
+  | 'gear'
+  | 'heart'
+  | 'home'
+  | 'hand-back-point-up'
+  | 'house-chimney-heart'
+  | 'image'
+  | 'info'
+  | 'keyboard'
+  | 'lightbulb-on'
+  | 'lightbulb'
+  | 'lock'
+  | 'lock-open'
+  | 'messages-question'
+  | 'microphone'
+  | 'minus'
+  | 'note-medical'
+  | 'note-sticky'
+  | 'pencil'
+  | 'plus'
+  | 'pen-ruler'
+  | 'podcast'
+  | 'rotate'
+  | 'ruler'
+  | 'scissors'
+  | 'satellite-dish'
+  | 'search'
+  | 'seedling'
+  | 'sign-in-alt'
+  | 'sign-out-alt'
+  | 'share'
+  | 'shovel'
+  | 'snowflake'
+  | 'star'
+  | 'sun-bright'
+  | 'temperature-snow'
+  | 'thumbs-up'
+  | 'tomato'
+  | 'times'
+  | 'trash'
+  | 'trowel'
+  | 'user-plus'
+  | 'user-slash'
+  | 'wand-sparkles'
+  | 'wheat'
+  | 'x'
+  | string
+
 export interface AlertI {
   id: number
-  tags: AlertTagI[]
-  icon: IconName
+  tags?: AlertTagI[]
+  icon: IconNameI
   /**
    * ColourCode of the icon
    * Ex: #ffffff
@@ -9,6 +103,8 @@ export interface AlertI {
   iconColor: string
   message: string
   published_at?: Date
+  updated_at?: Date
+  status?: 'draft' | 'published'
 }
 
 export interface AlertTagI {

package/src/device.d.ts

@@ -17,8 +17,8 @@ export interface DeviceDataI {
   uuid: string
   /** RAW User agent string from the device */
   userAgent?: string
-  /** Optional platform (e.g., 'ios', 'android', 'windows') */
-  platform?: 'ios' | 'android' | 'windows'
+  /** Optional platform (e.g., 'ios', 'android', 'web') */
+  platform?: 'ios' | 'android' | 'web'
   /** Optional version of the device */
   version?: string
   /**
@@ -35,6 +35,14 @@ export interface DeviceDataI {
   name?: string
   /** Optional app version of the device. Ex: 1.0.0 */
   appVersion?: string
+  /** Web Push endpoint associated with the device */
+  webPushEndpoint?: string
+  /** Web Push user public key */
+  webPushP256dh?: string
+  /** Web Push auth secret */
+  webPushAuth?: string
+  /** Web Push subscription payload */
+  webPushSubscription?: string
   /** Timestamp of when the device was created */
   createdAt: Date
   /** Timestamp of when the device was last updated */

package/src/gardenMap.d.ts

@@ -2,12 +2,19 @@
  * A gardenMap is a collection of garden zones
  */
 export interface GardenMapI {
-  id: number
-  memberId: number
+  id: number;
+  name: string;
+  icon_name: string;
+  category?: string;
+  default: boolean;
+  width_in_units: number;
+  height_in_units: number;
+  createdAt: string;
+  Selections: SelectionI[];
   GardenZones: GardenZoneI[]
-  createdAt: Date
-  updatedAt: Date
+  imageUrl: string;
 }
+
 export interface GardenZoneI {
   id: number
   name: string | null

package/src/gardenOverview.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Garden Overview Types
+ * Represents the detailed overview of a garden selection
+ */
+import { PlantI } from './plant'
+
+export interface GardenOverviewI {
+  id: number
+  title: string
+  iconName: string
+  yearOfCulture: number
+  statistics: GardenOverviewStatsI
+}
+
+export interface GardenOverviewStatsI {
+  totalSeeds: number
+  totalSurface: string
+  totalSurfaceWithoutCulture: string
+  surfaceComparisonMessage: string | null
+  familyDistribution: FamilyStatsI[]
+  fertilization: FertilizationStatsI
+  zones: GardenOverviewZoneStatsI[]
+}
+
+export interface FertilizationStatsI {
+  totalWeightInKg: number
+  weightComparisonMessage: string | null
+  fertilizerDetails: FertilizerStatsI[]
+}
+
+export interface FertilizerStatsI {
+  fertilizerName: string
+  fertilizerQuantity: string
+  imageURL: string
+}
+
+export interface FamilyStatsI {
+  family: string
+  hexColor: string
+  totalSeeds: number
+  totalSurface: string
+  percentage: number
+  plants: GardenOverviewPlantStatsI[]
+}
+
+/**
+ * Extended PlantI with overview-specific statistics
+ * Contains the full plant data plus surface, seedQuantity, and position
+ */
+export interface GardenOverviewPlantStatsI extends PlantI {
+  seedQuantity: number
+  surface: string
+  position: number
+  densityMode: string
+  fertilizerName: string
+  fertilizerQuantity: string
+}
+
+export interface GardenOverviewZonePlantStatsI {
+  id: number
+  name: string
+  imageURL: string | null
+}
+
+export interface GardenOverviewZoneFertilizerStatsI {
+  name: string
+  quantity: string
+}
+
+export interface GardenOverviewZoneStatsI {
+  id: number
+  name: string
+  totalSeeds: number
+  surface: string
+  fertilizerQuantity: string
+  thumbnailURL: string
+  plants: GardenOverviewZonePlantStatsI[]
+  fertilizers: GardenOverviewZoneFertilizerStatsI[]
+}

package/src/home.api.d.ts

@@ -0,0 +1,159 @@
+import type { PlantI } from './plant'
+import type { SelectionI } from './selection'
+
+export namespace HOME {
+  export type HeroCardMode = 'featuredSelection' | 'featuredPlant'
+
+  export type SectionComponentType =
+    | 'Header'
+    | 'HeroCards'
+    | 'PlantCarousel'
+    | 'HeroCardsCarousel'
+    | 'WideCardsCarousel'
+    | 'Weather'
+    | 'AdviceCarousel'
+    | 'OnboardingCard'
+
+  export type CarouselComponentType = Extract<
+    SectionComponentType,
+    'PlantCarousel' | 'HeroCardsCarousel' | 'WideCardsCarousel'
+  >
+
+  export interface WeatherDayI {
+    date: string
+    minTempC: number
+    maxTempC: number
+    chanceOfRainPercentage: number | null
+    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'
+  }
+
+  export interface HeaderSectionI {
+    componentType: 'Header'
+    title: string
+    subtitle: string
+  }
+
+  export interface AdviceI {
+    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 {
+    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
+    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
+  }
+
+  export type SectionI =
+    | HeaderSectionI
+    | HeroCardsSectionI
+    | PlantCarouselSectionI
+    | HeroCardsCarouselSectionI
+    | WideCardsCarouselSectionI
+    | WeatherSectionI
+    | AdviceSectionI
+    | OnboardingCardSectionI
+
+  export interface Response {
+    sections: SectionI[]
+  }
+}

package/src/index.ts

@@ -6,16 +6,22 @@ export * from './task'
 export * from './calendarView'
 export * from './apiError'
 export * from './gardenMap'
+export * from './gardenOverview'
 export * from './alert'
 export * from './image'
 export * from './note'
 export * from './taggedItem'
 export * from './fertilizer'
+export * from './utmParams'
 import * as PlantsAPI from './plants.api'
 import * as UsersAPI from './users.api'
+import * as SessionsAPI from './sessions.api'
+import * as HomeAPI from './home.api'
 
 // Allow access to the API namespaces without conflicts
 export namespace API {
   export import PLANTS = PlantsAPI
   export import USERS = UsersAPI
+  export import SESSIONS = SessionsAPI
+  export import HOME = HomeAPI
 }

package/src/member.d.ts

@@ -27,7 +27,7 @@ export interface MemberI {
   hasAnActiveSubscription?: boolean
   /**
    * Acts as a one-way not identifiable token.
-   * Crisp and other services like Upvoty use this token to identify the user
+   * Crisp and other services may use this token to identify the user
    */
   userToken: string
   /**

package/src/plants.api.d.ts

@@ -1,4 +1,4 @@
-import { PlantI, PlantTagI } from './plant.d'
+import { PlantI } from './plant.d'
 import { SelectionI } from './selection.d'
 import { ImageDataI } from './image.d'
 
@@ -59,4 +59,26 @@ export namespace PLANTS {
      */
     export type Response = PlantExtendedDataI[]
   }
+  export namespace UPDATE {
+    export interface Request {
+      params: {
+        slug: string
+      }
+      body: {
+        name?: string
+        description?: string
+        shared?: boolean
+        spaceBetweenSeedMin?: number | null
+        spaceBetweenSeedMax?: number | null
+        spaceBetweenAlleyMin?: number | null
+        spaceBetweenAlleyMax?: number | null
+        weeksToMaturity?: number | null
+        indoorSeeding?: boolean
+        outdoorSeeding?: boolean
+        sunRequirements?: 'partialShade' | 'fullSun' | 'fullShade' | null
+        isHardy?: boolean | null
+      }
+    }
+    export type Response = PlantI
+  }
 }

package/src/selection.d.ts

@@ -41,6 +41,7 @@ export interface SelectionI {
   createdAt: Date
   updatedAt: Date
   Plants?: PlantI[]
+  yearOfCulture: number
 }
 
 /**

package/src/sessions.api.d.ts

@@ -0,0 +1,134 @@
+import type { UTMParams } from './utmParams'
+import type { EventType, EventDetailsI } from '../../server/types/sessionEvent'
+import type { PaymentProductTypeI } from '../../server/types/payment'
+
+interface RequestHeaders {
+  'x-session-token'?: string
+  'x-native-app-version'?: string
+  'x-application-type'?: 'react-native' | 'web'
+  'user-agent'?: string
+}
+
+export namespace SESSIONS {
+  export namespace POST {
+    export interface Request {
+      headers: RequestHeaders
+      body: {
+        uuid?: string
+        platform?: 'web' | 'react-native' | 'unknown'
+        device_id?: number
+        app_version?: string
+        ip_address?: string
+      } & Partial<UTMParams>
+    }
+    export interface Response {
+      success: boolean
+      session: {
+        id: number
+        uuid: string
+        is_authenticated: boolean
+        expires_at: string
+        platform: string
+        first_seen_at: string
+        last_activity_at: string
+      }
+      message?: string
+    }
+  }
+
+  export namespace GET {
+    export interface Request {
+      headers: RequestHeaders
+      query: {
+        session_id: string
+      }
+    }
+    export interface Response {
+      success: boolean
+      session?: {
+        id: number
+        uuid: string
+        is_authenticated: boolean
+        expires_at: string
+        platform: string
+        first_seen_at: string
+        last_activity_at: string
+        memberId?: number
+      }
+      message?: string
+    }
+  }
+
+  export namespace EVENTS {
+    export namespace POST {
+      export interface Request {
+        headers: RequestHeaders
+        body: EventDetailsI & {
+          uuid: string
+          event_data?: any
+          // Feature usage specific
+          feature_name?: string
+          feature_action?: string
+          // Event metadata
+          platform?: 'web' | 'react-native' | 'unknown'
+          device_id?: number
+          app_version?: string
+          ip_address?: string
+          // Payment tracking
+          payment_customer_external_id?: string
+          payment_processor?: 'stripe' | 'apple' | 'google'
+          payment_middleware?: 'stripe' | 'revenuecat'
+          payment_product_type?: PaymentProductTypeI
+          payment_transaction_id?: string
+          // Revenue tracking
+          revenue_amount?: number
+          currency?: string
+          created_by?: 'server' | 'client' | 'unknown'
+        }
+      }
+      export interface Response {
+        success: boolean
+        event: {
+          id: number
+          sessionId: number
+          createdAt: string
+        } & EventDetailsI
+        message?: string
+      }
+    }
+
+    export namespace GET {
+      export interface Request {
+        headers: RequestHeaders
+        query: {
+          session_id?: string
+          event_type?: EventType
+          feature_name?: string
+          campaign_id?: string
+          start_date?: string
+          end_date?: string
+          limit?: number
+          offset?: number
+        }
+      }
+      export interface Response {
+        success: boolean
+        events: Array<
+          {
+            id: number
+            sessionId: number
+            event_data?: any
+            feature_name?: string
+            feature_action?: string
+            platform: string
+            revenue_amount?: number
+            currency?: string
+            createdAt: string
+          } & EventDetailsI
+        >
+        total_count: number
+        message?: string
+      }
+    }
+  }
+}

package/src/users.api.d.ts

@@ -1,5 +1,7 @@
 import type { DeviceDataI } from './device.d'
 import type { MemberI as MemberDataI } from './member.d'
+import type { SelectionI } from './selection.d'
+import type { PlantI } from './plant.d'
 
 interface RequestHeaders {
   'x-session-token': string
@@ -33,8 +35,56 @@ export namespace USERS {
         pushKey?: DeviceDataI['pushKey']
         apnsToken?: DeviceDataI['apnsToken']
         fcmToken?: DeviceDataI['fcmToken']
+        webPushEndpoint?: DeviceDataI['webPushEndpoint']
+        webPushP256dh?: DeviceDataI['webPushP256dh']
+        webPushAuth?: DeviceDataI['webPushAuth']
+        webPushSubscription?: DeviceDataI['webPushSubscription']
       }
     }
     export type Response = DeviceDataI
   }
+  export namespace RECOMMENDATIONS {
+    export type ComponentType = 'PlantCarousel' | 'SelectionCarousel' | 'HeroCardsCarousel' | 'YourSelection'
+
+    interface BaseRecommendation {
+      id: string
+      componentType: ComponentType
+      title?: string
+      subtitle?: string
+      cardsVisible?: number
+    }
+
+    export interface PlantCarouselRecommendation extends BaseRecommendation {
+      componentType: 'PlantCarousel'
+      selection: SelectionI & { Plants?: PlantI[] }
+      displayRanking?: boolean
+    }
+
+    export interface SelectionCarouselRecommendation extends BaseRecommendation {
+      componentType: 'SelectionCarousel'
+      selections: SelectionI[]
+      displayRanking?: boolean
+    }
+
+    export interface HeroCardsCarouselRecommendation extends BaseRecommendation {
+      componentType: 'HeroCardsCarousel'
+      selections: SelectionI[]
+    }
+
+    export interface YourSelectionRecommendation extends BaseRecommendation {
+      componentType: 'YourSelection'
+    }
+
+    export type RecommendationI =
+      | PlantCarouselRecommendation
+      | SelectionCarouselRecommendation
+      | HeroCardsCarouselRecommendation
+      | YourSelectionRecommendation
+
+    export interface Request {
+      headers: RequestHeaders
+    }
+
+    export type Response = RecommendationI[]
+  }
 }

package/src/utmParams.d.ts

@@ -0,0 +1,134 @@
+/**
+ * UTMSource - Identifies the origin platform or website that sent the traffic
+ *
+ * This type answers the question: "Where did this visitor come from?"
+ * It tracks the specific platform, website, or source that generated the traffic.
+ *
+ * Common values are included in the union type, but custom domains/values are also allowed.
+ */
+export type UTMSource =
+  | 'google' // Google search results or Google Ads
+  | 'facebook' // Facebook posts, ads, or shared content
+  | 'instagram' // Instagram posts, stories, or ads
+  | 'youtube' // YouTube videos, ads, or descriptions
+  | 'email' // Email newsletter campaigns
+  | 'direct' // Direct visits to the website
+  | 'Brevo' // Our newsletter software
+  | (string & {}) // Custom domains like 'semencesduportage.com' or any other string
+
+/**
+ * UTMMedium - Identifies the marketing channel or method used
+ *
+ * This type answers the question: "What type of marketing brought this visitor?"
+ * It categorizes the marketing method, whether paid, organic, or referral-based.
+ *
+ * Common values are included in the union type, but custom values are also allowed.
+ */
+export type UTMMedium =
+  | 'cpc' // Cost-per-click advertising (Google Ads, Facebook Ads, etc.)
+  | 'paid' // Paid social media advertising campaigns
+  | 'organic' // Free/organic traffic (search engine results, social media posts)
+  | 'email' // Email marketing campaigns and newsletters
+  | 'push' // Push notification campaigns
+  | 'display' // Display/banner advertising
+  | 'referral' // Referral traffic from partnerships or other websites
+  | 'affiliate' // Affiliate marketing programs
+  | (string & {}) // Any other custom medium
+
+/**
+ * UTMCampaign - Identifies the specific marketing campaign name
+ *
+ * This type answers the question: "Which specific campaign generated this traffic?"
+ * It allows you to track performance across different marketing initiatives.
+ *
+ * Examples:
+ * - 'alert_ID' - Alert based campaigns
+ * - 'summer_sale_2024' - Seasonal sales campaigns
+ * - 'new_user_discount' - User acquisition campaigns
+ * - 'retention_series' - Customer retention campaigns
+ */
+export type UTMCampaign = 'reel' | 'alert' | string
+
+/**
+ * UTMTerm - Identifies the specific keywords or search terms used
+ *
+ * This type answers the question: "What keywords or terms led to this visit?"
+ * It's particularly useful for paid search campaigns and organic search tracking.
+ *
+ * Examples:
+ * - 'tomato_seeds' - Specific keyword for tomato seed searches
+ * - 'planting_guide' - Specific keyword for planting guide searches
+ * - 'organic_fertilizer' - Product-specific keywords
+ * - 'garden_planning' - Service-related keywords
+ */
+export type UTMTerm = string
+
+/**
+ * UTMContent - Identifies the specific content variation or creative element
+ *
+ * This type answers the question: "Which specific content version was clicked?"
+ * It enables A/B testing and creative performance tracking.
+ *
+ * Examples:
+ * - 'headline_a' - Version A of a headline for A/B testing
+ * - 'image_garden_1' - Specific image used in the campaign
+ * - 'link_top_banner' - Specific link placement (top banner)
+ * - 'cta_button_blue' - Specific call-to-action button
+ */
+export type UTMContent = string
+
+/**
+ * UTMParams - Complete interface for all UTM tracking parameters
+ *
+ * This interface combines all UTM parameters into a single object for easy
+ * tracking and analytics. All parameters are optional to allow flexible usage.
+ *
+ * COOKIE STORAGE:
+ * Each parameter is stored as a separate cookie:
+ * - utm_source
+ * - utm_medium
+ * - utm_campaign
+ * - utm_term
+ * - utm_content
+ * - fbclid
+ * - fbp
+ * - gclid
+ *
+ * Usage example:
+ * const utmParams: UTMParams = {
+ *   utm_source: 'facebook',
+ *   utm_medium: 'paid',
+ *   utm_campaign: 'hardiness_zone',
+ *   utm_term: 'tomato_seeds',
+ *   utm_content: 'headline_a',
+ *   fbclid: 'IwAR123...',
+ *   fbp: 'fb.1.1234567890.1234567890',
+ *   gclid: 'EAIaIQobChMI...'
+ * };
+ */
+export interface UTMParams {
+  /** Unique UUID session identifier from front-end tracking script */
+  uuid?: string
+  /** The source platform that generated the traffic */
+  utm_source?: UTMSource
+  /** The marketing channel or method used */
+  utm_medium?: UTMMedium
+  /** The specific campaign name */
+  utm_campaign?: UTMCampaign
+  /** The keywords or search terms used */
+  utm_term?: UTMTerm
+  /** The specific content variation or creative element */
+  utm_content?: UTMContent
+  /** Facebook click identifier for attribution (stored as fbclid in URL) */
+  fbclid?: string
+  /** Facebook browser ID for pixel tracking (stored as _fbp cookie) */
+  fbp?: string
+  /** Google Ads click identifier for attribution (stored as gclid in URL) */
+  gclid?: string
+  /** Google Ads click identifier for iOS/Android app to web (Google surfaces) */
+  gbraid?: string
+  /** Google Ads click identifier for iOS/Android app to web (non-Google surfaces) */
+  wbraid?: string
+  /** OLD Referral source from partners - now utm_source=jardinierparesseux */
+  referrer?: string
+}