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

package/src/plants.api.d.ts

@@ -1,84 +1,92 @@
-import { PlantI } from './plant.d'
-import { SelectionI } from './selection.d'
-import { ImageDataI } from './image.d'
-
-interface PlantExtendedDataI extends PlantI {
-  /**
-   * Future plant images gallery for now using notes as a proxy
-   */
-  Images: ImageDataI[]
-  /**
-   * Selections of the plant
-   */
-  Selections: SelectionI[]
-}
-
-export namespace PLANTS {
-  export namespace RECOMMENDATIONS {
-    /**
-     * Request parameters for plant recommendations
-     * @remarks identification by session token is optional
-     */
-    export interface Request {
-      headers?: {
-        'x-session-token'?: string
-      }
-    }
-    /**
-     * Response containing recommended plants with their tags
-     */
-    export type Response = PlantExtendedDataI[]
-  }
-  export namespace SEARCH {
-    /**
-     * Request parameters for plant recommendations
-     * @remarks identification by session token is optional
-     */
-    export interface Request {
-      headers?: {
-        'x-session-token'?: string
-      }
-      query?: {
-        withAzoteNeedsKgPerHa?: boolean
-        withSpacing?: boolean
-        parentsOnly?: boolean
-        search?: string
-        family?: string
-        limit?: number
-        /**
-         * If submitted, it means we are searching for plants that can be planted in the given garden zone.
-         * It almost means:
-         * - withSpacing will be set to true automatically.
-         * - Plant.contextualSearchText may be added to the results to provided additional contextual information to the search results (and therefore the member)
-         */
-        gardenZoneId?: string | number
-      }
-    }
-    /**
-     * Response containing search plants with their tags
-     */
-    export type Response = PlantExtendedDataI[]
-  }
-  export namespace UPDATE {
-    export interface Request {
-      params: {
-        slug: string
-      }
-      body: {
-        name?: string
-        description?: string
-        shared?: boolean
-        spaceBetweenSeedMin?: number | null
-        spaceBetweenSeedMax?: number | null
-        spaceBetweenAlleyMin?: number | null
-        spaceBetweenAlleyMax?: number | null
-        weeksToMaturity?: number | null
-        indoorSeeding?: boolean
-        outdoorSeeding?: boolean
-        sunRequirements?: 'partialShade' | 'fullSun' | 'fullShade' | null
-        isHardy?: boolean | null
-      }
-    }
-    export type Response = PlantI
-  }
-}
+import { PlantI } from './plant.d'
+import { SelectionI } from './selection.d'
+import { ImageDataI } from './image.d'
+
+interface PlantExtendedDataI extends PlantI {
+  /**
+   * Future plant images gallery for now using notes as a proxy
+   */
+  Images: ImageDataI[]
+  /**
+   * Selections of the plant
+   */
+  Selections: SelectionI[]
+}
+
+export namespace PLANTS {
+  export namespace RECOMMENDATIONS {
+    /**
+     * Request parameters for plant recommendations
+     * @remarks identification by session token is optional
+     */
+    export interface Request {
+      headers?: {
+        'x-session-token'?: string
+      }
+      query?: {
+        gardenZoneId?: string | number
+        selectionSlug?: string
+      }
+    }
+    export type RecommendedPlantI = PlantExtendedDataI & {
+      contextualSearchText?: string
+    }
+    export type Response = RecommendedPlantI[]
+  }
+  export namespace SEARCH {
+    /**
+     * Request parameters for plant recommendations
+     * @remarks identification by session token is optional
+     */
+    export interface Request {
+      headers?: {
+        'x-session-token'?: string
+      }
+      query?: {
+        withAzoteNeedsKgPerHa?: boolean
+        withSpacing?: boolean
+        parentsOnly?: boolean
+        search?: string
+        family?: string
+        limit?: number
+        /**
+         * If submitted, it means we are searching for plants that can be planted in the given garden zone.
+         * It almost means:
+         * - withSpacing will be set to true automatically.
+         * - Plant.contextualSearchText may be added to the results to provided additional contextual information to the search results (and therefore the member)
+         */
+        gardenZoneId?: string | number
+        /**
+         * Slug of the selection currently being edited. Used to contextualize rotation insights for search results.
+         */
+        selectionSlug?: string
+      }
+    }
+    /**
+     * Response containing search plants with their tags
+     */
+    export type Response = PlantExtendedDataI[]
+  }
+  export namespace UPDATE {
+    export interface Request {
+      params: {
+        slug: string
+      }
+      body: {
+        name?: string
+        description?: string
+        shared?: boolean
+        spaceBetweenSeedMin?: number | null
+        spaceBetweenSeedMax?: number | null
+        spaceBetweenAlleyMin?: number | null
+        spaceBetweenAlleyMax?: number | null
+        weeksToMaturity?: number | null
+        indoorSeeding?: boolean
+        outdoorSeeding?: boolean
+        sunRequirements?: 'partialShade' | 'fullSun' | 'fullShade' | null
+        isHardy?: boolean | null
+      }
+    }
+    export type Response = PlantI
+  }
+}

