Add support for loading initial data from .data.yml files

Introduces the ability to load and initialize object data from .data.yml files in the project structure. The ObjectQL core now loads these files during configuration, attaches the data to object configs, and provides an init() method to insert initial records if they do not already exist. The Express example server is updated to use this mechanism for seeding data, and the ObjectConfig interface is extended to support a data property.

Author: hotlong

examples/apps/project-management/src/projects.data.yml

@@ -0,0 +1,13 @@
+- _id: PROJ-001
+  name: "Website Redesign (From Data)"
+  description: "Initial data loaded from projects.data.yml"
+  status: "in_progress"
+  priority: "high"
+  owner: "u-123"
+
+- _id: PROJ-002
+  name: "Mobile App (From Data)"
+  description: "Initial data loaded from projects.data.yml"
+  status: "planned"
+  priority: "medium"
+  owner: "u-999"

examples/servers/express/src/index.ts

@@ -5,58 +5,20 @@ import cors from 'cors';
 import * as path from 'path';
 import config from './objectql.config';
 
-const app = new ObjectQL({
+const objectql = new ObjectQL({
   datasources: config.datasources,
   packages: config.packages
 });
 
 console.log(`ObjectQL Server started with ${config.packages.length} packages.`);
 
-const projectObj = app.getObject('projects');
-if (!projectObj) {
-    console.error("Project object not found after loading!");
-}
-
-// Example: Find orders with amount > 1000 and expand customer details
-const query: UnifiedQuery = {
-  fields: ['name', 'status', 'priority'],
-  filters: [
-    ['status', '=', 'in_progress'],
-    'and',
-    ['priority', '=', 'high']
-  ],
-  sort: [['name', 'desc']],
-  // Note: Expansion requires relationship support. 
-  // If 'tasks' looks up 'project', we can query tasks and expand project.
-  // Querying project and expanding tasks usually requires a defined detail relationship.
-  // Keeping simplified for now.
-};
-
-
 (async () => {
     try {
         console.log("Starting server...");
 
-        // --- 1. Seed Data (Optional, reused from previous logic) ---
-        // Create some dummy data (System context to bypass hooks/setup data)
-        const systemCtx = app.createContext({ isSystem: true });
-        
-        try {
-            await systemCtx.object('projects').create({
-                name: 'Website Redesign',
-                status: 'in_progress',
-                priority: 'high',
-                owner: 'u-123'
-            });
-             await systemCtx.object('projects').create({
-                name: 'Mobile App',
-                status: 'planned',
-                priority: 'high',
-                owner: 'u-999'
-            });
-        } catch (e) {
-            console.log("Error seeding data (might already exist):", e);
-        }
+        // --- 1. Init Data (from .data.yml) ---
+        await objectql.init();
+
 
         // --- 2. Start Express Server ---
         const server = express();
@@ -69,7 +31,7 @@ const query: UnifiedQuery = {
         // Mount ObjectQL API
         // Example: /api/projects
         server.use('/api', createObjectQLRouter({
-            objectql: app,
+            objectql: objectql,
             swagger: {
                 enabled: true,
                 path: '/docs'
@@ -78,9 +40,9 @@ const query: UnifiedQuery = {
                 // Simulate Authentication: Read User ID from header
                 const userId = req.headers['x-user-id'] as string;
                 if (userId === 'admin') {
-                     return app.createContext({ isSystem: true });
+                     return objectql.createContext({ isSystem: true });
                 }
-                return app.createContext({
+                return objectql.createContext({
                     userId: userId || undefined
                 });
             }

examples/servers/express/src/objectql.config.ts

@@ -1,5 +1,4 @@
 import { MongoDriver } from '@objectql/driver-mongo';
-import path from 'path';
 
 export default {
     datasources: {

packages/core/src/index.ts

@@ -120,4 +120,29 @@ export class ObjectQL implements IObjectQL {
         }
         return driver;
     }
+
+    async init() {
+        const ctx = this.createContext({ isSystem: true });
+        for (const objectName in this.objects) {
+            const obj = this.objects[objectName];
+            if (obj.data && obj.data.length > 0) {
+                console.log(`Initializing data for object ${objectName}...`);
+                const repo = ctx.object(objectName);
+                for (const record of obj.data) {
+                    try {
+                        if (record._id) {
+                             const existing = await repo.findOne(record._id);
+                             if (existing) {
+                                 continue;
+                             }
+                        }
+                        await repo.create(record);
+                        console.log(`Inserted init data for ${objectName}: ${record._id || 'unknown id'}`);
+                    } catch (e) {
+                        console.error(`Failed to insert init data for ${objectName}:`, e);
+                    }
+                }
+            }
+        }
+    }
 }

packages/core/src/loader.ts

@@ -115,7 +115,41 @@ export function loadObjectConfigs(dir: string): Record<string, ObjectConfig> {
         }
     }
 
-    // 3. Load Actions (.action.js, .action.ts)
+    // 3. Load Data (.data.yml, .data.yaml)
+    const dataFiles = glob.sync(['**/*.data.yml', '**/*.data.yaml'], {
+        cwd: dir,
+        absolute: true
+    });
+
+    for (const file of dataFiles) {
+        try {
+            const content = fs.readFileSync(file, 'utf8');
+            const data = yaml.load(content);
+
+            if (!Array.isArray(data)) {
+                console.warn(`Data file ${file} does not contain an array. Skipping.`);
+                continue;
+            }
+
+            // Guess object name from filename
+            // project.data.yml -> project
+            const basename = path.basename(file);
+            const objectName = basename.replace(/\.data\.ya?ml$/, '');
+
+            if (configs[objectName]) {
+                configs[objectName].data = data;
+            } else {
+                // Maybe the object config hasn't been found yet? 
+                // loadObjectConfigs runs glob for objects first, so configs should be populated.
+                console.warn(`Found data for unknown object '${objectName}' in ${file}`);
+            }
+
+        } catch (e) {
+            console.error(`Error loading data from ${file}:`, e);
+        }
+    }
+
+    // 4. Load Actions (.action.js, .action.ts)
     const actionFiles = glob.sync(['**/*.action.{js,ts}'], {
         cwd: dir,
         absolute: true

packages/core/src/metadata.ts

@@ -1,4 +1,3 @@
-
 /**
  * Represents the supported field data types in the ObjectQL schema.
  * These types determine how data is stored, validated, and rendered.
@@ -138,4 +137,7 @@ export interface ObjectConfig {
 
     /** Lifecycle hooks. */
     listeners?: ObjectListeners;
+
+    /** Initial data to populate when system starts. */
+    data?: any[];
 }

packages/core/src/types.ts

@@ -15,6 +15,7 @@ export interface IObjectQL {
     getObject(name: string): ObjectConfig | undefined;
     getConfigs(): Record<string, ObjectConfig>;
     datasource(name: string): Driver;
+    init(): Promise<void>;
 }
 
 export interface HookContext<T = any> {