ninedeploy 0.18.26 → 0.18.28

package/dist/lib/importers/sources.js

@@ -0,0 +1,100 @@
+import { stripUserinfo } from './plan.js';
+export class SourceError extends Error {
+}
+/** CapRover asked for a two-factor code (status 1114). */
+export class OtpRequiredError extends SourceError {
+}
+/** `https://host[:port][/prefix]` without a trailing slash or userinfo. */
+export function normaliseBase(raw) {
+    let u;
+    try {
+        u = new URL(raw);
+    }
+    catch {
+        throw new SourceError(`Not a URL: ${stripUserinfo(raw)}`);
+    }
+    if (u.protocol !== 'https:' && u.protocol !== 'http:')
+        throw new SourceError('The source URL must start with https:// (or http://).');
+    return stripUserinfo(`${u.origin}${u.pathname}`).replace(/\/+$/, '');
+}
+async function body(res) {
+    const text = await res.text();
+    if (!text)
+        return null;
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        return text;
+    }
+}
+function httpError(res, what, hint = '') {
+    return new SourceError(`${what} answered HTTP ${res.status}${hint ? `: ${hint}` : ''}`);
+}
+/** Coolify: `Authorization: Bearer <token>`; a plain `read` token is enough. */
+export function coolifySource(base, token, f = fetch) {
+    return async (path) => {
+        const res = await f(`${base}${path}`, { headers: { authorization: `Bearer ${token}`, accept: 'application/json' } });
+        const data = await body(res);
+        if (res.ok)
+            return data;
+        const message = typeof data === 'object' && data && 'message' in data ? String(data.message) : '';
+        if (res.status === 403 && /api is disabled/i.test(message))
+            throw httpError(res, 'Coolify', 'the API is off. Turn it on under Settings → Advanced → API access.');
+        if (res.status === 401)
+            throw httpError(res, 'Coolify', 'the token was refused (create one under Keys & Tokens → API tokens, with "read").');
+        if (res.status === 403)
+            throw httpError(res, 'Coolify', message || 'the token lacks access (IP allow-list, scope or ability).');
+        throw httpError(res, `Coolify ${path}`, message);
+    };
+}
+/** Dokploy: `x-api-key`, tRPC procedures as `GET /api/<procedure>?<input>`. */
+export function dokploySource(base, apiKey, f = fetch) {
+    return async (path) => {
+        const res = await f(`${base}${path}`, { headers: { 'x-api-key': apiKey, accept: 'application/json' } });
+        const data = await body(res);
+        if (res.ok)
+            return data;
+        // Dokploy answers a plain 401 for a wrong key and for one past its rate limit alike (checked live on v0.31.0).
+        if (res.status === 401)
+            throw httpError(res, 'Dokploy', 'the API key was refused: it is wrong, belongs to another organization, or has used up its rate limit. A Dokploy key allows 10 requests a day unless it was created with rate limiting off, and a plan makes 2 plus one per application, compose stack and database. Create one under Profile → API keys with rate limiting off.');
+        const message = typeof data === 'object' && data && 'message' in data ? String(data.message) : '';
+        throw httpError(res, `Dokploy ${path.split('?')[0]}`, message);
+    };
+}
+/**
+ * CapRover: sign in once (never retried: each wrong password starts a 30 s
+ * back-off), then send `x-captain-auth`. Errors arrive with HTTP 200 and a
+ * non-100 `status` in the envelope.
+ */
+export async function caproverSource(base, password, otp, f = fetch) {
+    const res = await f(`${base}/api/v2/login/`, {
+        method: 'POST',
+        headers: { 'content-type': 'application/json', 'x-namespace': 'captain' },
+        body: JSON.stringify(otp ? { password, otpToken: otp } : { password }),
+    });
+    if (!res.ok)
+        throw httpError(res, 'CapRover sign-in');
+    const env = (await body(res));
+    if (env?.status === 1114)
+        throw new OtpRequiredError('CapRover asks for a two-factor code.');
+    if (env?.status === 1113)
+        throw new SourceError('CapRover is pausing sign-ins after a wrong password; wait 30 seconds and try again.');
+    if (env?.status === 1105)
+        throw new SourceError('CapRover refused the password (or the two-factor code).');
+    const token = env?.data?.token;
+    if (env?.status !== 100 || typeof token !== 'string')
+        throw new SourceError(`CapRover sign-in failed (status ${env?.status ?? '?'}).`);
+    return async (path) => {
+        const r = await f(`${base}${path}`, { headers: { 'x-captain-auth': token, 'x-namespace': 'captain', accept: 'application/json' } });
+        if (!r.ok)
+            throw httpError(r, `CapRover ${path}`);
+        const e = (await body(r));
+        if (e?.status === 1106)
+            throw new SourceError('CapRover no longer accepts the session (it restarted, or the password changed); run the import again.');
+        if (e?.status !== 100)
+            throw new SourceError(`CapRover ${path} failed (status ${e?.status ?? '?'}${e?.description ? `: ${e.description}` : ''}).`);
+        return e.data;
+    };
+}
+//# sourceMappingURL=sources.js.map

