setup.gs

/**
 * Example script v1.2.3 by John Doe
 *
 * See Wiki page for info & setup instructions:
 * https://habitica.fandom.com/wiki/
 */

/* ========================================== */
/* [Users] Required script data to fill in    */
/* ========================================== */
const USER_ID = "PasteYourUserIdHere";
const API_TOKEN = "PasteYourApiTokenHere";
// IMPORTANT: Do not share your API token with anyone!

/* ========================================== */
/* [Users] Required customizations to fill in */
/* ========================================== */
// [Authors] Place all mandatory user-modified variables here
// - e.g. skill to use, number of times to use, task to use skill on, etc.

/* ========================================== */
/* [Users] Optional customizations to fill in */
/* ========================================== */
// [Authors] Place all optional user-modified variables here
// - e.g. enable/disable notifications, enable/disable script features, etc.

/* ========================================== */
/* [Users] Do not edit code below this line   */
/* ========================================== */

// [Authors] Place your user ID and script name here
// - This is used for the "X-Client" HTTP header
// - See https://habitica.fandom.com/wiki/Guidance_for_Comrades#X-Client_Header
const AUTHOR_ID = "b477462a-5bb5-4040-9505-f0b049b4f0bb";
const SCRIPT_NAME = "HabiticaGASTemplate";

// [Authors] Add global variables here
// - Note that these do not persist in between script calls
// - If you want to save values between calls, use PropertiesService
// - See https://developers.google.com/apps-script/reference/properties/properties-service
const scriptProperties = PropertiesService.getScriptProperties();

/* =================================== */
/* [Authors] Below you find functions, */
/*   that are only used once during    */
/*   installation, update or removal   */
/* =================================== */

function install() {
  // [Authors] These are one-time initial setup instructions that we'll ask
  //   the user to manually execute only once, during initial script setup
  // - Add triggers and webhooks for your script to service the events you care about
  // - Feel free to do all other one-time setup actions here as well
  //   e.g. creating tasks, reward buttons, etc.

  // check, if setup was already executed
  if (!getInstallTime()) {

    // if all options entered by the user are valid
    if (validateOptions()) {
      // create triggers
      createTriggers();
      // create webhooks
      createWebhooks();

      // save the time the installation was completed
      updateInstallTime();

      logInfo("Installation of the script succesfully finished!");
    }
  }
  else {
    logError("Installation of the script was already executed before")
  }
}

function uninstall() {
  // [Authors] These are one-time instructions that we'll tell the user to
  //   execute during script removal
  // - Add deleteWebhooks() here, if you created a webhook during initial setup
  // - Remove all other permanent changes the script has introduced during initial
  //   setup and normal use

  // delete triggers
  deleteTriggers();
  // delete webhooks
  deleteWebhooks();

  // remove the install time
  deleteInstallTime();

  logInfo("Removal of the script succesfully finished!");
}

function update() {
  // [Authors] This function updates the script after the user changed settings.
  // - It simply uninstalls and installs again.
  uninstall();
  install();
}

function createTriggers() {
  // [Authors] This function is used to create your necessary triggers
  // - Below you find an example trigger, that recurs every hour
  // - Feel free to modify this trigger or add additional triggers

  logInfo("Creating triggers");

  ScriptApp.newTrigger("processTrigger")
    .timeBased()
    .everyHours(1)
    .create();
}

function createWebhooks() {
  // [Authors] This function is used to create webhooks to your script
  // - Below you find an example webhook, that gets called, when a task is scored
  // - Feel free to modify this webhook or add additional webhooks

  logInfo("Creating webhooks");

  let webhookData = {
    "type": "taskActivity",
    "options": {
      "scored": true
    }
  }
  api_createWebhook(webhookData);
}

function deleteTriggers() {
  // [Authors] This function deletes all existing triggers for your script

  let triggers = ScriptApp.getProjectTriggers();
  if (triggers.length > 0) {

    logInfo("Deleting triggers");

    for (let trigger of triggers) {
      ScriptApp.deleteTrigger(trigger);
    }
  }
}

function deleteWebhooks() {
  // [Authors] This function deletes all existing webhooks to your script

  let response = api_fetch("https://habitica.com/api/v3/user/webhook", GET_PARAMS);
  let obj = parseJSON(response);
  let webhooks = obj.data;

  if (webhooks.length > 0) {

    console.log("Deleting webhooks");

    let webAppURL = getWebAppURL();

    for (let webhook of webhooks) {
      if (webhook.url == webAppURL) {
        api_fetch("https://habitica.com/api/v3/user/webhook/" + webhook.id, DELETE_PARAMS);
      }
    }
  }
}

function validateOptions() {
  // [Authors] This function is used to validate the options entered by the user
  // - Validation of the predefined script data is already programmed
  // - Usually check for the right type and value

  let valid = true;

  if (typeof INT_USER_ID !== "string" || !TOKEN_REGEXP.test(INT_USER_ID)) {
    logError("USER_ID must equal your Habitica User ID.\n\ne.g. const USER_ID = \"12345678-90ab-416b-cdef-1234567890ab\";\n\nYour Habitica User ID can be found at https://habitica.com/user/settings/api");
    valid = false;
  }

  if (typeof INT_API_TOKEN !== "string" || !TOKEN_REGEXP.test(INT_API_TOKEN)) {
    logError("API_TOKEN must equal your Habitica API Token.\n\ne.g. const API_TOKEN = \"2345678-90ab-416b-cdef-1234567890ab\";\n\nYour Habitica API Token can be found at https://habitica.com/user/settings/api");
    valid = false;
  }

  // test credentials
  if (valid) {
    valid = testCredentials();
  }

  if (!valid) {
    logInfo("Please fix the above errors, create a new version of the deployment, and run the doOneTimeSetup() function again.\nIf you aren't sure how to do this, see \"Changing the Settings\" in the documentation for this script.");
  }

  return valid;
}

function testCredentials() {
  // [Authors] This function tests the user credentials

  try {
    api_getUser();
  }
  catch (error) {
    if (error.message.startsWith("Request failed") && error.cause.getResponseCode() == 401) {
      logError("Your USER_ID and/or API_TOKEN is incorrect. Both of these can be found at https://habitica.com/user/settings/api");
      return false;
    }
    else {
      throw error;
    }
  }

  return true;
}