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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@la-main-verte/shared-types",
-  "version": "1.0.74",
+  "version": "1.0.76",
   "description": "Shared TypeScript interfaces for frontend of la-main-verte app",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/apiError.d.ts

@@ -1,28 +1,49 @@
-export interface ApiErrorI {
-  /**
-   * Literally describe what the server error is, ideally in the language of the user
-   */
-  error_message?: string
-  /**
-   * A string code to identify the error
-   */
-  error_type?:
+/**
+ * Standard API Response Types
+ * ------------------------------------------------------------------------------------------------
+ * These types define the standard shapes for all API responses.
+ * The frontend uses these to display toast notifications:
+ *   - Error responses: error_message → toast title, error_suggestion → toast subtitle
+ *   - Success responses: message → toast title, suggestion → toast subtitle
+ * ------------------------------------------------------------------------------------------------
+ */
+
+/**
+ * Standard error response returned by apiResponse.helper functions.
+ * The frontend shows error_message and error_suggestion in a toast.error().
+ */
+export interface ErrorApiResponseI {
+  error_code: number | string
+  error_type:
     | 'not_identified'
     | 'invalid_request'
     | 'subscription_required'
+    | 'not_authorized'
     | 'internal_server_error'
     | 'resource_already_exists'
     | 'not_found'
     | 'app_update_required'
+    | 'sequelize_validation_error'
     | string
-  /**
-   * A numerical code that can be used to identify the error
-   * Ex: 401, 403, 404, 500 or L12, L13, L14
-   */
-  error_code?: string | number
-  /**
-   * A string that can be used to suggest a solution to the user
-   * Ex: "Please check your internet connection and try again."
-   */
-  error_suggestion?: string
+  /** Describes the error, ideally in the user's language. Displayed as the toast title. */
+  error_message: string
+  /** Suggests a resolution to the user. Displayed as the toast subtitle. */
+  error_suggestion: string
 }
+
+/**
+ * Standard success response shape for endpoints that return a confirmation with an optional message.
+ * The frontend shows message and suggestion in a toast.success() when present.
+ */
+export interface SuccessApiResponseI {
+  success: true
+  /** Contextual message to display (e.g. "Félicitation !"). Displayed as the toast title. */
+  message?: string
+  /** Additional detail shown alongside message (e.g. next task info). Displayed as the toast subtitle. */
+  suggestion?: string
+  /** Optional icon name for the frontend to render alongside the message. */
+  iconName?: string
+}
+
+/** @deprecated Use ErrorApiResponseI instead */
+export type ApiErrorI = ErrorApiResponseI

package/src/gardenMap.d.ts

@@ -55,6 +55,68 @@ export interface GardenMapI {
   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
@@ -62,7 +124,15 @@ export interface GardenZoneI {
   widthInMeters: number
   heightInMeters: number
   diameterInMeters: number
-  shape: 'rectangle' | 'circle'
+  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

package/src/home.api.d.ts

@@ -180,6 +180,7 @@ export namespace HOME {
   }
 
   export interface UpcomingTaskAdviceI {
+    /** @deprecated Since 1.9.10, this field is always `''`. */
     content: string
     taskName: string
     plantName: string

package/src/index.ts

@@ -1,30 +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'
-
-// 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 * 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

@@ -0,0 +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
+    }
+  }
+}

package/src/plant.d.ts

@@ -1,107 +1,107 @@
-import type { TaxonFamilyI } from './taxonFamily'
-import type { SeedingInfoI } from './pages.api'
-/**
- * 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
- */
-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
-  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
-  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[]
-  Member?: Partial<MemberI>
-  notes?: NoteI[]
-  rotationGroup?: string
-  // @deprecate once v1.8.1 is fully adopted
-  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 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
-}
+import type { TaxonFamilyI } from './taxonFamily'
+import type { SeedingInfoI } from './pages.api'
+/**
+ * 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
+ */
+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
+  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
+  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[]
+  Member?: Partial<MemberI>
+  notes?: NoteI[]
+  rotationGroup?: string
+  // @deprecate once v1.8.1 is fully adopted
+  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 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/task.d.ts

