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

package/src/gardenMap.d.ts

@@ -1,143 +1,143 @@
-import type { FertilizerI } from './fertilizer'
-import type { PlantSelectionI } from './plantSelection'
-
-/**
- * Viewport corners with x/y coordinates
- * Used by front-end to describe the visible area of the map
- */
-export interface ViewportCornersI {
-  topLeft: { x: number; y: number } | null
-  topRight: { x: number; y: number } | null
-  bottomLeft: { x: number; y: number } | null
-  bottomRight: { x: number; y: number } | null
-}
-
-/**
- * Viewport as min/max boundaries
- * Used by back-end placement logic for collision detection
- */
-export interface ViewportBoundariesI {
-  minX: number
-  minY: number
-  maxX: number
-  maxY: number
-}
-
-/**
- * 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: GardenMapCategory
-  default: boolean
-  memberId: number
-  width_in_units: number
-  height_in_units: number
-  createdAt: string
-  Selections: SelectionI[]
-  GardenZones: GardenZoneI[]
-  imageURL: string
-}
-
-export interface GardenZoneI {
-  id: number
-  name: string | null
-  gardenMapId: number
-  widthInMeters: number
-  heightInMeters: number
-  diameterInMeters: number
-  shape: 'rectangle' | 'circle'
-  xPosition: number
-  yPosition: number
-  zIndex: number
-  order: number
-  /**
-   * When set, the zone is shown only for that year.
-   * Null means the zone is timeless (visible for every year).
-   */
-  yearOfCulture: number | null
-  totalSurfaceInSquareMeters: number
-  totalSurfaceInSquareFeet: number
-  backgroundColor: string
-  createdAt: Date
-  updatedAt: Date
-  /**
-   * When set, the garden zone is a subdivision of another garden zone
-   * Parent zones are meant to be as eternal as possible.
-   * Subdivisions are meant to be created and destroyed on a yearly basis.
-   */
-  parent_garden_zone_id: number
-  /**
-   * Virtual field to check if the garden zone is a subdivision
-   * It is a renamed field from parent_garden_zone_id
-   */
-  is_subdivision: boolean
-  has_subdivisions: boolean
-  timeless: boolean
-  /**
-   * Orientation virtual field ONLY USE FOR RECTANGLES
-   * --------------------------------
-   * Disregard if the shape is a circle or square. It will return 'vertical'
-   */
-  orientation: 'horizontal' | 'vertical'
-  /**
-   * NOT USED BY THE FRONTEND YET - Use GardenZoneCulture instead
-   */
-  GardenZoneCultures?: GardenZoneCultureI[]
-  /**
-   * The culture on the GardenZone
-   */
-  GardenZoneCulture?: GardenZoneCultureI
-  rotationSuggestion?: string
-}
-
-export interface GardenZoneCultureI {
-  id: number
-  gardenZoneId: number
-  plantSelectionId: number
-  seedQuantity: number
-  densityMode: 'dense' | 'sparse' | 'custom'
-  fertilizerId: number
-  /**
-   * The year of the culture - do not use it yet.
-   * @deprecated Potentially a mistake to have this field here
-   */
-  yearOfCulture: number
-  PlantSelection?: PlantSelectionI
-  /**
-   * The number of alleys
-   * --------------------------------
-   * Value is computed by the backend and NOT coming from the DB.
-   */
-  numberOfAlleys?: number
-  /**
-   * The number of seeds per alley
-   * --------------------------------
-   * Value is computed by the backend and NOT coming from the DB.
-   */
-  numberOfSeedsPerAlley?: number
-  Fertilizer?: FertilizerI
-  custom_space_between_seeds_in_cm?: number
-  custom_space_between_alley_in_cm?: number
-}
-
-export type UpdateGardenZonePayload = Partial<GardenZoneI> &
-  Partial<GardenZoneCultureI> & {
-    targetNumberOfPlants?: number
-  }
+import type { FertilizerI } from './fertilizer'
+import type { PlantSelectionI } from './plantSelection'
+
+/**
+ * Viewport corners with x/y coordinates
+ * Used by front-end to describe the visible area of the map
+ */
+export interface ViewportCornersI {
+  topLeft: { x: number; y: number } | null
+  topRight: { x: number; y: number } | null
+  bottomLeft: { x: number; y: number } | null
+  bottomRight: { x: number; y: number } | null
+}
+
+/**
+ * Viewport as min/max boundaries
+ * Used by back-end placement logic for collision detection
+ */
+export interface ViewportBoundariesI {
+  minX: number
+  minY: number
+  maxX: number
+  maxY: number
+}
+
+/**
+ * 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: GardenMapCategory
+  default: boolean
+  memberId: number
+  width_in_units: number
+  height_in_units: number
+  createdAt: string
+  Selections: SelectionI[]
+  GardenZones: GardenZoneI[]
+  imageURL: string
+}
+
+export interface GardenZoneI {
+  id: number
+  name: string | null
+  gardenMapId: number
+  widthInMeters: number
+  heightInMeters: number
+  diameterInMeters: number
+  shape: 'rectangle' | 'circle'
+  xPosition: number
+  yPosition: number
+  zIndex: number
+  order: number
+  /**
+   * When set, the zone is shown only for that year.
+   * Null means the zone is timeless (visible for every year).
+   */
+  yearOfCulture: number | null
+  totalSurfaceInSquareMeters: number
+  totalSurfaceInSquareFeet: number
+  backgroundColor: string
+  createdAt: Date
+  updatedAt: Date
+  /**
+   * When set, the garden zone is a subdivision of another garden zone
+   * Parent zones are meant to be as eternal as possible.
+   * Subdivisions are meant to be created and destroyed on a yearly basis.
+   */
+  parent_garden_zone_id: number
+  /**
+   * Virtual field to check if the garden zone is a subdivision
+   * It is a renamed field from parent_garden_zone_id
+   */
+  is_subdivision: boolean
+  has_subdivisions: boolean
+  timeless: boolean
+  /**
+   * Orientation virtual field ONLY USE FOR RECTANGLES
+   * --------------------------------
+   * Disregard if the shape is a circle or square. It will return 'vertical'
+   */
+  orientation: 'horizontal' | 'vertical'
+  /**
+   * NOT USED BY THE FRONTEND YET - Use GardenZoneCulture instead
+   */
+  GardenZoneCultures?: GardenZoneCultureI[]
+  /**
+   * The culture on the GardenZone
+   */
+  GardenZoneCulture?: GardenZoneCultureI
+  rotationSuggestion?: string
+}
+
+export interface GardenZoneCultureI {
+  id: number
+  gardenZoneId: number
+  plantSelectionId: number
+  seedQuantity: number
+  densityMode: 'dense' | 'sparse' | 'custom'
+  fertilizerId: number
+  /**
+   * The year of the culture - do not use it yet.
+   * @deprecated Potentially a mistake to have this field here
+   */
+  yearOfCulture: number
+  PlantSelection?: PlantSelectionI
+  /**
+   * The number of alleys
+   * --------------------------------
+   * Value is computed by the backend and NOT coming from the DB.
+   */
+  numberOfAlleys?: number
+  /**
+   * The number of seeds per alley
+   * --------------------------------
+   * Value is computed by the backend and NOT coming from the DB.
+   */
+  numberOfSeedsPerAlley?: number
+  Fertilizer?: FertilizerI
+  custom_space_between_seeds_in_cm?: number
+  custom_space_between_alley_in_cm?: number
+}
+
+export type UpdateGardenZonePayload = Partial<GardenZoneI> &
+  Partial<GardenZoneCultureI> & {
+    targetNumberOfPlants?: number
+  }

