@webship.co/workspace-container 0.0.0-stage → 1.0.0-alpha1

package/README.md

@@ -1,3 +1,16 @@
-# Temporary Holding Version
+# @webship.co/workspace-container
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The container family's shared base for [Webship Workspace](https://github.com/webship/workspace)
+plugins. A runtime plugin (`@webship.co/workspace-docker`, `-lando`, `-docksal`, `-podman`,
+`-kubernetes`) is one call plus its runtime:
+
+```ts
+import { registerContainer } from '@webship.co/workspace-container';
+export function register(api: PluginApi) { registerContainer(api, runtime); }
+```
+
+`registerContainer` draws the row menu on every project the runtime recognises (its verbs as
+terminal sessions in the project: start, stop, restart, status, logs, shell and the runtime's own,
+plus the site link), answers the up/down caption after the row is drawn, and adds the "scaffold a
+project file here" option to New folder. The `ContainerRuntime` says what differs: how a folder is
+detected as a project, the CLI, how to tell whether it is up, the verbs and their commands.

package/css/container.css

@@ -0,0 +1,7 @@
+/* The container family: the per-runtime menu and the New-folder init option.
+   Appended to the dashboard stylesheet after the components, so it may only ADD rules. */
+.container-menu-note { text-transform: none; font-weight: 400; opacity: .75; white-space: normal; }
+.container-menu-note code { white-space: normal; overflow-wrap: anywhere; }
+.container-absent { opacity: .75; }
+.container-absent:hover { opacity: 1; }
+.act-menu-container .uk-nav-header[data-group="project"] { text-transform: none; font-family: var(--font-code); }

package/dist/src/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * registerContainer(api, runtime): the whole surface of a container-runtime plugin.
+ *
+ * The row menu on every project the runtime recognises (its verbs as screen sessions in the
+ * project, grouped: start/stop/restart, status, logs and shell, the rest; the site link), the
+ * up/down caption, and the New-folder init option. What differs between runtimes is in the runtime.
+ */
+import type { PluginApi } from '@webship.co/workspace-plugin-api';
+import type { ContainerProject, ContainerRuntime } from './runtime';
+export * from './runtime';
+/** The first of `files` that exists in the folder, as a project, or null. */
+export declare function detectByFiles(projectDir: string, files: string[]): ContainerProject | null;
+export declare function registerContainer(api: PluginApi, r: ContainerRuntime): void;

package/dist/src/index.js

