@serve.zone/dcrouter-apiclient 32.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (200) hide show
  1. package/dist_ts_apiclient/classes.apitoken.d.ts +41 -0
  2. package/dist_ts_apiclient/classes.apitoken.js +115 -0
  3. package/dist_ts_apiclient/classes.certificate.d.ts +57 -0
  4. package/dist_ts_apiclient/classes.certificate.js +69 -0
  5. package/dist_ts_apiclient/classes.config.d.ts +7 -0
  6. package/dist_ts_apiclient/classes.config.js +11 -0
  7. package/dist_ts_apiclient/classes.dcrouterapiclient.d.ts +54 -0
  8. package/dist_ts_apiclient/classes.dcrouterapiclient.js +97 -0
  9. package/dist_ts_apiclient/classes.email.d.ts +30 -0
  10. package/dist_ts_apiclient/classes.email.js +52 -0
  11. package/dist_ts_apiclient/classes.gatewayclient.d.ts +28 -0
  12. package/dist_ts_apiclient/classes.gatewayclient.js +52 -0
  13. package/dist_ts_apiclient/classes.logs.d.ts +28 -0
  14. package/dist_ts_apiclient/classes.logs.js +69 -0
  15. package/dist_ts_apiclient/classes.radius.d.ts +59 -0
  16. package/dist_ts_apiclient/classes.radius.js +95 -0
  17. package/dist_ts_apiclient/classes.remoteingress.d.ts +66 -0
  18. package/dist_ts_apiclient/classes.remoteingress.js +164 -0
  19. package/dist_ts_apiclient/classes.route.d.ts +39 -0
  20. package/dist_ts_apiclient/classes.route.js +125 -0
  21. package/dist_ts_apiclient/classes.stats.d.ts +47 -0
  22. package/dist_ts_apiclient/classes.stats.js +38 -0
  23. package/dist_ts_apiclient/classes.testing.d.ts +65 -0
  24. package/dist_ts_apiclient/classes.testing.js +120 -0
  25. package/dist_ts_apiclient/index.d.ts +12 -0
  26. package/dist_ts_apiclient/index.js +16 -0
  27. package/dist_ts_apiclient/plugins.d.ts +4 -0
  28. package/dist_ts_apiclient/plugins.js +6 -0
  29. package/dist_ts_interfaces/data/acme-config.d.ts +23 -0
  30. package/dist_ts_interfaces/data/acme-config.js +2 -0
  31. package/dist_ts_interfaces/data/auth.d.ts +8 -0
  32. package/dist_ts_interfaces/data/auth.js +2 -0
  33. package/dist_ts_interfaces/data/config-events.d.ts +34 -0
  34. package/dist_ts_interfaces/data/config-events.js +8 -0
  35. package/dist_ts_interfaces/data/dns-authority.d.ts +98 -0
  36. package/dist_ts_interfaces/data/dns-authority.js +26 -0
  37. package/dist_ts_interfaces/data/dns-provider.d.ts +136 -0
  38. package/dist_ts_interfaces/data/dns-provider.js +41 -0
  39. package/dist_ts_interfaces/data/dns-record.d.ts +48 -0
  40. package/dist_ts_interfaces/data/dns-record.js +2 -0
  41. package/dist_ts_interfaces/data/domain.d.ts +35 -0
  42. package/dist_ts_interfaces/data/domain.js +2 -0
  43. package/dist_ts_interfaces/data/email-domain.d.ts +177 -0
  44. package/dist_ts_interfaces/data/email-domain.js +2 -0
  45. package/dist_ts_interfaces/data/email-settings.d.ts +68 -0
  46. package/dist_ts_interfaces/data/email-settings.js +2 -0
  47. package/dist_ts_interfaces/data/index.d.ts +18 -0
  48. package/dist_ts_interfaces/data/index.js +19 -0
  49. package/dist_ts_interfaces/data/remoteingress.d.ts +181 -0
  50. package/dist_ts_interfaces/data/remoteingress.js +15 -0
  51. package/dist_ts_interfaces/data/route-management.d.ts +270 -0
  52. package/dist_ts_interfaces/data/route-management.js +130 -0
  53. package/dist_ts_interfaces/data/security-policy.d.ts +32 -0
  54. package/dist_ts_interfaces/data/security-policy.js +2 -0
  55. package/dist_ts_interfaces/data/smtp-account.d.ts +50 -0
  56. package/dist_ts_interfaces/data/smtp-account.js +9 -0
  57. package/dist_ts_interfaces/data/stats.d.ts +283 -0
  58. package/dist_ts_interfaces/data/stats.js +2 -0
  59. package/dist_ts_interfaces/data/target-profile.d.ts +30 -0
  60. package/dist_ts_interfaces/data/target-profile.js +2 -0
  61. package/dist_ts_interfaces/data/testing.d.ts +191 -0
  62. package/dist_ts_interfaces/data/testing.js +20 -0
  63. package/dist_ts_interfaces/data/vpn.d.ts +65 -0
  64. package/dist_ts_interfaces/data/vpn.js +2 -0
  65. package/dist_ts_interfaces/data/workhoster.d.ts +63 -0
  66. package/dist_ts_interfaces/data/workhoster.js +2 -0
  67. package/dist_ts_interfaces/index.d.ts +5 -0
  68. package/dist_ts_interfaces/index.js +8 -0
  69. package/dist_ts_interfaces/plugins.d.ts +2 -0
  70. package/dist_ts_interfaces/plugins.js +4 -0
  71. package/dist_ts_interfaces/requests/acme-config.d.ts +42 -0
  72. package/dist_ts_interfaces/requests/acme-config.js +2 -0
  73. package/dist_ts_interfaces/requests/admin.d.ts +69 -0
  74. package/dist_ts_interfaces/requests/admin.js +3 -0
  75. package/dist_ts_interfaces/requests/api-tokens.d.ts +85 -0
  76. package/dist_ts_interfaces/requests/api-tokens.js +2 -0
  77. package/dist_ts_interfaces/requests/certificate.d.ts +87 -0
  78. package/dist_ts_interfaces/requests/certificate.js +5 -0
  79. package/dist_ts_interfaces/requests/combined.stats.d.ts +29 -0
  80. package/dist_ts_interfaces/requests/combined.stats.js +2 -0
  81. package/dist_ts_interfaces/requests/config-events.d.ts +35 -0
  82. package/dist_ts_interfaces/requests/config-events.js +4 -0
  83. package/dist_ts_interfaces/requests/config.d.ts +93 -0
  84. package/dist_ts_interfaces/requests/config.js +3 -0
  85. package/dist_ts_interfaces/requests/dns-authority.d.ts +80 -0
  86. package/dist_ts_interfaces/requests/dns-authority.js +3 -0
  87. package/dist_ts_interfaces/requests/dns-providers.d.ts +117 -0
  88. package/dist_ts_interfaces/requests/dns-providers.js +2 -0
  89. package/dist_ts_interfaces/requests/dns-records.d.ts +89 -0
  90. package/dist_ts_interfaces/requests/dns-records.js +2 -0
  91. package/dist_ts_interfaces/requests/domains.d.ts +142 -0
  92. package/dist_ts_interfaces/requests/domains.js +2 -0
  93. package/dist_ts_interfaces/requests/email-domains.d.ts +154 -0
  94. package/dist_ts_interfaces/requests/email-domains.js +2 -0
  95. package/dist_ts_interfaces/requests/email-ops.d.ts +211 -0
  96. package/dist_ts_interfaces/requests/email-ops.js +3 -0
  97. package/dist_ts_interfaces/requests/email-settings.d.ts +26 -0
  98. package/dist_ts_interfaces/requests/email-settings.js +2 -0
  99. package/dist_ts_interfaces/requests/index.d.ts +29 -0
  100. package/dist_ts_interfaces/requests/index.js +30 -0
  101. package/dist_ts_interfaces/requests/logs.d.ts +43 -0
  102. package/dist_ts_interfaces/requests/logs.js +4 -0
  103. package/dist_ts_interfaces/requests/network-targets.d.ts +102 -0
  104. package/dist_ts_interfaces/requests/network-targets.js +2 -0
  105. package/dist_ts_interfaces/requests/radius.d.ts +280 -0
  106. package/dist_ts_interfaces/requests/radius.js +3 -0
  107. package/dist_ts_interfaces/requests/realtime.d.ts +38 -0
  108. package/dist_ts_interfaces/requests/realtime.js +12 -0
  109. package/dist_ts_interfaces/requests/remoteingress.d.ts +162 -0
  110. package/dist_ts_interfaces/requests/remoteingress.js +3 -0
  111. package/dist_ts_interfaces/requests/route-management.d.ts +147 -0
  112. package/dist_ts_interfaces/requests/route-management.js +2 -0
  113. package/dist_ts_interfaces/requests/security-policy.d.ts +105 -0
  114. package/dist_ts_interfaces/requests/security-policy.js +2 -0
  115. package/dist_ts_interfaces/requests/smtp-accounts.d.ts +125 -0
  116. package/dist_ts_interfaces/requests/smtp-accounts.js +2 -0
  117. package/dist_ts_interfaces/requests/source-profiles.d.ts +102 -0
  118. package/dist_ts_interfaces/requests/source-profiles.js +2 -0
  119. package/dist_ts_interfaces/requests/stats.d.ts +196 -0
  120. package/dist_ts_interfaces/requests/stats.js +4 -0
  121. package/dist_ts_interfaces/requests/target-profiles.d.ts +105 -0
  122. package/dist_ts_interfaces/requests/target-profiles.js +2 -0
  123. package/dist_ts_interfaces/requests/testing.d.ts +169 -0
  124. package/dist_ts_interfaces/requests/testing.js +2 -0
  125. package/dist_ts_interfaces/requests/users.d.ts +53 -0
  126. package/dist_ts_interfaces/requests/users.js +3 -0
  127. package/dist_ts_interfaces/requests/vpn.d.ts +188 -0
  128. package/dist_ts_interfaces/requests/vpn.js +3 -0
  129. package/dist_ts_interfaces/requests/workhoster.d.ts +79 -0
  130. package/dist_ts_interfaces/requests/workhoster.js +2 -0
  131. package/license +21 -0
  132. package/package.json +67 -0
  133. package/readme.md +218 -0
  134. package/ts_apiclient/classes.apitoken.ts +157 -0
  135. package/ts_apiclient/classes.certificate.ts +124 -0
  136. package/ts_apiclient/classes.config.ts +17 -0
  137. package/ts_apiclient/classes.dcrouterapiclient.ts +138 -0
  138. package/ts_apiclient/classes.email.ts +77 -0
  139. package/ts_apiclient/classes.gatewayclient.ts +110 -0
  140. package/ts_apiclient/classes.logs.ts +91 -0
  141. package/ts_apiclient/classes.radius.ts +180 -0
  142. package/ts_apiclient/classes.remoteingress.ts +217 -0
  143. package/ts_apiclient/classes.route.ts +166 -0
  144. package/ts_apiclient/classes.stats.ts +111 -0
  145. package/ts_apiclient/classes.testing.ts +152 -0
  146. package/ts_apiclient/index.ts +17 -0
  147. package/ts_apiclient/plugins.ts +10 -0
  148. package/ts_apiclient/readme.md +218 -0
  149. package/ts_interfaces/data/acme-config.ts +23 -0
  150. package/ts_interfaces/data/auth.ts +8 -0
  151. package/ts_interfaces/data/config-events.ts +38 -0
  152. package/ts_interfaces/data/dns-authority.ts +106 -0
  153. package/ts_interfaces/data/dns-provider.ts +174 -0
  154. package/ts_interfaces/data/dns-record.ts +50 -0
  155. package/ts_interfaces/data/domain.ts +36 -0
  156. package/ts_interfaces/data/email-domain.ts +206 -0
  157. package/ts_interfaces/data/email-settings.ts +75 -0
  158. package/ts_interfaces/data/index.ts +18 -0
  159. package/ts_interfaces/data/remoteingress.ts +204 -0
  160. package/ts_interfaces/data/route-management.ts +436 -0
  161. package/ts_interfaces/data/security-policy.ts +37 -0
  162. package/ts_interfaces/data/smtp-account.ts +63 -0
  163. package/ts_interfaces/data/stats.ts +305 -0
  164. package/ts_interfaces/data/target-profile.ts +31 -0
  165. package/ts_interfaces/data/testing.ts +184 -0
  166. package/ts_interfaces/data/vpn.ts +68 -0
  167. package/ts_interfaces/data/workhoster.ts +72 -0
  168. package/ts_interfaces/index.ts +9 -0
  169. package/ts_interfaces/plugins.ts +6 -0
  170. package/ts_interfaces/readme.md +194 -0
  171. package/ts_interfaces/requests/acme-config.ts +54 -0
  172. package/ts_interfaces/requests/admin.ts +96 -0
  173. package/ts_interfaces/requests/api-tokens.ts +109 -0
  174. package/ts_interfaces/requests/certificate.ts +106 -0
  175. package/ts_interfaces/requests/combined.stats.ts +30 -0
  176. package/ts_interfaces/requests/config-events.ts +45 -0
  177. package/ts_interfaces/requests/config.ts +94 -0
  178. package/ts_interfaces/requests/dns-authority.ts +104 -0
  179. package/ts_interfaces/requests/dns-providers.ts +154 -0
  180. package/ts_interfaces/requests/dns-records.ts +113 -0
  181. package/ts_interfaces/requests/domains.ts +178 -0
  182. package/ts_interfaces/requests/email-domains.ts +193 -0
  183. package/ts_interfaces/requests/email-ops.ts +266 -0
  184. package/ts_interfaces/requests/email-settings.ts +34 -0
  185. package/ts_interfaces/requests/index.ts +29 -0
  186. package/ts_interfaces/requests/logs.ts +58 -0
  187. package/ts_interfaces/requests/network-targets.ts +127 -0
  188. package/ts_interfaces/requests/radius.ts +341 -0
  189. package/ts_interfaces/requests/realtime.ts +59 -0
  190. package/ts_interfaces/requests/remoteingress.ts +202 -0
  191. package/ts_interfaces/requests/route-management.ts +194 -0
  192. package/ts_interfaces/requests/security-policy.ts +144 -0
  193. package/ts_interfaces/requests/smtp-accounts.ts +163 -0
  194. package/ts_interfaces/requests/source-profiles.ts +127 -0
  195. package/ts_interfaces/requests/stats.ts +207 -0
  196. package/ts_interfaces/requests/target-profiles.ts +130 -0
  197. package/ts_interfaces/requests/testing.ts +186 -0
  198. package/ts_interfaces/requests/users.ts +66 -0
  199. package/ts_interfaces/requests/vpn.ts +238 -0
  200. package/ts_interfaces/requests/workhoster.ts +100 -0
