@swell/cli 2.9.30 → 2.9.31

package/dist/commands/app/delete.d.ts

@@ -0,0 +1,33 @@
+import { RemoteAppCommand } from '../../remote-app-command.js';
+export default class AppDelete extends RemoteAppCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        confirm: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        yes: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+    };
+    static orientation: {
+        env: string;
+    };
+    static summary: string;
+    run(): Promise<void>;
+    private deleteRequest;
+    private ensureDeleted;
+    private errorTheme;
+    /**
+     * Remove .swellrc when it holds the deleted app's id, so the next push
+     * creates a new app. Another id is left alone.
+     * @param {string} appId the deleted app
+     * @returns {Promise<boolean>} false when .swellrc names another app
+     */
+    private removeSwellRc;
+    private errorBlocked;
+    /**
+     * The app named by swell.json, with the reasons it can't be deleted.
+     * Only the store that owns it may delete it.
+     * @param {string} privateId app id from swell.json
+     * @param {string} storeId the logged in store
+     * @returns {Promise<any>} the app
+     */
+    private getOwnedApp;
+}

package/dist/commands/app/delete.js

@@ -0,0 +1,179 @@
+import { confirm } from '@inquirer/prompts';
+import { Flags } from '@oclif/core';
+import * as fs from 'node:fs/promises';
+import { readRcFile } from '../../lib/app-config.js';
+import config from '../../lib/config.js';
+import style from '../../lib/style.js';
+import { RemoteAppCommand } from '../../remote-app-command.js';
+export default class AppDelete extends RemoteAppCommand {
+    static description = `Deletes the app from the store that owns it, to free a slot under the store's app limit.
+
+The app's versions, configs, functions and its development install in the test environment are removed. Records the app created in the store are not deleted.
+
+An app can't be deleted while it is installed anywhere else, if it is linked to a partner, or if it was ever published. The command lists what blocks it.
+
+After deleting, .swellrc is removed, so the next \`swell app push\` creates a new app.`;
+    static examples = [
+        'swell app delete',
+        'swell app delete --confirm',
+        'swell app delete --confirm -y',
+    ];
+    static flags = {
+        confirm: Flags.boolean({
+            description: 'confirm deleting the app, instead of being asked',
+        }),
+        yes: Flags.boolean({
+            char: 'y',
+            description: 'skip all prompts; requires --confirm',
+        }),
+    };
+    static orientation = {
+        env: 'test',
+    };
+    static summary = 'Delete an app your store owns.';
+    async run() {
+        const { flags } = await this.parse(AppDelete);
+        const { confirm: confirmed, yes } = flags;
+        if (yes && !confirmed) {
+            this.error(`Missing --confirm for non-interactive mode.
+
+Deleting an app can't be undone.
+
+Example: ${style.command('swell app delete --confirm -y')}`, { exit: 1 });
+        }
+        if (!confirmed && !process.stdin.isTTY) {
+            this.error(`Missing --confirm: there is no terminal to ask for confirmation.
+
+Example: ${style.command('swell app delete --confirm')}`, { exit: 1 });
+        }
+        if (this.swellConfig.get('type') === 'theme') {
+            this.errorTheme();
+        }
+        const privateId = this.app.private_id;
+        if (!privateId) {
+            this.error(`App ${style.appConfigName('id')} is not defined in swell.json.`, { exit: 1 });
+        }
+        const storeId = config.getDefaultStore();
+        config.ensureLoggedIn(storeId);
+        const app = await this.getOwnedApp(privateId, storeId);
+        const appLabel = `${style.appName(app.name)} (${app.id})`;
+        if (app.type === 'theme') {
+            this.errorTheme();
+        }
+        const blockers = app.delete_blockers || [];
+        if (blockers.length > 0) {
+            this.errorBlocked(appLabel, blockers);
+        }
+        if (!confirmed) {
+            const continueDelete = await confirm({
+                default: false,
+                message: `Delete ${app.name} from store ${storeId}? This can't be undone.`,
+            });
+            if (!continueDelete) {
+                this.log('Delete cancelled.');
+                return;
+            }
+        }
+        // The BFF hands out a key, and deletes only when it is sent back
+        const challenge = await this.deleteRequest(app.id);
+        this.ensureDeleted(appLabel, challenge);
+        if (!challenge?.confirm_delete_key) {
+            this.error(`Unable to delete app ${appLabel}: no confirmation key.`);
+        }
+        const result = await this.deleteRequest(app.id, challenge.confirm_delete_key);
+        this.ensureDeleted(appLabel, result);
+        const swellRcRemoved = await this.removeSwellRc(app.id);
+        this.log(`✓ Deleted app ${appLabel}`);
+        this.log(`  Store: ${style.storeId(storeId)}`);
+        if (!swellRcRemoved) {
+            this.log(`  .swellrc kept: it names another app`);
+        }
+        this.log();
+        this.log(`Run ${style.command('swell app push')} to create it again as a new app.`);
+    }
+    async deleteRequest(id, confirmDeleteKey) {
+        try {
+            return await this.api.delete({ adminPath: `/apps/${id}` }, confirmDeleteKey
+                ? { body: { confirm_delete_key: confirmDeleteKey } }
+                : {});
+        }
+        catch (error) {
+            return this.error(`Unable to delete app: ${errorMessage(error)}`);
+        }
+    }
+    ensureDeleted(appLabel, response) {
+        const error = response?.errors?.app;
+        if (error?.blockers?.length > 0) {
+            this.errorBlocked(appLabel, error.blockers);
+        }
+        if (response?.errors) {
+            const messages = Object.values(response.errors).map((err) => err?.message || String(err));
+            this.error(`Unable to delete app ${appLabel}: ${messages.join(' ')}`);
+        }
+    }
+    errorTheme() {
+        this.error(`Themes can't be deleted with ${style.command('swell app delete')}. Delete an uploaded theme from the store's storefronts in the dashboard.`, { exit: 1 });
+    }
+    /**
+     * Remove .swellrc when it holds the deleted app's id, so the next push
+     * creates a new app. Another id is left alone.
+     * @param {string} appId the deleted app
+     * @returns {Promise<boolean>} false when .swellrc names another app
+     */
+    async removeSwellRc(appId) {
+        let rc;
+        try {
+            rc = await readRcFile(this.swellRcPath());
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                return true;
+            }
+            throw error;
+        }
+        if (rc.id && rc.id !== appId) {
+            return false;
+        }
+        await fs.rm(this.swellRcPath(), { force: true });
+        return true;
+    }
+    errorBlocked(appLabel, blockers) {
+        this.error([
+            `App ${appLabel} can't be deleted:`,
+            ...blockers.map((blocker) => `  - ${blocker.message}`),
+        ].join('\n'), { exit: 1 });
+    }
+    /**
+     * The app named by swell.json, with the reasons it can't be deleted.
+     * Only the store that owns it may delete it.
+     * @param {string} privateId app id from swell.json
+     * @param {string} storeId the logged in store
+     * @returns {Promise<any>} the app
+     */
+    async getOwnedApp(privateId, storeId) {
+        let app;
+        try {
+            app = await this.api.get({ adminPath: `/apps/${privateId}` }, { query: { delete_blockers: true } });
+        }
+        catch (error) {
+            const message = errorMessage(error);
+            if (message === 'App not found') {
+                this.error(`App ${style.appConfigValue(privateId)} was not found on store ${style.storeId(storeId)}. Nothing to delete.`, { exit: 1 });
+            }
+            this.error(`Unable to get app: ${message}`);
+        }
+        if (!app?.id || app.client_id !== storeId) {
+            this.error(`App ${style.appConfigValue(privateId)} is not owned by store ${style.storeId(storeId)}. Only the store that owns an app can delete it.`, { exit: 1 });
+        }
+        return app;
+    }
+}
+function errorMessage(error) {
+    try {
+        const json = JSON.parse(error.message);
+        return typeof json.error === 'string' ? json.error : json.error.message;
+    }
+    catch {
+        return error.message;
+    }
+}

