@swell/cli 2.9.2 → 2.9.4

package/dist/lib/workflows/operations.js

@@ -0,0 +1,162 @@
+import { getCurrentAppSlugId } from '../apps/index.js';
+import { classifyIdentifier, resolveInspectScope, } from '../apps/inspect-scope.js';
+import { HEX24 } from '../apps/object-id.js';
+import { resolveAppId } from '../apps/resolve.js';
+export const WORKFLOW_STATUSES = [
+    'active',
+    'failed',
+    'completed',
+    'terminated',
+];
+export const WORKFLOW_INSTANCE_ID_PATTERN = /^wf_inst_[\dA-Za-z]+$/;
+const REDACTED_WORKFLOW_FIELDS = new Set([
+    'access_token',
+    'api_key',
+    'authorization',
+    'bearer_token',
+    'cf_api_token',
+    'cloudflare_token',
+    'installed_app_id',
+    'params',
+    'private_key',
+    'public_key',
+    'runtime_token',
+    'secret_key',
+    'token',
+    'token_hash',
+]);
+const RELATIVE_TIME_FORMAT = new Intl.RelativeTimeFormat('en', {
+    numeric: 'auto',
+});
+export async function resolveWorkflowOperationRef(api, workflow, flags) {
+    const kind = classifyIdentifier(workflow);
+    if (kind.kind === 'slug') {
+        const appId = HEX24.test(kind.appPart)
+            ? kind.appPart
+            : await resolveAppId(api, kind.appPart);
+        return {
+            appId,
+            appSlug: kind.appPart,
+            query: { workflow_name: kind.name },
+        };
+    }
+    if (kind.kind === 'id') {
+        const manifest = await api.get({
+            adminPath: `/data/:functions/${kind.id}`,
+        });
+        if (!manifest?.app_id) {
+            throw new Error(`Workflow manifest '${workflow}' does not have an app_id. Pass app.<app>.<workflow> or --app=<slug>.`);
+        }
+        const workflowName = workflowDisplayName(manifest);
+        if (workflowName === kind.id || workflowName === '-') {
+            throw new Error(`Workflow manifest '${workflow}' does not have a workflow name. Pass app.<app>.<workflow> or --app=<slug>.`);
+        }
+        return {
+            appId: manifest.app_id,
+            query: { workflow_id: kind.id, workflow_name: workflowName },
+        };
+    }
+    if (kind.kind === 'name') {
+        const scope = await resolveWorkflowScope(api, flags);
+        if (!scope.appId) {
+            throw new Error(`Bare workflow name '${workflow}' requires --app=<slug> or --app=. to scope. Alternatively, pass app.<app>.<workflow> or a 24-char manifest id.`);
+        }
+        return {
+            appId: scope.appId,
+            appSlug: scope.appSlug,
+            query: { workflow_name: workflow },
+        };
+    }
+    throw new Error(`Invalid workflow identifier '${workflow}'. Expected bare name, app.<app>.<workflow>, or 24-char manifest id.`);
+}
+export async function resolveWorkflowScope(api, flags) {
+    return resolveInspectScope({
+        resolveAppId: (slug) => resolveAppId(api, slug),
+        readCurrentAppSlug: () => getCurrentAppSlugId(),
+    }, flags);
+}
+export function isWorkflowInstanceIdentifier(value) {
+    return WORKFLOW_INSTANCE_ID_PATTERN.test(value);
+}
+export function workflowDisplayName(record) {
+    return record.workflow_name || record.name || record.id || '-';
+}
+export function workflowListMeta(record) {
+    const parts = [];
+    const summary = record.summary || {};
+    if (!record.enabled) {
+        parts.push('disabled');
+    }
+    if (summary.active_instances) {
+        parts.push(`active ${summary.active_instances}`);
+    }
+    if (summary.failed_instances) {
+        parts.push(`failed ${summary.failed_instances}`);
+    }
+    if (summary.completed_recent) {
+        parts.push(`completed ${summary.completed_recent}`);
+    }
+    if (summary.terminated_recent) {
+        parts.push(`terminated ${summary.terminated_recent}`);
+    }
+    return parts.join(' · ');
+}
+export function workflowRunDate(run) {
+    return (run.date_failed ||
+        run.date_terminated ||
+        run.date_completed ||
+        run.date_started ||
+        run.date_created);
+}
+export function workflowRunMeta(run) {
+    const parts = [];
+    if (run.status) {
+        parts.push(run.status);
+    }
+    const date = workflowRunDate(run);
+    if (date) {
+        parts.push(formatWorkflowRelativeTime(date));
+    }
+    return parts.join(' · ');
+}
+export function formatWorkflowRelativeTime(value, now = Date.now()) {
+    const timestamp = Date.parse(value);
+    if (!Number.isFinite(timestamp)) {
+        return value;
+    }
+    const diffSeconds = Math.round((timestamp - now) / 1000);
+    const absSeconds = Math.abs(diffSeconds);
+    if (absSeconds < 60) {
+        return RELATIVE_TIME_FORMAT.format(diffSeconds, 'second');
+    }
+    if (absSeconds < 60 * 60) {
+        return RELATIVE_TIME_FORMAT.format(Math.round(diffSeconds / 60), 'minute');
+    }
+    if (absSeconds < 24 * 60 * 60) {
+        return RELATIVE_TIME_FORMAT.format(Math.round(diffSeconds / (60 * 60)), 'hour');
+    }
+    if (absSeconds < 30 * 24 * 60 * 60) {
+        return RELATIVE_TIME_FORMAT.format(Math.round(diffSeconds / (24 * 60 * 60)), 'day');
+    }
+    return value;
+}
+export function redactWorkflowPayload(value) {
+    if (Array.isArray(value)) {
+        return value.map((item) => redactWorkflowPayload(item));
+    }
+    if (!value || typeof value !== 'object') {
+        if (typeof value === 'string' && value.startsWith('wf_rt_')) {
+            return '[redacted]';
+        }
+        return value;
+    }
+    const result = {};
+    for (const [key, child] of Object.entries(value)) {
+        if (REDACTED_WORKFLOW_FIELDS.has(key.toLowerCase())) {
+            result[key] = '[redacted]';
+            continue;
+        }
+        result[key] = redactWorkflowPayload(child);
+    }
+    return result;
+}

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