package/src/rotationGroup.d.ts

@@ -0,0 +1,3 @@
+export type RotationGroup = 'regenerative' | 'demanding' | 'moderately_demanding' | 'less_demanding'
+
+export const ROTATION_GROUPS: RotationGroup[] = ['regenerative', 'demanding', 'moderately_demanding', 'less_demanding']

package/src/selection.d.ts

@@ -1,55 +1,55 @@
-import { PlantI } from './plant'
-
-export interface SelectionI {
-  id: number
-  memberId: number
-  title: string
-  slug: string
-  description?: string
-  orderBy?: 'startDate' | 'name'
-  default?: boolean
-  viewsCount?: number
-  imageLocation?: string
-  imageURL?: string
-  /**
-   * Indicates if the selection is featured on the app (search, explore, etc).
-   **/
-  featured: boolean
-  /**
-   * Indicates if the selection is dynamically generated on the fly by the API.
-   * Ex: "What you can seed in March"
-   * INTERNAL USE ONLY
-   */
-  isDynamic: boolean
-  /**
-   * Background color of the selection, for UI purposes.
-   */
-  backgroundColor: string | null
-  /**
-   * Font color of the selection, for UI purposes.
-   */
-  fontColor: string | null
-  /**
-   * Font awesome icon name of the selection, for UI purposes.
-   * -----------------------------------------
-   * Not all icons are available in the react-native-app. Must be explicitly declared first.
-   * Ex: 'fa-bag-seedling', 'fa-bug', etc.
-   */
-  iconName: string | null
-  link?: string
-  sharingURL?: string
-  createdAt: Date
-  updatedAt: Date
-  Plants?: PlantI[]
-  yearOfCulture: number
-}
-
-/**
- * Those are the different possible types for a selection.
- */
-export type SelectionType = 'Serre' | 'Potager' | 'Recette' | 'Coup de coeur' | "Jardin d'intérieur" | 'Autres'
-
-export interface SelectionTypeI {
-  name: SelectionType
-  iconName?: IconName
-}
+import { PlantI } from './plant'
+
+export interface SelectionI {
+  id: number
+  memberId: number
+  title: string
+  slug: string
+  description?: string
+  orderBy?: 'startDate' | 'name'
+  default?: boolean
+  viewsCount?: number
+  imageLocation?: string
+  imageURL?: string
+  /**
+   * Indicates if the selection is featured on the app (search, explore, etc).
+   **/
+  featured: boolean
+  /**
+   * Indicates if the selection is dynamically generated on the fly by the API.
+   * Ex: "What you can seed in March"
+   * INTERNAL USE ONLY
+   */
+  isDynamic: boolean
+  /**
+   * Background color of the selection, for UI purposes.
+   */
+  backgroundColor: string | null
+  /**
+   * Font color of the selection, for UI purposes.
+   */
+  fontColor: string | null
+  /**
+   * Font awesome icon name of the selection, for UI purposes.
+   * -----------------------------------------
+   * Not all icons are available in the react-native-app. Must be explicitly declared first.
+   * Ex: 'fa-bag-seedling', 'fa-bug', etc.
+   */
+  iconName: string | null
+  link?: string
+  sharingURL?: string
+  createdAt: Date
+  updatedAt: Date
+  Plants?: PlantI[]
+  yearOfCulture: number
+}
+
+/**
+ * Those are the different possible types for a selection.
+ */
+export type SelectionType = 'Serre' | 'Potager' | 'Recette' | 'Coup de coeur' | "Jardin d'intérieur" | 'Autres'
+
+export interface SelectionTypeI {
+  name: SelectionType
+  iconName?: IconName
+}

package/src/sessions.api.d.ts

