@friggframework/core 2.0.0--canary.680.daae24e.0 → 2.0.0--canary.686.e94de4d.0

package/extensions/extension-loader.js

@@ -0,0 +1,187 @@
+/**
+ * Extension Loader
+ *
+ * Validates and normalizes the core extensions of the app definition
+ * (`appDefinition.coreExtensions`, an array). Core extensions add custom
+ * Prisma models, encryption schemas, admin routes and bootstrap logic to a
+ * Frigg app. The key is `coreExtensions`, not `extensions`: ADR-017 keeps
+ * `appDefinition.extensions` for its keyed object form.
+ *
+ * @example
+ * const extensions = loadExtensions(appDefinition);
+ * // extensions is a normalized array, safe to iterate
+ */
+
+const path = require('path');
+const {
+    coreExtensionRoutePathError,
+} = require('../management-api/route-registry');
+
+/**
+ * Validates a single extension definition.
+ * @param {Object} ext - Raw extension config from app definition
+ * @param {number} index - Position in the coreExtensions array (for error messages)
+ * @returns {{valid: boolean, errors: string[]}}
+ */
+function validateExtension(ext, index) {
+    const prefix = `coreExtensions[${index}]`;
+    const errors = [];
+
+    if (!ext || typeof ext !== 'object') {
+        errors.push(`${prefix}: must be an object`);
+        return { valid: false, errors };
+    }
+
+    if (!ext.name || typeof ext.name !== 'string') {
+        errors.push(`${prefix}.name: required string`);
+    }
+
+    // schema is optional — path to a .prisma file
+    if (ext.schema !== undefined) {
+        if (typeof ext.schema !== 'string') {
+            errors.push(`${prefix}.schema: must be a string (path to .prisma file)`);
+        } else if (!ext.schema.endsWith('.prisma')) {
+            errors.push(`${prefix}.schema: must end with .prisma`);
+        }
+    }
+
+    // encryption is optional — object with model names → { fields: [...] }
+    if (ext.encryption !== undefined) {
+        if (!ext.encryption || typeof ext.encryption !== 'object') {
+            errors.push(`${prefix}.encryption: must be an object`);
+        } else {
+            for (const [model, config] of Object.entries(ext.encryption)) {
+                if (!config || !Array.isArray(config.fields)) {
+                    errors.push(
+                        `${prefix}.encryption.${model}: must have a "fields" array`
+                    );
+                }
+            }
+        }
+    }
+
+    // routes is optional — { path, handler }
+    if (ext.routes !== undefined) {
+        if (!ext.routes || typeof ext.routes !== 'object') {
+            errors.push(`${prefix}.routes: must be an object with { path, handler }`);
+        } else {
+            if (!ext.routes.path || typeof ext.routes.path !== 'string') {
+                errors.push(`${prefix}.routes.path: required string`);
+            } else {
+                const pathError = coreExtensionRoutePathError(ext.routes.path);
+                if (pathError) {
+                    errors.push(`${prefix}.routes.path: ${pathError}`);
+                }
+            }
+            if (!ext.routes.handler) {
+                errors.push(`${prefix}.routes.handler: required (function or module path)`);
+            }
+        }
+    }
+
+    // bootstrap is optional — function or module path
+    if (ext.bootstrap !== undefined) {
+        if (typeof ext.bootstrap !== 'function' && typeof ext.bootstrap !== 'string') {
+            errors.push(
+                `${prefix}.bootstrap: must be a function or a string (module path)`
+            );
+        }
+    }
+
+    return { valid: errors.length === 0, errors };
+}
+
+/**
+ * Loads and validates extensions from the app definition.
+ *
+ * @param {Object} appDefinition - The full app definition
+ * @returns {Array<Object>} Normalized extensions array (empty if none)
+ * @throws {Error} If any extension fails validation
+ */
+function loadExtensions(appDefinition) {
+    if (!appDefinition) return [];
+
+    // The array this loader reads used to be `appDefinition.extensions`;
+    // that key now belongs to ADR-017's keyed object. An array there is the
+    // old spelling: stop at load rather than silently dropping the extensions.
+    if (Array.isArray(appDefinition.extensions)) {
+        throw new Error(
+            'appDefinition.extensions (array) was renamed to appDefinition.coreExtensions; ' +
+                'move the array to coreExtensions'
+        );
+    }
+
+    const raw = appDefinition.coreExtensions;
+    if (!raw) return [];
+
+    if (!Array.isArray(raw)) {
+        throw new Error('appDefinition.coreExtensions must be an array');
+    }
+
+    if (raw.length === 0) return [];
+
+    const allErrors = [];
+
+    const normalized = raw.map((ext, index) => {
+        const { valid, errors } = validateExtension(ext, index);
+        if (!valid) {
+            allErrors.push(...errors);
+            return null;
+        }
+
+        // Normalize bootstrap — resolve string paths to functions
+        let bootstrapFn = null;
+        if (typeof ext.bootstrap === 'function') {
+            bootstrapFn = ext.bootstrap;
+        } else if (typeof ext.bootstrap === 'string') {
+            bootstrapFn = require(ext.bootstrap);
+        }
+
+        // Normalize route handler — resolve string paths to functions
+        let routeHandler = null;
+        if (ext.routes) {
+            if (typeof ext.routes.handler === 'function') {
+                routeHandler = ext.routes.handler;
+            } else if (typeof ext.routes.handler === 'string') {
+                routeHandler = require(ext.routes.handler);
+            } else {
+                routeHandler = ext.routes.handler;
+            }
+        }
+
+        return {
+            name: ext.name,
+            schema: ext.schema || null,
+            encryption: ext.encryption || null,
+            routes: ext.routes
+                ? { path: ext.routes.path, handler: routeHandler }
+                : null,
+            bootstrap: bootstrapFn,
+        };
+    });
+
+    if (allErrors.length > 0) {
+        throw new Error(
+            `Invalid extension configuration:\n- ${allErrors.join('\n- ')}`
+        );
+    }
+
+    return normalized.filter(Boolean);
+}
+
+/**
+ * Get extension schema file paths from loaded extensions.
+ * @param {Array<Object>} extensions - Normalized extensions
+ * @returns {string[]} Array of absolute paths to .prisma schema files
+ */
+function getExtensionSchemaPaths(extensions) {
+    return extensions
+        .filter((ext) => ext.schema)
+        .map((ext) => ext.schema);
+}
+
+module.exports = {
+    loadExtensions,
+    validateExtension,
+    getExtensionSchemaPaths,
+};

