sitevision-cli 1.0.0-beta.31 → 1.0.0-beta.33

package/dist/utils/tasks.js

@@ -1,10 +1,12 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { EventEmitter } from 'node:events';
+import { stripVTControlCharacters } from 'node:util';
 import { useSyncExternalStore } from 'react';
 import { WebpackRunner, hasLocalWebpackConfig } from './webpack-runner.js';
 import { hasSitevisionScripts, runSitevisionScriptsBuild, getDelegatedZipPath, checkSitevisionScriptsCompatibility, } from './sitevision-scripts-runner.js';
-import { copyStaticToBuild, copySrcToBuild, cleanBuild, createBuildZip, zipExists, } from './zip.js';
+import { copyStaticToBuild, copySrcToBuild, cleanBuild, createBuildZip, formatFileSize, getZipSize, zipExists, } from './zip.js';
+import { deleteSessionCookie } from './keychain.js';
 import { isBundledApp, getAppType, getFullAppId, getZipPath, getSignedZipPath, getDeployZipPath, localizedText, } from './project-detection.js';
 import { signApp, deployApp, deployProduction, activateApp, createAddon, listAddons, classifyAddon, } from './sitevision-api.js';
 import { ProcessRunner } from './process-runner.js';
@@ -28,11 +30,19 @@ export function useTasks() {
 export function runningTasks(appRoot) {
     return tasks.filter(t => t.status === 'running' && (!appRoot || t.appRoot === appRoot));
 }
+/** A scaffold belongs to no listed app yet, so it counts for every one. */
+export function scaffoldRunning() {
+    return runningTasks().some(t => t.kind === 'create');
+}
+/** What "stop" means for the selected app: its own tasks and any scaffold. */
+export function stoppableTasks(appRoot) {
+    return runningTasks().filter(t => t.kind === 'create' || t.appRoot === appRoot);
+}
 export function clearFinished() {
     tasks = tasks.filter(t => t.status === 'running');
     notify();
 }
-function createTask(kind, project, label, stop = () => { }) {
+export function createTask(kind, project, label, stop = () => { }) {
     const task = {
         id: nextId++,
         kind,
@@ -48,7 +58,7 @@ function createTask(kind, project, label, stop = () => { }) {
     tasks.push(task);
     notify();
     const log = (tag, text, level = 'info') => {
-        for (const line of text.trimEnd().split('\n')) {
+        for (const line of logLines(text)) {
             task.lines.push({ time: Date.now(), tag, level, text: line });
         }
         if (task.lines.length > MAX_LINES) {
@@ -69,7 +79,7 @@ function createTask(kind, project, label, stop = () => { }) {
     };
     return { task, log, finish };
 }
-function setPhase(task, phase) {
+export function setPhase(task, phase) {
     task.phase = phase;
     notify();
 }
@@ -78,7 +88,9 @@ const errorText = (error) => error instanceof Error ? error.message : String(err
 // One-shot steps shared by the tasks below.
 // ---------------------------------------------------------------------------
 /** Build the app to dist/<appId>.zip. Returns the zip path or throws. */
-async function buildOnce(project, task, log, mode, signal) {
+async function buildOnce(project, task, log, mode, signal, 
+// False (`svc build --no-zip`): leave build/ and no zip.
+zip = true) {
     const { root, manifest } = project;
     cleanBuild(root);
     if (isBundledApp(manifest) && !hasLocalWebpackConfig(root)) {
@@ -97,7 +109,10 @@ async function buildOnce(project, task, log, mode, signal) {
         if (!zipExists(zipPath)) {
             throw new Error(`Build reported success but no zip was found at ${zipPath}.`);
         }
-        return zipPath;
+        // sitevision-scripts always zips; without a zip means taking it away.
+        if (!zip)
+            fs.rmSync(zipPath);
+        return zip ? zipPath : undefined;
     }
     if (isBundledApp(manifest)) {
         if (!WebpackRunner.isWebpackAvailable(root)) {
@@ -123,6 +138,8 @@ async function buildOnce(project, task, log, mode, signal) {
         copySrcToBuild(root);
         copyStaticToBuild(root);
     }
+    if (!zip)
+        return undefined;
     setPhase(task, 'zipping');
     return createBuildZip(root, getFullAppId(manifest.id));
 }
@@ -170,15 +187,26 @@ async function deployOnce(project, task, log, zipPath, config, options) {
             }
         }
     }
+    // A stale session must not be replayed by the next run. Not when it came
+    // from SITEVISION_SESSION_COOKIE: that one would just be read again.
+    if (!result.success &&
+        result.authExpired &&
+        config.sessionCookie &&
+        !process.env['SITEVISION_SESSION_COOKIE']) {
+        deleteSessionCookie(config.domain, config.username);
+    }
     if (!result.success)
         throw new Error(result.error ?? 'Deployment failed');
+    if (options.production && options.activate && !result.activated) {
+        throw new Error(result.message ?? 'Deployed, but not activated');
+    }
     log('dep', `${result.message ?? 'deployed'}${result.executableId ? ` · exec ${result.executableId}` : ''}`, 'ok');
     return result.executableId;
 }
 // ---------------------------------------------------------------------------
 // Tasks
 // ---------------------------------------------------------------------------
-export function startBuild(project) {
+export function startBuild(project, { zip = true } = {}) {
     const controller = new AbortController();
     const { task, log, finish } = createTask('build', project, 'build', () => {
         controller.abort();
@@ -186,8 +214,10 @@ export function startBuild(project) {
     });
     void (async () => {
         try {
-            const zip = await buildOnce(project, task, log, 'production', controller.signal);
-            log('bld', `created ${zip}`, 'ok');
+            const built = await buildOnce(project, task, log, 'production', controller.signal, zip);
+            log('bld', built
+                ? `created ${built} · ${formatFileSize(getZipSize(built))}`
+                : 'built, zip skipped', 'ok');
             finish('success');
         }
         catch (error) {
@@ -266,6 +296,7 @@ export function startInstall(project) {
         .catch(error => finish('error', errorText(error)));
     return task;
 }
+const WEBPACK_UNSEEN_TARGETS = ['static', 'manifest.json'];
 const WATCH_TARGETS = [
     'src',
     'static',
@@ -283,8 +314,6 @@ export function startDev(project, options) {
     const watchers = [];
     let webpack = null;
     let debounce;
-    let building = false;
-    let pending = false;
     const controller = new AbortController();
     const stop = () => {
         controller.abort();
@@ -318,36 +347,24 @@ export function startDev(project, options) {
         log('svc', errorText(error), 'error');
         setPhase(task, 'error');
     };
-    const rebuild = async () => {
-        if (building) {
-            pending = true;
+    const rebuild = serialized(async () => {
+        if (controller.signal.aborted)
             return;
-        }
-        building = true;
         try {
-            do {
-                pending = false;
-                try {
-                    // eslint-disable-next-line no-await-in-loop
-                    const zip = await buildOnce(project, task, log, 'development', controller.signal);
-                    // eslint-disable-next-line no-await-in-loop
-                    await afterBuild(zip);
-                }
-                catch (error) {
-                    fail(error);
-                }
-            } while (pending && !controller.signal.aborted);
+            const zip = await buildOnce(project, task, log, 'development', controller.signal);
+            if (zip)
+                await afterBuild(zip);
         }
-        finally {
-            building = false;
+        catch (error) {
+            fail(error);
         }
-    };
+    });
     // Size + mtime of every watched file. An event that leaves this unchanged
     // (editor metadata, xattrs, identical re-save) is noise and must not
     // rebuild, or a stray event during sign/deploy loops forever.
-    const snapshot = () => {
+    const snapshot = (targets) => {
         const entries = [];
-        for (const name of WATCH_TARGETS) {
+        for (const name of targets) {
             const target = path.join(root, name);
             const stat = fs.statSync(target, { throwIfNoEntry: false });
             if (!stat)
@@ -367,22 +384,22 @@ export function startDev(project, options) {
         return entries.toSorted().join('\n');
     };
     let fingerprint = '';
-    const onChange = (name, event, file) => {
-        const where = file ? path.join(name, file) : name;
-        clearTimeout(debounce);
-        debounce = setTimeout(() => {
-            const next = snapshot();
-            if (next === fingerprint) {
-                log('fs', `${event} ${where} · no file changed, ignored`, 'warn');
-                return;
-            }
-            fingerprint = next;
-            log('fs', `${event} ${where}`);
-            void rebuild();
-        }, 300);
-    };
-    const watchFiles = () => {
-        for (const name of WATCH_TARGETS) {
+    const watchFiles = (targets, changed) => {
+        const onChange = (name, event, file) => {
+            const where = file ? path.join(name, file) : name;
+            clearTimeout(debounce);
+            debounce = setTimeout(() => {
+                const next = snapshot(targets);
+                if (next === fingerprint) {
+                    log('fs', `${event} ${where} · no file changed, ignored`, 'warn');
+                    return;
+                }
+                fingerprint = next;
+                log('fs', `${event} ${where}`);
+                changed();
+            }, 300);
+        };
+        for (const name of targets) {
             const target = path.join(root, name);
             if (!fs.existsSync(target))
                 continue;
@@ -391,8 +408,8 @@ export function startDev(project, options) {
                 onChange(name, event, file);
             }));
         }
-        fingerprint = snapshot();
-        log('svc', `watching ${WATCH_TARGETS.join(', ')}`);
+        fingerprint = snapshot(targets);
+        log('svc', `watching ${targets.join(', ')}`);
     };
     void (async () => {
         try {
@@ -409,25 +426,37 @@ export function startDev(project, options) {
                     cssPrefix: manifest.id,
                     restApp: getAppType(manifest) !== 'web' && getAppType(manifest) !== 'widget',
                 });
+                // Zip, sign and deploy what is in build/ now. Webpack compiles and
+                // static edits both end here, one at a time, the latest one last.
+                let compiled = false;
+                const repackage = serialized(async () => {
+                    if (!compiled || controller.signal.aborted)
+                        return;
+                    try {
+                        copyStaticToBuild(root);
+                        await afterBuild(await createBuildZip(root, getFullAppId(manifest.id)));
+                    }
+                    catch (error) {
+                        fail(error);
+                    }
+                });
                 await webpack.watch(result => {
-                    void (async () => {
-                        reportBuild(result, log);
-                        if (!result.success) {
-                            setPhase(task, 'error');
-                            return;
-                        }
-                        try {
-                            copyStaticToBuild(root);
-                            await afterBuild(await createBuildZip(root, getFullAppId(manifest.id)));
-                        }
-                        catch (error) {
-                            fail(error);
-                        }
-                    })();
+                    reportBuild(result, log);
+                    compiled = result.success;
+                    if (result.success)
+                        void repackage();
+                    else
+                        setPhase(task, 'error');
+                });
+                // Webpack watches what it bundles; what is copied in as-is it never sees.
+                watchFiles(WEBPACK_UNSEEN_TARGETS, () => {
+                    void repackage();
                 });
             }
             else {
-                watchFiles();
+                watchFiles(WATCH_TARGETS, () => {
+                    void rebuild();
+                });
                 await rebuild();
             }
         }
@@ -437,3 +466,40 @@ export function startDev(project, options) {
     })();
     return task;
 }
+/**
+ * Run `run` one call at a time. Calls made meanwhile collapse into one run with
+ * the latest value, so of several quick saves the last is what gets deployed
+ * last, never an older one that happened to upload slower.
+ */
+export function serialized(run) {
+    let running = false;
+    let waiting;
+    return async (value) => {
+        waiting = { value };
+        if (running)
+            return;
+        running = true;
+        try {
+            while (waiting) {
+                const { value: current } = waiting;
+                waiting = undefined;
+                // eslint-disable-next-line no-await-in-loop
+                await run(current);
+            }
+        }
+        finally {
+            running = false;
+        }
+    };
+}
+/**
+ * Child output as log rows: split on LF or CRLF, no colour or cursor codes, and
+ * of a line redrawn with bare CRs (progress bars) only the final state. Any of
+ * those left in would move the cursor inside Ink's frame.
+ */
+export function logLines(text) {
+    return stripVTControlCharacters(text)
+        .trimEnd()
+        .split(/\r?\n/)
+        .map(line => line.slice(line.lastIndexOf('\r') + 1));
+}

package/dist/utils/version-check.js

@@ -1,9 +1,9 @@
 import https from 'node:https';
 /**
  * True if version `a` is strictly greater than `b`, comparing the numeric
- * MAJOR.MINOR.PATCH core. Pre-release suffixes (e.g. `-beta.1`) are ignored.
+ * MAJOR.MINOR.PATCH core. With equal cores, a stable `a` beats a pre-release `b`.
  */
-function isNewer(a, b) {
+export function isNewer(a, b) {
     const core = (v) => (v.split('-')[0] ?? '').split('.');
     const pa = core(a);
     const pb = core(b);
@@ -15,7 +15,7 @@ function isNewer(a, b) {
         if (da < db)
             return false;
     }
-    return false;
+    return !a.includes('-') && b.includes('-');
 }
 /**
  * Check the npm registry for a newer published version of `packageName`.

package/dist/utils/webpack-runner.js

@@ -7,7 +7,9 @@
 import path from 'path';
 import fs from 'fs';
 import { createRequire } from 'module';
+import { pathToFileURL } from 'url';
 import { copyChunksToResources } from './zip.js';
+import { findInstalledPackage } from './sitevision-scripts-runner.js';
 // =============================================================================
 // LOCAL CONFIG DETECTION
 // =============================================================================
@@ -56,8 +58,7 @@ export class WebpackRunner {
             return;
         }
         // Load webpack from project's node_modules
-        const webpackPath = path.join(this.projectRoot, 'node_modules', 'webpack');
-        if (!fs.existsSync(webpackPath)) {
+        if (!WebpackRunner.isWebpackAvailable(this.projectRoot)) {
             throw new Error('webpack not found in project. Make sure webpack is installed: npm install webpack');
         }
         try {
@@ -83,7 +84,8 @@ export class WebpackRunner {
             throw new Error('webpack.config.js not found. Make sure your project has a webpack configuration.');
         }
         try {
-            const configModule = await import(configPath);
+            // A bare Windows path (C:\\...) is not a valid import specifier.
+            const configModule = await import(pathToFileURL(configPath).href);
             const configFactory = configModule.default || configModule;
             // If it's a function, call it with options
             if (typeof configFactory === 'function') {
@@ -225,8 +227,7 @@ export class WebpackRunner {
      * Check if webpack is available in the project
      */
     static isWebpackAvailable(projectRoot) {
-        const webpackPath = path.join(projectRoot, 'node_modules', 'webpack');
-        return fs.existsSync(webpackPath);
+        return findInstalledPackage(projectRoot, 'webpack') !== null;
     }
     /**
      * Get the webpack version from the project

package/dist/utils/workspace.js

@@ -7,7 +7,9 @@ const MAX_DEPTH = 3;
  * Find every Sitevision app below `root` (e.g. root/webapps/x, root/restapps/y).
  * Depth-limited walk that skips dependency and output folders.
  */
-export function discoverApps(root) {
+export function discoverApps(root, 
+// Filled with why each app that was left out is broken.
+skipped = []) {
     const found = [];
     const walk = (dir, depth) => {
         let entries;
@@ -27,8 +29,10 @@ export function discoverApps(root) {
             try {
                 project = detectProject(full);
             }
-            catch {
-                // Unparseable manifest: skip it; the app can still be opened directly.
+            catch (error) {
+                // A broken app is left out, said out loud, and not searched for more.
+                skipped.push(error instanceof Error ? error.message : String(error));
+                continue;
             }
             if (project) {
                 found.push(project);
@@ -55,6 +59,40 @@ export function configIncomplete(dev) {
         return true;
     return (dev.authMethod ?? 'basic') === 'basic' && !dev.username;
 }
+/**
+ * What a deploy is sent with, or which required value is missing. The one place
+ * dev properties become a DeployConfig, so nothing ever posts to "undefined".
+ */
+export function toDeployConfig(dev, 
+// False for what talks to the site rather than an addon: listing its addons
+// (how an empty addon name gets picked) and logging in.
+{ addon = true } = {}) {
+    const required = {
+        domain: dev?.domain,
+        siteName: dev?.siteName,
+        ...(addon && { addonName: dev?.addonName }),
+        // A token or cookie login has no use for a username.
+        ...((dev?.authMethod ?? 'basic') === 'basic' && { username: dev?.username }),
+    };
+    const missing = Object.entries(required).find(([, value]) => !value)?.[0];
+    if (!dev || missing) {
+        return {
+            error: `Deploy config is missing "${missing ?? 'domain'}". Run svc and press e to set it, or add it to .dev_properties.json.`,
+        };
+    }
+    return {
+        config: {
+            domain: dev.domain,
+            siteName: dev.siteName,
+            addonName: dev.addonName ?? '',
+            username: dev.username ?? '',
+            password: dev.password,
+            accessToken: dev.accessToken,
+            sessionCookie: dev.sessionCookie,
+            useHTTP: dev.useHTTPForDevDeploy,
+        },
+    };
+}
 /**
  * True when a workspace has apps but nothing usable to deploy with: neither the
  * shared root config nor the apps themselves carry domain/site/username. The

package/dist/utils/zip.js

@@ -114,7 +114,7 @@ async function buildZipBuffer(entries) {
         const localHeader = Buffer.alloc(30);
         localHeader.writeUInt32LE(0x04034b50, 0);
         localHeader.writeUInt16LE(20, 4); // version needed to extract
-        localHeader.writeUInt16LE(0, 6); // general purpose flag
+        localHeader.writeUInt16LE(0x08_00, 6); // general purpose flag: UTF-8 names
         localHeader.writeUInt16LE(method, 8);
         localHeader.writeUInt16LE(dosTime, 10);
         localHeader.writeUInt16LE(dosDate, 12);
@@ -130,7 +130,7 @@ async function buildZipBuffer(entries) {
         centralHeader.writeUInt32LE(0x02014b50, 0);
         centralHeader.writeUInt16LE(20, 4); // version made by
         centralHeader.writeUInt16LE(20, 6); // version needed
-        centralHeader.writeUInt16LE(0, 8); // general purpose flag
+        centralHeader.writeUInt16LE(0x08_00, 8); // general purpose flag: UTF-8 names
         centralHeader.writeUInt16LE(method, 10);
         centralHeader.writeUInt16LE(dosTime, 12);
         centralHeader.writeUInt16LE(dosDate, 14);
@@ -228,6 +228,9 @@ export async function createBuildZip(projectRoot, appId) {
     if (!fs.existsSync(buildDir)) {
         throw new Error(`Build directory not found: ${buildDir}. Run build first.`);
     }
+    if (!fs.existsSync(path.join(buildDir, 'manifest.json'))) {
+        throw new Error(`${buildDir} has no manifest.json, so the zip would not be an app. manifest.json belongs in static/ (or src/ for an app that is not bundled).`);
+    }
     return createZip(buildDir, zipPath);
 }
 // =============================================================================
@@ -268,15 +271,17 @@ export function copyChunksToResources(buildDir) {
 export function copyStaticToBuild(projectRoot) {
     const staticDir = path.join(projectRoot, 'static');
     const buildDir = path.join(projectRoot, 'build');
-    if (!fs.existsSync(staticDir)) {
-        return;
-    }
-    // Ensure build directory exists
-    if (!fs.existsSync(buildDir)) {
-        fs.mkdirSync(buildDir, { recursive: true });
+    fs.mkdirSync(buildDir, { recursive: true });
+    if (fs.existsSync(staticDir))
+        copyDirRecursive(staticDir, buildDir);
+    // Every build ends here. A manifest kept at the project root is detected,
+    // so it ships when neither src/ nor static/ brought one.
+    const manifestIn = (dir) => path.join(projectRoot, dir, 'manifest.json');
+    if (fs.existsSync(manifestIn('.')) &&
+        !fs.existsSync(manifestIn('src')) &&
+        !fs.existsSync(manifestIn('static'))) {
+        fs.copyFileSync(manifestIn('.'), path.join(buildDir, 'manifest.json'));
     }
-    // Copy static directory contents to build
-    copyDirRecursive(staticDir, buildDir);
 }
 /**
  * Copy source files to build directory (for non-bundled apps)
@@ -286,15 +291,9 @@ export function copyStaticToBuild(projectRoot) {
 export function copySrcToBuild(projectRoot) {
     const srcDir = path.join(projectRoot, 'src');
     const buildDir = path.join(projectRoot, 'build');
-    if (!fs.existsSync(srcDir)) {
-        return;
-    }
-    // Ensure build directory exists
-    if (!fs.existsSync(buildDir)) {
-        fs.mkdirSync(buildDir, { recursive: true });
-    }
-    // Copy src directory contents to build
-    copyDirRecursive(srcDir, buildDir);
+    fs.mkdirSync(buildDir, { recursive: true });
+    if (fs.existsSync(srcDir))
+        copyDirRecursive(srcDir, buildDir);
 }
 /**
  * Recursively copy a directory

package/package.json

@@ -1,7 +1,22 @@
 {
 	"name": "sitevision-cli",
-	"version": "1.0.0-beta.31",
+	"version": "1.0.0-beta.33",
+	"description": "Build, sign and deploy Sitevision apps from the terminal",
 	"license": "MIT",
+	"author": "Rasmus Söderström",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/xrasod/SitevisionCli.git"
+	},
+	"homepage": "https://github.com/xrasod/SitevisionCli#readme",
+	"bugs": "https://github.com/xrasod/SitevisionCli/issues",
+	"keywords": [
+		"sitevision",
+		"cli",
+		"webapp",
+		"restapp",
+		"deploy"
+	],
 	"bin": {
 		"svc": "dist/cli.js"
 	},
@@ -10,9 +25,10 @@
 		"node": ">=22"
 	},
 	"scripts": {
-		"build": "tsc",
+		"build": "node -e \"fs.rmSync('dist',{recursive:true,force:true})\" && tsc && node -e \"fs.chmodSync('dist/cli.js',0o755)\"",
 		"dev": "tsc --watch",
 		"test": "prettier --check . && xo && ava",
+		"prepublishOnly": "npm test && npm run build",
 		"release": "./scripts/publish.sh",
 		"release:beta": "./scripts/publish-beta.sh"
 	},
@@ -52,7 +68,12 @@
 		],
 		"nodeArguments": [
 			"--import=tsx"
-		]
+		],
+		"environmentVariables": {
+			"FORCE_COLOR": "0",
+			"SVC_NO_KEYCHAIN": "memory",
+			"XDG_CONFIG_HOME": "test/.xdg"
+		}
 	},
 	"prettier": "@vdemedes/prettier-config"
 }

package/readme.md

@@ -60,7 +60,7 @@ and `p` to deploy and activate.
 | `1`–`4`         | Overview · Config · Versions · Log                  |
 | `/`             | Command palette                                     |
 | `?`             | Help: every key in one place                        |
-| `,`             | Settings (language, intro animation)                |
+| `,`             | Settings (language, update check, hints)            |
 | `Tab` / `Esc`   | Switch pane / back                                  |
 | `q`             | Quit                                                |
 
@@ -72,17 +72,24 @@ that apply. `svc --minimal` gives a compact layout for small panes.
 
 ```bash
 svc                                   # interactive shell
-svc build                             # build to dist/<id>.zip
+svc build [--no-zip]                  # build to dist/<id>.zip
 svc sign                              # sign to dist/<id>-signed.zip
 svc deploy [--force]                  # deploy the zip
 svc deploy --production [--activate]  # deploy the signed zip
 svc dev [--signed]                    # build + deploy on change
 svc watch [--signed]                  # build on change, no deploy
 svc info                              # project information
+svc setup-signing [--global]          # save the signing username and certificate
 ```
 
-Direct commands use the base environment. `--token` and `--cookie` pass an
-OAuth2 token or session cookie for one run.
+Short flags: `-f` force, `-p` production, `-a` activate, `-s` signed. An unknown
+flag is an error.
+
+Direct commands use the base environment, run without a terminal, and exit
+non-zero when a step fails, so `svc build && svc sign && svc deploy -p -a` is
+safe in CI. `SITEVISION_DEPLOY_PASSWORD` and `SITEVISION_SIGNING_PASSWORD`
+supply the passwords; `SITEVISION_ACCESS_TOKEN` and `SITEVISION_SESSION_COOKIE`
+pass an OAuth2 token or session cookie for one run.
 
 ## Configuration
 

package/dist/app.d.ts

@@ -1,6 +0,0 @@
-import { type ProjectInfo } from './utils/project-detection.js';
-type Props = {
-    project: ProjectInfo;
-};
-export default function App({ project: initialProject }: Props): import("react").JSX.Element | null;
-export {};