@specverse/engines 6.5.4 → 6.7.8

package/libs/instance-factories/services/templates/mongodb-native/client-generator.ts

@@ -0,0 +1,51 @@
+/**
+ * MongoDB Native Driver — client singleton
+ *
+ * Emits a small connection module shared by all controllers and services.
+ * Collection naming convention: lowercase + 's' suffix (User → users,
+ * Category → categorys), matching the lowercase-pluralized scheme declared
+ * in the factory yaml. Models with custom collection names can override
+ * via spec — the controller-generator looks at `model.storage?.collection`.
+ */
+import type { TemplateContext } from '@specverse/types';
+
+export default function generateMongoClient(_context: TemplateContext): string {
+  return `/**
+ * MongoDB native driver — singleton client + helpers.
+ *
+ * Picks up MONGODB_URI / MONGODB_DB from the environment. The client is
+ * lazily initialised on first use and reused across requests; \`disconnect\`
+ * is exposed for graceful-shutdown wiring.
+ */
+import { MongoClient, type Db, type Collection, type Document } from 'mongodb';
+
+const uri = process.env.MONGODB_URI || 'mongodb://localhost:27017';
+const dbName = process.env.MONGODB_DB || 'specverse';
+
+let client: MongoClient | null = null;
+let database: Db | null = null;
+
+export async function getDb(): Promise<Db> {
+  if (database) return database;
+  client = new MongoClient(uri);
+  await client.connect();
+  database = client.db(dbName);
+  return database;
+}
+
+export async function getCollection<T extends Document = Document>(
+  name: string,
+): Promise<Collection<T>> {
+  const db = await getDb();
+  return db.collection<T>(name);
+}
+
+export async function disconnect(): Promise<void> {
+  if (client) {
+    await client.close();
+    client = null;
+    database = null;
+  }
+}
+`;
+}

package/libs/instance-factories/services/templates/mongodb-native/controller-generator.ts

