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

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.55",
-  "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.57",
+  "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,124 +1,124 @@
-export type IconNameI =
-  | 'arrow-down'
-  | 'arrow-down-a-z'
-  | 'arrow-up-a-z'
-  | 'arrow-left'
-  | 'arrow-up'
-  | 'arrow-up-short-wide'
-  | 'arrow-up-91'
-  | 'arrow-down-91'
-  | 'arrow-up-square-triangle'
-  | 'arrow-down-square-triangle'
-  | 'arrow-up-big-small'
-  | 'arrow-down-big-small'
-  | 'bag-seedling'
-  | 'bars'
-  | 'bell'
-  | 'broom-wide'
-  | 'bug'
-  | 'calendar-check'
-  | 'calendar-day'
-  | 'calendar-days'
-  | 'calendar-minus'
-  | 'calendar-pen'
-  | 'calendar-plus'
-  | 'camera'
-  | 'chart-pie'
-  | 'chart-tree-map'
-  | 'check'
-  | 'chevron-down'
-  | 'chevron-left'
-  | 'chevron-right'
-  | 'circle-question'
-  | 'city'
-  | 'cog'
-  | 'comment'
-  | 'comment-dots'
-  | 'comments-question-check'
-  | 'copy'
-  | 'columns-3'
-  | 'distribute-spacing-horizontal'
-  | 'distribute-spacing-vertical'
-  | 'envelope'
-  | 'eye'
-  | 'eye-slash'
-  | 'filter-circle-xmark'
-  | 'filter-list'
-  | 'flask'
-  | 'gear'
-  | 'heart'
-  | 'home'
-  | 'hand-back-point-up'
-  | 'house-chimney-heart'
-  | 'image'
-  | 'info'
-  | 'keyboard'
-  | 'lightbulb-on'
-  | 'lightbulb'
-  | 'lock'
-  | 'lock-open'
-  | 'messages-question'
-  | 'microphone'
-  | 'minus'
-  | 'note-medical'
-  | 'note-sticky'
-  | 'pencil'
-  | 'plus'
-  | 'pen-ruler'
-  | 'podcast'
-  | 'rotate'
-  | 'ruler'
-  | 'scissors'
-  | 'satellite-dish'
-  | 'search'
-  | 'seedling'
-  | 'sign-in-alt'
-  | 'sign-out-alt'
-  | 'share'
-  | 'shovel'
-  | 'snowflake'
-  | 'star'
-  | 'sun-bright'
-  | 'temperature-snow'
-  | 'thumbs-up'
-  | 'tomato'
-  | 'times'
-  | 'trash'
-  | 'trowel'
-  | 'user-plus'
-  | 'user-slash'
-  | 'wand-sparkles'
-  | 'wheat'
-  | 'x'
-  | string
-
-export interface AlertI {
-  id: number
-  tags?: AlertTagI[]
-  icon: IconNameI
-  /**
-   * ColourCode of the icon
-   * Ex: #ffffff
-   */
-  iconColor: string
-  message: string
-  published_at?: Date
-  updated_at?: Date
-  status?: 'draft' | 'published'
-}
-
-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 type AlertV14I = AlertI
+export type IconNameI =
+  | 'arrow-down'
+  | 'arrow-down-a-z'
+  | 'arrow-up-a-z'
+  | 'arrow-left'
+  | 'arrow-up'
+  | 'arrow-up-short-wide'
+  | 'arrow-up-91'
+  | 'arrow-down-91'
+  | 'arrow-up-square-triangle'
+  | 'arrow-down-square-triangle'
+  | 'arrow-up-big-small'
+  | 'arrow-down-big-small'
+  | 'bag-seedling'
+  | 'bars'
+  | 'bell'
+  | 'broom-wide'
+  | 'bug'
+  | 'calendar-check'
+  | 'calendar-day'
+  | 'calendar-days'
+  | 'calendar-minus'
+  | 'calendar-pen'
+  | 'calendar-plus'
+  | 'camera'
+  | 'chart-pie'
+  | 'chart-tree-map'
+  | 'check'
+  | 'chevron-down'
+  | 'chevron-left'
+  | 'chevron-right'
+  | 'circle-question'
+  | 'city'
+  | 'cog'
+  | 'comment'
+  | 'comment-dots'
+  | 'comments-question-check'
+  | 'copy'
+  | 'columns-3'
+  | 'distribute-spacing-horizontal'
+  | 'distribute-spacing-vertical'
+  | 'envelope'
+  | 'eye'
+  | 'eye-slash'
+  | 'filter-circle-xmark'
+  | 'filter-list'
+  | 'flask'
+  | 'gear'
+  | 'heart'
+  | 'home'
+  | 'hand-back-point-up'
+  | 'house-chimney-heart'
+  | 'image'
+  | 'info'
+  | 'keyboard'
+  | 'lightbulb-on'
+  | 'lightbulb'
+  | 'lock'
+  | 'lock-open'
+  | 'messages-question'
+  | 'microphone'
+  | 'minus'
+  | 'note-medical'
+  | 'note-sticky'
+  | 'pencil'
+  | 'plus'
+  | 'pen-ruler'
+  | 'podcast'
+  | 'rotate'
+  | 'ruler'
+  | 'scissors'
+  | 'satellite-dish'
+  | 'search'
+  | 'seedling'
+  | 'sign-in-alt'
+  | 'sign-out-alt'
+  | 'share'
+  | 'shovel'
+  | 'snowflake'
+  | 'star'
+  | 'sun-bright'
+  | 'temperature-snow'
+  | 'thumbs-up'
+  | 'tomato'
+  | 'times'
+  | 'trash'
+  | 'trowel'
+  | 'user-plus'
+  | 'user-slash'
+  | 'wand-sparkles'
+  | 'wheat'
+  | 'x'
+  | string
+
+export interface AlertI {
+  id: number
+  tags?: AlertTagI[]
+  icon: IconNameI
+  /**
+   * ColourCode of the icon
+   * Ex: #ffffff
+   */
+  iconColor: string
+  message: string
+  published_at?: Date
+  updated_at?: Date
+  status?: 'draft' | 'published'
+}
+
+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 type AlertV14I = AlertI

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,9 +1,9 @@
-import { PlantI } from './plant'
-
-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,52 +1,52 @@
-/**
- * Raw Data returned by the device model
- * Device.toJSON() will return this data
- */
-export interface DeviceDataI {
-  /** Unique identifier for the device */
-  id: string
-  /** Identifier for the user associated with the device (UUID) */
-  memberId: string
-  /** Expo Push Notification Key */
-  pushKey?: string
-  /** Apple Push Notification Service Token */
-  apnsToken?: string
-  /** Firebase (Android) Cloud Messaging Token */
-  fcmToken?: string
-  /** Unique identifier for the device (UUID) */
-  uuid: string
-  /** RAW User agent string from the device */
-  userAgent?: string
-  /** Optional platform (e.g., 'ios', 'android', 'web') */
-  platform?: 'ios' | 'android' | 'web'
-  /** 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
-  /** Web Push endpoint associated with the device */
-  webPushEndpoint?: string
-  /** Web Push user public key */
-  webPushP256dh?: string
-  /** Web Push auth secret */
-  webPushAuth?: string
-  /** Web Push subscription payload */
-  webPushSubscription?: 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
-}
+/**
+ * Raw Data returned by the device model
+ * Device.toJSON() will return this data
+ */
+export interface DeviceDataI {
+  /** Unique identifier for the device */
+  id: string
+  /** Identifier for the user associated with the device (UUID) */
+  memberId: string
+  /** Expo Push Notification Key */
+  pushKey?: string
+  /** Apple Push Notification Service Token */
+  apnsToken?: string
+  /** Firebase (Android) Cloud Messaging Token */
+  fcmToken?: string
+  /** Unique identifier for the device (UUID) */
+  uuid: string
+  /** RAW User agent string from the device */
+  userAgent?: string
+  /** Optional platform (e.g., 'ios', 'android', 'web') */
+  platform?: 'ios' | 'android' | 'web'
+  /** 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
+  /** Web Push endpoint associated with the device */
+  webPushEndpoint?: string
+  /** Web Push user public key */
+  webPushP256dh?: string
+  /** Web Push auth secret */
+  webPushAuth?: string
+  /** Web Push subscription payload */
+  webPushSubscription?: 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
+}

package/src/fertilizer.d.ts

@@ -1,20 +1,20 @@
-export interface FertilizerI {
-  id: number
-  name: string
-  slug: string
-  azotePercentage: number
-  phosphorePercentage: number
-  potassiumPercentage: number
-  /**
-   * The real azote percentage is the azote percentage multiplied by the azote efficiency.
-   */
-  realAzotePercentage: number
-  /**
-   * The azote efficiency is a percentage number between 0 and 1.
-   * Its how efficient the mineralization of the azote is.
-   */
-  azoteEfficiency: number
-  imageLocation: string
-  imageURL: string
-  quantitySuggested: string
-}
+export interface FertilizerI {
+  id: number
+  name: string
+  slug: string
+  azotePercentage: number
+  phosphorePercentage: number
+  potassiumPercentage: number
+  /**
+   * The real azote percentage is the azote percentage multiplied by the azote efficiency.
+   */
+  realAzotePercentage: number
+  /**
+   * The azote efficiency is a percentage number between 0 and 1.
+   * Its how efficient the mineralization of the azote is.
+   */
+  azoteEfficiency: number
+  imageLocation: string
+  imageURL: string
+  quantitySuggested: string
+}