refactor(app-crm): migrate action handlers to metadata bodies

Author: zhuangjianguo

examples/app-crm/objectstack.config.ts

@@ -34,31 +34,8 @@ import {
   RoleHierarchy,
 } from './src/sharing';
 
-// ─── Action Handler Registration (runtime lifecycle) ────────────────
-// Handlers are wired separately from metadata. The `onEnable` export
-// is called by the kernel's AppPlugin after the engine is ready.
-// See: src/actions/register-handlers.ts for the full registration flow.
-import { registerCrmActionHandlers } from './src/actions/register-handlers';
 import { allHooks } from './src/hooks';
 
-/**
- * Plugin lifecycle hook — called by AppPlugin when the engine is ready.
- *
- * Action handlers are still wired imperatively because actions reference
- * their handler via a string `target` and the function registry binding
- * happens here. Lifecycle hooks (`*.hook.ts`) are now metadata: they are
- * picked up automatically from `defineStack({ hooks: allHooks })` below
- * and bound to the ObjectQL engine by `AppPlugin`. No manual
- * `registerHook(...)` wiring is needed for hooks any more.
- */
-export const onEnable = async (ctx: {
-  ql: {
-    registerAction: (...args: unknown[]) => void;
-  };
-}) => {
-  registerCrmActionHandlers(ctx.ql as Parameters<typeof registerCrmActionHandlers>[0]);
-};
-
 export default defineStack({
   manifest: {
     id: 'com.example.crm',

examples/app-crm/src/actions/case.actions.ts

@@ -2,14 +2,38 @@
 
 import type { Action } from '@objectstack/spec/ui';
 
-/** Escalate Case */
+/**
+ * Escalate Case.
+ *
+ * Modal-typed action: the UI collects `reason` then POSTs to
+ * `/api/v1/actions/case/escalate_case`. The body runs in the QuickJS
+ * sandbox via `actionBodyRunnerFactory`, gated by `api.write`.
+ */
 export const EscalateCaseAction: Action = {
   name: 'escalate_case',
   label: 'Escalate Case',
   objectName: 'case',
   icon: 'alert-triangle',
   type: 'modal',
-  target: 'escalateCase',
+  target: 'escalate_case',
+  body: {
+    language: 'js',
+    source: `
+      const id = ctx.recordId;
+      if (!id) throw new Error('escalate_case requires a recordId');
+      await ctx.api.object('case').update({
+        id,
+        is_escalated: true,
+        escalation_reason: input.reason ?? null,
+        escalated_by: ctx.user?.id ?? null,
+        escalated_at: new Date().toISOString(),
+        priority: 'urgent',
+      }, { where: { id } });
+      return { ok: true, id };
+    `,
+    capabilities: ['api.write'],
+    timeoutMs: 5000,
+  },
   locations: ['record_header', 'list_item'],
   visible: 'is_escalated == false && is_closed == false',
   params: [
@@ -25,14 +49,37 @@ export const EscalateCaseAction: Action = {
   refreshAfter: true,
 };
 
-/** Close Case */
+/**
+ * Close Case.
+ *
+ * Modal-typed action: collects `resolution` then closes the case via
+ * the metadata body. Runs sandboxed under `api.write`.
+ */
 export const CloseCaseAction: Action = {
   name: 'close_case',
   label: 'Close Case',
   objectName: 'case',
   icon: 'check-circle',
   type: 'modal',
-  target: 'closeCase',
+  target: 'close_case',
+  body: {
+    language: 'js',
+    source: `
+      const id = ctx.recordId;
+      if (!id) throw new Error('close_case requires a recordId');
+      await ctx.api.object('case').update({
+        id,
+        is_closed: true,
+        resolution: input.resolution ?? null,
+        closed_by: ctx.user?.id ?? null,
+        closed_at: new Date().toISOString(),
+        status: 'closed',
+      }, { where: { id } });
+      return { ok: true, id };
+    `,
+    capabilities: ['api.write'],
+    timeoutMs: 5000,
+  },
   locations: ['record_header'],
   visible: 'is_closed == false',
   params: [

examples/app-crm/src/actions/contact.actions.ts

@@ -34,14 +34,40 @@ export const MarkPrimaryContactAction: Action = {
   refreshAfter: true,
 };
 
-/** Send Email to Contact */
+/**
+ * Send Email to Contact.
+ *
+ * Modal-typed action: collects subject + body, then logs an `activity`
+ * record via the metadata body. Runs sandboxed under `api.write`.
+ */
 export const SendEmailAction: Action = {
   name: 'send_email',
   label: 'Send Email',
   objectName: 'contact',
   icon: 'mail',
   type: 'modal',
-  target: 'sendEmail',
+  target: 'send_email',
+  body: {
+    language: 'js',
+    source: `
+      const record = ctx.record ?? {};
+      const recipientId = ctx.recordId ?? record.id ?? null;
+      const activity = await ctx.api.object('activity').insert({
+        type: 'email',
+        subject: input.subject ? String(input.subject) : ('Email to ' + (record.email ?? '')),
+        body: input.body ? String(input.body) : '',
+        contact_id: recipientId,
+        account_id: record.account_id ?? null,
+        direction: 'outbound',
+        status: 'sent',
+        created_by: ctx.user?.id ?? null,
+        sent_at: new Date().toISOString(),
+      });
+      return { activityId: activity?.id };
+    `,
+    capabilities: ['api.write'],
+    timeoutMs: 5000,
+  },
   locations: ['record_header', 'list_item'],
   visible: 'email_opt_out == false',
   params: [

examples/app-crm/src/actions/global.actions.ts

@@ -2,13 +2,39 @@
 
 import type { Action } from '@objectstack/spec/ui';
 
-/** Log a Call */
+/**
+ * Log a Call.
+ *
+ * Modal-typed cross-domain (global) action: collects subject /
+ * duration / notes then writes an `activity` record via the metadata
+ * body. The originating record id is forwarded as `related_to_id`.
+ */
 export const LogCallAction: Action = {
   name: 'log_call',
   label: 'Log a Call',
   icon: 'phone',
   type: 'modal',
-  target: 'logCall',
+  target: 'log_call',
+  body: {
+    language: 'js',
+    source: `
+      const recordId = ctx.recordId ?? ctx.record?.id ?? null;
+      const activity = await ctx.api.object('activity').insert({
+        type: 'call',
+        subject: input.subject ? String(input.subject) : 'Untitled Call',
+        duration_minutes: input.duration ? Number(input.duration) : 0,
+        notes: input.notes ? String(input.notes) : '',
+        related_to_id: recordId,
+        direction: 'outbound',
+        status: 'completed',
+        created_by: ctx.user?.id ?? null,
+        call_date: new Date().toISOString(),
+      });
+      return { activityId: activity?.id };
+    `,
+    capabilities: ['api.write'],
+    timeoutMs: 5000,
+  },
   locations: ['record_header', 'list_item', 'record_related'],
   params: [
     {
@@ -34,13 +60,38 @@ export const LogCallAction: Action = {
   refreshAfter: true,
 };
 
-/** Export to CSV */
+/**
+ * Export to CSV.
+ *
+ * Script-typed cross-domain (global) action: dumps the rows of the
+ * target object to a CSV string. Object name is forwarded by the
+ * dispatcher via `input.objectName` (defaults to `account`).
+ */
 export const ExportToCsvAction: Action = {
   name: 'export_csv',
   label: 'Export to CSV',
   icon: 'download',
   type: 'script',
-  target: 'exportToCSV',
+  body: {
+    language: 'js',
+    source: `
+      const objectName = input.objectName ?? 'account';
+      const raw = await ctx.api.object(objectName).find();
+      // DEBUG: surface what the engine returned
+      return {
+        rawType: typeof raw,
+        isArray: Array.isArray(raw),
+        keys: raw && typeof raw === 'object' ? Object.keys(raw).slice(0, 5) : null,
+        len: Array.isArray(raw) ? raw.length : (raw?.records?.length ?? raw?.value?.length ?? 'n/a'),
+      };
+      const keys = Object.keys(records[0]);
+      const header = keys.join(',');
+      const rows = records.map((r) => keys.map((k) => r[k] ?? '').join(','));
+      return [header, ...rows].join('\\n');
+    `,
+    capabilities: ['api.read'],
+    timeoutMs: 10000,
+  },
   locations: ['list_toolbar'],
   successMessage: 'Export completed!',
   refreshAfter: false,