@skuio/storefront 0.6.0 → 0.7.0

package/dist/mail.d.ts

@@ -1,5 +1,5 @@
 export { M as MailAdapter, a as MailMessage } from './types-CWreCyxc.js';
-import { w as StorefrontConfig, O as Order, F as Fulfillment } from './config-C4YCi7m4.js';
+import { z as StorefrontConfig, O as Order, S as StoreQuote, F as Fulfillment } from './config-CCxTka_z.js';
 export { ConsoleMailOptions, consoleMail } from './mail/console.js';
 export { MailSendError, SendgridMailOptions, sendgridMail } from './mail/sendgrid.js';
 export { CloudflareMailOptions, CloudflareSendEmailBinding, cloudflareMail } from './mail/cloudflare.js';
@@ -31,5 +31,13 @@ declare function ownerPasswordResetMail(input: {
     expiresMinutes: number;
 }, ctx: MailContext): RenderedMail;
 declare function merchantNewOrderMail(order: Order, ctx: MailContext): RenderedMail;
+/** Where a buyer opens a quote without signing in: the access key is the credential. */
+declare function quoteUrl(quote: StoreQuote, siteUrl: string): string;
+/** To the buyer: we have your request. Carries the link that is their way back in — no account needed. */
+declare function quoteReceivedMail(quote: StoreQuote, ctx: MailContext): RenderedMail;
+/** To the buyer: the quote is priced and waiting for their answer. */
+declare function quoteReadyMail(quote: StoreQuote, ctx: MailContext): RenderedMail;
+/** To the merchant: a new request, or the buyer's answer to an offer. */
+declare function merchantQuoteMail(quote: StoreQuote, ctx: MailContext, event: 'requested' | 'accepted' | 'declined', orderNumber?: string | null): RenderedMail;
 
-export { type MailContext, type RenderedMail, escapeHtml, magicLinkMail, merchantNewOrderMail, orderConfirmationMail, ownerPasswordResetMail, partnerSignInMail, shippingConfirmationMail };
+export { type MailContext, type RenderedMail, escapeHtml, magicLinkMail, merchantNewOrderMail, merchantQuoteMail, orderConfirmationMail, ownerPasswordResetMail, partnerSignInMail, quoteReadyMail, quoteReceivedMail, quoteUrl, shippingConfirmationMail };

package/dist/mail.js

@@ -12,11 +12,15 @@ import {
   escapeHtml,
   magicLinkMail,
   merchantNewOrderMail,
+  merchantQuoteMail,
   orderConfirmationMail,
   ownerPasswordResetMail,
   partnerSignInMail,
+  quoteReadyMail,
+  quoteReceivedMail,
+  quoteUrl,
   shippingConfirmationMail
-} from "./chunk-UCREHLZH.js";
+} from "./chunk-BD274TXU.js";
 import "./chunk-4PTKC5PH.js";
 export {
   MailSendError,
@@ -25,9 +29,13 @@ export {
   escapeHtml,
   magicLinkMail,
   merchantNewOrderMail,
+  merchantQuoteMail,
   orderConfirmationMail,
   ownerPasswordResetMail,
   partnerSignInMail,
+  quoteReadyMail,
+  quoteReceivedMail,
+  quoteUrl,
   sendgridMail,
   shippingConfirmationMail
 };

package/dist/payments/bitcoin.d.ts

@@ -1,4 +1,4 @@
-import { O as Order } from '../config-C4YCi7m4.js';
+import { O as Order } from '../config-CCxTka_z.js';
 import { PaymentAdapter, PaymentContext, PaymentEvent } from '../payments.js';
 import '../store.js';
 import '../driver-Cr4l6GgG.js';

package/dist/payments/btcpay.d.ts

@@ -1,6 +1,6 @@
 import { PaymentAdapter } from '../payments.js';
 import '../store.js';
-import '../config-C4YCi7m4.js';
+import '../config-CCxTka_z.js';
 import '../driver-Cr4l6GgG.js';
 import '../types-CWreCyxc.js';
 

package/dist/payments/manual.d.ts

@@ -1,4 +1,4 @@
-import { O as Order } from '../config-C4YCi7m4.js';
+import { O as Order } from '../config-CCxTka_z.js';
 import { PaymentContext, PaymentAdapter } from '../payments.js';
 import '../store.js';
 import '../driver-Cr4l6GgG.js';

package/dist/payments/manual.js

@@ -1,6 +1,6 @@
 import {
   escapeHtml
-} from "../chunk-UCREHLZH.js";
+} from "../chunk-BD274TXU.js";
 import {
   formatMoney
 } from "../chunk-4PTKC5PH.js";

