@serve.zone/interfaces 30.11.0 → 30.13.0

package/ts/requests/coremail.ts

@@ -10,6 +10,7 @@ import type {
   ICoreMailRecipientResolution,
   ICoreMailReconciliationStatus,
   ICoreMailReplicaIdentity,
+  ICoreMailServiceMailStatistics,
   ICoreMailSubmission,
   ICoreMailUploadGrant,
   TCoreMailInboundAckOutcome,
@@ -237,6 +238,33 @@ export interface IReq_CoreMailGetReconciliationStatus extends plugins.typedreque
   };
 }
 
+/**
+ * Control-session read of per-service mail counters. Authority comes from the
+ * authenticated control session; the request carries no tenant or binding
+ * authority of its own.
+ */
+export interface IReq_CoreMailGetServiceMailStatistics extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_CoreMailGetServiceMailStatistics
+> {
+  method: 'coreMailGetServiceMailStatistics';
+  request: {
+    /** Inclusive first UTC calendar day, `YYYY-MM-DD`. */
+    fromDayUtc: string;
+    /** Inclusive last UTC calendar day, `YYYY-MM-DD`. */
+    toDayUtc: string;
+    /** Optional service filter. Omitted means every service known to this CoreMail. */
+    serviceIds?: string[];
+    /** Opaque CoreMail-owned composite cursor. */
+    cursor?: string;
+    limit: number;
+  };
+  response: {
+    statistics: ICoreMailServiceMailStatistics[];
+    nextCursor?: string;
+  };
+}
+
 export interface IReq_CoreMailGatewayAuthenticate extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
   IReq_CoreMailGatewayAuthenticate
@@ -256,6 +284,13 @@ export interface IReq_CoreMailGatewayAuthenticate extends plugins.typedrequestIn
   };
 }
 
+/**
+ * CoreMail binds every issued routing handle to a digest of the exact
+ * normalized `envelope` and `source` sent here. The following
+ * `coreMailGatewayPrepareInboundHandoff` call must therefore resend
+ * byte-identical values: the full `rcptTo` set in the same order, the same
+ * `mailFrom`, and the same connection source fields.
+ */
 export interface IReq_CoreMailGatewayResolveRecipients extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
   IReq_CoreMailGatewayResolveRecipients
@@ -271,6 +306,13 @@ export interface IReq_CoreMailGatewayResolveRecipients extends plugins.typedrequ
   };
 }
 
+/**
+ * The handoff is validated against the routing handles issued by
+ * `coreMailGatewayResolveRecipients`. `message.envelope` and `source` must be
+ * byte-identical to the resolve-time values, including the full `rcptTo` set in
+ * the same order, because CoreMail recomputes the envelope digest the handles
+ * are bound to.
+ */
 export interface IReq_CoreMailGatewayPrepareInboundHandoff extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
   IReq_CoreMailGatewayPrepareInboundHandoff
@@ -343,6 +385,12 @@ export interface IReq_CoreMailGatewayCompleteOutboundHandoff extends plugins.typ
   };
 }
 
+/**
+ * Status polling for one accepted transport message. `status.updatedAt` must be
+ * monotonic per `transportMessageId`. A `transportMessageId` that is
+ * permanently unknown to the gateway must be answered with a terminal `failed`
+ * status rather than an error, because CoreMail retries errors indefinitely.
+ */
 export interface IReq_CoreMailGatewayGetOutboundStatus extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
   IReq_CoreMailGatewayGetOutboundStatus

package/ts/requests/mail.ts

@@ -1,4 +1,5 @@
 import * as plugins from '../plugins.js';
+import type { ICoreMailGatewayPeerDesiredState } from '../data/coremail.js';
 import type { IIdentity } from '../data/user.js';
 import type {
   IMailAddressBinding,
@@ -144,6 +145,67 @@ export interface IReq_DeleteMailAddressBinding extends plugins.typedrequestInter
   };
 }
 
+/**
+ * dcrouter-owned CoreMail gateway peer state.
+ *
+ * `peer.transferOrigin` must equal the `gateway.coreMailTransferOrigin` carried
+ * in that CoreMail service's own desired state. The producer (Cloudly or
+ * Onebox) is the single owner of that string: dcrouter never infers it from a
+ * socket, Host header, TypedSocket tag, or peer input.
+ */
+export interface IReq_ListCoreMailGatewayPeers extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_ListCoreMailGatewayPeers
+> {
+  method: 'listCoreMailGatewayPeers';
+  request: {
+    auth: IMailControlRequestAuth;
+    owner: IMailResourceOwner;
+  };
+  response: {
+    peers: ICoreMailGatewayPeerDesiredState[];
+  };
+}
+
+/**
+ * Creates or replaces one CoreMail gateway peer. On success the accepted peer is
+ * returned in its stored form so the producer can compare the exact applied
+ * state. `owner` is required (not partial) because a peer is producer-owned
+ * provisioning state, never a filtered listing.
+ */
+export interface IReq_SyncCoreMailGatewayPeer extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_SyncCoreMailGatewayPeer
+> {
+  method: 'syncCoreMailGatewayPeer';
+  request: {
+    auth: IMailControlRequestAuth;
+    owner: IMailResourceOwner;
+    peer: ICoreMailGatewayPeerDesiredState;
+  };
+  response: {
+    success: boolean;
+    peer?: ICoreMailGatewayPeerDesiredState;
+    message?: string;
+  };
+}
+
+export interface IReq_DeleteCoreMailGatewayPeer extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_DeleteCoreMailGatewayPeer
+> {
+  method: 'deleteCoreMailGatewayPeer';
+  request: {
+    auth: IMailControlRequestAuth;
+    owner: IMailResourceOwner;
+    coreMailServiceId: string;
+  };
+  response: {
+    success: boolean;
+    message?: string;
+  };
+}
+
 export interface IReq_ListWorkAppMailBindings extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
   IReq_ListWorkAppMailBindings

package/ts/requests/runtimesession.ts

@@ -3,6 +3,16 @@ import type * as data from '../data/runtimesession.js';
 import type * as terminal from '../data/runtimeterminalreceipt.js';
 import type * as network from '../data/networkdelivery.js';
 import type * as protection from '../data/networkprotection.js';
+import type * as credential from '../data/networkcredential.js';
+
+/** Current-peer, exact-projection authorization; response contains secret keys. */
+export interface IReq_Pallet_Controller_GetRuntimeManagedVpnCredentialV1 extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest, IReq_Pallet_Controller_GetRuntimeManagedVpnCredentialV1
+> {
+  method: 'getRuntimeManagedVpnCredentialV1';
+  request: credential.IGetRuntimeManagedVpnCredentialRequestV1;
+  response: credential.IGetRuntimeManagedVpnCredentialResponseV1;
+}
 
 /** Current authenticated peer reports its durable complete native protection journal. */
 export interface IReq_Pallet_Controller_ReportRuntimeNetworkProtectionV1 extends plugins.typedrequestInterfaces.implementsTR<