@@ -0,0 +1,75 @@
1
+ import type { IUnifiedEmailServerOptions } from '@push.rocks/smartmta';
2
+
3
+ /** Outbound SMTP egress mode. 'remoteIngress' (default): deliver via RemoteIngress edges only,
4
+ * no direct-from-hub fallback. 'direct' is an explicit operator opt-out. */
5
+ export type TEmailOutboundMode = 'direct' | 'remoteIngress';
6
+
7
+ /** Readiness of the RemoteIngress outbound egress path — surfaced when outboundMode is 'remoteIngress'. */
8
+ export interface IEmailOutboundEgressStatus {
9
+ ready: boolean;
10
+ eligibleEdgeCount: number;
11
+ /** Populated when not ready, e.g. 'no connected mail edge with native QUIC egress'. */
12
+ reason?: string;
13
+ }
14
+
15
+ /** Lifecycle state of the smartmta Rust mailer bridge. 'failed' and 'restarting' mean mail processing is degraded. */
16
+ export type TEmailBridgeState = 'idle' | 'starting' | 'running' | 'restarting' | 'failed' | 'stopped';
17
+
18
+ export interface IEmailPortConfig {
19
+ /** External to internal SMTP port mapping. */
20
+ portMapping?: Record<number, number>;
21
+ /** Custom route settings for specific external ports. */
22
+ portSettings?: Record<number, {
23
+ terminateTls?: boolean;
24
+ routeName?: string;
25
+ [key: string]: unknown;
26
+ }>;
27
+ /** Path to store received emails, when configured by the runtime. */
28
+ receivedEmailsPath?: string;
29
+ }
30
+
31
+ export interface IEmailServerSettings {
32
+ enabled: boolean;
33
+ hostname: string | null;
34
+ outboundMode: TEmailOutboundMode;
35
+ ports: number[];
36
+ portMapping: Record<number, number> | null;
37
+ receivedEmailsPath: string | null;
38
+ maxMessageSize: number | null;
39
+ domainCount: number;
40
+ routeCount: number;
41
+ authUserCount: number;
42
+ /** Operator-managed SMTP submission accounts (hashed credentials, DB-backed). */
43
+ smtpAccountCount?: number;
44
+ /** Present when the email server is running: whether the SMTP listener is accepting connections. */
45
+ smtpListenerActive?: boolean;
46
+ /** Present when outboundMode is 'remoteIngress': whether a mail egress edge is currently available. */
47
+ outboundEgress?: IEmailOutboundEgressStatus;
48
+ /** Present when the email server is running: current state of the Rust mailer bridge. */
49
+ mailerBridgeState?: TEmailBridgeState;
50
+ updatedAt: number;
51
+ updatedBy: string;
52
+ }
53
+
54
+ export interface IEmailServerSettingsSeed {
55
+ enabled?: boolean;
56
+ outboundMode?: TEmailOutboundMode;
57
+ emailConfig?: IUnifiedEmailServerOptions;
58
+ emailPortConfig?: IEmailPortConfig;
59
+ }
60
+
61
+ export type TEmailServerSettingsUpdate = {
62
+ enabled?: boolean;
63
+ hostname?: string | null;
64
+ outboundMode?: TEmailOutboundMode;
65
+ ports?: number[];
66
+ portMapping?: Record<number, number> | null;
67
+ receivedEmailsPath?: string | null;
68
+ maxMessageSize?: number | null;
69
+ /**
70
+ * Exact names of persisted legacy routes to remove (the internal-relay
71
+ * retirement lever). Fails loudly on unknown names and refuses generated
72
+ * managed routes ('workapp-mail-*', 'smtp-account-*').
73
+ */
74
+ removeRouteNames?: string[];
75
+ };
@@ -0,0 +1,18 @@
1
+ export * from './auth.js';
2
+ export * from './stats.js';
3
+ export * from './remoteingress.js';
4
+ export * from './route-management.js';
5
+ export * from './target-profile.js';
6
+ export * from './vpn.js';
7
+ export * from './dns-provider.js';
8
+ export * from './domain.js';
9
+ export * from './dns-authority.js';
10
+ export * from './workhoster.js';
11
+ export * from './dns-record.js';
12
+ export * from './acme-config.js';
13
+ export * from './email-domain.js';
14
+ export * from './email-settings.js';
15
+ export * from './smtp-account.js';
16
+ export * from './security-policy.js';
17
+ export * from './config-events.js';
18
+ export * from './testing.js';
@@ -0,0 +1,204 @@
1
+ import type { IRouteConfig } from '@push.rocks/smartproxy';
2
+
3
+ /** Edges tagged 'mail' bind SMTP ports and are eligible for outbound SMTP egress and mail DNS fronting. */
4
+ export const REMOTE_INGRESS_MAIL_TAG = 'mail';
5
+ /** Edges tagged 'dns' forward public TCP/UDP 53 to the hub's authoritative DNS. */
6
+ export const REMOTE_INGRESS_DNS_TAG = 'dns';
7
+
8
+ /*
9
+ * Edge capability tokens exchanged on the RemoteIngress wire. The remoteingress core
10
+ * emits them from its Rust implementation and its TS entry exports no constants for
11
+ * them (see the capability table in the @serve.zone/remoteingress readme), so the hub
12
+ * side owns exactly one copy here and every dcrouter capability check reads it.
13
+ */
14
+ /** The edge accepts hub-initiated outbound TCP egress proxies. Absent it, egress is refused. */
15
+ export const REMOTE_INGRESS_EGRESS_TCP_CAPABILITY = 'egressTcp';
16
+ /** The edge reports its bound egress source addresses, which the hub exposes as identity status. */
17
+ export const REMOTE_INGRESS_EGRESS_IDENTITY_CAPABILITY = 'egressIdentity';
18
+
19
+ /**
20
+ * A stored remote ingress edge registration.
21
+ */
22
+ export interface IRemoteIngress {
23
+ id: string;
24
+ name: string;
25
+ secret: string;
26
+ listenPorts: number[];
27
+ /** UDP listen ports (e.g. for QUIC/HTTP3). Derived from routes with transport 'udp' or 'all'. */
28
+ listenPortsUdp?: number[];
29
+ enabled: boolean;
30
+ /** Whether to auto-derive ports from remoteIngress-tagged routes. Defaults to true. */
31
+ autoDerivePorts: boolean;
32
+ /** Optional per-edge performance overrides. */
33
+ performance?: IRemoteIngressPerformanceConfig;
34
+ /** Optional per-edge outbound egress policy. Omitted or disabled means no egress. */
35
+ egress?: IRemoteIngressEgressPolicyConfig;
36
+ tags?: string[];
37
+ /** Operator-declared public IPv4 of the edge host — used to generate mail/DNS A records. */
38
+ publicIp?: string;
39
+ /** Operator-declared public IPv6 of the edge host — used to generate AAAA records once the edge has an IPv6 PTR. */
40
+ publicIpV6?: string;
41
+ /** FQDN matching this edge's PTR record — used as per-delivery outbound EHLO identity and FCrDNS A record. */
42
+ mailHostname?: string;
43
+ createdAt: number;
44
+ updatedAt: number;
45
+ /** Effective ports (union of manual + derived) — only present in API responses. */
46
+ effectiveListenPorts?: number[];
47
+ /** Ports explicitly set by the user — only present in API responses. */
48
+ manualPorts?: number[];
49
+ /** Ports auto-derived from route configs — only present in API responses. */
50
+ derivedPorts?: number[];
51
+ /** Effective UDP ports (union of manual + derived) — only present in API responses. */
52
+ effectiveListenPortsUdp?: number[];
53
+ }
54
+
55
+ /**
56
+ * Runtime status of a remote ingress edge.
57
+ */
58
+ export interface IRemoteIngressStatus {
59
+ edgeId: string;
60
+ connected: boolean;
61
+ publicIp: string | null;
62
+ activeTunnels: number;
63
+ lastHeartbeat: number | null;
64
+ connectedAt: number | null;
65
+ transportMode?: 'tcpTls' | 'quic' | 'quicWithFallback';
66
+ fallbackUsed?: boolean;
67
+ capabilities?: string[];
68
+ egressEnabled?: boolean;
69
+ performance?: IRemoteIngressPerformanceEffective;
70
+ flowControl?: IRemoteIngressFlowControlStatus;
71
+ queues?: IRemoteIngressQueueStatus;
72
+ traffic?: IRemoteIngressTrafficStatus;
73
+ udp?: IRemoteIngressUdpStatus;
74
+ }
75
+
76
+ export type TRemoteIngressPerformanceProfile = 'balanced' | 'throughput' | 'highConcurrency';
77
+
78
+ export interface IRemoteIngressPerformanceConfig {
79
+ profile?: TRemoteIngressPerformanceProfile;
80
+ maxStreamsPerEdge?: number;
81
+ totalWindowBudgetBytes?: number;
82
+ minStreamWindowBytes?: number;
83
+ maxStreamWindowBytes?: number;
84
+ sustainedStreamWindowBytes?: number;
85
+ quicDatagramReceiveBufferBytes?: number;
86
+ streamFramePayloadBytes?: number;
87
+ firstDataConnectTimeoutMs?: number;
88
+ clientWriteTimeoutMs?: number;
89
+ /** Streams retained after the backend sent FIN while the client upload stays open; 0 disables backend-initiated retention. */
90
+ maxHalfClosedStreams?: number;
91
+ /** Hard deadline in milliseconds for directional half-close draining. */
92
+ halfCloseDrainTimeoutMs?: number;
93
+ serverFirstPorts?: number[];
94
+ }
95
+
96
+ export interface IRemoteIngressEgressPolicyConfig {
97
+ /** Enables edge-originating outbound TCP egress. Currently limited to SMTP port 25. */
98
+ enabled: boolean;
99
+ /** Allowed destination ports. dcrouter currently accepts only [25]. */
100
+ allowedPorts?: number[];
101
+ /** Allow private destination ranges in addition to public ranges. Defaults to false. */
102
+ allowPrivateRanges?: boolean;
103
+ /** CIDRs denied after edge-side DNS resolution. */
104
+ deniedCidrs?: string[];
105
+ /** Optional host allow patterns evaluated by the edge before dialing. */
106
+ allowedHostPatterns?: string[];
107
+ /** Optional per-edge concurrent egress stream cap. */
108
+ maxConcurrentStreams?: number;
109
+ }
110
+
111
+ export interface IRemoteIngressHubSettings {
112
+ enabled: boolean;
113
+ tunnelPort: number;
114
+ hubDomain?: string;
115
+ performance?: IRemoteIngressPerformanceConfig;
116
+ updatedAt: number;
117
+ updatedBy: string;
118
+ }
119
+
120
+ export type TRemoteIngressHubSettingsUpdate = Partial<Pick<IRemoteIngressHubSettings, 'enabled' | 'tunnelPort'>> & {
121
+ hubDomain?: string | null;
122
+ performance?: IRemoteIngressPerformanceConfig | null;
123
+ };
124
+
125
+ export interface IRemoteIngressPerformanceEffective {
126
+ profile: TRemoteIngressPerformanceProfile;
127
+ maxStreamsPerEdge: number;
128
+ totalWindowBudgetBytes: number;
129
+ minStreamWindowBytes: number;
130
+ maxStreamWindowBytes: number;
131
+ sustainedStreamWindowBytes: number;
132
+ quicDatagramReceiveBufferBytes: number;
133
+ streamFramePayloadBytes: number;
134
+ firstDataConnectTimeoutMs: number;
135
+ clientWriteTimeoutMs: number;
136
+ serverFirstPorts: number[];
137
+ }
138
+
139
+ export interface IRemoteIngressFlowControlStatus {
140
+ applies: boolean;
141
+ currentWindowBytes: number;
142
+ minWindowBytes: number;
143
+ maxWindowBytes: number;
144
+ totalWindowBudgetBytes: number;
145
+ estimatedInFlightBytes: number;
146
+ stalledStreams: number;
147
+ }
148
+
149
+ export interface IRemoteIngressQueueStatus {
150
+ ctrlQueueDepth: number;
151
+ dataQueueDepth: number;
152
+ sustainedQueueDepth: number;
153
+ }
154
+
155
+ export interface IRemoteIngressTrafficStatus {
156
+ bytesIn: number;
157
+ bytesOut: number;
158
+ streamsOpenedTotal: number;
159
+ streamsClosedTotal: number;
160
+ rejectedStreams: number;
161
+ }
162
+
163
+ export interface IRemoteIngressUdpStatus {
164
+ activeSessions: number;
165
+ droppedDatagrams: number;
166
+ }
167
+
168
+ /**
169
+ * Route-level remote ingress configuration.
170
+ * When attached to a route, signals that traffic for this route
171
+ * should be accepted from remote edge nodes.
172
+ */
173
+ export interface IRouteRemoteIngress {
174
+ /** Whether this route receives traffic from edge nodes */
175
+ enabled: boolean;
176
+ /** Optional filter: only edges whose id or tags match get this route's ports.
177
+ * When absent, the route applies to all edges. */
178
+ edgeFilter?: string[];
179
+ }
180
+
181
+ export interface IRouteIngress {
182
+ /** Accept traffic connected directly to the gateway hub listener. */
183
+ directHub: boolean;
184
+ /** Accept authenticated SmartVPN traffic carrying trusted VPN metadata. */
185
+ smartVpn: boolean;
186
+ }
187
+
188
+ /**
189
+ * Extended route config used within dcrouter.
190
+ * Adds explicit ingress path policy and dcrouter compatibility properties to
191
+ * SmartProxy's IRouteConfig.
192
+ * SmartProxy ignores unknown properties at runtime.
193
+ */
194
+ export type IDcRouterRouteConfig = IRouteConfig & {
195
+ /**
196
+ * Explicit trusted ingress paths. New routes must opt in; direct hub
197
+ * listening is intentionally not a default.
198
+ */
199
+ ingress?: IRouteIngress;
200
+ remoteIngress?: IRouteRemoteIngress;
201
+ /** Compatibility policy: only VPN clients whose TargetProfile matches this route get access.
202
+ * Matching is determined by domain overlap, target overlap, or direct routeRef. */
203
+ vpnOnly?: boolean;
204
+ };