package/dist/payments/paypal.d.ts

@@ -1,4 +1,4 @@
-import { A as Address, O as Order } from '../config-C4YCi7m4.js';
+import { A as Address, O as Order } from '../config-CCxTka_z.js';
 import { Quote } from '../store.js';
 import { PaymentEvent, PaymentAdapter } from '../payments.js';
 import '../driver-Cr4l6GgG.js';

package/dist/payments/stripe.d.ts

@@ -1,5 +1,5 @@
 import Stripe from 'stripe';
-import { O as Order } from '../config-C4YCi7m4.js';
+import { O as Order } from '../config-CCxTka_z.js';
 import { PaymentContext, PaymentEvent, PaymentAdapter } from '../payments.js';
 import '../store.js';
 import '../driver-Cr4l6GgG.js';

package/dist/payments.d.ts

@@ -1,5 +1,5 @@
 import { Store } from './store.js';
-import { O as Order, M as Money } from './config-C4YCi7m4.js';
+import { O as Order, M as Money } from './config-CCxTka_z.js';
 import './driver-Cr4l6GgG.js';
 import './types-CWreCyxc.js';
 

package/dist/store.d.ts

@@ -1,4 +1,4 @@
-import { w as StorefrontConfig, C as Catalog, M as Money, a as Availability, j as OrderEvent, O as Order, m as OrderStatus, F as Fulfillment, u as ShippingOption, g as DiscountCode, Q as QuantityDiscount, A as Address, P as PartnerProfile, q as PublicDiscount, e as Customer } from './config-C4YCi7m4.js';
+import { z as StorefrontConfig, C as Catalog, M as Money, a as Availability, j as OrderEvent, O as Order, m as OrderStatus, F as Fulfillment, x as ShippingOption, g as DiscountCode, r as QuantityDiscount, A as Address, P as PartnerProfile, q as PublicDiscount, e as Customer, S as StoreQuote } from './config-CCxTka_z.js';
 import { D as Database, a as DbStatement } from './driver-Cr4l6GgG.js';
 export { b as DbValue, c as bindable } from './driver-Cr4l6GgG.js';
 import { M as MailAdapter } from './types-CWreCyxc.js';