@@ -66,6 +66,7 @@ export declare abstract class PushAppCommand extends RemoteAppCommand {
         env?: string;
         'storefront-id'?: string;
         'storefront-select'?: boolean;
+        yes?: boolean;
     }, defaultStorefront?: any): Promise<void>;
     handleWatchFileChange(configFile: string, configType: ConfigType, event: WatchFileEvent): Promise<void>;
     logAppFrontendUrl(): void;

package/dist/push-app-command.js

@@ -386,14 +386,9 @@ export class PushAppCommand extends RemoteAppCommand {
         const query = Object.entries(params || {})
             .map(([key, value]) => `${key}=${value}`)
             .join('&');
-        try {
-            return this.handleRequestErrors(async () => this.api.get({
-                adminPath: `/apps/${this.app.id}/storefront?${query}`,
-            }));
-        }
-        catch {
-            // noop
-        }
+        return this.handleRequestErrors(async () => this.api.get({
+            adminPath: `/apps/${this.app.id}/storefront?${query}`,
+        }));
     }
     async getAppToPull(args, shouldChoose = true) {
         const { appId, targetPath } = args;
@@ -402,9 +397,9 @@ export class PushAppCommand extends RemoteAppCommand {
         await this.api.setStoreEnv(currentStore, klass.orientation?.env);
         this.resolveAppPath(appId, targetPath);
         if (isPathDirectory(this.appPath)) {
-            this.swellConfig = swellConfig(this.appPath);
-            const localAppId = this.swellConfig.get('id');
-            const localAppType = this.swellConfig.get('type');
+            this.swellConfig = await swellConfig(this.appPath);
+            const localAppId = String(this.swellConfig.get('id'));
+            const localAppType = String(this.swellConfig.get('type'));
             if (localAppId) {
                 if (appId && appId !== localAppId) {
                     this.error(`${localAppType === 'theme' ? 'A theme' : 'An app'} already exists in this path with a different ID: ${style.appConfigValue(localAppId)}`);
@@ -418,7 +413,7 @@ export class PushAppCommand extends RemoteAppCommand {
                 ? await this.chooseAppToPull()
                 : undefined;
         if (shouldChoose) {
-            this.swellConfig = swellConfig(this.appPath);
+            this.swellConfig = await swellConfig(this.appPath);
         }
         return app;
     }
@@ -528,7 +523,7 @@ export class PushAppCommand extends RemoteAppCommand {
                 : this.storefront.app_id;
             this.app = await this.getApp(appId);
         }
-        this.swellConfig = swellConfig(this.appPath);
+        this.swellConfig = await swellConfig(this.appPath);
         return this.storefront;
     }
     async getStorefrontToPush(flags = {}) {
@@ -600,6 +595,7 @@ export class PushAppCommand extends RemoteAppCommand {
     async setStorefrontEnv(flags, defaultStorefront) {
         const currentStore = localConfig.getDefaultStore();
         const targetStorefront = flags['storefront-id'];
+        const nonInteractive = flags.yes || false;
         if (defaultStorefront &&
             !targetStorefront &&
             !flags['storefront-id'] &&
@@ -615,7 +611,7 @@ export class PushAppCommand extends RemoteAppCommand {
         else {
             const hasTestEnv = await this.api.isTestEnvEnabled();
             if (hasTestEnv) {
-                const env = await selectEnvironmentId();
+                const env = nonInteractive ? 'test' : await selectEnvironmentId();
                 await this.api.setStoreEnv(currentStore, env);
             }
         }

package/oclif.manifest.json

@@ -110,6 +110,7 @@
         "swell logs",
         "swell logs -f -p -n 10 -c date,req,data",
         "swell logs -s accounts",
+        "swell logs --type workflow --app my-app -s run-import",
         "swell logs --after 2023-08-25T16:01:02.697Z -c date",
         "swell logs --after 2023-08-27"
       ],
@@ -123,7 +124,7 @@
           "type": "option"
         },
         "app": {
-          "description": "filter logs by app id",
+          "description": "filter logs by app id, slug, or \".\" for current swell.json",
           "name": "app",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -218,7 +219,8 @@
             "api",
             "function",
             "webhook",
-            "transaction"
+            "transaction",
+            "workflow"
           ],
           "type": "option"
         }
@@ -281,6 +283,10 @@
         {
           "description": "Validate a function file",
           "command": "<%= config.bin %> <%= command.id %> function myfunction.ts"
+        },
+        {
+          "description": "Validate a workflow file",
+          "command": "<%= config.bin %> <%= command.id %> function run-import.ts"
         }
       ],
       "flags": {
@@ -1791,12 +1797,13 @@
         },
         "trigger": {
           "default": "",
-          "description": "cron | model | route",
+          "description": "cron | model | route | workflow",
           "name": "trigger",
           "options": [
             "cron",
             "model",
-            "route"
+            "route",
+            "workflow"
           ]
         }
       },
@@ -1804,7 +1811,9 @@
         "$ swell create function",
         "$ swell create function order-handler.ts model -e order.created,order.updated -y",
         "$ swell create function cleanup.ts cron -s \"0 0 * * *\" -y",
-        "$ swell create function api-endpoint.ts route -r public -y"
+        "$ swell create function api-endpoint.ts route -r public -y",
+        "$ swell create function run-import.ts --type workflow -y",
+        "$ swell create function run-import.ts workflow -y"
       ],
       "flags": {
         "app-path": {
@@ -1860,6 +1869,16 @@
           "multiple": false,
           "type": "option"
         },
+        "type": {
+          "description": "Create a workflow function",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "workflow"
+          ],
+          "type": "option"
+        },
         "yes": {
           "char": "y",
           "description": "Skip prompts, require all arguments",
@@ -1877,9 +1896,9 @@
       "strict": true,
       "summary": "Create a serverless function in JavaScript or TypeScript.",
       "helpMeta": {
-        "usageDirect": "<name> <trigger> [...] -y",
+        "usageDirect": "<name> [<trigger>|workflow] [...] -y",
         "variantSection": {
-          "title": "TRIGGER OPTIONS",
+          "title": "FUNCTION MODES",
           "variants": [
             {
               "name": "model",
@@ -1895,6 +1914,11 @@
               "name": "route",
               "flag": "-r, --route=<option>",
               "description": "Access: public (default) | private"
+            },
+            {
+              "name": "workflow",
+              "flag": "--type=workflow",
+              "description": "Durable explicit-create workflow"
             }
           ]
         },
@@ -2553,6 +2577,7 @@
         "swell inspect content app.honest_reviews.reviews",
         "swell inspect webhooks --app=my-app",
         "swell inspect functions app.my-app.payment-sync",
+        "swell inspect workflow-runs --workflow app.my-app.run-import --status active",
         "swell inspect notifications com.orders.receipt.v2",
         "swell inspect settings app.my-app"
       ],
@@ -2828,6 +2853,159 @@
         "webhooks.js"
       ]
     },
+    "inspect:workflow-runs": {
+      "aliases": [],
+      "args": {
+        "identifier": {
+          "description": "wf_inst_* workflow run instance id.",
+          "name": "identifier",
+          "required": false
+        }
+      },
+      "description": "Lists recent workflow runtime instances, or shows one workflow run by instance id.\n\nIdentifier forms:\n  (none)              - recent runs across installed apps, or --app scope\n  wf_inst_<id>         - single run detail\n\nUse --workflow=<workflow> to filter list mode by workflow name, app.<app>.<workflow>, or manifest id.\n",
+      "examples": [
+        "swell inspect workflow-runs",
+        "swell inspect workflow-runs --app=my-app --status active",
+        "swell inspect workflow-runs --workflow run-import --app=my-app",
+        "swell inspect workflow-runs --workflow app.my-app.run-import --status active",
+        "swell inspect workflow-runs wf_inst_abc123 --app=my-app",
+        "swell inspect workflow-runs wf_inst_abc123"
+      ],
+      "flags": {
+        "app": {
+          "description": "Filter by app slug, or \".\" for current swell.json.",
+          "name": "app",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "live": {
+          "description": "Use live environment (default: test).",
+          "name": "live",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "json": {
+          "description": "Emit pure JSON without the \"Next steps\" footer. Detail mode only.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "yes": {
+          "char": "y",
+          "description": "No-op; accepted for agent compatibility.",
+          "hidden": true,
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "limit": {
+          "description": "Maximum runs to show.",
+          "name": "limit",
+          "default": 10,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "status": {
+          "description": "Workflow run status.",
+          "name": "status",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "active",
+            "failed",
+            "completed",
+            "terminated"
+          ],
+          "type": "option"
+        },
+        "workflow": {
+          "description": "Filter by workflow name, app.<app>.<workflow>, or manifest id.",
+          "name": "workflow",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "inspect:workflow-runs",
+      "pluginAlias": "@swell/cli",
+      "pluginName": "@swell/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Workflow runtime instances.",
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "inspect",
+        "workflow-runs.js"
+      ]
+    },
+    "inspect:workflows": {
+      "aliases": [],
+      "args": {
+        "identifier": {
+          "description": "Resource identifier — see \"Identifier forms\" below.",
+          "name": "identifier",
+          "required": false
+        }
+      },
+      "description": "Lists workflow manifests across deployed apps with runtime state. Pass --app=<slug> or --app=. (current swell.json) to scope.\n\nPass an identifier to view a workflow manifest, summary counts, and failed instance sample as JSON.\n\nIdentifier forms:\n  app.<app>.<name>     - full paste-back key (list column 1)\n  <name>               - requires --app= scope\n  <24-char id>         - any scope\n",
+      "examples": [
+        "swell inspect workflows",
+        "swell inspect workflows --app=my-app",
+        "swell inspect workflows app.my-app.run-import",
+        "swell inspect workflows run-import --app=my-app",
+        "swell inspect workflows --live"
+      ],
+      "flags": {
+        "app": {
+          "description": "Filter by app slug, or \".\" for current swell.json.",
+          "name": "app",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "live": {
+          "description": "Use live environment (default: test).",
+          "name": "live",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "json": {
+          "description": "Emit pure JSON without the \"Next steps\" footer. Detail mode only.",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "yes": {
+          "char": "y",
+          "description": "No-op; accepted for agent compatibility.",
+          "hidden": true,
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "inspect:workflows",
+      "pluginAlias": "@swell/cli",
+      "pluginName": "@swell/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Durable app workflows and runtime state.",
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "inspect",
+        "workflows.js"
+      ]
+    },
     "theme:dev": {
       "aliases": [],
       "args": {},
@@ -3378,5 +3556,5 @@
       ]
     }
   },
-  "version": "2.9.2"
+  "version": "2.9.4"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swell/cli",
-  "version": "2.9.2",
+  "version": "2.9.4",
   "type": "module",
   "description": "Swell's command line interface/utility",
   "keywords": [
@@ -59,6 +59,7 @@
     "qs": "6.12.3",
     "semver": "7.5.4",
     "table": "6.8.1",
+    "typescript": "5.2.2",
     "ws": "8.18.1"
   },
   "devDependencies": {
@@ -87,8 +88,7 @@
     "oclif": "4.0.3",
     "shx": "0.3.4",
     "testdouble": "3.20.0",
-    "ts-node": "10.9.1",
-    "typescript": "5.2.2"
+    "ts-node": "10.9.1"
   },
   "oclif": {
     "bin": "swell",