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

package/README.md

@@ -1,26 +1,26 @@
-# La Main Verte - Shared TypeScript Interfaces
-
-This package contains the TypeScript interfaces used for the front-end of La Main Verte application.
-
-## Installation
-
-To install the package, run:
-
-```bash
-
-npm install @la-main-verte/shared-types
-```
-
-## Usage
-
-You can import the interfaces directly into your project:
-
-```ts
-import type { PlantI, NoteI } from '@la-main-verte/shared-types'
-
-const plant: PlantI = await APIResponse.json()
-```
-
-## License
-
-This package is licensed under the MIT License.
+# La Main Verte - Shared TypeScript Interfaces
+
+This package contains the TypeScript interfaces used for the front-end of La Main Verte application.
+
+## Installation
+
+To install the package, run:
+
+```bash
+
+npm install @la-main-verte/shared-types
+```
+
+## Usage
+
+You can import the interfaces directly into your project:
+
+```ts
+import type { PlantI, NoteI } from '@la-main-verte/shared-types'
+
+const plant: PlantI = await APIResponse.json()
+```
+
+## License
+
+This package is licensed under the MIT License.

package/package.json

@@ -1,16 +1,16 @@
-{
-  "name": "@la-main-verte/shared-types",
-  "version": "1.0.48",
-  "description": "Shared TypeScript interfaces for frontend of la-main-verte app",
-  "main": "src/index.js",
-  "types": "src/index.d.ts",
-  "author": "lamainverte.ca",
-  "license": "MIT",
-  "dependencies": {
-    "typescript": "^5.6.3"
-  },
-  "devDependencies": {},
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
-}
+{
+  "name": "@la-main-verte/shared-types",
+  "version": "1.0.49",
+  "description": "Shared TypeScript interfaces for frontend of la-main-verte app",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "author": "lamainverte.ca",
+  "license": "MIT",
+  "dependencies": {
+    "typescript": "^5.6.3"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/src/alert.d.ts

@@ -1,25 +1,25 @@
-export interface AlertI {
-  id: number
-  tags: AlertTagI[]
-  icon: IconName
-  /**
-   * ColourCode of the icon
-   * Ex: #ffffff
-   */
-  iconColor: string
-  message: string
-}
-
-export interface AlertTagI {
-  name: string
-  /**
-   * ColourCode of the alert tag background
-   * Ex: #ffffff
-   */
-  backgroundColor: string
-  /**
-   * ColourCode of the alert tag text
-   * Ex: #ffffff
-   */
-  textColor: string
-}
+export interface AlertI {
+  id: number
+  tags: AlertTagI[]
+  icon: IconName
+  /**
+   * ColourCode of the icon
+   * Ex: #ffffff
+   */
+  iconColor: string
+  message: string
+}
+
+export interface AlertTagI {
+  name: string
+  /**
+   * ColourCode of the alert tag background
+   * Ex: #ffffff
+   */
+  backgroundColor: string
+  /**
+   * ColourCode of the alert tag text
+   * Ex: #ffffff
+   */
+  textColor: string
+}

package/src/apiError.d.ts

@@ -1,28 +1,28 @@
-export interface ApiErrorI {
-  /**
-   * Literally describe what the server error is, ideally in the language of the user
-   */
-  error_message?: string
-  /**
-   * A string code to identify the error
-   */
-  error_type?:
-    | 'not_identified'
-    | 'invalid_request'
-    | 'subscription_required'
-    | 'internal_server_error'
-    | 'resource_already_exists'
-    | 'not_found'
-    | 'app_update_required'
-    | string
-  /**
-   * A numerical code that can be used to identify the error
-   * Ex: 401, 403, 404, 500 or L12, L13, L14
-   */
-  error_code?: string | number
-  /**
-   * A string that can be used to suggest a solution to the user
-   * Ex: "Please check your internet connection and try again."
-   */
-  error_suggestion?: string
-}
+export interface ApiErrorI {
+  /**
+   * Literally describe what the server error is, ideally in the language of the user
+   */
+  error_message?: string
+  /**
+   * A string code to identify the error
+   */
+  error_type?:
+    | 'not_identified'
+    | 'invalid_request'
+    | 'subscription_required'
+    | 'internal_server_error'
+    | 'resource_already_exists'
+    | 'not_found'
+    | 'app_update_required'
+    | string
+  /**
+   * A numerical code that can be used to identify the error
+   * Ex: 401, 403, 404, 500 or L12, L13, L14
+   */
+  error_code?: string | number
+  /**
+   * A string that can be used to suggest a solution to the user
+   * Ex: "Please check your internet connection and try again."
+   */
+  error_suggestion?: string
+}

package/src/calendarView.d.ts

@@ -1,7 +1,9 @@
-export interface CalendarViewI {
-  id: number
-  title: string
-  slug: string
-  orderBy: 'startDate' | 'name'
-  Plants: PlantI[]
-}
+import { PlantI } from './plant'
+
+export interface CalendarViewI {
+  id: number
+  title: string
+  slug: string
+  orderBy: 'startDate' | 'name'
+  Plants: PlantI[]
+}

package/src/device.d.ts

@@ -1,41 +1,41 @@
-/**
- * Raw Data returned by the device model
- * Device.toJSON() will return this data
- */
-type DeviceDataI = {
-  /** Unique identifier for the device */
-  id: string
-  /** Identifier for the user associated with the device (UUID) */
-  memberId: string
-  /** Optional push notification key */
-  pushKey?: string
-  /** Unique identifier for the device (UUID) */
-  uuid: string
-  /** RAW User agent string from the device */
-  userAgent: string
-  /** Optional platform (e.g., 'ios', 'android', 'windows') */
-  platform?: 'ios' | 'android' | 'windows'
-  /** Optional version of the device */
-  version?: string
-  /**
-   * Technical model of the device
-   * ---
-   * Ex:  iPhone12,1, iPhone13,2, iPhone14,4, etc.
-   */
-  model?: string
-  /**
-   * 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
-  /** Timestamp of when the device was created */
-  createdAt: Date
-  /** Timestamp of when the device was last updated */
-  updatedAt: Date
-  /** Virtual field that combines the name and appVersion */
-  fullName: string
-}
-export { DeviceDataI }
+/**
+ * Raw Data returned by the device model
+ * Device.toJSON() will return this data
+ */
+type DeviceDataI = {
+  /** Unique identifier for the device */
+  id: string
+  /** Identifier for the user associated with the device (UUID) */
+  memberId: string
+  /** Optional push notification key */
+  pushKey?: string
+  /** Unique identifier for the device (UUID) */
+  uuid: string
+  /** RAW User agent string from the device */
+  userAgent: string
+  /** Optional platform (e.g., 'ios', 'android', 'windows') */
+  platform?: 'ios' | 'android' | 'windows'
+  /** Optional version of the device */
+  version?: string
+  /**
+   * Technical model of the device
+   * ---
+   * Ex:  iPhone12,1, iPhone13,2, iPhone14,4, etc.
+   */
+  model?: string
+  /**
+   * 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
+  /** Timestamp of when the device was created */
+  createdAt: Date
+  /** Timestamp of when the device was last updated */
+  updatedAt: Date
+  /** Virtual field that combines the name and appVersion */
+  fullName: string
+}
+export { DeviceDataI }

package/src/gardenMap.d.ts

@@ -1,69 +1,71 @@
-/**
- * A gardenMap is a collection of garden zones
- */
-export interface GardenMapI {
-  id: number
-  memberId: number
-  GardenZones: GardenZoneI[]
-  createdAt: Date
-  updatedAt: Date
-}
-export interface GardenZoneI {
-  id: number
-  name: string | null
-  gardenMapId: number
-  widthInMeters: number
-  heightInMeters: number
-  diameterInMeters: number
-  shape: 'rectangle' | 'circle'
-  xPosition: number
-  yPosition: number | null
-  zIndex: number
-  order: number
-  totalSurfaceInSquareMeters: number
-  totalSurfaceInSquareFeet: number
-  backgroundColor: string
-  createdAt: Date
-  updatedAt: Date
-  /**
-   * Orientation virtual field ONLY USE FOR RECTANGLES
-   * --------------------------------
-   * Disregard if the shape is a circle or square. It will return 'vertical'
-   */
-  orientation: 'horizontal' | 'vertical'
-  /**
-   * NOT USED BY THE FRONTEND YET - Use GardenZoneCulture instead
-   */
-  GardenZoneCultures?: GardenZoneCultureI[]
-  /**
-   * The culture on the GardenZone
-   */
-  GardenZoneCulture?: GardenZoneCultureI
-}
-
-export interface GardenZoneCultureI {
-  id: number
-  gardenZoneId: number
-  plantSelectionId: number
-  seedQuantity: number
-  densityMode: 'dense' | 'sparse' | 'custom'
-  /**
-   * The year of the culture - do not use it yet.
-   * @deprecated Potentially a mistake to have this field here
-   */
-  yearOfCulture: number
-  PlantSelection?: PlantSelectionI
-  /**
-   * The number of alleys
-   * --------------------------------
-   * Value is computed by the backend and NOT coming from the DB.
-   */
-  numberOfAlleys?: number
-  /**
-   * The number of seeds per alley
-   * --------------------------------
-   * Value is computed by the backend and NOT coming from the DB.
-   */
-  numberOfSeedsPerAlley?: number
-  fertilizerQuantitySuggested?: string
-}
+import { PlantSelectionI } from './plantSelection.d.ts'
+
+/**
+ * A gardenMap is a collection of garden zones
+ */
+export interface GardenMapI {
+  id: number
+  memberId: number
+  GardenZones: GardenZoneI[]
+  createdAt: Date
+  updatedAt: Date
+}
+export interface GardenZoneI {
+  id: number
+  name: string | null
+  gardenMapId: number
+  widthInMeters: number
+  heightInMeters: number
+  diameterInMeters: number
+  shape: 'rectangle' | 'circle'
+  xPosition: number
+  yPosition: number | null
+  zIndex: number
+  order: number
+  totalSurfaceInSquareMeters: number
+  totalSurfaceInSquareFeet: number
+  backgroundColor: string
+  createdAt: Date
+  updatedAt: Date
+  /**
+   * Orientation virtual field ONLY USE FOR RECTANGLES
+   * --------------------------------
+   * Disregard if the shape is a circle or square. It will return 'vertical'
+   */
+  orientation: 'horizontal' | 'vertical'
+  /**
+   * NOT USED BY THE FRONTEND YET - Use GardenZoneCulture instead
+   */
+  GardenZoneCultures?: GardenZoneCultureI[]
+  /**
+   * The culture on the GardenZone
+   */
+  GardenZoneCulture?: GardenZoneCultureI
+}
+
+export interface GardenZoneCultureI {
+  id: number
+  gardenZoneId: number
+  plantSelectionId: number
+  seedQuantity: number
+  densityMode: 'dense' | 'sparse' | 'custom'
+  /**
+   * The year of the culture - do not use it yet.
+   * @deprecated Potentially a mistake to have this field here
+   */
+  yearOfCulture: number
+  PlantSelection?: PlantSelectionI
+  /**
+   * The number of alleys
+   * --------------------------------
+   * Value is computed by the backend and NOT coming from the DB.
+   */
+  numberOfAlleys?: number
+  /**
+   * The number of seeds per alley
+   * --------------------------------
+   * Value is computed by the backend and NOT coming from the DB.
+   */
+  numberOfSeedsPerAlley?: number
+  fertilizerQuantitySuggested?: string
+}

package/src/image.d.ts

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

package/src/index.ts

@@ -1,18 +1,21 @@
-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 './alert'
-export * from './image'
-import * as PlantsAPI from './plants.api'
-import * as UsersAPI from './users.api'
-
-// Allow access to the API namespaces without conflicts
-export namespace API {
-  export import PLANTS = PlantsAPI
-  export import USERS = UsersAPI
-}
+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 './alert'
+export * from './image'
+export * from './note'
+export * from './taggedItem'
+export * from './tag'
+import * as PlantsAPI from './plants.api'
+import * as UsersAPI from './users.api'
+
+// Allow access to the API namespaces without conflicts
+export namespace API {
+  export import PLANTS = PlantsAPI
+  export import USERS = UsersAPI
+}

package/src/member.d.ts

@@ -1,58 +1,61 @@
-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 like Upvoty 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 like Upvoty 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

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