@la-main-verte/shared-types 1.0.69 → 1.0.71

package/src/pages.api.d.ts

@@ -1,36 +1,36 @@
-import type { PlantI } from './plant'
-
-export namespace PAGES {
-  export interface SeedingTagI {
-    label: string
-    variant: string
-  }
-
-  export interface StartDateBadgeI {
-    day: string
-    month: string
-  }
-
-  export interface SeedingInfoI {
-    tags: SeedingTagI[]
-    startDateBadge: StartDateBadgeI | null
-    description: string | null
-  }
-
-  export interface SeedableFamiliesByMonthResponse {
-    title?: string | null
-    subtitle?: string | null
-    Plants: PlantI[]
-  }
-
-  export interface MonthPreviewI {
-    month: number
-    label: string
-    previewPlants: Pick<PlantI, 'id' | 'name' | 'family' | 'slug' | 'imageURL'>[]
-    totalFamiliesCount: number
-  }
-
-  export interface MonthsPreviewResponse {
-    months: MonthPreviewI[]
-  }
-}
+import type { PlantI } from './plant'
+
+export namespace PAGES {
+  export interface SeedingTagI {
+    label: string
+    variant: string
+  }
+
+  export interface StartDateBadgeI {
+    day: string
+    month: string
+  }
+
+  export interface SeedingInfoI {
+    tags: SeedingTagI[]
+    startDateBadge: StartDateBadgeI | null
+    description: string | null
+  }
+
+  export interface SeedableFamiliesByMonthResponse {
+    title?: string | null
+    subtitle?: string | null
+    Plants: PlantI[]
+  }
+
+  export interface MonthPreviewI {
+    month: number
+    label: string
+    previewPlants: Pick<PlantI, 'id' | 'name' | 'family' | 'slug' | 'imageURL'>[]
+    totalFamiliesCount: number
+  }
+
+  export interface MonthsPreviewResponse {
+    months: MonthPreviewI[]
+  }
+}

package/src/plant.d.ts

@@ -80,6 +80,11 @@ export interface PlantI {
   rotationFamily?: string
   taxonFamily?: TaxonFamilyI
   seedingInfo: SeedingInfoI
+  /**
+   * Contextual search text for recommended plants
+   * Provides additional context when suggesting plants for specific garden zones
+   */
+  contextualSearchText?: string
 }
 
 interface PlantTagI {

package/src/plantFilters.d.ts

@@ -1,40 +1,40 @@
-export interface PlantFiltersConfigI {
-  filters: PlantFilterI[]
-}
-
-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
-  /** General help text for this filter attribute (always displayed) */
-  helpText?: string
-  /** Contextual help text based on member profile (displayed when relevant) */
-  contextualHelpText?: string
-}
-
-export interface FilterOptionI {
-  value: string
-  label: string
-  /** General help text for this option (always displayed) */
-  helpText?: string
-  /** Contextual help text based on member profile (displayed when relevant) */
-  contextualHelpText?: string
-}
-
-/**
- * Member context used to generate contextual help texts
- */
-export interface MemberFilterContextI {
-  /** Hardiness zone index (e.g., 30, 40, 50) - null if not available */
-  hardinessZoneIndex: number | null
-  /** Hardiness zone name (e.g., "4a", "5b") - null if not available */
-  hardinessZoneName: string | null
-  /** Whether the member has a greenhouse */
-  hasGreenhouse: boolean
-  /** Whether the member has a balcony */
-  hasBalcony: boolean
-}
+export interface PlantFiltersConfigI {
+  filters: PlantFilterI[]
+}
+
+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
+  /** General help text for this filter attribute (always displayed) */
+  helpText?: string
+  /** Contextual help text based on member profile (displayed when relevant) */
+  contextualHelpText?: string
+}
+
+export interface FilterOptionI {
+  value: string
+  label: string
+  /** General help text for this option (always displayed) */
+  helpText?: string
+  /** Contextual help text based on member profile (displayed when relevant) */
+  contextualHelpText?: string
+}
+
+/**
+ * Member context used to generate contextual help texts
+ */
+export interface MemberFilterContextI {
+  /** Hardiness zone index (e.g., 30, 40, 50) - null if not available */
+  hardinessZoneIndex: number | null
+  /** Hardiness zone name (e.g., "4a", "5b") - null if not available */
+  hardinessZoneName: string | null
+  /** Whether the member has a greenhouse */
+  hasGreenhouse: boolean
+  /** Whether the member has a balcony */
+  hasBalcony: boolean
+}

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,92 +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
-      }
-      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
-  }
-}
+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

@@ -1,3 +1,3 @@
-export type RotationGroup = 'regenerative' | 'demanding' | 'moderately_demanding' | 'less_demanding'
-
-export const ROTATION_GROUPS: RotationGroup[] = ['regenerative', 'demanding', 'moderately_demanding', 'less_demanding']
+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,58 +1,58 @@
-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
-  GardenMap?: {
-    name: string
-  }
-}
-
-/**
- * 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
+  GardenMap?: {
+    name: string
+  }
+}
+
+/**
+ * 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
+}