package/oclif.manifest.json

@@ -721,6 +721,59 @@
         "_uninstall.js"
       ]
     },
+    "app:delete": {
+      "aliases": [],
+      "args": {},
+      "description": "Deletes the app from the store that owns it, to free a slot under the store's app limit.\n\nThe app's versions, configs, functions and its development install in the test environment are removed. Records the app created in the store are not deleted.\n\nAn app can't be deleted while it is installed anywhere else, if it is linked to a partner, or if it was ever published. The command lists what blocks it.\n\nAfter deleting, .swellrc is removed, so the next `swell app push` creates a new app.",
+      "examples": [
+        "swell app delete",
+        "swell app delete --confirm",
+        "swell app delete --confirm -y"
+      ],
+      "flags": {
+        "app-path": {
+          "description": "Path to your app directory",
+          "name": "app-path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "confirm": {
+          "description": "confirm deleting the app, instead of being asked",
+          "name": "confirm",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "yes": {
+          "char": "y",
+          "description": "skip all prompts; requires --confirm",
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "app:delete",
+      "pluginAlias": "@swell/cli",
+      "pluginName": "@swell/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Delete an app your store owns.",
+      "enableJsonFlag": false,
+      "requiresSwellConfig": true,
+      "delayOrientation": false,
+      "orientation": {
+        "env": "test"
+      },
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "app",
+        "delete.js"
+      ]
+    },
     "app:dev": {
       "aliases": [],
       "args": {},
@@ -3685,5 +3738,5 @@
       ]
     }
   },
-  "version": "2.9.30"
+  "version": "2.9.31"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swell/cli",
-  "version": "2.9.30",
+  "version": "2.9.31",
   "type": "module",
   "description": "Swell's command line interface/utility",
   "keywords": [