Premium Features

const maxLimit =
  premiumFeaturesEnabled && userHasPremium
    ? req.ctx.configuration.results.limits.premiumUser  // 10,000
    : req.ctx.configuration.results.limits.regularUser; // 1,000

limits: {
  regularUser: 1000,
  premiumUser: 10000,
}

GET /users/testActivity

// Response format:
{
  "2024": [1, 3, 0, 5, 2, ...], // Tests per day (365 values)
  "2025": [2, 1, 4, ...]
}

export async function getTestActivity(
  req: MonkeyRequest,
): Promise<GetTestActivityResponse> {
  const premiumFeaturesEnabled = req.ctx.configuration.users.premium.enabled;
  const userHasPremium = await UserDAL.checkIfUserIsPremium(uid, user);

  if (!premiumFeaturesEnabled) {
    throw new MonkeyError(503, "Premium features are disabled");
  }

  if (!userHasPremium) {
    throw new MonkeyError(503, "User does not have premium");
  }

  return new MonkeyResponse(
    "Test activity data retrieved",
    user.testActivity ?? null,
  );
}

const isPremium =
  (await UserDAL.checkIfUserIsPremium(user.uid, user)) || undefined;

{
  "premium": {
    "expirationTimestamp": 1735689600000 // Unix timestamp in milliseconds
  }
}

// From backend/src/dal/user.ts:1196-1213
export async function checkIfUserIsPremium(
  uid: string,
  userInfoOverride?: Pick<DBUser, "premium">,
): Promise<boolean> {
  const expirationDate = user.premium?.expirationTimestamp;

  if (expirationDate === undefined) return false;
  if (expirationDate === -1) return true; // Lifetime
  return expirationDate > Date.now();
}

{
  "premium": {
    "expirationTimestamp": -1  // Special value for lifetime
  }
}

GET /users

// Response includes:
{
  "isPremium": true,
  // ... other user data
}

if (!premiumFeaturesEnabled) {
  resultsWithRanks = resultsWithRanks.map((it) => omit(it, ["isPremium"]));
}

GET /users/results?limit=500&offset=0

// Premium: Can retrieve up to 10,000 results
// Regular: Can retrieve up to 1,000 results

let limit =
  req.query.limit ??
  Math.min(req.ctx.configuration.results.maxBatchSize, maxLimit);

if (limit + offset > maxLimit) {
  if (offset < maxLimit) {
    // Batch is partly in the allowed range
    limit = maxLimit - offset;
  } else {
    throw new MonkeyError(422, `Max results limit of ${maxLimit} exceeded.`);
  }
}

// Example from backend/src/api/controllers/result.ts:88-90
const premiumFeaturesEnabled = req.ctx.configuration.users.premium.enabled;
const userHasPremium = await UserDAL.checkIfUserIsPremium(uid);

// From backend/src/api/controllers/result.ts:124-133
void addLog(
  "user_results_requested",
  {
    limit,
    offset,
    onOrAfterTimestamp,
    isPremium: userHasPremium,
  },
  uid,
);

interface DBUser {
  premium?: {
    expirationTimestamp: number; // -1 for lifetime, or Unix timestamp
  };
  // ... other fields
}

// From backend/src/dal/user.ts:1337-1350
isPremium: {
  $cond: {
    if: {
      $or: [
        { $eq: ["$premium.expirationTimestamp", -1] },
        {
          $gt: ["$premium.expirationTimestamp", { $toLong: "$$NOW" }],
        },
      ],
    },
    then: true,
    else: "$$REMOVE",
  },
}