@objectql/types 4.0.2 → 4.0.4

package/dist/form.d.ts

@@ -1,322 +0,0 @@
-/**
- * ObjectQL
- * Copyright (c) 2026-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-/**
- * Form Metadata Definition
- *
- * Defines the structure for forms, layouts, and field arrangements in ObjectQL.
- * Forms control how data is entered, edited, and displayed to users with
- * sections, tabs, columns, and conditional visibility.
- *
- * Based on patterns from Salesforce Page Layouts, Dynamics Forms, and similar platforms.
- */
-import { ValidationCondition } from './validation';
-/**
- * Form types supported by ObjectQL
- */
-export type FormType = 'create' | 'edit' | 'view' | 'wizard' | 'quick_create' | 'inline' | 'custom';
-/**
- * Layout types for form arrangement
- */
-export type FormLayoutType = 'single_column' | 'two_column' | 'three_column' | 'tabs' | 'accordion' | 'custom';
-/**
- * Field display configuration in form
- */
-export interface FormField {
-    /** Field name */
-    name: string;
-    /** Display label (overrides field config) */
-    label?: string;
-    /** Help text (overrides field config) */
-    help_text?: string;
-    /** Placeholder text */
-    placeholder?: string;
-    /** Whether field is required in this form */
-    required?: boolean;
-    /** Whether field is readonly in this form */
-    readonly?: boolean;
-    /** Whether field is hidden in this form */
-    hidden?: boolean;
-    /** Field width in columns (for multi-column layouts) */
-    width?: number;
-    /** Span across columns */
-    span?: number;
-    /** Visibility condition */
-    visible_when?: ValidationCondition | string;
-    /** Enabled condition */
-    enabled_when?: ValidationCondition | string;
-    /** Default value override */
-    default_value?: any;
-    /** Field-specific validation override */
-    validation?: any;
-    /** Custom CSS class */
-    class_name?: string;
-    /** Field-specific configuration */
-    config?: Record<string, any>;
-}
-/**
- * Form section configuration
- */
-export interface FormSection {
-    /** Section identifier */
-    id?: string;
-    /** Section label */
-    label?: string;
-    /** Section description */
-    description?: string;
-    /** Number of columns in this section */
-    columns?: number;
-    /** Fields in this section */
-    fields: (string | FormField)[];
-    /** Whether section is collapsible */
-    collapsible?: boolean;
-    /** Default collapsed state */
-    collapsed?: boolean;
-    /** Visibility condition */
-    visible_when?: ValidationCondition | string;
-    /** Section border style */
-    border?: boolean;
-    /** Section background color */
-    background?: string;
-    /** Custom CSS class */
-    class_name?: string;
-}
-/**
- * Form tab configuration
- */
-export interface FormTab {
-    /** Tab identifier */
-    id: string;
-    /** Tab label */
-    label: string;
-    /** Tab icon */
-    icon?: string;
-    /** Sections within this tab */
-    sections: FormSection[];
-    /** Visibility condition */
-    visible_when?: ValidationCondition | string;
-    /** Badge/count to display on tab */
-    badge?: string | number;
-    /** Whether this tab is disabled */
-    disabled?: boolean;
-}
-/**
- * Wizard step configuration
- */
-export interface WizardStep {
-    /** Step identifier */
-    id: string;
-    /** Step label */
-    label: string;
-    /** Step description */
-    description?: string;
-    /** Icon for step */
-    icon?: string;
-    /** Sections in this step */
-    sections: FormSection[];
-    /** Validation to pass before proceeding */
-    validation?: ValidationCondition;
-    /** Whether user can skip this step */
-    skippable?: boolean;
-    /** Visibility condition */
-    visible_when?: ValidationCondition | string;
-    /** Action to execute when step is completed */
-    on_complete?: string;
-}
-/**
- * Form action/button configuration
- */
-export interface FormAction {
-    /** Action identifier */
-    name: string;
-    /** Display label */
-    label: string;
-    /** Button type */
-    type?: 'submit' | 'cancel' | 'custom' | 'save' | 'save_new' | 'save_close';
-    /** Icon */
-    icon?: string;
-    /** Button style variant */
-    variant?: 'primary' | 'secondary' | 'danger' | 'success' | 'ghost';
-    /** Position */
-    position?: 'header' | 'footer' | 'both';
-    /** Confirmation message before executing */
-    confirm?: string;
-    /** Visibility condition */
-    visible_when?: ValidationCondition | string;
-    /** Enabled condition */
-    enabled_when?: ValidationCondition | string;
-    /** Custom action handler */
-    handler?: string;
-    /** Navigate to path after action */
-    redirect?: string;
-}
-/**
- * Form validation configuration
- */
-export interface FormValidationConfig {
-    /** Enable real-time validation */
-    realtime?: boolean;
-    /** Validate on blur */
-    validate_on_blur?: boolean;
-    /** Validate on change */
-    validate_on_change?: boolean;
-    /** Show validation summary */
-    show_summary?: boolean;
-    /** Custom validation rules */
-    rules?: any[];
-}
-/**
- * Form header configuration
- */
-export interface FormHeader {
-    /** Show header */
-    show?: boolean;
-    /** Header title */
-    title?: string;
-    /** Header subtitle */
-    subtitle?: string;
-    /** Show record info (created, updated dates) */
-    show_record_info?: boolean;
-    /** Custom header component */
-    component?: string;
-}
-/**
- * Form footer configuration
- */
-export interface FormFooter {
-    /** Show footer */
-    show?: boolean;
-    /** Footer actions */
-    actions?: FormAction[];
-    /** Footer position */
-    position?: 'sticky' | 'static';
-    /** Custom footer component */
-    component?: string;
-}
-/**
- * Form autosave configuration
- */
-export interface FormAutosaveConfig {
-    /** Enable autosave */
-    enabled: boolean;
-    /** Autosave interval in milliseconds */
-    interval?: number;
-    /** Show autosave indicator */
-    show_indicator?: boolean;
-    /** Autosave on field blur */
-    on_blur?: boolean;
-}
-/**
- * Complete form configuration
- */
-export interface FormConfig {
-    /** Unique form identifier */
-    name: string;
-    /** Display label */
-    label: string;
-    /** Form type */
-    type?: FormType;
-    /** Object this form is for */
-    object: string;
-    /** Form description */
-    description?: string;
-    /** Layout type */
-    layout: FormLayoutType;
-    /** Number of columns (for column layouts) */
-    columns?: number;
-    /** Sections (for non-tab layouts) */
-    sections?: FormSection[];
-    /** Tabs (for tab layout) */
-    tabs?: FormTab[];
-    /** Wizard steps (for wizard layout) */
-    steps?: WizardStep[];
-    /** Form header */
-    header?: FormHeader;
-    /** Form footer */
-    footer?: FormFooter;
-    /** Form actions/buttons */
-    actions?: FormAction[];
-    /** Validation configuration */
-    validation?: FormValidationConfig;
-    /** Autosave configuration */
-    autosave?: FormAutosaveConfig;
-    /** Show required field indicator */
-    show_required_indicator?: boolean;
-    /** Show field help text */
-    show_help_text?: boolean;
-    /** Compact mode (reduced spacing) */
-    compact?: boolean;
-    /** Read-only mode */
-    readonly?: boolean;
-    /** Disable all fields */
-    disabled?: boolean;
-    /** Show success message after save */
-    success_message?: string;
-    /** Redirect after successful save */
-    redirect_on_success?: string;
-    /** Access control */
-    permissions?: {
-        /** Roles that can view this form */
-        view?: string[];
-        /** Roles that can edit using this form */
-        edit?: string[];
-    };
-    /** Custom form handler */
-    handler?: string;
-    /** Custom CSS class */
-    class_name?: string;
-    /** Form width (for modal forms) */
-    width?: string;
-    /** Maximum width */
-    max_width?: string;
-    /** Custom form configuration */
-    config?: Record<string, any>;
-    /** AI context for form generation */
-    ai_context?: {
-        /** Purpose of this form */
-        intent?: string;
-        /** User experience goals */
-        ux_goals?: string[];
-        /** Field organization strategy */
-        organization_strategy?: string;
-    };
-}
-/**
- * Lightweight form reference
- * Used in navigation, dropdowns, and form selectors
- */
-export interface FormReference {
-    /** Form name/identifier */
-    name: string;
-    /** Display label */
-    label?: string;
-    /** Form type */
-    type?: FormType;
-    /** Whether this is the default form */
-    is_default?: boolean;
-}
-/**
- * Dynamic form state (runtime)
- */
-export interface FormState {
-    /** Current form values */
-    values: Record<string, any>;
-    /** Field errors */
-    errors: Record<string, string>;
-    /** Touched fields */
-    touched: Record<string, boolean>;
-    /** Whether form is submitting */
-    submitting: boolean;
-    /** Whether form is valid */
-    valid: boolean;
-    /** Whether form is dirty (has changes) */
-    dirty: boolean;
-    /** Current wizard step (for wizard forms) */
-    current_step?: number;
-    /** Custom state */
-    custom?: Record<string, any>;
-}

