@umituz/react-native-gamification 1.2.0 → 1.3.0

package/src/domain/entities/Leaderboard.ts

@@ -1,101 +0,0 @@
-/**
- * Leaderboard Entity
- * 
- * Represents leaderboard entries in the gamification system
- */
-
-export interface LeaderboardEntry {
-  id: string;
-  userId: string;
-  leaderboardId: string; // Leaderboard identifier (e.g., "global", "weekly", "monthly")
-  rank: number; // Current rank (1-based)
-  score: number; // Score for ranking
-  metric: string; // Metric used for ranking (e.g., "points", "experience", "streak")
-  displayName?: string; // User's display name
-  avatar?: string; // User's avatar URL
-  metadata?: Record<string, any>;
-  period?: "daily" | "weekly" | "monthly" | "all-time"; // Time period for leaderboard
-  periodStart?: string; // Start date of the period
-  periodEnd?: string; // End date of the period
-  createdDate: string;
-  updatedDate: string;
-}
-
-export interface Leaderboard {
-  id: string;
-  name: string;
-  description?: string;
-  metric: string; // Metric used for ranking
-  period?: "daily" | "weekly" | "monthly" | "all-time";
-  periodStart?: string;
-  periodEnd?: string;
-  entries: LeaderboardEntry[];
-  totalParticipants: number;
-  lastUpdated: string;
-}
-
-export interface LeaderboardRanking {
-  userId: string;
-  rank: number;
-  score: number;
-  percentile: number; // Percentile rank (0-100)
-  aboveUsers: number; // Number of users above
-  belowUsers: number; // Number of users below
-}
-
-export type LeaderboardCategory = 'points' | 'achievements' | 'streaks' | 'activity';
-
-/**
- * Factory function to create leaderboard entry
- */
-export function createLeaderboardEntry(
-  props: Omit<LeaderboardEntry, 'id' | 'createdDate' | 'updatedDate' | 'change'> & { previousRank?: number }
-): LeaderboardEntry {
-  const now = new Date().toISOString();
-  const change = props.previousRank ? props.previousRank - props.rank : 0;
-  
-  return {
-    ...props,
-    id: `entry-${Date.now()}-${Math.random().toString(36).substring(7)}`,
-    createdDate: now,
-    updatedDate: now,
-    metadata: {
-      ...props.metadata,
-      change,
-    },
-  };
-}
-
-/**
- * Calculate rank change indicator
- */
-export function getRankChangeIndicator(change: number): '↑' | '↓' | '=' {
-  if (change > 0) return '↑'; // Improved (moved up)
-  if (change < 0) return '↓'; // Declined (moved down)
-  return '='; // No change
-}
-
-/**
- * Get top N entries from leaderboard
- */
-export function getTopEntries(
-  leaderboard: Leaderboard,
-  limit: number = 10
-): LeaderboardEntry[] {
-  return leaderboard.entries
-    .sort((a, b) => a.rank - b.rank)
-    .slice(0, limit);
-}
-
-/**
- * Find user's position in leaderboard
- */
-export function findUserRank(
-  leaderboard: Leaderboard,
-  userId: string
-): LeaderboardEntry | null {
-  return leaderboard.entries.find((entry) => entry.userId === userId) || null;
-}
-
-
-

package/src/domain/entities/Level.ts

@@ -1,40 +0,0 @@
-/**
- * Level Entity
- * 
- * Represents user levels in the gamification system
- */
-
-export interface Level {
-  id: string;
-  userId: string;
-  currentLevel: number;
-  currentExperience: number; // Current XP in current level
-  totalExperience: number; // Total XP accumulated
-  experienceToNextLevel: number; // XP needed for next level
-  levelProgress: number; // Percentage progress in current level (0-100)
-  metadata?: Record<string, any>;
-  createdDate: string;
-  updatedDate: string;
-}
-
-export interface LevelDefinition {
-  level: number;
-  experienceRequired: number; // Total XP required to reach this level
-  title?: string;
-  description?: string;
-  rewards?: string[]; // Reward IDs or types
-  metadata?: Record<string, any>;
-}
-
-export interface LevelProgress {
-  userId: string;
-  currentLevel: number;
-  currentExperience: number;
-  totalExperience: number;
-  experienceToNextLevel: number;
-  levelProgress: number;
-  canLevelUp: boolean;
-}
-
-
-

package/src/domain/entities/Point.ts

@@ -1,40 +0,0 @@
-/**
- * Point Entity
- * 
- * Represents points in the gamification system
- */
-
-export interface Point {
-  id: string;
-  userId: string;
-  amount: number;
-  source: string; // Source of points (e.g., "achievement", "action", "reward")
-  sourceId?: string; // ID of the source (e.g., achievement ID)
-  category?: string; // Category for grouping points
-  description?: string;
-  metadata?: Record<string, any>;
-  createdDate: string;
-}
-
-export interface PointBalance {
-  userId: string;
-  total: number;
-  byCategory: Record<string, number>; // Points grouped by category
-  lastUpdated: string;
-}
-
-export interface PointTransaction {
-  id: string;
-  userId: string;
-  amount: number; // Can be negative for deductions
-  source: string;
-  sourceId?: string;
-  category?: string;
-  description?: string;
-  balance: number; // Balance after this transaction
-  metadata?: Record<string, any>;
-  createdDate: string;
-}
-
-
-

