@la-main-verte/shared-types 1.0.90 → 1.0.92

package/src/plant.d.ts

@@ -1,201 +1,201 @@
-import type { TaxonFamilyI } from './taxonFamily'
-import type { SeedingInfoI } from './pages.api'
-import type { PlantFilterI } from './plantFilters'
-import type { RotationGroup } from './rotationGroup'
-/**
- * Range filter value for min/max filters
- */
-export interface RangeFilterValueI {
-  min: number
-  max: number
-}
-
-/**
- * Plant filter value types
- * Represents the possible values for a single filter
- */
-export type PlantFilterValueI = string | string[] | number | boolean | RangeFilterValueI
-
-/**
- * Plant attributes for filtering
- * Used in JSONB field and as query parameters
- * Supports multiple value types for different filter types
- */
-/**
- * A group of related attribute values, used for nested attribute objects.
- * Ex: { growth: { type: 'déterminée' }}
- */
-export type PlantAttributeGroupI = Record<string, PlantFilterValueI>
-
-/**
- * Plant attributes for filtering
- * Used in JSONB field and as query parameters
- * Supports flat values and one level of nested groups.
- */
-export type PlantAttributesI = Record<string, PlantFilterValueI | PlantAttributeGroupI>
-
-export interface PlantI {
-  id: number
-  name: string
-  slug: string
-  description: string
-  descriptionSource?: string
-  female: boolean
-  family?: string | null
-  isFamily: boolean
-  taxonFamilyId?: number | null
-  spaceBetweenSeedMin: number
-  spaceBetweenSeedMax: number
-  spaceBetweenAlleyMin: number
-  spaceBetweenAlleyMax: number
-  weeksInTransplant: number
-  weeksDuringWhichYouCanSeedOutdoor: number
-  weeksToMaturity: number
-  daysToMaturity: number | null
-  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
-  memberFirstName?: string | null
-  shared: boolean
-  hexColor: string | null
-  sunRequirements: 'partialShade' | 'fullSun' | 'fullShade' | null
-  isHardy: boolean | null
-  quantityForFiveInJardinVivrier?: number | null
-  imageURL: string
-  /**
-   * Filename of the plant's 3D mesh asset stored on S3.
-   * - Ideally a `.webp` file (e.g. `ail.webp`).
-   * - Stored in S3 under the `images/meshes/` folder.
-   * - By default named after the `Plant.slug` (e.g. `ail.webp` for the garlic plant).
-   * - Only the filename is persisted; the public URL is exposed through the
-   *   virtual `meshURL` field.
-   */
-  meshFilename: string | null
-  /**
-   * Public ImageKit URL to the plant's 3D mesh asset.
-   * Virtual field computed from `meshFilename`. The underlying file is
-   * stored on S3 at `images/meshes/{meshFilename}` and rewritten to
-   * ImageKit for CDN delivery and transformations.
-   *
-   * Falls back to `imageURL` when `meshFilename` is not set.
-   *
-   * Example: `https://ik.imagekit.io/lamainverte/meshes/ail.webp`
-   */
-  meshURL: 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[]
-  Member?: Partial<MemberI>
-  notes?: NoteI[]
-  /**
-   * Nitrogen-derived rotation group enum (virtual field on the Plant model).
-   * Source of truth for rotation classification — derived from
-   * `azoteNeedsKgPerHa` plus the regenerative override on `taxonFamily`.
-   */
-  rotationGroup?: RotationGroup | null
-  /**
-   * French label of `rotationGroup`, ready for display.
-   */
-  translatedRotationGroup?: string | null
-  taxonFamily?: TaxonFamilyI
-  seedingInfo: SeedingInfoI
-  /**
-   * Contextual search text for recommended plants
-   * Provides additional context when suggesting plants for specific garden zones
-   */
-  contextualSearchText?: string
-}
-
-interface PlantInventoryI {
-  id: number
-  plantId: number
-  supplierName: string
-  plantName: string
-  supplierURL: string
-  imageLocation: string
-  description: string
-  inStock: boolean
-}
-
-export type AvailableGrowingConditionsI = Record<string, string[]>
-
-/**
- * For each attribute filter key (e.g. "fruit.color"), the list of values that
- * still yield at least one match under the current search + active filters.
- * Consumed by the frontend to mark filter tags as "unavailable".
- */
-export type AvailableAttributesI = Record<string, string[]>
-
-/**
- * Which filter surface the frontend should render for the current search.
- * - `specific`: family-specific filters (e.g. tomate attributes)
- * - `general`:  global growing-conditions filters
- *
- * Mutually exclusive by design — the two sets never appear together.
- */
-export type PlantFiltersModeI = 'specific' | 'general'
-
-/**
- * Backend-driven description of the filter UI for a given search response.
- * The frontend is a dumb renderer: it shows the filters listed here with the
- * given mode and marks tags whose value is not in `availability` as unavailable.
- */
-export interface PlantFiltersUII {
-  mode: PlantFiltersModeI
-  filters: PlantFilterI[]
-  availability: 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[]
-  total?: number
-  familyName?: string
-  filtersUI?: PlantFiltersUII
-}
-
-/**
- * Response shape for `GET /selections/:slug/gardenZones/:id/rotation-suggestions`.
- * - `advice`: short user-facing sentence explaining the recommendation
- * - `Plants`: parent plants matching the recommended rotation group, with
- *   the avoided taxon families excluded. Empty when the zone has no usable
- *   history yet.
- */
-export interface PlantRotationSuggestionsI {
-  targetYear: number
-  advice: string
-  Plants: PlantI[]
-}
+import type { TaxonFamilyI } from './taxonFamily'
+import type { SeedingInfoI } from './pages.api'
+import type { PlantFilterI } from './plantFilters'
+import type { RotationGroup } from './rotationGroup'
+/**
+ * Range filter value for min/max filters
+ */
+export interface RangeFilterValueI {
+  min: number
+  max: number
+}
+
+/**
+ * Plant filter value types
+ * Represents the possible values for a single filter
+ */
+export type PlantFilterValueI = string | string[] | number | boolean | RangeFilterValueI
+
+/**
+ * Plant attributes for filtering
+ * Used in JSONB field and as query parameters
+ * Supports multiple value types for different filter types
+ */
+/**
+ * A group of related attribute values, used for nested attribute objects.
+ * Ex: { growth: { type: 'déterminée' }}
+ */
+export type PlantAttributeGroupI = Record<string, PlantFilterValueI>
+
+/**
+ * Plant attributes for filtering
+ * Used in JSONB field and as query parameters
+ * Supports flat values and one level of nested groups.
+ */
+export type PlantAttributesI = Record<string, PlantFilterValueI | PlantAttributeGroupI>
+
+export interface PlantI {
+  id: number
+  name: string
+  slug: string
+  description: string
+  descriptionSource?: string
+  female: boolean
+  family?: string | null
+  isFamily: boolean
+  taxonFamilyId?: number | null
+  spaceBetweenSeedMin: number
+  spaceBetweenSeedMax: number
+  spaceBetweenAlleyMin: number
+  spaceBetweenAlleyMax: number
+  weeksInTransplant: number
+  weeksDuringWhichYouCanSeedOutdoor: number
+  weeksToMaturity: number
+  daysToMaturity: number | null
+  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
+  memberFirstName?: string | null
+  shared: boolean
+  hexColor: string | null
+  sunRequirements: 'partialShade' | 'fullSun' | 'fullShade' | null
+  isHardy: boolean | null
+  quantityForFiveInJardinVivrier?: number | null
+  imageURL: string
+  /**
+   * Filename of the plant's 3D mesh asset stored on S3.
+   * - Ideally a `.webp` file (e.g. `ail.webp`).
+   * - Stored in S3 under the `images/meshes/` folder.
+   * - By default named after the `Plant.slug` (e.g. `ail.webp` for the garlic plant).
+   * - Only the filename is persisted; the public URL is exposed through the
+   *   virtual `meshURL` field.
+   */
+  meshFilename: string | null
+  /**
+   * Public ImageKit URL to the plant's 3D mesh asset.
+   * Virtual field computed from `meshFilename`. The underlying file is
+   * stored on S3 at `images/meshes/{meshFilename}` and rewritten to
+   * ImageKit for CDN delivery and transformations.
+   *
+   * Falls back to `imageURL` when `meshFilename` is not set.
+   *
+   * Example: `https://ik.imagekit.io/lamainverte/meshes/ail.webp`
+   */
+  meshURL: 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[]
+  Member?: Partial<MemberI>
+  notes?: NoteI[]
+  /**
+   * Nitrogen-derived rotation group enum (virtual field on the Plant model).
+   * Source of truth for rotation classification — derived from
+   * `azoteNeedsKgPerHa` plus the regenerative override on `taxonFamily`.
+   */
+  rotationGroup?: RotationGroup | null
+  /**
+   * French label of `rotationGroup`, ready for display.
+   */
+  translatedRotationGroup?: string | null
+  taxonFamily?: TaxonFamilyI
+  seedingInfo: SeedingInfoI
+  /**
+   * Contextual search text for recommended plants
+   * Provides additional context when suggesting plants for specific garden zones
+   */
+  contextualSearchText?: string
+}
+
+interface PlantInventoryI {
+  id: number
+  plantId: number
+  supplierName: string
+  plantName: string
+  supplierURL: string
+  imageLocation: string
+  description: string
+  inStock: boolean
+}
+
+export type AvailableGrowingConditionsI = Record<string, string[]>
+
+/**
+ * For each attribute filter key (e.g. "fruit.color"), the list of values that
+ * still yield at least one match under the current search + active filters.
+ * Consumed by the frontend to mark filter tags as "unavailable".
+ */
+export type AvailableAttributesI = Record<string, string[]>
+
+/**
+ * Which filter surface the frontend should render for the current search.
+ * - `specific`: family-specific filters (e.g. tomate attributes)
+ * - `general`:  global growing-conditions filters
+ *
+ * Mutually exclusive by design — the two sets never appear together.
+ */
+export type PlantFiltersModeI = 'specific' | 'general'
+
+/**
+ * Backend-driven description of the filter UI for a given search response.
+ * The frontend is a dumb renderer: it shows the filters listed here with the
+ * given mode and marks tags whose value is not in `availability` as unavailable.
+ */
+export interface PlantFiltersUII {
+  mode: PlantFiltersModeI
+  filters: PlantFilterI[]
+  availability: 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[]
+  total?: number
+  familyName?: string
+  filtersUI?: PlantFiltersUII
+}
+
+/**
+ * Response shape for `GET /selections/:slug/gardenZones/:id/rotation-suggestions`.
+ * - `advice`: short user-facing sentence explaining the recommendation
+ * - `Plants`: parent plants matching the recommended rotation group, with
+ *   the avoided taxon families excluded. Empty when the zone has no usable
+ *   history yet.
+ */
+export interface PlantRotationSuggestionsI {
+  targetYear: number
+  advice: string
+  Plants: PlantI[]
+}