package/extensions/index.js

@@ -0,0 +1,41 @@
+/**
+ * Frigg Extension System
+ *
+ * Extensions allow integration developers to extend Frigg Core with:
+ * - Custom Prisma models (schema composition)
+ * - Encrypted fields (encryption registry merge)
+ * - Admin API routes (route mounting)
+ * - Bootstrap lifecycle hooks (credential loading, etc.)
+ *
+ * @module @friggframework/core/extensions
+ */
+
+const { loadExtensions, validateExtension, getExtensionSchemaPaths } = require('./extension-loader');
+const { composeSchemas, extractModelBlocks, getSchemaFilePaths } = require('./schema-composer');
+const {
+    mountExtensionRoutes,
+    createExtensionRoutesRouter,
+} = require('./route-mounter');
+const { runExtensionBootstraps } = require('./bootstrap-runner');
+const { initializeApp, resetInitialization } = require('./initialize-app');
+
+module.exports = {
+    // Extension loading & validation
+    loadExtensions,
+    validateExtension,
+    getExtensionSchemaPaths,
+
+    // Schema composition
+    composeSchemas,
+    extractModelBlocks,
+    getSchemaFilePaths,
+
+    // Route mounting
+    mountExtensionRoutes,
+    createExtensionRoutesRouter,
+
+    // Bootstrap lifecycle
+    runExtensionBootstraps,
+    initializeApp,
+    resetInitialization,
+};

package/extensions/initialize-app.js

