@serve.zone/interfaces 7.19.0 → 7.21.0

package/changelog.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 2026-06-11 - 7.21.0
+
+### Features
+
+- add Cloudly mail overview request interfaces (mail)
+  - Adds interfaces for mail overview domains and recent email queue entries.
+  - Defines the getMailOverview typed request contract with configuration status, gateway URL, domains, emails, and error text.
+
+## 2026-06-11 - 7.20.0
+
+### Features
+
+- add live proxy traffic stats request interfaces (requests)
+  - Add per-host traffic stats shape with byte rates, request rate, and active connections
+  - Add Cloudly, coreflow, and coretraffic request contracts for retrieving live traffic stats
+
 ## 2026-06-11 - 7.19.0
 
 ### Features

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@serve.zone/interfaces',
-    version: '7.19.0',
+    version: '7.21.0',
     description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLHVGQUF1RjtDQUNyRyxDQUFBIn0=

package/dist_ts/requests/mail.d.ts

@@ -199,3 +199,35 @@ export interface IReq_EnqueueMail extends plugins.typedrequestInterfaces.impleme
         message?: string;
     };
 }
+/**
+ * Cloudly admin UI mail overview, relayed from the hub dcrouter's ops API.
+ * Read-only summary: configured email domains and recent queue entries.
+ */
+export interface IMailOverviewDomain {
+    domain: string;
+    dnsMode?: string;
+    status?: string;
+}
+export interface IMailOverviewEmail {
+    id: string;
+    direction?: string;
+    from?: string;
+    to?: string;
+    subject?: string;
+    status?: string;
+    timestamp?: number;
+}
+export interface IReq_Any_Cloudly_GetMailOverview extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_GetMailOverview> {
+    method: 'getMailOverview';
+    request: {
+        identity: IIdentity;
+    };
+    response: {
+        /** False when no dcrouter ops API token is configured in settings. */
+        configured: boolean;
+        gatewayUrl?: string;
+        domains: IMailOverviewDomain[];
+        emails: IMailOverviewEmail[];
+        errorText?: string;
+    };
+}

package/dist_ts/requests/node.d.ts

@@ -128,6 +128,22 @@ export interface IReq_Any_Cloudly_GetNodeActions extends plugins.typedrequestInt
         actions: INodeAction[];
     };
 }
+/**
+ * Admin UI asks Cloudly for a node's live proxy traffic rates; Cloudly
+ * relays to the node's coreflow which queries its local coretraffic.
+ */
+export interface IReq_Any_Cloudly_GetNodeTrafficStats extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_GetNodeTrafficStats> {
+    method: 'getNodeTrafficStats';
+    request: {
+        identity: IIdentity;
+        nodeId: string;
+        windowSeconds?: number;
+    };
+    response: {
+        hosts: import('./routing.js').ITrafficHostStats[];
+        timestamp: number;
+    };
+}
 /**
  * Cloudly -> admin UIs: live node metrics relay (1s cadence, not persisted).
  */

package/dist_ts/requests/routing.d.ts

@@ -21,3 +21,41 @@ export interface IRequest_Coretraffic_Coreflow_GetCurrentRouting {
         reverseConfigs: IReverseProxyConfig[];
     };
 }
+/**
+ * Live proxy traffic rates for one served hostname.
+ */
+export interface ITrafficHostStats {
+    hostName: string;
+    bytesInPerSec: number;
+    bytesOutPerSec: number;
+    requestsPerSec: number;
+    connectionsActive: number;
+}
+/**
+ * Coreflow asks its local coretraffic for current per-hostname traffic
+ * rates (sourced from the proxy's metrics, not persisted).
+ */
+export interface IRequest_Coreflow_Coretraffic_GetTrafficStats {
+    method: 'getTrafficStats';
+    request: {
+        windowSeconds?: number;
+    };
+    response: {
+        hosts: ITrafficHostStats[];
+        timestamp: number;
+    };
+}
+/**
+ * Cloudly asks a node's coreflow for that node's current proxy traffic
+ * rates; coreflow relays to its local coretraffic.
+ */
+export interface IRequest_Cloudly_Coreflow_GetTrafficStats {
+    method: 'coreflowGetTrafficStats';
+    request: {
+        windowSeconds?: number;
+    };
+    response: {
+        hosts: ITrafficHostStats[];
+        timestamp: number;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serve.zone/interfaces",
-  "version": "7.19.0",
+  "version": "7.21.0",
   "private": false,
   "description": "Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.",
   "exports": {

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@serve.zone/interfaces',
-  version: '7.19.0',
+  version: '7.21.0',
   description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
 }

package/ts/requests/mail.ts

@@ -288,3 +288,41 @@ export interface IReq_EnqueueMail extends plugins.typedrequestInterfaces.impleme
     message?: string;
   };
 }
