toolaby 1.4.0 → 1.4.2

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, BUILD_COPY_NOTE } from './lib/project.js';
+import { detectProject, CODE_FILES, filesToWrite, STALE_FILES, BUILD_COPY_NOTE } from './lib/project.js';
 
-const VERSION = '1.4.0';
+const VERSION = '1.4.2';
 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.
@@ -42,7 +42,8 @@ const command = argv.find((a) => ['--version', '-v', '--help', '-h'].includes(a)
 const rest = argv.filter((a) => a !== command);
 const positional = rest.filter((a) => !a.startsWith('--'));
 const opt = (k, d = null) => { const i = rest.indexOf(k); return i >= 0 && rest[i + 1] && !rest[i + 1].startsWith('--') ? rest[i + 1] : d; };
-const flag = (k) => rest.includes(k);
+// `upgrade` is `wire --force`: the platform's files replaced with the current ones, the extension's own untouched.
+const flag = (k) => rest.includes(k) || (k === '--force' && command === 'upgrade');
 const WALLS = { test: 'https://test.toolaby.app', live: 'https://toolaby.app' };
 const live = flag('--live');
 const wall = (opt('--wall') ?? process.env.TOOLABY_WALL ?? (live ? WALLS.live : WALLS.test)).replace(/\/$/, '');
@@ -186,7 +187,7 @@ async function filesFor(slug, scaffold, manifestKey = null) {
 
 async function wire() {
   const slug = positional[0];
-  if (!isId(slug)) fail('usage: toolaby wire <tool-id> [--into <folder>] [--force]   — `toolaby tools` lists your ids');
+  if (!isId(slug)) fail(command === 'upgrade' ? 'usage: toolaby upgrade <tool-id> [--into <folder>]   — `toolaby tools` lists your ids' : 'usage: toolaby wire <tool-id> [--into <folder>] [--force]   — `toolaby tools` lists your ids');
   const dir = resolve(opt('--into') ?? '.');
   if (!existsSync(dir)) fail(`${dir} does not exist`);
   const tree = listTree(dir, 3);
@@ -211,7 +212,13 @@ async function wire() {
   const present = targets.filter((f) => existsSync(join(dir, f)));
   if (present.length && !flag('--force')) fail(`${present.join(', ')} already in ${dir}; add --force to replace them.`);
   const write = (rel, content) => { mkdirSync(dirname(join(dir, rel)), { recursive: true }); writeFileSync(join(dir, rel), content); };
+  // A command older than the Wall asks for files the Wall no longer hands out: said, with the way to the current one, rather than a crash.
+  const missing = targets.map((p) => p.split('/').pop()).filter((name) => typeof plan.files[name] !== 'string');
+  if (missing.length) fail(`This command (${VERSION}) is older than the Wall at ${wall}: it expects ${missing.join(', ')}, which the Wall no longer hands out.\n  Update it: npm install -g toolaby@latest — or run the Wall's own copy: npx --yes ${wall}/toolaby.tgz ${command} ${slug}`);
   for (const path of targets) write(path, plan.files[path.split('/').pop()].replaceAll('__APP_POPUP__', appPopup ?? ''));
+  // What an earlier wiring wrote and this one does not, wherever it put them: taken away, so nothing stale is shipped.
+  const removed = [];
+  for (const at of new Set([project.codeDir, project.popupDir, 'public/', 'src/public/'])) for (const f of STALE_FILES) { const p = join(dir, `${at}${f}`); if (existsSync(p)) { unlinkSync(p); removed.push(`${at}${f}`); } }
   const did = [];
   let ownWorker = null;
   if (wiring) {
@@ -222,12 +229,14 @@ async function wire() {
   } else if (project.createWorker) {
     write(project.createWorker.file, project.createWorker.content);
     did.push(`a background entry, ${project.createWorker.file} (it starts the platform)`);
-  } else if (project.worker) {
+  } else if (project.worker && !project.extraFiles) {
+    // A framework with its own extension point (WXT's module) starts the platform in the background itself.
     ownWorker = { file: project.worker, classic: false };
   }
 
   out(`\n  ${plan.name} → ${dir}${project.kind === 'plain' ? '' : `  (${project.label})`}  ·  ${side}${side === 'Test' ? ' (the tk_test_ key; `--live` for the store build)' : ''}\n`);
   out(`  Written: ${targets.join(', ')}${did.length ? `,\n           ${did.join(',\n           ')}` : ''}.\n`);
+  if (removed.length) out(`  Removed: ${removed.join(', ')} — earlier files, now inside toolaby.js.\n`);
   for (const sn of project.snippets) out(`  Add to ${sn.file} — yours to paste, the manifest being generated:\n\n${sn.code.split('\n').map((l) => `     ${l}`).join('\n')}\n`);
   if (ownWorker) out(`  Your background, ${ownWorker.file}: add${ownWorker.classic ? ' — after giving "background" a "type": "module" in manifest.json (importScripts() is not available in a module worker)' : ''}:\n\n${project.workerLines.trimEnd().split('\n').map((l) => `     ${l}`).join('\n')}\n`);
   if (project.built) out(`  ${BUILD_COPY_NOTE}\n`);
@@ -343,6 +352,7 @@ function help() {
     toolaby wire <tool-id>             wire the extension in this folder to your tool, on Test
     toolaby wire <tool-id> --live      the same, on Live: the store build
                                        --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>
     toolaby tools                      your tools, with their ids
     toolaby webhooks events            the six events, with an example of each
@@ -355,7 +365,7 @@ function help() {
 `);
 }
 
-const commands = { login: async () => { await login(); }, logout, whoami, tools, wire, create, webhooks, help, '--help': help, '-h': help, '--version': () => out(VERSION), '-v': () => out(VERSION) };
+const commands = { login: async () => { await login(); }, logout, whoami, tools, wire, upgrade: wire, create, webhooks, help, '--help': help, '-h': help, '--version': () => out(VERSION), '-v': () => out(VERSION) };
 const run = commands[command];
 if (!run) { console.error(`\n  Unknown command "${command}".`); help(); process.exit(1); }
 Promise.resolve().then(run).catch((e) => fail(e.message));

package/lib/project.js

@@ -1,18 +1,20 @@
 // Generated from wall/src/packages/wiring/project.ts by wall/scripts/pack-create.mjs — edit there.
 /** What to tell a developer whose build ships the extension — the Wire button, the command and the Set up page all say it in these words. */
-export const BUILD_COPY_NOTE = 'A build ships this extension: make sure it copies the platform\'s files to its output — toolaby.js, toolaby.config.js, toolaby-client.module.js, paywall.js, paywall.css and toolaby-popup.* — the way it copies your popup.html.';
-/** Always written, where the build imports from: the client, its config and types, and the panel a popup of the developer's own can draw. */
-export const CODE_FILES = ['toolaby.config.js', 'toolaby.js', 'toolaby-client.module.js', 'toolaby.d.ts', 'paywall.js', 'paywall.css'];
+export const BUILD_COPY_NOTE = 'A build ships this extension: make sure it copies the platform\'s files to its output — toolaby.js, toolaby.config.js and toolaby-popup.html — the way it copies your popup.html.';
+/** Always written, where the build imports from: the platform as one file (the client and the popup UI), its config, its types. */
+export const CODE_FILES = ['toolaby.config.js', 'toolaby.js', 'toolaby.d.ts'];
 /** Beside the client when the build generates the manifest: the fragment it spreads in, derived from the key (boilerplate/toolaby.manifest.js). */
 export const MANIFEST_HELPER = ['toolaby.manifest.js', 'toolaby.manifest.d.ts'];
-/** The Wall's popup, where the build copies files as they are; it imports the panel beside it, so the panel goes there too when that is elsewhere. */
-export const POPUP_FILES = ['toolaby-popup.html', 'toolaby-popup.js', 'toolaby-popup.css'];
-export const PANEL_FILES = ['paywall.js', 'paywall.css'];
+/** The Wall's popup: a shell, and the line that mounts it from toolaby.js beside it (an extension page may not run a script inline). */
+export const POPUP_FILES = ['toolaby-popup.html', 'toolaby-popup.js'];
+/** What earlier wirings wrote and this one does not: an upgrade takes them away, wherever a wiring put them. */
+export const STALE_FILES = ['toolaby-client.module.js', 'paywall.js', 'paywall.css', 'toolaby-popup.css', 'toolaby-account.js'];
 /** Every file a wiring writes, with its path: the code files, and — with a popup to stand in front of — the Wall's popup and, beside it, the panel. */
 export const filesToWrite = (p, appPopup) => [
     ...CODE_FILES.map((f) => `${p.codeDir}${f}`),
     ...(p.manifestFile ? [] : MANIFEST_HELPER.map((f) => `${p.codeDir}${f}`)),
-    ...(appPopup ? [...POPUP_FILES, ...(p.popupDir !== p.codeDir ? PANEL_FILES : [])].map((f) => `${p.popupDir}${f}`) : []),
+    ...(appPopup ? POPUP_FILES.map((f) => `${p.popupDir}${f}`) : []),
+    ...(p.extraFiles ?? []).map((f) => f.to),
 ];
 /** The import of toolaby.js from a file at `from`, both relative to the root. */
 export function importPath(from, codeDir = '') {
@@ -37,32 +39,19 @@ export function detectProject(o) {
         const appPopup = popup ? 'popup.html' : null;
         const workerFile = worker ?? `${src}entrypoints/background.ts`;
         const workerLines = `import { toolaby } from '${importPath(workerFile)}';\n\nexport default defineBackground(() => {\n  toolaby.startBackground();\n});\n`;
-        const code = [
-            `// wxt.config.ts — the Wall's needs in the manifest come from toolaby.config.js${appPopup ? ', and its popup goes in front of yours' : ''}`,
-            `import { manifest as toolaby } from './toolaby.manifest.js';`,
-            ``,
-            `export default defineConfig({`,
-            `  manifest: { ...toolaby }, // the extension's id, the storage permission, the Wall's address`,
-            ...(appPopup ? [
-                `  hooks: {`,
-                `    // WXT names your popup entrypoint after merging the manifest above; the hook runs after that.`,
-                `    'build:manifestGenerated': (_, manifest) => {`,
-                `      manifest.action = { ...manifest.action, default_popup: 'toolaby-popup.html' };`,
-                `    },`,
-                `  },`,
-            ] : []),
-            `});`,
-        ].join('\n');
+        // WXT's extension point: a module in modules/, loaded by WXT itself. It merges the manifest, puts the Wall's popup in
+        // front, and starts the platform in the background — yours, or its own when there is none. Nothing to paste.
         return {
-            kind: 'wxt', label: 'WXT', codeDir: '', popupDir: `${src}public/`, manifestFile: null, wrapper: true, appPopup, worker, built: false, foundManifest: null,
-            createWorker: worker ? null : { file: workerFile, content: workerLines },
-            workerLines, snippets: [{ file: first(has, ['wxt.config.ts', 'wxt.config.js', 'wxt.config.mts', 'wxt.config.mjs']) ?? 'wxt.config.ts', language: 'ts', code }],
+            kind: 'wxt', label: 'WXT', codeDir: '', popupDir: '', manifestFile: null, wrapper: true, appPopup, worker, built: false, foundManifest: null,
+            createWorker: null,
+            workerLines, snippets: [],
+            extraFiles: [{ from: 'toolaby.wxt.ts', to: 'modules/toolaby.wxt.ts' }, { from: 'toolaby.background.js', to: 'toolaby.background.js' }],
         };
     }
     if (plasmo) {
         // Plasmo builds only the pages its own manifest names (popup.tsx → popup.html, from .plasmo/), and its manifest
         // override replaces `action` whole: a page of ours in front of the popup would leave the popup unbuilt. So no
-        // wrapper here — the gate goes in the popup's code, one call, and the panel is a function away (paywall.js).
+        // wrapper here — the gate goes in the popup's code, one call, and the panel is a function away (toolaby.js).
         const src = has('src') && !first(has, ['popup.tsx', 'popup.html', 'background.ts', 'background.js']) ? 'src/' : '';
         const worker = first(has, [`${src}background.ts`, `${src}background.js`, `${src}background/index.ts`, `${src}background/index.js`]);
         const workerFile = worker ?? `${src}background.ts`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "toolaby",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "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": {