@serve.zone/dcrouter-interfaces

@serve.zone/dcrouter-interfaces contains the shared TypeScript data models and TypedRequest contracts used by dcrouter's OpsServer, dashboard, API client, tests, and external automation.

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.

Install

pnpm add @serve.zone/dcrouter-interfaces

The same contracts are exposed through the main package subpath:

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

What It Exports

Export	Purpose
`data`	Shared runtime-shaped models such as identities, routes, DNS records, domains, email domains, remote ingress edges, VPN objects, stats, and security policy data.
`requests`	TypedRequest request/response contracts for OpsServer methods.
`typedrequestInterfaces`	Helper types re-exported from `@api.global/typedrequest-interfaces` through `plugins.ts`.

Covered API Areas

Area	Examples
Auth	admin login, logout, identity verification, users
Routes	merged route listing, API route CRUD, toggles, warnings, ownership metadata
Access	API tokens, source profiles, target profiles, network targets
DNS and domains	DNS providers, domains, DNS records, ACME config
Email	email-domain management and email operations
Edge services	remote ingress, VPN, RADIUS
Observability	stats, combined stats, logs, configuration
WorkHoster	external app/workhoster route ownership contracts

Raw TypedRequest 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.enabled, route.systemKey);
}

When To Use It

Use it in custom CLIs that call dcrouter's TypedRequest API directly.
Use it in tests that need request/response types without the OO client.
Use it in integrations where server and client code need the same data shapes.
Use @serve.zone/dcrouter-apiclient instead when you want higher-level managers and builders.

Development

This folder is published from the dcrouter monorepo via tspublish.json with order 1, before the client package that imports it.

Useful source entry points:

index.ts exports data and requests namespaces.
data/index.ts groups shared data models.
requests/index.ts groups TypedRequest contracts.
data/route-management.ts defines route ownership, API token scopes, profiles, and network target shapes.

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.8 KiB Raw Blame History