@specverse/engines 6.11.2 → 6.16.0

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

@@ -0,0 +1,178 @@
+/**
+ * Postgres native (pg) — pool singleton.
+ *
+ * Emits a small connection module shared by all controllers and services.
+ * Table-naming convention: lowercase + 's' suffix (User → users), matching
+ * the lowercase-pluralized scheme declared in the factory yaml. Models with
+ * custom table names override via `model.storage?.table` (the
+ * controller-generator looks there first).
+ *
+ * Connection priority: POSTGRES_URL > DATABASE_URL > localhost default.
+ * Both URL forms are widely accepted by hosting providers (Supabase, Neon,
+ * Railway, Render). The pool is lazily initialised on first use and reused;
+ * `disconnect` is exposed for graceful-shutdown wiring.
+ */
+import type { TemplateContext } from '@specverse/types';
+
+export default function generatePgClient(_context: TemplateContext): string {
+  return `/**
+ * Postgres native (pg) — singleton pool + helpers.
+ *
+ * Picks up POSTGRES_URL or DATABASE_URL from the environment. The pool is
+ * lazily initialised on first use and reused across requests; \`disconnect\`
+ * is exposed for graceful-shutdown wiring. \`withTx\` runs a callback in a
+ * single connection inside BEGIN/COMMIT (rolled back on throw).
+ */
+import { Pool, type PoolClient, type QueryResult, type QueryResultRow } from 'pg';
+
+const connectionString =
+  process.env.POSTGRES_URL ||
+  process.env.DATABASE_URL ||
+  'postgres://postgres:postgres@localhost:5432/specverse';
+
+let pool: Pool | null = null;
+
+export function getPool(): Pool {
+  if (pool) return pool;
+  pool = new Pool({ connectionString });
+  return pool;
+}
+
+/** Run a parameterised query against the pool.
+ *  T defaults to QueryResultRow so callers can pass a row interface. */
+export async function query<T extends QueryResultRow = QueryResultRow>(
+  text: string,
+  params: ReadonlyArray<unknown> = [],
+): Promise<QueryResult<T>> {
+  return getPool().query<T>(text, params as unknown[]);
+}
+
+/** Run a callback inside a transaction. The callback receives a dedicated
+ *  client; commit on resolve, rollback on throw. */
+export async function withTx<T>(
+  fn: (client: PoolClient) => Promise<T>,
+): Promise<T> {
+  const client = await getPool().connect();
+  try {
+    await client.query('BEGIN');
+    const result = await fn(client);
+    await client.query('COMMIT');
+    return result;
+  } catch (err) {
+    await client.query('ROLLBACK');
+    throw err;
+  } finally {
+    client.release();
+  }
+}
+
+/** Build a comma-separated list of \`"col"\` from an object's keys, plus
+ *  matching positional placeholders \`$1, $2, ...\`. Quoted to preserve
+ *  case-sensitive identifiers (camelCase columns work without folding). */
+function buildPositionals(keys: string[], offset = 0): string {
+  return keys.map((_k, i) => '$' + (i + 1 + offset)).join(', ');
+}
+function quoteCols(keys: string[]): string {
+  return keys.map((k) => '"' + k.replace(/"/g, '""') + '"').join(', ');
+}
+
+/** INSERT a record into \`table\` and return the inserted row (with any
+ *  database-supplied defaults like generated id / createdAt populated). */
+export async function insertOne<T extends QueryResultRow = QueryResultRow>(
+  table: string,
+  record: Record<string, unknown>,
+): Promise<T> {
+  const keys = Object.keys(record);
+  const values = keys.map((k) => record[k]);
+  const sql = keys.length === 0
+    ? \`INSERT INTO "\${table}" DEFAULT VALUES RETURNING *\`
+    : \`INSERT INTO "\${table}" (\${quoteCols(keys)}) VALUES (\${buildPositionals(keys)}) RETURNING *\`;
+  const result = await query<T>(sql, values);
+  return result.rows[0] as T;
+}
+
+/** Bulk-insert many records into \`table\` in one round trip. Returns the
+ *  inserted rows. All records must share the same shape. */
+export async function insertMany<T extends QueryResultRow = QueryResultRow>(
+  table: string,
+  records: ReadonlyArray<Record<string, unknown>>,
+): Promise<T[]> {
+  if (records.length === 0) return [];
+  const firstKeys = Object.keys(records[0]!);
+  const valuesClauses: string[] = [];
+  const flatValues: unknown[] = [];
+  for (let i = 0; i < records.length; i++) {
+    const row = records[i] as Record<string, unknown>;
+    const placeholders = firstKeys.map((_k, j) => '$' + (i * firstKeys.length + j + 1)).join(', ');
+    valuesClauses.push('(' + placeholders + ')');
+    for (const k of firstKeys) flatValues.push(row[k]);
+  }
+  const sql = \`INSERT INTO "\${table}" (\${quoteCols(firstKeys)}) VALUES \${valuesClauses.join(', ')} RETURNING *\`;
+  const result = await query<T>(sql, flatValues);
+  return result.rows;
+}
+
+/** SELECT a single row by a field equality. Returns null if not found. */
+export async function findOneByField<T extends QueryResultRow = QueryResultRow>(
+  table: string,
+  field: string,
+  value: unknown,
+): Promise<T | null> {
+  const sql = \`SELECT * FROM "\${table}" WHERE "\${field.replace(/"/g, '""')}" = $1 LIMIT 1\`;
+  const result = await query<T>(sql, [value]);
+  return result.rows[0] ?? null;
+}
+
+/** SELECT a single row matching all (field, value) pairs (AND-ed). */
+export async function findOneByFields<T extends QueryResultRow = QueryResultRow>(
+  table: string,
+  fields: Record<string, unknown>,
+): Promise<T | null> {
+  const keys = Object.keys(fields);
+  if (keys.length === 0) {
+    const result = await query<T>(\`SELECT * FROM "\${table}" LIMIT 1\`);
+    return result.rows[0] ?? null;
+  }
+  const where = keys.map((k, i) => '"' + k.replace(/"/g, '""') + '" = $' + (i + 1)).join(' AND ');
+  const sql = \`SELECT * FROM "\${table}" WHERE \${where} LIMIT 1\`;
+  const result = await query<T>(sql, keys.map((k) => fields[k]));
+  return result.rows[0] ?? null;
+}
+
+/** SELECT all rows from a table — equivalent to a Mongo
+ *  \`collection.find({}).toArray()\` for the bulk-fan-out auto-create
+ *  convention. */
+export async function findAll<T extends QueryResultRow = QueryResultRow>(
+  table: string,
+): Promise<T[]> {
+  const result = await query<T>(\`SELECT * FROM "\${table}"\`);
+  return result.rows;
+}
+
+/** UPDATE columns of the row identified by id. Quotes column names so
+ *  camelCase identifiers survive postgres' default lower-case folding. */
+export async function updateOneById(
+  table: string,
+  id: unknown,
+  patch: Record<string, unknown>,
+): Promise<void> {
+  const keys = Object.keys(patch);
+  if (keys.length === 0) return;
+  const setClause = keys.map((k, i) => '"' + k.replace(/"/g, '""') + '" = $' + (i + 1)).join(', ');
+  const sql = \`UPDATE "\${table}" SET \${setClause} WHERE "id" = $\${keys.length + 1}\`;
+  await query(sql, [...keys.map((k) => patch[k]), id]);
+}
+
+/** DELETE the row identified by id. */
+export async function deleteOneById(table: string, id: unknown): Promise<void> {
+  await query(\`DELETE FROM "\${table}" WHERE "id" = $1\`, [id]);
+}
+
+export async function disconnect(): Promise<void> {
+  if (pool) {
+    await pool.end();
+    pool = null;
+  }
+}
+`;
+}

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

