toolaby 1.4.4 → 1.4.5

package/bin.mjs

@@ -32,9 +32,9 @@ import { homedir } from 'node:os';
 import { spawn } from 'node:child_process';
 import { createHmac, randomBytes } from 'node:crypto';
 import { wireManifest, WORKER_LINES } from './lib/manifest.js';
-import { detectProject, CODE_FILES, filesToWrite, fillPages, scaffoldManifest, STALE_FILES, BUILD_COPY_NOTE } from './lib/project.js';
+import { detectProject, CODE_FILES, filesToWrite, fillPages, scaffoldManifest, scaffoldFilesFor, surfacesOf, hasPopup, hasSidePanel, SURFACES, STALE_FILES, BUILD_COPY_NOTE } from './lib/project.js';
 
-const VERSION = '1.4.4';
+const VERSION = '1.4.5';
 const CLIENT_ID = 'toolaby-cli';
 const argv = process.argv.slice(2);
 // `--version` and `--help` are commands of their own; every other command is the first bare word.
@@ -259,20 +259,25 @@ async function create() {
   // The scaffold's own files as the Wall names them (older Walls did not, hence the list): a Wall that adds one to the
   // minimal extension is written by this command too, instead of a manifest naming a file that never arrived.
   const scaffold = Array.isArray(plan.scaffold) && plan.scaffold.length ? plan.scaffold : ['manifest.json', 'background.js', 'popup.html', 'sidepanel.html', 'popup.css', 'popup.js', 'README.md'];
-  const wanted = [...CODE_FILES, ...scaffold];
+  // Which surfaces this extension is made with: both (the default), one of them, or none at all for a tool that works
+  // from the background. Asked for once here, rather than written and then deleted by hand.
+  const asked = opt('--surfaces');
+  if (asked && !SURFACES.includes(asked)) fail(`--surfaces takes ${SURFACES.join(', ')} — not "${asked}".`);
+  const surfaces = surfacesOf(asked);
+  const wanted = [...CODE_FILES, ...scaffoldFilesFor(surfaces, scaffold)];
   const absent = wanted.filter((f) => typeof plan.files[f] !== 'string');
   if (absent.length) fail(`The Wall at ${wall} named ${absent.join(', ')} for a new extension but did not hand ${absent.length > 1 ? 'them' : 'it'} over.\n  Nothing was written. Update this command: npm install -g toolaby@latest — or run the Wall's own copy: npx --yes ${wall}/toolaby.tgz create ${slug}`);
   // Both surfaces, and the panel drawn inside them: no page of the Wall's stands in front, so both names stay empty.
   for (const f of wanted) write(f, fillPages(plan.files[f]));
   // The manifest names the side panel only now that the page is beside it — an extension whose side_panel points at a
   // missing file does not load at all, so a Wall that stops serving the page must not leave the key behind either.
-  const wroteSidePanel = wanted.includes('sidepanel.html');
-  write('manifest.json', JSON.stringify(scaffoldManifest(JSON.parse(readFileSync(join(dir, 'manifest.json'), 'utf8')), { sidePanel: wroteSidePanel }), null, 2) + '\n');
+  write('manifest.json', JSON.stringify(scaffoldManifest(JSON.parse(readFileSync(join(dir, 'manifest.json'), 'utf8')), { sidePanel: hasSidePanel(surfaces), popup: hasPopup(surfaces) }), null, 2) + '\n');
   for (const s of [16, 48, 128]) {
     const res = await fetch(`${wall}/boilerplate/icons/icon${s}.png`);
     write(join('icons', `icon${s}.png`), Buffer.from(await res.arrayBuffer()));
   }
-  out(`\n  ${plan.name} → ${dir}\n\n    1. chrome://extensions → Developer mode → Load unpacked → ${dir}\n    2. Click the icon: the popup shows what the Free plan holds; Buy opens ${plan.site}/tools/${slug}\n${wroteSidePanel ? "    3. Open side panel, in that popup: the same page at the panel's width (README.md says how to keep only one)\n" : ''}\n  Edit background.js: your work goes behind toolaby.gate().\n`);
+  const clicking = { both: 'Click the icon: the popup shows what the Free plan holds. Open side panel, in it, is the same page at the panel\'s width', popup: 'Click the icon: the popup shows what the Free plan holds', 'side-panel': 'Click the icon: the side panel opens — it has no popup, so the click is the panel\'s', none: 'No popup and no side panel: nothing opens on a click. Your code says when to sell — toolaby.openPaymentPage()' }[surfaces];
+  out(`\n  ${plan.name} → ${dir}${surfaces === 'both' ? '' : `  (--surfaces ${surfaces})`}\n\n    1. chrome://extensions → Developer mode → Load unpacked → ${dir}\n    2. ${clicking}; Buy opens ${plan.site}/tools/${slug}\n\n  Edit background.js: your work goes behind toolaby.gate().\n  Surfaces, and how to add or drop one later: ${plan.site}/docs/surfaces\n`);
 }
 
 // ── webhooks: the catalogue, and a delivery on demand ───────────────────────────────────────────────────────────────
