@swell/cli 2.0.1-alpha.13 → 2.0.1-alpha.17

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

@@ -10,4 +10,4 @@ declare const toFunctionFileName: (value: string) => string;
 declare const toCollectionName: (value: string) => string;
 declare const toCollectionLabel: (value: string) => string;
 declare const toNotificationLabel: (value: string) => string;
-export { CreateFileParams, toFileName, toAppName, toAppId, toFunctionFileName, toCollectionName, toCollectionLabel, toNotificationLabel, };
+export { CreateFileParams, toAppId, toAppName, toCollectionLabel, toCollectionName, toFileName, toFunctionFileName, toNotificationLabel, };

package/dist/lib/create/index.js

@@ -1,14 +1,18 @@
-import { dasherize, pluralize, underscore, titleize } from 'inflection';
+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(/([0-9])([A-Z])/gi, '$1 $2')
+    .replaceAll(/([A-Z])([0-9])/gi, '$1 $2');
 // Example: 'My App' => 'my_app'
 const toAppId = (value) => String(value || '')
-    .replace(/[^a-zA-Z0-9\-_\s:\.\/]/g, '')
-    .replace(/[_\s-:\.\/]+/g, '_')
-    .replace(/^[_]+|[_]+$/g, '')
-    .replace(/([a-z])([A-Z])/g, '$1_$2')
+    .replaceAll(/[^\s\w./:-]/g, '')
+    .replaceAll(/[_\s-:./]+/g, '_')
+    .replaceAll(/^_+|_+$/g, '')
+    .replaceAll(/([a-z])([A-Z])/g, '$1_$2')
     .toLowerCase();
 // Example: 'My Thing' => 'my-thing'
 // And: 'myThing' => 'myThing'
@@ -19,4 +23,4 @@ const toCollectionName = (value) => pluralize(value.replaceAll(/[^A-Za-z]/g, '-'
 const toCollectionLabel = (value) => pluralize(titleize(value).replace('-', ' '));
 // Example: 'order-receipt' => 'Order Receipt'
 const toNotificationLabel = (value) => titleize(value).replace('-', ' ');
-export { toFileName, toAppName, toAppId, toFunctionFileName, toCollectionName, toCollectionLabel, toNotificationLabel, };
+export { toAppId, toAppName, toCollectionLabel, toCollectionName, toFileName, toFunctionFileName, toNotificationLabel, };

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

@@ -1,9 +1,9 @@
 interface CreateModelFileBody {
-    label?: string;
     collection?: string;
     description?: string;
-    fields?: ModelFieldResponse;
     events?: ModelEventObject;
+    fields?: ModelFieldResponse;
+    label?: string;
 }
 interface ModelEventObject {
     types?: ModelEvent[];

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

@@ -1,11 +1,11 @@
 interface WriteNotificationsFileParams {
+    admin?: boolean;
     description: string;
     event: string;
     model: string;
     name: string;
-    subject: string;
-    admin?: boolean;
     once?: boolean;
+    subject: string;
 }
 interface CreateNotificationFileBody {
     admin?: boolean;

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/sessions.js

@@ -20,7 +20,6 @@ function createServer(onSessionId, storeId) {
     // the spinner is used to show progress while waiting for the browser
     const spinner = ux.action;
     serverForLogin({
-        storeId,
         onPost(req) {
             // we received the session id from the browser so we can move on
             const sessionId = req.headers['x-session'];
@@ -37,6 +36,7 @@ function createServer(onSessionId, storeId) {
             ].join(' '));
             await open(loginUrl);
         },
+        storeId,
     });
 }
 /**
@@ -52,7 +52,7 @@ function createServer(onSessionId, storeId) {
  * from the browser
  * @returns void
  */
-function serverForLogin({ storeId, onPost, onStart, }) {
+function serverForLogin({ onPost, onStart, storeId, }) {
     // flag to track if the POST and GET requests have been handled
     // we only want to handle them once
     let postHandled = false;

package/dist/lib/stores.d.ts

@@ -35,6 +35,7 @@ declare function selectStoreId({ authorizations, currentStoreId, force, }: {
  * Select the store to switch to from a CLI prompt from the list of
  * already logged in stores.
  *
+ * @param message Store selection message
  * @returns The store ID to switch to
  * @throws CLIError - If there are no stores to switch to
  */
@@ -42,6 +43,8 @@ declare function selectLoggedInStoreId(message?: string): Promise<string>;
 /**
  * Select an environment.
  *
+ * @param message Environment selection message
+ * @returns Environment to switch to
  * @throws CLIError - If there are no stores to switch to
  */
 declare function selectEnvironmentId(message?: string): Promise<string>;
@@ -59,5 +62,5 @@ declare function selectEnvironmentId(message?: string): Promise<string>;
 declare function modifyDefaultStore({ currentStoreId, storeId, }: {
     currentStoreId: string;
     storeId: string;
-}): Promise<void>;
-export { modifyDefaultStore, selectLoggedInStoreId, selectStoreId, selectEnvironmentId, showStores, };
+}, force?: boolean): Promise<void>;
+export { modifyDefaultStore, selectEnvironmentId, selectLoggedInStoreId, selectStoreId, showStores, };

package/dist/lib/stores.js

@@ -101,6 +101,7 @@ async function selectStoreId({ authorizations, currentStoreId, force = false, })
  * Select the store to switch to from a CLI prompt from the list of
  * already logged in stores.
  *
+ * @param message Store selection message
  * @returns The store ID to switch to
  * @throws CLIError - If there are no stores to switch to
  */
@@ -123,14 +124,16 @@ async function selectLoggedInStoreId(message) {
             new Separator(),
             { name: 'Login to another account', value: '' },
         ],
+        loop: false,
         message: message || 'Which store do you want to switch to?',
         pageSize: 25,
-        loop: false,
     });
 }
 /**
  * Select an environment.
  *
+ * @param message Environment selection message
+ * @returns Environment to switch to
  * @throws CLIError - If there are no stores to switch to
  */
 async function selectEnvironmentId(message) {
@@ -145,7 +148,7 @@ async function selectEnvironmentId(message) {
                 value: 'test',
             },
         ],
-        message: message || 'Which envoronment?',
+        message: message || 'Which environment?',
     });
 }
 /**
@@ -159,15 +162,15 @@ async function selectEnvironmentId(message) {
  *
  * @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);
     }
 }
-export { modifyDefaultStore, selectLoggedInStoreId, selectStoreId, selectEnvironmentId, showStores, };
+export { modifyDefaultStore, selectEnvironmentId, selectLoggedInStoreId, selectStoreId, showStores, };

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/lib/swell-function-wrapper.d.ts

@@ -84,11 +84,11 @@ declare class SwellRequest {
     ingestLogs(response: any): Promise<void>;
     /**
      * Merge values into app data for the current request.
-     * @param {object|string|undefined} idOrValues string to indicate app ID, or values to merge
+     * @param {object|string} idOrValues string to indicate app ID, or values to merge
      * @param {object|undefined} values values to merge into app data
      * @returns {object|undefined} existing app data merged with values if passed
      */
