@objectql/types 1.6.1 → 1.7.1

package/src/action.ts

@@ -1,96 +0,0 @@
-import { FieldConfig } from "./field";
-import { HookAPI } from "./hook"; // Reuse the restricted API interface
-
-/**
- * Defines the scope of the action.
- * - `record`: Acts on a specific record instance (e.g. "Approve Order").
- * - `global`: Acts on the collection or system (e.g. "Import CSV", "Daily Report").
- */
-export type ActionType = 'record' | 'global';
-
-/**
- * Re-using FieldConfig allows us to describe input parameters 
- * using the same rich vocabulary as database fields (validation, UI hints, etc).
- */
-export type ActionInputDefinition = Record<string, FieldConfig>;
-
-/**
- * Context passed to the action handler execution.
- */
-export interface ActionContext<BaseT = any, InputT = any> {
-    /** The object this action belongs to. */
-    objectName: string;
-    
-    /** The name of the action being executed. */
-    actionName: string;
-
-    /** 
-     * The ID of the record being acted upon.
-     * Only available if type is 'record'.
-     */
-    id?: string | number;
-
-    /**
-     * The validated input arguments.
-     */
-    input: InputT;
-
-    /**
-     * Database Access API (Same as Hooks).
-     */
-    api: HookAPI;
-
-    /**
-     * User Session.
-     */
-    user?: {
-        id: string | number;
-        [key: string]: any;
-    };
-}
-
-/**
- * The configuration of an Action visible to the Metadata engine (YAML/JSON side).
- */
-export interface ActionConfig {
-    label?: string;
-    description?: string;
-    icon?: string;
-    
-    /**
-     * Default: 'global' if no fields defined, but usually specified explicitly.
-     */
-    type?: ActionType; // 'record' | 'global'
-
-    /**
-     * Message to show before executing. If present, UI should prompt confirmation.
-     */
-    confirm_text?: string;
-    
-    /**
-     * If true, this action is not exposed via API directly (server-internal).
-     */
-    internal?: boolean;
-    
-    /**
-     * Input parameter schema.
-     */
-    params?: ActionInputDefinition;
-    
-    /**
-     * Output data shape description (optional, for content negotiation).
-     */
-    return_type?: string | FieldConfig; 
-}
-
-/**
- * The full implementation definition (Code side).
- */
-export interface ActionDefinition<BaseT = any, InputT = any, ReturnT = any> extends ActionConfig {
-    /**
-     * The business logic implementation.
-     */
-    handler: (ctx: ActionContext<BaseT, InputT>) => Promise<ReturnT>;
-}
-
-export type ActionHandler<BaseT = any, InputT = any, ReturnT = any> = (ctx: ActionContext<BaseT, InputT>) => Promise<ReturnT>;

package/src/app.ts

@@ -1,23 +0,0 @@
-import { ObjectConfig } from "./object";
-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>;
-    removePackage(name: string): void;
-    metadata: MetadataRegistry; 
-
-    registerObject(object: ObjectConfig): 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;
-    executeAction(objectName: string, actionName: string, ctx: ActionContext): Promise<any>;
-}

package/src/application.ts

@@ -1,46 +0,0 @@
-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/src/config.ts

@@ -1,37 +0,0 @@
-import { MetadataRegistry } from "./registry";
-import { Driver } from "./driver";
-import { ObjectConfig } from "./object";
-import { ObjectQLPlugin } from "./plugin";
-
-export interface ObjectQLConfig {
-    registry?: MetadataRegistry;
-    datasources?: Record<string, Driver>;
-    /**
-     * Optional connection string for auto-configuration.
-     * e.g. "sqlite://dev.db", "postgres://localhost/db", "mongodb://localhost/db"
-     */
-    connection?: string;
-    /**
-     * Path(s) to the directory containing schema files (*.object.yml).
-     */
-    source?: string | string[];
-    objects?: Record<string, ObjectConfig>;
-    /**
-     * @deprecated Use 'presets' instead.
-     */
-    packages?: string[];
-    /**
-     * List of npm packages or presets to load.
-     */
-    presets?: string[];
-    /**
-     * List of plugins to load. 
-     * Can be an instance of ObjectQLPlugin or a package name string.
-     */
-    plugins?: (ObjectQLPlugin | string)[];
-    /**
-     * List of remote ObjectQL instances to connect to.
-     * e.g. ["http://user-service:3000", "http://order-service:3000"]
-     */
-    remotes?: string[];
-}

