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

package/README.md

@@ -1,3 +1,18 @@
-# Temporary Holding Version
+# @webship.co/workspace-forge
 
-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 forge family's shared base for [Webship Workspace](https://github.com/webship/workspace)
+plugins. A forge plugin (`@webship.co/workspace-github`, `-gitlab`, `-bitbucket`) is one call plus its
+provider:
+
+```ts
+import { registerForge } from '@webship.co/workspace-forge';
+export function register(api: PluginApi) { registerForge(api, provider(api)); }
+```
+
+`registerForge` registers the credential the dashboard uses for the host (`api.addForge`, which
+`gh`-based work such as the AI-items sync picks up), draws the row menu on every project whose git
+remote is at the host (open the repository, the open issues and pull or merge requests in the modal,
+open a request from the current branch in a terminal, copy the clone URL), the repository chip on
+the card, and the "Clone a repository into this folder" option of New folder. The `ForgeProvider`
+says what differs between forges: the host, the CLI, how a remote URL reads, where the pages are,
+how the open issues and requests are listed, the command that opens a request, the clone URL.

package/css/forge.css

@@ -0,0 +1,12 @@
+/* The forge family: the per-forge menu, the repository chip and the New-folder clone option.
+   Appended to the dashboard stylesheet after the components, so it may only ADD rules. */
+.forge-menu-repo { text-transform: none; font-family: var(--font-code); }
+.forge-menu-note { text-transform: none; font-weight: 400; opacity: .75; white-space: normal; }
+.forge-menu-note code { white-space: normal; overflow-wrap: anywhere; }
+.forge-unlinked { opacity: .75; }
+.forge-unlinked:hover { opacity: 1; }
+.pcard-meta .proj-forge-link { max-width: 13rem; }
+.proj-forge-link { white-space: nowrap; }
+.forge-items .uk-text-meta { margin-left: .4rem; }
+.folder-new-form .folder-forge-repo { display: none; }
+.folder-new-form .folder-forge:has(input[value="clone"]:checked) .folder-forge-repo { display: block; }

package/dist/src/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * registerForge(api, forge): the whole surface of a forge plugin, from a provider's facts.
+ *
+ * The credential the dashboard uses for the host (api.addForge), the row menu on every project
+ * whose git remote is at the host (repository, issues, pull requests, open one from the branch),
+ * the repository chip on the card, the issues and requests modals, and the "Clone from <forge>"
+ * option when a new folder is made. What differs between forges is in the provider.
+ */
+import type { PluginApi } from '@webship.co/workspace-plugin-api';
+import type { ForgeProvider, ForgeRepo } from './provider';
+export * from './provider';
+/** The remotes of a repository folder: name -> url. */
+export declare function gitRemotes(projectDir: string): Record<string, string>;
+export declare function gitBranch(projectDir: string): string | null;
+/** The repository of the folder on this forge: origin first, then any remote. */
+export declare function repoOnForge(forge: ForgeProvider, projectDir: string): ForgeRepo | null;
+/** 'owner/name' from a remote URL at `host`, in the ssh, https and ssh:// spellings; null otherwise. */
+export declare function repoPathAt(host: string, url: string): string | null;
+export declare function registerForge(api: PluginApi, f: ForgeProvider): void;

package/dist/src/index.js