@@ -0,0 +1,169 @@
+"use strict";
+/**
+ * registerContainer(api, runtime): the whole surface of a container-runtime plugin.
+ *
+ * The row menu on every project the runtime recognises (its verbs as screen sessions in the
+ * project, grouped: start/stop/restart, status, logs and shell, the rest; the site link), the
+ * up/down caption, and the New-folder init option. What differs between runtimes is in the runtime.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectByFiles = detectByFiles;
+exports.registerContainer = registerContainer;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+__exportStar(require("./runtime"), exports);
+/** The first of `files` that exists in the folder, as a project, or null. */
+function detectByFiles(projectDir, files) {
+    for (const f of files) {
+        if (fs_1.default.existsSync(path_1.default.join(projectDir, f)))
+            return { file: f };
+    }
+    return null;
+}
+function registerContainer(api, r) {
+    const { esc, workspaceDir, listProjects, screenAction, NAME_RE } = api.lib;
+    const post = (name) => `/actions/p/${api.name}/${name}`;
+    const shq = (v) => `'${String(v).replace(/'/g, `'\\''`)}'`;
+    if (typeof api.addCss === 'function')
+        api.addCss(path_1.default.join(__dirname, '..', '..', 'css', 'container.css'));
+    if (typeof api.addTypeAction === 'function')
+        api.addTypeAction(r.id, ['sites', 'code']);
+    // The detection, memoised briefly: a page of thirty rows stats the same files once.
+    let cache = new Map();
+    let cacheAt = 0;
+    const projectOf = (dir) => {
+        const now = Date.now();
+        if (now - cacheAt > 5000) {
+            cache = new Map();
+            cacheAt = now;
+        }
+        if (!cache.has(dir)) {
+            try {
+                cache.set(dir, r.detect(dir));
+            }
+            catch (_) {
+                cache.set(dir, null);
+            }
+        }
+        return cache.get(dir) || null;
+    };
+    // The state, cached for a short while per folder: the menu must not run the CLI per render.
+    const states = new Map();
+    async function stateOf(p, dir) {
+        const hit = states.get(dir);
+        if (hit && Date.now() - hit.at < 15 * 1000)
+            return hit.value;
+        let value = 'unknown';
+        try {
+            value = await r.state(p, dir, api.lib);
+        }
+        catch (_) {
+            value = 'unknown';
+        }
+        states.set(dir, { at: Date.now(), value });
+        return value;
+    }
+    const item = (name, v, vals) => `<li><a href hx-post="${post(`verb-${name}`)}" ${vals()}${v.danger ? ' class="uk-text-danger"' : ''}><span uk-icon="icon: ${esc(v.icon)}; ratio: .7"></span> ${esc(v.label)}</a></li>`;
+    api.addRowMenu(r.id, { label: r.label, row: 0 }, ({ project, dir, allowed, vals }) => {
+        if (allowed.size && !allowed.has(r.id))
+            return null;
+        const pdir = path_1.default.join(dir, project);
+        const p = projectOf(pdir);
+        if (!p)
+            return null;
+        const groups = { lifecycle: [], status: [], look: [], other: [] };
+        for (const [name, v] of Object.entries(r.verbs)) {
+            const html = item(name, v, vals);
+            if (v.kind === 'start' || v.kind === 'stop' || v.kind === 'restart')
+                groups.lifecycle.push(html);
+            else if (v.kind === 'status')
+                groups.status.push(html);
+            else if (v.kind === 'logs' || v.kind === 'shell')
+                groups.look.push(html);
+            else
+                groups.other.push(html);
+        }
+        return `<span class="act-with-status"><div class="uk-inline act-menu act-menu-${esc(r.id)} act-menu-container">
+        <button class="uk-button uk-button-default uk-button-small" type="button" title="${esc(r.title)}: ${esc(p.file)}"><span uk-icon="icon: server; ratio: .7"></span> ${esc(r.label)} <span uk-icon="icon: chevron-down; ratio: .6"></span></button>
+        <div uk-dropdown="mode: click; pos: bottom-right"><ul class="uk-nav uk-dropdown-nav">
+          <li class="uk-nav-header" data-group="project">${esc(p.name || project)} · ${esc(p.file)}</li>
+          ${p.url ? `<li><a href="${esc(p.url)}" target="_blank" rel="noopener"><span uk-icon="icon: link-external; ratio: .7"></span> Open the site</a></li>` : ''}
+          ${groups.lifecycle.join('')}
+          ${groups.status.length ? `<li class="uk-nav-divider"></li>${groups.status.join('')}` : ''}
+          ${groups.look.length ? `<li class="uk-nav-divider"></li>${groups.look.join('')}` : ''}
+          ${groups.other.length ? `<li class="uk-nav-divider"></li>${groups.other.join('')}` : ''}
+          ${r.menuNote ? `<li class="uk-nav-header container-menu-note">${esc(r.menuNote)}</li>` : ''}
+        </ul></div>
+      </div><span class="act-status uk-text-meta" hx-get="/fragments/p/${esc(api.name)}/state/${encodeURIComponent(dir.split('/').pop() || '')}/${encodeURIComponent(project)}" hx-trigger="load delay:200ms" hx-swap="innerHTML">…</span></span>`;
+    });
+    // The caption, answered after the row is drawn: 'up', 'down' or '?'.
+    api.addFragment(async ({ send, rest }) => {
+        const m = rest.match(/^state\/([a-z0-9_-]+)\/([a-zA-Z0-9_-]+)$/);
+        if (!m)
+            return send('', 404);
+        const dir = path_1.default.join(workspaceDir(m[1]), m[2]);
+        const p = projectOf(dir);
+        if (!p)
+            return send('');
+        const s = await stateOf(p, dir);
+        send(s === 'unknown' ? '?' : s);
+    });
+    const guard = ({ form, send, workspace }) => {
+        const dir = workspaceDir(workspace);
+        const project = String(form.projectName || '');
+        if (!NAME_RE.test(project) || !listProjects(dir).includes(project)) {
+            send('<div class="msg error">Unknown project.</div>', 400);
+            return null;
+        }
+        const p = projectOf(path_1.default.join(dir, project));
+        if (!p) {
+            send(`<div class="msg error">This folder is not a ${esc(r.title)} project.</div>`, 409);
+            return null;
+        }
+        return { dir, project, p };
+    };
+    for (const [name, v] of Object.entries(r.verbs)) {
+        api.addAction(`verb-${name}`, (ctx) => {
+            const g = guard(ctx);
+            if (!g)
+                return;
+            states.delete(path_1.default.join(g.dir, g.project));
+            return screenAction(ctx.send, { workspace: ctx.workspace, project: g.project, projectDir: path_1.default.join(g.dir, g.project),
+                ownerDir: path_1.default.join(g.dir, g.project), verb: `${r.id}-${name}`,
+                cmdLine: `command -v ${r.cli} >/dev/null 2>&1 || { echo "${r.cli} is not installed: ${r.cliHint.replace(/"/g, '\\"')}"; exit 1; }; ${v.cmd(g.p, g.project)}`,
+                label: `${r.id} ${v.label.toLowerCase()}` });
+        });
+    }
+    if (r.init) {
+        const init = r.init;
+        api.addFolderSetup({
+            html: () => `<div class="uk-margin-small-top folder-container folder-${esc(r.id)}">
+          <span class="uk-text-meta">${esc(r.title)}:</span>
+          <label class="uk-margin-small-right"><input class="uk-radio" type="radio" name="${esc(r.id)}" value="none" checked> Not now</label>
+          <label><input class="uk-radio" type="radio" name="${esc(r.id)}" value="init"> ${esc(init.label)}</label>
+          ${init.help ? `<div class="uk-text-meta">${esc(init.help)}</div>` : ''}
+        </div>`,
+            steps: (_ws, name, form) => (form[r.id] === 'init' ? [`( cd ${shq(name)} && ${init.cmd(name)} )`] : []),
+            prompt: () => [],
+            problem: () => '',
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;;;;;;;;;;;;;;AAWH,sCAKC;AAED,8CAwGC;AAxHD,4CAAoB;AACpB,gDAAwB;AAKxB,4CAA0B;AAE1B,6EAA6E;AAC7E,SAAgB,aAAa,CAAC,UAAkB,EAAE,KAAe;IAC/D,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,IAAI,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;IAClE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,iBAAiB,CAAC,GAAc,EAAE,CAAmB;IACnE,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC;IAC3E,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,cAAc,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;IAChE,MAAM,GAAG,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC;IAEpE,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU;QAAE,GAAG,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC;IAC3G,IAAI,OAAO,GAAG,CAAC,aAAa,KAAK,UAAU;QAAE,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAExF,oFAAoF;IACpF,IAAI,KAAK,GAAG,IAAI,GAAG,EAAmC,CAAC;IACvD,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,MAAM,SAAS,GAAG,CAAC,GAAW,EAA2B,EAAE;QACzD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,GAAG,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;YAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;YAAC,OAAO,GAAG,GAAG,CAAC;QAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAAC,IAAI,CAAC;gBAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAAC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAAC,CAAC;QAAC,CAAC;QACnG,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;IAChC,CAAC,CAAC;IAEF,4FAA4F;IAC5F,MAAM,MAAM,GAAG,IAAI,GAAG,EAA4D,CAAC;IACnF,KAAK,UAAU,OAAO,CAAC,CAAmB,EAAE,GAAW;QACrD,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC;QAC7D,IAAI,KAAK,GAA8B,SAAS,CAAC;QACjD,IAAI,CAAC;YAAC,KAAK,GAAG,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;QAAC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YAAC,KAAK,GAAG,SAAS,CAAC;QAAC,CAAC;QAChF,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,CAAoD,EAAE,IAAkB,EAAE,EAAE,CACtG,wBAAwB,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,KAAK,IAAI,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,yBAAyB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC;IAEzL,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAc,EAAE,EAAE;QAC/F,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAAE,OAAO,IAAI,CAAC;QACpD,MAAM,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACrC,MAAM,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,MAAM,MAAM,GAA6B,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QAC5F,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACjC,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS;gBAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAC5F,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ;gBAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAClD,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO;gBAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;gBACpE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,yEAAyE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;2FACF,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,qDAAqD,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;;2DAE7H,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;YACtF,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,gHAAgH,CAAC,CAAC,CAAC,EAAE;YACvJ,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,mCAAmC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;YACvF,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,mCAAmC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;YACnF,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,mCAAmC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;YACrF,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,iDAAiD,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;;yEAE5B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,IAAI,kBAAkB,CAAC,OAAO,CAAC,qEAAqE,CAAC;IACjP,CAAC,CAAC,CAAC;IAEH,qEAAqE;IACrE,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;QACvC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;QACjE,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QAC7B,MAAM,GAAG,GAAG,cAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC;QACxB,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAiB,EAAE,EAAE;QACzD,MAAM,GAAG,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAAC,IAAI,CAAC,+CAA+C,EAAE,GAAG,CAAC,CAAC;YAAC,OAAO,IAAI,CAAC;QAAC,CAAC;QAChJ,MAAM,CAAC,GAAG,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,CAAC,EAAE,CAAC;YAAC,IAAI,CAAC,+CAA+C,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;YAAC,OAAO,IAAI,CAAC;QAAC,CAAC;QACjH,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAC7B,CAAC,CAAC;IAEF,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,SAAS,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC,GAAkB,EAAE,EAAE;YACnD,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YAAC,IAAI,CAAC,CAAC;gBAAE,OAAO;YACrC,MAAM,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YAC3C,OAAO,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,cAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC;gBACnH,QAAQ,EAAE,cAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE;gBAC9D,OAAO,EAAE,cAAc,CAAC,CAAC,GAAG,+BAA+B,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE;gBAC5J,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;QACX,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;QACpB,GAAG,CAAC,cAAc,CAAC;YACjB,IAAI,EAAE,GAAG,EAAE,CAAC,2DAA2D,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;uCAC/C,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;4FACyC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;8DACvC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAmB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;YAC7F,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,6BAA6B,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;eACjE;YACT,KAAK,EAAE,CAAC,GAAW,EAAE,IAAY,EAAE,IAAU,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7H,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE;YAChB,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE;SACX,CAAC,CAAC;IACZ,CAAC;AACH,CAAC"}

package/dist/src/runtime.d.ts

@@ -0,0 +1,59 @@
+/**
+ * What a container runtime is, to the dashboard.
+ *
+ * A runtime (Docker Compose, Lando, Docksal, Podman, Kubernetes) runs a project from a file the
+ * project carries (docker-compose.yml, .lando.yml, .docksal/, a Containerfile, k8s manifests). The
+ * row menu, the caption, the screen sessions and the New-folder section are the family's
+ * (registerContainer); the runtime says how a project is detected, which commands do what, how to
+ * tell whether it is up, and where the site answers.
+ */
+import type { PluginLib } from '@webship.co/workspace-plugin-api';
+/** The project as the runtime sees it. */
+export interface ContainerProject {
+    /** The file (or folder) that made it a project of this runtime: 'docker-compose.yml'. */
+    file: string;
+    /** The project's name for the runtime, when it has one (the compose project, the lando app). */
+    name?: string;
+    /** Where the site answers, when the file says (a lando proxy, a compose port). */
+    url?: string;
+}
+export interface RuntimeVerb {
+    /** What the menu calls it. */
+    label: string;
+    /** An icon name for the menu. */
+    icon: string;
+    /** The command line, run in the project folder in a screen session. */
+    cmd: (p: ContainerProject, project: string) => string;
+    /** 'start' | 'stop' | 'restart' | 'status' | 'logs' | 'shell' | 'other': where the menu puts it. */
+    kind: 'start' | 'stop' | 'restart' | 'status' | 'logs' | 'shell' | 'other';
+    /** Only offered when the project is up (logs, shell) or down (start). */
+    when?: 'up' | 'down';
+    /** Outward-facing or destructive: the menu says so. */
+    danger?: boolean;
+}
+export interface ContainerRuntime {
+    /** The slot, the type action and the route namespace: 'lando'. */
+    id: string;
+    /** The button's text: 'LANDO'. */
+    label: string;
+    /** The product's name in sentences: 'Lando'. */
+    title: string;
+    /** The CLI: 'lando', 'fin', 'docker', 'podman', 'kubectl'. */
+    cli: string;
+    /** How to install it, for the message when it is missing. */
+    cliHint: string;
+    /** Whether a folder is a project of this runtime, and what. Memoised by the caller per render. */
+    detect: (projectDir: string) => ContainerProject | null;
+    /** Whether the project is up: a quick command answering 'up', 'down' or 'unknown'. Cached by the caller. */
+    state: (p: ContainerProject, projectDir: string, lib: PluginLib) => Promise<'up' | 'down' | 'unknown'>;
+    /** The verbs, in menu order. */
+    verbs: Record<string, RuntimeVerb>;
+    /** The New-folder option: scaffold a project file (the command run in the new folder), or none. */
+    init?: {
+        label: string;
+        cmd: (name: string) => string;
+        help?: string;
+    };
+    /** A line the menu ends with. */
+    menuNote?: string;
+}

package/dist/src/runtime.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * What a container runtime is, to the dashboard.
+ *
+ * A runtime (Docker Compose, Lando, Docksal, Podman, Kubernetes) runs a project from a file the
+ * project carries (docker-compose.yml, .lando.yml, .docksal/, a Containerfile, k8s manifests). The
+ * row menu, the caption, the screen sessions and the New-folder section are the family's
+ * (registerContainer); the runtime says how a project is detected, which commands do what, how to
+ * tell whether it is up, and where the site answers.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=runtime.js.map

package/dist/src/runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../../src/runtime.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG"}

package/package.json

@@ -1,6 +1,31 @@
 {
   "name": "@webship.co/workspace-container",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-alpha1",
+  "description": "The container family's shared base for Webship Workspace plugins: the ContainerRuntime contract, and the row menu (start, stop, restart, status, logs, shell, open the site, the runtime's own verbs), the state caption and the New-folder init option every runtime plugin registers through registerContainer(api, runtime).",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webship/workspace-container.git"
+  },
+  "files": [
+    "dist/src",
+    "css",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "test": "npm run build && node --test dist/tests/*.test.js",
+    "lint": "tsc -p tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "@webship.co/workspace-plugin-api": "^1.0.0-alpha1",
+    "typescript": "^5.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}