@friggframework/core 2.0.0-next.41 → 2.0.0-next.43

package/modules/use-cases/process-authorization-callback.js

@@ -0,0 +1,122 @@
+const { Module } = require('../module');
+const { ModuleConstants } = require('../ModuleConstants');
+
+class ProcessAuthorizationCallback {
+    /**
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../repositories/module-repository-factory').ModuleRepositoryInterface} params.moduleRepository - Repository for module data operations.
+     * @param {import('../../credential/repositories/credential-repository-factory').CredentialRepositoryInterface} params.credentialRepository - Repository for credential data operations.
+     * @param {Array<Object>} params.moduleDefinitions - Array of module definitions.
+     */
+    constructor({ moduleRepository, credentialRepository, moduleDefinitions }) {
+        this.moduleRepository = moduleRepository;
+        this.credentialRepository = credentialRepository;
+        this.moduleDefinitions = moduleDefinitions;
+    }
+
+    async execute(userId, entityType, params) {
+        const moduleDefinition = this.moduleDefinitions.find((def) => {
+            return entityType === def.moduleName;
+        });
+
+        if (!moduleDefinition) {
+            throw new Error(
+                `Module definition not found for entity type: ${entityType}`
+            );
+        }
+
+        // todo: check if we need to pass entity to Module, right now it's null
+        let entity = null;
+
+        const module = new Module({
+            userId,
+            entity,
+            definition: moduleDefinition,
+        });
+
+        let tokenResponse;
+        if (module.apiClass.requesterType === ModuleConstants.authType.oauth2) {
+            tokenResponse = await moduleDefinition.requiredAuthMethods.getToken(
+                module.api,
+                params
+            );
+        } else {
+            tokenResponse =
+                await moduleDefinition.requiredAuthMethods.setAuthParams(
+                    module.api,
+                    params
+                );
+            await this.onTokenUpdate(module, moduleDefinition, userId);
+        }
+
+        const authRes = await module.testAuth();
+        if (!authRes) {
+            throw new Error('Authorization failed');
+        }
+
+        const entityDetails =
+            await moduleDefinition.requiredAuthMethods.getEntityDetails(
+                module.api,
+                params,
+                tokenResponse,
+                userId
+            );
+
+        Object.assign(
+            entityDetails.details,
+            module.apiParamsFromEntity(module.api)
+        );
+
+        const persistedEntity = await this.findOrCreateEntity(
+            entityDetails,
+            entityType,
+            module.credential.id
+        );
+
+        return {
+            credential_id: module.credential.id,
+            entity_id: persistedEntity.id,
+            type: module.getName(),
+        };
+    }
+
+    async onTokenUpdate(module, moduleDefinition, userId) {
+        const credentialDetails =
+            await moduleDefinition.requiredAuthMethods.getCredentialDetails(
+                module.api,
+                userId
+            );
+
+        Object.assign(
+            credentialDetails.details,
+            module.apiParamsFromCredential(module.api)
+        );
+        credentialDetails.details.authIsValid = true;
+
+        const persisted = await this.credentialRepository.upsertCredential(credentialDetails);
+        module.credential = persisted;
+    }
+
+    async findOrCreateEntity(entityDetails, moduleName, credentialId) {
+        const { identifiers, details } = entityDetails;
+
+        const existingEntity = await this.moduleRepository.findEntity({
+            externalId: identifiers.externalId,
+            user: identifiers.user,
+            moduleName: moduleName,
+        });
+
+        if (existingEntity) {
+            return existingEntity;
+        }
+
+        return await this.moduleRepository.createEntity({
+            ...identifiers,
+            ...details,
+            moduleName: moduleName,
+            credential: credentialId,
+        });
+    }
+}
+
+module.exports = { ProcessAuthorizationCallback };

package/modules/use-cases/refresh-entity-options.js