package/dist/form.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * ObjectQL
- * Copyright (c) 2026-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=form.js.map

package/dist/form.js.map

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

package/dist/menu.d.ts

@@ -1,89 +0,0 @@
-/**
- * ObjectQL
- * Copyright (c) 2026-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-export type MenuType = 'sidebar' | 'topnav' | 'context' | 'mobile' | 'admin';
-export type MenuItemType = 'page' | 'section' | 'url' | 'folder' | 'object' | 'action';
-export interface MenuItem {
-    /**
-     * Unique identifier for the menu item
-     */
-    name: string;
-    /**
-     * Display label
-     */
-    label: string;
-    /**
-     * Icon name
-     */
-    icon?: string;
-    /**
-     * Item type
-     */
-    type?: MenuItemType;
-    /**
-     * Navigation path (for type: page/url)
-     */
-    path?: string;
-    /**
-     * Associated Object name (for type: object)
-     */
-    object?: string;
-    /**
-     * Object View name (for type: object)
-     */
-    view?: string;
-    /**
-     * Nested menu items
-     */
-    items?: MenuItem[];
-    /**
-     * Link target (e.g. _blank)
-     */
-    target?: string;
-    /**
-     * Visibility condition
-     */
-    hidden?: boolean | string;
-    /**
-     * Badge value or expression
-     */
-    badge?: string;
-    /**
-     * Custom properties
-     */
-    [key: string]: any;
-}
-export interface MenuConfig {
-    /**
-     * Unique identifier for the menu
-     */
-    name: string;
-    /**
-     * Display label
-     */
-    label: string;
-    /**
-     * Menu type/location
-     */
-    type?: MenuType;
-    /**
-     * The application this menu belongs to
-     */
-    app?: string;
-    /**
-     * Menu items
-     */
-    items: MenuItem[];
-    /**
-     * Whether the menu is active
-     */
-    is_active?: boolean;
-    /**
-     * Custom properties
-     */
-    [key: string]: any;
-}

