@la-main-verte/shared-types 1.0.83 → 1.0.86

package/package.json

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

package/src/audience.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Audience targeting shared types
+ * -------------------------------
+ * An Audience is a reusable, named set of targeting criteria. Membership is
+ * precomputed into a join table, so these shapes describe the *definition* of
+ * an audience, not its resolved members.
+ *
+ * Criteria are heterogeneous and open-ended: each `type` has its own `params`.
+ * The canonical runtime validation lives in the zod discriminated union at
+ * `server/domains/audience/criterion.schema.ts`; keep these types in sync with it.
+ */
+
+/** How an audience combines its criteria. */
+export type AudienceCombinator = 'all' | 'any'
+
+/** Member within `radiusKm` of a point. `label` is a human-readable origin (e.g. a city name). */
+export interface GeoRadiusCriterion {
+  type: 'geo_radius'
+  params: {
+    latitude: number
+    longitude: number
+    radiusKm: number
+    label?: string
+  }
+}
+
+/**
+ * Member whose `countryCode` matches (ISO 3166-1 alpha-2, e.g. "CA", "US", "FR").
+ * @see documentation/geographic-targeting.md
+ */
+export interface CountryCriterion {
+  type: 'country'
+  params: { countryCode: string }
+}
+
+/**
+ * Member whose `provinceCode` matches (ISO 3166-2 subdivision code, e.g. "CA-QC", "US-CA", "FR-IDF").
+ * @see documentation/geographic-targeting.md
+ */
+export interface ProvinceCriterion {
+  type: 'province'
+  params: { provinceCode: string }
+}
+
+/** Member whose `city` matches (case-insensitive). */
+export interface CityCriterion {
+  type: 'city'
+  params: { cityName: string }
+}
+
+/** Member owns at least one GardenMap of the given category (e.g. "greenhouse"). */
+export interface GardenMapCategoryCriterion {
+  type: 'garden_map_category'
+  params: { category: string }
+}
+
+/**
+ * Behavioral: member who was active on at least `minDistinctDays` distinct
+ * calendar days (counted from SessionEvents) within the last `windowDays`.
+ * Time-relative — evaluated at recompute time, so the daily refresh cron keeps
+ * the trailing window honest.
+ */
+export interface ActivityDistinctDaysCriterion {
+  type: 'activity_distinct_days'
+  params: { minDistinctDays: number; windowDays: number }
+}
+
+export type AudienceCriterion =
+  | GeoRadiusCriterion
+  | CountryCriterion
+  | ProvinceCriterion
+  | CityCriterion
+  | GardenMapCategoryCriterion
+  | ActivityDistinctDaysCriterion
+
+export type AudienceCriterionType = AudienceCriterion['type']
+
+export interface AudienceI {
+  id: number
+  name: string
+  description: string | null
+  combinator: AudienceCombinator
+  criteria: AudienceCriterion[]
+  createdAt: Date
+  updatedAt: Date
+}

package/src/home.api.d.ts

