@naisys/hub-protocol 3.0.0-beta.3

package/dist/schemas/mail.js

@@ -0,0 +1,177 @@
+import { z } from "zod";
+// =============================================================================
+// Common
+// =============================================================================
+export const MessageKindSchema = z.enum(["mail", "chat"]);
+export const AttachmentPurposeEnum = z.enum(["mail", "context"]);
+// =============================================================================
+// Send
+// =============================================================================
+/** Request to send a mail message */
+export const MailSendRequestSchema = z.object({
+    fromUserId: z.number(),
+    toUserIds: z.array(z.number()),
+    subject: z.string(),
+    body: z.string(),
+    kind: MessageKindSchema,
+    attachmentIds: z.array(z.number()).optional(),
+});
+/** Response to mail send request */
+export const MailSendResponseSchema = z.object({
+    success: z.boolean(),
+    error: z.string().optional(),
+});
+// =============================================================================
+// List
+// =============================================================================
+/** Request to list mail messages */
+export const MailListRequestSchema = z.object({
+    userId: z.number(),
+    filter: z.enum(["received", "sent"]).optional(),
+    kind: MessageKindSchema,
+    skip: z.number().optional(),
+    take: z.number().optional(),
+    withUserIds: z.array(z.number()).optional(),
+});
+/** Attachment metadata included in message responses */
+export const MailAttachmentDataSchema = z.object({
+    id: z.string(),
+    filename: z.string(),
+    fileSize: z.number(),
+});
+/** A single message in a mail list response */
+export const MailListMessageDataSchema = z.object({
+    id: z.number(),
+    fromUsername: z.string(),
+    fromTitle: z.string(),
+    recipientUsernames: z.array(z.string()),
+    subject: z.string(),
+    createdAt: z.string(),
+    isUnread: z.boolean(),
+    body: z.string().optional(),
+    attachments: z.array(MailAttachmentDataSchema).optional(),
+});
+/** Response to mail list request */
+export const MailListResponseSchema = z.object({
+    success: z.boolean(),
+    messages: z.array(MailListMessageDataSchema).optional(),
+    error: z.string().optional(),
+});
+// =============================================================================
+// Peek (fetch without marking as read)
+// =============================================================================
+/** Request to peek at a specific mail message */
+export const MailPeekRequestSchema = z.object({
+    userId: z.number(),
+    messageId: z.number(),
+});
+/** Full message data returned when fetching a message */
+export const MailMessageDataSchema = z.object({
+    id: z.number(),
+    subject: z.string(),
+    fromUsername: z.string(),
+    fromTitle: z.string(),
+    recipientUsernames: z.array(z.string()),
+    createdAt: z.string(),
+    body: z.string(),
+    attachments: z.array(MailAttachmentDataSchema).optional(),
+});
+/** Response to mail peek request */
+export const MailPeekResponseSchema = z.object({
+    success: z.boolean(),
+    message: MailMessageDataSchema.optional(),
+    error: z.string().optional(),
+});
+// =============================================================================
+// Archive
+// =============================================================================
+/** Request to archive mail messages */
+export const MailArchiveRequestSchema = z.object({
+    userId: z.number(),
+    messageIds: z.array(z.number()),
+});
+/** Response to mail archive request */
+export const MailArchiveResponseSchema = z.object({
+    success: z.boolean(),
+    archivedIds: z.array(z.number()).optional(),
+    error: z.string().optional(),
+});
+// =============================================================================
+// Search
+// =============================================================================
+/** Request to search mail messages */
+export const MailSearchRequestSchema = z.object({
+    userId: z.number(),
+    terms: z.string(),
+    includeArchived: z.boolean().optional(),
+    subjectOnly: z.boolean().optional(),
+});
+/** A single message in a mail search response */
+export const MailSearchMessageDataSchema = z.object({
+    id: z.number(),
+    subject: z.string(),
+    fromUsername: z.string(),
+    createdAt: z.string(),
+});
+/** Response to mail search request */
+export const MailSearchResponseSchema = z.object({
+    success: z.boolean(),
+    messages: z.array(MailSearchMessageDataSchema).optional(),
+    error: z.string().optional(),
+});
+// =============================================================================
+// Mark Read
+// =============================================================================
+/** Request to mark messages as read */
+export const MailMarkReadRequestSchema = z.object({
+    userId: z.number(),
+    messageIds: z.array(z.number()),
+    kind: MessageKindSchema,
+});
+/** Response to mark-read request */
+export const MailMarkReadResponseSchema = z.object({
+    success: z.boolean(),
+    error: z.string().optional(),
+});
+// =============================================================================
+// Unread
+// =============================================================================
+/** Request to get unread messages */
+export const MailUnreadRequestSchema = z.object({
+    userId: z.number(),
+    kind: MessageKindSchema,
+    afterId: z.number().optional(),
+});
+/** Response to unread messages request */
+export const MailUnreadResponseSchema = z.object({
+    success: z.boolean(),
+    messages: z.array(MailMessageDataSchema).optional(),
+    error: z.string().optional(),
+});
+// =============================================================================
+// Push notification
+// =============================================================================
+/** Push notification from hub to NAISYS when mail is received */
+export const MailReceivedPushSchema = z.object({
+    recipientUserIds: z.array(z.number()),
+    kind: MessageKindSchema,
+});
+/** Full-data mail/chat push from hub to supervisor after DB write */
+export const MailPushSchema = z.object({
+    recipientUserIds: z.array(z.number()),
+    fromUserId: z.number(),
+    kind: MessageKindSchema,
+    messageId: z.number(),
+    subject: z.string().optional(),
+    body: z.string(),
+    createdAt: z.string(),
+    participants: z.string(),
+    attachments: z.array(MailAttachmentDataSchema).optional(),
+});
+/** Read-receipt push from hub to supervisor when messages are marked read */
+export const MailReadPushSchema = z.object({
+    messageIds: z.array(z.number()),
+    userId: z.number(),
+    kind: MessageKindSchema,
+    participants: z.array(z.string()),
+});

