hoyocheckin/check-in.js

A simple package for HoYoLAB check-ins

const axios = require('axios');
const axiosRetry = require('axios-retry').default || require('axios-retry');

axiosRetry(axios, { retries: 3, retryDelay: (retryCount) => retryCount * 1000 });

const HoyoGame = {
  StarRail: 'StarRail',
  Genshin: 'Genshin',
  HKImpact: 'HKImpact',
  Zenless: 'Zenless',
  TearsOfThemis: 'TearsOfThemis'
};

const checkIn = async (cookie, game, version = false, userAgent = '') => {
  // For backwards compatibility, the version parameter can be a boolean or a string ('v1' or 'v2')
  let cookiePrefix = '';
  if (typeof version === 'boolean') {
    cookiePrefix = version ? '_v2' : '';
  } else if (typeof version === 'string') {
    if (version.toLowerCase() === 'v2') {
      cookiePrefix = '_v2';
    } else {
      cookiePrefix = ''; // for v1
    }
  }

  if (!(game in HoyoGame)) {
    throw new Error('Invalid check-in game. Please choose from StarRail, Genshin, HKImpact, and Zenless.');
  }

  let url = '';
  if (game === HoyoGame.StarRail) {
    url = 'https://sg-public-api.hoyolab.com/event/luna/os/sign?lang=en-us&act_id=e202303301540311';
  } else if (game === HoyoGame.Genshin) {
    url = 'https://sg-hk4e-api.hoyolab.com/event/sol/sign?lang=en-us&act_id=e202102251931481';
  } else if (game === HoyoGame.HKImpact) {
    url = 'https://sg-public-api.hoyolab.com/event/mani/sign?lang=en-us&act_id=e202110291205111';
  } else if (game === HoyoGame.Zenless) {
    url = 'https://sg-public-api.hoyolab.com/event/luna/zzz/os/sign?lang=en-us&act_id=e202406031448091';
  } else if (game === HoyoGame.TearsOfThemis) {
    url = 'https://sg-public-api.hoyolab.com/event/luna/os/sign?lang=en-us&act_id=e202308141137581';
  }

  const headers = {
    // Constructs the Cookie header based on the version.
    Cookie: `ltoken${cookiePrefix}=${cookie[`ltoken${cookiePrefix}`]}; ltuid${cookiePrefix}=${cookie[`ltuid${cookiePrefix}`]};`,
    'User-Agent': userAgent ||
        'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36',
    Origin: 'https://act.hoyolab.com',
    Connection: 'keep-alive',
    Referer: 'https://act.hoyolab.com/'
  };

  const axiosConfig = {
    headers,
    timeout: 10000
  };

  try {
    const response = await axios.post(url, null, axiosConfig);
    const responseData = response.data;
    const { data, message, retcode } = responseData;

    if (retcode === -5003) {
      return {
        data,
        message,
        retcode,
        alreadyCheckedIn: true
      };
    }

    return {
      data,
      message,
      retcode,
      alreadyCheckedIn: false
    };
  } catch (error) {
    throw new Error(`Check-in request failed: ${error.message}`);
  }
};

module.exports = {
  checkIn,
  HoyoGame
};