dragonwocky/notion-enhancer
1
0
Fork 0
mirror of https://github.com/notion-enhancer/notion-enhancer.git synced 2025-04-03 12:19:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(cli): repack enhanced sources into app.asar

Browse Source
This commit is contained in:
dragonwocky 2024-04-21 15:45:29 +10:00
parent 23ea8c1c55
commit a4b1e6e5f2
Signed by: dragonwocky
GPG Key ID: 7998D08F7D7BD7A8
8 changed files with 278 additions and 348 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

232
bin.mjs
View File

@ -6,21 +6,21 @@
* (https://notion-enhancer.github.io/) under the MIT license * (https://notion-enhancer.github.io/) under the MIT license
*/ */
import arg from "arg";
import chalk from "chalk-template";
import os from "node:os"; import os from "node:os";
import { createRequire } from "node:module"; import { createRequire } from "node:module";
import chalk from "chalk-template";
import arg from "arg";
import { import {
getAppPath, backupApp,
getBackupPath, enhanceApp,
checkEnhancementVersion, getInsertVersion,
getResourcePath,
restoreApp,
setNotionPath, setNotionPath,
unpackApp,
applyEnhancements,
takeBackup,
restoreBackup,
} from "./scripts/enhance-desktop-app.mjs"; } from "./scripts/enhance-desktop-app.mjs";
import { greaterThan } from "./src/core/updateCheck.mjs";
import { existsSync } from "node:fs"; import { existsSync } from "node:fs";
const nodeRequire = createRequire(import.meta.url), const nodeRequire = createRequire(import.meta.url),
manifest = nodeRequire("./package.json"); manifest = nodeRequire("./package.json");
@ -144,7 +144,7 @@ const printHelp = (commands, options) => {
chalk` ${cmd[0].padEnd(cmdPad)} {grey :} ${cmd[1]}`, chalk` ${cmd[0].padEnd(cmdPad)} {grey :} ${cmd[1]}`,
parseOpt = (opt) => parseOpt = (opt) =>
chalk` ${opt[0].padEnd(optPad)} {grey :} ${opt[1][1]}`; chalk` ${opt[0].padEnd(optPad)} {grey :} ${opt[1][1]}`;
print`{bold.whiteBright ${name} v${version}}\n{grey ${homepage}} print`{bold.whiteBright.underline ${name} v${version}}\n{grey ${homepage}}
\n{bold.whiteBright USAGE}\n${name} <command> [options] \n{bold.whiteBright USAGE}\n${name} <command> [options]
\n{bold.whiteBright COMMANDS}\n${commands.map(parseCmd).join("\n")} \n{bold.whiteBright COMMANDS}\n${commands.map(parseCmd).join("\n")}
\n{bold.whiteBright OPTIONS}\n${options.map(parseOpt).join("\n")}\n`; \n{bold.whiteBright OPTIONS}\n${options.map(parseOpt).join("\n")}\n`;
@ -160,8 +160,8 @@ const printHelp = (commands, options) => {
os: os.release(), os: os.release(),
}); });
} else { } else {
const enhancerVersion = `${manifest.name}@v${manifest.version}`, const nodeVersion = `node@${process.version}`,
nodeVersion = `node@${process.version}`, enhancerVersion = `${manifest.name}@v${manifest.version}`,
osVersion = `${process.platform}-${process.arch}/${os.release()}`; osVersion = `${process.platform}-${process.arch}/${os.release()}`;
print`${enhancerVersion} via ${nodeVersion} on ${osVersion}\n`; print`${enhancerVersion} via ${nodeVersion} on ${osVersion}\n`;
} }
@ -170,40 +170,42 @@ const printHelp = (commands, options) => {
try { try {
const commands = [ const commands = [
// ["command", "description"] // ["command", "description"]
["apply", "add enhancements to the notion app"], ["apply", "Inject the notion-enhancer into Notion desktop."],
["remove", "return notion to its pre-enhanced/pre-modded state"], ["remove", "Restore Notion desktop to its pre-enhanced state."],
["check", "check the current state of the notion app"], ["check", "Report Notion desktop's enhancement state."],
], ],
options = [ options = [
// ["alias, option=example", [type, "description"]] // ["alias, option=example", [type, "description"]]
[ [
"--path=</path/to/notion/resources>", "--path=</path/to/notion/resources>",
[String, "manually provide a notion installation location"], [String, "Manually provide a Notion installation location."],
],
[
"--overwrite",
[Boolean, "for rapid development; unsafely overwrite sources"],
], ],
[ [
"--no-backup", "--no-backup",
[Boolean, "skip backup; enhancement will be faster but irreversible"], [Boolean, "Skip backup; enhancement will be irreversible."],
],
[
"--json",
[Boolean, "Output JSON from the `check` and `--version` commands."],
], ],
[ [
"-y, --yes", "-y, --yes",
[Boolean, 'skip prompts; assume "yes" and run non-interactively'], [Boolean, 'Skip prompts; assume "yes" and run non-interactively.'],
], ],
[ [
"-n, --no", "-n, --no",
[Boolean, 'skip prompts; assume "no" and run non-interactively'], [Boolean, 'Skip prompts; assume "no" and run non-interactively.'],
], ],
[ [
"-q, --quiet", "-q, --quiet",
[Boolean, 'skip prompts; assume "no" unless -y and hide all output'], [Boolean, 'Skip prompts; assume "no" unless -y and hide all output.'],
], ],
["-d, --debug", [Boolean, "show detailed error messages"]], [
["-j, --json", [Boolean, "display json output (where applicable)"]], "-d, --debug",
["-h, --help", [Boolean, "display usage information"]], [Boolean, "Show detailed error messages and keep extracted files."],
["-v, --version", [Boolean, "display version number"]], ],
["-h, --help", [Boolean, "Display usage information for this CLI."]],
["-v, --version", [Boolean, "Display this CLI's version number."]],
]; ];
const args = arg(compileOptsToArgSpec(options)); const args = arg(compileOptsToArgSpec(options));
@ -216,149 +218,121 @@ try {
if (args["--version"]) printVersion(), process.exit(); if (args["--version"]) printVersion(), process.exit();
if (args["--path"]) setNotionPath(args["--path"]); if (args["--path"]) setNotionPath(args["--path"]);
const appPath = getAppPath(), const appPath = getResourcePath("app.asar"),
backupPath = getBackupPath(), backupPath = getResourcePath("app.asar.bak"),
insertVersion = checkEnhancementVersion(); insertVersion = await getInsertVersion(),
updateAvailable = greaterThan(manifest.version, insertVersion);
const messages = { const messages = {
"notion-found": `notion installation found`, "notion-found": insertVersion
"notion-not-found": `notion installation not found (corrupted or nonexistent)`, ? // prettier-ignore
"notion-is-packed": `electron archive found: extracting app.asar`, `Notion desktop found with ${manifest.name} v${insertVersion
} applied${updateAvailable ? "" : " (up to date)"}.`
: `Notion desktop found (no enhancements applied).`,
"notion-not-found": `Notion desktop not found.`,
"not-applied": `notion-enhancer not applied`, // prettier-ignore
"version-applied": `notion-enhancer v${manifest.version} applied`, "update-available": chalk`v${manifest.version
"version-mismatch": `notion-enhancer v${insertVersion} applied != v${manifest.version} current`, } is available! To apply, run {underline ${manifest.name} apply -y}.`,
"prompt-version-replace": `replace?`, // prettier-ignore
"update-confirm": `${updateAvailable ? "Upgrade" : "Downgrade"
} to ${manifest.name}${manifest.name} v${manifest.version}?`,
"backup-found": `backup found`, "backup-found": `Restoring to pre-enhanced state from backup...`,
"backup-not-found": `backup not found`, "backup-not-found": chalk`No backup found: to restore Notion desktop to its pre-enhanced state,
"creating-backup": `backing up notion before enhancement`, uninstall it and reinstall Notion from {underline https://www.notion.so/desktop}.`,
"restoring-backup": `restoring`,
"inserting-enhancements": `inserting enhancements and patching notion sources`, "backup-app": `Backing up app before enhancement...`,
"manual-removal-instructions": `to remove the notion-enhancer from notion, uninstall notion and "enhance-app": `Enhancing and patching app sources...`,
then install a vanilla version of the app from https://www.notion.so/desktop (mac,
windows) or ${manifest.homepage}/getting-started/installation (linux)`,
}; };
const SUCCESS = chalk`{bold.whiteBright SUCCESS} {green ✔}`, const SUCCESS = chalk`{bold.whiteBright SUCCESS} {green ✔}`,
FAILURE = chalk`{bold.whiteBright FAILURE} {red ✘}`, FAILURE = chalk`{bold.whiteBright FAILURE} {red ✘}`,
CANCELLED = chalk`{bold.whiteBright CANCELLED} {red ✘}`, CANCELLED = chalk`{bold.whiteBright CANCELLED} {red ✘}`,
INCOMPLETE = Symbol(); INCOMPLETE = Symbol();
const interactiveRestoreBackup = async () => { const interactiveRestore = async () => {
if (backupPath) { if (!backupPath || !existsSync(backupPath)) {
// replace enhanced app with vanilla app.bak/app.asar.bak print` {red * ${messages["backup-not-found"]}}\n`;
print` {grey * ${messages["backup-found"]}: ${messages["restoring-backup"]}} `;
startSpinner();
await restoreBackup();
stopSpinner();
return INCOMPLETE;
} else {
print` {red * ${messages["backup-not-found"]}: ${messages["manual-removal-instructions"]}}\n`;
return FAILURE; return FAILURE;
} }
print` {grey * ${messages["backup-found"]}} `;
startSpinner();
await restoreApp();
stopSpinner();
return SUCCESS;
}; };
const canEnhancementsBeApplied = async () => { const getNotion = () => {
if (!appPath) { if (!appPath || !existsSync(appPath)) {
// notion not installed
print` {red * ${messages["notion-not-found"]}}\n`; print` {red * ${messages["notion-not-found"]}}\n`;
return FAILURE; return FAILURE;
} else if (insertVersion === manifest.version) { } else {
// same version already applied print` {grey * ${messages["notion-found"]}}\n`;
if (args["--overwrite"]) { return INCOMPLETE;
print` {grey * ${messages["inserting-enhancements"]}} `;
startSpinner();
await applyEnhancements();
stopSpinner();
print` {grey * ${messages["version-applied"]}}\n`;
} else {
print` {grey * ${messages["notion-found"]}: ${messages["version-applied"]}}\n`;
}
return SUCCESS;
} }
if (insertVersion && insertVersion !== manifest.version) { },
compareVersions = async () => {
if (insertVersion === manifest.version) {
// same version already applied
print` {grey * ${messages["notion-found"]}}\n`;
return SUCCESS;
} else if (insertVersion) {
// diff version already applied // diff version already applied
print` {grey * ${messages["notion-found"]}: ${messages["version-mismatch"]}}\n`; print` {grey * ${messages["notion-found"]}}\n`;
// prettier-ignore const replace = await promptConfirmation(messages["update-confirm"]);
const promptReplacement = await promptConfirmation(messages["prompt-version-replace"]);
print`\n`; print`\n`;
return ["Y", "y"].includes(promptReplacement) return ["Y", "y"].includes(replace)
? await interactiveRestoreBackup() ? (await interactiveRestore()) === SUCCESS
? INCOMPLETE
: FAILURE
: CANCELLED; : CANCELLED;
} else return INCOMPLETE; } else return INCOMPLETE;
}, },
interactiveApplyEnhancements = async () => { interactiveEnhance = async () => {
if (appPath.endsWith(".asar")) {
print` {grey * ${messages["notion-is-packed"]}} `;
// asar blocks thread = spinner won't actually spin
// first frame at least can serve as waiting indicator
startSpinner();
await unpackApp();
stopSpinner();
}
// backup is used to restore app to pre-enhanced state
// new backup should be taken every enhancement
// e.g. in case old backup was from prev. version of app
if (!args["--no-backup"]) { if (!args["--no-backup"]) {
print` {grey * ${messages["creating-backup"]}} `; print` {grey * ${messages["backup-app"]}} `;
startSpinner(); startSpinner();
await takeBackup(); await backupApp();
stopSpinner(); stopSpinner();
} }
print` {grey * ${messages["inserting-enhancements"]}} `; print` {grey * ${messages["enhance-app"]}} `;
startSpinner(); startSpinner();
await applyEnhancements(); await enhanceApp(__debug);
stopSpinner(); stopSpinner();
print` {grey * ${messages["version-applied"]}}\n`;
return SUCCESS;
},
interactiveRemoveEnhancements = async () => {
if (!appPath) {
// notion not installed
print` {red * ${messages["notion-not-found"]}}\n`;
return FAILURE;
} else if (insertVersion) {
print` {grey * ${messages["notion-found"]}: ${messages["version-applied"]}}\n`;
return (await interactiveRestoreBackup()) === INCOMPLETE
? SUCCESS
: FAILURE;
}
print` {grey * ${messages["notion-found"]}: ${messages["not-applied"]}}\n`;
return SUCCESS; return SUCCESS;
}; };
switch (args["_"][0]) { switch (args["_"][0]) {
case "apply": { case "apply": {
print`{bold.whiteBright [NOTION-ENHANCER] APPLY}\n`; print`{bold.whiteBright [${manifest.name.toUpperCase()}] APPLY}\n`;
let res = await canEnhancementsBeApplied(); let res = getNotion();
if (res === INCOMPLETE) res = await interactiveApplyEnhancements(); if (res === INCOMPLETE) res = await compareVersions();
if (res === INCOMPLETE) res = await interactiveEnhance();
print`${res}\n`; print`${res}\n`;
break; break;
} }
case "remove": { case "remove": {
print`{bold.whiteBright [NOTION-ENHANCER] REMOVE}\n`; print`{bold.whiteBright [${manifest.name.toUpperCase()}] REMOVE}\n`;
const res = await interactiveRemoveEnhancements(); let res = getNotion();
if (res === INCOMPLETE) {
res = insertVersion ? await interactiveRestore() : SUCCESS;
}
print`${res}\n`; print`${res}\n`;
break; break;
} }
case "check": { case "check": {
if (__json) { if (__json) {
printObject({ const cliVersion = manifest.version,
appPath, state = { appPath, backupPath, insertVersion, cliVersion };
backupPath, if (appPath && !existsSync(appPath)) state.appPath = null;
insertVersion, if (backupPath && !existsSync(backupPath)) state.backupPath = null;
currentVersion: manifest.version, printObject(state), process.exit();
}); }
process.exit(); print`{bold.whiteBright [${manifest.name.toUpperCase()}] CHECK}\n`;
let res = getNotion();
if (res === INCOMPLETE && updateAvailable) {
print` {grey * ${messages["update-available"]}}\n`;
} }
print`{bold.whiteBright [NOTION-ENHANCER] CHECK:} `;
if (manifest.version === insertVersion) {
print`${messages["version-applied"]}\n`;
} else if (insertVersion) {
print`${messages["version-mismatch"]}\n`;
} else if (appPath) {
print`${messages["not-applied"]}\n`;
} else print`${messages["notion-not-found"]}\n`;
break; break;
} }
@ -375,6 +349,6 @@ try {
.map((at) => at.replace(/\s{4}/g, " ")) .map((at) => at.replace(/\s{4}/g, " "))
.join("\n")}}`; .join("\n")}}`;
} else { } else {
print`{bold.red Error:} ${message} {grey (run with -d for more information)}\n`; print`{bold.red Error:} ${message} {grey (Run with -d for more information.)}\n`;
} }
} }

10
package-lock.json generated
View File

@ -9,7 +9,7 @@
"version": "0.11.1", "version": "0.11.1",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@electron/asar": "^3.2.8", "@electron/asar": "^3.2.9",
"arg": "^5.0.2", "arg": "^5.0.2",
"chalk-template": "^1.1.0" "chalk-template": "^1.1.0"
}, },
@ -24,9 +24,9 @@
} }
}, },
"node_modules/@electron/asar": { "node_modules/@electron/asar": {
"version": "3.2.8", "version": "3.2.9",
"resolved": "https://registry.npmjs.org/@electron/asar/-/asar-3.2.8.tgz", "resolved": "https://registry.npmjs.org/@electron/asar/-/asar-3.2.9.tgz",
"integrity": "sha512-cmskk5M06ewHMZAplSiF4AlME3IrnnZhKnWbtwKVLRkdJkKyUVjMLhDIiPIx/+6zQWVlKX/LtmK9xDme7540Sg==", "integrity": "sha512-Vu2P3X2gcZ3MY9W7yH72X9+AMXwUQZEJBrsPIbX0JsdllLtoh62/Q8Wg370/DawIEVKOyfD6KtTLo645ezqxUA==",
"dependencies": { "dependencies": {
"commander": "^5.0.0", "commander": "^5.0.0",
"glob": "^7.1.6", "glob": "^7.1.6",
@ -36,7 +36,7 @@
"asar": "bin/asar.js" "asar": "bin/asar.js"
}, },
"engines": { "engines": {
"node": ">=10.11.1" "node": ">=10.12.0"
} }
}, },
"node_modules/arg": { "node_modules/arg": {

7
package.json
View File

@ -7,7 +7,6 @@
"repository": "github:notion-enhancer/desktop", "repository": "github:notion-enhancer/desktop",
"bugs": "https://github.com/notion-enhancer/desktop/issues", "bugs": "https://github.com/notion-enhancer/desktop/issues",
"funding": "https://github.com/sponsors/dragonwocky", "funding": "https://github.com/sponsors/dragonwocky",
"packageManager": "yarn@3.6.1",
"license": "MIT", "license": "MIT",
"bin": "bin.mjs", "bin": "bin.mjs",
"type": "module", "type": "module",
@ -35,8 +34,8 @@
"notion-enhancer" "notion-enhancer"
], ],
"dependencies": { "dependencies": {
"@electron/asar": "^3.2.8", "@electron/asar": "^3.2.9",
"arg": "^5.0.2", "chalk-template": "^1.1.0",
"chalk-template": "^1.1.0" "arg": "^5.0.2"
} }
} }

