@objectql/types 1.8.3 → 1.9.0

package/dist/view.d.ts

@@ -0,0 +1,304 @@
+/**
+ * View Metadata Definition
+ *
+ * Defines the structure for list views, grid views, and other data visualization views
+ * in ObjectQL applications. Views define how data from objects is displayed to users
+ * including columns, filters, sorting, and available actions.
+ *
+ * Based on common patterns from Salesforce List Views, Airtable Views, and similar platforms.
+ */
+import { ValidationOperator } from './validation';
+/**
+ * Types of views supported by ObjectQL
+ */
+export type ViewType = 'list' | 'kanban' | 'calendar' | 'timeline' | 'gallery' | 'map' | 'pivot' | 'custom';
+/**
+ * Column configuration for a view
+ */
+export interface ViewColumn {
+    /** Field name to display */
+    field: string;
+    /** Display label (defaults to field label) */
+    label?: string;
+    /** Column width in pixels */
+    width?: number;
+    /** Whether this column is visible by default */
+    visible?: boolean;
+    /** Whether this column is sortable */
+    sortable?: boolean;
+    /** Whether this column is filterable */
+    filterable?: boolean;
+    /** Display format (date, currency, percent, etc.) */
+    format?: string;
+    /** Whether to display as a badge/chip */
+    badge?: boolean;
+    /** Custom template for rendering */
+    template?: string;
+    /** Alignment (left, center, right) */
+    align?: 'left' | 'center' | 'right';
+    /** Whether this column is frozen/pinned */
+    frozen?: boolean;
+    /** Truncate text after N characters */
+    truncate?: number;
+    /** Tooltip configuration */
+    tooltip?: string | {
+        field?: string;
+        template?: string;
+    };
+}
+/**
+ * Filter condition for a view
+ */
+export interface ViewFilter {
+    /** Field to filter on */
+    field: string;
+    /** Comparison operator */
+    operator: ValidationOperator | 'is_null' | 'is_not_null';
+    /** Value to compare against */
+    value?: any;
+    /** Multiple values (for 'in' operator) */
+    values?: any[];
+    /** Label for this filter (for UI) */
+    label?: string;
+}
+/**
+ * Logical grouping of filters
+ */
+export interface ViewFilterGroup {
+    /** Logical operator */
+    operator: 'and' | 'or';
+    /** Filters in this group */
+    filters: (ViewFilter | ViewFilterGroup)[];
+}
+/**
+ * Sort configuration for a view
+ */
+export interface ViewSort {
+    /** Field to sort by */
+    field: string;
+    /** Sort direction */
+    direction: 'asc' | 'desc';
+}
+/**
+ * Action available in the view
+ */
+export interface ViewAction {
+    /** Action name/identifier */
+    name: string;
+    /** Display label */
+    label?: string;
+    /** Icon */
+    icon?: string;
+    /** Action type */
+    type?: 'standard' | 'custom';
+    /** Confirmation message before executing */
+    confirm?: string;
+    /** Visibility condition */
+    visible_when?: string;
+    /** Enabled condition */
+    enabled_when?: string;
+}
+/**
+ * Grouping configuration for a view
+ */
+export interface ViewGrouping {
+    /** Field to group by */
+    field: string;
+    /** Display label for the group */
+    label?: string;
+    /** Sort order within groups */
+    sort?: 'asc' | 'desc';
+    /** Whether groups are collapsed by default */
+    collapsed?: boolean;
+}
+/**
+ * Pagination configuration
+ */
+export interface ViewPagination {
+    /** Enable pagination */
+    enabled: boolean;
+    /** Default page size */
+    page_size?: number;
+    /** Available page size options */
+    page_size_options?: number[];
+}
+/**
+ * Kanban view specific configuration
+ */
+export interface KanbanViewConfig {
+    /** Field to use for columns (status field) */
+    column_field: string;
+    /** Field to use for card title */
+    title_field: string;
+    /** Field to use for card subtitle */
+    subtitle_field?: string;
+    /** Additional fields to display on card */
+    card_fields?: string[];
+    /** Field to use for card color */
+    color_field?: string;
+    /** Field to use for card avatar/image */
+    avatar_field?: string;
+    /** Enable drag and drop */
+    enable_drag_drop?: boolean;
+}
+/**
+ * Calendar view specific configuration
+ */
+export interface CalendarViewConfig {
+    /** Field to use for event start date */
+    start_date_field: string;
+    /** Field to use for event end date */
+    end_date_field?: string;
+    /** Field to use for event title */
+    title_field: string;
+    /** Field to use for event color */
+    color_field?: string;
+    /** Default view mode (day, week, month) */
+    default_mode?: 'day' | 'week' | 'month' | 'year';
+    /** Enable all-day events */
+    all_day_field?: string;
+}
+/**
+ * Timeline view specific configuration
+ */
+export interface TimelineViewConfig {
+    /** Field to use for task start */
+    start_field: string;
+    /** Field to use for task end */
+    end_field: string;
+    /** Field to use for task name */
+    name_field: string;
+    /** Field to use for progress percentage */
+    progress_field?: string;
+    /** Field to use for dependencies */
+    dependencies_field?: string;
+    /** Enable drag to resize */
+    enable_resize?: boolean;
+    /** Enable drag to move */
+    enable_move?: boolean;
+}
+/**
+ * Gallery view specific configuration
+ */
+export interface GalleryViewConfig {
+    /** Field to use for card image */
+    image_field: string;
+    /** Field to use for card title */
+    title_field: string;
+    /** Field to use for card description */
+    description_field?: string;
+    /** Number of columns */
+    columns?: number;
+    /** Card aspect ratio */
+    aspect_ratio?: string;
+}
+/**
+ * Map view specific configuration
+ */
+export interface MapViewConfig {
+    /** Field containing location data */
+    location_field: string;
+    /** Field to use for marker title */
+    title_field: string;
+    /** Field to use for marker description */
+    description_field?: string;
+    /** Default map center [latitude, longitude] */
+    center?: [number, number];
+    /** Default zoom level */
+    zoom?: number;
+    /** Enable clustering */
+    enable_clustering?: boolean;
+}
+/**
+ * Complete view configuration
+ */
+export interface ViewConfig {
+    /** Unique view identifier */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Object this view applies to */
+    object: string;
+    /** View description */
+    description?: string;
+    /** View type */
+    type?: ViewType;
+    /** Icon for the view */
+    icon?: string;
+    /** Columns to display (for list views) */
+    columns?: ViewColumn[];
+    /** Default filters */
+    filters?: (ViewFilter | ViewFilterGroup)[];
+    /** Default sorting */
+    sort?: ViewSort[];
+    /** Grouping configuration */
+    grouping?: ViewGrouping;
+    /** Pagination configuration */
+    pagination?: ViewPagination;
+    /** Maximum number of records to fetch */
+    limit?: number;
+    /** Available actions */
+    actions?: ViewAction[];
+    /** Enable search */
+    enable_search?: boolean;
+    /** Searchable fields */
+    search_fields?: string[];
+    /** Enable inline editing */
+    enable_inline_edit?: boolean;
+    /** Enable bulk selection */
+    enable_bulk_select?: boolean;
+    /** Enable export */
+    enable_export?: boolean;
+    /** Export formats */
+    export_formats?: ('csv' | 'xlsx' | 'pdf' | 'json')[];
+    /** Kanban-specific config */
+    kanban?: KanbanViewConfig;
+    /** Calendar-specific config */
+    calendar?: CalendarViewConfig;
+    /** Timeline-specific config */
+    timeline?: TimelineViewConfig;
+    /** Gallery-specific config */
+    gallery?: GalleryViewConfig;
+    /** Map-specific config */
+    map?: MapViewConfig;
+    /** Whether this is the default view */
+    is_default?: boolean;
+    /** Access control */
+    permissions?: {
+        /** Roles allowed to view */
+        view?: string[];
+        /** Roles allowed to edit view configuration */
+        edit?: string[];
+    };
+    /** Whether the view is shared with all users */
+    is_public?: boolean;
+    /** Owner of the view (for personal views) */
+    owner?: string;
+    /** Custom view configuration */
+    config?: Record<string, any>;
+    /** AI context for view generation */
+    ai_context?: {
+        /** Purpose of this view */
+        intent?: string;
+        /** Target user role */
+        persona?: string;
+        /** Key insights to display */
+        insights?: string[];
+    };
+}
+/**
+ * Lightweight view reference
+ * Used in navigation, dropdowns, and view selectors
+ */
+export interface ViewReference {
+    /** View name/identifier */
+    name: string;
+    /** Display label */
+    label?: string;
+    /** Icon */
+    icon?: string;
+    /** View type */
+    type?: ViewType;
+    /** Whether this is the default view */
+    is_default?: boolean;
+}

