@friggframework/core 2.0.0-next.5 → 2.0.0-next.50

package/index.js

@@ -24,8 +24,47 @@ const {
     Token,
     UserModel,
     WebsocketConnection,
+    prisma,
+    TokenRepository,
+    WebsocketConnectionRepository,
 } = require('./database/index');
-const { Encrypt, Cryptor } = require('./encrypt/encrypt');
+const {
+    createUserRepository,
+    UserRepositoryMongo,
+    UserRepositoryPostgres,
+} = require('./user/repositories/user-repository-factory');
+const {
+    GetUserFromXFriggHeaders,
+} = require('./user/use-cases/get-user-from-x-frigg-headers');
+const {
+    GetUserFromAdopterJwt,
+} = require('./user/use-cases/get-user-from-adopter-jwt');
+const {
+    AuthenticateUser,
+} = require('./user/use-cases/authenticate-user');
+
+const {
+    CredentialRepository,
+} = require('./credential/repositories/credential-repository');
+const {
+    ModuleRepository,
+} = require('./modules/repositories/module-repository');
+const {
+    IntegrationMappingRepository,
+} = require('./integrations/repositories/integration-mapping-repository');
+const {
+    CreateProcess,
+} = require('./integrations/use-cases/create-process');
+const {
+    UpdateProcessState,
+} = require('./integrations/use-cases/update-process-state');
+const {
+    UpdateProcessMetrics,
+} = require('./integrations/use-cases/update-process-metrics');
+const {
+    GetProcess,
+} = require('./integrations/use-cases/get-process');
+const { Cryptor } = require('./encrypt');
 const {
     BaseError,
     FetchError,
@@ -35,30 +74,26 @@ const {
 } = require('./errors/index');
 const {
     IntegrationBase,
-    IntegrationModel,
     Options,
-    IntegrationMapping,
-    IntegrationFactory,
-    IntegrationHelper,
     createIntegrationRouter,
     checkRequiredParams,
-    createFriggBackend,
+    getModulesDefinitionFromIntegrationClasses,
+    LoadIntegrationContextUseCase,
 } = require('./integrations/index');
 const { TimeoutCatcher } = require('./lambda/index');
 const { debug, initDebugLog, flushDebugLog } = require('./logs/index');
 const {
     Credential,
-    EntityManager,
     Entity,
-    ModuleManager,
     ApiKeyRequester,
     BasicAuthRequester,
     OAuth2Requester,
     Requester,
     ModuleConstants,
     ModuleFactory,
-    Auther,
-} = require('./module-plugin/index');
+} = require('./modules/index');
+const application = require('./application');
+const utils = require('./utils');
 
 // const {Sync } = require('./syncs/model');
 
