bdy 1.25.22-dev → 1.25.22-master

package/distTs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.25.22-dev",
+  "version": "1.25.22-master",
   "type": "commonjs",
   "license": "MIT",
   "homepage": "https://buddy.works/docs/cli",

package/distTs/src/command/sandbox/fetch/add.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../../cliError"));
+const utils_1 = require("../../../utils");
+const texts_1 = require("../../../texts");
+const output_1 = __importDefault(require("../../../output"));
+const input_1 = __importDefault(require("../../../input"));
+const sandbox_1 = require("../../../types/sandbox");
+const fetchSource_1 = require("../fetchSource");
+const commandSandboxFetchAdd = (0, utils_1.newCommand)('add', texts_1.DESC_COMMAND_SANDBOX_FETCH_ADD, {
+    requiredScopes: [utils_1.REST_API_SCOPE.SANDBOX_WRITE],
+    examples: texts_1.EXAMPLE_SANDBOX_FETCH_ADD,
+});
+commandSandboxFetchAdd.alias('create');
+(0, utils_1.sandboxScopeOptions)(commandSandboxFetchAdd);
+commandSandboxFetchAdd.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
+commandSandboxFetchAdd.option('--ref <ref>', texts_1.OPTION_SANDBOX_FETCH_REF);
+commandSandboxFetchAdd.option('--repository <url>', texts_1.OPTION_SANDBOX_FETCH_REPOSITORY);
+commandSandboxFetchAdd.option('--path <directory>', texts_1.OPTION_SANDBOX_FETCH_PATH);
+commandSandboxFetchAdd.option('--artifact <name:version>', texts_1.OPTION_SANDBOX_FETCH_ARTIFACT);
+commandSandboxFetchAdd.option('--source-path <path>', texts_1.OPTION_SANDBOX_FETCH_SOURCE_PATH);
+commandSandboxFetchAdd.option('--build <command>', texts_1.OPTION_SANDBOX_FETCH_BUILD);
+commandSandboxFetchAdd.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandSandboxFetchAdd.action(async (identifier, options) => {
+    if (options.artifact && (options.repository || options.ref)) {
+        output_1.default.exitError(new cliError_1.default('usage_error', texts_1.ERR_SANDBOX_FETCH_MIX_ARTIFACT));
+    }
+    if (options.sourcePath && !options.artifact) {
+        output_1.default.exitError(new cliError_1.default('usage_error', texts_1.ERR_SANDBOX_FETCH_SOURCE_PATH));
+    }
+    const workspace = input_1.default.restApiWorkspace(options.workspace);
+    const client = input_1.default.restApiTokenClient();
+    const sandboxId = await input_1.default.sandboxId(client, workspace, options, identifier);
+    let type = sandbox_1.SANDBOX_FETCH.PROJECT_REPO;
+    if (options.artifact)
+        type = sandbox_1.SANDBOX_FETCH.ARTIFACT;
+    else if (options.repository)
+        type = sandbox_1.SANDBOX_FETCH.PUBLIC_REPO;
+    const body = { type };
+    if (options.repository)
+        body.repository = options.repository;
+    if (options.ref)
+        body.ref = options.ref;
+    if (options.path)
+        body.path = options.path;
+    if (options.artifact)
+        body.artifact = options.artifact;
+    if (options.sourcePath)
+        body.source_path = options.sourcePath;
+    if (options.build)
+        body.build_command = options.build;
+    const fetch = await client.addSandboxFetch(workspace, sandboxId, body);
+    // a fetch added to a stopped sandbox stays STALE until it is refetched
+    const path = (0, fetchSource_1.sandboxFetchPath)(fetch);
+    output_1.default.exitResult(options.format === 'json', fetch, fetch.status === sandbox_1.SANDBOX_FETCH_STATUS.STALE
+        ? (0, texts_1.TXT_SANDBOX_FETCH_ADDED_STALE)(identifier, path)
+        : (0, texts_1.TXT_SANDBOX_FETCH_ADDED)(path));
+});
+exports.default = commandSandboxFetchAdd;

