@serve.zone/interfaces 7.3.0 → 7.4.0

package/changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2026-06-09 - 7.4.0
+
+### Features
+
+- add gateway-specific identity contract for gateway requests (gateway)
+  - Introduces IGatewayIdentity with open gateway role and type fields.
+  - Updates gateway request identity payloads to use IGatewayIdentity while remaining structurally compatible with platform identities.
+
 ## 2026-06-09 - 7.3.0
 
 ### Features

package/dist_ts/00_commitinfo_data.js

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

package/dist_ts/data/gateway.d.ts

@@ -3,6 +3,19 @@ import type { TDnsRecordType } from './dns.js';
  * Type of platform acting as a gateway client against a gateway (dcrouter).
  */
 export type TGatewayClientType = 'onebox' | 'cloudly' | 'custom';
+/**
+ * Identity attached to gateway requests. Gateways run their own user/auth
+ * domain (e.g. dcrouter operator accounts), so role/type stay open strings;
+ * platform identities (IIdentity) are structurally assignable to this shape.
+ */
+export interface IGatewayIdentity {
+    jwt: string;
+    userId: string;
+    name: string;
+    expiresAt: number;
+    role?: string;
+    type?: string;
+}
 /**
  * Role resolved for a gateway API token or identity.
  */

package/dist_ts/requests/gateway.d.ts

@@ -1,6 +1,5 @@
 import * as plugins from '../plugins.js';
-import type { IIdentity } from '../data/user.js';
-import type { IGatewayCapabilities, IGatewayClientContext, IGatewayClientOwnership, IGatewayDnsRecord, IGatewayDomain, IGatewayRouteConfig, IGatewayRouteSyncResult } from '../data/gateway.js';
+import type { IGatewayCapabilities, IGatewayClientContext, IGatewayClientOwnership, IGatewayDnsRecord, IGatewayDomain, IGatewayIdentity, IGatewayRouteConfig, IGatewayRouteSyncResult } from '../data/gateway.js';
 /**
  * Gateway client contracts: the machine-facing API a gateway (dcrouter)
  * serves to gateway clients (Onebox, Cloudly/Coreflow).
@@ -14,7 +13,7 @@ import type { IGatewayCapabilities, IGatewayClientContext, IGatewayClientOwnersh
 export interface IReq_GetGatewayCapabilities extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetGatewayCapabilities> {
     method: 'getGatewayCapabilities';
     request: {
-        identity?: IIdentity;
+        identity?: IGatewayIdentity;
         apiToken?: string;
     };
     response: {
@@ -24,7 +23,7 @@ export interface IReq_GetGatewayCapabilities extends plugins.typedrequestInterfa
 export interface IReq_GetGatewayClientContext extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetGatewayClientContext> {
     method: 'getGatewayClientContext';
     request: {
-        identity?: IIdentity;
+        identity?: IGatewayIdentity;
         apiToken?: string;
     };
     response: {
@@ -35,7 +34,7 @@ export interface IReq_GetGatewayClientContext extends plugins.typedrequestInterf
 export interface IReq_GetGatewayClientDomains extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetGatewayClientDomains> {
     method: 'getGatewayClientDomains';
     request: {
-        identity?: IIdentity;
+        identity?: IGatewayIdentity;
         apiToken?: string;
         gatewayClientId?: string;
     };
@@ -46,7 +45,7 @@ export interface IReq_GetGatewayClientDomains extends plugins.typedrequestInterf
 export interface IReq_GetGatewayClientDnsRecords extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetGatewayClientDnsRecords> {
     method: 'getGatewayClientDnsRecords';
     request: {
-        identity?: IIdentity;
+        identity?: IGatewayIdentity;
         apiToken?: string;
         gatewayClientId?: string;
     };
@@ -57,7 +56,7 @@ export interface IReq_GetGatewayClientDnsRecords extends plugins.typedrequestInt
 export interface IReq_SyncGatewayClientRoute extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_SyncGatewayClientRoute> {
     method: 'syncGatewayClientRoute';
     request: {
-        identity?: IIdentity;
+        identity?: IGatewayIdentity;
         apiToken?: string;
         ownership: IGatewayClientOwnership;
         route?: IGatewayRouteConfig;
@@ -69,7 +68,7 @@ export interface IReq_SyncGatewayClientRoute extends plugins.typedrequestInterfa
 export interface IReq_ExportCertificate extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ExportCertificate> {
     method: 'exportCertificate';
     request: {
-        identity?: IIdentity;
+        identity?: IGatewayIdentity;
         apiToken?: string;
         domain: string;
     };
@@ -82,7 +81,7 @@ export interface IReq_ExportCertificate extends plugins.typedrequestInterfaces.i
 export interface IReq_ImportCertificate extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_ImportCertificate> {
     method: 'importCertificate';
     request: {
-        identity?: IIdentity;
+        identity?: IGatewayIdentity;
         apiToken?: string;
         cert: plugins.tsclass.network.ICert;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serve.zone/interfaces",
-  "version": "7.3.0",
+  "version": "7.4.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.3.0',
+  version: '7.4.0',
   description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
 }

package/ts/data/gateway.ts

@@ -5,6 +5,20 @@ import type { TDnsRecordType } from './dns.js';
  */
 export type TGatewayClientType = 'onebox' | 'cloudly' | 'custom';
 