@@ -1,134 +1,134 @@
-import type { UTMParams } from './utmParams'
-import type { EventType, EventDetailsI } from '../../server/types/sessionEvent'
-import type { PaymentProductTypeI } from '../../server/types/payment'
-
-interface RequestHeaders {
-  'x-session-token'?: string
-  'x-native-app-version'?: string
-  'x-application-type'?: 'react-native' | 'web'
-  'user-agent'?: string
-}
-
-export namespace SESSIONS {
-  export namespace POST {
-    export interface Request {
-      headers: RequestHeaders
-      body: {
-        uuid?: string
-        platform?: 'web' | 'react-native' | 'unknown'
-        device_id?: number
-        app_version?: string
-        ip_address?: string
-      } & Partial<UTMParams>
-    }
-    export interface Response {
-      success: boolean
-      session: {
-        id: number
-        uuid: string
-        is_authenticated: boolean
-        expires_at: string
-        platform: string
-        first_seen_at: string
-        last_activity_at: string
-      }
-      message?: string
-    }
-  }
-
-  export namespace GET {
-    export interface Request {
-      headers: RequestHeaders
-      query: {
-        session_id: string
-      }
-    }
-    export interface Response {
-      success: boolean
-      session?: {
-        id: number
-        uuid: string
-        is_authenticated: boolean
-        expires_at: string
-        platform: string
-        first_seen_at: string
-        last_activity_at: string
-        memberId?: number
-      }
-      message?: string
-    }
-  }
-
-  export namespace EVENTS {
-    export namespace POST {
-      export interface Request {
-        headers: RequestHeaders
-        body: EventDetailsI & {
-          uuid: string
-          event_data?: any
-          // Feature usage specific
-          feature_name?: string
-          feature_action?: string
-          // Event metadata
-          platform?: 'web' | 'react-native' | 'unknown'
-          device_id?: number
-          app_version?: string
-          ip_address?: string
-          // Payment tracking
-          payment_customer_external_id?: string
-          payment_processor?: 'stripe' | 'apple' | 'google'
-          payment_middleware?: 'stripe' | 'revenuecat'
-          payment_product_type?: PaymentProductTypeI
-          payment_transaction_id?: string
-          // Revenue tracking
-          revenue_amount?: number
-          currency?: string
-          created_by?: 'server' | 'client' | 'unknown'
-        }
-      }
-      export interface Response {
-        success: boolean
-        event: {
-          id: number
-          sessionId: number
-          createdAt: string
-        } & EventDetailsI
-        message?: string
-      }
-    }
-
-    export namespace GET {
-      export interface Request {
-        headers: RequestHeaders
-        query: {
-          session_id?: string
-          event_type?: EventType
-          feature_name?: string
-          campaign_id?: string
-          start_date?: string
-          end_date?: string
-          limit?: number
-          offset?: number
-        }
-      }
-      export interface Response {
-        success: boolean
-        events: Array<
-          {
-            id: number
-            sessionId: number
-            event_data?: any
-            feature_name?: string
-            feature_action?: string
-            platform: string
-            revenue_amount?: number
-            currency?: string
-            createdAt: string
-          } & EventDetailsI
-        >
-        total_count: number
-        message?: string
-      }
-    }
-  }
-}
+import type { UTMParams } from './utmParams'
+import type { EventType, EventDetailsI } from '../../server/types/sessionEvent'
+import type { PaymentProductTypeI } from '../../server/types/payment'
+
+interface RequestHeaders {
+  'x-session-token'?: string
+  'x-native-app-version'?: string
+  'x-application-type'?: 'react-native' | 'web'
+  'user-agent'?: string
+}
+
+export namespace SESSIONS {
+  export namespace POST {
+    export interface Request {
+      headers: RequestHeaders
+      body: {
+        uuid?: string
+        platform?: 'web' | 'react-native' | 'unknown'
+        device_id?: number
+        app_version?: string
+        ip_address?: string
+      } & Partial<UTMParams>
+    }
+    export interface Response {
+      success: boolean
+      session: {
+        id: number
+        uuid: string
+        is_authenticated: boolean
+        expires_at: string
+        platform: string
+        first_seen_at: string
+        last_activity_at: string
+      }
+      message?: string
+    }
+  }
+
+  export namespace GET {
+    export interface Request {
+      headers: RequestHeaders
+      query: {
+        session_id: string
+      }
+    }
+    export interface Response {
+      success: boolean
+      session?: {
+        id: number
+        uuid: string
+        is_authenticated: boolean
+        expires_at: string
+        platform: string
+        first_seen_at: string
+        last_activity_at: string
+        memberId?: number
+      }
+      message?: string
+    }
+  }
+
+  export namespace EVENTS {
+    export namespace POST {
+      export interface Request {
+        headers: RequestHeaders
+        body: EventDetailsI & {
+          uuid: string
+          event_data?: any
+          // Feature usage specific
+          feature_name?: string
+          feature_action?: string
+          // Event metadata
+          platform?: 'web' | 'react-native' | 'unknown'
+          device_id?: number
+          app_version?: string
+          ip_address?: string
+          // Payment tracking
+          payment_customer_external_id?: string
+          payment_processor?: 'stripe' | 'apple' | 'google'
+          payment_middleware?: 'stripe' | 'revenuecat'
+          payment_product_type?: PaymentProductTypeI
+          payment_transaction_id?: string
+          // Revenue tracking
+          revenue_amount?: number
+          currency?: string
+          created_by?: 'server' | 'client' | 'unknown'
+        }
+      }
+      export interface Response {
+        success: boolean
+        event: {
+          id: number
+          sessionId: number
+          createdAt: string
+        } & EventDetailsI
+        message?: string
+      }
+    }
+
+    export namespace GET {
+      export interface Request {
+        headers: RequestHeaders
+        query: {
+          session_id?: string
+          event_type?: EventType
+          feature_name?: string
+          campaign_id?: string
+          start_date?: string
+          end_date?: string
+          limit?: number
+          offset?: number
+        }
+      }
+      export interface Response {
+        success: boolean
+        events: Array<
+          {
+            id: number
+            sessionId: number
+            event_data?: any
+            feature_name?: string
+            feature_action?: string
+            platform: string
+            revenue_amount?: number
+            currency?: string
+            createdAt: string
+          } & EventDetailsI
+        >
+        total_count: number
+        message?: string
+      }
+    }
+  }
+}