@@ -0,0 +1,59 @@
+const { Module } = require('../module');
+
+class RefreshEntityOptions {
+    /**
+     * @param {Object} params
+     * @param {import('../repositories/module-repository-interface').ModuleRepositoryInterface} params.moduleRepository
+     * @param {} params.moduleDefinitions
+     */
+    constructor({ moduleRepository, moduleDefinitions }) {
+        this.moduleRepository = moduleRepository;
+        this.moduleDefinitions = moduleDefinitions;
+    }
+
+    /**
+     * Retrieve a Module instance for a given user and entity/module type.
+     * @param {string} userId
+     * @param {string} entityId
+     */
+    async execute(entityId, userId, options) {
+        const entity = await this.moduleRepository.findEntityById(
+            entityId,
+            userId
+        );
+
+        if (!entity) {
+            throw new Error(`Entity ${entityId} not found`);
+        }
+
+        if (entity.userId !== userId) {
+            throw new Error(
+                `Entity ${entityId} does not belong to user ${userId}`
+            );
+        }
+
+        const entityType = entity.type;
+        const moduleDefinition = this.moduleDefinitions.find((def) => {
+            const modelName =
+                Module.getEntityModelFromDefinition(def).modelName;
+            return entityType === modelName;
+        });
+
+        if (!moduleDefinition) {
+            throw new Error(
+                `Module definition not found for entity type: ${entityType}`
+            );
+        }
+
+        const module = new Module({
+            userId,
+            entity,
+            definition: moduleDefinition,
+        });
+
+        await module.refreshEntityOptions(options);
+        return module.getEntityOptions();
+    }
+}
+
+module.exports = { RefreshEntityOptions };

package/modules/use-cases/test-module-auth.js

@@ -0,0 +1,55 @@
+const { Module } = require('../module');
+
+class TestModuleAuth {
+    /**
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../repositories/module-repository-interface').ModuleRepositoryInterface} params.moduleRepository - Repository for module data operations.
+     * @param {Array<Object>} params.moduleDefinitions - Array of module definitions.
+     */
+    constructor({ moduleRepository, moduleDefinitions }) {
+        this.moduleRepository = moduleRepository;
+        this.moduleDefinitions = moduleDefinitions;
+    }
+
+    async execute(entityId, userId) {
+        const entity = await this.moduleRepository.findEntityById(
+            entityId,
+            userId
+        );
+
+        if (!entity) {
+            throw new Error(`Entity ${entityId} not found`);
+        }
+
+        if (entity.userId !== userId) {
+            throw new Error(
+                `Entity ${entityId} does not belong to user ${userId}`
+            );
+        }
+
+        const entityType = entity.type;
+        const moduleDefinition = this.moduleDefinitions.find((def) => {
+            const modelName =
+                Module.getEntityModelFromDefinition(def).modelName;
+            return entityType === modelName;
+        });
+
+        if (!moduleDefinition) {
+            throw new Error(
+                `Module definition not found for entity type: ${entityType}`
+            );
+        }
+
+        const module = new Module({
+            userId,
+            entity,
+            definition: moduleDefinition,
+        });
+
+        const testAuthResponse = await module.testAuth();
+
+        return testAuthResponse;
+    }
+}
+
+module.exports = { TestModuleAuth };

package/modules/utils/map-module-dto.js