+/**
+ * Identity attached to gateway requests. Gateways run their own user/auth
+ * domain (e.g. dcrouter operator accounts), so role/type stay open strings;
+ * platform identities (IIdentity) are structurally assignable to this shape.
+ */
+export interface IGatewayIdentity {
+  jwt: string;
+  userId: string;
+  name: string;
+  expiresAt: number;
+  role?: string;
+  type?: string;
+}
+
 /**
  * Role resolved for a gateway API token or identity.
  */

package/ts/requests/gateway.ts

@@ -1,11 +1,11 @@
 import * as plugins from '../plugins.js';
-import type { IIdentity } from '../data/user.js';
 import type {
   IGatewayCapabilities,
   IGatewayClientContext,
   IGatewayClientOwnership,
   IGatewayDnsRecord,
   IGatewayDomain,
+  IGatewayIdentity,
   IGatewayRouteConfig,
   IGatewayRouteSyncResult,
 } from '../data/gateway.js';
@@ -27,7 +27,7 @@ export interface IReq_GetGatewayCapabilities extends plugins.typedrequestInterfa
 > {
   method: 'getGatewayCapabilities';
   request: {
-    identity?: IIdentity;
+    identity?: IGatewayIdentity;
     apiToken?: string;
   };
   response: {
@@ -41,7 +41,7 @@ export interface IReq_GetGatewayClientContext extends plugins.typedrequestInterf
 > {
   method: 'getGatewayClientContext';
   request: {
-    identity?: IIdentity;
+    identity?: IGatewayIdentity;
     apiToken?: string;
   };
   response: {
@@ -56,7 +56,7 @@ export interface IReq_GetGatewayClientDomains extends plugins.typedrequestInterf
 > {
   method: 'getGatewayClientDomains';
   request: {
-    identity?: IIdentity;
+    identity?: IGatewayIdentity;
     apiToken?: string;
     gatewayClientId?: string;
   };
@@ -71,7 +71,7 @@ export interface IReq_GetGatewayClientDnsRecords extends plugins.typedrequestInt
 > {
   method: 'getGatewayClientDnsRecords';
   request: {
-    identity?: IIdentity;
+    identity?: IGatewayIdentity;
     apiToken?: string;
     gatewayClientId?: string;
   };
@@ -86,7 +86,7 @@ export interface IReq_SyncGatewayClientRoute extends plugins.typedrequestInterfa
 > {
   method: 'syncGatewayClientRoute';
   request: {
-    identity?: IIdentity;
+    identity?: IGatewayIdentity;
     apiToken?: string;
     ownership: IGatewayClientOwnership;
     route?: IGatewayRouteConfig;
@@ -102,7 +102,7 @@ export interface IReq_ExportCertificate extends plugins.typedrequestInterfaces.i
 > {
   method: 'exportCertificate';
   request: {
-    identity?: IIdentity;
+    identity?: IGatewayIdentity;
     apiToken?: string;
     domain: string;
   };
@@ -119,7 +119,7 @@ export interface IReq_ImportCertificate extends plugins.typedrequestInterfaces.i
 > {
   method: 'importCertificate';
   request: {
-    identity?: IIdentity;
+    identity?: IGatewayIdentity;
     apiToken?: string;
     cert: plugins.tsclass.network.ICert;
   };