@@ -0,0 +1,372 @@
+/**
+ * PostgreSQL Native (pg) — Controller Generator
+ *
+ * Generates per-model controllers exposing CURVED operations via the pg
+ * pool helpers (`insertOne` / `findOneByField` / `updateOneById` / etc.).
+ * Same shape and same behaviour as the mongodb-native counterpart — the
+ * only differences are runtime-driver calls.
+ *
+ * Scope (MVP):
+ *   - 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 per-step bodies via `matchPgStep`. The same
+ *     matcher is passed to the AI-behaviors-generator (via realize/index.ts)
+ *     so both sides agree on `declaredVars`, function names, and inputs.
+ *
+ * Out of scope:
+ *   - withTx() multi-statement transactions for create/update flows
+ *     (deferred — current MVP commits each helper call individually)
+ *   - JOIN-driven retrieve variants (deferred)
+ *
+ * Table naming: lowercase + 's' (User → users) unless the model declares
+ * `storage.table`. ID is a string at the API surface; the pgClient helpers
+ * pass the value through as-is so UUIDs / slugs / int-as-string all work.
+ */
+import type { TemplateContext } from '@specverse/types';
+import { buildTransitionMap, isAutoField } from '@specverse/types/spec-rules';
+
+export default function generatePgNativeController(context: TemplateContext): string {
+  const { controller, model, models } = context as any;
+  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 table = tableName(model);
+  const curedOps = controller.cured || {};
+
+  // Build a name → ModelSpec registry once so step-conventions can read
+  // attribute defaults (level: 1, totalResources: '', etc.) and FK targets
+  // when emitting create/insertMany code.
+  const modelRegistry: Record<string, any> = {};
+  if (Array.isArray(models)) {
+    for (const m of models) if (m?.name) modelRegistry[m.name] = m;
+  } else if (models && typeof models === 'object') {
+    Object.assign(modelRegistry, models);
+  }
+
+  const customActions = generateCustomActions(controller, modelRegistry);
+
+  const validate = generateValidateMethod(model, modelName);
+  const create = curedOps.create ? generateCreateMethod(modelName, modelVar) : '';
+  const retrieve = curedOps.retrieve ? generateRetrieveMethod(modelName, modelVar) : '';
+  const update = curedOps.update ? generateUpdateMethod(modelName, modelVar) : '';
+  const evolve = curedOps.evolve ? generateEvolveMethod(model, modelName, modelVar) : '';
+  const del = curedOps.delete ? generateDeleteMethod(modelName, modelVar) : '';
+
+  const hasEventPublishing =
+    curedOps.create || curedOps.update || curedOps.evolve || curedOps.delete;
+
+  // Helpers always imported: insertOne / findOneByField / findAll /
+  // updateOneById / deleteOneById are referenced by the CRUD ops; `query`
+  // is referenced by retrieveAll's offset path. The composite + bulk
+  // helpers are conditional — only the convention-driven step bodies
+  // emit them, so we scan the customActions.code to decide.
+  const helperImports = [
+    'insertOne',
+    'findOneByField',
+    'findAll',
+    'updateOneById',
+    'deleteOneById',
+    'query',
+    customActions.code.includes('findOneByFields(') ? 'findOneByFields' : '',
+    customActions.code.includes('insertMany(') ? 'insertMany' : '',
+  ].filter(Boolean).join(', ');
+
+  return `/**
+ * ${controllerName}
+ * Model-specific business logic for ${modelName} (PostgreSQL native driver)
+ * ${controller.description || ''}
+ */
+import { ${helperImports} } from '../db/pgClient.js';
+${hasEventPublishing || customActions.needsAiBehaviors ? `import { eventBus } from '../events/eventBus.js';` : ''}
+${customActions.needsAiBehaviors ? `import * as aiBehaviors from '../behaviors/${controllerName}.ai.js';` : ''}
+
+const TABLE_NAME = '${table}';
+
+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 tableName(model: any): string {
+  if (model?.storage?.table) return String(model.storage.table);
+  // 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(modelName: string, modelVar: 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 ${modelVar} = await insertOne(TABLE_NAME, { ...data });
+
+    await eventBus.publish('${modelName}Created', { ...${modelVar}, timestamp: new Date().toISOString() } as any);
+    return ${modelVar};
+  }
+`;
+}
+
+function generateRetrieveMethod(modelName: string, _modelVar: string): string {
+  return `
+  /**
+   * Retrieve ${modelName} by id. Returns null when not found.
+   */
+  public async retrieve(id: string): Promise<any | null> {
+    return await findOneByField(TABLE_NAME, 'id', id);
+  }
+
+  /**
+   * Retrieve a page of ${modelName}s.
+   */
+  public async retrieveAll(options: { skip?: number; take?: number } = {}): Promise<any[]> {
+    if (!options.skip && !options.take) {
+      return await findAll(TABLE_NAME);
+    }
+    const limit = options.take ?? 100;
+    const offset = options.skip ?? 0;
+    const result = await query(\`SELECT * FROM "\${TABLE_NAME}" LIMIT $1 OFFSET $2\`, [limit, offset]);
+    return result.rows;
+  }
+`;
+}
+
+function generateUpdateMethod(modelName: string, modelVar: 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: Record<string, unknown> = {};
+    for (const [key, value] of Object.entries(data)) {
+      if (key === 'id') continue;
+      if (Array.isArray(value)) continue;
+      if (value !== null && typeof value === 'object' && !(value instanceof Date)) continue;
+      updateData[key] = value;
+    }
+
+    await updateOneById(TABLE_NAME, id, updateData);
+    const ${modelVar} = await findOneByField(TABLE_NAME, 'id', 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): 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) : {};
+  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 current = await findOneByField(TABLE_NAME, 'id', 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 updateOneById(TABLE_NAME, id, { [targetLifecycle]: targetState });
+    const ${modelVar} = await findOneByField(TABLE_NAME, 'id', 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): string {
+  return `
+  /**
+   * Delete ${modelName}.
+   */
+  public async delete(id: string): Promise<void> {
+    const ${modelVar} = await findOneByField(TABLE_NAME, 'id', id);
+    await deleteOneById(TABLE_NAME, id);
+    if (${modelVar}) {
+      await eventBus.publish('${modelName}Deleted', { ...${modelVar}, timestamp: new Date().toISOString() } as any);
+    }
+  }
+`;
+}
+
+interface CustomActionsResult {
+  code: string;
+  needsAiBehaviors: boolean;
+}
+
+import { matchPgStep, type PgStepContext } from './step-conventions.js';
+
+function generateCustomActions(controller: any, modelRegistry: Record<string, any> = {}): CustomActionsResult {
+  if (!controller.actions || Object.keys(controller.actions).length === 0) {
+    return { code: '', needsAiBehaviors: false };
+  }
+  const CRUD_NAMES = new Set(['create', 'retrieve', 'retrieveAll', 'update', 'evolve', 'delete', 'validate']);
+  const modelName = controller.model || (controller.name || '').replace(/Controller$/, '') || 'Model';
+  const tableNameLocal = modelName.toLowerCase() + 's';
+  const out: string[] = [];
+  let needsAiBehaviors = false;
+  for (const [actionName, action] of Object.entries<any>(controller.actions)) {
+    if (CRUD_NAMES.has(actionName)) {
+      console.warn(
+        `⚠️  ${controller.name || 'Controller'}.${actionName} — behaviour-derived action collides with the auto-generated CURVED \`${actionName}\` op. Dropped to avoid TS2393 duplicate-implementation. Rename the behaviour (e.g. \`${actionName}Soft\` / \`hardDelete\`) if you need the custom logic.`
+      );
+      continue;
+    }
+    const steps: any[] = Array.isArray(action.steps) ? action.steps : [];
+    const stepsHeader = steps.length > 0
+      ? steps.map((s: any) => `   *   - ${typeof s === 'string' ? s : (s.action || JSON.stringify(s))}`).join('\n')
+      : '   *   (no spec steps declared)';
+
+    const declaredVars = new Set<string>();
+    const stepBodies: string[] = [];
+    let usesArgs = false;
+    let actionRefersToAi = false;
+    steps.forEach((rawStep: any, i: number) => {
+      const stepText = typeof rawStep === 'string' ? rawStep : (rawStep?.step || rawStep?.action);
+      if (typeof stepText !== 'string') {
+        stepBodies.push(`    // Step ${i + 1}: (non-string step ignored)`);
+        return;
+      }
+      const ctx: PgStepContext = {
+        modelName,
+        tableName: tableNameLocal,
+        serviceName: controller.name || 'Controller',
+        operationName: actionName,
+        stepNum: i + 1,
+        parameterNames: Object.keys(action.parameters || {}),
+        declaredVars,
+        models: modelRegistry,
+      };
+      const result = matchPgStep(stepText, ctx);
+      stepBodies.push(result.call);
+      if (/\bargs\./.test(result.call)) usesArgs = true;
+      if (!result.matched) actionRefersToAi = true;
+    });
+
+    if (actionRefersToAi) needsAiBehaviors = true;
+    const argsParam = usesArgs ? 'args: any = {}' : '_args: any = {}';
+    let combined = stepBodies.join('\n\n');
+    // Drop unused step{N}Result locals (strict tsc's noUnusedLocals applies
+    // even to underscored names — same logic as the mongo controller).
+    const stepResultRe = /const\s+(step\d+Result)\s*=/g;
+    let mres: RegExpExecArray | null;
+    const declared: string[] = [];
+    while ((mres = stepResultRe.exec(combined)) !== null) declared.push(mres[1]!);
+    for (const name of declared) {
+      const refCount = (combined.match(new RegExp(`\\b${name}\\b`, 'g')) || []).length;
+      if (refCount <= 1) {
+        combined = combined.replace(new RegExp(`const\\s+${name}\\s*=\\s*`), '');
+      }
+    }
+    const body = steps.length > 0
+      ? combined + `\n    return { success: true };`
+      : `    throw new Error('${controller.name || 'Controller'}.${actionName} is not implemented');`;
+
+    out.push(`
+  /**
+   * ${actionName}
+   * ${action.description || ''}
+   *
+   * Spec steps:
+${stepsHeader}
+   */
+  public async ${actionName}(${argsParam}): Promise<any> {
+${body}
+  }
+`);
+  }
+  return { code: out.join('\n'), needsAiBehaviors };
+}