package/src/selections.api.d.ts

@@ -0,0 +1,42 @@
+import { GardenZoneI } from './gardenMap.d'
+import { SelectionI } from './selection.d'
+
+export namespace SELECTIONS {
+  export namespace ADD_PLANT {
+    export interface Request {
+      params: {
+        /**
+         * Slug of the selection to add the plant to, or the literal `default`
+         * to target the member's default selection.
+         */
+        slug: string
+        plantSlug: string
+      }
+      query?: {
+        /**
+         * Opt-in: also create a GardenZone (holding the plant's culture) on the
+         * selection's GardenMap. Only the plant search opened from the garden
+         * plan asks for this — adding from the calendar, the home screen or the
+         * explore screen just puts the plant in the selection.
+         *
+         * Opting in is a *request*, not a guarantee: see
+         * {@link ADD_PLANT.Response.autoCreatedGardenZone}.
+         */
+        autoCreateGardenZone?: boolean
+      }
+    }
+
+    export type Response = SelectionI & {
+      /**
+       * The GardenZone created for this plant, or `null` when none was.
+       *
+       * `null` even though `autoCreateGardenZone` was requested when the API
+       * legitimately declined: the selection has no GardenMap, the member is on
+       * the free tier and already reached the culture limit, or the plant
+       * already had a culture. Clients must therefore key their feedback off
+       * this field rather than off what they asked for.
+       */
+      autoCreatedGardenZone: GardenZoneI | null
+    }
+  }
+}