@@ -0,0 +1,123 @@
+/**
+ * Application Initialization with Extension Lifecycle
+ *
+ * Provides an async initialization function that runs extension bootstraps
+ * after database connection but before router creation. This is the integration
+ * point for providers (Lambda, Netlify) to hook into the extension lifecycle.
+ *
+ * Call `initializeApp()` during the async startup phase of your handler/function.
+ * It is safe to call multiple times — subsequent calls are no-ops.
+ *
+ * @example
+ * const { initializeApp } = require('@friggframework/core/extensions/initialize-app');
+ *
+ * // In a Lambda handler or Netlify function:
+ * await initializeApp();
+ * // Now extensions are bootstrapped and router can be created
+ */
+
+const { loadExtensions } = require('./extension-loader');
+const { runExtensionBootstraps } = require('./bootstrap-runner');
+
+let _initialized = false;
+let _initPromise = null;
+
+/**
+ * Initializes extensions by running bootstrap hooks.
+ *
+ * This function:
+ * 1. Loads the app definition
+ * 2. Loads and validates extensions
+ * 3. Runs extension bootstrap hooks in sequence
+ *
+ * Bootstrap hooks receive (prisma, appDefinition) and can:
+ * - Load credentials from database into integration Definition.env
+ * - Register services or middleware
+ * - Perform any one-time async initialization
+ *
+ * @param {Object} [options]
+ * @param {Object} [options.appDefinition] - Override app definition (skips loadAppDefinition)
+ * @param {Object} [options.prisma] - Override Prisma client instance
+ * @param {boolean} [options.force=false] - Force re-initialization
+ * @returns {Promise<{extensions: Array}>} The loaded extensions
+ */
+async function initializeApp(options = {}) {
+    const { force = false } = options;
+
+    // Return cached promise if already initializing (prevent race conditions)
+    if (_initPromise && !force) {
+        return _initPromise;
+    }
+
+    if (_initialized && !force) {
+        return { extensions: [] };
+    }
+
+    _initPromise = _doInitialize(options);
+
+    try {
+        const result = await _initPromise;
+        _initialized = true;
+        return result;
+    } catch (error) {
+        _initPromise = null;
+        throw error;
+    }
+}
+
+async function _doInitialize(options = {}) {
+    let { appDefinition, prisma } = options;
+
+    // Load app definition if not provided
+    if (!appDefinition) {
+        try {
+            const { loadAppDefinition } = require('../handlers/app-definition-loader');
+            const loaded = loadAppDefinition();
+            appDefinition = loaded.appDefinition;
+        } catch {
+            // No app definition available — skip extension bootstrap
+            return { extensions: [] };
+        }
+    }
+
+    if (!appDefinition) {
+        return { extensions: [] };
+    }
+
+    // Load extensions
+    const extensions = loadExtensions(appDefinition);
+
+    if (extensions.length === 0) {
+        return { extensions };
+    }
+
+    // Get Prisma client if not provided
+    if (!prisma) {
+        try {
+            const db = require('../database/prisma');
+            prisma = db.prisma;
+        } catch {
+            // Prisma not available — skip bootstrap
+            console.warn('Prisma client not available, skipping extension bootstraps');
+            return { extensions };
+        }
+    }
+
+    // Run bootstrap hooks
+    await runExtensionBootstraps(extensions, { prisma, appDefinition });
+
+    return { extensions };
+}
+
+/**
+ * Reset initialization state (for testing).
+ */
+function resetInitialization() {
+    _initialized = false;
+    _initPromise = null;
+}
+
+module.exports = {
+    initializeApp,
+    resetInitialization,
+};

package/extensions/route-mounter.js

