@serve.zone/interfaces 8.1.1 → 10.0.0

package/changelog.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 2026-07-10 - 10.0.0
+
+### Breaking Changes
+
+- accept JWT-only credentials for cluster config requests (config)
+  - Add IIdentityCredential as a JWT-only authentication contract.
+  - Make IIdentity extend IIdentityCredential so full identities remain compatible where credentials are accepted.
+  - Update getClusterConfig request identity to require only the JWT needed for server-side resolution.
+
+## 2026-07-10 - 9.0.0
+
+### Breaking Changes
+
+- require identity for baremetal request contracts (baremetal)
+  - Require identity on getBaremetalServers and controlBaremetal requests.
+  - Add typedrequest contract conformance to baremetal request interfaces.
+  - Update package manager metadata to pnpm 11.11.0.
+
 ## 2026-07-07 - 8.1.1
 
 ### Fixes

package/dist_ts/00_commitinfo_data.js

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

package/dist_ts/data/user.d.ts

@@ -3,18 +3,19 @@ export interface IToken {
     expiresAt: number;
     assignedRoles: string[];
 }
+export interface IIdentityCredential {
+    jwt: string;
+}
 /**
  * an identity is assumed by authentication as a user
  * an identity is ephemeral and has to be renewed regularly
  */
-export interface IIdentity {
+export interface IIdentity extends IIdentityCredential {
     name: string;
     userId: string;
     type: 'machine' | 'human';
     role: 'admin' | 'user' | 'api' | 'cluster';
     expiresAt: number;
-    /** the jwt token should contain above data for verification */
-    jwt: string;
 }
 export interface IUser {
     id: string;

package/dist_ts/requests/baremetal.d.ts

@@ -1,14 +1,19 @@
+import * as plugins from '../plugins.js';
 import type { IBareMetal } from '../data/baremetal.js';
-export interface IRequest_Any_Cloudly_GetBaremetalServers {
+import type { IIdentity } from '../data/user.js';
+export interface IRequest_Any_Cloudly_GetBaremetalServers extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_GetBaremetalServers> {
     method: 'getBaremetalServers';
-    request: {};
+    request: {
+        identity: IIdentity;
+    };
     response: {
         baremetals: IBareMetal[];
     };
 }
-export interface IRequest_Any_Cloudly_ControlBaremetal {
+export interface IRequest_Any_Cloudly_ControlBaremetal extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_ControlBaremetal> {
     method: 'controlBaremetal';
     request: {
+        identity: IIdentity;
         baremetalId: string;
         action: 'powerOn' | 'powerOff' | 'reset';
     };

package/dist_ts/requests/config.d.ts

@@ -17,7 +17,7 @@ export interface IRequest_Any_Cloudly_GetServerConfig extends plugins.typedreque
 export interface IRequest_Any_Cloudly_GetClusterConfig extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Any_Cloudly_GetClusterConfig> {
     method: 'getClusterConfig';
     request: {
-        identity: userInterfaces.IIdentity;
+        identity: userInterfaces.IIdentityCredential;
     };
     response: {
         configData: clusterInterfaces.ICluster;

package/package.json

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

package/readme.md

@@ -99,7 +99,7 @@ Common data contracts include:
 - `ISecretBundle` and `ISecretGroup` for secret ownership and shared secret groups.
 - Mail gateway contracts for domain authorities, address bindings, WorkApp bindings, managed SMTP/API credentials, spool items, delivery journals, and inbound/outbound message payloads.
 - Service-level mail configuration through `IService.data.mail`, including per-address inbound `smtpForward` settings and outbound credential metadata. Cloudly settings include dcrouter gateway, SMTP submission, and inbound forward-target keys for reconciling those bindings.
-- `IUser`, `IIdentity`, and token-related contracts for authentication context.
+- `IUser`, JWT-only `IIdentityCredential`, full `IIdentity`, and token-related contracts for authentication context. `IIdentity` extends `IIdentityCredential` with server-issued user metadata.
 - `ICloudlyConfig`, `ICloudlySettings`, status, server, bare-metal, BaseOS, backup, and task execution interfaces for control-plane state.
 
 Shared service port helpers are exported from `data` so Cloudly, App Store resolution, Coreflow, Coretraffic, Onebox, and dcrouter agree on the same normalization rules:
@@ -138,6 +138,8 @@ interface IExampleRequest {
 }
 ```
 
+`requests.config.IRequest_Any_Cloudly_GetClusterConfig` accepts `data.IIdentityCredential`, which contains only the JWT needed for server-side identity resolution. Username/password login and machine-token exchange responses continue to return the full `data.IIdentity`.
+
 Gateway request contracts include `getGatewayClientRoutes` (`requests.gateway.IReq_GetGatewayClientRoutes`) for listing owned `IGatewayClientRoute[]` route views, and `syncGatewayClientRoute` for idempotently syncing or deleting hostname-owned and routeRef-owned routes. Mail request contracts include `syncMailAddressBinding`, `deleteMailAddressBinding`, `rotateMailCredential`, and `getMailDeliveryStatus`. `IReq_GetMailDeliveryStatus` looks up a delivery spool item by `spoolItemId`, returns `data.IMailDeliveryStatus`, and accepts `IMailSubmissionRequestAuth` so service-mail credentials can query their own accepted, queued, deferred, delivered, or failed status. `TMailAddressBindingSync.outboundEnabled` explicitly controls whether a gateway should maintain a managed outbound SMTP credential for an address binding. Binding credential metadata is public; `rotateMailCredential` returns the new secret only in its one-time `IMailCredentialOneTimeSecret` response.
 
 Request groups are exported by product area:

package/ts/00_commitinfo_data.ts

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

package/ts/data/user.ts

@@ -4,18 +4,20 @@ export interface IToken {
   assignedRoles: string[];
 }
 
+export interface IIdentityCredential {
+  jwt: string;
+}
+
 /**
  * an identity is assumed by authentication as a user
  * an identity is ephemeral and has to be renewed regularly
  */
-export interface IIdentity {
+export interface IIdentity extends IIdentityCredential {
   name: string;
   userId: string;
   type: 'machine' | 'human';
   role: 'admin' | 'user' | 'api' | 'cluster';
   expiresAt: number;
-  /** the jwt token should contain above data for verification */
-  jwt: string;
 }
 
 export interface IUser {
@@ -27,4 +29,4 @@ export interface IUser {
     password?: string;
     tokens?: IToken[];
   }
-}
+}

package/ts/requests/baremetal.ts

@@ -1,17 +1,29 @@
 import * as plugins from '../plugins.js';
 import type { IBareMetal } from '../data/baremetal.js';
+import type { IIdentity } from '../data/user.js';
 
-export interface IRequest_Any_Cloudly_GetBaremetalServers {
+export interface IRequest_Any_Cloudly_GetBaremetalServers
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_GetBaremetalServers
+> {
   method: 'getBaremetalServers';
-  request: {};
+  request: {
+    identity: IIdentity;
+  };
   response: {
     baremetals: IBareMetal[];
   };
 }
 
-export interface IRequest_Any_Cloudly_ControlBaremetal {
+export interface IRequest_Any_Cloudly_ControlBaremetal
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IRequest_Any_Cloudly_ControlBaremetal
+> {
   method: 'controlBaremetal';
   request: {
+    identity: IIdentity;
     baremetalId: string;
     action: 'powerOn' | 'powerOff' | 'reset';
   };
@@ -19,4 +31,4 @@ export interface IRequest_Any_Cloudly_ControlBaremetal {
     success: boolean;
     message: string;
   };
-}
+}

package/ts/requests/config.ts

@@ -27,7 +27,7 @@ extends plugins.typedrequestInterfaces.implementsTR<
 > {
   method: 'getClusterConfig';
   request: {
-    identity: userInterfaces.IIdentity;
+    identity: userInterfaces.IIdentityCredential;
   };
   response: {
     configData: clusterInterfaces.ICluster;