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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@la-main-verte/shared-types",
-  "version": "1.0.56",
+  "version": "1.0.58",
   "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,18 +1,33 @@
+/**
+ * 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?: string;
-  default: boolean;
-  width_in_units: number;
-  height_in_units: number;
-  createdAt: string;
-  Selections: SelectionI[];
+  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;
+  imageURL: string
 }
 
 export interface GardenZoneI {

package/src/home.api.d.ts

@@ -23,7 +23,6 @@ export namespace HOME {
     date: string
     minTempC: number
     maxTempC: number
-    chanceOfRainPercentage: number | null
     iconUrl: string | null
     condition?: string | null
   }
@@ -88,6 +87,7 @@ export namespace HOME {
     backgroundColor?: string | null
     backgroundImageUrl?: string | null
     ctaLabel?: string | null
+    ctaRoute?: string | null
     previewPlants?: PlantI[]
     selection?: SelectionI | null
     plant?: PlantI | null

package/src/index.ts

@@ -13,6 +13,7 @@ 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'

package/src/plant.d.ts

@@ -1,3 +1,17 @@
+import type { TaxonFamilyI } from './taxonFamily'
+/**
+ * Plant filter value types
+ * Represents the possible values for a single filter
+ */
+export type PlantFilterValueI = string | string[] | number | boolean
+
+/**
+ * Plant attributes for filtering
+ * Used in JSONB field and as query parameters
+ * Supports multiple value types for different filter types
+ */
+export type PlantAttributesI = Record<string, PlantFilterValueI>
+
 export interface PlantI {
   id: number
   name: string
@@ -6,6 +20,7 @@ export interface PlantI {
   descriptionSource?: string
   female: boolean
   family?: string | null
+  taxonFamilyId?: number | null
   spaceBetweenSeedMin: number
   spaceBetweenSeedMax: number
   spaceBetweenAlleyMin: number
@@ -49,28 +64,19 @@ export interface PlantI {
   tasks?: TaskI[]
   Images?: ImageI[]
   notes?: NoteI[]
+  rotationGroup?: string
+  // @deprecate once v1.8.1 is fully adopted
   rotationFamily?: string
+  taxonFamily?: TaxonFamilyI
 }
 
 interface PlantTagI {
   name: string
   /**
-   * Font color of the tag
-   * Ex: #ffffff
+   * JSONB field containing plant-specific attributes for filtering
+   * Ex: { growth: { type: 'déterminée' }, fruit: { color: 'rouge' } }
    */
-  fontColor: string
-  /**
-   * Background color of the tag
-   * Ex: #1B76E6
-   */
-  backgroundColor: string
-  /**
-   * Font awesome Icon name
-   * Ex: 'tomato'
-   */
-  iconName: string
-  /** Selection slug related to the tag */
-  slug: string
+  attributes?: PlantAttributesI
 }
 
 interface PlantInventoryI {
@@ -83,3 +89,10 @@ interface PlantInventoryI {
   description: string
   inStock: boolean
 }
+
+export interface PlantSearchResultI {
+  plants: PlantModelI[]
+  selections: SelectionModelI[]
+  total?: number
+  familyName?: string
+}

package/src/plantFilters.d.ts

@@ -0,0 +1,19 @@
+export interface PlantFiltersConfigI {
+  filters: PlantFilterI[]
+  helpText?: string
+}
+
+export interface PlantFilterI {
+  key: string // Path in the JSONB (ex: "growth.type")
+  label: string // Label to display
+  type: 'select' | 'multiselect' | 'boolean' | 'range'
+  isMain?: boolean // If true, displayed as button filter; if false/undefined, in modal
+  options?: FilterOptionI[] // For select/multiselect
+  min?: number // For range
+  max?: number // For range
+}
+
+export interface FilterOptionI {
+  value: string
+  label: string
+}

package/src/plants.api.d.ts

@@ -23,11 +23,15 @@ export namespace PLANTS {
       headers?: {
         'x-session-token'?: string
       }
+      query?: {
+        gardenZoneId?: string | number
+        selectionSlug?: string
+      }
     }
-    /**
-     * Response containing recommended plants with their tags
-     */
-    export type Response = PlantExtendedDataI[]
+    export type RecommendedPlantI = PlantExtendedDataI & {
+      contextualSearchText?: string
+    }
+    export type Response = RecommendedPlantI[]
   }
   export namespace SEARCH {
     /**
@@ -52,6 +56,10 @@ export namespace PLANTS {
          * - Plant.contextualSearchText may be added to the results to provided additional contextual information to the search results (and therefore the member)
          */
         gardenZoneId?: string | number
+        /**
+         * Slug of the selection currently being edited. Used to contextualize rotation insights for search results.
+         */
+        selectionSlug?: string
       }
     }
     /**

package/src/rotationGroup.d.ts

@@ -0,0 +1,3 @@
+export type RotationGroup = 'regenerative' | 'demanding' | 'moderately_demanding' | 'less_demanding'
+
+export const ROTATION_GROUPS: RotationGroup[] = ['regenerative', 'demanding', 'moderately_demanding', 'less_demanding']