214
scripts/enhance-desktop-app.mjs
View File

@ -1,179 +1,143 @@
/** /**
* notion-enhancer * notion-enhancer
* (c) 2023 dragonwocky <thedragonring.bod@gmail.com> (https://dragonwocky.me/) * (c) 2024 dragonwocky <thedragonring.bod@gmail.com> (https://dragonwocky.me/)
* (https://notion-enhancer.github.io/) under the MIT license * (https://notion-enhancer.github.io/) under the MIT license
*/ */
import asar from "@electron/asar";
import os from "node:os"; import os from "node:os";
import fsp from "node:fs/promises"; import fsp from "node:fs/promises";
import { resolve } from "node:path";
import { existsSync } from "node:fs"; import { existsSync } from "node:fs";
import { fileURLToPath } from "node:url";
import { join, resolve } from "node:path";
import { execSync } from "node:child_process"; import { execSync } from "node:child_process";
import { createRequire } from "node:module"; import { createRequire } from "node:module";
import { fileURLToPath } from "node:url";
import asar from "@electron/asar";
import patch from "./patch-desktop-app.mjs"; import patch from "./patch-desktop-app.mjs";
let __notionResources;
const nodeRequire = createRequire(import.meta.url), const nodeRequire = createRequire(import.meta.url),
manifest = nodeRequire("../package.json"),
platform = platform =
process.platform === "linux" && process.platform === "linux" &&
os.release().toLowerCase().includes("microsoft") os.release().toLowerCase().includes("microsoft")
? "wsl" ? "wsl"
: process.platform, : process.platform,
polyfillWslEnv = (name) => { getEnv = (name) => {
if (platform !== "wsl" || process.env[name]) return process.env[name]; if (platform !== "wsl" || process.env[name]) return process.env[name];
// adds a windows environment variable to process.env // read windows environment variables and convert
// in a wsl environment, inc. path conversion // windows paths to paths mounted in the wsl fs
const value = execSync(`cmd.exe /c echo %${name}%`, { const pipe = { encoding: "utf8", stdio: "pipe" },
encoding: "utf8", value = execSync(`cmd.exe /c echo %${name}%`, pipe).trim(),
stdio: "pipe",
}).trim(),
isAbsolutePath = /^[a-zA-Z]:[\\\/]/.test(value), isAbsolutePath = /^[a-zA-Z]:[\\\/]/.test(value),
onSystemDrive = /^[\\\/]/.test(value); isSystemPath = /^[\\\/]/.test(value);
if (isAbsolutePath) { if (isAbsolutePath) {
// e.g. C:\Program Files // e.g. C:\Program Files
const drive = value[0].toLowerCase(), const drive = value[0].toLowerCase(),
path = value.slice(2).replace(/\\/g, "/"); path = value.slice(2).replace(/\\/g, "/");
process.env[name] = `/mnt/${drive}${path}`; process.env[name] = `/mnt/${drive}${path}`;
} else if (onSystemDrive) { } else if (isSystemPath) {
// e.g. \Program Files // e.g. \Program Files
const drive = polyfillWslEnv("SYSTEMDRIVE")[0].toLowerCase(), const drive = getEnv("SYSTEMDRIVE")[0].toLowerCase(),
path = value.replace(/\\/g, "/"); path = value.replace(/\\/g, "/");
process.env[name] = `/mnt/${drive}${path}`; process.env[name] = `/mnt/${drive}${path}`;
} else process.env[name] = value; } else process.env[name] = value;
return process.env[name]; return process.env[name];
},
readdirDeep = async (dir) => {
dir = resolve(dir);
let files = [];
for (let file of await fsp.readdir(dir)) {
if (["node_modules", ".git"].includes(file)) continue;
file = join(dir, file);
const stat = await fsp.lstat(file);
if (stat.isDirectory()) {
files = files.concat(await readdirDeep(file));
} else if (stat.isSymbolicLink()) {
} else files.push(file);
}
return files;
}; };
let __notionResources;
const setNotionPath = (path) => { const setNotionPath = (path) => {
// sets notion resource path to user provided value // sets notion resource path to user provided value
// e.g. with the --path cli option // e.g. with the --path cli option
__notionResources = path; __notionResources = path;
}, },
getResourcePath = (path) => { getResourcePath = (...paths) => {
if (__notionResources) return resolve(`${__notionResources}/${path}`); if (__notionResources) return resolve(__notionResources, ...paths);
polyfillWslEnv("LOCALAPPDATA"); // prettier-ignore
polyfillWslEnv("PROGRAMW6432"); for (const [platforms, notionResources] of [
const potentialPaths = { [['win32', 'wsl'], resolve(`${getEnv("LOCALAPPDATA")}/Programs/Notion/resources`)],
win32: [ [['win32', 'wsl'], resolve(`${getEnv("PROGRAMW6432")}/Notion/resources`)],
resolve(`${process.env.LOCALAPPDATA}/Programs/Notion/resources`), [['darwin'], `/Users/${getEnv("USER")}/Applications/Notion.app/Contents/Resources`],
resolve(`${process.env.PROGRAMW6432}/Notion/resources`), [['darwin'], "/Applications/Notion.app/Contents/Resources"],
], [['linux'], "/opt/notion-app"],
darwin: [ ]) {
`/Users/${process.env.USER}/Applications/Notion.app/Contents/Resources`, if (!platforms.includes(platform)) continue;
"/Applications/Notion.app/Contents/Resources", if (!existsSync(notionResources)) continue;
], __notionResources = notionResources;
linux: ["/opt/notion-app"], return resolve(__notionResources, ...paths);
};
potentialPaths["wsl"] = potentialPaths["win32"];
for (const testPath of potentialPaths[platform]) {
if (!existsSync(testPath)) continue;
__notionResources = testPath;
return resolve(`${__notionResources}/${path}`);
} }
}, },
// prefer unpacked if both exist extractFile = (path) => {
getAppPath = () => ["app", "app.asar"].map(getResourcePath).find(existsSync), const archive = getResourcePath("app.asar");
getBackupPath = () => return asar.extractFile(archive, path);
["app.bak", "app.asar.bak"].map(getResourcePath).find(existsSync),
checkEnhancementVersion = () => {
// prettier-ignore
const manifestPath = getResourcePath("app/node_modules/notion-enhancer/package.json");
if (!existsSync(manifestPath)) return undefined;
const insertVersion = nodeRequire(manifestPath).version;
return insertVersion;
}; };
const unpackApp = async () => { const getInsertPath = (...paths) => {
const appPath = getAppPath(); return "node_modules/notion-enhancer/" + paths.join("/");
if (!appPath || !appPath.endsWith("asar")) return false;
// asar reads synchronously
asar.extractAll(appPath, appPath.replace(/\.asar$/, ""));
await fsp.rm(appPath);
return true;
}, },
applyEnhancements = async () => { getInsertVersion = () => {
const appPath = getAppPath(); try {
if (!appPath || appPath.endsWith("asar")) return false; const manifest = extractFile(getInsertPath("package.json")).toString();
const srcPath = fileURLToPath(new URL("../src", import.meta.url)), return JSON.parse(manifest).version;
insertPath = getResourcePath("app/node_modules/notion-enhancer"); } catch {
if (existsSync(insertPath)) await fsp.rm(insertPath, { recursive: true }); return null;
// insert the notion-enhancer/src folder into notion's node_modules folder
await fsp.cp(srcPath, insertPath, { recursive: true });
// call patch-desktop-app.mjs on each file
// prettier-ignore
const notionScripts = (await readdirDeep(appPath))
.filter((file) => file.endsWith(".js")),
scriptUpdates = [];
for (const file of notionScripts) {
const scriptId = file.slice(appPath.length + 1, -3).replace(/\\/g, "/"),
scriptContent = await fsp.readFile(file, { encoding: "utf8" }),
patchedContent = patch(scriptId, scriptContent),
changesMade = patchedContent !== scriptContent;
if (changesMade) scriptUpdates.push(fsp.writeFile(file, patchedContent));
} }
// create package.json };
// prettier-ignore
const manifestPath = getResourcePath("app/node_modules/notion-enhancer/package.json"), const backupApp = async () => {
jsManifest = { ...manifest, main: "init.js" }; const archive = getResourcePath("app.asar");
// remove cli-specific fields if (!existsSync(archive)) return false;
delete jsManifest.bin; await fsp.cp(archive, archive + ".bak");
delete jsManifest.type;
delete jsManifest.scripts;
delete jsManifest.engines;
delete jsManifest.packageManager;
delete jsManifest.dependencies;
const jsonManifest = JSON.stringify(jsManifest);
scriptUpdates.push(fsp.writeFile(manifestPath, jsonManifest));
await Promise.all(scriptUpdates);
return true; return true;
}, },
takeBackup = async () => { restoreApp = async () => {
const appPath = getAppPath(); const archive = getResourcePath("app.asar");
if (!appPath) return false; if (!existsSync(archive + ".bak")) return false;
const backupPath = getBackupPath(); await fsp.rename(archive + ".bak", archive);
if (backupPath) await fsp.rm(backupPath, { recursive: true });
const destPath = `${appPath}.bak`;
if (!appPath.endsWith(".asar")) {
await fsp.cp(appPath, destPath, { recursive: true });
} else await fsp.rename(appPath, destPath);
return true; return true;
}, },
restoreBackup = async () => { enhanceApp = async (debug = false) => {
const backupPath = getBackupPath(); const app = getResourcePath("app"),
if (!backupPath) return false; archive = getResourcePath("app.asar");
const destPath = backupPath.replace(/\.bak$/, ""); if (!existsSync(archive)) return false;
if (existsSync(destPath)) await fsp.rm(destPath, { recursive: true }); if (existsSync(app)) await fsp.rm(app, { recursive: true, force: true });
await fsp.rename(backupPath, destPath); await fsp.mkdir(app);
const appPath = getAppPath(); // extract archive to folder and apply patches
if (destPath !== appPath) await fsp.rm(appPath, { recursive: true }); for (let file of asar.listPackage(archive)) {
file = file.replace(/^\//g, "");
const stat = asar.statFile(archive, file),
isFolder = !!stat.files,
isSymlink = !!stat.link,
isExecutable = stat.executable,
appPath = resolve(app, file);
if (isFolder) {
await fsp.mkdir(appPath);
} else if (isSymlink) {
await fsp.symlink(appPath, resolve(app, link));
} else {
await fsp.writeFile(appPath, patch(file, extractFile(file)));
if (isExecutable) await fsp.chmod(appPath, "755");
}
}
// insert the notion-enhancer/src folder into notion's node_modules
const insertSrc = fileURLToPath(new URL("../src", import.meta.url)),
insertDest = resolve(app, getInsertPath());
await fsp.cp(insertSrc, insertDest, { recursive: true });
// create package.json with cli-specific fields removed
const insertManifest = resolve(insertDest, "package.json"),
manifest = { ...nodeRequire("../package.json"), main: "init.js" },
excludes = ["bin", "type", "scripts", "engines", "dependencies"];
for (const key of excludes) delete manifest[key];
await fsp.writeFile(insertManifest, JSON.stringify(manifest));
// re-package enhanced sources into executable archive
await asar.createPackage(app, archive);
// cleanup extracted files unless in debug mode
if (!debug) await fsp.rm(app, { recursive: true });
return true; return true;
}; };
export { export {
backupApp,
restoreApp,
enhanceApp,
getInsertVersion,
getResourcePath, getResourcePath,
getAppPath,
getBackupPath,
checkEnhancementVersion,
setNotionPath, setNotionPath,
unpackApp,
applyEnhancements,
takeBackup,
restoreBackup,
}; };

154
scripts/patch-desktop-app.mjs
View File

@ -4,93 +4,85 @@
* (https://notion-enhancer.github.io/) under the MIT license * (https://notion-enhancer.github.io/) under the MIT license
*/ */
const replaceIfNotFound = ({ string, mode = "replace" }, search, replacement) => // patch scripts within notion's sources to
string.includes(replacement) // activate and respond to the notion-enhancer
? string const injectTriggerOnce = (file, content) =>
: string.replace( content +
search, (!/require\(['|"]notion-enhancer['|"]\)/.test(content)
typeof replacement === "string" && mode === "append" ? `\n\nrequire("notion-enhancer")('${file}',exports,(js)=>eval(js));`
? `$&${replacement}` : ""),
: typeof replacement === "string" && mode === "prepend" replaceIfNotFound = ({ string, mode = "replace" }, search, replacement) =>
? `${replacement}$&` string.includes(replacement)
: replacement ? string
); : string.replace(
search,
typeof replacement === "string" && mode === "append"
? `$&${replacement}`
: typeof replacement === "string" && mode === "prepend"
? `${replacement}$&`
: replacement
);
// require()-ing the notion-enhancer in worker scripts const patches = {
// or in renderer scripts will throw errors => manually // prettier-ignore
// inject trigger into only the necessary scripts ".webpack/main/index.js": (file, content) => {
// (avoid re-injection on re-enhancement) content = injectTriggerOnce(file, content);
const injectTriggerOnce = (scriptId, scriptContent) => const replace = (...args) =>
scriptContent + (content = replaceIfNotFound(
(!/require\(['|"]notion-enhancer['|"]\)/.test(scriptContent) { string: content, mode: "replace" },
? `\n\nrequire("notion-enhancer")('${scriptId}',exports,(js)=>eval(js));` ...args
: ""); )),
prepend = (...args) =>
(content = replaceIfNotFound(
{ string: content, mode: "prepend" },
...args
));
const mainScript = ".webpack/main/index", // https://github.com/notion-enhancer/notion-enhancer/issues/160:
rendererScripts = [ // enable the notion:// protocol, windows-style tab layouts, and
".webpack/renderer/tab_browser_view/preload", // quitting the app when the last window is closed on linux
".webpack/renderer/draggable_tabs/preload", const isWindows =
".webpack/renderer/tabs/preload", /(?:"win32"===process\.platform(?:(?=,isFullscreen)|(?=&&\w\.BrowserWindow)|(?=&&\(\w\.app\.requestSingleInstanceLock)))/g,
], isWindowsOrLinux = '["win32","linux"].includes(process.platform)';
patches = { replace(isWindows, isWindowsOrLinux);
// prettier-ignore
[mainScript]: (scriptContent) => {
scriptContent = injectTriggerOnce(mainScript, scriptContent);
const replace = (...args) =>
(scriptContent = replaceIfNotFound(
{ string: scriptContent, mode: "replace" },
...args
)),
prepend = (...args) =>
(scriptContent = replaceIfNotFound(
{ string: scriptContent, mode: "prepend" },
...args
));
// https://github.com/notion-enhancer/notion-enhancer/issues/160: // restore node integration in the renderer process
// enable the notion:// protocol, windows-style tab layouts, and // so the notion-enhancer can be require()-d into it
// quitting the app when the last window is closed on linux replace(/sandbox:!0/g, `sandbox:!1,nodeIntegration:!0,session:require('electron').session.fromPartition("persist:notion")`);
const isWindows =
/(?:"win32"===process\.platform(?:(?=,isFullscreen)|(?=&&\w\.BrowserWindow)|(?=&&\(\w\.app\.requestSingleInstanceLock)))/g,
isWindowsOrLinux = '["win32","linux"].includes(process.platform)';
replace(isWindows, isWindowsOrLinux);
// restore node integration in the renderer process // bypass webRequest filter to load enhancer menu
// so the notion-enhancer can be require()-d into it replace(/(\w)\.top!==\w\?(\w)\(\{cancel:!0\}\)/, "$1.top!==$1?$2({})");
replace(/sandbox:!0/g, `sandbox:!1,nodeIntegration:!0,session:require('electron').session.fromPartition("persist:notion")`);
// bypass webRequest filter to load enhancer menu // https://github.com/notion-enhancer/desktop/issues/291
replace(/(\w)\.top!==\w\?(\w)\({cancel:!0}\)/, "$1.top!==$1?$2({})"); // bypass csp issues by intercepting the notion:// protocol
const protocolHandler = /try\{const \w=await \w\.assetCache\.handleRequest\(\w\);/,
protocolInterceptor = `{const n="notion://www.notion.so/__notion-enhancer/";if(e.url.startsWith(n))return require("electron").net.fetch(\`file://\${require("path").join(__dirname,"..","..","node_modules","notion-enhancer",e.url.slice(n.length))}\`)}`;
prepend(protocolHandler, protocolInterceptor);
// expose the app config to the global namespace for manipulation
// e.g. to enable development mode
prepend(/\w\.exports=JSON\.parse\('\{"env":"production"/, "globalThis.__notionConfig=");
// https://github.com/notion-enhancer/desktop/issues/291 // expose the app store to the global namespace for reading
// bypass csp issues by intercepting the notion:// protocol // e.g. to check if keep in background is enabled
const protocolHandler = /try{const \w=await \w\.assetCache\.handleRequest\(\w\);/, prepend(/\w\.Store=\(0,\w\.configureStore\)/, "globalThis.__notionStore=");
protocolInterceptor = `{const n="notion://www.notion.so/__notion-enhancer/";if(e.url.startsWith(n))return require("electron").net.fetch(\`file://\${require("path").join(__dirname,"..","..","node_modules","notion-enhancer",e.url.slice(n.length))}\`)}`; prepend(/\w\.updatePreferences=\w\.updatePreferences/, "globalThis.__updatePreferences=");
prepend(protocolHandler, protocolInterceptor);
// expose the app config to the global namespace for manipulation
// e.g. to enable development mode
prepend(/\w\.exports=JSON\.parse\('{"env":"production"/, "globalThis.__notionConfig=");
// expose the app store to the global namespace for reading // conditionally create frameless windows
// e.g. to check if keep in background is enabled const titlebarStyle = `titleBarStyle:globalThis.__notionConfig?.titlebarStyle??"hiddenInset"`;
prepend(/\w\.Store=\(0,\w\.configureStore\)/, "globalThis.__notionStore="); replace(`titleBarStyle:"hiddenInset"`, titlebarStyle);
prepend(/\w\.updatePreferences=\w\.updatePreferences/, "globalThis.__updatePreferences=");
// conditionally create frameless windows return content;
const titlebarStyle = `titleBarStyle:globalThis.__notionConfig?.titlebarStyle??"hiddenInset"`; },
replace(`titleBarStyle:"hiddenInset"`, titlebarStyle); ".webpack/renderer/tabs/preload.js": injectTriggerOnce,
".webpack/renderer/tab_browser_view/preload.js": injectTriggerOnce,
return scriptContent; };
},
["*"]: (scriptId, scriptContent) => { const decoder = new TextDecoder(),
if (!rendererScripts.includes(scriptId)) return scriptContent; encoder = new TextEncoder();
return injectTriggerOnce(scriptId, scriptContent); export default (file, content) => {
}, if (!patches[file]) return content;
}; content = decoder.decode(content);
content = patches[file](file, content);
export default (scriptId, scriptContent) => { return encoder.encode(content);
if (patches["*"]) scriptContent = patches["*"](scriptId, scriptContent);
if (patches[scriptId]) scriptContent = patches[scriptId](scriptContent);
return scriptContent;
}; };

6
src/core/updateCheck.mjs
View File

@ -25,8 +25,10 @@ const parseVersion = (semver) => {
.map((v) => v ?? "") .map((v) => v ?? "")
.map((v) => (/^\d+$/.test(v) ? parseInt(v) : v)); .map((v) => (/^\d+$/.test(v) ? parseInt(v) : v));
}, },
// is a < b
greaterThan = (a, b) => { greaterThan = (a, b) => {
// is a greater than b if (a && !b) return true;
if (!a && b) return false;
a = parseVersion(a); a = parseVersion(a);
b = parseVersion(b); b = parseVersion(b);
for (let i = 0; i < a.length; i++) { for (let i = 0; i < a.length; i++) {
@ -44,4 +46,4 @@ const checkForUpdate = async () => {
return !(await checkForUpdate()) && version !== _release; return !(await checkForUpdate()) && version !== _release;
}; };
export { checkForUpdate, isDevelopmentBuild }; export { checkForUpdate, isDevelopmentBuild, greaterThan };

1
src/extensions/titlebar/mod.json
View File

@ -50,7 +50,6 @@
"clientScripts": ["client.mjs"], "clientScripts": ["client.mjs"],
"electronScripts": [ "electronScripts": [
[".webpack/main/index", "electron.cjs"], [".webpack/main/index", "electron.cjs"],
[".webpack/renderer/draggable_tabs/preload", "tabs.cjs"],
[".webpack/renderer/tabs/preload", "tabs.cjs"] [".webpack/renderer/tabs/preload", "tabs.cjs"]
] ]
} }

2
src/init.js
View File

@ -26,7 +26,7 @@ if (isElectron()) {
module.exports = async (target, __exports, __eval) => { module.exports = async (target, __exports, __eval) => {
const __getApi = () => globalThis.__enhancerApi; const __getApi = () => globalThis.__enhancerApi;
if (target === ".webpack/main/index") require("./worker.js"); if (target === ".webpack/main/index.js") require("./worker.js");
else { else {
// expose globalThis.__enhancerApi to scripts // expose globalThis.__enhancerApi to scripts
const { contextBridge } = require("electron"); const { contextBridge } = require("electron");