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

package/src/plant.d.ts

@@ -1,85 +1,98 @@
-export interface PlantI {
-  id: number
-  name: string
-  slug: string
-  description: string
-  descriptionSource?: string
-  female: boolean
-  family?: string | null
-  spaceBetweenSeedMin: number
-  spaceBetweenSeedMax: number
-  spaceBetweenAlleyMin: number
-  spaceBetweenAlleyMax: number
-  weeksInTransplant: number
-  weeksDuringWhichYouCanSeedOutdoor: number
-  weeksToMaturity: number
-  weeksToWaitAfterFreezingDate: number
-  weeksToHarvest: number
-  indoorSeeding: boolean
-  outdoorSeeding: boolean
-  azoteNeedsKgPerHa: number
-  hibernate: boolean
-  germinationTemperature: number | null
-  minGerminationTemperature: number | null
-  germinationNumberOfDays: string | null
-  germinationSeedDepth: string | null
-  cultivationInfo: string | null
-  parentId: number | null
-  memberId?: number
-  shared: boolean
-  hexColor: string | null
-  sunRequirements: 'partialShade' | 'fullSun' | 'fullShade' | null
-  isHardy: boolean | null
-  imageURL: string
-  totalWeeksToMaturity: number
-  hasNoInformation: boolean
-  createdAt: Date
-  updatedAt: Date
-  translatedSunRequirements: 'Plein soleil' | 'Mi-ombre' | 'Ombre' | null
-  parent?: PlantI
-  children?: PlantI[]
-  PlantInventories?: PlantInventoryI[]
-  taggedItems?: TaggedItemI[]
-  /**
-   * List of selections that the plant is in.
-   * --------------------------------------
-   * Tends to be used for featured selections
-   */
-  Selections?: SelectionI[]
-  tasks?: TaskI[]
-  Images?: ImageI[]
-  notes?: NoteI[]
-  rotationFamily?: string
-}
-
-interface PlantTagI {
-  name: string
-  /**
-   * Font color of the tag
-   * Ex: #ffffff
-   */
-  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
-}
-
-interface PlantInventoryI {
-  id: number
-  plantId: number
-  supplierName: string
-  plantName: string
-  supplierURL: string
-  imageLocation: string
-  description: string
-  inStock: boolean
-}
+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
+  slug: string
+  description: string
+  descriptionSource?: string
+  female: boolean
+  family?: string | null
+  taxonFamilyId?: number | null
+  spaceBetweenSeedMin: number
+  spaceBetweenSeedMax: number
+  spaceBetweenAlleyMin: number
+  spaceBetweenAlleyMax: number
+  weeksInTransplant: number
+  weeksDuringWhichYouCanSeedOutdoor: number
+  weeksToMaturity: number
+  weeksToWaitAfterFreezingDate: number
+  weeksToHarvest: number
+  indoorSeeding: boolean
+  outdoorSeeding: boolean
+  azoteNeedsKgPerHa: number
+  hibernate: boolean
+  germinationTemperature: number | null
+  minGerminationTemperature: number | null
+  germinationNumberOfDays: string | null
+  germinationSeedDepth: string | null
+  cultivationInfo: string | null
+  parentId: number | null
+  memberId?: number
+  shared: boolean
+  hexColor: string | null
+  sunRequirements: 'partialShade' | 'fullSun' | 'fullShade' | null
+  isHardy: boolean | null
+  imageURL: string
+  totalWeeksToMaturity: number
+  hasNoInformation: boolean
+  createdAt: Date
+  updatedAt: Date
+  translatedSunRequirements: 'Plein soleil' | 'Mi-ombre' | 'Ombre' | null
+  parent?: PlantI
+  children?: PlantI[]
+  PlantInventories?: PlantInventoryI[]
+  taggedItems?: TaggedItemI[]
+  /**
+   * List of selections that the plant is in.
+   * --------------------------------------
+   * Tends to be used for featured selections
+   */
+  Selections?: SelectionI[]
+  tasks?: TaskI[]
+  Images?: ImageI[]
+  notes?: NoteI[]
+  rotationGroup?: string
+  // @deprecate once v1.8.1 is fully adopted
+  rotationFamily?: string
+  taxonFamily?: TaxonFamilyI
+}
+
+interface PlantTagI {
+  name: string
+  /**
+   * JSONB field containing plant-specific attributes for filtering
+   * Ex: { growth: { type: 'déterminée' }, fruit: { color: 'rouge' } }
+   */
+  attributes?: PlantAttributesI
+}
+
+interface PlantInventoryI {
+  id: number
+  plantId: number
+  supplierName: string
+  plantName: string
+  supplierURL: string
+  imageLocation: string
+  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/plantSelection.d.ts

@@ -1,13 +1,13 @@
-import { PlantI } from './plant.d.ts'
-import { SelectionI } from './selection.d.ts'
-
-export interface PlantSelectionI {
-  id: number
-  plantId: number
-  selectionId: number
-  seedQuantity: number
-  createdAt: Date
-  updatedAt: Date
-  Plant: PlantI
-  Selection: SelectionI
-}
+import { PlantI } from './plant.d.ts'
+import { SelectionI } from './selection.d.ts'
+
+export interface PlantSelectionI {
+  id: number
+  plantId: number
+  selectionId: number
+  seedQuantity: number
+  createdAt: Date
+  updatedAt: Date
+  Plant: PlantI
+  Selection: SelectionI
+}

package/src/plants.api.d.ts

@@ -1,84 +1,92 @@
-import { PlantI } from './plant.d'
-import { SelectionI } from './selection.d'
-import { ImageDataI } from './image.d'
-
-interface PlantExtendedDataI extends PlantI {
-  /**
-   * Future plant images gallery for now using notes as a proxy
-   */
-  Images: ImageDataI[]
-  /**
-   * Selections of the plant
-   */
-  Selections: SelectionI[]
-}
-
-export namespace PLANTS {
-  export namespace RECOMMENDATIONS {
-    /**
-     * Request parameters for plant recommendations
-     * @remarks identification by session token is optional
-     */
-    export interface Request {
-      headers?: {
-        'x-session-token'?: string
-      }
-    }
-    /**
-     * Response containing recommended plants with their tags
-     */
-    export type Response = PlantExtendedDataI[]
-  }
-  export namespace SEARCH {
-    /**
-     * Request parameters for plant recommendations
-     * @remarks identification by session token is optional
-     */
-    export interface Request {
-      headers?: {
-        'x-session-token'?: string
-      }
-      query?: {
-        withAzoteNeedsKgPerHa?: boolean
-        withSpacing?: boolean
-        parentsOnly?: boolean
-        search?: string
-        family?: string
-        limit?: number
-        /**
-         * If submitted, it means we are searching for plants that can be planted in the given garden zone.
-         * It almost means:
-         * - withSpacing will be set to true automatically.
-         * - Plant.contextualSearchText may be added to the results to provided additional contextual information to the search results (and therefore the member)
-         */
-        gardenZoneId?: string | number
-      }
-    }
-    /**
-     * Response containing search plants with their tags
-     */
-    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
-  }
-}
+import { PlantI } from './plant.d'
+import { SelectionI } from './selection.d'
+import { ImageDataI } from './image.d'
+
+interface PlantExtendedDataI extends PlantI {
+  /**
+   * Future plant images gallery for now using notes as a proxy
+   */
+  Images: ImageDataI[]
+  /**
+   * Selections of the plant
+   */
+  Selections: SelectionI[]
+}
+
+export namespace PLANTS {
+  export namespace RECOMMENDATIONS {
+    /**
+     * Request parameters for plant recommendations
+     * @remarks identification by session token is optional
+     */
+    export interface Request {
+      headers?: {
+        'x-session-token'?: string
+      }
+      query?: {
+        gardenZoneId?: string | number
+        selectionSlug?: string
+      }
+    }
+    export type RecommendedPlantI = PlantExtendedDataI & {
+      contextualSearchText?: string
+    }
+    export type Response = RecommendedPlantI[]
+  }
+  export namespace SEARCH {
+    /**
+     * Request parameters for plant recommendations
+     * @remarks identification by session token is optional
+     */
+    export interface Request {
+      headers?: {
+        'x-session-token'?: string
+      }
+      query?: {
+        withAzoteNeedsKgPerHa?: boolean
+        withSpacing?: boolean
+        parentsOnly?: boolean
+        search?: string
+        family?: string
+        limit?: number
+        /**
+         * If submitted, it means we are searching for plants that can be planted in the given garden zone.
+         * It almost means:
+         * - withSpacing will be set to true automatically.
+         * - 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
+      }
+    }
+    /**
+     * Response containing search plants with their tags
+     */
+    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/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']

package/src/selection.d.ts

@@ -1,55 +1,55 @@
-import { PlantI } from './plant'
-
-export interface SelectionI {
-  id: number
-  memberId: number
-  title: string
-  slug: string
-  description?: string
-  orderBy?: 'startDate' | 'name'
-  default?: boolean
-  viewsCount?: number
-  imageLocation?: string
-  imageURL?: string
-  /**
-   * Indicates if the selection is featured on the app (search, explore, etc).
-   **/
-  featured: boolean
-  /**
-   * Indicates if the selection is dynamically generated on the fly by the API.
-   * Ex: "What you can seed in March"
-   * INTERNAL USE ONLY
-   */
-  isDynamic: boolean
-  /**
-   * Background color of the selection, for UI purposes.
-   */
-  backgroundColor: string | null
-  /**
-   * Font color of the selection, for UI purposes.
-   */
-  fontColor: string | null
-  /**
-   * Font awesome icon name of the selection, for UI purposes.
-   * -----------------------------------------
-   * Not all icons are available in the react-native-app. Must be explicitly declared first.
-   * Ex: 'fa-bag-seedling', 'fa-bug', etc.
-   */
-  iconName: string | null
-  link?: string
-  sharingURL?: string
-  createdAt: Date
-  updatedAt: Date
-  Plants?: PlantI[]
-  yearOfCulture: number
-}
-
-/**
- * Those are the different possible types for a selection.
- */
-export type SelectionType = 'Serre' | 'Potager' | 'Recette' | 'Coup de coeur' | "Jardin d'intérieur" | 'Autres'
-
-export interface SelectionTypeI {
-  name: SelectionType
-  iconName?: IconName
-}
+import { PlantI } from './plant'
+
+export interface SelectionI {
+  id: number
+  memberId: number
+  title: string
+  slug: string
+  description?: string
+  orderBy?: 'startDate' | 'name'
+  default?: boolean
+  viewsCount?: number
+  imageLocation?: string
+  imageURL?: string
+  /**
+   * Indicates if the selection is featured on the app (search, explore, etc).
+   **/
+  featured: boolean
+  /**
+   * Indicates if the selection is dynamically generated on the fly by the API.
+   * Ex: "What you can seed in March"
+   * INTERNAL USE ONLY
+   */
+  isDynamic: boolean
+  /**
+   * Background color of the selection, for UI purposes.
+   */
+  backgroundColor: string | null
+  /**
+   * Font color of the selection, for UI purposes.
+   */
+  fontColor: string | null
+  /**
+   * Font awesome icon name of the selection, for UI purposes.
+   * -----------------------------------------
+   * Not all icons are available in the react-native-app. Must be explicitly declared first.
+   * Ex: 'fa-bag-seedling', 'fa-bug', etc.
+   */
+  iconName: string | null
+  link?: string
+  sharingURL?: string
+  createdAt: Date
+  updatedAt: Date
+  Plants?: PlantI[]
+  yearOfCulture: number
+}
+
+/**
+ * Those are the different possible types for a selection.
+ */
+export type SelectionType = 'Serre' | 'Potager' | 'Recette' | 'Coup de coeur' | "Jardin d'intérieur" | 'Autres'
+
+export interface SelectionTypeI {
+  name: SelectionType
+  iconName?: IconName
+}