@objectstack/metadata 0.8.1 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @objectstack/metadata
 
+## 0.8.2
+
+### Patch Changes
+
+- Updated dependencies [555e6a7]
+  - @objectstack/spec@0.8.2
+  - @objectstack/core@0.8.2
+  - @objectstack/types@0.8.2
+
 ## 0.8.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,11 +4,13 @@
  * Metadata loading, saving, and persistence for ObjectStack
  */
 export { MetadataManager, type WatchCallback } from './metadata-manager.js';
+export { MetadataPlugin } from './plugin.js';
 export { type MetadataLoader } from './loaders/loader-interface.js';
 export { FilesystemLoader } from './loaders/filesystem-loader.js';
 export { type MetadataSerializer, type SerializeOptions } from './serializers/serializer-interface.js';
 export { JSONSerializer } from './serializers/json-serializer.js';
 export { YAMLSerializer } from './serializers/yaml-serializer.js';
+export * as Migration from './migration/index.js';
 export { TypeScriptSerializer } from './serializers/typescript-serializer.js';
 export type { MetadataFormat, MetadataStats, MetadataLoadOptions, MetadataSaveOptions, MetadataExportOptions, MetadataImportOptions, MetadataLoadResult, MetadataSaveResult, MetadataWatchEvent, MetadataCollectionInfo, MetadataLoaderContract, MetadataManagerConfig, } from '@objectstack/spec/system';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAG5E,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAGlE,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACvG,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAG9E,YAAY,EACV,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAG5E,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAG7C,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAGlE,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACvG,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAG9E,YAAY,EACV,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,0BAA0B,CAAC"}

package/dist/index.js

@@ -5,7 +5,10 @@
  */
 // Main Manager
 export { MetadataManager } from './metadata-manager.js';
+// Plugin
+export { MetadataPlugin } from './plugin.js';
 export { FilesystemLoader } from './loaders/filesystem-loader.js';
 export { JSONSerializer } from './serializers/json-serializer.js';
 export { YAMLSerializer } from './serializers/yaml-serializer.js';
+export * as Migration from './migration/index.js';
 export { TypeScriptSerializer } from './serializers/typescript-serializer.js';

package/dist/migration/executor.d.ts

@@ -0,0 +1,9 @@
+import { System } from '@objectstack/spec';
+import { ISchemaDriver } from '@objectstack/spec/contracts';
+export declare class MigrationExecutor {
+    private driver;
+    constructor(driver: ISchemaDriver);
+    executeChangeSet(changeSet: System.ChangeSet): Promise<void>;
+    private executeOperation;
+}
+//# sourceMappingURL=executor.d.ts.map

package/dist/migration/executor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor.d.ts","sourceRoot":"","sources":["../../src/migration/executor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,qBAAa,iBAAiB;IAChB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,aAAa;IAEnC,gBAAgB,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;YAapD,gBAAgB;CAgC/B"}

package/dist/migration/executor.js

@@ -0,0 +1,49 @@
+export class MigrationExecutor {
+    constructor(driver) {
+        this.driver = driver;
+    }
+    async executeChangeSet(changeSet) {
+        console.log(`Executing ChangeSet: ${changeSet.name} (${changeSet.id})`);
+        for (const op of changeSet.operations) {
+            try {
+                await this.executeOperation(op);
+            }
+            catch (e) {
+                console.error(`Failed to execute operation ${op.type}:`, e);
+                throw e;
+            }
+        }
+    }
+    async executeOperation(op) {
+        switch (op.type) {
+            case 'create_object':
+                console.log(`  > Create Object: ${op.object.name}`);
+                await this.driver.createCollection(op.object.name, op.object);
+                break;
+            case 'add_field':
+                console.log(`  > Add Field: ${op.objectName}.${op.fieldName}`);
+                await this.driver.addColumn(op.objectName, op.fieldName, op.field);
+                break;
+            case 'remove_field':
+                console.log(`  > Remove Field: ${op.objectName}.${op.fieldName}`);
+                await this.driver.dropColumn(op.objectName, op.fieldName);
+                break;
+            case 'delete_object':
+                console.log(`  > Delete Object: ${op.objectName}`);
+                await this.driver.dropCollection(op.objectName);
+                break;
+            case 'execute_sql':
+                console.log(`  > Execute SQL`);
+                await this.driver.executeRaw(op.sql);
+                break;
+            case 'modify_field':
+                console.warn(`  ! Modify Field: ${op.objectName}.${op.fieldName} (Not fully implemented)`);
+                break;
+            case 'rename_object':
+                console.warn(`  ! Rename Object: ${op.oldName} -> ${op.newName} (Not fully implemented)`);
+                break;
+            default:
+                throw new Error(`Unknown operation type`);
+        }
+    }
+}

