@printobserver/sdk 0.2.0 → 0.4.0

package/dist/contract.js

@@ -7,22 +7,24 @@
  *  generate-clients`, and commit what that writes.
  */
 import { GeneratedSurface, reasonGiven } from "./surface.js";
-/**
- * The version of the server contract these types were generated from, which
- * is the version the type crate declares in the tree they came from.
- */
-export const CONTRACT_VERSION = "0.2.0";
+export const CONTRACT_VERSION = "0.4.0";
 /**
  * Every operation this client exposes a method for, which is every operation
  * the server declares and no other.
  */
 export const OPERATION_NAMES = [
+    "prints",
     "status",
     "context",
     "image",
     "history",
     "manifest_get",
+    "look",
     "manifest_set",
+    "spools",
+    "spool",
+    "printer_history",
+    "preflight",
     "pause",
     "resume",
     "cancel",
@@ -33,7 +35,58 @@ export const OPERATION_NAMES = [
     "set_bed_target_c",
     "set_fan_percent",
     "acknowledge_failure",
+    "register_spool",
+    "load_spool",
+    "unload_spool",
+    "adjust_spool",
+    "retire_spool",
+];
+/** Every kind the server declares a payload type for, in name order. */
+export const EVENT_KINDS = [
+    "action_executed",
+    "action_rejected",
+    "action_requested",
+    "agent_assessment",
+    "camera_look",
+    "charge_pended",
+    "filament_change_signalled",
+    "filament_consumed",
+    "file_tally_rebaselined",
+    "intervention_expired",
+    "malformed_external_event",
+    "obico_failure_alert",
+    "obico_printer_notification",
+    "operator_acknowledgement",
+    "periodic_observation",
+    "port_failure",
+    "preflight_checked",
+    "print_ended",
+    "print_started",
+    "print_untracked",
+    "spool_adjusted",
+    "spool_command_rejected",
+    "spool_loaded",
+    "spool_registered",
+    "spool_retired",
+    "spool_unloaded",
+    "spool_unverified",
+    "startup_reconciliation",
+    "supervision_session_closed",
+    "supervision_session_opened",
+    "unaccounted_print",
 ];
+/**
+ * The payload of one event as the type its kind declares, or `undefined` for
+ * an event of any other kind — one this client knows or one it does not. No
+ * validation beyond the kind's name: the payload is the document the server
+ * sent, handed on as the type the table says it is.
+ */
+export function payloadOf(event, kind) {
+    if (event.kind !== kind) {
+        return undefined;
+    }
+    return event.payload;
+}
 /**
  * One method per operation the server declares.
  *
@@ -42,6 +95,21 @@ export const OPERATION_NAMES = [
  * vocabulary are hand-written, and this class is written against them.
  */
 export class GeneratedClient extends GeneratedSurface {
+    /**
+     * Call `prints` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no.
+     */
+    // llmlint: ignore[names_match_behavior] See suppressions.toml.
+    async prints() {
+        const target = `/v1/prints`;
+        const asked = [];
+        const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("GET", target, asked, sending);
+    }
     /**
      * Call `status` on the configured supervisor.
      *
@@ -53,6 +121,7 @@ export class GeneratedClient extends GeneratedSurface {
         const target = `/v1/prints/${printId}/status`;
         const asked = [];
         const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("GET", target, asked, sending);
     }
     /**
@@ -66,6 +135,7 @@ export class GeneratedClient extends GeneratedSurface {
         const target = `/v1/prints/${printId}/context`;
         const asked = [];
         const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("GET", target, asked, sending);
     }
     /**
@@ -79,6 +149,7 @@ export class GeneratedClient extends GeneratedSurface {
         const target = `/v1/images/${imageId}`;
         const asked = [];
         const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("GET", target, asked, sending);
     }
     /**
@@ -95,6 +166,7 @@ export class GeneratedClient extends GeneratedSurface {
             asked.push(["limit", String(limit)]);
         }
         const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("GET", target, asked, sending);
     }
     /**
@@ -108,6 +180,24 @@ export class GeneratedClient extends GeneratedSurface {
         const target = `/v1/prints/${printId}/manifest`;
         const asked = [];
         const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("GET", target, asked, sending);
+    }
+    /**
+     * Call `look` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no.
+     */
+    async look(printId, waitS) {
+        const target = `/v1/prints/${printId}/look`;
+        const asked = [];
+        if (waitS !== undefined) {
+            asked.push(["wait_s", String(waitS)]);
+        }
+        const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("GET", target, asked, sending);
     }
     /**
@@ -126,8 +216,91 @@ export class GeneratedClient extends GeneratedSurface {
         const sending = {};
         sending.reason = reason;
         sending.manifest = manifest;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("PUT", target, asked, sending);
     }
+    /**
+     * Call `spools` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no.
+     */
+    async spools(includeRetired) {
+        const target = `/v1/spools`;
+        const asked = [];
+        if (includeRetired !== undefined) {
+            asked.push(["include_retired", String(includeRetired)]);
+        }
+        const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("GET", target, asked, sending);
+    }
+    /**
+     * Call `spool` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no.
+     */
+    async spool(spoolId) {
+        const target = `/v1/spools/${spoolId}`;
+        const asked = [];
+        const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("GET", target, asked, sending);
+    }
+    /**
+     * Call `printer_history` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no.
+     */
+    async printerHistory(kinds, since, until, spoolId, before, limit) {
+        const target = `/v1/history`;
+        const asked = [];
+        if (kinds !== undefined) {
+            for (const value of kinds) {
+                asked.push(["kinds", String(value)]);
+            }
+        }
+        if (since !== undefined) {
+            asked.push(["since", String(since)]);
+        }
+        if (until !== undefined) {
+            asked.push(["until", String(until)]);
+        }
+        if (spoolId !== undefined) {
+            asked.push(["spool_id", String(spoolId)]);
+        }
+        if (before !== undefined) {
+            asked.push(["before", String(before)]);
+        }
+        if (limit !== undefined) {
+            asked.push(["limit", String(limit)]);
+        }
+        const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("GET", target, asked, sending);
+    }
+    /**
+     * Call `preflight` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no.
+     */
+    async preflight(fileName) {
+        const target = `/v1/preflight`;
+        const asked = [];
+        if (fileName !== undefined) {
+            asked.push(["file_name", String(fileName)]);
+        }
+        const sending = undefined;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("GET", target, asked, sending);
+    }
     /**
      * Call `pause` on the configured supervisor.
      *
@@ -144,6 +317,7 @@ export class GeneratedClient extends GeneratedSurface {
         const sending = {};
         sending.actor = this.actor;
         sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -162,6 +336,7 @@ export class GeneratedClient extends GeneratedSurface {
         const sending = {};
         sending.actor = this.actor;
         sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -180,6 +355,7 @@ export class GeneratedClient extends GeneratedSurface {
         const sending = {};
         sending.actor = this.actor;
         sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -191,7 +367,7 @@ export class GeneratedClient extends GeneratedSurface {
      * is made, and the policy's own refusal arrives as `Rejected`, carrying
      * the reason, the value asked for and the range allowed.
      */
-    async startPrint(printId, fileName, manifest, reason) {
+    async startPrint(printId, fileName, manifest, reason, overrideFilamentCheck) {
         reasonGiven(reason);
         const target = `/v1/prints/${printId}/actions/start_print`;
         const asked = [];
@@ -199,7 +375,11 @@ export class GeneratedClient extends GeneratedSurface {
         sending.actor = this.actor;
         sending.file_name = fileName;
         sending.manifest = manifest;
+        if (overrideFilamentCheck !== undefined) {
+            sending.override_filament_check = overrideFilamentCheck;
+        }
         sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -222,6 +402,7 @@ export class GeneratedClient extends GeneratedSurface {
         }
         sending.factor = factor;
         sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -244,6 +425,7 @@ export class GeneratedClient extends GeneratedSurface {
         }
         sending.factor = factor;
         sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -267,6 +449,7 @@ export class GeneratedClient extends GeneratedSurface {
         sending.reason = reason;
         sending.target_c = targetC;
         sending.tool = tool;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -289,6 +472,7 @@ export class GeneratedClient extends GeneratedSurface {
         }
         sending.reason = reason;
         sending.target_c = targetC;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -311,6 +495,7 @@ export class GeneratedClient extends GeneratedSurface {
         }
         sending.percent = percent;
         sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
     /**
@@ -331,6 +516,127 @@ export class GeneratedClient extends GeneratedSurface {
         sending.disposition = disposition;
         sending.event_id = eventId;
         sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("POST", target, asked, sending);
+    }
+    /**
+     * Call `register_spool` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no. A call whose reason is empty is refused here, before a request
+     * is made, and the policy's own refusal arrives as `Rejected`, carrying
+     * the reason, the value asked for and the range allowed.
+     */
+    async registerSpool(initialG, material, name, reason, color, densityGCm3, diameterMm, remainingG, tareG) {
+        reasonGiven(reason);
+        const target = `/v1/spools/actions/register_spool`;
+        const asked = [];
+        const sending = {};
+        sending.actor = this.actor;
+        if (color !== undefined) {
+            sending.color = color;
+        }
+        if (densityGCm3 !== undefined) {
+            sending.density_g_cm3 = densityGCm3;
+        }
+        if (diameterMm !== undefined) {
+            sending.diameter_mm = diameterMm;
+        }
+        sending.initial_g = initialG;
+        sending.material = material;
+        sending.name = name;
+        sending.reason = reason;
+        if (remainingG !== undefined) {
+            sending.remaining_g = remainingG;
+        }
+        if (tareG !== undefined) {
+            sending.tare_g = tareG;
+        }
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("POST", target, asked, sending);
+    }
+    /**
+     * Call `load_spool` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no. A call whose reason is empty is refused here, before a request
+     * is made, and the policy's own refusal arrives as `Rejected`, carrying
+     * the reason, the value asked for and the range allowed.
+     */
+    async loadSpool(spoolId, reason, tool) {
+        reasonGiven(reason);
+        const target = `/v1/spools/${spoolId}/actions/load_spool`;
+        const asked = [];
+        const sending = {};
+        sending.actor = this.actor;
+        sending.reason = reason;
+        sending.tool = tool;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("POST", target, asked, sending);
+    }
+    /**
+     * Call `unload_spool` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no. A call whose reason is empty is refused here, before a request
+     * is made, and the policy's own refusal arrives as `Rejected`, carrying
+     * the reason, the value asked for and the range allowed.
+     */
+    async unloadSpool(spoolId, reason) {
+        reasonGiven(reason);
+        const target = `/v1/spools/${spoolId}/actions/unload_spool`;
+        const asked = [];
+        const sending = {};
+        sending.actor = this.actor;
+        sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("POST", target, asked, sending);
+    }
+    /**
+     * Call `adjust_spool` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no. A call whose reason is empty is refused here, before a request
+     * is made, and the policy's own refusal arrives as `Rejected`, carrying
+     * the reason, the value asked for and the range allowed.
+     */
+    async adjustSpool(spoolId, reason, grossG, remainingG) {
+        reasonGiven(reason);
+        const target = `/v1/spools/${spoolId}/actions/adjust_spool`;
+        const asked = [];
+        const sending = {};
+        sending.actor = this.actor;
+        if (grossG !== undefined) {
+            sending.gross_g = grossG;
+        }
+        sending.reason = reason;
+        if (remainingG !== undefined) {
+            sending.remaining_g = remainingG;
+        }
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
+        return await this.call("POST", target, asked, sending);
+    }
+    /**
+     * Call `retire_spool` on the configured supervisor.
+     *
+     * Rejects with `Unreachable` when nothing answered, with `Unreadable` when
+     * the answer could not be read, and with `Refused` when the supervisor
+     * said no. A call whose reason is empty is refused here, before a request
+     * is made, and the policy's own refusal arrives as `Rejected`, carrying
+     * the reason, the value asked for and the range allowed.
+     */
+    async retireSpool(spoolId, reason) {
+        reasonGiven(reason);
+        const target = `/v1/spools/${spoolId}/actions/retire_spool`;
+        const asked = [];
+        const sending = {};
+        sending.actor = this.actor;
+        sending.reason = reason;
+        // llmlint: ignore[boundary_inputs_validated] See suppressions.toml.
         return await this.call("POST", target, asked, sending);
     }
 }

package/dist/surface.d.ts

@@ -10,7 +10,7 @@
  * are that module's, imported as types alone, so that the two files can name
  * each other's shapes without either being unloadable.
  */
-import type { ActionAnswer, Actor, Range, RejectionReason } from "./contract.ts";
+import type { ActionAnswer, Actor, Range, RejectionReason, SpoolCommandAnswer } from "./contract.ts";
 /** Why a call did not answer what it asked for. */
 export declare class ClientError extends Error {
     constructor(said: string);
@@ -72,9 +72,13 @@ export declare class Rejected extends ClientError {
     readonly requested: number | undefined;
     /** The range that is allowed, where the policy ruled on a value. */
     readonly allowed: Range | undefined;
-    /** The whole answer, whose record carries the request and the decision. */
-    readonly answer: ActionAnswer;
-    constructor(reason: RejectionReason, requested: number | undefined, allowed: Range | undefined, answer: ActionAnswer);
+    /**
+     * The whole answer: an action's, whose record carries the request and the
+     * decision, or a spool command's, carrying the decision and the events its
+     * refusal wrote.
+     */
+    readonly answer: ActionAnswer | SpoolCommandAnswer;
+    constructor(reason: RejectionReason, requested: number | undefined, allowed: Range | undefined, answer: ActionAnswer | SpoolCommandAnswer);
 }
 /**
  * Refuse a mutating call that carries no reason, before it is made.

package/dist/surface.js

@@ -99,7 +99,11 @@ export class Rejected extends ClientError {
     requested;
     /** The range that is allowed, where the policy ruled on a value. */
     allowed;
-    /** The whole answer, whose record carries the request and the decision. */
+    /**
+     * The whole answer: an action's, whose record carries the request and the
+     * decision, or a spool command's, carrying the decision and the events its
+     * refusal wrote.
+     */
     answer;
     constructor(reason, requested, allowed, answer) {
         super(`the supervisor's policy refused this action: ${JSON.stringify(reason)}` +

package/package.json

@@ -12,12 +12,12 @@
   "license": "MIT",
   "main": "dist/index.js",
   "name": "@printobserver/sdk",
-  "printobserverContractVersion": "0.2.0",
+  "printobserverContractVersion": "0.4.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/nickderobertis/printobserver"
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "0.2.0"
+  "version": "0.4.0"
 }