@@ -91,9 +126,18 @@ module.exports = {
     Token,
     UserModel,
     WebsocketConnection,
-
-    // encrypt
-    Encrypt,
+    prisma,
+    TokenRepository,
+    WebsocketConnectionRepository,
+    createUserRepository,
+    UserRepositoryMongo,
+    UserRepositoryPostgres,
+    GetUserFromXFriggHeaders,
+    GetUserFromAdopterJwt,
+    AuthenticateUser,
+    CredentialRepository,
+    ModuleRepository,
+    IntegrationMappingRepository,
     Cryptor,
 
     // errors
@@ -105,14 +149,26 @@ module.exports = {
 
     // integrations
     IntegrationBase,
-    IntegrationModel,
     Options,
-    IntegrationMapping,
-    IntegrationFactory,
-    IntegrationHelper,
     checkRequiredParams,
     createIntegrationRouter,
-    createFriggBackend,
+    getModulesDefinitionFromIntegrationClasses,
+    LoadIntegrationContextUseCase,
+    CreateProcess,
+    UpdateProcessState,
+    UpdateProcessMetrics,
+    GetProcess,
+
+    // application - Command factories for integration developers
+    application,
+    createFriggCommands: application.createFriggCommands,
+    createIntegrationCommands: application.createIntegrationCommands,
+    createUserCommands: application.createUserCommands,
+    createEntityCommands: application.createEntityCommands,
+    createCredentialCommands: application.createCredentialCommands,
+    findIntegrationContextByExternalEntityId:
+        application.findIntegrationContextByExternalEntityId,
+    integrationCommands: application.integrationCommands,
 
     // lambda
     TimeoutCatcher,
@@ -124,17 +180,16 @@ module.exports = {
 
     // module plugin
     Credential,
-    EntityManager,
     Entity,
-    ModuleManager,
     ApiKeyRequester,
     BasicAuthRequester,
     OAuth2Requester,
     Requester,
     ModuleConstants,
     ModuleFactory,
-    Auther,
-
     // queues
     QueuerUtil,
+
+    // utils
+    ...utils,
 };

package/integrations/WEBHOOK-QUICKSTART.md

@@ -0,0 +1,151 @@
+# Webhook Quick Start Guide
+
+Get webhooks working in your Frigg integration in 3 simple steps.
+
+## Step 1: Enable Webhooks
+
+Add `webhooks: true` to your Integration Definition:
+
+```javascript
+class MyIntegration extends IntegrationBase {
+    static Definition = {
+        name: 'my-integration',
+        version: '1.0.0',
+        modules: {
+            myapi: { definition: MyApiDefinition },
+        },
+        webhooks: true,  // ← Add this line
+    };
+}
+```
+
+## Step 2: Handle Webhook Processing
+
+Override the `onWebhook` handler to process webhooks:
+
+```javascript
+class MyIntegration extends IntegrationBase {
+    // ... Definition ...
+
+    async onWebhook({ data }) {
+        const { body } = data;
+
+        // You have full access to:
+        // - this.myapi (your API modules)
+        // - this.config (integration config)
+        // - Database operations
+
+        if (body.event === 'item.created') {
+            await this.myapi.api.createItem(body.data);
+        }
+
+        return { processed: true };
+    }
+}
+```
+
+## Step 3: Deploy
+
+Deploy your Frigg app - webhook routes are automatically created:
+
+```bash
+POST /api/my-integration-integration/webhooks/:integrationId
+```
+
+## That's It!
+
+The default behavior handles:
+- ✅ Receiving webhooks (instant 200 OK response)
+- ✅ Queuing to SQS
+- ✅ Loading your integration with DB and API modules
+- ✅ Calling your `onWebhook` handler
+
+## Optional: Custom Signature Verification
+
+Override `onWebhookReceived` for custom signature checks:
+
+```javascript
+async onWebhookReceived({ req, res }) {
+    // Verify signature
+    const signature = req.headers['x-webhook-signature'];
+    if (!this.verifySignature(req.body, signature)) {
+        return res.status(401).json({ error: 'Invalid signature' });
+    }
+
+    // Queue for processing (default behavior)
+    await this.queueWebhook({
+        integrationId: req.params.integrationId,
+        body: req.body,
+    });
+
+    res.status(200).json({ received: true });
+}
+```
+
+## Two Webhook Routes
+
+### With Integration ID (Recommended)
+```
+POST /api/{name}-integration/webhooks/:integrationId
+```
+- Full integration loaded in worker
+- Access to DB, config, and API modules
+- Use `this.myapi`, `this.config`, etc.
+
+### Without Integration ID
+```
+POST /api/{name}-integration/webhooks
+```
+- Unhydrated integration
+- Useful for system-wide events
+- Limited context
+
+## Need Help?
+
+See full documentation: `packages/core/handlers/WEBHOOKS.md`
+
+## Common Patterns
+
+### Slack
+```javascript
+async onWebhookReceived({ req, res }) {
+    if (req.body.type === 'url_verification') {
+        return res.json({ challenge: req.body.challenge });
+    }
+    // ... verify signature, queue ...
+}
+```
+
+### Stripe
+```javascript
+async onWebhookReceived({ req, res }) {
+    const stripe = require('stripe')(process.env.STRIPE_SECRET_KEY);
+    const event = stripe.webhooks.constructEvent(
+        JSON.stringify(req.body),
+        req.headers['stripe-signature'],
+        process.env.STRIPE_WEBHOOK_SECRET
+    );
+    await this.queueWebhook({ body: event });
+    res.status(200).json({ received: true });
+}
+```
+
+### GitHub
+```javascript
+async onWebhookReceived({ req, res }) {
+    const crypto = require('crypto');
+    const signature = req.headers['x-hub-signature-256'];
+    const hash = crypto
+        .createHmac('sha256', process.env.GITHUB_WEBHOOK_SECRET)
+        .update(JSON.stringify(req.body))
+        .digest('hex');
+    
+    if (`sha256=${hash}` !== signature) {
+        return res.status(401).json({ error: 'Invalid signature' });
+    }
+    
+    await this.queueWebhook({ integrationId: req.params.integrationId, body: req.body });
+    res.status(200).json({ received: true });
+}
+```
+

package/integrations/index.js

@@ -1,19 +1,21 @@
 const { IntegrationBase } = require('./integration-base');
-const { IntegrationModel } = require('./integration-model');
 const { Options } = require('./options');
-const { IntegrationMapping } = require('./integration-mapping');
-const { IntegrationFactory, IntegrationHelper } = require('./integration-factory');
-const { createIntegrationRouter, checkRequiredParams } = require('./integration-router');
-const { createFriggBackend } = require('./create-frigg-backend');
+const {
+    createIntegrationRouter,
+    checkRequiredParams,
+} = require('./integration-router');
+const {
+    getModulesDefinitionFromIntegrationClasses,
+} = require('./utils/map-integration-dto');
+const {
+    LoadIntegrationContextUseCase,
+} = require('./use-cases/load-integration-context');
 
 module.exports = {
     IntegrationBase,
-    IntegrationModel,
     Options,
-    IntegrationMapping,
-    IntegrationFactory,
-    IntegrationHelper,
     createIntegrationRouter,
     checkRequiredParams,
-    createFriggBackend
+    getModulesDefinitionFromIntegrationClasses,
+    LoadIntegrationContextUseCase,
 };