@swell/cli 2.9.30 → 2.9.32

package/dist/help/custom-help.js

@@ -280,7 +280,11 @@ export default class CustomHelp extends Help {
             const value = ('helpValue' in flag && flag.helpValue) ||
                 ('options' in flag && flag.options ? 'option' : 'value');
             const suffix = flag.type === 'boolean' ? '' : `=<${value}>`;
-            return [name, `${shortChar}--${name}${suffix}`];
+            const negatable = flag.type === 'boolean' && flag.allowNo;
+            return [
+                name,
+                `${shortChar}--${negatable ? '[no-]' : ''}${name}${suffix}`,
+            ];
         }));
         const flagWidth = Math.max(30, ...[...flagLabels.values()].map((label) => label.length));
         for (const [name, flag] of flagEntries) {

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

@@ -0,0 +1,45 @@
+type Values = Record<string, any>;
+export type ActionSource = 'bulk' | 'field' | 'list' | 'record' | 'settings';
+/** An app function action, with what the dashboard sends to run it */
+export interface DeclaredAction {
+    function: string;
+    id: string;
+    modal?: Values;
+    /** The query of the view whose records a bulk action runs on */
+    query?: Values;
+    /** The name of the settings config, for a settings action or action field */
+    settings?: string;
+    source: ActionSource;
+    view?: string;
+}
+/**
+ * The function actions a content config declares.
+ *
+ * @param values the values of the content config
+ * @returns the actions
+ */
+export declare function getContentActions(values: Values): DeclaredAction[];
+/**
+ * The function actions a settings config declares.
+ *
+ * @param values the values of the settings config
+ * @param settings the name of the settings config
+ * @returns the actions
+ */
+export declare function getSettingsActions(values: Values, settings: string): DeclaredAction[];
+/**
+ * The ids of the fields of an action's modal, as the platform finds them to
+ * pass on only their values.
+ *
+ * @param modal the modal of the action
+ * @returns the field ids
+ */
+export declare function getModalFieldIds(modal: Values): string[];
+/**
+ * A function name as the platform compares an action's `function` with it.
+ *
+ * @param name a function name
+ * @returns the name in the form the platform compares
+ */
+export declare function functionSlug(name: string): string;
+export {};

package/dist/lib/apps/actions.js

@@ -0,0 +1,114 @@
+function isFunctionAction(item) {
+    return (typeof item?.id === 'string' &&
+        typeof item?.function === 'string');
+}
+// The dashboard renders the fields of rows and groups in place
+function flattenFields(fields) {
+    if (!Array.isArray(fields)) {
+        return [];
+    }
+    return fields.flatMap((field) => field?.type === 'field_row' || field?.type === 'field_group'
+        ? flattenFields(field.fields)
+        : [field]);
+}
+function getActionFields(fields) {
+    return flattenFields(fields).filter((field) => field?.type === 'action');
+}
+/**
+ * The function actions a content config declares.
+ *
+ * @param values the values of the content config
+ * @returns the actions
+ */
+export function getContentActions(values) {
+    const views = Array.isArray(values?.views) ? values.views : [];
+    const actions = [];
+    for (const view of views) {
+        const source = view.type || (view.id === 'list' ? 'list' : 'record');
+        for (const action of [
+            ...(view.actions || []),
+            ...(view.extra_actions || []),
+        ]) {
+            if (isFunctionAction(action)) {
+                actions.push({ ...pickAction(action), source, view: view.id });
+            }
+        }
+        for (const action of view.bulk_actions || []) {
+            if (isFunctionAction(action)) {
+                actions.push({
+                    ...pickAction(action),
+                    ...(view.query ? { query: view.query } : undefined),
+                    source: 'bulk',
+                    view: view.id,
+                });
+            }
+        }
+    }
+    const fields = [
+        ...(values?.fields || []),
+        ...views.flatMap((view) => [
+            ...(view.fields || []),
+            ...(view.tabs || []).flatMap((tab) => tab?.fields || []),
+        ]),
+    ];
+    for (const field of getActionFields(fields)) {
+        if (isFunctionAction(field)) {
+            actions.push({ ...pickAction(field), source: 'field' });
+        }
+    }
+    return actions;
+}
+/**
+ * The function actions a settings config declares.
+ *
+ * @param values the values of the settings config
+ * @param settings the name of the settings config
+ * @returns the actions
+ */
+export function getSettingsActions(values, settings) {
+    const actions = [];
+    for (const action of values?.actions || []) {
+        if (isFunctionAction(action)) {
+            actions.push({ ...pickAction(action), settings, source: 'settings' });
+        }
+    }
+    for (const field of getActionFields(values?.fields)) {
+        if (isFunctionAction(field)) {
+            actions.push({ ...pickAction(field), settings, source: 'field' });
+        }
+    }
+    return actions;
+}
+/**
+ * The ids of the fields of an action's modal, as the platform finds them to
+ * pass on only their values.
+ *
+ * @param modal the modal of the action
+ * @returns the field ids
+ */
+export function getModalFieldIds(modal) {
+    return flattenFields(modal.fields)
+        .map((field) => field?.id)
+        .filter((id) => typeof id === 'string');
+}
+/**
+ * A function name as the platform compares an action's `function` with it.
+ *
+ * @param name a function name
+ * @returns the name in the form the platform compares
+ */
+export function functionSlug(name) {
+    return name
+        .replaceAll(/[^\s\w./:-]/g, '')
+        .replaceAll(/[\s./:_-]+/g, '-')
+        .replaceAll(/^-+|-+$/g, '')
+        .replaceAll(/([a-z])([A-Z])/g, '$1-$2')
+        .toLowerCase();
+}
+function pickAction(action) {
+    return {
+        function: action.function,
+        id: action.id,
+        ...(action.modal ? { modal: action.modal } : undefined),
+    };
+}

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

@@ -0,0 +1 @@
+export declare function warnListingSources(appPath: string, config: Record<string, any>, warn: (message: string) => void): void;

package/dist/lib/apps/listing.js

@@ -0,0 +1,41 @@
+import { statSync } from 'node:fs';
+import * as path from 'node:path';
+const LISTING_SOURCE_FIELDS = ['logo_src', 'preview_src', 'preview_mobile_src'];
+const LISTING_SOURCE_LISTS = ['images', 'highlights'];
+// The listing takes its full description from DESCRIPTION.md and each image
+// from the asset whose path from the app root is the swell.json value as
+// written, so values that point elsewhere do nothing. The platform takes an
+// empty value as unset.
+export function warnListingSources(appPath, config, warn) {
+    if (config.full_description !== undefined) {
+        warn('swell.json sets full_description, which push does not apply: the full description is the content of DESCRIPTION.md at the app root.');
+    }
+    const sources = [
+        ...LISTING_SOURCE_FIELDS.map((field) => [
+            field,
+            config[field],
+        ]),
+        ...LISTING_SOURCE_LISTS.flatMap((list) => (Array.isArray(config[list]) ? config[list] : []).map((item, index) => [
+            `${list}[${index}].image_src`,
+            item?.image_src,
+        ])),
+    ];
+    for (const [field, source] of sources) {
+        if (typeof source !== 'string' || source === '') {
+            continue;
+        }
+        const filePath = path.posix.normalize(source.replaceAll('\\', '/'));
+        const stats = statSync(path.join(appPath, filePath), {
+            throwIfNoEntry: false,
+        });
+        if (!stats?.isFile()) {
+            warn(`swell.json ${field} names ${source}, which the app does not have: the listing gets no image from it.`);
+        }
+        else if (!filePath.startsWith('assets/')) {
+            warn(`swell.json ${field} names ${source}, which is not in assets/: the listing gets no image from it. Move the file to assets/ and write assets/${path.posix.basename(filePath)}.`);
+        }
+        else if (filePath !== source) {
+            warn(`swell.json ${field} names ${source}, which is not the file's path from the app root: the listing gets no image from it. Write ${filePath}.`);
+        }
+    }
+}

package/dist/lib/bundle.js

@@ -60,7 +60,7 @@ export async function bundleFunction(filePath) {
 }
 export async function bundleWorkflow(filePath, analysis) {
     try {
-        const entrySource = getSwellWorkflowEntrypoint(filePath);
+        const entrySource = await getSwellWorkflowEntrypoint(filePath);
         const buildResult = await esbuild.build({
             bundle: true,
             stdin: {
@@ -130,13 +130,22 @@ async function getSwellFunctionWrapper() {
     const __dirname = path.dirname(__filename);
     return fs.readFile(path.join(__dirname, './swell-function-wrapper.js'), 'utf8');
 }
-function getSwellWorkflowEntrypoint(filePath) {
+// The entry defines these functions itself, so the bundle names no file of
+// the CLI and the workflow module exports only its entrypoint
+async function getSwellWorkflowRequest() {
+    const source = await fs.readFile(path.join(path.dirname(fileURLToPath(import.meta.url)), './swell-workflow-request.js'), 'utf8');
+    return source.replaceAll(/^export /gm, '');
+}
+async function getSwellWorkflowEntrypoint(filePath) {
     const workflowImport = `./${path.basename(filePath)}`;
+    const workflowRequest = await getSwellWorkflowRequest();
     return `
 import { WorkflowEntrypoint } from 'cloudflare:workers';
 import { NonRetryableError } from 'cloudflare:workflows';
 import UserWorkflow from ${JSON.stringify(workflowImport)};
 
+${workflowRequest}
+
 const RUNTIME_PROXY_PATH = '/:workflows/runtime/request';
 const RUNTIME_TOKEN_PATTERN = /\\bwf_rt_[0-9A-Za-z]+_[0-9A-Za-z]{12,}\\b/g;
 
@@ -210,38 +219,6 @@ function getInvocation(event) {
   return payload;
 }
 
-function buildWorkflowRequest(invocation, proxy) {
-  const runtime = invocation.runtime;
-
-  return {
-    id: runtime.request_id,
-    appId: runtime.app_slug || runtime.app_id,
-    environmentId: runtimeEnvironmentId(runtime),
-    store: {
-      id: runtime.store_id,
-    },
-    app: {
-      admin_url: runtime.app_admin_url,
-    },
-    data: invocation.data,
-    workflow: {
-      workflow_id: runtime.workflow_id,
-      workflow_name: runtime.workflow_name,
-      workflow_instance_id: runtime.workflow_instance_id,
-      trigger: runtime.trigger,
-      request_id: runtime.request_id,
-    },
-    isLocalDev: false,
-    swell: {
-      get: (path, data) => proxy.api('get', path, data),
-      post: (path, data) => proxy.api('post', path, data),
-      put: (path, data) => proxy.api('put', path, data),
-      delete: (path, data) => proxy.api('delete', path, data),
-      settings: () => proxy.settings(),
-    },
-  };
-}
-
 function buildWorkflowStep(cloudflareStep, proxy) {
   return Object.freeze({
     do(name, optionsOrCallback, maybeCallback) {
@@ -361,11 +338,6 @@ function getRuntimeApiHost(runtime) {
   return apiHost.replace(/\\/$/, '');
 }
 
-// 'test' in the test environment, null in live
-function runtimeEnvironmentId(runtime) {
-  return runtime.environment_id || null;
-}
-
 function runtimeIdentity(runtime) {
   return {
     app_id: runtime.app_id,

package/dist/lib/function-declarations.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The types an app's functions type-check against: the app's own
+ * @swell/app-types when it has the package, otherwise the CLI's.
+ *
+ * @param directory a directory of the app
+ * @returns the declarations, after a line naming the package version
+ */
+export declare function getFunctionDeclarations(directory: string): Promise<string>;

package/dist/lib/function-declarations.js

@@ -0,0 +1,27 @@
+import * as fs from 'node:fs/promises';
+import { createRequire } from 'node:module';
+import * as path from 'node:path';
+/**
+ * The types an app's functions type-check against: the app's own
+ * @swell/app-types when it has the package, otherwise the CLI's.
+ *
+ * @param directory a directory of the app
+ * @returns the declarations, after a line naming the package version
+ */
+export async function getFunctionDeclarations(directory) {
+    const file = resolveAppTypes(path.join(directory, 'package.json')) ??
+        resolveAppTypes(import.meta.url);
+    if (!file) {
+        throw new Error('@swell/app-types is not installed');
+    }
+    const { version } = JSON.parse(await fs.readFile(path.join(path.dirname(file), 'package.json'), 'utf8'));
+    return `// @swell/app-types ${version}\n${await fs.readFile(file, 'utf8')}`;
+}
+function resolveAppTypes(from) {
+    try {
+        return createRequire(from).resolve('@swell/app-types/index.d.ts');
+    }
+    catch {
+        return undefined;
+    }
+}

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

@@ -30,7 +30,13 @@ async function request(originalRequest, _env, context) {
             ...(error.body ?? { error: error.message }),
             retry: error.retry === false ? false : undefined,
         };
-        response = new SwellResponse(errorBody, { status: error.status || 500 });
+        const retryAfter = Number(error.retryAfter);
+        response = new SwellResponse(errorBody, {
+            status: error.status || 500,
+            ...(retryAfter > 0
+                ? { headers: { 'Retry-After': String(Math.ceil(retryAfter)) } }
+                : {}),
+        });
     }
     return SwellResponse._respond(req, response, context);
 }
@@ -447,6 +453,7 @@ class SwellError extends Error {
         this.body = body;
         this.code = options.code || body?.error?.code;
         this.retry = options.retry;
+        this.retryAfter = options.retryAfter;
     }
     get isRetryable() {
         return RETRYABLE_CODES.has(this.code);

package/dist/lib/swell-workflow-request.d.ts

@@ -0,0 +1,34 @@
+export function runtimeEnvironmentId(runtime: any): any;
+export function buildWorkflowRequest(invocation: any, proxy: any): {
+    id: any;
+    appId: any;
+    environmentId: any;
+    store: {
+        id: any;
+    };
+    app: {
+        admin_url: any;
+        frontend_url: any;
+    };
+    data: any;
+    workflow: {
+        workflow_id: any;
+        workflow_name: any;
+        workflow_instance_id: any;
+        trigger: any;
+        request_id: any;
+    };
+    isLocalDev: boolean;
+    swell: {
+        get: (path: any, data: any) => any;
+        post: (path: any, data: any) => any;
+        put: (path: any, data: any) => any;
+        delete: (path: any, data: any) => any;
+        settings: () => any;
+    };
+    appValues(idOrValues: any, values: any): {
+        $app: {
+            [x: number]: any;
+        };
+    };
+};

package/dist/lib/swell-workflow-request.js

@@ -0,0 +1,58 @@
+// The request a workflow's run(req, step) gets, built from the invocation the
+// platform starts the run with. Every workflow bundle includes this module.
+// 'test' in the test environment, null in live
+export function runtimeEnvironmentId(runtime) {
+    return runtime.environment_id || null;
+}
+export function buildWorkflowRequest(invocation, proxy) {
+    const { data, runtime } = invocation;
+    const appId = runtime.app_slug || runtime.app_id;
+    return {
+        id: runtime.request_id,
+        appId,
+        environmentId: runtimeEnvironmentId(runtime),
+        store: {
+            id: runtime.store_id,
+        },
+        app: {
+            admin_url: runtime.app_admin_url,
+            frontend_url: runtime.app_frontend_url,
+        },
+        data,
+        workflow: {
+            workflow_id: runtime.workflow_id,
+            workflow_name: runtime.workflow_name,
+            workflow_instance_id: runtime.workflow_instance_id,
+            trigger: runtime.trigger,
+            request_id: runtime.request_id,
+        },
+        isLocalDev: false,
+        swell: {
+            get: (path, data) => proxy.api('get', path, data),
+            post: (path, data) => proxy.api('post', path, data),
+            put: (path, data) => proxy.api('put', path, data),
+            delete: (path, data) => proxy.api('delete', path, data),
+            settings: () => proxy.settings(),
+        },
+        appValues(idOrValues, values) {
+            const targetAppId = typeof idOrValues === 'string' ? idOrValues : appId;
+            const appValues = typeof idOrValues === 'string' ? values : idOrValues;
+            if (!targetAppId) {
+                throw new Error('appValues: missing app id (req.appId is empty)');
+            }
+            if (!isOrdinaryObject(appValues)) {
+                throw new Error('appValues: values must be a plain object (arrays, class instances, null, and primitives are not allowed)');
+            }
+            return {
+                $app: {
+                    [targetAppId]: appValues,
+                },
+            };
+        },
+    };
+}
+function isOrdinaryObject(val) {
+    return (typeof val === 'object' &&
+        val !== null &&
+        Object.getPrototypeOf(val) === Object.prototype);
+}

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

@@ -21,13 +21,14 @@ export declare abstract class PushAppCommand extends RemoteAppCommand {
     watchingIgnoreFilter: GlobbyFilterFunction | null;
     watchingTimer: NodeJS.Timeout | null;
     watchListener: (eventType: fs.WatchEventType, filename: null | string) => Promise<void>;
+    protected pushesSwellJson(file?: string): boolean;
     protected showFrontendMigrationError(): never;
     buildFrontend(projectType?: FrontendProjectType): Promise<void>;
     chooseAppToPull(query?: any): Promise<App>;
     createAppStorefront(hasOtherStorefronts?: boolean, nonInteractive?: boolean): Promise<any>;
     deployAppFrontend(force?: boolean, log?: boolean): Promise<void>;
     deployFrontend(projectType: FrontendProjectType): Promise<string>;
-    ensureAppExists(file?: string, shouldCreate?: boolean, force?: boolean): Promise<boolean>;
+    ensureAppExists(file?: string, shouldCreate?: boolean): Promise<boolean>;
     ensureLoggedIn(): Promise<void>;
     exec(command: string, cwd?: string, onOutput?: (string: string) => any | false): Promise<void>;
     execFrontend(command: string, onOutput?: (string: string) => any | false): Promise<void>;

package/dist/push-app-command.js

@@ -10,6 +10,7 @@ import { componentsToRebuild } from './lib/apps/components.js';
 import { buildFrontendPackage, getManagedFrontendFramework, } from './lib/apps/frontend-package.js';
 import { warnFrontendRouteCollisions } from './lib/apps/frontend-routes.js';
 import { ConfigType, getFrontendProjectValidValues, allConfigFilesInDir, CUSTOM_FRAMEWORK_SLUG, appConfigFromFile, filePathExistsAsync, findAppConfig, getConfigTypeFromPath, getConfigTypeKeyFromValue, getFrontendProjectType, getProjectCommands, globAllFilesByPath, hashFile, hashString, isPathDirectory, toPosixPath, } from './lib/apps/index.js';
+import { warnListingSources } from './lib/apps/listing.js';
 import { getGlobIgnorePathsChecker } from './lib/apps/paths.js';
 import { slugFromApp } from './lib/apps/slug.js';
 import { getLocalInputs } from './lib/bundle.js';
@@ -119,6 +120,10 @@ export class PushAppCommand extends RemoteAppCommand {
             }
         }
     };
+    // The platform applies the listing in swell.json when the file is pushed
+    pushesSwellJson(file) {
+        return !file;
+    }
     showFrontendMigrationError() {
         return this.error(style.funcWarn(`⚠️  Your frontend directory exists but appears to use an older structure.\n` +
             `Swell CLI v2.1.0+ requires a Workers-based frontend with package.json.\n\n` +
@@ -330,7 +335,7 @@ export class PushAppCommand extends RemoteAppCommand {
             this.error(`Error deploying frontend: ${error.message}`);
         }
     }
-    async ensureAppExists(file, shouldCreate = true, force = false) {
+    async ensureAppExists(file, shouldCreate = true) {
         const klass = this.ctor;
         const currentStore = localConfig.getDefaultStore();
         await this.ensureLoggedIn();
@@ -356,10 +361,13 @@ export class PushAppCommand extends RemoteAppCommand {
             this.app = app;
             return true;
         }
+        if (this.pushesSwellJson(file)) {
+            warnListingSources(this.appPath, this.swellConfig.store, (message) => this.warn(message));
+        }
         // If app exists but owned by another client, create a new instance
         if (app?.client_id && app.client_id !== currentStore) {
             // Create a new app
-            this.app = await this.getCreateUpdateApp(undefined, force);
+            this.app = await this.getCreateUpdateApp();
             if (!this.app) {
                 return false;
             }
@@ -373,7 +381,7 @@ export class PushAppCommand extends RemoteAppCommand {
         }
         else {
             // Update existing app if not targeting a file
-            this.app = await this.getCreateUpdateApp(app, force);
+            this.app = await this.getCreateUpdateApp(app);
         }
         return true;
     }

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

@@ -26,7 +26,7 @@ export declare abstract class RemoteAppCommand extends AppCommand {
     protected getApp(id?: string): Promise<App>;
     protected getAppWithConfig(id?: string): Promise<App>;
     getConfigData(configId: string): Promise<any>;
-    protected getCreateUpdateApp(updateApp?: App | null, force?: boolean): Promise<App>;
+    protected getCreateUpdateApp(updateApp?: App | null): Promise<App>;
     protected getInstalledApp(): Promise<any>;
     /**
      * Anything on the target store already using the services named by

package/dist/remote-app-command.js

@@ -176,7 +176,7 @@ export class RemoteAppCommand extends AppCommand {
             adminPath: `/apps/${this.app.id}/configs/${configId}/data`,
         }, { query: { ...(themeId ? { theme_id: themeId } : undefined) } });
     }
-    async getCreateUpdateApp(updateApp, force = false) {
+    async getCreateUpdateApp(updateApp) {
         const spinner = ora();
         let sourceApp;
         try {
@@ -205,9 +205,6 @@ export class RemoteAppCommand extends AppCommand {
                 ? { private_id: this.swellConfig.store.id }
                 : undefined),
             ...(sourceApp?.id ? { source_id: sourceApp.id } : undefined),
-            // Overwrite name/description/logo_icon on the server
-            // instead of only filling them in when empty
-            ...(force ? { $force_meta: true } : undefined),
         };
         const appLabel = this.app.type === 'theme' ? 'theme' : 'app';
         let app = updateApp || {};