package/dist/lib/importers/sources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sources.js","sourceRoot":"","sources":["../../../src/lib/importers/sources.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,MAAM,OAAO,WAAY,SAAQ,KAAK;CAAG;AACzC,0DAA0D;AAC1D,MAAM,OAAO,gBAAiB,SAAQ,WAAW;CAAG;AAIpD,2EAA2E;AAC3E,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,IAAI,CAAM,CAAC;IACX,IAAI,CAAC;QACH,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,WAAW,CAAC,cAAc,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,KAAK,OAAO;QAAE,MAAM,IAAI,WAAW,CAAC,uDAAuD,CAAC,CAAC;IACtI,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,GAAa;IAC/B,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAC9B,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACvB,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,GAAa,EAAE,IAAY,EAAE,IAAI,GAAG,EAAE;IACvD,OAAO,IAAI,WAAW,CAAC,GAAG,IAAI,kBAAkB,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAC1F,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,KAAa,EAAE,CAAC,GAAU,KAAK;IACzE,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;QACrH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,GAAG,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;QACxB,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAE,IAA6B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5H,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC;YAAE,MAAM,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,oEAAoE,CAAC,CAAC;QAClK,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG;YAAE,MAAM,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,mFAAmF,CAAC,CAAC;QAC7I,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG;YAAE,MAAM,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,IAAI,2DAA2D,CAAC,CAAC;QAChI,MAAM,SAAS,CAAC,GAAG,EAAE,WAAW,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,MAAc,EAAE,CAAC,GAAU,KAAK;IAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;QACxG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,GAAG,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;QACxB,+GAA+G;QAC/G,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG;YAAE,MAAM,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,iUAAiU,CAAC,CAAC;QAC3X,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,IAAI,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAE,IAA6B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5H,MAAM,SAAS,CAAC,GAAG,EAAE,WAAW,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC,CAAC;AACJ,CAAC;AAID;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAAY,EAAE,QAAgB,EAAE,GAAuB,EAAE,CAAC,GAAU,KAAK;IAC5G,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,GAAG,IAAI,gBAAgB,EAAE;QAC3C,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,aAAa,EAAE,SAAS,EAAE;QACzE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;KACvE,CAAC,CAAC;IACH,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,MAAM,SAAS,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,CAA4B,CAAC;IACzD,IAAI,GAAG,EAAE,MAAM,KAAK,IAAI;QAAE,MAAM,IAAI,gBAAgB,CAAC,sCAAsC,CAAC,CAAC;IAC7F,IAAI,GAAG,EAAE,MAAM,KAAK,IAAI;QAAE,MAAM,IAAI,WAAW,CAAC,qFAAqF,CAAC,CAAC;IACvI,IAAI,GAAG,EAAE,MAAM,KAAK,IAAI;QAAE,MAAM,IAAI,WAAW,CAAC,yDAAyD,CAAC,CAAC;IAC3G,MAAM,KAAK,GAAI,GAAG,EAAE,IAAwC,EAAE,KAAK,CAAC;IACpE,IAAI,GAAG,EAAE,MAAM,KAAK,GAAG,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,MAAM,IAAI,WAAW,CAAC,mCAAmC,GAAG,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC;IACvI,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;QACpI,IAAI,CAAC,CAAC,CAAC,EAAE;YAAE,MAAM,SAAS,CAAC,CAAC,EAAE,YAAY,IAAI,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAA4B,CAAC;QACrD,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI;YAAE,MAAM,IAAI,WAAW,CAAC,uGAAuG,CAAC,CAAC;QACvJ,IAAI,CAAC,EAAE,MAAM,KAAK,GAAG;YAAE,MAAM,IAAI,WAAW,CAAC,YAAY,IAAI,mBAAmB,CAAC,EAAE,MAAM,IAAI,GAAG,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACnJ,OAAO,CAAC,CAAC,IAAI,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ninedeploy",
-  "version": "0.18.26",
+  "version": "0.18.28",
   "description": "Interactive CLI for NineDeploy self-hosted PaaS",
   "license": "MIT",
   "repository": {
@@ -23,8 +23,8 @@
     "ninedeploy": "./dist/index.js"
   },
   "dependencies": {
-    "@ninedeploy/sdk": "0.18.26",
-    "@ninedeploy/schemas": "0.18.26",
+    "@ninedeploy/sdk": "0.18.28",
+    "@ninedeploy/schemas": "0.18.28",
     "commander": "^15.0.0",
     "ws": "^8.21.3"
   },