@@ -0,0 +1,18 @@
+/**
+ * @param {import('../module').Module} moduleInstance
+ * Convert a Module domain instance to a plain DTO suitable for JSON responses.
+ */
+function mapModuleClassToModuleDTO(moduleInstance) {
+    if (!moduleInstance) return null;
+
+    return {
+        id: moduleInstance.entity.id,
+        name: moduleInstance.name,
+        userId: moduleInstance.userId,
+        entity: moduleInstance.entity,
+        credentialId: moduleInstance.credential?._id?.toString(),
+        type: moduleInstance.getName()
+    };
+}
+
+module.exports = { mapModuleClassToModuleDTO }; 

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "2.0.0-next.41",
+  "version": "2.0.0-next.43",
   "dependencies": {
     "@hapi/boom": "^10.0.1",
+    "@prisma/client": "^6.16.3",
     "aws-sdk": "^2.1200.0",
     "bcryptjs": "^2.4.3",
     "body-parser": "^1.20.2",
@@ -22,9 +23,9 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@friggframework/eslint-config": "2.0.0-next.41",
-    "@friggframework/prettier-config": "2.0.0-next.41",
-    "@friggframework/test": "2.0.0-next.41",
+    "@friggframework/eslint-config": "2.0.0-next.43",
+    "@friggframework/prettier-config": "2.0.0-next.43",
+    "@friggframework/test": "2.0.0-next.43",
     "@types/lodash": "4.17.15",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "chai": "^4.3.6",
@@ -34,12 +35,19 @@
     "eslint-plugin-promise": "^7.0.0",
     "jest": "^29.7.0",
     "prettier": "^2.7.1",
+    "prisma": "^6.16.3",
     "sinon": "^16.1.1",
     "typescript": "^5.0.2"
   },
   "scripts": {
     "lint:fix": "prettier --write --loglevel error . && eslint . --fix",
-    "test": "jest --passWithNoTests # TODO"
+    "test": "jest --passWithNoTests # TODO",
+    "prisma:generate:mongo": "npx prisma generate --schema ./prisma-mongodb/schema.prisma",
+    "prisma:generate:postgres": "npx prisma generate --schema ./prisma-postgresql/schema.prisma",
+    "prisma:generate": "npm run prisma:generate:mongo && npm run prisma:generate:postgres",
+    "prisma:push:mongo": "npx prisma db push --schema ./prisma-mongodb/schema.prisma",
+    "prisma:migrate:postgres": "npx prisma migrate dev --schema ./prisma-postgresql/schema.prisma",
+    "postinstall": "npm run prisma:generate"
   },
   "author": "",
   "license": "MIT",
@@ -56,5 +64,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a5c413164c1b492a228689851d037706f7f869af"
+  "gitHead": "2619db8a4e885887ad9071fe166cf0e8dee12d91"
 }

package/prisma-mongodb/schema.prisma