package/dist/migration/index.d.ts

@@ -0,0 +1,2 @@
+export * from './executor.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/migration/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migration/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/migration/index.js

@@ -0,0 +1 @@
+export * from './executor.js';

package/dist/plugin.d.ts

@@ -0,0 +1,15 @@
+import { Plugin, PluginContext } from '@objectstack/core';
+export interface MetadataPluginOptions {
+    rootDir?: string;
+    watch?: boolean;
+}
+export declare class MetadataPlugin implements Plugin {
+    name: string;
+    version: string;
+    private manager;
+    private options;
+    constructor(options?: MetadataPluginOptions);
+    init(ctx: PluginContext): Promise<void>;
+    start(ctx: PluginContext): Promise<void>;
+}
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAI1D,MAAM,WAAW,qBAAqB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,qBAAa,cAAe,YAAW,MAAM;IACzC,IAAI,SAA8B;IAClC,OAAO,SAAW;IAElB,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,OAAO,CAAwB;gBAE3B,OAAO,GAAE,qBAA0B;IAezC,IAAI,CAAC,GAAG,EAAE,aAAa;IAQvB,KAAK,CAAC,GAAG,EAAE,aAAa;CAiDjC"}

package/dist/plugin.js

@@ -0,0 +1,71 @@
+import { MetadataManager } from './metadata-manager.js';
+import { ObjectStackDefinitionSchema } from '@objectstack/spec';
+export class MetadataPlugin {
+    constructor(options = {}) {
+        this.name = 'com.objectstack.metadata';
+        this.version = '1.0.0';
+        this.options = {
+            watch: true,
+            ...options
+        };
+        const rootDir = this.options.rootDir || process.cwd();
+        this.manager = new MetadataManager({
+            rootDir,
+            watch: this.options.watch ?? true,
+            formats: ['yaml', 'json', 'typescript', 'javascript']
+        });
+    }
+    async init(ctx) {
+        ctx.logger.info('Initializing Metadata Manager', { root: this.options.rootDir || process.cwd() });
+        // Register Metadata Manager as a service
+        // This allows other plugins to query raw metadata or listen to changes
+        ctx.registerService('metadata', this.manager);
+    }
+    async start(ctx) {
+        ctx.logger.info('Loading metadata...');
+        // Define metadata types directly from the Protocol Definition
+        // This ensures the loader is always in sync with the Spec
+        const metadataTypes = Object.keys(ObjectStackDefinitionSchema.shape)
+            .filter(key => key !== 'manifest'); // Manifest is handled separately
+        for (const type of metadataTypes) {
+            try {
+                // Try to load metadata of this type
+                const items = await this.manager.loadMany(type, {
+                    recursive: true
+                });
+                if (items.length > 0) {
+                    ctx.logger.info(`Loaded ${items.length} ${type}`);
+                    // Helper: Register with ObjectQL Registry
+                    const ql = ctx.getService('objectql');
+                    if (ql && ql.registry) {
+                        items.forEach((item) => {
+                            // Determine key field (id or name)
+                            const keyField = item.id ? 'id' : 'name';
+                            // Map plural type to singular/registry type if needed
+                            // For now, we use the singular form for standard types: 
+                            // objects -> object, apps -> app, etc.
+                            // But Registry seems to accept arbitrary strings.
+                            // To match Protocol standard, we might want to normalize.
+                            // Let's use the directory name (plural) as the type for now,
+                            // OR map 'objects' -> 'object' specifically.
+                            let registryType = type;
+                            if (type === 'objects')
+                                registryType = 'object';
+                            if (type === 'apps')
+                                registryType = 'app';
+                            if (type === 'plugins')
+                                registryType = 'plugin';
+                            if (type === 'functions')
+                                registryType = 'function';
+                            ql.registry.registerItem(registryType, item, keyField);
+                        });
+                    }
+                }
+            }
+            catch (e) {
+                // Ignore missing directories or errors
+                // ctx.logger.debug(`No metadata found for type: ${type}`);
+            }
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@objectstack/metadata",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Metadata loading, saving, and persistence for ObjectStack",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -16,9 +16,9 @@
     "js-yaml": "^4.1.0",
     "chokidar": "^3.5.3",
     "zod": "^4.3.6",
-    "@objectstack/core": "0.8.1",
-    "@objectstack/spec": "0.8.1",
-    "@objectstack/types": "0.8.1"
+    "@objectstack/core": "0.9.0",
+    "@objectstack/spec": "0.9.0",
+    "@objectstack/types": "0.9.0"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",

package/src/index.ts

@@ -7,6 +7,9 @@
 // Main Manager
 export { MetadataManager, type WatchCallback } from './metadata-manager.js';
 
+// Plugin
+export { MetadataPlugin } from './plugin.js';
+
 // Loaders
 export { type MetadataLoader } from './loaders/loader-interface.js';
 export { FilesystemLoader } from './loaders/filesystem-loader.js';
@@ -15,6 +18,7 @@ export { FilesystemLoader } from './loaders/filesystem-loader.js';
 export { type MetadataSerializer, type SerializeOptions } from './serializers/serializer-interface.js';
 export { JSONSerializer } from './serializers/json-serializer.js';
 export { YAMLSerializer } from './serializers/yaml-serializer.js';
+export * as Migration from './migration/index.js';
 export { TypeScriptSerializer } from './serializers/typescript-serializer.js';
 
 // Re-export types from spec

package/src/migration/executor.ts

@@ -0,0 +1,52 @@
+import { System } from '@objectstack/spec';
+import { ISchemaDriver } from '@objectstack/spec/contracts';
+
+export class MigrationExecutor {
+  constructor(private driver: ISchemaDriver) {}
+
+  async executeChangeSet(changeSet: System.ChangeSet): Promise<void> {
+    console.log(`Executing ChangeSet: ${changeSet.name} (${changeSet.id})`);
+    
+    for (const op of changeSet.operations) {
+      try {
+        await this.executeOperation(op);
+      } catch (e) {
+        console.error(`Failed to execute operation ${op.type}:`, e);
+        throw e;
+      }
+    }
+  }
+
+  private async executeOperation(op: System.MigrationOperation): Promise<void> {
+    switch (op.type) {
+      case 'create_object':
+        console.log(`  > Create Object: ${op.object.name}`);
+        await this.driver.createCollection(op.object.name, op.object);
+        break;
+      case 'add_field':
+        console.log(`  > Add Field: ${op.objectName}.${op.fieldName}`);
+        await this.driver.addColumn(op.objectName, op.fieldName, op.field);
+        break;
+      case 'remove_field':
+        console.log(`  > Remove Field: ${op.objectName}.${op.fieldName}`);
+        await this.driver.dropColumn(op.objectName, op.fieldName);
+        break;
+      case 'delete_object':
+        console.log(`  > Delete Object: ${op.objectName}`);
+        await this.driver.dropCollection(op.objectName);
+        break;
+      case 'execute_sql':
+        console.log(`  > Execute SQL`);
+        await this.driver.executeRaw(op.sql);
+        break;
+      case 'modify_field':
+        console.warn(`  ! Modify Field: ${op.objectName}.${op.fieldName} (Not fully implemented)`);
+        break;
+      case 'rename_object':
+        console.warn(`  ! Rename Object: ${op.oldName} -> ${op.newName} (Not fully implemented)`);
+        break;
+      default:
+        throw new Error(`Unknown operation type`);
+    }
+  }
+}

package/src/migration/index.ts

@@ -0,0 +1 @@
+export * from './executor.js';

package/src/plugin.ts

@@ -0,0 +1,89 @@
+import { Plugin, PluginContext } from '@objectstack/core';
+import { MetadataManager } from './metadata-manager.js';
+import { ObjectStackDefinitionSchema } from '@objectstack/spec';
+
+export interface MetadataPluginOptions {
+    rootDir?: string;
+    watch?: boolean;
+}
+
+export class MetadataPlugin implements Plugin {
+    name = 'com.objectstack.metadata';
+    version = '1.0.0';
+    
+    private manager: MetadataManager;
+    private options: MetadataPluginOptions;
+
+    constructor(options: MetadataPluginOptions = {}) {
+        this.options = {
+            watch: true,
+            ...options
+        };
+
+        const rootDir = this.options.rootDir || process.cwd();
+
+        this.manager = new MetadataManager({ 
+            rootDir,
+            watch: this.options.watch ?? true,
+            formats: ['yaml', 'json', 'typescript', 'javascript'] 
+        });
+    }
+
+    async init(ctx: PluginContext) {
+        ctx.logger.info('Initializing Metadata Manager', { root: this.options.rootDir || process.cwd() });
+        
+        // Register Metadata Manager as a service
+        // This allows other plugins to query raw metadata or listen to changes
+        ctx.registerService('metadata', this.manager);
+    }
+
+    async start(ctx: PluginContext) {
+        ctx.logger.info('Loading metadata...');
+        
+        // Define metadata types directly from the Protocol Definition
+        // This ensures the loader is always in sync with the Spec
+        const metadataTypes = Object.keys(ObjectStackDefinitionSchema.shape)
+            .filter(key => key !== 'manifest'); // Manifest is handled separately
+
+        for (const type of metadataTypes) {
+            try {
+                // Try to load metadata of this type
+                const items = await this.manager.loadMany(type, {
+                    recursive: true
+                });
+
+                if (items.length > 0) {
+                     ctx.logger.info(`Loaded ${items.length} ${type}`);
+                     
+                     // Helper: Register with ObjectQL Registry
+                     const ql = ctx.getService('objectql') as any;
+                     if (ql && ql.registry) {
+                        items.forEach((item: any) => {
+                            // Determine key field (id or name)
+                            const keyField = item.id ? 'id' : 'name';
+                            
+                            // Map plural type to singular/registry type if needed
+                            // For now, we use the singular form for standard types: 
+                            // objects -> object, apps -> app, etc.
+                            // But Registry seems to accept arbitrary strings.
+                            // To match Protocol standard, we might want to normalize.
+                            // Let's use the directory name (plural) as the type for now,
+                            // OR map 'objects' -> 'object' specifically.
+                            
+                            let registryType = type;
+                            if (type === 'objects') registryType = 'object';
+                            if (type === 'apps') registryType = 'app';
+                            if (type === 'plugins') registryType = 'plugin';
+                            if (type === 'functions') registryType = 'function';
+                            
+                            ql.registry.registerItem(registryType, item, keyField);
+                        });
+                     }
+                }
+            } catch (e: any) {
+                // Ignore missing directories or errors
+                // ctx.logger.debug(`No metadata found for type: ${type}`);
+            }
+        }
+    }
+}