@swell/cli 2.0.1-alpha.16 → 2.0.1-alpha.18

package/dist/lib/config.js

@@ -2,6 +2,10 @@ import Conf from 'conf';
 import Configstore from 'configstore';
 import { homedir } from 'node:os';
 import path from 'node:path';
+import localEnv from '../env/local.js';
+import prodEnv from '../env/production.js';
+import reviewEnv from '../env/review.js';
+import stagingEnv from '../env/staging.js';
 import style from './style.js';
 const configPath = process.env.NODE_ENV === 'test'
     ? path.resolve(process.cwd(), 'test', '.swell', 'config.json')
@@ -28,6 +32,36 @@ const env = new Conf({
     projectName: 'swell',
     projectSuffix: '',
 });
+function setEnv(name, reviewBranch) {
+    let newEnv = {};
+    if (name.startsWith('prod')) {
+        newEnv = { ...prodEnv };
+    }
+    else if (name.startsWith('stag')) {
+        newEnv = { ...stagingEnv };
+    }
+    else if (name.startsWith('local')) {
+        newEnv = { ...localEnv };
+    }
+    else if (name.startsWith('rev') || name.startsWith('ra')) {
+        if (reviewBranch) {
+            const reviewAppEnv = { ...reviewEnv };
+            const reviewDomain = reviewBranch.replaceAll('/', '-');
+            for (const key of Object.keys(reviewAppEnv)) {
+                reviewAppEnv[key] = reviewAppEnv[key].replace('${REVIEW_DOMAIN}', reviewDomain);
+            }
+            newEnv = reviewAppEnv;
+        }
+        else {
+            throw new Error('Review environment requires a branch name.');
+        }
+    }
+    else {
+        throw new Error(`Invalid environment '${name}'. Should be one of 'prod', 'staging', 'review', or 'local'.`);
+    }
+    env.set(newEnv);
+    return newEnv;
+}
 /**
  * Get specified attributes for given object.
  *
@@ -68,6 +102,18 @@ function getDefaultStore() {
 function setDefaultStore(storeId) {
     return configStore.set('defaultStore', storeId);
 }
+function getDefaultStorefront(appPath) {
+    const storeId = getDefaultStore();
+    const defaultStorefronts = configStore.get('defaultStorefronts') || {};
+    return defaultStorefronts[storeId]?.[appPath];
+}
+function setDefaultStorefront(appPath, storefrontId) {
+    const storeId = getDefaultStore();
+    const defaultStorefronts = configStore.get('defaultStorefronts') || {};
+    defaultStorefronts[storeId] = defaultStorefronts[storeId] || {};
+    defaultStorefronts[storeId][appPath] = storefrontId;
+    return configStore.set('defaultStorefronts', defaultStorefronts);
+}
 function getSessionId(storeId) {
     if (!configStore.has('stores'))
         return;
@@ -122,10 +168,12 @@ const config = {
     get,
     getAll,
     getDefaultStore,
+    getDefaultStorefront,
     getSessionId,
     getUser,
     setDefaultStore,
+    setDefaultStorefront,
     setStore,
     setUser,
 };
-export { config as default, env };
+export { config as default, env, setEnv };

package/dist/lib/constants.d.ts

@@ -1,5 +1,10 @@
 export declare const API_BASE_URL: any;
 export declare const ADMIN_API_BASE_URL: any;
 export declare const LOGIN_HOST: any;
+export declare const APP_PAGES_HOST: any;
+export declare const STOREFRONT_FRONTEND_HOST: any;
 export declare function getAdminApiBaseUrl(storeId: string): any;
 export declare function getLoginHost(storeId?: string): any;
+export declare function getAppFrontendHost(storeId: string, installedAppId: string): any;
+export declare function getStorefrontFrontendHost(storefrontSlug: string, branchId?: string): any;
+export declare function getLocalFrontendHost(storeId: string, sessionId: string): any;

package/dist/lib/constants.js

@@ -1,12 +1,18 @@
-/* eslint-disable no-template-curly-in-string */
+import defaultEnv from '../env/production.js';
 import { env } from './config.js';
 // note: env values stored in ~/.swell/env.json
 // url for backend api calls
