@la-main-verte/shared-types 1.0.29 → 1.0.32

package/package.json

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

package/src/plant.d.ts

@@ -40,7 +40,12 @@ export interface PlantI {
   children?: PlantI[]
   PlantInventories?: PlantInventoryI[]
   taggedItems?: TaggedItemI[]
-  tags?: PlantTagI[]
+  /**
+   * List of selections that the plant is in.
+   * --------------------------------------
+   * Tends to be used for featured selections
+   */
+  Selections?: SelectionI[]
   tasks?: TaskI[]
 }
 

package/src/plants.api.d.ts

@@ -1,7 +1,8 @@
 import { PlantI, PlantTagI } from './plant.d'
+import { SelectionI } from './selection.d'
 
-interface PlantDataWithTagsI extends PlantI {
-  tags: PlantTagI[]
+interface PlantExtendedDataI extends PlantI {
+  Selections: SelectionI[]
 }
 
 export namespace API.Plants {
@@ -18,6 +19,29 @@ export namespace API.Plants {
     /**
      * Response containing recommended plants with their tags
      */
-    export type Response = readonly PlantDataWithTagsI[]
+    export type Response = readonly 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
+      }
+    }
+    /**
+     * Response containing search plants with their tags
+     */
+    export type Response = readonly PlantExtendedDataI[]
   }
 }

package/src/selection.d.ts

@@ -11,6 +11,18 @@ export interface SelectionI {
   imageURL?: string
   featured: boolean
   isDynamic: boolean
+  /**
+   * Background color of the selection, for UI purposes.
+   */
+  backgroundColor: string | null
+  /**
+   * Font color of the selection, for UI purposes.
+   */
+  fontColor: string | null
+  /**
+   * Icon name of the selection, for UI purposes.
+   */
+  iconName: string | null
   link?: string
   sharingURL?: string
   createdAt: Date