package/dist/schemas/models.d.ts

@@ -0,0 +1,41 @@
+import { z } from "zod";
+/** Pushed from hub to NAISYS instances with all model definitions */
+export declare const ModelsResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    error: z.ZodOptional<z.ZodString>;
+    llmModels: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        versionName: z.ZodString;
+        apiType: z.ZodEnum<typeof import("@naisys/common").LlmApiType>;
+        maxTokens: z.ZodNumber;
+        baseUrl: z.ZodOptional<z.ZodString>;
+        apiKeyVar: z.ZodString;
+        inputCost: z.ZodDefault<z.ZodNumber>;
+        outputCost: z.ZodDefault<z.ZodNumber>;
+        cacheWriteCost: z.ZodOptional<z.ZodNumber>;
+        cacheReadCost: z.ZodOptional<z.ZodNumber>;
+        cacheTtlSeconds: z.ZodOptional<z.ZodNumber>;
+        supportsVision: z.ZodOptional<z.ZodBoolean>;
+        supportsHearing: z.ZodOptional<z.ZodBoolean>;
+        supportsComputerUse: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    imageModels: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        versionName: z.ZodString;
+        size: z.ZodString;
+        baseUrl: z.ZodOptional<z.ZodString>;
+        apiKeyVar: z.ZodString;
+        cost: z.ZodNumber;
+        quality: z.ZodOptional<z.ZodEnum<{
+            standard: "standard";
+            hd: "hd";
+            high: "high";
+            medium: "medium";
+            low: "low";
+        }>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type ModelsResponse = z.infer<typeof ModelsResponseSchema>;
+//# sourceMappingURL=models.d.ts.map

package/dist/schemas/models.js

@@ -0,0 +1,9 @@
+import { ImageModelSchema, LlmModelSchema } from "@naisys/common";
+import { z } from "zod";
+/** Pushed from hub to NAISYS instances with all model definitions */
+export const ModelsResponseSchema = z.object({
+    success: z.boolean(),
+    error: z.string().optional(),
+    llmModels: z.array(LlmModelSchema).optional(),
+    imageModels: z.array(ImageModelSchema).optional(),
+});

package/dist/schemas/sessions.d.ts

