@getxflow/cli 0.34.2 → 1.0.0

package/dist/commands/projects.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.templates = templates;
-exports.functionNameFrom = functionNameFrom;
 exports.init = init;
+exports.appsList = appsList;
+exports.appsAdd = appsAdd;
 exports.link = link;
 exports.list = list;
 exports.get = get;
@@ -17,7 +17,6 @@ const session_1 = require("../session");
 const skills_1 = require("./skills");
 const sources_1 = require("./sources");
 const template_1 = require("../template");
-const zip_1 = require("../zip");
 const ui_1 = require("../ui");
 /** .git alone does not count: linking a fresh clone is normal. */
 function isEmptyEnough(dir) {
@@ -33,157 +32,123 @@ function write(root, path, content) {
 function escapeHtml(value) {
     return value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
 }
-/** Give the project its own tab title. */
-function titleFromProject(path, content, name) {
-    if (path !== 'index.html')
-        return content;
-    const html = content.toString('utf-8').replace(/<title>[^<]*<\/title>/, `<title>${escapeHtml(name)}</title>`);
-    return Buffer.from(html, 'utf-8');
-}
-async function templates() {
-    const client = (0, session_1.connect)();
-    const { templates: list } = await (0, api_1.apiJson)(client, '/api/v1/templates');
-    if (list.length === 0) {
-        (0, ui_1.note)('No templates');
+/** Give the app its own tab title instead of the template one. */
+function nameTheApp(appRoot, name) {
+    const path = (0, node_path_1.join)(appRoot, 'index.html');
+    if (!(0, node_fs_1.existsSync)(path))
         return;
-    }
-    (0, ui_1.table)(list.map((t) => [t.id, t.name, t.is_default ? 'default' : '', t.description ?? '']));
-}
-function slugify(name) {
-    return name
-        .toLowerCase()
-        .replace(/[^a-z0-9-]+/g, '-')
-        .replace(/^-+|-+$/g, '')
-        .slice(0, 41);
+    const html = (0, node_fs_1.readFileSync)(path, 'utf-8');
+    (0, node_fs_1.writeFileSync)(path, html.replace(/<title>[^<]*<\/title>/, `<title>${escapeHtml(name)}</title>`));
 }
-/**
- * A function name out of the project name: the platform takes lowercase latin
- * letters, digits and dashes, and the folder it lives in gives it its name.
- *
- * The folder name is the fallback, so a project called in Russian still gets a
- * function: the name a person reads and the name the cloud takes are different
- * things, and the folder already holds a usable one.
- */
-function functionNameFrom(name, folder) {
-    const usable = /^[a-z0-9][a-z0-9-]{0,40}$/;
-    const slug = slugify(name);
-    if (usable.test(slug))
-        return slug;
-    const fromFolder = folder ? slugify(folder) : '';
-    if (usable.test(fromFolder))
-        return fromFolder;
-    throw new errors_1.CliError(`Cannot make a function name out of "${name}"`, 'The name comes from the project name, and the folder is the fallback: name either of them in latin ' +
-        'letters, digits and dashes (xflow init my-fn --function)');
-}
-/**
- * Create a standalone function: a shared backend of the organization, a project
- * without a site. No template is fetched — there is no frontend to fetch.
- */
-async function initFunction(args, client, target, name) {
-    const functionName = functionNameFrom(name, (0, node_path_1.basename)(target));
-    (0, ui_1.step)('Creating the function on the platform');
-    const project = await (0, api_1.apiJson)(client, '/api/v1/projects', {
-        method: 'POST',
-        body: {
-            name,
-            kind: 'function',
-            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 });
-        for (const file of (0, template_1.functionScaffoldFiles)(name, functionName))
-            write(target, file.path, file.content);
-        // No build block: the platform builds the functions of such a project and
-        // never its site, so a build command would be a promise nobody keeps.
-        (0, config_1.writeConfig)(target, { projectId: project.id });
-        (0, config_1.ignoreStateInGit)(target);
-        if (client.organizationId)
-            (0, config_1.writeState)(target, { organizationId: client.organizationId });
-    }
-    catch (e) {
-        (0, ui_1.note)((0, ui_1.dim)(`  The function "${project.name}" is already created (${project.id}).`));
-        (0, ui_1.note)((0, ui_1.dim)('  Sort the folder out and pick it up: xflow link ' + project.id));
-        throw e;
-    }
-    (0, skills_1.installSkillQuietly)(target);
-    (0, ui_1.ok)(`Function "${project.name}" created: functions/${functionName}`);
-    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'}`));
+/** A folder name typed for an app: one segment of latin letters, digits and dashes. */
+function checkFolder(folder) {
+    if (!folder)
+        throw new errors_1.CliError('Name the folder of the new app', 'For example: xflow apps add shop');
+    if (!/^[a-z0-9][a-z0-9-]{0,39}$/.test(folder)) {
+        throw new errors_1.CliError(`"${folder}" does not fit as an app folder`, 'Lowercase latin letters, digits and dashes, for example: shop');
     }
-    (0, ui_1.out)('');
-    (0, ui_1.out)(`  ${(0, ui_1.bold)('Next:')}`);
-    (0, ui_1.out)(`    cd ${(0, node_path_1.basename)(target)}`);
-    (0, ui_1.out)('    npm install');
-    (0, ui_1.out)('    xflow deploy       # send the code, build and release the function');
+    return folder;
 }
-/** Create a project from the platform template. */
+/** A new app: the platform seeds its first revision from the template, the CLI pulls it into apps/<folder>. */
+async function layApp(client, app, projectRoot, folder) {
+    const appRoot = (0, node_path_1.join)(projectRoot, config_1.APPS_DIR, folder);
+    await (0, sources_1.pullAppInto)(client, app.id, appRoot);
+    nameTheApp(appRoot, app.name);
+    (0, ui_1.ok)(`App "${app.name}" in ${config_1.APPS_DIR}/${folder}: ${app.url}`);
+}
+/** A new project and, unless --no-app, its first app from the platform template. */
 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)();
     if (!isEmptyEnough(target)) {
-        throw new errors_1.CliError(`The directory ${target} is not empty`, 'Create the project in an empty folder: xflow init my-app. To link an existing folder to a project: xflow link <id>');
-    }
-    if ((0, args_1.flagBool)(args, 'function'))
-        return initFunction(args, client, target, name);
-    let templateId = (0, args_1.flagString)(args, 'template');
-    if (!templateId) {
-        const { templates: list } = await (0, api_1.apiJson)(client, '/api/v1/templates');
-        templateId = (list.find((t) => t.is_default) ?? list[0])?.id;
-        if (!templateId)
-            throw new errors_1.CliError('The platform has no templates at all');
+        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>');
     }
-    (0, ui_1.step)('Fetching the template');
-    const archive = await (0, api_1.apiBinary)(client, `/api/v1/templates/${templateId}/archive`);
-    const files = (0, zip_1.dropDirectoryEntries)((0, zip_1.zipRead)(archive));
+    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');
     const project = await (0, api_1.apiJson)(client, '/api/v1/projects', {
         method: 'POST',
-        body: { name, database_id: (0, args_1.flagString)(args, 'database') ?? null, server: (0, args_1.flagString)(args, 'server') ?? null },
+        body: { name, app: folder ? { name } : null, server: (0, args_1.flagString)(args, 'server') ?? null },
         timeoutMs: 60_000,
     });
     try {
-        (0, node_fs_1.mkdirSync)(target, { recursive: true });
-        for (const file of files)
-            write(target, file.path, titleFromProject(file.path, file.content, name));
-        for (const file of (0, template_1.scaffoldFiles)(name))
+        (0, node_fs_1.mkdirSync)((0, node_path_1.join)(target, 'functions'), { recursive: true });
+        (0, node_fs_1.mkdirSync)((0, node_path_1.join)(target, 'migrations'), { recursive: true });
+        for (const file of (0, template_1.projectScaffold)(name))
             write(target, file.path, file.content);
-        (0, template_1.writePlatformEnv)(target, project.project_token, client.apiUrl);
-        const config = {
-            projectId: project.id,
-            build: { command: 'npm run build', dir: 'dist' },
-        };
-        (0, config_1.writeConfig)(target, config);
+        (0, config_1.writeConfig)(target, { projectId: project.id });
         (0, config_1.ignoreStateInGit)(target);
         if (client.organizationId)
             (0, config_1.writeState)(target, { organizationId: client.organizationId });
+        if (project.app && folder)
+            await layApp(client, project.app, target, folder);
     }
     catch (e) {
         (0, ui_1.note)((0, ui_1.dim)(`  The project "${project.name}" is already created (${project.id}).`));
-        (0, ui_1.note)((0, ui_1.dim)('  Sort the folder out and pick it up: xflow link ' + project.id));
+        (0, ui_1.note)((0, ui_1.dim)(`  Sort the folder out and pick it up in an empty one: xflow link ${project.id}`));
         throw e;
     }
     (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.ok)(`Project "${project.name}" created`);
+    if (project.server)
+        (0, ui_1.note)((0, ui_1.dim)(`  Its database goes to the own server "${project.server.name}"`));
     (0, ui_1.out)('');
     (0, ui_1.out)(`  ${(0, ui_1.bold)('Next:')}`);
-    (0, ui_1.out)(`    cd ${(0, node_path_1.basename)(target)}`);
-    (0, ui_1.out)('    npm install');
-    (0, ui_1.out)('    xflow dev          # develop');
-    (0, ui_1.out)('    xflow deploy       # send the code, build and release');
+    (0, ui_1.out)(`    cd ${(0, node_path_1.basename)(target)} && npm install          # functions`);
+    if (folder) {
+        (0, ui_1.out)(`    cd ${config_1.APPS_DIR}/${folder} && npm install && xflow dev   # the app on 127.0.0.1:3000`);
+        (0, ui_1.out)(`    xflow deploy ${config_1.APPS_DIR}/${folder} -m "First version"`);
+    }
+    else {
+        (0, ui_1.out)('    xflow deploy functions -m "First version"   # the project has no apps: its functions are workflows');
+    }
+}
+/** `xflow apps`: the apps of the project, with their folders here. */
+async function appsList(args) {
+    const { projectId, client, root } = await (0, session_1.projectTarget)(args);
+    const card = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}`);
+    const local = root ? (0, config_1.localApps)(root) : [];
+    const folderOf = (id) => local.find((item) => item.appId === id)?.folder;
+    if ((0, args_1.flagBool)(args, 'json')) {
+        (0, ui_1.out)(JSON.stringify(card.apps.map((app) => ({ ...app, folder: folderOf(app.id) ?? null })), null, 2));
+        return;
+    }
+    if (card.apps.length === 0) {
+        (0, ui_1.note)('No apps: the functions of this project are workflows. Add one: xflow apps add <folder>');
+        return;
+    }
+    (0, ui_1.table)(card.apps.map((app) => [
+        folderOf(app.id) ? `${config_1.APPS_DIR}/${folderOf(app.id)}` : '(no folder here)',
+        app.name,
+        app.url,
+        app.access,
+        app.live_deploy_id ? `live ${app.live_deploy_id}` : 'never published',
+    ]));
+    (0, ui_1.note)((0, ui_1.dim)('  Who opens an app (the access level) is set by a person in the web interface'));
+}
+/** `xflow apps add <folder>`: a new app of this project, laid out from the template. */
+async function appsAdd(args) {
+    const folder = checkFolder(args.words[0] ?? '');
+    const { root, config } = (0, config_1.requireProject)();
+    const appRoot = (0, node_path_1.join)(root, config_1.APPS_DIR, folder);
+    if (!isEmptyEnough(appRoot))
+        throw new errors_1.CliError(`${config_1.APPS_DIR}/${folder} is not empty`, 'Pick another folder name');
+    const client = await (0, session_1.connectProject)(config.projectId, root, config);
+    (0, ui_1.step)('Creating the app on the platform');
+    const { app } = await (0, api_1.apiJson)(client, `/api/v1/projects/${config.projectId}/apps`, {
+        method: 'POST',
+        // The tile color is optional; the platform names the colors it knows if this one is wrong.
+        body: { name: (0, args_1.flagString)(args, 'name') ?? folder, tone: (0, args_1.flagString)(args, 'color') },
+        timeoutMs: 60_000,
+    });
+    await layApp(client, app, root, folder);
+    (0, ui_1.note)((0, ui_1.dim)(`  Let it call a function: add "${folder}" to functions.<name>.callers in xflow.json, then xflow deploy functions`));
+    (0, ui_1.note)((0, ui_1.dim)(`  Build it: xflow deploy ${config_1.APPS_DIR}/${folder} -m "First version" (the first build publishes itself)`));
 }
 /**
- * Linking is a step, not a task. Without this the agent reports the command as done and
- * goes quiet, leaving the person in front of a folder: it has to read the skill and come
- * back with a question instead.
+ * Linking is a step, not a task: the agent has to read the skill and come back with
+ * a question instead of reporting the command as done.
  */
 function nextAfterLink(skillReady) {
     (0, ui_1.out)('');
@@ -195,30 +160,22 @@ function nextAfterLink(skillReady) {
 async function link(args) {
     const root = (0, config_1.findProjectRoot)() ?? process.cwd();
     const existing = (0, node_fs_1.existsSync)((0, node_path_1.join)(root, config_1.CONFIG_FILE)) ? (0, config_1.readConfig)(root) : undefined;
-    // Asked before anything is written: an empty folder means a clone, and the
-    // sources have to come with it.
+    // Asked before anything is written: an empty folder means a clone, and the whole project comes with it.
     const fresh = !existing && isEmptyEnough(process.cwd());
     let client = (0, session_1.connect)(existing);
     const projectId = args.words[0];
-    if (!projectId) {
+    if (!projectId)
         throw new errors_1.CliError('A project identifier is required', 'The list: xflow projects list');
-    }
-    if (!(0, session_1.isProjectId)(projectId)) {
+    if (!(0, session_1.isProjectId)(projectId))
         throw new errors_1.CliError(`link takes a project id, got "${projectId}"`, 'The ids: xflow projects list');
-    }
     let card;
     try {
         card = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}`);
     }
     catch (e) {
-        // Project ids are unique across the platform, so a 404 under this key does
-        // not mean the project does not exist: another signed-in organization may
-        // hold it. A dead key (401/403) says even less. Ask every stored
-        // organization before giving up.
-        if (!(e instanceof api_1.ApiError && (e.status === 404 || e.status === 401 || e.status === 403)) ||
-            client.source === 'env') {
+        // Ids are unique across the platform: another signed-in organization may hold it.
+        if (!(e instanceof api_1.ApiError && (e.status === 404 || e.status === 401 || e.status === 403)) || client.source === 'env')
             throw e;
-        }
         const { hit, dead } = await (0, session_1.findProjectOrg)(client.apiUrl, projectId);
         if (!hit) {
             throw new errors_1.CliError(`No signed-in organization holds the project ${projectId}`, dead.length > 0
@@ -230,41 +187,27 @@ async function link(args) {
         (0, ui_1.note)((0, ui_1.dim)(`  The project belongs to "${hit.name ?? hit.organizationId}", not to the active organization`));
     }
     const dir = existing ? root : process.cwd();
-    (0, config_1.writeConfig)(dir, {
-        ...(existing ?? {}),
-        projectId: card.id,
-        build: existing?.build ?? { command: 'npm run build', dir: 'dist' },
-    });
+    const config = { ...(existing ?? {}), projectId: card.id };
+    (0, config_1.writeConfig)(dir, config);
     (0, config_1.ignoreStateInGit)(dir);
     if (client.organizationId)
         (0, config_1.writeState)(dir, { organizationId: client.organizationId });
-    (0, template_1.writePlatformEnv)(dir, card.project_token, client.apiUrl, card.functions, card.function_map);
-    (0, ui_1.note)((0, ui_1.dim)('  .env now points at this project, run it locally with xflow dev'));
     const skillReady = (0, skills_1.installSkillQuietly)(dir);
     (0, ui_1.ok)(`The folder is linked to the project "${card.name}"`);
     (0, ui_1.note)((0, ui_1.dim)(`  ${(0, node_path_1.join)(dir, config_1.CONFIG_FILE)}`));
-    if (!fresh) {
-        nextAfterLink(skillReady);
-        return;
-    }
-    // A clone without the code is half a clone, and the folder has to remember
-    // which revision it works from: without that the first push has nothing to
-    // compare against and stops.
-    try {
-        const { info, files } = await (0, sources_1.downloadRevision)(client, card.id, dir);
-        (0, config_1.writeState)(dir, { treeHash: info.tree_hash });
-        (0, ui_1.ok)(`Revision ${info.revision}: ${files} files`);
-    }
-    catch (e) {
-        if (e instanceof api_1.ApiError && e.status === 404) {
-            (0, ui_1.note)((0, ui_1.dim)('  The project has no sources yet: write the code and run xflow deploy'));
-            nextAfterLink(skillReady);
+    if (fresh) {
+        // A clone without the code is half a clone: the root and every app come down.
+        try {
+            await (0, sources_1.cloneProject)(client, card, dir);
+        }
+        catch (e) {
+            (0, ui_1.warn)(`The sources did not arrive: ${e instanceof Error ? e.message : e}`);
+            (0, ui_1.note)((0, ui_1.dim)('  The folder is linked, fetch them separately: xflow pull --into <empty dir>'));
             return;
         }
-        // No next step while the code is missing: the pull has to succeed first.
-        (0, ui_1.warn)(`The sources did not arrive: ${e instanceof Error ? e.message : e}`);
-        (0, ui_1.note)((0, ui_1.dim)('  The folder is linked, fetch them separately: xflow pull'));
-        return;
+    }
+    else if (card.apps.length > 0 && (0, config_1.localApps)(dir).length === 0) {
+        (0, ui_1.note)((0, ui_1.dim)(`  The project has ${card.apps.length} app(s) and no folder here holds one: clone it into an empty folder with xflow link`));
     }
     nextAfterLink(skillReady);
 }
@@ -276,24 +219,14 @@ async function list() {
         (0, ui_1.table)(projects.map((p) => [
             p.id,
             p.name,
-            // A standalone function has no pages at all, so the states of a site
-            // ("published", "dev only") would say nothing about it.
-            p.kind === 'function'
-                ? 'function'
-                : p.live_deploy_id
-                    ? 'published'
-                    : p.dev_deploy_id
-                        ? 'dev only'
-                        : 'no build',
+            p.apps.length === 0 ? 'no apps' : p.apps.length === 1 ? '1 app' : `${p.apps.length} apps`,
             (0, ui_1.formatAge)(p.updated_at),
         ]));
     }
     else {
         (0, ui_1.note)('No projects. To create one: xflow init');
     }
-    // One organization answers, and with several signed in that is worth saying:
-    // a project that "is not here" may simply live in another one. Not under an
-    // env key or a folder binding, where "active" would be the wrong word.
+    // With several organizations signed in, a project that "is not here" may live in another one.
     const orgs = (0, credentials_1.listOrgs)(client.apiUrl);
     if (client.source === 'active' && orgs.length > 1) {
         const name = orgs.find((org) => org.active)?.name;
@@ -308,34 +241,45 @@ async function get(args) {
         throw new errors_1.CliError(`projects get takes a project id, got "${explicit}"`, 'The ids: xflow projects list');
     }
     const projectId = explicit ?? config?.projectId;
-    if (!projectId) {
+    if (!projectId)
         throw new errors_1.CliError('A project identifier is required', 'Or run the command inside the project folder');
-    }
-    // An id typed by hand is looked for across every signed-in organization and
-    // ignores the folder whole, xflow.json included, the way --project does it.
-    // Named by the folder, the project of an unbound one gets probed and the
-    // binding written, the way publish and pull do it.
-    const client = explicit !== undefined
-        ? await (0, session_1.connectProject)(explicit, null)
-        : await (0, session_1.connectProject)(projectId, root, config);
+    // An id typed by hand ignores the folder whole, the way --project does it.
+    const client = explicit !== undefined ? await (0, session_1.connectProject)(explicit, null) : await (0, session_1.connectProject)(projectId, root, config);
     const card = await (0, api_1.apiJson)(client, `/api/v1/projects/${projectId}`);
+    const local = explicit === undefined && root ? (0, config_1.localApps)(root) : [];
     (0, ui_1.out)(`${(0, ui_1.bold)(card.name)}  ${(0, ui_1.dim)(card.id)}`);
     if (card.description)
         (0, ui_1.out)(card.description);
     (0, ui_1.out)('');
-    (0, ui_1.out)(`Built version:    ${card.dev_deploy_id ?? '(no build)'}`);
-    (0, ui_1.out)(`Visitors see:     ${card.live_deploy_id ?? '(never published)'}`);
-    (0, ui_1.out)(`Database:         ${card.database ? `${card.database.name} (${card.database.schema})` : '(none)'}`);
+    (0, ui_1.out)(`Database: ${card.database.schema}${card.database.server_id ? ' (own server)' : ''}`);
     (0, ui_1.out)('');
-    (0, ui_1.out)(card.project_url);
+    (0, ui_1.out)('Apps:');
+    if (card.apps.length === 0)
+        (0, ui_1.note)((0, ui_1.dim)('  none: the functions are workflows'));
+    else {
+        (0, ui_1.table)(card.apps.map((app) => [
+            `  ${local.find((item) => item.appId === app.id)?.folder ?? app.name}`,
+            app.url,
+            app.access,
+            app.live_deploy_id ? `live ${app.live_deploy_id}` : 'never published',
+        ]));
+    }
     if (card.functions.length > 0) {
         (0, ui_1.out)('');
         (0, ui_1.out)('Functions:');
-        (0, ui_1.table)(card.functions.map((f) => [`  ${f.name}`, f.status, (0, ui_1.formatAge)(f.last_deployed_at)]));
+        (0, ui_1.table)(card.functions.map((f) => [
+            `  ${f.name}`,
+            f.status,
+            f.callers.length > 0 ? f.callers.join(', ') : 'no callers',
+            f.open ? 'open' : '',
+            (0, ui_1.formatAge)(f.last_deployed_at),
+        ]));
     }
     if (card.schedules.length > 0) {
         (0, ui_1.out)('');
         (0, ui_1.out)('Schedules:');
         (0, ui_1.table)(card.schedules.map((s) => [`  ${s.function_name}`, s.cron_expression, s.status]));
     }
+    (0, ui_1.out)('');
+    (0, ui_1.out)(card.project_url);
 }