@la-main-verte/shared-types 1.0.48 → 1.0.49

package/src/plant.d.ts

@@ -1,83 +1,90 @@
-export interface PlantI {
-  id: number
-  name: string
-  slug: string
-  description: string
-  descriptionSource?: string
-  female: boolean
-  family?: string | null
-  spaceBetweenSeedMin: number
-  spaceBetweenSeedMax: number
-  spaceBetweenAlleyMin: number
-  spaceBetweenAlleyMax: number
-  weeksInTransplant: number
-  weeksDuringWhichYouCanSeedOutdoor: number
-  weeksToMaturity: number
-  weeksToWaitAfterFreezingDate: number
-  weeksToHarvest: number
-  indoorSeeding: boolean
-  outdoorSeeding: boolean
-  azoteNeedsKgPerHa: number
-  hibernate: boolean
-  germinationTemperature: number | null
-  minGerminationTemperature: number | null
-  germinationNumberOfDays: string | null
-  germinationSeedDepth: string | null
-  cultivationInfo: string | null
-  parentId: number | null
-  memberId?: number
-  shared: boolean
-  hexColor: string | null
-  sunRequirements: 'partialShade' | 'fullSun' | 'fullShade' | null
-  isHardy: boolean | null
-  imageURL: string
-  totalWeeksToMaturity: number
-  hasNoInformation: boolean
-  createdAt: Date
-  updatedAt: Date
-  translatedSunRequirements: string
-  parent?: PlantI
-  children?: PlantI[]
-  PlantInventories?: PlantInventoryI[]
-  taggedItems?: TaggedItemI[]
-  /**
-   * List of selections that the plant is in.
-   * --------------------------------------
-   * Tends to be used for featured selections
-   */
-  Selections?: SelectionI[]
-  tasks?: TaskI[]
-  Images?: ImageI[]
-}
-
-interface PlantTagI {
-  name: string
-  /**
-   * Font color of the tag
-   * Ex: #ffffff
-   */
-  fontColor: string
-  /**
-   * Background color of the tag
-   * Ex: #1B76E6
-   */
-  backgroundColor: string
-  /**
-   * Font awesome Icon name
-   * Ex: 'tomato'
-   */
-  iconName: string
-  /** Selection slug related to the tag */
-  slug: string
-}
-
-interface PlantInventoryI {
-  id: number
-  plantId: number
-  supplierName: string
-  plantName: string
-  supplierURL: string
-  imageLocation: string
-  description: string
-  inStock: boolean
-}
+import { ImageI } from './image.d.ts'
+import { SelectionI } from './selection.d.ts'
+import { TaskI } from './task.d.ts'
+import { TaggedItemI } from './taggedItem.d.ts'
+import { NoteI } from './note.js'
+
+export interface PlantI {
+  id: number
+  name: string
+  slug: string
+  description: string
+  descriptionSource?: string
+  female: boolean
+  family?: string | null
+  spaceBetweenSeedMin: number
+  spaceBetweenSeedMax: number
+  spaceBetweenAlleyMin: number
+  spaceBetweenAlleyMax: number
+  weeksInTransplant: number
+  weeksDuringWhichYouCanSeedOutdoor: number
+  weeksToMaturity: number
+  weeksToWaitAfterFreezingDate: number
+  weeksToHarvest: number
+  indoorSeeding: boolean
+  outdoorSeeding: boolean
+  azoteNeedsKgPerHa: number
+  hibernate: boolean
+  germinationTemperature: number | null
+  minGerminationTemperature: number | null
+  germinationNumberOfDays: string | null
+  germinationSeedDepth: string | null
+  cultivationInfo: string | null
+  parentId: number | null
+  memberId?: number
+  shared: boolean
+  hexColor: string | null
+  sunRequirements: 'partialShade' | 'fullSun' | 'fullShade' | null
+  isHardy: boolean | null
+  imageURL: string
+  totalWeeksToMaturity: number
+  hasNoInformation: boolean
+  createdAt: Date
+  updatedAt: Date
+  translatedSunRequirements: string
+  parent?: PlantI
+  children?: PlantI[]
+  PlantInventories?: PlantInventoryI[]
+  taggedItems?: TaggedItemI[]
+  /**
+   * List of selections that the plant is in.
+   * --------------------------------------
+   * Tends to be used for featured selections
+   */
+  Selections?: SelectionI[]
+  tasks?: TaskI[]
+  Images?: ImageI[]
+  notes?: NoteI[]
+}
+
+interface PlantTagI {
+  name: string
+  /**
+   * Font color of the tag
+   * Ex: #ffffff
+   */
+  fontColor: string
+  /**
+   * Background color of the tag
+   * Ex: #1B76E6
+   */
+  backgroundColor: string
+  /**
+   * Font awesome Icon name
+   * Ex: 'tomato'
+   */
+  iconName: string
+  /** Selection slug related to the tag */
+  slug: string
+}
+
+interface PlantInventoryI {
+  id: number
+  plantId: number
+  supplierName: string
+  plantName: string
+  supplierURL: string
+  imageLocation: string
+  description: string
+  inStock: boolean
+}

package/src/plantSelection.d.ts

@@ -1,8 +1,8 @@
-export interface PlantSelectionI {
-  id: number
-  plantId: number
-  selectionId: number
-  seedQuantity: number
-  createdAt: Date
-  updatedAt: Date
-}
+export interface PlantSelectionI {
+  id: number
+  plantId: number
+  selectionId: number
+  seedQuantity: number
+  createdAt: Date
+  updatedAt: Date
+}

package/src/plants.api.d.ts

@@ -1,61 +1,61 @@
-import { PlantI, PlantTagI } 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[]
-  }
-}
+import { PlantI, PlantTagI } 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[]
+  }
+}

package/src/selection.d.ts

@@ -1,52 +1,54 @@
-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[]
-}
-
-/**
- * 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[]
+}
+
+/**
+ * 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/tag.d.ts

@@ -0,0 +1,9 @@
+export interface TagI {
+    id?: number
+    name?: string
+    tagType?: 'plant' | 'task'
+    icon?: string
+    color?: string
+    createdAt: Date
+    updatedAt: Date
+  }

package/src/taggedItem.d.ts

@@ -0,0 +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
+}

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

package/src/users.api.d.ts

@@ -1,38 +1,38 @@
-import type { DeviceDataI } from './device.d'
-import type { MemberI as MemberDataI } from './member.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']
-      }
-    }
-    export type Response = DeviceDataI
-  }
-}
+import type { DeviceDataI } from './device.d'
+import type { MemberI as MemberDataI } from './member.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']
+      }
+    }
+    export type Response = DeviceDataI
+  }
+}