@womp/openai-plugin 0.8.0 → 0.8.1

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 })` | the design as its scene is now, analysed as it prints at its own size and 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? })` | 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 |
 | `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?, shipTo? })` | freezes the design as quoted, at its own size 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, 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 |
 | `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 |
 

package/dist/index.d.ts

@@ -78,7 +78,7 @@ interface PrintOption extends Material {
     /** Business days to make it, once ordered. */
     productionDays: number;
 }
-/** A design analysed as it prints, at its own size, and priced in each material on offer. */
+/** A design analysed as it prints, at its own size or scaled to `longestSideCm`, and priced in each material on offer. */
 interface PrintAnalysis {
     designId: string;
     title: string;
@@ -268,6 +268,7 @@ interface WompBackend {
     /** The design as its scene is now, analysed and priced. Changes nothing. */
     analyzePrint(subject: string, input: {
         designId: string;
+        longestSideCm?: number;
     }): Promise<PrintAnalysis>;
     finishScene(subject: string, input: {
         designId: string;
@@ -279,13 +280,14 @@ interface WompBackend {
         designId: string;
         buildId: string;
     }): Promise<Build>;
-    /** Freezes the design as quoted, 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. `shipTo` comes only to a host with `completeCheckout`. */
     checkoutDesign(subject: string, input: {
         designId: string;
         material: string;
         color?: string;
         finish?: string;
         quantity?: number;
+        longestSideCm?: number;
         shipTo?: ShipTo;
     }): Promise<Checkout>;
     /** Optional: charges a payment from ChatGPT's payment sheet and places the order; without it, checkout is on the web alone. */