task.object.ts

import { P, cel } from '@objectstack/spec';
// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.

import { ObjectSchema, Field } from '@objectstack/spec/data';

export const Task = ObjectSchema.create({
  name: 'crm_task',
  label: 'Task',
  pluralLabel: 'Tasks',
  icon: 'check-square',
  description: 'Activities and to-do items',

  fields: {
    // Task Information
    subject: Field.text({
      label: 'Subject',
      required: true,
      searchable: true,
      maxLength: 255,
    }),
    
    description: Field.markdown({
      label: 'Description',
    }),
    
    // Task Management
    status: Field.select({
      label: 'Status',
      required: true,
      options: [
        { label: 'Not Started', value: 'not_started', color: '#808080', default: true },
        { label: 'In Progress', value: 'in_progress', color: '#FFA500' },
        { label: 'Waiting', value: 'waiting', color: '#FFD700' },
        { label: 'Completed', value: 'completed', color: '#00AA00' },
        { label: 'Deferred', value: 'deferred', color: '#999999' },
      ]
    }),
    
    priority: Field.select({
      label: 'Priority',
      required: true,
      options: [
        { label: 'Low', value: 'low', color: '#4169E1', default: true },
        { label: 'Normal', value: 'normal', color: '#00AA00' },
        { label: 'High', value: 'high', color: '#FFA500' },
        { label: 'Urgent', value: 'urgent', color: '#FF0000' },
      ]
    }),
    
    type: Field.select({
      label: 'Task Type',
      options: [
        { label: 'Call', value: 'call' },
        { label: 'Email', value: 'email' },
        { label: 'Meeting', value: 'meeting' },
        { label: 'Follow-up', value: 'follow_up' },
        { label: 'Demo', value: 'demo' },
        { label: 'Other', value: 'other' },
      ]
    }),
    
    // Dates
    due_date: Field.date({
      label: 'Due Date',
    }),
    
    reminder_date: Field.datetime({
      label: 'Reminder Date/Time',
    }),
    
    completed_date: Field.datetime({
      label: 'Completed Date',
      readonly: true,
    }),
    
    // Assignment
    owner: Field.lookup('user', {
      defaultValue: cel`os.user.id`,
      label: 'Assigned To',
    }),
    
    // Related To (Polymorphic relationship - can link to multiple object types)
    related_to_type: Field.select({
      label: 'Related To Type',
      options: [
        { label: 'Account', value: 'crm_account' },
        { label: 'Contact', value: 'crm_contact' },
        { label: 'Opportunity', value: 'crm_opportunity' },
        { label: 'Lead', value: 'crm_lead' },
        { label: 'Case', value: 'crm_case' },
      ]
    }),
    
    related_to_account: Field.lookup('crm_account', {
      label: 'Related Account',
    }),
    
    related_to_contact: Field.lookup('crm_contact', {
      label: 'Related Contact',
    }),
    
    related_to_opportunity: Field.lookup('crm_opportunity', {
      label: 'Related Opportunity',
    }),
    
    related_to_lead: Field.lookup('crm_lead', {
      label: 'Related Lead',
    }),
    
    related_to_case: Field.lookup('crm_case', {
      label: 'Related Case',
    }),
    
    // Recurrence (for recurring tasks)
    is_recurring: Field.boolean({
      label: 'Recurring Task',
      defaultValue: false,
    }),
    
    recurrence_type: Field.select({
      label: 'Recurrence Type',
      options: [
        { label: 'Daily', value: 'daily' },
        { label: 'Weekly', value: 'weekly' },
        { label: 'Monthly', value: 'monthly' },
        { label: 'Yearly', value: 'yearly' },
      ]
    }),
    
    recurrence_interval: Field.number({
      label: 'Recurrence Interval',
      defaultValue: 1,
      min: 1,
    }),
    
    recurrence_end_date: Field.date({
      label: 'Recurrence End Date',
    }),
    
    // Flags
    is_completed: Field.boolean({
      label: 'Is Completed',
      defaultValue: false,
      readonly: true,
    }),
    
    is_overdue: Field.boolean({
      label: 'Is Overdue',
      defaultValue: false,
      readonly: true,
    }),

    // Set by the `task_due_reminder` schedule flow once a reminder has fired,
    // so the hourly sweep never re-alerts the same task. Reset to false if you
    // push `reminder_date` into the future.
    reminder_sent: Field.boolean({
      label: 'Reminder Sent',
      defaultValue: false,
      readonly: true,
    }),

    // Progress
    progress_percent: Field.percent({
      label: 'Progress (%)',
      min: 0,
      max: 100,
      defaultValue: 0,
    }),
    
    // Time tracking
    estimated_hours: Field.number({
      label: 'Estimated Hours',
      scale: 2,
      min: 0,
    }),
    
    actual_hours: Field.number({
      label: 'Actual Hours',
      scale: 2,
      min: 0,
    }),
  },
  
  enable: {
    trackHistory: true,
    searchable: true,
    apiEnabled: true,
    files: true,
    feeds: true,            // Enable social feed, comments, and mentions
    activities: true,       // Enable tasks and events tracking
    trash: true,
    mru: true,              // Track Most Recently Used
  },
  
  // Database indexes for performance
  indexes: [
    { fields: ['status'] },
    { fields: ['priority'] },
    { fields: ['owner'] },
    { fields: ['due_date'] },
  ],
  
  // ADR-0079: render-only `titleFormat` retired in favor of `nameField`,
  // which names the real field holding the record title (here: `subject`).
  nameField: 'subject',
  compactLayout: ['subject', 'status', 'priority', 'due_date', 'owner'],
  
  // Removed: list_views and form_views belong in UI configuration, not object definition
  
  validations: [
    {
      name: 'completed_date_required',
      type: 'script',
      severity: 'error',
      message: 'Completed date is required when status is Completed',
      condition: P`record.status == "completed" && isBlank(record.completed_date)`,
    },
    {
      name: 'recurrence_fields_required',
      type: 'script',
      severity: 'error',
      message: 'Recurrence type is required for recurring tasks',
      condition: P`record.is_recurring == true && isBlank(record.recurrence_type)`,
    },
    {
      name: 'related_to_required',
      type: 'script',
      severity: 'warning',
      message: 'At least one related record should be selected',
      condition: P`isBlank(record.related_to_account) && isBlank(record.related_to_contact) && isBlank(record.related_to_opportunity) && isBlank(record.related_to_lead) && isBlank(record.related_to_case)`,
    },
  ],
  
  // NOTE: object `workflows[]` were removed in @objectstack 7.7. Field-updates
  // moved to this object's *.hook.ts; scheduled status-flips & notifications
  // moved to src/flows/*.flow.ts (see flows/index.ts).
});