@aeolus-fleet/common 0.25.0 → 0.25.2

package/dist/schemas/crew-request.d.ts

@@ -1,8 +1,8 @@
 import { z } from 'zod';
 /**
  * Inputs and outputs of the crew request procedures (decision 0029): a
- * standing request that a ship be kept crewed, with settings the server
- * stores without meaning. A requester with fleet:manage sets and removes it.
+ * standing request that a ship be kept crewed, with crew settings the
+ * server checks but never acts on. A requester with fleet:manage sets and removes it.
  */
 /**
  * The most a crew request's settings may hold: 16 KB as the UTF-8 bytes of
@@ -13,8 +13,8 @@ export declare const CREW_REQUEST_SETTINGS_MAX_BYTES: number;
 export declare function crewRequestSettingsBytes(settings: CrewRequestSettings): number;
 /**
  * A crew request's settings: one JSON object (harness, workspace, options, an
- * optional first prompt, an optional squadron). Their shape is the trierarch
- * plugin's to check, not the server's.
+ * optional first prompt, an optional squadron). The server reads their shape
+ * as crew settings (`readCrewSettings`) once their size fits.
  */
 export declare const crewRequestSettingsSchema: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
 export type CrewRequestSettings = z.infer<typeof crewRequestSettingsSchema>;

package/dist/schemas/crew-request.js

@@ -2,8 +2,8 @@ import { z } from 'zod';
 import { idSchema } from '../ids/index.js';
 /**
  * Inputs and outputs of the crew request procedures (decision 0029): a
- * standing request that a ship be kept crewed, with settings the server
- * stores without meaning. A requester with fleet:manage sets and removes it.
+ * standing request that a ship be kept crewed, with crew settings the
+ * server checks but never acts on. A requester with fleet:manage sets and removes it.
  */
 /**
  * The most a crew request's settings may hold: 16 KB as the UTF-8 bytes of
@@ -17,8 +17,8 @@ export function crewRequestSettingsBytes(settings) {
 }
 /**
  * A crew request's settings: one JSON object (harness, workspace, options, an
- * optional first prompt, an optional squadron). Their shape is the trierarch
- * plugin's to check, not the server's.
+ * optional first prompt, an optional squadron). The server reads their shape
+ * as crew settings (`readCrewSettings`) once their size fits.
  */
 export const crewRequestSettingsSchema = z.record(z.string(), z.json());
 /**

package/dist/trierarch/crew-settings.d.ts

@@ -15,7 +15,7 @@ export type TrierarchWorkspace = z.infer<typeof trierarchWorkspaceSchema>;
  * A crew request's settings as a trierarch reads them (decision 0027): the
  * fixed core of an optional harness, workspace, an optional squadron, an
  * optional first prompt and options. Without a harness, the trierarch it
- * goes to crews it with its default: the first in its configuration. The server stores them without meaning; the trierarch
+ * goes to crews it with its default: the first in its configuration. The server refuses a request whose settings this schema refuses (#809) but never acts on them; the trierarch
  * plugin and the trierarch parse them with this schema. Never a path or a
  * command-line flag: a workspace names a repository or folder, options pick
  * named settings, and a first prompt never starts with `-`.
@@ -41,3 +41,21 @@ export declare const crewSettingsSchema: z.ZodObject<{
  */
 export declare const NO_MACHINE_MATCHES_REASON = "no machine matches its labels";
 export type CrewSettings = z.infer<typeof crewSettingsSchema>;
+/** Why settings are not crew settings: the settings field at fault, or `settings` when the issue has no field, and the reason as one line. */
+export interface CrewSettingsRefusal {
+    field: string;
+    reason: string;
+}
+/**
+ * Settings read as crew settings, or why they are not: the first issue, as
+ * one line with its path. The one reading for the fleet, which refuses a
+ * request whose settings are not crew settings, and the trierarch plugin,
+ * which places them (#809).
+ */
+export declare function readCrewSettings(settings: unknown): {
+    settings: CrewSettings;
+} | {
+    refusal: CrewSettingsRefusal;
+};
+/** Why settings are not crew settings, or undefined when they are. */
+export declare function crewSettingsRefusal(settings: unknown): CrewSettingsRefusal | undefined;

package/dist/trierarch/crew-settings.js