@@ -11,6 +11,8 @@ interface StoreEnv {
     SESSION_SECRET?: string;
     /** Merchant address that hears about every paid order. */
     ORDER_NOTIFICATION_EMAIL?: string;
+    /** Merchant address that hears about quote requests and answers; falls back to ORDER_NOTIFICATION_EMAIL. */
+    QUOTE_NOTIFICATION_EMAIL?: string;
     [key: string]: string | undefined;
 }
 interface StoreContext {
@@ -127,7 +129,7 @@ declare class CatalogService {
     private readonly ctx;
     private readonly ttlMs;
     constructor(ctx: StoreContext, ttlMs: number);
-    /** The catalogue snapshot: active products with availability, and the category tree. */
+    /** The catalog snapshot: active products with availability, and the category tree. */
     load(): Promise<Catalog>;
     invalidate(): void;
     private build;
@@ -138,7 +140,7 @@ declare class CatalogService {
     /** Every product row including inactive ones — the Store API's view for `unknown_skus` checks. */
     existingSkus(skus: string[]): Promise<Set<string>>;
     /**
-     * Products in keyset order, for an operations system importing the catalogue.
+     * Products in keyset order, for an operations system importing the catalog.
      * Ordered by `(updated_at, sku)` so a cursor is strictly monotonic and a
      * re-run from a watermark never repeats or skips a row.
      */
@@ -386,6 +388,32 @@ interface Quote {
     currency: string;
     option: ShippingOption;
 }
+/** An order with every amount already decided, ready to insert. Amounts are minor units in `currency`. */
+interface PricedOrderSpec {
+    email: string;
+    name: string | null;
+    phone: string | null;
+    currency: string;
+    lines: PricedLine[];
+    subtotal: number;
+    shipping: number;
+    tax: number;
+    discount: number;
+    total: number;
+    shippingAddress: Address;
+    billingAddress: Address | null;
+    shippingMethod: {
+        code: string;
+        name: string;
+    } | null;
+    notes: string | null;
+    metadata: Record<string, string>;
+    discountCode: string | null;
+    discountPartner: string | null;
+    commission: number;
+    /** Extra fields for the order's `created` event. */
+    createdEvent: Record<string, unknown>;
+}
 declare class CheckoutService {
     private readonly ctx;
     private readonly catalog;
@@ -395,7 +423,7 @@ declare class CheckoutService {
     /** Shipping options a destination may choose from. */
     optionsForCountry(country: string): ShippingOption[];
     /**
-     * Price a set of lines from the catalogue. Quantities are clamped to the
+     * Price a set of lines from the catalog. Quantities are clamped to the
      * store's per-line maximum; unknown or unavailable SKUs fail validation.
      */
     quote(items: CheckoutItem[], country: string, shippingOptionId: string, discountCode?: string | null): Promise<Quote>;
@@ -406,11 +434,22 @@ declare class CheckoutService {
     quoteDefault(items: CheckoutItem[], country: string, discountCode?: string | null): Promise<Quote>;
     /** Create a pending order the payment adapter can take from here. */
     createOrder(input: CheckoutInput): Promise<Order>;
+    /**
+     * Insert an order whose every amount is already decided. The checkout prices from the catalog first; an accepted
+     * store quote (QuotesService.accept) passes the offered prices. Nothing on the Store API reaches this: an order is
+     * only ever placed by a buyer.
+     */
+    placePricedOrder(spec: PricedOrderSpec): Promise<Order>;
 }
+/**
+ * Clean a shipping address and report what it is missing into `details` (keys `shipping_address.*`). The country is
+ * upper-cased and the country's own format (state, postal code) is checked.
+ */
+declare function checkShippingAddress(address: Address | null | undefined, details: Record<string, string>): Address;
 
 declare const CONNECT_CODE_MINUTES = 10;
 declare const API_KEY_PREFIX = "sk_store_";
-declare const CONNECT_SCOPES: readonly ["orders", "payments", "fulfillments", "inventory", "catalog"];
+declare const CONNECT_SCOPES: readonly ["orders", "payments", "fulfillments", "inventory", "catalog", "quotes"];
 type ConnectScope = (typeof CONNECT_SCOPES)[number];
 declare const SCOPE_DESCRIPTIONS: Record<ConnectScope, string>;
 interface Connection {
@@ -684,6 +723,120 @@ declare class OwnersService {
     prune(): Promise<void>;
 }
 
+interface QuoteRequestItem {
+    sku: string;
+    quantity: number;
+}
+/** What a buyer sends to ask for a quote. No account is needed: the email is the identity. */
+interface QuoteRequestInput {
+    items: QuoteRequestItem[];
+    email: string;
+    name: string;
+    phone?: string | null;
+    company?: string | null;
+    /** Lead time, intended use, delivery constraints — whatever the buyer wants priced in. */
+    message?: string | null;
+    /** Optional at request time; required by the time the quote is accepted. */
+    shippingAddress?: Address | null;
+    metadata?: Record<string, string>;
+}
+/** The operations system's price for a quote. Replaces the lines: it may change quantities, drop or add SKUs. */
+interface QuoteOfferInput {
+    lines: {
+        sku: string;
+        name?: string | null;
+        quantity: number;
+        unit_amount: Money;
+    }[];
+    shipping?: Money | null;
+    tax?: Money | null;
+    /** ISO-8601; the offer lapses after it. Null or absent: open-ended. */
+    expires_at?: string | null;
+    note?: string | null;
+    /** Email the buyer that the quote is ready (default true). */
+    notify_customer?: boolean;
+}
+interface QuoteAcceptInput {
+    /** Falls back to the address given with the request. One of the two must be complete. */
+    shippingAddress?: Address | null;
+    phone?: string | null;
+    /** The buyer's purchase-order number, kept on the order's notes and metadata. */
+    poNumber?: string | null;
+    notes?: string | null;
+}
+interface QuoteChangedPage {
+    quotes: StoreQuote[];
+    nextCursor: string | null;
+}
+/**
+ * Request for quote. A buyer asks for a price on products — signed in or as a guest who never makes an account —
+ * the operations system prices it over the Store API (`PATCH /quotes/{id}` with an `offer`), and the buyer accepts
+ * it, which places an order at exactly the offered prices, or declines it.
+ *
+ * The store never invents a price: a quote is either unpriced or carries the operations system's offer, and an
+ * order only comes from the buyer accepting one.
+ */
+declare class QuotesService {
+    private readonly ctx;
+    private readonly catalog;
+    private readonly checkout;
+    private readonly orders;
+    constructor(ctx: StoreContext, catalog: CatalogService, checkout: CheckoutService, orders: OrdersService);
+    get(id: string): Promise<StoreQuote | null>;
+    require(id: string): Promise<StoreQuote>;
+    /** The emailed link's lookup: id plus the access key. This is how a guest gets back to their quote. */
+    getWithKey(id: string, key: string): Promise<StoreQuote | null>;
+    forCustomer(customerId: string): Promise<StoreQuote[]>;
+    getForCustomer(id: string, customerId: string): Promise<StoreQuote | null>;
+    count(): Promise<number>;
+    /** Quotes changed since a watermark, oldest first, keyset-paged on (updated_at, id); `updatedSince` is inclusive. */
+    changedSince(updatedSince: string | null, cursor: string | null, limit: number): Promise<QuoteChangedPage>;
+    events(id: string): Promise<{
+        id: number;
+        type: string;
+        data: Record<string, unknown> | null;
+        createdAt: string;
+    }[]>;
+    /**
+     * Record a request for quote. The buyer needs no account and no password: the customer row is keyed by email,
+     * exactly as a guest checkout's is, and the emailed access-key link is how they come back. Sold-out products may
+     * be quoted (lead time is part of the answer); unknown or withdrawn ones may not. Throttled per email address.
+     */
+    request(input: QuoteRequestInput): Promise<StoreQuote>;
+    /**
+     * Accept a priced quote: places an order at exactly the offered prices (lines, shipping, tax) and links it. The
+     * order is pay-later (`payment_provider: manual`, never expires) — the operations system invoices and marks it
+     * paid, as B2B terms usually go; a store that wants card payment can start an adapter on the returned order.
+     * A second accept returns the same order.
+     */
+    accept(id: string, input?: QuoteAcceptInput): Promise<{
+        quote: StoreQuote;
+        order: Order;
+    }>;
+    /** The buyer turns a quote down — before or after it is priced. */
+    decline(id: string, reason?: string | null): Promise<StoreQuote>;
+    /**
+     * Price a quote. The lines replace the request's: the operations system may change a quantity, drop a line or add
+     * an alternative (a SKU the store does not list needs a `name`). Re-offering a live or lapsed quote revises it.
+     */
+    offer(id: string, input: QuoteOfferInput): Promise<StoreQuote>;
+    setExternalReference(id: string, reference: string | null): Promise<StoreQuote>;
+    /** The merchant withdraws a quote. An accepted one has an order: cancel that instead. */
+    cancel(id: string, reason?: string | null): Promise<StoreQuote>;
+    /**
+     * Lapse offers past their `expires_at`. Lazy, like abandoned checkouts: it runs at the start of the Store API quote
+     * list and of an accept, so no cron is needed and a consumer never sees a lapsed offer as live.
+     */
+    expireStale(limit?: number): Promise<number>;
+    private assertNotFlooding;
+    private event;
+    private mailContext;
+    /** The merchant hears about requests and answers at QUOTE_NOTIFICATION_EMAIL, else ORDER_NOTIFICATION_EMAIL. */
+    private notifyMerchant;
+    private send;
+    private hydrate;
+}
+
 declare const MAGIC_LINK_MINUTES = 15;
 declare const SESSION_DAYS = 30;
 interface MagicLink {
@@ -780,7 +933,7 @@ declare class RateLimiter {
     pruneStatement(): DbStatement;
 }
 
-declare const STORE_PLATFORM_VERSION = "2.1.0";
+declare const STORE_PLATFORM_VERSION = "2.2.0";
 interface StoreOptions {
     db: Database;
     config: StorefrontConfig;
@@ -788,7 +941,7 @@ interface StoreOptions {
     mail?: MailAdapter;
     /** Injectable clock for tests. */
     clock?: () => Date;
-    /** How long an isolate keeps a catalogue snapshot. 0 disables the cache. */
+    /** How long an isolate keeps a catalog snapshot. 0 disables the cache. */
     catalogCacheTtlMs?: number;
     log?: (message: string, data?: unknown) => void;
 }
@@ -803,6 +956,7 @@ interface StoreHealth {
         categories: number;
         orders: number;
         customers: number;
+        quotes: number;
     };
     /** True once an owner exists, so a consumer can tell the merchant to run `owner:create` first. */
     owner_configured: boolean;
@@ -820,6 +974,7 @@ interface Store {
     readonly customers: CustomersService;
     readonly orders: OrdersService;
     readonly checkout: CheckoutService;
+    readonly quotes: QuotesService;
     readonly sessions: SessionsService;
     readonly events: EventsService;
     readonly owners: OwnersService;
@@ -833,4 +988,4 @@ interface Store {
  */
 declare function createStore(options: StoreOptions): Store;
 
-export { ABANDONED_AFTER_MINUTES, API_KEY_PREFIX, type AuthorizeParams, type AuthorizeRequest, CONNECT_CODE_MINUTES, CONNECT_SCOPES, CatalogService, type CategoryInput, type CategoryListQuery, type CategoryPage, type CategoryRecord, type ChangedPage, type CheckoutInput, type CheckoutItem, CheckoutService, type ConnectScope, type Connection, ConnectionsService, CustomersService, Database, DbStatement, EventsService, type FulfillmentInput, type InventoryItemInput, type InventoryResult, InventoryService, type IssuedKey, MAGIC_LINK_MINUTES, type MagicLink, OWNER_RESET_MINUTES, OWNER_SESSION_DAYS, OrdersService, type Owner, type OwnerResetLink, type OwnerSession, OwnersService, PARTNER_LINK_MINUTES, PARTNER_SESSION_DAYS, PASSWORD_ITERATIONS, PASSWORD_MIN_LENGTH, type PartnerReport, type PartnerReportLine, type PartnerReportOptions, type PartnerTraffic, PartnersService, type PaymentRecord, type PricedLine, type ProductInput, type ProductListQuery, type ProductPage, type ProductRecord, type Quote, type RateLimitPolicy, RateLimiter, SCOPE_DESCRIPTIONS, SESSION_DAYS, STORE_PLATFORM_VERSION, type Session, SessionsService, type Store, type StoreContext, type StoreEnv, StoreError, type StoreErrorCode, type StoreHealth, type StoreOptions, type TrafficDay, type TrafficSource, type VisitInput, createStore, deriveAvailability, hashPassword, hashToken, isLocalHost, newId, normalizeEmail, normalizeOwnerEmail, passwordProblem, randomBase64Url, randomToken, secretsEqual, sha256Hex, verifyPassword };
+export { ABANDONED_AFTER_MINUTES, API_KEY_PREFIX, type AuthorizeParams, type AuthorizeRequest, CONNECT_CODE_MINUTES, CONNECT_SCOPES, CatalogService, type CategoryInput, type CategoryListQuery, type CategoryPage, type CategoryRecord, type ChangedPage, type CheckoutInput, type CheckoutItem, CheckoutService, type ConnectScope, type Connection, ConnectionsService, CustomersService, Database, DbStatement, EventsService, type FulfillmentInput, type InventoryItemInput, type InventoryResult, InventoryService, type IssuedKey, MAGIC_LINK_MINUTES, type MagicLink, OWNER_RESET_MINUTES, OWNER_SESSION_DAYS, OrdersService, type Owner, type OwnerResetLink, type OwnerSession, OwnersService, PARTNER_LINK_MINUTES, PARTNER_SESSION_DAYS, PASSWORD_ITERATIONS, PASSWORD_MIN_LENGTH, type PartnerReport, type PartnerReportLine, type PartnerReportOptions, type PartnerTraffic, PartnersService, type PaymentRecord, type PricedLine, type PricedOrderSpec, type ProductInput, type ProductListQuery, type ProductPage, type ProductRecord, type Quote, type QuoteAcceptInput, type QuoteChangedPage, type QuoteOfferInput, type QuoteRequestInput, type QuoteRequestItem, QuotesService, type RateLimitPolicy, RateLimiter, SCOPE_DESCRIPTIONS, SESSION_DAYS, STORE_PLATFORM_VERSION, type Session, SessionsService, type Store, type StoreContext, type StoreEnv, StoreError, type StoreErrorCode, type StoreHealth, type StoreOptions, type TrafficDay, type TrafficSource, type VisitInput, checkShippingAddress, createStore, deriveAvailability, hashPassword, hashToken, isLocalHost, newId, normalizeEmail, normalizeOwnerEmail, passwordProblem, randomBase64Url, randomToken, secretsEqual, sha256Hex, verifyPassword };