@getxflow/cli 1.2.2 → 1.4.0

package/README.md

@@ -10,7 +10,7 @@ cd my-app/apps/my-app && npm install && xflow dev
 xflow deploy -m "First version"
 ```
 
-Requires Node 20+. The package has no dependencies: it holds an access key, and nobody
+Requires Node 22+. The package has no dependencies: it holds an access key, and nobody
 else's code belongs next to it.
 
 | Command | What it does |

package/dist/bin.js

@@ -176,6 +176,10 @@ async function run(args) {
                 await (0, db_1.dbQuery)({ ...args, words: args.words.slice(2) });
                 return;
             }
+            if (second === 'exec') {
+                await (0, db_1.dbExec)({ ...args, words: args.words.slice(2) });
+                return;
+            }
             if (second === 'move') {
                 await (0, db_1.dbMove)(rest);
                 return;
@@ -184,7 +188,7 @@ async function run(args) {
                 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, migrate and move');
+            throw new errors_1.CliError(`Unknown command: db ${second}`, 'Available: status, list, schema, query, exec, migrate and move');
         case 'storage':
             if (second === 'push') {
                 await (0, storage_1.storagePush)(rest);

package/dist/commands/db.js

@@ -4,6 +4,7 @@ exports.dbStatus = dbStatus;
 exports.dbList = dbList;
 exports.dbSchema = dbSchema;
 exports.dbQuery = dbQuery;
+exports.dbExec = dbExec;
 exports.dbMove = dbMove;
 exports.dbMigrate = dbMigrate;
 exports.migrateBeforeDeploy = migrateBeforeDeploy;
@@ -227,6 +228,20 @@ async function dbSchema(args) {
     ]));
     (0, ui_1.note)((0, ui_1.dim)('  Columns of one table: xflow db schema <table>'));
 }
+/**
+ * The statement typed after the command, or read from the .sql file named there.
+ * The hint is split in lines: an agent terminal cuts a long one at its width.
+ */
+function readSql(words, command, example, file) {
+    const typed = words.join(' ').trim();
+    const sql = /\.sql$/i.test(typed)
+        ? (0, text_file_1.readTextFile)(typed, 'An argument ending in .sql is read as a file: check the path, or end the statement with ;')
+        : typed;
+    if (!sql) {
+        throw new errors_1.CliError(typed ? `${typed} is empty` : 'An SQL statement is required', `For example: xflow db ${command} '${example}'\n  A long one from a file outside the project: xflow db ${command} ../${file}`);
+    }
+    return sql;
+}
 /**
  * Reading data.
  *
@@ -234,14 +249,7 @@ async function dbSchema(args) {
  * database itself rather than by us guessing at the text of the SQL.
  */
 async function dbQuery(args) {
-    const typed = args.words.join(' ').trim();
-    const sql = /\.sql$/i.test(typed)
-        ? (0, text_file_1.readTextFile)(typed, 'An argument ending in .sql is read as a file: check the path, or end the query with ;')
-        : typed;
-    if (!sql) {
-        throw new errors_1.CliError(typed ? `${typed} is empty` : 'A query is required', "For example: xflow db query 'select * from orders order by created_at desc limit 20', " +
-            'or a long one from a file outside the project: xflow db query ../report.sql');
-    }
+    const sql = readSql(args.words, 'query', 'select * from orders order by created_at desc limit 20', 'report.sql');
     const { projectId, client } = await (0, session_1.projectTarget)(args);
     const data = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/db/query`, {
         method: 'POST',
@@ -280,6 +288,46 @@ async function dbQuery(args) {
             : `  Shown the first ${data.rows.length} rows, more exist: narrow the query, with a where clause or an offset`));
     }
 }
