import cheerio from "cheerio"; import * as fs from "fs"; import * as path from "path"; import type { NodeCG } from "../../types/nodecg"; export function parsePanels( dashboardDir: string, manifest: NodeCG.Manifest, ): NodeCG.Bundle.Panel[] { const unparsedPanels = manifest.dashboardPanels ?? undefined; const dashboardDirExists = fs.existsSync(dashboardDir); // If neither the folder nor the manifest exist, return an empty array. if (!dashboardDirExists && typeof unparsedPanels === "undefined") { return []; } const bundleName = manifest.name; const panels: NodeCG.Bundle.Panel[] = []; // If the dashboard folder exists but the nodecg.dashboardPanels property doesn't, throw an error. if (dashboardDirExists && typeof unparsedPanels === "undefined") { throw new Error( `${bundleName} has a "dashboard" folder, but no "nodecg.dashboardPanels" property was found in its package.json`, ); } unparsedPanels?.forEach((panel, index) => { assertRequiredProps(panel, index); // Check if this bundle already has a panel by this name const dupeFound = panels.some((p) => p.name === panel.name); if (dupeFound) { throw new Error( `Panel #${index} (${panel.name}) has the same name as another panel in ${bundleName}.`, ); } const filePath = path.join(dashboardDir, panel.file); // Check that the panel file exists, throws error if it doesn't if (!fs.existsSync(filePath)) { throw new Error( `Panel file "${panel.file}" in bundle "${bundleName}" does not exist.`, ); } // This fixes some harder to spot issues with Unicode Byte Order Markings in dashboard HTML. const panelStr = fs.readFileSync(filePath, "utf8"); const $ = cheerio.load(panelStr.trim()); // We used to need to check for a tag, but modern versions of Cheerio add this for us automatically! // Check that the panel has a DOCTYPE const html = $.html(); if (!html.match(/( to it.", ); } // Error if this panel is a dialog but also has a workspace defined if (panel.dialog && panel.workspace) { throw new Error( `Dialog "${path.basename(panel.file)}" in bundle "${bundleName}" has a "workspace" ` + 'configured. Dialogs don\'t get put into workspaces. Either remove the "workspace" property from ' + 'this dialog, or turn it into a normal panel by setting "dialog" to false.', ); } if (panel.dialog && panel.fullbleed) { throw new Error( `Panel "${path.basename(panel.file)}" in bundle "${bundleName}" is fullbleed, ` + "but it also a dialog. Fullbleed panels cannot be dialogs. Either set fullbleed or dialog " + "to false.", ); } if (panel.fullbleed && panel.workspace) { throw new Error( `Panel "${path.basename(panel.file)}" in bundle "${bundleName}" is fullbleed, ` + "but it also has a workspace defined. Fullbleed panels are not allowed to define a workspace, " + "as they are automatically put into their own workspace. Either set fullbleed to " + "false or remove the workspace property from this panel.", ); } if (panel.fullbleed && typeof panel.width !== "undefined") { throw new Error( `Panel "${path.basename(panel.file)}" in bundle "${bundleName}" is fullbleed, ` + "but it also has a width defined. Fullbleed panels have their width set based on the, " + "width of the browser viewport. Either set fullbleed to " + "false or remove the width property from this panel.", ); } if (panel.workspace?.toLowerCase().startsWith("__nodecg")) { throw new Error( `Panel "${path.basename(panel.file)}" in bundle "${bundleName}" is in a workspace ` + "whose name begins with __nodecg, which is a reserved string. Please change the name " + "of this workspace to not begin with this string.", ); } let sizeInfo: | { fullbleed: false; width: number; } | { fullbleed: true; }; if (panel.fullbleed) { sizeInfo = { fullbleed: true, }; } else { sizeInfo = { fullbleed: false, width: panel.width ?? 1, }; } let workspaceInfo: | { dialog: false; workspace: string; } | { dialog: true; dialogButtons?: NodeCG.Manifest.UnparsedPanel["dialogButtons"]; }; if (panel.dialog) { workspaceInfo = { dialog: true, dialogButtons: panel.dialogButtons, }; } else { workspaceInfo = { dialog: false, workspace: panel.workspace ? panel.workspace.toLowerCase() : "default", }; } const parsedPanel: NodeCG.Bundle.Panel = { name: panel.name, title: panel.title, file: panel.file, ...sizeInfo, ...workspaceInfo, path: filePath, headerColor: panel.headerColor ?? "#525F78", bundleName, html: $.html(), }; panels.push(parsedPanel); }); return panels; } function assertRequiredProps( panel: NodeCG.Manifest.UnparsedPanel, index: number, ): void { const missingProps = []; if (typeof panel.name === "undefined") { missingProps.push("name"); } if (typeof panel.title === "undefined") { missingProps.push("title"); } if (typeof panel.file === "undefined") { missingProps.push("file"); } if (missingProps.length) { throw new Error( `Panel #${index} could not be parsed as it is missing the following properties: ` + missingProps.join(", "), ); } }