package/distTs/src/command/sandbox/fetch/delete.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../../utils");
+const texts_1 = require("../../../texts");
+const output_1 = __importDefault(require("../../../output"));
+const input_1 = __importDefault(require("../../../input"));
+const fetchSource_1 = require("../fetchSource");
+const commandSandboxFetchDelete = (0, utils_1.newCommand)('delete', texts_1.DESC_COMMAND_SANDBOX_FETCH_DELETE, {
+    requiredScopes: [utils_1.REST_API_SCOPE.SANDBOX_WRITE],
+    examples: texts_1.EXAMPLE_SANDBOX_FETCH_DELETE,
+});
+commandSandboxFetchDelete.alias('rm');
+(0, utils_1.sandboxScopeOptions)(commandSandboxFetchDelete);
+commandSandboxFetchDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
+commandSandboxFetchDelete.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandSandboxFetchDelete.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
+commandSandboxFetchDelete.argument('<fetch>', texts_1.OPTION_SANDBOX_FETCH_ARG);
+commandSandboxFetchDelete.action(async (identifier, fetchRef, options) => {
+    const workspace = input_1.default.restApiWorkspace(options.workspace);
+    const client = input_1.default.restApiTokenClient();
+    const sandboxId = await input_1.default.sandboxId(client, workspace, options, identifier);
+    const fetch = await (0, fetchSource_1.resolveSandboxFetch)(client, workspace, sandboxId, fetchRef);
+    const json = options.format === 'json';
+    const confirmed = await output_1.default.confirmDestructive(options.force, (0, texts_1.TXT_SANDBOX_FETCH_DELETE_CONFIRM)(identifier, (0, fetchSource_1.sandboxFetchPath)(fetch)), json);
+    if (!confirmed)
+        output_1.default.exitResult(json, { deleted: null });
+    await client.deleteSandboxFetch(workspace, sandboxId, fetch.id);
+    output_1.default.exitResult(json, { deleted: fetch }, (0, texts_1.TXT_SANDBOX_FETCH_DELETED)((0, fetchSource_1.sandboxFetchPath)(fetch)));
+});
+exports.default = commandSandboxFetchDelete;

package/distTs/src/command/sandbox/fetch/get.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../../utils");
+const texts_1 = require("../../../texts");
+const output_1 = __importDefault(require("../../../output"));
+const input_1 = __importDefault(require("../../../input"));
+const sandbox_1 = require("../../../types/sandbox");
+const fetchSource_1 = require("../fetchSource");
+const commandSandboxFetchGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_SANDBOX_FETCH_GET, {
+    requiredScopes: [utils_1.REST_API_SCOPE.SANDBOX_READ],
+    examples: texts_1.EXAMPLE_SANDBOX_FETCH_GET,
+});
+(0, utils_1.sandboxScopeOptions)(commandSandboxFetchGet);
+commandSandboxFetchGet.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandSandboxFetchGet.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
+commandSandboxFetchGet.argument('<fetch>', texts_1.OPTION_SANDBOX_FETCH_ARG);
+commandSandboxFetchGet.action(async (identifier, fetchRef, options) => {
+    const workspace = input_1.default.restApiWorkspace(options.workspace);
+    const client = input_1.default.restApiTokenClient();
+    const sandboxId = await input_1.default.sandboxId(client, workspace, options, identifier);
+    const found = await (0, fetchSource_1.resolveSandboxFetch)(client, workspace, sandboxId, fetchRef);
+    // the single fetch endpoint is the one that measures behind/outdated
+    const f = await client.getSandboxFetch(workspace, sandboxId, found.id);
+    if (options.format === 'json') {
+        output_1.default.json(f);
+    }
+    else {
+        const isArtifact = f.type === sandbox_1.SANDBOX_FETCH.ARTIFACT;
+        const data = [
+            ['Field', 'Value'],
+            ['ID', f.id || '-'],
+            ['Type', f.type || '-'],
+            ['Path', (0, fetchSource_1.sandboxFetchPath)(f)],
+            ['Source', (0, fetchSource_1.sandboxFetchSource)(f)],
+            [isArtifact ? 'Version' : 'Ref', (0, fetchSource_1.sandboxFetchRefOrVersion)(f)],
+            ['Build command', f.build_command || '-'],
+            ['Status', f.status || '-'],
+            ['Revision', f.current_revision || '-'],
+            ['Behind', (0, fetchSource_1.sandboxFetchBehind)(f)],
+            ['Fetched', f.fetched_date || '-'],
+        ];
+        if (f.error_message)
+            data.push(['Error', f.error_message]);
+        output_1.default.table(data);
+    }
+    output_1.default.exitNormal();
+});
+exports.default = commandSandboxFetchGet;