package/dist/menu.js.map

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

package/dist/page.d.ts

@@ -1,279 +0,0 @@
-/**
- * ObjectQL
- * Copyright (c) 2026-present ObjectStack Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-/**
- * Page Metadata Definition
- *
- * Defines the structure for pages in ObjectQL applications.
- * Inspired by low-code platforms like Airtable, Retool, Appsmith, and Salesforce Lightning.
- *
- * Pages are composable UI containers that can render data from objects,
- * display custom components, and orchestrate user interactions.
- */
-/**
- * Layout types for page arrangement
- */
-export type PageLayoutType = 'single_column' | 'two_column' | 'three_column' | 'dashboard' | 'canvas' | 'tabs' | 'wizard' | 'custom';
-/**
- * Component types that can be placed on a page
- */
-export type PageComponentType = 'data_grid' | 'form' | 'detail_view' | 'chart' | 'metric' | 'list' | 'calendar' | 'kanban' | 'timeline' | 'text' | 'html' | 'iframe' | 'button' | 'tabs' | 'container' | 'divider' | 'image' | 'custom';
-/**
- * Responsive breakpoint configuration
- */
-export interface ResponsiveConfig {
-    /** Mobile viewport (< 640px) */
-    mobile?: {
-        columns?: number;
-        visible?: boolean;
-        order?: number;
-    };
-    /** Tablet viewport (640px - 1024px) */
-    tablet?: {
-        columns?: number;
-        visible?: boolean;
-        order?: number;
-    };
-    /** Desktop viewport (> 1024px) */
-    desktop?: {
-        columns?: number;
-        visible?: boolean;
-        order?: number;
-    };
-}
-/**
- * Data source configuration for components
- */
-export interface ComponentDataSource {
-    /** Object name to query */
-    object?: string;
-    /** Filter conditions */
-    filters?: any[];
-    /** Fields to display */
-    fields?: string[];
-    /** Sort configuration */
-    sort?: Array<[string, 'asc' | 'desc']>;
-    /** Maximum records to fetch */
-    limit?: number;
-    /** Enable pagination */
-    paginate?: boolean;
-    /** Related objects to expand */
-    expand?: Record<string, any>;
-    /** Custom query override */
-    query?: any;
-}
-/**
- * Action triggered by component interaction
- */
-export interface ComponentAction {
-    /** Action type */
-    type: 'navigate' | 'open_modal' | 'run_action' | 'submit_form' | 'refresh' | 'custom';
-    /** Navigation path (for type: navigate) */
-    path?: string;
-    /** Modal component to open (for type: open_modal) */
-    modal?: string;
-    /** Action name to execute (for type: run_action) */
-    action?: string;
-    /** Target object for action */
-    object?: string;
-    /** Custom handler function */
-    handler?: string;
-    /** Confirmation message before executing */
-    confirm?: string;
-    /** Success message after execution */
-    success_message?: string;
-    /** Error handling */
-    on_error?: 'show_toast' | 'show_modal' | 'ignore';
-}
-/**
- * Styling configuration for components
- */
-export interface ComponentStyle {
-    /** Width (e.g., '100%', '300px', 'auto') */
-    width?: string;
-    /** Height */
-    height?: string;
-    /** Minimum width */
-    min_width?: string;
-    /** Minimum height */
-    min_height?: string;
-    /** Background color */
-    background?: string;
-    /** Text color */
-    color?: string;
-    /** Border */
-    border?: string;
-    /** Border radius */
-    border_radius?: string;
-    /** Padding */
-    padding?: string;
-    /** Margin */
-    margin?: string;
-    /** Custom CSS classes */
-    class_name?: string;
-    /** Inline styles */
-    custom_css?: Record<string, any>;
-}
-/**
- * Base component configuration
- */
-export interface PageComponent {
-    /** Unique component identifier within the page */
-    id: string;
-    /** Component type */
-    type: PageComponentType;
-    /** Display label */
-    label?: string;
-    /** Component description */
-    description?: string;
-    /** Data source configuration */
-    data_source?: ComponentDataSource;
-    /** Component-specific configuration */
-    config?: Record<string, any>;
-    /** Actions triggered by this component */
-    actions?: {
-        on_click?: ComponentAction;
-        on_submit?: ComponentAction;
-        on_load?: ComponentAction;
-        on_change?: ComponentAction;
-        [key: string]: ComponentAction | undefined;
-    };
-    /** Visual styling */
-    style?: ComponentStyle;
-    /** Responsive behavior */
-    responsive?: ResponsiveConfig;
-    /** Visibility conditions */
-    visible_when?: Record<string, any>;
-    /** Access control */
-    permissions?: string[];
-    /** Nested components (for containers, tabs, etc.) */
-    components?: PageComponent[];
-    /** Grid position (for dashboard layout) */
-    grid?: {
-        x: number;
-        y: number;
-        w: number;
-        h: number;
-    };
-    /** Custom component reference */
-    component?: string;
-}
-/**
- * Page section/region configuration
- */
-export interface PageSection {
-    /** Section identifier */
-    id: string;
-    /** Section label */
-    label?: string;
-    /** Section type */
-    type?: 'header' | 'sidebar' | 'content' | 'footer' | 'custom';
-    /** Components in this section */
-    components: PageComponent[];
-    /** Section styling */
-    style?: ComponentStyle;
-    /** Collapsible section */
-    collapsible?: boolean;
-    /** Default collapsed state */
-    collapsed?: boolean;
-    /** Visibility conditions */
-    visible_when?: Record<string, any>;
-}
-/**
- * Page metadata configuration
- */
-export interface PageConfig {
-    /** Unique page identifier */
-    name: string;
-    /** Display label */
-    label: string;
-    /** Page description */
-    description?: string;
-    /** Icon for navigation */
-    icon?: string;
-    /** Layout type */
-    layout: PageLayoutType;
-    /** Page sections */
-    sections?: PageSection[];
-    /** Components (alternative to sections for simple layouts) */
-    components?: PageComponent[];
-    /** Page-level data sources */
-    data_sources?: Record<string, ComponentDataSource>;
-    /** Page-level actions */
-    actions?: Record<string, ComponentAction>;
-    /** Page styling */
-    style?: ComponentStyle;
-    /** Access control */
-    permissions?: {
-        /** Roles allowed to view this page */
-        view?: string[];
-        /** Roles allowed to edit this page */
-        edit?: string[];
-    };
-    /** SEO and metadata */
-    meta?: {
-        title?: string;
-        description?: string;
-        keywords?: string[];
-    };
-    /** Page state management */
-    state?: {
-        /** Initial state values */
-        initial?: Record<string, any>;
-        /** State persistence */
-        persist?: boolean;
-        /** Storage key for persistence */
-        storage_key?: string;
-    };
-    /** Responsive configuration */
-    responsive?: ResponsiveConfig;
-    /** Custom page handler/controller */
-    handler?: string;
-    /** Enable real-time updates */
-    realtime?: boolean;
-    /** Refresh interval in seconds */
-    refresh_interval?: number;
-    /** AI context for page generation and understanding */
-    ai_context?: {
-        /** Purpose of the page */
-        intent?: string;
-        /** Target user persona */
-        persona?: string;
-        /** Key user tasks */
-        tasks?: string[];
-    };
-}
-/**
- * Lightweight page reference (for menus, navigation, etc.)
- *
- * Used in application navigation menus and links to reference pages
- * without loading the full page configuration. This is useful for:
- * - Building navigation menus
- * - Creating page links
- * - Page selection dropdowns
- *
- * @example
- * ```typescript
- * // In navigation menu
- * const menuItem: PageReference = {
- *   name: 'dashboard',
- *   label: 'Dashboard',
- *   icon: 'dashboard',
- *   path: '/dashboard'
- * };
- * ```
- */
-export interface PageReference {
-    /** Page name/identifier */
-    name: string;
-    /** Display label */
-    label?: string;
-    /** Icon */
-    icon?: string;
-    /** Path/route */
-    path?: string;
-}