@@ -0,0 +1,103 @@
+/**
+ * Route Mounter
+ *
+ * Mounts extension-defined Express routers onto the main app.
+ * Each extension can declare routes with a base path and a handler factory.
+ *
+ * The handler factory receives (prisma, appDefinition) and returns an Express Router.
+ * Routes are protected by the admin auth middleware by default.
+ *
+ * @example
+ * mountExtensionRoutes(app, extensions, { prisma, appDefinition });
+ */
+
+const { validateAdminApiKey } = require('../handlers/middleware/admin-auth');
+
+/**
+ * Mounts all extension routes onto an Express app.
+ *
+ * @param {import('express').Express} app - Express app or router to mount on
+ * @param {Array<Object>} extensions - Normalized extensions (from extension-loader)
+ * @param {Object} context
+ * @param {Object} context.prisma - Prisma client instance
+ * @param {Object} context.appDefinition - Full app definition
+ * @param {Function} [context.authMiddleware] - Override admin auth middleware
+ */
+function mountExtensionRoutes(app, extensions, context = {}) {
+    if (!extensions || extensions.length === 0) return;
+
+    const { prisma, appDefinition, authMiddleware } = context;
+    const adminAuth = authMiddleware || validateAdminApiKey;
+
+    for (const ext of extensions) {
+        if (!ext.routes) continue;
+
+        const { path: basePath, handler } = ext.routes;
+
+        let router;
+        if (typeof handler === 'function') {
+            // Handler factory: (prisma, appDefinition) => Router
+            router = handler(prisma, appDefinition);
+        } else if (handler && handler.router) {
+            // Direct router object export pattern: { router }
+            router = handler.router;
+        } else if (handler && handler.default && typeof handler.default === 'function') {
+            // ES module default export
+            router = handler.default(prisma, appDefinition);
+        } else {
+            console.warn(
+                `Extension "${ext.name}": routes.handler is not a function or router object, skipping`
+            );
+            continue;
+        }
+
+        // Mount with admin auth middleware
+        app.use(basePath, adminAuth, router);
+    }
+}
+
+module.exports = { mountExtensionRoutes };
+
+/**
+ * Builds one router serving every app-level extension's routes
+ * (`appDefinition.coreExtensions[].routes`), each behind the admin API key.
+ *
+ * Lazy by design: the extensions, their route factories and the Prisma
+ * client are only touched on the first request, so requiring a handler
+ * module never connects anything.
+ *
+ * @param {Object} [params]
+ * @param {Object} [params.appDefinition] - raw app Definition; defaults to
+ *   loadAppDefinition().appDefinition on first request.
+ * @param {Object} [params.prisma] - defaults to core's Prisma client.
+ * @returns {import('express').Router}
+ */
+function createExtensionRoutesRouter({ appDefinition, prisma } = {}) {
+    const express = require('express');
+    const outer = express.Router();
+    let inner = null;
+
+    outer.use((req, res, next) => {
+        if (!inner) {
+            const definition =
+                appDefinition ||
+                require('../handlers/app-definition-loader').loadAppDefinition()
+                    .appDefinition;
+            const { loadExtensions } = require('./extension-loader');
+            const extensions = loadExtensions(definition);
+            const built = express.Router();
+            if (extensions.some((ext) => ext.routes)) {
+                mountExtensionRoutes(built, extensions, {
+                    prisma: prisma || require('../database/prisma').prisma,
+                    appDefinition: definition,
+                });
+            }
+            inner = built;
+        }
+        return inner(req, res, next);
+    });
+
+    return outer;
+}
+
+module.exports.createExtensionRoutesRouter = createExtensionRoutesRouter;

package/extensions/schema-composer.js