package/distTs/src/command/sandbox/fetch/list.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../../utils");
+const texts_1 = require("../../../texts");
+const output_1 = __importDefault(require("../../../output"));
+const input_1 = __importDefault(require("../../../input"));
+const fetchSource_1 = require("../fetchSource");
+const commandSandboxFetchList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_SANDBOX_FETCH_LIST, {
+    requiredScopes: [utils_1.REST_API_SCOPE.SANDBOX_READ],
+    examples: texts_1.EXAMPLE_SANDBOX_FETCH_LIST,
+});
+commandSandboxFetchList.alias('ls');
+(0, utils_1.sandboxScopeOptions)(commandSandboxFetchList);
+commandSandboxFetchList.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandSandboxFetchList.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
+commandSandboxFetchList.action(async (identifier, options) => {
+    const workspace = input_1.default.restApiWorkspace(options.workspace);
+    const client = input_1.default.restApiTokenClient();
+    const sandboxId = await input_1.default.sandboxId(client, workspace, options, identifier);
+    const response = await client.listSandboxFetches(workspace, sandboxId);
+    const fetches = response.fetches || [];
+    if (options.format === 'json') {
+        output_1.default.json(fetches);
+    }
+    else {
+        if (fetches.length === 0) {
+            output_1.default.exitError(texts_1.ERR_SANDBOX_FETCHES_NOT_FOUND);
+        }
+        const data = [
+            ['ID', 'Path', 'Source', 'Ref/Version', 'Status', 'Revision', 'Behind'],
+        ];
+        for (const f of fetches) {
+            data.push([
+                f.id || '-',
+                (0, fetchSource_1.sandboxFetchPath)(f),
+                (0, fetchSource_1.sandboxFetchSource)(f),
+                (0, fetchSource_1.sandboxFetchRefOrVersion)(f),
+                f.status || '-',
+                (0, fetchSource_1.sandboxFetchRevision)(f),
+                (0, fetchSource_1.sandboxFetchBehind)(f),
+            ]);
+        }
+        output_1.default.table(data);
+    }
+    output_1.default.exitNormal();
+});
+exports.default = commandSandboxFetchList;

package/distTs/src/command/sandbox/fetch/refetch.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../../utils");
+const texts_1 = require("../../../texts");
+const output_1 = __importDefault(require("../../../output"));
+const input_1 = __importDefault(require("../../../input"));
+const fetchSource_1 = require("../fetchSource");
+const commandSandboxFetchRefetch = (0, utils_1.newCommand)('refetch', texts_1.DESC_COMMAND_SANDBOX_FETCH_REFETCH, {
+    requiredScopes: [utils_1.REST_API_SCOPE.SANDBOX_WRITE],
+    examples: texts_1.EXAMPLE_SANDBOX_FETCH_REFETCH,
+});
+(0, utils_1.sandboxScopeOptions)(commandSandboxFetchRefetch);
+commandSandboxFetchRefetch.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandSandboxFetchRefetch.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
+commandSandboxFetchRefetch.argument('<fetch>', texts_1.OPTION_SANDBOX_FETCH_ARG);
+commandSandboxFetchRefetch.action(async (identifier, fetchRef, options) => {
+    const workspace = input_1.default.restApiWorkspace(options.workspace);
+    const client = input_1.default.restApiTokenClient();
+    const sandboxId = await input_1.default.sandboxId(client, workspace, options, identifier);
+    const found = await (0, fetchSource_1.resolveSandboxFetch)(client, workspace, sandboxId, fetchRef);
+    const fetch = await client.refetchSandboxFetch(workspace, sandboxId, found.id);
+    output_1.default.exitResult(options.format === 'json', fetch, (0, texts_1.TXT_SANDBOX_FETCH_REFETCHED)((0, fetchSource_1.sandboxFetchPath)(fetch)));
+});
+exports.default = commandSandboxFetchRefetch;

package/distTs/src/command/sandbox/fetch.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../utils");
+const texts_1 = require("../../texts");
+const list_1 = __importDefault(require("./fetch/list"));
+const get_1 = __importDefault(require("./fetch/get"));
+const add_1 = __importDefault(require("./fetch/add"));
+const delete_1 = __importDefault(require("./fetch/delete"));
+const refetch_1 = __importDefault(require("./fetch/refetch"));
+const commandSandboxFetch = (0, utils_1.newCommand)('fetch', texts_1.DESC_COMMAND_SANDBOX_FETCH, {
+    examples: [
+        ...texts_1.EXAMPLE_SANDBOX_FETCH_LIST,
+        ...texts_1.EXAMPLE_SANDBOX_FETCH_GET,
+        ...texts_1.EXAMPLE_SANDBOX_FETCH_ADD,
+        ...texts_1.EXAMPLE_SANDBOX_FETCH_DELETE,
+        ...texts_1.EXAMPLE_SANDBOX_FETCH_REFETCH,
+    ],
+});
+commandSandboxFetch.alias('f');
+commandSandboxFetch.addCommand(list_1.default);
+commandSandboxFetch.addCommand(get_1.default);
+commandSandboxFetch.addCommand(add_1.default);
+commandSandboxFetch.addCommand(delete_1.default);
+commandSandboxFetch.addCommand(refetch_1.default);
+exports.default = commandSandboxFetch;

