index.ts

// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.

import { defineAction } from '@objectstack/spec/ui';

const task = 'showcase_task';
const invoice = 'showcase_invoice';
const fieldZoo = 'showcase_field_zoo';

/**
 * Action matrix — covers every `ActionType` (script / url / flow / modal /
 * api / form) surfaced across a spread of `ActionLocation`s (toolbar, row,
 * record header/more, related list, global nav).
 */

/**
 * script — inline sandboxed handler, shown on each row and the record header.
 *
 * The `body` (L2 sandboxed JS) is what makes this action *executable*: AppPlugin
 * walks the bundle's actions on bind and only registers an engine handler for
 * those carrying a `body` (or `target` -> bundle function). Without it the
 * runtime has nothing to invoke and `POST /actions/showcase_task/showcase_mark_done`
 * fails with "Action ... not found".
 *
 * It flips the dedicated `done` flag and `progress` rather than the `status`
 * select on purpose: `status` is governed by the `task_status_flow`
 * state-machine (only `in_review -> done` is a legal direct jump), so writing
 * `status: 'done'` from a Backlog/To Do/In Progress row would be rejected. The
 * `done` boolean is the completion flag that works from any state.
 */
export const MarkDoneAction = defineAction({
  name: 'showcase_mark_done',
  label: 'Mark Done',
  icon: 'check',
  objectName: task,
  type: 'script',
  body: {
    language: 'js',
    source:
      "var id = ctx.recordId || (ctx.record && ctx.record.id) || input.recordId;" +
      "if (!id) throw new Error('No record to mark done');" +
      "await ctx.api.object('showcase_task').update({ id: id, done: true, progress: 100 });" +
      "return { ok: true, id: id };",
    capabilities: ['api.write'],
  },
  successMessage: 'Task marked done.',
  // Hide once the task is complete. Gate on `record.done` (the boolean this
  // action sets) so the button vanishes after a successful click and stays
  // hidden on finished records (the "why is it still here?" report). NOTE the
  // `record.`-prefix: the ActionEngine evaluates a record-header action's
  // `visible` against `{ record, recordId, … }` with fail-closed semantics, so
  // a bare `done`/`status` throws (field not at top level) and silently hides
  // the action. Single operand, too — the template path throws on `&&`/`||`.
  visible: '!record.done',
  // `record_section` so the Task Detail page's `record:quick_actions` bar
  // (which names this action) resolves it — the engine location-filters even
  // explicitly-named actions, mirroring the platform's own sys-user pages.
  locations: ['list_item', 'record_header', 'record_section'],
  refreshAfter: true,
});

/** url — navigate out, from the row overflow menu. */
export const OpenDocsAction = defineAction({
  name: 'showcase_open_docs',
  label: 'Open Docs',
  icon: 'book-open',
  objectName: task,
  type: 'url',
  target: 'https://docs.objectstack.ai',
  locations: ['record_more'],
  refreshAfter: false,
});

/**
 * flow — launch the Reassign screen-flow wizard. Row-level (`list_item`) so the
 * row's `recordId` flows into the flow, which collects `new_assignee` via a
 * `screen` node and writes it back with `update_record`. The objectui
 * FlowRunner renders the screen and resumes the run.
 */
export const BulkReassignAction = defineAction({
  name: 'showcase_bulk_reassign',
  label: 'Reassign…',
  icon: 'users',
  objectName: task,
  type: 'flow',
  target: 'showcase_reassign_wizard',
  locations: ['list_item', 'list_toolbar'],
  refreshAfter: true,
});

/** modal — open a dialog/page. */
export const QuickViewAction = defineAction({
  name: 'showcase_quick_view',
  label: 'Quick View',
  icon: 'eye',
  objectName: task,
  type: 'modal',
  target: 'showcase_component_gallery',
  locations: ['list_item'],
  refreshAfter: false,
});

/** api — call a custom endpoint. */
export const RecalcEstimateAction = defineAction({
  name: 'showcase_recalc_estimate',
  label: 'Recalculate Estimate',
  icon: 'calculator',
  objectName: task,
  type: 'api',
  target: '/api/v1/showcase/recalc',
  successMessage: 'Estimate recalculated.',
  locations: ['record_more', 'record_section'],
  refreshAfter: true,
});

/** form — open a parameter form dialog. */
export const LogTimeAction = defineAction({
  name: 'showcase_log_time',
  label: 'Log Time',
  icon: 'clock',
  objectName: task,
  type: 'form',
  // Targets the `edit` FORM view. `showcase_task.default` is the LIST view (the
  // container's main `list` implicitly claims the `default` key), so pointing a
  // form action there opens a list as a form — now a build error (#2554).
  target: 'showcase_task.edit',
  // `record_section` so it surfaces in the Task Detail quick-actions bar too.
  locations: ['record_header', 'record_related', 'record_section'],
  refreshAfter: true,
});

