@la-main-verte/shared-types 1.0.57 → 1.0.58

package/src/users.api.d.ts

@@ -1,90 +1,90 @@
-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
-  'x-native-app-version'?: string
-  'x-application-type'?: 'react-native' | 'web'
-}
-
-export namespace USERS {
-  export namespace GET {
-    export interface Request {
-      headers: RequestHeaders
-      params: {
-        scopes: ('unreadNotificationsCount' | 'coordinates')[]
-      }
-    }
-    export type Response = MemberDataI & {
-      unreadAlertsCount?: number
-    }
-  }
-  export namespace DEVICES {
-    export interface Request {
-      headers: RequestHeaders
-      body: {
-        /** @see DeviceDataI */
-        userAgent?: DeviceDataI['userAgent']
-        platform?: DeviceDataI['platform']
-        version?: DeviceDataI['version']
-        model?: DeviceDataI['model']
-        name?: DeviceDataI['name']
-        appVersion?: DeviceDataI['appVersion']
-        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[]
-  }
-}
+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
+  'x-native-app-version'?: string
+  'x-application-type'?: 'react-native' | 'web'
+}
+
+export namespace USERS {
+  export namespace GET {
+    export interface Request {
+      headers: RequestHeaders
+      params: {
+        scopes: ('unreadNotificationsCount' | 'coordinates')[]
+      }
+    }
+    export type Response = MemberDataI & {
+      unreadAlertsCount?: number
+    }
+  }
+  export namespace DEVICES {
+    export interface Request {
+      headers: RequestHeaders
+      body: {
+        /** @see DeviceDataI */
+        userAgent?: DeviceDataI['userAgent']
+        platform?: DeviceDataI['platform']
+        version?: DeviceDataI['version']
+        model?: DeviceDataI['model']
+        name?: DeviceDataI['name']
+        appVersion?: DeviceDataI['appVersion']
+        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

@@ -1,134 +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
-}
+/**
+ * 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
+}