package/src/domain/entities/Progress.ts

@@ -1,43 +0,0 @@
-/**
- * Progress Entity
- * 
- * Represents user progress tracking in the gamification system
- */
-
-export interface Progress {
-  id: string;
-  userId: string;
-  metric: string; // Metric identifier (e.g., "goals_completed", "sessions_attended")
-  currentValue: number; // Current value
-  targetValue?: number; // Target value (optional)
-  progress: number; // Percentage progress (0-100)
-  unit?: string; // Unit of measurement (e.g., "times", "hours", "days")
-  category?: string; // Category for grouping
-  period?: "daily" | "weekly" | "monthly" | "all-time"; // Time period
-  periodStart?: string; // Start date of the period
-  periodEnd?: string; // End date of the period
-  metadata?: Record<string, any>;
-  createdDate: string;
-  updatedDate: string;
-}
-
-export interface ProgressUpdate {
-  userId: string;
-  metric: string;
-  increment: number; // Amount to increment
-  category?: string;
-  period?: "daily" | "weekly" | "monthly" | "all-time";
-  metadata?: Record<string, any>;
-}
-
-export interface ProgressMilestone {
-  metric: string;
-  value: number;
-  title: string;
-  description?: string;
-  reward?: string; // Reward ID or type
-  metadata?: Record<string, any>;
-}
-
-
-

package/src/domain/entities/Reward.ts

@@ -1,131 +0,0 @@
-/**
- * Reward Entity
- * 
- * Represents rewards in the gamification system
- */
-
-import type { PointTransaction } from './Point';
-
-export interface Reward {
-  id: string;
-  userId: string;
-  type: string; // Reward type (e.g., "badge", "unlock", "discount", "item")
-  title: string;
-  description?: string;
-  icon?: string;
-  category?: string;
-  pointsCost?: number; // Points required to claim
-  levelRequired?: number; // Level required to claim
-  unlocked: boolean;
-  unlockedDate?: string;
-  claimed: boolean;
-  claimedDate?: string;
-  expiresAt?: string; // Expiration date for time-limited rewards
-  metadata?: Record<string, any>;
-  createdDate: string;
-  updatedDate: string;
-}
-
-export interface RewardDefinition {
-  type: string;
-  title: string;
-  description?: string;
-  icon?: string;
-  category?: string;
-  pointsCost?: number;
-  levelRequired?: number;
-  rarity?: "common" | "rare" | "epic" | "legendary";
-  expiresAt?: string;
-  metadata?: Record<string, any>;
-}
-
-export interface RewardClaim {
-  id: string;
-  userId: string;
-  rewardId: string;
-  pointsSpent?: number;
-  claimedDate: string;
-  metadata?: Record<string, any>;
-}
-
-export type RewardRarity = 'common' | 'uncommon' | 'rare' | 'epic' | 'legendary';
-
-/**
- * Factory function to create reward
- */
-export function createReward(
-  props: Omit<Reward, 'id' | 'unlocked' | 'claimed' | 'createdDate' | 'updatedDate'>
-): Reward {
-  const now = new Date().toISOString();
-  return {
-    ...props,
-    id: `reward-${Date.now()}-${Math.random().toString(36).substring(7)}`,
-    unlocked: false,
-    claimed: false,
-    createdDate: now,
-    updatedDate: now,
-  };
-}
-
-/**
- * Factory function to create points transaction
- */
-export function createPointsTransaction(
-  userId: string,
-  amount: number,
-  type: 'earn' | 'spend' | 'bonus',
-  source: string,
-  description: string
-): PointTransaction {
-  const now = new Date().toISOString();
-  return {
-    id: `transaction-${Date.now()}-${Math.random().toString(36).substring(7)}`,
-    userId,
-    amount: type === 'spend' ? -Math.abs(amount) : Math.abs(amount),
-    source,
-    description,
-    balance: 0, // Will be calculated by repository
-    createdDate: now,
-  };
-}
-
-/**
- * Calculate user level from total experience/points
- */
-export function calculateLevel(totalPoints: number): number {
-  // Simple level formula: level = floor(sqrt(points / 100))
-  return Math.floor(Math.sqrt(totalPoints / 100));
-}
-
-/**
- * Calculate points needed for next level
- */
-export function calculateNextLevelPoints(currentLevel: number): number {
-  const nextLevel = currentLevel + 1;
-  return Math.pow(nextLevel, 2) * 100;
-}
-
-/**
- * Check if reward is expired
- */
-export function isRewardExpired(reward: Reward): boolean {
-  if (!reward.expiresAt) return false;
-  return new Date() > new Date(reward.expiresAt);
-}
-
-/**
- * Get points value for rarity
- */
-export function getPointsForRarity(rarity: RewardRarity): number {
-  const pointsMap: Record<RewardRarity, number> = {
-    common: 50,
-    uncommon: 100,
-    rare: 250,
-    epic: 500,
-    legendary: 1000,
-  };
-  return pointsMap[rarity];
-}
-
-
-

