@procedures/server 0.3.0 → 0.5.0

package/src/schemas.ts

@@ -0,0 +1,69 @@
+/**
+ * The input and output schemas of `server.start`, `server.stop` and `server.status`.
+ *
+ * The three procedures came from `@procedures/peer`: they manage the background server of the
+ * `mark` CLI, and this package holds the host. The input schemas validate each field, so the
+ * help of `mark server start` lists the options, and the port "abc" fails before the
+ * handler. The output schemas are loose objects: a field that a schema does not name stays in
+ * the result.
+ */
+
+import { z } from "zod";
+import { zodAdapter, type ZodLikeSchema } from "@procedures/client";
+import type {
+  ServerStartInput,
+  ServerStartOutput,
+  ServerStatusInput,
+  ServerStatusOutput,
+  ServerStopInput,
+  ServerStopOutput,
+} from "./types.js";
+
+const port = z.number().int().min(1).max(65535);
+
+export const serverStartInputSchema: ZodLikeSchema<ServerStartInput> = zodAdapter<ServerStartInput>(
+  z.object({
+    port: port.optional().describe("The port to listen on (default: 3000)"),
+    host: z.string().min(1).optional().describe("The host to bind to (default: 127.0.0.1)"),
+    transport: z.enum(["http", "websocket", "both"]).optional().describe("The transport (default: http)"),
+  })
+);
+
+export const serverStopInputSchema: ZodLikeSchema<ServerStopInput> = zodAdapter<ServerStopInput>(
+  z.object({
+    port: port.optional().describe("The port of the server to stop (default: all servers)"),
+    force: z.boolean().optional().describe("Stop with SIGKILL instead of SIGTERM"),
+  })
+);
+
+export const serverStatusInputSchema: ZodLikeSchema<ServerStatusInput> = zodAdapter<ServerStatusInput>(
+  z.object({
+    port: port.optional().describe("The port of the server (default: all servers)"),
+  })
+);
+
+export const ServerStartOutputSchema: z.ZodType<ServerStartOutput> = z.looseObject({
+  success: z.boolean().describe("True when the server started"),
+  pid: z.number().optional().describe("The process id of the server"),
+  port: z.number().optional().describe("The port of the server"),
+  endpoint: z.string().optional().describe("The URL of the server"),
+  logFile: z.string().optional().describe("The log file of the server"),
+  message: z.string().describe("A message about the result"),
+});
+
+export const ServerStopOutputSchema: z.ZodType<ServerStopOutput> = z.looseObject({
+  success: z.boolean().describe("True when the server stopped"),
+  message: z.string().describe("A message about the result"),
+});
+
+export const ServerStatusOutputSchema: z.ZodType<ServerStatusOutput> = z.looseObject({
+  running: z.boolean().describe("True when a server runs"),
+  pid: z.number().optional().describe("The process id of the server"),
+  port: z.number().optional().describe("The port of the server"),
+  endpoint: z.string().optional().describe("The URL of the server"),
+  transport: z.string().optional().describe("The transport of the server"),
+  startedAt: z.string().optional().describe("The start time (ISO 8601)"),
+  uptime: z.string().optional().describe("The time since the start, as text"),
+  logFile: z.string().optional().describe("The log file of the server"),
+  message: z.string().describe("A message about the result"),
+});

package/src/types.ts

@@ -23,6 +23,13 @@ export interface ServerConfig {
   token: string | null | undefined;
   /** The procedures to serve (`--expose`): exact keys or `prefix.*`. Empty: every procedure. */
   expose: string[];
+  /**
+   * The topic patterns of the remote events (`--events`): exact names, prefixes (`orders.*`) or
+   * `*`. Empty: the server serves no topic, and each subscription gets `TOPIC_NOT_FOUND`.
+   */
+  events?: string[] | undefined;
+  /** The folder that confines each path of the `fs.*` procedures (`--fs-root`). Undefined: no root. */
+  fsRoot?: string | undefined;
 }
 
 export interface ServerCreateResult {
@@ -30,3 +37,79 @@ export interface ServerCreateResult {
   endpoints: Array<{ type: string; address: string }>;
   procedureCount: number;
 }
+
+// =============================================================================
+// server.start Types (from @procedures/peer)
+// =============================================================================
+
+export interface ServerStartInput {
+  /** Port to listen on */
+  port?: number | undefined;
+  /** Host to bind to */
+  host?: string | undefined;
+  /** Transport type */
+  transport?: "http" | "websocket" | "both" | undefined;
+}
+
+export interface ServerStartOutput {
+  /** Whether start succeeded */
+  success: boolean;
+  /** Process ID of server */
+  pid?: number | undefined;
+  /** Port server is running on */
+  port?: number | undefined;
+  /** Endpoint URL */
+  endpoint?: string | undefined;
+  /** Log file path */
+  logFile?: string | undefined;
+  /** Status message */
+  message: string;
+}
+
+// =============================================================================
+// server.stop Types (from @procedures/peer)
+// =============================================================================
+
+export interface ServerStopInput {
+  /** Port of server to stop (stops all if omitted) */
+  port?: number | undefined;
+  /** Force kill with SIGKILL instead of SIGTERM */
+  force?: boolean | undefined;
+}
+
+export interface ServerStopOutput {
+  /** Whether stop succeeded */
+  success: boolean;
+  /** Status message */
+  message: string;
+}
+
+// =============================================================================
+// server.status Types (from @procedures/peer)
+// =============================================================================
+
+export interface ServerStatusInput {
+  /** Port to check (shows all if omitted) */
+  port?: number | undefined;
+}
+
+export interface ServerStatusOutput {
+  /** Whether server is running */
+  running: boolean;
+  /** Process ID */
+  pid?: number | undefined;
+  /** Port */
+  port?: number | undefined;
+  /** Endpoint URL */
+  endpoint?: string | undefined;
+  /** Transport type */
+  transport?: string | undefined;
+  /** When server started (ISO string) */
+  startedAt?: string | undefined;
+  /** Human-readable uptime */
+  uptime?: string | undefined;
+  /** Log file path */
+  logFile?: string | undefined;
+  /** Status message */
+  message: string;
+}