@objectql/types 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @objectql/core
 
+## 1.6.0
+
+### Minor Changes
+
+- Minor version release - 1.6.0
+
 ## 1.5.0
 
 ### Minor Changes

package/dist/app.d.ts

@@ -3,23 +3,14 @@ import { Driver } from "./driver";
 import { MetadataRegistry } from "./registry";
 import { HookName, HookHandler, HookContext } from "./hook";
 import { ActionHandler, ActionContext } from "./action";
-import { LoaderPlugin } from "./loader";
 export interface IObjectQL {
     getObject(name: string): ObjectConfig | undefined;
     getConfigs(): Record<string, ObjectConfig>;
     datasource(name: string): Driver;
     init(): Promise<void>;
-    addPackage(name: string): void;
     removePackage(name: string): void;
     metadata: MetadataRegistry;
     registerObject(object: ObjectConfig): void;
-    loadFromDirectory(dir: string): void;
-    addLoader(plugin: LoaderPlugin): void;
-    /**
-     * Updates and persists metadata content.
-     * Only works if the metadata was loaded from a writable file source (e.g. local disk).
-     */
-    updateMetadata(type: string, id: string, content: any): Promise<void>;
     on(event: HookName, objectName: string, handler: HookHandler): void;
     triggerHook(event: HookName, objectName: string, ctx: HookContext): Promise<void>;
     registerAction(objectName: string, actionName: string, handler: ActionHandler): void;

package/dist/application.d.ts

@@ -0,0 +1,38 @@
+export interface AppConfig {
+    /**
+     * Unique identifier for the application
+     */
+    name: string;
+    /**
+     * Display label for the application
+     */
+    label: string;
+    /**
+     * Description of what this application does
+     */
+    description?: string;
+    /**
+     * Icon name/class for the application
+     */
+    icon?: string;
+    /**
+     * URL to the application logo
+     */
+    logo?: string;
+    /**
+     * Default path to redirect when opening the app
+     */
+    homepage?: string;
+    /**
+     * Sort order for display
+     */
+    sort_no?: number;
+    /**
+     * Whether the application is enabled
+     */
+    is_active?: boolean;
+    /**
+     * Custom metadata/settings
+     */
+    [key: string]: any;
+}

package/dist/application.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=application.js.map

package/dist/application.js.map

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

package/dist/field.d.ts

@@ -85,4 +85,13 @@ export interface FieldConfig {
     ai_context?: ValidationAiContext;
     /** Dimension of the vector for 'vector' type fields. */
     dimension?: number;
+    /** Formula expression. */
+    formula?: string;
+    /** Object to summarize. */
+    summary_object?: string;
+    /** Field on the summary object. */
+    summary_field?: string;
+    /** Type of summary (count, sum, min, max, avg). */
+    summary_type?: string;
+    filters?: any[];
 }

package/dist/index.d.ts

@@ -11,4 +11,8 @@ export * from './plugin';
 export * from './config';
 export * from './context';
 export * from './validation';
+export * from './permission';
+export * from './page';
 export * from './loader';
+export * from './application';
+export * from './menu';

package/dist/index.js

@@ -27,5 +27,9 @@ __exportStar(require("./plugin"), exports);
 __exportStar(require("./config"), exports);
 __exportStar(require("./context"), exports);
 __exportStar(require("./validation"), exports);
+__exportStar(require("./permission"), exports);
+__exportStar(require("./page"), exports);
 __exportStar(require("./loader"), exports);
+__exportStar(require("./application"), exports);
+__exportStar(require("./menu"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,2CAAyB;AACzB,2CAAyB;AACzB,0CAAwB;AACxB,6CAA2B;AAC3B,yCAAuB;AACvB,2CAAyB;AACzB,+CAA6B;AAC7B,wCAAsB;AACtB,2CAAyB;AACzB,2CAAyB;AACzB,4CAA0B;AAC1B,+CAA6B;AAG7B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,2CAAyB;AACzB,2CAAyB;AACzB,0CAAwB;AACxB,6CAA2B;AAC3B,yCAAuB;AACvB,2CAAyB;AACzB,+CAA6B;AAC7B,wCAAsB;AACtB,2CAAyB;AACzB,2CAAyB;AACzB,4CAA0B;AAC1B,+CAA6B;AAC7B,+CAA6B;AAC7B,yCAAuB;AACvB,2CAAyB;AACzB,gDAA8B;AAC9B,yCAAuB"}

package/dist/menu.d.ts

@@ -0,0 +1,82 @@
+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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=menu.js.map

package/dist/menu.js.map

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

package/dist/page.d.ts

@@ -0,0 +1,272 @@
+/**
+ * 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;
+}

package/dist/page.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=page.js.map

package/dist/page.js.map

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