@swell/cli 2.0.11 → 2.0.13

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

@@ -1,6 +1,5 @@
 import { PushAppCommand } from '../../push-app-command.js';
 export default class AppDev extends PushAppCommand {
-    static delayOrientation: boolean;
     static examples: string[];
     static flags: {
         'storefront-id': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
@@ -8,9 +7,10 @@ export default class AppDev extends PushAppCommand {
         'no-push': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         port: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
     };
+    static summary: string;
+    static delayOrientation: boolean;
     static orientation: {
         env: string;
     };
-    static summary: string;
     run(): Promise<void>;
 }

package/dist/commands/app/dev.js

@@ -2,7 +2,6 @@ import { Flags } from '@oclif/core';
 import { PushAppCommand } from '../../push-app-command.js';
 import AppFrontendDev from './frontend/dev.js';
 export default class AppDev extends PushAppCommand {
-    static delayOrientation = true;
     static examples = [
         'swell app dev',
         'swell app dev --storefront-id <id>',
@@ -18,10 +17,11 @@ export default class AppDev extends PushAppCommand {
             description: 'for storefront apps, prompt to select a storefront to preview',
         }),
     };
+    static summary = `Run an app in dev mode from your local machine.`;
+    static delayOrientation = true;
     static orientation = {
         env: 'test',
     };
-    static summary = `Run an app in dev mode from your local machine.`;
     async run() {
         await this.config.runCommand('app:frontend:dev', this.argv);
     }

package/dist/commands/app/install.js

@@ -76,7 +76,7 @@ Without a store specified, install the app in the Live environment of the curren
             this.error(`You cannot install an app in the test environment of the same store.`);
         }
         config.ensureLoggedIn(storeToInstall);
-        this.api.setStoreEnv(storeToInstall, envToInstall);
+        await this.api.setStoreEnv(storeToInstall, envToInstall);
         // check if app is already installed on store
         const existingInstalledApp = await this.getInstalledApp();
         const existingVersion = existingInstalledApp?.id

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

@@ -9,7 +9,10 @@ export default class AppPull extends PushAppCommand {
     static flags: {
         force: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
+    static orientation: {
+        env: string;
+    };
     static summary: string;
-    logPulledChanges(pulled: string[], removed: string[]): void;
     run(): Promise<void>;
+    logPulledChanges(pulled: string[], removed: string[]): void;
 }

package/dist/commands/app/pull.js

@@ -32,13 +32,10 @@ ${Object.values(ConfigPaths)
             description: 'force pull all files',
         }),
     };
+    static orientation = {
+        env: 'test',
+    };
     static summary = 'Pull app files from Swell to your local machine.';
-    logPulledChanges(pulled, removed) {
-        const typeLabel = this.appType === 'theme' ? 'theme' : 'app';
-        const changeCount = pulled.length + removed.length;
-        const pluralFiles = changeCount === 1 ? 'file' : 'files';
-        this.log(`Pulled ${changeCount} ${pluralFiles} from ${style.appConfigValue(this.app.name)} ${typeLabel} in ${style.path(path.resolve(this.appPath))}.`);
-    }
     async run() {
         const { args, flags } = await this.parse(AppPull);
         const { force } = flags;
@@ -47,4 +44,10 @@ ${Object.values(ConfigPaths)
         const { pulled, removed } = await this.pullAppConfigs(force);
         this.logPulledChanges(pulled, removed);
     }
+    logPulledChanges(pulled, removed) {
+        const typeLabel = this.appType === 'theme' ? 'theme' : 'app';
+        const changeCount = pulled.length + removed.length;
+        const pluralFiles = changeCount === 1 ? 'file' : 'files';
+        this.log(`Pulled ${changeCount} ${pluralFiles} from ${style.appConfigValue(this.app.name)} ${typeLabel} in ${style.path(path.resolve(this.appPath))}.`);
+    }
 }

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

@@ -3,12 +3,14 @@ export default class AppPush extends PushAppCommand {
     static args: {
         file: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
     };
-    static delayOrientation: boolean;
     static description: string;
     static examples: string[];
     static flags: any;
-    static orientation: any;
     static summary: string;
+    static delayOrientation: boolean;
+    static orientation: {
+        env: string;
+    };
     resolvePushPaths(file: string): {
         filePath: string;
         relativePath: string;

package/dist/commands/app/push.js

@@ -10,7 +10,6 @@ export default class AppPush extends PushAppCommand {
             description: 'relative path to a configuration file or directory to push',
         }),
     };
