@getxflow/cli 0.28.0 → 0.29.0

package/dist/api.js

@@ -16,7 +16,9 @@ class ApiError extends Error {
     limit;
     removing;
     request;
-    constructor(message, code, status, hint, details = {}) {
+    /** The platform that answered: its signed-in organizations are the ones worth naming. */
+    apiUrl;
+    constructor(message, code, status, hint, details = {}, apiUrl) {
         super(message);
         this.name = 'ApiError';
         this.code = code;
@@ -26,6 +28,7 @@ class ApiError extends Error {
         this.limit = details.limit;
         this.removing = details.removing;
         this.request = details.request;
+        this.apiUrl = apiUrl;
     }
 }
 exports.ApiError = ApiError;
@@ -126,7 +129,7 @@ async function readError(response, client) {
     const text = await response.text().catch(() => '');
     try {
         const parsed = JSON.parse(text);
-        return new ApiError(parsed.error || `Request rejected (${response.status})`, parsed.code || 'unknown', response.status, parsed.hint, parsed);
+        return new ApiError(parsed.error || `Request rejected (${response.status})`, parsed.code || 'unknown', response.status, parsed.hint, parsed, client.apiUrl);
     }
     catch {
         return notAnAnswer(response.status, client.apiUrl, text);

package/dist/bin.js

@@ -176,11 +176,15 @@ async function run(args) {
                 await (0, db_1.dbQuery)({ ...args, words: args.words.slice(2) });
                 return;
             }
+            if (second === 'move') {
+                await (0, db_1.dbMove)(rest);
+                return;
+            }
             if (second === undefined || second === 'status') {
                 await (0, db_1.dbStatus)({ ...args, words: args.words.slice(2) });
                 return;
             }
-            throw new errors_1.CliError(`Unknown command: db ${second}`, 'Available: status, list, schema, query and migrate');
+            throw new errors_1.CliError(`Unknown command: db ${second}`, 'Available: status, list, schema, query, migrate and move');
         case 'storage':
             if (second === 'push') {
                 await (0, storage_1.storagePush)(rest);
@@ -327,7 +331,7 @@ async function main() {
                 if (process.env.XFLOW_TOKEN?.trim()) {
                     (0, ui_1.fatalNote)((0, ui_1.dim)('  XFLOW_TOKEN is set: it is the key of one organization and is used as it comes, so a project or a page of another one is not found'));
                 }
-                else if ((0, credentials_1.anyMultipleOrgs)()) {
+                else if (e.apiUrl && (0, credentials_1.listOrgs)(e.apiUrl).length > 1) {
                     (0, ui_1.fatalNote)((0, ui_1.dim)('  Several organizations are signed in: the answer may live in another one, see xflow org'));
                 }
             }

package/dist/commands/db.js

@@ -4,6 +4,7 @@ exports.dbStatus = dbStatus;
 exports.dbList = dbList;
 exports.dbSchema = dbSchema;
 exports.dbQuery = dbQuery;
+exports.dbMove = dbMove;
 exports.dbMigrate = dbMigrate;
 const node_fs_1 = require("node:fs");
 const node_crypto_1 = require("node:crypto");
@@ -24,12 +25,34 @@ function serverLabel(server) {
         return 'platform';
     return server.status === 'active' ? `own "${server.name}"` : `own "${server.name}", ${server.status}`;
 }
-function printPlace(history) {
+const moving = (move) => move?.status === 'copying' || move?.status === 'switching';
+/** Asked apart from the history: during a move the database does not answer, this does. */
+async function projectDatabase(client, projectId) {
+    try {
+        return await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/db/move`);
+    }
+    catch (e) {
+        if (e instanceof api_1.ApiError && e.code === 'not_deployed')
+            return null;
+        throw e;
+    }
+}
+function printPlace(history, place) {
     (0, ui_1.out)(`Schema: ${(0, ui_1.bold)(history.schema)}`);
     if (history.server !== undefined)
         (0, ui_1.out)(`Server: ${serverLabel(history.server)}`);
+    if (place?.move)
+        (0, ui_1.out)(`Move:   ${moveLine(place.move)}`);
     (0, ui_1.out)('');
 }
+/** Mid-move the history cannot be read, so the answer is the move itself. */
+function printMoving(place) {
+    if (place.database)
+        (0, ui_1.out)(`Database: ${(0, ui_1.bold)(place.database.name)}`);
+    (0, ui_1.out)(`Server:   ${serverLabel(place.server)}`);
+    (0, ui_1.out)(`Move:     ${place.move?.note ?? ''}`);
+    (0, ui_1.note)((0, ui_1.dim)('  Migrations and queries wait until it is over; the platform finishes it on its own'));
+}
 function checksum(sql) {
     return (0, node_crypto_1.createHash)('sha256').update(sql).digest('hex').slice(0, 16);
 }
@@ -58,8 +81,11 @@ async function dbStatus(args) {
     // is the applied history alone, which does not depend on any working copy.
     if ((0, args_1.flagString)(args, 'project') !== undefined) {
         const { projectId, client } = await (0, session_1.projectTarget)(args);
+        const place = await projectDatabase(client, projectId);
+        if (place && moving(place.move))
+            return printMoving(place);
         const history = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/db/migrate`);
-        printPlace(history);
+        printPlace(history, place);
         if (history.applied.length === 0) {
             (0, ui_1.note)('No migrations have been applied yet');
             return;
@@ -71,9 +97,12 @@ async function dbStatus(args) {
     const { root, config } = (0, config_1.requireProject)();
     const client = await (0, session_1.connectProject)(config.projectId, root, config);
     const local = readMigrations(root);
+    const place = await projectDatabase(client, config.projectId);
+    if (place && moving(place.move))
+        return printMoving(place);
     const history = await (0, api_1.apiJson)(client, `/api/v1/projects/${config.projectId}/db/migrate`);
     const applied = new Map(history.applied.map((row) => [row.name, row]));
-    printPlace(history);
+    printPlace(history, place);
     if (local.length === 0 && applied.size === 0) {
         (0, ui_1.note)(`No migrations. The first one: ${MIGRATIONS_DIR}/0001_init.sql`);
         return;
@@ -104,6 +133,19 @@ async function dbStatus(args) {
         (0, ui_1.warn)('A changed file will not be applied again: write a new migration');
     }
 }
+function serverRow(server) {
+    const room = server.used_bytes !== null && server.space_bytes !== null
+        ? `${(0, ui_1.formatBytes)(server.used_bytes)} of ${(0, ui_1.formatBytes)(server.space_bytes)} used`
+        : '';
+    return [
+        server.id === null ? 'platform' : `own "${server.name}"`,
+        server.id === null ? 'plan space' : server.tier ?? '',
+        server.status === 'active' ? '' : server.status,
+        room,
+        `${server.databases} ${server.databases === 1 ? 'database' : 'databases'}`,
+        server.new_databases_here ? 'new databases go here' : '',
+    ];
+}
 function attachedProjects(database) {
     const names = database.projects.map((project) => project.name);
     if (database.hidden_projects > 0)
@@ -123,24 +165,34 @@ async function dbList() {
     if (data.databases.length === 0) {
         (0, ui_1.note)('The organization has no databases');
         (0, ui_1.note)((0, ui_1.dim)('  One is created with the first project: xflow init'));
-        return;
     }
-    (0, ui_1.table)(data.databases.map((database) => [
+    else {
+        printDatabases(data.databases, data.total, data.truncated);
+    }
+    printServers(data.servers);
+}
+function moveLine(move) {
+    return move.finished_at ? `${move.note} (${(0, ui_1.formatAge)(move.finished_at)})` : move.note;
+}
+function printDatabases(databases, total, truncated) {
+    (0, ui_1.table)(databases.map((database) => [
         database.name,
         database.id,
         database.schema ?? '-',
         serverLabel(database.server),
         attachedProjects(database),
     ]));
-    if (data.truncated)
-        (0, ui_1.note)((0, ui_1.dim)(`  Shown ${data.databases.length} of ${data.total}`));
-    for (const database of data.databases) {
+    if (truncated)
+        (0, ui_1.note)((0, ui_1.dim)(`  Shown ${databases.length} of ${total}`));
+    for (const database of databases) {
         const attached = database.projects.length + database.hidden_projects;
         if (attached > 1)
             (0, ui_1.note)((0, ui_1.dim)(`  ${database.name} is shared by ${attached} projects: a migration affects all of them`));
+        if (database.move)
+            (0, ui_1.note)((0, ui_1.dim)(`  ${database.name}: ${moveLine(database.move)}`));
     }
     const down = new Map();
-    for (const { server } of data.databases)
+    for (const { server } of databases)
         if (server && server.status !== 'active')
             down.set(server.id, server);
     for (const server of down.values()) {
@@ -148,6 +200,15 @@ async function dbList() {
             'Not fixable from the code: tell the person, the server state is in the "Data" section of the web interface'));
     }
 }
+/** Where a new or a moved database can go, with the room on each. Only the platform: no choice to show. */
+function printServers(servers) {
+    if (!servers || servers.length < 2)
+        return;
+    (0, ui_1.out)('');
+    (0, ui_1.out)((0, ui_1.bold)('Servers'));
+    (0, ui_1.table)(servers.map(serverRow));
+    (0, ui_1.note)((0, ui_1.dim)('  A new project with its database on one of them: xflow init --server <name>. An existing one: xflow db move --to <name>'));
+}
 /** Long values would tear the columns apart; the cut is marked, never silent. */
 const CELL_LIMIT = 60;
 function plain(value) {
@@ -255,6 +316,62 @@ async function dbQuery(args) {
             : `  Shown the first ${data.rows.length} rows, more exist: narrow the query, with a where clause or an offset`));
     }
 }
+const MOVE_POLL_MS = 3_000;
+/** Past this the command lets go: the move carries on, db status follows it. */
+const MOVE_FOLLOW_MS = 10 * 60_000;
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+/**
+ * Moving the project database to another server of the organization. The platform
+ * runs the move by itself; this command starts it and follows it to the end.
+ */
+async function dbMove(args) {
+    const to = (0, args_1.flagString)(args, 'to');
+    if (!to) {
+        throw new errors_1.CliError('Name the server: --to <name>', 'The servers and their names: xflow db list ("platform" is the common one)');
+    }
+    const { projectId, client } = await (0, session_1.projectTarget)(args);
+    const path = `/api/v1/projects/${projectId}/db/move`;
+    let place;
+    try {
+        place = await (0, api_1.apiJson)(client, path, {
+            method: 'POST',
+            body: { to, confirm: (0, args_1.flagString)(args, 'confirm') },
+            timeoutMs: 60_000,
+        });
+    }
+    catch (e) {
+        // Said in the words of this command: the flag, and the name that goes in it.
+        if (e instanceof api_1.ApiError && e.code === 'confirm_required') {
+            const found = await projectDatabase(client, projectId).catch(() => null);
+            const name = found?.database?.name ?? '<database>';
+            throw new errors_1.CliError(e.message, `To move it: xflow db move --to "${to}" --confirm "${name}"`);
+        }
+        throw e;
+    }
+    (0, ui_1.note)((0, ui_1.dim)('  The platform carries the move through by itself: stopping this command does not stop it'));
+    const deadline = Date.now() + MOVE_FOLLOW_MS;
+    let shown = '';
+    while (moving(place.move)) {
+        const line = place.move?.note ?? '';
+        if (line !== shown)
+            (0, ui_1.step)(line);
+        shown = line;
+        if (Date.now() > deadline) {
+            (0, ui_1.note)('Still going: xflow db status follows it');
+            return;
+        }
+        await sleep(MOVE_POLL_MS);
+        place = await (0, api_1.apiJson)(client, path);
+    }
+    const { move } = place;
+    if (move?.status === 'failed')
+        throw new errors_1.CliError(move.note);
+    if (move && (move.functions_done ?? 0) < (move.functions_total ?? 0)) {
+        (0, ui_1.warn)(move.note);
+        return;
+    }
+    (0, ui_1.ok)(move?.note ?? `The database is on ${serverLabel(place.server)}`);
+}
 async function dbMigrate(args) {
     const { root, config } = (0, config_1.requireProject)();
     const client = await (0, session_1.connectProject)(config.projectId, root, config);

package/dist/commands/projects.js

@@ -69,7 +69,8 @@ async function init(args) {
     (0, ui_1.step)('Creating the project on the platform');
     const project = await (0, api_1.apiJson)(client, '/api/v1/projects', {
         method: 'POST',
-        body: { name, database_id: (0, args_1.flagString)(args, 'database') ?? null },
+        body: { name, database_id: (0, args_1.flagString)(args, 'database') ?? null, server: (0, args_1.flagString)(args, 'server') ?? null },
+        timeoutMs: 60_000,
     });
     try {
         (0, node_fs_1.mkdirSync)(target, { recursive: true });
@@ -94,6 +95,10 @@ async function init(args) {
     }
     (0, skills_1.installSkillQuietly)(target);
     (0, ui_1.ok)(`Project "${project.name}" created: ${files.length} template files`);
+    if (project.database) {
+        const { server } = project.database;
+        (0, ui_1.note)((0, ui_1.dim)(`  Its database "${project.database.name}" is on ${server ? `own "${server.name}"` : 'the platform server'}`));
+    }
     (0, ui_1.out)('');
     (0, ui_1.out)(`  ${(0, ui_1.bold)('Next:')}`);
     (0, ui_1.out)(`    cd ${(0, node_path_1.basename)(target)}`);

package/dist/credentials.js

@@ -7,7 +7,6 @@ exports.rememberOrgName = rememberOrgName;
 exports.setActiveOrg = setActiveOrg;
 exports.forgetOrg = forgetOrg;
 exports.forgetAllOrgs = forgetAllOrgs;
-exports.anyMultipleOrgs = anyMultipleOrgs;
 exports.pickKey = pickKey;
 exports.storedKeyInputs = storedKeyInputs;
 const node_fs_1 = require("node:fs");
@@ -198,11 +197,6 @@ function forgetAllOrgs(apiUrl) {
     writeStore(store);
     return true;
 }
-/** True when any address holds keys of more than one organization. */
-function anyMultipleOrgs() {
-    const store = readStore();
-    return Object.values(store.orgs ?? {}).some((address) => Object.keys(address.keys).length > 1);
-}
 /**
  * One rule for the whole CLI: XFLOW_TOKEN (default address only) beats the
  * folder's organization, which beats the active one. A folder bound to an

package/dist/flags.js

@@ -40,7 +40,7 @@ exports.KNOWN = {
     'org members': [],
     'org switch': [],
     templates: [],
-    init: ['name', 'template', 'database'],
+    init: ['name', 'template', 'database', 'server'],
     link: [],
     projects: [],
     'projects list': [],
@@ -75,6 +75,7 @@ exports.KNOWN = {
     'db schema': ['project'],
     'db query': ['limit', 'json', 'project'],
     'db migrate': ['dry-run', 'allow-destructive'],
+    'db move': ['to', 'confirm', 'project'],
     storage: ['json', 'project'],
     'storage ls': ['json', 'project'],
     'storage list': ['json', 'project'],

package/dist/help.js

@@ -88,6 +88,8 @@ ${(0, ui_1.bold)('Database')}
   xflow db query "select ..."     read data, in a read-only transaction
   xflow db migrate [--dry-run] [--allow-destructive]
                                   apply the migrations from migrations/*.sql
+  xflow db move --to <server> --confirm <database>
+                                  move the project database to another server
 
 ${(0, ui_1.bold)('Pages')}
   xflow pages                     public sites of the organization at <name>.xflowpage.ru
@@ -162,7 +164,7 @@ no working copy of its own:
   xflow db query --project 3f2a… "select id, title from tasks where done = false"
   xflow functions invoke kanban --project 3f2a… --data-file card.json
 
-Which commands: ${(0, ui_1.bold)('db status')}, ${(0, ui_1.bold)('db query')}, ${(0, ui_1.bold)('db schema')}, ${(0, ui_1.bold)('functions list')},
+Which commands: ${(0, ui_1.bold)('db status')}, ${(0, ui_1.bold)('db query')}, ${(0, ui_1.bold)('db schema')}, ${(0, ui_1.bold)('db move')}, ${(0, ui_1.bold)('functions list')},
 ${(0, ui_1.bold)('functions invoke')}, ${(0, ui_1.bold)('functions logs')}, ${(0, ui_1.bold)('logs')}, ${(0, ui_1.bold)('env')}, ${(0, ui_1.bold)('env rm')},
 ${(0, ui_1.bold)('connections')}, ${(0, ui_1.bold)('connections link')}, ${(0, ui_1.bold)('connections unlink')}, ${(0, ui_1.bold)('schedules')},
 ${(0, ui_1.bold)('schedules set')}, ${(0, ui_1.bold)('schedules rm')}, ${(0, ui_1.bold)('storage ls')}, ${(0, ui_1.bold)('storage push')},
@@ -295,13 +297,29 @@ will work.`,
                                    --json prints the values whole)
   xflow db query <file>.sql        the same, the query read from a file
   xflow db migrate                 apply migrations/*.sql
+  xflow db move --to <server> --confirm <database>
+                                   move the project database to another server
 
 ${(0, ui_1.bold)('list')} is about the organization, not about this project: it names the logical
 databases, the identifier ${(0, ui_1.bold)('xflow init --database <id>')} asks for, and the projects
 attached to each one. That last column is the one to read before a migration. The server
 column says where a database lives: ${(0, ui_1.bold)('platform')} is the common one, ${(0, ui_1.bold)('own "<name>"')} the
 organization's own server. While an own server is not running, its databases do not
-answer, and that is not fixable from the code: its state is in the web interface.
+answer, and that is not fixable from the code: its state is in the web interface. An
+organization with own servers also gets them listed, with the room used on each and the
+one new databases go to: that is the choice for ${(0, ui_1.bold)('xflow init --server')} and ${(0, ui_1.bold)('db move')}.
+
+${(0, ui_1.bold)('move')} takes the database of this project to another server of the organization:
+${(0, ui_1.bold)('platform')} or an own server by name (or id, when two share a name). The platform copies
+the tables, switches the functions of every project on the database and removes the old
+copy; nothing needs a deploy. While it copies, the applications read data but cannot save
+anything new, usually for a couple of minutes, and that goes for every project on the
+database, which is why ${(0, ui_1.bold)('--confirm')} takes the database name. It also needs the right
+to move databases on the key: off by default, only its owner turns it on, in the platform
+settings where the key permissions live. The command follows the move to the end;
+stopping it does not stop the move, and ${(0, ui_1.bold)('xflow db status')} shows where it stands. A move
+that fails is rolled back: the database stays where it was and works as before. Buying,
+paying for and deleting servers stay with the person, in the web interface.
 
 ${(0, ui_1.bold)('schema')} answers a different question than the ${(0, ui_1.bold)('migrations/')} directory: one logical
 database is shared by several projects, so the files say what you did, and the schema
@@ -700,6 +718,12 @@ is not a formality: your own palette on top of them looks foreign inside the pla
   --name <name>       project name (the folder name by default)
   --template <id>     a different template (the list: xflow templates)
   --database <id>     attach a logical database of the organization (the list: xflow db list)
+  --server <name>     a new database for the project, right away on that server:
+                      platform, or an own server of the organization (xflow db list)
+
+Without either flag the project gets its database with the first migration, on the
+server new databases of the organization go to. ${(0, ui_1.bold)('--server')} decides it up front: the
+server has to be running, and the database counts against the plan at once.
 
 The order: the project is created on the platform first, because without it there is
 nowhere to get the token for .env. If writing the files fails, the project stays empty

package/dist/ui.js

@@ -96,7 +96,9 @@ function formatBytes(bytes) {
         return `${bytes} B`;
     if (bytes < 1024 * 1024)
         return `${(bytes / 1024).toFixed(1)} KB`;
-    return `${(bytes / 1024 / 1024).toFixed(1)} MB`;
+    if (bytes < 1024 * 1024 * 1024)
+        return `${(bytes / 1024 / 1024).toFixed(1)} MB`;
+    return `${(bytes / 1024 / 1024 / 1024).toFixed(1)} GB`;
 }
 function formatAge(iso) {
     if (!iso)

package/dist/version.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_API_URL = exports.CLI_VERSION = void 0;
 /** Keep in sync with cli/package.json. */
-exports.CLI_VERSION = '0.28.0';
+exports.CLI_VERSION = '0.29.0';
 /** Overridden by XFLOW_API_URL or the `api` field in xflow.json. */
 exports.DEFAULT_API_URL = 'https://app.getxflow.com';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getxflow/cli",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "CLI for the XFlow platform: source sync, deployment and publishing of applications",
   "license": "UNLICENSED",
   "engines": {

package/skills/xflow/SKILL.md

@@ -22,7 +22,7 @@ contains the fix.
 
 ## Keeping these instructions current
 
-These instructions ship with xflow CLI 0.28.0, so the copy you are reading can be older than
+These instructions ship with xflow CLI 0.29.0, so the copy you are reading can be older than
 the CLI answering your commands.
 
 When the CLI says this file does not match it, run `xflow skills --refresh` and then **read
@@ -435,13 +435,24 @@ transaction (50 rows by default, `--limit` up to 300; `--json` prints long value
 with double quotes goes in a `.sql` file outside the project, `xflow db query ../q.sql`: PowerShell
 strips them from arguments. Look before you write a migration against a shared database.
 
-An organization can have its own database server, and its new databases are then created there.
-`xflow db list` names the server of each database (`platform` is the common one), `xflow db
-status` the one under this project. Code stays the same: `DATABASE_URL` arrives as before, pass it
-as is, without an `ssl` option (an own server is reached over a closed network, and `ssl` makes
-the connection fail). While an own server is not running, migrations and queries say so and
-functions that use the database time out. That is not your code and not yours to fix: tell the
-person, who sees the server state in the "Data" section of the web interface, instead of retrying.
+An organization can have own database servers, several of them for different jobs. `xflow db
+list` names the server of each database (`platform` is the common one) and lists the own servers
+with the room used and the one new databases go to; `xflow db status` names the one under this
+project. The server belongs to the database: projects sharing a database share its server.
+- A new project with its database on a chosen server: `xflow init --server <name>` (`platform`
+  for the common one). Without it the first migration creates the database where new ones go.
+- An existing database: `xflow db move --to <name> --confirm <database name>`. Writes to every
+  project on it close while it copies, usually a couple of minutes; the platform switches the
+  functions itself, no deploy. It needs the right to move databases, off on the key by default:
+  refused for the right, say what should move where and why, and the person turns it on or
+  moves it in the "Data" section.
+- Buying, paying for and deleting servers are the person's, in the web interface.
+
+Code stays the same: `DATABASE_URL` arrives as before, pass it as is, without an `ssl` option (an
+own server is reached over a closed network, and `ssl` makes the connection fail). While an own
+server is not running, migrations and queries say so and functions that use the database time
+out. That is not your code and not yours to fix: tell the person, who sees the server state in
+the "Data" section of the web interface, instead of retrying.
 
 ## File storage