@swell/cli 2.9.13 → 2.9.15

package/dist/commands/app/push.js

@@ -17,8 +17,8 @@ type to an app in your store's test environment.
 If the app does not exist, it will be created and its global ID saved to a .swellrc file.
 
 - If no file is specified, all configuration files will be pushed to the store.
-  This includes the app icon (assets/icon.png), cover image (assets/image.png),
-  and swell.json.
+  This includes the app icon (assets/icon.png), screenshots (assets/screenshots/),
+  README.md, and swell.json.
 - If a file is specified, only that file will be pushed to the store.
 - If a directory is specified, only files in that directory will be pushed.
 

package/dist/commands/app/release.js

@@ -115,10 +115,17 @@ The app must be connected to a partner account with access to publish.`;
         const spinner = ora();
         this.log();
         spinner.start(`${amend ? 'Updating release' : 'Releasing'} version ${style.appConfigValue(appVersion.version)}`);
-        await this.updateVersion(appVersion.version, {
-            ...releaseData,
-            released: true,
-        }, spinner);
+        try {
+            await this.updateVersion(appVersion.version, {
+                ...releaseData,
+                released: true,
+            });
+        }
+        catch (error) {
+            spinner.fail(error.message);
+            this.logReleaseDetailsHint(error);
+            return this.exit(1);
+        }
         spinner.succeed(`${style.appConfigValue(this.app.name)} release ${appVersion.version} ${amend ? 'updated' : 'released'}.`);
     }
     async validateCreateVersion(inputVersion, flags) {
@@ -138,7 +145,8 @@ The app must be connected to a partner account with access to publish.`;
             else {
                 await this.config.runCommand('app:version', [
                     version,
-                    ...(flags.message ? [`-m ${JSON.stringify(flags.message)}`] : []),
+                    '--validate-release',
+                    ...(flags.message ? ['-m', flags.message] : []),
                     ...(flags['no-git-tag'] ? ['--no-git-tag'] : []),
                     ...(flags.yes ? ['-y'] : []),
                 ]);

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

@@ -10,6 +10,7 @@ export default class AppVersion extends PushAppCommand {
         'force-create-files': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         message: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         'no-git-tag': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        'validate-release': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         yes: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     static orientation: {

package/dist/commands/app/version.js

@@ -64,6 +64,10 @@ behavior by using the --no-git-tag option.`;
         'no-git-tag': Flags.boolean({
             description: 'do not create a git tag for this version',
         }),
+        'validate-release': Flags.boolean({
+            description: 'validate the app has all details required to release before creating the version',
+            hidden: true,
+        }),
         yes: Flags.boolean({
             char: 'y',
             description: 'skip confirmation prompt',
@@ -75,7 +79,7 @@ behavior by using the --no-git-tag option.`;
     static summary = 'Increment the version of your Swell app.';
     async run() {
         const { args, flags } = await this.parse(AppVersion);
-        const { amend, 'no-git-tag': noGitTag, yes, 'force-create-files': forceCreateFiles = false, } = flags;
+        const { amend, 'no-git-tag': noGitTag, yes, 'force-create-files': forceCreateFiles = false, 'validate-release': validateRelease = false, } = flags;
         let { message } = flags;
         let { nextVersion } = args;
         if (!(await this.ensureAppExists(undefined, false))) {
@@ -116,7 +120,7 @@ behavior by using the --no-git-tag option.`;
             }
             return;
         }
-        nextVersion = this.validateAndComputeVersion(nextVersion, localVersion);
+        nextVersion = await this.validateAndComputeVersion(nextVersion, localVersion);
         await this.pushAppConfigs();
         await this.deployAppFrontend(false, false);
         if (!message) {
@@ -139,18 +143,33 @@ behavior by using the --no-git-tag option.`;
         const spinner = ora();
         spinner.start('Creating version');
         try {
-            await this.createRemoteVersion(nextVersion, message, spinner, forceCreateFiles);
-            await this.gitCommit(message);
-            if (!noGitTag)
-                await this.gitTag(nextVersion);
+            await this.createRemoteVersion(nextVersion, message, spinner, {
+                forceCreateFiles,
+                validateRelease,
+            });
         }
         catch (error) {
             spinner.fail(error.stderr || error.message);
-            return;
+            this.logReleaseDetailsHint(error);
+            return this.exit(1);
         }
         spinner.succeed(`${style.appConfigValue(this.app.name)} version ${nextVersion} created.`);
+        // git is optional: commit and tag only when the app is inside a repository
+        if (await git.find({ cwd: this.appPath })) {
+            try {
+                await this.gitCommit(message);
+                if (!noGitTag)
+                    await this.gitTag(nextVersion);
+            }
+            catch (error) {
+                this.log(style.funcWarn(`Git commit/tag failed: ${(error.stderr || error.message).trim()}`));
+            }
+        }
+        else {
+            this.log(style.dim('Not a git repository, skipping git commit and tag.'));
+        }
     }
-    async createRemoteVersion(nextVersion, message, spinner, forceCreateFiles = false) {
+    async createRemoteVersion(nextVersion, message, spinner, { forceCreateFiles = false, validateRelease = false } = {}) {
         const body = {
             description: message,
             version: nextVersion,
@@ -158,6 +177,9 @@ behavior by using the --no-git-tag option.`;
         if (forceCreateFiles) {
             body.$force_create_files = true;
         }
+        if (validateRelease) {
+            body.$validate_release = true;
+        }
         // update the version on the remote
         const versionResponse = await this.api.post({ adminPath: `/apps/${this.app.id}/versions` }, {
             body,
@@ -173,34 +195,40 @@ behavior by using the --no-git-tag option.`;
         this.swellConfig.set('version', nextVersion);
     }
     async gitCommit(message) {
+        const cwd = this.appPath;
         // check if there are changes in the app config file
         // if there are no changes, there is nothing to commit
         const configStatus = await git.spawn(['status', this.swellConfig.path], {
-            cwd: this.swellConfig.cwd,
+            cwd,
         });
         if (configStatus.stdout.includes('nothing to commit')) {
             return;
         }
         // add the app config file to commit - this will contain the new version
-        await git.spawn(['add', this.swellConfig.path]);
+        await git.spawn(['add', this.swellConfig.path], { cwd });
         // commit the version change to git. It skips the git hooks with -n
-        await git.spawn(['commit', '-n', '-m', message]);
+        await git.spawn(['commit', '-n', '-m', message], { cwd });
     }
     async gitTag(nextVersion) {
         const tag = nextVersion;
         // tag the version in git
-        await git.spawn(['tag', tag], { cwd: process.cwd() });
+        await git.spawn(['tag', tag], { cwd: this.appPath });
     }
-    validateAndComputeVersion(nextVersion, localVersion) {
+    async validateAndComputeVersion(nextVersion, localVersion) {
         let version = nextVersion;
         // compute the value of the next version and check if it's valid
         if (RELEASE_TYPES.includes(nextVersion)) {
             // increment the version
             version = semver.inc(localVersion, version);
         }
-        if (semver.lte(version, localVersion)) {
+        if (semver.lt(version, localVersion)) {
             this.error(`Version ${version} must be greater than the current version ${localVersion}.`);
         }
+        // swell.json may declare a version that has not been created yet,
+        // e.g. the first version of a new app. Only reject it if it already exists.
+        if (semver.eq(version, localVersion) && (await this.getVersion(version))) {
+            this.error(`Version ${version} already exists.`);
+        }
         return version;
     }
 }

package/dist/lib/api.d.ts

@@ -21,7 +21,7 @@ export default class Api {
     put(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
     delete(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
     isTestEnvEnabled(): Promise<boolean>;
-    setEnv(envId: string): Promise<void>;
+    setEnv(envId: string, storeId?: string): Promise<void>;
     setStoreEnv(storeId: string, envId?: string): Promise<void>;
     setPublicKey(publicKey?: string): Promise<void>;
     private isFrontend;

package/dist/lib/api.js

@@ -2,7 +2,7 @@ import fetch from 'node-fetch';
 import { stringify } from 'qs';
 import { getCurrentAppSlugId, hasAppContext } from './apps/index.js';
 import config from './config.js';
-import { API_BASE_URL, getAdminApiBaseUrl, getFrontendApiBaseUrl, } from './constants.js';
+import { API_BASE_URL, getAdminApiBaseUrl, getFrontendApiBaseUrl, getLoginHost, } from './constants.js';
 import style from './style.js';
 export var HttpMethod;
 (function (HttpMethod) {
@@ -190,16 +190,21 @@ export default class Api {
         });
         return clientRecord.test_enabled !== false;
     }
-    async setEnv(envId) {
+    async setEnv(envId, storeId) {
         const hasTestEnv = await this.isTestEnvEnabled();
         if (!hasTestEnv) {
-            throw new Error('Test environment is not enabled for this store.');
+            const targetStoreId = storeId || this.storeId || config.getDefaultStore();
+            const settingsUrl = `${getLoginHost(targetStoreId)}/admin/settings/general`;
+            throw new Error(`Test environment is not enabled for this store.
+
+Enable it in the dashboard under Settings > General > Test environment:
+${settingsUrl}`);
         }
         this.envId = envId;
     }
     async setStoreEnv(storeId, envId) {
         if (envId) {
-            await this.setEnv(envId);
+            await this.setEnv(envId, storeId);
         }
         this.storeId = storeId;
         this.envId = envId;

package/dist/lib/apps/index.d.ts

@@ -16,7 +16,6 @@ export interface App {
         [key: string]: string;
     };
     configs?: AppConfig[];
-    cover_image?: unknown;
     date_created?: string;
     date_updated?: string;
     demo_url?: string;
@@ -39,6 +38,10 @@ export interface App {
         title: string;
     }>;
     id?: string;
+    images?: Array<{
+        file?: unknown;
+        id: string;
+    }>;
     installed?: {
         date_created: string;
         id: string;

package/dist/push-app-command.d.ts

@@ -76,6 +76,7 @@ export declare abstract class PushAppCommand extends RemoteAppCommand {
     }): void;
     logStorefrontConnected(): void;
     logStorefrontFrontendUrl(storefront?: any, branchId?: string): void;
+    logReleaseDetailsHint(error: any): void;
     pushFile(relativePath: string): Promise<void>;
     pushFilePath(relativePath: string, force?: boolean): Promise<void>;
     resolveAppPath(appId?: string, targetPath?: string): Promise<string>;

package/dist/push-app-command.js

@@ -672,6 +672,14 @@ export class PushAppCommand extends RemoteAppCommand {
         const currentStore = localConfig.getDefaultStore();
         this.log(`View your storefront at ${style.link(this.storefrontFrontendUrl(currentStore, storefront, branchId))}.`);
     }
+    // Tell the user how to recover when the server rejects a release
+    // because app details are missing
+    logReleaseDetailsHint(error) {
+        if (!String(error?.message).includes('to release')) {
+            return;
+        }
+        this.log(style.dim(`Update swell.json and assets as needed, run ${style.command('swell app push')}, then run ${style.command('swell app release')} again.`));
+    }
     async pushFile(relativePath) {
         const relativePathPosix = toPosixPath(relativePath);
         const basePath = relativePathPosix.split('/')[0];

package/oclif.manifest.json

@@ -1180,7 +1180,7 @@
           "name": "file"
         }
       },
-      "description": "Push all app files, a specific file, or a specific configuration\ntype to an app in your store's test environment.\n\nIf the app does not exist, it will be created and its global ID saved to a .swellrc file.\n\n- If no file is specified, all configuration files will be pushed to the store.\n  This includes the app icon (assets/icon.png), cover image (assets/image.png),\n  and swell.json.\n- If a file is specified, only that file will be pushed to the store.\n- If a directory is specified, only files in that directory will be pushed.\n\nApp file directories:\nassets/\ncontent/\nfrontend/\ncomponents/\nfunctions/\nmodels/\nnotifications/\nsettings/\ntheme/\nwebhooks/",
+      "description": "Push all app files, a specific file, or a specific configuration\ntype to an app in your store's test environment.\n\nIf the app does not exist, it will be created and its global ID saved to a .swellrc file.\n\n- If no file is specified, all configuration files will be pushed to the store.\n  This includes the app icon (assets/icon.png), screenshots (assets/screenshots/),\n  README.md, and swell.json.\n- If a file is specified, only that file will be pushed to the store.\n- If a directory is specified, only files in that directory will be pushed.\n\nApp file directories:\nassets/\ncontent/\nfrontend/\ncomponents/\nfunctions/\nmodels/\nnotifications/\nsettings/\ntheme/\nwebhooks/",
       "examples": [
         "swell app push",
         "swell app push content",
@@ -1359,6 +1359,13 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "validate-release": {
+          "description": "validate the app has all details required to release before creating the version",
+          "hidden": true,
+          "name": "validate-release",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "yes": {
           "char": "y",
           "description": "skip confirmation prompt",
@@ -3594,5 +3601,5 @@
       ]
     }
   },
-  "version": "2.9.13"
+  "version": "2.9.15"
 }

package/package.json

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