-    appValues(idOrValues?: object | string | undefined, values?: object | undefined): object | undefined;
+    appValues(idOrValues: object | string, values?: object | undefined): object | undefined;
 }
 /**
  * Class representing the Swell backend API.

package/dist/lib/swell-function-wrapper.js

@@ -182,11 +182,11 @@ class SwellRequest {
     }
     /**
      * Merge values into app data for the current request.
-     * @param {object|string|undefined} idOrValues string to indicate app ID, or values to merge
+     * @param {object|string} idOrValues string to indicate app ID, or values to merge
      * @param {object|undefined} values values to merge into app data
      * @returns {object|undefined} existing app data merged with values if passed
      */
-    appValues(idOrValues = undefined, values = undefined) {
+    appValues(idOrValues, values = undefined) {
         const appId = typeof idOrValues === 'string' ? appIdOrValues : this.appId;
         const appValues = typeof idOrValues === 'string' ? values : idOrValues;
         if (!appId || !isOrdinaryObject(appValues)) {

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;
+    watchingFiles: Array<string>;
+    watchingChangeQueue: Array<any>;
+    watchingChangeQueueRunning: boolean;
+    logWatchChanges: boolean;
+    onWatchChange?: ((appConfig?: AppConfig, result?: any) => void) | undefined;
+    exec(command: string, onOutput?: (string: string) => false | any): Promise<void>;
+    setWatchingFiles(): void;
+    watchForChanges({ logChanges, syncAll, onChange, }?: {
+        logChanges?: boolean | undefined;
+        syncAll?: boolean | undefined;
+        onChange?: (() => void) | undefined;
+    }): Promise<void>;
+    watchListener: (eventType: string, filename: Buffer | null | string) => Promise<void>;
+    handleWatchFileChange(configFile: string, configType: ConfigType, event: WatchFileEvent): Promise<void>;
+    runWatchChangeQueue(): Promise<void>;
+    deployAppFrontend(force?: boolean, log?: boolean): Promise<void>;
+    getFrontendDeploymentHash(): string | undefined;
+    getFrontendProjectType(required?: boolean): FrontendProjectType | null;
+    ensureLoggedIn(): Promise<true | undefined>;
+    ensureAppExists(file?: string, shouldCreate?: boolean): Promise<boolean>;
+    private confirmRemoveInstalledApp;
+    resolveAppPath(appId?: string, targetPath?: string): string;
+    getAppStorefront(params?: {
+        storefront_id?: string;
+        type?: string;
+    }): Promise<any>;
+    getAllStorefronts(params?: {
+        app_id?: string;
+        theme_app_id?: string;
+        type?: string;
+    }): Promise<any>;
+    getAllAppStorefronts(params?: {
+        type?: string;
+    }): Promise<any>;
+    saveCurrentStorefront(): void;
+    getAppToPull(args: {
+        appId?: string;
+        targetPath?: string;
+    }, shouldChoose?: boolean): Promise<App | undefined>;
+    getExistingApp(appId: string): Promise<App>;
+    getStorefrontToPush(flags?: {
+        'storefront-id'?: string;
+        'storefront-select'?: boolean;
+    }): Promise<any>;
+    getStorefrontToPull(args?: {
+        appId?: string;
+        targetPath?: string;
+    }, flags?: {
+        'storefront-id'?: string;
+        'storefront-select'?: boolean;
+    }): Promise<any>;
+    chooseAppToPull(query?: any): Promise<App>;
+    createAppStorefront(hasOtherStorefronts?: boolean): Promise<any>;
+    logStorefrontConnected(): void;
+    logDashboardUrl(flags: {
+        [flag: string]: any;
+    }): void;
+    pushFilePath(relativePath: string, force?: boolean): Promise<void>;
+    pushFile(relativePath: string): Promise<void>;
+    deployFrontend(projectType: FrontendProjectType): Promise<string>;
+    buildFrontend(projectType: FrontendProjectType): Promise<void>;
+    wranglerDeployFrontend(projectType: FrontendProjectType): Promise<string>;
+    updateFrontendDeployment(currentStore: string, projectType: FrontendProjectType, deploymentUrl: string, deploymentHash: string): Promise<void>;
+    logAppFrontendUrl(): void;
+    logStorefrontFrontendUrl(storefront?: any, branchId?: string): void;
+}
+export {};