package/src/context.ts

@@ -1,45 +0,0 @@
-import { IObjectRepository } from './repository';
-
-export interface ObjectQLContext {
-    // === Identity & Isolation ===
-    userId?: string;                        // Current User ID
-    spaceId?: string;                       // Multi-tenancy Isolation (Organization ID)
-    roles: string[];                        // RBAC Roles
-
-    // === Execution Flags ===
-    /**
-     * Sudo Mode / System Bypass.
-     */
-    isSystem?: boolean;
-
-    // === Data Entry Point ===
-    /**
-     * Returns a repository proxy bound to this context.
-     * All operations performed via this proxy inherit userId, spaceId, and transaction.
-     */
-    object(entityName: string): IObjectRepository;
-
-    /**
-     * Execute a function within a transaction.
-     * The callback receives a new context 'trxCtx' which inherits userId, spaceId from this context.
-     */
-    transaction(callback: (trxCtx: ObjectQLContext) => Promise<any>): Promise<any>;
-
-    /**
-     * Returns a new context with system privileges (isSystem: true).
-     * It shares the same transaction scope as the current context.
-     */
-    sudo(): ObjectQLContext;
-
-    /**
-     * Internal: Driver-specific transaction handle.
-     */
-    transactionHandle?: any;
-}
-
-export interface ObjectQLContextOptions {
-    userId?: string;
-    spaceId?: string;
-    roles?: string[];
-    isSystem?: boolean;
-}

package/src/driver.ts

@@ -1,27 +0,0 @@
-export interface Driver {
-    find(objectName: string, query: any, options?: any): Promise<any[]>;
-    findOne(objectName: string, id: string | number, query?: any, options?: any): Promise<any>;
-    create(objectName: string, data: any, options?: any): Promise<any>;
-    update(objectName: string, id: string | number, data: any, options?: any): Promise<any>;
-    delete(objectName: string, id: string | number, options?: any): Promise<any>;
-    count(objectName: string, filters: any, options?: any): Promise<number>;
-    
-    // Schema / Lifecycle
-    init?(objects: any[]): Promise<void>;
-
-    // Advanced
-    aggregate?(objectName: string, query: any, options?: any): Promise<any>;
-    distinct?(objectName: string, field: string, filters?: any, options?: any): Promise<any[]>;
-    
-    // Bulk / Atomic
-    createMany?(objectName: string, data: any[], options?: any): Promise<any>;
-    updateMany?(objectName: string, filters: any, data: any, options?: any): Promise<any>;
-    deleteMany?(objectName: string, filters: any, options?: any): Promise<any>;
-    findOneAndUpdate?(objectName: string, filters: any, update: any, options?: any): Promise<any>;
-
-    // Transaction
-    beginTransaction?(): Promise<any>;
-    commitTransaction?(trx: any): Promise<void>;
-    rollbackTransaction?(trx: any): Promise<void>;
-}
-

package/src/field.ts