+
+/**
+ * Cloudly admin UI mail overview, relayed from the hub dcrouter's ops API.
+ * Read-only summary: configured email domains and recent queue entries.
+ */
+export interface IMailOverviewDomain {
+  domain: string;
+  dnsMode?: string;
+  status?: string;
+}
+
+export interface IMailOverviewEmail {
+  id: string;
+  direction?: string;
+  from?: string;
+  to?: string;
+  subject?: string;
+  status?: string;
+  timestamp?: number;
+}
+
+export interface IReq_Any_Cloudly_GetMailOverview extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetMailOverview
+> {
+  method: 'getMailOverview';
+  request: {
+    identity: IIdentity;
+  };
+  response: {
+    /** False when no dcrouter ops API token is configured in settings. */
+    configured: boolean;
+    gatewayUrl?: string;
+    domains: IMailOverviewDomain[];
+    emails: IMailOverviewEmail[];
+    errorText?: string;
+  };
+}

package/ts/requests/node.ts

@@ -164,6 +164,26 @@ export interface IReq_Any_Cloudly_GetNodeActions extends plugins.typedrequestInt
   };
 }
 
+/**
+ * Admin UI asks Cloudly for a node's live proxy traffic rates; Cloudly
+ * relays to the node's coreflow which queries its local coretraffic.
+ */
+export interface IReq_Any_Cloudly_GetNodeTrafficStats extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_GetNodeTrafficStats
+> {
+  method: 'getNodeTrafficStats';
+  request: {
+    identity: IIdentity;
+    nodeId: string;
+    windowSeconds?: number;
+  };
+  response: {
+    hosts: import('./routing.js').ITrafficHostStats[];
+    timestamp: number;
+  };
+}
+
 /**
  * Cloudly -> admin UIs: live node metrics relay (1s cadence, not persisted).
  */

package/ts/requests/routing.ts

@@ -23,3 +23,44 @@ export interface IRequest_Coretraffic_Coreflow_GetCurrentRouting {
     reverseConfigs: IReverseProxyConfig[];
   };
 }
+
+/**
+ * Live proxy traffic rates for one served hostname.
+ */
+export interface ITrafficHostStats {
+  hostName: string;
+  bytesInPerSec: number;
+  bytesOutPerSec: number;
+  requestsPerSec: number;
+  connectionsActive: number;
+}
+
+/**
+ * Coreflow asks its local coretraffic for current per-hostname traffic
+ * rates (sourced from the proxy's metrics, not persisted).
+ */
+export interface IRequest_Coreflow_Coretraffic_GetTrafficStats {
+  method: 'getTrafficStats';
+  request: {
+    windowSeconds?: number;
+  };
+  response: {
+    hosts: ITrafficHostStats[];
+    timestamp: number;
+  };
+}
+
+/**
+ * Cloudly asks a node's coreflow for that node's current proxy traffic
+ * rates; coreflow relays to its local coretraffic.
+ */
+export interface IRequest_Cloudly_Coreflow_GetTrafficStats {
+  method: 'coreflowGetTrafficStats';
+  request: {
+    windowSeconds?: number;
+  };
+  response: {
+    hosts: ITrafficHostStats[];
+    timestamp: number;
+  };
+}