@serve.zone/interfaces 7.0.0 → 7.1.0

package/changelog.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 2026-06-09 - 7.1.0
+
+### Features
+
+- add service reconciliation status contracts (service-status)
+  - Add reconciliation status types and an optional reconciliationStatus field to service data
+  - Add typed request contract for reporting reconciliation status updates
+  - Align the cloudlyStatus request contract with typedrequest interfaces
+- add optional identity context to settings requests (settings)
+  - Adds optional identity to get, update, clear, provider connection test, and internal get setting request payloads.
+
 ## 2026-06-08 - 7.0.0
 
 ### Breaking Changes

package/dist_ts/00_commitinfo_data.js

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

package/dist_ts/data/service.d.ts

@@ -17,6 +17,21 @@ export interface IServiceVolume {
     /** Driver-specific options forwarded to Docker's VolumeDriver.Create request. */
     options?: Record<string, string>;
 }
+export type TServiceReconciliationStatus = 'running' | 'ready' | 'degraded' | 'failed';
+export interface IServiceReconciliationStageStatus {
+    stage: string;
+    stageKey: string;
+    status: TServiceReconciliationStatus;
+    domainName?: string;
+    message?: string;
+    errorText?: string;
+    reportedAt: number;
+}
+export interface IServiceReconciliationStatus {
+    status: TServiceReconciliationStatus;
+    updatedAt: number;
+    stages: Record<string, IServiceReconciliationStageStatus>;
+}
 export interface IService {
     id: string;
     data: {
@@ -30,6 +45,7 @@ export interface IService {
         appTemplateVersion?: string;
         appStoreUpgradePolicy?: 'manual' | 'notify' | 'auto';
         hostedAppLifecycle?: IHostedAppLifecycleState;
+        reconciliationStatus?: IServiceReconciliationStatus;
         environment: {
             [key: string]: string;
         };

package/dist_ts/requests/settings.d.ts

@@ -1,8 +1,11 @@
 import * as plugins from '../plugins.js';
 import type { ICloudlySettings, ICloudlySettingsMasked } from '../data/settings.js';
+import type { IIdentity } from '../data/user.js';
 export interface IRequest_GetSettings extends plugins.typedrequestInterfaces.ITypedRequest {
     method: 'getSettings';
-    request: {};
+    request: {
+        identity?: IIdentity;
+    };
     response: {
         settings: ICloudlySettingsMasked;
     };
@@ -10,6 +13,7 @@ export interface IRequest_GetSettings extends plugins.typedrequestInterfaces.ITy
 export interface IRequest_UpdateSettings extends plugins.typedrequestInterfaces.ITypedRequest {
     method: 'updateSettings';
     request: {
+        identity?: IIdentity;
         updates: Partial<ICloudlySettings>;
     };
     response: {
@@ -20,6 +24,7 @@ export interface IRequest_UpdateSettings extends plugins.typedrequestInterfaces.
 export interface IRequest_ClearSetting extends plugins.typedrequestInterfaces.ITypedRequest {
     method: 'clearSetting';
     request: {
+        identity?: IIdentity;
         key: keyof ICloudlySettings;
     };
     response: {
@@ -30,6 +35,7 @@ export interface IRequest_ClearSetting extends plugins.typedrequestInterfaces.IT
 export interface IRequest_TestProviderConnection extends plugins.typedrequestInterfaces.ITypedRequest {
     method: 'testProviderConnection';
     request: {
+        identity?: IIdentity;
         provider: 'hetzner' | 'cloudflare' | 'aws' | 'digitalocean' | 'azure' | 'google' | 'vultr' | 'linode' | 'ovh' | 'scaleway';
     };
     response: {
@@ -41,6 +47,7 @@ export interface IRequest_TestProviderConnection extends plugins.typedrequestInt
 export interface IRequest_GetSetting extends plugins.typedrequestInterfaces.ITypedRequest {
     method: 'getSetting';
     request: {
+        identity?: IIdentity;
         key: keyof ICloudlySettings;
     };
     response: {

package/dist_ts/requests/status.d.ts

@@ -1,11 +1,29 @@
+import * as plugins from '../plugins.js';
+import * as serviceInterfaces from '../data/service.js';
 import * as userInterfaces from '../data/user.js';
 /**
  * a status update dashboard
  */
-export interface IRequest_Coreflow_Cloudly_CoreflowManagerStatusupdate {
+export interface IRequest_Coreflow_Cloudly_CoreflowManagerStatusupdate extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Coreflow_Cloudly_CoreflowManagerStatusupdate> {
     method: 'cloudlyStatus';
     request: {
         identity: userInterfaces.IIdentity;
     };
     response: {};
 }
+export interface IRequest_Coreflow_Cloudly_ReportReconciliationStatus extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IRequest_Coreflow_Cloudly_ReportReconciliationStatus> {
+    method: 'reportReconciliationStatus';
+    request: {
+        identity: userInterfaces.IIdentity;
+        serviceId: string;
+        serviceName?: string;
+        stage: string;
+        stageKey?: string;
+        status: serviceInterfaces.TServiceReconciliationStatus;
+        domainName?: string;
+        message?: string;
+        errorText?: string;
+        reportedAt?: number;
+    };
+    response: {};
+}

package/dist_ts/requests/status.js

@@ -1,2 +1,4 @@
+import * as plugins from '../plugins.js';
+import * as serviceInterfaces from '../data/service.js';
 import * as userInterfaces from '../data/user.js';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhdHVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvc3RhdHVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxjQUFjLE1BQU0saUJBQWlCLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhdHVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvc3RhdHVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxpQkFBaUIsTUFBTSxvQkFBb0IsQ0FBQztBQUN4RCxPQUFPLEtBQUssY0FBYyxNQUFNLGlCQUFpQixDQUFDIn0=

package/package.json

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

package/ts/data/service.ts

@@ -19,6 +19,24 @@ export interface IServiceVolume {
   options?: Record<string, string>;
 }
 
+export type TServiceReconciliationStatus = 'running' | 'ready' | 'degraded' | 'failed';
+
+export interface IServiceReconciliationStageStatus {
+  stage: string;
+  stageKey: string;
+  status: TServiceReconciliationStatus;
+  domainName?: string;
+  message?: string;
+  errorText?: string;
+  reportedAt: number;
+}
+
+export interface IServiceReconciliationStatus {
+  status: TServiceReconciliationStatus;
+  updatedAt: number;
+  stages: Record<string, IServiceReconciliationStageStatus>;
+}
+
 export interface IService {
   id: string;
   data: {
@@ -32,6 +50,7 @@ export interface IService {
     appTemplateVersion?: string;
     appStoreUpgradePolicy?: 'manual' | 'notify' | 'auto';
     hostedAppLifecycle?: IHostedAppLifecycleState;
+    reconciliationStatus?: IServiceReconciliationStatus;
     environment: { [key: string]: string };
     /**
      * the main secret bundle id, exclusive to the service

package/ts/requests/settings.ts

@@ -1,10 +1,13 @@
 import * as plugins from '../plugins.js';
 import type { ICloudlySettings, ICloudlySettingsMasked } from '../data/settings.js';
+import type { IIdentity } from '../data/user.js';
 
 // Get Settings
 export interface IRequest_GetSettings extends plugins.typedrequestInterfaces.ITypedRequest {
   method: 'getSettings';
-  request: {};
+  request: {
+    identity?: IIdentity;
+  };
   response: {
     settings: ICloudlySettingsMasked;
   };
@@ -14,6 +17,7 @@ export interface IRequest_GetSettings extends plugins.typedrequestInterfaces.ITy
 export interface IRequest_UpdateSettings extends plugins.typedrequestInterfaces.ITypedRequest {
   method: 'updateSettings';
   request: {
+    identity?: IIdentity;
     updates: Partial<ICloudlySettings>;
   };
   response: {
@@ -26,6 +30,7 @@ export interface IRequest_UpdateSettings extends plugins.typedrequestInterfaces.
 export interface IRequest_ClearSetting extends plugins.typedrequestInterfaces.ITypedRequest {
   method: 'clearSetting';
   request: {
+    identity?: IIdentity;
     key: keyof ICloudlySettings;
   };
   response: {
@@ -38,6 +43,7 @@ export interface IRequest_ClearSetting extends plugins.typedrequestInterfaces.IT
 export interface IRequest_TestProviderConnection extends plugins.typedrequestInterfaces.ITypedRequest {
   method: 'testProviderConnection';
   request: {
+    identity?: IIdentity;
     provider: 'hetzner' | 'cloudflare' | 'aws' | 'digitalocean' | 'azure' | 'google' | 'vultr' | 'linode' | 'ovh' | 'scaleway';
   };
   response: {
@@ -51,9 +57,10 @@ export interface IRequest_TestProviderConnection extends plugins.typedrequestInt
 export interface IRequest_GetSetting extends plugins.typedrequestInterfaces.ITypedRequest {
   method: 'getSetting';
   request: {
+    identity?: IIdentity;
     key: keyof ICloudlySettings;
   };
   response: {
     value: string | undefined;
   };
-}
+}

package/ts/requests/status.ts

@@ -1,12 +1,39 @@
+import * as plugins from '../plugins.js';
+import * as serviceInterfaces from '../data/service.js';
 import * as userInterfaces from '../data/user.js';
 
 /**
  * a status update dashboard
  */
-export interface IRequest_Coreflow_Cloudly_CoreflowManagerStatusupdate {
+export interface IRequest_Coreflow_Cloudly_CoreflowManagerStatusupdate
+  extends plugins.typedrequestInterfaces.implementsTR<
+    plugins.typedrequestInterfaces.ITypedRequest,
+    IRequest_Coreflow_Cloudly_CoreflowManagerStatusupdate
+  > {
   method: 'cloudlyStatus';
   request: {
     identity: userInterfaces.IIdentity;
   };
   response: {};
 }
+
+export interface IRequest_Coreflow_Cloudly_ReportReconciliationStatus
+  extends plugins.typedrequestInterfaces.implementsTR<
+    plugins.typedrequestInterfaces.ITypedRequest,
+    IRequest_Coreflow_Cloudly_ReportReconciliationStatus
+  > {
+  method: 'reportReconciliationStatus';
+  request: {
+    identity: userInterfaces.IIdentity;
+    serviceId: string;
+    serviceName?: string;
+    stage: string;
+    stageKey?: string;
+    status: serviceInterfaces.TServiceReconciliationStatus;
+    domainName?: string;
+    message?: string;
+    errorText?: string;
+    reportedAt?: number;
+  };
+  response: {};
+}