package/dist/view.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * View Metadata Definition
+ *
+ * Defines the structure for list views, grid views, and other data visualization views
+ * in ObjectQL applications. Views define how data from objects is displayed to users
+ * including columns, filters, sorting, and available actions.
+ *
+ * Based on common patterns from Salesforce List Views, Airtable Views, and similar platforms.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=view.js.map

package/dist/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../src/view.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG"}

package/dist/workflow.d.ts

@@ -0,0 +1,358 @@
+/**
+ * Workflow and Automation Metadata Definition
+ *
+ * Defines the structure for workflows, approvals, and automation processes in ObjectQL.
+ * Workflows orchestrate business processes, approval chains, and automated actions.
+ *
+ * Based on patterns from Salesforce Process Builder, Microsoft Power Automate, and similar platforms.
+ */
+import { ValidationCondition } from './validation';
+/**
+ * Types of workflows supported by ObjectQL
+ */
+export type WorkflowType = 'approval' | 'automation' | 'scheduled' | 'sequential' | 'parallel' | 'custom';
+/**
+ * Workflow trigger event types
+ */
+export type WorkflowTriggerEvent = 'create' | 'update' | 'delete' | 'create_or_update' | 'field_change' | 'schedule' | 'manual' | 'webhook' | 'custom';
+/**
+ * Workflow trigger configuration
+ */
+export interface WorkflowTrigger {
+    /** Trigger event type */
+    event: WorkflowTriggerEvent;
+    /** Conditions that must be met to trigger the workflow */
+    conditions?: ValidationCondition[];
+    /** Schedule configuration (for scheduled workflows) */
+    schedule?: {
+        /** Cron expression */
+        cron?: string;
+        /** Interval in minutes */
+        interval?: number;
+        /** Timezone for schedule */
+        timezone?: string;
+    };
+    /** Specific fields to monitor (for field_change event) */
+    fields?: string[];
+    /** Webhook configuration (for webhook triggers) */
+    webhook?: {
+        /** Webhook URL pattern */
+        path?: string;
+        /** HTTP method */
+        method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+        /** Authentication required */
+        auth?: boolean;
+    };
+}
+/**
+ * Workflow step types
+ */
+export type WorkflowStepType = 'approval' | 'action' | 'notification' | 'field_update' | 'create_record' | 'condition' | 'wait' | 'loop' | 'webhook' | 'script' | 'parallel' | 'custom';
+/**
+ * Assignee configuration for approval steps
+ */
+export interface WorkflowAssignee {
+    /** Assignee type */
+    type: 'user' | 'role' | 'field' | 'expression' | 'queue';
+    /** Specific user ID (for type: user) */
+    user?: string;
+    /** Role name (for type: role) */
+    role?: string;
+    /** Field containing assignee (for type: field) */
+    field?: string;
+    /** Expression to evaluate assignee (for type: expression) */
+    expression?: string;
+    /** Queue name (for type: queue) */
+    queue?: string;
+}
+/**
+ * Approval step action configuration
+ */
+export interface ApprovalAction {
+    /** Action label */
+    label: string;
+    /** Action value/identifier */
+    value?: string;
+    /** Next step to execute */
+    next_step?: string;
+    /** Workflow outcome if this action is chosen */
+    outcome?: 'approved' | 'rejected' | 'pending' | 'custom';
+    /** Field updates to apply */
+    updates?: Record<string, any>;
+    /** Comment field name */
+    comment_field?: string;
+    /** Whether comment is required */
+    comment_required?: boolean;
+}
+/**
+ * Field update configuration
+ */
+export interface FieldUpdateConfig {
+    /** Field to update */
+    field: string;
+    /** New value */
+    value?: any;
+    /** Expression to calculate value */
+    expression?: string;
+    /** Copy value from another field */
+    copy_from?: string;
+}
+/**
+ * Notification configuration
+ */
+export interface NotificationConfig {
+    /** Notification type */
+    type: 'email' | 'sms' | 'push' | 'in_app' | 'custom';
+    /** Recipients */
+    to?: {
+        /** Recipient type */
+        type: 'user' | 'role' | 'field' | 'email';
+        /** Value based on type */
+        value?: string;
+    }[];
+    /** Email template or subject */
+    subject?: string;
+    /** Message template */
+    template?: string;
+    /** Message body */
+    body?: string;
+    /** Custom notification handler */
+    handler?: string;
+}
+/**
+ * Create record configuration
+ */
+export interface CreateRecordConfig {
+    /** Object to create record in */
+    object: string;
+    /** Field mappings from trigger record */
+    field_mappings?: Record<string, string>;
+    /** Static field values */
+    values?: Record<string, any>;
+}
+/**
+ * Conditional branch configuration
+ */
+export interface ConditionalBranch {
+    /** Condition to evaluate */
+    condition: ValidationCondition;
+    /** Steps to execute if condition is true */
+    then_steps?: string[];
+    /** Steps to execute if condition is false */
+    else_steps?: string[];
+}
+/**
+ * Wait configuration
+ */
+export interface WaitConfig {
+    /** Wait type */
+    type: 'duration' | 'until' | 'field_change';
+    /** Duration to wait (ISO 8601 duration) */
+    duration?: string;
+    /** Wait until specific datetime */
+    until?: string;
+    /** Wait until field changes */
+    field?: string;
+    /** Timeout (ISO 8601 duration) */
+    timeout?: string;
+}
+/**
+ * Loop configuration
+ */
+export interface LoopConfig {
+    /** Type of loop */
+    type: 'items' | 'count' | 'while';
+    /** Items to iterate over (field or expression) */
+    items?: string;
+    /** Number of iterations */
+    count?: number;
+    /** Condition for while loop */
+    condition?: ValidationCondition;
+    /** Steps to execute in each iteration */
+    steps?: string[];
+}
+/**
+ * Webhook call configuration
+ */
+export interface WebhookCallConfig {
+    /** URL to call */
+    url: string;
+    /** HTTP method */
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    /** Headers */
+    headers?: Record<string, string>;
+    /** Request body */
+    body?: any;
+    /** Body template */
+    body_template?: string;
+    /** Authentication configuration */
+    auth?: {
+        type: 'basic' | 'bearer' | 'api_key' | 'oauth2';
+        credentials?: Record<string, any>;
+    };
+    /** Timeout in milliseconds */
+    timeout?: number;
+    /** Retry configuration */
+    retry?: {
+        max_attempts?: number;
+        backoff?: 'exponential' | 'linear';
+    };
+}
+/**
+ * Workflow step definition
+ */
+export interface WorkflowStep {
+    /** Unique step identifier */
+    name: string;
+    /** Display label */
+    label?: string;
+    /** Step description */
+    description?: string;
+    /** Step type */
+    type: WorkflowStepType;
+    /** Condition to execute this step */
+    condition?: ValidationCondition;
+    /** Assignee (for approval steps) */
+    assignee?: WorkflowAssignee;
+    /** Available actions (for approval steps) */
+    actions?: Record<string, ApprovalAction>;
+    /** Field updates to apply */
+    field_updates?: FieldUpdateConfig[];
+    /** Notification configuration */
+    notification?: NotificationConfig;
+    /** Record creation configuration */
+    create_record?: CreateRecordConfig;
+    /** Conditional branching */
+    conditional?: ConditionalBranch;
+    /** Wait configuration */
+    wait?: WaitConfig;
+    /** Loop configuration */
+    loop?: LoopConfig;
+    /** Webhook configuration */
+    webhook?: WebhookCallConfig;
+    /** Custom script */
+    script?: string;
+    /** Parallel steps to execute */
+    parallel_steps?: string[];
+    /** Next step to execute (default flow) */
+    next_step?: string;
+    /** Timeout for this step (ISO 8601 duration) */
+    timeout?: string;
+    /** Error handling */
+    on_error?: {
+        /** Action on error */
+        action: 'fail' | 'continue' | 'retry' | 'skip';
+        /** Next step on error */
+        next_step?: string;
+        /** Retry configuration */
+        retry?: {
+            max_attempts?: number;
+            delay?: string;
+        };
+    };
+}
+/**
+ * Complete workflow configuration
+ */
+export interface WorkflowConfig {
+    /** Unique workflow identifier */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Workflow type */
+    type: WorkflowType;
+    /** Object this workflow applies to */
+    object: string;
+    /** Workflow description */
+    description?: string;
+    /** Icon for the workflow */
+    icon?: string;
+    /** Whether the workflow is active */
+    is_active?: boolean;
+    /** Trigger configuration */
+    trigger: WorkflowTrigger;
+    /** Ordered list of workflow steps */
+    steps: WorkflowStep[];
+    /** Initial step to execute */
+    initial_step?: string;
+    /** Workflow variables */
+    variables?: Record<string, any>;
+    /** Success outcome field updates */
+    on_success?: {
+        /** Field updates on successful completion */
+        updates?: Record<string, any>;
+        /** Notification on success */
+        notification?: NotificationConfig;
+    };
+    /** Failure outcome configuration */
+    on_failure?: {
+        /** Field updates on failure */
+        updates?: Record<string, any>;
+        /** Notification on failure */
+        notification?: NotificationConfig;
+    };
+    /** Execution timeout (ISO 8601 duration) */
+    timeout?: string;
+    /** Execution mode */
+    execution_mode?: 'synchronous' | 'asynchronous';
+    /** Priority (higher priority workflows execute first) */
+    priority?: number;
+    /** Access control */
+    permissions?: {
+        /** Roles that can trigger this workflow */
+        execute?: string[];
+        /** Roles that can view workflow history */
+        view?: string[];
+        /** Roles that can edit workflow configuration */
+        edit?: string[];
+    };
+    /** Custom workflow configuration */
+    config?: Record<string, any>;
+    /** AI context for workflow generation */
+    ai_context?: {
+        /** Business process description */
+        intent?: string;
+        /** Process participants */
+        stakeholders?: string[];
+        /** Expected duration */
+        duration?: string;
+    };
+}
+/**
+ * Workflow execution status
+ */
+export type WorkflowStatus = 'pending' | 'running' | 'waiting' | 'completed' | 'approved' | 'rejected' | 'failed' | 'cancelled' | 'timeout';
+/**
+ * Workflow instance (execution record)
+ */
+export interface WorkflowInstance {
+    /** Instance ID */
+    id: string;
+    /** Workflow name */
+    workflow_name: string;
+    /** Record ID that triggered the workflow */
+    record_id?: string;
+    /** Current status */
+    status: WorkflowStatus;
+    /** Current step */
+    current_step?: string;
+    /** Started timestamp */
+    started_at?: string;
+    /** Completed timestamp */
+    completed_at?: string;
+    /** Triggered by user */
+    triggered_by?: string;
+    /** Error message (if failed) */
+    error?: string;
+    /** Execution context */
+    context?: Record<string, any>;
+    /** Step history */
+    step_history?: Array<{
+        step: string;
+        status: 'completed' | 'failed' | 'skipped';
+        started_at: string;
+        completed_at?: string;
+        actor?: string;
+        result?: any;
+    }>;
+}

package/dist/workflow.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Workflow and Automation Metadata Definition
+ *
+ * Defines the structure for workflows, approvals, and automation processes in ObjectQL.
+ * Workflows orchestrate business processes, approval chains, and automated actions.
+ *
+ * Based on patterns from Salesforce Process Builder, Microsoft Power Automate, and similar platforms.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=workflow.js.map

package/dist/workflow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.js","sourceRoot":"","sources":["../src/workflow.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@objectql/types",
-  "version": "1.8.3",
+  "version": "1.9.0",
   "description": "Pure TypeScript type definitions and interfaces for the ObjectQL protocol - The Contract",
   "keywords": [
     "objectql",