/** global nav command-palette action. */
export const NewTaskAction = defineAction({
  name: 'showcase_new_task',
  label: 'New Task',
  icon: 'plus',
  objectName: task,
  type: 'modal',
  target: 'showcase_component_gallery',
  locations: ['global_nav'],
  refreshAfter: true,
});

/**
 * script — Submit an invoice for finance + legal sign-off (§1 demo entry point).
 *
 * Flipping `status` to `sent` is exactly the transition the `showcase_invoice_signoff`
 * flow's start gate watches (`status == "sent" && previous.status != "sent"`), so
 * this button opens a fresh 会签 (finance ∧ legal) approval request from the record
 * header — the same request the boot-time demo seeds (src/security/seed-approval-demo.ts),
 * but on demand. The sandboxed body's write fires the record-change trigger like any
 * user edit. Gated to draft invoices so it disappears once submitted.
 */
export const SubmitForSignoffAction = defineAction({
  name: 'showcase_submit_signoff',
  label: 'Submit for Sign-off',
  icon: 'send',
  objectName: invoice,
  type: 'script',
  body: {
    language: 'js',
    source:
      "var id = ctx.recordId || (ctx.record && ctx.record.id) || input.recordId;" +
      "if (!id) throw new Error('No invoice to submit');" +
      "await ctx.api.object('showcase_invoice').update({ id: id, status: 'sent' });" +
      "return { ok: true, id: id };",
    capabilities: ['api.write'],
  },
  successMessage: 'Invoice submitted for finance + legal sign-off.',
  // Only on invoices not yet sent. `record.`-prefixed single comparison, per the
  // ActionEngine's fail-closed CEL evaluation (see MarkDoneAction's note).
  visible: "record.status != 'sent'",
  locations: ['list_item', 'record_header'],
  refreshAfter: true,
});

/**
 * script — the **action-param widget gallery** (ADR-0059). One inline param of
 * every non-trivial widget type, so the `ActionParamDialog` renders each real
 * field widget (not a text box): richtext editor, color picker, date picker,
 * select, number, the AutoNumber widget for an `autonumber` param, and — the
 * ⚠️ ones — `image`/`file` uploads through the ambient UploadProvider with
 * `multiple` / `accept` / `maxSize` honored, and the **upload guard** (Confirm
 * stays disabled while a file is still uploading). Lives on Field Zoo, the
 * "one specimen of everything" object, next to its every-field-type record.
 *
 * The body just echoes the received keys — the point is the dialog, not a side
 * effect — so it needs no capabilities.
 */
export const ActionParamGalleryAction = defineAction({
  name: 'showcase_action_param_gallery',
  label: 'Action Param Gallery',
  icon: 'sparkles',
  objectName: fieldZoo,
  type: 'script',
  params: [
    { name: 'p_text', type: 'text', label: 'Title', required: true, placeholder: 'A short title' },
    { name: 'p_richtext', type: 'richtext', label: 'Rich note', helpText: 'Renders the rich-text editor, not a plain textarea.' },
    {
      name: 'p_priority', type: 'select', label: 'Priority', defaultValue: 'normal',
      options: [
        { label: 'Low', value: 'low' },
        { label: 'Normal', value: 'normal' },
        { label: 'High', value: 'high' },
      ],
    },
    { name: 'p_date', type: 'date', label: 'Effective date' },
    { name: 'p_color', type: 'color', label: 'Accent color', defaultValue: '#7C3AED' },
    // Spec `autonumber` param → the AutoNumber widget (read-only, auto-assigned).
    { name: 'p_reference', type: 'autonumber', label: 'Reference #' },
    // ⚠️ image/file uploads: real widget + upload guard + multiple/accept/maxSize.
    { name: 'p_cover', type: 'image', label: 'Cover image', accept: ['image/*'], maxSize: 5 * 1024 * 1024 },
    {
      name: 'p_attachments', type: 'file', label: 'Attachments', multiple: true,
      accept: ['application/pdf', 'image/*'], maxSize: 10 * 1024 * 1024,
      helpText: 'Confirm stays disabled while a file is still uploading (ADR-0059 upload guard).',
    },
  ],
  body: {
    language: 'js',
    // No side effect — the value of this action is the dialog's widgets. Echo
    // the keys the dialog collected so the result dialog shows something.
    source: 'return { ok: true, received: Object.keys(input || {}) };',
    capabilities: [],
  },
  successMessage: 'Params received — every widget type rendered through the shared field-widget map.',
  locations: ['record_header', 'list_item'],
  refreshAfter: false,
});

export const allActions = [
  MarkDoneAction,
  OpenDocsAction,
  BulkReassignAction,
  QuickViewAction,
  RecalcEstimateAction,
  LogTimeAction,
  NewTaskAction,
  SubmitForSignoffAction,
  ActionParamGalleryAction,
];