@getxflow/cli 1.4.0 → 1.6.0

package/dist/commands/pages.js

@@ -1,257 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pagesList = pagesList;
-exports.pagesCreate = pagesCreate;
-exports.pagesDeploy = pagesDeploy;
-exports.pagesStatus = pagesStatus;
-exports.pagesRollback = pagesRollback;
-exports.pagesRemove = pagesRemove;
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const api_1 = require("../api");
-const args_1 = require("../args");
-const config_1 = require("../config");
-const credentials_1 = require("../credentials");
-const errors_1 = require("../errors");
-const session_1 = require("../session");
-const ui_1 = require("../ui");
-const zip_1 = require("../zip");
-const deploy_1 = require("./deploy");
-const storage_1 = require("./storage");
-/**
- * Pages: public sites of the organization at <name>.xflowpage.ru. They open without
- * signing in and outside the platform, and an upload is live at once.
- */
-/** Keep in sync with the platform: a refusal here saves the upload. */
-const MAX_UPLOAD_BYTES = 5 * 1024 * 1024;
-const MAX_UNPACKED_BYTES = 25 * 1024 * 1024;
-const MAX_FILES = 1000;
-/** Where build tools write the site: named when the folder turns out to be the sources. */
-const BUILD_DIRS = ['dist', 'build', 'out'];
-/** A page belongs to the organization, not to a project: the key is picked as for xflow org members. */
-function pagesClient() {
-    return (0, session_1.connect)((0, config_1.localConfig)());
-}
-function pagePath(ref) {
-    return `/api/v1/pages/${encodeURIComponent(ref)}`;
-}
-function clip(text, max) {
-    return text.length > max ? `${text.slice(0, max - 1)}…` : text;
-}
-function stateOf(page) {
-    if (page.status === 'blocked')
-        return 'taken down';
-    if (page.status === 'disabled')
-        return 'switched off';
-    return page.current_revision === null ? 'empty' : 'live';
-}
-function describeState(page) {
-    if (page.status === 'blocked') {
-        const reason = page.blocked_reason ? ': ' + page.blocked_reason : '';
-        return `Taken down by the platform${reason}. Write to team@getxflow.com if it is a mistake`;
-    }
-    if (page.status === 'disabled')
-        return 'Switched off: the address shows a placeholder until a person switches it on';
-    if (page.current_revision === null)
-        return 'Empty: nothing is uploaded yet';
-    return `Live: version ${page.current_revision}, put there ${(0, ui_1.formatAge)(page.deployed_at)}`;
-}
-async function pagesList(args) {
-    const client = pagesClient();
-    const { pages } = await (0, api_1.apiJson)(client, '/api/v1/pages');
-    if ((0, args_1.flagBool)(args, 'json')) {
-        (0, ui_1.out)(JSON.stringify({ pages }, null, 2));
-        return;
-    }
-    if (pages.length === 0) {
-        (0, ui_1.note)('The organization has no pages yet');
-        (0, ui_1.note)((0, ui_1.dim)('  A new one: xflow pages create "Price list" ./dist'));
-    }
-    else {
-        (0, ui_1.table)(pages.map((page) => [
-            page.slug,
-            clip(page.title, 40),
-            stateOf(page),
-            (0, ui_1.formatAge)(page.deployed_at ?? page.created_at),
-            page.url,
-        ]));
-    }
-    const orgs = (0, credentials_1.listOrgs)(client.apiUrl);
-    if (client.source === 'active' && orgs.length > 1) {
-        const name = orgs.find((org) => org.active)?.name;
-        const whose = name ? `"${name}"` : 'the active organization';
-        (0, ui_1.note)((0, ui_1.dim)(`  Pages of ${whose} only. For another organization: xflow org switch <name or id>`));
-    }
-}
-async function pagesCreate(args) {
-    const source = args.words.length > 2 ? args.words[args.words.length - 1] : undefined;
-    const title = args.words.slice(1, -1).join(' ').trim();
-    if (!source || !title) {
-        throw new errors_1.CliError('A title and what to put on the page are required', 'A page is born with its first version: xflow pages create "Price list" ./dist --slug price-list');
-    }
-    const upload = readUpload(source);
-    const slug = (0, args_1.flagString)(args, 'slug');
-    const query = new URLSearchParams(slug ? { title, slug } : { title });
-    (0, ui_1.step)(`Uploading ${upload.label}`);
-    const result = await (0, api_1.apiUpload)(pagesClient(), `/api/v1/pages?${query}`, upload.body, {
-        'Content-Type': contentTypeOf(upload),
-    });
-    (0, ui_1.ok)(`Page "${result.page.title}" is live: ${result.file_count} file(s), ${(0, ui_1.formatBytes)(result.size_bytes)}`);
-    (0, ui_1.out)(result.page.url);
-    (0, ui_1.note)((0, ui_1.dim)(`  Anyone with the address sees it within seconds. The next version: xflow pages deploy ${result.page.slug} <path>`));
-}
-function contentTypeOf(upload) {
-    return upload.kind === 'zip' ? 'application/zip' : 'text/html';
-}
-function assertUploadSize(bytes) {
-    if (bytes <= MAX_UPLOAD_BYTES)
-        return;
-    throw new errors_1.CliError(`The upload is ${(0, ui_1.formatBytes)(bytes)}, a page takes ${MAX_UPLOAD_BYTES / 1024 / 1024} MB at most`, 'Pages are for sites, presentations and invoices: compress the images and drop the sourcemaps');
-}
-/**
- * The folder of a built site, zipped here. The sources of a site are refused before the
- * walk: the platform would reject them anyway, and node_modules is a long way down.
- */
-function zipSite(absolute, source) {
-    const built = BUILD_DIRS.find((dir) => (0, node_fs_1.existsSync)((0, node_path_1.join)(absolute, dir, 'index.html')));
-    const pointAtBuild = built
-        ? `The built site is in ${(0, node_path_1.join)(source, built)}: upload that folder`
-        : 'Build it and upload the folder the build writes';
-    if ((0, node_fs_1.existsSync)((0, node_path_1.join)(absolute, 'package.json'))) {
-        throw new errors_1.CliError(`${source} holds the sources of a site, not a built one`, pointAtBuild);
-    }
-    if (!(0, node_fs_1.existsSync)((0, node_path_1.join)(absolute, 'index.html'))) {
-        throw new errors_1.CliError(`There is no index.html at the top of ${source}`, built ? pointAtBuild : 'The start page of a site is index.html at the top of its folder');
-    }
-    const files = (0, storage_1.collectMedia)(absolute);
-    if (files.length > MAX_FILES) {
-        throw new errors_1.CliError(`${source} holds ${files.length} files, a page takes ${MAX_FILES} at most`, 'Drop what the site never loads');
-    }
-    const bytes = files.reduce((sum, file) => sum + file.size, 0);
-    if (bytes > MAX_UNPACKED_BYTES) {
-        throw new errors_1.CliError(`${source} is ${(0, ui_1.formatBytes)(bytes)}, a page takes ${MAX_UNPACKED_BYTES / 1024 / 1024} MB at most`, 'Compress the images and drop the sourcemaps');
-    }
-    const body = (0, zip_1.zipCreate)(files.map((file) => ({ path: file.remote, content: (0, node_fs_1.readFileSync)(file.absolute) })));
-    assertUploadSize(body.length);
-    return { kind: 'zip', body, label: `${files.length} file(s), ${(0, ui_1.formatBytes)(bytes)}` };
-}
-function readUpload(source) {
-    const absolute = (0, node_path_1.resolve)(source);
-    let stat;
-    try {
-        stat = (0, node_fs_1.statSync)(absolute);
-    }
-    catch {
-        throw new errors_1.CliError(`No such file or folder: ${source}`);
-    }
-    if (stat.isDirectory())
-        return zipSite(absolute, source);
-    const extension = (0, node_path_1.extname)(absolute).toLowerCase();
-    if (extension !== '.html' && extension !== '.htm' && extension !== '.zip') {
-        throw new errors_1.CliError(`${(0, node_path_1.basename)(absolute)} cannot be a page`, 'A page goes up as a folder with index.html at the top, its .zip, or one .html file');
-    }
-    assertUploadSize(stat.size);
-    return {
-        kind: extension === '.zip' ? 'zip' : 'html',
-        body: (0, node_fs_1.readFileSync)(absolute),
-        label: `${(0, node_path_1.basename)(absolute)}, ${(0, ui_1.formatBytes)(stat.size)}`,
-    };
-}
-async function pagesDeploy(args) {
-    const [, ref, source] = args.words;
-    if (!ref || !source) {
-        throw new errors_1.CliError('A page and what to upload are required', 'For example: xflow pages deploy price-list ./dist. The pages: xflow pages');
-    }
-    const comment = (0, deploy_1.versionComment)((0, args_1.flagString)(args, 'message'));
-    const upload = readUpload(source);
-    const client = pagesClient();
-    (0, ui_1.step)(`Uploading ${upload.label}`);
-    const query = comment ? `?comment=${encodeURIComponent(comment)}` : '';
-    const result = await (0, api_1.apiUpload)(client, `${pagePath(ref)}/deploy${query}`, upload.body, {
-        'Content-Type': contentTypeOf(upload),
-    });
-    if (result.status === 'unchanged') {
-        (0, ui_1.ok)(`Nothing changed: version ${result.revision} is already on the address`);
-    }
-    else if (result.status === 'stored') {
-        (0, ui_1.warn)(`The page is switched off: version ${result.revision} is kept, not shown`);
-        (0, ui_1.note)((0, ui_1.dim)('  It goes live when a person switches the page on'));
-    }
-    else {
-        (0, ui_1.ok)(`Version ${result.revision} is live: ${result.file_count} file(s), ${(0, ui_1.formatBytes)(result.size_bytes)}`);
-    }
-    (0, ui_1.out)(result.page.url);
-    if (result.status === 'deployed') {
-        (0, ui_1.note)((0, ui_1.dim)(`  Anyone with the address sees it within seconds. The versions: xflow pages status ${result.page.slug}`));
-    }
-}
-async function pagesStatus(args) {
-    const ref = args.words[1];
-    if (!ref)
-        throw new errors_1.CliError('A page is required', 'The name from its address, or its id. The pages: xflow pages');
-    const data = await (0, api_1.apiJson)(pagesClient(), `${pagePath(ref)}/revisions`);
-    if ((0, args_1.flagBool)(args, 'json')) {
-        (0, ui_1.out)(JSON.stringify(data, null, 2));
-        return;
-    }
-    const { page, revisions } = data;
-    (0, ui_1.out)(`${(0, ui_1.bold)(page.title)}  ${page.url}`);
-    (0, ui_1.out)(describeState(page));
-    if (revisions.length === 0) {
-        (0, ui_1.note)((0, ui_1.dim)(`  Upload: xflow pages deploy ${page.slug} <folder, .zip or .html>`));
-        return;
-    }
-    (0, ui_1.out)();
-    (0, ui_1.table)(revisions.map((revision) => [
-        String(revision.revision),
-        (0, ui_1.formatAge)(revision.created_at),
-        `${revision.file_count} file(s)`,
-        (0, ui_1.formatBytes)(revision.size_bytes),
-        clip(revision.comment ?? '', 60),
-        revision.current ? 'current' : revision.restorable ? '' : 'files removed',
-    ]));
-    (0, ui_1.note)((0, ui_1.dim)(`  Put a version back: xflow pages rollback ${page.slug} <number>. The files of the last 5 are kept`));
-}
-async function pagesRollback(args) {
-    const [, ref, raw] = args.words;
-    if (!ref || !raw) {
-        throw new errors_1.CliError('A page and a version number are required', 'For example: xflow pages rollback price-list 2. The versions: xflow pages status <page>');
-    }
-    const revision = Number(raw);
-    if (!Number.isInteger(revision) || revision < 1) {
-        throw new errors_1.CliError(`A version number is a positive integer, got "${raw}"`, `The versions: xflow pages status ${ref}`);
-    }
-    const { page } = await (0, api_1.apiJson)(pagesClient(), `${pagePath(ref)}/rollback`, {
-        method: 'POST',
-        body: { revision },
-    });
-    if (page.status === 'active')
-        (0, ui_1.ok)(`Version ${revision} is back on the address`);
-    else
-        (0, ui_1.warn)(`The page is switched off: version ${revision} is current and goes live when it is switched on`);
-    (0, ui_1.out)(page.url);
-}
-async function pagesRemove(args) {
-    const ref = args.words[1];
-    if (!ref) {
-        throw new errors_1.CliError('A page is required', 'The name from its address, or its id. The pages: xflow pages');
-    }
-    // The page is read first: deleting is confirmed by the name in the address, and the
-    // page can be named here by its id.
-    const client = pagesClient();
-    const { page } = await (0, api_1.apiJson)(client, pagePath(ref));
-    const query = (0, args_1.flagBool)(args, 'yes') ? `?confirm=${encodeURIComponent(page.slug)}` : '';
-    try {
-        await (0, api_1.apiJson)(client, `${pagePath(page.id)}${query}`, { method: 'DELETE' });
-    }
-    catch (e) {
-        // The platform names what goes and refuses until the answer is seen. Said in the
-        // words of this command, not of the API.
-        if (e instanceof api_1.ApiError && e.code === 'confirm_required') {
-            throw new errors_1.CliError(e.message, `To delete it anyway: xflow pages rm ${page.slug} --yes`);
-        }
-        throw e;
-    }
-    (0, ui_1.ok)(`The page is deleted: ${page.url} shows nothing now`);
-    (0, ui_1.note)((0, ui_1.dim)(`  Its versions are gone for good, the name ${page.slug} stays reserved for the organization`));
-}