How friggframework/api-module-library works
• v1-ready API Modules – the refactored, optimized modules built for the new Frigg v1 architecture.
• Older “needs-updating” API Modules – the legacy modules originally from Frigg v0.
Overall Project Context
– Represent the Frigg API Module Library as the central system.
– Note that the purpose is to serve as a collection of modules, each encapsulating integration logic with a specific third-party API.
Main Components
a. Repository Infrastructure:
• Inside, two primary groups:
– “v1-ready API Modules” (new family)
– “Needs-Updating API Modules” (legacy family)
b. Individual API Modules:
• Within each group, represent individual modules as separate components (rectangles) with names such as “activecampaign”, “stripe”, “hubspot”, “asana”, etc.
• Each module should include internal components such as:
– API Layer (api.js)
– Configuration (defaultConfig.json)
– Manager/Controller (manager.js) that encapsulates business logic and helper functions.
– Models (for credential or entity definitions).
– Test suites (illustrated to denote testing structure).
c. External Third-Party APIs:
Relationships and Data Flow
– Connect the “API Modules” components to the external third-party services indicating that these modules act as bridges.
– Illustrate how “v1-ready” modules might adhere to improved, uniform integration patterns, while the “needs-updating” modules are legacy implementations.
Architectural Patterns and Technologies
– Highlight that the system employs a modular (plug-in) architecture where each module is developed independently.
– Note the use of Lerna and NX as tools for monorepo management – you might encapsulate these as “DevOps/Build Tools” alongside the repository.
– Point out that each module is structured similarly (with API, configs, models, tests), which shows a consistency in design—perhaps a “template” can be visually indicated.
– Mention common usage of Node.js and JavaScript testing workflows (jest, setup/teardown scripts) to illustrate the technical stack.
– Optionally, annotate that continuous integration (via GitHub Actions workflows in the .github directory) ties the modules together for streamlined builds and releases.