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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@la-main-verte/shared-types",
-  "version": "1.0.76",
+  "version": "1.0.77",
   "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

@@ -1,213 +1,214 @@
-import type { FertilizerI } from './fertilizer'
-import type { PlantSelectionI } from './plantSelection'
-
-/**
- * Viewport corners with x/y coordinates
- * Used by front-end to describe the visible area of the map
- */
-export interface ViewportCornersI {
-  topLeft: { x: number; y: number } | null
-  topRight: { x: number; y: number } | null
-  bottomLeft: { x: number; y: number } | null
-  bottomRight: { x: number; y: number } | null
-}
-
-/**
- * Viewport as min/max boundaries
- * Used by back-end placement logic for collision detection
- */
-export interface ViewportBoundariesI {
-  minX: number
-  minY: number
-  maxX: number
-  maxY: number
-}
-
-/**
- * Available garden map categories across the platform
- */
-export type GardenMapCategory =
-  | 'community_garden'
-  | 'greenhouse'
-  | 'garden'
-  | 'recipe'
-  | 'favorites'
-  | 'indoor_garden'
-  | 'balcony'
-  | 'inventory'
-  | 'others'
-
-/**
- * A gardenMap is a collection of garden zones
- */
-export interface GardenMapI {
-  id: number
-  name: string
-  icon_name: string
-  category: GardenMapCategory
-  default: boolean
-  memberId: number
-  width_in_units: number
-  height_in_units: number
-  createdAt: string
-  Selections: SelectionI[]
-  GardenZones: GardenZoneI[]
-  imageURL: string
-}
-
-/**
- * Legacy shape values accepted by the v1 route
- * (`POST /selections/:slug/gardenMap/gardenZone`).
- * This legacy param must remain rectangle/circle only.
- */
-export type GardenZoneLegacyShape = 'rectangle' | 'circle'
-
-/**
- * Visual shape identifier stored in `geometry.properties.shape`.
- */
-export type GardenZoneShape = 'rectangle' | 'circle' | 'polygon'
-
-export type GardenZoneCategory = 'cultural' | 'decorative'
-
-/**
- * Inner GeoJSON Polygon geometry (coordinates ring).
- */
-export interface GeoJSONPolygon {
-  type: 'Polygon'
-  coordinates: number[][][]
-}
-
-/**
- * Properties stored alongside the GeoJSON Feature.
- * `shape` is the canonical shape identifier.
- * Shape-specific fields (center, radius, radiusX, radiusY) describe the parametric definition.
- * `rotation` (degrees, clockwise) and `cornerRadius` (cm) follow GeoJSON/MapBox conventions.
- * `svgPath` holds the editable SVG path string for Bézier polygon rendering.
- */
-export interface GeoJSONFeatureProperties {
-  shape: GardenZoneShape
-  /** Rotation in degrees, clockwise. GeoJSON convention name. */
-  rotation?: number
-  /** Corner radius in cm. MapBox convention name. */
-  cornerRadius?: number
-  /** SVG path string with Bézier curves for polygon rendering. */
-  svgPath?: string
-  /** Center point [x, y] in cm for circle/ellipse shapes. */
-  center?: [number, number]
-  /** Radius in cm for circle shapes. */
-  radius?: number
-  /** Horizontal radius in cm for ellipse shapes. */
-  radiusX?: number
-  /** Vertical radius in cm for ellipse shapes. */
-  radiusY?: number
-}
-
-/**
- * GeoJSON Feature wrapping a Polygon geometry with shape properties.
- * This is the canonical storage format for all garden zone geometries.
- *
- * - `properties` holds the parametric definition (shape, rotation, radii, svgPath)
- * - `geometry` holds the computed polygon coordinates for calculations
- *
- * GeoJSON is the truth (for logic), SVG is the projection (for display and editing).
- */
-export interface GeoJSONFeature {
-  type: 'Feature'
-  properties: GeoJSONFeatureProperties
-  geometry: GeoJSONPolygon
-}
-
-export interface GardenZoneI {
-  id: number
-  name: string | null
-  gardenMapId: number
-  widthInMeters: number
-  heightInMeters: number
-  diameterInMeters: number
-  shape: GardenZoneShape
-  /**
-   * Virtual field — the actual visual shape derived from geometry.properties.shape,
-   * falling back to the DB shape column for legacy zones.
-   */
-  geometryShape: GardenZoneShape
-  geometry?: GeoJSONFeature | null
-  category: GardenZoneCategory
-  backgroundImage: string | null
-  xPosition: number
-  yPosition: number
-  zIndex: number
-  order: number
-  /**
-   * When set, the zone is shown only for that year.
-   * Null means the zone is timeless (visible for every year).
-   */
-  yearOfCulture: number | null
-  totalSurfaceInSquareMeters: number
-  totalSurfaceInSquareFeet: number
-  backgroundColor: string
-  createdAt: Date
-  updatedAt: Date
-  /**
-   * When set, the garden zone is a subdivision of another garden zone
-   * Parent zones are meant to be as eternal as possible.
-   * Subdivisions are meant to be created and destroyed on a yearly basis.
-   */
-  parent_garden_zone_id: number
-  /**
-   * Virtual field to check if the garden zone is a subdivision
-   * It is a renamed field from parent_garden_zone_id
-   */
-  is_subdivision: boolean
-  has_subdivisions: boolean
-  timeless: boolean
-  /**
-   * Orientation virtual field ONLY USE FOR RECTANGLES
-   * --------------------------------
-   * Disregard if the shape is a circle or square. It will return 'vertical'
-   */
-  orientation: 'horizontal' | 'vertical'
-  /**
-   * NOT USED BY THE FRONTEND YET - Use GardenZoneCulture instead
-   */
-  GardenZoneCultures?: GardenZoneCultureI[]
-  /**
-   * The culture on the GardenZone
-   */
-  GardenZoneCulture?: GardenZoneCultureI
-  rotationSuggestion?: string
-}
-
-export interface GardenZoneCultureI {
-  id: number
-  gardenZoneId: number
-  plantSelectionId: number
-  seedQuantity: number
-  densityMode: 'dense' | 'sparse' | 'custom'
-  fertilizerId: number
-  /**
-   * The year of the culture - do not use it yet.
-   * @deprecated Potentially a mistake to have this field here
-   */
-  yearOfCulture: number
-  PlantSelection?: PlantSelectionI
-  /**
-   * The number of alleys
-   * --------------------------------
-   * Value is computed by the backend and NOT coming from the DB.
-   */
-  numberOfAlleys?: number
-  /**
-   * The number of seeds per alley
-   * --------------------------------
-   * Value is computed by the backend and NOT coming from the DB.
-   */
-  numberOfSeedsPerAlley?: number
-  Fertilizer?: FertilizerI
-  custom_space_between_seeds_in_cm?: number
-  custom_space_between_alley_in_cm?: number
-}
-
-export type UpdateGardenZonePayload = Partial<GardenZoneI> &
-  Partial<GardenZoneCultureI> & {
-    targetNumberOfPlants?: number
-  }
+import type { FertilizerI } from './fertilizer'
+import type { PlantSelectionI } from './plantSelection'
+
+/**
+ * Viewport corners with x/y coordinates
+ * Used by front-end to describe the visible area of the map
+ */
+export interface ViewportCornersI {
+  topLeft: { x: number; y: number } | null
+  topRight: { x: number; y: number } | null
+  bottomLeft: { x: number; y: number } | null
+  bottomRight: { x: number; y: number } | null
+}
+
+/**
+ * Viewport as min/max boundaries
+ * Used by back-end placement logic for collision detection
+ */
+export interface ViewportBoundariesI {
+  minX: number
+  minY: number
+  maxX: number
+  maxY: number
+}
+
+/**
+ * Available garden map categories across the platform
+ */
+export type GardenMapCategory =
+  | 'community_garden'
+  | 'greenhouse'
+  | 'garden'
+  | 'recipe'
+  | 'favorites'
+  | 'indoor_garden'
+  | 'balcony'
+  | 'inventory'
+  | 'others'
+
+/**
+ * A gardenMap is a collection of garden zones
+ */
+export interface GardenMapI {
+  id: number
+  name: string
+  icon_name: string
+  category: GardenMapCategory
+  default: boolean
+  memberId: number
+  width_in_units: number
+  height_in_units: number
+  createdAt: string
+  Selections: SelectionI[]
+  GardenZones: GardenZoneI[]
+  imageURL: string
+}
+
+/**
+ * Legacy shape values accepted by the v1 route
+ * (`POST /selections/:slug/gardenMap/gardenZone`).
+ * This legacy param must remain rectangle/circle only.
+ */
+export type GardenZoneLegacyShape = 'rectangle' | 'circle'
+
+/**
+ * Visual shape identifier stored in `geometry.properties.shape`.
+ */
+export type GardenZoneShape = 'rectangle' | 'circle' | 'polygon'
+
+export type GardenZoneCategory = 'cultural' | 'decorative'
+
+/**
+ * Inner GeoJSON Polygon geometry (coordinates ring).
+ */
+export interface GeoJSONPolygon {
+  type: 'Polygon'
+  coordinates: number[][][]
+}
+
+/**
+ * Properties stored alongside the GeoJSON Feature.
+ * `shape` is the canonical shape identifier.
+ * Shape-specific fields (center, radius, radiusX, radiusY) describe the parametric definition.
+ * `rotation` (degrees, clockwise) and `cornerRadius` (cm) follow GeoJSON/MapBox conventions.
+ * `svgPath` holds the editable SVG path string for Bézier polygon rendering.
+ */
+export interface GeoJSONFeatureProperties {
+  shape: GardenZoneShape
+  /** Rotation in degrees, clockwise. GeoJSON convention name. */
+  rotation?: number
+  /** Corner radius in cm. MapBox convention name. */
+  cornerRadius?: number
+  /** SVG path string with Bézier curves for polygon rendering. */
+  svgPath?: string
+  /** Center point [x, y] in cm for circle/ellipse shapes. */
+  center?: [number, number]
+  /** Radius in cm for circle shapes. */
+  radius?: number
+  /** Horizontal radius in cm for ellipse shapes. */
+  radiusX?: number
+  /** Vertical radius in cm for ellipse shapes. */
+  radiusY?: number
+}
+
+/**
+ * GeoJSON Feature wrapping a Polygon geometry with shape properties.
+ * This is the canonical storage format for all garden zone geometries.
+ *
+ * - `properties` holds the parametric definition (shape, rotation, radii, svgPath)
+ * - `geometry` holds the computed polygon coordinates for calculations
+ *
+ * GeoJSON is the truth (for logic), SVG is the projection (for display and editing).
+ */
+export interface GeoJSONFeature {
+  type: 'Feature'
+  properties: GeoJSONFeatureProperties
+  geometry: GeoJSONPolygon
+}
+
+export interface GardenZoneI {
+  id: number
+  name: string | null
+  gardenMapId: number
+  widthInMeters: number
+  heightInMeters: number
+  diameterInMeters: number
+  shape: GardenZoneShape
+  /**
+   * Virtual field — the actual visual shape derived from geometry.properties.shape,
+   * falling back to the DB shape column for legacy zones.
+   */
+  geometryShape: GardenZoneShape
+  geometry?: GeoJSONFeature | null
+  category: GardenZoneCategory
+  backgroundImage: string | null
+  xPosition: number
+  yPosition: number
+  zIndex: number
+  order: number
+  /**
+   * When set, the zone is shown only for that year.
+   * Null means the zone is timeless (visible for every year).
+   */
+  yearOfCulture: number | null
+  totalSurfaceInSquareMeters: number
+  totalSurfaceInSquareFeet: number
+  backgroundColor: string
+  createdAt: Date
+  updatedAt: Date
+  /**
+   * When set, the garden zone is a subdivision of another garden zone
+   * Parent zones are meant to be as eternal as possible.
+   * Subdivisions are meant to be created and destroyed on a yearly basis.
+   */
+  parent_garden_zone_id: number
+  /**
+   * Virtual field to check if the garden zone is a subdivision
+   * It is a renamed field from parent_garden_zone_id
+   */
+  is_subdivision: boolean
+  has_subdivisions: boolean
+  timeless: boolean
+  /**
+   * Orientation virtual field ONLY USE FOR RECTANGLES
+   * --------------------------------
+   * Disregard if the shape is a circle or square. It will return 'vertical'
+   */
+  orientation: 'horizontal' | 'vertical'
+  /**
+   * NOT USED BY THE FRONTEND YET - Use GardenZoneCulture instead
+   */
+  GardenZoneCultures?: GardenZoneCultureI[]
+  /**
+   * The culture on the GardenZone
+   */
+  GardenZoneCulture?: GardenZoneCultureI
+  rotationSuggestion?: string
+  category?: 'cultural' | 'decorative' | null
+}
+
+export interface GardenZoneCultureI {
+  id: number
+  gardenZoneId: number
+  plantSelectionId: number
+  seedQuantity: number
+  densityMode: 'dense' | 'sparse' | 'custom'
+  fertilizerId: number
+  /**
+   * The year of the culture - do not use it yet.
+   * @deprecated Potentially a mistake to have this field here
+   */
+  yearOfCulture: number
+  PlantSelection?: PlantSelectionI
+  /**
+   * The number of alleys
+   * --------------------------------
+   * Value is computed by the backend and NOT coming from the DB.
+   */
+  numberOfAlleys?: number
+  /**
+   * The number of seeds per alley
+   * --------------------------------
+   * Value is computed by the backend and NOT coming from the DB.
+   */
+  numberOfSeedsPerAlley?: number
+  Fertilizer?: FertilizerI
+  custom_space_between_seeds_in_cm?: number
+  custom_space_between_alley_in_cm?: number
+}
+
+export type UpdateGardenZonePayload = Partial<GardenZoneI> &
+  Partial<GardenZoneCultureI> & {
+    targetNumberOfPlants?: number
+  }

package/src/gardenOverview.d.ts

@@ -1,79 +1,87 @@
-/**
- * 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[]
-}
+/**
+ * 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[]
+  jardinVivrierComparison: GardenOverviewJardinVivrierFamilyStatsI[]
+  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[]
+}
+
+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
+ */
+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/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,6 +57,7 @@ export interface PlantI {
   hexColor: string | null
   sunRequirements: 'partialShade' | 'fullSun' | 'fullShade' | null
   isHardy: boolean | null
+  quantityForFiveInJardinVivrier?: number | null
   imageURL: string
   totalWeeksToMaturity: number
   hasNoInformation: boolean
@@ -99,6 +101,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[]