Add example apps for preset usage and audit plugin

Introduces two new example applications: one demonstrating how to use a preset ('app-using-preset') and another showing a custom audit log plugin ('plugin-audit'). Each example includes configuration, TypeScript source, and supporting files. Also updates the project-management tsconfig to exclude its config file.

Author: hotlong

examples/app-using-preset/objectql.config.ts

@@ -0,0 +1,10 @@
+import { ObjectQL } from '@objectql/core';
+import * as path from 'path';
+
+const db = new ObjectQL({
+    connection: `sqlite://${path.join(__dirname, 'preset.sqlite3')}`,
+    // Load the project-management capabilities as a preset
+    presets: ['@example/project-management']
+});
+
+export default db;

examples/app-using-preset/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@example/app-using-preset",
+  "version": "1.0.0",
+  "private": true,
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "repl": "objectql repl"
+  },
+  "dependencies": {
+    "@example/project-management": "workspace:*"
+  },
+  "devDependencies": {
+    "@objectql/core": "workspace:*",
+    "@objectql/types": "workspace:*",
+    "@objectql/cli": "workspace:*",
+    "@objectql/driver-knex": "workspace:*",
+    "sqlite3": "^5.1.7",
+    "typescript": "^5.3.0"
+  }
+}

examples/app-using-preset/src/index.ts

@@ -0,0 +1,23 @@
+import db from '../objectql.config';
+
+async function main() {
+    await db.init();
+    
+    console.log('--- Objects loaded from Preset ---');
+    const objects = db.metadata.list('object');
+    console.log(objects.map(o => o.name));
+    
+    // We can access 'project' because it was loaded from the preset
+    const projectRepo = db.createContext({}).object('project');
+    
+    // Create a project using the preset's definition
+    const project = await projectRepo.create({
+        name: 'Preset Usage Demo',
+        description: 'Created via App Using Preset'
+    });
+    
+    console.log('--- Created Project ---');
+    console.log(project);
+}
+
+main().catch(console.error);

examples/app-using-preset/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": ".",
+    "composite": true
+  },
+  "include": ["src/**/*", "objectql.config.ts"]
+}

examples/plugin-audit/objectql.config.ts

@@ -0,0 +1,13 @@
+import { ObjectQL } from '@objectql/core';
+import * as path from 'path';
+import { AuditLogPlugin } from './src/audit.plugin';
+
+const db = new ObjectQL({
+    connection: `sqlite://${path.join(__dirname, 'audit.sqlite3')}`,
+    source: ['src'],
+    plugins: [
+        new AuditLogPlugin()
+    ]
+});
+
+export default db;

examples/plugin-audit/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@example/plugin-audit",
+  "version": "0.1.0",
+  "private": true,
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "repl": "objectql repl"
+  },
+  "dependencies": {
+    "sqlite3": "^5.1.7"
+  },
+  "devDependencies": {
+     "@objectql/cli": "workspace:*",
+     "@objectql/core": "workspace:*",
+     "@objectql/types": "workspace:*",
+     "@objectql/driver-knex": "workspace:*",
+     "typescript": "^5.3.0"
+  }
+}

examples/plugin-audit/src/audit.plugin.ts

@@ -0,0 +1,23 @@
+import { ObjectQLPlugin, IObjectQL, MutationHookContext } from '@objectql/types';
+
+export class AuditLogPlugin implements ObjectQLPlugin {
+    name = 'audit-log';
+
+    setup(app: IObjectQL) {
+        console.log('[AuditLogPlugin] Setting up...');
+
+        // 1. Listen to all 'afterCreate' events
+        app.on('afterCreate', '*', async (ctx) => {
+            // Narrow down context type or use assertion since 'afterCreate' is Mutation
+            const mutationCtx = ctx as MutationHookContext;
+            const userId = mutationCtx.user?.id || 'Guest';
+            console.log(`[Audit] Created ${mutationCtx.objectName} (ID: ${mutationCtx.id}) by User ${userId}`);
+        });
+
+        // 2. Listen to all 'afterDelete' events
+        app.on('afterDelete', '*', async (ctx) => {
+            const mutationCtx = ctx as MutationHookContext;
+            console.log(`[Audit] Deleted ${mutationCtx.objectName} (ID: ${mutationCtx.id})`);
+        });
+    }
+}

examples/plugin-audit/src/index.ts

@@ -0,0 +1,19 @@
+import db from '../objectql.config';
+
+async function main() {
+    await db.init();
+    
+    const noteRepo = db.createContext({ userId: 'u001' }).object('note');
+
+    console.log('--- Creating Note ---');
+    // Should trigger [Audit] log
+    const note = await noteRepo.create({
+        content: 'Hello Project Plugin!'
+    });
+
+    console.log('--- Deleting Note ---');
+    // Should trigger [Audit] log
+    await noteRepo.delete(note.id);
+}
+
+main().catch(console.error);

examples/plugin-audit/src/note.object.yml

@@ -0,0 +1,4 @@
+name: note
+fields:
+  content:
+    type: text

examples/plugin-audit/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": ".",
+    "composite": true
+  },
+  "include": ["src/**/*", "objectql.config.ts"]
+}