@butlerbot/sdk 0.0.39 → 0.0.40

package/dist/index.d.ts

@@ -54,7 +54,7 @@ export declare class ButlerBotClient {
     cancelJob(config: OptionalApiKey<CancelJobOptions>): Promise<import("./types/type_registry").JobCancelResponse>;
     /** Continues a job parked waiting for budget. Throws a `ButlerBotAPIError` with `isConflict` when it is in any other status */
     resumeJob(config: OptionalApiKey<ResumeJobOptions>): Promise<import("./types/type_registry").JobResumeResponse>;
-    /** Changes one job's name, and its autonomy: how far it may act, until when, and what it always asks about */
+    /** Changes one job's name, the model it runs on, its spending cap and its autonomy: how far it may act, until when, and what it always asks about */
     updateJob(config: OptionalApiKey<UpdateJobOptions>): Promise<import("./types/type_registry").JobUpdateResponse>;
     /** Changes the model one phase of a job's plan runs on; only a phase that has not started */
     setPhaseModel(config: OptionalApiKey<SetPhaseModelOptions>): Promise<import("./types/type_registry").JobPhaseModelResponse>;

package/dist/index.js

@@ -92,7 +92,7 @@ class ButlerBotClient {
     resumeJob(config) {
         return (0, jobs_1.resumeJob)(this.forRequest(config));
     }
-    /** Changes one job's name, and its autonomy: how far it may act, until when, and what it always asks about */
+    /** Changes one job's name, the model it runs on, its spending cap and its autonomy: how far it may act, until when, and what it always asks about */
     updateJob(config) {
         return (0, jobs_1.updateJob)(this.forRequest(config));
     }

package/dist/modules/jobs.d.ts

@@ -43,6 +43,13 @@ export type UpdateJobOptions = JobsRequestOptions & {
     alwaysAsk?: string[];
     /** A ceiling on what the job may spend in all, in dollars. Null clears it. */
     capUsd?: number | null;
+    /**
+     * The model or alias the whole job runs on, and the plan's default.
+     *
+     * A name sets it; null clears it, leaving the planner to pick a model per phase. One
+     * phase's model on its own is `setPhaseModel`.
+     */
+    model?: string | null;
 };
 export type SetPhaseModelOptions = JobsRequestOptions & {
     jobId: string;
@@ -74,7 +81,7 @@ export declare function cancelJob(options: CancelJobOptions): Promise<JobCancelR
  * is true and whose `body` still carries the job as it stands.
  */
 export declare function resumeJob(options: ResumeJobOptions): Promise<JobResumeResponse>;
-/** Changes one job's name, and its autonomy: how far it may act, until when, and what it always asks about. */
+/** Changes one job's name, the model it runs on, its spending cap and its autonomy: how far it may act, until when, and what it always asks about. */
 export declare function updateJob(options: UpdateJobOptions): Promise<JobUpdateResponse>;
 /**
  * Changes the model one phase of a job's plan runs on.

package/dist/modules/jobs.js

@@ -64,13 +64,13 @@ async function resumeJob(options) {
     const url = (0, url_formatter_1.formatURL)(`${jobsBase(options)}/${encodeURIComponent(options.jobId)}/resume`, {}, { apiKey: options.apiKey, debug: options.debug });
     return (0, api_request_1.requestAPI)({ url, method: "POST", action: `resume job ${options.jobId}` });
 }
-/** Changes one job's name, and its autonomy: how far it may act, until when, and what it always asks about. */
+/** Changes one job's name, the model it runs on, its spending cap and its autonomy: how far it may act, until when, and what it always asks about. */
 async function updateJob(options) {
     const url = (0, url_formatter_1.formatURL)(`${jobsBase(options)}/${encodeURIComponent(options.jobId)}`, {}, { apiKey: options.apiKey, debug: options.debug });
     return (0, api_request_1.requestAPI)({
         url,
         method: "PATCH",
-        body: body({ title: options.title, autonomy: options.autonomy, autonomyUntil: options.autonomyUntil, alwaysAsk: options.alwaysAsk, capUsd: options.capUsd }),
+        body: body({ title: options.title, autonomy: options.autonomy, autonomyUntil: options.autonomyUntil, alwaysAsk: options.alwaysAsk, capUsd: options.capUsd, model: options.model }),
         action: `update job ${options.jobId}`,
     });
 }

package/dist/types/jobs/job.d.ts

@@ -52,6 +52,13 @@ export type JobView = {
     journalCardUri: string | null;
     /** The chat the job was asked for in, and where it reports back. */
     originConversationId: string | null;
+    /**
+     * The model or alias the user asked the whole job to run on, and the plan's default.
+     *
+     * Null when nobody chose one, in which case the planner picks a model per phase. A phase's
+     * own `model` is what that phase actually runs on either way.
+     */
+    model: string | null;
     /** What was chosen for this job, or null when nothing was. */
     autonomy: JobAutonomy | null;
     /** When `autonomy` lapses back to asking, in UTC milliseconds. */

package/dist/types/outreach/delivery.d.ts

@@ -31,6 +31,14 @@ export type DeliverySurface = {
 export declare const DELIVERY_ANSWER_VIA: readonly ["web", "discord", "chat", "tool"];
 /** Which surface the answer came back on. */
 export type DeliveryAnsweredVia = typeof DELIVERY_ANSWER_VIA[number];
+export declare const DELIVERY_CLOSED_REASONS: readonly ["job_done", "job_failed", "job_cancelled"];
+/** Why a delivery was closed with nobody having answered it: what became of the job that asked. */
+export type DeliveryClosedReason = typeof DELIVERY_CLOSED_REASONS[number];
+/** A delivery closed unanswered, and when. */
+export type DeliveryClosed = {
+    at: number;
+    reason: DeliveryClosedReason;
+};
 export type DeliveryAnswer = {
     at: number;
     text: string;
@@ -54,9 +62,16 @@ export type Delivery = {
     surfaces: DeliverySurface[];
     /** Null until somebody answers. Only ever set once. */
     answered: DeliveryAnswer | null;
+    /**
+     * Set when the job this belonged to ended before anyone answered, and null otherwise.
+     *
+     * A closed delivery is no longer open, and answering it is refused: the server answers a
+     * 409 the same way it does one already answered.
+     */
+    closed: DeliveryClosed | null;
     created: number;
 };
-/** Whether a delivery is still waiting on the user. */
+/** Whether a delivery is still waiting on the user: unanswered, and not closed under it. */
 export declare function isDeliveryOpen(delivery: Delivery): boolean;
 export type DeliveryListResponse = {
     success: true;

package/dist/types/outreach/delivery.js

@@ -7,7 +7,7 @@
  * on that job's inbox.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DELIVERY_ANSWER_VIA = exports.DELIVERY_SURFACE_STATUSES = exports.DELIVERY_SURFACES = exports.ANSWERABLE_DELIVERY_INTENTS = exports.DELIVERY_INTENTS = void 0;
+exports.DELIVERY_CLOSED_REASONS = exports.DELIVERY_ANSWER_VIA = exports.DELIVERY_SURFACE_STATUSES = exports.DELIVERY_SURFACES = exports.ANSWERABLE_DELIVERY_INTENTS = exports.DELIVERY_INTENTS = void 0;
 exports.isDeliveryOpen = isDeliveryOpen;
 exports.DELIVERY_INTENTS = ["question", "update", "approval", "statement"];
 /** The intents that leave something outstanding until the user answers. */
@@ -15,7 +15,8 @@ exports.ANSWERABLE_DELIVERY_INTENTS = ["question", "approval"];
 exports.DELIVERY_SURFACES = ["web", "discord"];
 exports.DELIVERY_SURFACE_STATUSES = ["pending", "sent", "failed"];
 exports.DELIVERY_ANSWER_VIA = ["web", "discord", "chat", "tool"];
-/** Whether a delivery is still waiting on the user. */
+exports.DELIVERY_CLOSED_REASONS = ["job_done", "job_failed", "job_cancelled"];
+/** Whether a delivery is still waiting on the user: unanswered, and not closed under it. */
 function isDeliveryOpen(delivery) {
-    return exports.ANSWERABLE_DELIVERY_INTENTS.includes(delivery.intent) && !delivery.answered;
+    return exports.ANSWERABLE_DELIVERY_INTENTS.includes(delivery.intent) && !delivery.answered && !delivery.closed;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@butlerbot/sdk",
-	"version": "0.0.39",
+	"version": "0.0.40",
 	"description": "The official ButlerBot SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/readme.md

@@ -342,8 +342,11 @@ const { resumed, reason, action, message } = await client.resumeJob({ jobId });
 newest page first, with each page in the order its entries were written and `hasMore` saying whether
 an older page exists. Each entry says which shift wrote it (`shiftIndex`, `shiftKind`) and on which
 model. A job's `title` is a few words of its own, set at start or renamed with `updateJob`, which
-also takes `capUsd`, a ceiling on what the job may spend in all (null clears it). `setPhaseModel`
-changes the model a phase that has not started runs on, to one of the detail's `phaseModels`.
+also takes `capUsd`, a ceiling on what the job may spend in all (null clears it), and `model`, the
+model or alias the whole job runs on and the plan's default — a name sets it, null clears it and
+leaves the planner to pick per phase, and a job's own `model` reads back the same way.
+`setPhaseModel` changes the model one phase that has not started runs on, to one of the detail's
+`phaseModels`.
 `resumeJob` continues a job parked as `waiting_budget` when there is room for it again: it answers
 with `resumed`, a `reason` of `resumed`, `over_tier_limit`, `allowance_spent` or `refused`, an
 `action` of `raise_allowance`, `upgrade_tier` or `wait` when there is one, a `wakeAt` when the job
@@ -378,6 +381,10 @@ Answering closes the delivery, and when it belongs to a job the answer is put on
 inbox, which wakes a job that was parked waiting for it — `job.delivered` says what became of
 it. An approval takes `decision: "approve" | "deny"` alongside the text.
 
+A delivery whose job ended before anyone answered is closed instead: `closed` carries the time
+and a reason of `job_done`, `job_failed` or `job_cancelled`. `isDeliveryOpen` reads false for
+one, and answering it is refused with a 409 just as one already answered is.
+
 ### When a call fails
 
 Every jobs and outreach call throws `ButlerBotAPIError` when the server does not answer with a