@aeolus-fleet/core 0.0.0 → 0.18.0

package/dist/adapters/trpc/fleet.d.ts

@@ -0,0 +1,637 @@
+/**
+ * Fleet procedures: commission ships, hand out their starting prompts, release
+ * them, list the fleet and follow it live, read a ship's page (the ship, its
+ * timeline, its messages and one message's delivery history), and Needs
+ * attention: the undeliverable deliveries, resent or dismissed, and argo's
+ * inbox: the messages to it, read, marked done or replied to. The caller's
+ * fleet and ship come from its credentials, never from the input.
+ */
+export declare const fleetRouter: import("@trpc/server").TRPCBuiltRouter<{
+    ctx: import("./context.js").Context;
+    meta: import("./trpc.js").ProcedureMeta;
+    errorShape: import("@trpc/server").TRPCDefaultErrorShape | {
+        message: string;
+        data: {
+            requestId: string | undefined;
+            code: import("@trpc/server").TRPC_ERROR_CODE_KEY;
+            httpStatus: number;
+            path?: string;
+            stack?: string;
+        };
+        code: import("@trpc/server").TRPC_ERROR_CODE_NUMBER;
+    };
+    transformer: false;
+}, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
+    /** A new agent ship awaiting crew, and its first starting prompt: shown once. */
+    commission: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            name: string;
+            type: string;
+            idempotencyKey: string;
+            fleetScopes?: ("fleet:read" | "fleet:manage" | "fleet:crew" | "crew:assign" | "crew:run")[] | undefined;
+            note?: string | undefined;
+        };
+        output: {
+            shipId: `shp_${string}`;
+            prompt: string | null;
+            crewLines: {
+                harness: string;
+                line: string;
+            }[] | null;
+            secret: string | null;
+            startingPrompt: {
+                issuedAt: string;
+                isClaimed: boolean;
+            } | null;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** A new starting prompt for a ship awaiting crew. Its secret invalidates the previous one. */
+    getStartingPrompt: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: {
+            shipId: `shp_${string}`;
+            prompt: string;
+            crewLines: {
+                harness: string;
+                line: string;
+            }[];
+            secret: string;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * Pings a crewed ship: a message its session answers with pong, proving
+     * its model is working. Pings never stack: while one waits unanswered, this
+     * answers with that one. Never argo, a ship awaiting crew or a retired one.
+     */
+    ping: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: {
+            messageId: `msg_${string}`;
+            sentAt: string;
+            isNew: boolean;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * Frees a crewed ship from the session crewing it: its crew token and secret
+     * stop working, and what it held in flight returns to pending for the next
+     * crew. Never argo; a ship awaiting crew gets a new starting prompt instead.
+     */
+    release: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * Ends a ship for good, crewed or not, never argo: its lease and secret end,
+     * its direct deliveries are abandoned, deliveries to its type stay for the
+     * other ships of the type. Answers how many it abandoned.
+     */
+    retire: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: {
+            abandonedDeliveries: number;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * Asks that a ship be kept crewed, with settings stored without meaning,
+     * replacing any request it holds (decision 0029).
+     */
+    crewRequest: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+            settings: Record<string, import("zod").JSONType>;
+        };
+        output: {
+            settingsVersion: number;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Removes a ship's crew request; its crew, if any, stays aboard. */
+    removeCrewRequest: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Assigns a ship's crew request to a trierarch, only while it is unassigned (optimistic claim, decision 0029). */
+    assignCrew: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+            trierarchShipId: unknown;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** The assigner writes why no trierarch can take a ship's unassigned crew request. */
+    explainCrewRequest: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+            reason: string | null;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** The assigned trierarch writes how its crew of a ship stands. */
+    reportCrewStatus: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+            status: "crewing" | "running" | "restarting" | "crashed" | "releasing";
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** The assigned trierarch confirms it released the ship of a releasing request, which then goes (the finalizer). */
+    confirmCrewRelease: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** The crew requests assigned to the caller's ship: a trierarch's ships. */
+    assignedCrewRequests: import("@trpc/server").TRPCQueryProcedure<{
+        input: void;
+        output: {
+            shipId: `shp_${string}`;
+            settings: Record<string, import("zod").JSONType>;
+            settingsVersion: number;
+            requestedAt: string;
+            status: "crewing" | "running" | "restarting" | "crashed" | "releasing" | null;
+        }[];
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * Gives a ship a new name, any ship but argo or a retired one. Its id,
+     * history and session stay; a sender addressing the old name no longer
+     * reaches it.
+     */
+    rename: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+            name: string;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * A new crew for a crewed ship whose session is gone: a release and a new
+     * starting prompt in one transaction. Its prompt, crew lines and secret are shown once.
+     */
+    recrew: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: {
+            shipId: `shp_${string}`;
+            prompt: string;
+            crewLines: {
+                harness: string;
+                line: string;
+            }[];
+            secret: string;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * The fleet's ship and daily message limits with what each counts, and when
+     * today's message count starts again: what the console shows at a limit.
+     */
+    limits: import("@trpc/server").TRPCQueryProcedure<{
+        input: void;
+        output: {
+            ships: {
+                limit: number | null;
+                count: number;
+            };
+            dailyMessages: {
+                limit: number | null;
+                count: number;
+                resetsAt: string;
+            };
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Every ship of the caller's fleet with its status and prompt state. Never a secret. */
+    list: import("@trpc/server").TRPCQueryProcedure<{
+        input: void;
+        output: {
+            id: `shp_${string}`;
+            name: string;
+            type: string;
+            kind: "operator" | "agent" | "viewer";
+            status: "retired" | "awaitingCrew" | "crewed";
+            startingPrompt: {
+                issuedAt: string;
+                isClaimed: boolean;
+            } | null;
+            location: {
+                kind: "DEVICE" | "CLOUD" | "SERVER" | "OTHER";
+                description: string | null;
+            } | null;
+            lastSeenAt: string | null;
+            ping: {
+                state: "undeliverable" | "waiting" | "answered" | "received";
+                sentAt: string;
+                answeredAt: string | null;
+            } | null;
+            harness: string | null;
+            model: {
+                id: string;
+                statedAt: string;
+            } | null;
+            scopes: ("messages:send" | "messages:receive" | "fleet:read" | "fleet:manage" | "fleet:crew" | "crew:assign" | "crew:run")[];
+            report: {
+                state: "working" | "blocked" | "idle";
+                note: string | null;
+                reportedAt: string;
+                detailsVersion: number;
+            } | null;
+            crewRequest: {
+                settingsVersion: number;
+                requestedAt: string;
+                assignedTo: {
+                    id: `shp_${string}`;
+                    name: string;
+                } | null;
+                status: "crewing" | "running" | "restarting" | "crashed" | "releasing" | null;
+                reason: string | null;
+                crewedBy: {
+                    id: `shp_${string}`;
+                    name: string;
+                } | null;
+            } | null;
+            awaitingCrewSince: string | null;
+            retiredAt: string | null;
+        }[];
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** One ship of the fleet, retired ones included, with when it was commissioned, crewed and retired. */
+    ship: import("@trpc/server").TRPCQueryProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: {
+            id: `shp_${string}`;
+            name: string;
+            type: string;
+            kind: "operator" | "agent" | "viewer";
+            status: "retired" | "awaitingCrew" | "crewed";
+            startingPrompt: {
+                issuedAt: string;
+                isClaimed: boolean;
+            } | null;
+            location: {
+                kind: "DEVICE" | "CLOUD" | "SERVER" | "OTHER";
+                description: string | null;
+            } | null;
+            lastSeenAt: string | null;
+            ping: {
+                state: "undeliverable" | "waiting" | "answered" | "received";
+                sentAt: string;
+                answeredAt: string | null;
+            } | null;
+            harness: string | null;
+            model: {
+                id: string;
+                statedAt: string;
+            } | null;
+            scopes: ("messages:send" | "messages:receive" | "fleet:read" | "fleet:manage" | "fleet:crew" | "crew:assign" | "crew:run")[];
+            awaitingCrewSince: string | null;
+            retiredAt: string | null;
+            report: {
+                state: "working" | "blocked" | "idle";
+                note: string | null;
+                reportedAt: string;
+                detailsVersion: number;
+                details: Record<string, import("zod").JSONType> | null;
+            } | null;
+            crewRequest: {
+                settingsVersion: number;
+                requestedAt: string;
+                assignedTo: {
+                    id: `shp_${string}`;
+                    name: string;
+                } | null;
+                status: "crewing" | "running" | "restarting" | "crashed" | "releasing" | null;
+                reason: string | null;
+                crewedBy: {
+                    id: `shp_${string}`;
+                    name: string;
+                } | null;
+                settings: Record<string, import("zod").JSONType>;
+            } | null;
+            commissionedAt: string;
+            crewedSince: string | null;
+            inFlightDeliveries: number;
+            openDeliveries: number;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Every change to a ship, newest first: the events naming it and the ones it caused. */
+    shipTimeline: import("@trpc/server").TRPCQueryProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: {
+            seq: number;
+            id: `evt_${string}`;
+            type: "FleetInitialised" | "ShipCommissioned" | "ShipClaimed" | "LeaseRevoked" | "CredentialRevoked" | "StartingPromptIssued" | "OperatorPasswordReset" | "MessageAccepted" | "DeliveryClaimed" | "DeliveryAcknowledged" | "DeliveryUndeliverable" | "DeliveryReturned" | "ShipRetired" | "DeliveryAbandoned" | "DeliveryDismissed" | "ShipRenamed" | "ShipReported" | "SignInTicketIssued" | "FleetLimitsChanged" | "ViewerSessionStarted" | "CrewRequested" | "CrewRequestRemoved" | "CrewAssigned" | "CrewStatusChanged" | "CrewRequestExplained";
+            occurredAt: string;
+            actor: {
+                id: `shp_${string}`;
+                name: string;
+            } | null;
+            ship: {
+                id: `shp_${string}`;
+                name: string;
+            } | null;
+            message: {
+                id: `msg_${string}`;
+                sender: {
+                    id: `shp_${string}`;
+                    name: string;
+                };
+                recipient: {
+                    kind: "ship";
+                    ship: {
+                        id: `shp_${string}`;
+                        name: string;
+                    };
+                } | {
+                    kind: "type";
+                    type: string;
+                };
+                contentType: string;
+                model: string | null;
+            } | null;
+            details: Record<string, string | number | boolean | null>;
+        }[];
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** The messages a ship sent, was sent, or claimed as a ship of their type, newest first. */
+    shipMessages: import("@trpc/server").TRPCQueryProcedure<{
+        input: {
+            shipId: unknown;
+        };
+        output: {
+            id: `msg_${string}`;
+            sender: {
+                id: `shp_${string}`;
+                name: string;
+            };
+            recipient: {
+                kind: "ship";
+                ship: {
+                    id: `shp_${string}`;
+                    name: string;
+                };
+            } | {
+                kind: "type";
+                type: string;
+            };
+            inReplyTo: `msg_${string}` | null;
+            sentAt: string;
+            contentType: string;
+            model: string | null;
+            preview: string;
+            delivery: {
+                id: `dlv_${string}`;
+                state: "pending" | "delivered" | "acknowledged" | "undeliverable" | "dismissed" | "abandoned";
+                claimedBy: {
+                    id: `shp_${string}`;
+                    name: string;
+                } | null;
+            };
+        }[];
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** One message: envelope, payload, and its delivery with every change, newest first. */
+    message: import("@trpc/server").TRPCQueryProcedure<{
+        input: {
+            messageId: unknown;
+        };
+        output: {
+            id: `msg_${string}`;
+            recipient: {
+                kind: "ship";
+                ship: {
+                    id: `shp_${string}`;
+                    name: string;
+                };
+            } | {
+                kind: "type";
+                type: string;
+            };
+            contentType: string;
+            model: string | null;
+            inReplyTo: `msg_${string}` | null;
+            sentAt: string;
+            sender: {
+                id: `shp_${string}`;
+                name: string;
+            };
+            payload: string;
+            delivery: {
+                id: `dlv_${string}`;
+                state: "pending" | "delivered" | "acknowledged" | "undeliverable" | "dismissed" | "abandoned";
+                attempts: number;
+                claimedBy: {
+                    id: `shp_${string}`;
+                    name: string;
+                } | null;
+                history: {
+                    seq: number;
+                    type: "MessageAccepted" | "DeliveryClaimed" | "DeliveryAcknowledged" | "DeliveryUndeliverable" | "DeliveryReturned" | "DeliveryAbandoned" | "DeliveryDismissed";
+                    occurredAt: string;
+                    ship: {
+                        id: `shp_${string}`;
+                        name: string;
+                    } | null;
+                    location: {
+                        kind: "DEVICE" | "CLOUD" | "SERVER" | "OTHER";
+                        description: string | null;
+                    } | null;
+                    harness: string | null;
+                    attempts: number | null;
+                }[];
+            };
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Needs attention: every undeliverable delivery of the fleet, oldest first, with its whole message. */
+    needsAttention: import("@trpc/server").TRPCQueryProcedure<{
+        input: void;
+        output: {
+            deliveryId: `dlv_${string}`;
+            attempts: number;
+            since: string;
+            message: {
+                id: `msg_${string}`;
+                sender: {
+                    id: `shp_${string}`;
+                    name: string;
+                };
+                recipient: {
+                    kind: "ship";
+                    ship: {
+                        id: `shp_${string}`;
+                        name: string;
+                    };
+                } | {
+                    kind: "type";
+                    type: string;
+                };
+                inReplyTo: `msg_${string}` | null;
+                sentAt: string;
+                contentType: string;
+                payload: string;
+            };
+        }[];
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Lets an undeliverable delivery go: dismissed, kept in history. Dismissing it again is OK. */
+    dismiss: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            deliveryId: unknown;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * Sends an undeliverable delivery again: a new message from the same sender
+     * to the same recipient that names the original, which is dismissed.
+     * Answers the new message; a second resend of the delivery answers the same.
+     */
+    resend: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            deliveryId: unknown;
+        };
+        output: {
+            messageId: `msg_${string}`;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** The caller's inbox, argo's for the console: the messages to it the filter keeps, newest first. */
+    inbox: import("@trpc/server").TRPCQueryProcedure<{
+        input: {
+            filter: "open" | "done" | "all";
+        };
+        output: {
+            deliveryId: `dlv_${string}`;
+            state: "pending" | "delivered" | "acknowledged" | "undeliverable" | "dismissed" | "abandoned";
+            readAt: string | null;
+            doneAt: string | null;
+            repliedWith: `msg_${string}` | null;
+            message: {
+                id: `msg_${string}`;
+                sender: {
+                    id: `shp_${string}`;
+                    name: string;
+                };
+                inReplyTo: `msg_${string}` | null;
+                sentAt: string;
+                contentType: string;
+                model: string | null;
+                payload: string;
+            };
+        }[];
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Marks a message to argo read, as opening it does, or unread again. Read is not done. */
+    markRead: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            deliveryId: unknown;
+            isRead: boolean;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Marks a message to argo done without a reply: acknowledged under the console session's lease. */
+    markDone: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            deliveryId: unknown;
+        };
+        output: Record<string, never>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /** Replies to a message to argo as plain text to its sender, and marks it done, in one transaction. */
+    reply: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            deliveryId: unknown;
+            payload: string;
+            idempotencyKey: string;
+        };
+        output: {
+            messageId: `msg_${string}`;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * The fleet's committed events after a position, for a client that is no
+     * browser: the same numbers the live stream sends, waiting up to
+     * waitSeconds while none has come. A query: it changes nothing.
+     */
+    follow: import("@trpc/server").TRPCQueryProcedure<{
+        input: {
+            afterSeq?: number | undefined;
+            max?: number | undefined;
+            waitSeconds?: number | undefined;
+        } | undefined;
+        output: {
+            events: {
+                seq: number;
+                id: `evt_${string}`;
+                type: "FleetInitialised" | "ShipCommissioned" | "ShipClaimed" | "LeaseRevoked" | "CredentialRevoked" | "StartingPromptIssued" | "OperatorPasswordReset" | "MessageAccepted" | "DeliveryClaimed" | "DeliveryAcknowledged" | "DeliveryUndeliverable" | "DeliveryReturned" | "ShipRetired" | "DeliveryAbandoned" | "DeliveryDismissed" | "ShipRenamed" | "ShipReported" | "SignInTicketIssued" | "FleetLimitsChanged" | "ViewerSessionStarted" | "CrewRequested" | "CrewRequestRemoved" | "CrewAssigned" | "CrewStatusChanged" | "CrewRequestExplained";
+                occurredAt: string;
+                actorShipId: `shp_${string}` | null;
+                shipId: `shp_${string}` | null;
+                messageId: `msg_${string}` | null;
+                deliveryId: `dlv_${string}` | null;
+            }[];
+            lastSeq: number;
+        };
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+    /**
+     * The fleet's committed events, live, over the WebSocket: each with its
+     * number, which tRPC sends back as `lastEventId` when the browser
+     * reconnects, so it misses none. Without a number, or too far behind, the
+     * browser is told to load the fleet again first (`resync`). Each wake-up
+     * asks again whether the caller still holds, so a console session that ended
+     * hears no more.
+     */
+    events: import("@trpc/server").TRPCSubscriptionProcedure<{
+        input: {
+            lastEventId?: string | null | undefined;
+        };
+        output: AsyncIterable<import("@trpc/server/unstable-core-do-not-import").TrackedData<{
+            kind: "event";
+            event: {
+                seq: number;
+                id: `evt_${string}`;
+                type: "FleetInitialised" | "ShipCommissioned" | "ShipClaimed" | "LeaseRevoked" | "CredentialRevoked" | "StartingPromptIssued" | "OperatorPasswordReset" | "MessageAccepted" | "DeliveryClaimed" | "DeliveryAcknowledged" | "DeliveryUndeliverable" | "DeliveryReturned" | "ShipRetired" | "DeliveryAbandoned" | "DeliveryDismissed" | "ShipRenamed" | "ShipReported" | "SignInTicketIssued" | "FleetLimitsChanged" | "ViewerSessionStarted" | "CrewRequested" | "CrewRequestRemoved" | "CrewAssigned" | "CrewStatusChanged" | "CrewRequestExplained";
+                occurredAt: string;
+                actorShipId: `shp_${string}` | null;
+                shipId: `shp_${string}` | null;
+                messageId: `msg_${string}` | null;
+                deliveryId: `dlv_${string}` | null;
+            };
+        } | {
+            kind: "resync";
+        }>, any, any>;
+        meta: import("./trpc.js").ProcedureMeta;
+    }>;
+}>>;