MemberJunction Packages Summary

This page provides an overview of all the packages in the MemberJunction project and how they work together to form a complete platform.

Core Packages

@memberjunction/core

Description: The foundation of the MemberJunction platform, providing the essential entity model, business logic, and metadata handling.

Key Features:

Entity object model
Metadata management
Business logic framework
Data validation
Change tracking
Event system
Security and permissions

Usage: Used by all other packages as the foundation for data access and business logic.

@memberjunction/graphql

Description: Provides a GraphQL API layer for MemberJunction, enabling flexible data queries and mutations.

Key Features:

Dynamic GraphQL schema generation based on metadata
Entity queries and mutations
Custom resolvers for complex operations
Authentication and authorization integration
Filtering, sorting, and pagination
Support for complex data relationships
Real-time subscriptions

Usage: Used by client applications to interact with MemberJunction data.

@memberjunction/ui

Description: Provides a comprehensive set of UI components for building MemberJunction applications.

Key Features:

Entity list and detail views
Form components
Data grid
Search components
Dashboard widgets
Navigation components
Dialog and modal systems
Theming and styling

Usage: Used to build the user interface for MemberJunction applications.

@memberjunction/codegen

Description: A powerful code generation tool that automates the creation of TypeScript code based on MemberJunction's metadata.

Key Features:

Entity class generation
API service generation
GraphQL schema generation
UI component generation
Database script generation
Type definition creation
Documentation generation

Usage: Used during development and build processes to generate code from metadata.

Server Packages

@memberjunction/server

Description: Provides the server-side infrastructure for MemberJunction applications.

Key Features:

API endpoints
Authentication and authorization
Request handling
Error management
Logging
Performance monitoring

Usage: Used as the backend server for MemberJunction applications.

@memberjunction/data-providers

Description: Implements data access providers for different database systems.

Key Features:

SQL Server provider
Azure SQL provider
In-memory provider (for testing)
Query building and execution
Transaction management
Connection pooling

Usage: Used by the core package to interact with databases.

@memberjunction/authentication

Description: Provides authentication and identity management capabilities.

Key Features:

Multiple authentication providers
User management
Role-based access control
Token generation and validation
Password management
Multi-factor authentication

Usage: Used to secure MemberJunction applications and manage user identities.

Client Packages

@memberjunction/angular-client

Description: Provides Angular components and services for building MemberJunction applications.

Key Features:

Angular-specific UI components
Service wrappers
Angular routing integration
Form validation
State management

Usage: Used by Angular applications built on MemberJunction.

@memberjunction/client-api

Description: Provides client-side API utilities for interacting with MemberJunction.

Key Features:

API client
GraphQL client
Authentication utilities
Caching
Error handling

Usage: Used by client applications to communicate with MemberJunction servers.

Utility Packages

@memberjunction/utils

Description: Provides common utilities used across MemberJunction packages.

Key Features:

String manipulation
Date/time utilities
Collection helpers
Type conversion
Validation utilities
Object manipulation

Usage: Used by all other packages for common utility functions.

@memberjunction/testing

Description: Provides testing utilities for MemberJunction packages.

Key Features:

Test data generation
Mock providers
Test helpers
Assertion utilities
Performance testing

Usage: Used during development and testing of MemberJunction packages.

@memberjunction/cli

Description: Provides command-line tools for working with MemberJunction.

Key Features:

Project scaffolding
Code generation
Database management
Deployment utilities
Configuration management

Usage: Used by developers to create and manage MemberJunction projects.

Package Dependencies

Below is a diagram of the main package dependencies:

@memberjunction/core
  ↑
  └── @memberjunction/utils
                ↑
                │
┌───────────────┼───────────────┐
│               │               │
│               │               │
@memberjunction/graphql   @memberjunction/codegen
│               ↑               ↑
│               │               │
│               └───────┬───────┘
│                       │
@memberjunction/server   │
│                       │
│                       │
@memberjunction/ui ←────┘
  ↑
  │
┌─┴──────────────────────┐
│                        │
@memberjunction/angular-client

Development Workflow

When developing with MemberJunction packages:

Define metadata for your entities, fields, and relationships
Generate code using the CodeGen package
Implement custom business logic by extending generated entity classes
Build UI components using the UI package
Set up the server using the Server package
Configure authentication using the Authentication package
Add AI capabilities using the AI package
Deploy to your chosen environment

Getting Started

To get started with MemberJunction packages:

Install the core packages:

npm install @memberjunction/core @memberjunction/graphql @memberjunction/ui

Set up your database and configure connection settings.
Create entity metadata and generate code:
```
npx mj-codegen --config codegen.config.js
```
Build your application using the generated code and UI components.

Best Practices

When working with MemberJunction packages:

Use the CodeGen package to maintain consistency between database and code
Extend generated entity classes rather than modifying them directly
Leverage the event system for cross-entity business logic
Use GraphQL fragments to optimize data fetching
Implement proper security at the entity and field level
Cache frequently accessed data to improve performance

Resources

MemberJunction GitHub Repo

To get access to the complete source code for the MemberJunction project, visit us on GitHub! The code there is available for anyone to view, submit contributions to (see contribution guidelines on GitHub), submit issues, etc. For most users, accessing the code via npm and installing specific libraries is the more common path.

Complete Documentation

The below is a link to our generated documentation site that uses the JSDoc comments throughout the codebase across all the packages to provide an updated documentation guide on packages and objects for each version of the software.

https://memberjunction.github.io/MJ/