5etools-mirror-2.github.io/node/generate-pages/generate-pages-page-generator.js

import Handlebars from "handlebars";
import fs from "fs";

/** @abstract */
export class PageGeneratorBase {
	_filename;
	_page;

	_pageTitle;
	_pageDescription;
	_navbarTitle;
	_navbarTitleHtml;
	_navbarDescription;
	_navbarPageTitleStyleAdditional;
	_isFontAwesome = false;
	_stylesheets;

	init () {
		this._registerPartials();
		return this;
	}

	_registerPartial ({ident, filename}) {
		Handlebars.registerPartial(ident, this.constructor._getLoadedSource({filename}));
	}

	_registerPartials () {
		this._registerPartial({ident: "head", filename: "head/template-head.hbs"});

		this._registerPartial({ident: "adRhs", filename: "ad/template-ad-rhs.hbs"});
		this._registerPartial({ident: "adRhsScrollingPage", filename: "ad/template-ad-rhs--scrolling-page.hbs"});
		this._registerPartial({ident: "adLeaderboard", filename: "ad/template-ad-leaderboard.hbs"});
		this._registerPartial({ident: "adMobile1", filename: "ad/template-ad-mobile-1.hbs"});
		this._registerPartial({ident: "adFooter", filename: "ad/template-ad-footer.hbs"});

		this._registerPartial({ident: "navbar", filename: "navbar/template-navbar.hbs"});

		this._registerPartial({ident: "scripts", filename: "scripts/template-scripts.hbs"});

		this._registerPartial({ident: "blank", filename: "misc/template-blank.hbs"});
		this._registerPartial({ident: "btngroupManager", filename: "misc/template-btngroup-manager.hbs"});
		this._registerPartial({ident: "overlayNoise", filename: "misc/template-overlay-noise.hbs"});
	}

	getPage () { return this._page; }

	/**
	 * @abstract
	 * @return {object}
	 */
	_getData () {
		return {
			pageTitle: this._pageTitle,
			pageDescription: this._pageDescription,
			navbarTitle: this._navbarTitle ?? this._pageTitle,
			navbarTitleHtml: this._navbarTitleHtml,
			navbarDescription: this._navbarDescription,
			navbarPageTitleStyleAdditional: this._navbarPageTitleStyleAdditional,
			isFontAwesome: this._isFontAwesome,
			stylesheets: this._stylesheets,
		};
	}

	generatePage () {
		const template = Handlebars.compile(this.constructor._getLoadedSource({filename: this._filename}));
		const rendered = template(this._getData())
			.split("\n")
			.map(l => l.trimEnd())
			.join("\n");
		fs.writeFileSync(this._page, rendered, "utf-8");
	}

	static _getLoadedSource ({filename}) {
		return fs.readFileSync(`./node/generate-pages/template/${filename}`, "utf-8");
	}
}

export class PageGeneratorRedirectBase extends PageGeneratorBase {
	_filename = "page/template-page-redirect.hbs";

	_redirectHref;
	_redirectMessage;

	_getData () {
		return {
			...super._getData(),

			redirectHref: this._redirectHref,
			redirectMessage: this._redirectMessage,
		};
	}
}

/** @abstract */
export class PageGeneratorGeneric extends PageGeneratorBase {
	_scriptsLibAdditional;
	_scriptsLibAdditionalRemote;
	_scriptsUtilsAdditional;
	_scriptsRenderAdditional;
	_scripts;
	_scriptsModules;

	_getData () {
		return {
			...super._getData(),

			scriptsLibAdditional: this._scriptsLibAdditional,
			scriptsLibAdditionalRemote: this._scriptsLibAdditionalRemote,
			scriptsUtilsAdditional: this._scriptsUtilsAdditional,
			scriptsRenderAdditional: this._scriptsRenderAdditional,
			scripts: this._scripts,
			scriptsModules: this._scriptsModules,
		};
	}
}

export class PageGeneratorListBase extends PageGeneratorGeneric {
	_filename = "list/template-list.hbs";

	_navbarDescription = "Search by name on the left, click a name to display on the right.";

	_isStyleBook = false;
	_scriptIdentList;
	_scriptsPrePageAdditional;
	_isHasRenderer = true; // TODO(Future) only used in the Classes page -- refactor class rendering to own file
	_isModule = false;
	_isMultisource = false;
	_btnsList;
	_btnsSublist;
	_isWrpToken;
	_onscrollPageContent;
	_styleListContainerAdditional;
	_styleContentWrapperAdditional;
	_stylePageContentAdditional;
	_isPrinterView = false;