@@ -0,0 +1,212 @@
+"use strict";
+/**
+ * registerForge(api, forge): the whole surface of a forge plugin, from a provider's facts.
+ *
+ * The credential the dashboard uses for the host (api.addForge), the row menu on every project
+ * whose git remote is at the host (repository, issues, pull requests, open one from the branch),
+ * the repository chip on the card, the issues and requests modals, and the "Clone from <forge>"
+ * option when a new folder is made. What differs between forges is in the provider.
+ */
+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.gitRemotes = gitRemotes;
+exports.gitBranch = gitBranch;
+exports.repoOnForge = repoOnForge;
+exports.repoPathAt = repoPathAt;
+exports.registerForge = registerForge;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+__exportStar(require("./provider"), exports);
+/** The remotes of a repository folder: name -> url. */
+function gitRemotes(projectDir) {
+    let cfg;
+    try {
+        cfg = fs_1.default.readFileSync(path_1.default.join(projectDir, '.git', 'config'), 'utf8');
+    }
+    catch (_) {
+        return {};
+    }
+    const out = {};
+    for (const m of cfg.matchAll(/\[remote "([^"]+)"\]([^[]*)/g)) {
+        const url = (m[2].match(/url\s*=\s*(\S+)/) || [])[1];
+        if (url)
+            out[m[1]] = url;
+    }
+    return out;
+}
+function gitBranch(projectDir) {
+    try {
+        const head = fs_1.default.readFileSync(path_1.default.join(projectDir, '.git', 'HEAD'), 'utf8').trim();
+        return (head.match(/^ref: refs\/heads\/(.+)$/) || [])[1] || null;
+    }
+    catch (_) {
+        return null;
+    }
+}
+/** The repository of the folder on this forge: origin first, then any remote. */
+function repoOnForge(forge, projectDir) {
+    const remotes = gitRemotes(projectDir);
+    const names = ['origin', ...Object.keys(remotes).filter((n) => n !== 'origin')];
+    for (const name of names) {
+        if (!remotes[name])
+            continue;
+        const r = forge.repoOf(remotes[name], name);
+        if (r)
+            return r;
+    }
+    return null;
+}
+/** 'owner/name' from a remote URL at `host`, in the ssh, https and ssh:// spellings; null otherwise. */
+function repoPathAt(host, url) {
+    const h = host.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+    const m = url.match(new RegExp(`^(?:https?://(?:[^@/]+@)?${h}/|(?:ssh://)?(?:git@)?${h}[:/])(.+?)(?:\\.git)?/?$`, 'i'));
+    return m ? m[1] : null;
+}
+function registerForge(api, f) {
+    const { esc, workspaceDir, listProjects, screenAction, iconHtml, NAME_RE } = api.lib;
+    const post = (name) => `/actions/p/${api.name}/${name}`;
+    const shq = (v) => `'${String(v).replace(/'/g, `'\\''`)}'`;
+    if (typeof api.addForge === 'function')
+        api.addForge(f.host(), { label: f.title, env: f.env, auth: f.auth });
+    if (typeof api.addCss === 'function')
+        api.addCss(path_1.default.join(__dirname, '..', '..', 'css', 'forge.css'));
+    // ---- The menu on a project row ---------------------------------------------------------------
+    api.addRowMenu(f.id, { label: f.label, row: 0 }, ({ key, project, dir, vals }) => {
+        const pdir = path_1.default.join(dir, project);
+        if (!fs_1.default.existsSync(path_1.default.join(pdir, '.git')))
+            return null;
+        const repo = repoOnForge(f, pdir);
+        if (!repo)
+            return null;
+        const branch = gitBranch(pdir);
+        const u = f.urls(repo);
+        const caption = repo.remote === 'origin' ? 'origin' : repo.remote;
+        const modal = (name) => `hx-post="${post(name)}" hx-vals='{"workspace":"${esc(key)}","projectName":"${esc(project)}"}' hx-target="#editor-modal-body" hx-swap="innerHTML"`;
+        return `<span class="act-with-status"><div class="uk-inline act-menu act-menu-${esc(f.id)} act-menu-forge">
+        <button class="uk-button uk-button-default uk-button-small" type="button" title="${esc(repo.path)} on ${esc(f.title)}"><span uk-icon="icon: git-fork; ratio: .7"></span> ${esc(f.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 forge-menu-repo" data-group="repository">${esc(repo.path)}${branch ? ` · ${esc(branch)}` : ''}</li>
+          <li><a href="${esc(repo.web)}" target="_blank" rel="noopener"><span uk-icon="icon: link-external; ratio: .7"></span> Open the repository</a></li>
+          <li><a href ${modal('issues')}><span uk-icon="icon: warning; ratio: .7"></span> Open issues</a></li>
+          <li><a href ${modal('pulls')}><span uk-icon="icon: git-branch; ratio: .7"></span> Open ${esc(f.pullsLabel.toLowerCase())}</a></li>
+          <li class="uk-nav-divider"></li>
+          ${branch && f.newPullCommand
+            ? `<li><a href hx-post="${post('new-pull')}" ${vals()}><span uk-icon="icon: push; ratio: .7"></span> Open a ${esc(f.pullsLabel.toLowerCase().replace(/s$/, ''))} from ${esc(branch)}…</a></li>`
+            : `<li><a href="${esc(u.newPull(branch || ''))}" target="_blank" rel="noopener"><span uk-icon="icon: push; ratio: .7"></span> New ${esc(f.pullsLabel.toLowerCase().replace(/s$/, ''))}${branch ? ` from ${esc(branch)}` : ''}</a></li>`}
+          <li><a href="${esc(u.newIssue)}" target="_blank" rel="noopener"><span uk-icon="icon: plus-circle; ratio: .7"></span> New issue</a></li>
+          <li><a href="#" class="copy-cmd" data-copy="${esc(f.cloneUrl(repo.path))}" title="Copy the clone URL"><span uk-icon="icon: copy; ratio: .7"></span> Copy the clone URL</a></li>
+        </ul></div>
+      </div><span class="act-status uk-text-meta">${esc(caption)}</span></span>`;
+    });
+    // ---- The repository chip on the card ---------------------------------------------------------
+    api.addProjectChip(({ project, dir }) => {
+        const repo = repoOnForge(f, path_1.default.join(dir, project));
+        if (!repo)
+            return null;
+        return `<a class="proj-alias proj-plugin-link proj-forge-link proj-${esc(f.id)}-link" href="${esc(repo.web)}" target="_blank" rel="noopener"
+      title="${esc(repo.path)} on ${esc(f.title)}">${iconHtml('tabler:git-fork', 0.7)}<span class="pcard-chip-text">${esc(repo.path)}</span></a>`;
+    });
+    // ---- Issues and requests, listed in the modal -------------------------------------------------
+    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 repo = repoOnForge(f, path_1.default.join(dir, project));
+        if (!repo) {
+            send(`<div class="msg error">This project has no git remote on ${esc(f.title)}.</div>`, 409);
+            return null;
+        }
+        return { dir, project, repo };
+    };
+    const itemsHtml = (items, empty) => (items.length
+        ? `<ul class="uk-list uk-list-divider forge-items">${items.map((i) => `<li><a href="${esc(i.url)}" target="_blank" rel="noopener">#${esc(i.number)} ${esc(i.title)}</a>${i.author ? `<span class="uk-text-meta">${esc(i.author)}</span>` : ''}${i.updated ? `<span class="uk-text-meta">${esc(String(i.updated).slice(0, 10))}</span>` : ''}</li>`).join('')}</ul>`
+        : `<p class="uk-text-meta">${esc(empty)}</p>`);
+    for (const [name, title, list, pageOf] of [
+        ['issues', 'Open issues', (r, env) => f.listIssues(r, api.lib, env), (r) => f.urls(r).issues],
+        ['pulls', `Open ${f.pullsLabel.toLowerCase()}`, (r, env) => f.listPulls(r, api.lib, env), (r) => f.urls(r).pulls],
+    ]) {
+        api.addAction(name, async (ctx) => {
+            const g = guard(ctx);
+            if (!g)
+                return;
+            const env = f.env() || process.env;
+            let items = [];
+            let problem = '';
+            try {
+                items = await list(g.repo, env);
+            }
+            catch (e) {
+                problem = String(e.message || e);
+            }
+            return ctx.send(`
+        <div class="editor-card">
+          <h3 class="uk-margin-small-bottom">${esc(title)} — ${esc(g.repo.path)}</h3>
+          <p class="uk-text-meta">On ${esc(f.title)}. <a href="${esc(pageOf(g.repo))}" target="_blank" rel="noopener">All of them</a>${!f.env() ? ` · no credential (${esc(f.tokenHint)}): a private repository answers nothing` : ''}</p>
+          ${problem ? `<div class="msg error"><pre>${esc(problem)}</pre></div>` : itemsHtml(items, `No ${title.toLowerCase()}.`)}
+        </div>`);
+        });
+    }
+    // ---- A pull request from the current branch, in a terminal -------------------------------------
+    if (f.newPullCommand) {
+        const cmd = f.newPullCommand;
+        api.addAction('new-pull', (ctx) => {
+            const g = guard(ctx);
+            if (!g)
+                return;
+            const branch = gitBranch(path_1.default.join(g.dir, g.project));
+            if (!branch)
+                return ctx.send('<div class="msg error">The project is on a detached HEAD: check out a branch first.</div>', 409);
+            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: `${f.id}-pull-${branch.replace(/[^a-zA-Z0-9_-]+/g, '-')}`,
+                cmdLine: cmd(g.repo, branch), label: `${f.id}: ${f.pullsLabel.toLowerCase().replace(/s$/, '')} from ${branch}` });
+        });
+    }
+    // ---- New folder: clone from the forge ---------------------------------------------------------
+    api.addFolderSetup({
+        html: (ws) => `<div class="uk-margin-small-top folder-forge folder-${esc(f.id)}">
+        <span class="uk-text-meta">${esc(f.title)}:</span>
+        <label class="uk-margin-small-right"><input class="uk-radio" type="radio" name="${esc(f.id)}" value="none" checked> Not now</label>
+        <label><input class="uk-radio" type="radio" name="${esc(f.id)}" value="clone"> Clone a repository into this folder</label>
+        <div class="folder-forge-repo uk-margin-small-top">
+          <label class="uk-form-label" for="folder-${esc(f.id)}-repo">Repository (owner/name, or its URL)</label>
+          <input class="uk-input uk-form-small uk-form-width-large" id="folder-${esc(f.id)}-repo" name="${esc(f.id)}_repo" placeholder="${esc(f.clone.placeholder)}">
+          <span class="uk-text-meta">${esc(ws)} gets a clone; the folder must be new.</span>
+        </div>
+      </div>`,
+        steps: (_ws, name, form) => {
+            if (form[f.id] !== 'clone')
+                return [];
+            const spec = String(form[`${f.id}_repo`] || '').trim();
+            const env = f.cloneEnv ? `${f.cloneEnv()} ` : '';
+            // git clones into an existing EMPTY folder, which is what the setup made.
+            return [`${env}git clone ${shq(f.cloneUrl(spec))} ${shq(name)}`];
+        },
+        prompt: () => [],
+        problem: (_ws, form) => {
+            if (form[f.id] !== 'clone')
+                return '';
+            const spec = String(form[`${f.id}_repo`] || '').trim();
+            return f.clone.pattern.test(spec) ? '' : f.clone.help;
+        },
+    });
+}
+//# 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;;;;;;;GAOG;;;;;;;;;;;;;;;;;;;AAWH,gCASC;AAED,8BAKC;AAGD,kCASC;AAGD,gCAIC;AAED,sCAuHC;AArKD,4CAAoB;AACpB,gDAAwB;AAKxB,6CAA2B;AAE3B,uDAAuD;AACvD,SAAgB,UAAU,CAAC,UAAkB;IAC3C,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QAAC,GAAG,GAAG,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;IAAC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QAAC,OAAO,EAAE,CAAC;IAAC,CAAC;IACxG,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,8BAA8B,CAAC,EAAE,CAAC;QAC7D,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,IAAI,GAAG;YAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IAC3B,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAgB,SAAS,CAAC,UAAkB;IAC1C,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QACnF,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IACnE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QAAC,OAAO,IAAI,CAAC;IAAC,CAAC;AAC9B,CAAC;AAED,iFAAiF;AACjF,SAAgB,WAAW,CAAC,KAAoB,EAAE,UAAkB;IAClE,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC;IAChF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,SAAS;QAC7B,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC;YAAE,OAAO,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,wGAAwG;AACxG,SAAgB,UAAU,CAAC,IAAY,EAAE,GAAW;IAClD,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACtD,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,4BAA4B,CAAC,yBAAyB,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC,CAAC;IACxH,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzB,CAAC;AAED,SAAgB,aAAa,CAAC,GAAc,EAAE,CAAgB;IAC5D,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC;IACrF,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,OAAQ,GAAW,CAAC,QAAQ,KAAK,UAAU;QAAG,GAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/H,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU;QAAE,GAAG,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC;IAEvG,iGAAiG;IAEjG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAc,EAAE,EAAE;QAC3F,MAAM,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACzD,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAClE,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,4BAA4B,GAAG,CAAC,GAAG,CAAC,oBAAoB,GAAG,CAAC,OAAO,CAAC,wDAAwD,CAAC;QACnL,OAAO,yEAAyE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;2FACF,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,uDAAuD,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;;8EAEjH,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;yBACvG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;wBACd,KAAK,CAAC,QAAQ,CAAC;wBACf,KAAK,CAAC,OAAO,CAAC,6DAA6D,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;;YAEtH,MAAM,IAAI,CAAC,CAAC,cAAc;YAClC,CAAC,CAAC,wBAAwB,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,yDAAyD,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,YAAY;YAC/L,CAAC,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,sFAAsF,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW;yBAClN,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;wDACgB,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;oDAE9B,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,iGAAiG;IAEjG,GAAG,CAAC,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE;QACtC,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,EAAE,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,OAAO,8DAA8D,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,gBAAgB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;eAChG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,iBAAiB,EAAE,GAAG,CAAC,iCAAiC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;IAChJ,CAAC,CAAC,CAAC;IAEH,kGAAkG;IAElG,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,IAAI,GAAG,WAAW,CAAC,CAAC,EAAE,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,IAAI,EAAE,CAAC;YAAC,IAAI,CAAC,4DAA4D,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YAAC,OAAO,IAAI,CAAC;QAAC,CAAC;QACzH,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAChC,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,KAAkB,EAAE,KAAa,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM;QACpE,CAAC,CAAC,mDAAmD,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,qCAAqC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,8BAA8B,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,8BAA8B,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO;QACnW,CAAC,CAAC,2BAA2B,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI;QACxC,CAAC,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAY,EAAE,GAAsB,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAY,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACtI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,CAAY,EAAE,GAAsB,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAY,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;KAClJ,EAAE,CAAC;QACX,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,GAAkB,EAAE,EAAE;YAC/C,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YAAC,IAAI,CAAC,CAAC;gBAAE,OAAO;YACrC,MAAM,GAAG,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC;YACnC,IAAI,KAAK,GAAgB,EAAE,CAAC;YAAC,IAAI,OAAO,GAAG,EAAE,CAAC;YAC9C,IAAI,CAAC;gBAAC,KAAK,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAAC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBAAC,OAAO,GAAG,MAAM,CAAE,CAAW,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;YAAC,CAAC;YACnG,OAAO,GAAG,CAAC,IAAI,CAAC;;+CAEyB,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;uCACxC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,mDAAmD,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAC,CAAC,EAAE;YACzN,OAAO,CAAC,CAAC,CAAC,+BAA+B,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC;eACjH,CAAC,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mGAAmG;IAEnG,IAAI,CAAC,CAAC,cAAc,EAAE,CAAC;QACrB,MAAM,GAAG,GAAG,CAAC,CAAC,cAAc,CAAC;QAC7B,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,GAAkB,EAAE,EAAE;YAC/C,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YAAC,IAAI,CAAC,CAAC;gBAAE,OAAO;YACrC,MAAM,MAAM,GAAG,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,MAAM;gBAAE,OAAO,GAAG,CAAC,IAAI,CAAC,2FAA2F,EAAE,GAAG,CAAC,CAAC;YAC/H,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,SAAS,MAAM,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC,EAAE;gBACtG,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,MAAM,EAAE,EAAE,CAAC,CAAC;QACtH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,kGAAkG;IAElG,GAAG,CAAC,cAAc,CAAC;QACjB,IAAI,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,uDAAuD,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;qCACrD,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;0FACyC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;4DACvC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;;qDAEhB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;iFACmB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,uBAAuB,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC;uCAC3H,GAAG,CAAC,EAAE,CAAC;;aAEjC;QACT,KAAK,EAAE,CAAC,GAAW,EAAE,IAAY,EAAE,IAAU,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO;gBAAE,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACvD,MAAM,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACjD,0EAA0E;YAC1E,OAAO,CAAC,GAAG,GAAG,aAAa,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE;QAChB,OAAO,EAAE,CAAC,GAAW,EAAE,IAAU,EAAE,EAAE;YACnC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO;gBAAE,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACvD,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QACxD,CAAC;KACK,CAAC,CAAC;AACZ,CAAC"}

package/dist/src/provider.d.ts

@@ -0,0 +1,74 @@
+/**
+ * What a git forge is, to the dashboard.
+ *
+ * A forge hosts repositories, issues and pull (or merge) requests at one host, and the dashboard
+ * authenticates there with a credential a person put in the forge plugin's settings. A provider
+ * knows the host, how to read a remote URL, where the pages are, how to list the open issues and
+ * requests, and which command opens a request from a branch. The row menu, the modals, the chip,
+ * the clone option and the credential hook are the family's (registerForge).
+ */
+import type { PluginLib } from '@webship.co/workspace-plugin-api';
+/** A repository on the forge, as read from a git remote. */
+export interface ForgeRepo {
+    /** 'owner/name' (or a deeper GitLab path). */
+    path: string;
+    /** The repository's web page. */
+    web: string;
+    /** The remote this was read from ('origin'). */
+    remote: string;
+}
+export interface ForgeItem {
+    number: number | string;
+    title: string;
+    url: string;
+    author?: string;
+    updated?: string;
+    state?: string;
+}
+export interface ForgeProvider {
+    /** The slot, the settings key and the route namespace: 'github'. */
+    id: string;
+    /** The button's text: 'GITHUB'. */
+    label: string;
+    /** The product's name in sentences: 'GitHub'. */
+    title: string;
+    /** The host this forge answers for, from the plugin's settings when it is configurable. */
+    host: () => string;
+    /** The CLI used when present (gh, glab); none for Bitbucket. */
+    cli?: string;
+    /** What the pull requests are called here: 'Pull requests' or 'Merge requests'. */
+    pullsLabel: string;
+    /** The environment a child process needs to authenticate at the host, or null when there is no credential. */
+    env: () => NodeJS.ProcessEnv | null;
+    /** Who the credential belongs to, for the settings page; never the token. */
+    auth: () => {
+        username?: string;
+        email?: string;
+        how: string;
+    };
+    /** The repository a remote URL names, if it is on this host. */
+    repoOf: (remoteUrl: string, remote: string) => ForgeRepo | null;
+    /** The clone URL of 'owner/name' (or a full URL given as is). */
+    cloneUrl: (spec: string) => string;
+    /** The pages of a repository. */
+    urls: (repo: ForgeRepo) => {
+        issues: string;
+        pulls: string;
+        newIssue: string;
+        newPull: (branch: string) => string;
+    };
+    listIssues: (repo: ForgeRepo, lib: PluginLib, env: NodeJS.ProcessEnv) => Promise<ForgeItem[]>;
+    listPulls: (repo: ForgeRepo, lib: PluginLib, env: NodeJS.ProcessEnv) => Promise<ForgeItem[]>;
+    /** The command that opens a pull request from the branch, run in a terminal in the project; null when there is no CLI (the New-pull page is linked instead). */
+    newPullCommand?: (repo: ForgeRepo, branch: string) => string;
+    /** The environment a `git clone` of a private repository needs (a credential helper); merged into the clone step. */
+    cloneEnv?: () => string;
+    /** The pattern a clone spec must match, and its help. */
+    clone: {
+        pattern: RegExp;
+        placeholder: string;
+        help: string;
+    };
+    /** Where the token comes from, for the message when there is none. */
+    tokenHint: string;
+}

package/dist/src/provider.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * What a git forge is, to the dashboard.
+ *
+ * A forge hosts repositories, issues and pull (or merge) requests at one host, and the dashboard
+ * authenticates there with a credential a person put in the forge plugin's settings. A provider
+ * knows the host, how to read a remote URL, where the pages are, how to list the open issues and
+ * requests, and which command opens a request from a branch. The row menu, the modals, the chip,
+ * the clone option and the credential hook are the family's (registerForge).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=provider.js.map

package/dist/src/provider.js.map

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

package/package.json

@@ -1,6 +1,31 @@
 {
   "name": "@webship.co/workspace-forge",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-alpha1",
+  "description": "The forge family's shared base for Webship Workspace plugins: the ForgeProvider contract, and the row menu (repository, issues, pull requests, open a pull request), the repo chip, the clone option in New folder and the credential the dashboard uses for the host, registered through registerForge(api, forge).",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webship/workspace-forge.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"
+  }
+}