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

package/src/home.api.d.ts

@@ -1,159 +1,173 @@
-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
+    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
+    ctaRoute?: 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[]
+  }
+
+  export interface HeroCardItemI {
+    id?: string | null
+    mode: HeroCardMode
+    title?: string | null
+    description?: string | null
+    backgroundColor?: string | null
+    backgroundImageUrl?: string | null
+    previewPlants?: PlantI[]
+    ctaLabel?: string | null
+    selection?: SelectionI | null
+    plant?: PlantI | null
+    ctaRoute?: string | null
+  }
+}

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,27 +1,28 @@
-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'
-import * as PlantsAPI from './plants.api'
-import * as UsersAPI from './users.api'
-import * as SessionsAPI from './sessions.api'
-import * as HomeAPI from './home.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 * 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'
+
+// 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
+}

package/src/member.d.ts

@@ -1,61 +1,61 @@
-import { NoteI } from './note'
-import { SelectionI } from './selection'
-
-export interface MemberI {
-  id: number
-  email: string
-  firstName: string
-  lastName: string
-  /** Virtual field to get the user's full name */
-  fullName?: string | null
-  city?: string
-  hardinessZoneName?: string
-  createdAt: Date
-  updatedAt: Date
-  lastFreezingDate?: Date
-  firstFreezingDate?: Date
-  /**
-   * Number of unread Crisp messages
-   */
-  unreadMessagesCount?: number
-  notes?: NoteI[]
-  selections?: SelectionI[]
-  userActivities?: UserActivityI[]
-  /**
-   * hasAnActiveSubscription is a VIRTUAL FIELD used to check if the user has an active subscription
-   */
-  hasAnActiveSubscription?: boolean
-  /**
-   * Acts as a one-way not identifiable token.
-   * Crisp and other services may use this token to identify the user
-   */
-  userToken: string
-  /**
-   * neverAddedATask <=> Has the use ever open the task form?
-   * Yes it is misleading, ticket is open to change it.
-   * It was too intense to force the user to add a task.
-   */
-  neverAddedATask?: boolean
-  neverAddedAPlant?: boolean
-  neverAddedANote?: boolean
-  neverTriedSpacingSection?: boolean
-  neverTriedAiAgent?: boolean
-  neverDeletedAPlant?: boolean
-  neverDeletedATask?: boolean
-  neverEditedATask?: boolean
-  finishedOnboarding: boolean
-  hasDownloadedNativeApp?: boolean
-  unitSystem: 'imperial' | 'metric'
-  subscriptionEndDate?: Date
-  /**
-   * Virtual field to get the app badge count
-   * ----------------------------------------
-   * For now, it's just the number of unread messages.
-   */
-  badgeCount?: number
-  /**
-   * Number of unread alerts, cached version of unread alerts (the table) count
-   */
-  unreadAlertsCount?: number
-  isAdmin: boolean
-}
+import { NoteI } from './note'
+import { SelectionI } from './selection'
+
+export interface MemberI {
+  id: number
+  email: string
+  firstName: string
+  lastName: string
+  /** Virtual field to get the user's full name */
+  fullName?: string | null
+  city?: string
+  hardinessZoneName?: string
+  createdAt: Date
+  updatedAt: Date
+  lastFreezingDate?: Date
+  firstFreezingDate?: Date
+  /**
+   * Number of unread Crisp messages
+   */
+  unreadMessagesCount?: number
+  notes?: NoteI[]
+  selections?: SelectionI[]
+  userActivities?: UserActivityI[]
+  /**
+   * hasAnActiveSubscription is a VIRTUAL FIELD used to check if the user has an active subscription
+   */
+  hasAnActiveSubscription?: boolean
+  /**
+   * Acts as a one-way not identifiable token.
+   * Crisp and other services may use this token to identify the user
+   */
+  userToken: string
+  /**
+   * neverAddedATask <=> Has the use ever open the task form?
+   * Yes it is misleading, ticket is open to change it.
+   * It was too intense to force the user to add a task.
+   */
+  neverAddedATask?: boolean
+  neverAddedAPlant?: boolean
+  neverAddedANote?: boolean
+  neverTriedSpacingSection?: boolean
+  neverTriedAiAgent?: boolean
+  neverDeletedAPlant?: boolean
+  neverDeletedATask?: boolean
+  neverEditedATask?: boolean
+  finishedOnboarding: boolean
+  hasDownloadedNativeApp?: boolean
+  unitSystem: 'imperial' | 'metric'
+  subscriptionEndDate?: Date
+  /**
+   * Virtual field to get the app badge count
+   * ----------------------------------------
+   * For now, it's just the number of unread messages.
+   */
+  badgeCount?: number
+  /**
+   * Number of unread alerts, cached version of unread alerts (the table) count
+   */
+  unreadAlertsCount?: number
+  isAdmin: boolean
+}

package/src/note.d.ts

@@ -1,28 +1,28 @@
-import { ImageI } from './image.d.ts'
-import { TaggedItemI } from './taggedItem.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[]
-}
+import { ImageI } from './image.d.ts'
+import { TaggedItemI } from './taggedItem.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[]
+}