	_registerPartials () {
		super._registerPartials();

		this._registerPartial({ident: "listListcontainer", filename: "list/template-list-listcontainer.hbs"});
		this._registerPartial({ident: "listFilterSearchGroup", filename: "list/template-list-filter-search-group.hbs"});
		this._registerPartial({ident: "listFiltertools", filename: "list/template-list-filtertools.hbs"});
		this._registerPartial({ident: "listList", filename: "list/template-list-list.hbs"});

		this._registerPartial({ident: "listContentwrapper", filename: "list/template-list-contentwrapper.hbs"});
		this._registerPartial({ident: "listSublistContainer", filename: "list/template-list-sublist-container.hbs"});
		this._registerPartial({ident: "listSublist", filename: "list/template-list-sublist.hbs"});
		this._registerPartial({ident: "listSublistsort", filename: "list/template-list-sublistsort.hbs"});
		this._registerPartial({ident: "listStatsTabs", filename: "list/template-list-stats-tabs.hbs"});
		this._registerPartial({ident: "listWrpPagecontent", filename: "list/template-list-wrp-pagecontent.hbs"});
		this._registerPartial({ident: "listRhsWrpFooterControls", filename: "list/template-list-rhs-wrp-footer-controls.hbs"});
		this._registerPartial({ident: "listRhsWrpToken", filename: "list/template-list-rhs-wrp-token.hbs"});
	}

	/**
	 * @return {object}
	 */
	_getData () {
		const data = super._getData();
		return {
			...data,

			scripts: [
				"listpage.js",
				...(this._isMultisource ? ["multisource.js"] : []),
				"filter-common.js",
				`filter-${this._scriptIdentList}.js`,
				...(this._scriptsPrePageAdditional || []),
				...(this._isModule ? [] : [`${this._scriptIdentList}.js`]),
				...data.scripts || [],
			],

			scriptsModules: [
				...(this._isModule ? [`${this._scriptIdentList}.js`] : []),
				...data.scriptsModules || [],
			],

			scriptsUtilsAdditional: [
				"utils-list.js",
				...data.scriptsUtilsAdditional || [],
			],

			scriptsRenderAdditional: [
				"render-markdown.js",
				...(this._isHasRenderer ? [`render-${this._scriptIdentList}.js`] : []),
				...data.scriptsRenderAdditional || [],
			],

			btnsList: this._btnsList,
			btnsSublist: this._btnsSublist,
			isWrpToken: this._isWrpToken,
			onscrollPageContent: this._onscrollPageContent,
			isStyleBook: this._isStyleBook,
			styleListContainerAdditional: this._styleListContainerAdditional,
			styleContentWrapperAdditional: this._styleContentWrapperAdditional,
			stylePageContentAdditional: this._stylePageContentAdditional,
			identPartialListListcontainer: "listListcontainer",
			identPartialListContentwrapper: "listContentwrapper",
			isPrinterView: this._isPrinterView,
		};
	}
}

export class PageGeneratorAdventureBookBase extends PageGeneratorGeneric {
	_filename = "advbook/template-advbook.hbs";

	_scriptIdentAdvBook;
	_advBookPlaceholder;

	_scriptsRenderAdditional = [
		"render-markdown.js",
		"render-map.js",
	];

	_getData () {
		const data = super._getData();
		return {
			...data,

			advBookPlaceholder: this._advBookPlaceholder,

			scripts: [
				...data.scripts || [],
				"bookutils.js",
				`${this._scriptIdentAdvBook}.js`,
			],
		};
	}
}

export class PageGeneratorAdventuresBooksBase extends PageGeneratorGeneric {
	_filename = "advbook/template-advsbooks.hbs";

	_scriptIdentAdvsBooks;
	_searchName;
	_btnsList;

	_getData () {
		const data = super._getData();
		return {
			...data,

			searchName: this._searchName,
			btnsList: this._btnsList,

			scripts: [
				...data.scripts || [],
				"bookutils.js",
				"bookslist.js",
				`${this._scriptIdentAdvsBooks}.js`,
			],
		};
	}
}

export class PageGeneratorTablepageBase extends PageGeneratorGeneric {
	_filename = "tablepage/template-tablepage.hbs";

	_stylesheets = [
		"list-page--grouped",
	];

	_scriptsRenderAdditional = [
		"render-markdown.js",
	];

	_scriptsUtilsAdditional = [
		"utils-list.js",
	];

	_getData () {
		const data = super._getData();
		return {
			...data,

			scripts: [
				"listpage.js",
				"tablepage.js",
				...data.scripts || [],
			],
		};
	}
}

export class PageGeneratorManagerBase extends PageGeneratorGeneric {
	_filename = "manager/template-manager.hbs";

	_scriptsRenderAdditional = [
		"render-markdown.js",
	];

	_scriptsUtilsAdditional = [
		"utils-list.js",
	];
}