@plus45/types 1.1.23 → 1.1.24

package/README.md

@@ -1,23 +1,23 @@
-# Plus45-Types
-
-This is a type library so that common types may be shared and maintained between the frontend and backend. The types are stored in the `/types` directory.
-
-# Publishing
-
-After updating types, you can push the changes by first going to `package.json` and incrementing the version number. Then, in the `plus45-types` directory, run this command:
-
-```bash
-npm publish
-```
-
-Make sure to push changes to the plus45-types directory to main when updating.
-
-\*\*If you get an error that says "This command requires you to be logged in," you must be a member of the Plus45 organization. You can sign into your npm account by typing `npm login`, press enter, then follow the steps to log in. You should now be able to publish.
-
-# Updating Packages
-
-If a new update is published for the @plus45/types package, you must manually update and install the new packages. You can do so by entering this in the `root` directory (you may also filter this to the frontend or backend):
-
-```bash
-pnpm update-types
-```
+# Plus45-Types
+
+This is a type library so that common types may be shared and maintained between the frontend and backend. The types are stored in the `/types` directory.
+
+# Publishing
+
+After updating types, you can push the changes by first going to `package.json` and incrementing the version number. Then, in the `plus45-types` directory, run this command:
+
+```bash
+npm publish
+```
+
+Make sure to push changes to the plus45-types directory to main when updating.
+
+\*\*If you get an error that says "This command requires you to be logged in," you must be a member of the Plus45 organization. You can sign into your npm account by typing `npm login`, press enter, then follow the steps to log in. You should now be able to publish.
+
+# Updating Packages
+
+If a new update is published for the @plus45/types package, you must manually update and install the new packages. You can do so by entering this in the `root` directory (you may also filter this to the frontend or backend):
+
+```bash
+pnpm update-types
+```

package/index.ts

@@ -1,42 +1,44 @@
-import { Exercise } from "./types/exercise/exercise";
-import ExerciseType from "./types/exercise/exercise_types";
-import { AccessToken } from "./types/user/access_token";
-import { User } from "./types/user/user";
-import {
-   DistanceUnits,
-   ExerciseUnit,
-   TimeUnits,
-   WeightUnits
-} from "./types/exercise/exercise_units";
-import { Workout } from "./types/workout/workout";
-import { Schedule } from "./types/schedule/schedule";
-import { ScheduleDay } from "./types/schedule/schedule_days";
-import { ScheduleRecurrence } from "./types/schedule/schedule_recurrence";
-import { UserSessionInfo } from "./types/user/session_info";
-
-export {
-   // User Type Structures
-   type User,
-   type UserSessionInfo,
-
-   // Exercise Type Structures
-   type Exercise,
-   type AccessToken,
-
-   // Workout Type Structures
-   type Workout,
-
-   // Schedule Type Structures
-   type Schedule,
-
-   // Enums
-   ExerciseType,
-   ExerciseUnit,
-   ScheduleDay,
-   ScheduleRecurrence,
-
-   // Collections
-   WeightUnits,
-   DistanceUnits,
-   TimeUnits
-};
+import { Exercise } from "./types/exercise/exercise";
+import ExerciseType from "./types/exercise/exercise_types";
+import { AccessToken } from "./types/user/access_token";
+import { User } from "./types/user/user";
+import {
+   DistanceUnits,
+   ExerciseUnit,
+   TimeUnits,
+   WeightUnits
+} from "./types/exercise/exercise_units";
+import { Workout } from "./types/workout/workout";
+import { Schedule } from "./types/schedule/schedule";
+import { ScheduleDay } from "./types/schedule/schedule_days";
+import { ScheduleRecurrence } from "./types/schedule/schedule_recurrence";
+import { UserSessionInfo } from "./types/user/session_info";
+import { ExerciseExecution } from "./types/exercise-executions/exercise_execution";
+
+export {
+   // User Type Structures
+   type User,
+   type UserSessionInfo,
+   type AccessToken,
+
+   // Exercise Type Structures
+   type Exercise,
+   type ExerciseExecution,
+
+   // Workout Type Structures
+   type Workout,
+
+   // Schedule Type Structures
+   type Schedule,
+
+   // Enums
+   ExerciseType,
+   ExerciseUnit,
+   ScheduleDay,
+   ScheduleRecurrence,
+
+   // Collections
+   WeightUnits,
+   DistanceUnits,
+   TimeUnits
+};

