@serve.zone/dcrouter-interfaces

Shared TypeScript contracts for dcrouter's TypedRequest API. Use this package when you want compile-time request/response types and shared data models without pulling in the higher-level client SDK.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit 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/ account to submit Pull Requests directly.

Installation

pnpm add @serve.zone/dcrouter-interfaces

You can also consume the same contracts through the main package subpath:

import { data, requests } from '@serve.zone/dcrouter/interfaces';

What It Exports

Export	Purpose
`data`	Shared runtime-shaped data such as identities, routes, stats, domains, DNS records, VPN data, remote ingress data, and email-domain data
`requests`	TypedRequest request/response contracts for OpsServer endpoints
`typedrequestInterfaces`	Re-exported helper types from `@api.global/typedrequest-interfaces`

API Surface Covered

Domain	Examples
Auth	login, logout, identity verification
Routes	list merged routes, create, update, delete, toggle
Access	API tokens, source profiles, target profiles, network targets, users
DNS and domains	providers, domains, DNS records, ACME config
Email	email operations and email-domain management
Edge services	remote ingress, VPN, RADIUS
Observability	stats, health, logs, configuration

Quick Example

import { 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',
  type: 'user',
};

const request = new 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);
}

When To Use This Package

Use it in tests that need strong request/response typing.
Use it in custom CLIs or dashboards that call TypedRequest directly.
Use it in shared code where both client and server need the same data shapes.

If you want managers, builders, and resource classes instead of raw contracts, use @serve.zone/dcrouter-apiclient.

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 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.

4.2 KiB Raw Blame History