@la-main-verte/shared-types 1.0.43 → 1.0.47

package/package.json

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

package/src/device.d.ts

@@ -1,9 +1,3 @@
-import { Model } from 'sequelize'
-
-/**
- * Raw Data returned by the device model
- * Device.toJSON() will return this data
- */
 /**
  * Raw Data returned by the device model
  * Device.toJSON() will return this data
@@ -23,9 +17,17 @@ type DeviceDataI = {
   platform?: 'ios' | 'android' | 'windows'
   /** Optional version of the device */
   version?: string
-  /** Optional model of the device */
+  /**
+   * Technical model of the device
+   * ---
+   * Ex:  iPhone12,1, iPhone13,2, iPhone14,4, etc.
+   */
   model?: string
-  /** Optional name of the device */
+  /**
+   * Readable name of the device
+   * ---
+   * Ex: 'iPhone 12 Pro Max', 'Samsung Galaxy S20', 'MacBook Pro 13 inch'
+   * */
   name?: string
   /** Optional app version of the device. Ex: 1.0.0 */
   appVersion?: string
@@ -33,5 +35,7 @@ type DeviceDataI = {
   createdAt: Date
   /** Timestamp of when the device was last updated */
   updatedAt: Date
+  /** Virtual field that combines the name and appVersion */
+  fullName: string
 }
-interface DeviceModelI extends Model<DeviceDataI> {}
+export { DeviceDataI }

package/src/image.d.ts

@@ -0,0 +1,10 @@
+export interface ImageI {
+  id: number
+  noteId: number
+  s3Key: string
+  s3Url: string
+  filename: string
+  imageURL: string
+  createdAt: Date
+  updatedAt: Date
+}

package/src/index.ts

@@ -7,6 +7,7 @@ export * from './calendarView'
 export * from './apiError'
 export * from './gardenMap'
 export * from './alert'
+export * from './image'
 import * as PlantsAPI from './plants.api'
 import * as UsersAPI from './users.api'
 

package/src/member.d.ts

@@ -3,12 +3,18 @@ export interface MemberI {
   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[]
@@ -37,4 +43,11 @@ export interface MemberI {
   finishedOnboarding: boolean
   hasDownloadedNativeApp?: boolean
   unitSystem: 'imperial' | 'metric'
+  /**
+   * Virtual field to get the app badge count
+   * ----------------------------------------
+   * For now, it's just the number of unread messages.
+   */
+  badgeCount?: number
+  isAdmin: boolean
 }

package/src/plant.d.ts

@@ -47,6 +47,7 @@ export interface PlantI {
    */
   Selections?: SelectionI[]
   tasks?: TaskI[]
+  Images?: ImageI[]
 }
 
 interface PlantTagI {

package/src/users.api.d.ts

@@ -17,7 +17,6 @@ export namespace USERS {
     }
     export type Response = MemberDataI & {
       unreadAlertsCount?: number
-      unreadMessagesCount?: number
     }
   }
   export namespace DEVICES {