@@ -1,149 +0,0 @@
-import { FieldValidation, ValidationAiContext } from './validation';
-
-/**
- * Represents the supported field data types in the ObjectQL schema.
- * These types determine how data is stored, validated, and rendered.
- * 
- * - `text`: Simple string.
- * - `textarea`: Long string.
- * - `select`: Choice from a list.
- * - `lookup`: Relationship to another object.
- */
-export type FieldType = 
-    | 'text' 
-    | 'textarea' 
-    | 'markdown'
-    | 'html' 
-    | 'select' 
-    | 'date' 
-    | 'datetime' 
-    | 'time'
-    | 'number' 
-    | 'currency' 
-    | 'percent'
-    | 'boolean' 
-    | 'email'
-    | 'phone'
-    | 'url'
-    | 'image'
-    | 'file'
-    | 'avatar'
-    | 'location'
-    | 'lookup' 
-    | 'master_detail'  
-    | 'password'
-    | 'formula'
-    | 'summary'
-    | 'auto_number'
-    | 'object'
-    | 'vector'
-    | 'grid';
-
-/**
- * Defines a single option for select/multiselect fields.
- */
-export interface FieldOption {
-    /** The display label for the option. */
-    label: string;
-    /** The actual value stored in the database. */
-    value: string | number;
-}
-
-/**
- * Configuration for a single field on an object.
- * This defines the schema, validation rules, and UI hints for the attribute.
- */
-export interface FieldConfig {
-    /** 
-     * The unique API name of the field. 
-     * If defined within an object map, this is often automatically populated from the key.
-     */
-    name?: string;
-    
-    /** The human-readable label used in UIs. */
-    label?: string;
-
-    /** Description of the field for documentation or tooltip. */
-    description?: string;
-    
-    /** The data type of the field. */
-    type: FieldType;
-    
-    /** Whether the field is mandatory. Defaults to false. */
-    required?: boolean;
-
-    /** Whether the field is unique in the table. */
-    unique?: boolean;
-
-    /** Whether to create a database index for this field. */
-    index?: boolean;
-
-    /** Whether the field is read-only in UI. */
-    readonly?: boolean;
-
-    /** Whether the field is hidden from default UI/API response. */
-    hidden?: boolean;
-    
-    /** The default value if not provided during creation. */
-    defaultValue?: any;
-
-    /** Tooltip or help text for the user. */
-    help_text?: string;
-    
-    /** 
-     * Whether the field allows multiple values. 
-     * Supported by 'select', 'lookup', 'file', 'image'.
-     */
-    multiple?: boolean;
-    
-    /** 
-     * Options for select fields.
-     * List of available choices for select/multiselect fields.
-     */
-    options?: FieldOption[];
-    
-    /**
-     * Reference to another object for lookup/master_detail fields.
-     * Specifies the target object name for relationship fields.
-     */
-    reference_to?: string;
-    
-    // Validation properties
-    /** Minimum for number/currency/percent. */
-    min?: number;
-    /** Maximum for number/currency/percent. */
-    max?: number;
-    /** Minimum length for text based fields. */
-    min_length?: number;
-    /** Maximum length for text based fields. */
-    max_length?: number;
-    /** Regular expression pattern for validation. */
-    regex?: string;
-    
-    /** 
-     * Field validation configuration.
-     * Defines validation rules applied at the field level.
-     */
-    validation?: FieldValidation;
-    
-    /**
-     * AI context for the field.
-     * Provides semantic information for AI tools.
-     */
-    ai_context?: ValidationAiContext;
-
-    // Vector properties
-    /** Dimension of the vector for 'vector' type fields. */
-    dimension?: number;
-
-    // Formula & Summary
-    /** 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/src/hook.ts

@@ -1,131 +0,0 @@
-import { UnifiedQuery } from "./query";
-
-/**
- * Standard CRUD operations supported by hooks.
- */
-export type HookOperation = 'find' | 'count' | 'create' | 'update' | 'delete';
-
-/**
- * Execution timing relative to the database operation.
- */
-export type HookTiming = 'before' | 'after';
-
-/**
- * Minimal API surface exposed to hooks for performing side-effects or checks.
- */
-export interface HookAPI {
-    // We use 'any' here to avoid circular dependencies with core/ObjectQL
-    // In practice, this is the ObjectQL instance.
-    find(objectName: string, query?: any): Promise<any[]>;
-    findOne(objectName: string, id: string | number): Promise<any>;
-    count(objectName: string, query?: any): Promise<number>;
-    create(objectName: string, data: any): Promise<any>;
-    update(objectName: string, id: string | number, data: any): Promise<any>;
-    delete(objectName: string, id: string | number): Promise<any>;
-}
-
-/**
- * Base context available in all hooks.
- */
-export interface BaseHookContext<T = any> {
-    /** The name of the object (entity) being acted upon. */
-    objectName: string;
-    
-    /** The triggering operation. */
-    operation: HookOperation;
-    
-    /** Access to the database/engine to perform extra queries. */
-    api: HookAPI;
-    
-    /** User/Session context (Authentication info). */
-    user?: {
-        id: string | number;
-        [key: string]: any;
-    };
-
-    /** 
-     * Shared state for passing data between matching 'before' and 'after' hooks.
-     * e.g. Calculate a diff in 'beforeUpdate' and read it in 'afterUpdate'.
-     */
-    state: Record<string, any>;
-}
-
-/**
- * Context for Retrieval operations (Find, Count).
- */
-export interface RetrievalHookContext<T = any> extends BaseHookContext<T> {
-    operation: 'find' | 'count';
-    
-    /** The query criteria being executed. Modifiable in 'before' hooks. */
-    query: any;
-    
-    /** The result of the query. Only available in 'after' hooks. */
-    result?: T[] | number;
-}
-
-/**
- * Context for Modification operations (Create, Update, Delete).
- */
-export interface MutationHookContext<T = any> extends BaseHookContext<T> {
-    operation: 'create' | 'update' | 'delete';
-    
-    /** The record ID. Undefined for 'create'. */
-    id?: string | number;
-    
-    /** 
-     * The incoming data changes. 
-     * - For 'create': The full object to insert.
-     * - For 'update': The partial fields to update.
-     * - For 'delete': Undefined.
-     */
-    data?: Partial<T>;
-
-    /**
-     * The final result record from the database.
-     * Only available in 'after' hooks.
-     */
-    result?: T;
-
-    /**
-     * The existing record fetched from DB before operation.
-     * Available in 'update' and 'delete' hooks.
-     */
-    previousData?: T;
-}
-
-/**
- * Specialized context for Updates, including change tracking.
- */
-export interface UpdateHookContext<T = any> extends MutationHookContext<T> {
-    operation: 'update';
-    
-    /**
-     * Helper to check if a specific field is being modified.
-     * Checks if the field exists in 'data' AND is different from 'previousData'.
-     */
-    isModified(field: keyof T): boolean;
-}
-
-/**
- * Definition interface for a set of hooks for a specific object.
- */
-export interface ObjectHookDefinition<T = any> {
-    beforeFind?: (ctx: RetrievalHookContext<T>) => Promise<void> | void;
-    afterFind?: (ctx: RetrievalHookContext<T>) => Promise<void> | void;
-    
-    beforeCount?: (ctx: RetrievalHookContext<T>) => Promise<void> | void;
-    afterCount?: (ctx: RetrievalHookContext<T>) => Promise<void> | void;
-    
-    beforeDelete?: (ctx: MutationHookContext<T>) => Promise<void> | void;
-    afterDelete?: (ctx: MutationHookContext<T>) => Promise<void> | void;
-    
-    beforeCreate?: (ctx: MutationHookContext<T>) => Promise<void> | void;
-    afterCreate?: (ctx: MutationHookContext<T>) => Promise<void> | void;
-    
-    beforeUpdate?: (ctx: UpdateHookContext<T>) => Promise<void> | void;
-    afterUpdate?: (ctx: UpdateHookContext<T>) => Promise<void> | void;
-}
-
-export type HookName = keyof ObjectHookDefinition;
-export type HookContext<T = any> = RetrievalHookContext<T> | MutationHookContext<T> | UpdateHookContext<T>;
-export type HookHandler<T = any> = (ctx: HookContext<T>) => Promise<void> | void;

package/src/index.ts

@@ -1,18 +0,0 @@
-export * from './field';
-export * from './object';
-export * from './driver';
-export * from './query';
-export * from './registry';
-export * from './hook';
-export * from './action';
-export * from './repository';
-export * from './app';
-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/src/loader.ts

@@ -1,17 +0,0 @@
-import { MetadataRegistry } from './registry';
-
-export interface LoaderHandlerContext {
-    file: string;
-    content: string;
-    registry: MetadataRegistry;
-    packageName?: string;
-}
-
-export type LoaderHandler = (ctx: LoaderHandlerContext) => void;
-
-export interface LoaderPlugin {
-    name: string;
-    glob: string[];
-    handler: LoaderHandler;
-    options?: any;
-}

package/src/menu.ts

@@ -1,102 +0,0 @@
-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;
-}