@wix/himalaya-cli 0.1368.0 → 0.1369.0

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/core/sdk/iap/src/mapping-source.d.ts

@@ -1,9 +1,11 @@
 import type { IapMappingSource } from "./catalog-pricing-contract.js";
-import { type AppBindingSource } from "./wix-payments-contract.js";
+import { type AppBindingSource, type AppleSaleRule } from "./wix-payments-contract.js";
 export type WixBridgeCall = (method: string, path: string, body: unknown, headers?: Record<string, string>) => Promise<unknown>;
 export interface WixIapMappingSourceDependencies {
     binding: AppBindingSource;
     call: WixBridgeCall;
+    /** The verticals the App Store sells; the shipped `APPLE_SALE_RULES` unless given. */
+    rules?: Readonly<Record<string, AppleSaleRule>>;
 }
 /** The connected source. Tests substitute this module at bundle-build time (`mappingSourceSeam`). */
 export declare function iapMappingSource(): IapMappingSource | undefined;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/core/sdk/iap/src/wix-payments-contract.d.ts

@@ -37,11 +37,24 @@ export interface AppleSaleRule {
     appProductId(entityId: string): string;
     productType: "NON_CONSUMABLE";
 }
+/**
+ * Whether Wix Stores items sell through the App Store, through wix-iap StartItemPayment
+ * (catalyst-server #24496), which places the member's eCom order for one catalog item. OFF: that RPC
+ * is not deployed, the member's identity across Serve → wix-iap → eCom is unproven, and a paid Stores
+ * order is not yet proven to deliver the download. The one switch: it adds the Stores rule to
+ * `APPLE_SALE_RULES`, which the mapping source and `himi store iap connect` read, and turns on the
+ * checkout's path (`itemPaymentEnabled` in @himalaya/iap-checkout).
+ */
+export declare const STORES_ITEM_PAYMENT_ENABLED = false;
+/** StartItemPayment's CatalogReference: the purchases catalog sells a Stores product under its product
+ *  id (eCom's `catalogItemId`). One-time unlocks only, whatever the backend also accepts. */
+export declare const STORES_PRODUCT_SALE_RULE: AppleSaleRule;
 /**
  * The one definition `himi store iap connect` writes mappings by and the mapping source reads them by,
  * keyed by catalog kind. wix-iap StartPayment maps the cashier order's single item id, and Online
  * Programs builds that order with the program id as the item id; programs are one-time unlocks.
- * Other verticals' order item ids are not established yet, so their items keep their own commerce.
+ * Wix Stores joins only with `STORES_ITEM_PAYMENT_ENABLED`. Other verticals' order item ids are not
+ * established yet, so their items keep their own commerce.
  */
 export declare const APPLE_SALE_RULES: Readonly<Record<string, AppleSaleRule>>;
 /** Captured when a protected call starts. The native bridge checks it and never puts it on
@@ -83,8 +96,9 @@ export interface WixIapPayment {
     canceledDate?: string;
     refundedDate?: string;
 }
-export type WixIapOperation = "startPayment" | "completePayment" | "getPayment";
+export type WixIapOperation = "startPayment" | "startItemPayment" | "completePayment" | "getPayment";
 export type StartPaymentErrorCode = "NOT_PENDING" | "WRONG_PAYMENT_METHOD" | "NOT_ORDER_BUYER" | "UNSUPPORTED_ORDER" | "PRODUCT_NOT_AVAILABLE" | "ALREADY_OWNED";
+export type StartItemPaymentErrorCode = "PRODUCT_NOT_AVAILABLE" | "ALREADY_OWNED" | "ITEM_NOT_AVAILABLE" | "SITE_NOT_ACCEPTING_PAYMENTS" | "UNSUPPORTED_ORDER";
 export type CompletePaymentErrorCode = "INVALID_PURCHASE" | "OWNED_BY_ANOTHER_CUSTOMER" | "PURCHASE_REVOKED" | "NOT_PURCHASED" | "ZERO_PRICE" | "NO_MATCHING_PAYMENT" | "PAYMENT_NOT_PENDING" | "APP_NOT_CONFIGURED";
 export type GetPaymentErrorCode = "NOT_FOUND";
 /** Why a call gave no usable answer, other than a named application error.
@@ -116,6 +130,34 @@ export type StartPaymentResult = {
     storeProductId: string;
     appAccountToken: string;
 } | WixIapFailure<StartPaymentErrorCode>;
+/** One item a Wix catalog sells through eCom, as eCom's `catalogReference` names it: for Wix Stores,
+ *  the product id and the Stores app id. The purchases catalog sells it under `catalogItemId` as its
+ *  `appProductId`. Variants and options are not supported, and the quantity is always 1. */
+export interface EcomCatalogReference {
+    catalogItemId: string;
+    catalogAppId: string;
+}
+/** StartItemPayment was handed to the transport and gave no answer this client can act on: an
+ *  outage, a lost or late answer, or a 2xx it could not decode. The service may have placed an
+ *  eCom order and started a Payment for it, and it has no idempotency key, so resending places
+ *  another order. No token came back, so nothing can be sold against it either. */
+export interface StartItemPaymentOutcomeUnknown {
+    status: "outcomeUnknown";
+    operation: "startItemPayment";
+    kind: WixIapFailureKind;
+    httpStatus?: number;
+}
+/** StartItemPayment places the member's eCom order for one catalog item, charges it with
+ *  `appleIAP` and starts its Payment, all server-side. Four different ids come back: the eCom
+ *  order (`ecomOrderId`), the Wix Payments charge (`payment.wixTransactionId`), the wix-iap
+ *  Payment (`payment.paymentId`) and the StoreKit `appAccountToken`. Keep them out of screen state. */
+export type StartItemPaymentResult = {
+    status: "started";
+    payment: WixIapPayment;
+    storeProductId: string;
+    appAccountToken: string;
+    ecomOrderId: string;
+} | WixIapFailure<StartItemPaymentErrorCode> | StartItemPaymentOutcomeUnknown;
 /** `matched`: the server verified the proof and paid the payment whose token the Apple transaction
  *  carries. Its status may still be `approving`. */
 export type CompletePaymentResult = {

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/core/sdk/iap/src/wix-payments-wire.d.ts

@@ -1,4 +1,4 @@
-import type { PurchasesAppBinding, WixIapFailure, WixIapFailureKind, WixIapOperation, WixIapPayment } from "./wix-payments-contract.js";
+import type { EcomCatalogReference, PurchasesAppBinding, WixIapFailure, WixIapFailureKind, WixIapOperation, WixIapPayment } from "./wix-payments-contract.js";
 export interface WixIapCall {
     method: "GET" | "POST";
     path: string;
@@ -10,6 +10,10 @@ export interface CallScope {
     prefix: string;
 }
 export declare function startPaymentCall(scope: CallScope, wixTransactionId: string): WixIapCall;
+/** Only the two ids StartItemPaymentRequest.item has: no quantity, options or member. */
+export declare function startItemPaymentCall(scope: CallScope, item: EcomCatalogReference): WixIapCall;
+/** CatalogReference's limits: `catalog_item_id` 1–36 characters, `catalog_app_id` a GUID. */
+export declare function catalogItemOf(raw: unknown): EcomCatalogReference | null;
 /** The JWS goes byte-for-byte: the server derives the member, and the proof names the product. */
 export declare function completePaymentCall(scope: CallScope, signedTransaction: string): WixIapCall;
 export declare function paymentCall(scope: CallScope, paymentId: string): WixIapCall;
@@ -29,6 +33,15 @@ export interface StartedPayment {
 }
 /** D61: the token is this payment's purchase intent; no other field may stand in for it. */
 export declare function decodeStarted(raw: unknown, expected: PaymentExpectation): StartedPayment | null;
+export interface StartedItemPayment extends StartedPayment {
+    ecomOrderId: string;
+}
+/** As StartPayment's answer, plus the member's eCom order. The Payment must name the requested
+ *  item: StartItemPayment builds it from the catalog entry it looked up, whose `appProductId` is
+ *  the catalog item id, so a Payment that names none is not known to be this item's. */
+export declare function decodeStartedItem(raw: unknown, expected: PaymentExpectation & {
+    catalogItemId: string;
+}): StartedItemPayment | null;
 /** CompletePayment's and GetPayment's answer: `{payment}`. */
 export declare function decodePaymentAnswer(raw: unknown, expected: PaymentExpectation): WixIapPayment | null;
 /** Maps a bridge rejection to a failure. The message itself is never kept: the bridge copies up

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/core/sdk/iap/src/wix-payments.d.ts

@@ -1,6 +1,6 @@
 import type { AppleTransaction } from "./index.js";
 import type { SessionProvider } from "./delivery-contract.js";
-import type { AppBindingSource, CompletePaymentResult, GetPaymentResult, IapAppHost, MemberIdentitySource, StartPaymentResult, WixIapRoute, WixTransport } from "./wix-payments-contract.js";
+import type { AppBindingSource, EcomCatalogReference, StartItemPaymentResult, CompletePaymentResult, GetPaymentResult, IapAppHost, MemberIdentitySource, StartPaymentResult, WixIapRoute, WixTransport } from "./wix-payments-contract.js";
 export interface WixIapClientDependencies {
     /** The trusted host session; each call is bound to the generation current when it starts. */
     session: SessionProvider;
@@ -18,6 +18,12 @@ export interface WixIapClient {
     startPayment(input: {
         wixTransactionId: string;
     }): Promise<StartPaymentResult>;
+    /** StartItemPayment for one catalog item: the service places the member's eCom order, charges it
+     *  and starts its Payment. Every call places a new order, so `outcomeUnknown` must never be
+     *  resent as if nothing happened. Returns the store product, the token and the eCom order. */
+    startItemPayment(input: {
+        item: EcomCatalogReference;
+    }): Promise<StartItemPaymentResult>;
     /** CompletePayment with held Apple proof, sent unchanged: the service pays the payment whose
      *  token the transaction carries. Success can still be `approving`. */
     completePayment(transaction: AppleTransaction): Promise<CompletePaymentResult>;
@@ -32,8 +38,8 @@ export interface WixIapClient {
  *
  * The shared checkout (`createIapCommerce`) builds it with Serve's IAP route for an app whose binary
  * carries a purchases-app binding; `route` stays a parameter with no default. It calls
- * StartPayment (`POST …/payments/start`), CompletePayment (`POST …/payments/complete`)
- * and GetPayment (`GET …/payments/{id}`) through the
+ * StartPayment (`POST …/payments/start`), StartItemPayment (`POST …/payments/start-item`, not yet
+ * deployed), CompletePayment (`POST …/payments/complete`) and GetPayment (`GET …/payments/{id}`) through the
  * `wix_api` bridge. A matched or approved Payment is not durable access and never finishes the
  * store transaction.
  *

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/flows/iap-checkout/src/apple-iap-contract.d.ts

@@ -1,4 +1,4 @@
-import type { AppBindingSource, CatalogReference, Clock, DeliveryState, HostCallExpectation, IapCatalogPricing, MemberIdentitySource, SessionProvider, TransactionStore, WixIapClient } from "@wix/himalaya/iap";
+import type { AppBindingSource, CatalogReference, Clock, DeliveryState, EcomCatalogReference, HostCallExpectation, IapCatalogPricing, MemberIdentitySource, SessionProvider, TransactionStore, WixIapClient } from "@wix/himalaya/iap";
 /** The host's Wix REST bridge (`himalaya.wixApi`). Resolves a 2xx body; rejects with
  *  `HTTP <status> [<code>]: <message>` otherwise. Credentials are attached natively.
  *  Same positional shape as the runtime's `wixApiCall`: `expectation` is bridge metadata for a
@@ -72,6 +72,13 @@ export type OrderAttempt = {
     status: "sessionChanged";
 };
 export type AccessRead = "granted" | "pending" | "none" | "unavailable" | "sessionChanged";
+/** An item wix-iap can order itself (StartItemPayment): the item as eCom's catalog reference, and
+ *  how the adapter finds the eCom order that call places again. */
+export interface ItemPayment {
+    catalogItem: EcomCatalogReference;
+    /** The reference `readAccess` reads for the eCom order StartItemPayment placed. */
+    verticalRefOf(ecomOrderId: string): VerticalRef;
+}
 /** The only per-vertical code. Every call goes through the session-bound bridge it is given. */
 export interface IapOrderAdapter {
     /** The catalog kind it sells (`onlineProgram`, `pricingPlan`, `storesProduct`, or a custom one). */
@@ -90,6 +97,9 @@ export interface IapOrderAdapter {
     /** The member's access to an item before any order exists (bought through Wix, say). Read-only:
      *  never opens or prepares an order. An adapter without it shows Get access until a sale says otherwise. */
     currentAccess?(item: IapOrderItem, bridge: SessionBoundBridge): Promise<AccessRead>;
+    /** When the platform enables StartItemPayment, an eligible item whose order wix-iap places itself
+     *  instead of `openOrder`. Null for an item outside that shape, which keeps `openOrder`. */
+    itemPayment?(item: IapOrderItem): ItemPayment | null;
 }
 /** Durable, member-partitioned purchase references. Ids only: never a proof or a credential, and
  *  the member id is stored only as a one-way hash in the key. */
@@ -99,9 +109,12 @@ export interface OrderPartitionKey {
     /** The signed-in member's Wix id, from the host session (wix-iap records purchases against it). */
     memberId: string;
 }
-/** `held`: Apple charged, and CompletePayment refused the proof without recording it, so the
- *  transaction stays unfinished and is retried. `needsSupport`: recorded and refused for good. */
-export type OrderRefStage = "ordered" | "charged" | "started" | "submitted" | "held" | "needsSupport";
+/** `startingItem`: a StartItemPayment was or is about to be sent and its answer is not stored, so
+ *  the service may have placed an order this device knows nothing of; nothing else is sold for the
+ *  item until it expires. `held`: Apple charged, and CompletePayment refused the proof without
+ *  recording it, so the transaction stays unfinished and is retried. `needsSupport`: recorded and
+ *  refused for good. */
+export type OrderRefStage = "startingItem" | "ordered" | "charged" | "started" | "submitted" | "held" | "needsSupport";
 export interface OrderRef {
     /** `<kind>:<id>` of the item, or `payment:<paymentId>` for a payment with no local order. */
     key: string;
@@ -135,7 +148,7 @@ export interface OrderRefStore {
         siteId: string;
     }): boolean | null;
 }
-export type OrderFailureCode = "notEnabled" | "notConfigured" | "signInRequired" | "unsupportedItem" | "notAppleRoute" | "storageUnavailable" | "approvalRequired" | "orderClosed" | "orderRefused" | "chargeFailed" | "paymentRefused" | "paymentHeld" | "alreadyOwned" | "paymentInProgress" | "productChanged" | "invalidAssociation" | "needsSupport" | "unavailable" | "sessionChanged";
+export type OrderFailureCode = "notEnabled" | "notConfigured" | "signInRequired" | "unsupportedItem" | "notAppleRoute" | "storageUnavailable" | "approvalRequired" | "orderClosed" | "orderRefused" | "chargeFailed" | "paymentRefused" | "paymentHeld" | "alreadyOwned" | "paymentInProgress" | "productChanged" | "invalidAssociation" | "needsSupport" | "unavailable" | "sessionChanged" | "outcomeUnknown";
 /** Progress of a payment this device handed to wix-iap, tracked from its durable reference. */
 export type PaymentAccess = "processing" | "granted" | "accessUnknown" | "needsSupport";
 export interface PaymentProgress {

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/flows/iap-checkout/src/apple-iap-core.d.ts

@@ -1,6 +1,8 @@
 import type { AppleIapCheckout, AppleIapCheckoutDependencies, AppleIapCheckoutState } from "./apple-iap-contract.js";
+/** `itemPaymentEnabled`: platform configuration (checkout-source.ts), never a screen's. */
 export declare function createAppleIapCheckoutWith(deps: AppleIapCheckoutDependencies & {
     enabled: boolean;
+    itemPaymentEnabled?: boolean;
 }): AppleIapCheckout;
 /** What a checkout that is not enabled answers: nothing sold, nothing tracked. */
 export declare function notEnabledState(): AppleIapCheckoutState;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/flows/iap-checkout/src/checkout-source.d.ts

@@ -3,3 +3,11 @@ export declare const HIMALAYA_SERVE_CHECKOUT_ROUTES: AppleIapCheckoutRoutes;
 export declare function appleIapCheckoutRoutes(): AppleIapCheckoutRoutes | null;
 /** The low-level factory's switch: on whenever the production routes exist. */
 export declare function appleIapCheckoutEnabled(): boolean;
+/**
+ * Whether an item whose adapter names it in eCom's catalog (a Wix Stores product) is paid through
+ * wix-iap StartItemPayment, which places the member's eCom order server-side. The same switch as
+ * the Stores sale rule (`STORES_ITEM_PAYMENT_ENABLED`, @himalaya/iap), so Stores items reach an App
+ * Store route only when this path sells them. Turning it off again stops only new attempts: stored
+ * ones are still held, completed and tracked (docs/iap-wix-checkout.md).
+ */
+export declare function itemPaymentEnabled(): boolean;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/flows/iap-checkout/src/commerce-core.d.ts

@@ -14,6 +14,8 @@ export interface CommerceHost {
 }
 export interface IapCommerceDependencies {
     routes: AppleIapCheckoutRoutes | null;
+    /** StartItemPayment for items whose adapter names them in eCom's catalog (checkout-source.ts). */
+    itemPaymentEnabled?: boolean;
     pricing: IapCatalogPricing;
     binding: AppBindingSource;
     /** One provider for the wix-iap client and the checkout: every step compares its generations. */

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/flows/iap-checkout/src/iap-order-backend.d.ts

@@ -29,6 +29,9 @@ export interface WixOrderBackendDependencies {
     /** Whether Apple may already be charging for this product: an unfinished transaction, or an Ask
      *  to Buy request awaiting approval. Asked inside the purchase job, after any reconcile. */
     productBusy?(productId: string): boolean;
+    /** Pay for an item its adapter names in eCom's catalog with StartItemPayment. Off: every item
+     *  goes through its adapter's own order. Platform configuration (checkout-source.ts). */
+    itemPaymentEnabled?: boolean;
     report(event: OrderEvent): void;
 }
 export declare function createWixOrderBackend(deps: WixOrderBackendDependencies): DeliveryBackend;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/flows/iap-checkout/src/index.d.ts

@@ -3,5 +3,6 @@ export { iapPurchaseFields } from "./purchase-fields.js";
 export { createAppleIapCheckout } from "./apple-iap.js";
 export { onlineProgramOrders, pricingPlanOrders, storesProductOrders, classifyCart } from "./iap-verticals/index.js";
 export { createWorkerOrderRefStore } from "./order-refs.js";
+export { itemPaymentEnabled } from "./checkout-source.js";
 export type { AccessRead, AppleIapCheckout, AppleIapCheckoutDependencies, AppleIapCheckoutPhase, AppleIapCheckoutState, BridgeOutcome, BridgeRefusal, CashierRoute, IapEligibility, IapOrderAdapter, IapOrderItem, OrderAttempt, OrderFailureCode, OrderPartitionKey, OrderRef, OrderRefPartition, OrderRefStage, OrderRefStore, PaymentAccess, PaymentProgress, SessionBoundBridge, VerticalRef, WixBridge, } from "./apple-iap-contract.js";
 export type { AppleIapCheckoutRoutes, IapCommerce, IapCommerceOptions, IapPurchaseCopy, IapPurchaseFields, IapPurchaseGap, IapPurchaseReadiness, } from "./commerce-contract.js";

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/flows/iap-checkout/src/order-refs.d.ts

@@ -6,7 +6,11 @@ export interface KeyValueStorage {
 /** How long (7 days) a payment Apple charged but Wix did not take keeps a support hold: its item
  *  is not sold again meanwhile. A literal: an expression at module scope is kept in every bundle. */
 export declare const NEEDS_SUPPORT_HOLD_MS = 604800000;
-/** Drops every hold older than NEEDS_SUPPORT_HOLD_MS, whatever its key (an item, or a `payment:`
+/** How long (1 hour) a StartItemPayment whose answer was never stored blocks its item: wix-iap's
+ *  `PENDING_TTL`. By then a Payment that answer may have started is canceled, and its token never
+ *  reached StoreKit, so nothing can pay the order it placed. A literal, as above. */
+export declare const ITEM_START_HOLD_MS = 3600000;
+/** Drops every hold older than its stage's hold time, whatever its key (an item, or a `payment:`
  *  with no local order), so holds never accumulate and lock the member out. A held proof still
  *  unfinished renews its hold on every retry, so only one Apple no longer delivers expires. Returns
  *  the keys it removed. */