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

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

@@ -1,9 +1,16 @@
 "use strict";
 const origialConsoleLog = console.log;
 addEventListener('fetch', (event) => {
-    event.respondWith(handleRequest(event.request, event.env, event));
+    event.respondWith(request(event.request, event.env, event));
 });
-async function handleRequest(originalRequest, _env, context) {
+/**
+ * Handle a function request.
+ * @param {Request} originalRequest from cloudflare
+ * @param {*} _env cloudflare environment vars
+ * @param {*} context cloudflare conttext
+ * @returns {Promise<SwellResponse>}
+ */
+async function request(originalRequest, _env, context) {
     const req = new SwellRequest(originalRequest, context);
     await req.initialize();
     let response;
@@ -12,16 +19,10 @@ async function handleRequest(originalRequest, _env, context) {
     }
     catch (err) {
         // Log the error for Swell
-        console.error(err.stack);
+        console.error(err);
         response = new SwellResponse({ error: err.message }, { status: err.status || 500 });
     }
-    // Create a response by default if one is not returned
-    if (!(response instanceof Response)) {
-        response = new SwellResponse(response);
-    }
-    // Send logs back to Swell
-    context.waitUntil(req.ingestLogs(response));
-    return response;
+    return SwellResponse._respond(req, response, context);
 }
 /**
  * Invokes one of the function types that are available.
@@ -74,6 +75,9 @@ async function executeModuleHandler(req, context) {
     }
     throw new Error(`Function does not export a method to handle ${method.toUpperCase()} requests`);
 }
+/**
+ * Class representing a Swell request.
+ */
 class SwellRequest {
     constructor(req, context) {
         this.originalRequest = req;
@@ -141,11 +145,11 @@ class SwellRequest {
         origialConsoleLog(...line);
         this._logs.push({
             date: Date.now(),
-            line: line.map((l) => JSON.stringify(l)),
+            line: line.map((l) => (l instanceof Error ? l.stack : JSON.stringify(l))),
             ...(level !== 'info' ? { level } : {}),
         });
     }
-    async ingestLogs(response) {
+    getIngestableLogs(response) {
         if (!this.logParams) {
             return;
         }
@@ -153,23 +157,51 @@ class SwellRequest {
             this.logParams.time = Date.now() - this.logParams.$start;
             delete this.logParams.$start;
         }
-        const result = await this.swell.post('/:logs', {
-            $ingest_function_logs: {
-                params: {
-                    ...this.logParams,
-                    message: {
-                        ...this.logParams?.message,
-                        logs: this._logs,
-                        status: response.status,
-                    },
+        return {
+            params: {
+                ...this.logParams,
+                message: {
+                    ...this.logParams?.message,
+                    logs: this._logs,
+                    status: response.status,
                 },
             },
+        };
+    }
+    async ingestLogs(response) {
+        const ingestableLogs = this.getIngestableLogs(response);
+        if (!ingestableLogs) {
+            return;
+        }
+        const result = await this.swell.post('/:logs', {
+            $ingest_function_logs: ingestableLogs,
         });
         if (!result?.success) {
             console.error('Error ingesting logs', result);
         }
     }
+    /**
+     * Merge values into app data for the current request.
+     * @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, values = undefined) {
+        const appId = typeof idOrValues === 'string' ? appIdOrValues : this.appId;
+        const appValues = typeof idOrValues === 'string' ? values : idOrValues;
+        if (!appId || !isOrdinaryObject(appValues)) {
+            return undefined;
+        }
+        return {
+            $app: {
+                [appId]: appValues,
+            },
+        };
+    }
 }
+/**
+ * Class representing the Swell backend API.
+ */
 class SwellAPI {
     constructor(req, context) {
         this.request = req;
@@ -261,6 +293,9 @@ class SwellAPI {
         return this.makeRequest('GET', `/settings/${id}`);
     }
 }
+/**
+ * Class representing a Swell error.
+ */
 class SwellError extends Error {
     constructor(message, options = {}) {
         let formattedMessage;
@@ -278,10 +313,13 @@ class SwellError extends Error {
         this.status = options.status || 500;
     }
 }
+/**
+ * Class representing a Swell response.
+ */
 class SwellResponse extends Response {
     constructor(data, options = {}) {
         const resultHeaders = {};
-        let result;
+        let result = '';
         if (typeof data === 'string') {
             result = data;
             resultHeaders['Content-Type'] = 'text/plain;charset=UTF-8';
@@ -298,5 +336,52 @@ class SwellResponse extends Response {
                 ...(options.headers || {}),
             },
         });
+        // Saved for future access
+        this._swellData = data;
+        this._swellOptions = options || {};
     }
+    static _respond(req, response, context) {
+        let finalResponse = response;
+        // Convert a plain Response instance to SwellResponse
+        if (finalResponse instanceof Response &&
+            !(finalResponse instanceof SwellResponse)) {
+            finalResponse = new SwellResponse(response.body, {
+                status: response.status,
+                headers: response.headers,
+            });
+        }
+        else if (!(finalResponse instanceof SwellResponse)) {
+            finalResponse = new SwellResponse(response);
+        }
+        // Send logs back with the response for event hooks
+        if (req.data?.$event?.hook) {
+            return SwellResponse._respondWithLogs(finalResponse, req);
+        }
+        // Ingest logs in the background
+        context.waitUntil(req.ingestLogs(finalResponse));
+        return finalResponse;
+    }
+    static _respondWithLogs(response, req) {
+        const ingestableLogs = req.getIngestableLogs(response);
+        // Rebuild response with logs
+        const responseData = response instanceof SwellResponse ? response?._swellData : response;
+        const resultData = ingestableLogs
+            ? {
+                $logs: ingestableLogs,
+                $data: responseData,
+            }
+            : responseData;
+        return new SwellResponse(resultData, response?._swellOptions);
+    }
+}
+/**
+ * Helper to determine if a value is an ordinary object.
+ * @param {any} obj
+ * @returns {boolean}
+ */
+function isOrdinaryObject(val) {
+    return (typeof val === 'object' &&
+        val !== null &&
+        Object.getPrototypeOf(val) === Object.prototype);
 }
+;

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

@@ -14,12 +14,14 @@ export declare abstract class RemoteAppCommand extends AppCommand {
     protected getApp(id?: string): Promise<App>;
     protected getAppWithConfig(id?: string): Promise<App>;
     protected getCreateUpdateApp(updateApp?: App): Promise<App>;
+    protected getVersions(version?: null | string | undefined): Promise<AppVersion[]>;
     protected handleRequestErrors(request: () => any, spinnerError?: () => void): Promise<any>;
     init(): Promise<void>;
     protected postConfig(configJson: any): Promise<any>;
     protected pushConfigFile(appConfig: AppConfig): Promise<any>;
     protected removeConfig(config: AppConfig): Promise<any>;
     protected showErrors(errors: any, spinnerError?: () => void): void;
+    protected swellRcPath(): string;
     protected syncAppConfigs(): Promise<{
         installed: string[];
         removed: string[];
@@ -31,6 +33,4 @@ export declare abstract class RemoteAppCommand extends AppCommand {
      */
     private initApp;
     private showOrientation;
-    protected getVersions(version?: string | undefined | null): Promise<AppVersion[]>;
-    protected swellRcPath(): string;
 }

package/dist/remote-app-command.js

@@ -5,9 +5,9 @@ import ora from 'ora';
 import { AppCommand } from './app-command.js';
 import { appConfigFileExists, readRcFile, writeRcFile, } from './lib/app-config.js';
 import { FunctionProcessingError, IgnoringFileError, allConfigFilesPaths, appConfigFromFile, appLogoIcon, batchAppConfigsByType, configFilePath, isAppLogoIcon, } from './lib/apps/index.js';
-import { toAppId } from './lib/create/index.js';
 import { default as swellConfig } from './lib/config.js';
 import { getLoginHost } from './lib/constants.js';
+import { toAppId } from './lib/create/index.js';
 import style from './lib/style.js';
 /**
  * Extends the AppCommand with methods that ease managing remote apps and
@@ -22,7 +22,7 @@ export class RemoteAppCommand extends AppCommand {
     dashboardUrl(flags = {}, storeId) {
         const { env } = flags;
         const envFlag = env || this.ctor.orientation?.env;
-        const outputEnv = envFlag === 'live' ? '' : !envFlag ? '' : 'test';
+        const outputEnv = envFlag === 'live' ? '' : envFlag ? 'test' : '';
         return `${getLoginHost(storeId)}/admin/${outputEnv ? `${outputEnv}/` : ''}apps/${this.app.id}`;
     }
     async deleteConfig(configId) {
@@ -142,7 +142,7 @@ export class RemoteAppCommand extends AppCommand {
                     adminPath: `/apps/${this.appConfig.store.id}`,
                 });
             }
-            catch (err) {
+            catch {
                 // noop
             }
             spinner.start(`Creating app...`);
@@ -180,6 +180,17 @@ export class RemoteAppCommand extends AppCommand {
         }
         return {};
     }
+    async getVersions(version) {
+        const versionsResponse = await this.api.get({ adminPath: `/apps/${this.app.id}/versions` }, {
+            query: {
+                limit: 1000,
+                sort: 'version desc',
+                ...(version ? { version } : undefined),
+            },
+        });
+        this.debugJson('getApp: versionsResponse', versionsResponse);
+        return versionsResponse.results || [];
+    }
     async handleRequestErrors(request, spinnerError) {
         try {
             const response = await request();
@@ -291,6 +302,9 @@ export class RemoteAppCommand extends AppCommand {
                 .join(' '));
         }
     }
+    swellRcPath() {
+        return path.join(this.appPath, '.swellrc');
+    }
     async syncAppConfigs() {
         const configsToPush = [];
         const installed = [];
@@ -306,8 +320,8 @@ export class RemoteAppCommand extends AppCommand {
         const batches = batchAppConfigsByType(configsToPush);
         for (const batch of batches) {
             this.log(style.appConfigName(batch.label));
-            // eslint-disable-next-line no-await-in-loop
             for (const appConfig of batch.configs) {
+                // eslint-disable-next-line no-await-in-loop
                 const installedConfig = await this.pushConfigFile(appConfig);
                 if (installedConfig)
                     installed.push(installedConfig.id);
@@ -375,18 +389,4 @@ export class RemoteAppCommand extends AppCommand {
         this.log(orientationOutput.join(' '));
         this.log();
     }
-    async getVersions(version) {
-        const versionsResponse = await this.api.get({ adminPath: `/apps/${this.app.id}/versions` }, {
-            query: {
-                limit: 1000,
-                sort: 'version desc',
-                ...(version ? { version } : undefined),
-            },
-        });
-        this.debugJson('getApp: versionsResponse', versionsResponse);
-        return versionsResponse.results || [];
-    }
-    swellRcPath() {
-        return path.join(this.appPath, '.swellrc');
-    }
 }

package/oclif.manifest.json

@@ -8,6 +8,13 @@
         "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
+        "force": {
+          "char": "f",
+          "description": "show all available stores and switch the current session if needed",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "store": {
           "char": "s",
           "description": "store to login to",
@@ -15,13 +22,6 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "force": {
-          "char": "f",
-          "description": "show all available stores and switch the current session if needed",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -442,6 +442,9 @@
       "strict": true,
       "summary": "Install an existing app in another store environment.",
       "enableJsonFlag": false,
+      "orientation": {
+        "env": "test"
+      },
       "isESM": true,
       "relativePath": [
         "dist",
@@ -703,15 +706,6 @@
           "multiple": false,
           "type": "option"
         },
-        "label": {
-          "char": "l",
-          "description": "content model label",
-          "name": "label",
-          "default": "",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "description": {
           "char": "d",
           "description": "content model description",
@@ -730,10 +724,10 @@
           "multiple": false,
           "type": "option"
         },
-        "views": {
-          "char": "v",
-          "description": "list of content model views delimited by commas, i.e. list,edit,new",
-          "name": "views",
+        "label": {
+          "char": "l",
+          "description": "content model label",
+          "name": "label",
           "default": "",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -744,6 +738,15 @@
           "name": "overwrite",
           "allowNo": false,
           "type": "boolean"
+        },
+        "views": {
+          "char": "v",
+          "description": "list of content model views delimited by commas, i.e. list,edit,new",
+          "name": "views",
+          "default": "",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -823,6 +826,12 @@
           "multiple": false,
           "type": "option"
         },
+        "overwrite": {
+          "description": "overwrite existing function file",
+          "name": "overwrite",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "route": {
           "char": "r",
           "description": "access type used with route trigger",
@@ -844,12 +853,6 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "overwrite": {
-          "description": "overwrite existing function file",
-          "name": "overwrite",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -928,15 +931,6 @@
           "multiple": false,
           "type": "option"
         },
-        "label": {
-          "char": "l",
-          "description": "data model label, i.e. Products",
-          "name": "label",
-          "default": "",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "description": {
           "char": "d",
           "description": "data model description",
@@ -946,6 +940,15 @@
           "multiple": false,
           "type": "option"
         },
+        "events": {
+          "char": "e",
+          "description": "list of data model events delimited by commas",
+          "name": "events",
+          "default": "created,updated,deleted",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "fields": {
           "char": "f",
           "description": "list of data model fields delimited by commas",
@@ -955,11 +958,11 @@
           "multiple": false,
           "type": "option"
         },
-        "events": {
-          "char": "e",
-          "description": "list of data model events delimited by commas",
-          "name": "events",
-          "default": "created,updated,deleted",
+        "label": {
+          "char": "l",
+          "description": "data model label, i.e. Products",
+          "name": "label",
+          "default": "",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -1021,6 +1024,13 @@
           "multiple": false,
           "type": "option"
         },
+        "admin": {
+          "char": "a",
+          "description": "indicate when the notification is sent to store admins only",
+          "name": "admin",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "description": {
           "char": "d",
           "description": "notification description",
@@ -1030,15 +1040,6 @@
           "multiple": false,
           "type": "option"
         },
-        "subject": {
-          "char": "s",
-          "description": "notification email subject",
-          "name": "subject",
-          "default": "",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "event": {
           "char": "e",
           "description": "data model event to trigger the notification event, i.e. created",
@@ -1048,13 +1049,6 @@
           "multiple": false,
           "type": "option"
         },
-        "admin": {
-          "char": "a",
-          "description": "indicate when the notification is sent to store admins only",
-          "name": "admin",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "once": {
           "char": "o",
           "description": "indicate the notification should be sent only once when conditions are met, instead of repeating",
@@ -1067,6 +1061,15 @@
           "name": "overwrite",
           "allowNo": false,
           "type": "boolean"
+        },
+        "subject": {
+          "char": "s",
+          "description": "notification email subject",
+          "name": "subject",
+          "default": "",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -1086,5 +1089,5 @@
       ]
     }
   },
-  "version": "2.0.1-alpha.12"
+  "version": "2.0.1-alpha.16"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swell/cli",
-  "version": "2.0.1-alpha.12",
+  "version": "2.0.1-alpha.16",
   "type": "module",
   "description": "Swell's command line interface/utility",
   "keywords": [
@@ -88,6 +88,7 @@
     }
   },
   "scripts": {
+    "preinstall": "npm i -g ts-node",
     "build": "shx rm -rf dist && shx rm -f tsconfig.tsbuildinfo && tsc -b",
     "lint": "eslint . --ext .ts --config .eslintrc",
     "postpack": "shx rm -f oclif.manifest.json",