-export const API_BASE_URL = env.get('API_BASE_URL') || 'https://api.swell.store';
+export const API_BASE_URL = env.get('API_BASE_URL') || defaultEnv.API_BASE_URL;
 // url for admin api calls
-export const ADMIN_API_BASE_URL = env.get('ADMIN_API_BASE_URL') || 'https://${STORE_ID}.swell.store/admin/api';
+export const ADMIN_API_BASE_URL = env.get('ADMIN_API_BASE_URL') || defaultEnv.ADMIN_API_BASE_URL;
 // url host for admin login
-export const LOGIN_HOST = env.get('LOGIN_HOST') || 'https://${STORE_ID}.swell.store';
+export const LOGIN_HOST = env.get('LOGIN_HOST') || defaultEnv.LOGIN_HOST;
+// url host for app frontend
+export const APP_PAGES_HOST = env.get('APP_PAGES_HOST') || defaultEnv.APP_PAGES_HOST;
+// url host for storefront app frontend
+export const STOREFRONT_FRONTEND_HOST = env.get('STOREFRONT_FRONTEND_HOST') ||
+    env.get('STOREFRONT_PAGES_HOST') || // Deprecated
+    defaultEnv.STOREFRONT_FRONTEND_HOST;
 // helpers to get constants with replacements
 export function getAdminApiBaseUrl(storeId) {
     return ADMIN_API_BASE_URL.replace('${STORE_ID}', storeId);
@@ -14,3 +20,16 @@ export function getAdminApiBaseUrl(storeId) {
 export function getLoginHost(storeId) {
     return LOGIN_HOST.replace('${STORE_ID}', storeId || 'login');
 }
+export function getAppFrontendHost(storeId, installedAppId) {
+    return APP_PAGES_HOST.replace('${STORE_ID}', storeId)
+        .replace('${APP_ID}', installedAppId)
+        .replace('${ENV}', 'app');
+}
+export function getStorefrontFrontendHost(storefrontSlug, branchId) {
+    return STOREFRONT_FRONTEND_HOST.replace('${STOREFRONT_SLUG}', storefrontSlug).replace('${BRANCH_PREFIX}', branchId ? `${branchId}.` : '');
+}
+export function getLocalFrontendHost(storeId, sessionId) {
+    return APP_PAGES_HOST.replace('${STORE_ID}', storeId)
+        .replace('${APP_ID}', sessionId)
+        .replace('${ENV}', 'local');
+}

package/dist/lib/create/content.d.ts

@@ -12,7 +12,7 @@ interface ContentViewProps {
     tabs: [];
 }
 type ContentView = 'edit' | 'list' | 'new';
-type ContentType = 'asset' | 'basic_html' | 'blocks' | 'boolean' | 'category_lookup' | 'checkbox' | 'checkboxes' | 'collection' | 'color' | 'currency' | 'customer_lookup' | 'date' | 'datetime' | 'document' | 'dropdown' | 'email' | 'field_group' | 'generic_lookup' | 'icon' | 'image' | 'long_text' | 'lookup' | 'markdown' | 'number' | 'percent' | 'phone' | 'product_lookup' | 'radio' | 'rich_html' | 'select' | 'short_text' | 'slider' | 'slug' | 'tags' | 'text' | 'textarea' | 'time' | 'toggle' | 'url' | 'variant_lookup' | 'video';
+type ContentType = 'asset' | 'basic_html' | 'boolean' | 'category_lookup' | 'checkbox' | 'checkboxes' | 'collection' | 'color' | 'color_scheme' | 'color_scheme_group' | 'currency' | 'customer_lookup' | 'date' | 'datetime' | 'document' | 'dropdown' | 'email' | 'field_group' | 'font_family' | 'generic_lookup' | 'html' | 'icon' | 'image' | 'long_text' | 'lookup' | 'markdown' | 'number' | 'percent' | 'phone' | 'product_lookup' | 'radio' | 'rich_html' | 'rich_text' | 'select' | 'short_text' | 'slider' | 'slug' | 'tags' | 'text' | 'textarea' | 'time' | 'toggle' | 'url' | 'variant_lookup' | 'video';
 interface ContentFieldProps {
     id: string;
     label: string;

package/dist/lib/create/index.js

@@ -2,7 +2,11 @@ import { dasherize, pluralize, titleize, underscore } from 'inflection';
 // Example: 'My Thing' => 'my-thing'
 const toFileName = (value) => dasherize(underscore(value.split('.')[0].replace(' ', '_'))).toLowerCase();
 // Example: 'my-things' => 'My Things'
-const toAppName = (value) => pluralize(titleize(value).replace('-', ' '));
+const toAppName = (value) => titleize(value)
+    .replaceAll(/[_\s-:./-]+/g, ' ')
+    .replaceAll(/([a-z])([A-Z])/g, '$1 $2')
+    .replaceAll(/(\d)([a-z])/gi, '$1 $2')
+    .replaceAll(/([a-z])(\d)/gi, '$1 $2');
 // Example: 'My App' => 'my_app'
 const toAppId = (value) => String(value || '')
     .replaceAll(/[^\s\w./:-]/g, '')

package/dist/lib/info.js

@@ -20,7 +20,7 @@ export class FieldDefinitions {
     get client() {
         return {
             label: 'Test store',
-            transform: (client) => `${client.name} (${style.storeId(client.id)})`,
+            transform: (client) => client && `${client.name} (${style.storeId(client.id)})`,
         };
     }
     get dateCreated() {
@@ -57,7 +57,7 @@ export class FieldDefinitions {
             label: 'Version',
             transform: (_version) => {
                 if (this.versions.length === 0) {
-                    return 'N/A';
+                    return this.app.version || 'N/A';
                 }
                 return [
                     style.appConfigValue(this.versions[0].version),

package/dist/lib/stores.d.ts

@@ -54,13 +54,15 @@ declare function selectEnvironmentId(message?: string): Promise<string>;
  * If there is no current store id, it will always be set as the default
  * without asking.
  *
- * @param currentStoreId - The ID of the default store
- * @param storeId - The ID of the store to set as the default
+ * @param storeParams -
+ *  currentStoreId - The ID of the default store
+ *  storeId - The ID of the store to set as the default
+ * @param force - True to force
  *
  * @returns void
  */
 declare function modifyDefaultStore({ currentStoreId, storeId, }: {
     currentStoreId: string;
     storeId: string;
-}): Promise<void>;
+}, force?: boolean): Promise<void>;
 export { modifyDefaultStore, selectEnvironmentId, selectLoggedInStoreId, selectStoreId, showStores, };

package/dist/lib/stores.js

@@ -157,19 +157,21 @@ async function selectEnvironmentId(message) {
  * If there is no current store id, it will always be set as the default
  * without asking.
  *
- * @param currentStoreId - The ID of the default store
- * @param storeId - The ID of the store to set as the default
+ * @param storeParams -
+ *  currentStoreId - The ID of the default store
+ *  storeId - The ID of the store to set as the default
+ * @param force - True to force
  *
  * @returns void
  */
-async function modifyDefaultStore({ currentStoreId, storeId, }) {
+async function modifyDefaultStore({ currentStoreId, storeId, }, force = false) {
     let modifyDefault = false;
-    if (currentStoreId && currentStoreId !== storeId) {
+    if (!force && currentStoreId && currentStoreId !== storeId) {
         modifyDefault = await confirm({
             message: `Do you want to make ${style.storeId(storeId)} your default store?`,
         });
     }
-    if (!currentStoreId || modifyDefault) {
+    if (force || !currentStoreId || modifyDefault) {
         config.setDefaultStore(storeId);
     }
 }

package/dist/lib/style.d.ts

@@ -5,9 +5,11 @@ declare const _default: {
     link: import("chalk").ChalkInstance;
     path: import("chalk").ChalkInstance;
     dim: import("chalk").ChalkInstance;
+    strike: import("chalk").ChalkInstance;
     command: import("chalk").ChalkInstance;
     storeId: import("chalk").ChalkInstance;
     currentUser: import("chalk").ChalkInstance;
+    appName: import("chalk").ChalkInstance;
     appEnvLive: import("chalk").ChalkInstance;
     appEnv: import("chalk").ChalkInstance;
     appConfigName: import("chalk").ChalkInstance;

package/dist/lib/style.js

@@ -7,11 +7,13 @@ export default {
     link: chalk.blueBright.underline,
     path: chalk.underline,
     dim: chalk.dim,
+    strike: chalk.strikethrough,
     // styles for consistent output of some elements
     command: chalk.magenta.bold,
     storeId: chalk.yellow,
     currentUser: chalk.blueBright.underline,
     // apps
+    appName: chalk.yellow,
     appEnvLive: chalk.magenta,
     appEnv: chalk.yellow,
     appConfigName: chalk.yellow,

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

@@ -0,0 +1,73 @@
+/// <reference types="node" />
+import { App, AppConfig, ConfigType, FrontendProjectType } from './lib/apps/index.js';
+import { RemoteAppCommand } from './remote-app-command.js';
+type WatchFileEvent = 'change' | 'deleted' | 'new';
+export declare abstract class PushAppCommand extends RemoteAppCommand {
+    frontendPath: string;
+    logWatchChanges: boolean;
+    onWatchChange?: ((appConfig?: AppConfig, result?: any) => void) | undefined;
+    watchingChangeQueue: Array<any>;
+    watchingChangeQueueRunning: boolean;
+    watchingFiles: Array<string>;
+    watchListener: (eventType: string, filename: Buffer | null | string) => Promise<void>;
+    buildFrontend(projectType: FrontendProjectType): Promise<void>;
+    chooseAppToPull(query?: any): Promise<App>;
+    createAppStorefront(hasOtherStorefronts?: boolean): Promise<any>;
+    deployAppFrontend(force?: boolean, log?: boolean): Promise<void>;
+    deployFrontend(projectType: FrontendProjectType): Promise<string>;
+    ensureAppExists(file?: string, shouldCreate?: boolean): Promise<boolean>;
+    ensureLoggedIn(): Promise<true | undefined>;
+    exec(command: string, onOutput?: (string: string) => any | false): Promise<void>;
+    getAllAppStorefronts(params?: {
+        type?: string;
+    }): Promise<any>;
+    getAllStorefronts(params?: {
+        app_id?: string;
+        theme_app_id?: string;
+        type?: string;
+    }): Promise<any>;
+    getAppStorefront(params?: {
+        storefront_id?: string;
+        type?: string;
+    }): Promise<any>;
+    getAppToPull(args: {
+        appId?: string;
+        targetPath?: string;
+    }, shouldChoose?: boolean): Promise<App | undefined>;
+    getExistingApp(appId: string): Promise<App>;
+    getFrontendDeploymentHash(): string | undefined;
+    getFrontendProjectType(required?: boolean): FrontendProjectType | null;
+    getStorefrontToPull(args?: {
+        appId?: string;
+        targetPath?: string;
+    }, flags?: {
+        'storefront-id'?: string;
+        'storefront-select'?: boolean;
+    }): Promise<any>;
+    getStorefrontToPush(flags?: {
+        'storefront-id'?: string;
+        'storefront-select'?: boolean;
+    }): Promise<any>;
+    handleWatchFileChange(configFile: string, configType: ConfigType, event: WatchFileEvent): Promise<void>;
+    logAppFrontendUrl(): void;
+    logDashboardUrl(flags: {
+        [flag: string]: any;
+    }): void;
+    logStorefrontConnected(): void;
+    logStorefrontFrontendUrl(storefront?: any, branchId?: string): void;
+    pushFile(relativePath: string): Promise<void>;
+    pushFilePath(relativePath: string, force?: boolean): Promise<void>;
+    resolveAppPath(appId?: string, targetPath?: string): string;
+    runWatchChangeQueue(): Promise<void>;
+    saveCurrentStorefront(): void;
+    setWatchingFiles(): void;
+    updateFrontendDeployment(currentStore: string, projectType: FrontendProjectType, deploymentUrl: string, deploymentHash: string): Promise<void>;
+    watchForChanges({ logChanges, onChange, syncAll, }?: {
+        logChanges?: boolean | undefined;
+        onChange?: (() => void) | undefined;
+        syncAll?: boolean | undefined;
+    }): Promise<void>;
+    wranglerDeployFrontend(projectType: FrontendProjectType): Promise<string>;
+    private confirmRemoveInstalledApp;
+}
+export {};