@serve.zone/interfaces 7.11.0 → 7.13.0

package/changelog.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 2026-06-10 - 7.13.0
+
+### Features
+
+- add deployment log streaming request interfaces (deployment)
+  - Add start and stop typed request contracts for deployment log streams between clients, Cloudly, and Coreflow.
+  - Add typed contracts for reporting, pushing, and ending streamed deployment log lines.
+
+## 2026-06-10 - 7.12.0
+
+### Features
+
+- add interactive deployment shell request interfaces (deployment)
+  - Define deployment shell command and process request contracts for Cloudly and Coreflow.
+  - Add output and exit reporting/push interfaces for streaming shell process updates.
+
 ## 2026-06-10 - 7.11.0
 
 ### Features

package/dist_ts/00_commitinfo_data.js

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

package/dist_ts/requests/deployment.d.ts

@@ -331,3 +331,204 @@ export interface IReq_Cloudly_Any_PushServiceReconciliationStatus extends plugin
     };
     response: Record<string, never>;
 }
+export interface IDeploymentShellCommand {
+    command: string;
+    args?: string[];
+    label?: string;
+    prompt?: string;
+}
+export interface IReq_Any_Cloudly_DeploymentShellGetCommand extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_DeploymentShellGetCommand> {
+    method: 'deploymentShellGetCommand';
+    request: {
+        identity: IIdentity;
+        deploymentId: string;
+    };
+    response: {
+        shellCommand: IDeploymentShellCommand;
+    };
+}
+export interface IReq_Any_Cloudly_DeploymentShellStart extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_DeploymentShellStart> {
+    method: 'deploymentShellStart';
+    request: {
+        identity: IIdentity;
+        deploymentId: string;
+        processId: string;
+        command: string;
+        args?: string[];
+    };
+    response: {
+        processId: string;
+    };
+}
+export interface IReq_Any_Cloudly_DeploymentShellInput extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_DeploymentShellInput> {
+    method: 'deploymentShellInput';
+    request: {
+        identity: IIdentity;
+        processId: string;
+        input: string;
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Any_Cloudly_DeploymentShellKill extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_DeploymentShellKill> {
+    method: 'deploymentShellKill';
+    request: {
+        identity: IIdentity;
+        processId: string;
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Cloudly_Coreflow_DeploymentShellGetCommand extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Coreflow_DeploymentShellGetCommand> {
+    method: 'coreflowDeploymentShellGetCommand';
+    request: {
+        deploymentId: string;
+    };
+    response: {
+        found: boolean;
+        shellCommand?: IDeploymentShellCommand;
+    };
+}
+export interface IReq_Cloudly_Coreflow_DeploymentShellStart extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Coreflow_DeploymentShellStart> {
+    method: 'coreflowDeploymentShellStart';
+    request: {
+        deploymentId: string;
+        processId: string;
+        command: string;
+        args?: string[];
+    };
+    response: {
+        found: boolean;
+        processId?: string;
+    };
+}
+export interface IReq_Cloudly_Coreflow_DeploymentShellInput extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Coreflow_DeploymentShellInput> {
+    method: 'coreflowDeploymentShellInput';
+    request: {
+        processId: string;
+        input: string;
+    };
+    response: {
+        found: boolean;
+    };
+}
+export interface IReq_Cloudly_Coreflow_DeploymentShellKill extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Coreflow_DeploymentShellKill> {
+    method: 'coreflowDeploymentShellKill';
+    request: {
+        processId: string;
+    };
+    response: {
+        found: boolean;
+    };
+}
+export interface IReq_Coreflow_Cloudly_ReportDeploymentShellOutput extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Coreflow_Cloudly_ReportDeploymentShellOutput> {
+    method: 'reportDeploymentShellOutput';
+    request: {
+        identity: IIdentity;
+        processId: string;
+        output: string;
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Coreflow_Cloudly_ReportDeploymentShellExit extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Coreflow_Cloudly_ReportDeploymentShellExit> {
+    method: 'reportDeploymentShellExit';
+    request: {
+        identity: IIdentity;
+        processId: string;
+        exitCode: number;
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Cloudly_Any_PushDeploymentShellOutput extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Any_PushDeploymentShellOutput> {
+    method: 'pushDeploymentShellOutput';
+    request: {
+        processId: string;
+        output: string;
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Cloudly_Any_PushDeploymentShellExit extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Any_PushDeploymentShellExit> {
+    method: 'pushDeploymentShellExit';
+    request: {
+        processId: string;
+        exitCode: number;
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Any_Cloudly_DeploymentLogStreamStart extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_DeploymentLogStreamStart> {
+    method: 'deploymentLogStreamStart';
+    request: {
+        identity: IIdentity;
+        deploymentId: string;
+        streamId: string;
+        /** Number of trailing log lines to seed the stream with (default 200). */
+        tail?: number;
+    };
+    response: {
+        streamId: string;
+    };
+}
+export interface IReq_Any_Cloudly_DeploymentLogStreamStop extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Any_Cloudly_DeploymentLogStreamStop> {
+    method: 'deploymentLogStreamStop';
+    request: {
+        identity: IIdentity;
+        streamId: string;
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Cloudly_Coreflow_DeploymentLogStreamStart extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Coreflow_DeploymentLogStreamStart> {
+    method: 'coreflowDeploymentLogStreamStart';
+    request: {
+        deploymentId: string;
+        streamId: string;
+        tail?: number;
+    };
+    response: {
+        found: boolean;
+        streamId?: string;
+    };
+}
+export interface IReq_Cloudly_Coreflow_DeploymentLogStreamStop extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Coreflow_DeploymentLogStreamStop> {
+    method: 'coreflowDeploymentLogStreamStop';
+    request: {
+        streamId: string;
+    };
+    response: {
+        found: boolean;
+    };
+}
+export interface IReq_Coreflow_Cloudly_ReportDeploymentLogLines extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Coreflow_Cloudly_ReportDeploymentLogLines> {
+    method: 'reportDeploymentLogLines';
+    request: {
+        identity: IIdentity;
+        streamId: string;
+        deploymentId: string;
+        lines: string[];
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Coreflow_Cloudly_ReportDeploymentLogStreamEnd extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Coreflow_Cloudly_ReportDeploymentLogStreamEnd> {
+    method: 'reportDeploymentLogStreamEnd';
+    request: {
+        identity: IIdentity;
+        streamId: string;
+        /** e.g. 'container-exited' | 'stopped' | 'ttl-expired' | 'error' */
+        reason?: string;
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Cloudly_Any_PushDeploymentLogLines extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Any_PushDeploymentLogLines> {
+    method: 'pushDeploymentLogLines';
+    request: {
+        streamId: string;
+        deploymentId: string;
+        lines: string[];
+    };
+    response: Record<string, never>;
+}
+export interface IReq_Cloudly_Any_PushDeploymentLogStreamEnd extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_Any_PushDeploymentLogStreamEnd> {
+    method: 'pushDeploymentLogStreamEnd';
+    request: {
+        streamId: string;
+        reason?: string;
+    };
+    response: Record<string, never>;
+}

package/package.json

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

package/ts/requests/deployment.ts

@@ -482,3 +482,315 @@ extends plugins.typedrequestInterfaces.implementsTR<
   };
   response: Record<string, never>;
 }
+
+// ============================================================================
+// Interactive deployment shell (workspace terminal)
+// UI -> Cloudly -> Coreflow, with output/exit streamed back via pushes.
+// ============================================================================
+
+export interface IDeploymentShellCommand {
+  command: string;
+  args?: string[];
+  label?: string;
+  prompt?: string;
+}
+
+export interface IReq_Any_Cloudly_DeploymentShellGetCommand
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_DeploymentShellGetCommand
+> {
+  method: 'deploymentShellGetCommand';
+  request: {
+    identity: IIdentity;
+    deploymentId: string;
+  };
+  response: {
+    shellCommand: IDeploymentShellCommand;
+  };
+}
+
+export interface IReq_Any_Cloudly_DeploymentShellStart
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_DeploymentShellStart
+> {
+  method: 'deploymentShellStart';
+  request: {
+    identity: IIdentity;
+    deploymentId: string;
+    processId: string;
+    command: string;
+    args?: string[];
+  };
+  response: {
+    processId: string;
+  };
+}
+
+export interface IReq_Any_Cloudly_DeploymentShellInput
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_DeploymentShellInput
+> {
+  method: 'deploymentShellInput';
+  request: {
+    identity: IIdentity;
+    processId: string;
+    input: string;
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Any_Cloudly_DeploymentShellKill
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_DeploymentShellKill
+> {
+  method: 'deploymentShellKill';
+  request: {
+    identity: IIdentity;
+    processId: string;
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Cloudly_Coreflow_DeploymentShellGetCommand
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_DeploymentShellGetCommand
+> {
+  method: 'coreflowDeploymentShellGetCommand';
+  request: {
+    deploymentId: string;
+  };
+  response: {
+    found: boolean;
+    shellCommand?: IDeploymentShellCommand;
+  };
+}
+
+export interface IReq_Cloudly_Coreflow_DeploymentShellStart
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_DeploymentShellStart
+> {
+  method: 'coreflowDeploymentShellStart';
+  request: {
+    deploymentId: string;
+    processId: string;
+    command: string;
+    args?: string[];
+  };
+  response: {
+    found: boolean;
+    processId?: string;
+  };
+}
+
+export interface IReq_Cloudly_Coreflow_DeploymentShellInput
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_DeploymentShellInput
+> {
+  method: 'coreflowDeploymentShellInput';
+  request: {
+    processId: string;
+    input: string;
+  };
+  response: {
+    found: boolean;
+  };
+}
+
+export interface IReq_Cloudly_Coreflow_DeploymentShellKill
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_DeploymentShellKill
+> {
+  method: 'coreflowDeploymentShellKill';
+  request: {
+    processId: string;
+  };
+  response: {
+    found: boolean;
+  };
+}
+
+export interface IReq_Coreflow_Cloudly_ReportDeploymentShellOutput
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_ReportDeploymentShellOutput
+> {
+  method: 'reportDeploymentShellOutput';
+  request: {
+    identity: IIdentity;
+    processId: string;
+    output: string;
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Coreflow_Cloudly_ReportDeploymentShellExit
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_ReportDeploymentShellExit
+> {
+  method: 'reportDeploymentShellExit';
+  request: {
+    identity: IIdentity;
+    processId: string;
+    exitCode: number;
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Cloudly_Any_PushDeploymentShellOutput
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Any_PushDeploymentShellOutput
+> {
+  method: 'pushDeploymentShellOutput';
+  request: {
+    processId: string;
+    output: string;
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Cloudly_Any_PushDeploymentShellExit
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Any_PushDeploymentShellExit
+> {
+  method: 'pushDeploymentShellExit';
+  request: {
+    processId: string;
+    exitCode: number;
+  };
+  response: Record<string, never>;
+}
+
+// ============================================================================
+// Live deployment log streaming (deployment detail page)
+// UI -> Cloudly -> Coreflow, with log lines streamed back via pushes.
+// ============================================================================
+
+export interface IReq_Any_Cloudly_DeploymentLogStreamStart
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_DeploymentLogStreamStart
+> {
+  method: 'deploymentLogStreamStart';
+  request: {
+    identity: IIdentity;
+    deploymentId: string;
+    streamId: string;
+    /** Number of trailing log lines to seed the stream with (default 200). */
+    tail?: number;
+  };
+  response: {
+    streamId: string;
+  };
+}
+
+export interface IReq_Any_Cloudly_DeploymentLogStreamStop
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Any_Cloudly_DeploymentLogStreamStop
+> {
+  method: 'deploymentLogStreamStop';
+  request: {
+    identity: IIdentity;
+    streamId: string;
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Cloudly_Coreflow_DeploymentLogStreamStart
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_DeploymentLogStreamStart
+> {
+  method: 'coreflowDeploymentLogStreamStart';
+  request: {
+    deploymentId: string;
+    streamId: string;
+    tail?: number;
+  };
+  response: {
+    found: boolean;
+    streamId?: string;
+  };
+}
+
+export interface IReq_Cloudly_Coreflow_DeploymentLogStreamStop
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Coreflow_DeploymentLogStreamStop
+> {
+  method: 'coreflowDeploymentLogStreamStop';
+  request: {
+    streamId: string;
+  };
+  response: {
+    found: boolean;
+  };
+}
+
+export interface IReq_Coreflow_Cloudly_ReportDeploymentLogLines
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_ReportDeploymentLogLines
+> {
+  method: 'reportDeploymentLogLines';
+  request: {
+    identity: IIdentity;
+    streamId: string;
+    deploymentId: string;
+    lines: string[];
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Coreflow_Cloudly_ReportDeploymentLogStreamEnd
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Coreflow_Cloudly_ReportDeploymentLogStreamEnd
+> {
+  method: 'reportDeploymentLogStreamEnd';
+  request: {
+    identity: IIdentity;
+    streamId: string;
+    /** e.g. 'container-exited' | 'stopped' | 'ttl-expired' | 'error' */
+    reason?: string;
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Cloudly_Any_PushDeploymentLogLines
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Any_PushDeploymentLogLines
+> {
+  method: 'pushDeploymentLogLines';
+  request: {
+    streamId: string;
+    deploymentId: string;
+    lines: string[];
+  };
+  response: Record<string, never>;
+}
+
+export interface IReq_Cloudly_Any_PushDeploymentLogStreamEnd
+extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Any_PushDeploymentLogStreamEnd
+> {
+  method: 'pushDeploymentLogStreamEnd';
+  request: {
+    streamId: string;
+    reason?: string;
+  };
+  response: Record<string, never>;
+}