+/**
+ * A one-off data change: one INSERT, UPDATE, DELETE or MERGE, saved at once and
+ * kept out of the migration history. The platform judges it by what the database
+ * reports, not by the text: schema changes are refused, a mass change asks for
+ * --allow-destructive.
+ */
+async function dbExec(args) {
+    const sql = readSql(args.words, 'exec', "update orders set status = 'paid' where id = 42", 'fix.sql');
+    const { projectId, client } = await (0, session_1.projectTarget)(args);
+    const data = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}/db/exec`, {
+        method: 'POST',
+        body: { sql, allow_destructive: (0, args_1.flagBool)(args, 'allow-destructive') },
+        timeoutMs: 120_000,
+    });
+    if ((0, args_1.flagBool)(args, 'json')) {
+        (0, ui_1.out)(JSON.stringify(data, null, 2));
+        return;
+    }
+    // A write inside WITH comes tagged SELECT: its count is the rows read, the tables below say what changed.
+    (0, ui_1.ok)(data.command === 'SELECT'
+        ? 'The writes inside WITH are saved'
+        : `${data.command}: ${data.row_count} ${data.row_count === 1 ? 'row' : 'rows'}, saved`);
+    for (const t of data.tables) {
+        const parts = [
+            t.inserted > 0 ? `${t.inserted} inserted` : '',
+            t.updated > 0 ? `${t.updated} updated` : '',
+            t.deleted > 0 ? `${t.deleted} deleted` : '',
+        ].filter(Boolean);
+        (0, ui_1.note)((0, ui_1.dim)(`  ${t.table}: ${parts.join(', ')}`));
+    }
+    for (const dump of data.dumps) {
+        (0, ui_1.note)((0, ui_1.dim)(`  Copy of ${dump.table} before the change: ${dump.rows} rows, kept for ${data.dump_retention_days} days`));
+    }
+    if (data.rows.length > 0) {
+        (0, ui_1.out)('');
+        (0, ui_1.table)([data.columns, ...data.rows.map((row) => data.columns.map((column) => cell(row[column])))]);
+        if (data.truncated)
+            (0, ui_1.note)((0, ui_1.dim)(`  The first ${data.rows.length} returned rows: the rest are saved but not sent back`));
+    }
+}
 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;

package/dist/commands/org.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.orgList = orgList;
 exports.orgMembers = orgMembers;
+exports.findOrg = findOrg;
 exports.orgSwitch = orgSwitch;
 const api_1 = require("../api");
 const config_1 = require("../config");
@@ -47,6 +48,19 @@ async function orgMembers() {
     const count = data.truncated ? `${data.members.length} of ${data.total}` : String(data.total);
     (0, ui_1.note)((0, ui_1.dim)(`  ${count} in "${org ? label(org) : 'the organization'}". Inviting and removing people happens in the platform interface`));
 }
+/** An organization by id, or by name ignoring case; a name shared by several asks for the id. */
+function findOrg(orgs, wanted) {
+    const byId = orgs.find((org) => org.organizationId === wanted);
+    if (byId)
+        return byId;
+    const byName = orgs.filter((org) => (org.name ?? '').toLowerCase() === wanted.toLowerCase());
+    if (byName.length > 1) {
+        throw new errors_1.CliError(`Several organizations are named "${wanted}"`, `Use the id instead: ${byName.map((org) => org.organizationId).join(', ')}`);
+    }
+    if (!byName[0])
+        throw new errors_1.CliError(`No stored key for "${wanted}"`, 'The list: xflow org. To add one: xflow login');
+    return byName[0];
+}
 /** Local switch of the active organization: a pointer move, no browser. */
 function orgSwitch(args) {
     const wanted = args.words[0];
@@ -57,15 +71,7 @@ function orgSwitch(args) {
     if (orgs.length === 0) {
         throw new errors_1.CliError(`No keys for ${apiUrl}`, 'Sign in: xflow login');
     }
-    const byId = orgs.find((org) => org.organizationId === wanted);
-    const byName = orgs.filter((org) => (org.name ?? '').toLowerCase() === wanted.toLowerCase());
-    if (!byId && byName.length > 1) {
-        throw new errors_1.CliError(`Several organizations are named "${wanted}"`, `Use the id instead: ${byName.map((org) => org.organizationId).join(', ')}`);
-    }
-    const target = byId ?? byName[0];
-    if (!target) {
-        throw new errors_1.CliError(`No stored key for "${wanted}"`, 'The list: xflow org. To add one: xflow login');
-    }
+    const target = findOrg(orgs, wanted);
     if (target.active) {
         (0, ui_1.ok)(`"${label(target)}" is already the active organization`);
         return;

package/dist/commands/projects.js

@@ -13,6 +13,7 @@ const args_1 = require("../args");
 const config_1 = require("../config");
 const credentials_1 = require("../credentials");
 const errors_1 = require("../errors");
+const org_1 = require("./org");
 const session_1 = require("../session");
 const skills_1 = require("./skills");
 const sources_1 = require("./sources");
@@ -61,12 +62,25 @@ async function init(args) {
     const target = (0, node_path_1.resolve)(args.words[0] ?? '.');
     const name = (0, args_1.flagString)(args, 'name') ?? (0, node_path_1.basename)(target);
     const noApp = (0, args_1.flagBool)(args, 'no-app');
-    const client = (0, session_1.connect)();
+    let client = (0, session_1.connect)();
+    // A person in several organizations names the one that gets the project: the active one may be a client's.
+    const orgs = client.source === 'env' ? [] : (0, credentials_1.listOrgs)(client.apiUrl);
+    const wanted = (0, args_1.flagString)(args, 'org');
+    if (wanted) {
+        if (client.source === 'env')
+            throw new errors_1.CliError('--org does not apply to a key from XFLOW_TOKEN', 'That key belongs to one organization: drop --org');
+        const org = (0, org_1.findOrg)(orgs, wanted);
+        client = { apiUrl: client.apiUrl, token: org.token, source: 'folder', organizationId: org.organizationId };
+    }
+    else if (orgs.length > 1) {
+        throw new errors_1.CliError(`You are signed in to ${orgs.length} organizations: name the one that gets the project`, `xflow init ${args.words[0] ?? '.'} --org <name>. The list: xflow org`);
+    }
+    const orgName = orgs.find((org) => org.organizationId === client.organizationId)?.name;
     if (!isEmptyEnough(target)) {
         throw new errors_1.CliError(`The directory ${target} is not empty`, 'Create the project in an empty folder: xflow init my-project. To link an existing folder to a project: xflow link <id>');
     }
     const folder = noApp ? null : checkFolder((0, args_1.flagString)(args, 'app') ?? (0, sources_1.appFolderName)(name, new Set(), 'app'));
-    (0, ui_1.step)('Creating the project on the platform');
+    (0, ui_1.step)(orgName ? `Creating the project in "${orgName}"` : 'Creating the project on the platform');
     const project = await (0, api_1.apiJson)(client, '/api/v1/projects', {
         method: 'POST',
         body: { name, app: folder ? { name } : null, server: (0, args_1.flagString)(args, 'server') ?? null },

package/dist/flags.js

@@ -44,7 +44,7 @@ exports.KNOWN = {
     'org list': [],
     'org members': [],
     'org switch': [],
-    init: ['name', 'app', 'no-app', 'server'],
+    init: ['name', 'app', 'no-app', 'server', 'org'],
     link: [],
     projects: [],
     'projects list': [],
@@ -79,6 +79,7 @@ exports.KNOWN = {
     'db list': [],
     'db schema': ['project'],
     'db query': ['json', 'project'],
+    'db exec': ['allow-destructive', 'json', 'project'],
     'db migrate': ['dry-run', 'allow-destructive'],
     'db move': ['to', 'yes', 'project'],
     storage: ['json', 'project'],
@@ -117,7 +118,7 @@ exports.KNOWN = {
  * line here, or a refusal nobody prints any more stays behind as a lie.
  */
 exports.WORKING_COPY = {
-    pull: 'it writes the sources next to it',
+    pull: 'it writes the sources next to it. A project without a folder comes down whole with xflow link <id> in an empty one',
     status: 'it compares the folder with the revision on the platform',
     dev: 'it runs the dev server of the app folder it stands in',
     'apps add': 'it lays the template into apps/',