88 lines
4.1 KiB
Markdown
88 lines
4.1 KiB
Markdown
|
# `ts/` Backend Module
|
||
|
|
|
||
|
|
The `ts/` folder contains the server runtime for `idp.global`: startup, website server wiring, typed routes, OIDC endpoints, and the core `Reception` managers.
|
||
|
|
|
||
|
|
## Issue Reporting and Security
|
||
|
|
|
||
|
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||
|
|
|
||
|
|
## What Lives Here
|
||
|
|
|
||
|
|
- `index.ts` boots the service, loads env vars, starts the website server, and mounts OIDC endpoints.
|
||
|
|
- `reception/classes.reception.ts` creates the service container and initializes all managers.
|
||
|
|
- `reception/` contains the domain logic for users, sessions, orgs, roles, invites, apps, billing, and OIDC.
|
||
|
|
- `plugins.ts` centralizes external imports used by the backend.
|
||
|
|
|
||
|
|
## Startup Behavior
|
||
|
|
|
||
|
|
The backend startup in `ts/index.ts` does four main things:
|
||
|
|
|
||
|
|
1. Loads runtime configuration from `.nogit` and the working directory.
|
||
|
|
2. Creates a `UtilityWebsiteServer` that serves the built frontend.
|
||
|
|
3. Registers OIDC endpoints such as discovery, JWKS, authorize, token, userinfo, and revoke.
|
||
|
|
4. Creates and starts `Reception`, then starts HTTP serving on port `2999`.
|
||
|
|
|
||
|
|
## Required Environment
|
||
|
|
|
||
|
|
```bash
|
||
|
|
export MONGODB_URL=mongodb://localhost:27017/idp-dev
|
||
|
|
export IDP_BASEURL=http://localhost:2999
|
||
|
|
export INSTANCE_NAME=idp-dev
|
||
|
|
```
|
||
|
|
|
||
|
|
Optional:
|
||
|
|
|
||
|
|
- `SERVEZONE_PLATFROM_AUTHORIZATION`
|
||
|
|
- `PADDLE_TOKEN`
|
||
|
|
- `PADDLE_PRICE_ID`
|
||
|
|
|
||
|
|
## Key Managers
|
||
|
|
|
||
|
|
| Class | Responsibility |
|
||
|
|
| --- | --- |
|
||
|
|
| `JwtManager` | JWT issuance, validation, and key rotation support |
|
||
|
|
| `LoginSessionManager` | Session creation, refresh, logout, and session metadata |
|
||
|
|
| `RegistrationSessionManager` | Registration flow state |
|
||
|
|
| `UserManager` | User-centric queries and mutations |
|
||
|
|
| `OrganizationManager` | Organization creation and access checks |
|
||
|
|
| `RoleManager` | Role and permission management |
|
||
|
|
| `UserInvitationManager` | Invitations, member updates, and ownership transfer |
|
||
|
|
| `BillingPlanManager` | Billing plan state and Paddle config endpoint |
|
||
|
|
| `AppManager` | Global app administration |
|
||
|
|
| `AppConnectionManager` | App connection tracking |
|
||
|
|
| `ActivityLogManager` | User activity logging |
|
||
|
|
| `OidcManager` | OIDC discovery, auth code flow, token exchange, userinfo, revoke |
|
||
|
|
|
||
|
|
## Local Development
|
||
|
|
|
||
|
|
From the repository root:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pnpm install
|
||
|
|
pnpm build
|
||
|
|
pnpm watch
|
||
|
|
```
|
||
|
|
|
||
|
|
The watch setup runs the backend from `ts/` and rebuilds the frontend bundle from `ts_web/`.
|
||
|
|
|
||
|
|
## License and Legal Information
|
||
|
|
|
||
|
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](../license) file.
|
||
|
|
|
||
|
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||
|
|
|
||
|
|
### Trademarks
|
||
|
|
|
||
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
||
|
|
|
||
|
|
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||
|
|
|
||
|
|
### Company Information
|
||
|
|
|
||
|
|
Task Venture Capital GmbH
|
||
|
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
||
|
|
|
||
|
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||
|
|
|
||
|
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|