package/src/gardenOverview.d.ts

@@ -1,79 +1,79 @@
-/**
- * Garden Overview Types
- * Represents the detailed overview of a garden selection
- */
-import { PlantI } from './plant'
-
-export interface GardenOverviewI {
-  id: number
-  title: string
-  iconName: string
-  yearOfCulture: number
-  statistics: GardenOverviewStatsI
-}
-
-export interface GardenOverviewStatsI {
-  totalSeeds: number
-  totalSurface: string
-  totalSurfaceWithoutCulture: string
-  surfaceComparisonMessage: string | null
-  familyDistribution: FamilyStatsI[]
-  fertilization: FertilizationStatsI
-  zones: GardenOverviewZoneStatsI[]
-}
-
-export interface FertilizationStatsI {
-  totalWeightInKg: number
-  weightComparisonMessage: string | null
-  fertilizerDetails: FertilizerStatsI[]
-}
-
-export interface FertilizerStatsI {
-  fertilizerName: string
-  fertilizerQuantity: string
-  imageURL: string
-}
-
-export interface FamilyStatsI {
-  family: string
-  hexColor: string
-  totalSeeds: number
-  totalSurface: string
-  percentage: number
-  plants: GardenOverviewPlantStatsI[]
-}
-
-/**
- * Extended PlantI with overview-specific statistics
- * Contains the full plant data plus surface, seedQuantity, and position
- */
-export interface GardenOverviewPlantStatsI extends PlantI {
-  seedQuantity: number
-  surface: string
-  position: number
-  densityMode: string
-  fertilizerName: string
-  fertilizerQuantity: string
-}
-
-export interface GardenOverviewZonePlantStatsI {
-  id: number
-  name: string
-  imageURL: string | null
-}
-
-export interface GardenOverviewZoneFertilizerStatsI {
-  name: string
-  quantity: string
-}
-
-export interface GardenOverviewZoneStatsI {
-  id: number
-  name: string
-  totalSeeds: number
-  surface: string
-  fertilizerQuantity: string
-  thumbnailURL: string
-  plants: GardenOverviewZonePlantStatsI[]
-  fertilizers: GardenOverviewZoneFertilizerStatsI[]
-}
+/**
+ * Garden Overview Types
+ * Represents the detailed overview of a garden selection
+ */
+import { PlantI } from './plant'
+
+export interface GardenOverviewI {
+  id: number
+  title: string
+  iconName: string
+  yearOfCulture: number
+  statistics: GardenOverviewStatsI
+}
+
+export interface GardenOverviewStatsI {
+  totalSeeds: number
+  totalSurface: string
+  totalSurfaceWithoutCulture: string
+  surfaceComparisonMessage: string | null
+  familyDistribution: FamilyStatsI[]
+  fertilization: FertilizationStatsI
+  zones: GardenOverviewZoneStatsI[]
+}
+
+export interface FertilizationStatsI {
+  totalWeightInKg: number
+  weightComparisonMessage: string | null
+  fertilizerDetails: FertilizerStatsI[]
+}
+
+export interface FertilizerStatsI {
+  fertilizerName: string
+  fertilizerQuantity: string
+  imageURL: string
+}
+
+export interface FamilyStatsI {
+  family: string
+  hexColor: string
+  totalSeeds: number
+  totalSurface: string
+  percentage: number
+  plants: GardenOverviewPlantStatsI[]
+}
+
+/**
+ * Extended PlantI with overview-specific statistics
+ * Contains the full plant data plus surface, seedQuantity, and position
+ */
+export interface GardenOverviewPlantStatsI extends PlantI {
+  seedQuantity: number
+  surface: string
+  position: number
+  densityMode: string
+  fertilizerName: string
+  fertilizerQuantity: string
+}
+
+export interface GardenOverviewZonePlantStatsI {
+  id: number
+  name: string
+  imageURL: string | null
+}
+
+export interface GardenOverviewZoneFertilizerStatsI {
+  name: string
+  quantity: string
+}
+
+export interface GardenOverviewZoneStatsI {
+  id: number
+  name: string
+  totalSeeds: number
+  surface: string
+  fertilizerQuantity: string
+  thumbnailURL: string
+  plants: GardenOverviewZonePlantStatsI[]
+  fertilizers: GardenOverviewZoneFertilizerStatsI[]
+}