package/package.json

@@ -1,6 +1,6 @@
-{
-   "name": "@plus45/types",
-   "version": "1.1.23",
-   "main": "index.ts",
-   "types": "index.ts"
-}
+{
+   "name": "@plus45/types",
+   "version": "1.1.24",
+   "main": "index.ts",
+   "types": "index.ts"
+}

package/types/exercise/exercise.ts

@@ -1,16 +1,16 @@
-import ExerciseType from "./exercise_types";
-import { ExerciseUnit } from "./exercise_units";
-
-export type Exercise = {
-   id: string;
-   name: string;
-   created_by: string;
-   type: ExerciseType;
-   description?: string;
-   sets?: number;
-   reps?: number;
-   value?: number;
-   value_unit?: ExerciseUnit;
-   created_at: Date;
-   deleted?: boolean;
-};
+import ExerciseType from "./exercise_types";
+import { ExerciseUnit } from "./exercise_units";
+
+export type Exercise = {
+   id: string;
+   name: string;
+   created_by: string;
+   type: ExerciseType;
+   description?: string;
+   sets?: number;
+   reps?: number;
+   value?: number;
+   value_unit?: ExerciseUnit;
+   created_at: Date;
+   deleted?: boolean;
+};

package/types/exercise/exercise_types.ts

@@ -1,26 +1,26 @@
-/**
- * Enum for different types of exercises.
- */
-enum ExerciseType {
-   /**
-    * Sets-Reps based exercise (e.g. 3x10)
-    */
-   STRENGTH = "STRENGTH",
-
-   /**
-    * Time based exercise (e.g. 3x30s)
-    */
-   TIME = "TIME",
-
-   /**
-    * Distance based exercise (e.g. 3x400m)
-    */
-   DISTANCE = "DISTANCE",
-
-   /**
-    * Custom exercise (uses string as data)
-    */
-   CUSTOM = "CUSTOM"
-}
-
-export default ExerciseType;
+/**
+ * Enum for different types of exercises.
+ */
+enum ExerciseType {
+   /**
+    * Sets-Reps based exercise (e.g. 3x10)
+    */
+   STRENGTH = "STRENGTH",
+
+   /**
+    * Time based exercise (e.g. 3x30s)
+    */
+   TIME = "TIME",
+
+   /**
+    * Distance based exercise (e.g. 3x400m)
+    */
+   DISTANCE = "DISTANCE",
+
+   /**
+    * Custom exercise (uses string as data)
+    */
+   CUSTOM = "CUSTOM"
+}
+
+export default ExerciseType;

package/types/exercise/exercise_units.ts

@@ -1,28 +1,28 @@
-export enum ExerciseUnit {
-   // Time
-   seconds = "SECONDS",
-   minutes = "MINUTES",
-
-   // Weight
-   pounds = "POUNDS",
-   kilograms = "KILOGRAMS",
-
-   // Distance
-   miles = "MILES",
-   kilometers = "KILOMETERS",
-   yards = "YARDS",
-   feet = "FEET",
-   meters = "METERS"
-}
-
-export const WeightUnits = [ExerciseUnit.pounds, ExerciseUnit.kilograms];
-
-export const TimeUnits = [ExerciseUnit.seconds, ExerciseUnit.minutes];
-
-export const DistanceUnits = [
-   ExerciseUnit.miles,
-   ExerciseUnit.kilometers,
-   ExerciseUnit.yards,
-   ExerciseUnit.feet,
-   ExerciseUnit.meters
-];
+export enum ExerciseUnit {
+   // Time
+   seconds = "SECONDS",
+   minutes = "MINUTES",
+
+   // Weight
+   pounds = "POUNDS",
+   kilograms = "KILOGRAMS",
+
+   // Distance
+   miles = "MILES",
+   kilometers = "KILOMETERS",
+   yards = "YARDS",
+   feet = "FEET",
+   meters = "METERS"
+}
+
+export const WeightUnits = [ExerciseUnit.pounds, ExerciseUnit.kilograms];
+
+export const TimeUnits = [ExerciseUnit.seconds, ExerciseUnit.minutes];
+
+export const DistanceUnits = [
+   ExerciseUnit.miles,
+   ExerciseUnit.kilometers,
+   ExerciseUnit.yards,
+   ExerciseUnit.feet,
+   ExerciseUnit.meters
+];

