129 lines
4.0 KiB
Markdown
129 lines
4.0 KiB
Markdown
# @idp.global/interfaces
|
|
|
|
Shared TypeScript contracts for the `idp.global` backend, browser client, CLI, and frontend.
|
|
|
|
Use this package when you want typed request/response payloads and shared data models for users, sessions, organizations, apps, billing, and OIDC.
|
|
|
|
## 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.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
pnpm add @idp.global/interfaces
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```ts
|
|
import { data, request, tags } from '@idp.global/interfaces';
|
|
|
|
const loginRequest: request.IReq_LoginWithEmailOrUsernameAndPassword['request'] = {
|
|
username: 'user@example.com',
|
|
password: 'secret',
|
|
};
|
|
|
|
const organization: data.IOrganization = {
|
|
id: 'org_1',
|
|
data: {
|
|
name: 'Acme',
|
|
slug: 'acme',
|
|
billingPlanId: 'plan_free',
|
|
roleIds: [],
|
|
},
|
|
};
|
|
```
|
|
|
|
## Exports
|
|
|
|
### `data`
|
|
|
|
The `data` export includes types for:
|
|
|
|
- users
|
|
- organizations
|
|
- roles
|
|
- JWT payloads
|
|
- login sessions
|
|
- devices
|
|
- activity logs
|
|
- apps and app connections
|
|
- billing plans and Paddle checkout data
|
|
- OIDC data structures
|
|
- invitations
|
|
|
|
### `request`
|
|
|
|
The `request` export includes typed request contracts for:
|
|
|
|
- login, logout, refresh, password reset, and device attachment
|
|
- registration flow requests
|
|
- user and session queries
|
|
- organization CRUD-style requests
|
|
- invitations and membership changes
|
|
- app and admin actions
|
|
- billing and JWT validation support
|
|
|
|
### `tags`
|
|
|
|
Shared tag exports live under `tags/`.
|
|
|
|
## Layout
|
|
|
|
| Path | Purpose |
|
|
| --- | --- |
|
|
| `data/index.ts` | Re-exports all shared data interfaces |
|
|
| `request/index.ts` | Re-exports all typed request contracts |
|
|
| `tags/index.ts` | Re-exports shared tags |
|
|
|
|
## Examples
|
|
|
|
### Login Contract
|
|
|
|
```ts
|
|
type TLogin = request.IReq_LoginWithEmailOrUsernameAndPassword;
|
|
|
|
const payload: TLogin['request'] = {
|
|
username: 'user@example.com',
|
|
password: 'secret',
|
|
};
|
|
```
|
|
|
|
### Session Contract
|
|
|
|
```ts
|
|
type TSessions = request.IReq_GetUserSessions['response']['sessions'];
|
|
```
|
|
|
|
### OIDC Contract
|
|
|
|
```ts
|
|
type TUserInfo = data.IUserInfoResponse;
|
|
```
|
|
|
|
## Scope
|
|
|
|
This package is intentionally contract-only. It does not open sockets, store auth state, or perform HTTP/websocket communication by itself.
|
|
|
|
## 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.
|