@final-commerce/command-frame 0.14.1-online.1 → 0.14.1-online.3

package/dist/actions/attach-checkout-contact/types.d.ts

@@ -1,6 +1,6 @@
 /**
- * Guest contact for the order. There is no shopper account, so this is the only
- * way to reach them — `email` is where the receipt goes and is required.
+ * Contact for the order. `email` is where the receipt goes and is required. The two boxes are the
+ * shopper account's (see `getShopperAccount`); a box never stops the payment, whatever happens to it.
  */
 export interface AttachCheckoutContactParams {
     email: string;
@@ -8,6 +8,18 @@ export interface AttachCheckoutContactParams {
     phone?: string;
     /** Defaults to the outlet the storefront booted against. */
     outletId?: string;
+    /**
+     * The checkout's account box ("Track this order and check out faster next time", from
+     * `getShopperAccount`): links this email to a shopper account at this store. Omitted = not ticked.
+     */
+    accountOptIn?: boolean;
+    /** The news box ("Email me news and offers"): this store's consent, true or false. Omitted = not asked. */
+    marketingOptIn?: boolean;
+    /**
+     * The "Save this address" box (signed-in shoppers): once the order is paid, its shipping address is
+     * saved to the shopper's account. Omitted = not ticked.
+     */
+    saveAddress?: boolean;
 }
 export interface AttachCheckoutContactResponse {
     /**

package/dist/actions/get-address-details/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * getAddressDetails action
+ * Calls the getAddressDetails action on the parent window
+ */
+import type { GetAddressDetails } from './types';
+export declare const getAddressDetails: GetAddressDetails;

package/dist/actions/get-address-details/action.js

@@ -0,0 +1,8 @@
+/**
+ * getAddressDetails action
+ * Calls the getAddressDetails action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const getAddressDetails = async (params) => {
+    return await commandFrameClient.call('getAddressDetails', params);
+};

package/dist/actions/get-address-details/mock.d.ts

@@ -0,0 +1,2 @@
+import type { GetAddressDetails } from './types';
+export declare const mockGetAddressDetails: GetAddressDetails;

package/dist/actions/get-address-details/mock.js

@@ -0,0 +1,7 @@
+export const mockGetAddressDetails = async (params) => {
+    console.log('[Mock] getAddressDetails called', params);
+    return {
+        success: true,
+        address: { address1: '12 Water St', city: "St. John's", state: 'NL', postCode: 'A1C 1A1', country: 'CA' },
+    };
+};

package/dist/actions/get-address-details/types.d.ts

@@ -0,0 +1,22 @@
+/** In the cart's shape: country ISO 3166-1 alpha-2, province or state as its code. */
+export interface AddressDetails {
+    address1: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    postCode?: string;
+    country: string;
+}
+export interface GetAddressDetailsParams {
+    /** A suggestion's `id`, from searchAddresses. */
+    id: string;
+    language?: string;
+}
+export interface GetAddressDetailsResponse {
+    success: boolean;
+    /** Ready for setOrderAddress. Add the shopper's name; keep anything they edit afterwards. */
+    address?: AddressDetails;
+    reason?: string;
+}
+/** The picked suggestion as a full address. Ends the lookup session the searches opened. */
+export type GetAddressDetails = (params: GetAddressDetailsParams) => Promise<GetAddressDetailsResponse>;

package/dist/actions/get-address-details/types.js

@@ -0,0 +1,3 @@
+// The second half of address autocomplete: the suggestion the shopper picked, as a full address.
+// Served ONLY by the storefront runtime. Failures resolve with `success: false`; never throws.
+export {};

package/dist/actions/get-checkout-status/types.d.ts

@@ -21,6 +21,15 @@ export interface GetCheckoutStatusResponse {
      */
     cancelReason?: CheckoutCancelReason;
     receiptId: string | null;
+    /**
+     * The shopper account line for the confirmation page: "Added to your orders" when signed in, else
+     * (any guest who gave an email) a prompt to get a code; for `sign-in`, call requestShopperCode() with
+     * no params and it goes to that email. Ready to display.
+     */
+    account?: {
+        label: string;
+        action: 'none' | 'sign-in';
+    };
     timestamp: string;
 }
 /** Never throws for an unknown order: answers `status: null`. */

package/dist/actions/get-shopper-account/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * getShopperAccount action
+ * Calls the getShopperAccount action on the parent window
+ */
+import type { GetShopperAccount } from './types';
+export declare const getShopperAccount: GetShopperAccount;

package/dist/actions/get-shopper-account/action.js

@@ -0,0 +1,8 @@
+/**
+ * getShopperAccount action
+ * Calls the getShopperAccount action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const getShopperAccount = async (params) => {
+    return await commandFrameClient.call('getShopperAccount', params ?? {});
+};

package/dist/actions/get-shopper-account/mock.d.ts

@@ -0,0 +1,3 @@
+import type { GetShopperAccount } from './types';
+/** Standalone mock: a guest, with the two checkout boxes. */
+export declare const mockGetShopperAccount: GetShopperAccount;

package/dist/actions/get-shopper-account/mock.js

@@ -0,0 +1,12 @@
+/** Standalone mock: a guest, with the two checkout boxes. */
+export const mockGetShopperAccount = async () => {
+    console.log('[Mock] getShopperAccount called');
+    return {
+        success: true,
+        signedIn: false,
+        boxes: [
+            { id: 'accountOptIn', label: 'Track this order and check out faster next time', checked: false },
+            { id: 'marketingOptIn', label: 'Email me news and offers from this store', checked: false },
+        ],
+    };
+};

package/dist/actions/get-shopper-account/types.d.ts

@@ -0,0 +1,46 @@
+/** A checkbox the checkout shows, with its wording and default. */
+export interface ShopperCheckoutBox {
+    /** `saveAddress` is offered to a signed-in shopper only; send it with the shipping address step's contact. */
+    id: 'accountOptIn' | 'marketingOptIn' | 'saveAddress';
+    label: string;
+    checked: boolean;
+}
+export interface ShopperAccountView {
+    name: string;
+    /** null for an account made with a phone that has not added an email yet. */
+    email: string | null;
+    phone: string | null;
+}
+/** A saved address, as stored, plus one line to show it by. */
+export interface ShopperAddressView {
+    id: string;
+    label: string | null;
+    /** "12 Water St, St. John's, NL A1C 1A1" */
+    line: string;
+    isDefault: boolean;
+    firstName?: string;
+    lastName?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    postCode?: string;
+    country?: string;
+}
+export type GetShopperAccountParams = Record<string, never>;
+export interface GetShopperAccountResponse {
+    success: boolean;
+    signedIn: boolean;
+    /** Present when signed in. */
+    shopper?: ShopperAccountView;
+    /** Signed in only: the saved addresses, the default first. The checkout prefills the default itself. */
+    addresses?: ShopperAddressView[];
+    /**
+     * The account boxes for the checkout's contact step. A guest gets "Track this order" and the news
+     * box; a signed-in shopper gets the news box and "Save this address" (ticked).
+     */
+    boxes: ShopperCheckoutBox[];
+    reason?: string;
+}
+/** Who is signed in at this store, their saved addresses, and the checkout boxes to show. */
+export type GetShopperAccount = (params?: GetShopperAccountParams) => Promise<GetShopperAccountResponse>;

package/dist/actions/get-shopper-account/types.js

@@ -0,0 +1,6 @@
+// The shopper account on a store's website (My Account's store-scoped twin): sign in or sign up
+// with a code by email or text, see this store's orders. Served ONLY by the storefront runtime; on a
+// register it does not exist. Every value comes back READY TO DISPLAY (the runtime formats money,
+// dates and labels), so a flow shows it as it is and computes nothing. Failures resolve with
+// `success: false` and a `reason` written for the shopper; these never throw.
+export {};

package/dist/actions/get-shopper-order/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * getShopperOrder action
+ * Calls the getShopperOrder action on the parent window
+ */
+import type { GetShopperOrder } from './types';
+export declare const getShopperOrder: GetShopperOrder;

package/dist/actions/get-shopper-order/action.js

@@ -0,0 +1,8 @@
+/**
+ * getShopperOrder action
+ * Calls the getShopperOrder action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const getShopperOrder = async (params) => {
+    return await commandFrameClient.call('getShopperOrder', params ?? {});
+};

package/dist/actions/get-shopper-order/mock.d.ts

@@ -0,0 +1,2 @@
+import type { GetShopperOrder } from './types';
+export declare const mockGetShopperOrder: GetShopperOrder;

package/dist/actions/get-shopper-order/mock.js

@@ -0,0 +1,24 @@
+export const mockGetShopperOrder = async (params) => {
+    console.log('[Mock] getShopperOrder called', params);
+    return {
+        success: true,
+        order: {
+            orderId: params.orderId,
+            receiptId: '#1042',
+            placedAtLabel: 'Nov 1, 2026',
+            status: 'paid',
+            statusLabel: 'Paid',
+            totalLabel: '$42.50',
+            itemsLabel: '2 items',
+            items: [{ name: 'Harbour mug', variant: 'Slate', quantity: 2, totalLabel: '$40.00' }],
+            totals: [
+                { label: 'Subtotal', amountLabel: '$40.00' },
+                { label: 'Tax', amountLabel: '$2.50' },
+                { label: 'Total', amountLabel: '$42.50' },
+            ],
+            paidWithLabel: 'Visa •••• 4242',
+            deliveryLabel: 'Pickup at Water St.',
+            returnLabel: null,
+        },
+    };
+};

package/dist/actions/get-shopper-order/types.d.ts

@@ -0,0 +1,32 @@
+import type { ShopperOrderView } from '../get-shopper-orders/types';
+export interface ShopperOrderItemView {
+    name: string;
+    /** e.g. "Slate", or null */
+    variant: string | null;
+    quantity: number;
+    totalLabel: string;
+}
+export interface ShopperOrderDetailView extends ShopperOrderView {
+    items: ShopperOrderItemView[];
+    /** Subtotal, Discount, Tax, Shipping, Refunded, Total: only the ones that apply. */
+    totals: {
+        label: string;
+        amountLabel: string;
+    }[];
+    /** "Visa •••• 4242", or null */
+    paidWithLabel: string | null;
+    /** "Pickup at Water St.", "Shipping", or null */
+    deliveryLabel: string | null;
+    /** "Return requested Nov 3, 2026", or null */
+    returnLabel: string | null;
+}
+export interface GetShopperOrderParams {
+    orderId: string;
+}
+export interface GetShopperOrderResponse {
+    success: boolean;
+    order?: ShopperOrderDetailView;
+    reason?: string;
+}
+/** One of the shopper's orders at this store. */
+export type GetShopperOrder = (params: GetShopperOrderParams) => Promise<GetShopperOrderResponse>;

package/dist/actions/get-shopper-order/types.js

@@ -0,0 +1,6 @@
+// The shopper account on a store's website (My Account's store-scoped twin): sign in or sign up
+// with a code by email or text, see this store's orders. Served ONLY by the storefront runtime; on a
+// register it does not exist. Every value comes back READY TO DISPLAY (the runtime formats money,
+// dates and labels), so a flow shows it as it is and computes nothing. Failures resolve with
+// `success: false` and a `reason` written for the shopper; these never throw.
+export {};

package/dist/actions/get-shopper-orders/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * getShopperOrders action
+ * Calls the getShopperOrders action on the parent window
+ */
+import type { GetShopperOrders } from './types';
+export declare const getShopperOrders: GetShopperOrders;

package/dist/actions/get-shopper-orders/action.js

@@ -0,0 +1,8 @@
+/**
+ * getShopperOrders action
+ * Calls the getShopperOrders action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const getShopperOrders = async (params) => {
+    return await commandFrameClient.call('getShopperOrders', params ?? {});
+};

package/dist/actions/get-shopper-orders/mock.d.ts

@@ -0,0 +1,2 @@
+import type { GetShopperOrders } from './types';
+export declare const mockGetShopperOrders: GetShopperOrders;

package/dist/actions/get-shopper-orders/mock.js

@@ -0,0 +1,18 @@
+export const mockGetShopperOrders = async () => {
+    console.log('[Mock] getShopperOrders called');
+    return {
+        success: true,
+        orders: [
+            {
+                orderId: '6a2f1c7b1e35f9a4c67a1010',
+                receiptId: '#1042',
+                placedAtLabel: 'Nov 1, 2026',
+                status: 'paid',
+                statusLabel: 'Paid',
+                totalLabel: '$42.50',
+                itemsLabel: '3 items',
+            },
+        ],
+        nextCursor: null,
+    };
+};

package/dist/actions/get-shopper-orders/types.d.ts

@@ -0,0 +1,29 @@
+import type { ShopperOrderStatus } from '@final-commerce/common';
+/** One order row, ready to display. */
+export interface ShopperOrderView {
+    orderId: string;
+    receiptId: string;
+    /** e.g. "Nov 1, 2026" */
+    placedAtLabel: string;
+    /** For styling only: the label is what the shopper reads. */
+    status: ShopperOrderStatus;
+    /** "Paid", "Refunded", "Partially refunded", "Cancelled" */
+    statusLabel: string;
+    /** "$42.50" */
+    totalLabel: string;
+    /** "3 items" */
+    itemsLabel: string;
+}
+export interface GetShopperOrdersParams {
+    /** From the previous page's `nextCursor`. */
+    cursor?: string;
+}
+export interface GetShopperOrdersResponse {
+    success: boolean;
+    /** This store's orders placed with the shopper's verified emails, newest first. */
+    orders: ShopperOrderView[];
+    nextCursor: string | null;
+    reason?: string;
+}
+/** The signed-in shopper's orders at this store. */
+export type GetShopperOrders = (params?: GetShopperOrdersParams) => Promise<GetShopperOrdersResponse>;

package/dist/actions/get-shopper-orders/types.js

@@ -0,0 +1,6 @@
+// The shopper account on a store's website (My Account's store-scoped twin): sign in or sign up
+// with a code by email or text, see this store's orders. Served ONLY by the storefront runtime; on a
+// register it does not exist. Every value comes back READY TO DISPLAY (the runtime formats money,
+// dates and labels), so a flow shows it as it is and computes nothing. Failures resolve with
+// `success: false` and a `reason` written for the shopper; these never throw.
+export {};

package/dist/actions/request-shopper-code/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * requestShopperCode action
+ * Calls the requestShopperCode action on the parent window
+ */
+import type { RequestShopperCode } from './types';
+export declare const requestShopperCode: RequestShopperCode;

package/dist/actions/request-shopper-code/action.js

@@ -0,0 +1,8 @@
+/**
+ * requestShopperCode action
+ * Calls the requestShopperCode action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const requestShopperCode = async (params) => {
+    return await commandFrameClient.call('requestShopperCode', params ?? {});
+};

package/dist/actions/request-shopper-code/mock.d.ts

@@ -0,0 +1,2 @@
+import type { RequestShopperCode } from './types';
+export declare const mockRequestShopperCode: RequestShopperCode;

package/dist/actions/request-shopper-code/mock.js

@@ -0,0 +1,4 @@
+export const mockRequestShopperCode = async (params) => {
+    console.log('[Mock] requestShopperCode called', params);
+    return { success: true, message: `We sent a 6-digit code to ${params.email ?? params.phone ?? 'your email'}` };
+};

package/dist/actions/request-shopper-code/types.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Where the code goes: an `email`, or a `phone` (a text message; any common spelling, the runtime
+ * makes it E.164 with +1 when no country is given). Give one, not both. Give neither right after a
+ * guest checkout to send it to the email that checkout used ("Email me a code" on the confirmation).
+ */
+export interface RequestShopperCodeParams {
+    email?: string;
+    phone?: string;
+}
+export interface RequestShopperCodeResponse {
+    success: boolean;
+    /** "We sent a 6-digit code to s…@example.com" (or "…by text to ••• 0101"). Never says who has an account. */
+    message?: string;
+    reason?: string;
+}
+/** Send a 6-digit sign-in code by email or text. It works at this store only. Signing up is the same step. */
+export type RequestShopperCode = (params: RequestShopperCodeParams) => Promise<RequestShopperCodeResponse>;

package/dist/actions/request-shopper-code/types.js

@@ -0,0 +1,6 @@
+// The shopper account on a store's website (My Account's store-scoped twin): sign in or sign up
+// with a code by email or text, see this store's orders. Served ONLY by the storefront runtime; on a
+// register it does not exist. Every value comes back READY TO DISPLAY (the runtime formats money,
+// dates and labels), so a flow shows it as it is and computes nothing. Failures resolve with
+// `success: false` and a `reason` written for the shopper; these never throw.
+export {};

package/dist/actions/search-addresses/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * searchAddresses action
+ * Calls the searchAddresses action on the parent window
+ */
+import type { SearchAddresses } from './types';
+export declare const searchAddresses: SearchAddresses;

package/dist/actions/search-addresses/action.js

@@ -0,0 +1,8 @@
+/**
+ * searchAddresses action
+ * Calls the searchAddresses action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const searchAddresses = async (params) => {
+    return await commandFrameClient.call('searchAddresses', params);
+};

package/dist/actions/search-addresses/mock.d.ts

@@ -0,0 +1,3 @@
+import type { SearchAddresses } from './types';
+/** Standalone mock: two Water Street addresses for anything typed. */
+export declare const mockSearchAddresses: SearchAddresses;

package/dist/actions/search-addresses/mock.js

@@ -0,0 +1,24 @@
+/** Standalone mock: two Water Street addresses for anything typed. */
+export const mockSearchAddresses = async (params) => {
+    console.log('[Mock] searchAddresses called', params);
+    if (params.query.trim().length < 3)
+        return { success: true, available: true, suggestions: [] };
+    return {
+        success: true,
+        available: true,
+        suggestions: [
+            {
+                id: 'mock-place-1',
+                label: "12 Water St, St. John's, NL, Canada",
+                main: '12 Water St',
+                secondary: "St. John's, NL, Canada",
+            },
+            {
+                id: 'mock-place-2',
+                label: "120 Water St, St. John's, NL, Canada",
+                main: '120 Water St',
+                secondary: "St. John's, NL, Canada",
+            },
+        ],
+    };
+};

package/dist/actions/search-addresses/types.d.ts

@@ -0,0 +1,31 @@
+/** One line to show in the dropdown. Pass its `id` to getAddressDetails when the shopper picks it. */
+export interface AddressSuggestion {
+    id: string;
+    /** The whole line: "12 Water St, St. John's, NL, Canada". */
+    label: string;
+    /** The street part, for a two-line row: "12 Water St". */
+    main: string;
+    /** The rest: "St. John's, NL, Canada". */
+    secondary: string;
+}
+export interface SearchAddressesParams {
+    /** What the shopper typed so far. Under 3 characters answers no suggestions without a lookup. */
+    query: string;
+    /** ISO 3166-1 alpha-2. Defaults to the store's own country. */
+    country?: string;
+    /** Language of the suggestions, e.g. `fr`. */
+    language?: string;
+}
+export interface SearchAddressesResponse {
+    success: boolean;
+    suggestions: AddressSuggestion[];
+    /** false when this site has no address lookup: keep the plain fields and stop asking. */
+    available: boolean;
+    reason?: string;
+}
+/**
+ * Addresses matching what the shopper typed, for an autocomplete dropdown. Call it as they type
+ * (wait ~250 ms after the last keystroke); the runtime groups the searches and the pick into one
+ * lookup session itself.
+ */
+export type SearchAddresses = (params: SearchAddressesParams) => Promise<SearchAddressesResponse>;

package/dist/actions/search-addresses/types.js

@@ -0,0 +1,5 @@
+// Address autocomplete for a store website's checkout: what the shopper typed in, matching
+// addresses out, then the picked one as a full address (getAddressDetails). Served ONLY by the
+// storefront runtime. Failures resolve with `success: false` and a `reason`; these never throw, and
+// when lookup is not available the flow simply keeps its plain address fields.
+export {};

package/dist/actions/sign-in-shopper/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * signInShopper action
+ * Calls the signInShopper action on the parent window
+ */
+import type { SignInShopper } from './types';
+export declare const signInShopper: SignInShopper;

package/dist/actions/sign-in-shopper/action.js

@@ -0,0 +1,8 @@
+/**
+ * signInShopper action
+ * Calls the signInShopper action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const signInShopper = async (params) => {
+    return await commandFrameClient.call('signInShopper', params ?? {});
+};

package/dist/actions/sign-in-shopper/mock.d.ts

@@ -0,0 +1,2 @@
+import type { SignInShopper } from './types';
+export declare const mockSignInShopper: SignInShopper;

package/dist/actions/sign-in-shopper/mock.js

@@ -0,0 +1,7 @@
+export const mockSignInShopper = async (params) => {
+    console.log('[Mock] signInShopper called', params);
+    const email = params.email ?? null;
+    return params.code === '000000'
+        ? { success: false, reason: 'That code is wrong' }
+        : { success: true, shopper: { name: email?.split('@')[0] ?? '', email, phone: params.phone ?? null } };
+};

package/dist/actions/sign-in-shopper/types.d.ts

@@ -0,0 +1,19 @@
+import type { ShopperAccountView } from '../get-shopper-account/types';
+/** The same `email` or `phone` the code was sent to (or neither, after a guest checkout), and the code. */
+export interface SignInShopperParams {
+    email?: string;
+    phone?: string;
+    code: string;
+}
+export interface SignInShopperResponse {
+    success: boolean;
+    shopper?: ShopperAccountView;
+    /** "That code is wrong", "Too many tries, get a new code", ... */
+    reason?: string;
+}
+/**
+ * Sign in (or up) with the code. The session is kept for this store only. Signing in fills the
+ * checkout's contact and default address when they are empty, and the payment step then offers the
+ * shopper's saved cards.
+ */
+export type SignInShopper = (params: SignInShopperParams) => Promise<SignInShopperResponse>;

package/dist/actions/sign-in-shopper/types.js

@@ -0,0 +1,6 @@
+// The shopper account on a store's website (My Account's store-scoped twin): sign in or sign up
+// with a code by email or text, see this store's orders. Served ONLY by the storefront runtime; on a
+// register it does not exist. Every value comes back READY TO DISPLAY (the runtime formats money,
+// dates and labels), so a flow shows it as it is and computes nothing. Failures resolve with
+// `success: false` and a `reason` written for the shopper; these never throw.
+export {};

package/dist/actions/sign-out-shopper/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * signOutShopper action
+ * Calls the signOutShopper action on the parent window
+ */
+import type { SignOutShopper } from './types';
+export declare const signOutShopper: SignOutShopper;

package/dist/actions/sign-out-shopper/action.js

@@ -0,0 +1,8 @@
+/**
+ * signOutShopper action
+ * Calls the signOutShopper action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const signOutShopper = async (params) => {
+    return await commandFrameClient.call('signOutShopper', params ?? {});
+};

package/dist/actions/sign-out-shopper/mock.d.ts

@@ -0,0 +1,2 @@
+import type { SignOutShopper } from './types';
+export declare const mockSignOutShopper: SignOutShopper;

package/dist/actions/sign-out-shopper/mock.js

@@ -0,0 +1,4 @@
+export const mockSignOutShopper = async () => {
+    console.log('[Mock] signOutShopper called');
+    return { success: true };
+};

package/dist/actions/sign-out-shopper/types.d.ts

@@ -0,0 +1,7 @@
+export type SignOutShopperParams = Record<string, never>;
+export interface SignOutShopperResponse {
+    success: boolean;
+    reason?: string;
+}
+/** Ends this store's session on this device. */
+export type SignOutShopper = (params?: SignOutShopperParams) => Promise<SignOutShopperResponse>;

package/dist/actions/sign-out-shopper/types.js

@@ -0,0 +1,6 @@
+// The shopper account on a store's website (My Account's store-scoped twin): sign in or sign up
+// with a code by email or text, see this store's orders. Served ONLY by the storefront runtime; on a
+// register it does not exist. Every value comes back READY TO DISPLAY (the runtime formats money,
+// dates and labels), so a flow shows it as it is and computes nothing. Failures resolve with
+// `success: false` and a `reason` written for the shopper; these never throw.
+export {};

package/dist/index.d.ts

@@ -68,12 +68,20 @@ export declare const command: {
     readonly startCheckout: import(".").StartCheckout;
     readonly attachCheckoutContact: import(".").AttachCheckoutContact;
     readonly getAddressOptions: import(".").GetAddressOptions;
+    readonly searchAddresses: import(".").SearchAddresses;
+    readonly getAddressDetails: import(".").GetAddressDetails;
     readonly setOrderAddress: import(".").SetOrderAddress;
     readonly getShippingOptions: import(".").GetShippingOptions;
     readonly selectShippingOption: import(".").SelectShippingOption;
     readonly setOutlet: import(".").SetOutlet;
     readonly resumeCheckout: import(".").ResumeCheckout;
     readonly getCheckoutStatus: import(".").GetCheckoutStatus;
+    readonly getShopperAccount: import(".").GetShopperAccount;
+    readonly requestShopperCode: import(".").RequestShopperCode;
+    readonly signInShopper: import(".").SignInShopper;
+    readonly signOutShopper: import(".").SignOutShopper;
+    readonly getShopperOrders: import(".").GetShopperOrders;
+    readonly getShopperOrder: import(".").GetShopperOrder;
     readonly getMotoConfig: import(".").GetMotoConfig;
     readonly addCustomerNote: import(".").AddCustomerNote;
     readonly removeCustomerNote: import(".").RemoveCustomerNote;
@@ -241,6 +249,14 @@ export type { SelectShippingOption, SelectShippingOptionParams, SelectShippingOp
 export type { SetOutlet, SetOutletParams, SetOutletResponse } from './actions/set-outlet/types';
 export type { ResumeCheckout, ResumeCheckoutParams, ResumeCheckoutResponse, ResumeCheckoutResult, } from './actions/resume-checkout/types';
 export type { GetCheckoutStatus, GetCheckoutStatusParams, GetCheckoutStatusResponse, CheckoutOrderStatus, CheckoutCancelReason, } from './actions/get-checkout-status/types';
+export type { GetShopperAccount, GetShopperAccountParams, GetShopperAccountResponse, ShopperCheckoutBox, ShopperAccountView, ShopperAddressView, } from './actions/get-shopper-account/types';
+export type { RequestShopperCode, RequestShopperCodeParams, RequestShopperCodeResponse, } from './actions/request-shopper-code/types';
+export type { SignInShopper, SignInShopperParams, SignInShopperResponse } from './actions/sign-in-shopper/types';
+export type { SignOutShopper, SignOutShopperParams, SignOutShopperResponse } from './actions/sign-out-shopper/types';
+export type { SearchAddresses, SearchAddressesParams, SearchAddressesResponse, AddressSuggestion, } from './actions/search-addresses/types';
+export type { GetAddressDetails, GetAddressDetailsParams, GetAddressDetailsResponse, AddressDetails, } from './actions/get-address-details/types';
+export type { GetShopperOrders, GetShopperOrdersParams, GetShopperOrdersResponse, ShopperOrderView, } from './actions/get-shopper-orders/types';
+export type { GetShopperOrder, GetShopperOrderParams, GetShopperOrderResponse, ShopperOrderDetailView, ShopperOrderItemView, } from './actions/get-shopper-order/types';
 export type { GetMotoConfig, GetMotoConfigResponse, MotoUnavailableReason } from './actions/get-moto-config/types';
 export type { AddCustomerNote, AddCustomerNoteParams, AddCustomerNoteResponse, } from './actions/add-customer-note/types';
 export type { RemoveCustomerNote, RemoveCustomerNoteParams, RemoveCustomerNoteResponse, } from './actions/remove-customer-note/types';

package/dist/index.js

@@ -68,12 +68,21 @@ import { chargeMoto } from './actions/charge-moto/action';
 import { startCheckout } from './actions/start-checkout/action';
 import { attachCheckoutContact } from './actions/attach-checkout-contact/action';
 import { getAddressOptions } from './actions/get-address-options/action';
+import { searchAddresses } from './actions/search-addresses/action';
+import { getAddressDetails } from './actions/get-address-details/action';
 import { setOrderAddress } from './actions/set-order-address/action';
 import { getShippingOptions } from './actions/get-shipping-options/action';
 import { selectShippingOption } from './actions/select-shipping-option/action';
 import { setOutlet } from './actions/set-outlet/action';
 import { resumeCheckout } from './actions/resume-checkout/action';
 import { getCheckoutStatus } from './actions/get-checkout-status/action';
+// Shopper account (store websites)
+import { getShopperAccount } from './actions/get-shopper-account/action';
+import { requestShopperCode } from './actions/request-shopper-code/action';
+import { signInShopper } from './actions/sign-in-shopper/action';
+import { signOutShopper } from './actions/sign-out-shopper/action';
+import { getShopperOrders } from './actions/get-shopper-orders/action';
+import { getShopperOrder } from './actions/get-shopper-order/action';
 import { getMotoConfig } from './actions/get-moto-config/action';
 // Customer Actions
 import { addCustomerNote } from './actions/add-customer-note/action';
@@ -237,12 +246,20 @@ export const command = {
     startCheckout,
     attachCheckoutContact,
     getAddressOptions,
+    searchAddresses,
+    getAddressDetails,
     setOrderAddress,
     getShippingOptions,
     selectShippingOption,
     setOutlet,
     resumeCheckout,
     getCheckoutStatus,
+    getShopperAccount,
+    requestShopperCode,
+    signInShopper,
+    signOutShopper,
+    getShopperOrders,
+    getShopperOrder,
     getMotoConfig,
     // Customer Actions
     addCustomerNote,

package/dist/projects/render/mocks.js

@@ -48,6 +48,14 @@ import { mockGetOutlets } from '../../actions/get-outlets/mock';
 import { mockSetOutlet } from '../../actions/set-outlet/mock';
 import { mockResumeCheckout } from '../../actions/resume-checkout/mock';
 import { mockGetCheckoutStatus } from '../../actions/get-checkout-status/mock';
+import { mockGetShopperAccount } from '../../actions/get-shopper-account/mock';
+import { mockRequestShopperCode } from '../../actions/request-shopper-code/mock';
+import { mockSignInShopper } from '../../actions/sign-in-shopper/mock';
+import { mockSignOutShopper } from '../../actions/sign-out-shopper/mock';
+import { mockGetShopperOrders } from '../../actions/get-shopper-orders/mock';
+import { mockSearchAddresses } from '../../actions/search-addresses/mock';
+import { mockGetAddressDetails } from '../../actions/get-address-details/mock';
+import { mockGetShopperOrder } from '../../actions/get-shopper-order/mock';
 import { mockGetMotoConfig } from '../../actions/get-moto-config/mock';
 import { mockGetTimeClockStatus } from '../../actions/get-time-clock-status/mock';
 import { mockClearCart } from '../../actions/clear-cart/mock';
@@ -171,6 +179,8 @@ export const RENDER_MOCKS = {
     startCheckout: mockStartCheckout,
     attachCheckoutContact: mockAttachCheckoutContact,
     getAddressOptions: mockGetAddressOptions,
+    searchAddresses: mockSearchAddresses,
+    getAddressDetails: mockGetAddressDetails,
     setOrderAddress: mockSetOrderAddress,
     getShippingOptions: mockGetShippingOptions,
     selectShippingOption: mockSelectShippingOption,
@@ -178,6 +188,12 @@ export const RENDER_MOCKS = {
     setOutlet: mockSetOutlet,
     resumeCheckout: mockResumeCheckout,
     getCheckoutStatus: mockGetCheckoutStatus,
+    getShopperAccount: mockGetShopperAccount,
+    requestShopperCode: mockRequestShopperCode,
+    signInShopper: mockSignInShopper,
+    signOutShopper: mockSignOutShopper,
+    getShopperOrders: mockGetShopperOrders,
+    getShopperOrder: mockGetShopperOrder,
     getMotoConfig: mockGetMotoConfig,
     clearCart: mockClearCart,
     deleteParkedOrder: mockDeleteParkedOrder,

package/dist/projects/render/types.d.ts

@@ -1,4 +1,4 @@
-import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, GetCustomStockActions, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, GetCompositePrice, GetCompositeAvailability, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, SetVariantUnavailable, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, ResumeOrder, SetOrderMetadata, AssignOrderUser, ReleaseFromCart, SetOrderType, SetScheduledFor, SetOrderStatus, GetOrderStatuses, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, RecordExternalPayment, GetCashRoundingAmount, TapToPayPayment, TerminalPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, RedeemRefund, GetRefundPlan, CheckPermission, GetCurrentCart, Print, SetActiveOrder, GetCustomTables, GetCustomTableData, UpsertCustomTableData, DeleteCustomTableData, GetCustomExtensions, GetCurrentCompanyCustomExtensions, GetCustomExtensionCustomTables, GetCustomTableFields, GetSecretsKeys, GetSecretVal, SetSecretVal, GetUsers, GetRoles, RemoveCartDiscount, GetActiveOrder, GetActiveCustomer, SetActiveCustomer, GetActiveOutlet, GetActiveStation, GetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem, CanTransition, GetAvailableTransitions, ApplyTransition, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms, GetBookingResources, GetBookingAvailability, GetBookings, HoldBooking, AddBookingToCart, RemoveBookingFromCart, CancelBooking, CreatePaymentLink, ChargeMoto, StartCheckout, AttachCheckoutContact, GetAddressOptions, SetOrderAddress, GetShippingOptions, SelectShippingOption, GetOutlets, SetOutlet, ResumeCheckout, GetCheckoutStatus, GetMotoConfig, GetTimeClockStatus } from '../../index';
+import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, GetCustomStockActions, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, GetCompositePrice, GetCompositeAvailability, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, SetVariantUnavailable, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, ResumeOrder, SetOrderMetadata, AssignOrderUser, ReleaseFromCart, SetOrderType, SetScheduledFor, SetOrderStatus, GetOrderStatuses, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, RecordExternalPayment, GetCashRoundingAmount, TapToPayPayment, TerminalPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, RedeemRefund, GetRefundPlan, CheckPermission, GetCurrentCart, Print, SetActiveOrder, GetCustomTables, GetCustomTableData, UpsertCustomTableData, DeleteCustomTableData, GetCustomExtensions, GetCurrentCompanyCustomExtensions, GetCustomExtensionCustomTables, GetCustomTableFields, GetSecretsKeys, GetSecretVal, SetSecretVal, GetUsers, GetRoles, RemoveCartDiscount, GetActiveOrder, GetActiveCustomer, SetActiveCustomer, GetActiveOutlet, GetActiveStation, GetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem, CanTransition, GetAvailableTransitions, ApplyTransition, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms, GetBookingResources, GetBookingAvailability, GetBookings, HoldBooking, AddBookingToCart, RemoveBookingFromCart, CancelBooking, CreatePaymentLink, ChargeMoto, StartCheckout, AttachCheckoutContact, GetAddressOptions, SetOrderAddress, GetShippingOptions, SelectShippingOption, GetOutlets, SetOutlet, ResumeCheckout, GetCheckoutStatus, GetShopperAccount, RequestShopperCode, SignInShopper, SignOutShopper, GetShopperOrders, GetShopperOrder, SearchAddresses, GetAddressDetails, GetMotoConfig, GetTimeClockStatus } from '../../index';
 export interface RenderProviderActions {
     exampleFunction: ExampleFunction;
     getProducts: GetProducts;
@@ -74,6 +74,8 @@ export interface RenderProviderActions {
     attachCheckoutContact: AttachCheckoutContact;
     /** Shipping, on the till (ship-to) and the website alike. The runtime prices; the flow renders. */
     getAddressOptions: GetAddressOptions;
+    searchAddresses: SearchAddresses;
+    getAddressDetails: GetAddressDetails;
     setOrderAddress: SetOrderAddress;
     getShippingOptions: GetShippingOptions;
     selectShippingOption: SelectShippingOption;
@@ -87,6 +89,13 @@ export interface RenderProviderActions {
     resumeCheckout: ResumeCheckout;
     /** Where an online order stands now, by its order password. Storefront-only. */
     getCheckoutStatus: GetCheckoutStatus;
+    /** The shopper account on a store's website (sign in, this store's orders). Storefront-only. */
+    getShopperAccount: GetShopperAccount;
+    requestShopperCode: RequestShopperCode;
+    signInShopper: SignInShopper;
+    signOutShopper: SignOutShopper;
+    getShopperOrders: GetShopperOrders;
+    getShopperOrder: GetShopperOrder;
     getMotoConfig: GetMotoConfig;
     addNonRevenueItem: AddNonRevenueItem;
     addCustomerNote: AddCustomerNote;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@final-commerce/command-frame",
-  "version": "0.14.1-online.1",
+  "version": "0.14.1-online.3",
   "description": "Commands Frame library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -57,7 +57,7 @@
     "ignoreBranchesMissingTickets": true
   },
   "dependencies": {
-    "@final-commerce/common": "2.11.1-online.1"
+    "@final-commerce/common": "2.11.1-online.3"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.0.0",