edupage-api/src/Application.js

Simple node.js package to manage your EduPage account.

const debug = require("debug")("edupage:log");
const error = require("debug")("edupage:error");
const {APIError, EdupageError, ParseError, FatalError} = require("./exceptions");
const RawData = require("../lib/RawData");
const Edupage = require("./Edupage");
const {ENDPOINT, API_STATUS, TIMELINE_ITEM_TYPE} = require("./enums");

debug.log = console.log.bind(console);


/**
 * @typedef {import("../lib/RawData").RawDataObject} RawDataObject
 */

/**
 * @typedef {import("./enums").EntityType} EntityType
 */

/**
 * @experimental
 * @class Application
 * @extends {RawData}
 */
class Application extends RawData {
	/**
	 * Creates an instance of Application.
	 * @param {RawDataObject} [data={}] Raw data to initialize the instance with.
	 * @param {Edupage} [edupage=null] Edupage instance to use.
	 * @memberof Application
	 */
	constructor(data = {}, edupage = null) {
		super(data);

		/**
		 * Edupage instance associated to this object.
		 * @type {Edupage}
		 */
		this.edupage = edupage;

		/**
		 * Id of the application.
		 * @type {string}
		 */
		this.id = data.id;

		/**
		 * Date from which the application is valid.
		 * @type {Date}
		 */
		this.dateFrom = data.datefrom ? new Date(data.datefrom) : null;

		/**
		 * Date until which the application is valid.
		 * @type {Date}
		 */
		this.dateTo = data.dateto ? new Date(data.dateto) : null;

		/**
		 * Name of the application.
		 * @type {string}
		 */
		this.name = data.name;

		/**
		 * Array of parameter names to be provided to `Application.post(...)` call (e.g. date, price...)
		 * @type {string[]}
		 */
		this.parameters = data.dataColumns;

		/**
		 * Type of entities this application is available for.
		 * @type {EntityType}
		 */
		this.availableFor = data.user;

		/**
		 * Flag indicating whether the application is enabled.
		 * @type {boolean}
		 */
		this.isEnabled = data.enabled;

		/**
		 * Unknown property
		 * @type {boolean}
		 */
		this.isTextOptional = data.textOptional || false;

		/**
		 * Unknown property
		 * @type {boolean}
		 */
		this.isAdvancedWorkflow = data.isAdvancedWorkflow || false;

		/**
		 * Unknown property
		 * @type {boolean}
		 */
		this.isSimpleWorkflow = data.isSimpleWorkflow || false;

		if(this.edupage) Application.prototype.init.call(this);
	}

	/**
	 * Creates Application draft
	 * @return {Promise<string>} Created draft id 
	 * @memberof Application
	 */
	async createDraft() {
		if(!this.edupage) throw new EdupageError(`Application does not have assigned Edupage instance yet`);

		const res = await this.edupage.api({
			url: ENDPOINT.TIMELINE_CREATE_ITEM,
			data: {
				typ: TIMELINE_ITEM_TYPE.PROCESS,
				selectedProcessType: this.id,
				selectedUser: this.edupage.user.getUserString(false)
			}
		});

		if(res.status !== API_STATUS.OK) {
			error(`Received invalid status from the server '${res.status}'`);
			throw new APIError(`Failed to create draft for the application: Invalid status received '${res.status}'`, res);
		}

		const draft = (res.redirect?.match(/draft=(\d+)/) || "")[1];

		if(!draft) return FatalError.throw(new ParseError("Failed to parse draft id from redirect URL"), {res, draft, _data: this._data});

		return draft;
	}

	/**
	 * Posts the application with input parameters
	 * @experimental
	 * @param {RawDataObject} [parameters={}] Object of parameters from `Application.parameters`
	 * @param {string} [draftId=null] Your custom created draft ID. If the paramater is not specified (or provided value is falsy), new draft is created internally.
	 * @return {Promise<boolean>} `true` if the method was successful, otherwise `false`
	 * @memberof Application
	 */
	async post(parameters = {}, draftId = null) {
		return new Promise((resolve, reject) => {
			const tryFetch = async _count => {
				this.edupage.api({
					url: ENDPOINT.DASHBOARD_GCALL,
					method: "POST",
					type: "text",
					data: new URLSearchParams({
						gpid: draftId || await this.createDraft(),
						gsh: this.edupage.ASC.gsecHash,
						action: "create",
						_LJSL: "2052",	//Seems like some -static- (it might vary) parameter (Loaded JS Libraries), keep it for a safety
						...parameters
					}).toString(),
					encodeBody: false
				}).then(res => {
					const success = /"border_error":\s*false/.test(res) && !/"border_error":\s*true/.test(res);

					resolve(success);
				}).catch(err => {
					if(err.retry) {
						debug(`[Application] Got retry signal, retrying...`);
						tryFetch(err.count + 1);
					} else {
						error(`[Application] Could not post application`, err);
						reject(new EdupageError("Failed to post application: " + err.message));
					}
				});
			};
			tryFetch(-1);
		});
	}

	/**
	 * Initializes instance.
	 * @param {Edupage} [edupage=null] Edupage instance to use.
	 * @memberof Application
	 */
	init(edupage = null) {
		if(edupage) this.edupage = edupage;
	}
}

module.exports = Application;