-    static delayOrientation = true;
     static description = `Push all app files, a specific file, or a specific configuration
 type to an app in your store's test environment.
 
@@ -39,10 +38,11 @@ ${Object.values(ConfigPaths)
             description: 'skip deploying app frontend',
         }),
     };
+    static summary = 'Push local files to your Swell app.';
+    static delayOrientation = true;
     static orientation = {
         env: 'test',
     };
-    static summary = 'Push local files to your Swell app.';
     resolvePushPaths(file) {
         // Join the appPath and file to get the absolute filePath
         const filePath = path.resolve(process.cwd(), file);

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

@@ -7,6 +7,9 @@ export default class AppRelease extends PushAppCommand {
     static examples: string[];
     static flags: any;
     static summary: string;
+    static orientation: {
+        env: string;
+    };
     run(): Promise<void>;
     validateReleaseDetails(): void;
     private validateCreateVersion;

package/dist/commands/app/release.js

@@ -57,6 +57,9 @@ The app must be connected to a partner account with access to publish.`;
         }),
     };
     static summary = 'Release a new version of your an app for publishing to the App Store.';
+    static orientation = {
+        env: 'test',
+    };
     async run() {
         const { args, flags } = await this.parse(AppRelease);
         const { amend, message, 'not-supported': notSupported, 'release-notes': releaseNotesFile, yes, } = flags;

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

@@ -12,6 +12,9 @@ export default class AppVersion extends PushAppCommand {
         yes: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     static summary: string;
+    static orientation: {
+        env: string;
+    };
     run(): Promise<void>;
     private createRemoteVersion;
     private gitCommit;

package/dist/commands/app/version.js

@@ -68,6 +68,9 @@ behavior by using the --no-git-tag option.`;
         }),
     };
     static summary = 'Increment the version of your Swell app.';
+    static orientation = {
+        env: 'test',
+    };
     async run() {
         const { args, flags } = await this.parse(AppVersion);
         const { amend, 'no-git-tag': noGitTag, yes } = flags;

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

@@ -1,5 +1,6 @@
 import { CreateAppCommand } from '../../create-app-command.js';
 export default class CreateApp extends CreateAppCommand {
+    appType: string;
     static args: {
         id: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
     };
@@ -9,7 +10,6 @@ export default class CreateApp extends CreateAppCommand {
         description: string;
     }[];
     static flags: any;
-    appType: string;
     createSwellConfig({ allowOverwrite, inputId, inputStorefrontApp, inputType, inputYes, nestedPath, }: {
         allowOverwrite?: boolean;
         inputId: string;

package/dist/commands/create/app.js

@@ -7,6 +7,7 @@ import { newConfig, swellConfigFileExists } from '../../lib/app-config.js';
 import { toAppId, toAppName } from '../../lib/create/index.js';
 import style from '../../lib/style.js';
 export default class CreateApp extends CreateAppCommand {
+    appType = '';
     static args = {
         id: Args.string({
             default: '',
@@ -45,7 +46,6 @@ export default class CreateApp extends CreateAppCommand {
             options: ['admin', 'integration', 'storefront', 'theme'],
         }),
     };
-    appType = '';
     async createSwellConfig({ allowOverwrite = true, inputId, inputStorefrontApp, inputType, inputYes, nestedPath = true, }) {
         let confirmYes = inputYes;
         const type = inputType ||

package/dist/commands/login.js

@@ -44,7 +44,7 @@ have available for logging in to.
             }
         }
         const [sessionId, storeId] = await getSessionIdOrLoginInBrowser(store);
-        this.api.setStoreEnv(storeId);
+        await this.api.setStoreEnv(storeId);
         user = await this.api.get({ adminPath: 'user' }, { sessionId });
         await this.getAndSetStoreConfig({ sessionId, storeId });
         await modifyDefaultStore({ currentStoreId, storeId }, force);

package/dist/commands/theme/dev.d.ts

@@ -1,5 +1,6 @@
 import { PushAppCommand } from '../../push-app-command.js';
 export default class AppThemeDev extends PushAppCommand {
+    appType: string;
     static examples: string[];
     static flags: {
         bundle: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
@@ -8,12 +9,9 @@ export default class AppThemeDev extends PushAppCommand {
         'no-push': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         'storefront-id': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         'storefront-select': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
-    };
-    static orientation: {
-        env: string;
+        env: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
     };
     static summary: string;
-    appType: string;
     logAppLocalUrl(storeId: string, sessionId: string): void;
     run(): Promise<void>;
     private findAndInstallDependencies;

package/dist/commands/theme/dev.js

@@ -10,6 +10,7 @@ import style from '../../lib/style.js';
 import { PushAppCommand } from '../../push-app-command.js';
 const FALLBACK_PORT = 3000;
 export default class AppThemeDev extends PushAppCommand {
+    appType = 'theme';
     static examples = [
         'swell theme dev',
         'swell theme dev --local',
@@ -38,12 +39,12 @@ export default class AppThemeDev extends PushAppCommand {
             default: false,
             description: 'prompt to select a storefront to preview and push theme files to',
         }),
-    };
-    static orientation = {
-        env: 'test',
+        env: Flags.string({
+            char: 'e',
+            description: 'target environment to push to, defaults to live',
+        }),
     };
     static summary = `Run a theme in dev mode from your local machine.`;
-    appType = 'theme';
     logAppLocalUrl(storeId, sessionId) {
         this.log(`View it at ${style.link(this.localFrontendUrl(storeId, sessionId))}\n`);
     }
@@ -51,6 +52,10 @@ export default class AppThemeDev extends PushAppCommand {
         const { flags } = await this.parse(AppThemeDev);
         const { force, local } = flags;
         const noPush = flags['no-push'];
+        await this.ensureLoggedIn();
+        // Set env from default storefront first
+        const defaultStorefront = localConfig.getDefaultStorefront(this.appPath);
+        await this.setStorefrontEnv(flags, defaultStorefront);
         if (!(await this.ensureAppExists(undefined, false))) {
             return;
         }
@@ -59,12 +64,13 @@ export default class AppThemeDev extends PushAppCommand {
             const sessionId = localConfig.getSessionId(currentStore);
             this.storefrontLocalUrl = this.localFrontendUrl(currentStore, sessionId);
         }
-        if (!noPush) {
-            await this.pushAppConfigs(force);
-        }
         await this.getStorefrontToPush(flags);
+        await this.logOrientation({ env: this.api.envId || 'live' });
         this.logStorefrontConnected();
         this.saveCurrentStorefront();
+        if (!noPush) {
+            await this.pushAppConfigs(force);
+        }
         await this.startThemeDevServer(local);
     }
     async findAndInstallDependencies() {

package/dist/commands/theme/init.d.ts

@@ -1,9 +1,9 @@
 import InitApp from '../app/init.js';
 export default class InitTheme extends InitApp {
+    appType: string;
     static description: string;
     static examples: {
         command: string;
         description: string;
     }[];
-    appType: string;
 }

package/dist/commands/theme/init.js

@@ -1,5 +1,6 @@
 import InitApp from '../app/init.js';
 export default class InitTheme extends InitApp {
+    appType = 'theme';
     static description = 'Initialize theme swell.json in the current directory.';
     static examples = [
         {
@@ -11,5 +12,4 @@ export default class InitTheme extends InitApp {
             description: 'Initialize theme and accept all default values.',
         },
     ];
-    appType = 'theme';
 }

package/dist/commands/theme/pull.d.ts

@@ -1,20 +1,20 @@
 import AppPull from '../app/pull.js';
 export default class AppThemePull extends AppPull {
+    appType: string;
     static args: {
         appId: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
         targetPath: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
     };
-    static delayOrientation: boolean;
     static description: string;
     static examples: string[];
     static flags: {
         force: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         'storefront-id': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         'storefront-select': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        env: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         'sync-app': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
-    static orientation: {};
     static summary: string;
-    appType: string;
+    static delayOrientation: boolean;
     run(): Promise<void>;
 }

package/dist/commands/theme/pull.js

@@ -3,6 +3,7 @@ import { ThemeConfigPaths } from '../../lib/apps/index.js';
 import style from '../../lib/style.js';
 import AppPull from '../app/pull.js';
 export default class AppThemePull extends AppPull {
+    appType = 'theme';
     static args = {
         appId: Args.string({
             default: '',
@@ -13,7 +14,6 @@ export default class AppThemePull extends AppPull {
             description: 'path to download theme files into',
         }),
     };
-    static delayOrientation = true;
     static description = `Pull all theme files, a specific file, or a specific configuration
 type from a theme in your store's test environment to your local machine.
 
@@ -43,14 +43,17 @@ ${Object.values(ThemeConfigPaths)
             default: false,
             description: 'prompt to select a storefront to pull theme files to',
         }),
+        env: Flags.string({
+            char: 'e',
+            description: 'target environment to pull from, defaults to live',
+        }),
         'sync-app': Flags.boolean({
             default: false,
             description: 'pull app files in addition to theme files to',
         }),
     };
