@aglyn/plugins-commerce 1.0.0-beta.288 → 1.0.0-beta.290

package/src/lib/server/quote-pay.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { type PluginApiHandler, type PluginApiRequest } from '@aglyn/aglyn/server';
+import * as CommerceModel from '../model';
+import { type CheckoutSessionExpiry } from './checkout-session-expiry';
+import { resolveManualTaxRateId } from './manual-tax-rate';
+import { type NativeCheckoutMode } from './native-checkout';
+import { ensureCheckoutDomain } from './payment-method-domains';
+/** Lookups and presses one address may make per site, per ten minutes. */
+export declare const QUOTE_VIEW_LOOKUPS_PER_WINDOW = 60;
+export declare const QUOTE_PAY_PRESSES_PER_WINDOW = 20;
+export declare const QUOTE_WINDOW_MS: number;
+export interface QuotePayDeps {
+    firestore(): FirebaseFirestore.Firestore;
+    consumeRateLimit(key: string, options: {
+        limit: number;
+        windowMs: number;
+    }): Promise<{
+        allowed: boolean;
+        resetMs: number;
+    }>;
+    orgForHost(hostId: string): Promise<{
+        id?: string;
+        org?: any;
+    } | null>;
+    nativeMode(orgId: string): Promise<NativeCheckoutMode>;
+    /** The store's manual tax rate as a Stripe tax rate, or null when one cannot be had. */
+    taxRateId(input: Parameters<typeof resolveManualTaxRateId>[0]): Promise<string | null>;
+    createSession(params: URLSearchParams, headers: Record<string, string>): Promise<{
+        ok: boolean;
+        session: {
+            id?: string;
+            url?: string;
+            client_secret?: string;
+            error?: unknown;
+        };
+    }>;
+    expireSession(sessionId: string): Promise<CheckoutSessionExpiry>;
+    /** Registers the page's domain for Apple Pay; never throws. */
+    ensureDomain(input: Parameters<typeof ensureCheckoutDomain>[0]): Promise<unknown>;
+    now(): number;
+}
+export declare function defaultQuotePayDeps(): QuotePayDeps;
+/** A link route's answer: a status, a JSON body and any extra headers. */
+export type QuoteLinkOutcome = {
+    status: number;
+    body: Record<string, unknown>;
+    headers?: Record<string, string>;
+};
+/** The rate limit a link route spends per address per site, BEFORE the token is checked. */
+export declare function limitedQuoteLink(deps: QuotePayDeps, req: PluginApiRequest, key: string, limit: number): Promise<QuoteLinkOutcome | null>;
+export interface LoadedQuote {
+    hostRef: FirebaseFirestore.DocumentReference;
+    host: Record<string, unknown>;
+    order: CommerceModel.HostOrder;
+    storeName: string;
+    store: FirebaseFirestore.DocumentSnapshot;
+}
+/**
+ * The quote a link names, after its token: the quote, the replaced answer for
+ * a link to an older version, or the one not-found answer for everything else.
+ */
+export declare function loadLinkedQuote(deps: QuotePayDeps, hostId: string, quoteId: string, token: string): Promise<{
+    loaded: LoadedQuote;
+} | {
+    outcome: QuoteLinkOutcome;
+}>;
+/** The link's site, quote and token from a query or a body, and whether all three are there. */
+export declare function quoteLinkParams(source: Record<string, unknown>): {
+    hostId: string;
+    quoteId: string;
+    token: string;
+    complete: boolean;
+};
+/** `GET /api/commerce/quote-view`: the quote page's data. */
+export declare function handleQuoteView(deps: QuotePayDeps, req: PluginApiRequest): Promise<QuoteLinkOutcome>;
+/** The Checkout Session a quote's Pay opens, as form params. Pure over its inputs. */
+export declare function buildQuoteSessionParams(input: {
+    hostId: string;
+    quoteId: string;
+    order: CommerceModel.HostOrder;
+    charge: CommerceModel.QuoteCheckoutCharge;
+    accountId: string;
+    feeCents: number;
+    taxRateId: string;
+    returnUrl: string;
+    paymentMethods: CommerceModel.StorefrontPaymentMethodControls;
+}): URLSearchParams;
+/** `POST /api/commerce/quote-pay`: a fresh Checkout Session for the quote. */
+export declare function handleQuotePay(deps: QuotePayDeps, req: PluginApiRequest): Promise<QuoteLinkOutcome>;
+/** Sends a link route's answer, never cached or indexed. */
+export declare function sendQuoteLinkOutcome(res: Parameters<PluginApiHandler>[1], outcome: QuoteLinkOutcome): void;
+/** `GET /api/commerce/quote-view`. */
+export declare const quoteViewHandler: PluginApiHandler;
+/** `POST /api/commerce/quote-pay`. */
+export declare const quotePayHandler: PluginApiHandler;