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

package/src/index.ts

@@ -1,27 +1,27 @@
-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'
+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[]
+}

package/src/plant.d.ts

@@ -1,85 +1,85 @@
-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: 'Plein soleil' | 'Mi-ombre' | 'Ombre' | null
-  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[]
-  rotationFamily?: string
-}
-
-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
-}
+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: 'Plein soleil' | 'Mi-ombre' | 'Ombre' | null
+  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[]
+  rotationFamily?: string
+}
+
+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,13 +1,13 @@
-import { PlantI } from './plant.d.ts'
-import { SelectionI } from './selection.d.ts'
-
-export interface PlantSelectionI {
-  id: number
-  plantId: number
-  selectionId: number
-  seedQuantity: number
-  createdAt: Date
-  updatedAt: Date
-  Plant: PlantI
-  Selection: SelectionI
-}
+import { PlantI } from './plant.d.ts'
+import { SelectionI } from './selection.d.ts'
+
+export interface PlantSelectionI {
+  id: number
+  plantId: number
+  selectionId: number
+  seedQuantity: number
+  createdAt: Date
+  updatedAt: Date
+  Plant: PlantI
+  Selection: SelectionI
+}

package/src/plants.api.d.ts

@@ -1,84 +1,84 @@
-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
+      }
+    }
+    /**
+     * 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
+  }
+}