@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,305 @@
1
+ export interface IServerStats {
2
+ uptime: number;
3
+ startTime: number;
4
+ memoryUsage: {
5
+ heapUsed: number;
6
+ heapTotal: number;
7
+ external: number;
8
+ rss: number;
9
+ // SmartMetrics memory data
10
+ maxMemoryMB?: number;
11
+ actualUsageBytes?: number;
12
+ actualUsagePercentage?: number;
13
+ };
14
+ cpuUsage: {
15
+ user: number;
16
+ system: number;
17
+ };
18
+ activeConnections: number;
19
+ totalConnections: number;
20
+ requestsPerSecond: number;
21
+ throughput: {
22
+ bytesIn: number;
23
+ bytesOut: number;
24
+ bytesInPerSecond: number;
25
+ bytesOutPerSecond: number;
26
+ };
27
+ }
28
+
29
+ export interface ITimeSeriesPoint {
30
+ timestamp: number;
31
+ value: number;
32
+ }
33
+
34
+ export interface IEmailStats {
35
+ sent: number;
36
+ received: number;
37
+ bounced: number;
38
+ queued: number;
39
+ failed: number;
40
+ averageDeliveryTime: number;
41
+ deliveryRate: number;
42
+ bounceRate: number;
43
+ timeSeries?: {
44
+ sent: ITimeSeriesPoint[];
45
+ received: ITimeSeriesPoint[];
46
+ failed: ITimeSeriesPoint[];
47
+ };
48
+ }
49
+
50
+ export interface IDnsStats {
51
+ totalQueries: number;
52
+ cacheHits: number;
53
+ cacheMisses: number;
54
+ cacheHitRate: number;
55
+ activeDomains: number;
56
+ averageResponseTime: number;
57
+ queryTypes: {
58
+ [key: string]: number;
59
+ };
60
+ timeSeries?: {
61
+ queries: ITimeSeriesPoint[];
62
+ };
63
+ recentQueries?: Array<{
64
+ timestamp: number;
65
+ domain: string;
66
+ type: string;
67
+ answered: boolean;
68
+ responseTimeMs: number;
69
+ }>;
70
+ }
71
+
72
+ export interface IRateLimitInfo {
73
+ domain: string;
74
+ currentRate: number;
75
+ limit: number;
76
+ remaining: number;
77
+ resetTime: number;
78
+ blocked: boolean;
79
+ }
80
+
81
+ export interface ISecurityEvent {
82
+ timestamp: number;
83
+ level: string;
84
+ type: string;
85
+ message: string;
86
+ details?: any;
87
+ ipAddress?: string;
88
+ domain?: string;
89
+ success?: boolean;
90
+ }
91
+
92
+ export type TAuthenticationSource = 'auto' | 'local' | 'idp.global';
93
+ export type TResolvedAuthenticationSource = Exclude<TAuthenticationSource, 'auto'>;
94
+ export type TAuthenticationFailureReason =
95
+ | 'invalidCredentials'
96
+ | 'serviceUnavailable'
97
+ | 'identityIssuanceFailed'
98
+ | 'internalError';
99
+
100
+ export interface IAuthenticationEvent {
101
+ id: string;
102
+ timestamp: number;
103
+ username: string;
104
+ userId?: string;
105
+ success: boolean;
106
+ requestedAuthSource: TAuthenticationSource;
107
+ resolvedAuthSource?: TResolvedAuthenticationSource;
108
+ failureReason?: TAuthenticationFailureReason;
109
+ }
110
+
111
+ export interface ISecurityMetrics {
112
+ blockedIPs: string[];
113
+ reputationScores: {
114
+ [domain: string]: number;
115
+ };
116
+ spamDetected: number;
117
+ malwareDetected: number;
118
+ phishingDetected: number;
119
+ authenticationFailures: number;
120
+ authenticationSuccesses: number;
121
+ authenticationWindowStart: number;
122
+ authenticationEvents?: IAuthenticationEvent[];
123
+ suspiciousActivities: number;
124
+ recentEvents?: ISecurityEvent[];
125
+ }
126
+
127
+ export interface ILogEntry {
128
+ timestamp: number;
129
+ level: 'debug' | 'info' | 'warn' | 'error';
130
+ category: 'smtp' | 'dns' | 'security' | 'system' | 'email';
131
+ message: string;
132
+ metadata?: any;
133
+ }
134
+
135
+ export interface IConnectionInfo {
136
+ id: string;
137
+ remoteAddress: string;
138
+ localAddress: string;
139
+ startTime: number;
140
+ protocol: 'smtp' | 'smtps' | 'http' | 'https';
141
+ state: 'connecting' | 'connected' | 'authenticated' | 'transmitting' | 'closing';
142
+ bytesReceived: number;
143
+ bytesSent: number;
144
+ /** Present when the row is an aggregate, e.g. one row per remote IP. */
145
+ connectionCount?: number;
146
+ }
147
+
148
+ export interface IQueueStatus {
149
+ name: string;
150
+ size: number;
151
+ processing: number;
152
+ failed: number;
153
+ retrying: number;
154
+ averageProcessingTime: number;
155
+ }
156
+
157
+ export interface IHealthStatus {
158
+ healthy: boolean;
159
+ uptime: number;
160
+ services: {
161
+ [service: string]: {
162
+ status: 'healthy' | 'degraded' | 'unhealthy';
163
+ message?: string;
164
+ lastCheck: number;
165
+ };
166
+ };
167
+ version?: string;
168
+ }
169
+
170
+ export interface IDomainActivity {
171
+ domain: string;
172
+ bytesInPerSecond: number;
173
+ bytesOutPerSecond: number;
174
+ activeConnections: number;
175
+ routeCount: number;
176
+ /** Lifetime request count when available from SmartProxy. */
177
+ requestCount: number;
178
+ /** Live HTTP request rate when SmartProxy exposes per-domain rates. */
179
+ requestsPerSecond?: number;
180
+ /** HTTP requests over the last minute when SmartProxy exposes per-domain rates. */
181
+ requestsLastMinute?: number;
182
+ }
183
+
184
+ export interface IAsnActivity {
185
+ asn: number;
186
+ organization: string;
187
+ country: string | null;
188
+ activeConnections: number;
189
+ ipCount: number;
190
+ bytesInPerSecond: number;
191
+ bytesOutPerSecond: number;
192
+ sampleIps: string[];
193
+ }
194
+
195
+ export interface IProtocolConnectionHistoryPoint {
196
+ timestamp: number;
197
+ total: number;
198
+ protocols: Record<string, number>;
199
+ }
200
+
201
+ export interface INetworkMetrics {
202
+ totalBandwidth: {
203
+ in: number;
204
+ out: number;
205
+ };
206
+ totalBytes?: {
207
+ in: number;
208
+ out: number;
209
+ };
210
+ activeConnections: number;
211
+ connectionDetails: IConnectionDetails[];
212
+ topEndpoints: Array<{
213
+ endpoint: string;
214
+ connections: number;
215
+ bandwidth: {
216
+ in: number;
217
+ out: number;
218
+ };
219
+ }>;
220
+ topEndpointsByBandwidth: Array<{
221
+ endpoint: string;
222
+ connections: number;
223
+ bandwidth: {
224
+ in: number;
225
+ out: number;
226
+ };
227
+ }>;
228
+ topASNs: IAsnActivity[];
229
+ domainActivity: IDomainActivity[];
230
+ throughputHistory?: Array<{ timestamp: number; in: number; out: number }>;
231
+ frontendConnectionHistory?: IProtocolConnectionHistoryPoint[];
232
+ backendConnectionHistory?: IProtocolConnectionHistoryPoint[];
233
+ requestsPerSecond?: number;
234
+ requestsTotal?: number;
235
+ backends?: IBackendInfo[];
236
+ frontendProtocols?: IProtocolDistribution | null;
237
+ backendProtocols?: IProtocolDistribution | null;
238
+ }
239
+
240
+ export interface IProtocolDistribution {
241
+ h1Active: number;
242
+ h1Total: number;
243
+ h2Active: number;
244
+ h2Total: number;
245
+ h3Active: number;
246
+ h3Total: number;
247
+ wsActive: number;
248
+ wsTotal: number;
249
+ otherActive: number;
250
+ otherTotal: number;
251
+ }
252
+
253
+ export interface IConnectionDetails {
254
+ remoteAddress: string;
255
+ protocol: 'http' | 'https' | 'smtp' | 'smtps';
256
+ state: 'connecting' | 'connected' | 'established' | 'closing';
257
+ startTime: number;
258
+ bytesIn: number;
259
+ bytesOut: number;
260
+ /** Present when the row is an aggregate, e.g. one row per remote IP. */
261
+ connectionCount?: number;
262
+ }
263
+
264
+ export interface IBackendInfo {
265
+ id?: string;
266
+ backend: string;
267
+ domain: string | null;
268
+ protocol: string;
269
+ activeConnections: number;
270
+ totalConnections: number;
271
+ connectErrors: number;
272
+ handshakeErrors: number;
273
+ requestErrors: number;
274
+ avgConnectTimeMs: number;
275
+ poolHitRate: number;
276
+ h2Failures: number;
277
+ h2Suppressed: boolean;
278
+ h3Suppressed: boolean;
279
+ h2CooldownRemainingSecs: number | null;
280
+ h3CooldownRemainingSecs: number | null;
281
+ h2ConsecutiveFailures: number | null;
282
+ h3ConsecutiveFailures: number | null;
283
+ h3Port: number | null;
284
+ cacheAgeSecs: number | null;
285
+ }
286
+
287
+ export interface IRadiusStats {
288
+ running: boolean;
289
+ uptime: number;
290
+ authRequests: number;
291
+ authAccepts: number;
292
+ authRejects: number;
293
+ accountingRequests: number;
294
+ activeSessions: number;
295
+ totalInputBytes: number;
296
+ totalOutputBytes: number;
297
+ }
298
+
299
+ export interface IVpnStats {
300
+ running: boolean;
301
+ subnet: string;
302
+ registeredClients: number;
303
+ connectedClients: number;
304
+ wgListenPort: number;
305
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * A specific IP:port target within a TargetProfile.
3
+ */
4
+ export interface ITargetProfileTarget {
5
+ ip: string;
6
+ port: number;
7
+ }
8
+
9
+ /**
10
+ * A reusable, named target profile that defines what resources a VPN client can reach.
11
+ * Assigned to VPN clients via targetProfileIds.
12
+ *
13
+ * SourceProfile = source-side (who can access: ipAllowList, rateLimit, auth)
14
+ * TargetProfile = target-side (what can be accessed: domains, IP:port targets, route refs)
15
+ */
16
+ export interface ITargetProfile {
17
+ id: string;
18
+ name: string;
19
+ description?: string;
20
+ /** Domain patterns this profile grants access to (supports wildcards: '*.example.com') */
21
+ domains?: string[];
22
+ /** Specific IP:port targets this profile grants access to */
23
+ targets?: ITargetProfileTarget[];
24
+ /** Route references by stored route ID. Legacy route names are normalized when unique. */
25
+ routeRefs?: string[];
26
+ /** Also allow routes whose source security would allow the VPN client's real connecting IP. */
27
+ allowRoutesByClientSourceIp?: boolean;
28
+ createdAt: number;
29
+ updatedAt: number;
30
+ createdBy: string;
31
+ }
@@ -0,0 +1,184 @@
1
+ import type { IIdentity } from './auth.js';
2
+
3
+ /** V1 limits are server-enforced. Unresolved effects never expire automatically. */
4
+ export const testingLimits = {
5
+ defaultPageSize: 25,
6
+ maxPageSize: 100,
7
+ maxRegistrations: 1000,
8
+ maxZones: 100,
9
+ maxGrantsPerRegistration: 25,
10
+ maxActiveJobsPerRegistration: 8,
11
+ maxUnresolvedOperationsPerRegistration: 32,
12
+ maxRetainedOperationsPerRegistration: 1000,
13
+ maxIdempotencyReceiptsPerRegistration: 1000,
14
+ maxDnsRecordsPerGrant: 10,
15
+ maxWorkers: 2,
16
+ maxPendingAccessRequests: 128,
17
+ pollAfterMs: 2000,
18
+ leaseMs: 120000,
19
+ resolvedRetentionMs: 30 * 86400000,
20
+ maxCredentialLifetimeMs: 366 * 86400000,
21
+ } as const;
22
+
23
+ export type TTestingErrorCode =
24
+ | 'unauthorized' | 'forbidden' | 'invalid_input' | 'not_found' | 'expired'
25
+ | 'zone_unavailable' | 'approval_required' | 'grant_denied' | 'grant_revoked'
26
+ | 'ownership_conflict' | 'revision_conflict' | 'idempotency_conflict'
27
+ | 'quota_exceeded' | 'rate_limited' | 'acme_unavailable' | 'issuance_failed'
28
+ | 'provider_unavailable' | 'service_unavailable' | 'indeterminate' | 'recovery_not_supported'
29
+ | 'credential_unavailable';
30
+
31
+ export interface ITestingError {
32
+ code: TTestingErrorCode;
33
+ /** Fixed safe explanation; never a provider response, request envelope, or key. */
34
+ message: string;
35
+ retryAt?: number;
36
+ }
37
+
38
+ export type TTestingResult<T> = { ok: true; value: T } | { ok: false; error: ITestingError };
39
+ export interface ITestingMachineAuth { apiToken: string; }
40
+ /** Exactly one credential source is accepted, and it must resolve to an admin. */
41
+ export interface ITestingAdminAuth { identity?: IIdentity; apiToken?: string; }
42
+ /** Lists shared by machines and admins still apply the corresponding role guard. */
43
+ export interface ITestingReadAuth { identity?: IIdentity; apiToken?: string; }
44
+ export interface ITestingPageRequest { afterId?: string; limit?: number; }
45
+ export interface ITestingPage<T> { items: T[]; nextAfterId: string | null; }
46
+ export interface ITestingMutationRequest { idempotencyKey: string; }
47
+
48
+ export interface ITestingRegistration {
49
+ id: string;
50
+ displayName: string;
51
+ state: 'active' | 'revoked';
52
+ credentialGeneration: number;
53
+ credentialExpiresAt: number;
54
+ revision: number;
55
+ createdAt: number;
56
+ updatedAt: number;
57
+ createdBy: string;
58
+ revokedBy?: string;
59
+ revocationReason?: string;
60
+ }
61
+
62
+ /** Secret-bearing response: suppress request hooks and never log or cache it. */
63
+ export interface ITestingRegistrationCredential {
64
+ registration: ITestingRegistration;
65
+ token: string;
66
+ }
67
+
68
+ export type TTestingDnsRecordType = 'A' | 'AAAA' | 'CNAME';
69
+ export interface ITestingZonePolicy {
70
+ domainId: string;
71
+ enabled: boolean;
72
+ permittedRecordTypes: TTestingDnsRecordType[];
73
+ minTtl: number;
74
+ maxTtl: number;
75
+ maxGrants: number;
76
+ }
77
+ export interface ITestingZone extends ITestingZonePolicy {
78
+ id: string;
79
+ name: string;
80
+ revision: number;
81
+ createdAt: number;
82
+ updatedAt: number;
83
+ updatedBy: string;
84
+ }
85
+
86
+ export type TTestingGrantState = 'pending' | 'approved' | 'denied' | 'revoked';
87
+ export interface ITestingDomainGrant {
88
+ id: string;
89
+ registrationId: string;
90
+ zoneId: string;
91
+ /** Canonical exact FQDN; no wildcard, parent, or descendant authority. */
92
+ hostname: string;
93
+ state: TTestingGrantState;
94
+ revision: number;
95
+ createdAt: number;
96
+ updatedAt: number;
97
+ reviewedAt?: number;
98
+ reviewedBy?: string;
99
+ reviewReason?: string;
100
+ cleanupState: 'none' | 'pending' | 'completed' | 'indeterminate';
101
+ }
102
+
103
+ export interface ITestingCertificateMetadata {
104
+ id: string;
105
+ identifiers: string[];
106
+ fingerprintSha256: string;
107
+ validFrom: number;
108
+ validUntil: number;
109
+ renewAfter: number;
110
+ }
111
+ /** Only the authorized download response contains PEM material. */
112
+ export interface ITestingCertificateDownload extends ITestingCertificateMetadata {
113
+ certificatePem: string;
114
+ privateKeyPem: string;
115
+ }
116
+
117
+ export type TTestingCertificateJobState =
118
+ | 'queued' | 'running' | 'retry_wait' | 'indeterminate' | 'ready'
119
+ | 'failed' | 'cancelled' | 'abandoned_unverified';
120
+
121
+ export interface ITestingOperationMetadata {
122
+ id: string;
123
+ grantId: string;
124
+ revision: number;
125
+ createdAt: number;
126
+ updatedAt: number;
127
+ attempts: number;
128
+ pollAfterMs: number;
129
+ retryAt?: number;
130
+ expiresAt?: number;
131
+ }
132
+ export type TTestingCertificateJob = ITestingOperationMetadata & (
133
+ | { state: 'ready'; certificate: ITestingCertificateMetadata }
134
+ | { state: Exclude<TTestingCertificateJobState, 'ready'>; error?: ITestingError }
135
+ );
136
+
137
+ export interface ITestingDnsRecord {
138
+ clientRecordKey: string;
139
+ grantId: string;
140
+ hostname: string;
141
+ type: TTestingDnsRecordType;
142
+ value: string;
143
+ ttl: number;
144
+ revision: number;
145
+ createdAt: number;
146
+ updatedAt: number;
147
+ }
148
+ export type TTestingDnsMutationState =
149
+ | 'queued' | 'running' | 'retry_wait' | 'indeterminate' | 'succeeded'
150
+ | 'failed' | 'cancelled' | 'abandoned_unverified';
151
+ export type TTestingDnsMutationResult =
152
+ | { action: 'upsert'; record: ITestingDnsRecord }
153
+ | { action: 'delete'; clientRecordKey: string; revision: number };
154
+ export type TTestingDnsMutation = ITestingOperationMetadata & (
155
+ | { state: 'succeeded'; result: TTestingDnsMutationResult }
156
+ | { state: Exclude<TTestingDnsMutationState, 'succeeded'>; error?: ITestingError }
157
+ );
158
+
159
+ export type TTestingOperationKind = 'certificate' | 'dns';
160
+ export type TTestingRecoveryAction = 'recheck' | 'retry-proven-unapplied' | 'abandon';
161
+ export type TTestingRecoveryEvidence =
162
+ | 'intent_persisted' | 'effect_unacknowledged' | 'effect_acknowledged'
163
+ | 'effect_proven_unapplied' | 'outcome_verified' | 'cleanup_pending'
164
+ | 'abandoned_unverified';
165
+ export interface ITestingRecoveryAudit {
166
+ operatorId: string;
167
+ action: TTestingRecoveryAction;
168
+ reason: string;
169
+ at: number;
170
+ }
171
+ export interface ITestingOperationRecovery {
172
+ kind: TTestingOperationKind;
173
+ operationId: string;
174
+ registrationId: string;
175
+ grantId: string;
176
+ revision: number;
177
+ state: TTestingCertificateJobState | TTestingDnsMutationState;
178
+ evidence: TTestingRecoveryEvidence;
179
+ supportedActions: TTestingRecoveryAction[];
180
+ createdAt: number;
181
+ updatedAt: number;
182
+ error?: ITestingError;
183
+ lastRecovery?: ITestingRecoveryAudit;
184
+ }
@@ -0,0 +1,68 @@
1
+ /**
2
+ * A registered VPN client (secrets excluded from API responses).
3
+ */
4
+ export interface IVpnClient {
5
+ clientId: string;
6
+ enabled: boolean;
7
+ /** IDs of TargetProfiles assigned to this client */
8
+ targetProfileIds?: string[];
9
+ description?: string;
10
+ assignedIp?: string;
11
+ createdAt: number;
12
+ updatedAt: number;
13
+ expiresAt?: string;
14
+ destinationAllowList?: string[];
15
+ destinationBlockList?: string[];
16
+ useHostIp?: boolean;
17
+ useDhcp?: boolean;
18
+ staticIp?: string;
19
+ forceVlan?: boolean;
20
+ vlanId?: number;
21
+ }
22
+
23
+ /**
24
+ * VPN server status.
25
+ */
26
+ export interface IVpnServerStatus {
27
+ running: boolean;
28
+ subnet: string;
29
+ wgListenPort: number;
30
+ serverPublicKeys: {
31
+ noisePublicKey: string;
32
+ wgPublicKey: string;
33
+ } | null;
34
+ registeredClients: number;
35
+ connectedClients: number;
36
+ }
37
+
38
+ /**
39
+ * A currently connected VPN client (runtime info from the daemon).
40
+ */
41
+ export interface IVpnConnectedClient {
42
+ clientId: string;
43
+ assignedIp: string;
44
+ connectedSince: string;
45
+ bytesSent: number;
46
+ bytesReceived: number;
47
+ transport: string;
48
+ /** Real client IP:port reported by the VPN transport, when available. */
49
+ remoteAddr?: string;
50
+ /** Parsed real client IP reported by the VPN transport, when available. */
51
+ sourceIp?: string;
52
+ }
53
+
54
+ /**
55
+ * VPN client telemetry data.
56
+ */
57
+ export interface IVpnClientTelemetry {
58
+ clientId: string;
59
+ assignedIp: string;
60
+ bytesSent: number;
61
+ bytesReceived: number;
62
+ packetsDropped: number;
63
+ bytesDropped: number;
64
+ lastKeepaliveAt?: string;
65
+ keepalivesReceived: number;
66
+ rateLimitBytesPerSec?: number;
67
+ burstBytes?: number;
68
+ }
@@ -0,0 +1,72 @@
1
+ import type { IApiTokenPolicy, TGatewayClientType } from './route-management.js';
2
+
3
+ // The machine-facing gateway client contracts live in @serve.zone/interfaces
4
+ // (data/gateway.ts). This file keeps only dcrouter-local shapes.
5
+
6
+ export interface IGatewayClient {
7
+ id: string;
8
+ type: TGatewayClientType;
9
+ name: string;
10
+ description?: string;
11
+ hostnamePatterns: string[];
12
+ allowedRouteTargets: NonNullable<IApiTokenPolicy['allowedRouteTargets']>;
13
+ capabilities: NonNullable<IApiTokenPolicy['capabilities']>;
14
+ enabled: boolean;
15
+ tokenCount?: number;
16
+ policyGeneration: number;
17
+ createdAt: number;
18
+ updatedAt: number;
19
+ createdBy: string;
20
+ }
21
+
22
+ export interface IWorkAppMailOwnership {
23
+ workHosterType: TGatewayClientType;
24
+ workHosterId: string;
25
+ workAppId: string;
26
+ }
27
+
28
+ export interface IWorkAppMailInboundRoute {
29
+ enabled: boolean;
30
+ targetHost: string;
31
+ targetPort: number;
32
+ preserveHeaders?: boolean;
33
+ addHeaders?: Record<string, string>;
34
+ }
35
+
36
+ export interface IWorkAppMailIdentity {
37
+ id: string;
38
+ externalKey: string;
39
+ ownership: IWorkAppMailOwnership;
40
+ address: string;
41
+ localPart: string;
42
+ domain: string;
43
+ enabled: boolean;
44
+ displayName?: string;
45
+ inbound?: IWorkAppMailInboundRoute;
46
+ smtp: {
47
+ enabled: boolean;
48
+ username: string;
49
+ };
50
+ createdAt: number;
51
+ updatedAt: number;
52
+ createdBy: string;
53
+ }
54
+
55
+ export interface IWorkAppMailCredentials {
56
+ username: string;
57
+ password: string;
58
+ host?: string;
59
+ ports?: {
60
+ smtp?: number;
61
+ submission?: number;
62
+ smtps?: number;
63
+ };
64
+ }
65
+
66
+ export interface IWorkAppMailIdentitySyncResult {
67
+ success: boolean;
68
+ action?: 'created' | 'updated' | 'deleted' | 'unchanged';
69
+ identity?: IWorkAppMailIdentity;
70
+ smtpCredentials?: IWorkAppMailCredentials;
71
+ message?: string;
72
+ }
@@ -0,0 +1,9 @@
1
+ export * from './plugins.js';
2
+
3
+ // Data types
4
+ import * as data from './data/index.js';
5
+ export { data };
6
+
7
+ // Request interfaces
8
+ import * as requests from './requests/index.js';
9
+ export { requests };
@@ -0,0 +1,6 @@
1
+ // @apiglobal scope
2
+ import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
3
+
4
+ export {
5
+ typedrequestInterfaces
6
+ }