@la-main-verte/shared-types 1.0.76 → 1.0.78

package/package.json

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

package/src/gardenMap.d.ts

@@ -175,6 +175,7 @@ export interface GardenZoneI {
    */
   GardenZoneCulture?: GardenZoneCultureI
   rotationSuggestion?: string
+  category?: 'cultural' | 'decorative' | null
 }
 
 export interface GardenZoneCultureI {

package/src/gardenOverview.d.ts

@@ -18,6 +18,7 @@ export interface GardenOverviewStatsI {
   totalSurfaceWithoutCulture: string
   surfaceComparisonMessage: string | null
   familyDistribution: FamilyStatsI[]
+  jardinVivrierComparison: GardenOverviewJardinVivrierFamilyStatsI[]
   fertilization: FertilizationStatsI
   zones: GardenOverviewZoneStatsI[]
 }
@@ -43,6 +44,13 @@ export interface FamilyStatsI {
   plants: GardenOverviewPlantStatsI[]
 }
 
+export interface GardenOverviewJardinVivrierFamilyStatsI {
+  family: string
+  parentImageURL: string | null
+  cultivatedQuantity: number
+  suggestedQuantityForFiveInJardinVivrier: number | null
+}
+
 /**
  * Extended PlantI with overview-specific statistics
  * Contains the full plant data plus surface, seedQuantity, and position

package/src/index.ts

@@ -1,32 +1,32 @@
-export * from './member'
-export * from './selection'
-export * from './plantSelection'
-export * from './plant'
-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'
-export * from './plantFilters'
-import * as PlantsAPI from './plants.api'
-import * as UsersAPI from './users.api'
-import * as SessionsAPI from './sessions.api'
-import * as HomeAPI from './home.api'
-import * as PagesAPI from './pages.api'
-import * as PaymentsAPI from './payments.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
-  export import PAGES = PagesAPI
-  export import PAYMENTS = PaymentsAPI
-}
+export * from './member'
+export * from './selection'
+export * from './plantSelection'
+export * from './plant'
+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'
+export * from './plantFilters'
+import * as PlantsAPI from './plants.api'
+import * as UsersAPI from './users.api'
+import * as SessionsAPI from './sessions.api'
+import * as HomeAPI from './home.api'
+import * as PagesAPI from './pages.api'
+import * as PaymentsAPI from './payments.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
+  export import PAGES = PagesAPI
+  export import PAYMENTS = PaymentsAPI
+}

package/src/payments.api.d.ts

@@ -1,17 +1,17 @@
-export namespace PAYMENTS {
-  export namespace GET {
-    export interface Request {
-      params: {
-        checkoutSessionId: string
-      }
-    }
-
-    export interface Response {
-      amount: number
-      category: 'Analysis' | 'Subscription'
-      email: string
-      member_id: number | null
-      productType: 'analysis' | 'monthlySubscription' | 'yearlySubscription' | 'fiveYearLicense' | null
-    }
-  }
-}
+export namespace PAYMENTS {
+  export namespace GET {
+    export interface Request {
+      params: {
+        checkoutSessionId: string
+      }
+    }
+
+    export interface Response {
+      amount: number
+      category: 'Analysis' | 'Subscription'
+      email: string
+      member_id: number | null
+      productType: 'analysis' | 'monthlySubscription' | 'yearlySubscription' | 'fiveYearLicense' | null
+    }
+  }
+}

package/src/plant.d.ts

@@ -1,5 +1,6 @@
 import type { TaxonFamilyI } from './taxonFamily'
 import type { SeedingInfoI } from './pages.api'
+import type { PlantFilterI } from './plantFilters'
 /**
  * Range filter value for min/max filters
  */
@@ -56,7 +57,9 @@ export interface PlantI {
   hexColor: string | null
   sunRequirements: 'partialShade' | 'fullSun' | 'fullShade' | null
   isHardy: boolean | null
+  quantityForFiveInJardinVivrier?: number | null
   imageURL: string
+  plantMeshURL: string | null
   totalWeeksToMaturity: number
   hasNoInformation: boolean
   createdAt: Date
@@ -99,6 +102,17 @@ interface PlantInventoryI {
   inStock: boolean
 }
 
+export type AvailableGrowingConditionsI = Record<string, string[]>
+
+export interface GrowingConditionsConfigI {
+  filters: PlantFilterI[]
+}
+
+export interface GrowingConditionsFiltersI {
+  sunRequirements?: 'partialShade' | 'fullShade'
+  rotationGroup?: 'regenerative' | 'demanding' | 'moderately_demanding' | 'less_demanding'
+}
+
 export interface PlantSearchResultI {
   plants: PlantModelI[]
   selections: SelectionModelI[]

package/src/users.api.d.ts

@@ -1,136 +1,136 @@
-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 interface ThemedRecommendationI {
-      id: string
-      label: string
-      icon: string
-      title?: string
-      subtitle?: string
-      selections: SelectionI[]
-      cardsVisible?: number
-      displayRanking?: boolean
-    }
-
-    export type RecommendationI =
-      | PlantCarouselRecommendation
-      | SelectionCarouselRecommendation
-      | HeroCardsCarouselRecommendation
-      | YourSelectionRecommendation
-
-    export interface Request {
-      headers: RequestHeaders
-    }
-
-    export interface Response {
-      recommendations: RecommendationI[]
-      themedRecommendations: ThemedRecommendationI[]
-    }
-  }
-  export namespace UPDATE {
-    export interface Request {
-      headers: RequestHeaders
-      body: {
-        city?: string
-        lastFreezingDate?: string | Date
-        firstFreezingDate?: string | Date
-        moveDatesRequested?: boolean
-        lastFertilizerIdChosen?: number
-        lastOrganicMatterPercentage?: number
-        unitSystem?: 'imperial' | 'metric'
-        gardenZoneTimelessPreference?: boolean
-      }
-    }
-    export type Response = MemberDataI
-  }
-  export namespace GIFT_CARDS {
-    export namespace REDEEM {
-      export interface Request {
-        headers: RequestHeaders
-        body: {
-          code: string
-        }
-      }
-      export interface Response {
-        success: boolean
-        message?: string
-        error?: string
-        error_message?: string
-      }
-    }
-  }
-}
+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 interface ThemedRecommendationI {
+      id: string
+      label: string
+      icon: string
+      title?: string
+      subtitle?: string
+      selections: SelectionI[]
+      cardsVisible?: number
+      displayRanking?: boolean
+    }
+
+    export type RecommendationI =
+      | PlantCarouselRecommendation
+      | SelectionCarouselRecommendation
+      | HeroCardsCarouselRecommendation
+      | YourSelectionRecommendation
+
+    export interface Request {
+      headers: RequestHeaders
+    }
+
+    export interface Response {
+      recommendations: RecommendationI[]
+      themedRecommendations: ThemedRecommendationI[]
+    }
+  }
+  export namespace UPDATE {
+    export interface Request {
+      headers: RequestHeaders
+      body: {
+        city?: string
+        lastFreezingDate?: string | Date
+        firstFreezingDate?: string | Date
+        moveDatesRequested?: boolean
+        lastFertilizerIdChosen?: number
+        lastOrganicMatterPercentage?: number
+        unitSystem?: 'imperial' | 'metric'
+        gardenZoneTimelessPreference?: boolean
+      }
+    }
+    export type Response = MemberDataI
+  }
+  export namespace GIFT_CARDS {
+    export namespace REDEEM {
+      export interface Request {
+        headers: RequestHeaders
+        body: {
+          code: string
+        }
+      }
+      export interface Response {
+        success: boolean
+        message?: string
+        error?: string
+        error_message?: string
+      }
+    }
+  }
+}