package/types/exercise-executions/exercise_execution.ts

@@ -0,0 +1,9 @@
+import { Exercise } from "../exercise/exercise";
+import { ExerciseUnit } from "../exercise/exercise_units";
+
+export type ExerciseExecution = {
+   completed?: boolean;
+   submittedValue?: number;
+   submittedUnit?: ExerciseUnit;
+   executedBy?: string; // User ID
+} & Exercise;

package/types/schedule/schedule.ts

@@ -1,11 +1,11 @@
-export type Schedule = {
-   id: string;
-   user_id: string;
-   workout_id: string;
-   days_of_week: number[];
-   start_time: string | null;
-   recurrence: number;
-   created_at: string;
-   start_week: number;
-   start_year: number;
-};
+export type Schedule = {
+   id: string;
+   user_id: string;
+   workout_id: string;
+   days_of_week: number[];
+   start_time: string | null;
+   recurrence: number;
+   created_at: string;
+   start_week: number;
+   start_year: number;
+};

package/types/schedule/schedule_days.ts

@@ -1,9 +1,9 @@
-export enum ScheduleDay {
-   "SUNDAY" = 0,
-   "MONDAY" = 1,
-   "TUESDAY" = 2,
-   "WEDNESDAY" = 3,
-   "THURSDAY" = 4,
-   "FRIDAY" = 5,
-   "SATURDAY" = 6
-}
+export enum ScheduleDay {
+   "SUNDAY" = 0,
+   "MONDAY" = 1,
+   "TUESDAY" = 2,
+   "WEDNESDAY" = 3,
+   "THURSDAY" = 4,
+   "FRIDAY" = 5,
+   "SATURDAY" = 6
+}

package/types/schedule/schedule_recurrence.ts

@@ -1,4 +1,4 @@
-export enum ScheduleRecurrence {
-   Weekly = "WEEKLY",
-   BIWEEKLY = "BIWEEKLY"
-}
+export enum ScheduleRecurrence {
+   Weekly = "WEEKLY",
+   BIWEEKLY = "BIWEEKLY"
+}

package/types/user/access_token.ts

@@ -1,12 +1,12 @@
-export type AccessToken = {
-   id: string;
-   user_id: string;
-   hashed_token: string;
-   expires_at: Date;
-   user_agent: string;
-   ip_address: string;
-   platform?: string;
-   language?: string;
-   location?: string;
-   created_at: Date;
-};
+export type AccessToken = {
+   id: string;
+   user_id: string;
+   hashed_token: string;
+   expires_at: Date;
+   user_agent: string;
+   ip_address: string;
+   platform?: string;
+   language?: string;
+   location?: string;
+   created_at: Date;
+};

package/types/user/session_info.ts

@@ -1,6 +1,6 @@
-export type UserSessionInfo = {
-   userAgent: string;
-   platform: string;
-   language: string;
-   ipAddress?: string;
-};
+export type UserSessionInfo = {
+   userAgent: string;
+   platform: string;
+   language: string;
+   ipAddress?: string;
+};

package/types/user/user.ts

@@ -1,11 +1,11 @@
-export type User = {
-   id: string;
-   first_name: string;
-   last_name: string;
-   username: string;
-   email: string;
-   lang: string;
-   created_at: string;
-   theme_mode: string;
-   theme_color: "light" | "dark";
-};
+export type User = {
+   id: string;
+   first_name: string;
+   last_name: string;
+   username: string;
+   email: string;
+   lang: string;
+   created_at: string;
+   theme_mode: string;
+   theme_color: "light" | "dark";
+};

package/types/workout/workout.ts

@@ -1,9 +1,9 @@
-import { Exercise } from "../exercise/exercise";
-
-export type Workout = {
-   id: string;
-   name: string;
-   created_by: string;
-   exercises: Exercise[];
-   created_at: Date;
-};
+import { type Exercise } from "../exercise/exercise";
+
+export type Workout = {
+   id: string;
+   name: string;
+   created_by: string;
+   exercises: Exercise[];
+   created_at: Date;
+};