@womp/openai-plugin 0.8.1 → 0.9.0

package/README.md

@@ -67,11 +67,11 @@ sign-in.
 | `runScript(subject, { designId, code, purpose })` | runs one script on the design; `purpose` becomes the current build's activity, its last screenshot or a fresh render its picture; a failed script returns `ok: false` |
 | `renderScene(subject, { designId, view?, targetId? })` | renders the design; the image also becomes the current build's picture |
 | `getMaterials(subject)` | the materials on offer to the caller, before any design exists: each with its label, whether it prints in one colour (`colorRequired`) and its finishes, the first the default; and the largest size checkout takes |
-| `analyzePrint(subject, { designId, longestSideCm? })` | the design as its scene is now, analysed as it prints at its own size, or scaled so its longest side is `longestSideCm`, changing nothing, leaving out Areas named `REFERENCE` (bought parts modelled only to show a fit): size, whether it fits the largest size, separate pieces, and the price per piece in each material on offer |
+| `analyzePrint(subject, { designId, longestSideCm?, parts? })` | the design as its scene is now, analysed as it prints at its own size, or scaled so its longest side is `longestSideCm`, changing nothing, leaving out Areas named `REFERENCE` (bought parts modelled only to show a fit); with `parts` (node ids of Areas that print), only those Areas, at the scale of the whole design: size, whether it fits the largest size, separate pieces, and the price per piece in each material on offer |
 | `finishScene(subject, { designId, title })` | marks the current build done, with this version's title; called only for a design that passed the print checks |
 | `claimLink?(subject)` | optional: a one-time link to a page that keeps the chat's designs in an account; without it the design card offers no button |
 | `getBuild(subject, { designId, buildId })` | a build's status, activity, title and picture; a build that isn't the caller's reads as empty |
-| `checkoutDesign(subject, { designId, material, color?, finish?, quantity?, longestSideCm?, shipTo? })` | freezes the design as quoted, at its own size or scaled to `longestSideCm`, and without its `REFERENCE` Areas, and returns the quote with its checkout link; with `shipTo`, also the order to that address as a payment-sheet session; called only for a design that passed the print checks |
+| `checkoutDesign(subject, { designId, items, longestSideCm?, shipTo? })` | freezes the design as quoted, at its own size or scaled to `longestSideCm`, and without its `REFERENCE` Areas, and returns the quote with one checkout link for all its `items`, each `{ parts?, material, color?, finish?, quantity? }`: the Areas `parts` names, or the whole design, priced on its own; with `shipTo`, also the order to that address as a payment-sheet session; called only when every item passed the print checks |
 | `completeCheckout?(subject, payment)` | optional: charges a payment made in ChatGPT's payment sheet and places the session's order; without it `checkout_design` takes no `shipTo` and there is no `complete_checkout` |
 | `getOrderStatus(subject, { orderId? })` | the caller's paid orders, newest first, and the one to show, with no name, address, email or money |
 
@@ -82,7 +82,7 @@ changes an earlier one.
 
 - **Identity.** Every tool acts as `subject`, the signed-in Womp account. Tool arguments and client `_meta` are never read for identity. Without a subject every tool call fails; with `wwwAuthenticate`, the failure carries that challenge in `_meta["mcp/www_authenticate"]`, so ChatGPT offers to link the account.
 - **Brief and review.** `open_scene` requires a brief (a full one for a new design, an edit brief to reopen one) and `finish_scene` the critic's review. Both stay in the chat: the backend never receives them.
-- **Print checks.** `finish_scene` and `checkout_design` take the material, finish, colour and pieces, analyse the design as it is now (`analyzePrint`) and check it (`printability.ts`): the material and finish are on offer, a material that prints in one colour has it as `#rrggbb`, the size fits, and it prints as the pieces given (1 by default). Only a design that passes is finished (`finishScene`) or quoted (`checkoutDesign`).
+- **Print checks.** `finish_scene` and `checkout_design` take the material, finish, colour and pieces, analyse the design as it is now (`analyzePrint`) and check it (`printability.ts`): the material and finish are on offer, a material that prints in one colour has it as `#rrggbb`, the size fits, and it prints as the pieces given (1 by default). `checkout_design` takes them for each of its items and checks each item on its own: the parts it names, or the whole design. Only a design that passes is finished (`finishScene`), and only when every item passes is it quoted (`checkoutDesign`).
 - **Prompts** are five parts, each a template literal in its own tag, after one line on the workflow.
   - `<brief>` (`brief.ts`): what to build: research, size, parts, proportions, silhouette, the material and the pieces.
   - `<experience>` (`experience.ts`): the user, the conversation, the card, the product shot, the order of the tools, the print checks as they reach the user.

package/dist/index.d.ts

@@ -110,19 +110,25 @@ interface CheckoutLink {
     url: string;
     expiresAt: string;
 }
-/** A design quoted for ordering, as the user chose it. */
+/** A design quoted for ordering, as the user chose it: its items, in one order. */
 interface Checkout {
     designId: string;
     title: string;
-    /** The item as an order lists it, such as "Tinted clear · #e11d48 · glossy · 4.0 × 3.0 × 1.0 cm". */
-    summary: string;
-    quantity: number;
-    /** How many separate pieces each one prints as. */
-    pieces: number;
+    items: {
+        /** The names of the Areas it prints; empty for the whole design. */
+        parts: string[];
+        /** The item as an order lists it, such as "Tinted clear · #e11d48 · glossy · 4.0 × 3.0 × 1.0 cm". */
+        summary: string;
+        quantity: number;
+        /** How many separate pieces each one prints as. */
+        pieces: number;
+        /** The whole quantity's price, before shipping. */
+        price: number;
+    }[];
     currency: string;
-    /** The whole quantity's price, before shipping. */
+    /** Every item's price together, before shipping. */
     price: number;
-    /** The day it leaves the factory, as YYYY-MM-DD. */
+    /** The day the order leaves the factory, as YYYY-MM-DD. */
     shipsBy: string;
     minimumOrder: MinimumOrder;
     link: CheckoutLink;
@@ -265,10 +271,11 @@ interface WompBackend {
         materials: Material[];
         maxSizeCm: [number, number, number];
     }>;
-    /** The design as its scene is now, analysed and priced. Changes nothing. */
+    /** The design as its scene is now, or only the Areas `parts` names, analysed and priced. Changes nothing. */
     analyzePrint(subject: string, input: {
         designId: string;
         longestSideCm?: number;
+        parts?: number[];
     }): Promise<PrintAnalysis>;
     finishScene(subject: string, input: {
         designId: string;
@@ -280,13 +287,19 @@ interface WompBackend {
         designId: string;
         buildId: string;
     }): Promise<Build>;
-    /** Freezes the design as quoted, at `longestSideCm` when given, so its order prints it as it is now. `shipTo` comes only to a host with `completeCheckout`. */
+    /**
+     * Freezes the design as quoted, at `longestSideCm` when given, so its order prints it as it is now: every item in one
+     * checkout, each the Areas its `parts` names or the whole design. `shipTo` comes only to a host with `completeCheckout`.
+     */
     checkoutDesign(subject: string, input: {
         designId: string;
-        material: string;
-        color?: string;
-        finish?: string;
-        quantity?: number;
+        items: {
+            parts?: number[];
+            material: string;
+            color?: string;
+            finish?: string;
+            quantity?: number;
+        }[];
         longestSideCm?: number;
         shipTo?: ShipTo;
     }): Promise<Checkout>;