111 lines
4.9 KiB
Markdown
111 lines
4.9 KiB
Markdown
# @serve.zone/dcrouter-interfaces
|
|
|
|
Shared TypeScript request and data interfaces for dcrouter's OpsServer API. 📡
|
|
|
|
This package is the contract layer for typed clients, frontend code, tests, or automation that talks to a running dcrouter instance through TypedRequest.
|
|
|
|
## 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.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pnpm add @serve.zone/dcrouter-interfaces
|
|
```
|
|
|
|
Or consume the same interfaces through the main package:
|
|
|
|
```typescript
|
|
import { data, requests } from '@serve.zone/dcrouter/interfaces';
|
|
```
|
|
|
|
## What It Exports
|
|
|
|
The package exposes two namespaces from `index.ts`:
|
|
|
|
| Export | Purpose |
|
|
| --- | --- |
|
|
| `data` | Shared runtime-shaped types such as route data, auth identity, stats, domains, certificates, VPN, DNS, and email-domain data |
|
|
| `requests` | TypedRequest request and response contracts for every OpsServer endpoint |
|
|
|
|
## Example
|
|
|
|
```typescript
|
|
import * as typedrequest from '@api.global/typedrequest';
|
|
import { data, requests } from '@serve.zone/dcrouter-interfaces';
|
|
|
|
const identity: data.IIdentity = {
|
|
jwt: 'jwt-token',
|
|
userId: 'admin-1',
|
|
name: 'Admin',
|
|
expiresAt: Date.now() + 60_000,
|
|
role: 'admin',
|
|
};
|
|
|
|
const request = new typedrequest.TypedRequest<requests.IReq_GetMergedRoutes>(
|
|
'https://dcrouter.example.com/typedrequest',
|
|
'getMergedRoutes',
|
|
);
|
|
|
|
const response = await request.fire({ identity });
|
|
|
|
for (const route of response.routes) {
|
|
console.log(route.id, route.origin, route.systemKey, route.enabled);
|
|
}
|
|
```
|
|
|
|
## API Domains Covered
|
|
|
|
| Domain | Examples |
|
|
| --- | --- |
|
|
| Auth | admin login, logout, identity verification |
|
|
| Routes | merged routes, create, update, delete, toggle |
|
|
| Access | API tokens, source profiles, target profiles, network targets |
|
|
| DNS and domains | providers, domains, DNS records |
|
|
| Certificates | overview, reprovision, import, export, delete, ACME config |
|
|
| Email | email operations, email domains |
|
|
| Remote ingress | edge registrations, status, connection tokens |
|
|
| VPN | clients, status, telemetry, lifecycle |
|
|
| RADIUS | clients, VLANs, sessions, accounting |
|
|
| Observability | stats, logs, health, configuration |
|
|
|
|
## Notable Data Types
|
|
|
|
| Type | Description |
|
|
| --- | --- |
|
|
| `data.IMergedRoute` | Route entry returned by route management, including `origin`, `enabled`, and optional `systemKey` |
|
|
| `data.IDcRouterRouteConfig` | dcrouter-flavored route config used across the stack |
|
|
| `data.IRouteMetadata` | Reference metadata connecting routes to source profiles or network targets |
|
|
| `data.IIdentity` | Admin identity used for authenticated requests |
|
|
| `data.IApiTokenInfo` | Public token metadata without the secret |
|
|
|
|
## When To Use This Package
|
|
|
|
- Use it in custom dashboards or CLIs that call TypedRequest directly.
|
|
- Use it in tests that need strongly typed request payloads or response assertions.
|
|
- Use it when you want the API contract without pulling in the OO client.
|
|
|
|
If you want a higher-level client with managers and resource classes, use `@serve.zone/dcrouter-apiclient` instead.
|
|
|
|
## 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.
|