@@ -1,276 +1,262 @@
-import type { PlantI } from './plant'
-import type { SelectionI } from './selection'
-import type { TaskI } from './task'
-
-export namespace HOME {
-  export type HeroCardMode = 'featuredSelection' | 'featuredPlant'
-
-  export type SectionComponentType =
-    | 'Header'
-    | 'HeroCards'
-    | 'PlantCarousel'
-    | 'HeroCardsCarousel'
-    | 'WideCardsCarousel'
-    | 'Weather'
-    | 'AdviceCarousel'
-    | 'OnboardingCard'
-    | 'UpcomingTasks'
-
-  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'
-    backgroundColor?: string
-  }
-
-  export interface HeaderSectionI {
-    componentType: 'Header'
-    title: string
-    subtitle: string
-  }
-
-  export interface AdviceI {
-    id?: string | number
-    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 {
-    id?: string | number
-    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
-  }
-
-  /** Minimal plant info for preview display (e.g. parent plant in grouped tasks) */
-  export interface TaskPlantPreviewI {
-    name: string
-    slug: string
-    imageURL?: string | null
-  }
-
-  /** Plant info within a family group — includes the task ID specific to this plant */
-  export interface TaskFamilyPlantPreviewI extends TaskPlantPreviewI {
-    taskId: number
-  }
-
-  /** Family group info when multiple plants share the same task */
-  export interface TaskFamilyGroupI {
-    familyName: string
-    plantsCount: number
-    plants: TaskFamilyPlantPreviewI[]
-  }
-
-  export interface UpcomingTaskI {
-    task: TaskI
-    /** PlantSelection id used by task list views to group tasks per planted item. */
-    plantSelectionId?: number
-    plantName: string
-    plantSlug: string
-    plantImageURL?: string | null
-    gardenName: string
-    gardenCategory: string
-    selectionSlug: string
-    /** If this task is grouped by family */
-    familyGroup?: TaskFamilyGroupI
-  }
-
-  export type TaskListView = 'current' | 'completed' | 'earlier'
-
-  export interface TaskListTabI {
-    key: TaskListView
-    label: string
-  }
-
-  export interface TaskListResponseI {
-    view: TaskListView
-    title: string
-    subtitle: string
-    emptyListMessage: string
-    tabs: TaskListTabI[]
-    tasks: UpcomingTaskI[]
-  }
-
-  export interface UpcomingTaskAdviceI {
-    /** @deprecated Since 1.9.10, this field is always `''`. */
-    content: string
-    taskName: string
-    plantName: string
-    plantSlug: string
-    plantImageURL?: string | null
-    gardenName: string
-    gardenCategory: string
-    selectionSlug: string
-    task: TaskI
-    /** If this task is grouped by family */
-    familyGroup?: TaskFamilyGroupI
-  }
-
-  export interface UpcomingTasksSectionI {
-    componentType: 'UpcomingTasks'
-    title: string
-    subtitle?: string
-    advices: UpcomingTaskAdviceI[]
-  }
-
-  /** Preview plant for WhenToSeedWhat section */
-  export interface WhenToSeedWhatPlantPreviewI {
-    id: number
-    name: string
-    family?: string | null
-    slug: string
-    imageURL?: string | null
-  }
-
-  /** A generic link card section with title, subtitle, URL, and optional preview images */
-  export interface LinkCardSectionI {
-    componentType: 'LinkCard'
-    title: string
-    subtitle?: string
-    url: string
-    previewPlants?: WhenToSeedWhatPlantPreviewI[]
-    backgroundColor?: string
-    /** Show a red badge indicator (replaces the plant preview stack when true) */
-    showBadge?: boolean
-    /** Optional badge count to display */
-    badgeCount?: number
-  }
-
-  export type SectionI =
-    | HeaderSectionI
-    | HeroCardsSectionI
-    | PlantCarouselSectionI
-    | HeroCardsCarouselSectionI
-    | WideCardsCarouselSectionI
-    | WeatherSectionI
-    | AdviceSectionI
-    | OnboardingCardSectionI
-    | UpcomingTasksSectionI
-    | LinkCardSectionI
-
-  export interface Response {
-    sections: SectionI[]
-    weather?: WeatherSectionI
-    advice?: AdviceSectionI
-  }
-
-  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
-  }
-}
+import type { PlantI } from './plant'
+import type { SelectionI } from './selection'
+import type { TaskI } from './task'
+
+export namespace HOME {
+  export type HeroCardMode = 'featuredSelection' | 'featuredPlant'
+
+  export type SectionComponentType =
+    | 'Header'
+    | 'HeroCards'
+    | 'PlantCarousel'
+    | 'HeroCardsCarousel'
+    | 'WideCardsCarousel'
+    | 'Weather'
+    | 'AdviceCarousel'
+    | 'OnboardingCard'
+    | 'UpcomingTasks'
+
+  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'
+    backgroundColor?: string
+  }
+
+  export interface HeaderSectionI {
+    componentType: 'Header'
+    title: string
+    subtitle: string
+  }
+
+  export interface AdviceI {
+    id?: string | number
+    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 {
+    id?: string | number
+    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
+  }
+
+  /** Minimal plant info for preview display (e.g. parent plant in grouped tasks) */
+  export interface TaskPlantPreviewI {
+    name: string
+    slug: string
+    imageURL?: string | null
+  }
+
+  /** Plant info within a family group — includes the task ID specific to this plant */
+  export interface TaskFamilyPlantPreviewI extends TaskPlantPreviewI {
+    taskId: number
+  }
+
+  /** Family group info when multiple plants share the same task */
+  export interface TaskFamilyGroupI {
+    familyName: string
+    plantsCount: number
+    plants: TaskFamilyPlantPreviewI[]
+  }
+
+  export interface UpcomingTaskI {
+    task: TaskI
+    /** PlantSelection id used by task list views to group tasks per planted item. */
+    plantSelectionId?: number
+    plantName: string
+    plantSlug: string
+    plantImageURL?: string | null
+    gardenName: string
+    gardenCategory: string
+    selectionSlug: string
+    /** If this task is grouped by family */
+    familyGroup?: TaskFamilyGroupI
+  }
+
+  export type TaskListView = 'current' | 'completed' | 'earlier'
+
+  export interface UpcomingTaskAdviceI {
+    /** @deprecated Since 1.9.10, this field is always `''`. */
+    content: string
+    taskName: string
+    plantName: string
+    plantSlug: string
+    plantImageURL?: string | null
+    gardenName: string
+    gardenCategory: string
+    selectionSlug: string
+    task: TaskI
+    /** If this task is grouped by family */
+    familyGroup?: TaskFamilyGroupI
+  }
+
+  export interface UpcomingTasksSectionI {
+    componentType: 'UpcomingTasks'
+    title: string
+    subtitle?: string
+    advices: UpcomingTaskAdviceI[]
+  }
+
+  /** Preview plant for WhenToSeedWhat section */
+  export interface WhenToSeedWhatPlantPreviewI {
+    id: number
+    name: string
+    family?: string | null
+    slug: string
+    imageURL?: string | null
+  }
+
+  /** A generic link card section with title, subtitle, URL, and optional preview images */
+  export interface LinkCardSectionI {
+    componentType: 'LinkCard'
+    title: string
+    subtitle?: string
+    url: string
+    previewPlants?: WhenToSeedWhatPlantPreviewI[]
+    backgroundColor?: string
+    /** Show a red badge indicator (replaces the plant preview stack when true) */
+    showBadge?: boolean
+    /** Optional badge count to display */
+    badgeCount?: number
+  }
+
+  export type SectionI =
+    | HeaderSectionI
+    | HeroCardsSectionI
+    | PlantCarouselSectionI
+    | HeroCardsCarouselSectionI
+    | WideCardsCarouselSectionI
+    | WeatherSectionI
+    | AdviceSectionI
+    | OnboardingCardSectionI
+    | UpcomingTasksSectionI
+    | LinkCardSectionI
+
+  export interface Response {
+    sections: SectionI[]
+    weather?: WeatherSectionI
+    advice?: AdviceSectionI
+  }
+
+  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/index.ts

@@ -1,34 +1,35 @@
-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'
-export * from './taxonFamily'
-export * from './rotationGroup'
-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
-}
+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 './audience'
+export * from './image'
+export * from './note'
+export * from './taggedItem'
+export * from './fertilizer'
+export * from './utmParams'
+export * from './plantFilters'
+export * from './taxonFamily'
+export * from './rotationGroup'
+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/member.d.ts