package/src/gardenZoneBlueprint.api.d.ts

@@ -0,0 +1,7 @@
+import type { HOME } from './home.api'
+
+export namespace GARDEN_ZONE_BLUEPRINT {
+  export interface Response {
+    sections: HOME.SectionI[]
+  }
+}

package/src/home.api.d.ts

@@ -38,6 +38,7 @@ export namespace HOME {
     days: WeatherDayI[]
     lastUpdatedAt: string
     dataSource: 'weatherapi'
+    backgroundColor?: string
   }
 
   export interface HeaderSectionI {
@@ -47,6 +48,7 @@ export namespace HOME {
   }
 
   export interface AdviceI {
+    id?: string | number
     title: string
     markdownContent: string
     titleColor?: string
@@ -66,6 +68,7 @@ export namespace HOME {
   }
 
   export interface WideCardItemI {
+    id?: string | number
     title?: string | null
     text: string
     badgeText?: string | null
@@ -229,6 +232,8 @@ export namespace HOME {
 
   export interface Response {
     sections: SectionI[]
+    weather?: WeatherSectionI
+    advice?: AdviceSectionI
   }
 
   export interface HeroCardItemI {

package/src/image.d.ts

@@ -1,10 +1,10 @@
-export interface ImageI {
-  id: number
-  noteId: number
-  s3Key: string
-  s3Url: string
-  filename: string
-  imageURL: string
-  createdAt: Date
-  updatedAt: Date
-}
+export interface ImageI {
+  id: number
+  noteId: number
+  s3Key: string
+  s3Url: string
+  filename: string
+  imageURL: string
+  createdAt: Date
+  updatedAt: Date
+}

package/src/index.ts

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

package/src/member.d.ts

@@ -27,9 +27,14 @@ export interface MemberI {
   hasAnActiveSubscription?: boolean
   /**
    * Acts as a one-way not identifiable token.
-   * Crisp and other services may use this token to identify the user
+   * Crisp uses this token to identify the user conversation
    */
   userToken: string
+  /**
+   * HMAC signature used by Crisp identity verification.
+   * Signed on the backend from the user email.
+   */
+  crispUserEmailSignature?: string
   /**
    * neverAddedATask <=> Has the use ever open the task form?
    * Yes it is misleading, ticket is open to change it.

package/src/note.d.ts

@@ -1,30 +1,30 @@
-import { ImageI } from './image.d.ts'
-import { TaggedItemI } from './taggedItem.d.ts'
-import { MemberI } from './member.d.ts'
-
-export interface NoteI {
-  id: number
-  memberId: number
-  title: string
-  contentInMarkdown: string
-  color?: string
-  agreedToShare: boolean
-  createdAt: Date
-  updatedAt: Date
-  /**
-   * Virtual field for the note thumbnail imageURL (absolute path) */
-  imageURL?: string
-  /**
-   * Virtual field indicating if the note content is short
-   * Used to alter the design of the note (likely with ContentInMarkdown replacing the title)
-   * */
-  hasShortContent?: boolean
-  /**
-   * Virtual field for the note sharing URL (relative path) */
-  sharingURL: string
-  darkColor: string
-  pastelColor: string
-  Images: ImageI[]
-  TaggedItems: TaggedItemI[]
-  Member?: MemberI
-}
+import { ImageI } from './image.d.ts'
+import { TaggedItemI } from './taggedItem.d.ts'
+import { MemberI } from './member.d.ts'
+
+export interface NoteI {
+  id: number
+  memberId: number
+  title: string
+  contentInMarkdown: string
+  color?: string
+  agreedToShare: boolean
+  createdAt: Date
+  updatedAt: Date
+  /**
+   * Virtual field for the note thumbnail imageURL (absolute path) */
+  imageURL?: string
+  /**
+   * Virtual field indicating if the note content is short
+   * Used to alter the design of the note (likely with ContentInMarkdown replacing the title)
+   * */
+  hasShortContent?: boolean
+  /**
+   * Virtual field for the note sharing URL (relative path) */
+  sharingURL: string
+  darkColor: string
+  pastelColor: string
+  Images: ImageI[]
+  TaggedItems: TaggedItemI[]
+  Member?: MemberI
+}