@@ -0,0 +1,188 @@
+/**
+ * Schema Composer
+ *
+ * Merges extension .prisma schema fragments with a base Prisma schema.
+ * Extensions can add new models/enums that get composed into the final schema
+ * used for `prisma generate` and migrations.
+ *
+ * Two approaches are supported:
+ * 1. Build-time merge: Concatenate model definitions from extension files
+ *    into the base schema and write a merged output file.
+ * 2. Multi-file schema (Prisma 5.15+): Return a list of schema paths for
+ *    Prisma's native `prismaSchemaFolder` feature.
+ *
+ * @example
+ * const { composeSchemas } = require('@friggframework/core/extensions/schema-composer');
+ *
+ * // Build-time merge — writes a merged schema file
+ * await composeSchemas({
+ *   baseSchemaPath: '/path/to/prisma-postgresql/schema.prisma',
+ *   extensionSchemaPaths: ['/path/to/extensions/db-credentials/schema.prisma'],
+ *   outputPath: '/path/to/prisma-postgresql/schema.composed.prisma',
+ * });
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Extracts model/enum blocks from a .prisma file, stripping out
+ * generator and datasource blocks (which should only appear in the base schema).
+ *
+ * @param {string} schemaContent - Raw .prisma file content
+ * @returns {string} Only model/enum/type definitions
+ */
+function extractModelBlocks(schemaContent) {
+    const lines = schemaContent.split('\n');
+    const result = [];
+    let depth = 0;
+    let inBlock = false;
+    let blockType = null;
+
+    for (const line of lines) {
+        const trimmed = line.trim();
+
+        // Detect block start
+        if (depth === 0 && !inBlock) {
+            const blockMatch = trimmed.match(
+                /^(model|enum|type)\s+\w+\s*\{/
+            );
+            if (blockMatch) {
+                inBlock = true;
+                blockType = blockMatch[1];
+                result.push(line);
+                depth += (line.match(/\{/g) || []).length;
+                depth -= (line.match(/\}/g) || []).length;
+                continue;
+            }
+
+            // Skip generator/datasource blocks
+            const skipMatch = trimmed.match(
+                /^(generator|datasource)\s+\w+\s*\{/
+            );
+            if (skipMatch) {
+                inBlock = true;
+                blockType = 'skip';
+                depth += (line.match(/\{/g) || []).length;
+                depth -= (line.match(/\}/g) || []).length;
+                continue;
+            }
+
+            // Keep standalone comments between blocks
+            if (trimmed.startsWith('//') || trimmed === '') {
+                // Only keep if we've already accumulated some model blocks
+                if (result.length > 0) {
+                    result.push(line);
+                }
+                continue;
+            }
+        } else if (inBlock) {
+            depth += (line.match(/\{/g) || []).length;
+            depth -= (line.match(/\}/g) || []).length;
+
+            if (blockType !== 'skip') {
+                result.push(line);
+            }
+
+            if (depth <= 0) {
+                inBlock = false;
+                blockType = null;
+                depth = 0;
+                if (result.length > 0) {
+                    result.push(''); // blank line between blocks
+                }
+            }
+        }
+    }
+
+    return result.join('\n').trim();
+}
+
+/**
+ * Composes a merged Prisma schema from a base schema + extension fragments.
+ *
+ * @param {Object} options
+ * @param {string} options.baseSchemaPath - Absolute path to the core .prisma file
+ * @param {string[]} options.extensionSchemaPaths - Absolute paths to extension .prisma files
+ * @param {string} [options.outputPath] - Where to write the merged schema.
+ *   Defaults to `<baseDir>/schema.composed.prisma`
+ * @returns {string} The merged schema content
+ */
+function composeSchemas({ baseSchemaPath, extensionSchemaPaths, outputPath }) {
+    if (!baseSchemaPath) {
+        throw new Error('baseSchemaPath is required');
+    }
+
+    if (
+        !extensionSchemaPaths ||
+        !Array.isArray(extensionSchemaPaths) ||
+        extensionSchemaPaths.length === 0
+    ) {
+        // No extensions — just return base schema as-is
+        const baseContent = fs.readFileSync(baseSchemaPath, 'utf-8');
+        return baseContent;
+    }
+
+    const baseContent = fs.readFileSync(baseSchemaPath, 'utf-8');
+
+    // Collect model blocks from each extension
+    const extensionBlocks = [];
+    for (const extPath of extensionSchemaPaths) {
+        if (!fs.existsSync(extPath)) {
+            throw new Error(
+                `Extension schema not found: ${extPath}`
+            );
+        }
+        const extContent = fs.readFileSync(extPath, 'utf-8');
+        const models = extractModelBlocks(extContent);
+        if (models) {
+            extensionBlocks.push(
+                `// --- Extension schema from: ${path.basename(path.dirname(extPath))}/${path.basename(extPath)} ---`,
+                models
+            );
+        }
+    }
+
+    if (extensionBlocks.length === 0) {
+        return baseContent;
+    }
+
+    // Append extension models to the base schema
+    const merged = [
+        baseContent.trimEnd(),
+        '',
+        '// =========================================================================',
+        '// Extension Models (auto-composed — do not edit manually)',
+        '// =========================================================================',
+        '',
+        ...extensionBlocks,
+        '',
+    ].join('\n');
+
+    // Write the merged schema if outputPath is specified
+    const resolvedOutput =
+        outputPath ||
+        path.join(path.dirname(baseSchemaPath), 'schema.composed.prisma');
+
+    fs.writeFileSync(resolvedOutput, merged, 'utf-8');
+
+    return merged;
+}
+
+/**
+ * Returns schema paths suitable for Prisma's native multi-file schema support
+ * (prismaSchemaFolder feature, Prisma 5.15+).
+ *
+ * @param {string} baseSchemaPath - Path to the core schema
+ * @param {string[]} extensionSchemaPaths - Paths to extension schemas
+ * @returns {string[]} All schema file paths
+ */
+function getSchemaFilePaths(baseSchemaPath, extensionSchemaPaths) {
+    return [baseSchemaPath, ...(extensionSchemaPaths || [])];
+}
+
+module.exports = {
+    composeSchemas,
+    extractModelBlocks,
+    getSchemaFilePaths,
+};