@@ -1,72 +1,126 @@
-import type { NoteI } from './note'
-import type { 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 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.
-   * 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'
-  gardenZoneTimelessPreference?: boolean
-  subscriptionEndDate?: Date
-  /**
-   * Last fertilizer ID chosen by the user.
-   * Used as the default fertilizer for new garden zones.
-   */
-  lastFertilizerIdChosen?: number
-  /**
-   * 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 type { NoteI } from './note'
+import type { 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 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.
+   * 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'
+  gardenZoneTimelessPreference?: boolean
+  subscriptionEndDate?: Date
+  /**
+   * Last fertilizer ID chosen by the user.
+   * Used as the default fertilizer for new garden zones.
+   */
+  lastFertilizerIdChosen?: number
+  /**
+   * 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
+}
+
+/**
+ * PrivateMemberI
+ * --------------
+ * The data a member is allowed to see about *themselves* — the shape
+ * returned to the front-end by GET/POST /users. (A future `PublicMemberI`
+ * will model the much smaller set of fields shown to other members.)
+ *
+ * Unlike `MemberI` (the full domain model), this is a deliberate
+ * allow-list of only the fields the client actually consumes. It exists
+ * to prevent leaking sensitive or internal Member columns: anything not
+ * listed here is never serialized to the client. Keep this in sync with
+ * `privateMember.presenter.ts` on the backend.
+ */
+export interface PrivateMemberI {
+  id: number
+  email: string
+  city?: string
+  unitSystem: 'imperial' | 'metric'
+  gardenZoneTimelessPreference?: boolean
+  firstFreezingDate?: Date
+  lastFreezingDate?: Date
+  subscriptionEndDate?: Date
+  hasAnActiveSubscription?: boolean
+  hasDownloadedNativeApp?: boolean
+  isAdmin: boolean
+  /**
+   * App badge count (currently unread messages + unread alerts).
+   */
+  badgeCount?: number
+  /**
+   * One-way Crisp identification token. Not personally identifiable.
+   */
+  userToken: string
+  /**
+   * HMAC signature used by Crisp identity verification.
+   */
+  crispUserEmailSignature?: string
+  unreadMessagesCount?: number
+  unreadAlertsCount?: number
+  neverAddedANote?: boolean
+  neverAddedAPlant?: boolean
+  neverDeletedAPlant?: boolean
+  neverEditedATask?: boolean
+  neverTriedAiAgent?: boolean
+  neverTriedSpacingSection?: boolean
+  /**
+   * True when the member belongs to the "very active" audience (~14 days of
+   * distinct activity). Only present when GET /users is called with the
+   * `requestAppStoreReview` scope; the app uses it to trigger a one-time
+   * in-app store-review prompt.
+   */
+  requestAppStoreReview?: boolean
+}

package/src/plant.d.ts

@@ -21,7 +21,18 @@ export type PlantFilterValueI = string | string[] | number | boolean | RangeFilt
  * Used in JSONB field and as query parameters
  * Supports multiple value types for different filter types
  */
-export type PlantAttributesI = Record<string, PlantFilterValueI>
+/**
+ * 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

package/src/users.api.d.ts

@@ -1,136 +1,134 @@
-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
-      }
-    }
-  }
-}
+import type { DeviceDataI } from './device.d'
+import type { PrivateMemberI } 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' | 'requestAppStoreReview')[]
+      }
+    }
+    export type Response = PrivateMemberI
+  }
+  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 = PrivateMemberI
+  }
+  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
+      }
+    }
+  }
+}