package/src/domain/entities/Streak.ts

@@ -1,154 +0,0 @@
-/**
- * Streak Entity
- * 
- * Represents user streaks in the gamification system
- */
-
-export interface Streak {
-  id: string;
-  userId: string;
-  type: string; // Streak type (e.g., "daily_login", "daily_goal", "weekly_workout")
-  currentStreak: number; // Current consecutive days/actions
-  longestStreak: number; // Longest streak ever achieved
-  lastActivityDate: string; // Last date when streak was maintained
-  isActive: boolean; // Whether streak is currently active
-  metadata?: Record<string, any>;
-  createdDate: string;
-  updatedDate: string;
-}
-
-export interface StreakDefinition {
-  type: string;
-  name: string;
-  description?: string;
-  resetOnMiss: boolean; // Whether streak resets if missed
-  timezone?: string; // Timezone for daily streaks
-  metadata?: Record<string, any>;
-}
-
-export interface StreakProgress {
-  userId: string;
-  type: string;
-  currentStreak: number;
-  longestStreak: number;
-  isActive: boolean;
-  daysUntilMilestone?: number; // Days until next milestone (7, 30, 100, etc.)
-  nextMilestone?: number; // Next milestone value
-}
-
-export interface StreakMilestone {
-  days: number;
-  name: string;
-  reward: number; // Points awarded
-  achieved: boolean;
-}
-
-/**
- * Factory function to create streak entity
- */
-export function createStreakEntity(userId: string, type: string): Streak {
-  const now = new Date().toISOString();
-  return {
-    id: `streak-${Date.now()}-${Math.random().toString(36).substring(7)}`,
-    userId,
-    type,
-    currentStreak: 0,
-    longestStreak: 0,
-    lastActivityDate: now,
-    isActive: false,
-    createdDate: now,
-    updatedDate: now,
-  };
-}
-
-/**
- * Check if streak should continue (activity within last 24 hours)
- */
-export function isStreakActive(streak: Streak): boolean {
-  const now = new Date();
-  const lastActivity = new Date(streak.lastActivityDate);
-  const hoursSinceLastActivity = (now.getTime() - lastActivity.getTime()) / (1000 * 60 * 60);
-
-  return hoursSinceLastActivity <= 24;
-}
-
-/**
- * Check if streak is broken (no activity for more than 48 hours)
- */
-export function isStreakBroken(streak: Streak): boolean {
-  const now = new Date();
-  const lastActivity = new Date(streak.lastActivityDate);
-  const hoursSinceLastActivity = (now.getTime() - lastActivity.getTime()) / (1000 * 60 * 60);
-
-  return hoursSinceLastActivity > 48;
-}
-
-/**
- * Update streak with new activity
- */
-export function updateStreakWithActivity(streak: Streak): Streak {
-  const now = new Date().toISOString();
-
-  // Check if streak is broken
-  if (isStreakBroken(streak)) {
-    return {
-      ...streak,
-      currentStreak: 1,
-      longestStreak: Math.max(1, streak.longestStreak),
-      lastActivityDate: now,
-      isActive: true,
-      updatedDate: now,
-    };
-  }
-
-  // Continue streak
-  const newStreak = streak.currentStreak + 1;
-  const newLongestStreak = Math.max(newStreak, streak.longestStreak);
-
-  return {
-    ...streak,
-    currentStreak: newStreak,
-    longestStreak: newLongestStreak,
-    lastActivityDate: now,
-    isActive: true,
-    updatedDate: now,
-  };
-}
-
-/**
- * Get streak milestones
- */
-export function getStreakMilestones(currentStreak: number): StreakMilestone[] {
-  const milestones: StreakMilestone[] = [
-    { days: 7, name: 'Week Warrior', reward: 50, achieved: currentStreak >= 7 },
-    { days: 14, name: 'Fortnight Fighter', reward: 100, achieved: currentStreak >= 14 },
-    { days: 30, name: 'Monthly Master', reward: 250, achieved: currentStreak >= 30 },
-    { days: 60, name: 'Consistency Champion', reward: 500, achieved: currentStreak >= 60 },
-    { days: 100, name: 'Century Star', reward: 1000, achieved: currentStreak >= 100 },
-    { days: 365, name: 'Yearly Legend', reward: 5000, achieved: currentStreak >= 365 },
-  ];
-
-  return milestones;
-}
-
-/**
- * Get next milestone for motivation
- */
-export function getNextMilestone(currentStreak: number): StreakMilestone | null {
-  const milestones = getStreakMilestones(currentStreak);
-  return milestones.find((m) => !m.achieved) || null;
-}
-
-/**
- * Calculate days until streak break
- */
-export function getDaysUntilStreakBreak(streak: Streak): number {
-  const now = new Date();
-  const lastActivity = new Date(streak.lastActivityDate);
-  const hoursRemaining = 48 - (now.getTime() - lastActivity.getTime()) / (1000 * 60 * 60);
-
-  return Math.max(0, Math.ceil(hoursRemaining / 24));
-}
-
-
-