@@ -1,3 +1,5 @@
+import type { SuccessApiResponseI } from './apiError'
+
 export interface TaskI {
   id: number
   name: string
@@ -29,23 +31,14 @@ export interface TaskTagI {
   iconName?: string
 }
 
-/** Optional toast notification payload returned after task completion. All fields are optional — the frontend applies its own defaults for any missing field. */
-export interface CompleteTaskToastI {
-  title?: string
-  subtitle?: string
-  iconName?: string
-}
-
 /**
  * Response returned when one or more tasks are marked as done.
+ * Extends SuccessApiResponseI for standard message/suggestion fields.
  * Keys are plant slugs, values are the full updated task list for that plant selection.
  * Single completion returns a record with one entry; bulk returns one entry per plant.
  */
-export interface CompleteTaskResponseI {
-  success: boolean
+export interface CompleteTaskResponseI extends SuccessApiResponseI {
   updatedTasksByPlant: Record<string, TaskI[]>
-  /** Optional toast to display after completion. Missing fields fall back to frontend defaults. */
-  toast?: CompleteTaskToastI
 }
 
 /**

package/src/users.api.d.ts

@@ -1,122 +1,136 @@
-import type { DeviceDataI } from './device.d'
-import type { MemberI as MemberDataI } from './member.d'
-import type { SelectionI } from './selection.d'
-import type { PlantI } from './plant.d'
-
-interface RequestHeaders {
-  'x-session-token': string
-  'x-native-app-version'?: string
-  'x-application-type'?: 'react-native' | 'web'
-}
-
-export namespace USERS {
-  export namespace GET {
-    export interface Request {
-      headers: RequestHeaders
-      params: {
-        scopes: ('unreadNotificationsCount' | 'coordinates')[]
-      }
-    }
-    export type Response = MemberDataI & {
-      unreadAlertsCount?: number
-    }
-  }
-  export namespace DEVICES {
-    export interface Request {
-      headers: RequestHeaders
-      body: {
-        /** @see DeviceDataI */
-        userAgent?: DeviceDataI['userAgent']
-        platform?: DeviceDataI['platform']
-        version?: DeviceDataI['version']
-        model?: DeviceDataI['model']
-        name?: DeviceDataI['name']
-        appVersion?: DeviceDataI['appVersion']
-        pushKey?: DeviceDataI['pushKey']
-        apnsToken?: DeviceDataI['apnsToken']
-        fcmToken?: DeviceDataI['fcmToken']
-        webPushEndpoint?: DeviceDataI['webPushEndpoint']
-        webPushP256dh?: DeviceDataI['webPushP256dh']
-        webPushAuth?: DeviceDataI['webPushAuth']
-        webPushSubscription?: DeviceDataI['webPushSubscription']
-      }
-    }
-    export type Response = DeviceDataI
-  }
-  export namespace RECOMMENDATIONS {
-    export type ComponentType = 'PlantCarousel' | 'SelectionCarousel' | 'HeroCardsCarousel' | 'YourSelection'
-
-    interface BaseRecommendation {
-      id: string
-      componentType: ComponentType
-      title?: string
-      subtitle?: string
-      cardsVisible?: number
-    }
-
-    export interface PlantCarouselRecommendation extends BaseRecommendation {
-      componentType: 'PlantCarousel'
-      selection: SelectionI & { Plants?: PlantI[] }
-      displayRanking?: boolean
-    }
-
-    export interface SelectionCarouselRecommendation extends BaseRecommendation {
-      componentType: 'SelectionCarousel'
-      selections: SelectionI[]
-      displayRanking?: boolean
-    }
-
-    export interface HeroCardsCarouselRecommendation extends BaseRecommendation {
-      componentType: 'HeroCardsCarousel'
-      selections: SelectionI[]
-    }
-
-    export interface YourSelectionRecommendation extends BaseRecommendation {
-      componentType: 'YourSelection'
-    }
-
-    export type RecommendationI =
-      | PlantCarouselRecommendation
-      | SelectionCarouselRecommendation
-      | HeroCardsCarouselRecommendation
-      | YourSelectionRecommendation
-
-    export interface Request {
-      headers: RequestHeaders
-    }
-
-    export type Response = RecommendationI[]
-  }
-  export namespace UPDATE {
-    export interface Request {
-      headers: RequestHeaders
-      body: {
-        city?: string
-        lastFreezingDate?: string | Date
-        firstFreezingDate?: string | Date
-        moveDatesRequested?: boolean
-        lastFertilizerIdChosen?: number
-        lastOrganicMatterPercentage?: number
-        unitSystem?: 'imperial' | 'metric'
-        gardenZoneTimelessPreference?: boolean
-      }
-    }
-    export type Response = MemberDataI
-  }
-  export namespace GIFT_CARDS {
-    export namespace REDEEM {
-      export interface Request {
-        headers: RequestHeaders
-        body: {
-          code: string
-        }
-      }
-      export interface Response {
-        success: boolean
-        message?: string
-        error?: string
-        error_message?: string
-      }
-    }
-  }
-}
+import type { DeviceDataI } from './device.d'
+import type { MemberI as MemberDataI } from './member.d'
+import type { SelectionI } from './selection.d'
+import type { PlantI } from './plant.d'
+
+interface RequestHeaders {
+  'x-session-token': string
+  'x-native-app-version'?: string
+  'x-application-type'?: 'react-native' | 'web'
+}
+
+export namespace USERS {
+  export namespace GET {
+    export interface Request {
+      headers: RequestHeaders
+      params: {
+        scopes: ('unreadNotificationsCount' | 'coordinates')[]
+      }
+    }
+    export type Response = MemberDataI & {
+      unreadAlertsCount?: number
+    }
+  }
+  export namespace DEVICES {
+    export interface Request {
+      headers: RequestHeaders
+      body: {
+        /** @see DeviceDataI */
+        userAgent?: DeviceDataI['userAgent']
+        platform?: DeviceDataI['platform']
+        version?: DeviceDataI['version']
+        model?: DeviceDataI['model']
+        name?: DeviceDataI['name']
+        appVersion?: DeviceDataI['appVersion']
+        pushKey?: DeviceDataI['pushKey']
+        apnsToken?: DeviceDataI['apnsToken']
+        fcmToken?: DeviceDataI['fcmToken']
+        webPushEndpoint?: DeviceDataI['webPushEndpoint']
+        webPushP256dh?: DeviceDataI['webPushP256dh']
+        webPushAuth?: DeviceDataI['webPushAuth']
+        webPushSubscription?: DeviceDataI['webPushSubscription']
+      }
+    }
+    export type Response = DeviceDataI
+  }
+  export namespace RECOMMENDATIONS {
+    export type ComponentType = 'PlantCarousel' | 'SelectionCarousel' | 'HeroCardsCarousel' | 'YourSelection'
+
+    interface BaseRecommendation {
+      id: string
+      componentType: ComponentType
+      title?: string
+      subtitle?: string
+      cardsVisible?: number
+    }
+
+    export interface PlantCarouselRecommendation extends BaseRecommendation {
+      componentType: 'PlantCarousel'
+      selection: SelectionI & { Plants?: PlantI[] }
+      displayRanking?: boolean
+    }
+
+    export interface SelectionCarouselRecommendation extends BaseRecommendation {
+      componentType: 'SelectionCarousel'
+      selections: SelectionI[]
+      displayRanking?: boolean
+    }
+
+    export interface HeroCardsCarouselRecommendation extends BaseRecommendation {
+      componentType: 'HeroCardsCarousel'
+      selections: SelectionI[]
+    }
+
+    export interface YourSelectionRecommendation extends BaseRecommendation {
+      componentType: 'YourSelection'
+    }
+
+    export interface ThemedRecommendationI {
+      id: string
+      label: string
+      icon: string
+      title?: string
+      subtitle?: string
+      selections: SelectionI[]
+      cardsVisible?: number
+      displayRanking?: boolean
+    }
+
+    export type RecommendationI =
+      | PlantCarouselRecommendation
+      | SelectionCarouselRecommendation
+      | HeroCardsCarouselRecommendation
+      | YourSelectionRecommendation
+
+    export interface Request {
+      headers: RequestHeaders
+    }
+
+    export interface Response {
+      recommendations: RecommendationI[]
+      themedRecommendations: ThemedRecommendationI[]
+    }
+  }
+  export namespace UPDATE {
+    export interface Request {
+      headers: RequestHeaders
+      body: {
+        city?: string
+        lastFreezingDate?: string | Date
+        firstFreezingDate?: string | Date
+        moveDatesRequested?: boolean
+        lastFertilizerIdChosen?: number
+        lastOrganicMatterPercentage?: number
+        unitSystem?: 'imperial' | 'metric'
+        gardenZoneTimelessPreference?: boolean
+      }
+    }
+    export type Response = MemberDataI
+  }
+  export namespace GIFT_CARDS {
+    export namespace REDEEM {
+      export interface Request {
+        headers: RequestHeaders
+        body: {
+          code: string
+        }
+      }
+      export interface Response {
+        success: boolean
+        message?: string
+        error?: string
+        error_message?: string
+      }
+    }
+  }
+}