package/src/commands/databaseUpgrade.ts

@@ -0,0 +1,144 @@
+/**
+ * `ninedeploy databases upgrade …` — O2 major-version upgrades (PostgreSQL,
+ * MySQL and MariaDB on the panel host).
+ *
+ *   status <dbId>                              current release, targets, and the upgrade history
+ *   start <dbId> --to <release> [--yes] [--no-wait]
+ *                                              stop, move into a new volume (PostgreSQL: dump and
+ *                                              restore; MySQL/MariaDB: copy and upgrade in place),
+ *                                              compare, switch
+ *   rollback <dbId> <upgradeId> [--yes]        point the database back at the previous volume
+ *   finalize <dbId> <upgradeId> [--yes]        delete the volume the database no longer uses
+ */
+import type { NineDeployClient } from '../client.js';
+import { prompt } from '../prompts.js';
+import { c, error, header, info, kv, spinner, success, table } from '../lib/format.js';
+
+type Upgrade = Awaited<ReturnType<NineDeployClient['databases']['upgrades']['start']>>;
+
+const LABELS: Record<string, string> = { postgres: 'PostgreSQL', mysql: 'MySQL', mariadb: 'MariaDB' };
+const label = (engine: string) => LABELS[engine] ?? engine;
+/** `fromSeries`/`toSeries` arrive from 0.18.28; older panels send only the majors. */
+const fromOf = (u: Upgrade) => u.fromSeries ?? String(u.fromMajor);
+const toOf = (u: Upgrade) => u.toSeries ?? String(u.toMajor);
+
+const num = (v: string | undefined, usage: string): number | null => {
+  const n = Number(v);
+  if (!Number.isInteger(n) || n <= 0) {
+    error(usage);
+    process.exitCode = 1;
+    return null;
+  }
+  return n;
+};
+const fail = (err: unknown): void => {
+  error(err instanceof Error ? err.message : String(err));
+  process.exitCode = 1;
+};
+const confirm = async (word: string, question: string): Promise<boolean> => {
+  const answer = await prompt(`${question} Type "${word}" to continue`, '');
+  if (answer.trim() !== word) {
+    info('Aborted.');
+    return false;
+  }
+  return true;
+};
+
+function describeOutcome(u: Upgrade, dbId: number): void {
+  if (u.status === 'completed') {
+    success(`Upgraded to ${label(u.engine)} ${toOf(u)}.`);
+    if (u.verification) {
+      const extra = u.verification.users != null ? `, ${u.verification.users} account(s)` : `, ${u.verification.sequences} sequence(s)`;
+      info(`Compared before the switch: ${u.verification.tables} table(s), ${u.verification.rows} row(s)${extra}.`);
+    }
+    info(`The previous volume ${u.previousVolume} is kept. Check your services, then: ninedeploy databases upgrade finalize ${dbId} ${u.id}`);
+    info(`To go back to ${label(u.engine)} ${fromOf(u)}: ninedeploy databases upgrade rollback ${dbId} ${u.id}`);
+  } else {
+    error(`The upgrade ${u.status === 'failed' ? 'failed' : `ended ${u.status}`}: ${u.error ?? 'no reason recorded'}`);
+    process.exitCode = 1;
+  }
+}
+
+export async function upgradeStatus(client: NineDeployClient, dbIdStr: string): Promise<void> {
+  const id = num(dbIdStr, 'Usage: ninedeploy databases upgrade status <dbId>');
+  if (id === null) return;
+  let options: Awaited<ReturnType<NineDeployClient['databases']['upgrades']['options']>>;
+  let history: Upgrade[];
+  try {
+    [options, history] = await spinner('Reading the cluster', () => Promise.all([client.databases.upgrades.options(id), client.databases.upgrades.list(id)]));
+  } catch (err) { fail(err); return; }
+  header('Major upgrade');
+  const name = label(options.engine ?? 'postgres');
+  const current = options.currentSeries ?? (options.currentMajor != null ? String(options.currentMajor) : null);
+  kv('Running', current != null ? `${name} ${current}` : c.dim('unknown'));
+  if (options.refusal) info(options.refusal.message);
+  else kv('Can move to', (options.versions ?? options.targets.map(String)).map((v) => `${name} ${v}`).join(', '));
+  if (history.length) {
+    table(history.map((u) => ({
+      id: u.id,
+      upgrade: `${fromOf(u)} → ${toOf(u)}`,
+      status: u.status === 'running' ? `running (${u.phase ?? '…'})` : u.status,
+      started: u.createdAt,
+      kept: u.status === 'completed' ? u.previousVolume : u.status === 'rolled_back' ? u.targetVolume : '',
+      error: u.error ?? '',
+    })));
+  }
+}
+
+export async function upgradeStart(
+  client: NineDeployClient,
+  dbIdStr: string,
+  opts: { to?: string; yes?: boolean; wait?: boolean; pollMs?: number } = {},
+): Promise<void> {
+  const usage = 'Usage: ninedeploy databases upgrade start <dbId> --to <release> [--yes] [--no-wait]';
+  const id = num(dbIdStr, usage);
+  if (id === null) return;
+  const to = (opts.to ?? '').trim();
+  if (!/^[0-9]{1,2}([.][0-9]{1,2})?$/.test(to)) {
+    error(`--to must be a release, e.g. --to 18 (PostgreSQL), --to 8.4 (MySQL) or --to 11.8 (MariaDB). ${usage}`);
+    process.exitCode = 1;
+    return;
+  }
+  if (!opts.yes && !(await confirm('upgrade', `The database stops for the whole upgrade (a safety dump, the move to ${to} in a new volume, a comparison). Attached services lose their connection until it is back.`))) return;
+  // A whole number goes as toMajor, which panels from before MySQL/MariaDB upgrades also accept.
+  const input = /^[0-9]+$/.test(to) ? { toMajor: Number(to) } : { toVersion: to };
+  let admitted: Upgrade;
+  try { admitted = await spinner('Checking the database', () => client.databases.upgrades.start(id, input)); } catch (err) { fail(err); return; }
+  const target = `${label(admitted.engine)} ${toOf(admitted)}`;
+  if (opts.wait === false) {
+    success(`Upgrade #${admitted.id} to ${target} is running. Follow it with: ninedeploy databases upgrade status ${id}`);
+    return;
+  }
+  let done: Upgrade;
+  try {
+    done = await spinner(`Upgrading to ${target}`, () => client.databases.upgrades.wait(id, admitted.id, opts.pollMs ? { intervalMs: opts.pollMs } : {}));
+  } catch (err) { fail(err); return; }
+  describeOutcome(done, id);
+}
+
+export async function upgradeRollback(client: NineDeployClient, dbIdStr: string, upgradeIdStr: string, opts: { yes?: boolean } = {}): Promise<void> {
+  const usage = 'Usage: ninedeploy databases upgrade rollback <dbId> <upgradeId> [--yes]';
+  const id = num(dbIdStr, usage);
+  if (id === null) return;
+  const upgradeId = num(upgradeIdStr, usage);
+  if (upgradeId === null) return;
+  if (!opts.yes && !(await confirm('rollback', 'The database restarts on its previous volume. Writes made since the upgrade stay on the upgraded volume and are NOT carried back.'))) return;
+  try {
+    const u = await spinner('Rolling back', () => client.databases.upgrades.rollback(id, upgradeId));
+    success(`The database runs on ${label(u.engine)} ${fromOf(u)} again (${u.previousVolume}).`);
+    info(`The upgraded volume ${u.targetVolume} is kept. Delete it with: ninedeploy databases upgrade finalize ${id} ${u.id}`);
+  } catch (err) { fail(err); }
+}
+
+export async function upgradeFinalize(client: NineDeployClient, dbIdStr: string, upgradeIdStr: string, opts: { yes?: boolean } = {}): Promise<void> {
+  const usage = 'Usage: ninedeploy databases upgrade finalize <dbId> <upgradeId> [--yes]';
+  const id = num(dbIdStr, usage);
+  if (id === null) return;
+  const upgradeId = num(upgradeIdStr, usage);
+  if (upgradeId === null) return;
+  if (!opts.yes && !(await confirm('finalize', 'The volume the database no longer uses is DELETED; after this there is no rollback.'))) return;
+  try {
+    const u = await spinner('Finalizing', () => client.databases.upgrades.finalize(id, upgradeId));
+    success(`Deleted ${u.removedVolume}.`);
+  } catch (err) { fail(err); }
+}