@krampa/common 0.3.2 → 0.4.0

package/README.md

@@ -20,20 +20,43 @@ npm install @krampa/common
 import { GOAL_TYPES, GOAL_TYPE_VALUES, GoalType } from "@krampa/common";
 
 // Use constants
-const goalType = GOAL_TYPES.FREQUENCY_CARDIO; // "frequency/cardio"
+const goalType = GOAL_TYPES.WORKOUT_STRENGTH; // "workout/strength"
 
 // Use in TypeScript types
 const myGoal: GoalType = "weight/loss";
 
 // Use for database enum
 const dbEnum = GOAL_TYPE_VALUES; // Array of all valid goal types
+```
+
+### Challenge Status
+
+```typescript
+import { CHALLENGE_STATUSES, CHALLENGE_STATUS_VALUES, ChallengeStatus } from "@krampa/common";
+
+// Use constants
+const status = CHALLENGE_STATUSES.ONGOING; // "ONGOING"
+
+// Use in TypeScript types
+const challengeStatus: ChallengeStatus = "PENDING";
+
+// Use for database enum
+const dbEnum = CHALLENGE_STATUS_VALUES; // Array of all valid challenge statuses
+```
 
-// Type guards
-import { isCardioGoal, isWeightGoal } from "@krampa/common";
+### Invite Status
 
-if (isCardioGoal(goal.type)) {
-  // Handle cardio-specific logic
-}
+```typescript
+import { INVITE_STATUSES, INVITE_STATUS_VALUES, InviteStatus } from "@krampa/common";
+
+// Use constants
+const status = INVITE_STATUSES.ACCEPTED; // "ACCEPTED"
+
+// Use in TypeScript types
+const inviteStatus: InviteStatus = "PENDING";
+
+// Use for database enum
+const dbEnum = INVITE_STATUS_VALUES; // Array of all valid invite statuses
 ```
 
 ## Development

package/dist/goal-types.d.ts

@@ -6,7 +6,7 @@ export declare const GOAL_TYPES: {
     readonly WEIGHT_LOSS: "weight/loss";
     readonly WEIGHT_GAIN: "weight/gain";
     readonly WEIGHT_MAINTAIN: "weight/maintain";
-    readonly WORKOUT_GENERAL: "workout/general";
+    readonly WORKOUT_STRENGTH: "workout/strength";
     readonly WORKOUT_CARDIO: "workout/cardio";
     readonly WORKOUT_OTHER: "workout/other";
     readonly ACHIEVEMENT_PR: "achievement/pr";
@@ -14,5 +14,5 @@ export declare const GOAL_TYPES: {
     readonly MEASUREMENT_BODY: "measurement/body";
     readonly CUSTOM_OTHER: "custom/other";
 };
-export declare const GOAL_TYPE_VALUES: readonly ["weight/loss", "weight/gain", "weight/maintain", "workout/general", "workout/cardio", "workout/other", "achievement/pr", "steps/daily", "measurement/body", "custom/other"];
+export declare const GOAL_TYPE_VALUES: readonly ["weight/loss", "weight/gain", "weight/maintain", "workout/strength", "workout/cardio", "workout/other", "achievement/pr", "steps/daily", "measurement/body", "custom/other"];
 export type GoalType = (typeof GOAL_TYPE_VALUES)[number];

package/dist/goal-types.js

@@ -12,7 +12,7 @@ exports.GOAL_TYPES = {
     WEIGHT_GAIN: "weight/gain",
     WEIGHT_MAINTAIN: "weight/maintain",
     // Workout goals (distance/time embedded in cardio)
-    WORKOUT_GENERAL: "workout/general",
+    WORKOUT_STRENGTH: "workout/strength",
     WORKOUT_CARDIO: "workout/cardio",
     WORKOUT_OTHER: "workout/other",
     // Achievement goals
@@ -27,7 +27,7 @@ exports.GOAL_TYPE_VALUES = [
     exports.GOAL_TYPES.WEIGHT_LOSS,
     exports.GOAL_TYPES.WEIGHT_GAIN,
     exports.GOAL_TYPES.WEIGHT_MAINTAIN,
-    exports.GOAL_TYPES.WORKOUT_GENERAL,
+    exports.GOAL_TYPES.WORKOUT_STRENGTH,
     exports.GOAL_TYPES.WORKOUT_CARDIO,
     exports.GOAL_TYPES.WORKOUT_OTHER,
     exports.GOAL_TYPES.ACHIEVEMENT_PR,

package/dist/goal-value-types.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Goal value type definitions
+ * Shared between frontend and backend for type safety
+ */
+export type WeightChange = {
+    startWeight: number;
+    targetWeight: number;
+};
+export type WeightMaintain = {
+    targetWeight: number;
+};
+export type WorkoutCardioValue = {
+    activityName: string;
+    weeklyTarget: number;
+    weeklyDistance?: number;
+    weeklyTime?: number;
+};
+export type WorkoutOtherValue = {
+    activityName: string;
+    weeklyTarget: number;
+};
+export type WorkoutStrengthValue = {
+    weeklyTarget: number;
+    workoutTypes: string[];
+};
+export type StepsGoalValue = {
+    targetSteps: number;
+};
+type BaseGoal = {};
+export type WeightLossGoal = BaseGoal & {
+    type: "weight/loss";
+    value: WeightChange;
+};
+export type WeightGainGoal = BaseGoal & {
+    type: "weight/gain";
+    value: WeightChange;
+};
+export type WeightMaintainGoal = BaseGoal & {
+    type: "weight/maintain";
+    value: WeightMaintain;
+};
+export type WorkoutStrengthGoal = BaseGoal & {
+    type: "workout/strength";
+    value: WorkoutStrengthValue;
+};
+export type WorkoutCardioGoal = BaseGoal & {
+    type: "workout/cardio";
+    value: WorkoutCardioValue;
+};
+export type WorkoutOtherGoal = BaseGoal & {
+    type: "workout/other";
+    value: WorkoutOtherValue;
+};
+export type StepsGoal = BaseGoal & {
+    type: "steps/daily";
+    value: StepsGoalValue;
+};
+export type Goal = WeightLossGoal | WeightGainGoal | WeightMaintainGoal | WorkoutStrengthGoal | WorkoutCardioGoal | WorkoutOtherGoal | StepsGoal;
+export {};

package/dist/goal-value-types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Goal value type definitions
+ * Shared between frontend and backend for type safety
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -3,5 +3,6 @@
  * Shared types and constants
  */
 export * from "./goal-types";
+export * from "./goal-value-types";
 export * from "./invite-status";
 export * from "./challenge-status";

package/dist/index.js

@@ -19,5 +19,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./goal-types"), exports);
+__exportStar(require("./goal-value-types"), exports);
 __exportStar(require("./invite-status"), exports);
 __exportStar(require("./challenge-status"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@krampa/common",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Shared types and constants for Krampa fitness challenge app",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",