package/distTs/src/command/sandbox/fetchSource.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findSandboxFetch = exports.resolveSandboxFetch = exports.sandboxFetchPath = exports.sandboxFetchRevision = exports.sandboxFetchRefOrVersion = exports.sandboxFetchBehind = exports.sandboxFetchSource = exports.SANDBOX_FETCH_DEFAULT = void 0;
+const cliError_1 = __importDefault(require("../../cliError"));
+const texts_1 = require("../../texts");
+const sandbox_1 = require("../../types/sandbox");
+exports.SANDBOX_FETCH_DEFAULT = ':default';
+// Where the files come from: the project repository, a public repository URL or
+// the artifact (with the path inside it when only part of it is fetched)
+const sandboxFetchSource = (f) => {
+    if (f.type === sandbox_1.SANDBOX_FETCH.ARTIFACT) {
+        const artifact = f.artifact || '-';
+        return f.source_path ? `${artifact} (${f.source_path})` : artifact;
+    }
+    if (f.type === sandbox_1.SANDBOX_FETCH.PUBLIC_REPO)
+        return f.repository || '-';
+    return 'project repository';
+};
+exports.sandboxFetchSource = sandboxFetchSource;
+// How far the fetched files are from what the fetch points at. Repositories count
+// commits behind the ref, artifacts only know whether the version moved on. Null
+// means the API could not measure it (e.g. an unreachable public repository).
+const sandboxFetchBehind = (f) => {
+    if (f.type === sandbox_1.SANDBOX_FETCH.ARTIFACT) {
+        if (f.outdated === true)
+            return 'outdated';
+        if (f.outdated === false)
+            return 'up to date';
+        return '-';
+    }
+    if (typeof f.behind !== 'number')
+        return '-';
+    if (f.behind === 0)
+        return 'up to date';
+    return `${f.behind} behind`;
+};
+exports.sandboxFetchBehind = sandboxFetchBehind;
+// The ref of a repository fetch, the version of an artifact fetch (name:version)
+const sandboxFetchRefOrVersion = (f) => {
+    if (f.type === sandbox_1.SANDBOX_FETCH.ARTIFACT) {
+        const artifact = f.artifact || '';
+        const idx = artifact.lastIndexOf(':');
+        return idx > 0 ? artifact.substring(idx + 1) : '-';
+    }
+    return f.ref || '-';
+};
+exports.sandboxFetchRefOrVersion = sandboxFetchRefOrVersion;
+const sandboxFetchRevision = (f) => f.current_revision ? f.current_revision.substring(0, 7) : '-';
+exports.sandboxFetchRevision = sandboxFetchRevision;
+// How a fetch is named in messages: its target directory, ":default" for the
+// fetch into the app directory (the API keeps its path empty)
+const sandboxFetchPath = (f) => f.path || exports.SANDBOX_FETCH_DEFAULT;
+exports.sandboxFetchPath = sandboxFetchPath;
+const trimSlash = (p) => (p || '').replace(/\/+$/, '');
+// The API ID or an explicitly set target directory, no app directory needed
+const matchSandboxFetch = (fetches, ref) => fetches.find((f) => f.id === ref) ||
+    fetches.find((f) => !!f.path && trimSlash(f.path) === trimSlash(ref));
+// Lists the sandbox fetches and picks one. The sandbox itself is read only when
+// the ref may name the app directory: ":default", or the directory given
+// explicitly for the fetch into it, which keeps an empty path
+const resolveSandboxFetch = async (client, workspace, sandboxId, ref) => {
+    const response = await client.listSandboxFetches(workspace, sandboxId);
+    const fetches = response.fetches || [];
+    let appDir;
+    if (!matchSandboxFetch(fetches, ref)) {
+        const sandbox = await client.getSandbox(workspace, sandboxId);
+        appDir = sandbox.app_dir;
+    }
+    return (0, exports.findSandboxFetch)(fetches, ref, appDir);
+};
+exports.resolveSandboxFetch = resolveSandboxFetch;
+// A fetch is identified by its target directory, ":default" (or the app directory
+// itself) names the one into the app directory. The API ID is accepted too, so
+// output of `list --format json` can be fed back directly.
+const findSandboxFetch = (fetches, ref, appDir) => {
+    let found = matchSandboxFetch(fetches, ref);
+    if (!found &&
+        (ref === exports.SANDBOX_FETCH_DEFAULT ||
+            (!!appDir && trimSlash(ref) === trimSlash(appDir)))) {
+        found = fetches.find((f) => !f.path || (!!appDir && trimSlash(f.path) === trimSlash(appDir)));
+    }
+    if (!found) {
+        throw new cliError_1.default('not_found', texts_1.ERR_SANDBOX_FETCH_NOT_FOUND, texts_1.HINT_SANDBOX_FETCH_LIST);
+    }
+    return found;
+};
+exports.findSandboxFetch = findSandboxFetch;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.25.22-dev",
+  "version": "1.25.22-master",
   "type": "commonjs",
   "license": "MIT",
   "homepage": "https://buddy.works/docs/cli",