@@ -0,0 +1,319 @@
+/**
+ * MongoDB Native Driver — Controller Generator
+ *
+ * Generates per-model controllers exposing CURVED operations via the native
+ * MongoDB driver (collection-level insertOne / findOne / updateOne / deleteOne).
+ *
+ * Scope (MVP — TODO #43):
+ *   - Validate / Create / Retrieve / Update / Delete fully wired
+ *   - Evolve emits a lifecycle-aware update when the model declares states;
+ *     transitions are validated against the declared flow before update
+ *   - Custom actions emit AI-behavior stubs (callable, but the body is left
+ *     as a TODO with the spec steps inline) — same pattern Prisma uses
+ *
+ * Out of scope here (deferred follow-up TODOs):
+ *   - $transaction wrapping for multi-document writes (MongoDB sessions)
+ *   - Aggregation-pipeline-driven retrieve variants (joins via $lookup)
+ *   - Inline behavior-step → driver-call generation parity with the
+ *     prisma step-conventions library
+ *
+ * Collection naming: lowercase + 's' (User → users) unless the model
+ * declares `storage.collection`. ID field is ObjectId-aware: a 24-hex
+ * string is parsed via `new ObjectId(id)`; anything else is kept as-is so
+ * specs that use string ids (UUIDs, slugs) keep working unchanged.
+ */
+import type { TemplateContext } from '@specverse/types';
+import { buildTransitionMap, isAutoField } from '@specverse/types/spec-rules';
+
+export default function generateMongoNativeController(context: TemplateContext): string {
+  const { controller, model } = context;
+  if (!controller) throw new Error('Controller is required in template context');
+  if (!model) throw new Error('Model is required for controller generation');
+
+  const controllerName = controller.name;
+  const modelName = model.name;
+  const modelVar = lowerFirst(modelName);
+  const collection = collectionName(model);
+  const curedOps = controller.cured || {};
+
+  const customActions = generateCustomActions(controller);
+
+  const validate = generateValidateMethod(model, modelName);
+  const create = curedOps.create ? generateCreateMethod(model, modelName, modelVar, collection) : '';
+  const retrieve = curedOps.retrieve ? generateRetrieveMethod(modelName, modelVar, collection) : '';
+  const update = curedOps.update ? generateUpdateMethod(modelName, modelVar, collection) : '';
+  const evolve = curedOps.evolve ? generateEvolveMethod(model, modelName, modelVar, collection) : '';
+  const del = curedOps.delete ? generateDeleteMethod(modelName, modelVar, collection) : '';
+
+  const hasEventPublishing =
+    curedOps.create || curedOps.update || curedOps.evolve || curedOps.delete;
+
+  return `/**
+ * ${controllerName}
+ * Model-specific business logic for ${modelName} (MongoDB native driver)
+ * ${controller.description || ''}
+ */
+import { ObjectId, type Filter, type Document } from 'mongodb';
+import { getCollection } from '../db/mongoClient.js';
+${hasEventPublishing ? `import { eventBus } from '../events/eventBus.js';` : ''}
+
+const COLLECTION_NAME = '${collection}';
+
+/** Parse an id string to the value the collection expects: ObjectId for
+ * 24-hex-character ids, otherwise pass-through (UUIDs, slugs, ints-as-string). */
+function parseId(id: string): ObjectId | string {
+  if (typeof id === 'string' && /^[a-fA-F0-9]{24}$/.test(id)) return new ObjectId(id);
+  return id;
+}
+
+/** _id-aware filter builder. */
+function byId(id: string): Filter<Document> {
+  return { _id: parseId(id) as any };
+}
+
+export class ${controllerName} {
+${validate}
+${create}
+${retrieve}
+${update}
+${evolve}
+${del}
+${customActions.code}
+}
+
+export const ${modelVar}Controller = new ${controllerName}();
+export default ${modelVar}Controller;
+`;
+}
+
+function lowerFirst(s: string): string {
+  return s.charAt(0).toLowerCase() + s.slice(1);
+}
+
+function collectionName(model: any): string {
+  if (model?.storage?.collection) return String(model.storage.collection);
+  // Lowercase-pluralized: User → users, OrderItem → orderitems
+  return model.name.toLowerCase() + 's';
+}
+
+function generateValidateMethod(model: any, modelName: string): string {
+  return `
+  /**
+   * Validate ${modelName} data — runs before create / update / evolve.
+   */
+  public validate(
+    _data: any,
+    _context: { operation: 'create' | 'update' | 'evolve' }
+  ): { valid: boolean; errors: string[] } {
+    const errors: string[] = [];
+${generateValidationLogic(model)}
+    return { valid: errors.length === 0, errors };
+  }
+`;
+}
+
+function generateValidationLogic(model: any): string {
+  if (!model.attributes) return '    // No validation rules defined';
+  const attrList = Array.isArray(model.attributes)
+    ? model.attributes.map((a: any) => [a.name, a])
+    : Object.entries(model.attributes);
+  const out: string[] = [];
+  attrList.forEach(([name, attr]: [string, any]) => {
+    if (attr.required && !isAutoField(name, attr)) {
+      out.push(`    if (_context.operation === 'create' && !_data.${name}) errors.push('${name} is required');`);
+    }
+    if (attr.type === 'String' || attr.type === 'string') {
+      if (attr.min) out.push(`    if (_data.${name} && _data.${name}.length < ${attr.min}) errors.push('${name} must be at least ${attr.min} characters');`);
+      if (attr.max) out.push(`    if (_data.${name} && _data.${name}.length > ${attr.max}) errors.push('${name} must be at most ${attr.max} characters');`);
+    }
+    if (attr.values && Array.isArray(attr.values)) {
+      const values = attr.values.map((v: string) => `'${v}'`).join(', ');
+      out.push(`    if (_data.${name} && ![${values}].includes(_data.${name})) errors.push('${name} must be one of: ${attr.values.join(', ')}');`);
+    }
+    if (attr.format === 'email') {
+      out.push(`    if (_data.${name} && !/^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/.test(_data.${name})) errors.push('${name} must be a valid email address');`);
+    }
+  });
+  return out.join('\n') || '    // No validation rules defined';
+}
+
+function generateCreateMethod(model: any, modelName: string, modelVar: string, collection: string): string {
+  return `
+  /**
+   * Create a new ${modelName}.
+   */
+  public async create(data: any): Promise<any> {
+    const validation = this.validate(data, { operation: 'create' });
+    if (!validation.valid) throw new Error(\`Validation failed: \${validation.errors.join(', ')}\`);
+
+    const collection = await getCollection(COLLECTION_NAME);
+    const result = await collection.insertOne({ ...data });
+    const ${modelVar} = { _id: result.insertedId, ...data };
+
+    await eventBus.publish('${modelName}Created', { ...${modelVar}, timestamp: new Date().toISOString() } as any);
+    return ${modelVar};
+  }
+`;
+}
+
+function generateRetrieveMethod(modelName: string, modelVar: string, collection: string): string {
+  return `
+  /**
+   * Retrieve ${modelName} by id. Returns null when not found.
+   */
+  public async retrieve(id: string): Promise<any | null> {
+    const collection = await getCollection(COLLECTION_NAME);
+    return await collection.findOne(byId(id));
+  }
+
+  /**
+   * Retrieve a page of ${modelName}s.
+   */
+  public async retrieveAll(options: { skip?: number; take?: number } = {}): Promise<any[]> {
+    const collection = await getCollection(COLLECTION_NAME);
+    const cursor = collection.find({});
+    if (options.skip) cursor.skip(options.skip);
+    if (options.take) cursor.limit(options.take);
+    return await cursor.toArray();
+  }
+`;
+}
+
+function generateUpdateMethod(modelName: string, modelVar: string, collection: string): string {
+  return `
+  /**
+   * Update ${modelName}.
+   */
+  public async update(id: string, data: any): Promise<any> {
+    const validation = this.validate(data, { operation: 'update' });
+    if (!validation.valid) throw new Error(\`Validation failed: \${validation.errors.join(', ')}\`);
+
+    // Strip nested objects + id — only scalar fields are written.
+    const updateData: any = {};
+    for (const [key, value] of Object.entries(data)) {
+      if (key === 'id' || key === '_id') continue;
+      if (Array.isArray(value)) continue;
+      if (value !== null && typeof value === 'object' && !(value instanceof Date)) continue;
+      updateData[key] = value;
+    }
+
+    const collection = await getCollection(COLLECTION_NAME);
+    await collection.updateOne(byId(id), { $set: updateData });
+    const ${modelVar} = await collection.findOne(byId(id));
+    if (!${modelVar}) throw new Error('${modelName} not found after update');
+
+    await eventBus.publish('${modelName}Updated', { ...${modelVar}, timestamp: new Date().toISOString() } as any);
+    return ${modelVar};
+  }
+`;
+}
+
+function generateEvolveMethod(model: any, modelName: string, modelVar: string, collection: string): string {
+  const lifecycles = Array.isArray(model.lifecycles)
+    ? model.lifecycles
+    : (model.lifecycles ? Object.entries(model.lifecycles).map(([name, lc]: [string, any]) => ({ name, ...lc })) : []);
+  const lifecycle = lifecycles[0];
+  const lifecycleName = lifecycle?.name || 'status';
+  const validTransitions = lifecycle ? buildTransitionMap(lifecycle) : {};
+  // Derive states from the transition map when the spec used `flow:` shorthand
+  // (states is undefined on the wire, but buildTransitionMap expands the flow).
+  const states = lifecycle?.states && lifecycle.states.length > 0
+    ? lifecycle.states.map((s: any) => typeof s === 'string' ? s : s.name)
+    : Array.from(new Set([
+        ...Object.keys(validTransitions),
+        ...Object.values(validTransitions).flat(),
+      ]));
+
+  return `
+  /**
+   * Evolve ${modelName} through lifecycle "${lifecycleName}"
+   * States: ${states.join(' → ') || '(none declared)'}
+   */
+  public async evolve(id: string, data: any): Promise<any> {
+    const collection = await getCollection(COLLECTION_NAME);
+    const current = await collection.findOne(byId(id));
+    if (!current) throw new Error('${modelName} not found');
+
+    const targetLifecycle = data?.lifecycleName || '${lifecycleName}';
+    const targetState = data?.toState ?? data?.state ?? data?.[targetLifecycle];
+    if (!targetState) throw new Error('evolve requires toState (or ${lifecycleName}) in the request body');
+
+    ${states.length > 0 ? `
+    const currentState = (current as any)[targetLifecycle];
+    const validTransitions: Record<string, string[]> = ${JSON.stringify(validTransitions)};
+    const allowed = validTransitions[currentState] || [];
+    if (!allowed.includes(targetState)) {
+      throw new Error(\`Invalid transition: \${currentState} → \${targetState}. Allowed: \${allowed.join(', ') || 'none'}\`);
+    }
+    ` : ''}
+
+    await collection.updateOne(byId(id), { $set: { [targetLifecycle]: targetState } });
+    const ${modelVar} = await collection.findOne(byId(id));
+    if (!${modelVar}) throw new Error('${modelName} not found after evolve');
+
+    await eventBus.publish('${modelName}Evolved', { ...${modelVar}, timestamp: new Date().toISOString() } as any);
+    return ${modelVar};
+  }
+`;
+}
+
+function generateDeleteMethod(modelName: string, modelVar: string, collection: string): string {
+  return `
+  /**
+   * Delete ${modelName}.
+   */
+  public async delete(id: string): Promise<void> {
+    const collection = await getCollection(COLLECTION_NAME);
+    const ${modelVar} = await collection.findOne(byId(id));
+    await collection.deleteOne(byId(id));
+    if (${modelVar}) {
+      await eventBus.publish('${modelName}Deleted', { ...${modelVar}, timestamp: new Date().toISOString() } as any);
+    }
+  }
+`;
+}
+
+interface CustomActionsResult {
+  code: string;
+}
+
+/**
+ * Custom actions emit TODO stubs that throw "not implemented".
+ *
+ * Why not delegate to `aiBehaviors.<actionName>`? Because the AI-behaviors
+ * generator only emits functions for STEPS that didn't match a convention
+ * pattern — not for actions themselves. So `aiBehaviors.rotate` would not
+ * exist even when an action named `rotate` is declared on the controller.
+ *
+ * Real implementation of action bodies is deferred to the MongoDB-native
+ * step-conventions library (#43F follow-up — mirror Prisma's
+ * step-conventions.ts but emit native-driver collection calls).
+ */
+function generateCustomActions(controller: any): CustomActionsResult {
+  if (!controller.actions || Object.keys(controller.actions).length === 0) {
+    return { code: '' };
+  }
+  const out: string[] = [];
+  for (const [actionName, action] of Object.entries<any>(controller.actions)) {
+    const stepsHeader = (action.steps && action.steps.length > 0)
+      ? action.steps.map((s: any) => `   *   - ${typeof s === 'string' ? s : (s.action || JSON.stringify(s))}`).join('\n')
+      : '   *   (no spec steps declared)';
+    out.push(`
+  /**
+   * ${actionName}
+   * ${action.description || ''}
+   *
+   * Spec steps:
+${stepsHeader}
+   */
+  public async ${actionName}(_args: any = {}): Promise<any> {
+    // TODO (#43F): translate spec steps into native MongoDB driver calls
+    // via a mongodb-native step-conventions library (mirror of the prisma
+    // one). For now this is a stub so realize completes and the action
+    // surface is callable for parity tests.
+    throw new Error('${controller.name}.${actionName} is not implemented');
+  }
+`);
+  }
+  return { code: out.join('\n') };
+}

package/libs/instance-factories/services/templates/mongodb-native/service-generator.ts

@@ -0,0 +1,83 @@
+/**
+ * MongoDB Native Driver — Service Generator
+ *
+ * Generates abstract business-logic services that use `getCollection` /
+ * `getDb` directly. The service body is intentionally skeletal: each
+ * declared operation gets a typed method, but the body is a TODO stub
+ * containing the spec steps as comments. Real-implementation generation
+ * is a separate concern (#43 follow-up: behavior-step → driver-call
+ * conventions parity with the prisma step library).
+ */
+import type { TemplateContext } from '@specverse/types';
+
+export default function generateMongoNativeService(context: TemplateContext): string {
+  const { service } = context;
+  if (!service) throw new Error('Service is required in template context');
+
+  const serviceName = service.name;
+  const operationsCode = generateOperations(service);
+  const usesDb = /\bgetDb\b|\bgetCollection\b/.test(operationsCode);
+  const hasEvents = (service.publishes && service.publishes.length > 0) ||
+                    (service.subscribes && service.subscribes.length > 0);
+
+  return `/**
+ * ${serviceName}
+ * Abstract business logic service (MongoDB native driver)
+ * ${service.description || ''}
+ */
+${usesDb ? `import { getDb, getCollection } from '../db/mongoClient.js';` : ''}
+${hasEvents ? `import { eventBus } from '../events/eventBus.js';` : ''}
+
+export class ${serviceName} {
+${operationsCode}
+}
+
+const ${lowerFirst(serviceName)} = new ${serviceName}();
+export const ${lowerFirst(serviceName)}Instance = ${lowerFirst(serviceName)};
+export default ${lowerFirst(serviceName)};
+`;
+}
+
+function lowerFirst(s: string): string {
+  return s.charAt(0).toLowerCase() + s.slice(1);
+}
+
+function generateOperations(service: any): string {
+  const ops = service.operations;
+  if (!ops || (Array.isArray(ops) && ops.length === 0) || (!Array.isArray(ops) && Object.keys(ops).length === 0)) {
+    return `
+  /**
+   * Default service entrypoint — replace with real operations once declared
+   * on the service's spec.
+   */
+  public async execute(_params: any = {}): Promise<any> {
+    throw new Error('${service.name}.execute is not implemented');
+  }
+`;
+  }
+  const entries: [string, any][] = Array.isArray(ops)
+    ? ops.map((op: any) => [op.name, op])
+    : Object.entries(ops);
+  return entries.map(([name, op]) => generateOperation(name, op, service.name)).join('\n');
+}
+
+function generateOperation(operationName: string, operation: any, serviceName: string): string {
+  const stepsHeader = (operation.steps && operation.steps.length > 0)
+    ? operation.steps.map((s: any) => `   *   - ${typeof s === 'string' ? s : (s.action || JSON.stringify(s))}`).join('\n')
+    : '   *   (no spec steps declared)';
+  return `
+  /**
+   * ${operationName}
+   * ${operation.description || ''}
+   *
+   * Spec steps:
+${stepsHeader}
+   */
+  public async ${operationName}(_args: any = {}): Promise<any> {
+    // TODO (#43 follow-up): translate spec steps into native MongoDB driver
+    // calls. For now this is a stub so realize completes and the service
+    // surface is callable for parity tests.
+    throw new Error('${serviceName}.${operationName} is not implemented');
+  }
+`;
+}