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

package/src/gardenMap.d.ts

@@ -1,90 +1,90 @@
-/**
- * A gardenMap is a collection of garden zones
- */
-export interface GardenMapI {
-  id: number;
-  name: string;
-  icon_name: string;
-  category?: string;
-  default: boolean;
-  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
-  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
-  /**
-   * 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
-}
-
-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
-  fertilizerQuantitySuggested?: string
-  Fertilizer?: FertilizerI
-}
+/**
+ * A gardenMap is a collection of garden zones
+ */
+export interface GardenMapI {
+  id: number
+  name: string
+  icon_name: string
+  category?: string
+  default: boolean
+  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
+  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
+  /**
+   * 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
+}
+
+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
+  fertilizerQuantitySuggested?: string
+  Fertilizer?: FertilizerI
+}

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/home.api.d.ts

@@ -1,159 +1,159 @@
-import type { PlantI } from './plant'
-import type { SelectionI } from './selection'
-
-export namespace HOME {
-  export type HeroCardMode = 'featuredSelection' | 'featuredPlant'
-
-  export type SectionComponentType =
-    | 'Header'
-    | 'HeroCards'
-    | 'PlantCarousel'
-    | 'HeroCardsCarousel'
-    | 'WideCardsCarousel'
-    | 'Weather'
-    | 'AdviceCarousel'
-    | 'OnboardingCard'
-
-  export type CarouselComponentType = Extract<
-    SectionComponentType,
-    'PlantCarousel' | 'HeroCardsCarousel' | 'WideCardsCarousel'
-  >
-
-  export interface WeatherDayI {
-    date: string
-    minTempC: number
-    maxTempC: number
-    chanceOfRainPercentage: number | null
-    iconUrl: string | null
-    condition?: string | null
-  }
-
-  export interface WeatherSectionI {
-    componentType: 'Weather'
-    title: string
-    subtitle?: string
-    locationName: string
-    timezone: string
-    days: WeatherDayI[]
-    lastUpdatedAt: string
-    dataSource: 'weatherapi'
-  }
-
-  export interface HeaderSectionI {
-    componentType: 'Header'
-    title: string
-    subtitle: string
-  }
-
-  export interface AdviceI {
-    title: string
-    markdownContent: string
-    titleColor?: string
-    backgroundColor?: string
-  }
-
-  export interface AdviceSectionI {
-    componentType: 'AdviceCarousel'
-    title?: string
-    subtitle?: string
-    advices: AdviceI[]
-  }
-
-  export interface WideCardAuthorI {
-    name?: string | null
-    imageURL?: string | null
-  }
-
-  export interface WideCardItemI {
-    title?: string | null
-    text: string
-    badgeText?: string | null
-    thumbnailImageURL: string
-    author?: WideCardAuthorI | null
-    link?: string | null
-    metadata?: Record<string, unknown>
-  }
-
-  export interface WideCardsCarouselSectionI {
-    componentType: 'WideCardsCarousel'
-    title: string
-    subtitle?: string
-    cards: WideCardItemI[]
-  }
-
-  export interface HeroCardBlueprintI {
-    mode: HeroCardMode
-    title?: string | null
-    description?: string | null
-    backgroundColor?: string | null
-    backgroundImageUrl?: string | null
-    ctaLabel?: string | null
-    previewPlants?: PlantI[]
-    selection?: SelectionI | null
-    plant?: PlantI | null
-  }
-
-  export interface HeroCardsSectionI {
-    componentType: 'HeroCards'
-    title?: string | null
-    subtitle?: string | null
-    cards: HeroCardBlueprintI[]
-  }
-
-  export interface PlantCarouselSectionI {
-    componentType: 'PlantCarousel'
-    title: string
-    subtitle?: string
-    selection: SelectionI
-    displayRanking?: boolean
-  }
-
-  export interface HeroCardsCarouselSectionI {
-    componentType: 'HeroCardsCarousel'
-    selections: SelectionI[]
-  }
-
-  export interface FamilyRecommendationI {
-    family: string
-    headline: string
-    plants: PlantI[]
-  }
-
-  export interface FamilyExplorerSectionI {
-    componentType: 'FamilyExplorer'
-    title: string
-    subtitle?: string
-    families: FamilyRecommendationI[]
-  }
-
-  export interface OnboardingStepI {
-    id: string
-    title: string
-    description: string
-    isCompleted: boolean
-    ctaLink: string
-  }
-
-  export interface OnboardingCardSectionI {
-    componentType: 'OnboardingCard'
-    title: string
-    subtitle: string
-    steps: OnboardingStepI[]
-    completedStepsCount: number
-    totalStepsCount: number
-  }
-
-  export type SectionI =
-    | HeaderSectionI
-    | HeroCardsSectionI
-    | PlantCarouselSectionI
-    | HeroCardsCarouselSectionI
-    | WideCardsCarouselSectionI
-    | WeatherSectionI
-    | AdviceSectionI
-    | OnboardingCardSectionI
-
-  export interface Response {
-    sections: SectionI[]
-  }
-}
+import type { PlantI } from './plant'
+import type { SelectionI } from './selection'
+
+export namespace HOME {
+  export type HeroCardMode = 'featuredSelection' | 'featuredPlant'
+
+  export type SectionComponentType =
+    | 'Header'
+    | 'HeroCards'
+    | 'PlantCarousel'
+    | 'HeroCardsCarousel'
+    | 'WideCardsCarousel'
+    | 'Weather'
+    | 'AdviceCarousel'
+    | 'OnboardingCard'
+
+  export type CarouselComponentType = Extract<
+    SectionComponentType,
+    'PlantCarousel' | 'HeroCardsCarousel' | 'WideCardsCarousel'
+  >
+
+  export interface WeatherDayI {
+    date: string
+    minTempC: number
+    maxTempC: number
+    chanceOfRainPercentage: number | null
+    iconUrl: string | null
+    condition?: string | null
+  }
+
+  export interface WeatherSectionI {
+    componentType: 'Weather'
+    title: string
+    subtitle?: string
+    locationName: string
+    timezone: string
+    days: WeatherDayI[]
+    lastUpdatedAt: string
+    dataSource: 'weatherapi'
+  }
+
+  export interface HeaderSectionI {
+    componentType: 'Header'
+    title: string
+    subtitle: string
+  }
+
+  export interface AdviceI {
+    title: string
+    markdownContent: string
+    titleColor?: string
+    backgroundColor?: string
+  }
+
+  export interface AdviceSectionI {
+    componentType: 'AdviceCarousel'
+    title?: string
+    subtitle?: string
+    advices: AdviceI[]
+  }
+
+  export interface WideCardAuthorI {
+    name?: string | null
+    imageURL?: string | null
+  }
+
+  export interface WideCardItemI {
+    title?: string | null
+    text: string
+    badgeText?: string | null
+    thumbnailImageURL: string
+    author?: WideCardAuthorI | null
+    link?: string | null
+    metadata?: Record<string, unknown>
+  }
+
+  export interface WideCardsCarouselSectionI {
+    componentType: 'WideCardsCarousel'
+    title: string
+    subtitle?: string
+    cards: WideCardItemI[]
+  }
+
+  export interface HeroCardBlueprintI {
+    mode: HeroCardMode
+    title?: string | null
+    description?: string | null
+    backgroundColor?: string | null
+    backgroundImageUrl?: string | null
+    ctaLabel?: string | null
+    previewPlants?: PlantI[]
+    selection?: SelectionI | null
+    plant?: PlantI | null
+  }
+
+  export interface HeroCardsSectionI {
+    componentType: 'HeroCards'
+    title?: string | null
+    subtitle?: string | null
+    cards: HeroCardBlueprintI[]
+  }
+
+  export interface PlantCarouselSectionI {
+    componentType: 'PlantCarousel'
+    title: string
+    subtitle?: string
+    selection: SelectionI
+    displayRanking?: boolean
+  }
+
+  export interface HeroCardsCarouselSectionI {
+    componentType: 'HeroCardsCarousel'
+    selections: SelectionI[]
+  }
+
+  export interface FamilyRecommendationI {
+    family: string
+    headline: string
+    plants: PlantI[]
+  }
+
+  export interface FamilyExplorerSectionI {
+    componentType: 'FamilyExplorer'
+    title: string
+    subtitle?: string
+    families: FamilyRecommendationI[]
+  }
+
+  export interface OnboardingStepI {
+    id: string
+    title: string
+    description: string
+    isCompleted: boolean
+    ctaLink: string
+  }
+
+  export interface OnboardingCardSectionI {
+    componentType: 'OnboardingCard'
+    title: string
+    subtitle: string
+    steps: OnboardingStepI[]
+    completedStepsCount: number
+    totalStepsCount: number
+  }
+
+  export type SectionI =
+    | HeaderSectionI
+    | HeroCardsSectionI
+    | PlantCarouselSectionI
+    | HeroCardsCarouselSectionI
+    | WideCardsCarouselSectionI
+    | WeatherSectionI
+    | AdviceSectionI
+    | OnboardingCardSectionI
+
+  export interface Response {
+    sections: SectionI[]
+  }
+}

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