@@ -16,7 +16,7 @@ export const trierarchWorkspaceSchema = z.discriminatedUnion('kind', [
  * A crew request's settings as a trierarch reads them (decision 0027): the
  * fixed core of an optional harness, workspace, an optional squadron, an
  * optional first prompt and options. Without a harness, the trierarch it
- * goes to crews it with its default: the first in its configuration. The server stores them without meaning; the trierarch
+ * goes to crews it with its default: the first in its configuration. The server refuses a request whose settings this schema refuses (#809) but never acts on them; the trierarch
  * plugin and the trierarch parse them with this schema. Never a path or a
  * command-line flag: a workspace names a repository or folder, options pick
  * named settings, and a first prompt never starts with `-`.
@@ -47,4 +47,28 @@ export const crewSettingsSchema = z.strictObject({
  * every machine label of; it waits, and the console words it in full.
  */
 export const NO_MACHINE_MATCHES_REASON = 'no machine matches its labels';
+/**
+ * Settings read as crew settings, or why they are not: the first issue, as
+ * one line with its path. The one reading for the fleet, which refuses a
+ * request whose settings are not crew settings, and the trierarch plugin,
+ * which places them (#809).
+ */
+export function readCrewSettings(settings) {
+    const result = crewSettingsSchema.safeParse(settings);
+    if (result.success) {
+        return { settings: result.data };
+    }
+    const [issue] = result.error.issues;
+    if (issue === undefined) {
+        return { refusal: { field: 'settings', reason: 'settings are not valid crew settings: unreadable' } };
+    }
+    const path = issue.path.map(String);
+    const line = path.length === 0 ? issue.message : `${path.join('.')}: ${issue.message}`;
+    return { refusal: { field: path[0] ?? 'settings', reason: `settings are not valid crew settings: ${line}` } };
+}
+/** Why settings are not crew settings, or undefined when they are. */
+export function crewSettingsRefusal(settings) {
+    const read = readCrewSettings(settings);
+    return 'refusal' in read ? read.refusal : undefined;
+}
 //# sourceMappingURL=crew-settings.js.map

package/dist/trierarch/crew-settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"crew-settings.js","sourceRoot":"","sources":["../../src/trierarch/crew-settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;AAE/B,qFAAqF;AACrF,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAE3C,gHAAgH;AAChH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACnE,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;IACnH,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;CACzE,CAAC,CAAC;AAGH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,OAAO,EAAE,aAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,wBAAwB;IACnC,+GAA+G;IAC/G,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,IAAI,sBAAsB,EAAE,6BAA6B,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC;QAClJ,mFAAmF;SAClF,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,4DAA4D,CAAC;SACzG,QAAQ,EAAE;IACb,6FAA6F;IAC7F,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACvC;;;;OAIG;IACH,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;CAC/E,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,+BAA+B,CAAC"}
+{"version":3,"file":"crew-settings.js","sourceRoot":"","sources":["../../src/trierarch/crew-settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;AAE/B,qFAAqF;AACrF,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAE3C,gHAAgH;AAChH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACnE,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;IACnH,CAAC,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;CACzE,CAAC,CAAC;AAGH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,OAAO,EAAE,aAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,wBAAwB;IACnC,+GAA+G;IAC/G,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,IAAI,sBAAsB,EAAE,6BAA6B,MAAM,CAAC,sBAAsB,CAAC,QAAQ,CAAC;QAClJ,mFAAmF;SAClF,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,4DAA4D,CAAC;SACzG,QAAQ,EAAE;IACb,6FAA6F;IAC7F,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACvC;;;;OAIG;IACH,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;CAC/E,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,+BAA+B,CAAC;AAUzE;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAiB;IAChD,MAAM,MAAM,GAAG,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;IACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,kDAAkD,EAAE,EAAE,CAAC;IACxG,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;IACvF,OAAO,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,UAAU,EAAE,MAAM,EAAE,yCAAyC,IAAI,EAAE,EAAE,EAAE,CAAC;AAChH,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,mBAAmB,CAAC,QAAiB;IACnD,MAAM,IAAI,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,OAAO,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AACtD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeolus-fleet/common",
-  "version": "0.25.0",
+  "version": "0.25.2",
   "description": "Shared schemas and ids for Aeolus packages.",
   "keywords": [
     "aeolus"