@womp/openai-plugin 0.10.1 → 0.11.0

package/README.md

@@ -71,8 +71,8 @@ sign-in.
 | `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, 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` |
+| `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 shipping to that address: from a host with `completeCheckout`, the order there as a payment-sheet `session`, else `shipping`, the cheapest shipping as the user's checkout on the web first offers it and the day it arrives; 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 there is no `complete_checkout`, and a quote to an address carries `shipping` instead of a session |
 | `getOrderStatus(subject, { orderId? })` | the caller's paid orders, newest first, and the one to show, with no name, address, email or money |
 
 A build is one round of changes and has one card. Opening a new build never

package/dist/index.d.ts

@@ -93,7 +93,7 @@ interface PrintAnalysis {
     currency: string;
     options: PrintOption[];
 }
-/** Where an order paid in ChatGPT's payment sheet ships. */
+/** Where a quoted order ships. */
 interface ShipTo {
     name: string;
     line1: string;
@@ -132,8 +132,13 @@ interface Checkout {
     shipsBy: string;
     minimumOrder: MinimumOrder;
     link: CheckoutLink;
-    /** Quoted with `shipTo`: the order to that address, ready to pay in ChatGPT's payment sheet. */
+    /** Quoted with `shipTo` by a host with `completeCheckout`: the order to that address, ready to pay in ChatGPT's payment sheet. */
     session?: CheckoutSession;
+    /** Quoted with `shipTo` by a host without `completeCheckout`: the cheapest shipping to that address, as the user's checkout on the web first offers it, and the day it arrives (YYYY-MM-DD). */
+    shipping?: {
+        price: number;
+        arrivesBy: string;
+    };
 }
 /** A checkout session in the shape ChatGPT's payment sheet takes (OpenAI's Checkout API). Amounts in cents. */
 interface CheckoutSession {
@@ -289,7 +294,8 @@ interface WompBackend {
     }): Promise<Build>;
     /**
      * 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`.
+     * checkout, each the Areas its `parts` names or the whole design. With `shipTo`, the quote also prices shipping there:
+     * as a `session` from a host with `completeCheckout`, else as `shipping`.
      */
     checkoutDesign(subject: string, input: {
         designId: string;