@@ -0,0 +1,318 @@
+// Frigg Framework - Prisma Schema
+// MongoDB database schema for enterprise integration platform
+// Migration from Mongoose ODM to Prisma ORM
+
+generator client {
+  provider = "prisma-client-js"
+  output   = "../node_modules/@prisma-mongodb/client"
+}
+
+datasource db {
+  provider = "mongodb"
+  url      = env("DATABASE_URL")
+}
+
+// ============================================================================
+// USER MODELS
+// ============================================================================
+
+/// User model with discriminator pattern support
+/// Replaces Mongoose discriminators (IndividualUser, OrganizationUser)
+model User {
+  id    String   @id @default(auto()) @map("_id") @db.ObjectId
+  type  UserType
+
+  // Timestamps
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  // IndividualUser fields (nullable for organizations)
+  email          String?
+  username       String?
+  hashword       String? // Bcrypt hashed password (handled in application layer)
+  appUserId      String?
+  organizationId String? @db.ObjectId
+
+  // Self-referential relation for organization membership
+  organization User?  @relation("OrgMembers", fields: [organizationId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+  members      User[] @relation("OrgMembers")
+
+  // OrganizationUser fields (nullable for individuals)
+  appOrgId String?
+  name     String?
+
+  // Relations
+  tokens       Token[]
+  credentials  Credential[]
+  entities     Entity[]
+  integrations Integration[]
+
+  @@unique([email])
+  @@unique([username])
+  @@unique([appOrgId])
+  @@index([type])
+  @@index([appUserId])
+  @@map("User")
+}
+
+enum UserType {
+  INDIVIDUAL
+  ORGANIZATION
+}
+
+// ============================================================================
+// AUTHENTICATION MODELS
+// ============================================================================
+
+/// Authentication tokens with expiration
+/// Bcrypt hashed tokens stored (handled in application layer)
+model Token {
+  id      String    @id @default(auto()) @map("_id") @db.ObjectId
+  token   String // Bcrypt hashed
+  created DateTime  @default(now())
+  expires DateTime?
+  userId  String    @db.ObjectId
+  user    User      @relation(fields: [userId], references: [id], onDelete: Cascade)
+
+  @@index([userId])
+  @@index([expires])
+  @@map("Token")
+}
+
+// ============================================================================
+// CREDENTIAL & ENTITY MODELS
+// ============================================================================
+
+/// OAuth credentials and API tokens
+/// All sensitive data encrypted with KMS at rest
+model Credential {
+  id         String   @id @default(auto()) @map("_id") @db.ObjectId
+  userId     String?  @db.ObjectId
+  user       User?    @relation(fields: [userId], references: [id], onDelete: Cascade)
+  subType    String?
+  authIsValid Boolean?
+  externalId String?
+
+  // Dynamic OAuth fields stored as JSON (encrypted via Prisma middleware)
+  // Contains: access_token, refresh_token, domain, expires_in, token_type, etc.
+  data Json @default("{}")
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  // Relations
+  entities Entity[]
+
+  @@index([userId])
+  @@index([externalId])
+  @@map("Credential")
+}
+
+/// External service entities (API connections)
+model Entity {
+  id           String      @id @default(auto()) @map("_id") @db.ObjectId
+  credentialId String?     @db.ObjectId
+  credential   Credential? @relation(fields: [credentialId], references: [id], onDelete: SetNull)
+  subType      String?
+  userId       String?     @db.ObjectId
+  user         User?       @relation(fields: [userId], references: [id], onDelete: Cascade)
+  name         String?
+  moduleName   String?
+  externalId   String?
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  // Relations - many-to-many with scalar lists
+  integrations    Integration[] @relation("IntegrationEntities", fields: [integrationIds], references: [id])
+  integrationIds  String[]      @db.ObjectId
+
+  syncs           Sync[]        @relation("SyncEntities", fields: [syncIds], references: [id])
+  syncIds         String[]      @db.ObjectId
+
+  dataIdentifiers    DataIdentifier[]
+  associationObjects AssociationObject[]
+
+  @@index([userId])
+  @@index([externalId])
+  @@index([moduleName])
+  @@index([credentialId])
+  @@map("Entity")
+}
+
+// ============================================================================
+// INTEGRATION MODELS
+// ============================================================================
+
+/// Main integration configuration and state
+model Integration {
+  id     String            @id @default(auto()) @map("_id") @db.ObjectId
+  userId String?           @db.ObjectId
+  user   User?             @relation(fields: [userId], references: [id], onDelete: Cascade)
+  status IntegrationStatus @default(ENABLED)
+
+  // Configuration and version
+  config  Json?   // Integration configuration object
+  version String?
+
+  // Entity references (many-to-many via explicit scalar list)
+  entities  Entity[] @relation("IntegrationEntities", fields: [entityIds], references: [id])
+  entityIds String[] @db.ObjectId
+
+  // Message arrays (stored as JSON)
+  errors   Json @default("[]")
+  warnings Json @default("[]")
+  info     Json @default("[]")
+  logs     Json @default("[]")
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  // Relations
+  associations Association[]
+  syncs        Sync[]
+  mappings     IntegrationMapping[]
+
+  @@index([userId])
+  @@index([status])
+  @@map("Integration")
+}
+
+enum IntegrationStatus {
+  ENABLED
+  NEEDS_CONFIG
+  PROCESSING
+  DISABLED
+  ERROR
+}
+
+/// Integration-specific data mappings
+/// All mapping data encrypted with KMS
+model IntegrationMapping {
+  id            String      @id @default(auto()) @map("_id") @db.ObjectId
+  integrationId String      @db.ObjectId
+  integration   Integration @relation(fields: [integrationId], references: [id], onDelete: Cascade)
+  sourceId      String?
+
+  // Encrypted mapping data (handled via Prisma middleware)
+  mapping Json?
+
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+
+  @@unique([integrationId, sourceId])
+  @@index([integrationId])
+  @@index([sourceId])
+  @@map("IntegrationMapping")
+}
+
+// ============================================================================
+// SYNC MODELS
+// ============================================================================
+
+/// Bidirectional data synchronization tracking
+model Sync {
+  id            String       @id @default(auto()) @map("_id") @db.ObjectId
+  integrationId String?      @db.ObjectId
+  integration   Integration? @relation(fields: [integrationId], references: [id], onDelete: Cascade)
+
+  // Entity references (many-to-many via explicit scalar list)
+  entities  Entity[] @relation("SyncEntities", fields: [entityIds], references: [id])
+  entityIds String[] @db.ObjectId
+
+  hash String
+  name String
+
+  // Data identifiers (extracted to separate model)
+  dataIdentifiers DataIdentifier[]
+
+  @@index([integrationId])
+  @@index([hash])
+  @@index([name])
+  @@map("Sync")
+}
+
+/// Data identifier for sync operations
+/// Replaces nested array structure in Mongoose
+model DataIdentifier {
+  id       String  @id @default(auto()) @map("_id") @db.ObjectId
+  syncId   String? @db.ObjectId
+  sync     Sync?   @relation(fields: [syncId], references: [id], onDelete: Cascade)
+  entityId String  @db.ObjectId
+  entity   Entity  @relation(fields: [entityId], references: [id], onDelete: Cascade)
+
+  // Identifier data (can be any structure)
+  idData Json
+
+  hash String
+
+  @@index([syncId])
+  @@index([entityId])
+  @@index([hash])
+  @@map("DataIdentifier")
+}
+
+// ============================================================================
+// ASSOCIATION MODELS
+// ============================================================================
+
+/// Entity associations with cardinality tracking
+model Association {
+  id            String          @id @default(auto()) @map("_id") @db.ObjectId
+  integrationId String          @db.ObjectId
+  integration   Integration     @relation(fields: [integrationId], references: [id], onDelete: Cascade)
+  name          String
+  type          AssociationType
+  primaryObject String
+
+  // Associated objects (extracted to separate model)
+  objects AssociationObject[]
+
+  @@index([integrationId])
+  @@index([name])
+  @@map("Association")
+}
+
+/// Association object entry
+/// Replaces nested array structure in Mongoose
+model AssociationObject {
+  id            String       @id @default(auto()) @map("_id") @db.ObjectId
+  associationId String       @db.ObjectId
+  association   Association  @relation(fields: [associationId], references: [id], onDelete: Cascade)
+  entityId      String       @db.ObjectId
+  entity        Entity       @relation(fields: [entityId], references: [id], onDelete: Cascade)
+  objectType    String
+  objId         String
+  metadata      Json? // Optional metadata
+
+  @@index([associationId])
+  @@index([entityId])
+  @@map("AssociationObject")
+}
+
+enum AssociationType {
+  ONE_TO_MANY
+  ONE_TO_ONE
+  MANY_TO_ONE
+}
+
+// ============================================================================
+// UTILITY MODELS
+// ============================================================================
+
+/// Generic state storage
+model State {
+  id    String @id @default(auto()) @map("_id") @db.ObjectId
+  state Json?
+
+  @@map("State")
+}
+
+/// AWS API Gateway WebSocket connection tracking
+model WebsocketConnection {
+  id           String  @id @default(auto()) @map("_id") @db.ObjectId
+  connectionId String?
+
+  @@index([connectionId])
+  @@map("WebsocketConnection")
+}