@@ -368,6 +373,7 @@ function help() {
                                        --into <folder>   another folder     --force   replace the platform's files
     toolaby upgrade <tool-id>          the platform's files replaced with the current ones — the popup, the client — yours untouched
     toolaby create <tool-id>           a new, minimal extension for your tool, in <tool-id>/   --dir <folder>
+                                       --surfaces both|popup|side-panel|none   what it opens (default: both)
     toolaby tools                      your tools, with their ids
     toolaby webhooks events            the six events, with an example of each
     toolaby webhooks trigger <event>   an example delivery to your endpoints; --to <url> sends it to a local server instead

package/lib/project.js

@@ -19,18 +19,32 @@ export const filesToWrite = (p, appPopup, appSidePanel = null) => [
     ...(appSidePanel ? SIDE_PANEL_FILES.map((f) => `${p.popupDir}${f}`) : []),
     ...(p.extraFiles ?? []).map((f) => f.to),
 ];
+export const SURFACES = ['both', 'popup', 'side-panel', 'none'];
+export const surfacesOf = (v) => SURFACES.includes(v ?? '') ? v : 'both';
+export const hasPopup = (s) => s === 'both' || s === 'popup';
+export const hasSidePanel = (s) => s === 'both' || s === 'side-panel';
+/** The scaffold's own files for those surfaces: the manifest and the background always, the pages as asked for. */
+export const scaffoldFilesFor = (s, all) => all.filter((f) => (f === 'popup.html' ? hasPopup(s) : f === 'sidepanel.html' ? hasSidePanel(s) : f === 'popup.js' || f === 'popup.css' ? s !== 'none' : true));
 /**
  * The scaffold's manifest, once it is known which pages were really written. Chrome refuses to load an extension
  * whose `side_panel.default_path` names a file that is not there — the whole extension, not just the panel — so the
- * minimal extension ships a manifest that names only its popup, and whatever writes the side panel adds it here.
+ * minimal extension ships a manifest that names only its popup, and whatever writes the pages settles it here: the
+ * side panel added with its page, the popup taken out when there is none (the icon stays; the click then opens the
+ * side panel, or nothing, which is what a background-only tool wants).
  */
 export function scaffoldManifest(manifest, wrote) {
+    const out = { ...manifest };
+    if (wrote.popup === false) {
+        const action = { ...out.action };
+        delete action.default_popup;
+        out.action = action;
+    }
     if (!wrote.sidePanel)
-        return manifest;
-    const permissions = Array.isArray(manifest.permissions) ? [...manifest.permissions] : [];
+        return out;
+    const permissions = Array.isArray(out.permissions) ? [...out.permissions] : [];
     if (!permissions.includes('sidePanel'))
         permissions.push('sidePanel');
-    return { ...manifest, permissions, side_panel: { default_path: 'sidepanel.html' } };
+    return { ...out, permissions, side_panel: { default_path: 'sidepanel.html' } };
 }
 /**
  * The last two placeholders in a handed-out file — the extension's own popup and side panel, which only the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "toolaby",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "description": "The Toolaby command line: sign in once, then wire any Chrome extension to your tool on the Wall — sign-in, the Free plan, licences and subscriptions — or start a new one.",
   "type": "module",
   "bin": {