package/src/taggedItem.d.ts

@@ -1,12 +1,12 @@
-import { TagI } from './tag.d.ts'
-
-export interface TaggedItemI {
-  id: number
-  noteId: number
-  tagId: number
-  itemType: 'plant' | 'task'
-  itemId: number
-  createdAt: Date
-  updatedAt: Date
-  Tag: TagI
-}
+import { TagI } from './tag.d.ts'
+
+export interface TaggedItemI {
+  id: number
+  noteId: number
+  tagId: number
+  itemType: 'plant' | 'task'
+  itemId: number
+  createdAt: Date
+  updatedAt: Date
+  Tag: TagI
+}

package/src/task.d.ts

@@ -1,40 +1,40 @@
-export interface TaskI {
-  id: number
-  name: string
-  startDate: Date
-  endDate?: Date
-  /**
-   * ColourCode of the task
-   * Ex: #ffffff
-   */
-  colourCode: string
-  iconName?: string
-  private: boolean
-}
-
-/**
- * Represents predefined task tags used in the task creation/modification form.
- * There are just a few Tasks that have their own tags
- * and they just have a name a colourCode and an optional iconName similar to the Task they represent
- */
-export interface TaskTagI {
-  name: string
-  /**
-   * ColourCode of the task
-   * Ex: #ffffff
-   */
-  colourCode: string
-  iconName?: string
-}
-
-/**
- * Data used to create or edit a task
- */
-export interface TaskFormDataI {
-  name: string
-  startDate: Date
-  endDate?: Date
-  colourCode: string
-  iconName?: string
-  private: boolean
-}
+export interface TaskI {
+  id: number
+  name: string
+  startDate: Date
+  endDate?: Date
+  /**
+   * ColourCode of the task
+   * Ex: #ffffff
+   */
+  colourCode: string
+  iconName?: string
+  private: boolean
+}
+
+/**
+ * Represents predefined task tags used in the task creation/modification form.
+ * There are just a few Tasks that have their own tags
+ * and they just have a name a colourCode and an optional iconName similar to the Task they represent
+ */
+export interface TaskTagI {
+  name: string
+  /**
+   * ColourCode of the task
+   * Ex: #ffffff
+   */
+  colourCode: string
+  iconName?: string
+}
+
+/**
+ * Data used to create or edit a task
+ */
+export interface TaskFormDataI {
+  name: string
+  startDate: Date
+  endDate?: Date
+  colourCode: string
+  iconName?: string
+  private: boolean
+}