@aeolus-fleet/common 0.22.0 → 0.24.0

package/dist/schemas/index.d.ts

@@ -15,6 +15,7 @@ export * from './network.js';
 export * from './notice.js';
 export * from './operator-inbox.js';
 export * from './ping.js';
+export * from './question.js';
 export * from './report.js';
 export * from './ship.js';
 export * from './system.js';

package/dist/schemas/index.js

@@ -15,6 +15,7 @@ export * from './network.js';
 export * from './notice.js';
 export * from './operator-inbox.js';
 export * from './ping.js';
+export * from './question.js';
 export * from './report.js';
 export * from './ship.js';
 export * from './system.js';

package/dist/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}

package/dist/schemas/operator-inbox.d.ts

@@ -15,7 +15,7 @@ export declare const operatorInboxInputSchema: z.ZodObject<{
         all: "all";
     }>;
 }, z.core.$strip>;
-/** One message to argo: its delivery's state, when it was read and done, the reply that made it done, and the message. */
+/** One message to argo: its delivery's state, when it was read and done, the reply that made it done, argo's replies to it, and the message. */
 export declare const inboxMessageSchema: z.ZodObject<{
     deliveryId: z.ZodType<`dlv_${string}`, unknown, z.core.$ZodTypeInternals<`dlv_${string}`, unknown>>;
     state: z.ZodEnum<{
@@ -29,6 +29,12 @@ export declare const inboxMessageSchema: z.ZodObject<{
     readAt: z.ZodNullable<z.ZodISODateTime>;
     doneAt: z.ZodNullable<z.ZodISODateTime>;
     repliedWith: z.ZodNullable<z.ZodType<`msg_${string}`, unknown, z.core.$ZodTypeInternals<`msg_${string}`, unknown>>>;
+    replies: z.ZodArray<z.ZodObject<{
+        id: z.ZodType<`msg_${string}`, unknown, z.core.$ZodTypeInternals<`msg_${string}`, unknown>>;
+        contentType: z.ZodString;
+        payload: z.ZodString;
+        sentAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
     message: z.ZodObject<{
         id: z.ZodType<`msg_${string}`, unknown, z.core.$ZodTypeInternals<`msg_${string}`, unknown>>;
         sender: z.ZodObject<{
@@ -57,6 +63,12 @@ export declare const operatorInboxOutputSchema: z.ZodArray<z.ZodObject<{
     readAt: z.ZodNullable<z.ZodISODateTime>;
     doneAt: z.ZodNullable<z.ZodISODateTime>;
     repliedWith: z.ZodNullable<z.ZodType<`msg_${string}`, unknown, z.core.$ZodTypeInternals<`msg_${string}`, unknown>>>;
+    replies: z.ZodArray<z.ZodObject<{
+        id: z.ZodType<`msg_${string}`, unknown, z.core.$ZodTypeInternals<`msg_${string}`, unknown>>;
+        contentType: z.ZodString;
+        payload: z.ZodString;
+        sentAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
     message: z.ZodObject<{
         id: z.ZodType<`msg_${string}`, unknown, z.core.$ZodTypeInternals<`msg_${string}`, unknown>>;
         sender: z.ZodObject<{
@@ -83,11 +95,13 @@ export declare const markDoneInputSchema: z.ZodObject<{
 }, z.core.$strip>;
 /**
  * Input of `fleet.reply`: an answer to a message sent to argo, named by its
- * delivery, as plain text to its sender, which also marks the message done.
+ * delivery, to its sender, as plain text unless it says another content type,
+ * which also marks the message done.
  */
 export declare const replyInputSchema: z.ZodObject<{
     deliveryId: z.ZodType<`dlv_${string}`, unknown, z.core.$ZodTypeInternals<`dlv_${string}`, unknown>>;
     payload: z.ZodString;
+    contentType: z.ZodOptional<z.ZodString>;
     idempotencyKey: z.ZodString;
 }, z.core.$strip>;
 /** Output of `fleet.reply`: the reply. */

package/dist/schemas/operator-inbox.js

@@ -2,7 +2,7 @@ import { z } from 'zod';
 import { deliveryStateSchema } from '../fleet/index.js';
 import { idSchema } from '../ids/index.js';
 import { partySchema } from './history.js';
-import { sendInputSchema } from './message.js';
+import { contentTypeSchema, sendInputSchema } from './message.js';
 /**
  * Inputs and outputs of the operator inbox (docs/blueprint.md, "Inbox"): the
  * messages ships sent to argo. Opening one marks it read; read is not done.
@@ -15,7 +15,7 @@ export const INBOX_FILTERS = ['open', 'done', 'all'];
 export const inboxFilterSchema = z.enum(INBOX_FILTERS);
 /** Input of `fleet.inbox`. */
 export const operatorInboxInputSchema = z.object({ filter: inboxFilterSchema });
-/** One message to argo: its delivery's state, when it was read and done, the reply that made it done, and the message. */
+/** One message to argo: its delivery's state, when it was read and done, the reply that made it done, argo's replies to it, and the message. */
 export const inboxMessageSchema = z.object({
     deliveryId: idSchema('delivery'),
     state: deliveryStateSchema,
@@ -25,6 +25,8 @@ export const inboxMessageSchema = z.object({
     doneAt: isoTime.nullable(),
     /** The reply that acknowledged it, when a reply did. */
     repliedWith: idSchema('message').nullable(),
+    /** Every reply argo sent to it, oldest first: what a console reads an answer from (decision 0038). */
+    replies: z.array(z.object({ id: idSchema('message'), contentType: z.string(), payload: z.string(), sentAt: isoTime })),
     message: z.object({
         id: idSchema('message'),
         sender: partySchema,
@@ -46,11 +48,13 @@ export const inboxActionOutputSchema = z.strictObject({});
 export const markDoneInputSchema = z.object({ deliveryId: idSchema('delivery') });
 /**
  * Input of `fleet.reply`: an answer to a message sent to argo, named by its
- * delivery, as plain text to its sender, which also marks the message done.
+ * delivery, to its sender, as plain text unless it says another content type,
+ * which also marks the message done.
  */
 export const replyInputSchema = z.object({
     deliveryId: idSchema('delivery'),
     payload: sendInputSchema.shape.payload,
+    contentType: contentTypeSchema.optional(),
     idempotencyKey: sendInputSchema.shape.idempotencyKey,
 });
 /** Output of `fleet.reply`: the reply. */

package/dist/schemas/operator-inbox.js.map

@@ -1 +1 @@
-{"version":3,"file":"operator-inbox.js","sourceRoot":"","sources":["../../src/schemas/operator-inbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C;;;;GAIG;AAEH,uBAAuB;AACvB,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;AAEjC,yDAAyD;AACzD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAU,CAAC;AAC9D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AAGvD,8BAA8B;AAC9B,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAEhF,0HAA0H;AAC1H,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IAChC,KAAK,EAAE,mBAAmB;IAC1B,sDAAsD;IACtD,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC1B,iDAAiD;IACjD,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC1B,wDAAwD;IACxD,WAAW,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;IAC3C,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,EAAE,EAAE,QAAQ,CAAC,SAAS,CAAC;QACvB,MAAM,EAAE,WAAW;QACnB,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;QACzC,MAAM,EAAE,OAAO;QACf,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,qDAAqD;QACrD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC;CACH,CAAC,CAAC;AAIH,oFAAoF;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;AAErE,2EAA2E;AAC3E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAEvG,sFAAsF;AACtF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;AAE1D,mFAAmF;AACnF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAElF;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IAChC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,OAAO;IACtC,cAAc,EAAE,eAAe,CAAC,KAAK,CAAC,cAAc;CACrD,CAAC,CAAC;AAEH,0CAA0C;AAC1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC"}
+{"version":3,"file":"operator-inbox.js","sourceRoot":"","sources":["../../src/schemas/operator-inbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAElE;;;;GAIG;AAEH,uBAAuB;AACvB,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;AAEjC,yDAAyD;AACzD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAU,CAAC;AAC9D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AAGvD,8BAA8B;AAC9B,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAEhF,gJAAgJ;AAChJ,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IAChC,KAAK,EAAE,mBAAmB;IAC1B,sDAAsD;IACtD,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC1B,iDAAiD;IACjD,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC1B,wDAAwD;IACxD,WAAW,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;IAC3C,sGAAsG;IACtG,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACtH,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,EAAE,EAAE,QAAQ,CAAC,SAAS,CAAC;QACvB,MAAM,EAAE,WAAW;QACnB,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;QACzC,MAAM,EAAE,OAAO;QACf,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,qDAAqD;QACrD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC;CACH,CAAC,CAAC;AAIH,oFAAoF;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;AAErE,2EAA2E;AAC3E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAEvG,sFAAsF;AACtF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;AAE1D,mFAAmF;AACnF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAElF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IAChC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,OAAO;IACtC,WAAW,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IACzC,cAAc,EAAE,eAAe,CAAC,KAAK,CAAC,cAAc;CACrD,CAAC,CAAC;AAEH,0CAA0C;AAC1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC"}

package/dist/schemas/question.d.ts

@@ -0,0 +1,138 @@
+import { z } from 'zod';
+import { type MessageId } from '../ids/index.js';
+/**
+ * Questions to argo (decision 0038): a ship asks the operator by sending a
+ * message of the question content type to argo; the console answers it with a
+ * reply of the answer content type. Both payloads are data only: the fleet
+ * carries them as any message and never reads them; the console's server
+ * does. A question is open until argo
+ * sends its answer, whatever its delivery's state. The asking ship withdraws
+ * a question, or replaces it with a new one, by a message of its own content
+ * type naming the question's uuid.
+ */
+export declare const QUESTION_CONTENT_TYPE = "application/vnd.aeolus.question+json";
+export declare const ANSWER_CONTENT_TYPE = "application/vnd.aeolus.answer+json";
+export declare const WITHDRAWAL_CONTENT_TYPE = "application/vnd.aeolus.question-withdrawal+json";
+export declare const REPLACEMENT_CONTENT_TYPE = "application/vnd.aeolus.question-replacement+json";
+export declare function isQuestionContentType(contentType: string): boolean;
+export declare function isAnswerContentType(contentType: string): boolean;
+export declare function isWithdrawalContentType(contentType: string): boolean;
+export declare function isReplacementContentType(contentType: string): boolean;
+/** A question: its own uuid, a title, the context to answer from, numbered options, and the asker's pick and why. */
+export declare const questionSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    title: z.ZodString;
+    context: z.ZodString;
+    options: z.ZodArray<z.ZodObject<{
+        key: z.ZodInt;
+        label: z.ZodString;
+        detail: z.ZodString;
+    }, z.core.$strip>>;
+    pick: z.ZodObject<{
+        option: z.ZodInt;
+        why: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type Question = z.infer<typeof questionSchema>;
+/** A withdrawal: the uuid of the question the asker withdraws. */
+export declare const withdrawalSchema: z.ZodObject<{
+    questionId: z.ZodUUID;
+}, z.core.$strip>;
+/** A replacement: the uuid of the question the asker replaces, and the new question, with a uuid of its own. */
+export declare const replacementSchema: z.ZodObject<{
+    questionId: z.ZodUUID;
+    question: z.ZodObject<{
+        id: z.ZodUUID;
+        title: z.ZodString;
+        context: z.ZodString;
+        options: z.ZodArray<z.ZodObject<{
+            key: z.ZodInt;
+            label: z.ZodString;
+            detail: z.ZodString;
+        }, z.core.$strip>>;
+        pick: z.ZodObject<{
+            option: z.ZodInt;
+            why: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/** What the operator answers: one option and an optional note, or a note alone (more context needed, or none of the options). */
+export declare const answerChoiceSchema: z.ZodUnion<readonly [z.ZodObject<{
+    option: z.ZodInt;
+    note: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    note: z.ZodString;
+}, z.core.$strip>]>;
+export type AnswerChoice = z.infer<typeof answerChoiceSchema>;
+/** An answer: the question's uuid, and one option plus an optional note, or a note alone. */
+export declare const answerSchema: z.ZodUnion<readonly [z.ZodObject<{
+    questionId: z.ZodUUID;
+    option: z.ZodInt;
+    note: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    questionId: z.ZodUUID;
+    note: z.ZodString;
+}, z.core.$strip>]>;
+export type Answer = z.infer<typeof answerSchema>;
+/** The answer a question in argo's inbox has: the reply that carries it, when, and what it says. */
+export declare const inboxAnswerSchema: z.ZodObject<{
+    messageId: z.ZodType<`msg_${string}`, unknown, z.core.$ZodTypeInternals<`msg_${string}`, unknown>>;
+    sentAt: z.ZodISODateTime;
+    option: z.ZodNullable<z.ZodInt>;
+    note: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/** A question in argo's inbox, with its answer; null while it is open. */
+export declare const inboxQuestionSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    title: z.ZodString;
+    context: z.ZodString;
+    options: z.ZodArray<z.ZodObject<{
+        key: z.ZodInt;
+        label: z.ZodString;
+        detail: z.ZodString;
+    }, z.core.$strip>>;
+    pick: z.ZodObject<{
+        option: z.ZodInt;
+        why: z.ZodString;
+    }, z.core.$strip>;
+    answer: z.ZodNullable<z.ZodObject<{
+        messageId: z.ZodType<`msg_${string}`, unknown, z.core.$ZodTypeInternals<`msg_${string}`, unknown>>;
+        sentAt: z.ZodISODateTime;
+        option: z.ZodNullable<z.ZodInt>;
+        note: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type InboxQuestion = z.infer<typeof inboxQuestionSchema>;
+interface Carried {
+    contentType: string;
+    payload: string;
+}
+/**
+ * The question a message withdraws, and the new question when it replaces it;
+ * null when the message is neither a withdrawal nor a replacement.
+ */
+export declare function withdrawalOf({ contentType, payload }: Carried): {
+    questionId: string;
+    replacement: Question | null;
+} | null;
+/**
+ * The question a message to argo asks (a question, or the new question of a
+ * replacement), and its answer among argo's replies
+ * to it (the first answer naming the question); null when the message asks
+ * no question.
+ */
+export declare function inboxQuestionOf<T>({ message, replies, }: {
+    message: Carried;
+    replies: readonly (Carried & {
+        id: MessageId;
+        sentAt: T;
+    })[];
+}): (Question & {
+    answer: {
+        messageId: MessageId;
+        sentAt: T;
+        option: number | null;
+        note: string | null;
+    } | null;
+}) | null;
+export {};

package/dist/schemas/question.js

@@ -0,0 +1,154 @@
+import { z } from 'zod';
+import { idSchema } from '../ids/index.js';
+/**
+ * Questions to argo (decision 0038): a ship asks the operator by sending a
+ * message of the question content type to argo; the console answers it with a
+ * reply of the answer content type. Both payloads are data only: the fleet
+ * carries them as any message and never reads them; the console's server
+ * does. A question is open until argo
+ * sends its answer, whatever its delivery's state. The asking ship withdraws
+ * a question, or replaces it with a new one, by a message of its own content
+ * type naming the question's uuid.
+ */
+export const QUESTION_CONTENT_TYPE = 'application/vnd.aeolus.question+json';
+export const ANSWER_CONTENT_TYPE = 'application/vnd.aeolus.answer+json';
+export const WITHDRAWAL_CONTENT_TYPE = 'application/vnd.aeolus.question-withdrawal+json';
+export const REPLACEMENT_CONTENT_TYPE = 'application/vnd.aeolus.question-replacement+json';
+/** A content type's essence: media types compare without case and without their parameters (RFC 9110). */
+function essenceOf(contentType) {
+    const [essence = ''] = contentType.split(';');
+    return essence.trim().toLowerCase();
+}
+export function isQuestionContentType(contentType) {
+    return essenceOf(contentType) === QUESTION_CONTENT_TYPE;
+}
+export function isAnswerContentType(contentType) {
+    return essenceOf(contentType) === ANSWER_CONTENT_TYPE;
+}
+export function isWithdrawalContentType(contentType) {
+    return essenceOf(contentType) === WITHDRAWAL_CONTENT_TYPE;
+}
+export function isReplacementContentType(contentType) {
+    return essenceOf(contentType) === REPLACEMENT_CONTENT_TYPE;
+}
+const FIRST_OPTION = 1;
+/** An option's number, from 1. */
+const optionKeySchema = z.int().min(FIRST_OPTION);
+const textSchema = z.string().min(1);
+const optionSchema = z.object({ key: optionKeySchema, label: textSchema, detail: z.string() });
+/** A question: its own uuid, a title, the context to answer from, numbered options, and the asker's pick and why. */
+export const questionSchema = z
+    .object({
+    id: z.uuid(),
+    title: textSchema,
+    context: z.string(),
+    options: z.array(optionSchema).min(1),
+    pick: z.object({ option: optionKeySchema, why: textSchema }),
+})
+    .refine(({ options }) => new Set(options.map(({ key }) => key)).size === options.length, {
+    message: 'Every option has its own number',
+    path: ['options'],
+})
+    .refine(({ options, pick }) => options.some(({ key }) => key === pick.option), {
+    message: 'The pick names one of the options',
+    path: ['pick', 'option'],
+});
+/** A withdrawal: the uuid of the question the asker withdraws. */
+export const withdrawalSchema = z.object({ questionId: z.uuid() });
+/** A replacement: the uuid of the question the asker replaces, and the new question, with a uuid of its own. */
+export const replacementSchema = z
+    .object({ questionId: z.uuid(), question: questionSchema })
+    .refine(({ questionId, question }) => question.id !== questionId, {
+    message: 'The new question has a uuid of its own',
+    path: ['question', 'id'],
+});
+/** What the operator answers: one option and an optional note, or a note alone (more context needed, or none of the options). */
+export const answerChoiceSchema = z.union([
+    z.object({ option: optionKeySchema, note: textSchema.optional() }),
+    z.object({ note: textSchema }),
+]);
+/** An answer: the question's uuid, and one option plus an optional note, or a note alone. */
+export const answerSchema = z.union([
+    z.object({ questionId: z.uuid(), option: optionKeySchema, note: textSchema.optional() }),
+    z.object({ questionId: z.uuid(), note: textSchema }),
+]);
+/** The answer a question in argo's inbox has: the reply that carries it, when, and what it says. */
+export const inboxAnswerSchema = z.object({
+    messageId: idSchema('message'),
+    sentAt: z.iso.datetime(),
+    option: optionKeySchema.nullable(),
+    note: z.string().nullable(),
+});
+/** A question in argo's inbox, with its answer; null while it is open. */
+export const inboxQuestionSchema = z.object({
+    id: z.uuid(),
+    title: z.string(),
+    context: z.string(),
+    options: z.array(optionSchema),
+    pick: z.object({ option: optionKeySchema, why: z.string() }),
+    answer: inboxAnswerSchema.nullable(),
+});
+/** A payload as JSON; undefined when it is not JSON. */
+function jsonOf(payload) {
+    try {
+        return JSON.parse(payload);
+    }
+    catch {
+        return undefined;
+    }
+}
+/** The question a message asks: a question's payload, or the new question a replacement carries; null for any other message. */
+function questionOf({ contentType, payload }) {
+    if (isQuestionContentType(contentType)) {
+        const question = questionSchema.safeParse(jsonOf(payload));
+        return question.success ? question.data : null;
+    }
+    if (isReplacementContentType(contentType)) {
+        const replacement = replacementSchema.safeParse(jsonOf(payload));
+        return replacement.success ? replacement.data.question : null;
+    }
+    return null;
+}
+/**
+ * The question a message withdraws, and the new question when it replaces it;
+ * null when the message is neither a withdrawal nor a replacement.
+ */
+export function withdrawalOf({ contentType, payload }) {
+    if (isWithdrawalContentType(contentType)) {
+        const withdrawal = withdrawalSchema.safeParse(jsonOf(payload));
+        return withdrawal.success ? { questionId: withdrawal.data.questionId, replacement: null } : null;
+    }
+    if (isReplacementContentType(contentType)) {
+        const replacement = replacementSchema.safeParse(jsonOf(payload));
+        return replacement.success ? { questionId: replacement.data.questionId, replacement: replacement.data.question } : null;
+    }
+    return null;
+}
+/**
+ * The question a message to argo asks (a question, or the new question of a
+ * replacement), and its answer among argo's replies
+ * to it (the first answer naming the question); null when the message asks
+ * no question.
+ */
+export function inboxQuestionOf({ message, replies, }) {
+    const question = questionOf(message);
+    if (question === null) {
+        return null;
+    }
+    for (const reply of replies) {
+        const answer = isAnswerContentType(reply.contentType) ? answerSchema.safeParse(jsonOf(reply.payload)) : undefined;
+        if (answer?.success === true && answer.data.questionId === question.id) {
+            return {
+                ...question,
+                answer: {
+                    messageId: reply.id,
+                    sentAt: reply.sentAt,
+                    option: 'option' in answer.data ? answer.data.option : null,
+                    note: answer.data.note ?? null,
+                },
+            };
+        }
+    }
+    return { ...question, answer: null };
+}
+//# sourceMappingURL=question.js.map

package/dist/schemas/question.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"question.js","sourceRoot":"","sources":["../../src/schemas/question.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAkB,MAAM,iBAAiB,CAAC;AAE3D;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,sCAAsC,CAAC;AAC5E,MAAM,CAAC,MAAM,mBAAmB,GAAG,oCAAoC,CAAC;AACxE,MAAM,CAAC,MAAM,uBAAuB,GAAG,iDAAiD,CAAC;AACzF,MAAM,CAAC,MAAM,wBAAwB,GAAG,kDAAkD,CAAC;AAE3F,0GAA0G;AAC1G,SAAS,SAAS,CAAC,WAAmB;IACpC,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9C,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,WAAmB;IACvD,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,qBAAqB,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,WAAmB;IACrD,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,mBAAmB,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,WAAmB;IACzD,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,uBAAuB,CAAC;AAC5D,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,WAAmB;IAC1D,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,wBAAwB,CAAC;AAC7D,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,CAAC;AAEvB,kCAAkC;AAClC,MAAM,eAAe,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAElD,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAErC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAE/F,qHAAqH;AACrH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;IACZ,KAAK,EAAE,UAAU;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;CAC7D,CAAC;KACD,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM,EAAE;IACvF,OAAO,EAAE,iCAAiC;IAC1C,IAAI,EAAE,CAAC,SAAS,CAAC;CAClB,CAAC;KACD,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE;IAC7E,OAAO,EAAE,mCAAmC;IAC5C,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;CACzB,CAAC,CAAC;AAIL,kEAAkE;AAClE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAEnE,gHAAgH;AAChH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;KAC1D,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,UAAU,EAAE;IAChE,OAAO,EAAE,wCAAwC;IACjD,IAAI,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC;CACzB,CAAC,CAAC;AAEL,iIAAiI;AACjI,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC;IACxC,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;IAClE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;CAC/B,CAAC,CAAC;AAIH,6FAA6F;AAC7F,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC;IACxF,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;CACrD,CAAC,CAAC;AAIH,oGAAoG;AACpG,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC;IAC9B,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IACxB,MAAM,EAAE,eAAe,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH,0EAA0E;AAC1E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;IACZ,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IAC5D,MAAM,EAAE,iBAAiB,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC;AASH,wDAAwD;AACxD,SAAS,MAAM,CAAC,OAAe;IAC7B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,gIAAgI;AAChI,SAAS,UAAU,CAAC,EAAE,WAAW,EAAE,OAAO,EAAW;IACnD,IAAI,qBAAqB,CAAC,WAAW,CAAC,EAAE,CAAC;QACvC,MAAM,QAAQ,GAAG,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAC3D,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IACjD,CAAC;IACD,IAAI,wBAAwB,CAAC,WAAW,CAAC,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACjE,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IAChE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,EAAE,WAAW,EAAE,OAAO,EAAW;IAC5D,IAAI,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;QACzC,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/D,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACnG,CAAC;IACD,IAAI,wBAAwB,CAAC,WAAW,CAAC,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACjE,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1H,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAI,EACjC,OAAO,EACP,OAAO,GAIR;IACC,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACrC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,mBAAmB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClH,IAAI,MAAM,EAAE,OAAO,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,QAAQ,CAAC,EAAE,EAAE,CAAC;YACvE,OAAO;gBACL,GAAG,QAAQ;gBACX,MAAM,EAAE;oBACN,SAAS,EAAE,KAAK,CAAC,EAAE;oBACnB,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,MAAM,EAAE,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;oBAC3D,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI;iBAC/B;aACF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AACvC,CAAC"}

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@aeolus-fleet/common",
-  "version": "0.22.0",
-  "description": "Aeolus shared schemas, prefixed ids and types.",
+  "version": "0.24.0",
+  "description": "Shared schemas and ids for Aeolus packages.",
+  "keywords": [
+    "aeolus"
+  ],
   "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,