-    static orientation = {};
     static summary = 'Pull theme files from Swell to your local machine.';
-    appType = 'theme';
+    static delayOrientation = true;
     async run() {
         const { args, flags } = await this.parse(AppThemePull);
         const { force } = flags;

package/dist/commands/theme/push.d.ts

@@ -1,19 +1,18 @@
 import AppPush from '../app/push.js';
 export default class AppThemePush extends AppPush {
+    appType: string;
     static args: {
         file: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
     };
-    static delayOrientation: boolean;
     static description: string;
     static examples: string[];
     static flags: {
         force: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         'storefront-id': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         'storefront-select': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        env: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         'sync-app': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
-    static orientation: {};
     static summary: string;
-    appType: string;
     run(): Promise<void>;
 }

package/dist/commands/theme/push.js

@@ -1,15 +1,16 @@
 import { Args, Flags } from '@oclif/core';
 import { ThemeConfigPaths, filePathExists, isPathDirectory, } from '../../lib/apps/index.js';
+import { default as localConfig } from '../../lib/config.js';
 import style from '../../lib/style.js';
 import AppPush from '../app/push.js';
 export default class AppThemePush extends AppPush {
+    appType = 'theme';
     static args = {
         file: Args.string({
             char: 'f',
             description: 'relative path to a configuration file or directory to push',
         }),
     };
-    static delayOrientation = true;
     static description = `Push all theme files, a specific file, or a specific configuration
 type to an theme in your store's test environment.
 
@@ -45,19 +46,30 @@ ${Object.values(ThemeConfigPaths)
             default: false,
             description: 'prompt to select a storefront to push theme files to',
         }),
+        env: Flags.string({
+            char: 'e',
+            description: 'target environment to push to, defaults to live',
+        }),
         'sync-app': Flags.boolean({
             default: false,
             description: 'push app files in addition to theme files',
         }),
     };
-    static orientation = {};
     static summary = 'Push local files to your Swell theme.';
-    appType = 'theme';
     async run() {
         const { args, flags } = await this.parse(AppThemePush);
         const { file } = args;
         const { force } = flags;
         this.themeSyncApp = flags['sync-app'];
+        // Set default storefront env only if not syncing app, then it must be test env only
+        if (this.themeSyncApp) {
+            const currentStore = localConfig.getDefaultStore();
+            await this.api.setStoreEnv(currentStore, 'test');
+        }
+        else {
+            const defaultStorefront = localConfig.getDefaultStorefront(this.appPath);
+            await this.setStorefrontEnv(flags, defaultStorefront);
+        }
         if (!(await this.ensureAppExists(file, this.themeSyncApp))) {
             return;
         }
@@ -74,9 +86,10 @@ ${Object.values(ThemeConfigPaths)
                     this.error(`Path ${style.path(file)} does not exist.`);
                 }
                 // Targeting a directory
-                await (isPathDirectory(filePath)
+                const pushPromise = isPathDirectory(filePath)
                     ? this.pushFilePath(relativePath, force)
-                    : this.pushFile(relativePath));
+                    : this.pushFile(relativePath);
+                await pushPromise;
                 this.log();
                 this.logStorefrontFrontendUrl(this.storefront);
                 return;

package/dist/lib/api.d.ts

@@ -1,7 +1,7 @@
 export default class Api {
-    private envId;
-    private secretKey;
-    private storeId;
+    envId: string | undefined;
+    secretKey: string | undefined;
+    storeId: string | undefined;
     constructor(storeId?: string, envId?: string, secretKey?: string);
     api(pathOpts: Api.Paths, options: Api.RequestOptions): Promise<any>;
     delete(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
@@ -9,7 +9,8 @@ export default class Api {
     isAdmin(): boolean;
     post(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
     put(pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
-    setStoreEnv(storeId: string, envId?: string): void;
+    setStoreEnv(storeId: string, envId?: string): Promise<void>;
+    isTestEnvEnabled(): Promise<boolean>;
     truncatePath(path: string | undefined): string | undefined;
     waitForAsyncResponse(response: any, pathOpts: Api.Paths, options?: Api.RequestOptions): Promise<any>;
 }

package/dist/lib/api.js

@@ -123,10 +123,22 @@ export default class Api {
         });
         return this.waitForAsyncResponse(response, pathOpts, options);
     }
-    setStoreEnv(storeId, envId) {
+    async setStoreEnv(storeId, envId) {
+        if (envId) {
+            const hasTestEnv = await this.isTestEnvEnabled();
+            if (!hasTestEnv) {
+                throw new Error('Test environment is not enabled for this store.');
+            }
+        }
         this.storeId = storeId;
         this.envId = envId;
     }
+    async isTestEnvEnabled() {
+        const clientRecord = await this.get({
+            adminPath: `/client`,
+        });
+        return clientRecord.test_enabled !== false;
+    }
     truncatePath(path) {
         return path?.startsWith('/') ? path.slice(1) : path;
     }
@@ -135,8 +147,9 @@ export default class Api {
         if (!response?.async_progressing || !onAsyncGetPath) {
             return response;
         }
-        /* eslint-disable-next-line no-promise-executor-return */
-        await new Promise((resolve) => setTimeout(resolve, 1000));
+        await new Promise((resolve) => {
+            setTimeout(resolve, 1000);
+        });
         const asyncResponse = await this.api(onAsyncGetPath(response), {
             method: 'GET',
             onAsyncGetPath,

package/dist/lib/apps/app-config.d.ts

@@ -1,13 +1,13 @@
 /// <reference types="node" />
 import { ConfigType } from './index.js';
-declare class IgnoringFileError extends Error {
+export declare class IgnoringFileError extends Error {
     constructor(message: string);
 }
-declare class FunctionProcessingError extends Error {
+export declare class FunctionProcessingError extends Error {
     originalError: Error;
     constructor(message: string, error: Error);
 }
-type AppConfigFile = {
+interface AppConfigFile {
     content_type?: string;
     data?: string;
     date_uploaded?: string;
@@ -16,12 +16,12 @@ type AppConfigFile = {
     length?: number;
     md5?: string;
     url?: string;
-};
+}
 /**
  * An app configuration as defined by the Swell API. This implies that the
  * app & the configuration are saved to the API.
  */
-declare abstract class AppConfig {
+export declare abstract class AppConfig {
     appConfigId?: string;
     appPath: string;
     byteSize?: number;
@@ -53,4 +53,4 @@ declare abstract class AppConfig {
     protected abstract preparePostData(postData: any): Promise<any>;
     abstract type: ConfigType;
 }
-export { AppConfig, FunctionProcessingError, IgnoringFileError };
+export {};

package/dist/lib/apps/app-config.js

@@ -4,14 +4,14 @@ import { detectFilenameMime } from 'mime-detect';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import { bundleFunction } from '../bundle.js';
-import { ConfigPaths, ConfigType, filePathExists, hashFile } from './index.js';
-class IgnoringFileError extends Error {
+import { ConfigPaths, ConfigType, filePathExists, hashFile, } from './index.js';
+export class IgnoringFileError extends Error {
     constructor(message) {
         super(message);
         this.name = 'IgnoringFileError';
     }
 }
-class FunctionProcessingError extends Error {
+export class FunctionProcessingError extends Error {
     originalError;
     constructor(message, error) {
         super(message);
@@ -23,7 +23,7 @@ class FunctionProcessingError extends Error {
  * An app configuration as defined by the Swell API. This implies that the
  * app & the configuration are saved to the API.
  */
-class AppConfig {
+export class AppConfig {
     // Used when pushing a theme and the app config is considered
     appConfigId;
     // Full local path of remote AppConfig
@@ -295,4 +295,3 @@ class AppConfigTheme extends AppConfigDefault {
         return postData;
     }
 }
-export { AppConfig, FunctionProcessingError, IgnoringFileError };