@@ -0,0 +1,45 @@
+import { z } from "zod";
+/** Full session data pushed from hub to supervisor after creation */
+export declare const SessionPushSchema: z.ZodObject<{
+    session: z.ZodObject<{
+        userId: z.ZodNumber;
+        runId: z.ZodNumber;
+        sessionId: z.ZodNumber;
+        modelName: z.ZodString;
+        createdAt: z.ZodString;
+        lastActive: z.ZodString;
+        latestLogId: z.ZodNumber;
+        totalLines: z.ZodNumber;
+        totalCost: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type SessionPush = z.infer<typeof SessionPushSchema>;
+/** Request to create a new run session */
+export declare const SessionCreateRequestSchema: z.ZodObject<{
+    userId: z.ZodNumber;
+    modelName: z.ZodString;
+}, z.core.$strip>;
+export type SessionCreateRequest = z.infer<typeof SessionCreateRequestSchema>;
+/** Response to session create request */
+export declare const SessionCreateResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    runId: z.ZodOptional<z.ZodNumber>;
+    sessionId: z.ZodOptional<z.ZodNumber>;
+    error: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type SessionCreateResponse = z.infer<typeof SessionCreateResponseSchema>;
+/** Request to increment session for an existing run */
+export declare const SessionIncrementRequestSchema: z.ZodObject<{
+    userId: z.ZodNumber;
+    runId: z.ZodNumber;
+    modelName: z.ZodString;
+}, z.core.$strip>;
+export type SessionIncrementRequest = z.infer<typeof SessionIncrementRequestSchema>;
+/** Response to session increment request */
+export declare const SessionIncrementResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    sessionId: z.ZodOptional<z.ZodNumber>;
+    error: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type SessionIncrementResponse = z.infer<typeof SessionIncrementResponseSchema>;
+//# sourceMappingURL=sessions.d.ts.map

package/dist/schemas/sessions.js

@@ -0,0 +1,39 @@
+import { z } from "zod";
+/** Full session data pushed from hub to supervisor after creation */
+export const SessionPushSchema = z.object({
+    session: z.object({
+        userId: z.number(),
+        runId: z.number(),
+        sessionId: z.number(),
+        modelName: z.string(),
+        createdAt: z.string(),
+        lastActive: z.string(),
+        latestLogId: z.number(),
+        totalLines: z.number(),
+        totalCost: z.number(),
+    }),
+});
+/** Request to create a new run session */
+export const SessionCreateRequestSchema = z.object({
+    userId: z.number(),
+    modelName: z.string(),
+});
+/** Response to session create request */
+export const SessionCreateResponseSchema = z.object({
+    success: z.boolean(),
+    runId: z.number().optional(),
+    sessionId: z.number().optional(),
+    error: z.string().optional(),
+});
+/** Request to increment session for an existing run */
+export const SessionIncrementRequestSchema = z.object({
+    userId: z.number(),
+    runId: z.number(),
+    modelName: z.string(),
+});
+/** Response to session increment request */
+export const SessionIncrementResponseSchema = z.object({
+    success: z.boolean(),
+    sessionId: z.number().optional(),
+    error: z.string().optional(),
+});

package/dist/schemas/users.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+/** Response to user_list request - returns all users registered on the hub */
+export declare const UserListResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    error: z.ZodOptional<z.ZodString>;
+    users: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        userId: z.ZodNumber;
+        username: z.ZodString;
+        enabled: z.ZodBoolean;
+        leadUserId: z.ZodOptional<z.ZodNumber>;
+        config: z.ZodObject<{
+            username: z.ZodString;
+            title: z.ZodString;
+            agentPrompt: z.ZodString;
+            spendLimitDollars: z.ZodOptional<z.ZodNumber>;
+            spendLimitHours: z.ZodOptional<z.ZodNumber>;
+            tokenMax: z.ZodNumber;
+            shellModel: z.ZodString;
+            imageModel: z.ZodOptional<z.ZodString>;
+            mailEnabled: z.ZodOptional<z.ZodBoolean>;
+            chatEnabled: z.ZodOptional<z.ZodBoolean>;
+            webEnabled: z.ZodOptional<z.ZodBoolean>;
+            completeSessionEnabled: z.ZodOptional<z.ZodBoolean>;
+            debugPauseSeconds: z.ZodOptional<z.ZodNumber>;
+            wakeOnMessage: z.ZodOptional<z.ZodBoolean>;
+            commandProtection: z.ZodOptional<z.ZodEnum<{
+                none: "none";
+                manual: "manual";
+                "semi-auto": "semi-auto";
+                auto: "auto";
+            }>>;
+            initialCommands: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            multipleCommandsEnabled: z.ZodOptional<z.ZodBoolean>;
+            workspacesEnabled: z.ZodOptional<z.ZodBoolean>;
+            controlDesktop: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>;
+        assignedHostIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        apiKey: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type UserListResponse = z.infer<typeof UserListResponseSchema>;
+//# sourceMappingURL=users.d.ts.map

package/dist/schemas/users.js

@@ -0,0 +1,18 @@
+import { AgentConfigFileSchema } from "@naisys/common";
+import { z } from "zod";
+/** Response to user_list request - returns all users registered on the hub */
+export const UserListResponseSchema = z.object({
+    success: z.boolean(),
+    error: z.string().optional(),
+    users: z
+        .array(z.object({
+        userId: z.number(),
+        username: z.string(),
+        enabled: z.boolean(),
+        leadUserId: z.number().optional(),
+        config: AgentConfigFileSchema,
+        assignedHostIds: z.array(z.number()).optional(),
+        apiKey: z.string().optional(),
+    }))
+        .optional(),
+});

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@naisys/hub-protocol",
+  "version": "3.0.0-beta.3",
+  "type": "module",
+  "description": "[internal] Protocol types and schemas for NAISYS Hub communication",
+  "files": [
+    "dist",
+    "!dist/**/*.map"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsc",
+    "npm:publish:dryrun": "npm publish --dry-run",
+    "npm:publish": "npm publish --access public"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@naisys/common": "3.0.0-beta.3",
+    "zod": "^4.3.6"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  }
+}