How bcgov/social-middleware works
social-middleware is a NestJS API bridging frontend social-service applications with identity, MongoDB, and downstream services. Users authenticate through BC Services Card, then create and progress an application package through forms and household screening before referral or submission. The graph preserves those distinct stages and supporting attachment, notification, and Siebel capabilities. Several subsystems are represented from the tree and README; their internal call paths are not asserted where source excerpts do not show them.
Main entry points: application-package.service.ts Application lifecycle service · auth.controller.ts Authentication API · household.controller.ts Household API · application-form.service.ts Form management
Components 26
Identity and sessions
- Authentication API
social-middleware/src/auth/auth.controller.ts - Authentication strategies
social-middleware/src/auth/strategies - User management
social-middleware/src/auth/user.service.ts - Session guard
social-middleware/src/auth/session-auth.guard.ts
Application lifecycle
- Application package API
social-middleware/src/application-package/application-package.controller.ts - Application lifecycle service
social-middleware/src/application-package/services/application-package.service.ts - Attachments API
social-middleware/src/attachments/attachments.controller.ts - Attachment handling
social-middleware/src/attachments/attachments.service.ts
Forms and household
- Application form API
social-middleware/src/application-form/application-form.controller.ts - Form management
social-middleware/src/application-form/services/application-form.service.ts - Household API
social-middleware/src/household/household.controller.ts - Household management
social-middleware/src/household/services/household.service.ts - Screening access codes
social-middleware/src/household/services/access-code.service.ts - Form token API
social-middleware/src/forms/forms.controller.ts - Form token handling
social-middleware/src/forms/forms.service.ts
External services
- BC Services Card
- Notifications
social-middleware/src/notifications/services/notification.service.ts - Email queue
social-middleware/src/notifications/queue/notification-queue.service.ts - Email delivery
social-middleware/src/notifications/services/ches.service.ts - Siebel services
social-middleware/src/siebel/siebel-api.service.ts
API and persistence
- Application records
social-middleware/src/application-package/schema/application-package.schema.ts - Form records
social-middleware/src/application-form/schemas/application-form.schema.ts - Household records
social-middleware/src/household/schemas/household-members.schema.ts - Health endpoint
social-middleware/src/health/health.controller.ts - MongoDB
Other components
- Frontend user
Connections 30
- Frontend user → Authentication API: authenticates at
- Authentication API → Authentication strategies: dispatches callback
social-middleware/src/auth/auth.controller.ts - Authentication API → User management: looks up user
social-middleware/src/auth/auth.controller.ts - Authentication strategies → BC Services Card: exchanges credentials
- Frontend user → Application package API: manages applications
- Application package API → Application lifecycle service: delegates operations
social-middleware/src/application-package/application-package.controller.ts - Application lifecycle service → Application records: reads and updates
social-middleware/src/application-package/services/application-package.service.ts - Application lifecycle service → Form management: uses forms
social-middleware/src/application-package/services/application-package.service.ts - Application lifecycle service → Household management: checks household
social-middleware/src/application-package/services/application-package.service.ts - Application lifecycle service → Screening access codes: uses access codes
social-middleware/src/application-package/services/application-package.service.ts - Application lifecycle service → User management: uses user data
social-middleware/src/application-package/services/application-package.service.ts - Application lifecycle service → Siebel services: uses Siebel API
social-middleware/src/application-package/services/application-package.service.ts - Frontend user → Application form API: submits forms
- Application form API → Form management: delegates form work
social-middleware/src/application-form/application-form.controller.ts - Form management → Form records: reads and writes
social-middleware/src/application-form/services/application-form.service.ts - Frontend user → Household API: manages household
- Household API → Household management: delegates operations
social-middleware/src/household/household.controller.ts - Household API → Screening access codes: manages access codes
social-middleware/src/household/household.controller.ts - Household management → Household records: reads and updates
social-middleware/src/household/services/household.service.ts - Screening access codes → Household management: associates member
social-middleware/src/household/services/access-code.service.ts - Frontend user → Attachments API: uploads attachments
- Attachments API → Attachment handling: delegates attachment work
social-middleware/src/attachments/attachments.controller.ts - Household API → Notifications: sends notifications
social-middleware/src/household/household.controller.ts - Notifications → Email queue: queues email
social-middleware/src/notifications/services/notification.service.ts - Email queue → Email delivery: delivers email
- Frontend user → Form token API: requests form access
- Form token API → Form token handling: delegates token work
social-middleware/src/forms/forms.controller.ts - Frontend user → Health endpoint: checks service health
- Authentication API → Session guard: protects routes
social-middleware/src/auth/auth.controller.ts - Form management → MongoDB: persists form data