@serve.zone/interfaces 6.0.0 → 6.0.1

package/changelog.md

@@ -3,6 +3,12 @@
 ## Pending
 
 
+## 2026-05-26 - 6.0.1
+
+- add App Store service upgrade contracts (appstore)
+  - Adds App Store upgrade preview, operation tracking, start/apply, and progress push request contracts
+  - Adds service-level App Store upgrade policy, published ports, and service IDs to related service types
+
 ## 2026-05-25 - 6.0.0
 
 ### Breaking Changes

package/dist_ts/00_commitinfo_data.js

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

package/dist_ts/appstore/types.d.ts

@@ -160,6 +160,7 @@ export interface IAppStoreInstallRequest {
     envVars?: Record<string, string>;
 }
 export interface IUpgradeableAppStoreService {
+    serviceId?: string;
     serviceName: string;
     appTemplateId: string;
     currentVersion: string;

package/dist_ts/data/service.d.ts

@@ -1,5 +1,6 @@
 import type { IServiceRessources } from './docker.js';
 import type { IRegistryTarget } from './registry.js';
+import type { IAppStorePublishedPort } from '../appstore/index.js';
 export interface IServiceVolume {
     /** Stable Docker volume name. If omitted, Coreflow derives one from service id and mount path. */
     name?: string;
@@ -26,6 +27,7 @@ export interface IService {
         deployOnPush?: boolean;
         appTemplateId?: string;
         appTemplateVersion?: string;
+        appStoreUpgradePolicy?: 'manual' | 'notify' | 'auto';
         environment: {
             [key: string]: string;
         };
@@ -71,6 +73,7 @@ export interface IService {
             };
         };
         volumes?: IServiceVolume[];
+        publishedPorts?: IAppStorePublishedPort[];
         resources?: IServiceRessources;
         domains: {
             /**

package/dist_ts/requests/appstore.d.ts

@@ -2,6 +2,45 @@ import * as plugins from '../plugins.js';
 import type { IIdentity } from '../data/user.js';
 import type { IService } from '../data/service.js';
 import type { IAppStoreApp, IAppStoreAppMeta, IAppStoreInstallRequest, IAppStoreVersionConfig, IUpgradeableAppStoreService } from '../appstore/index.js';
+export type TAppStoreUpgradeStatus = 'running' | 'success' | 'failed';
+export type TAppStoreUpgradeStep = 'queued' | 'validating' | 'migration' | 'applying' | 'updating-service' | 'pushing-config' | 'complete' | 'failed';
+export interface IAppStoreUpgradeChange {
+    field: string;
+    currentValue: string;
+    targetValue: string;
+}
+export interface IAppStoreUpgradePreview {
+    serviceId: string;
+    serviceName: string;
+    appTemplateId: string;
+    fromVersion: string;
+    targetVersion: string;
+    resolvedTargetVersion: string;
+    hasMigration: boolean;
+    requiresManualReview: boolean;
+    changes: IAppStoreUpgradeChange[];
+    warnings: string[];
+    blockers: string[];
+    config: IAppStoreVersionConfig;
+    appMeta: IAppStoreAppMeta;
+}
+export interface IAppStoreUpgradeOperation {
+    id: string;
+    serviceId: string;
+    serviceName: string;
+    appTemplateId: string;
+    fromVersion: string;
+    targetVersion: string;
+    status: TAppStoreUpgradeStatus;
+    step: TAppStoreUpgradeStep;
+    progressLines: string[];
+    warnings: string[];
+    error?: string;
+    startedAt: number;
+    updatedAt: number;
+    completedAt?: number;
+    service?: IService;
+}
 export interface IReq_Any_GetAppStoreTemplates extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_GetAppStoreTemplates> {
     method: 'getAppStoreTemplates';
     request: {
@@ -42,3 +81,53 @@ export interface IReq_Any_GetUpgradeableAppStoreServices extends plugins.typedre
         services: IUpgradeableAppStoreService[];
     };
 }
+export interface IReq_Any_GetAppStoreUpgradePreview extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_GetAppStoreUpgradePreview> {
+    method: 'getAppStoreUpgradePreview';
+    request: {
+        identity: IIdentity;
+        serviceId: string;
+        targetVersion?: string;
+    };
+    response: {
+        preview: IAppStoreUpgradePreview;
+    };
+}
+export interface IReq_Any_UpgradeAppStoreService extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_UpgradeAppStoreService> {
+    method: 'upgradeAppStoreService';
+    request: {
+        identity: IIdentity;
+        serviceId: string;
+        targetVersion: string;
+    };
+    response: {
+        service: IService;
+        warnings: string[];
+    };
+}
+export interface IReq_Any_StartAppStoreServiceUpgrade extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_StartAppStoreServiceUpgrade> {
+    method: 'startAppStoreServiceUpgrade';
+    request: {
+        identity: IIdentity;
+        serviceId: string;
+        targetVersion: string;
+    };
+    response: {
+        operation: IAppStoreUpgradeOperation;
+    };
+}
+export interface IReq_Any_GetAppStoreUpgradeOperations extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_GetAppStoreUpgradeOperations> {
+    method: 'getAppStoreUpgradeOperations';
+    request: {
+        identity: IIdentity;
+    };
+    response: {
+        operations: IAppStoreUpgradeOperation[];
+    };
+}
+export interface IReq_Any_PushAppStoreUpgradeProgress extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_PushAppStoreUpgradeProgress> {
+    method: 'pushAppStoreUpgradeProgress';
+    request: {
+        operation: IAppStoreUpgradeOperation;
+    };
+    response: Record<string, never>;
+}

package/package.json

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

package/ts/appstore/types.ts

@@ -181,6 +181,7 @@ export interface IAppStoreInstallRequest {
 }
 
 export interface IUpgradeableAppStoreService {
+  serviceId?: string;
   serviceName: string;
   appTemplateId: string;
   currentVersion: string;

package/ts/data/service.ts

@@ -1,5 +1,6 @@
 import type { IServiceRessources } from './docker.js';
 import type { IRegistryTarget } from './registry.js';
+import type { IAppStorePublishedPort } from '../appstore/index.js';
 
 export interface IServiceVolume {
   /** Stable Docker volume name. If omitted, Coreflow derives one from service id and mount path. */
@@ -28,6 +29,7 @@ export interface IService {
     deployOnPush?: boolean;
     appTemplateId?: string;
     appTemplateVersion?: string;
+    appStoreUpgradePolicy?: 'manual' | 'notify' | 'auto';
     environment: { [key: string]: string };
     /**
      * the main secret bundle id, exclusive to the service
@@ -74,6 +76,7 @@ export interface IService {
       custom?: { [domain: string]: string };
     };
     volumes?: IServiceVolume[];
+    publishedPorts?: IAppStorePublishedPort[];
     resources?: IServiceRessources;
     domains: {
       /**

package/ts/requests/appstore.ts

@@ -9,6 +9,58 @@ import type {
   IUpgradeableAppStoreService,
 } from '../appstore/index.js';
 
+export type TAppStoreUpgradeStatus = 'running' | 'success' | 'failed';
+
+export type TAppStoreUpgradeStep =
+  | 'queued'
+  | 'validating'
+  | 'migration'
+  | 'applying'
+  | 'updating-service'
+  | 'pushing-config'
+  | 'complete'
+  | 'failed';
+
+export interface IAppStoreUpgradeChange {
+  field: string;
+  currentValue: string;
+  targetValue: string;
+}
+
+export interface IAppStoreUpgradePreview {
+  serviceId: string;
+  serviceName: string;
+  appTemplateId: string;
+  fromVersion: string;
+  targetVersion: string;
+  resolvedTargetVersion: string;
+  hasMigration: boolean;
+  requiresManualReview: boolean;
+  changes: IAppStoreUpgradeChange[];
+  warnings: string[];
+  blockers: string[];
+  config: IAppStoreVersionConfig;
+  appMeta: IAppStoreAppMeta;
+}
+
+export interface IAppStoreUpgradeOperation {
+  id: string;
+  serviceId: string;
+  serviceName: string;
+  appTemplateId: string;
+  fromVersion: string;
+  targetVersion: string;
+  status: TAppStoreUpgradeStatus;
+  step: TAppStoreUpgradeStep;
+  progressLines: string[];
+  warnings: string[];
+  error?: string;
+  startedAt: number;
+  updatedAt: number;
+  completedAt?: number;
+  service?: IService;
+}
+
 export interface IReq_Any_GetAppStoreTemplates extends plugins.typedrequestInterfaces.implementsTR<
   plugins.typedrequestInterfaces.ITypedRequest,
   IReq_Any_GetAppStoreTemplates
@@ -64,3 +116,73 @@ export interface IReq_Any_GetUpgradeableAppStoreServices extends plugins.typedre
     services: IUpgradeableAppStoreService[];
   };
 }
+
+export interface IReq_Any_GetAppStoreUpgradePreview extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_GetAppStoreUpgradePreview
+> {
+  method: 'getAppStoreUpgradePreview';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+    targetVersion?: string;
+  };
+  response: {
+    preview: IAppStoreUpgradePreview;
+  };
+}
+
+export interface IReq_Any_UpgradeAppStoreService extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_UpgradeAppStoreService
+> {
+  method: 'upgradeAppStoreService';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+    targetVersion: string;
+  };
+  response: {
+    service: IService;
+    warnings: string[];
+  };
+}
+
+export interface IReq_Any_StartAppStoreServiceUpgrade extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_StartAppStoreServiceUpgrade
+> {
+  method: 'startAppStoreServiceUpgrade';
+  request: {
+    identity: IIdentity;
+    serviceId: string;
+    targetVersion: string;
+  };
+  response: {
+    operation: IAppStoreUpgradeOperation;
+  };
+}
+
+export interface IReq_Any_GetAppStoreUpgradeOperations extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_GetAppStoreUpgradeOperations
+> {
+  method: 'getAppStoreUpgradeOperations';
+  request: {
+    identity: IIdentity;
+  };
+  response: {
+    operations: IAppStoreUpgradeOperation[];
+  };
+}
+
+export interface IReq_Any_PushAppStoreUpgradeProgress extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_PushAppStoreUpgradeProgress
+> {
+  method: 'pushAppStoreUpgradeProgress';
+  request: {
+    operation: IAppStoreUpgradeOperation;
+  };
+  response: Record<string, never>;
+}